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