man/man8/monkeysphere-server.8

   1 .TH MONKEYSPHERE-SERVER "1" "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
  39 Generate a OpenPGP key pair for the host.  `g' may be used in place of
  40 `gen-key'.
  41 .TP
  42 .B show-fingerprint
  43 Show the fingerprint for the host's OpenPGP key.  `f' may be used in place of
  44 `show-fingerprint'.
  45 .TP
  46 .B publish-key
  47 Publish the host's OpenPGP key to the keyserver.  `p' may be used in
  48 place of `publish-key'.
  49 .TP
  50 .B add-identity-certifier KEYID
  51 Instruct system to trust user identity certifications made by KEYID.
  52 `a' may be used in place of `add-identity-certifier'.
  53 .TP
  54 .B remove-identity-certifier KEYID
  55 Instruct system to ignore user identity certifications made by KEYID.
  56 `r' may be used in place of `remove-identity-certifier'.
  57 .TP
  58 .B list-identity-certifiers
  59 List key IDs trusted by the system to certify user identities.  `l'
  60 may be used in place of `list-identity-certifiers'.
  61 .TP
  62 .B help
  63 Output a brief usage summary.  `h' or `?' may be used in place of
  64 `help'.
  65
  66 .SH SETUP
  67
  68 In order to start using the monkeysphere, you must first generate an
  69 OpenPGP key for the server and convert that key to an ssh key that can
  70 be used by ssh for host authentication.  This can be done with the
  71 \fBgen-key\fP subcommand:
  72
  73 $ monkeysphere-server gen-key
  74
  75 To enable host verification via the monkeysphere, you must then
  76 publish the host's key to the Web of Trust using the \fBpublish-key\fP
  77 command to push the key to a keyserver.  Then modify the sshd_config
  78 to tell sshd where the new server host key is located:
  79
  80 HostKey /var/lib/monkeysphere/ssh_host_rsa_key
  81
  82 In order for users logging into the system to be able to verify the
  83 host via the monkeysphere, at least one person (ie. a server admin)
  84 will need to sign the host's key.  This is done in the same way that
  85 key signing is usually done, by pulling the host's key from the
  86 keyserver, signing the key, and re-publishing the signature.  Once
  87 that is done, users logging into the host will be able to certify the
  88 host's key via the signature of the host admin.
  89
  90 If the server will also handle user authentication through
  91 monkeysphere-generated authorized_keys files, the server must be told
  92 which keys will act as user certifiers.  This is done with the
  93 \fBadd-certifier\fP command:
  94
  95 $ monkeysphere-server add-certifier KEYID
  96
  97 where KEYID is the key ID of the server admin, or whoever's signature
  98 will be certifying users to the system.  Certifiers can be later
  99 remove with the \fBremove-certifier\fP command, and listed with the
 100 \fBlist-certifiers\fP command.
 101
 102 Remote user's will then be granted access to a local user account
 103 based on the appropriately signed and valid keys associated with user
 104 IDs listed in the authorized_user_ids file of the local user.  By
 105 default, the authorized_user_ids file for local users is found in
 106 ~/.config/monkeysphere/authorized_user_ids.  This can be changed in
 107 the monkeysphere-server.conf file.
 108
 109 The \fBupdate-users\fP command can then be used to generate
 110 authorized_keys file for local users based on the authorized user IDs
 111 listed in the user's authorized_user_ids file:
 112
 113 $ monkeysphere-server update-users USER
 114
 115 sshd can then use these files to grant access to user accounts for
 116 remote users.  If no user is specified, authorized_keys files will be
 117 generated for all users on the system.  You must also tell sshd to
 118 look at the monkeysphere-generated authorized_keys file for user
 119 authentication by setting the following in the sshd_config:
 120
 121 AuthorizedKeysFile /var/lib/monkeysphere/authorized_keys/%u
 122
 123 It is recommended to add "monkeysphere-server update-users" to a
 124 system crontab, so that user keys are kept up-to-date, and key
 125 revokations and expirations can be processed in a timely manor.
 126
 127 .SH FILES
 128
 129 .TP
 130 /etc/monkeysphere/monkeysphere-server.conf
 131 System monkeysphere-server config file.
 132 .TP
 133 /etc/monkeysphere/monkeysphere.conf
 134 System-wide monkeysphere config file.
 135 .TP
 136 /var/lib/monkeysphere/authorized_keys/USER
 137 Monkeysphere-generated user authorized_keys files.
 138 .TP
 139 /var/lib/monkeysphere/ssh_host_rsa_key
 140 Copy of the host's private key in ssh format, suitable for use by
 141 sshd.
 142 .TP
 143 /var/lib/monkeysphere/gnupg-host
 144 Monkeysphere host GNUPG home directory.
 145 .TP
 146 /var/lib/monkeysphere/gnupg-authentication
 147 Monkeysphere authentication GNUPG home directory.
 148
 149 .SH AUTHOR
 150
 151 Written by Jameson Rollins <jrollins@fifthhorseman.net>, Daniel Kahn
 152 Gillmor <dkg@fifthhorseman.net>
 153
 154 .SH SEE ALSO
 155
 156 .BR monkeysphere (1),
 157 .BR monkeysphere (5),
 158 .BR gpg (1),
 159 .BR ssh (1)