From bfa998a3d04e759be555dd8136aaa9450960a879 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Thu, 10 Apr 2014 19:00:04 -0400
Subject: [PATCH] Documentation
---
src/main/java/com/gitblit/transport/ssh/gitblit/KeysDispatcher.java | 37 +++++++++++++++++++++++++++++++++++--
1 files changed, 35 insertions(+), 2 deletions(-)
diff --git a/src/main/java/com/gitblit/transport/ssh/gitblit/KeysDispatcher.java b/src/main/java/com/gitblit/transport/ssh/gitblit/KeysDispatcher.java
index 8c4aa22..b42be17 100644
--- a/src/main/java/com/gitblit/transport/ssh/gitblit/KeysDispatcher.java
+++ b/src/main/java/com/gitblit/transport/ssh/gitblit/KeysDispatcher.java
@@ -30,6 +30,7 @@
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;
@@ -47,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
@@ -70,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());
@@ -131,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")
@@ -174,4 +178,33 @@
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));
+ }
+ }
}
--
Gitblit v1.9.1