1 .TH MONKEYSPHERE-SERVER "8" "June 2008" "monkeysphere" "User Commands"
5 monkeysphere-authentication \- Monkeysphere authentication admin tool.
9 .B monkeysphere-authentication \fIsubcommand\fP [\fIargs\fP]
11 .B monkeysphere-authentication expert \fIexpert-subcommand\fP [\fIargs\fP]
15 \fBMonkeysphere\fP is a framework to leverage the OpenPGP web of trust for
16 OpenSSH authentication. OpenPGP keys are tracked via GnuPG, and added to the
17 authorized_keys and known_hosts files used by OpenSSH for connection
20 \fBmonkeysphere-authentication\fP is a Monkeysphere server admin utility.
24 \fBmonkeysphere-authentication\fP takes various subcommands.
27 Setup the server for Monkeysphere user authentication. `s' may be
28 used in place of `setup'.
30 .B update-users [ACCOUNT]...
31 Rebuild the monkeysphere-controlled authorized_keys files. For each
32 specified account, the user ID's listed in the account's
33 authorized_user_ids file are processed. For each user ID, gpg will be
34 queried for keys associated with that user ID, optionally querying a
35 keyserver. If an acceptable key is found (see KEY ACCEPTABILITY in
36 monkeysphere(7)), the key is added to the account's
37 monkeysphere-controlled authorized_keys file. If the
38 RAW_AUTHORIZED_KEYS variable is set, then a separate authorized_keys
39 file (usually ~USER/.ssh/authorized_keys) is appended to the
40 monkeysphere-controlled authorized_keys file. If no accounts are
41 specified, then all accounts on the system are processed. `u' may be
42 used in place of `update-users'.
44 .B add-id-certifier KEYID
45 Instruct system to trust user identity certifications made by KEYID.
46 Using the `-n' or `--domain' option allows you to indicate that you
47 only trust the given KEYID to make identifications within a specific
48 domain (e.g. "trust KEYID to certify user identities within the
49 @example.org domain"). A certifier trust level can be specified with
50 the `-t' or `--trust' option (possible values are `marginal' and
51 `full' (default is `full')). A certifier trust depth can be specified
52 with the `-d' or `--depth' option (default is 1). `c+' may be used in
53 place of `add-id-certifier'.
55 .B remove-id-certifier KEYID
56 Instruct system to ignore user identity certifications made by KEYID.
57 `c-' may be used in place of `remove-id-certifier'.
60 List key IDs trusted by the system to certify user identities. `c'
61 may be used in place of `list-id-certifiers'.
64 Review the state of the server with respect to authentication. `d'
65 may be used in place of `diagnostics'.
68 Execute a gpg command, as the monkeysphere user, on the monkeysphere
69 authentication "sphere" keyring. This takes a single argument
70 (multiple gpg arguments need to be quoted). Use this command with
71 caution, as modifying the authentication sphere keyring can affect ssh
75 Output a brief usage summary. `h' or `?' may be used in place of
81 .SH SETUP USER AUTHENTICATION
83 If the server will handle user authentication through
84 monkeysphere-generated authorized_keys files, the server must be told
85 which keys will act as identity certifiers. This is done with the
86 \fBadd-id-certifier\fP command:
88 $ monkeysphere-authentication add-id-certifier KEYID
90 where KEYID is the key ID of the server admin, or whoever's
91 certifications should be acceptable to the system for the purposes of
92 authenticating remote users. You can run this command multiple times
93 to indicate that multiple certifiers are trusted. You may also
94 specify a filename instead of a key ID, as long as the file contains a
95 single OpenPGP public key. Certifiers can be removed with the
96 \fBremove-id-certifier\fP command, and listed with the
97 \fBlist-id-certifiers\fP command.
99 Remote users will then be granted access to a local account based on
100 the appropriately-signed and valid keys associated with user IDs
101 listed in that account's authorized_user_ids file. By default, the
102 authorized_user_ids file for an account is
103 ~/.monkeysphere/authorized_user_ids. This can be changed in the
104 monkeysphere-authentication.conf file.
106 The \fBupdate-users\fP command can then be used to generate
107 authorized_keys file for local accounts based on the authorized user
108 IDs listed in the account's authorized_user_ids file:
110 $ monkeysphere-authentication update-users USER
112 Not specifying USER will cause all accounts on the system to updated.
113 sshd can then use these monkeysphere generated authorized_keys files
114 to grant access to user accounts for remote users. You must also tell
115 sshd to look at the monkeysphere-generated authorized_keys file for
116 user authentication by setting the following in the sshd_config:
118 AuthorizedKeysFile /var/lib/monkeysphere/authentication/authorized_keys/%u
120 It is recommended to add "monkeysphere-authentication update-users" to a
121 system crontab, so that user keys are kept up-to-date, and key
122 revocations and expirations can be processed in a timely manner.
126 The following environment variables will override those specified in
127 the config file (defaults in parentheses):
129 MONKEYSPHERE_MONKEYSPHERE_USER
130 User to control authentication keychain (monkeysphere).
132 MONKEYSPHERE_LOG_LEVEL
133 Set the log level (INFO). Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, in
134 increasing order of verbosity.
136 MONKEYSPHERE_KEYSERVER
137 OpenPGP keyserver to use (pool.sks-keyservers.net).
139 MONKEYSPHERE_AUTHORIZED_USER_IDS
140 Path to user authorized_user_ids file
141 (%h/.monkeysphere/authorized_user_ids).
143 MONKEYSPHERE_RAW_AUTHORIZED_KEYS
144 Path to user-controlled authorized_keys file. `-' means not to add
145 user-controlled file (%h/.ssh/authorized_keys).
150 /etc/monkeysphere/monkeysphere-authentication.conf
151 System monkeysphere-authentication config file.
153 /var/lib/monkeysphere/authentication/authorized_keys/USER
154 Monkeysphere-generated user authorized_keys files.
159 Jameson Rollins <jrollins@fifthhorseman.net>,
160 Daniel Kahn Gillmor <dkg@fifthhorseman.net>,
161 Matthew Goins <mjgoins@openflows.com>
165 .BR monkeysphere (1),
166 .BR monkeysphere-host (8),
167 .BR monkeysphere (7),