AccessManager.sol 33 KB

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