Merge commit 'mjgoins/master'
[monkeysphere.git] / man / man8 / monkeysphere-server.8
1 .TH MONKEYSPHERE-SERVER "1" "June 2008" "monkeysphere 0.1" "User Commands"
2
3 .SH NAME
4
5 monkeysphere-server \- monkeysphere server admin user interface
6
7 .SH SYNOPSIS
8
9 .B monkeysphere-server \fIcommand\fP [\fIargs\fP]
10
11 .SH DESCRIPTION
12
13 \fBMonkeySphere\fP is a system to leverage the OpenPGP Web of Trust
14 for ssh authentication and encryption.  OpenPGP keys are tracked via
15 GnuPG, and added to the ssh authorized_keys and known_hosts files to
16 be used for authentication of ssh connections.
17
18 \fBmonkeysphere-server\fP is the MonkeySphere server admin utility.
19
20 .SH SUBCOMMANDS
21
22 \fBmonkeysphere-server\fP takes various subcommands:
23 .TP
24 .B update-users [USER]...
25 Update the admin-controlled authorized_keys files for user.  For each
26 user specified, user ID's listed in the user's authorized_user_ids
27 file are processed, and the user's authorized_keys file in
28 /var/cache/monkeysphere/authorized_keys/USER.  See `man monkeysphere'
29 for more info.  If the USER_CONTROLLED_AUTHORIZED_KEYS variable is
30 set, then a user-controlled authorized_keys file (usually
31 ~USER/.ssh/authorized_keys) is added to the authorized_keys file.  `k'
32 may be used in place of `update-known_hosts'.
33 .TP
34 .B gen-key
35 Generate a gpg key for the host.  `g' may be used in place of
36 `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 gpg key to the keyserver.  `p' may be used in place
44 of `publish-key'.
45 .TP
46 .B trust-keys KEYID...
47 Mark key specified with key IDs with full owner trust.  `t' may be used
48 in place of `trust-keys'.
49 .TP
50 .B help
51 Output a brief usage summary.  `h' or `?' may be used in place of
52 `help'.
53
54 .SH SETUP
55
56 In order to start using the monkeysphere, there are a couple of things
57 you need to do first.  The first is to generate an OpenPGP key for the
58 server and convert that key to an ssh key that can be used by ssh for
59 host authentication.  To do this, run the "gen-key" subcommand.  Once
60 that is done, publish the key to a keyserver with "publish-key"
61 subcommand.  Finally, you need to modify the sshd_config to tell sshd
62 where the new server host key:
63
64 HostKey /etc/monkeysphere/ssh_host_rsa_key
65
66 If the server will also handle user authentication through
67 monkeysphere-generated authorized_keys files, set the following:
68
69 AuthorizedKeysFile /var/cache/monkeysphere/authorized_keys/%u
70
71 Once those changes are made, restart the ssh server.
72
73 .SH FILES
74
75 .TP
76 /etc/monkeysphere/monkeysphere-server.conf
77 System monkeysphere-server config file.
78 .TP
79 /etc/monkeysphere/monkeysphere.conf
80 System-wide monkeysphere config file.
81 .TP
82 /etc/monkeysphere/gnupg
83 Monkeysphere GNUPG home directory.
84 .TP
85 /etc/monkeysphere/ssh_host_rsa_key
86 Copy of the host's private key in ssh format, suitable for use by sshd.
87 .TP
88 /etc/monkeysphere/authorized_user_ids/USER
89 Server maintained authorized_user_ids files for users.
90 .TP
91 /var/cache/monkeysphere/authorized_keys/USER
92 User authorized_keys file.
93
94 .SH AUTHOR
95
96 Written by Jameson Rollins <jrollins@fifthhorseman.net>
97
98 .SH SEE ALSO
99
100 .BR monkeysphere (1),
101 .BR gpg (1),
102 .BR ssh (1)