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