Refactor ECDSA implementation #71
Conversation
WalkthroughThe recent changes in the Flow SDK enhance cryptographic functionalities, improve code clarity, and strengthen testing practices. Key updates include revamped cryptographic classes, streamlined data structures, and added validation checks for key handling. The test suite has been expanded to cover new scenarios, ensuring robust verification of signature and hashing algorithms. This comprehensive set of modifications aims to bolster security, usability, and maintainability across the SDK. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- sdk/src/main/kotlin/org/onflow/flow/sdk/crypto/Crypto.kt (3 hunks)
- sdk/src/main/kotlin/org/onflow/flow/sdk/models.kt (29 hunks)
- sdk/src/test/kotlin/org/onflow/flow/sdk/crypto/HashTest.kt (2 hunks)
- sdk/src/test/kotlin/org/onflow/flow/sdk/crypto/SignTest.kt (1 hunks)
- sdk/src/test/kotlin/org/onflow/flow/sdk/models/HashSigningAlgorithmTest.kt (2 hunks)
- sdk/src/test/kotlin/org/onflow/flow/sdk/models/SignerTest.kt (1 hunks)
Files skipped from review due to trivial changes (1)
- sdk/src/test/kotlin/org/onflow/flow/sdk/models/SignerTest.kt
Additional comments not posted (44)
sdk/src/test/kotlin/org/onflow/flow/sdk/models/HashSigningAlgorithmTest.kt (6)
3-3: Add import statement forHashAlgorithm.The import statement for
HashAlgorithmhas been added, indicating its usage in the tests.
8-8: Class renamed toSignatureAndHashingModelTest.The class name change reflects an expanded focus on both signature and hashing algorithms.
31-31: Update test method name for clarity.The method name has been updated to
Test signature fromCodefor better clarity.
38-39: Update test method name and comment for clarity.The method name has been updated to
Test signature fromCadenceIndexand the comment now references the correct documentation.
46-46: Update test method name for clarity.The method name has been updated to
Test signature fromCode with invalid codefor better clarity.
51-51: Update test method name for clarity.The method name has been updated to
Test signature fromCadenceIndex with invalid indexfor better clarity.sdk/src/test/kotlin/org/onflow/flow/sdk/crypto/HashTest.kt (1)
9-9: Update test method name for clarity.The method name has been updated to
Get default hasherfor better clarity.sdk/src/test/kotlin/org/onflow/flow/sdk/crypto/SignTest.kt (11)
3-3: Add import statements forSignatureAlgorithmandbytesToHex.The import statements for
SignatureAlgorithmandbytesToHexhave been added, indicating their usage in the tests.
10-15: AddSupportedCurvedata class.The
SupportedCurvedata class encapsulates details about each curve, including the signature algorithm, private key size, public key size, and curve order.
18-28: AddsupportedAlgoslist.The
supportedAlgoslist contains all supported curves of the library.
32-48: Update test method for key pair generation.The method
Test KeyPair generationiterates through supported algorithms and validates key pair generation and integrity.
52-73: Update test method for key decoding.The method
Can decode keys correctlyvalidates the decoding functionality for both private and public keys.
77-101: Update test method for private key decoding exceptions.The method
Private key decoding throws exception when invalidvalidates that exceptions are thrown for invalid private keys.
106-134: Update test method for public key decoding exceptions.The method
Public key decoding throws exception when invalidvalidates that exceptions are thrown for invalid public keys.
138-151: Add test method for public key derivation.The method
Test derivePublicKeyvalidates the derivation of public keys from private keys.
156-181: Add test method for signer compatibility with hash algorithms.The method
Test signer compatibility with hash algorithmsvalidates that the signer can handle different hash algorithms and raises exceptions for unsupported ones.
185-209: Add test method for signer correctness.The method
Test signer correctnessvalidates the correctness of signatures.
213-237: Add test method for signer with invalid algorithm keys.The method
Test signer with invalid algo keysvalidates that exceptions are thrown for invalid algorithm keys.sdk/src/main/kotlin/org/onflow/flow/sdk/crypto/Crypto.kt (14)
5-7: Imports look good.The new imports for cryptographic parameters and signers from Bouncy Castle are necessary and correctly used.
Also applies to: 14-15, 18-19
37-43: Changes toPrivateKeydata class are approved.The addition of
algoandpublicKeyfields enhances the class by providing more context and usability.
47-80: Changes toPublicKeydata class are approved.The addition of the
algofield and theverifymethod enhances the class by providing more context and functionality for signature verification.
88-94: New methodcheckSupportedSignAlgois approved.The method correctly enforces algorithm compatibility checks and handles unsupported algorithms appropriately.
95-123: RefactoredgenerateKeyPairmethod is approved.The method correctly generates key pairs with the new fields in
PrivateKeyandPublicKey, enhancing the integrity of key generation.
127-163: RefactoreddecodePrivateKeymethod is approved.The method correctly decodes private keys with the new fields in
PrivateKey, enhancing the integrity of key decoding.
167-198: RefactoreddecodePublicKeymethod is approved.The method correctly decodes public keys with the new field in
PublicKey, enhancing the integrity of key decoding.
204-208: RefactoredgetSignerandgetHashermethods are approved.The methods correctly return instances of
SignerandHasherwith the new implementations, enhancing the functionality.
210-301: New and refactored methods inCryptoobject are approved.The methods correctly implement the intended functionality, enhancing the overall cryptographic capabilities of the SDK.
342-355: Updates toHasherImplclass are approved.The class correctly implements new hashing algorithms and validation checks, enhancing the hashing capabilities.
372-397: RefactoredSignerImplclass is approved.The class correctly implements the new signing process using
ECDSASigner, enhancing the signing capabilities.
292-301: NewformatSignaturemethod is approved.The method correctly formats signatures, ensuring proper handling of the resulting signature.
249-265: NewderivePublicKeymethod is approved.The method correctly derives the public key from the private key, enhancing the key management capabilities.
267-273: NewcheckHashAlgoForSigningmethod is approved.The method correctly enforces hash algorithm compatibility checks and handles unsupported algorithms appropriately.
sdk/src/main/kotlin/org/onflow/flow/sdk/models.kt (12)
19-21: ReformattedFlowTransactionStatusenum is approved.The reformatting improves readability without altering functionality.
58-60: ReformattedSignatureAlgorithmenum is approved.The reformatting improves readability without altering functionality.
142-147: RefactoredFlowAccountdata class is approved.The refactoring simplifies the
buildermethod definition without altering functionality.
152-161: RefactoredgetKeyIndexmethod inFlowAccountdata class is approved.The refactoring improves readability without altering functionality.
187-194: RefactoredFlowAccountKeydata class is approved.The refactoring simplifies the
buildermethod definition without altering functionality.
223-227: RefactoredFlowEventResultdata class is approved.The refactoring simplifies the
buildermethod definition without altering functionality.
Line range hint
486-530:
RefactoredFlowTransactiondata class is approved.The refactoring simplifies the
buildermethod and other method definitions without altering functionality.
576-579: RefactoredFlowTransactionProposalKeydata class is approved.The refactoring simplifies the
buildermethod definition without altering functionality.
600-603: RefactoredFlowTransactionSignaturedata class is approved.The refactoring simplifies the
buildermethod definition without altering functionality.
Line range hint
621-657:
RefactoredFlowBlockHeaderandFlowBlockdata classes are approved.The refactoring simplifies the
buildermethod definitions without altering functionality.
Line range hint
777-803:
RefactoredFlowCollectionGuaranteeandFlowBlockSealdata classes are approved.The refactoring simplifies the
buildermethod definitions without altering functionality.
819-821: RefactoredFlowCollectiondata class is approved.The refactoring simplifies the
buildermethod definition without altering functionality.
This PR refactors the ECDSA implementation, fixes potential issues, and add proper testing (almost inexistent before the PR).
Changes:
PrivateKeyandPublicKeyfields - in particular allow accessing the public key from the private key.verifyto thePublicKeytype. The method verifies a signature against a message using an input hashing algorithm.ecCoupleComponentSizewhich confuses the group order size and the prime field size.PublicKeyserialization which did not pad the point coordinates to the prime field order.PrivateKeyserialization is also padded to the group order size. Size checks are enforced in deserialization functions.models.kthas mainly formatting changes only).Signerdoes not implementHasheras it doesn't make sense to use aSignerto hash data.PrivateKeyandPublicKeyfields are updated (alternatively, it is safer to make the internal fields private and allow the construction ofPrivateKeyandPublicKeyonly through functions and constructors that check the fields are compatible, but this would be a larger breaking change)PrivateKeyserialization is now padded to the order size. Deserializing a private key string also requires the input to be padded.SignerImpldoes not accept aHasherinput. TheHashAlgorithminput is enough to get the hasher implementation.Summary by CodeRabbit
New Features
Bug Fixes
Documentation