.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
-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 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.
+\fBmonkeysphere\fP is the Monkeysphere client utility.
.SH SUBCOMMANDS
.TP
.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 user ID to 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). `u' may be
-used in place of `update-userids'.
-.TP
-.B remove-userids [USERID]...
-Remove a user ID from the authorized_user_ids file. The user IDs
-specified should be exact matches to OpenPGP user IDs. `r' may be
-used in place of `remove-userids'.
+queried for a key associated with the host URI (see HOST
+IDENTIFICATION in
+.BR monkeysphere(5)),
+optionally querying a keyserver.
+If an acceptable key is found for the host (see KEY ACCEPTABILITY in
+.BR monkeysphere(5)),
+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 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). `a' may be
-used in place of `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, 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)),
+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 `a` capable subkey. For the primary key with the
-specified key ID, generate a subkey with "authentication" capability
-that can be used for MonkeySphere transactions. `g' may be used in
-place of `gen-subkey'.
+.B gen-subkey [KEYID]
+Generate an authentication subkey for a private key in your GnuPG
+keyring. For the primary key with the specified key ID, generate a
+subkey with "authentication" capability that can be used for
+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 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'. `s' may be used in place of `subkey-to-ssh-agent'.
.TP
.B help
Output a brief usage summary. `h' or `?' may be used in place of
`help'.
-.SH HOST URIs
-
-Host OpenPGP keys have associated user IDs that use the ssh URI
-specification for the host, ie. "ssh://host.full.domain".
+.SH ENVIRONMENT
-.SH KEY ACCEPTABILITY
-
-GPG keys are considered acceptable if the following criteria are met:
+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, DEBUG, in increasing
+order of verbosity.
+.TP
+MONKEYSPHERE_GNUPGHOME, GNUPGHOME
+GnuPG home directory (~/.gnupg).
.TP
-.B capability
-For host keys, the key must have both the "authentication" ("a") and
-"encrypt" ("e") capability flags. For user keys, the key must have
-the "authentication" ("a") capability flag.
+MONKEYSPHERE_KEYSERVER
+OpenPGP keyserver to use (subkeys.pgp.net).
.TP
-.B validity
-The key must be "fully" valid, and must not be expired or revoked.
-
-.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').
+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).
.SH FILES
~/.config/monkeysphere/authorized_user_ids
OpenPGP 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.
.SH AUTHOR
-Written by Jameson Rollins <jrollins@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 (5),
.BR ssh (1),
+.BR ssh-add (1),
.BR gpg (1)
projects / monkeysphere.git / blobdiff