Merge pull request #26 from TimothyYe/cache

Cache

Author: TimothyYe

README.md

@@ -51,7 +51,7 @@ Download it from [releases](https://github.com/TimothyYe/skm/releases) and extac
 ```bash
 % skm
 
-SKM V0.6
+SKM V0.7
 https://github.com/TimothyYe/skm
 
 NAME:
@@ -61,7 +61,7 @@ USAGE:
    skm [global options] command [command options] [arguments...]
 
 VERSION:
-   0.6
+   0.7
 
 COMMANDS:
      init, i      Initialize SSH keys store for the first time usage.
@@ -74,11 +74,15 @@ COMMANDS:
      display, dp  Display the current SSH public key or specific SSH public key by alias name.
      backup, b    Backup all SSH keys to an archive file.
      restore, r   Restore SSH keys from an existing archive file.
+     cache        Add your SSH to SSH agent cache via alias name.
      help, h      Shows a list of commands or help for one command.
 
 GLOBAL OPTIONS:
-   --help, -h     show help
-   --version, -v  print the version
+   --store-path value   Path where SKM should store its profiles (default: "/Users/timothy/.skm")
+   --ssh-path value     Path to a .ssh folder (default: "/Users/timothy/.ssh")
+   --restic-path value  Path to the restic binary
+   --help, -h           show help
+   --version, -v        print the version
 ```
 
 ### For the first time use
@@ -250,6 +254,37 @@ restoring <Snapshot $SNAPSHOT of [/Users/$USER/.skm] at 2018-10-03 19:40:33.3331
 ✔  Backup restored to /Users/$USER/.skm
 ```
 
+### Integrate with SSH agent
+
+You can use `cache` command to cache your SSH key into SSH agent's cache via SSH alias name.
+
+__Cache your SSH key__  
+
+```bash
+λ tim [~/]
+→ skm cache --add my                                                                                                                                                                                                                                                                     
+Enter passphrase for /Users/timothy/.skm/my/id_rsa:
+Identity added: /Users/timothy/.skm/my/id_rsa (/Users/timothy/.skm/my/id_rsa)
+✔  SSH key [my] already added into cache
+```
+
+__Remove your SSH key from cache__  
+
+```bash
+λ tim [~/]
+→ ./skm cache --del my                                                                                                                                                                                                                                                                   
+Identity removed: /Users/timothy/.skm/my/id_rsa (MyKEY)
+✔  SSH key [my] removed from cache
+```
+
+__List your cached SSH keys from SSH agent__  
+
+```bash
+λ tim [skm/cmd/skm] at  cache !
+→ ./skm cache --list                                                                                                                                                                                                                                                                     
+2048 SHA256:qAVcwc0tdUOCjH3sTskwxAmfMQiL2sKtfPBXFnUoZHQ /Users/timothy/.skm/my/id_rsa (RSA)
+```
+
 ### Hook mechanism
 
 Edit and place a executable file named ```hook``` at the specified key directory, for example:

cmd/skm/actions.go

@@ -410,6 +410,37 @@ func restore(c *cli.Context) error {
 	return nil
 }
 
+func cache(c *cli.Context) error {
+	alias := c.Args().Get(0)
+	env := mustGetEnvironment(c)
+	keyMap := skm.LoadSSHKeys(env)
+
+	if c.Bool("add") {
+		// add SSH key into SSH agent cache
+		if err := skm.AddCache(alias, keyMap, env); err != nil {
+			color.Red("%s"+err.Error(), skm.CrossSymbol)
+			return nil
+		}
+		color.Green("%s SSH key [%s] already added into cache", skm.CheckSymbol, alias)
+	} else if c.Bool("del") {
+		// delete SSH key from SSH agent cache
+		if err := skm.DeleteCache(alias, keyMap, env); err != nil {
+			color.Red("%s"+err.Error(), skm.CrossSymbol)
+			return nil
+		}
+		color.Green("%s SSH key [%s] removed from cache", skm.CheckSymbol, alias)
+	} else if c.Bool("list") {
+		// list all cached SSH keys from SSH agent cache
+		if err := skm.ListCache(); err != nil {
+			return nil
+		}
+	} else {
+		color.Red("%s Invalid parameter!", skm.CrossSymbol)
+		return errors.New("invalid parameter")
+	}
+	return nil
+}
+
 func getKeyPayload(keyPath string) string {
 	key, err := ioutil.ReadFile(keyPath)
 	if err != nil {

cmd/skm/commands.go

@@ -81,5 +81,15 @@ func initCommands() []cli.Command {
 				cli.StringFlag{Name: "restic-snapshot", Usage: "The snapshot to be restored"},
 			},
 		},
+		{
+			Name:   "cache",
+			Usage:  "Add your SSH to SSH agent cache via alias name",
+			Action: cache,
+			Flags: []cli.Flag{
+				cli.BoolFlag{Name: "add", Usage: "Add SSH key to SSH agent cache"},
+				cli.BoolFlag{Name: "del", Usage: "Remove SSH key from SSH agent cache"},
+				cli.BoolFlag{Name: "list", Usage: "List all SSH keys from SSH agent cache"},
+			},
+		},
 	}
 }

utils.go

@@ -1,6 +1,7 @@
 package skm
 
 import (
+	"errors"
 	"fmt"
 	"io"
 	"os"
@@ -114,6 +115,58 @@ func RunHook(alias string, env *Environment) {
 	}
 }
 
+// AddCache adds SSH to ssh agent cache via key alias
+func AddCache(alias string, keyMap map[string]*SSHKey, env *Environment) error {
+	key, found := keyMap[alias]
+
+	if !found {
+		return fmt.Errorf("SSH key [%s] not found", alias)
+	}
+
+	// Add key to SSH agent cache
+	privateKeyPath := filepath.Join(env.StorePath, alias, key.Type.PrivateKey())
+	args := []string{privateKeyPath}
+	result := Execute("", "ssh-add", args...)
+
+	if !result {
+		return errors.New("Failed to remove SSH key from cache")
+	}
+
+	return nil
+}
+
+// DeleteCache removes SSH key from SSH agent cache via key alias
+func DeleteCache(alias string, keyMap map[string]*SSHKey, env *Environment) error {
+	key, found := keyMap[alias]
+
+	if !found {
+		return fmt.Errorf("SSH key [%s] not found", alias)
+	}
+
+	// Remove key from SSH agent cache
+	privateKeyPath := filepath.Join(env.StorePath, alias, key.Type.PrivateKey())
+	args := []string{"-d", privateKeyPath}
+	result := Execute("", "ssh-add", args...)
+
+	if !result {
+		return errors.New("Failed to remove SSH key from cache")
+	}
+
+	return nil
+}
+
+// ListCache lists cached SSH key from SSH agent cache
+func ListCache() error {
+	args := []string{"-l"}
+	result := Execute("", "ssh-add", args...)
+
+	if !result {
+		return errors.New("Failed to list SSH keys from cache")
+	}
+
+	return nil
+}
+
 // CreateLink creates symbol link for specified SSH key
 func CreateLink(alias string, keyMap map[string]*SSHKey, env *Environment) {
 	ClearKey(env)