b2b29d4909
## Description ref: #11362 I did **NOT** review the following folders, as they contain cryptography which I don't think I'm competent enough to give a useful review: - [ ] `crypto/xsalsa20symmetric` (new in v046, ported from TM i think) - [ ] `crypto/keys/secp256k1` (some new stuff in v046 too) Also performed some manual tests as part of #11939: - [x] Create keys on v0.45, make sure they still work in v0.46 https://github.com/cosmos/cosmos-sdk/issues/11939#issuecomment-1124881492 - [x] Create new keys in v0.46 https://github.com/cosmos/cosmos-sdk/issues/11939#issuecomment-1124881492 - [x] `--multisig` flag works with an address that's not in the keyring (see [repro](https://github.com/cosmos/cosmos-sdk/issues/9553)) --- ### 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... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] 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... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
41 lines
2.1 KiB
Go
41 lines
2.1 KiB
Go
// Package keys provides common key management API.
|
|
//
|
|
//
|
|
// The Keyring interface
|
|
//
|
|
// The Keyring interface defines the methods that a type needs to implement to be used
|
|
// as key storage backend. This package provides few implementations out-of-the-box.
|
|
//
|
|
// NewInMemory
|
|
//
|
|
// The NewInMemory constructor returns an implementation backed by an in-memory, goroutine-safe
|
|
// map that has historically been used for testing purposes or on-the-fly key generation as the
|
|
// generated keys are discarded when the process terminates or the type instance is garbage
|
|
// collected.
|
|
//
|
|
// New
|
|
//
|
|
// The New constructor returns an implementation backed by a keyring library
|
|
// (https://github.com/99designs/keyring), whose aim is to provide a common abstraction and uniform
|
|
// interface between secret stores available for Windows, macOS, and most GNU/Linux distributions
|
|
// as well as operating system-agnostic encrypted file-based backends.
|
|
//
|
|
// The backends:
|
|
// os The instance returned by this constructor uses the operating system's default
|
|
// credentials store to handle keys storage operations securely. It should be noted
|
|
// that the keyring keyring may be kept unlocked for the whole duration of the user
|
|
// session.
|
|
// file This backend more closely resembles the previous keyring storage used prior to
|
|
// v0.38.1. It stores the keyring encrypted 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 This backend uses KDE Wallet Manager as a credentials management application:
|
|
// https://github.com/KDE/kwallet
|
|
// pass This backend uses the pass command line utility to store and retrieve keys:
|
|
// https://www.passwordstore.org/
|
|
// test This backend stores keys insecurely to disk. It does not prompt for a password to
|
|
// be unlocked and it should be use only for testing purposes.
|
|
// memory Same instance as returned by NewInMemory. This backend uses a transient storage. Keys
|
|
// are discarded when the process terminates or the type instance is garbage collected.
|
|
package keyring
|