Preserve key index when re-adding an existing key

James Moger

2014-03-27 ab07d0d86d8b64b4f7c88b45bc81f1eec22105db

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

@@ -30,8 +30,10 @@
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;
import com.google.common.base.Joiner;

/**
 * The dispatcher and it's commands for SSH public key management.
@@ -47,14 +49,17 @@
      register(user, AddKey.class);
      register(user, RemoveKey.class);
      register(user, ListKeys.class);
      register(user, WhichKey.class);
      register(user, CommentKey.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
@@ -70,6 +75,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());
@@ -131,7 +137,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")
@@ -174,4 +180,73 @@
         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 {
            final String username = getContext().getClient().getUsername();
            List<SshKey> keys = getContext().getGitblit().getPublicKeyManager().getKeys(username);
            int index = 0;
            for (int i = 0; i < keys.size(); i++) {
               if (key.equals(keys.get(i))) {
                  index = i + 1;
                  break;
               }
            }
            asTable(index, key);
         }
      }

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

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

   @CommandMetaData(name = "comment", description = "Set the comment for an SSH public key")
   @UsageExample(syntax = "${cmd} 3 Home workstation", description = "Set the comment for key #3")
   public static class CommentKey extends SshCommand {

      @Argument(index = 0, metaVar = "INDEX", usage = "the key index", required = true)
      private int index;

      @Argument(index = 1, metaVar = "COMMENT", usage = "the new comment", required = true)
      private List<String> values = new ArrayList<String>();

      @Override
      public void run() throws UnloggedFailure {
         final String username = getContext().getClient().getUsername();
         IPublicKeyManager keyManager = getContext().getGitblit().getPublicKeyManager();
         List<SshKey> keys = keyManager.getKeys(username);
         if (index > keys.size()) {
            throw new UnloggedFailure(1,  "Invalid key index!");
         }

         String comment = Joiner.on(" ").join(values);
         SshKey key = keys.get(index - 1);
         key.setComment(comment);
         if (keyManager.addKey(username, key)) {
            stdout.println(String.format("Updated the comment for key #%d.", index));
         } else {
            throw new UnloggedFailure(1, String.format("Failed to update the comment for key #%d!", index));
         }
      }

   }
}