Add an encrypted config option to pcli #4343
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
cratelyn
added
A-client
cratelyn
approved these changes
May 7, 2024
There was a problem hiding this comment.
small details, this looks like excellent work, @cronokirby!
|
Addressed these suggestions in the latest commit |
cratelyn
approved these changes
May 7, 2024
|
I think if we're going to change the user input logic we should just have it retry on parse failure rather than handle empty strings specially, so we can close out #4335 |
redshiftzero
reviewed
May 7, 2024
|
Given that we plan to point-release this fix, please make sure to squash it down into a single commit, to ensure that cherry-picking doesn't miss anything. Refs #4345. |
This needs to be done because the new encrypted custody backend will also make use of the trait, so it needs to be moved outside of that particular module.
This means that you don't need to enter passwords unless custody methods are actually called
Co-authored-by: cratelyn <cratelyn@users.noreply.github.com>
This prevents them from changing without us realizing it, since we want backwards compatability.
hdevalence
force-pushed
the
4293-pcli-encrypted-config
branch
from
1af06e9 to
0349055
Compare
|
I rebased this to resolve a spurious conflict but I'm a little unclear on the status -- is this good to merge? |
|
We should not try to solve #4335 as part of this, looking at the threshold code it turns out to be somewhat involved |
|
This was all good to merge last evening, I just wanted to address the hard coded argon2 params, and to extend encryption to governance subkeys. Those were all included, so. |
hdevalence
added a commit
that referenced
this pull request
May 8, 2024
## Describe your changes Improves UX for the DKG ceremony based on user feedback, so we can actually tell people to use it. This is a PR on top of #4343 to make it as easy as possible to merge. ## Issue ticket number and link #4335 ## Checklist before requesting a review - [x] If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason: > client-side key generation logic only
hdevalence
pushed a commit
that referenced
this pull request
May 8, 2024
This adds a new option to encrypt the `soft-kms` and `threshold` custody backends with a password, so that spend-key related material is encrypted at rest. This is implemented by: 1. Having a `pcli init --encrypted` flag that applies to both of these backends, which prompts a user for a password (and confirmation) before using that to encrypt the config. 2. Having a `pcli init re-encrypt` command to read an existing config and encrypt its backend, if necessary, to allow importing existing configs. This is also implemented internally in a lazy way, so that a password is only prompted when the custody services methods are actually called, allowing us to not need a password for view only commands. Closes #4293. - [x] If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason: > This is a client-only change. --------- Co-authored-by: cratelyn <cratelyn@users.noreply.github.com>
hdevalence
added a commit
that referenced
this pull request
May 8, 2024
## Describe your changes Improves UX for the DKG ceremony based on user feedback, so we can actually tell people to use it. This is a PR on top of #4343 to make it as easy as possible to merge. ## Issue ticket number and link #4335 ## Checklist before requesting a review - [x] If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason: > client-side key generation logic only
1 task
conorsch
pushed a commit
that referenced
this pull request
May 8, 2024
This adds a new option to encrypt the `soft-kms` and `threshold` custody backends with a password, so that spend-key related material is encrypted at rest. This is implemented by: 1. Having a `pcli init --encrypted` flag that applies to both of these backends, which prompts a user for a password (and confirmation) before using that to encrypt the config. 2. Having a `pcli init re-encrypt` command to read an existing config and encrypt its backend, if necessary, to allow importing existing configs. This is also implemented internally in a lazy way, so that a password is only prompted when the custody services methods are actually called, allowing us to not need a password for view only commands. Closes #4293. - [x] If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason: > This is a client-only change. --------- Co-authored-by: cratelyn <cratelyn@users.noreply.github.com>
conorsch
pushed a commit
that referenced
this pull request
May 8, 2024
## Describe your changes Improves UX for the DKG ceremony based on user feedback, so we can actually tell people to use it. This is a PR on top of #4343 to make it as easy as possible to merge. ## Issue ticket number and link #4335 ## Checklist before requesting a review - [x] If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason: > client-side key generation logic only
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.
Describe your changes
This adds a new option to encrypt the
soft-kmsandthresholdcustody backends with a password, so that spend-key related material is encrypted at rest. This is implemented by:pcli init --encryptedflag that applies to both of these backends, which prompts a user for a password (and confirmation) before using that to encrypt the config.pcli init re-encryptcommand to read an existing config and encrypt its backend, if necessary, to allow importing existing configs.This is also implemented internally in a lazy way, so that a password is only prompted when the custody services methods are actually called, allowing us to not need a password for view only commands.
Issue ticket number and link
Closes #4293.
Checklist before requesting a review
If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason: