- Total Prize Pool: $40,000 in USDC
- HM awards: $31,780 in USDC
- QA awards: $1,320 in USDC
- Judge awards: $3,800 in USDC
- Validator awards: $2,600 in USDC
- Scout awards: $500 in USDC
- Read our guidelines for more details
- Starts October 15, 2024 20:00 UTC
- Ends October 25, 2024 20:00 UTC
The 4naly3er report can be found here.
Note for C4 wardens: Anything included in this Automated Findings / Publicly Known Issues section is considered a publicly known issue and is ineligible for awards.
The following are known issues with the Kleidi system:
- If the cold signers are malicious or compromised, they can execute transactions to compromise the system if neither recovery spells or the guardian are used
- If the hot signers are malicious or compromised, they can deploy a compromised system instance on a new chain with compromised recovery spells and malicious calldata checks that allow funds to be stolen
- If DEX's are whitelisted, this opens up the ability for the hot signers to steal funds from the system via high slippage and front and back running
- If a malicious protocol is whitelisted, this opens up the ability for hot signers to inadvernantly lose funds
- If a non-malicious but improperly configured protocol is whitelisted, this opens up the ability for hot signers to inadvernantly lose funds by using a protocol incorrectly
- Fee on transfer tokens may make the actual amount of tokens sent to destinations less or more than expected, this finding is out of scope for the system
- The system only works on EVM compatible chains, does not work on chains that have not undergone the Shanghai EVM upgrade
- The system only works with contracts that have a known ABI, it does not work with contracts that have dynamic ABIs the return value of token transfers are unchecked, however the call to the token contract is checked, the timelock has no accounting mechanisms
- Salt in the
DeploymentParamsstruct is not used in the call tocreateSystemInstance, this is a known issue, but is not a security concern. The same system instance with the same parameters can only be deployed once.
The whole of the docs contain known issues, so we don't want to be rewarding for things we already know.
- https://github.com/solidity-labs-io/kleidi/blob/main/docs/KNOWN_ISSUES.md
- https://github.com/solidity-labs-io/kleidi/blob/main/docs/EDGECASES.md
- https://github.com/solidity-labs-io/kleidi/blob/main/docs/REQUIREMENTS.md
The Kleidi Wallet is a collection of smart contracts that can be used to create a full self-custody wallet system for DeFi users. The protocol is opinionated and is designed to be used with Gnosis Safe multisigs, a timelock, guard contract, and recovery spells. It enables users to access DeFi yields and protocols, pull funds in case of emergency, and recover funds in case of lost keys either through social recovery or predefined backups.
- Security: The protocol is designed by the world class Smart Contract engineering team at Solidity Labs. It has had components formally verified, and has been audited twice with no critical or high issues discovered. It is designed to be used with Gnosis Safe multisigs, which are battle-tested and have secured tens of billions of dollars in assets. See our internal audit log here.
- Flexibility: The protocol is designed to be flexible and can be used in a variety of ways. It can be used by DAOs, individuals, and other entities. Recovery spells allow users the ability to create custom recovery logic or flows to protect their assets.
- Self Reliance: This smart contract system is designed to enable a self custody system that does not require trusted third parties. Funds can be securely managed by a single user in this system setup. Users can recover their funds without needing to rely on a trusted third party, though they can choose to use a social recovery system if they wish.
- Wrench Resistant: One of the guiding principles of this system is to be resistant to $5 wrench attacks. Even if an attacker is able to coerce a user into signing a transaction, the system of recovery spells and guardians slows down an attacker trying to steal funds. With a 30 day timelock as the delay on new transactions, an attacker would need to kidnap a user for a month and remain undetected for the entire period in order to steal funds.
- Defense in Depth: The system is designed with multiple layers of security. The timelock prevents transactions from being executed immediately. Recovery spells can be used to create custom recovery logic for a multisig. The recovery spell could either completely rotate the multisig signer set, or contain more complex logic to recover funds in case of lost keys.
Each system component works together to ensure a user cannot be coerced into signing actions they do not want to take.
- Guard: This contract restricts the the multisig by disallowing delegate and self calls. This removes multicall functionality from the Gnosis Safe while enabled. Additionally, it stops owners from being rotated out of the multisig (except by modules), stops additional modules from being added or removed during a transaction, and prevents the guard from being disabled by a transaction. With these checks in place, it is impossible to remove the guard, rotate signers, or add new modules to the multisig without a timelocked transaction passing.
- Timelock: This contract holds all funds and requires a delay before a transaction can be executed. This delay can be set to any time period between 1 and 30 days. This delay prevents an attacker from immediately executing a transaction after coercing a user into signing a transaction. The timelock can whitelist contract calls and calldata, this allows hot signers to execute interactions with other smart contracts as long as the contract, function signature, and certain parts of the calldata are whitelisted.
- Recovery Spells: Recovery spells are custom recovery mechanisms that can be used to recover funds in case of lost keys. They can be used to rotate the signers of a multisig, or to create other custom recovery logic. This allows users to craft custom recovery flows that can be used to recover funds in case of lost keys. Recovery spells can be used to create a recovery mechanism that is resistant to $5 wrench attacks, and can be used to recover funds in case of lost keys. A social recovery recovery spell could allow the recovery members to rotate the signers of the multisig after a predefined timelock. This would allow the multisig owner to cancel the recovery spell if they still had access to their keys, but would allow the recovery members to rotate the signers if the multisig owner lost their keys.
The only safe way to create a new wallet is through the InstanceDeployer contract. Wallet contracts created outside of the InstanceDeployer should be assumed to be unsafe. The InstanceDeployer deploys a system instance atomically and deterministically with the desired configuration. The configuration will include the timelock delay, guardian, pause duration, whitelisted targets, calldatas, and the users' Gnosis Safe as the owner. The Instance Deployer contract will have no permission in the deployed contracts once the deployment transaction is completed.
Instance deployer will
- Deploy a timelock contract with the desired delay, guardian, pause duration, whitelisted targets, calldatas, with the users' Gnosis Safe as the owner.
- Execute a transaction through the Gnosis Safe to perform the following actions:
- initialize the timelock with the specified protocols and hot signers
- add the Guard to the Safe
- add the Timelock as a Safe module
- add the recovery spells to the Safe as modules
- remove the InstanceDeployer as an owner of the Safe
- add the specified owners to the Safe
- set the specified Safe threshold
- If the timelock is removed as a module from the Safe before the Guard is disabled, there will be no way to rotate the signers of the Safe, add new modules, or remove modules.
- Previous audits: https://github.com/solidity-labs-io/kleidi/blob/main/audit/Kleidi-Recon-Report.pdf
- Documentation: https://github.com/solidity-labs-io/kleidi/tree/main/docs
- Website: https://www.kleidi.io/
- X/Twitter: https://x.com/KleidiWallet
- Discord: N/A
| File | Logic Contracts | Interfaces | nSLOC | Purpose | Libraries used |
|---|---|---|---|---|---|
| /src/ConfigurablePause.sol | 1 | **** | 54 | ||
| /src/Timelock.sol | 1 | **** | 565 | @openzeppelin-contracts/contracts/access/AccessControl.sol @openzeppelin-contracts/contracts/access/extensions/AccessControlEnumerable.sol @openzeppelin-contracts/contracts/token/ERC1155/IERC1155Receiver.sol @openzeppelin-contracts/contracts/token/ERC721/IERC721Receiver.sol @openzeppelin-contracts/contracts/utils/introspection/ERC165.sol @openzeppelin-contracts/contracts/utils/structs/EnumerableSet.sol @safe/Safe.sol src/BytesHelper.sol src/ConfigurablePause.sol src/utils/Constants.sol |
|
| /src/TimelockFactory.sol | 1 | **** | 39 | src/Timelock.sol src/utils/Create2Helper.sol |
|
| /src/Guard.sol | 1 | **** | 18 | @safe/base/GuardManager.sol @safe/common/Enum.sol @safe/Safe.sol src/BytesHelper.sol |
|
| /src/views/AddressCalculation.sol | 1 | **** | 108 | @safe/proxies/SafeProxyFactory.sol @safe/proxies/SafeProxy.sol src/Timelock.sol src/TimelockFactory.sol src/utils/Create2Helper.sol src/InstanceDeployer.sol |
|
| /src/utils/Constants.sol | **** | **** | 4 | ||
| /src/utils/Create2Helper.sol | **** | **** | 45 | ||
| /src/InstanceDeployer.sol | 1 | **** | 214 | @safe/proxies/SafeProxyFactory.sol @safe/base/ModuleManager.sol @safe/base/OwnerManager.sol @safe/base/GuardManager.sol @interface/IMulticall3.sol @safe/proxies/SafeProxy.sol @safe/common/Enum.sol @safe/Safe.sol src/Guard.sol src/Timelock.sol src/TimelockFactory.sol src/utils/Create2Helper.sol |
|
| /src/RecoverySpell.sol | 1 | **** | 144 | @openzeppelin-contracts/contracts/utils/cryptography/EIP712.sol @openzeppelin-contracts/contracts/utils/cryptography/ECDSA.sol @safe/common/Enum.sol @safe/Safe.sol @interface/IMulticall3.sol @safe/base/OwnerManager.sol @safe/base/ModuleManager.sol |
|
| /src/RecoverySpellFactory.sol | 1 | **** | 56 | @src/RecoverySpell.sol src/utils/Create2Helper.sol |
|
| /src/deploy/SystemDeploy.s.sol | 1 | **** | 113 | @forge-proposal-simulator/src/proposals/MultisigProposal.sol @forge-proposal-simulator/addresses/Addresses.sol src/Guard.sol src/Timelock.sol src/TimelockFactory.sol src/InstanceDeployer.sol src/views/AddressCalculation.sol src/RecoverySpellFactory.sol |
|
| /src/BytesHelper.sol_ | 1 | **** | 33 | Function getFirstWord is out of scope in this file. |
|
| Totals | 10 | **** | 1393 |
- See out_of_scope.txt
- Any files not listed in the scope table are Out Of Scope
| Question | Answer |
|---|---|
| ERC20 used by the protocol | Any (all possible ERC20s) |
| Test coverage | Integration tests: 93.27% - Unit Tests: 84.62% |
| ERC721 used by the protocol | Any |
| ERC777 used by the protocol | Any |
| ERC1155 used by the protocol | Any |
| Chains the protocol will be deployed on | Arbitrum,Ethereum,Optimism,Base |
| Question | Answer |
|---|---|
| Missing return values | Out of scope |
| Fee on transfer | Out of scope |
| Balance changes outside of transfers | Out of scope |
| Upgradeability | Out of scope |
| Flash minting | Out of scope |
| Pausability | Out of scope |
| Approval race protections | Out of scope |
| Revert on approval to zero address | Out of scope |
| Revert on zero value approvals | Out of scope |
| Revert on zero value transfers | Out of scope |
| Revert on transfer to the zero address | Out of scope |
| Revert on large approvals and/or transfers | Out of scope |
| Doesn't revert on failure | Out of scope |
| Multiple token addresses | Out of scope |
| Low decimals ( < 6) | Out of scope |
| High decimals ( > 18) | Out of scope |
| Blocklists | Out of scope |
| Question | Answer |
|---|---|
| Enabling/disabling fees (e.g. Blur disables/enables fees) | No |
| Pausability (e.g. Uniswap pool gets paused) | No |
| Upgradeability (e.g. Uniswap gets upgraded) | No |
N/A
- All invariants are described here: https://github.com/solidity-labs-io/kleidi/blob/main/docs/INVARIANTS.md
There are no specific areas of concern, rather we want to make sure that all system components work together. We have already done a lot of testing around this, but we always want more eyes on things.
Cold signers & Hot signers
N/A
- Clone the repo;
git clone --recurse https://github.com/code-423n4/2024-10-kleidi.git
cd 2024-10-kleidi- Before running the tests, make sure your
ETH_RPC_URLis set. The integration tests will not work locally, so you will need to test unit tests in your local.
For bash/zsh;
export ETH_RPC_URL="https://mainnet.infura.io/v3/YOUR_PROJECT_ID"- Build;
foundryup
forge build- Unit Testing;
forge test --mc UnitTest -vvv- Integration Testing;
forge test --mc IntegrationTest -vvv --fork-url $ETH_RPC_URL --fork-block-number 20515328- Unit Test Coverage;
forge coverage --mc UnitTest --report lcov- Unit & Integration Test Coverage;
forge coverage --report summary --report lcov --fork-url $ETH_RPC_URL --fork-block-number 20515328| File | % Lines | % Statements | % Branches | % Funcs |
|---|---|---|---|---|
| src/BytesHelper.sol | 100.00% (13/13) | 100.00% (18/18) | 100.00% (10/10) | 100.00% (4/4) |
| src/ConfigurablePause.sol | 100.00% (18/18) | 100.00% (20/20) | 100.00% (6/6) | 100.00% (6/6) |
| src/Guard.sol | 100.00% (3/3) | 100.00% (3/3) | 100.00% (5/5) | 100.00% (2/2) |
| src/InstanceDeployer.sol | 100.00% (50/50) | 100.00% (63/63) | 66.67% (10/15) | 100.00% (2/2) |
| src/RecoverySpell.sol | 100.00% (42/42) | 100.00% (58/58) | 100.00% (13/13) | 100.00% (4/4) |
| src/RecoverySpellFactory.sol | 100.00% (21/21) | 100.00% (31/31) | 100.00% (17/17) | 100.00% (3/3) |
| src/Timelock.sol | 100.00% (215/215) | 100.00% (274/274) | 92.62% (113/122) | 100.00% (49/49) |
| src/TimelockFactory.sol | 100.00% (3/3) | 100.00% (3/3) | 100.00% (0/0) | 100.00% (2/2) |
| src/deploy/SystemDeploy.s.sol | 78.95% (30/38) | 80.00% (36/45) | 100.00% (6/6) | 0.00% (0/5) |
| src/views/AddressCalculation.sol | 100.00% (23/23) | 100.00% (28/28) | 100.00% (6/6) | 100.00% (3/3) |
| test/mock/MockERC1155.sol | 100.00% (2/2) | 100.00% (2/2) | 100.00% (0/0) | 100.00% (2/2) |
| test/mock/MockERC721.sol | 100.00% (2/2) | 100.00% (2/2) | 100.00% (0/0) | 100.00% (2/2) |
| test/mock/MockLending.sol | 100.00% (2/2) | 100.00% (2/2) | 100.00% (0/0) | 100.00% (2/2) |
| test/mock/MockReentrancyExecutor.sol | 100.00% (1/1) | 100.00% (1/1) | 100.00% (0/0) | 100.00% (1/1) |
| test/mock/MockSafe.sol | 40.00% (4/10) | 30.77% (4/13) | 0.00% (0/3) | 66.67% (4/6) |
| test/utils/CallHelper.t.sol | 100.00% (33/33) | 100.00% (42/42) | 100.00% (0/0) | 100.00% (6/6) |
| test/utils/SigHelper.sol | 100.00% (3/3) | 100.00% (6/6) | 100.00% (0/0) | 100.00% (2/2) |
| test/utils/SystemIntegrationFixture.sol | 100.00% (56/56) | 100.00% (60/60) | 100.00% (0/0) | 100.00% (2/2) |
| test/utils/TimelockUnitFixture.sol | 100.00% (8/8) | 100.00% (8/8) | 100.00% (0/0) | 100.00% (1/1) |
| Total | 97.42% (529/543) | 97.35% (661/679) | 91.63% (186/203) | 93.27% (97/104) |
| File | % Lines | % Statements | % Branches | % Funcs |
|---|---|---|---|---|
| src/BytesHelper.sol | 92.31% (12/13) | 94.44% (17/18) | 90.00% (9/10) | 100.00% (4/4) |
| src/ConfigurablePause.sol | 100.00% (18/18) | 100.00% (20/20) | 100.00% (6/6) | 100.00% (6/6) |
| src/Guard.sol | 100.00% (3/3) | 100.00% (3/3) | 100.00% (5/5) | 100.00% (2/2) |
| src/InstanceDeployer.sol | 0.00% (0/50) | 0.00% (0/63) | 0.00% (0/15) | 0.00% (0/2) |
| src/RecoverySpell.sol | 100.00% (42/42) | 100.00% (58/58) | 100.00% (13/13) | 100.00% (4/4) |
| src/RecoverySpellFactory.sol | 100.00% (21/21) | 100.00% (31/31) | 100.00% (17/17) | 100.00% (3/3) |
| src/Timelock.sol | 100.00% (215/215) | 100.00% (274/274) | 92.62% (113/122) | 100.00% (49/49) |
| src/TimelockFactory.sol | 100.00% (3/3) | 100.00% (3/3) | 100.00% (0/0) | 100.00% (2/2) |
| src/deploy/SystemDeploy.s.sol | 0.00% (0/38) | 0.00% (0/45) | 0.00% (0/6) | 0.00% (0/5) |
| src/views/AddressCalculation.sol | 0.00% (0/23) | 0.00% (0/28) | 0.00% (0/6) | 0.00% (0/3) |
| test/mock/MockERC1155.sol | 100.00% (2/2) | 100.00% (2/2) | 100.00% (0/0) | 100.00% (2/2) |
| test/mock/MockERC721.sol | 100.00% (2/2) | 100.00% (2/2) | 100.00% (0/0) | 100.00% (2/2) |
| test/mock/MockLending.sol | 100.00% (2/2) | 100.00% (2/2) | 100.00% (0/0) | 100.00% (2/2) |
| test/mock/MockReentrancyExecutor.sol | 100.00% (1/1) | 100.00% (1/1) | 100.00% (0/0) | 100.00% (1/1) |
| test/mock/MockSafe.sol | 40.00% (4/10) | 30.77% (4/13) | 0.00% (0/3) | 66.67% (4/6) |
| test/utils/CallHelper.t.sol | 100.00% (33/33) | 100.00% (42/42) | 100.00% (0/0) | 100.00% (6/6) |
| test/utils/SigHelper.sol | 0.00% (0/3) | 0.00% (0/6) | 100.00% (0/0) | 0.00% (0/2) |
| test/utils/SystemIntegrationFixture.sol | 0.00% (0/56) | 0.00% (0/60) | 100.00% (0/0) | 0.00% (0/2) |
| test/utils/TimelockUnitFixture.sol | 100.00% (8/8) | 100.00% (8/8) | 100.00% (0/0) | 100.00% (1/1) |
| Total | 67.40% (366/543) | 68.78% (467/679) | 80.30% (163/203) | 84.62% (88/104) |
Employees of Kleidi and employees' family members are ineligible to participate in this audit.
Code4rena's rules cannot be overridden by the contents of this README. In case of doubt, please check with C4 staff.