summaryrefslogtreecommitdiff
path: root/man/man8/monkeysphere-server.8
blob: e9784b6dd35ee6616a52596e50b3bb332be9225c (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. Then modify the sshd_config
  82. to tell sshd where the new server host key is located:
  83. HostKey /var/lib/monkeysphere/ssh_host_rsa_key
  84. In order for users logging into the system to be able to verify the
  85. host via the monkeysphere, at least one person (i.e. a server admin)
  86. will need to sign the host's key. This is done in the same way that
  87. key signing is usually done, by pulling the host's key from the
  88. keyserver, signing the key, and re-publishing the signature. Once
  89. that is done, users logging into the host will be able to certify the
  90. host's key via the signature of the host admin.
  91. If the server will also handle user authentication through
  92. monkeysphere-generated authorized_keys files, the server must be told
  93. which keys will act as user certifiers. This is done with the
  94. \fBadd-certifier\fP command:
  95. $ monkeysphere-server add-certifier KEYID
  96. where KEYID is the key ID of the server admin, or whoever's signature
  97. will be certifying users to the system. Certifiers can be later
  98. remove with the \fBremove-certifier\fP command, and listed with the
  99. \fBlist-certifiers\fP command.
  100. Remote user's will then be granted access to a local user account
  101. based on the appropriately signed and valid keys associated with user
  102. IDs listed in the authorized_user_ids file of the local user. By
  103. default, the authorized_user_ids file for local users is found in
  104. ~/.config/monkeysphere/authorized_user_ids. This can be changed in
  105. the monkeysphere-server.conf file.
  106. The \fBupdate-users\fP command can then be used to generate
  107. authorized_keys file for local users based on the authorized user IDs
  108. listed in the user's authorized_user_ids file:
  109. $ monkeysphere-server update-users USER
  110. sshd can then use these files to grant access to user accounts for
  111. remote users. If no user is specified, authorized_keys files will be
  112. generated for all users on the system. You must also tell sshd to
  113. look at the monkeysphere-generated authorized_keys file for user
  114. authentication by setting the following in the sshd_config:
  115. AuthorizedKeysFile /var/lib/monkeysphere/authorized_keys/%u
  116. It is recommended to add "monkeysphere-server update-users" to a
  117. system crontab, so that user keys are kept up-to-date, and key
  118. revocations and expirations can be processed in a timely manor.
  119. .SH ENVIRONMENT
  120. The following environment variables will override those specified in
  121. the monkeysphere-server.conf configuration file (defaults in
  122. parentheses):
  123. .TP
  124. MONKEYSPHERE_KEYSERVER
  125. OpenPGP keyserver to use (subkeys.pgp.net).
  126. .TP
  127. MONKEYSPHERE_AUTHORIZED_USER_IDS
  128. Path to user authorized_user_ids file
  129. (%h/.config/monkeysphere/authorized_user_ids).
  130. .TP
  131. MONKEYSPHERE_RAW_AUTHORIZED_KEYS
  132. Path to user-controlled authorized_keys file. `-' means not to add
  133. user-controlled file (%h/.ssh/authorized_keys).
  134. .TP
  135. MONKEYSPHERE_MONKEYSPHERE_USER
  136. User to control authentication keychain (monkeysphere).
  137. .SH FILES
  138. .TP
  139. /etc/monkeysphere/monkeysphere-server.conf
  140. System monkeysphere-server config file.
  141. .TP
  142. /etc/monkeysphere/monkeysphere.conf
  143. System-wide monkeysphere config file.
  144. .TP
  145. /var/lib/monkeysphere/authorized_keys/USER
  146. Monkeysphere-generated user authorized_keys files.
  147. .TP
  148. /var/lib/monkeysphere/ssh_host_rsa_key
  149. Copy of the host's private key in ssh format, suitable for use by
  150. sshd.
  151. .TP
  152. /var/lib/monkeysphere/gnupg-host
  153. Monkeysphere host GNUPG home directory.
  154. .TP
  155. /var/lib/monkeysphere/gnupg-authentication
  156. Monkeysphere authentication GNUPG home directory.
  157. .SH AUTHOR
  158. Written by Jameson Rollins <jrollins@fifthhorseman.net>, Daniel Kahn
  159. Gillmor <dkg@fifthhorseman.net>
  160. .SH SEE ALSO
  161. .BR monkeysphere (1),
  162. .BR monkeysphere (5),
  163. .BR gpg (1),
  164. .BR ssh (1)