feat: Add 'keyring list' command to CLI

cli/cli.go

@@ -137,6 +137,7 @@ func NewDefraCommand() *cobra.Command {
 		MakeKeyringGenerateCommand(),
 		MakeKeyringImportCommand(),
 		MakeKeyringExportCommand(),
+		MakeKeyringListCommand(),
 	)
 
 	identity := MakeIdentityCommand()

cli/keyring_list.go

@@ -0,0 +1,44 @@
+package cli
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// MakeKeyringListCommand creates a new command to list all keys in the keyring.
+func MakeKeyringListCommand() *cobra.Command {
+	var cmd = &cobra.Command{
+		Use:   "list",
+		Short: "List all keys in the keyring",
+		Long: `List all keys in the keyring.
+The DEFRA_KEYRING_SECRET environment variable must be set to unlock the keyring.
+This can also be done with a .env file in the working directory or at a path
+defined with the --secret-file flag.
+
+Example:
+  defradb keyring list`,
+		Args: cobra.NoArgs,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			keyring, err := openKeyring(cmd)
+			if err != nil {
+				return err
+			}
+
+			keyNames, err := keyring.List()
+			if err != nil {
+				return err
+			}
+
+			if len(keyNames) == 0 {
+				cmd.Println("No keys found in the keyring.")
+				return nil
+			}
+
+			cmd.Println("Keys in the keyring:")
+			for _, keyName := range keyNames {
+				cmd.Println("- " + keyName)
+			}
+			return nil
+		},
+	}
+	return cmd
+}

keyring/file.go

@@ -64,3 +64,21 @@
 	}
 	return err
 }
+
+func (f *fileKeyring) List() ([]string, error) {
+
+	files, err := os.ReadDir(f.dir)
+	if err != nil {
+		return nil, err
+	}
+
+	// File names are key names
+	var keyNames []string
+	for _, file := range files {
+		if !file.IsDir() {
+			keyNames = append(keyNames, file.Name())
+		}
+	}
+
+	return keyNames, nil
+}

keyring/keyring.go

@@ -24,4 +24,6 @@ type Keyring interface {
 	//
 	// If a key with that name does not exist `ErrNotFound` is returned.
 	Delete(name string) error
+	// List returns a list of all keys in the keyring, used by the CLI 'keyring list' command
+	List() ([]string, error)
 }

keyring/system.go

@@ -53,3 +53,9 @@
 func (s *systemKeyring) Delete(user string) error {
 	return keyring.Delete(s.service, user)
 }
+
+func (s *systemKeyring) List() ([]string, error) {
+	// List does not need to be returned here
+	// This function is a stub
+	return nil, nil
+}