X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=man%2Fman1%2Fmonkeysphere.1;h=1c9217fe5b170751bcf0ca4e9eb7c10214d98da6;hb=eb815bce0da27a24ad718c31b77e45032e3a5916;hp=410a5d7d4745d6e20f2f91086ce5a5ed66867e16;hpb=35a6f7cf8c455318078c7f94951dbc964bb41006;p=monkeysphere.git diff --git a/man/man1/monkeysphere.1 b/man/man1/monkeysphere.1 index 410a5d7..1c9217f 100644 --- a/man/man1/monkeysphere.1 +++ b/man/man1/monkeysphere.1 @@ -1,108 +1,203 @@ .TH MONKEYSPHERE "1" "June 2008" "monkeysphere 0.1" "User Commands" + .SH NAME -monkeysphere \- MonkeySphere client user interface + +monkeysphere - Monkeysphere client user interface + .SH SYNOPSIS -.B monkeysphere \fIcommand\fP [\fIargs\fP] + +.B monkeysphere \fIsubcommand\fP [\fIargs\fP] + .SH DESCRIPTION -.PP -MonkeySphere is a system to leverage the OpenPGP Web of Trust for ssh -authentication and encryption. OpenPGP keys are tracked via GnuPG, -and added to the ssh authorized_keys and known_hosts files to be used -for authentication and encryption of ssh connection. - -\fBmonkeysphere\fP is the MonkeySphere client utility. -.PD + +\fBMonkeysphere\fP is a framework to leverage the OpenPGP web of trust +for OpenSSH authentication. OpenPGP keys are tracked via GnuPG, and +added to the authorized_keys and known_hosts files used by OpenSSH for +connection authentication. + +\fBmonkeysphere\fP is the Monkeysphere client utility. + .SH SUBCOMMANDS + \fBmonkeysphere\fP takes various subcommands: .TP -.B update-known_hosts [HOST]... +.B update\-known_hosts [HOST]... Update the known_hosts file. For each specified host, gpg will be -queried for a key associated with the host URI (see HOST URIs), -querying a keyserver if none is found in the user's keychain. search -for a gpg key for the host in the Web of Trust. If a key is found, it -will be added to the host_keys cache (see KEY CACHES) and any ssh keys -for the host will be removed from the user's known_hosts file. If the -found key is acceptable (see KEY ACCEPTABILITY), then the host's gpg -key will be added to the known_hosts file. If no gpg key is found for -the host, then nothing is done. If no hosts are specified, all hosts -listed in the known_hosts file will be processed. `k' may be used in -place of `update-known_hosts'. -.TP -.B update-userids [USERID]... -Add/update a userid in the authorized_user_ids file. The user IDs -specified should be exact matches to OpenPGP user IDs. For each -specified user ID, gpg will be queried for a key associated with that -user ID, querying a keyserver if none is found in the user's keychain. -If a key is found, it will be added to the user_keys cache (see KEY -CACHES) and the user ID will be added to the user's -authorized_user_ids file (if it wasn't already present). -.TP -.B update-authorized_keys -Update the monkeysphere authorized_keys file. The monkeysphere -authorized_keys file will be regenerated from the valid keys in the -user_key cache, and the user's independently controlled -authorized_keys file (usually ~/.ssh/authorized_keys). -.TP -.B gen-ae-subkey KEYID -Generate an `ae` capable subkey. For the primary key with the -specified key ID, generate a subkey with "authentication" and -"encryption" capability that can be used for MonkeySphere -transactions. +queried for a key associated with the host URI (see HOST +IDENTIFICATION in +.BR monkeysphere(7)), +optionally querying a keyserver. +If an acceptable key is found for the host (see KEY ACCEPTABILITY in +.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, +nothing is done. If no hosts are specified, all hosts listed in the +known_hosts file will be processed. This subcommand will exit with a +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 update\-authorized_keys +Update the authorized_keys file for the user executing the command +(see MONKEYSPHERE_AUTHORIZED_KEYS in ENVIRONMENT, below). First all +monkeysphere keys are cleared from the authorized_keys file. Then, +for 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 (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 +is found for the user ID, nothing is done. This subcommand will exit +with a status of 0 if at least one acceptable key was found for a user +ID, 1 if no matching keys were found at all, and 2 if matching keys +were found but none were acceptable. `a' may be used in place of +`update\-authorized_keys'. +.TP +.B gen\-subkey [KEYID] +Generate an authentication subkey for a private key in your GnuPG +keyring. KEYID is the key ID for the primary key for which the subkey +with "authentication" capability will be generated. If no key ID is +specified, but only one key exists in the secret keyring, that key +will be used. The length of the generated key can be specified with +the `\-\-length' or `\-l' option. `g' may be used in place of +`gen\-subkey'. +.TP +.B ssh\-proxycommand [--no-connect] HOST [PORT] +An ssh ProxyCommand 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 CHECK_KEYSERVER variable in the config file or the +MONKEYSPHERE_CHECK_KEYSERVER environment variable to either `true' or +`false' will override the keyserver-checking policy defined above and +either always or never check the keyserver for host key updates. + +.TP +.B subkey\-to\-ssh\-agent [ssh\-add arguments] +Push all authentication-capable subkeys in your GnuPG secret keyring +into your running ssh-agent. Additional arguments are passed through +to +.BR ssh\-add (1). +For example, to remove the authentication subkeys, pass an additional +`\-d' argument. To require confirmation on each use of the key, pass +`\-c'. The MONKEYSPHERE_SUBKEYS_FOR_AGENT environment can be used to +specify the full fingerprints of specific keys to add to the agent +(space separated), instead of adding them all. `s' may be used in +place of `subkey\-to\-ssh\-agent'. +.TP +.B sshfpr KEYID +Output the ssh fingerprint of a key in your gpg keyring. `f' may be +used in place of `fingerprint'. +.TP +.B version +Show the monkeysphere version number. `v' may be used in place of +`version'. .TP .B help Output a brief usage summary. `h' or `?' may be used in place of `help'. -.PD -.SH KEY ACCEPTABILITY -GPG keys are considered acceptable if the following criteria are met: -.PD -.TP -.B capability -The key must have both the "authentication" and "encrypt" capability -flags. -.TP -.B validity -The key must be "fully" valid, and must not be expired or revoked. -.PD -.SH KEY CACHES -Monkeysphere keeps track of keys in key cache directories. The files -in the cache are named with the format "USERID_HASH.PUB_KEY_ID", where -USERID_HASH is a hash of the exact OpenPGP user ID, and PUB_KEY_ID is -the key ID of the primary key. If the user/key ID combo exists in the -Web of Trust but is not acceptable, then the file is empty. If the -primary key has at least one acceptable sub key, then an ssh-style -key, converted from the OpenPGP key, of all acceptable subkeys will be -stored in the cache file, one per line. known_hosts style key lines -will be stored in the host_keys cache files, and authorized_keys style -key lines will be stored in the user_keys cache files. OpenPGP keys -are converted to ssh-style keys with the openpgp2ssh utility (see `man -openpgp2ssh'). -.PD + +.SH ENVIRONMENT + +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. Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, +in increasing order of verbosity. (INFO) +.TP +MONKEYSPHERE_GNUPGHOME, GNUPGHOME +GnuPG home directory. (~/.gnupg) +.TP +MONKEYSPHERE_KEYSERVER +OpenPGP keyserver to use. (pool.sks-keyservers.net) +.TP +MONKEYSPHERE_CHECK_KEYSERVER +Whether or not to check keyserver when making gpg queries. (true) +.TP +MONKEYSPHERE_KNOWN_HOSTS +Path to ssh known_hosts file. (~/.ssh/known_hosts) +.TP +MONKEYSPHERE_HASH_KNOWN_HOSTS +Whether or not to hash to the known_hosts file entries. (true) +.TP +MONKEYSPHERE_AUTHORIZED_KEYS +Path to ssh authorized_keys file. (~/.ssh/authorized_keys) +.TP +MONKEYSPHERE_PROMPT +If set to `false', never prompt the user for confirmation. (true) +.TP +MONKEYSPHERE_SUBKEYS_FOR_AGENT +A space-separated list of authentication-capable subkeys to add to the +ssh agent with subkey-to-ssh-agent. + .SH FILES -.PD 1 + .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 -GPG user IDs associated with keys that will be checked for addition to -the authorized_keys file. -.TP -~/.config/monkeysphere/authorized_keys -Monkeysphere generated authorized_keys file. -.TP -~/.config/monkeysphere/user_keys -User keys cache directory. -.TP -~/.config/monkeysphere/host_keys -Host keys cache directory. -.PD +~/.monkeysphere/authorized_user_ids +A list of OpenPGP user IDs, one per line. OpenPGP keys with an +exactly-matching User ID (calculated valid by the designated identity +certifiers), will have any valid authorization-capable keys or subkeys +added to the given user's authorized_keys file. + .SH AUTHOR -Written by Jameson Rollins + +Written by: +Jameson Rollins , +Daniel Kahn Gillmor + .SH SEE ALSO + +.BR monkeysphere\-host (8), +.BR monkeysphere\-authentication (8), +.BR monkeysphere (7), .BR ssh (1), -.BR gpg (1), -.BR monkeysphere-server (8) +.BR ssh\-add (1), +.BR gpg (1)