feat!: expose secret key length as a constant #181
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
|
Technically, this change is breaking in the sense that if anyone implemented the |
sdbondi
changed the title
SWvheerden
pushed a commit
to tari-project/tari
that referenced
this pull request
Jun 15, 2023
Description --- Cleans up and improves `EncryptedData` for simpler operations. Supersedes [PR 5433](#5433). Motivation and Context --- A pending PR updates `EncryptedData` to zeroize the plaintext commitment mask and expose the data as a tuple of byte arrays. However, there are more improvements and simplifications we can make. This PR does several things: - Uses the `const-generics` feature in `borsh` to allow for the use of a single byte array to represent the entire `EncryptedData` struct - Performs zeroizing of the plaintext mask during encryption and decryption - Uses the work in [another PR](tari-project/tari-crypto#181) to get the byte-encoded length of the mask at compile time (instead of relying on a brittle use of `size_of` that isn't guaranteed to hold) - Removes heap allocations during encryption and decryption - Provides `as_bytes` to expose the `EncryptedData` as a byte slice - Provides `to_bytes` to expose the `EncryptedData` as a byte array - Cleans up comments and naming for clarity - Updates faucet output JSON encoding to account for the changes (this does not affect genesis block data otherwise) How Has This Been Tested? --- Existing tests pass. What process can a PR reviewer use to test or verify this change? --- Confirm that existing tests pass, and that the listed features are implemented correctly. Breaking Changes --- There are no breaking changes. The existing `EncryptedData` API is unchanged.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently, the
PublicKeytrait exposes the encoded key byte length via the associatedKEY_LENconstant, and also provides it via thekey_lengthfunction. However, theSecretKeytrait only exposes its encoded key byte length via thekey_lengthfunction, which cannot be constant. There are use cases where it's handy to get the key size at compile time, particularly when you want to use arrays and avoid heap allocations.This PR unifies the
PublicKeyandSecretKeytraits by adding an associatedKEY_LENconstant toSecretKey. It then updates theRistrettoSecretKeyimplementation accordingly.BREAKING CHANGE: The
SecretKeytrait now requires aKEY_LENconstant.