cda1194336bfb028e8fabd71f46c3d0104fdc088
[monkeysphere.git] / doc / README
1 Monkeysphere README
2 ===================
3
4 user usage
5 ----------
6 For a user to update their known_hosts file:
7
8 $ monkeysphere update-known_hosts
9
10 For a user to update their monkeysphere authorized_keys file:
11
12 $ monkeysphere update-authorized_keys
13
14 server service publication
15 --------------------------
16 To publish a server host key:
17
18 # monkeysphere-server gen-key
19 # monkeysphere-server publish-key
20
21 This will generate the key for server with the service URI
22 (ssh://server.hostname).  The server admin should now sign the server
23 key so that people in the admin's web of trust can authenticate the
24 server without manual host key checking:
25
26 $ gpg --search ='ssh://server.hostname'
27 $ gpg --sign-key 'ssh://server.hostname'
28
29 server authorized_keys maintenance
30 ----------------------------------
31 A system can maintain monkeysphere authorized_keys files for it's
32 users.
33
34 For each user account on the server, the userids of people authorized
35 to log into that account would be placed in:
36
37 /etc/monkeysphere/authorized_user_ids/USER
38
39 However, in order for users to become authenticated, the server must
40 determine that the user keys have "full" validity.  This means that
41 the server must fully trust at least one person whose signature on the
42 connecting users key would validate the user.  This would generally be
43 the server admin.  If the server admin's keyid is XXXXXXXX, then on
44 the server run:
45
46 # monkeysphere-server trust-keys XXXXXXXX
47
48 To update the monkeysphere authorized_keys file for user "bob", the
49 system would then run the following:
50
51 # monkeysphere-server update-users bob
52
53 To update the monkeysphere authorized_keys file for all users on the
54 the system, run the same command with no arguments:
55
56 # monkeysphere-server update-users