.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 system to leverage the OpenPGP Web of Trust
+for ssh authentication. OpenPGP keys are tracked via GnuPG, and added
+to the ssh authorized_keys and known_hosts files to be used for
+authentication of ssh connections.
\fBmonkeysphere\fP is the MonkeySphere client utility.
KEY ACCEPTABILITY), then the key will be updated and re-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
+known_hosts file will be processed. This command will exit with a
+status of 0 if all host were found to be acceptable, 2 if all the
+hosts were found to be unacceptable (ie. with keys removed from the
+known_hosts file), and 1 otherwise. `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 specified. If a key is found, 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'.
-.TP
.B update-authorized_keys
Update the monkeysphere authorized_keys file. For each user ID in the
user's authorized_user_ids file, gpg will be queried for keys
keys will be removed from the user's authorized_keys file. If the
found key is acceptable (see KEY ACCEPTABILITY), then the key will be
updated and re-added to the authorized_keys file. If no gpg key is
-found for the user ID, then nothing is done. `a' may be used in place
-of `update-authorized_keys'.
+found for the user ID, then nothing is done. This command will exit
+with a status of 0 if all user IDs were found to be acceptable, 2 if
+all the user IDs were found to be unacceptable (ie. with keys removed
+from the authorized_keys file), and 1 otherwise. `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
.SH HOST URIs
Host OpenPGP keys have associated user IDs that use the ssh URI
-specification for the host, ie. "ssh://host.full.domain".
+specification for the host, ie. "ssh://host.full.domain[:port]".
.SH KEY ACCEPTABILITY
GPG keys are considered acceptable if the following criteria are met:
.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.
+The key must have the "authentication" ("a") usage flag set.
.TP
.B validity
-The key must be "fully" valid, and must not be expired or revoked.
+The key must be "fully" valid (ie. signed by a trusted certifier), and
+must not be expired or revoked.
.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.
.SH AUTHOR
projects / monkeysphere.git / blobdiff