2018-02-22 07:17:19 -08:00
|
|
|
package keys
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
2018-03-28 08:52:18 -07:00
|
|
|
"path/filepath"
|
2018-02-22 07:17:19 -08:00
|
|
|
|
2018-11-16 14:21:36 -08:00
|
|
|
"github.com/spf13/viper"
|
|
|
|
"github.com/tendermint/tendermint/libs/cli"
|
2018-12-10 06:27:25 -08:00
|
|
|
|
|
|
|
"github.com/cosmos/cosmos-sdk/client"
|
|
|
|
"github.com/cosmos/cosmos-sdk/crypto/keys"
|
2018-02-22 07:17:19 -08:00
|
|
|
)
|
|
|
|
|
2019-02-11 17:18:58 -08:00
|
|
|
// available output formats.
|
2019-02-08 12:45:23 -08:00
|
|
|
const (
|
|
|
|
OutputFormatText = "text"
|
|
|
|
OutputFormatJSON = "json"
|
2019-02-11 17:18:58 -08:00
|
|
|
|
|
|
|
// defaultKeyDBName is the client's subdirectory where keys are stored.
|
|
|
|
defaultKeyDBName = "keys"
|
2019-02-08 12:45:23 -08:00
|
|
|
)
|
2018-02-28 06:36:04 -08:00
|
|
|
|
2019-03-01 13:29:33 -08:00
|
|
|
type bechKeyOutFn func(keyInfo keys.Info) (keys.KeyOutput, error)
|
2018-08-30 21:06:44 -07:00
|
|
|
|
2018-08-06 11:11:30 -07:00
|
|
|
// GetKeyInfo returns key info for a given name. An error is returned if the
|
|
|
|
// keybase cannot be retrieved or getting the info fails.
|
|
|
|
func GetKeyInfo(name string) (keys.Info, error) {
|
2019-02-06 11:23:49 -08:00
|
|
|
keybase, err := NewKeyBaseFromHomeFlag()
|
2018-08-06 11:11:30 -07:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return keybase.Get(name)
|
|
|
|
}
|
|
|
|
|
|
|
|
// 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 GetPassphrase(name string) (string, error) {
|
|
|
|
var passphrase string
|
|
|
|
|
|
|
|
keyInfo, err := GetKeyInfo(name)
|
|
|
|
if err != nil {
|
|
|
|
return passphrase, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// we only need a passphrase for locally stored keys
|
|
|
|
// TODO: (ref: #864) address security concerns
|
|
|
|
if keyInfo.GetType() == keys.TypeLocal {
|
|
|
|
passphrase, err = ReadPassphraseFromStdin(name)
|
|
|
|
if err != nil {
|
|
|
|
return passphrase, err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return passphrase, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// ReadPassphraseFromStdin attempts to read a passphrase from STDIN return an
|
|
|
|
// error upon failure.
|
|
|
|
func ReadPassphraseFromStdin(name string) (string, error) {
|
|
|
|
buf := client.BufferStdin()
|
|
|
|
prompt := fmt.Sprintf("Password to sign with '%s':", name)
|
|
|
|
|
|
|
|
passphrase, err := client.GetPassword(prompt, buf)
|
|
|
|
if err != nil {
|
|
|
|
return passphrase, fmt.Errorf("Error reading passphrase: %v", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
return passphrase, nil
|
|
|
|
}
|
|
|
|
|
2019-02-06 11:23:49 -08:00
|
|
|
// NewKeyBaseFromHomeFlag initializes a Keybase based on the configuration.
|
|
|
|
func NewKeyBaseFromHomeFlag() (keys.Keybase, error) {
|
2018-10-12 19:22:07 -07:00
|
|
|
rootDir := viper.GetString(cli.HomeFlag)
|
2019-02-06 11:23:49 -08:00
|
|
|
return NewKeyBaseFromDir(rootDir)
|
2018-10-22 14:29:27 -07:00
|
|
|
}
|
|
|
|
|
2019-02-06 11:23:49 -08:00
|
|
|
// NewKeyBaseFromDir initializes a keybase at a particular dir.
|
|
|
|
func NewKeyBaseFromDir(rootDir string) (keys.Keybase, error) {
|
|
|
|
return getLazyKeyBaseFromDir(rootDir)
|
2018-02-22 07:17:19 -08:00
|
|
|
}
|
|
|
|
|
2019-02-07 14:38:45 -08:00
|
|
|
// NewInMemoryKeyBase returns a storage-less keybase.
|
|
|
|
func NewInMemoryKeyBase() keys.Keybase { return keys.NewInMemory() }
|
|
|
|
|
2019-02-06 11:23:49 -08:00
|
|
|
func getLazyKeyBaseFromDir(rootDir string) (keys.Keybase, error) {
|
2019-02-11 17:18:58 -08:00
|
|
|
return keys.New(defaultKeyDBName, filepath.Join(rootDir, "keys")), nil
|
2018-03-05 08:41:50 -08:00
|
|
|
}
|
|
|
|
|
2019-03-01 13:29:33 -08:00
|
|
|
func printKeyTextHeader() {
|
|
|
|
fmt.Printf("NAME:\tTYPE:\tADDRESS:\t\t\t\t\tPUBKEY:\n")
|
2018-04-20 09:51:47 -07:00
|
|
|
}
|
|
|
|
|
2019-03-01 13:29:33 -08:00
|
|
|
func printMultiSigKeyTextHeader() {
|
|
|
|
fmt.Printf("WEIGHT:\tTHRESHOLD:\tADDRESS:\t\t\t\t\tPUBKEY:\n")
|
2018-08-30 21:06:44 -07:00
|
|
|
}
|
|
|
|
|
2019-03-01 13:29:33 -08:00
|
|
|
func printMultiSigKeyInfo(keyInfo keys.Info, bechKeyOut bechKeyOutFn) {
|
|
|
|
ko, err := bechKeyOut(keyInfo)
|
2018-08-30 21:06:44 -07:00
|
|
|
if err != nil {
|
2019-03-01 13:29:33 -08:00
|
|
|
panic(err)
|
2018-08-30 21:06:44 -07:00
|
|
|
}
|
|
|
|
|
2019-03-01 13:29:33 -08:00
|
|
|
printMultiSigKeyTextHeader()
|
|
|
|
printMultiSigKeyOutput(ko)
|
2018-04-20 09:51:47 -07:00
|
|
|
}
|
|
|
|
|
2018-08-30 21:06:44 -07:00
|
|
|
func printKeyInfo(keyInfo keys.Info, bechKeyOut bechKeyOutFn) {
|
|
|
|
ko, err := bechKeyOut(keyInfo)
|
2018-06-05 21:53:04 -07:00
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
2018-08-30 21:06:44 -07:00
|
|
|
|
2018-02-22 07:17:19 -08:00
|
|
|
switch viper.Get(cli.OutputFlag) {
|
2019-02-08 12:45:23 -08:00
|
|
|
case OutputFormatText:
|
2019-03-01 13:29:33 -08:00
|
|
|
printKeyTextHeader()
|
2018-05-28 16:27:34 -07:00
|
|
|
printKeyOutput(ko)
|
2019-03-01 13:29:33 -08:00
|
|
|
|
2018-02-22 07:17:19 -08:00
|
|
|
case "json":
|
2018-05-31 12:10:12 -07:00
|
|
|
out, err := MarshalJSON(ko)
|
2018-02-22 07:17:19 -08:00
|
|
|
if err != nil {
|
2018-04-20 09:51:47 -07:00
|
|
|
panic(err)
|
2018-02-22 07:17:19 -08:00
|
|
|
}
|
2018-08-30 21:06:44 -07:00
|
|
|
|
2018-04-20 09:51:47 -07:00
|
|
|
fmt.Println(string(out))
|
2018-02-22 07:17:19 -08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func printInfos(infos []keys.Info) {
|
2019-03-01 13:29:33 -08:00
|
|
|
kos, err := keys.Bech32KeysOutput(infos)
|
2018-06-05 21:53:04 -07:00
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
2019-03-01 13:29:33 -08:00
|
|
|
|
2018-02-22 07:17:19 -08:00
|
|
|
switch viper.Get(cli.OutputFlag) {
|
2019-02-08 12:45:23 -08:00
|
|
|
case OutputFormatText:
|
2019-03-01 13:29:33 -08:00
|
|
|
printKeyTextHeader()
|
2018-04-20 09:51:47 -07:00
|
|
|
for _, ko := range kos {
|
2018-05-28 16:27:34 -07:00
|
|
|
printKeyOutput(ko)
|
2018-02-22 07:17:19 -08:00
|
|
|
}
|
2019-03-01 13:29:33 -08:00
|
|
|
|
2019-02-08 12:45:23 -08:00
|
|
|
case OutputFormatJSON:
|
2018-05-31 13:33:52 -07:00
|
|
|
out, err := MarshalJSON(kos)
|
2018-02-22 07:17:19 -08:00
|
|
|
if err != nil {
|
2018-04-20 09:51:47 -07:00
|
|
|
panic(err)
|
2018-02-22 07:17:19 -08:00
|
|
|
}
|
2019-03-01 13:29:33 -08:00
|
|
|
|
2018-04-20 09:51:47 -07:00
|
|
|
fmt.Println(string(out))
|
2018-02-22 07:17:19 -08:00
|
|
|
}
|
|
|
|
}
|
2018-05-28 16:27:34 -07:00
|
|
|
|
2019-03-01 13:29:33 -08:00
|
|
|
func printKeyOutput(ko keys.KeyOutput) {
|
2018-06-28 17:54:47 -07:00
|
|
|
fmt.Printf("%s\t%s\t%s\t%s\n", ko.Name, ko.Type, ko.Address, ko.PubKey)
|
2018-05-28 16:27:34 -07:00
|
|
|
}
|
2018-08-10 23:42:57 -07:00
|
|
|
|
2019-03-01 13:29:33 -08:00
|
|
|
func printMultiSigKeyOutput(ko keys.KeyOutput) {
|
|
|
|
for _, pk := range ko.PubKeys {
|
|
|
|
fmt.Printf("%d\t%d\t\t%s\t%s\n", pk.Weight, ko.Threshold, pk.Address, pk.PubKey)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-08-30 21:06:44 -07:00
|
|
|
func printKeyAddress(info keys.Info, bechKeyOut bechKeyOutFn) {
|
|
|
|
ko, err := bechKeyOut(info)
|
2018-08-10 23:42:57 -07:00
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
2018-08-30 21:06:44 -07:00
|
|
|
|
|
|
|
fmt.Println(ko.Address)
|
2018-08-10 23:42:57 -07:00
|
|
|
}
|
|
|
|
|
2018-08-30 21:06:44 -07:00
|
|
|
func printPubKey(info keys.Info, bechKeyOut bechKeyOutFn) {
|
|
|
|
ko, err := bechKeyOut(info)
|
2018-08-10 23:42:57 -07:00
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
2018-08-30 21:06:44 -07:00
|
|
|
|
2018-08-10 23:42:57 -07:00
|
|
|
fmt.Println(ko.PubKey)
|
|
|
|
}
|