feat(general): Ability to set key derivation algorithm #3731
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #3731 +/- ##
==========================================
+ Coverage 75.86% 77.10% +1.23%
==========================================
Files 470 476 +6
Lines 37301 28803 -8498
==========================================
- Hits 28299 22208 -6091
+ Misses 7071 4671 -2400
+ Partials 1931 1924 -7 ☔ View full report in Codecov by Sentry. |
redgoat650
approved these changes
Mar 22, 2024
Contributor
redgoat650
left a comment
There was a problem hiding this comment.
A few suggestions for user experience, but looks good otherwise
cli/command_repository_connect.go
Outdated
| cmd.Flag("enable-actions", "Allow snapshot actions").BoolVar(&c.connectEnableActions) | ||
| cmd.Flag("repository-format-cache-duration", "Duration of kopia.repository format blob cache").Hidden().DurationVar(&c.formatBlobCacheDuration) | ||
| cmd.Flag("disable-repository-format-cache", "Disable caching of kopia.repository format blob").Hidden().BoolVar(&c.disableFormatBlobCache) | ||
| cmd.Flag("key-derivation-algorithm", "Key Derivation Algorithm").Default(crypto.DefaultKeyDerivationAlgorithm).StringVar(&c.keyDerivationAlgorithm) |
Contributor
There was a problem hiding this comment.
Nit: matching capitalization of other flags
Suggested change
| cmd.Flag("key-derivation-algorithm", "Key Derivation Algorithm").Default(crypto.DefaultKeyDerivationAlgorithm).StringVar(&c.keyDerivationAlgorithm) | |
| cmd.Flag("key-derivation-algorithm", "Key derivation algorithm").Default(crypto.DefaultKeyDerivationAlgorithm).StringVar(&c.keyDerivationAlgorithm) |
cli/command_repository_connect.go
Outdated
| cmd.Flag("enable-actions", "Allow snapshot actions").BoolVar(&c.connectEnableActions) | ||
| cmd.Flag("repository-format-cache-duration", "Duration of kopia.repository format blob cache").Hidden().DurationVar(&c.formatBlobCacheDuration) | ||
| cmd.Flag("disable-repository-format-cache", "Disable caching of kopia.repository format blob").Hidden().BoolVar(&c.disableFormatBlobCache) | ||
| cmd.Flag("key-derivation-algorithm", "Key Derivation Algorithm").Default(crypto.DefaultKeyDerivationAlgorithm).StringVar(&c.keyDerivationAlgorithm) |
Contributor
There was a problem hiding this comment.
Suggestion: What if we used EnumVar instead of StringVar here? That way we can define the acceptable key derivation algo flag values in a user-friendly way? Similar to, e.g.
cmd.Flag("compression", "Compression algorithm").EnumVar(&c.policySetCompressionAlgorithm, supportedCompressionAlgorithms()...)
Suggested change
| cmd.Flag("key-derivation-algorithm", "Key Derivation Algorithm").Default(crypto.DefaultKeyDerivationAlgorithm).StringVar(&c.keyDerivationAlgorithm) | |
| cmd.Flag("key-derivation-algorithm", "Key Derivation Algorithm").Default(crypto.DefaultKeyDerivationAlgorithm).EnumVar(&c.keyDerivationAlgorithm, crypto.AllowedKeyDerivationAlgorithms()...) |
cli/command_user_add_set.go
Outdated
| } | ||
|
|
||
| cmd.Flag("ask-password", "Ask for user password").BoolVar(&c.userAskPassword) | ||
| cmd.Flag("key-derivation-algorithm", "Key Derivation Algorithm").Default(crypto.DefaultKeyDerivationAlgorithm).StringVar(&c.keyDerivationAlgorithm) |
Contributor
There was a problem hiding this comment.
Same suggestion here:
Suggested change
| cmd.Flag("key-derivation-algorithm", "Key Derivation Algorithm").Default(crypto.DefaultKeyDerivationAlgorithm).StringVar(&c.keyDerivationAlgorithm) | |
| cmd.Flag("key-derivation-algorithm", "Key Derivation Algorithm").Default(crypto.DefaultKeyDerivationAlgorithm).EnumVar(&c.keyDerivationAlgorithm, crypto.AllowedKeyDerivationAlgorithms()...) |
redgoat650
approved these changes
Mar 26, 2024
Contributor
redgoat650
left a comment
There was a problem hiding this comment.
Looks good, thanks for the flag improvements
Contributor
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 allows kopia users to pick the key derivation algorithm to use.
This is a follow up to #3725 which added the ability to switch between multiple key derivation algorithms.