AccessManager.sol 35 KB

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