add ZeroizeOnDrop to XprvData and XPrv #6
Merged
Conversation
This file contains hidden or 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
benma
reviewed
Jul 22, 2024
| @@ -134,7 +133,7 @@ struct XprvData { | |||
| } | |||
|
|
|||
| /// The `D` digest type param must implement SHA512. Use `sha2::Sha512` if in doubt. | |||
| #[derive(Clone, Debug)] | |||
| #[derive(Zeroize, ZeroizeOnDrop, Clone, Debug)] | |||
There was a problem hiding this comment.
What's the purpose of this? Since XprvData already has these, and it's the only field in this struct, it seems that this does not add anything.
There was a problem hiding this comment.
Valid question, but XPriv does not zeroization out of the box which is not an issue on its own as you noted. However, if a downstream project wants to wrap Xprv and then have the zeroization derived on the wrapper it won't work because the wrapping type here (Xprv) does not support zeroization. Hope that makes sense.
|
Local install seems to not want to amend the commit with a GPG signature. Please let me know if that is required for this PR. |
benma
approved these changes
Jul 22, 2024
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.
This is a small MR changing how
Zeroizeis being used. The main contribution is addingZeroizeandZeroizeOnDroptoXprv.A secondary change is removing
#[zeroize(drop)]fromXprvDataand replacing it withZeroizeOnDropbecause it is deprecated according to the documentation.If I missed anything I am happy to edit the PR.