summaryrefslogtreecommitdiff
path: root/man/man8/monkeysphere-server.8
blob: 79832a2fedd2094d064e2f0a2bece311077aa743 (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 ssh authentication. OpenPGP keys are tracked via GnuPG, and added
  9. to the authorized_keys and known_hosts files used by ssh 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 pair for the host. If HOSTNAME is not
  31. specified, then the system fully-qualified domain name will be user.
  32. An alternate key bit length can be specified with the `-l' or
  33. `--length' option (default 2048). An expiration length can be
  34. specified with the `-e' or `--expire' option (prompt otherwise). A
  35. key revoker fingerprint can be specified with the `-r' or `--revoker'
  36. option. `g' may be used in place of `gen-key'.
  37. .TP
  38. .B show-fingerprint
  39. Show the fingerprint for the host's OpenPGP key. `f' may be used in place of
  40. `show-fingerprint'.
  41. .TP
  42. .B publish-key
  43. Publish the host's OpenPGP key to the keyserver. `p' may be used in
  44. place of `publish-key'.
  45. .TP
  46. .B add-identity-certifier KEYID
  47. Instruct system to trust user identity certifications made by KEYID.
  48. A certifier domain can be specified with the `-n' or `--domain'
  49. option. A certifier trust level can be specified with the `-t' or
  50. `--trust' option (possible values are `1' for `marginal' and `2' for
  51. `full' (default is `2')). A certifier trust depth can be specified
  52. with the `-d' or `--depth' option (default is 1). `a' may be used in
  53. place of `add-identity-certifier'.
  54. .TP
  55. .B remove-identity-certifier KEYID
  56. Instruct system to ignore user identity certifications made by KEYID.
  57. `r' may be used in place of `remove-identity-certifier'.
  58. .TP
  59. .B list-identity-certifiers
  60. List key IDs trusted by the system to certify user identities. `l'
  61. may be used in place of `list-identity-certifiers'.
  62. .TP
  63. .B gpg-authentication-cmd
  64. Execute a gpg command on the gnupg-authentication keyring as the
  65. monkeysphere user. This takes a single command (multiple gpg
  66. arguments need to be quoted). Use this command with caution, as
  67. modifying the gnupg-authentication keyring can affect ssh user
  68. authentication.
  69. .TP
  70. .B help
  71. Output a brief usage summary. `h' or `?' may be used in place of
  72. `help'.
  73. .SH SETUP
  74. In order to start using the monkeysphere, you must first generate an
  75. OpenPGP key for the server and convert that key to an ssh key that can
  76. be used by ssh for host authentication. This can be done with the
  77. \fBgen-key\fP subcommand:
  78. $ monkeysphere-server gen-key
  79. To enable host verification via the monkeysphere, you must then
  80. publish the host's key to the Web of Trust using the \fBpublish-key\fP
  81. command to push the key to a keyserver. You must also modify the
  82. sshd_config on the server to tell sshd where the new server host key
  83. is located:
  84. HostKey /var/lib/monkeysphere/ssh_host_rsa_key
  85. In order for users logging into the system to be able to verify the
  86. host via the monkeysphere, at least one person (e.g. a server admin)
  87. will need to sign the host's key. This is done using standard key
  88. signing techniquies, usually by pulling the key from the keyserver,
  89. signing the key, and re-publishing the signature. Once that is done,
  90. users logging into the host will be able to certify the host's key via
  91. the signature of the host admin.
  92. If the server will also handle user authentication through
  93. monkeysphere-generated authorized_keys files, the server must be told
  94. which keys will act as user certifiers. This is done with the
  95. \fBadd-certifier\fP command:
  96. $ monkeysphere-server add-certifier KEYID
  97. where KEYID is the key ID of the server admin, or whoever's signature
  98. will be certifying users to the system. Certifiers can be removed
  99. with the \fBremove-certifier\fP command, and listed with the
  100. \fBlist-certifiers\fP command.
  101. Remote user's will then be granted access to a local user account
  102. based on the appropriately signed and valid keys associated with user
  103. IDs listed in the authorized_user_ids file of the local user. By
  104. default, the authorized_user_ids file for local users is found in
  105. ~/.config/monkeysphere/authorized_user_ids. This can be changed in
  106. the monkeysphere-server.conf file.
  107. The \fBupdate-users\fP command can then be used to generate
  108. authorized_keys file for local users based on the authorized user IDs
  109. listed in the various local user's authorized_user_ids file:
  110. $ monkeysphere-server update-users USER
  111. Not specifying a specific user will cause all users on the system to
  112. updated. sshd can then use these monkeysphere generated
  113. authorized_keys files to grant access to user accounts for remote
  114. users. You must also tell sshd to look at the monkeysphere-generated
  115. authorized_keys file for user authentication by setting the following
  116. in the sshd_config:
  117. AuthorizedKeysFile /var/lib/monkeysphere/authorized_keys/%u
  118. It is recommended to add "monkeysphere-server update-users" to a
  119. system crontab, so that user keys are kept up-to-date, and key
  120. revocations and expirations can be processed in a timely manor.
  121. .SH ENVIRONMENT
  122. The following environment variables will override those specified in
  123. the monkeysphere-server.conf configuration file (defaults in
  124. parentheses):
  125. .TP
  126. MONKEYSPHERE_KEYSERVER
  127. OpenPGP keyserver to use (subkeys.pgp.net).
  128. .TP
  129. MONKEYSPHERE_AUTHORIZED_USER_IDS
  130. Path to user authorized_user_ids file
  131. (%h/.config/monkeysphere/authorized_user_ids).
  132. .TP
  133. MONKEYSPHERE_RAW_AUTHORIZED_KEYS
  134. Path to user-controlled authorized_keys file. `-' means not to add
  135. user-controlled file (%h/.ssh/authorized_keys).
  136. .TP
  137. MONKEYSPHERE_MONKEYSPHERE_USER
  138. User to control authentication keychain (monkeysphere).
  139. .SH FILES
  140. .TP
  141. /etc/monkeysphere/monkeysphere-server.conf
  142. System monkeysphere-server config file.
  143. .TP
  144. /etc/monkeysphere/monkeysphere.conf
  145. System-wide monkeysphere config file.
  146. .TP
  147. /var/lib/monkeysphere/authorized_keys/USER
  148. Monkeysphere-generated user authorized_keys files.
  149. .TP
  150. /var/lib/monkeysphere/ssh_host_rsa_key
  151. Copy of the host's private key in ssh format, suitable for use by
  152. sshd.
  153. .TP
  154. /var/lib/monkeysphere/gnupg-host
  155. Monkeysphere host GNUPG home directory.
  156. .TP
  157. /var/lib/monkeysphere/gnupg-authentication
  158. Monkeysphere authentication GNUPG home directory.
  159. .SH AUTHOR
  160. Written by Jameson Rollins <jrollins@fifthhorseman.net>, Daniel Kahn
  161. Gillmor <dkg@fifthhorseman.net>
  162. .SH SEE ALSO
  163. .BR monkeysphere (1),
  164. .BR monkeysphere (5),
  165. .BR gpg (1),
  166. .BR ssh (1)