website/getting-started-admin.mdwn

   1 Monkeysphere Server Administrator README
   2 ========================================
   3
   4 As the administrator of an SSH server, you can take advantage of the
   5 Monkeysphere in two ways:
   6
   7 1. you can publish the host key of your machine to the Web of Trust
   8 (WoT) so that your users can automatically verify it, and
   9
  10 2. you can set up your machine to automatically identify connecting
  11 users by their presence in the OpenPGP Web of Trust.
  12
  13 These two pieces are independent: you can do one without the other.
  14
  15 Monkeysphere for host verification (monkeysphere-host)
  16 ======================================================
  17
  18 Server host key publication
  19 ---------------------------
  20
  21 To begin, you must first import an ssh host key.  This assumes that
  22 you have the ssh server installed, and that you have generated a host
  23 RSA key.  Once that has been done, import the key:
  24
  25         # monkeysphere-host import-key /etc/ssh/ssh_host_rsa_key server.example.net
  26
  27 This will generate an OpenPGP certificate for server.  The primary
  28 user ID for this certificate will be the ssh service URI for the host,
  29 (eg. `ssh://server.example.net`).  Remember that the name you provide
  30 here must be a fully qualified domain name for the host in order for
  31 the monkeysphere to work.
  32
  33 Now you can display information about the host key's certificate with
  34 the 'show-key' command:
  35
  36         # monkeysphere-host show-key
  37
  38 Once the host key's certificate has been generated, you'll probably
  39 want to publish it to the public keyservers which distribute the Web
  40 of Trust:
  41
  42         # monkeysphere-host publish-key
  43
  44 But anyone could publish a simple self-signed certificate to the WoT
  45 with any name attached.  Your users should be able to tell that
  46 someone they know and trust with the machine (e.g. *you*, the
  47 administrator) has verified that this particular key is indeed the
  48 correct key.  So your next step is to sign the host's key with your
  49 own OpenPGP key.
  50
  51 On your (the admin's) local machine retrieve the host key (it may take
  52 several minutes for the key to propagate across the keyserver
  53 network), and sign it:
  54
  55         $ gpg --search '=ssh://server.example.net'
  56         $ gpg --sign-key '=ssh://server.example.net'
  57
  58 Make sure you compare the fingerprint of the retrieved certificate
  59 with the output from the 'show-key' command above!
  60
  61 Finally, publish your signatures back to the keyservers, so that your
  62 users can automatically verify your machine when they connect:
  63
  64         $ gpg --send-key '=ssh://server.example.net'
  65
  66 See http://web.monkeysphere.info/signing-host-keys/ for more info
  67 signing host keys.
  68
  69 Monkeysphere for user authentication (monkeysphere-authentication)
  70 ==================================================================
  71
  72 A host can maintain ssh-style `authorized_keys` files automatically
  73 for its users with the Monkeysphere.  This frees you (the
  74 administrator) from the task of manually checking/placing SSH keys,
  75 and enables users to do relatively painless key transitions, and to
  76 quickly and universally revoke access if they find that their ssh key
  77 has become compromised.
  78
  79 You simply tell the system what *person* (identified by her OpenPGP
  80 User ID) should have access to an account, the Monkeysphere takes care
  81 of generating the proper `authorized_keys` file and keeping it
  82 up-to-date, and `sshd` reads the generated `authorized_keys` files
  83 directly.
  84
  85 Monkeysphere authorized_keys maintenance
  86 ----------------------------------------
  87
  88 For each user account on the server, the userids of people authorized
  89 to log into that account would be placed in:
  90
  91         ~/.monkeysphere/authorized_user_ids
  92
  93 The server will use the Monkeysphere to look up matching OpenPGP
  94 certificates, validate them, and generate an `authorized_keys` file.
  95
  96 To validate the OpenPGP certificates, the server needs to know who it
  97 can trust to correctly identify users.  The individuals trusted to
  98 identify users like this are known in the Monkeysphere as "Identity
  99 Certifiers".  One obvious choice is to trust *you*, the administrator,
 100 to be an Identity Certifier.  If your OpenPGP keyid is `$GPGID`, then
 101 run the following command on the server:
 102
 103         # monkeysphere-authentication add-identity-certifier $GPGID
 104
 105 You'll probably only set up Identity Certifiers when you set up the
 106 machine.  After that, you'll only need to add or remove Identity
 107 Certifiers when the roster of admins on the machine changes, or when
 108 one of the admins switches OpenPGP keys.
 109
 110 Now that the server knows who to trust to identify users, the
 111 Monkeysphere can generate ssh-style `authorized_keys` quickly and
 112 easily:
 113
 114 To update the Monkeysphere-generated `authorized_keys` file for user
 115 "bob", run:
 116
 117         # monkeysphere-authentication update-users bob
 118
 119 To update the monkeysphere `authorized_keys` file for all users on the
 120 the system, run the same command with no arguments:
 121
 122         # monkeysphere-authentication update-users
 123
 124 You probably want to set up a regularly scheduled job (e.g. with cron)
 125 to do this automatically.
 126
 127 Update OpenSSH server AuthorizedKeysFile configuration
 128 ------------------------------------------------------
 129
 130 Generating the `authorized_keys` files is not quite enough, because
 131 `sshd` needs to know where to find the generated keys.
 132
 133 You can do this by adding the following line to
 134 `/etc/ssh/sshd_config`, commenting out any other `AuthorizedKeysFile`
 135 directives:
 136
 137         AuthorizedKeysFile /var/lib/monkeysphere/authorized_keys/%u
 138
 139 You'll need to restart `sshd` to have your changes take effect.  As
 140 with any change to `sshd_config`, if you're doing this remotely, be
 141 sure to retain an existing session to the machine while you test your
 142 changes so you don't get locked out if something went wrong.