AccessManager.sol 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873
  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 "groups".
  16. *
  17. * An AccessManager instance will define a set of groups. Accounts can be added into any number of these groups. 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 {setFunctionAllowedGroup}.
  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 group defined by default named "public" which all accounts automatically have.
  26. *
  27. * Contracts where functions are mapped to groups are said to be in a "custom" mode, but contracts can also be
  28. * configured in two special modes: 1) the "open" mode, where all functions are allowed to the "public" group, and 2)
  29. * the "closed" mode, where no function is allowed to any group.
  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 {relay} 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. struct AccessMode {
  51. uint64 classId;
  52. bool closed;
  53. }
  54. // Structure that stores the details for a group/account pair. This structures fit into a single slot.
  55. struct Access {
  56. // Timepoint at which the user gets the permission. If this is either 0, or in the future, the group permission
  57. // are not available. Should be checked using {Time-isSetAndPast}
  58. uint48 since;
  59. // delay for execution. Only applies to restricted() / relay() calls. This does not restrict access to
  60. // functions that use the `onlyGroup` modifier.
  61. Time.Delay delay;
  62. }
  63. // Structure that stores the details of a group, including:
  64. // - the members of the group
  65. // - the admin group (that can grant or revoke permissions)
  66. // - the guardian group (that can cancel operations targeting functions that need this group
  67. // - the grand delay
  68. struct Group {
  69. mapping(address user => Access access) members;
  70. uint64 admin;
  71. uint64 guardian;
  72. Time.Delay delay; // delay for granting
  73. }
  74. struct Class {
  75. mapping(bytes4 selector => uint64 groupId) allowedGroups;
  76. Time.Delay adminDelay;
  77. }
  78. uint64 public constant ADMIN_GROUP = type(uint64).min; // 0
  79. uint64 public constant PUBLIC_GROUP = type(uint64).max; // 2**64-1
  80. mapping(address target => AccessMode mode) private _contractMode;
  81. mapping(uint64 classId => Class) private _classes;
  82. mapping(uint64 groupId => Group) private _groups;
  83. struct Schedule {
  84. uint48 timepoint;
  85. uint32 nonce;
  86. }
  87. mapping(bytes32 operationId => Schedule) private _schedules;
  88. // This should be transcient storage when supported by the EVM.
  89. bytes32 private _relayIdentifier;
  90. /**
  91. * @dev Check that the caller is authorized to perform the operation, following the restrictions encoded in
  92. * {_getAdminRestrictions}.
  93. */
  94. modifier onlyAuthorized() {
  95. _checkAuthorized();
  96. _;
  97. }
  98. constructor(address initialAdmin) {
  99. // admin is active immediately and without any execution delay.
  100. _grantGroup(ADMIN_GROUP, 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. * & {relay} 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 contract may thus ignore the second return argument. In that case they will fail
  117. * to identify the indirect workflow, and will consider call that require a delay to be forbidden.
  118. */
  119. function canCall(address caller, address target, bytes4 selector) public view virtual returns (bool, uint32) {
  120. (uint64 classId, bool closed) = getContractClass(target);
  121. if (closed) {
  122. return (false, 0);
  123. } else if (caller == address(this)) {
  124. // Caller is AccessManager => call was relayed. In that case the relay already checked permissions. We
  125. // verify that the call "identifier", which is set during the relay call, is correct.
  126. return (_relayIdentifier == _hashRelayIdentifier(target, selector), 0);
  127. } else {
  128. uint64 groupId = getClassFunctionGroup(classId, selector);
  129. (bool inGroup, uint32 currentDelay) = hasGroup(groupId, caller);
  130. return inGroup ? (currentDelay == 0, currentDelay) : (false, 0);
  131. }
  132. }
  133. /**
  134. * @dev Expiration delay for scheduled proposals. Defaults to 1 week.
  135. */
  136. function expiration() public view virtual returns (uint32) {
  137. return 1 weeks;
  138. }
  139. /**
  140. * @dev Minimum setback for all delay updates, with the exception of execution delays, which
  141. * can be increased without setback (and in the event of an accidental increase can be reset
  142. * via {revokeGroup}). Defaults to 5 days.
  143. */
  144. function minSetback() public view virtual returns (uint32) {
  145. return 5 days;
  146. }
  147. /**
  148. * @dev Get the mode under which a contract is operating.
  149. */
  150. function getContractClass(address target) public view virtual returns (uint64, bool) {
  151. AccessMode storage mode = _contractMode[target];
  152. return (mode.classId, mode.closed);
  153. }
  154. /**
  155. * @dev Get the permission level (group) required to call a function. This only applies for contract that are
  156. * operating under the `Custom` mode.
  157. */
  158. function getClassFunctionGroup(uint64 classId, bytes4 selector) public view virtual returns (uint64) {
  159. return _classes[classId].allowedGroups[selector];
  160. }
  161. function getClassAdminDelay(uint64 classId) public view virtual returns (uint32) {
  162. return _classes[classId].adminDelay.get();
  163. }
  164. /**
  165. * @dev Get the id of the group that acts as an admin for given group.
  166. *
  167. * The admin permission is required to grant the group, revoke the group and update the execution delay to execute
  168. * an operation that is restricted to this group.
  169. */
  170. function getGroupAdmin(uint64 groupId) public view virtual returns (uint64) {
  171. return _groups[groupId].admin;
  172. }
  173. /**
  174. * @dev Get the group that acts as a guardian for a given group.
  175. *
  176. * The guardian permission allows canceling operations that have been scheduled under the group.
  177. */
  178. function getGroupGuardian(uint64 groupId) public view virtual returns (uint64) {
  179. return _groups[groupId].guardian;
  180. }
  181. /**
  182. * @dev Get the group 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. * {GroupGrantDelayChanged} event.
  185. */
  186. function getGroupGrantDelay(uint64 groupId) public view virtual returns (uint32) {
  187. return _groups[groupId].delay.get();
  188. }
  189. /**
  190. * @dev Get the access details for a given account in a given group. These details include the timepoint at which
  191. * membership becomes active, and the delay applied to all operation by this user that require 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 groupId, address account) public view virtual returns (uint48, uint32, uint32, uint48) {
  201. Access storage access = _groups[groupId].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 group. Note that this
  208. * permission might be associated with a delay. {getAccess} can provide more details.
  209. */
  210. function hasGroup(uint64 groupId, address account) public view virtual returns (bool, uint32) {
  211. if (groupId == PUBLIC_GROUP) {
  212. return (true, 0);
  213. } else {
  214. (uint48 inGroupSince, uint32 currentDelay, , ) = getAccess(groupId, account);
  215. return (inGroupSince.isSetAndPast(Time.timestamp()), currentDelay);
  216. }
  217. }
  218. // =============================================== GROUP MANAGEMENT ===============================================
  219. /**
  220. * @dev Give a label to a group, for improved group discoverabily by UIs.
  221. *
  222. * Emits a {GroupLabel} event.
  223. */
  224. function labelGroup(uint64 groupId, string calldata label) public virtual onlyAuthorized {
  225. if (groupId == ADMIN_GROUP || groupId == PUBLIC_GROUP) {
  226. revert AccessManagerLockedGroup(groupId);
  227. }
  228. emit GroupLabel(groupId, label);
  229. }
  230. /**
  231. * @dev Add `account` to `groupId`, or change its execution delay.
  232. *
  233. * This gives the account the authorization to call any function that is restricted to this group. 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 group. 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 group, 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 in the group's admins
  246. *
  247. * Emits a {GroupGranted} event
  248. */
  249. function grantGroup(uint64 groupId, address account, uint32 executionDelay) public virtual onlyAuthorized {
  250. _grantGroup(groupId, account, getGroupGrantDelay(groupId), executionDelay);
  251. }
  252. /**
  253. * @dev Remove an account for a group, with immediate effect. If the sender is not in the group, this call has no
  254. * effect.
  255. *
  256. * Requirements:
  257. *
  258. * - the caller must be in the group's admins
  259. *
  260. * Emits a {GroupRevoked} event
  261. */
  262. function revokeGroup(uint64 groupId, address account) public virtual onlyAuthorized {
  263. _revokeGroup(groupId, account);
  264. }
  265. /**
  266. * @dev Renounce group permissions for the calling account, with immediate effect. If the sender is not in
  267. * the group, this call has no effect.
  268. *
  269. * Requirements:
  270. *
  271. * - the caller must be `callerConfirmation`.
  272. *
  273. * Emits a {GroupRevoked} event
  274. */
  275. function renounceGroup(uint64 groupId, address callerConfirmation) public virtual {
  276. if (callerConfirmation != _msgSender()) {
  277. revert AccessManagerBadConfirmation();
  278. }
  279. _revokeGroup(groupId, callerConfirmation);
  280. }
  281. /**
  282. * @dev Change admin group for a given group.
  283. *
  284. * Requirements:
  285. *
  286. * - the caller must be a global admin
  287. *
  288. * Emits a {GroupAdminChanged} event
  289. */
  290. function setGroupAdmin(uint64 groupId, uint64 admin) public virtual onlyAuthorized {
  291. _setGroupAdmin(groupId, admin);
  292. }
  293. /**
  294. * @dev Change guardian group for a given group.
  295. *
  296. * Requirements:
  297. *
  298. * - the caller must be a global admin
  299. *
  300. * Emits a {GroupGuardianChanged} event
  301. */
  302. function setGroupGuardian(uint64 groupId, uint64 guardian) public virtual onlyAuthorized {
  303. _setGroupGuardian(groupId, guardian);
  304. }
  305. /**
  306. * @dev Update the delay for granting a `groupId`.
  307. *
  308. * Requirements:
  309. *
  310. * - the caller must be a global admin
  311. *
  312. * Emits a {GroupGrantDelayChanged} event
  313. */
  314. function setGrantDelay(uint64 groupId, uint32 newDelay) public virtual onlyAuthorized {
  315. _setGrantDelay(groupId, newDelay);
  316. }
  317. /**
  318. * @dev Internal version of {grantGroup} without access control. Returns true if the group was newly granted.
  319. *
  320. * Emits a {GroupGranted} event
  321. */
  322. function _grantGroup(
  323. uint64 groupId,
  324. address account,
  325. uint32 grantDelay,
  326. uint32 executionDelay
  327. ) internal virtual returns (bool) {
  328. if (groupId == PUBLIC_GROUP) {
  329. revert AccessManagerLockedGroup(groupId);
  330. }
  331. bool inGroup = _groups[groupId].members[account].since != 0;
  332. uint48 since;
  333. if (inGroup) {
  334. // No setback here. Value can be reset by doing revoke + grant, effectively allowing the admin to perform
  335. // any change to the execution delay within the duration of the group admin delay.
  336. (_groups[groupId].members[account].delay, since) = _groups[groupId].members[account].delay.withUpdate(
  337. executionDelay,
  338. 0
  339. );
  340. } else {
  341. since = Time.timestamp() + grantDelay;
  342. _groups[groupId].members[account] = Access({since: since, delay: executionDelay.toDelay()});
  343. }
  344. emit GroupGranted(groupId, account, executionDelay, since);
  345. return !inGroup;
  346. }
  347. /**
  348. * @dev Internal version of {revokeGroup} without access control. This logic is also used by {renounceGroup}.
  349. * Returns true if the group was previously granted.
  350. *
  351. * Emits a {GroupRevoked} event
  352. */
  353. function _revokeGroup(uint64 groupId, address account) internal virtual returns (bool) {
  354. if (groupId == PUBLIC_GROUP) {
  355. revert AccessManagerLockedGroup(groupId);
  356. }
  357. if (_groups[groupId].members[account].since == 0) {
  358. return false;
  359. }
  360. delete _groups[groupId].members[account];
  361. emit GroupRevoked(groupId, account);
  362. return true;
  363. }
  364. /**
  365. * @dev Internal version of {setGroupAdmin} without access control.
  366. *
  367. * Emits a {GroupAdminChanged} event
  368. */
  369. function _setGroupAdmin(uint64 groupId, uint64 admin) internal virtual {
  370. if (groupId == ADMIN_GROUP || groupId == PUBLIC_GROUP) {
  371. revert AccessManagerLockedGroup(groupId);
  372. }
  373. _groups[groupId].admin = admin;
  374. emit GroupAdminChanged(groupId, admin);
  375. }
  376. /**
  377. * @dev Internal version of {setGroupGuardian} without access control.
  378. *
  379. * Emits a {GroupGuardianChanged} event
  380. */
  381. function _setGroupGuardian(uint64 groupId, uint64 guardian) internal virtual {
  382. if (groupId == ADMIN_GROUP || groupId == PUBLIC_GROUP) {
  383. revert AccessManagerLockedGroup(groupId);
  384. }
  385. _groups[groupId].guardian = guardian;
  386. emit GroupGuardianChanged(groupId, guardian);
  387. }
  388. /**
  389. * @dev Internal version of {setGrantDelay} without access control.
  390. *
  391. * Emits a {GroupGrantDelayChanged} event
  392. */
  393. function _setGrantDelay(uint64 groupId, uint32 newDelay) internal virtual {
  394. if (groupId == PUBLIC_GROUP) {
  395. revert AccessManagerLockedGroup(groupId);
  396. }
  397. (Time.Delay updated, uint48 effect) = _groups[groupId].delay.withUpdate(newDelay, minSetback());
  398. _groups[groupId].delay = updated;
  399. emit GroupGrantDelayChanged(groupId, newDelay, effect);
  400. }
  401. // ============================================= FUNCTION MANAGEMENT ==============================================
  402. /**
  403. * @dev Set the level of permission (`group`) required to call functions identified by the `selectors` in the
  404. * `target` contract.
  405. *
  406. * Requirements:
  407. *
  408. * - the caller must be a global admin
  409. *
  410. * Emits a {FunctionAllowedGroupUpdated} event per selector
  411. */
  412. function setClassFunctionGroup(
  413. uint64 classId,
  414. bytes4[] calldata selectors,
  415. uint64 groupId
  416. ) public virtual onlyAuthorized {
  417. for (uint256 i = 0; i < selectors.length; ++i) {
  418. _setClassFunctionGroup(classId, selectors[i], groupId);
  419. }
  420. }
  421. /**
  422. * @dev Internal version of {setFunctionAllowedGroup} without access control.
  423. *
  424. * Emits a {FunctionAllowedGroupUpdated} event
  425. */
  426. function _setClassFunctionGroup(uint64 classId, bytes4 selector, uint64 groupId) internal virtual {
  427. _checkValidClassId(classId);
  428. _classes[classId].allowedGroups[selector] = groupId;
  429. emit ClassFunctionGroupUpdated(classId, selector, groupId);
  430. }
  431. /**
  432. * @dev Set the delay for management operations on a given class of contract.
  433. *
  434. * Requirements:
  435. *
  436. * - the caller must be a global admin
  437. *
  438. * Emits a {FunctionAllowedGroupUpdated} event per selector
  439. */
  440. function setClassAdminDelay(uint64 classId, uint32 newDelay) public virtual onlyAuthorized {
  441. _setClassAdminDelay(classId, newDelay);
  442. }
  443. /**
  444. * @dev Internal version of {setClassAdminDelay} without access control.
  445. *
  446. * Emits a {ClassAdminDelayUpdated} event
  447. */
  448. function _setClassAdminDelay(uint64 classId, uint32 newDelay) internal virtual {
  449. _checkValidClassId(classId);
  450. (Time.Delay updated, uint48 effect) = _classes[classId].adminDelay.withUpdate(newDelay, minSetback());
  451. _classes[classId].adminDelay = updated;
  452. emit ClassAdminDelayUpdated(classId, newDelay, effect);
  453. }
  454. /**
  455. * @dev Reverts if `classId` is 0. This is the default class id given to contracts and it should not have any
  456. * configurations.
  457. */
  458. function _checkValidClassId(uint64 classId) private pure {
  459. if (classId == 0) {
  460. revert AccessManagerInvalidClass(classId);
  461. }
  462. }
  463. // =============================================== MODE MANAGEMENT ================================================
  464. /**
  465. * @dev Set the class of a contract.
  466. *
  467. * Requirements:
  468. *
  469. * - the caller must be a global admin
  470. *
  471. * Emits a {ContractClassUpdated} event.
  472. */
  473. function setContractClass(address target, uint64 classId) public virtual onlyAuthorized {
  474. _setContractClass(target, classId);
  475. }
  476. /**
  477. * @dev Set the class of a contract. This is an internal setter with no access restrictions.
  478. *
  479. * Emits a {ContractClassUpdated} event.
  480. */
  481. function _setContractClass(address target, uint64 classId) internal virtual {
  482. if (target == address(this)) {
  483. revert AccessManagerLockedAccount(target);
  484. }
  485. _contractMode[target].classId = classId;
  486. emit ContractClassUpdated(target, classId);
  487. }
  488. /**
  489. * @dev Set the closed flag for a contract.
  490. *
  491. * Requirements:
  492. *
  493. * - the caller must be a global admin
  494. *
  495. * Emits a {ContractClosed} event.
  496. */
  497. function setContractClosed(address target, bool closed) public virtual onlyAuthorized {
  498. _setContractClosed(target, closed);
  499. }
  500. /**
  501. * @dev Set the closed flag for a contract. This is an internal setter with no access restrictions.
  502. *
  503. * Emits a {ContractClosed} event.
  504. */
  505. function _setContractClosed(address target, bool closed) internal virtual {
  506. if (target == address(this)) {
  507. revert AccessManagerLockedAccount(target);
  508. }
  509. _contractMode[target].closed = closed;
  510. emit ContractClosed(target, closed);
  511. }
  512. // ============================================== DELAYED OPERATIONS ==============================================
  513. /**
  514. * @dev Return the timepoint at which a scheduled operation will be ready for execution. This returns 0 if the
  515. * operation is not yet scheduled, has expired, was executed, or was canceled.
  516. */
  517. function getSchedule(bytes32 id) public view virtual returns (uint48) {
  518. uint48 timepoint = _schedules[id].timepoint;
  519. return _isExpired(timepoint) ? 0 : timepoint;
  520. }
  521. /**
  522. * @dev Return the nonce for the latest scheduled operation with a given id. Returns 0 if the operation has never
  523. * been scheduled.
  524. */
  525. function getNonce(bytes32 id) public view virtual returns (uint32) {
  526. return _schedules[id].nonce;
  527. }
  528. /**
  529. * @dev Schedule a delayed operation for future execution, and return the operation identifier. It is possible to
  530. * choose the timestamp at which the operation becomes executable as long as it satisfies the execution delays
  531. * required for the caller. The special value zero will automatically set the earliest possible time.
  532. *
  533. * Returns the `operationId` that was scheduled. Since this value is a hash of the parameters, it can reoccur when
  534. * the same parameters are used; if this is relevant, the returned `nonce` can be used to uniquely identify this
  535. * scheduled operation from other occurrences of the same `operationId` in invocations of {relay} and {cancel}.
  536. *
  537. * Emits a {OperationScheduled} event.
  538. */
  539. function schedule(
  540. address target,
  541. bytes calldata data,
  542. uint48 when
  543. ) public virtual returns (bytes32 operationId, uint32 nonce) {
  544. address caller = _msgSender();
  545. // Fetch restriction to that apply to the caller on the targeted function
  546. (bool allowed, uint32 setback) = _canCallExtended(caller, target, data);
  547. uint48 minWhen = Time.timestamp() + setback;
  548. if (when == 0) {
  549. when = minWhen;
  550. }
  551. // If caller is not authorised, revert
  552. if (!allowed && (setback == 0 || when < minWhen)) {
  553. revert AccessManagerUnauthorizedCall(caller, target, bytes4(data[0:4]));
  554. }
  555. // If caller is authorised, schedule operation
  556. operationId = _hashOperation(caller, target, data);
  557. // Cannot reschedule unless the operation has expired
  558. uint48 prevTimepoint = _schedules[operationId].timepoint;
  559. if (prevTimepoint != 0 && !_isExpired(prevTimepoint)) {
  560. revert AccessManagerAlreadyScheduled(operationId);
  561. }
  562. unchecked {
  563. // It's not feasible to overflow the nonce in less than 1000 years
  564. nonce = _schedules[operationId].nonce + 1;
  565. }
  566. _schedules[operationId].timepoint = when;
  567. _schedules[operationId].nonce = nonce;
  568. emit OperationScheduled(operationId, nonce, when, caller, target, data);
  569. // Using named return values because otherwise we get stack too deep
  570. }
  571. /**
  572. * @dev Execute a function that is delay restricted, provided it was properly scheduled beforehand, or the
  573. * execution delay is 0.
  574. *
  575. * Returns the nonce that identifies the previously scheduled operation that is relayed, or 0 if the
  576. * operation wasn't previously scheduled (if the caller doesn't have an execution delay).
  577. *
  578. * Emits an {OperationExecuted} event only if the call was scheduled and delayed.
  579. */
  580. // Reentrancy is not an issue because permissions are checked on msg.sender. Additionally,
  581. // _consumeScheduledOp guarantees a scheduled operation is only executed once.
  582. // slither-disable-next-line reentrancy-no-eth
  583. function relay(address target, bytes calldata data) public payable virtual returns (uint32) {
  584. address caller = _msgSender();
  585. // Fetch restriction to that apply to the caller on the targeted function
  586. (bool allowed, uint32 setback) = _canCallExtended(caller, target, data);
  587. // If caller is not authorised, revert
  588. if (!allowed && setback == 0) {
  589. revert AccessManagerUnauthorizedCall(caller, target, bytes4(data));
  590. }
  591. // If caller is authorised, check operation was scheduled early enough
  592. bytes32 operationId = _hashOperation(caller, target, data);
  593. uint32 nonce;
  594. if (setback != 0) {
  595. nonce = _consumeScheduledOp(operationId);
  596. }
  597. // Mark the target and selector as authorised
  598. bytes32 relayIdentifierBefore = _relayIdentifier;
  599. _relayIdentifier = _hashRelayIdentifier(target, bytes4(data));
  600. // Perform call
  601. Address.functionCallWithValue(target, data, msg.value);
  602. // Reset relay identifier
  603. _relayIdentifier = relayIdentifierBefore;
  604. return nonce;
  605. }
  606. /**
  607. * @dev Consume a scheduled operation targeting the caller. If such an operation exists, mark it as consumed
  608. * (emit an {OperationExecuted} event and clean the state). Otherwise, throw an error.
  609. *
  610. * This is useful for contract that want to enforce that calls targeting them were scheduled on the manager,
  611. * with all the verifications that it implies.
  612. *
  613. * Emit a {OperationExecuted} event
  614. */
  615. function consumeScheduledOp(address caller, bytes calldata data) public virtual {
  616. address target = _msgSender();
  617. require(IAccessManaged(target).isConsumingScheduledOp());
  618. _consumeScheduledOp(_hashOperation(caller, target, data));
  619. }
  620. /**
  621. * @dev Internal variant of {consumeScheduledOp} that operates on bytes32 operationId.
  622. *
  623. * Returns the nonce of the scheduled operation that is consumed.
  624. */
  625. function _consumeScheduledOp(bytes32 operationId) internal virtual returns (uint32) {
  626. uint48 timepoint = _schedules[operationId].timepoint;
  627. uint32 nonce = _schedules[operationId].nonce;
  628. if (timepoint == 0) {
  629. revert AccessManagerNotScheduled(operationId);
  630. } else if (timepoint > Time.timestamp()) {
  631. revert AccessManagerNotReady(operationId);
  632. } else if (_isExpired(timepoint)) {
  633. revert AccessManagerExpired(operationId);
  634. }
  635. delete _schedules[operationId];
  636. emit OperationExecuted(operationId, nonce);
  637. return nonce;
  638. }
  639. /**
  640. * @dev Cancel a scheduled (delayed) operation. Returns the nonce that identifies the previously scheduled
  641. * operation that is cancelled.
  642. *
  643. * Requirements:
  644. *
  645. * - the caller must be the proposer, or a guardian of the targeted function
  646. *
  647. * Emits a {OperationCanceled} event.
  648. */
  649. function cancel(address caller, address target, bytes calldata data) public virtual returns (uint32) {
  650. address msgsender = _msgSender();
  651. bytes4 selector = bytes4(data[0:4]);
  652. bytes32 operationId = _hashOperation(caller, target, data);
  653. if (_schedules[operationId].timepoint == 0) {
  654. revert AccessManagerNotScheduled(operationId);
  655. } else if (caller != msgsender) {
  656. // calls can only be canceled by the account that scheduled them, a global admin, or by a guardian of the required group.
  657. (uint64 classId, ) = getContractClass(target);
  658. (bool isAdmin, ) = hasGroup(ADMIN_GROUP, msgsender);
  659. (bool isGuardian, ) = hasGroup(getGroupGuardian(getClassFunctionGroup(classId, selector)), msgsender);
  660. if (!isAdmin && !isGuardian) {
  661. revert AccessManagerCannotCancel(msgsender, caller, target, selector);
  662. }
  663. }
  664. delete _schedules[operationId].timepoint;
  665. uint32 nonce = _schedules[operationId].nonce;
  666. emit OperationCanceled(operationId, nonce);
  667. return nonce;
  668. }
  669. /**
  670. * @dev Hashing function for delayed operations
  671. */
  672. function _hashOperation(address caller, address target, bytes calldata data) private pure returns (bytes32) {
  673. return keccak256(abi.encode(caller, target, data));
  674. }
  675. /**
  676. * @dev Hashing function for relay protection
  677. */
  678. function _hashRelayIdentifier(address target, bytes4 selector) private pure returns (bytes32) {
  679. return keccak256(abi.encode(target, selector));
  680. }
  681. // ==================================================== OTHERS ====================================================
  682. /**
  683. * @dev Change the AccessManager instance used by a contract that correctly uses this instance.
  684. *
  685. * Requirements:
  686. *
  687. * - the caller must be a global admin
  688. */
  689. function updateAuthority(address target, address newAuthority) public virtual onlyAuthorized {
  690. IAccessManaged(target).setAuthority(newAuthority);
  691. }
  692. // ================================================= ADMIN LOGIC ==================================================
  693. /**
  694. * @dev Check if the current call is authorized according to admin logic.
  695. */
  696. function _checkAuthorized() private {
  697. address caller = _msgSender();
  698. (bool allowed, uint32 delay) = _canCallExtended(caller, address(this), _msgData());
  699. if (!allowed) {
  700. if (delay == 0) {
  701. (, uint64 requiredGroup, ) = _getAdminRestrictions(_msgData());
  702. revert AccessManagerUnauthorizedAccount(caller, requiredGroup);
  703. } else {
  704. _consumeScheduledOp(_hashOperation(caller, address(this), _msgData()));
  705. }
  706. }
  707. }
  708. /**
  709. * @dev Get the admin restrictions of a given function call based on the function and arguments involved.
  710. */
  711. function _getAdminRestrictions(bytes calldata data) private view returns (bool, uint64, uint32) {
  712. bytes4 selector = bytes4(data);
  713. if (data.length < 4) {
  714. return (false, 0, 0);
  715. } else if (selector == this.updateAuthority.selector || selector == this.setContractClass.selector) {
  716. // First argument is a target. Restricted to ADMIN with the class delay corresponding to the target's class
  717. address target = abi.decode(data[0x04:0x24], (address));
  718. (uint64 classId, ) = getContractClass(target);
  719. uint32 delay = getClassAdminDelay(classId);
  720. return (true, ADMIN_GROUP, delay);
  721. } else if (selector == this.setClassFunctionGroup.selector) {
  722. // First argument is a class. Restricted to ADMIN with the class delay corresponding to the class
  723. uint64 classId = abi.decode(data[0x04:0x24], (uint64));
  724. uint32 delay = getClassAdminDelay(classId);
  725. return (true, ADMIN_GROUP, delay);
  726. } else if (
  727. selector == this.labelGroup.selector ||
  728. selector == this.setGroupAdmin.selector ||
  729. selector == this.setGroupGuardian.selector ||
  730. selector == this.setGrantDelay.selector ||
  731. selector == this.setClassAdminDelay.selector ||
  732. selector == this.setContractClosed.selector
  733. ) {
  734. // Restricted to ADMIN with no delay beside any execution delay the caller may have
  735. return (true, ADMIN_GROUP, 0);
  736. } else if (selector == this.grantGroup.selector || selector == this.revokeGroup.selector) {
  737. // First argument is a groupId. Restricted to that group's admin with no delay beside any execution delay the caller may have.
  738. uint64 groupId = abi.decode(data[0x04:0x24], (uint64));
  739. uint64 groupAdminId = getGroupAdmin(groupId);
  740. return (true, groupAdminId, 0);
  741. } else {
  742. return (false, 0, 0);
  743. }
  744. }
  745. // =================================================== HELPERS ====================================================
  746. /**
  747. * @dev An extended version of {canCall} for internal use that considers restrictions for admin functions.
  748. */
  749. function _canCallExtended(address caller, address target, bytes calldata data) private view returns (bool, uint32) {
  750. if (target == address(this)) {
  751. (bool enabled, uint64 groupId, uint32 operationDelay) = _getAdminRestrictions(data);
  752. if (!enabled) {
  753. return (false, 0);
  754. }
  755. (bool inGroup, uint32 executionDelay) = hasGroup(groupId, caller);
  756. if (!inGroup) {
  757. return (false, 0);
  758. }
  759. // downcast is safe because both options are uint32
  760. uint32 delay = uint32(Math.max(operationDelay, executionDelay));
  761. return (delay == 0, delay);
  762. } else {
  763. bytes4 selector = bytes4(data);
  764. return canCall(caller, target, selector);
  765. }
  766. }
  767. /**
  768. * @dev Returns true if a schedule timepoint is past its expiration deadline.
  769. */
  770. function _isExpired(uint48 timepoint) private view returns (bool) {
  771. return timepoint + expiration() <= Time.timestamp();
  772. }
  773. }