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