1 .TH MONKEYSPHERE-SERVER "8" "June 2008" "monkeysphere" "User Commands"
5 monkeysphere-host \- Monkeysphere host admin tool.
9 .B monkeysphere-host \fIsubcommand\fP [\fIargs\fP]
11 .B monkeysphere-host expert \fIexpert-subcommand\fP [\fIargs\fP]
15 \fBMonkeysphere\fP is a framework to leverage the OpenPGP web of trust
16 for OpenSSH authentication. OpenPGP keys are tracked via GnuPG, and
17 added to the authorized_keys and known_hosts files used by OpenSSH for
18 connection authentication.
20 \fBmonkeysphere-host\fP is a Monkeysphere server admin utility.
24 \fBmonkeysphere-host\fP takes various subcommands:
27 Output information about host's OpenPGP and SSH keys. `s' may be used
28 in place of `show-key'.
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 like GnuPG
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
42 `e' may be used in place of `extend-key'.
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'.
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'.
52 .B add-revoker FINGERPRINT
53 Add a revoker to the host's OpenPGP key. `o' may be be used in place
57 Revoke the host's OpenPGP key. `r' may be used in place of
61 Publish the host's OpenPGP key to the keyserver. `p' may be used in
62 place of `publish-key'.
65 Output a brief usage summary. `h' or `?' may be used in place of
71 .SH "EXPERT" SUBCOMMANDS
73 Some commands are very unlikely to be needed by most administrators.
74 These commands must prefaced by the word `expert'.
77 Generate a OpenPGP key for the host. If HOSTNAME is not specified,
78 then the system fully-qualified domain name will be user. An
79 alternate key bit length can be specified with the `-l' or `--length'
80 option (default 2048). An expiration length can be specified with the
81 `-e' or `--expire' option (prompt otherwise). The expiration format
82 is the same as that of \fBextend-key\fP, below. `g' may be used in
87 import-key (i) import existing ssh key to gpg
88 --hostname (-h) NAME[:PORT] hostname for key user ID
89 --keyfile (-f) FILE key file to import
90 --expire (-e) EXPIRE date to expire
93 Review the state of the monkeysphere server host key and report on
94 suggested changes. Among other checks, this includes making sure
95 there is a valid host key, that the key is published, that the sshd
96 configuration points to the right place, etc. `d' may be used in
97 place of `diagnostics'.
99 .SH SETUP HOST AUTHENTICATION
101 To enable host verification via the monkeysphere, the host's key must
102 be published to the Web of Trust. This is not done by default. To
103 publish the host key to the keyservers, run the following command:
105 $ monkeysphere-host publish-key
107 You must also modify the sshd_config on the server to tell sshd where
108 the new server host key is located:
110 HostKey /var/lib/monkeysphere/host/ssh_host_rsa_key
112 In order for users logging into the system to be able to identify the
113 host via the monkeysphere, at least one person (e.g. a server admin)
114 will need to sign the host's key. This is done using standard OpenPGP
115 keysigning techniques, usually: pull the key from the keyserver,
116 verify and sign the key, and then re-publish the signature. Once an
117 admin's signature is published, users logging into the host can use it
118 to validate the host's key.
122 The following environment variables will override those specified in
123 the config file (defaults in parentheses):
125 MONKEYSPHERE_LOG_LEVEL
126 Set the log level (INFO). Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, in
127 increasing order of verbosity.
129 MONKEYSPHERE_KEYSERVER
130 OpenPGP keyserver to use (pool.sks-keyservers.net).
135 /etc/monkeysphere/monkeysphere-host.conf
136 System monkeysphere-host config file.
138 /var/lib/monkeysphere/host/ssh_host_rsa_key
139 Copy of the host's private key in ssh format, suitable for use by
145 Jameson Rollins <jrollins@fifthhorseman.net>,
146 Daniel Kahn Gillmor <dkg@fifthhorseman.net>,
147 Matthew Goins <mjgoins@openflows.com>
151 .BR monkeysphere (1),
152 .BR monkeysphere-authentication (8),
153 .BR monkeysphere (7),