fix(deps): update dependency @openzeppelin/contracts to v4 [security] #1307
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.
This PR contains the following updates:
^3.3.0
->^4.0.0
GitHub Vulnerability Alerts
GHSA-9c22-pwxw-p6hx
Impact
Initializer functions that are invoked separate from contract creation (the most prominent example being minimal proxies) may be reentered if they make an untrusted non-view external call.
Once an initializer has finished running it can never be re-executed. However, an exception put in place to support multiple inheritance made reentrancy possible in the scenario described above, breaking the expectation that there is a single execution.
Note that upgradeable proxies are commonly initialized together with contract creation, where reentrancy is not feasible, so the impact of this issue is believed to be minor.
Patches
A fix is included in the version v4.4.1 of
@openzeppelin/contracts
and@openzeppelin/contracts-upgradeable
.Workarounds
Avoid untrusted external calls during initialization.
References
OpenZeppelin/openzeppelin-contracts#3006
Credits
This issue was identified and reported by @chaitinblockchain through our bug bounty on Immunefi.
For more information
If you have any questions or comments about this advisory, or need assistance executing the mitigation, email us at security@openzeppelin.com.
Release Notes
OpenZeppelin/openzeppelin-contracts
v4.4.1
Compare Source
Initializable
: change the existinginitializer
modifier and add a newonlyInitializing
modifier to prevent reentrancy risk. (#3006)Breaking change
It is no longer possible to call an
initializer
-protected function from within anotherinitializer
function outside the context of a constructor. Projects using OpenZeppelin upgradeable proxies should continue to work as is, since in the common case the initializer is invoked in the constructor directly. If this is not the case for you, the suggested change is to use the newonlyInitializing
modifier in the following way:v4.4.0
Compare Source
Ownable
: add an internal_transferOwnership(address)
. (#2568)AccessControl
: add internal_grantRole(bytes32,address)
and_revokeRole(bytes32,address)
. (#2568)AccessControl
: mark_setupRole(bytes32,address)
as deprecated in favor of_grantRole(bytes32,address)
. (#2568)AccessControlEnumerable
: hook into_grantRole(bytes32,address)
and_revokeRole(bytes32,address)
. (#2946)EIP712
: cacheaddress(this)
to immutable storage to avoid potential issues if a vanilla contract is used in a delegatecall context. (#2852)_setApprovalForAll
toERC721
andERC1155
. (#2834)Governor
: shift vote start and end by one block to better match Compound's GovernorBravo and prevent voting at the Governor level if the voting snapshot is not ready. (#2892)GovernorCompatibilityBravo
: consider quorum an inclusive rather than exclusive minimum to match Compound's GovernorBravo. (#2974)GovernorSettings
: a new governor module that manages voting settings updatable through governance actions. (#2904)PaymentSplitter
: now supports ERC20 assets in addition to Ether. (#2858)ECDSA
: add a variant oftoEthSignedMessageHash
for arbitrary length message hashing. (#2865)MerkleProof
: add aprocessProof
function that returns the rebuilt root hash given a leaf and a proof. (#2841)VestingWallet
: new contract that handles the vesting of Ether and ERC20 tokens following a customizable vesting schedule. (#2748)Governor
: enable receiving Ether when a Timelock contract is not used. (#2748)GovernorTimelockCompound
: fix ability to use Ether stored in the Timelock contract. (#2748)v4.3.3
Compare Source
ERC1155Supply
: HandletotalSupply
changes by hooking into_beforeTokenTransfer
to ensure consistency of balances and supply duringIERC1155Receiver.onERC1155Received
calls.v4.3.2
Compare Source
UUPSUpgradeable
: Add modifiers to preventupgradeTo
andupgradeToAndCall
being executed on any contract that is not the active ERC1967 proxy. This prevents these functions being called on implementation contracts or minimal ERC1167 clones, in particular.v4.3.1
Compare Source
TimelockController
: Add additional isOperationReady check.v4.3.0
Compare Source
ERC2771Context
: use private variable from storage to store the forwarder address. Fixes issues where_msgSender()
was not callable from constructors. (#2754)EnumerableSet
: addvalues()
functions that returns an array containing all values in a single call. (#2768)Governor
: added a modular system ofGovernor
contracts based onGovernorAlpha
andGovernorBravo
. (#2672)interfaces
folder containing solidity interfaces to final ERCs. (#2517)ECDSA
: addtryRecover
functions that will not throw if the signature is invalid, and will return an error flag instead. (#2661)SignatureChecker
: Reduce gas usage of theisValidSignatureNow
function for the "signature by EOA" case. (#2661)v4.2.0
Compare Source
ERC20Votes
: add a new extension of theERC20
token with support for voting snapshots and delegation. (#2632)ERC20VotesComp
: Variant ofERC20Votes
that is compatible with Compound'sComp
token interface but restricts supply touint96
. (#2706)ERC20Wrapper
: add a new extension of theERC20
token which wraps an underlying token. Deposit and withdraw guarantee that the total supply is backed by a corresponding amount of underlying token. (#2633)EnumerableSet
andEnumerableMap
.EnumerableSet
andEnumerableMap
.Counter
: add a reset method. (#2678)unchecked
blocks.Math
: Add aceilDiv
method for performing ceiling division.ERC1155Supply
: add a newERC1155
extension that keeps track of the totalSupply of each tokenId. (#2593)BitMaps
: add a newBitMaps
library that provides a storage efficient datastructure foruint256
tobool
mapping with contiguous keys. (#2710)Breaking Changes
ERC20FlashMint
is no longer a Draft ERC. (#2673))How to update: Change your import paths by removing the
draft-
prefix from@openzeppelin/contracts/token/ERC20/extensions/draft-ERC20FlashMint.sol
.v4.1.0
Compare Source
IERC20Metadata
: add a new extended interface that includes the optionalname()
,symbol()
anddecimals()
functions. (#2561)ERC777
: make reception acquirement optional in_mint
. (#2552)ERC20Permit
: add a_useNonce
to enable further usage of ERC712 signatures. (#2565)ERC20FlashMint
: add an implementation of the ERC3156 extension for flash-minting ERC20 tokens. (#2543)SignatureChecker
: add a signature verification library that supports both EOA and ERC1271 compliant contracts as signers. (#2532)Multicall
: add abstract contract withmulticall(bytes[] calldata data)
function to bundle multiple calls together (#2608)ECDSA
: add support for ERC2098 short-signatures. (#2582)AccessControl
: add aonlyRole
modifier to restrict specific function to callers bearing a specific role. (#2609)StorageSlot
: add a library for reading and writing primitive types to specific storage slots. (#2542)UUPSUpgradeable
to implement the UUPS proxy pattern together withEIP1967Proxy
. (#2542)Breaking changes
This release includes two small breaking changes in
TimelockController
.onlyRole
modifier in this contract was designed to let anyone through if the role was granted toaddress(0)
,allowing the possibility to to make a role "open", which can be used for
EXECUTOR_ROLE
. This modifier is nowreplaced by
AccessControl.onlyRole
, which does not have this ability. The previous behavior was moved to themodifier
TimelockController.onlyRoleOrOpenRole
.PROPOSER_ROLE
an open role (as described in the previous item) if it was granted toaddress(0)
. This would affect theschedule
,scheduleBatch
, andcancel
operations inTimelockController
.This ability was removed as it does not make sense to open up the
PROPOSER_ROLE
in the same way that it does forEXECUTOR_ROLE
.v4.0.0
Compare Source
Context
: making_msgData
returnbytes calldata
instead ofbytes memory
(#2492)ERC20
: removed the_setDecimals
function and the storage slot associated to decimals. (#2502)Strings
: addition of atoHexString
function. (#2504)EnumerableMap
: change implementation to optimize forkey → value
lookups instead of enumeration. (#2518)GSN
: deprecate GSNv1 support in favor of upcoming support for GSNv2. (#2521)ERC165
: remove uses of storage in the base ERC165 implementation. ERC165 based contracts now use storage-less virtual functions. Old behavior remains available in theERC165Storage
extension. (#2505)Initializable
: make initializer check stricter during construction. (#2531)ERC721
: remove enumerability of tokens from the base implementation. This feature is now provided separately through theERC721Enumerable
extension. (#2511)AccessControl
: removed enumerability by default for a more lightweight contract. It is now opt-in throughAccessControlEnumerable
. (#2512)ERC2771Context
and aMinimalForwarder
for meta-transactions. (#2508)ERC20Capped
: optimize gas usage by enforcing the check directly in_mint
. (#2524)UpgradeableProxy
toERC1967Proxy
. (#2547)ERC777
: optimize the gas costs of the constructor. (#2551)ERC721URIStorage
: add a new extension that implements the_setTokenURI
behavior as it was available in 3.4.0. (#2555)AccessControl
: added ERC165 interface detection. (#2562)ERC1155
: makeuri
public so overloading function can call it using super. (#2576)Bug fixes for beta releases
AccessControlEnumerable
: FixedrenounceRole
not updating enumerable set of addresses for a role. (#2572)How to upgrade from 3.x
Since this version has moved a few contracts to different directories, users upgrading from a previous version will need to adjust their import statements. To make this easier, the package includes a script that will migrate import statements automatically. After upgrading to the latest version of the package, run:
Make sure you're using git or another version control system to be able to recover from any potential error in our script.
How to upgrade from 4.0-beta.x
Some further changes have been done between the different beta iterations. Transitions made during this period are configured in the
migrate-imports
script. Consequently, you can upgrade from any previous 4.0-beta.x version using the same script as described in the How to upgrade from 3.x section.v3.4.2
Compare Source
TimelockController
: Add additional isOperationReady check.Configuration
📅 Schedule: "" (UTC).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by WhiteSource Renovate. View repository job log here.