Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add AccessManager contracts #4121

Merged
merged 79 commits into from
Mar 24, 2023
Merged
Changes from 1 commit
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
1327b8f
add AccessManager.sol
frangio Mar 1, 2023
b54b922
docs
frangio Mar 1, 2023
5a0fd33
enforce team existence
frangio Mar 1, 2023
ee5de96
remove on-chain enumerability
frangio Mar 15, 2023
6284768
add Authority interface
frangio Mar 15, 2023
bce3641
remove redundancy
frangio Mar 15, 2023
223e6af
simplify and complete features
frangio Mar 16, 2023
eafb571
split in separate files
frangio Mar 16, 2023
24af159
write AccessManager docs
frangio Mar 16, 2023
833f219
add docs for AccessManagerAdapter
frangio Mar 16, 2023
0f27739
add to docs site
frangio Mar 16, 2023
2ac5aa1
docs for IAuthority
frangio Mar 16, 2023
f26c4d3
lint
frangio Mar 16, 2023
63f9393
add initial AccessManaged docs
frangio Mar 16, 2023
6fecd25
typos
frangio Mar 16, 2023
589b5b1
Update contracts/access/manager/AccessManager.sol
frangio Mar 16, 2023
619cc73
fix docs
frangio Mar 16, 2023
1b681a5
rename team "all" -> "public"
frangio Mar 16, 2023
48b31c0
ad hoc selector batching
frangio Mar 16, 2023
b078157
whitespace
frangio Mar 17, 2023
274c04d
add docs on team number choice
frangio Mar 17, 2023
082b05c
add missing function argument
frangio Mar 17, 2023
52f27c8
fix team role decoding
frangio Mar 17, 2023
1285c49
add ungrouped interface
frangio Mar 17, 2023
5c7472a
improve docs
frangio Mar 17, 2023
3cc1e73
remove todo
frangio Mar 17, 2023
ae3482d
add initial tests for teams
frangio Mar 19, 2023
535ea13
rename team -> badge
frangio Mar 19, 2023
68bb5fa
improve testing
frangio Mar 19, 2023
fa58ec5
Update contracts/access/manager/AccessManager.sol
frangio Mar 19, 2023
6d76058
use mapping labels from solidity 0.8.18
frangio Mar 20, 2023
3447438
add AccessManaged tests
frangio Mar 20, 2023
1d10639
fix group encoding
frangio Mar 20, 2023
d875a7b
add test for allowing
frangio Mar 20, 2023
d517d27
lint
frangio Mar 20, 2023
6d33cda
add changeset
frangio Mar 20, 2023
9ed1aef
lint
frangio Mar 20, 2023
6adc0d8
fix mock
frangio Mar 21, 2023
0624794
remove contract groups
frangio Mar 21, 2023
17ec3b6
add transferContractAuthority
frangio Mar 21, 2023
f9210c5
lint
frangio Mar 21, 2023
a54cd10
rename badge -> group
frangio Mar 21, 2023
8af9ca4
change test name
frangio Mar 21, 2023
2a05bcc
add setContractModeCustom and tests
frangio Mar 21, 2023
5f22f2d
remove use of mapping labels
frangio Mar 21, 2023
6a9fbed
Merge branch 'master' into accessmanager
frangio Mar 22, 2023
0580198
tweak comments
frangio Mar 22, 2023
e01e362
add tests for adapter
frangio Mar 22, 2023
cb026bc
lint
frangio Mar 22, 2023
76d35da
add revert reasons and group tests
frangio Mar 22, 2023
4069781
add tests for allowing and disallowing roles
frangio Mar 22, 2023
80ffd2a
lint
frangio Mar 22, 2023
3094d0c
add docs for AccessManaged
frangio Mar 22, 2023
b3a8b1b
Update contracts/access/manager/AccessManager.sol
frangio Mar 22, 2023
8a68322
Update contracts/access/manager/AccessManager.sol
frangio Mar 22, 2023
eeab8cf
Update contracts/access/manager/AccessManager.sol
frangio Mar 22, 2023
ca61e38
add tests for onlyDefaultAdmin
frangio Mar 22, 2023
8824c31
lint
frangio Mar 22, 2023
67e33b6
add internal _setContractMode
frangio Mar 22, 2023
5f270c7
Update .changeset/quiet-trainers-kick.md
frangio Mar 22, 2023
6f7ac96
Update contracts/access/manager/AccessManager.sol
frangio Mar 22, 2023
7ec5311
Update contracts/access/manager/AccessManager.sol
frangio Mar 22, 2023
82402d2
typo
frangio Mar 22, 2023
27807e6
Apply suggestions from code review
frangio Mar 22, 2023
80bc88b
roll back to 0.8.13
frangio Mar 22, 2023
cf4df22
add test for setFunctionAllowedGroup events
frangio Mar 22, 2023
bab4d34
remove mode restriction on setFunctionAllowedGroup
frangio Mar 22, 2023
642e279
simplify use of setFunctionAllowedGroup
frangio Mar 22, 2023
51aff23
lint
frangio Mar 22, 2023
6e3da66
remove unused import
frangio Mar 22, 2023
6b56c8f
remove onlyDefaultAdmin modifier
frangio Mar 22, 2023
b7e3b3f
lint
frangio Mar 22, 2023
8200986
use return value names for _decodeGroupRole
frangio Mar 22, 2023
18e53e2
rename RestrictedMode -> AccessMode
frangio Mar 22, 2023
f94a881
use Context._msgSender
frangio Mar 22, 2023
cd8babd
reorder arguments to grant/revoke/renounceGroup
frangio Mar 22, 2023
597edc0
add IAccessControlDefaultAdminRules
frangio Mar 22, 2023
ee560d0
Apply suggestions from code review
frangio Mar 22, 2023
33f5ace
Fix expected event parameter name in tests
ernestognw Mar 22, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add ungrouped interface
  • Loading branch information
frangio committed Mar 17, 2023
commit 1285c49c7cd55c3cb54f4719afefe54a837d04ae
77 changes: 67 additions & 10 deletions contracts/access/manager/AccessManager.sol
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ interface IAccessManager is IAuthority {

function renounceTeam(address user, uint8 team) external;

function getFunctionAllowedTeams(bytes32 group, bytes4 selector) external view returns (bytes32 teams);
function getFunctionAllowedTeams(address target, bytes4 selector) external view returns (bytes32 teams);
function getFunctionAllowedTeams(string calldata group, bytes4 selector) external view returns (bytes32 teams);

function setFunctionAllowedTeam(bytes32 group, bytes4[] calldata selectors, uint8 team, bool allowed) external;
function setFunctionAllowedTeam(address target, bytes4[] calldata selectors, uint8 team, bool allowed) external;
function setFunctionAllowedTeam(string calldata group, bytes4[] calldata selectors, uint8 team, bool allowed) external;

function getContractGroup(address target) external view returns (bytes32 group);

Expand All @@ -52,7 +54,7 @@ interface IAccessManager is IAuthority {
* that starts with the ASCII characters `team:`, followed by zeroes, and ending with the single byte corresponding to
* the team number.
*
* Contracts in the system are grouped as well. These are simply called "contract groups". There can be an arbitrary
* Contracts in the system may be grouped as well. These are simply called "contract groups". There can be an arbitrary
* number of groups. Each contract can only be in one group at a time. In the simplest setup, each contract is assigned
* to its own separate group, but groups can also be shared among similar contracts.
*
Expand All @@ -79,10 +81,14 @@ contract AccessManager is IAccessManager, AccessControlDefaultAdminRules {
mapping(address => bytes32) private _contractGroup;

uint8 private constant _TEAM_PUBLIC = 255;

bytes32 private constant _GROUP_UNSET = 0;
bytes32 private constant _GROUP_OPEN = "group:open";
bytes32 private constant _GROUP_CLOSED = "group:closed";

bytes14 private constant _GROUP_ISOLATE_PREFIX = "group:isolate:";
bytes13 private constant _GROUP_CUSTOM_PREFIX = "group:custom:";

/**
* @dev Initializes an AccessManager with initial default admin and transfer delay.
*/
Expand All @@ -98,12 +104,12 @@ contract AccessManager is IAccessManager, AccessControlDefaultAdminRules {
* Entrypoint for {AccessManaged} contracts.
*/
function canCall(address caller, address target, bytes4 selector) public view returns (bool) {
bytes32 group = getContractGroup(target);
bytes32 allowedTeams = getFunctionAllowedTeams(group, selector);
bytes32 allowedTeams = getFunctionAllowedTeams(target, selector);
bytes32 callerTeams = getUserTeams(caller);
return callerTeams & allowedTeams != 0;
}

// TODO: consider sanitizing name
/**
* @dev Creates a new team with a team number that can be chosen arbitrarily but must be unused, and gives it a
* human-readable name. The caller must be the default admin.
Expand Down Expand Up @@ -165,11 +171,19 @@ contract AccessManager is IAccessManager, AccessControlDefaultAdminRules {
renounceRole(_encodeTeamRole(team), user);
}

function getFunctionAllowedTeams(address target, bytes4 selector) public view virtual returns (bytes32) {
return _getFunctionAllowedTeams(getContractGroup(target), selector);
}

function getFunctionAllowedTeams(string calldata group, bytes4 selector) public view virtual returns (bytes32) {
return _getFunctionAllowedTeams(_encodeCustomGroup(group), selector);
}

/**
* @dev Returns a bitmap of the teams that are allowed to call a function selector on contracts belonging to a
* group. Bit `n` is set if team `n` is allowed, counting from least significant bit.
*/
function getFunctionAllowedTeams(bytes32 group, bytes4 selector) public view virtual returns (bytes32) {
function _getFunctionAllowedTeams(bytes32 group, bytes4 selector) internal view virtual returns (bytes32) {
if (group == _GROUP_OPEN) {
return _teamMask(_TEAM_PUBLIC);
} else if (group == _GROUP_CLOSED) {
Expand All @@ -179,16 +193,35 @@ contract AccessManager is IAccessManager, AccessControlDefaultAdminRules {
}
}

function setFunctionAllowedTeam(
address target,
bytes4[] calldata selectors,
uint8 team,
bool allowed
) public virtual {
require(_contractGroup[target] == 0);
_setFunctionAllowedTeam(_encodeIsolateGroup(target), selectors, team, allowed);
}

function setFunctionAllowedTeam(
string calldata group,
bytes4[] calldata selectors,
uint8 team,
bool allowed
) public virtual {
_setFunctionAllowedTeam(_encodeCustomGroup(group), selectors, team, allowed);
}

/**
* @dev Changes whether a team is allowed to call a function selector on contracts belonging to a group, according
* to the `allowed` argument. The caller must be the default admin.
*/
function setFunctionAllowedTeam(
function _setFunctionAllowedTeam(
bytes32 group,
bytes4[] calldata selectors,
uint8 team,
bool allowed
) public virtual onlyDefaultAdmin {
) internal virtual onlyDefaultAdmin {
require(group != 0);
for (uint256 i = 0; i < selectors.length; i++) {
bytes4 selector = selectors[i];
Expand All @@ -201,7 +234,12 @@ contract AccessManager is IAccessManager, AccessControlDefaultAdminRules {
* @dev Returns the contract group that the target contract currently belongs to. May be 0 if not set.
*/
function getContractGroup(address target) public view virtual returns (bytes32) {
return _contractGroup[target];
bytes32 group = _contractGroup[target];
if (group == 0) {
return _encodeIsolateGroup(target);
} else {
return group;
}
}

/**
Expand Down Expand Up @@ -289,11 +327,30 @@ contract AccessManager is IAccessManager, AccessControlDefaultAdminRules {
return (tag == bytes32("team:"), team);
}

/**
* @dev Returns the isolate group id for a target contract.
*
* The group id consists of the ASCII characters `group:isolate:` followed by the contract address bytes.
*/
function _encodeIsolateGroup(address target) internal virtual pure returns (bytes32) {
return _GROUP_ISOLATE_PREFIX | (bytes20(target) >> _GROUP_ISOLATE_PREFIX.length);
}

/**
* @dev Returns the isolate group id for a target contract.
*
* The group id consists of the ASCII characters `group:custom:` followed by the group name.
*/
function _encodeCustomGroup(string calldata name) internal virtual pure returns (bytes32) {
require(bytes(name).length + _GROUP_CUSTOM_PREFIX.length < 32);
return _GROUP_CUSTOM_PREFIX | (bytes32(bytes(name)) >> _GROUP_CUSTOM_PREFIX.length);
}

/**
* @dev Returns true if the group is one of "open", "closed", or unset (zero).
*/
function _isSpecialGroup(bytes32 group) private pure returns (bool) {
return group == _GROUP_UNSET || group == _GROUP_OPEN || group == _GROUP_CLOSED;
return group == _GROUP_OPEN || group == _GROUP_CLOSED;
}

/**
Expand Down