Skip to content

Commit f1d40b0

Browse files
committed
update godoc
1 parent 99206ed commit f1d40b0

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

crypto/keyring/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@
3333
// https://github.com/KDE/kwallet
3434
// pass This backend uses the pass command line utility to store and retrieve keys:
3535
// https://www.passwordstore.org/
36+
// keyctl This backend leverages the Linux's kernel security key management system
37+
// to store cryptographic keys securely in memory. This is available on Linux only.
3638
// test This backend stores keys insecurely to disk. It does not prompt for a password to
3739
// be unlocked and it should be used only for testing purposes.
3840
// memory Same instance as returned by NewInMemory. This backend uses a transient storage. Keys

crypto/keyring/keyring_linux.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import (
1111
"github.com/cosmos/cosmos-sdk/codec"
1212
)
1313

14+
// Linux-only backend options.
1415
const BackendKeyctl = "keyctl"
1516

1617
func newKeyctlBackendConfig(appName, _ string, _ io.Reader) keyring.Config {
@@ -24,7 +25,7 @@ func newKeyctlBackendConfig(appName, _ string, _ io.Reader) keyring.Config {
2425

2526
// New creates a new instance of a keyring.
2627
// Keyring options can be applied when generating the new instance.
27-
// Available backends are "os", "file", "kwallet", "memory", "pass", "test".
28+
// Available backends are "os", "file", "kwallet", "memory", "pass", "test", "keyctl".
2829
func New(
2930
appName, backend, rootDir string, userInput io.Reader, cdc codec.Codec, opts ...Option,
3031
) (Keyring, error) {

0 commit comments

Comments
 (0)