57d21fa8e0
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description this PR adds a new function to the keyring interface, as well as a CLI command to rename a key in the keyring ref: #9407 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [x] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [x] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [x] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [x] confirmed `!` in the type prefix if API or client breaking change - [x] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [x] reviewed API design and naming - [ ] reviewed documentation is accurate - [x] reviewed tests and test coverage - [x] manually tested (if applicable)
60 lines
2.2 KiB
Go
60 lines
2.2 KiB
Go
package keys
|
|
|
|
import (
|
|
"github.com/spf13/cobra"
|
|
"github.com/tendermint/tendermint/libs/cli"
|
|
|
|
"github.com/cosmos/cosmos-sdk/client/flags"
|
|
)
|
|
|
|
// Commands registers a sub-tree of commands to interact with
|
|
// local private key storage.
|
|
func Commands(defaultNodeHome string) *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "keys",
|
|
Short: "Manage your application's keys",
|
|
Long: `Keyring management commands. These keys may be in any format supported by the
|
|
Tendermint crypto library and can be used by light-clients, full nodes, or any other application
|
|
that needs to sign with a private key.
|
|
|
|
The keyring supports the following backends:
|
|
|
|
os Uses the operating system's default credentials store.
|
|
file Uses encrypted file-based keystore within the app's configuration directory.
|
|
This keyring will request a password each time it is accessed, which may occur
|
|
multiple times in a single command resulting in repeated password prompts.
|
|
kwallet Uses KDE Wallet Manager as a credentials management application.
|
|
pass Uses the pass command line utility to store and retrieve keys.
|
|
test Stores keys insecurely to disk. It does not prompt for a password to be unlocked
|
|
and it should be use only for testing purposes.
|
|
|
|
kwallet and pass backends depend on external tools. Refer to their respective documentation for more
|
|
information:
|
|
KWallet https://github.com/KDE/kwallet
|
|
pass https://www.passwordstore.org/
|
|
|
|
The pass backend requires GnuPG: https://gnupg.org/
|
|
`,
|
|
}
|
|
|
|
cmd.AddCommand(
|
|
MnemonicKeyCommand(),
|
|
AddKeyCommand(),
|
|
ExportKeyCommand(),
|
|
ImportKeyCommand(),
|
|
ListKeysCmd(),
|
|
ShowKeysCmd(),
|
|
DeleteKeyCommand(),
|
|
RenameKeyCommand(),
|
|
ParseKeyStringCommand(),
|
|
MigrateCommand(),
|
|
)
|
|
|
|
cmd.PersistentFlags().String(flags.FlagHome, defaultNodeHome, "The application home directory")
|
|
cmd.PersistentFlags().String(flags.FlagKeyringDir, "", "The client Keyring directory; if omitted, the default 'home' directory will be used")
|
|
cmd.PersistentFlags().String(flags.FlagKeyringBackend, flags.DefaultKeyringBackend, "Select keyring's backend (os|file|test)")
|
|
cmd.PersistentFlags().String(cli.OutputFlag, "text", "Output format (text|json)")
|
|
|
|
return cmd
|
|
}
|