tweak some of the log output inconsequentially

[monkeysphere.git] / man / man1 / monkeysphere.1

diff --git a/man/man1/monkeysphere.1 b/man/man1/monkeysphere.1
index 3ece73581926b01138be81b66f0a0d650e91477a..0e8004700159d1bd4d88b0691dd779cf664be097 100644 (file)
--- a/man/man1/monkeysphere.1
+++ b/man/man1/monkeysphere.1
@@ -64,6 +64,54 @@ monkeysphere transactions.  An expiration length can be specified with
 the `-e' or `--expire' option (prompt otherwise).  If no key ID is
 specified, but only one key exists in the secret keyring, that key
 will be used.  `g' may be used in place of `gen-subkey'.
+.TP
+.B ssh-proxycommand
+an ssh proxy command that can be used
+to trigger a monkeysphere update of the ssh known_hosts file for a
+host that is being connected to with ssh.  This works by updating the
+known_hosts file for the host first, before an attempted connection to
+the host is made.  Once the known_hosts file has been updated, a TCP
+connection to the host is made by exec'ing netcat(1).  Regular ssh
+communication is then done over this netcat TCP connection (see
+ProxyCommand in ssh_config(5) for more info).
+
+This command is meant to be run as the ssh "ProxyCommand".  This can
+either be done by specifying the proxy command on the command line:
+
+.B ssh -o ProxyCommand="monkeysphere ssh-proxycommand %h %p" ...
+
+or by adding the following line to your ~/.ssh/config script:
+
+.B ProxyCommand monkeysphere ssh-proxycommand %h %p
+
+The script can easily be incorporated into other ProxyCommand scripts
+by calling it with the "--no-connect" option, i.e.:
+
+.B monkeysphere ssh-proxycommand --no-connect "$HOST" "$PORT"
+
+This will run everything except the final exec of netcat to make the
+TCP connection to the host.  In this way this command can be added to
+another proxy command that does other stuff, and then makes the
+connection to the host itself.
+
+KEYSERVER CHECKING:
+The proxy command has a fairly nuanced policy for when keyservers are
+queried when processing a host.  If the host userID is not found in
+either the user's keyring or in the known_hosts file, then the
+keyserver is queried for the host userID.  If the host userID is found
+in the user's keyring, then the keyserver is not checked.  This
+assumes that the keyring is kept up-to-date, in a cronjob or the like,
+so that revocations are properly handled.  If the host userID is not
+found in the user's keyring, but the host is listed in the known_hosts
+file, then the keyserver is not checked.  This last policy might
+change in the future, possibly by adding a deferred check, so that
+hosts that go from non-monkeysphere-enabled to monkeysphere-enabled
+will be properly checked.
+
+Setting the MONKEYSPHERE_CHECK_KEYSERVER
+variable (to `true' or `false') will override the keyserver-checking policy
+defined above.
+
 .TP
 .B subkey-to-ssh-agent [ssh-add arguments]
 Push all authentication-capable subkeys in your GnuPG secret keyring
@@ -120,13 +168,14 @@ addition to the authorized_keys file.
 
 .SH AUTHOR
 
-Written by Jameson Rollins <jrollins@fifthhorseman.net>, Daniel
-Kahn Gillmor <dkg@fifthhorseman.net>
+Written by:
+Jameson Rollins <jrollins@fifthhorseman.net>,
+Daniel Kahn Gillmor <dkg@fifthhorseman.net>
 
 .SH SEE ALSO
 
-.BR monkeysphere-ssh-proxycommand (1),
-.BR monkeysphere-server (8),
+.BR monkeysphere-host (8),
+.BR monkeysphere-authentication (8),
 .BR monkeysphere (7),
 .BR ssh (1),
 .BR ssh-add (1),