X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=man%2Fman1%2Fmonkeysphere.1;h=1a529833bda8ce7c34e7e5beee38652015ed8f21;hb=487fffd53cd109fb7f6291735c1f5cb5a0df8eeb;hp=92ba2fa076512043c404495c37d73b53802f84e7;hpb=e32ef4a7da9587ad8bd22f8ed1f517257417f713;p=monkeysphere.git diff --git a/man/man1/monkeysphere.1 b/man/man1/monkeysphere.1 index 92ba2fa..1a52983 100644 --- a/man/man1/monkeysphere.1 +++ b/man/man1/monkeysphere.1 @@ -25,10 +25,10 @@ connection authentication. Update the known_hosts file. For each specified host, gpg will be queried for a key associated with the host URI (see HOST IDENTIFICATION in -.BR monkeysphere(5)), +.BR monkeysphere(7)), optionally querying a keyserver. If an acceptable key is found for the host (see KEY ACCEPTABILITY in -.BR monkeysphere(5)), +.BR monkeysphere(7)), the key is added to the user's known_hosts file. If a key is found but is unacceptable for the host, any matching keys are removed from the user's known_hosts file. If no gpg key is found for the host, @@ -38,6 +38,54 @@ status of 0 if at least one acceptable key was found for a specified host, 1 if no matching keys were found at all, and 2 if matching keys were found but none were acceptable. `k' may be used in place of `update-known_hosts'. +.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 update-authorized_keys Update the authorized_keys file for the user executing the command @@ -46,7 +94,7 @@ monkeysphere keys are cleared from the authorized_keys file. Then, or each user ID in the user's authorized_user_ids file, gpg will be queried for keys associated with that user ID, optionally querying a keyserver. If an acceptable key is found (see KEY ACCEPTABILITY in -.BR monkeysphere (5)), +.BR monkeysphere (7)), the key is added to the user's authorized_keys file. If a key is found but is unacceptable for the user ID, any matching keys are removed from the user's authorized_keys file. If no gpg key @@ -83,6 +131,10 @@ Output a brief usage summary. `h' or `?' may be used in place of The following environment variables will override those specified in the monkeysphere.conf configuration file (defaults in parentheses): .TP +MONKEYSPHERE_LOG_LEVEL +Set the log level (INFO). Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, +in increasing order of verbosity. +.TP MONKEYSPHERE_GNUPGHOME, GNUPGHOME GnuPG home directory (~/.gnupg). .TP @@ -104,13 +156,13 @@ Path to ssh authorized_keys file (~/.ssh/authorized_keys). .SH FILES .TP -~/.config/monkeysphere/monkeysphere.conf +~/.monkeysphere/monkeysphere.conf User monkeysphere config file. .TP /etc/monkeysphere/monkeysphere.conf System-wide monkeysphere config file. .TP -~/.config/monkeysphere/authorized_user_ids +~/.monkeysphere/authorized_user_ids OpenPGP user IDs associated with keys that will be checked for addition to the authorized_keys file. @@ -121,9 +173,12 @@ Kahn Gillmor .SH SEE ALSO -.BR monkeysphere-ssh-proxycommand (1), -.BR monkeysphere-server (8), -.BR monkeysphere (5), +\" DELETEME +\".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), .BR gpg (1)