Allow direct plugin calls with validation & permission hooks #90
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,20 @@ | ||
| { | ||
| "extends": "solhint:recommended", | ||
| "rules": { | ||
| "func-name-mixedcase": "off", | ||
| "immutable-vars-naming": ["error"], | ||
| "no-unused-import": ["error"], | ||
| "compiler-version": ["error", ">=0.8.19"], | ||
| "custom-errors": "off", | ||
| "func-visibility": ["error", { "ignoreConstructors": true }], | ||
| "max-line-length": ["error", 120], | ||
| "max-states-count": ["warn", 30], | ||
| "modifier-name-mixedcase": ["error"], | ||
| "private-vars-leading-underscore": ["error"], | ||
| "no-inline-assembly": "off", | ||
| "avoid-low-level-calls": "off", | ||
| "one-contract-per-file": "off", | ||
| "no-empty-blocks": "off", | ||
| "reason-string": ["warn", { "maxLength": 64 }] | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -78,22 +78,21 @@ contract UpgradeableModularAccount is | |
| error SignatureValidationInvalid(address plugin, uint32 entityId); | ||
| error UnexpectedAggregator(address plugin, uint32 entityId, address aggregator); | ||
| error UnrecognizedFunction(bytes4 selector); | ||
| error ValidationFunctionMissing(bytes4 selector); | ||
| error ValidationDoesNotApply(bytes4 selector, address plugin, uint32 entityId, bool isGlobal); | ||
| error ValidationSignatureSegmentMissing(); | ||
| error SignatureSegmentOutOfOrder(); | ||
|
|
||
| // Wraps execution of a native function with runtime validation and hooks | ||
| // Used for upgradeTo, upgradeToAndCall, execute, executeBatch, installPlugin, uninstallPlugin | ||
| modifier wrapNativeFunction() { | ||
| (PostExecToRun[] memory postPermissionHooks, PostExecToRun[] memory postExecHooks) = | ||
| _checkPermittedCallerAndAssociatedHooks(); | ||
|
|
||
| _; | ||
|
|
||
| _doCachedPostExecHooks(postExecHooks); | ||
| _doCachedPostExecHooks(postPermissionHooks); | ||
| } | ||
|
|
||
| constructor(IEntryPoint anEntryPoint) { | ||
|
|
@@ -136,7 +135,7 @@ contract UpgradeableModularAccount is | |
| revert UnrecognizedFunction(msg.sig); | ||
| } | ||
|
|
||
| _checkPermittedCallerAndAssociatedHooks(); | ||
|
Collaborator
There was a problem hiding this comment. What if a signer of the account call an execFunction? Would it fail here?
Contributor
There was a problem hiding this comment. I.e. if a signer, as set in the storage of Alternatively, if an account is only used from an EOA, you could add an EOA itself as an allowed caller by installing the EOA address + the direct call magic value as a validation. But, this wouldn't be usable via user op validation. There was a problem hiding this comment. Aren't we executing the pre-execution hooks currently twice in case a permitted caller is calling through fallback? Within
Contributor
There was a problem hiding this comment. @0xrubes you are correct... we'll get a fix PR up soon. |
||
|
|
||
| PostExecToRun[] memory postExecHooks; | ||
| // Cache post-exec hooks in memory | ||
|
|
@@ -500,17 +499,7 @@ contract UpgradeableModularAccount is | |
| } else { | ||
| currentAuthData = ""; | ||
| } | ||
| _doPreRuntimeValidationHook(preRuntimeValidationHooks[i], callData, currentAuthData); | ||
| } | ||
|
|
||
| if (authSegment.getIndex() != _RESERVED_VALIDATION_DATA_INDEX) { | ||
|
|
@@ -605,9 +594,78 @@ contract UpgradeableModularAccount is | |
| } | ||
| } | ||
|
|
||
| function _doPreRuntimeValidationHook( | ||
| PluginEntity validationHook, | ||
| bytes memory callData, | ||
| bytes memory currentAuthData | ||
| ) internal { | ||
| (address hookPlugin, uint32 hookEntityId) = validationHook.unpack(); | ||
| try IValidationHook(hookPlugin).preRuntimeValidationHook( | ||
| hookEntityId, msg.sender, msg.value, callData, currentAuthData | ||
| ) | ||
| // forgefmt: disable-start | ||
| // solhint-disable-next-line no-empty-blocks | ||
| {} catch (bytes memory revertReason) { | ||
| // forgefmt: disable-end | ||
| revert PreRuntimeValidationHookFailed(hookPlugin, hookEntityId, revertReason); | ||
| } | ||
| } | ||
|
|
||
| // solhint-disable-next-line no-empty-blocks | ||
| function _authorizeUpgrade(address newImplementation) internal override {} | ||
|
|
||
| /** | ||
| * Order of operations: | ||
| * 1. Check if the sender is the entry point, the account itself, or the selector called is public. | ||
| * - Yes: Return an empty array, there are no post-permissionHooks. | ||
| * - No: Continue | ||
| * 2. Check if the called selector (msg.sig) is included in the set of selectors the msg.sender can | ||
| * directly call. | ||
| * - Yes: Continue | ||
| * - No: Revert, the caller is not allowed to call this selector | ||
| * 3. If there are runtime validation hooks associated with this caller-sig combination, run them. | ||
| * 4. Run the pre-permissionHooks associated with this caller-sig combination, and return the | ||
| * post-permissionHooks to run later. | ||
| */ | ||
| function _checkPermittedCallerAndAssociatedHooks() | ||
| internal | ||
| returns (PostExecToRun[] memory, PostExecToRun[] memory) | ||
| { | ||
| AccountStorage storage _storage = getAccountStorage(); | ||
|
|
||
| if ( | ||
| msg.sender == address(_ENTRY_POINT) || msg.sender == address(this) | ||
| || _storage.selectorData[msg.sig].isPublic | ||
| ) { | ||
| return (new PostExecToRun[](0), new PostExecToRun[](0)); | ||
| } | ||
|
|
||
| PluginEntity directCallValidationKey = PluginEntityLib.pack(msg.sender, _SELF_PERMIT_VALIDATION_FUNCTIONID); | ||
|
|
||
| _checkIfValidationAppliesCallData(msg.data, directCallValidationKey, false); | ||
|
|
||
| // Direct call is allowed, run associated permission & validation hooks | ||
|
|
||
| // Validation hooks | ||
| PluginEntity[] memory preRuntimeValidationHooks = | ||
| _storage.validationData[directCallValidationKey].preValidationHooks; | ||
|
|
||
| uint256 hookLen = preRuntimeValidationHooks.length; | ||
| for (uint256 i = 0; i < hookLen; ++i) { | ||
| _doPreRuntimeValidationHook(preRuntimeValidationHooks[i], msg.data, ""); | ||
| } | ||
|
|
||
| // Permission hooks | ||
| PostExecToRun[] memory postPermissionHooks = | ||
| _doPreHooks(_storage.validationData[directCallValidationKey].permissionHooks, msg.data); | ||
|
|
||
| // Exec hooks | ||
| PostExecToRun[] memory postExecutionHooks = | ||
| _doPreHooks(_storage.selectorData[msg.sig].executionHooks, msg.data); | ||
|
|
||
| return (postPermissionHooks, postExecutionHooks); | ||
| } | ||
|
|
||
| function _checkIfValidationAppliesCallData( | ||
| bytes calldata callData, | ||
| PluginEntity validationFunction, | ||
|
|
@@ -661,25 +719,6 @@ contract UpgradeableModularAccount is | |
| } | ||
| } | ||
|
|
||
| function _globalValidationAllowed(bytes4 selector) internal view returns (bool) { | ||
| if ( | ||
| selector == this.execute.selector || selector == this.executeBatch.selector | ||
|
|
@@ -693,14 +732,22 @@ contract UpgradeableModularAccount is | |
| return getAccountStorage().selectorData[selector].allowGlobalValidation; | ||
| } | ||
|
|
||
| function _checkIfValidationAppliesSelector(bytes4 selector, PluginEntity validationFunction, bool isGlobal) | ||
| internal | ||
| view | ||
| { | ||
| AccountStorage storage _storage = getAccountStorage(); | ||
|
|
||
| // Check that the provided validation function is applicable to the selector | ||
| if (isGlobal) { | ||
| if (!_globalValidationAllowed(selector) || !_storage.validationData[validationFunction].isGlobal) { | ||
| revert ValidationFunctionMissing(selector); | ||
| } | ||
| } else { | ||
| // Not global validation, but per-selector | ||
| if (!getAccountStorage().validationData[validationFunction].selectors.contains(toSetValue(selector))) { | ||
| revert ValidationFunctionMissing(selector); | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.