AccessManager.sol 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850
  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 (_executionId == _hashExecutionId(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 permission level (role) required to call a function. This only applies for contract that are
  154. * operating under the `Custom` mode.
  155. */
  156. function getTargetFunctionRole(address target, bytes4 selector) public view virtual returns (uint64) {
  157. return _targets[target].allowedRoles[selector];
  158. }
  159. function getTargetAdminDelay(address target) public view virtual returns (uint32) {
  160. return _targets[target].adminDelay.get();
  161. }
  162. /**
  163. * @dev Get the id of the role that acts as an admin for given role.
  164. *
  165. * The admin permission is required to grant the role, revoke the role and update the execution delay to execute
  166. * an operation that is restricted to this role.
  167. */
  168. function getRoleAdmin(uint64 roleId) public view virtual returns (uint64) {
  169. return _roles[roleId].admin;
  170. }
  171. /**
  172. * @dev Get the role that acts as a guardian for a given role.
  173. *
  174. * The guardian permission allows canceling operations that have been scheduled under the role.
  175. */
  176. function getRoleGuardian(uint64 roleId) public view virtual returns (uint64) {
  177. return _roles[roleId].guardian;
  178. }
  179. /**
  180. * @dev Get the role current grant delay, that value may change at any point, without an event emitted, following
  181. * a call to {setGrantDelay}. Changes to this value, including effect timepoint are notified by the
  182. * {RoleGrantDelayChanged} event.
  183. */
  184. function getRoleGrantDelay(uint64 roleId) public view virtual returns (uint32) {
  185. return _roles[roleId].grantDelay.get();
  186. }
  187. /**
  188. * @dev Get the access details for a given account in a given role. These details include the timepoint at which
  189. * membership becomes active, and the delay applied to all operation by this user that requires this permission
  190. * level.
  191. *
  192. * Returns:
  193. * [0] Timestamp at which the account membership becomes valid. 0 means role is not granted.
  194. * [1] Current execution delay for the account.
  195. * [2] Pending execution delay for the account.
  196. * [3] Timestamp at which the pending execution delay will become active. 0 means no delay update is scheduled.
  197. */
  198. function getAccess(uint64 roleId, address account) public view virtual returns (uint48, uint32, uint32, uint48) {
  199. Access storage access = _roles[roleId].members[account];
  200. uint48 since = access.since;
  201. (uint32 currentDelay, uint32 pendingDelay, uint48 effect) = access.delay.getFull();
  202. return (since, currentDelay, pendingDelay, effect);
  203. }
  204. /**
  205. * @dev Check if a given account currently had the permission level corresponding to a given role. Note that this
  206. * permission might be associated with a delay. {getAccess} can provide more details.
  207. */
  208. function hasRole(uint64 roleId, address account) public view virtual returns (bool, uint32) {
  209. if (roleId == PUBLIC_ROLE) {
  210. return (true, 0);
  211. } else {
  212. (uint48 hasRoleSince, uint32 currentDelay, , ) = getAccess(roleId, account);
  213. return (hasRoleSince != 0 && hasRoleSince <= Time.timestamp(), currentDelay);
  214. }
  215. }
  216. // =============================================== ROLE MANAGEMENT ===============================================
  217. /**
  218. * @dev Give a label to a role, for improved role discoverabily by UIs.
  219. *
  220. * Emits a {RoleLabel} event.
  221. */
  222. function labelRole(uint64 roleId, string calldata label) public virtual onlyAuthorized {
  223. if (roleId == ADMIN_ROLE || roleId == PUBLIC_ROLE) {
  224. revert AccessManagerLockedRole(roleId);
  225. }
  226. emit RoleLabel(roleId, label);
  227. }
  228. /**
  229. * @dev Add `account` to `roleId`, or change its execution delay.
  230. *
  231. * This gives the account the authorization to call any function that is restricted to this role. An optional
  232. * execution delay (in seconds) can be set. If that delay is non 0, the user is required to schedule any operation
  233. * that is restricted to members this role. The user will only be able to execute the operation after the delay has
  234. * passed, before it has expired. During this period, admin and guardians can cancel the operation (see {cancel}).
  235. *
  236. * If the account has already been granted this role, the execution delay will be updated. This update is not
  237. * immediate and follows the delay rules. For example, If a user currently has a delay of 3 hours, and this is
  238. * called to reduce that delay to 1 hour, the new delay will take some time to take effect, enforcing that any
  239. * operation executed in the 3 hours that follows this update was indeed scheduled before this update.
  240. *
  241. * Requirements:
  242. *
  243. * - the caller must be in the role's admins
  244. *
  245. * Emits a {RoleGranted} event
  246. */
  247. function grantRole(uint64 roleId, address account, uint32 executionDelay) public virtual onlyAuthorized {
  248. _grantRole(roleId, account, getRoleGrantDelay(roleId), executionDelay);
  249. }
  250. /**
  251. * @dev Remove an account for a role, with immediate effect. If the sender is not in the role, this call has no
  252. * effect.
  253. *
  254. * Requirements:
  255. *
  256. * - the caller must be in the role's admins
  257. *
  258. * Emits a {RoleRevoked} event
  259. */
  260. function revokeRole(uint64 roleId, address account) public virtual onlyAuthorized {
  261. _revokeRole(roleId, account);
  262. }
  263. /**
  264. * @dev Renounce role permissions for the calling account, with immediate effect. If the sender is not in
  265. * the role, this call has no effect.
  266. *
  267. * Requirements:
  268. *
  269. * - the caller must be `callerConfirmation`.
  270. *
  271. * Emits a {RoleRevoked} event
  272. */
  273. function renounceRole(uint64 roleId, address callerConfirmation) public virtual {
  274. if (callerConfirmation != _msgSender()) {
  275. revert AccessManagerBadConfirmation();
  276. }
  277. _revokeRole(roleId, callerConfirmation);
  278. }
  279. /**
  280. * @dev Change admin role for a given role.
  281. *
  282. * Requirements:
  283. *
  284. * - the caller must be a global admin
  285. *
  286. * Emits a {RoleAdminChanged} event
  287. */
  288. function setRoleAdmin(uint64 roleId, uint64 admin) public virtual onlyAuthorized {
  289. _setRoleAdmin(roleId, admin);
  290. }
  291. /**
  292. * @dev Change guardian role for a given role.
  293. *
  294. * Requirements:
  295. *
  296. * - the caller must be a global admin
  297. *
  298. * Emits a {RoleGuardianChanged} event
  299. */
  300. function setRoleGuardian(uint64 roleId, uint64 guardian) public virtual onlyAuthorized {
  301. _setRoleGuardian(roleId, guardian);
  302. }
  303. /**
  304. * @dev Update the delay for granting a `roleId`.
  305. *
  306. * Requirements:
  307. *
  308. * - the caller must be a global admin
  309. *
  310. * Emits a {RoleGrantDelayChanged} event
  311. */
  312. function setGrantDelay(uint64 roleId, uint32 newDelay) public virtual onlyAuthorized {
  313. _setGrantDelay(roleId, newDelay);
  314. }
  315. /**
  316. * @dev Internal version of {grantRole} without access control. Returns true if the role was newly granted.
  317. *
  318. * Emits a {RoleGranted} event
  319. */
  320. function _grantRole(
  321. uint64 roleId,
  322. address account,
  323. uint32 grantDelay,
  324. uint32 executionDelay
  325. ) internal virtual returns (bool) {
  326. if (roleId == PUBLIC_ROLE) {
  327. revert AccessManagerLockedRole(roleId);
  328. }
  329. bool newMember = _roles[roleId].members[account].since == 0;
  330. uint48 since;
  331. if (newMember) {
  332. since = Time.timestamp() + grantDelay;
  333. _roles[roleId].members[account] = Access({since: since, delay: executionDelay.toDelay()});
  334. } else {
  335. // No setback here. Value can be reset by doing revoke + grant, effectively allowing the admin to perform
  336. // any change to the execution delay within the duration of the role admin delay.
  337. (_roles[roleId].members[account].delay, since) = _roles[roleId].members[account].delay.withUpdate(
  338. executionDelay,
  339. 0
  340. );
  341. }
  342. emit RoleGranted(roleId, account, executionDelay, since, newMember);
  343. return newMember;
  344. }
  345. /**
  346. * @dev Internal version of {revokeRole} without access control. This logic is also used by {renounceRole}.
  347. * Returns true if the role was previously granted.
  348. *
  349. * Emits a {RoleRevoked} event
  350. */
  351. function _revokeRole(uint64 roleId, address account) internal virtual returns (bool) {
  352. if (roleId == PUBLIC_ROLE) {
  353. revert AccessManagerLockedRole(roleId);
  354. }
  355. if (_roles[roleId].members[account].since == 0) {
  356. return false;
  357. }
  358. delete _roles[roleId].members[account];
  359. emit RoleRevoked(roleId, account);
  360. return true;
  361. }
  362. /**
  363. * @dev Internal version of {setRoleAdmin} without access control.
  364. *
  365. * Emits a {RoleAdminChanged} event
  366. */
  367. function _setRoleAdmin(uint64 roleId, uint64 admin) internal virtual {
  368. if (roleId == ADMIN_ROLE || roleId == PUBLIC_ROLE) {
  369. revert AccessManagerLockedRole(roleId);
  370. }
  371. _roles[roleId].admin = admin;
  372. emit RoleAdminChanged(roleId, admin);
  373. }
  374. /**
  375. * @dev Internal version of {setRoleGuardian} without access control.
  376. *
  377. * Emits a {RoleGuardianChanged} event
  378. */
  379. function _setRoleGuardian(uint64 roleId, uint64 guardian) internal virtual {
  380. if (roleId == ADMIN_ROLE || roleId == PUBLIC_ROLE) {
  381. revert AccessManagerLockedRole(roleId);
  382. }
  383. _roles[roleId].guardian = guardian;
  384. emit RoleGuardianChanged(roleId, guardian);
  385. }
  386. /**
  387. * @dev Internal version of {setGrantDelay} without access control.
  388. *
  389. * Emits a {RoleGrantDelayChanged} event
  390. */
  391. function _setGrantDelay(uint64 roleId, uint32 newDelay) internal virtual {
  392. if (roleId == PUBLIC_ROLE) {
  393. revert AccessManagerLockedRole(roleId);
  394. }
  395. uint48 effect;
  396. (_roles[roleId].grantDelay, effect) = _roles[roleId].grantDelay.withUpdate(newDelay, minSetback());
  397. emit RoleGrantDelayChanged(roleId, newDelay, effect);
  398. }
  399. // ============================================= FUNCTION MANAGEMENT ==============================================
  400. /**
  401. * @dev Set the level of permission (`role`) required to call functions identified by the `selectors` in the
  402. * `target` contract.
  403. *
  404. * Requirements:
  405. *
  406. * - the caller must be a global admin
  407. *
  408. * Emits a {TargetFunctionRoleUpdated} event per selector
  409. */
  410. function setTargetFunctionRole(
  411. address target,
  412. bytes4[] calldata selectors,
  413. uint64 roleId
  414. ) public virtual onlyAuthorized {
  415. for (uint256 i = 0; i < selectors.length; ++i) {
  416. _setTargetFunctionRole(target, selectors[i], roleId);
  417. }
  418. }
  419. /**
  420. * @dev Internal version of {setFunctionAllowedRole} without access control.
  421. *
  422. * Emits a {TargetFunctionRoleUpdated} event
  423. */
  424. function _setTargetFunctionRole(address target, bytes4 selector, uint64 roleId) internal virtual {
  425. _targets[target].allowedRoles[selector] = roleId;
  426. emit TargetFunctionRoleUpdated(target, selector, roleId);
  427. }
  428. /**
  429. * @dev Set the delay for management operations on a given target contract.
  430. *
  431. * Requirements:
  432. *
  433. * - the caller must be a global admin
  434. *
  435. * Emits a {TargetAdminDelayUpdated} event per selector
  436. */
  437. function setTargetAdminDelay(address target, uint32 newDelay) public virtual onlyAuthorized {
  438. _setTargetAdminDelay(target, newDelay);
  439. }
  440. /**
  441. * @dev Internal version of {setTargetAdminDelay} without access control.
  442. *
  443. * Emits a {TargetAdminDelayUpdated} event
  444. */
  445. function _setTargetAdminDelay(address target, uint32 newDelay) internal virtual {
  446. uint48 effect;
  447. (_targets[target].adminDelay, effect) = _targets[target].adminDelay.withUpdate(newDelay, minSetback());
  448. emit TargetAdminDelayUpdated(target, newDelay, effect);
  449. }
  450. // =============================================== MODE MANAGEMENT ================================================
  451. /**
  452. * @dev Set the closed flag for a contract.
  453. *
  454. * Requirements:
  455. *
  456. * - the caller must be a global admin
  457. *
  458. * Emits a {TargetClosed} event.
  459. */
  460. function setTargetClosed(address target, bool closed) public virtual onlyAuthorized {
  461. _setTargetClosed(target, closed);
  462. }
  463. /**
  464. * @dev Set the closed flag for a contract. This is an internal setter with no access restrictions.
  465. *
  466. * Emits a {TargetClosed} event.
  467. */
  468. function _setTargetClosed(address target, bool closed) internal virtual {
  469. if (target == address(this)) {
  470. revert AccessManagerLockedAccount(target);
  471. }
  472. _targets[target].closed = closed;
  473. emit TargetClosed(target, closed);
  474. }
  475. // ============================================== DELAYED OPERATIONS ==============================================
  476. /**
  477. * @dev Return the timepoint at which a scheduled operation will be ready for execution. This returns 0 if the
  478. * operation is not yet scheduled, has expired, was executed, or was canceled.
  479. */
  480. function getSchedule(bytes32 id) public view virtual returns (uint48) {
  481. uint48 timepoint = _schedules[id].timepoint;
  482. return _isExpired(timepoint) ? 0 : timepoint;
  483. }
  484. /**
  485. * @dev Return the nonce for the latest scheduled operation with a given id. Returns 0 if the operation has never
  486. * been scheduled.
  487. */
  488. function getNonce(bytes32 id) public view virtual returns (uint32) {
  489. return _schedules[id].nonce;
  490. }
  491. /**
  492. * @dev Schedule a delayed operation for future execution, and return the operation identifier. It is possible to
  493. * choose the timestamp at which the operation becomes executable as long as it satisfies the execution delays
  494. * required for the caller. The special value zero will automatically set the earliest possible time.
  495. *
  496. * Returns the `operationId` that was scheduled. Since this value is a hash of the parameters, it can reoccur when
  497. * the same parameters are used; if this is relevant, the returned `nonce` can be used to uniquely identify this
  498. * scheduled operation from other occurrences of the same `operationId` in invocations of {execute} and {cancel}.
  499. *
  500. * Emits a {OperationScheduled} event.
  501. */
  502. function schedule(
  503. address target,
  504. bytes calldata data,
  505. uint48 when
  506. ) public virtual returns (bytes32 operationId, uint32 nonce) {
  507. address caller = _msgSender();
  508. // Fetch restrictions that apply to the caller on the targeted function
  509. (bool immediate, uint32 setback) = _canCallExtended(caller, target, data);
  510. uint48 minWhen = Time.timestamp() + setback;
  511. if (when == 0) {
  512. when = minWhen;
  513. }
  514. // If caller is not authorised, revert
  515. if (!immediate && (setback == 0 || when < minWhen)) {
  516. revert AccessManagerUnauthorizedCall(caller, target, bytes4(data[0:4]));
  517. }
  518. // If caller is authorised, schedule operation
  519. operationId = _hashOperation(caller, target, data);
  520. // Cannot reschedule unless the operation has expired
  521. uint48 prevTimepoint = _schedules[operationId].timepoint;
  522. if (prevTimepoint != 0 && !_isExpired(prevTimepoint)) {
  523. revert AccessManagerAlreadyScheduled(operationId);
  524. }
  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 Execute a function that is delay restricted, provided it was properly scheduled beforehand, or the
  536. * execution delay is 0.
  537. *
  538. * Returns the nonce that identifies the previously scheduled operation that is executed, or 0 if the
  539. * operation wasn't previously scheduled (if the caller doesn't have an execution delay).
  540. *
  541. * Emits an {OperationExecuted} event only if the call was scheduled and delayed.
  542. */
  543. // Reentrancy is not an issue because permissions are checked on msg.sender. Additionally,
  544. // _consumeScheduledOp guarantees a scheduled operation is only executed once.
  545. // slither-disable-next-line reentrancy-no-eth
  546. function execute(address target, bytes calldata data) public payable virtual returns (uint32) {
  547. address caller = _msgSender();
  548. // Fetch restrictions that apply to the caller on the targeted function
  549. (bool immediate, uint32 setback) = _canCallExtended(caller, target, data);
  550. // If caller is not authorised, revert
  551. if (!immediate && setback == 0) {
  552. revert AccessManagerUnauthorizedCall(caller, target, bytes4(data));
  553. }
  554. // If caller is authorised, check operation was scheduled early enough
  555. bytes32 operationId = _hashOperation(caller, target, data);
  556. uint32 nonce;
  557. if (setback != 0) {
  558. nonce = _consumeScheduledOp(operationId);
  559. }
  560. // Mark the target and selector as authorised
  561. bytes32 executionIdBefore = _executionId;
  562. _executionId = _hashExecutionId(target, bytes4(data));
  563. // Perform call
  564. Address.functionCallWithValue(target, data, msg.value);
  565. // Reset execute identifier
  566. _executionId = executionIdBefore;
  567. return nonce;
  568. }
  569. /**
  570. * @dev Consume a scheduled operation targeting the caller. If such an operation exists, mark it as consumed
  571. * (emit an {OperationExecuted} event and clean the state). Otherwise, throw an error.
  572. *
  573. * This is useful for contract that want to enforce that calls targeting them were scheduled on the manager,
  574. * with all the verifications that it implies.
  575. *
  576. * Emit a {OperationExecuted} event
  577. */
  578. function consumeScheduledOp(address caller, bytes calldata data) public virtual {
  579. address target = _msgSender();
  580. if (IAccessManaged(target).isConsumingScheduledOp() != IAccessManaged.isConsumingScheduledOp.selector) {
  581. revert AccessManagerUnauthorizedConsume(target);
  582. }
  583. _consumeScheduledOp(_hashOperation(caller, target, data));
  584. }
  585. /**
  586. * @dev Internal variant of {consumeScheduledOp} that operates on bytes32 operationId.
  587. *
  588. * Returns the nonce of the scheduled operation that is consumed.
  589. */
  590. function _consumeScheduledOp(bytes32 operationId) internal virtual returns (uint32) {
  591. uint48 timepoint = _schedules[operationId].timepoint;
  592. uint32 nonce = _schedules[operationId].nonce;
  593. if (timepoint == 0) {
  594. revert AccessManagerNotScheduled(operationId);
  595. } else if (timepoint > Time.timestamp()) {
  596. revert AccessManagerNotReady(operationId);
  597. } else if (_isExpired(timepoint)) {
  598. revert AccessManagerExpired(operationId);
  599. }
  600. delete _schedules[operationId];
  601. emit OperationExecuted(operationId, nonce);
  602. return nonce;
  603. }
  604. /**
  605. * @dev Cancel a scheduled (delayed) operation. Returns the nonce that identifies the previously scheduled
  606. * operation that is cancelled.
  607. *
  608. * Requirements:
  609. *
  610. * - the caller must be the proposer, a guardian of the targeted function, or a global admin
  611. *
  612. * Emits a {OperationCanceled} event.
  613. */
  614. function cancel(address caller, address target, bytes calldata data) public virtual returns (uint32) {
  615. address msgsender = _msgSender();
  616. bytes4 selector = bytes4(data[0:4]);
  617. bytes32 operationId = _hashOperation(caller, target, data);
  618. if (_schedules[operationId].timepoint == 0) {
  619. revert AccessManagerNotScheduled(operationId);
  620. } else if (caller != msgsender) {
  621. // calls can only be canceled by the account that scheduled them, a global admin, or by a guardian of the required role.
  622. (bool isAdmin, ) = hasRole(ADMIN_ROLE, msgsender);
  623. (bool isGuardian, ) = hasRole(getRoleGuardian(getTargetFunctionRole(target, selector)), msgsender);
  624. if (!isAdmin && !isGuardian) {
  625. revert AccessManagerUnauthorizedCancel(msgsender, caller, target, selector);
  626. }
  627. }
  628. delete _schedules[operationId].timepoint;
  629. uint32 nonce = _schedules[operationId].nonce;
  630. emit OperationCanceled(operationId, nonce);
  631. return nonce;
  632. }
  633. /**
  634. * @dev Hashing function for delayed operations
  635. */
  636. function _hashOperation(address caller, address target, bytes calldata data) private pure returns (bytes32) {
  637. return keccak256(abi.encode(caller, target, data));
  638. }
  639. /**
  640. * @dev Hashing function for execute protection
  641. */
  642. function _hashExecutionId(address target, bytes4 selector) private pure returns (bytes32) {
  643. return keccak256(abi.encode(target, selector));
  644. }
  645. // ==================================================== OTHERS ====================================================
  646. /**
  647. * @dev Change the AccessManager instance used by a contract that correctly uses this instance.
  648. *
  649. * Requirements:
  650. *
  651. * - the caller must be a global admin
  652. */
  653. function updateAuthority(address target, address newAuthority) public virtual onlyAuthorized {
  654. IAccessManaged(target).setAuthority(newAuthority);
  655. }
  656. // ================================================= ADMIN LOGIC ==================================================
  657. /**
  658. * @dev Check if the current call is authorized according to admin logic.
  659. */
  660. function _checkAuthorized() private {
  661. address caller = _msgSender();
  662. (bool immediate, uint32 delay) = _canCallExtended(caller, address(this), _msgData());
  663. if (!immediate) {
  664. if (delay == 0) {
  665. (, uint64 requiredRole, ) = _getAdminRestrictions(_msgData());
  666. revert AccessManagerUnauthorizedAccount(caller, requiredRole);
  667. } else {
  668. _consumeScheduledOp(_hashOperation(caller, address(this), _msgData()));
  669. }
  670. }
  671. }
  672. /**
  673. * @dev Get the admin restrictions of a given function call based on the function and arguments involved.
  674. *
  675. * Returns:
  676. * - bool restricted: does this data match a restricted operation
  677. * - uint64: which role is this operation restricted to
  678. * - uint32: minimum delay to enforce for that operation (on top of the admin's execution delay)
  679. */
  680. function _getAdminRestrictions(bytes calldata data) private view returns (bool, uint64, uint32) {
  681. bytes4 selector = bytes4(data);
  682. if (data.length < 4) {
  683. return (false, 0, 0);
  684. }
  685. // Restricted to ADMIN with no delay beside any execution delay the caller may have
  686. if (
  687. selector == this.labelRole.selector ||
  688. selector == this.setRoleAdmin.selector ||
  689. selector == this.setRoleGuardian.selector ||
  690. selector == this.setGrantDelay.selector ||
  691. selector == this.setTargetAdminDelay.selector
  692. ) {
  693. return (true, ADMIN_ROLE, 0);
  694. }
  695. // Restricted to ADMIN with the admin delay corresponding to the target
  696. if (
  697. selector == this.updateAuthority.selector ||
  698. selector == this.setTargetClosed.selector ||
  699. selector == this.setTargetFunctionRole.selector
  700. ) {
  701. // First argument is a target.
  702. address target = abi.decode(data[0x04:0x24], (address));
  703. uint32 delay = getTargetAdminDelay(target);
  704. return (true, ADMIN_ROLE, delay);
  705. }
  706. // Restricted to that role's admin with no delay beside any execution delay the caller may have.
  707. if (selector == this.grantRole.selector || selector == this.revokeRole.selector) {
  708. // First argument is a roleId.
  709. uint64 roleId = abi.decode(data[0x04:0x24], (uint64));
  710. uint64 roleAdminId = getRoleAdmin(roleId);
  711. return (true, roleAdminId, 0);
  712. }
  713. return (false, 0, 0);
  714. }
  715. // =================================================== HELPERS ====================================================
  716. /**
  717. * @dev An extended version of {canCall} for internal use that considers restrictions for admin functions.
  718. *
  719. * Returns:
  720. * - bool immediate: whether the operation can be executed immediately (with no delay)
  721. * - uint32 delay: the execution delay
  722. *
  723. * If immediate is true, the delay can be disregarded and the operation can be immediately executed.
  724. * If immediate is false, the operation can be executed if and only if delay is greater than 0.
  725. */
  726. function _canCallExtended(address caller, address target, bytes calldata data) private view returns (bool, uint32) {
  727. if (target == address(this)) {
  728. (bool enabled, uint64 roleId, uint32 operationDelay) = _getAdminRestrictions(data);
  729. if (!enabled) {
  730. return (false, 0);
  731. }
  732. (bool inRole, uint32 executionDelay) = hasRole(roleId, caller);
  733. if (!inRole) {
  734. return (false, 0);
  735. }
  736. // downcast is safe because both options are uint32
  737. uint32 delay = uint32(Math.max(operationDelay, executionDelay));
  738. return (delay == 0, delay);
  739. } else {
  740. bytes4 selector = bytes4(data);
  741. return canCall(caller, target, selector);
  742. }
  743. }
  744. /**
  745. * @dev Returns true if a schedule timepoint is past its expiration deadline.
  746. */
  747. function _isExpired(uint48 timepoint) private view returns (bool) {
  748. return timepoint + expiration() <= Time.timestamp();
  749. }
  750. }