NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve VestingWallet's constructor and RSA.pkcs1Sha256 documentation (#5229)

Browse Source
This commit is contained in:
Hadrien Croubois
2024-09-27 07:48:15 +02:00
committed by GitHub
parent 057d35a9eb
commit ae753b7eac
3 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
contracts/finance/VestingWallet.sol
View File

@ -37,8 +37,8 @@ contract VestingWallet is Context, Ownable {
uint64 private immutable _duration;
/**
* @dev Sets the sender as the initial owner, the beneficiary as the pending owner, the start timestamp and the
* vesting duration of the vesting wallet.
* @dev Sets the beneficiary (owner), the start timestamp and the vesting duration (in seconds) of the vesting
* wallet.
*/
constructor(address beneficiary, uint64 startTimestamp, uint64 durationSeconds) payable Ownable(beneficiary) {
_start = startTimestamp;

3
contracts/finance/VestingWalletCliff.sol
View File

@ -17,7 +17,8 @@ abstract contract VestingWalletCliff is VestingWallet {
error InvalidCliffDuration(uint64 cliffSeconds, uint64 durationSeconds);
/**
* @dev Set the start timestamp of the vesting wallet cliff.
* @dev Set the duration of the cliff, in seconds. The cliff starts vesting schedule (see {VestingWallet}'s
* constructor) and ends `cliffSeconds` later.
*/
constructor(uint64 cliffSeconds) {
if (cliffSeconds > duration()) {

15
contracts/utils/cryptography/RSA.sol
View File

@ -27,14 +27,15 @@ library RSA {
/**
* @dev Verifies a PKCSv1.5 signature given a digest according to the verification
* method described in https://datatracker.ietf.org/doc/html/rfc8017#section-8.2.2[section 8.2.2 of RFC8017] with support
* for explicit or implicit NULL parameters in the DigestInfo (no other optional parameters are supported).
* method described in https://datatracker.ietf.org/doc/html/rfc8017#section-8.2.2[section 8.2.2 of RFC8017] with
* support for explicit or implicit NULL parameters in the DigestInfo (no other optional parameters are supported).
*
* IMPORTANT: For security reason, this function requires the signature and modulus to have a length of at least 2048 bits.
* If you use a smaller key, consider replacing it with a larger, more secure, one.
* IMPORTANT: For security reason, this function requires the signature and modulus to have a length of at least
* 2048 bits. If you use a smaller key, consider replacing it with a larger, more secure, one.
*
* WARNING: PKCS#1 v1.5 allows for replayability given the message may contain arbitrary optional parameters in the
* DigestInfo. Consider using an onchain nonce or unique identifier to include in the message to prevent replay attacks.
* WARNING: This verification algorithm doesn't prevent replayability. If called multiple times with the same
* digest, public key and (valid signature), it will return true every time. Consider including an onchain nonce or
* unique identifier in the message to prevent replay attacks.
*
* @param digest the digest to verify
* @param s is a buffer containing the signature
@ -79,7 +80,7 @@ library RSA {
// - PS is padding filled with 0xFF
// - DigestInfo ::= SEQUENCE {
// digestAlgorithm AlgorithmIdentifier,
// [optional algorithm parameters]
// [optional algorithm parameters] -- not currently supported
// digest OCTET STRING
// }