ref(util): move, export and use SSH public key parsing logic

Author: Aaron Schlesinger

cmd/keys.go

@@ -4,13 +4,13 @@ import (
 	"fmt"
 	"io/ioutil"
 	"path"
-	"regexp"
 	"strconv"
 	"strings"
 
 	"github.com/deis/workflow-cli/controller/api"
 	"github.com/deis/workflow-cli/controller/client"
 	"github.com/deis/workflow-cli/controller/models/keys"
+	"github.com/deis/workflow-cli/util"
 )
 
 // KeysList lists a user's keys.
@@ -157,22 +157,16 @@ func listKeys() ([]api.KeyCreateRequest, error) {
 }
 
 func getKey(filename string) (api.KeyCreateRequest, error) {
-	regex := regexp.MustCompile("^(ssh-...|ecdsa-[^ ]+) ([^ ]+) ?(.*)")
-	contents, err := ioutil.ReadFile(filename)
+	keyContents, err := ioutil.ReadFile(filename)
 
 	if err != nil {
 		return api.KeyCreateRequest{}, err
 	}
 
-	if regex.Match(contents) {
-		capture := regex.FindStringSubmatch(string(contents))
-		if capture[3] != "" {
-			return api.KeyCreateRequest{ID: capture[3], Public: string(contents), Name: filename}, nil
-		}
-
-		id := strings.Split(path.Base(filename), ".")[0]
-		return api.KeyCreateRequest{ID: id, Public: string(contents), Name: filename}, nil
+	backupID := strings.Split(path.Base(filename), ".")[0]
+	keyInfo, err := util.ParseSSHPubKey(backupID, keyContents)
+	if err != nil {
+		return api.KeyCreateRequest{}, fmt.Errorf("%s is not a valid ssh key", filename)
 	}
-
-	return api.KeyCreateRequest{}, fmt.Errorf("%s is not a valid ssh key", filename)
+	return api.KeyCreateRequest{ID: keyInfo.ID, Public: keyInfo.Public, Name: filename}, nil
 }

util/doc.go

@@ -0,0 +1,3 @@
+// Package util contains various utility functions that are used by both the CLI binary
+// and the client SDK
+package util

util/ssh.go

@@ -0,0 +1,49 @@
+package util
+
+import (
+	"fmt"
+	"regexp"
+)
+
+var (
+	sshPubKeyRegex = regexp.MustCompile("^(ssh-...|ecdsa-[^ ]+) ([^ ]+) ?(.*)")
+)
+
+// SSHPubKeyInfo contains the information on an SSH public key
+type SSHPubKeyInfo struct {
+	ID     string
+	Public string
+}
+
+// ErrInvalidSSHPubKey is the error returned when an SSH public key is unrecognizable
+type ErrInvalidSSHPubKey struct {
+	pubKey []byte
+}
+
+// Error is the error interface implementation
+func (e ErrInvalidSSHPubKey) Error() string {
+	return fmt.Sprintf("invalid SSH public key %s", string(e.pubKey))
+}
+
+// ErrUnknownSSHPubKeyID is the error returned when an SSH public key is not the expected format
+type ErrUnknownSSHPubKeyID struct {
+	pubKey []byte
+}
+
+func (e ErrUnknownSSHPubKeyID) Error() string {
+	return fmt.Sprintf("unknown SSH public key ID for %s", string(e.pubKey))
+}
+
+// ParseSSHPubKey parses a byte slice representation of an SSH Public Key into an
+// SSHPubKeyInfo struct. If it cannot find the key ID from the pubKey byte slice itself,
+// it uses backupKeyID instead. Returns an appropriate error if parsing failed.
+func ParseSSHPubKey(backupKeyID string, pubKey []byte) (*SSHPubKeyInfo, error) {
+	if !sshPubKeyRegex.Match(pubKey) {
+		return nil, ErrInvalidSSHPubKey{pubKey: pubKey}
+	}
+	capture := sshPubKeyRegex.FindStringSubmatch(string(pubKey))
+	if len(capture) < 4 || capture[3] == "" {
+		return &SSHPubKeyInfo{ID: backupKeyID, Public: string(pubKey)}, nil
+	}
+	return &SSHPubKeyInfo{ID: capture[3], Public: string(pubKey)}, nil
+}

util/ssh_test.go

@@ -0,0 +1,23 @@
+package util
+
+import (
+	"testing"
+)
+
+const (
+	pubKey      = `ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDIqRuNwhjntdJWuAVykr/873X8zzKo6Ms1Vx70BQx0wir8TpaLZEY6CqqKDrMbHZ2Z0ZV2ZITs9fC81GqIdmmDFXZxNfx+B1lSR3ZpmZpQpprtSCevZXihIgy+ND50Hp/wk+3VU54FxhudIlJgpPjb/o5vQFhiyM3ynR5gH3slWVaq9C0TkgXCnTzukGzSTeL7wYPNmLomkrAS0nk0yRfoUZcwmD++HMgEmYlhTbnMlkB3nxzEf/JQxhY6xCHrbtNbRkINCY21dHrsrr/MvBvD8FoKnKpxHX2+HNXZbe7Xl87L9o1OuXrtR1crvq+r+1fPjaynGir07zr9mgJPxouPL/e4ppxTL//vt1kVkWWkh/B+GyXEmP38bQGYMpEA7cAndlxPlOki35JYwDNn5CENQpDp8F4+JsKIzAF1zmkBIA7ngg0cSHHilNgwZXmX7h+7nngLgFIpP8h7A9fCpAKhHUfFUj+Zgl9Xm44+sZOwVBnVijK326TgVDFTUXjE/Xwny+3ERgYwBfOwOKmusNFnS0XHbmh+qa/+D8qge5bKilq48pKHzwngM/U6OwMxmSXTuHclLLen3Ime30TOiPzAhokrVNz/Z3VAkfBuJHby68SAKUgczUEU81wz5wFEt1n1sIJ5V49KMRGaSWb+eWvW81yA7NkDSjnsMLa/IF/ADQ== arschles@gmail.com`
+	backupKeyID = "mybackup"
+)
+
+func TestParseSSHPubKey(t *testing.T) {
+	info, err := ParseSSHPubKey(backupKeyID, []byte(pubKey))
+	if err != nil {
+		t.Fatalf("Error parsing well formed key (%s)", err)
+	}
+	if info.ID != "arschles@gmail.com" {
+		t.Fatalf("expected key ID arschles@gmail.com, got %s", info.ID)
+	}
+	if info.Public != pubKey {
+		t.Fatalf("expected key contents %s, got %s", pubKey, info.Public)
+	}
+}