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.  Then modify the sshd_config
  95 to tell sshd where the new server host key is located:
  96
  97 HostKey /var/lib/monkeysphere/ssh_host_rsa_key
  98
  99 In order for users logging into the system to be able to verify the
 100 host via the monkeysphere, at least one person (i.e. a server admin)
 101 will need to sign the host's key.  This is done in the same way that
 102 key signing is usually done, by pulling the host's key from the
 103 keyserver, signing the key, and re-publishing the signature.  Once
 104 that is done, users logging into the host will be able to certify the
 105 host's key via the signature of the host admin.
 106
 107 If the server will also handle user authentication through
 108 monkeysphere-generated authorized_keys files, the server must be told
 109 which keys will act as user certifiers.  This is done with the
 110 \fBadd-certifier\fP command:
 111
 112 $ monkeysphere-server add-certifier KEYID
 113
 114 where KEYID is the key ID of the server admin, or whoever's signature
 115 will be certifying users to the system.  Certifiers can be later
 116 remove with the \fBremove-certifier\fP command, and listed with the
 117 \fBlist-certifiers\fP command.
 118
 119 Remote user's will then be granted access to a local user account
 120 based on the appropriately signed and valid keys associated with user
 121 IDs listed in the authorized_user_ids file of the local user.  By
 122 default, the authorized_user_ids file for local users is found in
 123 ~/.config/monkeysphere/authorized_user_ids.  This can be changed in
 124 the monkeysphere-server.conf file.
 125
 126 The \fBupdate-users\fP command can then be used to generate
 127 authorized_keys file for local users based on the authorized user IDs
 128 listed in the user's authorized_user_ids file:
 129
 130 $ monkeysphere-server update-users USER
 131
 132 sshd can then use these files to grant access to user accounts for
 133 remote users.  If no user is specified, authorized_keys files will be
 134 generated for all users on the system.  You must also tell sshd to
 135 look at the monkeysphere-generated authorized_keys file for user
 136 authentication by setting the following in the sshd_config:
 137
 138 AuthorizedKeysFile /var/lib/monkeysphere/authorized_keys/%u
 139
 140 It is recommended to add "monkeysphere-server update-users" to a
 141 system crontab, so that user keys are kept up-to-date, and key
 142 revocations and expirations can be processed in a timely manor.
 143
 144 .SH ENVIRONMENT
 145
 146 The following environment variables will override those specified in
 147 the monkeysphere-server.conf configuration file (defaults in
 148 parentheses):
 149 .TP
 150 MONKEYSPHERE_KEYSERVER
 151 OpenPGP keyserver to use (subkeys.pgp.net).
 152 .TP
 153 MONKEYSPHERE_AUTHORIZED_USER_IDS
 154 Path to user authorized_user_ids file
 155 (%h/.config/monkeysphere/authorized_user_ids).
 156 .TP
 157 MONKEYSPHERE_RAW_AUTHORIZED_KEYS
 158 Path to user-controlled authorized_keys file.  `-' means not to add
 159 user-controlled file (%h/.ssh/authorized_keys).
 160 .TP
 161 MONKEYSPHERE_MONKEYSPHERE_USER
 162 User to control authentication keychain (monkeysphere).
 163
 164 .SH FILES
 165
 166 .TP
 167 /etc/monkeysphere/monkeysphere-server.conf
 168 System monkeysphere-server config file.
 169 .TP
 170 /etc/monkeysphere/monkeysphere.conf
 171 System-wide monkeysphere config file.
 172 .TP
 173 /var/lib/monkeysphere/authorized_keys/USER
 174 Monkeysphere-generated user authorized_keys files.
 175 .TP
 176 /var/lib/monkeysphere/ssh_host_rsa_key
 177 Copy of the host's private key in ssh format, suitable for use by
 178 sshd.
 179 .TP
 180 /var/lib/monkeysphere/gnupg-host
 181 Monkeysphere host GNUPG home directory.
 182 .TP
 183 /var/lib/monkeysphere/gnupg-authentication
 184 Monkeysphere authentication GNUPG home directory.
 185
 186 .SH AUTHOR
 187
 188 Written by Jameson Rollins <jrollins@fifthhorseman.net>, Daniel Kahn
 189 Gillmor <dkg@fifthhorseman.net>
 190
 191 .SH SEE ALSO
 192
 193 .BR monkeysphere (1),
 194 .BR monkeysphere (5),
 195 .BR gpg (1),
 196 .BR ssh (1)