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