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