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/commands/BaseCommand.java

@@ -37,8 +37,9 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.gitblit.transport.ssh.SshCommandContext;
import com.gitblit.Keys;
import com.gitblit.utils.IdGenerator;
import com.gitblit.utils.StringUtils;
import com.gitblit.utils.WorkQueue;
import com.gitblit.utils.WorkQueue.CancelableRunnable;
import com.gitblit.utils.cli.CmdLineParser;
@@ -49,8 +50,13 @@

   private static final Logger log = LoggerFactory.getLogger(BaseCommand.class);

   /** Ssh context */
   protected SshCommandContext ctx;
   private static final int PRIVATE_STATUS = 1 << 30;

   public final static int STATUS_CANCEL = PRIVATE_STATUS | 1;

   public final static int STATUS_NOT_FOUND = PRIVATE_STATUS | 2;

   public final static int STATUS_NOT_ADMIN = PRIVATE_STATUS | 3;

   protected InputStream in;

@@ -61,6 +67,9 @@
   protected ExitCallback exit;

   protected ServerSession session;

   /** Ssh command context */
   private SshCommandContext ctx;

   /** Text of the command line which lead up to invoking this instance. */
   private String commandName = "";
@@ -87,6 +96,9 @@

   @Override
   public void destroy() {
      log.debug("destroying " + getClass().getName());
      session = null;
      ctx = null;
   }

   protected static PrintWriter toPrintWriter(final OutputStream o) {
@@ -96,8 +108,20 @@
   @Override
   public abstract void start(Environment env) throws IOException;

   protected void provideStateTo(final BaseCommand cmd) {
      cmd.setContext(ctx);
      cmd.setInputStream(in);
      cmd.setOutputStream(out);
      cmd.setErrorStream(err);
      cmd.setExitCallback(exit);
   }

   public void setContext(SshCommandContext ctx) {
      this.ctx = ctx;
   }

   public SshCommandContext getContext() {
      return ctx;
   }

   @Override
@@ -118,16 +142,6 @@
   @Override
   public void setExitCallback(final ExitCallback callback) {
      this.exit = callback;
   }

   protected void provideBaseStateTo(final Command cmd) {
      if (cmd instanceof BaseCommand) {
         ((BaseCommand) cmd).setContext(ctx);
      }
      cmd.setInputStream(in);
      cmd.setOutputStream(out);
      cmd.setErrorStream(err);
      cmd.setExitCallback(exit);
   }

   protected String getName() {
@@ -188,9 +202,39 @@
      }

      if (clp.wasHelpRequestedByOption()) {
         CommandMetaData meta = getClass().getAnnotation(CommandMetaData.class);
         String title = meta.name().toUpperCase() + ": " + meta.description();
         String b = com.gitblit.utils.StringUtils.leftPad("", title.length() + 2, '═');
         StringWriter msg = new StringWriter();
         clp.printDetailedUsage(commandName, msg);
         msg.write(usage());
         msg.write('\n');
         msg.write(b);
         msg.write('\n');
         msg.write(' ');
         msg.write(title);
         msg.write('\n');
         msg.write(b);
         msg.write("\n\n");
         msg.write("USAGE\n");
         msg.write("─────\n");
         msg.write(' ');
         msg.write(commandName);
         msg.write('\n');
         msg.write("  ");
         clp.printSingleLineUsage(msg, null);
         msg.write("\n\n");
         msg.write("ARGUMENTS & OPTIONS\n");
         msg.write("───────────────────\n");
         clp.printUsage(msg, null);
         msg.write('\n');
         String examples = usage().trim();
         if (!StringUtils.isEmpty(examples)) {
            msg.write('\n');
            msg.write("EXAMPLES\n");
            msg.write("────────\n");
            msg.write(examples);
            msg.write('\n');
         }

         throw new UnloggedFailure(1, msg.toString());
      }
   }
@@ -200,8 +244,37 @@
      return new CmdLineParser(options);
   }

   protected String usage() {
   public String usage() {
      Class<? extends BaseCommand> clazz = getClass();
      if (clazz.isAnnotationPresent(UsageExamples.class)) {
         return examples(clazz.getAnnotation(UsageExamples.class).examples());
      } else if (clazz.isAnnotationPresent(UsageExample.class)) {
         return examples(clazz.getAnnotation(UsageExample.class));
      }
      return "";
   }

   protected String examples(UsageExample... examples) {
      int sshPort = getContext().getGitblit().getSettings().getInteger(Keys.git.sshPort, 29418);
      String username = getContext().getClient().getUsername();
      String hostname = "localhost";
      String ssh = String.format("ssh -l %s -p %d %s", username, sshPort, hostname);

      StringBuilder sb = new StringBuilder();
      for (UsageExample example : examples) {
         sb.append(example.description()).append("\n\n");
         String syntax = example.syntax();
         syntax = syntax.replace("${ssh}", ssh);
         syntax = syntax.replace("${username}", username);
         syntax = syntax.replace("${cmd}", commandName);
         sb.append("   ").append(syntax).append("\n\n");
      }
      return sb.toString();
   }

   protected void showHelp() throws UnloggedFailure {
      argv = new String [] { "--help" };
      parseCommandLine();
   }

   private final class TaskThunk implements CancelableRunnable {
@@ -220,7 +293,7 @@
      public void cancel() {
         synchronized (this) {
            try {
               // onExit(/*STATUS_CANCEL*/);
               onExit(STATUS_CANCEL);
            } finally {
               ctx = null;
            }
@@ -305,18 +378,12 @@
   /**
    * Terminate this command and return a result code to the remote client.
    * <p>
    * Commands should invoke this at most once. Once invoked, the command may
    * lose access to request based resources as any callbacks previously
    * registered with {@link RequestCleanup} will fire.
    * Commands should invoke this at most once.
    *
    * @param rc
    *            exit code for the remote client.
    * @param rc exit code for the remote client.
    */
   protected void onExit(final int rc) {
      exit.onExit(rc);
      // if (cleanup != null) {
      // cleanup.run();
      // }
   }

   private int handleError(final Throwable e) {
@@ -334,16 +401,14 @@
      } else {
         final StringBuilder m = new StringBuilder();
         m.append("Internal server error");
         // if (userProvider.get().isIdentifiedUser()) {
         // final IdentifiedUser u = (IdentifiedUser) userProvider.get();
         // m.append(" (user ");
         // m.append(u.getAccount().getUserName());
         // m.append(" account ");
         // m.append(u.getAccountId());
         // m.append(")");
         // }
         // m.append(" during ");
         // m.append(contextProvider.get().getCommandLine());
         String user = ctx.getClient().getUsername();
         if (user != null) {
            m.append(" (user ");
            m.append(user);
            m.append(")");
         }
         m.append(" during ");
         m.append(ctx.getCommandLine());
         log.error(m.toString(), e);
      }