1 .TH MONKEYSPHERE "1" "June 2008" "monkeysphere 0.1" "User Commands"
5 monkeysphere \- Monkeysphere client user interface
9 .B monkeysphere \fIsubcommand\fP [\fIargs\fP]
13 \fBMonkeysphere\fP is a framework to leverage the OpenPGP web of trust
14 for OpenSSH authentication. OpenPGP keys are tracked via GnuPG, and
15 added to the authorized_keys and known_hosts files used by OpenSSH for
16 connection authentication.
18 \fBmonkeysphere\fP is the Monkeysphere client utility.
22 \fBmonkeysphere\fP takes various subcommands:
24 .B update-known_hosts [HOST]...
25 Update the known_hosts file. For each specified host, gpg will be
26 queried for a key associated with the host URI (see HOST
27 IDENTIFICATION in monkeysphere(5)), optionally querying a keyserver.
28 If an acceptable key is found for the host (see KEY ACCEPTABILITY in
29 monkeysphere(5)), the key is added to the user's known_hosts file. If
30 a key is found but is unacceptable for the host, any matching keys are
31 removed from the user's known_hosts file. If no gpg key is found for
32 the host, nothing is done. If no hosts are specified, all hosts
33 listed in the known_hosts file will be processed. This subcommand
34 will exit with a status of 0 if at least one acceptable key was found
35 for a specified host, 1 if no matching keys were found at all, and 2
36 if matching keys were found but none were acceptable. `k' may be used
37 in place of `update-known_hosts'.
39 .B update-authorized_keys
40 Update the authorized_keys file for the user executing the command
41 (see MONKEYSPHERE_AUTHORIZED_KEYS in ENVIRONMENT, below). First all
42 monkeysphere keys are cleared from the authorized_keys file. Then, or
43 each user ID in the user's authorized_user_ids file, gpg will be
44 queried for keys associated with that user ID, optionally querying a
45 keyserver. If an acceptable key is found (see KEY ACCEPTABILITY in
46 monkeysphere(5)), the key is added to the user's authorized_keys file.
47 If a key is found but is unacceptable for the user ID, any matching
48 keys are removed from the user's authorized_keys file. If no gpg key
49 is found for the user ID, nothing is done. This subcommand will exit
50 with a status of 0 if at least one acceptable key was found for a user
51 ID, 1 if no matching keys were found at all, and 2 if matching keys
52 were found but none were acceptable. `a' may be used in place of
53 `update-authorized_keys'.
56 Generate an authentication subkey for a private key in your GnuPG
57 keyring. For the primary key with the specified key ID, generate a
58 subkey with "authentication" capability that can be used for
59 monkeysphere transactions. An expiration length can be specified with
60 the `-e' or `--expire' option (prompt otherwise). If no key ID is
61 specified, but only one key exists in the secret keyring, that key
62 will be used. `g' may be used in place of `gen-subkey'.
65 Output a brief usage summary. `h' or `?' may be used in place of
70 The following environment variables will override those specified in
71 the monkeysphere.conf configuration file (defaults in parentheses):
73 MONKEYSPHERE_GNUPGHOME, GNUPGHOME
74 GnuPG home directory (~/.gnupg).
76 MONKEYSPHERE_KEYSERVER
77 OpenPGP keyserver to use (subkeys.pgp.net).
79 MONKEYSPHERE_CHECK_KEYSERVER
80 Whether or not to check keyserver when making gpg queries (`true').
82 MONKEYSPHERE_KNOWN_HOSTS
83 Path to ssh known_hosts file (~/.ssh/known_hosts).
85 MONKEYSPHERE_HASH_KNOWN_HOSTS
86 Whether or not to hash to the known_hosts file entries (`true').
88 MONKEYSPHERE_AUTHORIZED_KEYS
89 Path to ssh authorized_keys file (~/.ssh/authorized_keys).
94 ~/.config/monkeysphere/monkeysphere.conf
95 User monkeysphere config file.
97 /etc/monkeysphere/monkeysphere.conf
98 System-wide monkeysphere config file.
100 ~/.config/monkeysphere/authorized_user_ids
101 OpenPGP user IDs associated with keys that will be checked for
102 addition to the authorized_keys file.
106 Written by Jameson Rollins <jrollins@fifthhorseman.net>, Daniel
107 Kahn Gillmor <dkg@fifthhorseman.net>
111 .BR monkeysphere-ssh-proxycommand (1),
112 .BR monkeysphere-server (8),
113 .BR monkeysphere (5),