man/man8/monkeysphere-server.8

   1 .TH MONKEYSPHERE-SERVER "8" "June 2008" "monkeysphere" "User Commands"
   2
   3 .SH NAME
   4
   5 monkeysphere-server \- Monkeysphere server admin user interface
   6
   7 .SH SYNOPSIS
   8
   9 .B monkeysphere-server \fIsubcommand\fP [\fIargs\fP]
  10
  11 .SH DESCRIPTION
  12
  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.
  17
  18 \fBmonkeysphere-server\fP is the Monkeysphere server admin utility.
  19
  20 .SH SUBCOMMANDS
  21
  22 \fBmonkeysphere-server\fP takes various subcommands:
  23 .TP
  24 .B update-users [ACCOUNT]...
  25 Rebuild the monkeysphere-controlled authorized_keys files.  For each
  26 specified account, the user ID's listed in the account's
  27 authorized_user_ids file are processed.  For each user ID, gpg will be
  28 queried for keys associated with that user ID, optionally querying a
  29 keyserver.  If an acceptable key is found (see KEY ACCEPTABILITY in
  30 monkeysphere(5)), the key is added to the account's
  31 monkeysphere-controlled authorized_keys file.  If the
  32 RAW_AUTHORIZED_KEYS variable is set, then a separate authorized_keys
  33 file (usually ~USER/.ssh/authorized_keys) is appended to the
  34 monkeysphere-controlled authorized_keys file.  If no accounts are
  35 specified, then all accounts on the system are processed.  `u' may be
  36 used in place of `update-users'.
  37 .TP
  38 .B gen-key [HOSTNAME]
  39 Generate a OpenPGP key pair for the host.  If HOSTNAME is not
  40 specified, then the system fully-qualified domain name will be user.
  41 An alternate key bit length can be specified with the `-l' or
  42 `--length' option (default 2048).  An expiration length can be
  43 specified with the `-e' or `--expire' option (prompt otherwise).  A
  44 key revoker fingerprint can be specified with the `-r' or `--revoker'
  45 option.  `g' may be used in place of `gen-key'.
  46 .TP
  47 .B add-hostname HOSTNAME
  48 Add a hostname user ID to the server host key.  `n+' may be used in
  49 place of `add-hostname'.
  50 .TP
  51 .B revoke-hostname HOSTNAME
  52 Revoke a hostname user ID from the server host key.  `n-' may be used
  53 in place of `revoke-hostname'.
  54 .TP
  55 .B show-key
  56 Output gpg information about host's OpenPGP key.  `s' may be used in
  57 place of `show-key'.
  58 .TP
  59 .B fingerprint
  60 Output just the fingerprint for the host's OpenPGP key.  `f' may be
  61 used in place of `fingerprint'.
  62 .TP
  63 .B publish-key
  64 Publish the host's OpenPGP key to the keyserver.  `p' may be used in
  65 place of `publish-key'.
  66 .TP
  67 .B diagnostics
  68 Review the state of the server with respect to the MonkeySphere in
  69 general and report on suggested changes.  Among other checks, this
  70 includes making sure there is a valid host key, that the key is
  71 published, that the sshd configuration points to the right place, and
  72 that there are at least some valid identity certifiers.  `d' may be
  73 used in place of `diagnostics'.
  74 .TP
  75 .B add-identity-certifier KEYID
  76 Instruct system to trust user identity certifications made by KEYID.
  77 Using the `-n' or `--domain' option allows you to indicate that you
  78 only trust the given KEYID to make identifications within a specific
  79 domain (e.g. "trust KEYID to certify user identities within the
  80 @example.org domain").  A certifier trust level can be specified with
  81 the `-t' or `--trust' option (possible values are `marginal' and
  82 `full' (default is `full')).  A certifier trust depth can be specified
  83 with the `-d' or `--depth' option (default is 1).  `c+' may be used in
  84 place of `add-identity-certifier'.
  85 .TP
  86 .B remove-identity-certifier KEYID
  87 Instruct system to ignore user identity certifications made by KEYID.
  88 `c-' may be used in place of `remove-identity-certifier'.
  89 .TP
  90 .B list-identity-certifiers
  91 List key IDs trusted by the system to certify user identities.  `c'
  92 may be used in place of `list-identity-certifiers'.
  93 .TP
  94 .B gpg-authentication-cmd
  95 Execute a gpg command on the gnupg-authentication keyring as the
  96 monkeysphere user.  This takes a single command (multiple gpg
  97 arguments need to be quoted).  Use this command with caution, as
  98 modifying the gnupg-authentication keyring can affect ssh user
  99 authentication.
 100 .TP
 101 .B help
 102 Output a brief usage summary.  `h' or `?' may be used in place of
 103 `help'.
 104
 105 .SH SETUP
 106
 107 In order to start using the monkeysphere, you must first generate an
 108 OpenPGP key for the server and convert that key to an ssh key that can
 109 be used by ssh for host authentication.  This can be done with the
 110 \fBgen-key\fP subcommand:
 111
 112 $ monkeysphere-server gen-key
 113
 114 To enable host verification via the monkeysphere, you must then
 115 publish the host's key to the Web of Trust using the \fBpublish-key\fP
 116 command to push the key to a keyserver.  You must also modify the
 117 sshd_config on the server to tell sshd where the new server host key
 118 is located:
 119
 120 HostKey /var/lib/monkeysphere/ssh_host_rsa_key
 121
 122 In order for users logging into the system to be able to verify the
 123 host via the monkeysphere, at least one person (e.g. a server admin)
 124 will need to sign the host's key.  This is done using standard key
 125 signing techniquies, usually by pulling the key from the keyserver,
 126 signing the key, and re-publishing the signature.  Once that is done,
 127 users logging into the host will be able to certify the host's key via
 128 the signature of the host admin.
 129
 130 If the server will also handle user authentication through
 131 monkeysphere-generated authorized_keys files, the server must be told
 132 which keys will act as user certifiers.  This is done with the
 133 \fBadd-certifier\fP command:
 134
 135 $ monkeysphere-server add-certifier KEYID
 136
 137 where KEYID is the key ID of the server admin, or whoever's signature
 138 will be certifying users to the system.  Certifiers can be removed
 139 with the \fBremove-certifier\fP command, and listed with the
 140 \fBlist-certifiers\fP command.
 141
 142 Remote user's will then be granted access to a local user account
 143 based on the appropriately signed and valid keys associated with user
 144 IDs listed in the authorized_user_ids file of the local user.  By
 145 default, the authorized_user_ids file for local users is found in
 146 ~/.config/monkeysphere/authorized_user_ids.  This can be changed in
 147 the monkeysphere-server.conf file.
 148
 149 The \fBupdate-users\fP command can then be used to generate
 150 authorized_keys file for local users based on the authorized user IDs
 151 listed in the various local user's authorized_user_ids file:
 152
 153 $ monkeysphere-server update-users USER
 154
 155 Not specifying a specific user will cause all users on the system to
 156 updated.  sshd can then use these monkeysphere generated
 157 authorized_keys files to grant access to user accounts for remote
 158 users.  You must also tell sshd to look at the monkeysphere-generated
 159 authorized_keys file for user authentication by setting the following
 160 in the sshd_config:
 161
 162 AuthorizedKeysFile /var/lib/monkeysphere/authorized_keys/%u
 163
 164 It is recommended to add "monkeysphere-server update-users" to a
 165 system crontab, so that user keys are kept up-to-date, and key
 166 revocations and expirations can be processed in a timely manor.
 167
 168 .SH ENVIRONMENT
 169
 170 The following environment variables will override those specified in
 171 the monkeysphere-server.conf configuration file (defaults in
 172 parentheses):
 173 .TP
 174 MONKEYSPHERE_KEYSERVER
 175 OpenPGP keyserver to use (subkeys.pgp.net).
 176 .TP
 177 MONKEYSPHERE_AUTHORIZED_USER_IDS
 178 Path to user authorized_user_ids file
 179 (%h/.config/monkeysphere/authorized_user_ids).
 180 .TP
 181 MONKEYSPHERE_RAW_AUTHORIZED_KEYS
 182 Path to user-controlled authorized_keys file.  `-' means not to add
 183 user-controlled file (%h/.ssh/authorized_keys).
 184 .TP
 185 MONKEYSPHERE_MONKEYSPHERE_USER
 186 User to control authentication keychain (monkeysphere).
 187
 188 .SH FILES
 189
 190 .TP
 191 /etc/monkeysphere/monkeysphere-server.conf
 192 System monkeysphere-server config file.
 193 .TP
 194 /etc/monkeysphere/monkeysphere.conf
 195 System-wide monkeysphere config file.
 196 .TP
 197 /var/lib/monkeysphere/authorized_keys/USER
 198 Monkeysphere-generated user authorized_keys files.
 199 .TP
 200 /var/lib/monkeysphere/ssh_host_rsa_key
 201 Copy of the host's private key in ssh format, suitable for use by
 202 sshd.
 203 .TP
 204 /var/lib/monkeysphere/gnupg-host
 205 Monkeysphere host GNUPG home directory.
 206 .TP
 207 /var/lib/monkeysphere/gnupg-authentication
 208 Monkeysphere authentication GNUPG home directory.
 209
 210 .SH AUTHOR
 211
 212 Written by Jameson Rollins <jrollins@fifthhorseman.net>, Daniel Kahn
 213 Gillmor <dkg@fifthhorseman.net>
 214
 215 .SH SEE ALSO
 216
 217 .BR monkeysphere (1),
 218 .BR monkeysphere (5),
 219 .BR gpg (1),
 220 .BR ssh (1)