man/man8/monkeysphere-authentication.8

   1 .TH MONKEYSPHERE-SERVER "8" "June 2008" "monkeysphere" "User Commands"
   2
   3 .SH NAME
   4
   5 monkeysphere-authentication \- Monkeysphere authentication admin tool.
   6
   7 .SH SYNOPSIS
   8
   9 .B monkeysphere-authentication \fIsubcommand\fP [\fIargs\fP]
  10 .br
  11 .B monkeysphere-authentication expert \fIexpert-subcommand\fP [\fIargs\fP]
  12
  13 .SH DESCRIPTION
  14
  15 \fBMonkeysphere\fP is a framework to leverage the OpenPGP web of trust for
  16 OpenSSH authentication.  OpenPGP keys are tracked via GnuPG, and added to the
  17 authorized_keys and known_hosts files used by OpenSSH for connection
  18 authentication.
  19
  20 \fBmonkeysphere-authentication\fP is a Monkeysphere server admin utility.
  21
  22 .SH SUBCOMMANDS
  23
  24 \fBmonkeysphere-authentication\fP takes various subcommands.
  25 .TP
  26 .B setup
  27 Setup the server for Monkeysphere user authentication.  `s' may be
  28 used in place of `setup'.
  29 .TP
  30 .B update-users [ACCOUNT]...
  31 Rebuild the monkeysphere-controlled authorized_keys files.  For each
  32 specified account, the user ID's listed in the account's
  33 authorized_user_ids file are processed.  For each user ID, gpg will be
  34 queried for keys associated with that user ID, optionally querying a
  35 keyserver.  If an acceptable key is found (see KEY ACCEPTABILITY in
  36 monkeysphere(7)), the key is added to the account's
  37 monkeysphere-controlled authorized_keys file.  If the
  38 RAW_AUTHORIZED_KEYS variable is set, then a separate authorized_keys
  39 file (usually ~USER/.ssh/authorized_keys) is appended to the
  40 monkeysphere-controlled authorized_keys file.  If no accounts are
  41 specified, then all accounts on the system are processed.  `u' may be
  42 used in place of `update-users'.
  43 .TP
  44 .B add-id-certifier KEYID
  45 Instruct system to trust user identity certifications made by KEYID.
  46 Using the `-n' or `--domain' option allows you to indicate that you
  47 only trust the given KEYID to make identifications within a specific
  48 domain (e.g. "trust KEYID to certify user identities within the
  49 @example.org domain").  A certifier trust level can be specified with
  50 the `-t' or `--trust' option (possible values are `marginal' and
  51 `full' (default is `full')).  A certifier trust depth can be specified
  52 with the `-d' or `--depth' option (default is 1).  `c+' may be used in
  53 place of `add-id-certifier'.
  54 .TP
  55 .B remove-id-certifier KEYID
  56 Instruct system to ignore user identity certifications made by KEYID.
  57 `c-' may be used in place of `remove-id-certifier'.
  58 .TP
  59 .B list-id-certifiers
  60 List key IDs trusted by the system to certify user identities.  `c'
  61 may be used in place of `list-id-certifiers'.
  62 .TP
  63 .B help
  64 Output a brief usage summary.  `h' or `?' may be used in place of
  65 `help'.
  66 .TP
  67 .B version
  68 show version number
  69
  70 .SH "EXPERT" SUBCOMMANDS
  71
  72 Some commands are very unlikely to be needed by most administrators.
  73 These commands must prefaced by the word `expert'.
  74 .TP
  75 .B diagnostics
  76 Review the state of the server with respect to authentication.  `d'
  77 may be used in place of `diagnostics'.
  78 .TP
  79 .B gpg-cmd
  80 Execute a gpg command on the gnupg-authentication keyring as the
  81 monkeysphere user.  This takes a single command (multiple gpg
  82 arguments need to be quoted).  Use this command with caution, as
  83 modifying the gnupg-authentication keyring can affect ssh user
  84 authentication.
  85
  86 .SH SETUP USER AUTHENTICATION
  87
  88 If the server will handle user authentication through
  89 monkeysphere-generated authorized_keys files, the server must be told
  90 which keys will act as identity certifiers.  This is done with the
  91 \fBadd-id-certifier\fP command:
  92
  93 $ monkeysphere-authentication add-id-certifier KEYID
  94
  95 where KEYID is the key ID of the server admin, or whoever's
  96 certifications should be acceptable to the system for the purposes of
  97 authenticating remote users.  You can run this command multiple times
  98 to indicate that multiple certifiers are trusted.  You may also
  99 specify a filename instead of a key ID, as long as the file contains a
 100 single OpenPGP public key.  Certifiers can be removed with the
 101 \fBremove-id-certifier\fP command, and listed with the
 102 \fBlist-id-certifiers\fP command.
 103
 104 Remote users will then be granted access to a local account based on
 105 the appropriately-signed and valid keys associated with user IDs
 106 listed in that account's authorized_user_ids file.  By default, the
 107 authorized_user_ids file for an account is
 108 ~/.monkeysphere/authorized_user_ids.  This can be changed in the
 109 monkeysphere-authentication.conf file.
 110
 111 The \fBupdate-users\fP command can then be used to generate
 112 authorized_keys file for local accounts based on the authorized user
 113 IDs listed in the account's authorized_user_ids file:
 114
 115 $ monkeysphere-authentication update-users USER
 116
 117 Not specifying USER will cause all accounts on the system to updated.
 118 sshd can then use these monkeysphere generated authorized_keys files
 119 to grant access to user accounts for remote users.  You must also tell
 120 sshd to look at the monkeysphere-generated authorized_keys file for
 121 user authentication by setting the following in the sshd_config:
 122
 123 AuthorizedKeysFile /var/lib/monkeysphere/authentication/authorized_keys/%u
 124
 125 It is recommended to add "monkeysphere-authentication update-users" to a
 126 system crontab, so that user keys are kept up-to-date, and key
 127 revocations and expirations can be processed in a timely manner.
 128
 129 .SH ENVIRONMENT
 130
 131 The following environment variables will override those specified in
 132 the config file (defaults in parentheses):
 133 .TP
 134 MONKEYSPHERE_MONKEYSPHERE_USER
 135 User to control authentication keychain (monkeysphere).
 136 .TP
 137 MONKEYSPHERE_LOG_LEVEL
 138 Set the log level (INFO).  Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, in
 139 increasing order of verbosity.
 140 .TP
 141 MONKEYSPHERE_KEYSERVER
 142 OpenPGP keyserver to use (pool.sks-keyservers.net).
 143 .TP
 144 MONKEYSPHERE_AUTHORIZED_USER_IDS
 145 Path to user authorized_user_ids file
 146 (%h/.monkeysphere/authorized_user_ids).
 147 .TP
 148 MONKEYSPHERE_RAW_AUTHORIZED_KEYS
 149 Path to user-controlled authorized_keys file.  `-' means not to add
 150 user-controlled file (%h/.ssh/authorized_keys).
 151
 152 .SH FILES
 153
 154 .TP
 155 /etc/monkeysphere/monkeysphere-authentication.conf
 156 System monkeysphere-authentication config file.
 157 .TP
 158 /var/lib/monkeysphere/authentication/authorized_keys/USER
 159 Monkeysphere-generated user authorized_keys files.
 160
 161 .SH AUTHOR
 162
 163 Written by:
 164 Jameson Rollins <jrollins@fifthhorseman.net>,
 165 Daniel Kahn Gillmor <dkg@fifthhorseman.net>,
 166 Matthew Goins <mjgoins@openflows.com>
 167
 168 .SH SEE ALSO
 169
 170 .BR monkeysphere (1),
 171 .BR monkeysphere-host (8),
 172 .BR monkeysphere (7),
 173 .BR gpg (1),
 174 .BR ssh (1)