keys

package
v0.33.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 2, 2019 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// FlagAddress is the flag for the user's address on the command line.
	FlagAddress = "address"
	// FlagPublicKey represents the user's public key on the command line.
	FlagPublicKey = "pubkey"
	// FlagBechPrefix defines a desired Bech32 prefix encoding for a key.
	FlagBechPrefix = "bech"
	// FlagBechPrefix defines a desired Bech32 prefix encoding for a key.
	FlagDevice = "device"
)
View Source
const (
	OutputFormatText = "text"
	OutputFormatJSON = "json"
)

available output formats.

Variables

This section is empty.

Functions

func Commands

func Commands() *cobra.Command

Commands registers a sub-tree of commands to interact with local private key storage.

func GetKeyInfo added in v0.24.0

func GetKeyInfo(name string) (keys.Info, error)

GetKeyInfo returns key info for a given name. An error is returned if the keybase cannot be retrieved or getting the info fails.

func GetPassphrase added in v0.24.0

func GetPassphrase(name string) (string, error)

GetPassphrase returns a passphrase for a given name. It will first retrieve the key info for that name if the type is local, it'll fetch input from STDIN. Otherwise, an empty passphrase is returned. An error is returned if the key info cannot be fetched or reading from STDIN fails.

func MarshalJSON

func MarshalJSON(o interface{}) ([]byte, error)

marshal keys

func NewInMemoryKeyBase added in v0.31.0

func NewInMemoryKeyBase() keys.Keybase

NewInMemoryKeyBase returns a storage-less keybase.

func NewKeyBaseFromDir added in v0.31.0

func NewKeyBaseFromDir(rootDir string) (keys.Keybase, error)

NewKeyBaseFromDir initializes a keybase at a particular dir.

func NewKeyBaseFromHomeFlag added in v0.31.0

func NewKeyBaseFromHomeFlag() (keys.Keybase, error)

NewKeyBaseFromHomeFlag initializes a Keybase based on the configuration.

func ReadPassphraseFromStdin added in v0.24.0

func ReadPassphraseFromStdin(name string) (string, error)

ReadPassphraseFromStdin attempts to read a passphrase from STDIN return an error upon failure.

func UnmarshalJSON added in v0.16.0

func UnmarshalJSON(bz []byte, ptr interface{}) error

unmarshal json

Types

type AddNewKey added in v0.31.0

type AddNewKey struct {
	Name     string `json:"name"`
	Password string `json:"password"`
	Mnemonic string `json:"mnemonic"`
	Account  int    `json:"account,string,omitempty"`
	Index    int    `json:"index,string,omitempty"`
}

AddNewKey request a new key

type DeleteKeyReq added in v0.31.0

type DeleteKeyReq struct {
	Password string `json:"password"`
}

DeleteKeyReq requests deleting a key

type RecoverKey added in v0.31.0

type RecoverKey struct {
	Password string `json:"password"`
	Mnemonic string `json:"mnemonic"`
	Account  int    `json:"account,string,omitempty"`
	Index    int    `json:"index,string,omitempty"`
}

RecoverKeyBody recovers a key

type UpdateKeyReq added in v0.31.0

type UpdateKeyReq struct {
	OldPassword string `json:"old_password"`
	NewPassword string `json:"new_password"`
}

UpdateKeyReq requests updating a key

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL