man/man8/monkeysphere-authentication.8

   1 .TH MONKEYSPHERE-SERVER "8" "March 2009" "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
  11 .SH DESCRIPTION
  12
  13 \fBMonkeysphere\fP is a framework to leverage the OpenPGP Web of Trust
  14 (WoT) for OpenSSH authentication.  OpenPGP keys are tracked via GnuPG,
  15 and added to the authorized_keys and known_hosts files used by OpenSSH
  16 for connection authentication.
  17
  18 \fBmonkeysphere\-authentication\fP is a Monkeysphere server admin
  19 utility for configuring and managing SSH user authentication through
  20 the WoT.
  21
  22 .SH SUBCOMMANDS
  23
  24 \fBmonkeysphere\-authentication\fP takes various subcommands:
  25 .TP
  26 .B update\-users [ACCOUNT]...
  27 Rebuild the monkeysphere-controlled authorized_keys files.  For each
  28 specified account, the user ID's listed in the account's
  29 authorized_user_ids file are processed.  For each user ID, gpg will be
  30 queried for keys associated with that user ID, optionally querying a
  31 keyserver.  If an acceptable key is found (see KEY ACCEPTABILITY in
  32 monkeysphere(7)), the key is added to the account's
  33 monkeysphere-controlled authorized_keys file.  If the
  34 RAW_AUTHORIZED_KEYS variable is set, then a separate authorized_keys
  35 file (usually ~USER/.ssh/authorized_keys) is appended to the
  36 monkeysphere-controlled authorized_keys file.  If no accounts are
  37 specified, then all accounts on the system are processed.  `u' may be
  38 used in place of `update\-users'.
  39 .TP
  40 .B add\-id\-certifier KEYID|FILE
  41 Instruct system to trust user identity certifications made by KEYID.
  42 The key ID will be loaded from the keyserver.  A file may be loaded
  43 instead of pulling the key from the keyserver by specifying the path
  44 to the file as the argument, or by specifying `\-' to load from stdin.
  45 Using the `\-n' or `\-\-domain' option allows you to indicate that you
  46 only trust the given KEYID to make identifications within a specific
  47 domain (e.g. "trust KEYID to certify user identities within the
  48 @example.org domain").  A certifier trust level can be specified with
  49 the `\-t' or `\-\-trust' option (possible values are `marginal' and
  50 `full' (default is `full')).  A certifier trust depth can be specified
  51 with the `\-d' or `\-\-depth' option (default is 1).  `c+' may be used in
  52 place of `add\-id\-certifier'.
  53 .TP
  54 .B remove\-id\-certifier KEYID
  55 Instruct system to ignore user identity certifications made by KEYID.
  56 `c\-' may be used in place of `remove\-id\-certifier'.
  57 .TP
  58 .B list\-id\-certifiers
  59 List key IDs trusted by the system to certify user identities.  `c'
  60 may be used in place of `list\-id\-certifiers'.
  61 .TP
  62 .B version
  63 Show the monkeysphere version number.  `v' may be used in place of
  64 `version'.
  65 .TP
  66 .B help
  67 Output a brief usage summary.  `h' or `?' may be used in place of
  68 `help'.
  69
  70
  71 Other commands:
  72 .TP
  73 .B setup
  74 Setup the server in preparation for Monkeysphere user authentication.
  75 This command is idempotent and run automatically by the other
  76 commands, and should therefore not usually need to be run manually.
  77 `s' may be used in place of `setup'.
  78 .TP
  79 .B diagnostics
  80 Review the state of the server with respect to authentication.  `d'
  81 may be used in place of `diagnostics'.
  82 .TP
  83 .B gpg\-cmd
  84 Execute a gpg command, as the monkeysphere user, on the monkeysphere
  85 authentication `sphere' keyring.  This takes a single argument
  86 (i.e. multiple gpg arguments need to be quoted all together).  Use
  87 this command with caution, as modifying the authentication sphere
  88 keyring can affect ssh user authentication.
  89
  90 .SH SETUP USER AUTHENTICATION
  91
  92 If the server will handle user authentication through
  93 monkeysphere-generated authorized_keys files, the server must be told
  94 which keys will act as identity certifiers.  This is done with the
  95 \fBadd\-id\-certifier\fP command:
  96
  97 # monkeysphere\-authentication add\-id\-certifier KEYID
  98
  99 where KEYID is the key ID of the server admin, or whoever's
 100 certifications should be acceptable to the system for the purposes of
 101 authenticating remote users.  You can run this command multiple times
 102 to indicate that multiple certifiers are trusted.  You may also
 103 specify a filename instead of a key ID, as long as the file contains a
 104 single OpenPGP public key.  Certifiers can be removed with the
 105 \fBremove\-id\-certifier\fP command, and listed with the
 106 \fBlist\-id\-certifiers\fP command.
 107
 108 A remote user will be granted access to a local account based on the
 109 appropriately-signed and valid keys associated with user IDs listed in
 110 that account's authorized_user_ids file.  By default, the
 111 authorized_user_ids file for an account is
 112 ~/.monkeysphere/authorized_user_ids.  This can be changed in the
 113 monkeysphere\-authentication.conf file.
 114
 115 The \fBupdate\-users\fP command is used to generate authorized_keys
 116 files for a local account based on the user IDs listed in the
 117 account's authorized_user_ids file:
 118
 119 # monkeysphere\-authentication update\-users USER
 120
 121 Not specifying USER will cause all accounts on the system to updated.
 122 The ssh server can use these monkeysphere-generated authorized_keys
 123 files to grant access to user accounts for remote users.  In order for
 124 sshd to look at the monkeysphere-generated authorized_keys file for
 125 user authentication, the AuthorizedKeysFile parameter must be set in
 126 the sshd_config to point to the monkeysphere\-generated
 127 authorized_keys files:
 128
 129 AuthorizedKeysFile /var/lib/monkeysphere/authentication/authorized_keys/%u
 130
 131 It is recommended to add "monkeysphere\-authentication update\-users"
 132 to a system crontab, so that user keys are kept up-to-date, and key
 133 revocations and expirations can be processed in a timely manner.
 134
 135 .SH ENVIRONMENT
 136
 137 The following environment variables will override those specified in
 138 the config file (defaults in parentheses):
 139 .TP
 140 MONKEYSPHERE_MONKEYSPHERE_USER
 141 User to control authentication keychain. (monkeysphere)
 142 .TP
 143 MONKEYSPHERE_LOG_LEVEL
 144 Set the log level.  Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, in
 145 increasing order of verbosity. (INFO)
 146 .TP
 147 MONKEYSPHERE_KEYSERVER
 148 OpenPGP keyserver to use. (pool.sks\-keyservers.net)
 149 .TP
 150 MONKEYSPHERE_AUTHORIZED_USER_IDS
 151 Path to user's authorized_user_ids file. %h gets replaced with the
 152 user's homedir, %u with the username.
 153 (%h/.monkeysphere/authorized_user_ids)
 154 .TP
 155 MONKEYSPHERE_RAW_AUTHORIZED_KEYS
 156 Path to regular ssh-style authorized_keys file to append to
 157 monkeysphere-generated authorized_keys.  `none' means not to add any
 158 raw authorized_keys file.  %h gets replaced with the user's homedir,
 159 %u with the username. (%h/.ssh/authorized_keys)
 160 .TP
 161 MONKEYSPHERE_PROMPT
 162 If set to `false', never prompt the user for confirmation. (true)
 163
 164 .SH FILES
 165
 166 .TP
 167 /etc/monkeysphere/monkeysphere\-authentication.conf
 168 System monkeysphere-authentication config file.
 169 .TP
 170 /var/lib/monkeysphere/authorized_keys/USER
 171 Monkeysphere-generated user authorized_keys files.
 172 .TP
 173 ~/.monkeysphere/authorized_user_ids
 174 A list of OpenPGP user IDs, one per line.  OpenPGP keys with an
 175 exactly-matching User ID (calculated valid by the designated identity
 176 certifiers), will have any valid authorization-capable keys or subkeys
 177 added to the given user's authorized_keys file.
 178
 179 .SH AUTHOR
 180
 181 This man page was written by:
 182 Jameson Rollins <jrollins@fifthhorseman.net>,
 183 Daniel Kahn Gillmor <dkg@fifthhorseman.net>,
 184 Matthew Goins <mjgoins@openflows.com>
 185
 186 .SH SEE ALSO
 187
 188 .BR monkeysphere (1),
 189 .BR monkeysphere\-host (8),
 190 .BR monkeysphere (7),
 191 .BR gpg (1),
 192 .BR ssh (1),
 193 .BR sshd (8),
 194 .BR sshd_config (5)