Bouncer contract implementation (#883)
* feat: implement bouncer contracts * fix: rename Bouncer to SignatureBouncerpull/768/head^2
Matt Condon
7 years ago
committed by
GitHub
parent
0926729c8f
commit
6a7114fdb4
@ -0,0 +1,90 @@ |
||||
pragma solidity ^0.4.18; |
||||
|
||||
import "../ownership/Ownable.sol"; |
||||
import "../ownership/rbac/RBAC.sol"; |
||||
import "../ECRecovery.sol"; |
||||
|
||||
/** |
||||
* @title SignatureBouncer |
||||
* @author PhABC and Shrugs |
||||
* @dev Bouncer allows users to submit a signature as a permission to do an action. |
||||
* @dev If the signature is from one of the authorized bouncer addresses, the signature |
||||
* @dev is valid. The owner of the contract adds/removes bouncers. |
||||
* @dev Bouncer addresses can be individual servers signing grants or different |
||||
* @dev users within a decentralized club that have permission to invite other members. |
||||
* @dev |
||||
* @dev This technique is useful for whitelists and airdrops; instead of putting all |
||||
* @dev valid addresses on-chain, simply sign a grant of the form |
||||
* @dev keccak256(`:contractAddress` + `:granteeAddress`) using a valid bouncer address. |
||||
* @dev Then restrict access to your crowdsale/whitelist/airdrop using the |
||||
* @dev `onlyValidSignature` modifier (or implement your own using isValidSignature). |
||||
* @dev |
||||
* @dev See the tests Bouncer.test.js for specific usage examples. |
||||
*/ |
||||
contract SignatureBouncer is Ownable, RBAC { |
||||
using ECRecovery for bytes32; |
||||
|
||||
string public constant ROLE_BOUNCER = "bouncer"; |
||||
|
||||
/** |
||||
* @dev requires that a valid signature of a bouncer was provided |
||||
*/ |
||||
modifier onlyValidSignature(bytes _sig) |
||||
{ |
||||
require(isValidSignature(msg.sender, _sig)); |
||||
_; |
||||
} |
||||
|
||||
/** |
||||
* @dev allows the owner to add additional bouncer addresses |
||||
*/ |
||||
function addBouncer(address _bouncer) |
||||
onlyOwner |
||||
public |
||||
{ |
||||
require(_bouncer != address(0)); |
||||
addRole(_bouncer, ROLE_BOUNCER); |
||||
} |
||||
|
||||
/** |
||||
* @dev allows the owner to remove bouncer addresses |
||||
*/ |
||||
function removeBouncer(address _bouncer) |
||||
onlyOwner |
||||
public |
||||
{ |
||||
require(_bouncer != address(0)); |
||||
removeRole(_bouncer, ROLE_BOUNCER); |
||||
} |
||||
|
||||
/** |
||||
* @dev is the signature of `this + sender` from a bouncer? |
||||
* @return bool |
||||
*/ |
||||
function isValidSignature(address _address, bytes _sig) |
||||
internal |
||||
view |
||||
returns (bool) |
||||
{ |
||||
return isValidDataHash( |
||||
keccak256(address(this), _address), |
||||
_sig |
||||
); |
||||
} |
||||
|
||||
/** |
||||
* @dev internal function to convert a hash to an eth signed message |
||||
* @dev and then recover the signature and check it against the bouncer role |
||||
* @return bool |
||||
*/ |
||||
function isValidDataHash(bytes32 hash, bytes _sig) |
||||
internal |
||||
view |
||||
returns (bool) |
||||
{ |
||||
address signer = hash |
||||
.toEthSignedMessageHash() |
||||
.recover(_sig); |
||||
return hasRole(signer, ROLE_BOUNCER); |
||||
} |
||||
} |
||||
@ -0,0 +1,22 @@ |
||||
pragma solidity ^0.4.18; |
||||
|
||||
import "../access/SignatureBouncer.sol"; |
||||
|
||||
|
||||
contract SignatureBouncerMock is SignatureBouncer { |
||||
function checkValidSignature(address _address, bytes _sig) |
||||
public |
||||
view |
||||
returns (bool) |
||||
{ |
||||
return isValidSignature(_address, _sig); |
||||
} |
||||
|
||||
function onlyWithValidSignature(bytes _sig) |
||||
onlyValidSignature(_sig) |
||||
public |
||||
view |
||||
{ |
||||
|
||||
} |
||||
} |
||||
@ -0,0 +1,119 @@ |
||||
|
||||
import assertRevert from '../helpers/assertRevert'; |
||||
import { signHex } from '../helpers/sign'; |
||||
|
||||
const Bouncer = artifacts.require('SignatureBouncerMock'); |
||||
|
||||
require('chai') |
||||
.use(require('chai-as-promised')) |
||||
.should(); |
||||
|
||||
export const getSigner = (contract, signer, data = '') => (addr) => { |
||||
// via: https://github.com/OpenZeppelin/zeppelin-solidity/pull/812/files
|
||||
const message = contract.address.substr(2) + addr.substr(2) + data; |
||||
// ^ substr to remove `0x` because in solidity the address is a set of byes, not a string `0xabcd`
|
||||
return signHex(signer, message); |
||||
}; |
||||
|
||||
contract('Bouncer', ([_, owner, authorizedUser, anyone, bouncerAddress, newBouncer]) => { |
||||
before(async function () { |
||||
this.bouncer = await Bouncer.new({ from: owner }); |
||||
this.roleBouncer = await this.bouncer.ROLE_BOUNCER(); |
||||
this.genSig = getSigner(this.bouncer, bouncerAddress); |
||||
}); |
||||
|
||||
it('should have a default owner of self', async function () { |
||||
const theOwner = await this.bouncer.owner(); |
||||
theOwner.should.eq(owner); |
||||
}); |
||||
|
||||
it('should allow owner to add a bouncer', async function () { |
||||
await this.bouncer.addBouncer(bouncerAddress, { from: owner }); |
||||
const hasRole = await this.bouncer.hasRole(bouncerAddress, this.roleBouncer); |
||||
hasRole.should.eq(true); |
||||
}); |
||||
|
||||
it('should not allow anyone to add a bouncer', async function () { |
||||
await assertRevert( |
||||
this.bouncer.addBouncer(bouncerAddress, { from: anyone }) |
||||
); |
||||
}); |
||||
|
||||
context('modifiers', () => { |
||||
it('should allow valid signature for sender', async function () { |
||||
await this.bouncer.onlyWithValidSignature( |
||||
this.genSig(authorizedUser), |
||||
{ from: authorizedUser } |
||||
); |
||||
}); |
||||
it('should not allow invalid signature for sender', async function () { |
||||
await assertRevert( |
||||
this.bouncer.onlyWithValidSignature( |
||||
'abcd', |
||||
{ from: authorizedUser } |
||||
) |
||||
); |
||||
}); |
||||
}); |
||||
|
||||
context('signatures', () => { |
||||
it('should accept valid message for valid user', async function () { |
||||
const isValid = await this.bouncer.checkValidSignature( |
||||
authorizedUser, |
||||
this.genSig(authorizedUser) |
||||
); |
||||
isValid.should.eq(true); |
||||
}); |
||||
it('should not accept invalid message for valid user', async function () { |
||||
const isValid = await this.bouncer.checkValidSignature( |
||||
authorizedUser, |
||||
this.genSig(anyone) |
||||
); |
||||
isValid.should.eq(false); |
||||
}); |
||||
it('should not accept invalid message for invalid user', async function () { |
||||
const isValid = await this.bouncer.checkValidSignature( |
||||
anyone, |
||||
'abcd' |
||||
); |
||||
isValid.should.eq(false); |
||||
}); |
||||
it('should not accept valid message for invalid user', async function () { |
||||
const isValid = await this.bouncer.checkValidSignature( |
||||
anyone, |
||||
this.genSig(authorizedUser) |
||||
); |
||||
isValid.should.eq(false); |
||||
}); |
||||
}); |
||||
|
||||
context('management', () => { |
||||
it('should not allow anyone to add bouncers', async function () { |
||||
await assertRevert( |
||||
this.bouncer.addBouncer(newBouncer, { from: anyone }) |
||||
); |
||||
}); |
||||
|
||||
it('should be able to add bouncers', async function () { |
||||
await this.bouncer.addBouncer(newBouncer, { from: owner }) |
||||
.should.be.fulfilled; |
||||
}); |
||||
|
||||
it('should not allow adding invalid address', async function () { |
||||
await assertRevert( |
||||
this.bouncer.addBouncer('0x0', { from: owner }) |
||||
); |
||||
}); |
||||
|
||||
it('should not allow anyone to remove bouncer', async function () { |
||||
await assertRevert( |
||||
this.bouncer.removeBouncer(newBouncer, { from: anyone }) |
||||
); |
||||
}); |
||||
|
||||
it('should be able to remove bouncers', async function () { |
||||
await this.bouncer.removeBouncer(newBouncer, { from: owner }) |
||||
.should.be.fulfilled; |
||||
}); |
||||
}); |
||||
}); |
||||
@ -1,8 +0,0 @@ |
||||
import utils from 'ethereumjs-util'; |
||||
|
||||
// Hash and add same prefix to the hash that ganache use.
|
||||
module.exports = function (message) { |
||||
const messageHex = Buffer.from(utils.sha3(message).toString('hex'), 'hex'); |
||||
const prefix = utils.toBuffer('\u0019Ethereum Signed Message:\n' + messageHex.length.toString()); |
||||
return utils.bufferToHex(utils.sha3(Buffer.concat([prefix, messageHex]))); |
||||
}; |
||||
@ -0,0 +1,22 @@ |
||||
import utils from 'ethereumjs-util'; |
||||
|
||||
/** |
||||
* Hash and add same prefix to the hash that ganache use. |
||||
* @param {string} message the plaintext/ascii/original message |
||||
* @return {string} the hash of the message, prefixed, and then hashed again |
||||
*/ |
||||
export const hashMessage = (message) => { |
||||
const messageHex = Buffer.from(utils.sha3(message).toString('hex'), 'hex'); |
||||
const prefix = utils.toBuffer('\u0019Ethereum Signed Message:\n' + messageHex.length.toString()); |
||||
return utils.bufferToHex(utils.sha3(Buffer.concat([prefix, messageHex]))); |
||||
}; |
||||
|
||||
// signs message using web3 (auto-applies prefix)
|
||||
export const signMessage = (signer, message = '', options = {}) => { |
||||
return web3.eth.sign(signer, web3.sha3(message, options)); |
||||
}; |
||||
|
||||
// signs hex string using web3 (auto-applies prefix)
|
||||
export const signHex = (signer, message = '') => { |
||||
return signMessage(signer, message, { encoding: 'hex' }); |
||||
}; |
||||
Loading…
Reference in new issue