#38 Add API access to public key locations

digitalautonomy · Jun 28, 2022 · 44d80b2 · 44d80b2
1 parent 0b9329a
commit 44d80b2
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 9 deletions.
diff --git a/api/key_entry.go b/api/key_entry.go
@@ -2,4 +2,5 @@ package api
 
 type KeyEntry interface {
 	Locations() []string
+	PublicKeyLocations() []string
 }
diff --git a/gui/key_list_test.go b/gui/key_list_test.go
@@ -17,6 +17,11 @@ func (ke *keyEntryMock) Locations() []string {
 	return returns.Get(0).([]string)
 }
 
+func (ke *keyEntryMock) PublicKeyLocations() []string {
+	returns := ke.Called()
+	return returns.Get(0).([]string)
+}
+
 func (s *guiSuite) Test_createKeyEntryBoxFrom_CreatesAGTKIBoxWithTheGivenASSHKeyEntry() {
 	box := s.setupBuildingOfKeyEntry("/home/amnesia/id_rsa.pub")
 

diff --git a/ssh/key_representation.go b/ssh/key_representation.go
@@ -41,23 +41,39 @@ func createKeypairRepresentation(private *privateKeyRepresentation, public *publ
 	}
 }
 
-// Locations implement the KeyEntry interface
-func (k *privateKeyRepresentation) Locations() []string {
-	if k.path == "" {
+func nilOrStringSlice(s string) []string {
+	if s == "" {
 		return nil
 	}
-	return []string{k.path}
+	return []string{s}
+}
+
+// Locations implement the KeyEntry interface
+func (k *privateKeyRepresentation) Locations() []string {
+	return nilOrStringSlice(k.path)
+}
+
+// PublicKeyLocations implement the KeyEntry interface
+func (k *privateKeyRepresentation) PublicKeyLocations() []string {
+	return nil
 }
 
 // Locations implement the KeyEntry interface
 func (k *publicKeyRepresentation) Locations() []string {
-	if k.path == "" {
-		return nil
-	}
-	return []string{k.path}
+	return nilOrStringSlice(k.path)
+}
+
+// PublicKeyLocations implement the KeyEntry interface
+func (k *publicKeyRepresentation) PublicKeyLocations() []string {
+	return k.Locations()
 }
 
 // Locations implement the KeyEntry interface
 func (k *keypairRepresentation) Locations() []string {
 	return append(k.private.Locations(), k.public.Locations()...)
 }
+
+// PublicKeyLocations implement the KeyEntry interface
+func (k *keypairRepresentation) PublicKeyLocations() []string {
+	return k.public.PublicKeyLocations()
+}
diff --git a/ssh/key_representation_test.go b/ssh/key_representation_test.go
@@ -66,6 +66,20 @@ func (s *sshSuite) Test_privateKeyRepresentation_Locations_returnsASliceWithTheP
 	s.Equal([]string{"another private key"}, pk.Locations())
 }
 
+func (s *sshSuite) Test_privateKeyRepresentation_PublicKeyLocations_returnsAnEmptySliceIfNoFilenameIsGiven() {
+	pk := createPrivateKeyRepresentation("")
+
+	s.Empty(pk.PublicKeyLocations())
+}
+
+func (s *sshSuite) Test_privateKeyRepresentation_PublicKeyLocations_returnsAnEmptySliceEvenIfAFilenameIsGiven() {
+	pk := createPrivateKeyRepresentation("/foo/bar/hello.priv")
+	s.Empty(pk.PublicKeyLocations())
+
+	pk = createPrivateKeyRepresentation("another private key")
+	s.Empty(pk.PublicKeyLocations())
+}
+
 func (s *sshSuite) Test_publicKeyRepresentation_Locations_returnsAnEmptySliceIfNoFilenameIsGiven() {
 	pk := createPublicKeyRepresentation("")
 
@@ -80,7 +94,21 @@ func (s *sshSuite) Test_publicKeyRepresentation_Locations_returnsASliceWithThePa
 	s.Equal([]string{"a public RSA key file"}, pk.Locations())
 }
 
-func (s *sshSuite) Test_keypairRepresentation_Locations_returnsAnEmptyList_ifNeitherPrivateOrPublicKeyHasEmptyPath() {
+func (s *sshSuite) Test_publicKeyRepresentation_PublicKeyLocations_returnsAnEmptySliceIfNoFilenameIsGiven() {
+	pk := createPublicKeyRepresentation("")
+
+	s.Empty(pk.PublicKeyLocations())
+}
+
+func (s *sshSuite) Test_publicKeyRepresentation_PublicKeyLocations_returnsASliceWithThePathToThePublicKey() {
+	pk := createPublicKeyRepresentation("/foo/bar/hello.pub")
+	s.Equal([]string{"/foo/bar/hello.pub"}, pk.PublicKeyLocations())
+
+	pk = createPublicKeyRepresentation("a public RSA key file")
+	s.Equal([]string{"a public RSA key file"}, pk.PublicKeyLocations())
+}
+
+func (s *sshSuite) Test_keypairRepresentation_Locations_returnsAnEmptyList_ifBothPrivateOrPublicKeyHaveEmptyPaths() {
 	priv := createPrivateKeyRepresentation("")
 	pub := createPublicKeyRepresentation("")
 
@@ -122,3 +150,37 @@ func (s *sshSuite) Test_keypairRepresentation_Locations_returnsThePrivateAndPubl
 
 	s.Equal([]string{"/home/another private key", "pub.rsa.4096.{{{"}, kp2.Locations())
 }
+
+func (s *sshSuite) Test_keypairRepresentation_PublicKeyLocations_returnsAnEmptyList_ifBothKeysHaveEmptyPaths() {
+	priv := createPrivateKeyRepresentation("")
+	pub := createPublicKeyRepresentation("")
+
+	kp := createKeypairRepresentation(priv, pub)
+
+	s.Empty(kp.PublicKeyLocations())
+}
+
+func (s *sshSuite) Test_keypairRepresentation_PublicKeyLocations_returnsAnEmptyList_ifOnlyThePrivateKeyHasAPath() {
+	priv := createPrivateKeyRepresentation("/home/foo/.ssh/privatekey.ed25519")
+	pub := createPublicKeyRepresentation("")
+
+	kp := createKeypairRepresentation(priv, pub)
+
+	s.Empty(kp.PublicKeyLocations())
+}
+
+func (s *sshSuite) Test_keypairRepresentation_PublicKeyLocations_returnsOnlyThePublicPaths() {
+	priv1 := createPrivateKeyRepresentation("/home/amnesia/.ssh/foo_rsa")
+	pub1 := createPublicKeyRepresentation("/home/amnesia/.ssh/foo_rsa.pub")
+
+	kp1 := createKeypairRepresentation(priv1, pub1)
+
+	s.Equal([]string{"/home/amnesia/.ssh/foo_rsa.pub"}, kp1.PublicKeyLocations())
+
+	priv2 := createPrivateKeyRepresentation("/home/another private key")
+	pub2 := createPublicKeyRepresentation("pub.rsa.4096.{{{")
+
+	kp2 := createKeypairRepresentation(priv2, pub2)
+
+	s.Equal([]string{"pub.rsa.4096.{{{"}, kp2.PublicKeyLocations())
+}