package keys import ( "bufio" "fmt" "os" "reflect" "strings" "github.com/pkg/errors" "github.com/cosmos/cosmos-sdk/crypto" cosmosKeys "github.com/cosmos/cosmos-sdk/crypto/keys" "github.com/cosmos/cosmos-sdk/crypto/keys/hd" "github.com/cosmos/cosmos-sdk/crypto/keys/keyerror" "github.com/cosmos/cosmos-sdk/crypto/keys/mintkey" "github.com/cosmos/cosmos-sdk/types" bip39 "github.com/cosmos/go-bip39" emintCrypto "github.com/cosmos/ethermint/crypto" tmcrypto "github.com/tendermint/tendermint/crypto" cryptoAmino "github.com/tendermint/tendermint/crypto/encoding/amino" dbm "github.com/tendermint/tm-db" ) var _ cosmosKeys.Keybase = dbKeybase{} // Language is a language to create the BIP 39 mnemonic in. // Currently, only english is supported though. // Find a list of all supported languages in the BIP 39 spec (word lists). type Language int //noinspection ALL const ( // English is the default language to create a mnemonic. // It is the only supported language by this package. English Language = iota + 1 // Japanese is currently not supported. Japanese // Korean is currently not supported. Korean // Spanish is currently not supported. Spanish // ChineseSimplified is currently not supported. ChineseSimplified // ChineseTraditional is currently not supported. ChineseTraditional // French is currently not supported. French // Italian is currently not supported. Italian addressSuffix = "address" infoSuffix = "info" ) const ( // used for deriving seed from mnemonic DefaultBIP39Passphrase = "" // bits of entropy to draw when creating a mnemonic defaultEntropySize = 256 ) var ( // ErrUnsupportedSigningAlgo is raised when the caller tries to use a // different signing scheme than secp256k1. ErrUnsupportedSigningAlgo = errors.New("unsupported signing algo: only secp256k1 is supported") // ErrUnsupportedLanguage is raised when the caller tries to use a // different language than english for creating a mnemonic sentence. ErrUnsupportedLanguage = errors.New("unsupported language: only english is supported") ) // dbKeybase combines encryption and storage implementation to provide // a full-featured key manager type dbKeybase struct { db dbm.DB } // newDbKeybase creates a new keybase instance using the passed DB for reading and writing keys. func newDbKeybase(db dbm.DB) cosmosKeys.Keybase { return dbKeybase{ db: db, } } // NewInMemory creates a transient keybase on top of in-memory storage // instance useful for testing purposes and on-the-fly key generation. func NewInMemory() cosmosKeys.Keybase { return dbKeybase{dbm.NewMemDB()} } // CreateMnemonic generates a new key and persists it to storage, encrypted // using the provided password. // It returns the generated mnemonic and the key Info. // It returns an error if it fails to // generate a key for the given algo type, or if another key is // already stored under the same name. func (kb dbKeybase) CreateMnemonic(name string, language cosmosKeys.Language, passwd string, algo cosmosKeys.SigningAlgo) (info cosmosKeys.Info, mnemonic string, err error) { if language != cosmosKeys.English { return nil, "", ErrUnsupportedLanguage } if algo != Secp256k1 { err = ErrUnsupportedSigningAlgo return } // default number of words (24): // this generates a mnemonic directly from the number of words by reading system entropy. entropy, err := bip39.NewEntropy(defaultEntropySize) if err != nil { return } mnemonic, err = bip39.NewMnemonic(entropy) if err != nil { return } seed := bip39.NewSeed(mnemonic, DefaultBIP39Passphrase) fullFundraiserPath := types.GetConfig().GetFullFundraiserPath() info, err = kb.persistDerivedKey(seed, passwd, name, fullFundraiserPath) return } // CreateAccount converts a mnemonic to a private key and persists it, encrypted with the given password. func (kb dbKeybase) CreateAccount(name, mnemonic, bip39Passwd, encryptPasswd string, account uint32, index uint32) (cosmosKeys.Info, error) { coinType := types.GetConfig().GetCoinType() hdPath := hd.NewFundraiserParams(account, coinType, index) return kb.Derive(name, mnemonic, bip39Passwd, encryptPasswd, *hdPath) } func (kb dbKeybase) Derive(name, mnemonic, bip39Passphrase, encryptPasswd string, params hd.BIP44Params) (info cosmosKeys.Info, err error) { seed, err := bip39.NewSeedWithErrorChecking(mnemonic, bip39Passphrase) if err != nil { return } info, err = kb.persistDerivedKey(seed, encryptPasswd, name, params.String()) return info, err } // CreateLedger creates a new locally-stored reference to a Ledger keypair // It returns the created key info and an error if the Ledger could not be queried func (kb dbKeybase) CreateLedger(name string, algo cosmosKeys.SigningAlgo, hrp string, account, index uint32) (cosmosKeys.Info, error) { if algo != Secp256k1 { return nil, ErrUnsupportedSigningAlgo } coinType := types.GetConfig().GetCoinType() hdPath := hd.NewFundraiserParams(account, coinType, index) priv, _, err := crypto.NewPrivKeyLedgerSecp256k1(*hdPath, hrp) if err != nil { return nil, err } pub := priv.PubKey() // Note: Once Cosmos App v1.3.1 is compulsory, it could be possible to check that pubkey and addr match return kb.writeLedgerKey(name, pub, *hdPath), nil } // CreateOffline creates a new reference to an offline keypair. It returns the // created key info. func (kb dbKeybase) CreateOffline(name string, pub tmcrypto.PubKey) (cosmosKeys.Info, error) { return kb.writeOfflineKey(name, pub), nil } // CreateMulti creates a new reference to a multisig (offline) keypair. It // returns the created key info. func (kb dbKeybase) CreateMulti(name string, pub tmcrypto.PubKey) (cosmosKeys.Info, error) { return nil, nil } func (kb *dbKeybase) persistDerivedKey(seed []byte, passwd, name, fullHdPath string) (info cosmosKeys.Info, err error) { // create master key and derive first key: masterPriv, ch := hd.ComputeMastersFromSeed(seed) derivedPriv, err := hd.DerivePrivateKeyForPath(masterPriv, ch, fullHdPath) if err != nil { return } // if we have a password, use it to encrypt the private key and store it // else store the public key only if passwd != "" { info = kb.writeLocalKey(name, emintCrypto.PrivKeySecp256k1(derivedPriv[:]), passwd) } else { pubk := emintCrypto.PrivKeySecp256k1(derivedPriv[:]).PubKey() info = kb.writeOfflineKey(name, pubk) } return info, nil } // List returns the keys from storage in alphabetical order. func (kb dbKeybase) List() ([]cosmosKeys.Info, error) { var res []cosmosKeys.Info iter := kb.db.Iterator(nil, nil) defer iter.Close() for ; iter.Valid(); iter.Next() { key := string(iter.Key()) // need to include only keys in storage that have an info suffix if strings.HasSuffix(key, infoSuffix) { info, err := readInfo(iter.Value()) if err != nil { return nil, err } res = append(res, info) } } return res, nil } // Get returns the public information about one key. func (kb dbKeybase) Get(name string) (cosmosKeys.Info, error) { bs := kb.db.Get(infoKey(name)) if len(bs) == 0 { return nil, keyerror.NewErrKeyNotFound(name) } return readInfo(bs) } func (kb dbKeybase) GetByAddress(address types.AccAddress) (cosmosKeys.Info, error) { ik := kb.db.Get(addrKey(address)) if len(ik) == 0 { return nil, fmt.Errorf("key with address %s not found", address) } bs := kb.db.Get(ik) return readInfo(bs) } // Sign signs the msg with the named key. // It returns an error if the key doesn't exist or the decryption fails. func (kb dbKeybase) Sign(name, passphrase string, msg []byte) (sig []byte, pub tmcrypto.PubKey, err error) { info, err := kb.Get(name) if err != nil { return } var priv tmcrypto.PrivKey switch info.(type) { case localInfo: linfo := info.(localInfo) if linfo.PrivKeyArmor == "" { err = fmt.Errorf("private key not available") return } priv, err = mintkey.UnarmorDecryptPrivKey(linfo.PrivKeyArmor, passphrase) if err != nil { return nil, nil, err } case ledgerInfo: linfo := info.(ledgerInfo) priv, err = crypto.NewPrivKeyLedgerSecp256k1Unsafe(linfo.Path) if err != nil { return } // case offlineInfo, multiInfo: case offlineInfo: _, err := fmt.Fprintf(os.Stderr, "Message to sign:\n\n%s\n", msg) if err != nil { return nil, nil, err } buf := bufio.NewReader(os.Stdin) _, err = fmt.Fprintf(os.Stderr, "\nEnter Amino-encoded signature:\n") if err != nil { return nil, nil, err } // Will block until user inputs the signature signed, err := buf.ReadString('\n') if err != nil { return nil, nil, err } if err := cdc.UnmarshalBinaryLengthPrefixed([]byte(signed), sig); err != nil { return nil, nil, errors.Wrap(err, "failed to decode signature") } return sig, info.GetPubKey(), nil } sig, err = priv.Sign(msg) if err != nil { return nil, nil, err } pub = priv.PubKey() return sig, pub, nil } func (kb dbKeybase) ExportPrivateKeyObject(name string, passphrase string) (tmcrypto.PrivKey, error) { info, err := kb.Get(name) if err != nil { return nil, err } var priv tmcrypto.PrivKey switch info.(type) { case localInfo: linfo := info.(localInfo) if linfo.PrivKeyArmor == "" { err = fmt.Errorf("private key not available") return nil, err } priv, err = mintkey.UnarmorDecryptPrivKey(linfo.PrivKeyArmor, passphrase) if err != nil { return nil, err } // case ledgerInfo, offlineInfo, multiInfo: case ledgerInfo, offlineInfo: return nil, errors.New("only works on local private keys") } return priv, nil } func (kb dbKeybase) Export(name string) (armor string, err error) { bz := kb.db.Get(infoKey(name)) if bz == nil { return "", fmt.Errorf("no key to export with name %s", name) } return mintkey.ArmorInfoBytes(bz), nil } // ExportPubKey returns public keys in ASCII armored format. // Retrieve a Info object by its name and return the public key in // a portable format. func (kb dbKeybase) ExportPubKey(name string) (armor string, err error) { bz := kb.db.Get(infoKey(name)) if bz == nil { return "", fmt.Errorf("no key to export with name %s", name) } info, err := readInfo(bz) if err != nil { return } return mintkey.ArmorPubKeyBytes(info.GetPubKey().Bytes()), nil } // ExportPrivKey returns a private key in ASCII armored format. // It returns an error if the key does not exist or a wrong encryption passphrase is supplied. func (kb dbKeybase) ExportPrivKey(name string, decryptPassphrase string, encryptPassphrase string) (armor string, err error) { priv, err := kb.ExportPrivateKeyObject(name, decryptPassphrase) if err != nil { return "", err } return mintkey.EncryptArmorPrivKey(priv, encryptPassphrase), nil } // ImportPrivKey imports a private key in ASCII armor format. // It returns an error if a key with the same name exists or a wrong encryption passphrase is // supplied. func (kb dbKeybase) ImportPrivKey(name string, armor string, passphrase string) error { if _, err := kb.Get(name); err == nil { return errors.New("Cannot overwrite key " + name) } privKey, err := mintkey.UnarmorDecryptPrivKey(armor, passphrase) if err != nil { return errors.Wrap(err, "couldn't import private key") } kb.writeLocalKey(name, privKey, passphrase) return nil } func (kb dbKeybase) Import(name string, armor string) (err error) { bz := kb.db.Get(infoKey(name)) if len(bz) > 0 { return errors.New("Cannot overwrite data for name " + name) } infoBytes, err := mintkey.UnarmorInfoBytes(armor) if err != nil { return } kb.db.Set(infoKey(name), infoBytes) return nil } // ImportPubKey imports ASCII-armored public keys. // Store a new Info object holding a public key only, i.e. it will // not be possible to sign with it as it lacks the secret key. func (kb dbKeybase) ImportPubKey(name string, armor string) (err error) { bz := kb.db.Get(infoKey(name)) if len(bz) > 0 { return errors.New("Cannot overwrite data for name " + name) } pubBytes, err := mintkey.UnarmorPubKeyBytes(armor) if err != nil { return } pubKey, err := cryptoAmino.PubKeyFromBytes(pubBytes) if err != nil { return } kb.writeOfflineKey(name, pubKey) return } // Delete removes key forever, but we must present the // proper passphrase before deleting it (for security). // It returns an error if the key doesn't exist or // passphrases don't match. // Passphrase is ignored when deleting references to // offline and Ledger / HW wallet keys. func (kb dbKeybase) Delete(name, passphrase string, skipPass bool) error { // verify we have the proper password before deleting info, err := kb.Get(name) if err != nil { return err } if linfo, ok := info.(localInfo); ok && !skipPass { if _, err = mintkey.UnarmorDecryptPrivKey(linfo.PrivKeyArmor, passphrase); err != nil { return err } } kb.db.DeleteSync(addrKey(info.GetAddress())) kb.db.DeleteSync(infoKey(name)) return nil } // Update changes the passphrase with which an already stored key is // encrypted. // // oldpass must be the current passphrase used for encryption, // getNewpass is a function to get the passphrase to permanently replace // the current passphrase func (kb dbKeybase) Update(name, oldpass string, getNewpass func() (string, error)) error { info, err := kb.Get(name) if err != nil { return err } switch info.(type) { case localInfo: linfo := info.(localInfo) key, err := mintkey.UnarmorDecryptPrivKey(linfo.PrivKeyArmor, oldpass) if err != nil { return err } newpass, err := getNewpass() if err != nil { return err } kb.writeLocalKey(name, key, newpass) return nil default: return fmt.Errorf("locally stored key required. Received: %v", reflect.TypeOf(info).String()) } } // CloseDB releases the lock and closes the storage backend. func (kb dbKeybase) CloseDB() { kb.db.Close() } func (kb dbKeybase) writeLocalKey(name string, priv tmcrypto.PrivKey, passphrase string) cosmosKeys.Info { privkey, ok := priv.(emintCrypto.PrivKeySecp256k1) if !ok { panic(fmt.Sprintf("invalid private key type: %T", priv)) } // encrypt private key using passphrase privArmor := mintkey.EncryptArmorPrivKey(privkey, passphrase) // make Info pub := privkey.PubKey() pubkey, ok := pub.(emintCrypto.PubKeySecp256k1) if !ok { panic(fmt.Sprintf("invalid public key type: %T", pub)) } info := newLocalInfo(name, pubkey, privArmor) kb.writeInfo(name, info) return info } func (kb dbKeybase) writeLedgerKey(name string, pub tmcrypto.PubKey, path hd.BIP44Params) cosmosKeys.Info { pubkey, ok := pub.(emintCrypto.PubKeySecp256k1) if !ok { panic(fmt.Sprintf("invalid public key type: %T", pub)) } info := newLedgerInfo(name, pubkey, path) kb.writeInfo(name, info) return info } func (kb dbKeybase) writeOfflineKey(name string, pub tmcrypto.PubKey) cosmosKeys.Info { pubkey, ok := pub.(emintCrypto.PubKeySecp256k1) if !ok { panic(fmt.Sprintf("invalid public key type: %T", pub)) } info := newOfflineInfo(name, pubkey) kb.writeInfo(name, info) return info } func (kb dbKeybase) writeInfo(name string, info cosmosKeys.Info) { // write the info by key key := infoKey(name) serializedInfo := writeInfo(info) kb.db.SetSync(key, serializedInfo) // store a pointer to the infokey by address for fast lookup kb.db.SetSync(addrKey(info.GetAddress()), key) } func addrKey(address types.AccAddress) []byte { return []byte(fmt.Sprintf("%s.%s", address.String(), addressSuffix)) } func infoKey(name string) []byte { return []byte(fmt.Sprintf("%s.%s", name, infoSuffix)) }