ref(util,pkg/ssh,cmd/keys.go): move util package to pkg/ssh

Author: Aaron Schlesinger

cmd/keys.go

@@ -10,7 +10,7 @@ import (
 	"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"
+	"github.com/deis/workflow-cli/pkg/ssh"
 )
 
 // KeysList lists a user's keys.
@@ -164,7 +164,7 @@ func getKey(filename string) (api.KeyCreateRequest, error) {
 	}
 
 	backupID := strings.Split(path.Base(filename), ".")[0]
-	keyInfo, err := util.ParseSSHPubKey(backupID, keyContents)
+	keyInfo, err := ssh.ParsePubKey(backupID, keyContents)
 	if err != nil {
 		return api.KeyCreateRequest{}, fmt.Errorf("%s is not a valid ssh key", filename)
 	}

pkg/ssh/doc.go

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

pkg/ssh/ssh.go

@@ -0,0 +1,49 @@
+package ssh
+
+import (
+	"fmt"
+	"regexp"
+)
+
+var (
+	pubKeyRegex = regexp.MustCompile("^(ssh-...|ecdsa-[^ ]+) ([^ ]+) ?(.*)")
+)
+
+// PubKeyInfo contains the information on an SSH public key
+type PubKeyInfo struct {
+	ID     string
+	Public string
+}
+
+// ErrInvalidPubKey is the error returned when an SSH public key is unrecognizable
+type ErrInvalidPubKey struct {
+	pubKey []byte
+}
+
+// Error is the error interface implementation
+func (e ErrInvalidPubKey) Error() string {
+	return fmt.Sprintf("invalid SSH public key %s", string(e.pubKey))
+}
+
+// ErrUnknownPubKeyID is the error returned when an SSH public key is not the expected format
+type ErrUnknownPubKeyID struct {
+	pubKey []byte
+}
+
+func (e ErrUnknownPubKeyID) Error() string {
+	return fmt.Sprintf("unknown SSH public key ID for %s", string(e.pubKey))
+}
+
+// ParsePubKey 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 ParsePubKey(backupKeyID string, pubKey []byte) (*PubKeyInfo, error) {
+	if !pubKeyRegex.Match(pubKey) {
+		return nil, ErrInvalidPubKey{pubKey: pubKey}
+	}
+	capture := pubKeyRegex.FindStringSubmatch(string(pubKey))
+	if len(capture) < 4 || capture[3] == "" {
+		return &PubKeyInfo{ID: backupKeyID, Public: string(pubKey)}, nil
+	}
+	return &PubKeyInfo{ID: capture[3], Public: string(pubKey)}, nil
+}

util/ssh_test.go pkg/ssh/ssh_test.goutil/ssh_test.go renamed to pkg/ssh/ssh_test.go

@@ -1,4 +1,4 @@
-package util
+package ssh
 
 import (
 	"testing"
@@ -10,7 +10,7 @@ const (
 )
 
 func TestParseSSHPubKey(t *testing.T) {
-	info, err := ParseSSHPubKey(backupKeyID, []byte(pubKey))
+	info, err := ParsePubKey(backupKeyID, []byte(pubKey))
 	if err != nil {
 		t.Fatalf("Error parsing well formed key (%s)", err)
 	}