Merge pull request #220 from pengisgood/key-api

Implement the key related apis

Author: aschmahmann

key.go

@@ -0,0 +1,84 @@
+package shell
+
+import "context"
+
+type Key struct {
+	Id   string
+	Name string
+}
+
+type KeyRenameObject struct {
+	Id        string
+	Now       string
+	Overwrite bool
+	Was       string
+}
+
+type keyListOutput struct {
+	Keys []*Key
+}
+
+type KeyOpt func(*RequestBuilder) error
+type keyGen struct{}
+
+var KeyGen keyGen
+
+func (keyGen) Type(alg string) KeyOpt {
+	return func(rb *RequestBuilder) error {
+		rb.Option("type", alg)
+		return nil
+	}
+}
+
+func (keyGen) Size(size int) KeyOpt {
+	return func(rb *RequestBuilder) error {
+		rb.Option("size", size)
+		return nil
+	}
+}
+
+// KeyGen Create a new keypair
+func (s *Shell) KeyGen(ctx context.Context, name string, options ...KeyOpt) (*Key, error) {
+	rb := s.Request("key/gen", name)
+	for _, opt := range options {
+		if err := opt(rb); err != nil {
+			return nil, err
+		}
+	}
+
+	var out Key
+	if err := rb.Exec(ctx, &out); err != nil {
+		return nil, err
+	}
+	return &out, nil
+}
+
+// KeyList List all local keypairs
+func (s *Shell) KeyList(ctx context.Context) ([]*Key, error) {
+	var out keyListOutput
+	if err := s.Request("key/list").Exec(ctx, &out); err != nil {
+		return nil, err
+	}
+	return out.Keys, nil
+}
+
+// KeyRename Rename a keypair
+func (s *Shell) KeyRename(ctx context.Context, old string, new string, force bool) (*KeyRenameObject, error) {
+	var out KeyRenameObject
+	if err := s.Request("key/rename", old, new).
+		Option("force", force).
+		Exec(ctx, &out); err != nil {
+		return nil, err
+	}
+	return &out, nil
+}
+
+// KeyRm remove a keypair
+func (s *Shell) KeyRm(ctx context.Context, name string) ([]*Key, error) {
+	var out keyListOutput
+	if err := s.Request("key/rm", name).
+		Exec(ctx, &out); err != nil {
+		return nil, err
+	}
+	return out.Keys, nil
+}

key_test.go

@@ -0,0 +1,116 @@
+package shell
+
+import (
+	"context"
+	"testing"
+
+	"github.com/cheekybits/is"
+)
+
+func TestKeyGen(t *testing.T) {
+	is := is.New(t)
+	s := NewShell(shellUrl)
+
+	defer func() {
+		_, err := s.KeyRm(context.Background(), "testKey1")
+		is.Nil(err)
+	}()
+	key1, err := s.KeyGen(context.Background(), "testKey1", KeyGen.Type("ed25519"))
+	is.Nil(err)
+	is.Equal(key1.Name, "testKey1")
+	is.NotNil(key1.Id)
+
+	defer func() {
+		_, err = s.KeyRm(context.Background(), "testKey2")
+		is.Nil(err)
+	}()
+	key2, err := s.KeyGen(context.Background(), "testKey2", KeyGen.Type("ed25519"))
+	is.Nil(err)
+	is.Equal(key2.Name, "testKey2")
+	is.NotNil(key2.Id)
+
+	defer func() {
+		_, err = s.KeyRm(context.Background(), "testKey3")
+		is.Nil(err)
+	}()
+	key3, err := s.KeyGen(context.Background(), "testKey3", KeyGen.Type("rsa"))
+	is.Nil(err)
+	is.Equal(key3.Name, "testKey3")
+	is.NotNil(key3.Id)
+
+	defer func() {
+		_, err = s.KeyRm(context.Background(), "testKey4")
+		is.Nil(err)
+	}()
+	key4, err := s.KeyGen(context.Background(), "testKey4", KeyGen.Type("rsa"), KeyGen.Size(4096))
+	is.Nil(err)
+	is.Equal(key4.Name, "testKey4")
+	is.NotNil(key4.Id)
+
+	_, err = s.KeyGen(context.Background(), "testKey5", KeyGen.Type("rsa"), KeyGen.Size(1024))
+	is.NotNil(err)
+	is.Equal(err.Error(), "key/gen: rsa keys must be >= 2048 bits to be useful")
+}
+
+func TestKeyList(t *testing.T) {
+	is := is.New(t)
+	s := NewShell(shellUrl)
+
+	defer func() {
+		_, err := s.KeyRm(context.Background(), "testKey")
+		is.Nil(err)
+	}()
+	key, err := s.KeyGen(context.Background(), "testKey")
+	is.Nil(err)
+
+	keys, err := s.KeyList(context.Background())
+	is.Nil(err)
+
+	is.Equal(len(keys), 2)
+	is.Equal(keys[0].Name, "self")
+	is.NotNil(keys[0].Id)
+	is.NotNil(keys[1].Id, key.Id)
+	is.NotNil(keys[1].Name, key.Name)
+}
+
+func TestKeyRename(t *testing.T) {
+	is := is.New(t)
+	s := NewShell(shellUrl)
+
+	key, err := s.KeyGen(context.Background(), "test1")
+	is.Nil(err)
+
+	out, err := s.KeyRename(context.Background(), "test1", "test2", false)
+	is.Nil(err)
+
+	is.Equal(out.Now, "test2")
+	is.Equal(out.Was, "test1")
+	is.Equal(out.Id, key.Id)
+	is.False(out.Overwrite)
+
+	_, err = s.KeyRm(context.Background(), "test2")
+	is.Nil(err)
+
+	_, err = s.KeyRename(context.Background(), "test2", "test1", false)
+	is.NotNil(err)
+	is.Equal(err.Error(), "key/rename: no key named test2 was found")
+}
+
+func TestKeyRm(t *testing.T) {
+	is := is.New(t)
+	s := NewShell(shellUrl)
+
+	key, err := s.KeyGen(context.Background(), "testKey")
+	is.Nil(err)
+
+	keys, err := s.KeyRm(context.Background(), "testKey")
+	is.Nil(err)
+
+	is.Equal(len(keys), 1)
+	is.Equal(keys[0].Name, key.Name)
+	is.Equal(keys[0].Id, key.Id)
+
+	_, err = s.KeyRm(context.Background(), "testKey")
+	is.NotNil(err)
+	is.Equal(err.Error(), "key/rm: no key named testKey was found")
+}