Add command for converting Byron, Icarus, and Shelley style cardano-address signing keys #1822
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
intricate
requested review from
dcoutts,
erikd,
Jimbo4350,
mrBliss and
newhoggy
as code owners
intricate
force-pushed
the
intricate/1756-cardano-address-keys
branch
2 times, most recently
from
a0770fa
to
8bcae8e
Compare
intricate
commented
Sep 8, 2020
| pKeyConvertCardanoAddressSigningKey = | ||
| KeyConvertCardanoAddressSigningKey | ||
| <$> pCardanoAddressKeyType | ||
| <*> pSigningKeyFile Input |
There was a problem hiding this comment.
Perhaps I should use an option parser whose help text specifically denotes that we expect a file containing a Bech32-encoded extended signing key.
newhoggy
reviewed
Sep 10, 2020
| pure $ Left $ | ||
| FileError fp (CardanoAddressSigningKeyBech32DecodeError err) | ||
| Right (_hrPart, _dataPart, bs) -> | ||
| pure $ first (FileError fp) (convertBip32SigningKey bs) |
There was a problem hiding this comment.
I had a go to see what an ExceptT version would look like:
readBech32Bip32SigningKeyFile
:: SigningKeyFile
-> ExceptT (FileError CardanoAddressSigningKeyConversionError) IO Crypto.XPrv
readBech32Bip32SigningKeyFile (SigningKeyFile fp) = do
str <- readFile fp & handleIOExceptT (FileIOError fp)
(_hrPart, _dataPart, bs) <- decodeBech32 (Text.concat $ Text.words str) & except & withExceptT (FileError fp . CardanoAddressSigningKeyBech32DecodeError)
convertBip32SigningKey bs & except & withExceptT (FileError fp)
The LHS of the & would be the business logic and the RHS of & is all the error type mangling.
newhoggy
approved these changes
Sep 10, 2020
Jimbo4350
reviewed
Sep 11, 2020
intricate
force-pushed
the
intricate/1756-cardano-address-keys
branch
3 times, most recently
from
df07253
to
a7ab18a
Compare
intricate
force-pushed
the
intricate/1756-cardano-address-keys
branch
from
a7ab18a
to
289de30
Compare
newhoggy
reviewed
Sep 15, 2020
| ItnSigningKeyDeserialisationError _sKey -> | ||
| -- Sensitive data, such as the signing key, is purposely not included in | ||
| -- the error message. | ||
| "Error deserialising signing key." |
There was a problem hiding this comment.
I'm curious about this concern since presumably the user has access to the key that might be printed anyway.
Might it be worthwhile printing **************suffix to at least make it easier for the user to check if they're using the right key?
There was a problem hiding this comment.
It'd be a concern if, for example, the user is redirecting stderr to some log file with more lax permissions than the signing key file itself.
I think it could be useful to print a suffix, but I wonder how many bytes of the signing key would be safe to display.
Jimbo4350
approved these changes
Sep 15, 2020
|
bors r+ |
iohk-bors bot
added a commit
that referenced
this pull request
Sep 15, 2020
1822: Add command for converting Byron, Icarus, and Shelley style cardano-address signing keys r=intricate a=intricate Closes #1756 Help text output of the new command added by this PR: ``` Usage: cardano-cli shelley key convert-cardano-address-key (--shelley-payment-key | --shelley-stake-key | --icarus-payment-key | --byron-payment-key) --signing-key-file FILE --out-file FILE Convert a cardano-address extended signing key to a corresponding Shelley-format key. Available options: --shelley-payment-key Use a Shelley-era extended payment key. --shelley-stake-key Use a Shelley-era extended stake key. --icarus-payment-key Use a Byron-era extended payment key formatted in the Icarus style. --byron-payment-key Use a Byron-era extended payment key formatted in the deprecated Byron style. --signing-key-file FILE Input filepath of the signing key. --out-file FILE The output file. ``` Co-authored-by: Luke Nadur <19835357+intricate@users.noreply.github.com>
|
Build failed: |
|
bors r+ |
dcoutts
approved these changes
Sep 15, 2020
|
Build succeeded: |
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.
Closes #1756
Help text output of the new command added by this PR: