AccessManager.sol 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881
  1. // SPDX-License-Identifier: MIT
  2. pragma solidity ^0.8.20;
  3. import {IAccessManager} from "./IAccessManager.sol";
  4. import {IAccessManaged} from "./IAccessManaged.sol";
  5. import {Address} from "../../utils/Address.sol";
  6. import {Context} from "../../utils/Context.sol";
  7. import {Multicall} from "../../utils/Multicall.sol";
  8. import {Math} from "../../utils/math/Math.sol";
  9. import {Time} from "../../utils/types/Time.sol";
  10. /**
  11. * @dev AccessManager is a central contract to store the permissions of a system.
  12. *
  13. * The smart contracts under the control of an AccessManager instance will have a set of "restricted" functions, and the
  14. * exact details of how access is restricted for each of those functions is configurable by the admins of the instance.
  15. * These restrictions are expressed in terms of "roles".
  16. *
  17. * An AccessManager instance will define a set of roles. Accounts can be added into any number of these roles. Each of
  18. * them defines a role, and may confer access to some of the restricted functions in the system, as configured by admins
  19. * through the use of {setFunctionAllowedRoles}.
  20. *
  21. * Note that a function in a target contract may become permissioned in this way only when: 1) said contract is
  22. * {AccessManaged} and is connected to this contract as its manager, and 2) said function is decorated with the
  23. * `restricted` modifier.
  24. *
  25. * There is a special role defined by default named "public" which all accounts automatically have.
  26. *
  27. * In addition to the access rules defined by each target's functions being assigned to roles, then entire target can
  28. * be "closed". This "closed" mode is set/unset by the admin using {setTargetClosed} and can be used to lock a contract
  29. * while permissions are being (re-)configured.
  30. *
  31. * Since all the permissions of the managed system can be modified by the admins of this instance, it is expected that
  32. * they will be highly secured (e.g., a multisig or a well-configured DAO).
  33. *
  34. * NOTE: This contract implements a form of the {IAuthority} interface, but {canCall} has additional return data so it
  35. * doesn't inherit `IAuthority`. It is however compatible with the `IAuthority` interface since the first 32 bytes of
  36. * the return data are a boolean as expected by that interface.
  37. *
  38. * NOTE: Systems that implement other access control mechanisms (for example using {Ownable}) can be paired with an
  39. * {AccessManager} by transferring permissions (ownership in the case of {Ownable}) directly to the {AccessManager}.
  40. * Users will be able to interact with these contracts through the {execute} function, following the access rules
  41. * registered in the {AccessManager}. Keep in mind that in that context, the msg.sender seen by restricted functions
  42. * will be {AccessManager} itself.
  43. *
  44. * WARNING: When granting permissions over an {Ownable} or {AccessControl} contract to an {AccessManager}, be very
  45. * mindful of the danger associated with functions such as {{Ownable-renounceOwnership}} or
  46. * {{AccessControl-renounceRole}}.
  47. */
  48. contract AccessManager is Context, Multicall, IAccessManager {
  49. using Time for *;
  50. // Structure that stores the details for a target contract.
  51. struct TargetConfig {
  52. mapping(bytes4 selector => uint64 roleId) allowedRoles;
  53. Time.Delay adminDelay;
  54. bool closed;
  55. }
  56. // Structure that stores the details for a role/account pair. This structures fit into a single slot.
  57. struct Access {
  58. // Timepoint at which the user gets the permission. If this is either 0, or in the future, the role
  59. // permission is not available.
  60. uint48 since;
  61. // Delay for execution. Only applies to restricted() / execute() calls.
  62. Time.Delay delay;
  63. }
  64. // Structure that stores the details of a role, including:
  65. // - the members of the role
  66. // - the admin role (that can grant or revoke permissions)
  67. // - the guardian role (that can cancel operations targeting functions that need this role)
  68. // - the grand delay
  69. struct Role {
  70. mapping(address user => Access access) members;
  71. uint64 admin;
  72. uint64 guardian;
  73. Time.Delay grantDelay;
  74. }
  75. // Structure that stores the details for a scheduled operation. This structure fits into a single slot.
  76. struct Schedule {
  77. uint48 timepoint;
  78. uint32 nonce;
  79. }
  80. uint64 public constant ADMIN_ROLE = type(uint64).min; // 0
  81. uint64 public constant PUBLIC_ROLE = type(uint64).max; // 2**64-1
  82. mapping(address target => TargetConfig mode) private _targets;
  83. mapping(uint64 roleId => Role) private _roles;
  84. mapping(bytes32 operationId => Schedule) private _schedules;
  85. // This should be transient storage when supported by the EVM.
  86. bytes32 private _executionId;
  87. /**
  88. * @dev Check that the caller is authorized to perform the operation, following the restrictions encoded in
  89. * {_getAdminRestrictions}.
  90. */
  91. modifier onlyAuthorized() {
  92. _checkAuthorized();
  93. _;
  94. }
  95. constructor(address initialAdmin) {
  96. if (initialAdmin == address(0)) {
  97. revert AccessManagerInvalidInitialAdmin(address(0));
  98. }
  99. // admin is active immediately and without any execution delay.
  100. _grantRole(ADMIN_ROLE, initialAdmin, 0, 0);
  101. }
  102. // =================================================== GETTERS ====================================================
  103. /**
  104. * @dev Check if an address (`caller`) is authorised to call a given function on a given contract directly (with
  105. * no restriction). Additionally, it returns the delay needed to perform the call indirectly through the {schedule}
  106. * & {execute} workflow.
  107. *
  108. * This function is usually called by the targeted contract to control immediate execution of restricted functions.
  109. * Therefore we only return true is the call can be performed without any delay. If the call is subject to a delay,
  110. * then the function should return false, and the caller should schedule the operation for future execution.
  111. *
  112. * We may be able to hash the operation, and check if the call was scheduled, but we would not be able to cleanup
  113. * the schedule, leaving the possibility of multiple executions. Maybe this function should not be view?
  114. *
  115. * NOTE: The IAuthority interface does not include the `uint32` delay. This is an extension of that interface that
  116. * is backward compatible. Some contracts may thus ignore the second return argument. In that case they will fail
  117. * to identify the indirect workflow, and will consider calls that require a delay to be forbidden.
  118. */
  119. function canCall(address caller, address target, bytes4 selector) public view virtual returns (bool, uint32) {
  120. if (isTargetClosed(target)) {
  121. return (false, 0);
  122. } else if (caller == address(this)) {
  123. // Caller is AccessManager, this means the call was sent through {execute} and it already checked
  124. // permissions. We verify that the call "identifier", which is set during {execute}, is correct.
  125. return (_isExecuting(target, selector), 0);
  126. } else {
  127. uint64 roleId = getTargetFunctionRole(target, selector);
  128. (bool isMember, uint32 currentDelay) = hasRole(roleId, caller);
  129. return isMember ? (currentDelay == 0, currentDelay) : (false, 0);
  130. }
  131. }
  132. /**
  133. * @dev Expiration delay for scheduled proposals. Defaults to 1 week.
  134. */
  135. function expiration() public view virtual returns (uint32) {
  136. return 1 weeks;
  137. }
  138. /**
  139. * @dev Minimum setback for all delay updates, with the exception of execution delays, which
  140. * can be increased without setback (and in the event of an accidental increase can be reset
  141. * via {revokeRole}). Defaults to 5 days.
  142. */
  143. function minSetback() public view virtual returns (uint32) {
  144. return 5 days;
  145. }
  146. /**
  147. * @dev Get the mode under which a contract is operating.
  148. */
  149. function isTargetClosed(address target) public view virtual returns (bool) {
  150. return _targets[target].closed;
  151. }
  152. /**
  153. * @dev Get the role required to call a function.
  154. */
  155. function getTargetFunctionRole(address target, bytes4 selector) public view virtual returns (uint64) {
  156. return _targets[target].allowedRoles[selector];
  157. }
  158. /**
  159. * @dev Get the admin delay for a target contract. Changes to contract configuration are subject to this delay.
  160. */
  161. function getTargetAdminDelay(address target) public view virtual returns (uint32) {
  162. return _targets[target].adminDelay.get();
  163. }
  164. /**
  165. * @dev Get the id of the role that acts as an admin for given role.
  166. *
  167. * The admin permission is required to grant the role, revoke the role and update the execution delay to execute
  168. * an operation that is restricted to this role.
  169. */
  170. function getRoleAdmin(uint64 roleId) public view virtual returns (uint64) {
  171. return _roles[roleId].admin;
  172. }
  173. /**
  174. * @dev Get the role that acts as a guardian for a given role.
  175. *
  176. * The guardian permission allows canceling operations that have been scheduled under the role.
  177. */
  178. function getRoleGuardian(uint64 roleId) public view virtual returns (uint64) {
  179. return _roles[roleId].guardian;
  180. }
  181. /**
  182. * @dev Get the role current grant delay, that value may change at any point, without an event emitted, following
  183. * a call to {setGrantDelay}. Changes to this value, including effect timepoint are notified by the
  184. * {RoleGrantDelayChanged} event.
  185. */
  186. function getRoleGrantDelay(uint64 roleId) public view virtual returns (uint32) {
  187. return _roles[roleId].grantDelay.get();
  188. }
  189. /**
  190. * @dev Get the access details for a given account for a given role. These details include the timepoint at which
  191. * membership becomes active, and the delay applied to all operation by this user that requires this permission
  192. * level.
  193. *
  194. * Returns:
  195. * [0] Timestamp at which the account membership becomes valid. 0 means role is not granted.
  196. * [1] Current execution delay for the account.
  197. * [2] Pending execution delay for the account.
  198. * [3] Timestamp at which the pending execution delay will become active. 0 means no delay update is scheduled.
  199. */
  200. function getAccess(uint64 roleId, address account) public view virtual returns (uint48, uint32, uint32, uint48) {
  201. Access storage access = _roles[roleId].members[account];
  202. uint48 since = access.since;
  203. (uint32 currentDelay, uint32 pendingDelay, uint48 effect) = access.delay.getFull();
  204. return (since, currentDelay, pendingDelay, effect);
  205. }
  206. /**
  207. * @dev Check if a given account currently had the permission level corresponding to a given role. Note that this
  208. * permission might be associated with a delay. {getAccess} can provide more details.
  209. */
  210. function hasRole(uint64 roleId, address account) public view virtual returns (bool, uint32) {
  211. if (roleId == PUBLIC_ROLE) {
  212. return (true, 0);
  213. } else {
  214. (uint48 hasRoleSince, uint32 currentDelay, , ) = getAccess(roleId, account);
  215. return (hasRoleSince != 0 && hasRoleSince <= Time.timestamp(), currentDelay);
  216. }
  217. }
  218. // =============================================== ROLE MANAGEMENT ===============================================
  219. /**
  220. * @dev Give a label to a role, for improved role discoverabily by UIs.
  221. *
  222. * Emits a {RoleLabel} event.
  223. */
  224. function labelRole(uint64 roleId, string calldata label) public virtual onlyAuthorized {
  225. if (roleId == ADMIN_ROLE || roleId == PUBLIC_ROLE) {
  226. revert AccessManagerLockedRole(roleId);
  227. }
  228. emit RoleLabel(roleId, label);
  229. }
  230. /**
  231. * @dev Add `account` to `roleId`, or change its execution delay.
  232. *
  233. * This gives the account the authorization to call any function that is restricted to this role. An optional
  234. * execution delay (in seconds) can be set. If that delay is non 0, the user is required to schedule any operation
  235. * that is restricted to members this role. The user will only be able to execute the operation after the delay has
  236. * passed, before it has expired. During this period, admin and guardians can cancel the operation (see {cancel}).
  237. *
  238. * If the account has already been granted this role, the execution delay will be updated. This update is not
  239. * immediate and follows the delay rules. For example, If a user currently has a delay of 3 hours, and this is
  240. * called to reduce that delay to 1 hour, the new delay will take some time to take effect, enforcing that any
  241. * operation executed in the 3 hours that follows this update was indeed scheduled before this update.
  242. *
  243. * Requirements:
  244. *
  245. * - the caller must be an admin for the role (see {getRoleAdmin})
  246. *
  247. * Emits a {RoleGranted} event
  248. */
  249. function grantRole(uint64 roleId, address account, uint32 executionDelay) public virtual onlyAuthorized {
  250. _grantRole(roleId, account, getRoleGrantDelay(roleId), executionDelay);
  251. }
  252. /**
  253. * @dev Remove an account from a role, with immediate effect. If the account does not have the role, this call has
  254. * no effect.
  255. *
  256. * Requirements:
  257. *
  258. * - the caller must be an admin for the role (see {getRoleAdmin})
  259. *
  260. * Emits a {RoleRevoked} event if the account had the role.
  261. */
  262. function revokeRole(uint64 roleId, address account) public virtual onlyAuthorized {
  263. _revokeRole(roleId, account);
  264. }
  265. /**
  266. * @dev Renounce role permissions for the calling account, with immediate effect. If the sender is not in
  267. * the role, this call has no effect.
  268. *
  269. * Requirements:
  270. *
  271. * - the caller must be `callerConfirmation`.
  272. *
  273. * Emits a {RoleRevoked} event if the account had the role.
  274. */
  275. function renounceRole(uint64 roleId, address callerConfirmation) public virtual {
  276. if (callerConfirmation != _msgSender()) {
  277. revert AccessManagerBadConfirmation();
  278. }
  279. _revokeRole(roleId, callerConfirmation);
  280. }
  281. /**
  282. * @dev Change admin role for a given role.
  283. *
  284. * Requirements:
  285. *
  286. * - the caller must be a global admin
  287. *
  288. * Emits a {RoleAdminChanged} event
  289. */
  290. function setRoleAdmin(uint64 roleId, uint64 admin) public virtual onlyAuthorized {
  291. _setRoleAdmin(roleId, admin);
  292. }
  293. /**
  294. * @dev Change guardian role for a given role.
  295. *
  296. * Requirements:
  297. *
  298. * - the caller must be a global admin
  299. *
  300. * Emits a {RoleGuardianChanged} event
  301. */
  302. function setRoleGuardian(uint64 roleId, uint64 guardian) public virtual onlyAuthorized {
  303. _setRoleGuardian(roleId, guardian);
  304. }
  305. /**
  306. * @dev Update the delay for granting a `roleId`.
  307. *
  308. * Requirements:
  309. *
  310. * - the caller must be a global admin
  311. *
  312. * Emits a {RoleGrantDelayChanged} event.
  313. */
  314. function setGrantDelay(uint64 roleId, uint32 newDelay) public virtual onlyAuthorized {
  315. _setGrantDelay(roleId, newDelay);
  316. }
  317. /**
  318. * @dev Internal version of {grantRole} without access control. Returns true if the role was newly granted.
  319. *
  320. * Emits a {RoleGranted} event.
  321. */
  322. function _grantRole(
  323. uint64 roleId,
  324. address account,
  325. uint32 grantDelay,
  326. uint32 executionDelay
  327. ) internal virtual returns (bool) {
  328. if (roleId == PUBLIC_ROLE) {
  329. revert AccessManagerLockedRole(roleId);
  330. }
  331. bool newMember = _roles[roleId].members[account].since == 0;
  332. uint48 since;
  333. if (newMember) {
  334. since = Time.timestamp() + grantDelay;
  335. _roles[roleId].members[account] = Access({since: since, delay: executionDelay.toDelay()});
  336. } else {
  337. // No setback here. Value can be reset by doing revoke + grant, effectively allowing the admin to perform
  338. // any change to the execution delay within the duration of the role admin delay.
  339. (_roles[roleId].members[account].delay, since) = _roles[roleId].members[account].delay.withUpdate(
  340. executionDelay,
  341. 0
  342. );
  343. }
  344. emit RoleGranted(roleId, account, executionDelay, since, newMember);
  345. return newMember;
  346. }
  347. /**
  348. * @dev Internal version of {revokeRole} without access control. This logic is also used by {renounceRole}.
  349. * Returns true if the role was previously granted.
  350. *
  351. * Emits a {RoleRevoked} event if the account had the role.
  352. */
  353. function _revokeRole(uint64 roleId, address account) internal virtual returns (bool) {
  354. if (roleId == PUBLIC_ROLE) {
  355. revert AccessManagerLockedRole(roleId);
  356. }
  357. if (_roles[roleId].members[account].since == 0) {
  358. return false;
  359. }
  360. delete _roles[roleId].members[account];
  361. emit RoleRevoked(roleId, account);
  362. return true;
  363. }
  364. /**
  365. * @dev Internal version of {setRoleAdmin} without access control.
  366. *
  367. * Emits a {RoleAdminChanged} event
  368. */
  369. function _setRoleAdmin(uint64 roleId, uint64 admin) internal virtual {
  370. if (roleId == ADMIN_ROLE || roleId == PUBLIC_ROLE) {
  371. revert AccessManagerLockedRole(roleId);
  372. }
  373. _roles[roleId].admin = admin;
  374. emit RoleAdminChanged(roleId, admin);
  375. }
  376. /**
  377. * @dev Internal version of {setRoleGuardian} without access control.
  378. *
  379. * Emits a {RoleGuardianChanged} event
  380. */
  381. function _setRoleGuardian(uint64 roleId, uint64 guardian) internal virtual {
  382. if (roleId == ADMIN_ROLE || roleId == PUBLIC_ROLE) {
  383. revert AccessManagerLockedRole(roleId);
  384. }
  385. _roles[roleId].guardian = guardian;
  386. emit RoleGuardianChanged(roleId, guardian);
  387. }
  388. /**
  389. * @dev Internal version of {setGrantDelay} without access control.
  390. *
  391. * Emits a {RoleGrantDelayChanged} event
  392. */
  393. function _setGrantDelay(uint64 roleId, uint32 newDelay) internal virtual {
  394. if (roleId == PUBLIC_ROLE) {
  395. revert AccessManagerLockedRole(roleId);
  396. }
  397. uint48 effect;
  398. (_roles[roleId].grantDelay, effect) = _roles[roleId].grantDelay.withUpdate(newDelay, minSetback());
  399. emit RoleGrantDelayChanged(roleId, newDelay, effect);
  400. }
  401. // ============================================= FUNCTION MANAGEMENT ==============================================
  402. /**
  403. * @dev Set the role required to call functions identified by the `selectors` in the `target` contract.
  404. *
  405. * Requirements:
  406. *
  407. * - the caller must be a global admin
  408. *
  409. * Emits a {TargetFunctionRoleUpdated} event per selector.
  410. */
  411. function setTargetFunctionRole(
  412. address target,
  413. bytes4[] calldata selectors,
  414. uint64 roleId
  415. ) public virtual onlyAuthorized {
  416. for (uint256 i = 0; i < selectors.length; ++i) {
  417. _setTargetFunctionRole(target, selectors[i], roleId);
  418. }
  419. }
  420. /**
  421. * @dev Internal version of {setFunctionAllowedRole} without access control.
  422. *
  423. * Emits a {TargetFunctionRoleUpdated} event
  424. */
  425. function _setTargetFunctionRole(address target, bytes4 selector, uint64 roleId) internal virtual {
  426. _targets[target].allowedRoles[selector] = roleId;
  427. emit TargetFunctionRoleUpdated(target, selector, roleId);
  428. }
  429. /**
  430. * @dev Set the delay for changing the configuration of a given target contract.
  431. *
  432. * Requirements:
  433. *
  434. * - the caller must be a global admin
  435. *
  436. * Emits a {TargetAdminDelayUpdated} event per selector
  437. */
  438. function setTargetAdminDelay(address target, uint32 newDelay) public virtual onlyAuthorized {
  439. _setTargetAdminDelay(target, newDelay);
  440. }
  441. /**
  442. * @dev Internal version of {setTargetAdminDelay} without access control.
  443. *
  444. * Emits a {TargetAdminDelayUpdated} event
  445. */
  446. function _setTargetAdminDelay(address target, uint32 newDelay) internal virtual {
  447. uint48 effect;
  448. (_targets[target].adminDelay, effect) = _targets[target].adminDelay.withUpdate(newDelay, minSetback());
  449. emit TargetAdminDelayUpdated(target, newDelay, effect);
  450. }
  451. // =============================================== MODE MANAGEMENT ================================================
  452. /**
  453. * @dev Set the closed flag for a contract.
  454. *
  455. * Requirements:
  456. *
  457. * - the caller must be a global admin
  458. *
  459. * Emits a {TargetClosed} event.
  460. */
  461. function setTargetClosed(address target, bool closed) public virtual onlyAuthorized {
  462. _setTargetClosed(target, closed);
  463. }
  464. /**
  465. * @dev Set the closed flag for a contract. This is an internal setter with no access restrictions.
  466. *
  467. * Emits a {TargetClosed} event.
  468. */
  469. function _setTargetClosed(address target, bool closed) internal virtual {
  470. if (target == address(this)) {
  471. revert AccessManagerLockedAccount(target);
  472. }
  473. _targets[target].closed = closed;
  474. emit TargetClosed(target, closed);
  475. }
  476. // ============================================== DELAYED OPERATIONS ==============================================
  477. /**
  478. * @dev Return the timepoint at which a scheduled operation will be ready for execution. This returns 0 if the
  479. * operation is not yet scheduled, has expired, was executed, or was canceled.
  480. */
  481. function getSchedule(bytes32 id) public view virtual returns (uint48) {
  482. uint48 timepoint = _schedules[id].timepoint;
  483. return _isExpired(timepoint) ? 0 : timepoint;
  484. }
  485. /**
  486. * @dev Return the nonce for the latest scheduled operation with a given id. Returns 0 if the operation has never
  487. * been scheduled.
  488. */
  489. function getNonce(bytes32 id) public view virtual returns (uint32) {
  490. return _schedules[id].nonce;
  491. }
  492. /**
  493. * @dev Schedule a delayed operation for future execution, and return the operation identifier. It is possible to
  494. * choose the timestamp at which the operation becomes executable as long as it satisfies the execution delays
  495. * required for the caller. The special value zero will automatically set the earliest possible time.
  496. *
  497. * Returns the `operationId` that was scheduled. Since this value is a hash of the parameters, it can reoccur when
  498. * the same parameters are used; if this is relevant, the returned `nonce` can be used to uniquely identify this
  499. * scheduled operation from other occurrences of the same `operationId` in invocations of {execute} and {cancel}.
  500. *
  501. * Emits a {OperationScheduled} event.
  502. *
  503. * NOTE: It is not possible to concurrently schedule more than one operation with the same `target` and `data`. If
  504. * this is necessary, a random byte can be appended to `data` to act as a salt that will be ignored by the target
  505. * contract if it is using standard Solidity ABI encoding.
  506. */
  507. function schedule(
  508. address target,
  509. bytes calldata data,
  510. uint48 when
  511. ) public virtual returns (bytes32 operationId, uint32 nonce) {
  512. address caller = _msgSender();
  513. // Fetch restrictions that apply to the caller on the targeted function
  514. (bool immediate, uint32 setback) = _canCallExtended(caller, target, data);
  515. uint48 minWhen = Time.timestamp() + setback;
  516. // if call is not authorized, or if requested timing is too soon
  517. if ((!immediate && setback == 0) || (when > 0 && when < minWhen)) {
  518. revert AccessManagerUnauthorizedCall(caller, target, bytes4(data[0:4]));
  519. }
  520. // Reuse variable due to stack too deep
  521. when = uint48(Math.max(when, minWhen)); // cast is safe: both inputs are uint48
  522. // If caller is authorised, schedule operation
  523. operationId = hashOperation(caller, target, data);
  524. _checkNotScheduled(operationId);
  525. unchecked {
  526. // It's not feasible to overflow the nonce in less than 1000 years
  527. nonce = _schedules[operationId].nonce + 1;
  528. }
  529. _schedules[operationId].timepoint = when;
  530. _schedules[operationId].nonce = nonce;
  531. emit OperationScheduled(operationId, nonce, when, caller, target, data);
  532. // Using named return values because otherwise we get stack too deep
  533. }
  534. /**
  535. * @dev Reverts if the operation is currently scheduled and has not expired.
  536. * (Note: This function was introduced due to stack too deep errors in schedule.)
  537. */
  538. function _checkNotScheduled(bytes32 operationId) private view {
  539. uint48 prevTimepoint = _schedules[operationId].timepoint;
  540. if (prevTimepoint != 0 && !_isExpired(prevTimepoint)) {
  541. revert AccessManagerAlreadyScheduled(operationId);
  542. }
  543. }
  544. /**
  545. * @dev Execute a function that is delay restricted, provided it was properly scheduled beforehand, or the
  546. * execution delay is 0.
  547. *
  548. * Returns the nonce that identifies the previously scheduled operation that is executed, or 0 if the
  549. * operation wasn't previously scheduled (if the caller doesn't have an execution delay).
  550. *
  551. * Emits an {OperationExecuted} event only if the call was scheduled and delayed.
  552. */
  553. // Reentrancy is not an issue because permissions are checked on msg.sender. Additionally,
  554. // _consumeScheduledOp guarantees a scheduled operation is only executed once.
  555. // slither-disable-next-line reentrancy-no-eth
  556. function execute(address target, bytes calldata data) public payable virtual returns (uint32) {
  557. address caller = _msgSender();
  558. // Fetch restrictions that apply to the caller on the targeted function
  559. (bool immediate, uint32 setback) = _canCallExtended(caller, target, data);
  560. // If caller is not authorised, revert
  561. if (!immediate && setback == 0) {
  562. revert AccessManagerUnauthorizedCall(caller, target, bytes4(data));
  563. }
  564. // If caller is authorised, check operation was scheduled early enough
  565. bytes32 operationId = hashOperation(caller, target, data);
  566. uint32 nonce;
  567. if (setback != 0) {
  568. nonce = _consumeScheduledOp(operationId);
  569. }
  570. // Mark the target and selector as authorised
  571. bytes32 executionIdBefore = _executionId;
  572. _executionId = _hashExecutionId(target, bytes4(data));
  573. // Perform call
  574. Address.functionCallWithValue(target, data, msg.value);
  575. // Reset execute identifier
  576. _executionId = executionIdBefore;
  577. return nonce;
  578. }
  579. /**
  580. * @dev Consume a scheduled operation targeting the caller. If such an operation exists, mark it as consumed
  581. * (emit an {OperationExecuted} event and clean the state). Otherwise, throw an error.
  582. *
  583. * This is useful for contract that want to enforce that calls targeting them were scheduled on the manager,
  584. * with all the verifications that it implies.
  585. *
  586. * Emit a {OperationExecuted} event
  587. */
  588. function consumeScheduledOp(address caller, bytes calldata data) public virtual {
  589. address target = _msgSender();
  590. if (IAccessManaged(target).isConsumingScheduledOp() != IAccessManaged.isConsumingScheduledOp.selector) {
  591. revert AccessManagerUnauthorizedConsume(target);
  592. }
  593. _consumeScheduledOp(hashOperation(caller, target, data));
  594. }
  595. /**
  596. * @dev Internal variant of {consumeScheduledOp} that operates on bytes32 operationId.
  597. *
  598. * Returns the nonce of the scheduled operation that is consumed.
  599. */
  600. function _consumeScheduledOp(bytes32 operationId) internal virtual returns (uint32) {
  601. uint48 timepoint = _schedules[operationId].timepoint;
  602. uint32 nonce = _schedules[operationId].nonce;
  603. if (timepoint == 0) {
  604. revert AccessManagerNotScheduled(operationId);
  605. } else if (timepoint > Time.timestamp()) {
  606. revert AccessManagerNotReady(operationId);
  607. } else if (_isExpired(timepoint)) {
  608. revert AccessManagerExpired(operationId);
  609. }
  610. delete _schedules[operationId].timepoint; // reset the timepoint, keep the nonce
  611. emit OperationExecuted(operationId, nonce);
  612. return nonce;
  613. }
  614. /**
  615. * @dev Cancel a scheduled (delayed) operation. Returns the nonce that identifies the previously scheduled
  616. * operation that is cancelled.
  617. *
  618. * Requirements:
  619. *
  620. * - the caller must be the proposer, a guardian of the targeted function, or a global admin
  621. *
  622. * Emits a {OperationCanceled} event.
  623. */
  624. function cancel(address caller, address target, bytes calldata data) public virtual returns (uint32) {
  625. address msgsender = _msgSender();
  626. bytes4 selector = bytes4(data[0:4]);
  627. bytes32 operationId = hashOperation(caller, target, data);
  628. if (_schedules[operationId].timepoint == 0) {
  629. revert AccessManagerNotScheduled(operationId);
  630. } else if (caller != msgsender) {
  631. // calls can only be canceled by the account that scheduled them, a global admin, or by a guardian of the required role.
  632. (bool isAdmin, ) = hasRole(ADMIN_ROLE, msgsender);
  633. (bool isGuardian, ) = hasRole(getRoleGuardian(getTargetFunctionRole(target, selector)), msgsender);
  634. if (!isAdmin && !isGuardian) {
  635. revert AccessManagerUnauthorizedCancel(msgsender, caller, target, selector);
  636. }
  637. }
  638. delete _schedules[operationId].timepoint; // reset the timepoint, keep the nonce
  639. uint32 nonce = _schedules[operationId].nonce;
  640. emit OperationCanceled(operationId, nonce);
  641. return nonce;
  642. }
  643. /**
  644. * @dev Hashing function for delayed operations
  645. */
  646. function hashOperation(address caller, address target, bytes calldata data) public view virtual returns (bytes32) {
  647. return keccak256(abi.encode(caller, target, data));
  648. }
  649. /**
  650. * @dev Hashing function for execute protection
  651. */
  652. function _hashExecutionId(address target, bytes4 selector) private pure returns (bytes32) {
  653. return keccak256(abi.encode(target, selector));
  654. }
  655. // ==================================================== OTHERS ====================================================
  656. /**
  657. * @dev Change the AccessManager instance used by a contract that correctly uses this instance.
  658. *
  659. * Requirements:
  660. *
  661. * - the caller must be a global admin
  662. */
  663. function updateAuthority(address target, address newAuthority) public virtual onlyAuthorized {
  664. IAccessManaged(target).setAuthority(newAuthority);
  665. }
  666. // ================================================= ADMIN LOGIC ==================================================
  667. /**
  668. * @dev Check if the current call is authorized according to admin logic.
  669. */
  670. function _checkAuthorized() private {
  671. address caller = _msgSender();
  672. (bool immediate, uint32 delay) = _canCallSelf(caller, _msgData());
  673. if (!immediate) {
  674. if (delay == 0) {
  675. (, uint64 requiredRole, ) = _getAdminRestrictions(_msgData());
  676. revert AccessManagerUnauthorizedAccount(caller, requiredRole);
  677. } else {
  678. _consumeScheduledOp(hashOperation(caller, address(this), _msgData()));
  679. }
  680. }
  681. }
  682. /**
  683. * @dev Get the admin restrictions of a given function call based on the function and arguments involved.
  684. *
  685. * Returns:
  686. * - bool restricted: does this data match a restricted operation
  687. * - uint64: which role is this operation restricted to
  688. * - uint32: minimum delay to enforce for that operation (on top of the admin's execution delay)
  689. */
  690. function _getAdminRestrictions(bytes calldata data) private view returns (bool, uint64, uint32) {
  691. bytes4 selector = bytes4(data);
  692. if (data.length < 4) {
  693. return (false, 0, 0);
  694. }
  695. // Restricted to ADMIN with no delay beside any execution delay the caller may have
  696. if (
  697. selector == this.labelRole.selector ||
  698. selector == this.setRoleAdmin.selector ||
  699. selector == this.setRoleGuardian.selector ||
  700. selector == this.setGrantDelay.selector ||
  701. selector == this.setTargetAdminDelay.selector
  702. ) {
  703. return (true, ADMIN_ROLE, 0);
  704. }
  705. // Restricted to ADMIN with the admin delay corresponding to the target
  706. if (
  707. selector == this.updateAuthority.selector ||
  708. selector == this.setTargetClosed.selector ||
  709. selector == this.setTargetFunctionRole.selector
  710. ) {
  711. // First argument is a target.
  712. address target = abi.decode(data[0x04:0x24], (address));
  713. uint32 delay = getTargetAdminDelay(target);
  714. return (true, ADMIN_ROLE, delay);
  715. }
  716. // Restricted to that role's admin with no delay beside any execution delay the caller may have.
  717. if (selector == this.grantRole.selector || selector == this.revokeRole.selector) {
  718. // First argument is a roleId.
  719. uint64 roleId = abi.decode(data[0x04:0x24], (uint64));
  720. uint64 roleAdminId = getRoleAdmin(roleId);
  721. return (true, roleAdminId, 0);
  722. }
  723. return (false, 0, 0);
  724. }
  725. // =================================================== HELPERS ====================================================
  726. /**
  727. * @dev An extended version of {canCall} for internal use that considers restrictions for admin functions.
  728. *
  729. * Returns:
  730. * - bool immediate: whether the operation can be executed immediately (with no delay)
  731. * - uint32 delay: the execution delay
  732. *
  733. * If immediate is true, the delay can be disregarded and the operation can be immediately executed.
  734. * If immediate is false, the operation can be executed if and only if delay is greater than 0.
  735. */
  736. function _canCallExtended(address caller, address target, bytes calldata data) private view returns (bool, uint32) {
  737. if (target == address(this)) {
  738. return _canCallSelf(caller, data);
  739. } else {
  740. bytes4 selector = bytes4(data);
  741. return canCall(caller, target, selector);
  742. }
  743. }
  744. /**
  745. * @dev A version of {canCall} that checks for admin restrictions in this contract.
  746. */
  747. function _canCallSelf(address caller, bytes calldata data) private view returns (bool immediate, uint32 delay) {
  748. if (caller == address(this)) {
  749. // Caller is AccessManager, this means the call was sent through {execute} and it already checked
  750. // permissions. We verify that the call "identifier", which is set during {execute}, is correct.
  751. return (_isExecuting(address(this), bytes4(data)), 0);
  752. }
  753. (bool enabled, uint64 roleId, uint32 operationDelay) = _getAdminRestrictions(data);
  754. if (!enabled) {
  755. return (false, 0);
  756. }
  757. (bool inRole, uint32 executionDelay) = hasRole(roleId, caller);
  758. if (!inRole) {
  759. return (false, 0);
  760. }
  761. // downcast is safe because both options are uint32
  762. delay = uint32(Math.max(operationDelay, executionDelay));
  763. return (delay == 0, delay);
  764. }
  765. /**
  766. * @dev Returns true if a call with `target` and `selector` is being executed via {executed}.
  767. */
  768. function _isExecuting(address target, bytes4 selector) private view returns (bool) {
  769. return _executionId == _hashExecutionId(target, selector);
  770. }
  771. /**
  772. * @dev Returns true if a schedule timepoint is past its expiration deadline.
  773. */
  774. function _isExpired(uint48 timepoint) private view returns (bool) {
  775. return timepoint + expiration() <= Time.timestamp();
  776. }
  777. }