Track the SSH public key used for a session and add a `keys which` command

James Moger

2014-03-27 8d96b960e472433d2b4a5b71df7000bf1fbde648

 src/main/java/com/gitblit/transport/ssh/gitblit/KeysDispatcher.java

@@ -30,6 +30,9 @@
import com.gitblit.transport.ssh.commands.CommandMetaData;
import com.gitblit.transport.ssh.commands.DispatchCommand;
import com.gitblit.transport.ssh.commands.SshCommand;
import com.gitblit.transport.ssh.commands.UsageExample;
import com.gitblit.utils.FlipTable;
import com.gitblit.utils.FlipTable.Borders;

/**
 * The dispatcher and it's commands for SSH public key management.
@@ -45,14 +48,16 @@
      register(user, AddKey.class);
      register(user, RemoveKey.class);
      register(user, ListKeys.class);
      register(user, WhichKey.class);
   }

   @CommandMetaData(name = "add", description = "Add an SSH public key to your account")
   @UsageExample(syntax = "cat ~/.ssh/id_rsa.pub | ${ssh} ${cmd} -", description = "Upload your SSH public key and add it to your account")
   public static class AddKey extends BaseKeyCommand {

      protected final Logger log = LoggerFactory.getLogger(getClass());

      @Argument(metaVar = "<stdin>|KEY", usage = "the key to add")
      @Argument(metaVar = "-|<KEY>", usage = "the key(s) to add", required = true)
      private List<String> addKeys = new ArrayList<String>();

      @Override
@@ -68,6 +73,7 @@
   }

   @CommandMetaData(name = "remove", aliases = { "rm" }, description = "Remove an SSH public key from your account")
   @UsageExample(syntax = "${cmd} 2", description = "Remove the SSH key identified as #2 in `keys list`")
   public static class RemoveKey extends BaseKeyCommand {

      protected final Logger log = LoggerFactory.getLogger(getClass());
@@ -129,7 +135,7 @@
      }
   }

   @CommandMetaData(name = "list", aliases = { "ls" }, description = "List your registered public keys")
   @CommandMetaData(name = "list", aliases = { "ls" }, description = "List your registered SSH public keys")
   public static class ListKeys extends SshCommand {

      @Option(name = "-L", usage = "list complete public key parameters")
@@ -140,20 +146,65 @@
         IPublicKeyManager keyManager = getContext().getGitblit().getPublicKeyManager();
         String username = getContext().getClient().getUsername();
         List<SshKey> keys = keyManager.getKeys(username);
         if (keys == null || keys.isEmpty()) {
            stdout.println("You have not registered any public keys for ssh authentication.");

         if (showRaw) {
            asRaw(keys);
         } else {
            asTable(keys);
         }
      }

      /* output in the same format as authorized_keys */
      protected void asRaw(List<SshKey> keys) {
         if (keys == null) {
            return;
         }
         for (int i = 0; i < keys.size(); i++) {
            if (showRaw) {
               // output in the same format as authorized_keys
               stdout.println(keys.get(i).getRawData());
            } else {
               // show 1-based index numbers with the fingerprint
               // this is useful for comparing with "ssh-add -l"
               stdout.println("#" + (i + 1) + ": " + keys.get(i).getFingerprint());
            }
         for (SshKey key : keys) {
            stdout.println(key.getRawData());
         }
      }

      protected void asTable(List<SshKey> keys) {
         String[] headers = { "#", "Fingerprint", "Comment", "Type" };
         int len = keys == null ? 0 : keys.size();
         Object[][] data = new Object[len][];
         for (int i = 0; i < len; i++) {
            // show 1-based index numbers with the fingerprint
            // this is useful for comparing with "ssh-add -l"
            SshKey k = keys.get(i);
            data[i] = new Object[] { (i + 1), k.getFingerprint(), k.getComment(), k.getAlgorithm() };
         }

         stdout.println(FlipTable.of(headers, data, Borders.BODY_HCOLS));
      }
   }

   @CommandMetaData(name = "which", description = "Display the SSH public key used for this session")
   public static class WhichKey extends SshCommand {

      @Option(name = "-L", usage = "list complete public key parameters")
      private boolean showRaw;

      @Override
      public void run() throws UnloggedFailure {
         SshKey key = getContext().getClient().getKey();
         if (key == null) {
            throw new UnloggedFailure(1,  "You have not authenticated with an SSH public key.");
         }

         if (showRaw) {
            stdout.println(key.getRawData());
         } else {
            asTable(key);
         }
      }

      protected void asTable(SshKey key) {
         String[] headers = { "Fingerprint", "Comment", "Type" };
         Object[][] data = new Object[1][];
         data[0] = new Object[] { key.getFingerprint(), key.getComment(), key.getAlgorithm() };

         stdout.println(FlipTable.of(headers, data, Borders.BODY_HCOLS));
      }
   }
}