diff --git a/Makefile b/Makefile index 8387f0608..0f414e1c2 100644 --- a/Makefile +++ b/Makefile @@ -5,24 +5,10 @@ GOTOOLS = \ github.com/jteeuwen/go-bindata/go-bindata REPO:=github.com/tendermint/go-crypto -all: get_vendor_deps install test +all: get_vendor_deps test -install: - go install ./cmd/keys - -test: test_unit test_cli - -test_unit: +test: go test `glide novendor` - #go run tests/tendermint/*.go - -test_cli: tests/shunit2 - # sudo apt-get install jq - @./tests/keys.sh - -tests/shunit2: - wget "https://raw.githubusercontent.com/kward/shunit2/master/source/2.1/src/shunit2" \ - -q -O tests/shunit2 get_vendor_deps: ensure_tools @rm -rf vendor/ diff --git a/cmd/README.md b/cmd/README.md deleted file mode 100644 index 8bf9ca73b..000000000 --- a/cmd/README.md +++ /dev/null @@ -1,117 +0,0 @@ -# Keys CLI - -This is as much an example how to expose cobra/viper, as for a cli itself -(I think this code is overkill for what go-keys needs). But please look at -the commands, and give feedback and changes. - -`RootCmd` calls some initialization functions (`cobra.OnInitialize` and `RootCmd.PersistentPreRunE`) which serve to connect environmental variables and cobra flags, as well as load the config file. It also validates the flags registered on root and creates the cryptomanager, which will be used by all subcommands. - -## Help info - -``` -# keys help - -Keys allows you to manage your local keystore for tendermint. - -These keys may be in any format supported by go-crypto and can be -used by light-clients, full nodes, or any other application that -needs to sign with a private key. - -Usage: - keys [command] - -Available Commands: - get Get details of one key - list List all keys - new Create a new public/private key pair - serve Run the key manager as an http server - update Change the password for a private key - -Flags: - --keydir string Directory to store private keys (subdir of root) (default "keys") - -o, --output string Output format (text|json) (default "text") - -r, --root string root directory for config and data (default "/Users/ethan/.tlc") - -Use "keys [command] --help" for more information about a command. -``` - -## Getting the config file - -The first step is to load in root, by checking the following in order: - -* -r, --root command line flag -* TM_ROOT environmental variable -* default ($HOME/.tlc evaluated at runtime) - -Once the `rootDir` is established, the script looks for a config file named `keys.{json,toml,yaml,hcl}` in that directory and parses it. These values will provide defaults for flags of the same name. - -There is an example config file for testing out locally, which writes keys to `./.mykeys`. You can - -## Getting/Setting variables - -When we want to get the value of a user-defined variable (eg. `output`), we can call `viper.GetString("output")`, which will do the following checks, until it finds a match: - -* Is `--output` command line flag present? -* Is `TM_OUTPUT` environmental variable set? -* Was a config file found and does it have an `output` variable? -* Is there a default set on the command line flag? - -If no variable is set and there was no default, we get back "". - -This setup allows us to have powerful command line flags, but use env variables or config files (local or 12-factor style) to avoid passing these arguments every time. - -## Nesting structures - -Sometimes we don't just need key-value pairs, but actually a multi-level config file, like - -``` -[mail] -from = "no-reply@example.com" -server = "mail.example.com" -port = 567 -password = "XXXXXX" -``` - -This CLI is too simple to warant such a structure, but I think eg. tendermint could benefit from such an approach. Here are some pointers: - -* [Accessing nested keys from config files](https://github.com/spf13/viper#accessing-nested-keys) -* [Overriding nested values with envvars](https://www.netlify.com/blog/2016/09/06/creating-a-microservice-boilerplate-in-go/#nested-config-values) - the mentioned outstanding PR is already merged into master! -* Overriding nested values with cli flags? (use `--log_config.level=info` ??) - -I'd love to see an example of this fully worked out in a more complex CLI. - -## Have your cake and eat it too - -It's easy to render data different ways. Some better for viewing, some better for importing to other programs. You can just add some global (persistent) flags to control the output formatting, and everyone gets what they want. - -``` -# keys list -e hex -All keys: -betty d0789984492b1674e276b590d56b7ae077f81adc -john b77f4720b220d1411a649b6c7f1151eb6b1c226a - -# keys list -e btc -All keys: -betty 3uTF4r29CbtnzsNHZoPSYsE4BDwH -john 3ZGp2Md35iw4XVtRvZDUaAEkCUZP - -# keys list -e b64 -o json -[ - { - "name": "betty", - "address": "0HiZhEkrFnTidrWQ1Wt64Hf4Gtw=", - "pubkey": { - "type": "secp256k1", - "data": "F83WvhT0KwttSoqQqd_0_r2ztUUaQix5EXdO8AZyREoV31Og780NW59HsqTAb2O4hZ-w-j0Z-4b2IjfdqqfhVQ==" - } - }, - { - "name": "john", - "address": "t39HILIg0UEaZJtsfxFR62scImo=", - "pubkey": { - "type": "ed25519", - "data": "t1LFmbg_8UTwj-n1wkqmnTp6NfaOivokEhlYySlGYCY=" - } - } -] -``` diff --git a/cmd/delete.go b/cmd/delete.go deleted file mode 100644 index 033cf2768..000000000 --- a/cmd/delete.go +++ /dev/null @@ -1,49 +0,0 @@ -// Copyright © 2017 Ethan Frey -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package cmd - -import ( - "fmt" - - "github.com/pkg/errors" - - "github.com/spf13/cobra" -) - -// deleteCmd represents the delete command -var deleteCmd = &cobra.Command{ - Use: "delete [name]", - Short: "DANGER: Delete a private key from your system", - RunE: runDeleteCmd, -} - -func runDeleteCmd(cmd *cobra.Command, args []string) error { - if len(args) != 1 || len(args[0]) == 0 { - return errors.New("You must provide a name for the key") - } - name := args[0] - - oldpass, err := getPassword("DANGER - enter password to permanently delete key:") - if err != nil { - return err - } - - err = GetKeyManager().Delete(name, oldpass) - if err != nil { - return err - } - fmt.Println("Password deleted forever (uh oh!)") - return nil -} diff --git a/cmd/get.go b/cmd/get.go deleted file mode 100644 index dfade2b74..000000000 --- a/cmd/get.go +++ /dev/null @@ -1,42 +0,0 @@ -// Copyright © 2017 Ethan Frey -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package cmd - -import ( - "github.com/pkg/errors" - - "github.com/spf13/cobra" -) - -// getCmd represents the get command -var getCmd = &cobra.Command{ - Use: "get [name]", - Short: "Get details of one key", - Long: `Return public details of one local key.`, - RunE: runGetCmd, -} - -func runGetCmd(cmd *cobra.Command, args []string) error { - if len(args) != 1 || len(args[0]) == 0 { - return errors.New("You must provide a name for the key") - } - name := args[0] - - info, err := GetKeyManager().Get(name) - if err == nil { - printInfo(info) - } - return err -} diff --git a/cmd/keys/main.go b/cmd/keys/main.go deleted file mode 100644 index 8780f7bbc..000000000 --- a/cmd/keys/main.go +++ /dev/null @@ -1,30 +0,0 @@ -// Copyright © 2017 Ethan Frey -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package main - -import ( - "os" - - "github.com/tendermint/go-crypto/cmd" - "github.com/tendermint/tmlibs/cli" -) - -func main() { - // for demos, we enable the key server, probably don't want this - // in most binaries we embed the key management into - cmd.RegisterServer() - root := cli.PrepareMainCmd(cmd.RootCmd, "TM", os.ExpandEnv("$HOME/.tlc")) - root.Execute() -} diff --git a/cmd/list.go b/cmd/list.go deleted file mode 100644 index 51eeeda12..000000000 --- a/cmd/list.go +++ /dev/null @@ -1,34 +0,0 @@ -// Copyright © 2017 Ethan Frey -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package cmd - -import "github.com/spf13/cobra" - -// listCmd represents the list command -var listCmd = &cobra.Command{ - Use: "list", - Short: "List all keys", - Long: `Return a list of all public keys stored by this key manager -along with their associated name and address.`, - RunE: runListCmd, -} - -func runListCmd(cmd *cobra.Command, args []string) error { - infos, err := GetKeyManager().List() - if err == nil { - printInfos(infos) - } - return err -} diff --git a/cmd/new.go b/cmd/new.go deleted file mode 100644 index ce4634074..000000000 --- a/cmd/new.go +++ /dev/null @@ -1,94 +0,0 @@ -// Copyright © 2017 Ethan Frey -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package cmd - -import ( - "fmt" - - "github.com/pkg/errors" - "github.com/tendermint/go-crypto/keys" - "github.com/tendermint/go-wire/data" - "github.com/tendermint/tmlibs/cli" - - "github.com/spf13/cobra" - "github.com/spf13/viper" -) - -const ( - flagType = "type" - flagNoBackup = "no-backup" -) - -// newCmd represents the new command -var newCmd = &cobra.Command{ - Use: "new [name]", - Short: "Create a new public/private key pair", - Long: `Add a public/private key pair to the key store. -The password muts be entered in the terminal and not -passed as a command line argument for security.`, - RunE: runNewCmd, -} - -func init() { - newCmd.Flags().StringP(flagType, "t", "ed25519", "Type of key (ed25519|secp256k1)") - newCmd.Flags().Bool(flagNoBackup, false, "Don't print out seed phrase (if others are watching the terminal)") -} - -func runNewCmd(cmd *cobra.Command, args []string) error { - if len(args) != 1 || len(args[0]) == 0 { - return errors.New("You must provide a name for the key") - } - name := args[0] - algo := viper.GetString(flagType) - - pass, err := getCheckPassword("Enter a passphrase:", "Repeat the passphrase:") - if err != nil { - return err - } - - info, seed, err := GetKeyManager().Create(name, pass, algo) - if err == nil { - printCreate(info, seed) - } - return err -} - -type NewOutput struct { - Key keys.Info `json:"key"` - Seed string `json:"seed"` -} - -func printCreate(info keys.Info, seed string) { - switch viper.Get(cli.OutputFlag) { - case "text": - printInfo(info) - // print seed unless requested not to. - if !viper.GetBool(flagNoBackup) { - fmt.Println("**Important** write this seed phrase in a safe place.") - fmt.Println("It is the only way to recover your account if you ever forget your password.\n") - fmt.Println(seed) - } - case "json": - out := NewOutput{Key: info} - if !viper.GetBool(flagNoBackup) { - out.Seed = seed - } - json, err := data.ToJSON(out) - if err != nil { - panic(err) // really shouldn't happen... - } - fmt.Println(string(json)) - } -} diff --git a/cmd/recover.go b/cmd/recover.go deleted file mode 100644 index 4896c4e05..000000000 --- a/cmd/recover.go +++ /dev/null @@ -1,61 +0,0 @@ -// Copyright © 2017 Ethan Frey -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package cmd - -import ( - "github.com/pkg/errors" - - "github.com/spf13/cobra" -) - -// recoverCmd represents the recover command -var recoverCmd = &cobra.Command{ - Use: "recover [name]", - Short: "Recover a private key from a seed phrase", - Long: `Recover a private key from a seed phrase. - -I really hope you wrote this down when you created the new key. -The seed is only displayed on creation, never again. - -You can also use this to copy a key between multiple testnets, -simply by "recovering" the key in the other nets you want to copy -to. Of course, it has no coins on the other nets, just the same address.`, - RunE: runRecoverCmd, -} - -func runRecoverCmd(cmd *cobra.Command, args []string) error { - if len(args) != 1 || len(args[0]) == 0 { - return errors.New("You must provide a name for the key") - } - name := args[0] - - pass, err := getPassword("Enter the new passphrase:") - if err != nil { - return err - } - - // not really a password... huh? - seed, err := getSeed("Enter your recovery seed phrase:") - if err != nil { - return err - } - - info, err := GetKeyManager().Recover(name, pass, seed) - if err != nil { - return err - } - printInfo(info) - return nil -} diff --git a/cmd/root.go b/cmd/root.go deleted file mode 100644 index cfd3d1adf..000000000 --- a/cmd/root.go +++ /dev/null @@ -1,50 +0,0 @@ -// Copyright © 2017 Ethan Frey -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package cmd - -import ( - "github.com/spf13/cobra" - keys "github.com/tendermint/go-crypto/keys" -) - -const KeySubdir = "keys" - -var ( - manager keys.Manager -) - -// RootCmd represents the base command when called without any subcommands -var RootCmd = &cobra.Command{ - Use: "keys", - Short: "Key manager for tendermint clients", - Long: `Keys allows you to manage your local keystore for tendermint. - -These keys may be in any format supported by go-crypto and can be -used by light-clients, full nodes, or any other application that -needs to sign with a private key.`, -} - -func init() { - RootCmd.AddCommand(getCmd) - RootCmd.AddCommand(listCmd) - RootCmd.AddCommand(newCmd) - RootCmd.AddCommand(updateCmd) - RootCmd.AddCommand(deleteCmd) - RootCmd.AddCommand(recoverCmd) -} - -func RegisterServer() { - RootCmd.AddCommand(serveCmd) -} diff --git a/cmd/serve.go b/cmd/serve.go deleted file mode 100644 index 8cf7d12d4..000000000 --- a/cmd/serve.go +++ /dev/null @@ -1,110 +0,0 @@ -// Copyright © 2017 Ethan Frey -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package cmd - -import ( - "fmt" - "net" - "net/http" - "os" - - "github.com/gorilla/handlers" - "github.com/gorilla/mux" - "github.com/pkg/errors" - "github.com/spf13/cobra" - "github.com/spf13/viper" - "github.com/tendermint/go-crypto/keys/server" -) - -const ( - flagPort = "port" - flagSocket = "socket" -) - -// serveCmd represents the serve command -var serveCmd = &cobra.Command{ - Use: "serve", - Short: "Run the key manager as an http server", - Long: `Launch an http server with a rest api to manage the -private keys much more in depth than the cli can perform. -In particular, this will allow you to sign transactions with -the private keys in the store.`, - RunE: runServeCmd, -} - -func init() { - serveCmd.Flags().IntP(flagPort, "p", 8118, "TCP Port for listen for http server") - serveCmd.Flags().StringP(flagSocket, "s", "", "UNIX socket for more secure http server") - serveCmd.Flags().StringP(flagType, "t", "ed25519", "Default key type (ed25519|secp256k1)") -} - -func runServeCmd(cmd *cobra.Command, args []string) error { - var l net.Listener - var err error - socket := viper.GetString(flagSocket) - if socket != "" { - l, err = createSocket(socket) - if err != nil { - return errors.Wrap(err, "Cannot create socket") - } - } else { - port := viper.GetInt(flagPort) - l, err = net.Listen("tcp", fmt.Sprintf(":%d", port)) - if err != nil { - return errors.Errorf("Cannot listen on port %d", port) - } - } - - router := mux.NewRouter() - ks := server.New(GetKeyManager(), viper.GetString(flagType)) - ks.Register(router) - - // only set cors for tcp listener - var h http.Handler - if socket == "" { - allowedHeaders := handlers.AllowedHeaders([]string{"Content-Type"}) - h = handlers.CORS(allowedHeaders)(router) - } else { - h = router - } - - err = http.Serve(l, h) - fmt.Printf("Server Killed: %+v\n", err) - return nil -} - -// createSocket deletes existing socket if there, creates a new one, -// starts a server on the socket, and sets permissions to 0600 -func createSocket(socket string) (net.Listener, error) { - err := os.Remove(socket) - if err != nil && !os.IsNotExist(err) { - // only fail if it does exist and cannot be deleted - return nil, err - } - - l, err := net.Listen("unix", socket) - if err != nil { - return nil, err - } - - mode := os.FileMode(0700) | os.ModeSocket - err = os.Chmod(socket, mode) - if err != nil { - l.Close() - return nil, err - } - - return l, nil -} diff --git a/cmd/update.go b/cmd/update.go deleted file mode 100644 index f31af509c..000000000 --- a/cmd/update.go +++ /dev/null @@ -1,53 +0,0 @@ -// Copyright © 2017 Ethan Frey -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package cmd - -import ( - "fmt" - - "github.com/pkg/errors" - - "github.com/spf13/cobra" -) - -// updateCmd represents the update command -var updateCmd = &cobra.Command{ - Use: "update [name]", - Short: "Change the password for a private key", - RunE: runUpdateCmd, -} - -func runUpdateCmd(cmd *cobra.Command, args []string) error { - if len(args) != 1 || len(args[0]) == 0 { - return errors.New("You must provide a name for the key") - } - name := args[0] - - oldpass, err := getPassword("Enter the current passphrase:") - if err != nil { - return err - } - newpass, err := getCheckPassword("Enter the new passphrase:", "Repeat the new passphrase:") - if err != nil { - return err - } - - err = GetKeyManager().Update(name, oldpass, newpass) - if err != nil { - return err - } - fmt.Println("Password successfully updated!") - return nil -} diff --git a/cmd/utils.go b/cmd/utils.go deleted file mode 100644 index b1550a127..000000000 --- a/cmd/utils.go +++ /dev/null @@ -1,144 +0,0 @@ -package cmd - -import ( - "bufio" - "fmt" - "os" - "path/filepath" - "strings" - - "github.com/bgentry/speakeasy" - "github.com/mattn/go-isatty" - "github.com/pkg/errors" - "github.com/spf13/viper" - - data "github.com/tendermint/go-wire/data" - "github.com/tendermint/tmlibs/cli" - - keys "github.com/tendermint/go-crypto/keys" - "github.com/tendermint/go-crypto/keys/cryptostore" - "github.com/tendermint/go-crypto/keys/storage/filestorage" -) - -const MinPassLength = 10 - -// GetKeyManager initializes a key manager based on the configuration -func GetKeyManager() keys.Manager { - if manager == nil { - // store the keys directory - rootDir := viper.GetString(cli.HomeFlag) - keyDir := filepath.Join(rootDir, KeySubdir) - - // TODO: smarter loading??? with language and fallback? - codec := keys.MustLoadCodec("english") - - // and construct the key manager - manager = cryptostore.New( - cryptostore.SecretBox, - filestorage.New(keyDir), - codec, - ) - } - return manager -} - -// if we read from non-tty, we just need to init the buffer reader once, -// in case we try to read multiple passwords (eg. update) -var buf *bufio.Reader - -func inputIsTty() bool { - return isatty.IsTerminal(os.Stdin.Fd()) || isatty.IsCygwinTerminal(os.Stdin.Fd()) -} - -func stdinPassword() (string, error) { - if buf == nil { - buf = bufio.NewReader(os.Stdin) - } - pass, err := buf.ReadString('\n') - if err != nil { - return "", err - } - return strings.TrimSpace(pass), nil -} - -func getPassword(prompt string) (pass string, err error) { - if inputIsTty() { - pass, err = speakeasy.Ask(prompt) - } else { - pass, err = stdinPassword() - } - if err != nil { - return "", err - } - if len(pass) < MinPassLength { - return "", errors.Errorf("Password must be at least %d characters", MinPassLength) - } - return pass, nil -} - -func getSeed(prompt string) (seed string, err error) { - if inputIsTty() { - fmt.Println(prompt) - } - seed, err = stdinPassword() - seed = strings.TrimSpace(seed) - return -} - -func getCheckPassword(prompt, prompt2 string) (string, error) { - // simple read on no-tty - if !inputIsTty() { - return getPassword(prompt) - } - - // TODO: own function??? - pass, err := getPassword(prompt) - if err != nil { - return "", err - } - pass2, err := getPassword(prompt2) - if err != nil { - return "", err - } - if pass != pass2 { - return "", errors.New("Passphrases don't match") - } - return pass, nil -} - -func printInfo(info keys.Info) { - switch viper.Get(cli.OutputFlag) { - case "text": - addr, err := data.ToText(info.Address) - if err != nil { - panic(err) // really shouldn't happen... - } - sep := "\t\t" - if len(info.Name) > 7 { - sep = "\t" - } - fmt.Printf("%s%s%s\n", info.Name, sep, addr) - case "json": - json, err := data.ToJSON(info) - if err != nil { - panic(err) // really shouldn't happen... - } - fmt.Println(string(json)) - } -} - -func printInfos(infos keys.Infos) { - switch viper.Get(cli.OutputFlag) { - case "text": - fmt.Println("All keys:") - for _, i := range infos { - printInfo(i) - } - case "json": - json, err := data.ToJSON(infos) - if err != nil { - panic(err) // really shouldn't happen... - } - fmt.Println(string(json)) - } -} diff --git a/tests/keys.sh b/tests/keys.sh deleted file mode 100755 index 599f3d743..000000000 --- a/tests/keys.sh +++ /dev/null @@ -1,142 +0,0 @@ -#!/bin/bash - -EXE=keys - -oneTimeSetUp() { - PASS=qwertyuiop - export TM_HOME=$HOME/.keys_test - rm -rf $TM_HOME - assertTrue $? -} - -newKey(){ - assertNotNull "keyname required" "$1" - KEYPASS=${2:-qwertyuiop} - KEY=$(echo $KEYPASS | ${EXE} new $1 -o json) - if ! assertTrue "created $1" $?; then return 1; fi - assertEquals "$1" $(echo $KEY | jq .key.name | tr -d \") - return $? -} - -# updateKey -updateKey() { - (echo $2; echo $3) | keys update $1 > /dev/null - return $? -} - -test00MakeKeys() { - USER=demouser - assertFalse "already user $USER" "${EXE} get $USER" - newKey $USER - assertTrue "no user $USER" "${EXE} get $USER" - # make sure bad password not accepted - assertFalse "accepts short password" "echo 123 | keys new badpass" -} - -test01ListKeys() { - # one line plus the number of keys - assertEquals "2" $(keys list | wc -l) - newKey foobar - assertEquals "3" $(keys list | wc -l) - # we got the proper name here... - assertEquals "foobar" $(keys list -o json | jq .[1].name | tr -d \" ) - # we get all names in normal output - EXPECTEDNAMES=$(echo demouser; echo foobar) - TEXTNAMES=$(keys list | tail -n +2 | cut -f1) - assertEquals "$EXPECTEDNAMES" "$TEXTNAMES" - # let's make sure the addresses match! - assertEquals "text and json addresses don't match" $(keys list | tail -1 | cut -f3) $(keys list -o json | jq .[1].address | tr -d \") -} - -test02updateKeys() { - USER=changer - PASS1=awsedrftgyhu - PASS2=S4H.9j.D9S7hso - PASS3=h8ybO7GY6d2 - - newKey $USER $PASS1 - assertFalse "accepts invalid pass" "updateKey $USER $PASS2 $PASS2" - assertTrue "doesn't update" "updateKey $USER $PASS1 $PASS2" - assertTrue "takes new key after update" "updateKey $USER $PASS2 $PASS3" -} - -test03recoverKeys() { - USER=sleepy - PASS1=S4H.9j.D9S7hso - - USER2=easy - PASS2=1234567890 - - # make a user and check they exist - KEY=$(echo $PASS1 | ${EXE} new $USER -o json) - if ! assertTrue "created $USER" $?; then return 1; fi - if [ -n "$DEBUG" ]; then echo $KEY; echo; fi - - SEED=$(echo $KEY | jq .seed | tr -d \") - ADDR=$(echo $KEY | jq .key.address | tr -d \") - PUBKEY=$(echo $KEY | jq .key.pubkey | tr -d \") - assertTrue "${EXE} get $USER > /dev/null" - - # let's delete this key - assertFalse "echo foo | ${EXE} delete $USER > /dev/null" - assertTrue "echo $PASS1 | ${EXE} delete $USER > /dev/null" - assertFalse "${EXE} get $USER > /dev/null" - - # fails on short password - assertFalse "echo foo; echo $SEED | ${EXE} recover $USER2 -o json > /dev/null" - # fails on bad seed - assertFalse "echo $PASS2; echo \"silly white whale tower bongo\" | ${EXE} recover $USER2 -o json > /dev/null" - # now we got it - KEY2=$((echo $PASS2; echo $SEED) | ${EXE} recover $USER2 -o json) - if ! assertTrue "recovery failed: $KEY2" $?; then return 1; fi - if [ -n "$DEBUG" ]; then echo $KEY2; echo; fi - - # make sure it looks the same - NAME2=$(echo $KEY2 | jq .name | tr -d \") - ADDR2=$(echo $KEY2 | jq .address | tr -d \") - PUBKEY2=$(echo $KEY2 | jq .pubkey | tr -d \") - assertEquals "wrong username" "$USER2" "$NAME2" - assertEquals "address doesn't match" "$ADDR" "$ADDR2" - assertEquals "pubkey doesn't match" "$PUBKEY" "$PUBKEY2" - - # and we can find the info - assertTrue "${EXE} get $USER2 > /dev/null" -} - -# try recovery with secp256k1 keys -test03recoverSecp() { - USER=dings - PASS1=Sbub-U9byS7hso - - USER2=booms - PASS2=1234567890 - - KEY=$(echo $PASS1 | ${EXE} new $USER -o json -t secp256k1) - if ! assertTrue "created $USER" $?; then return 1; fi - if [ -n "$DEBUG" ]; then echo $KEY; echo; fi - - SEED=$(echo $KEY | jq .seed | tr -d \") - ADDR=$(echo $KEY | jq .key.address | tr -d \") - PUBKEY=$(echo $KEY | jq .key.pubkey | tr -d \") - assertTrue "${EXE} get $USER > /dev/null" - - # now we got it - KEY2=$((echo $PASS2; echo $SEED) | ${EXE} recover $USER2 -o json) - if ! assertTrue "recovery failed: $KEY2" $?; then return 1; fi - if [ -n "$DEBUG" ]; then echo $KEY2; echo; fi - - # make sure it looks the same - NAME2=$(echo $KEY2 | jq .name | tr -d \") - ADDR2=$(echo $KEY2 | jq .address | tr -d \") - PUBKEY2=$(echo $KEY2 | jq .pubkey | tr -d \") - assertEquals "wrong username" "$USER2" "$NAME2" - assertEquals "address doesn't match" "$ADDR" "$ADDR2" - assertEquals "pubkey doesn't match" "$PUBKEY" "$PUBKEY2" - - # and we can find the info - assertTrue "${EXE} get $USER2 > /dev/null" -} - -# load and run these tests with shunit2! -DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" #get this files directory -. $DIR/shunit2