Add final audit report and changelog (#305)

Author: rmeissner

CHANGELOG.md

@@ -0,0 +1,235 @@
+# Changelog
+
+This changelog only contains changes starting from version 1.3.0
+
+# Version 1.3.0
+
+## Compiler settings
+
+Solidity compiler: [0.7.6](https://github.com/ethereum/solidity/releases/tag/v0.7.6) (more info see issue [#251](https://github.com/gnosis/safe-contracts/issues/251))
+
+Solidity optimizer: `disabled`
+
+## Expected deterministic deployment addresses
+
+### Core contracts
+- `GnosisSafe` at `0xd9Db270c1B5E3Bd161E8c8503c55cEABeE70955`
+- `GnosisSafeL2` at `0x3E5c63644E683549055b9Be8653de26E0B4CD36E`
+### Factory contracts
+- `GnosisSafeProxyFactory` at `0xa6B71E26C5e0845f74c812102Ca7114b6a896AB2`
+### Handler contracts
+- `DefaultCallbackHandler` at `0x1AC114C2099aFAf5261731655Dc6c306bFcd4Dbd`
+- `CompatibilityFallbackHandler` at `0xf48f2B2d2a534e402487b3ee7C18c33Aec0Fe5e4`
+### Lib contracts
+- `MultiSend` at `0xA238CBeb142c10Ef7Ad8442C6D1f9E89e07e7761`
+- `MultiSendCallOnly` at `0x40A2aCCbd92BCA938b02010E17A5b8929b49130D`
+- `CreateCall` at `0x7cbB62EaA69F79e6873cD1ecB2392971036cFAa4`
+### Storage reader contracts
+- `SimulateTxAccessor` at `0x59AD6735bCd8152B84860Cb256dD9e96b85F69Da`
+
+## Changes
+
+### Core contract
+File: [`contracts/GnosisSafe.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/GnosisSafe.sol)
+
+#### Add chainId to transaction hash
+Issue: [#170](https://github.com/gnosis/safe-contracts/issues/170)
+
+Expected behaviour:
+
+The `chainId` has been added to the [EIP-712](https://eips.ethereum.org/EIPS/eip-712) domain. In case of a change of the `chainId` (e.g. hardfork related) the new `chainId` will automatically be used for future signature checks.
+
+#### Add transaction guard
+Issue: [#224](https://github.com/gnosis/safe-contracts/issues/224)
+
+Expected behaviour:
+
+It is possible to add a transaction guard, which can check all of the parameters that have been sent to `execTransaction` prior to execution. For this check the `checkTransaction` needs to be implemented by the guard. In case that `checkTransaction` reverts, `execTransaction` will also revert. Another check that can be implemented by the guard is `checkAfterExecution`. This check is called at the very end of the execution and allows to perform checks on the final state of the Safe. The parameters passed to that check are the `safeTxHash` and a `success` boolean.
+
+#### Add StorageAccessible support
+Issue: [#201](https://github.com/gnosis/safe-contracts/issues/201)
+
+Expected behaviour:
+
+It is possible to use `simulateDelegatecallInternal` to simulate logic on the Safe by providing a contract and calldata. This contract will then be called via a delegatecall and the result will be returned via a revert.The revert data will have the following format: 
+`success:bool || response.length:uint256 || response:bytes`. 
+
+Important: This method will always revert.
+
+#### Remove changeMasterCopy
+Expected behaviour:
+
+It is not possible anymore to change the singleton address (formerly known as master copy) via a method call. To make the implications of a singleton address change more visible it is required to use a delegatecall with a migration contract. (See example migration in libraries)
+
+#### Make checkSignature public
+Issue: [#248](https://github.com/gnosis/safe-contracts/issues/248)
+
+Expected behaviour:
+
+The `checkSignature` method is now a view method that is public. This makes it possible that it can be used in other contracts (e.g. modules) to make it easier to reuse existing signature check logic. The function expects that there are at least enough valid signatures to hit the threshold.
+Another method that has been added to make the usage from external contracts easier is `checkNSignatures` which allows to set how many valid signatures are expected.
+Note: The storage allocated by `approveHash` will no longer be zeroed when being used in `checkSignature`. If this is required a delegatecall with a contract that zeroes past approved hashes should be used.
+
+#### Remove authorized from requiredTxGas
+Issue: [#247](https://github.com/gnosis/safe-contracts/issues/247)
+
+Expected behaviour:
+
+To make it easier to interact with this method (e.g. by providing a wrapper). The requirement that the method can only be called by the Safe itself has been removed. The method will still always revert. 
+Note: This method is superseded by the `StorageAccessible` logic and will be removed in the next major version.
+
+#### Move EIP-1271 logic to fallback handler
+Issue: [#223](https://github.com/gnosis/safe-contracts/issues/223)
+
+Expected behaviour:
+
+As [EIP-1271](https://eips.ethereum.org/EIPS/eip-1271) is still changing the logic for it has been moved to a fallback handler. The fallback handler uses the `checkSignatures` method to validate the signatures. Also this fallback handler supports the latest version of [EIP-1271](https://eips.ethereum.org/EIPS/eip-1271). The logic to mark a message hash as signed in the contract also has been moved to other contracts. `getMessageHash` has been moved to a fallback handler and `signMessage` into a library that can be used via delegatecall.
+Note: The `checkSignature` method still uses the previous version of [EIP-1271](https://eips.ethereum.org/EIPS/eip-1271) that uses the data to be signed instead of the hash of the data.
+
+#### Send along msg.sender to fallback handler
+Issue: [#246](https://github.com/gnosis/safe-contracts/issues/246)
+
+Expected behaviour:
+
+When the Safe forwards a call to the fallback handler it will append the `msg.sender` to the calldata. This will allow the fallback handler to use this information. 
+Note: Fallback handlers should make sure that the connected Safe supports this, else this can be used by the caller to influence the fallback handler (by specifying an arbitrary `msg.sender`)
+
+#### Revert on failure if safeTxGas and gasPrice are 0
+Issue: [#274](https://github.com/gnosis/safe-contracts/issues/274)
+
+Expected behaviour:
+
+If `safeTxGas` is 0 (therefore all available gas has been used for the internal tx) and `gasPrice` is also 0 (therefore no refund is involved) the transaction will revert when the internal tx fails. This makes it easier to interact with the Safe without having to estimate the internal transaction ahead of time.
+
+#### Add setup event
+Issue: [#233](https://github.com/gnosis/safe-contracts/issues/233)
+
+Expected behaviour:
+
+The Safe now emits an event that contains all setup information that influences the State of the nearly setup Safe. The initializer calldata is omitted to prevent excessive gas costs. And the refund information is omitted as they don’t have an influence on the internal contract state.
+
+#### Add incoming ETH event
+Issue: [#209](https://github.com/gnosis/safe-contracts/issues/209)
+
+Expected behaviour:
+
+When the Safe is receiving ETH it will now trigger an event (with exception of ETH received via a call to `execTransaction` or as a result of a selfdestruct of another contract).
+Note: It will not be possible anymore to send ETH via the solidity calls transfer or send to a Safe. This is expected to break because of the gas costs changes with the Berlin hard fork ([EIP-2929](https://eips.ethereum.org/EIPS/eip-2929)) in any case (even without the event) when using the legacy transaction format. As there is also a new transaction format ([EIP-2930](https://eips.ethereum.org/EIPS/eip-2930)) it is possible to use that together with the correct access list to still execute transfer/ send calls and emit the event.
+
+### Layer 2
+
+#### Add contract version that emits Safe tx information via events
+File: [`contracts/GnosisSafeL2.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/GnosisSafeL2.sol)
+
+Expected behaviour:
+
+The extended version will emit an event with all the information related to the Safe transaction that will be executed. As this is quite gas expensive, it is only expected that this version will be used on Layer 2 networks with low gas prices.
+It is expected that the events are emitted on entry to the method. As the normal Safe methods emit already some events after the execution of the Safe transaction. This will make it possible to connect other events to that call as they are "boxed" by the GnosisSafeL2 events and the GnosisSafe events.
+
+Example:
+
+On entry into `execTransaction` of the `GnosisSafeL2` contract a `SafeMultiSigTransaction` event will be emitted that contains all the parameters of the function and the `nonce`, `msg.sender` and `threshold`. Once the internal execution has finished the `execTransaction` of the `GnosisSafe` contract will emit a `ExecutionSuccess` or `ExecutionFailure` event. When processing the events of that transaction it is now possible to connect all events that were emitted between these two events to this specific Safe transaction.
+Same can be done with the `SafeModuleTransaction` and `ExecutionFromModuleSuccess` (or `ExecutionFromModuleFailure`) events when executing a transaction via a module.
+
+### Fallback handlers
+
+#### Add EIP-165 support to DefaultCallbackHandler
+Issue: [#161](https://github.com/gnosis/safe-contracts/issues/161)
+
+File: [`contracts/handler/DefaultCallbackHandler.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/handler/DefaultCallbackHandler.sol)
+
+Expected behaviour:
+
+Indicate via the `supportsInterface` method of [EIP-165](https://eips.ethereum.org/EIPS/eip-165) that the [EIP-721](https://eips.ethereum.org/EIPS/eip-721) and [EIP-1155](https://eips.ethereum.org/EIPS/eip-1155) receiver interfaces are supported. 
+
+#### Add CompatibilityFallbackHandler
+Issue: [#223](https://github.com/gnosis/safe-contracts/issues/223)
+
+File: [`contracts/handler/CompatibilityFallbackHandler.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/handler/CompatibilityFallbackHandler.sol)
+
+Expected behaviour:
+
+The `CompatibilityFallbackHandler` extends the `DefaultCallbackHandler` and implements support for some logic that has been removed from the core contracts. Namely [EIP-1271](https://eips.ethereum.org/EIPS/eip-1271) support and the non reverting method of the `StorageAccessible` contract. Also the fallback manager contains the logic to verify Safe messages.
+
+#### Add possibility to get sender in fallback handler
+File: [`contracts/handler/HandlerContext.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/handler/HandlerContext.sol)
+
+Expected behaviour:
+
+The `HandlerContext` can be used to retrieve the `msg.sender` and the Safe (aka manager) that have been forwarding the call to the fallback handler. The `msg.sender` is expected to be appended to the calldata (e.g. last 20 bytes). This will only work if used with a Safe contract that supports this (e.g. 1.3.0 or newer).
+
+### Guard
+
+#### Add DelegateCallTransactionGuard
+File: [`contracts/examples/guards/DelegateCallTransactionGuard.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/examples/guards/DelegateCallTransactionGuard.sol)
+
+Note: **This contract is meant as an example to demonstrate how to facilitate a guard. This should not be used in production without further checks.**
+
+Expected behaviour:
+
+This transaction guard can be used to prevent that Safe transactions that use a delegatecall operation are being executed. It is also possible to specify an exception when deploying the contract (e.g. a `MultiSendCallOnly` instance).
+
+#### Add DebugTransactionGuard
+File: [`contracts/examples/guards/DebugTransactionGuard.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/examples/guards/DebugTransactionGuard.sol)
+
+Note: **This contract is meant as an example to demonstrate how to facilitate a guard. This should not be used in production without further checks.**
+
+Expected behaviour:
+
+This transaction guard can be used to log more details about a transaction. This is similar to what the L2 version of the Safe does, but implemented as a transaction guard. One event will be emitted containing the transaction details and another to track the status of a specific nonce.
+
+#### Add ReentrancyTransactionGuard
+File: [`contracts/examples/guards/ReentrancyTransactionGuard.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/examples/guards/ReentrancyTransactionGuard.sol)
+
+Note: **This contract is meant as an example to demonstrate how to facilitate a guard. This should not be used in production without further checks.**
+
+Expected behaviour:
+
+This transaction guard can be used to prevent that Safe transactions can re-enter the `execTransaction` method. The transaction guard does not differentiate between different Safes, so if multiple Safes use the same guard instance it prevents entrancy in all of the connected Safes.
+
+### Libraries
+
+#### Make multiSend payable to avoid check on msg.value
+Issue: [#227](https://github.com/gnosis/safe-contracts/issues/227)
+
+File: [`contracts/libraries/MultiSend.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/libraries/MultiSend.sol)
+
+Expected behaviour:
+
+The `multiSend` is now payable therefore will enforce anymore that `msg.value` is 0. ETH that is not transferred out again will remain in `this` (the calling contract when used via a delegatecall or the contract when used via call, only possible with `MultiSendCallOnly`)
+
+#### Add MuliSend that disallows delegate operation
+File: [`contracts/libraries/MultiSendCallOnly.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/libraries/MultiSendCallOnly.sol)
+
+Expected behaviour:
+
+The logic is the same as for the normal `MultiSend`, but when an attempt is made to execute a transaction via a delegatecall the contract will revert.
+Note: The encoding of the data send to the `multiSend` method is exactly the same as for the normal `MultiSend`, this makes it easy to exchange the contracts depending on the use case.
+
+#### Add base contract for Gnosis Safe storage layout
+File: [`contracts/examples/libraries/GnosisSafeStorage.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/examples/libraries/GnosisSafeStorage.sol)
+
+Note: **This contract is meant as an example to demonstrate how access the Gnosis Safe state within a library contract. This should not be used in production without further checks.**
+
+Expected behaviour:
+
+The contract contains the basic storage layout of the `GnosisSafe.sol` contract.
+
+#### Add contract to mark Safe messages as signed
+File: [`contracts/examples/libraries/SignMessage.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/examples/libraries/SignMessage.sol)
+
+Note: **This contract is meant as an example to demonstrate how to mark Safe message as signed in the signedMessages mapping. This should not be used in production without further checks.**
+
+Expected behaviour:
+
+The library is meant as a compatibility tool for the removed `signMessage` function from the pre-1.3.0 Safe contracts. It has the same signature and assumes the same storage layout as the previous Safe contract versions. After calling this function with a massage, the hash of that message should be marked as executed in the `signedMessages` mapping.
+
+#### Add Migration example to downgrade from 1.3.0 to 1.2.0
+File: [`contracts/examples/libraries/Migrate_1_3_0_to_1_2_0.sol`](https://github.com/gnosis/safe-contracts/blob/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9/contracts/examples/libraries/Migrate_1_3_0_to_1_2_0.sol)
+
+Note: **This contract is meant as an example to demonstrate how to facilitate migration in the future. This should not be used in production without further checks.**
+
+Expected behaviour:
+
+This migration can be used to migrate a Safe to another singleton address. Once the migration has been executed the singleton address will point to the address specified in the constructor of the migration and the domain separator will be properly set in storage (as this is required by the 1.2.0 version of the Safe contracts).
+Note: This is meant as an example contract, only to be used in production if you know what you do.

README.md

@@ -28,6 +28,8 @@ To add support for a new network follow the steps of the ``Deploy`` section and
 
 ### Deploy
 
+> :warning: **Make sure to use the correct commit when deploying the contracts.** Any change (even comments) within the contract files will result in different addresses. The tagged versions that are used by the Gnosis Safe team can be found in the [releases](https://github.com/gnosis/safe-contracts/releases).
+
 This will deploy the contracts deterministically and verify the contracts on etherscan using [Solidity 0.7.6](https://github.com/ethereum/solidity/releases/tag/v0.7.6) by default.
 
 Preparation:

…es/guards/ReentrencyTransactionGuard.sol …es/guards/ReentrancyTransactionGuard.solcontracts/examples/guards/ReentrencyTransactionGuard.sol renamed to contracts/examples/guards/ReentrancyTransactionGuard.sol contracts/examples/guards/ReentrencyTransactionGuard.sol renamed to contracts/examples/guards/ReentrancyTransactionGuard.sol

@@ -5,8 +5,8 @@ import "../../common/Enum.sol";
 import "../../base/GuardManager.sol";
 import "../../GnosisSafe.sol";
 
-contract ReentrencyTransactionGuard is Guard {
-    bytes32 internal constant GUARD_STORAGE_SLOT = keccak256("reentrentry_guard.guard.struct");
+contract ReentrancyTransactionGuard is Guard {
+    bytes32 internal constant GUARD_STORAGE_SLOT = keccak256("reentrancy_guard.guard.struct");
 
     struct GuardValue {
         bool active;
@@ -41,7 +41,7 @@ contract ReentrencyTransactionGuard is Guard {
         address
     ) external override {
         GuardValue storage guard = getGuard();
-        require(!guard.active, "Reentrency detected");
+        require(!guard.active, "Reentrancy detected");
         guard.active = true;
     }
 

docs/Gnosis_Safe_Audit_Report_1_3_0_Final.pdf

@@ -5,7 +5,15 @@
   * Adam Kolář (@adamkolar)
 
 ##### Notes
-The audit was performed on commit [4bfc0c8519f1893015d7edfd2c2780fca163c364](https://github.com/gnosis/safe-contracts/tree/4bfc0c8519f1893015d7edfd2c2780fca163c364) and contract changes until commit [9b305a0f80da7f1107d1181f52c844f089557d05](https://github.com/gnosis/safe-contracts/tree/9b305a0f80da7f1107d1181f52c844f089557d05) have been checked.
+An initial audit was performed on commit [4bfc0c8519f1893015d7edfd2c2780fca163c364](https://github.com/gnosis/safe-contracts/tree/4bfc0c8519f1893015d7edfd2c2780fca163c364) and contract changes until commit [9b305a0f80da7f1107d1181f52c844f089557d05](https://github.com/gnosis/safe-contracts/tree/9b305a0f80da7f1107d1181f52c844f089557d05) have been checked.
+
+The final audit was performed on commit [ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9](https://github.com/gnosis/safe-contracts/tree/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9).
+
 
 ##### Files
-* [Audit Report 1.3.0](Gnosis_Safe_Audit_Report_1_3_0.pdf)
+* [Final Audit Report 1.3.0](Gnosis_Safe_Audit_Report_1_3_0_Final.pdf)
+* [Initial Audit Report 1.3.0](Gnosis_Safe_Audit_Report_1_3_0_Initial.pdf)
+
+##### External links for Audit Reports
+* [Final Audit Report 1.3.0](https://github.com/g0-group/Audits/blob/9c18c800e65d28a8cf9f608c9dbbc13edbac70c8/GnosisSafeMay2021.pdf)
+* [Initial Audit Report 1.3.0](https://github.com/g0-group/Audits/blob/9c18c800e65d28a8cf9f608c9dbbc13edbac70c8/GnosisSafeApr2021.pdf)