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