AccessManager.sol 35 KB

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