summaryrefslogtreecommitdiff
path: root/man/man8/monkeysphere-server.8
blob: 484862500f3cf341bc7f1a77c117375227496f97 (plain)
  1. .TH MONKEYSPHERE-SERVER "8" "June 2008" "monkeysphere" "User Commands"
  2. .SH NAME
  3. monkeysphere-server \- Monkeysphere server admin user interface
  4. .SH SYNOPSIS
  5. .B monkeysphere-server \fIsubcommand\fP [\fIargs\fP]
  6. .SH DESCRIPTION
  7. \fBMonkeysphere\fP is a framework to leverage the OpenPGP web of trust
  8. for OpenSSH authentication. OpenPGP keys are tracked via GnuPG, and
  9. added to the authorized_keys and known_hosts files used by OpenSSH for
  10. connection authentication.
  11. \fBmonkeysphere-server\fP is the Monkeysphere server admin utility.
  12. .SH SUBCOMMANDS
  13. \fBmonkeysphere-server\fP takes various subcommands:
  14. .TP
  15. .B update-users [ACCOUNT]...
  16. Rebuild the monkeysphere-controlled authorized_keys files. For each
  17. specified account, the user ID's listed in the account's
  18. authorized_user_ids file are processed. For each user ID, gpg will be
  19. queried for keys associated with that user ID, optionally querying a
  20. keyserver. If an acceptable key is found (see KEY ACCEPTABILITY in
  21. monkeysphere(5)), the key is added to the account's
  22. monkeysphere-controlled authorized_keys file. If the
  23. RAW_AUTHORIZED_KEYS variable is set, then a separate authorized_keys
  24. file (usually ~USER/.ssh/authorized_keys) is appended to the
  25. monkeysphere-controlled authorized_keys file. If no accounts are
  26. specified, then all accounts on the system are processed. `u' may be
  27. used in place of `update-users'.
  28. .TP
  29. .B gen-key [HOSTNAME]
  30. Generate a OpenPGP key for the host. If HOSTNAME is not specified,
  31. then the system fully-qualified domain name will be user. An
  32. alternate key bit length can be specified with the `-l' or `--length'
  33. option (default 2048). An expiration length can be specified with the
  34. `-e' or `--expire' option (prompt otherwise). The expiration format
  35. is the same as that of \fBextend-key\fP, below. A key revoker
  36. fingerprint can be specified with the `-r' or `--revoker' option. `g'
  37. may be used in place of `gen-key'.
  38. .TP
  39. .B extend-key EXPIRE
  40. Extend the validity of the OpenPGP key for the host until EXPIRE from
  41. the present. If EXPIRE is not specified, then the user will be
  42. prompted for the extension term. Expiration is specified like GnuPG
  43. does:
  44. .nf
  45. 0 = key does not expire
  46. <n> = key expires in n days
  47. <n>w = key expires in n weeks
  48. <n>m = key expires in n months
  49. <n>y = key expires in n years
  50. .fi
  51. `e' may be used in place of `extend-key'.
  52. .TP
  53. .B add-hostname HOSTNAME
  54. Add a hostname user ID to the server host key. `n+' may be used in
  55. place of `add-hostname'.
  56. .TP
  57. .B revoke-hostname HOSTNAME
  58. Revoke a hostname user ID from the server host key. `n-' may be used
  59. in place of `revoke-hostname'.
  60. .TP
  61. .B show-key
  62. Output gpg information about host's OpenPGP key. `s' may be used in
  63. place of `show-key'.
  64. .TP
  65. .B publish-key
  66. Publish the host's OpenPGP key to the keyserver. `p' may be used in
  67. place of `publish-key'.
  68. .TP
  69. .B diagnostics
  70. Review the state of the server with respect to the MonkeySphere in
  71. general and report on suggested changes. Among other checks, this
  72. includes making sure there is a valid host key, that the key is
  73. published, that the sshd configuration points to the right place, and
  74. that there are at least some valid identity certifiers. `d' may be
  75. used in place of `diagnostics'.
  76. .TP
  77. .B add-identity-certifier KEYID
  78. Instruct system to trust user identity certifications made by KEYID.
  79. Using the `-n' or `--domain' option allows you to indicate that you
  80. only trust the given KEYID to make identifications within a specific
  81. domain (e.g. "trust KEYID to certify user identities within the
  82. @example.org domain"). A certifier trust level can be specified with
  83. the `-t' or `--trust' option (possible values are `marginal' and
  84. `full' (default is `full')). A certifier trust depth can be specified
  85. with the `-d' or `--depth' option (default is 1). `c+' may be used in
  86. place of `add-identity-certifier'.
  87. .TP
  88. .B remove-identity-certifier KEYID
  89. Instruct system to ignore user identity certifications made by KEYID.
  90. `c-' may be used in place of `remove-identity-certifier'.
  91. .TP
  92. .B list-identity-certifiers
  93. List key IDs trusted by the system to certify user identities. `c'
  94. may be used in place of `list-identity-certifiers'.
  95. .TP
  96. .B gpg-authentication-cmd
  97. Execute a gpg command on the gnupg-authentication keyring as the
  98. monkeysphere user. This takes a single command (multiple gpg
  99. arguments need to be quoted). Use this command with caution, as
  100. modifying the gnupg-authentication keyring can affect ssh user
  101. authentication.
  102. .TP
  103. .B help
  104. Output a brief usage summary. `h' or `?' may be used in place of
  105. `help'.
  106. .SH SETUP
  107. In order to start using the monkeysphere, you must first generate an
  108. OpenPGP key for the server and convert that key to an ssh key that can
  109. be used by ssh for host authentication. This can be done with the
  110. \fBgen-key\fP subcommand:
  111. $ monkeysphere-server gen-key
  112. To enable host verification via the monkeysphere, you must then
  113. publish the host's key to the Web of Trust using the \fBpublish-key\fP
  114. command to push the key to a keyserver. You must also modify the
  115. sshd_config on the server to tell sshd where the new server host key
  116. is located:
  117. HostKey /var/lib/monkeysphere/ssh_host_rsa_key
  118. In order for users logging into the system to be able to verify the
  119. host via the monkeysphere, at least one person (e.g. a server admin)
  120. will need to sign the host's key. This is done using standard key
  121. signing techniquies, usually by pulling the key from the keyserver,
  122. signing the key, and re-publishing the signature. Once that is done,
  123. users logging into the host will be able to certify the host's key via
  124. the signature of the host admin.
  125. If the server will also handle user authentication through
  126. monkeysphere-generated authorized_keys files, the server must be told
  127. which keys will act as user certifiers. This is done with the
  128. \fBadd-certifier\fP command:
  129. $ monkeysphere-server add-certifier KEYID
  130. where KEYID is the key ID of the server admin, or whoever's signature
  131. will be certifying users to the system. Certifiers can be removed
  132. with the \fBremove-certifier\fP command, and listed with the
  133. \fBlist-certifiers\fP command.
  134. Remote user's will then be granted access to a local user account
  135. based on the appropriately signed and valid keys associated with user
  136. IDs listed in the authorized_user_ids file of the local user. By
  137. default, the authorized_user_ids file for local users is found in
  138. ~/.config/monkeysphere/authorized_user_ids. This can be changed in
  139. the monkeysphere-server.conf file.
  140. The \fBupdate-users\fP command can then be used to generate
  141. authorized_keys file for local users based on the authorized user IDs
  142. listed in the various local user's authorized_user_ids file:
  143. $ monkeysphere-server update-users USER
  144. Not specifying a specific user will cause all users on the system to
  145. updated. sshd can then use these monkeysphere generated
  146. authorized_keys files to grant access to user accounts for remote
  147. users. You must also tell sshd to look at the monkeysphere-generated
  148. authorized_keys file for user authentication by setting the following
  149. in the sshd_config:
  150. AuthorizedKeysFile /var/lib/monkeysphere/authorized_keys/%u
  151. It is recommended to add "monkeysphere-server update-users" to a
  152. system crontab, so that user keys are kept up-to-date, and key
  153. revocations and expirations can be processed in a timely manor.
  154. .SH ENVIRONMENT
  155. The following environment variables will override those specified in
  156. the monkeysphere-server.conf configuration file (defaults in
  157. parentheses):
  158. .TP
  159. MONKEYSPHERE_LOG_LEVEL
  160. Set the log level. Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, in
  161. increasing order of verbosity.
  162. .TP
  163. MONKEYSPHERE_KEYSERVER
  164. OpenPGP keyserver to use (subkeys.pgp.net).
  165. .TP
  166. MONKEYSPHERE_AUTHORIZED_USER_IDS
  167. Path to user authorized_user_ids file
  168. (%h/.config/monkeysphere/authorized_user_ids).
  169. .TP
  170. MONKEYSPHERE_RAW_AUTHORIZED_KEYS
  171. Path to user-controlled authorized_keys file. `-' means not to add
  172. user-controlled file (%h/.ssh/authorized_keys).
  173. .TP
  174. MONKEYSPHERE_MONKEYSPHERE_USER
  175. User to control authentication keychain (monkeysphere).
  176. .SH FILES
  177. .TP
  178. /etc/monkeysphere/monkeysphere-server.conf
  179. System monkeysphere-server config file.
  180. .TP
  181. /etc/monkeysphere/monkeysphere.conf
  182. System-wide monkeysphere config file.
  183. .TP
  184. /var/lib/monkeysphere/authorized_keys/USER
  185. Monkeysphere-generated user authorized_keys files.
  186. .TP
  187. /var/lib/monkeysphere/ssh_host_rsa_key
  188. Copy of the host's private key in ssh format, suitable for use by
  189. sshd.
  190. .TP
  191. /var/lib/monkeysphere/gnupg-host
  192. Monkeysphere host GNUPG home directory.
  193. .TP
  194. /var/lib/monkeysphere/gnupg-authentication
  195. Monkeysphere authentication GNUPG home directory.
  196. .SH AUTHOR
  197. Written by Jameson Rollins <jrollins@fifthhorseman.net>, Daniel Kahn
  198. Gillmor <dkg@fifthhorseman.net>
  199. .SH SEE ALSO
  200. .BR monkeysphere (1),
  201. .BR monkeysphere (5),
  202. .BR gpg (1),
  203. .BR ssh (1)