summaryrefslogtreecommitdiff
path: root/man/man8/monkeysphere-host.8
blob: f33aea635dcfa8535ecd88425c2b5c75d7c3fdb3 (plain)
  1. .TH MONKEYSPHERE-SERVER "8" "June 2008" "monkeysphere" "User Commands"
  2. .SH NAME
  3. monkeysphere-host \- Monkeysphere host admin tool.
  4. .SH SYNOPSIS
  5. .B monkeysphere-host \fIsubcommand\fP [\fIargs\fP]
  6. .br
  7. .B monkeysphere-host expert \fIexpert-subcommand\fP [\fIargs\fP]
  8. .SH DESCRIPTION
  9. \fBMonkeysphere\fP is a framework to leverage the OpenPGP web of trust
  10. for OpenSSH authentication. OpenPGP keys are tracked via GnuPG, and
  11. added to the authorized_keys and known_hosts files used by OpenSSH for
  12. connection authentication.
  13. \fBmonkeysphere-host\fP is a Monkeysphere server admin utility.
  14. .SH SUBCOMMANDS
  15. \fBmonkeysphere-host\fP takes various subcommands:
  16. .TP
  17. .B import-key FILE [NAME[:PORT]]
  18. Import a pem-encoded ssh secret host key from file FILE. If FILE
  19. is '-', then the key will be imported from stdin. NAME[:PORT] is used
  20. to specify the hostname (and port) used in the user ID of the new
  21. OpenPGP key. If NAME is not specified, then the system
  22. fully-qualified domain name will be used (ie. `hostname -f'). If PORT
  23. is not specified, the no port is added to the user ID, which means
  24. port 22 is assumed. `i' may be used in place of `import-key'.
  25. .TP
  26. .B show-key
  27. Output information about host's OpenPGP and SSH keys. `s' may be used
  28. in place of `show-key'.
  29. .TP
  30. .B extend-key [EXPIRE]
  31. Extend the validity of the OpenPGP key for the host until EXPIRE from
  32. the present. If EXPIRE is not specified, then the user will be
  33. prompted for the extension term. Expiration is specified as with
  34. GnuPG:
  35. .nf
  36. 0 = key does not expire
  37. <n> = key expires in n days
  38. <n>w = key expires in n weeks
  39. <n>m = key expires in n months
  40. <n>y = key expires in n years
  41. .fi
  42. `e' may be used in place of `extend-key'.
  43. .TP
  44. .B add-hostname HOSTNAME
  45. Add a hostname user ID to the server host key. `n+' may be used in
  46. place of `add-hostname'.
  47. .TP
  48. .B revoke-hostname HOSTNAME
  49. Revoke a hostname user ID from the server host key. `n-' may be used
  50. in place of `revoke-hostname'.
  51. .TP
  52. .B add-revoker FINGERPRINT
  53. Add a revoker to the host's OpenPGP key. `o' may be be used in place
  54. of `add-revoker'.
  55. .TP
  56. .B revoke-key
  57. Revoke the host's OpenPGP key. `r' may be used in place of
  58. `revoke-key'.
  59. .TP
  60. .B publish-key
  61. Publish the host's OpenPGP key to the keyserver. `p' may be used in
  62. place of `publish-key'.
  63. .TP
  64. .B help
  65. Output a brief usage summary. `h' or `?' may be used in place of
  66. `help'.
  67. .TP
  68. .B version
  69. show version number
  70. Other commands:
  71. .TP
  72. .B diagnostics
  73. Review the state of the monkeysphere server host key and report on
  74. suggested changes. Among other checks, this includes making sure
  75. there is a valid host key, that the key is published, that the sshd
  76. configuration points to the right place, etc. `d' may be used in
  77. place of `diagnostics'.
  78. .SH SETUP HOST AUTHENTICATION
  79. To enable host verification via the monkeysphere, the host's key must
  80. be published to the Web of Trust. This is not done by default. To
  81. publish the host key to the keyservers, run the following command:
  82. $ monkeysphere-host publish-key
  83. In order for users logging into the system to be able to identify the
  84. host via the monkeysphere, at least one person (e.g. a server admin)
  85. will need to sign the host's key. This is done using standard OpenPGP
  86. keysigning techniques, usually: pull the key from the keyserver,
  87. verify and sign the key, and then re-publish the signature. Once an
  88. admin's signature is published, users logging into the host can use it
  89. to validate the host's key.
  90. .SH ENVIRONMENT
  91. The following environment variables will override those specified in
  92. the config file (defaults in parentheses):
  93. .TP
  94. MONKEYSPHERE_LOG_LEVEL
  95. Set the log level (INFO). Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, in
  96. increasing order of verbosity.
  97. .TP
  98. MONKEYSPHERE_KEYSERVER
  99. OpenPGP keyserver to use (pool.sks-keyservers.net).
  100. .TP
  101. MONKEYSPHERE_PROMPT
  102. If set to `false', never prompt the user for confirmation. (true)
  103. .SH FILES
  104. .TP
  105. /etc/monkeysphere/monkeysphere-host.conf
  106. System monkeysphere-host config file.
  107. .TP
  108. /var/lib/monkeysphere/host/ssh_host_rsa_key
  109. Copy of the host's private key in ssh format, suitable for use by
  110. sshd.
  111. .SH AUTHOR
  112. Written by:
  113. Jameson Rollins <jrollins@fifthhorseman.net>,
  114. Daniel Kahn Gillmor <dkg@fifthhorseman.net>,
  115. Matthew Goins <mjgoins@openflows.com>
  116. .SH SEE ALSO
  117. .BR monkeysphere (1),
  118. .BR monkeysphere-authentication (8),
  119. .BR monkeysphere (7),
  120. .BR gpg (1),
  121. .BR ssh (1)