update for the release of 0.29-1
[monkeysphere.git] / man / man7 / monkeysphere.7
1 .TH MONKEYSPHERE "7" "March 2010" "monkeysphere" "System Frameworks"
2
3 .SH NAME
4
5 monkeysphere - ssh and TLS authentication framework using OpenPGP Web of Trust
6
7 .SH DESCRIPTION
8
9 \fBMonkeysphere\fP is a framework to leverage the OpenPGP web of trust
10 for OpenSSH and TLS key-based authentication.  OpenPGP keys are
11 tracked via GnuPG, and added to the authorized_keys and known_hosts
12 files used by OpenSSH for connection authentication.  Monkeysphere can
13 also be used by a validation agent to validate TLS connections
14 (e.g. https).
15
16 .SH IDENTITY CERTIFIERS
17
18 Each host that uses the \fBMonkeysphere\fP to authenticate its remote
19 users needs some way to determine that those users are who they claim
20 to be.  SSH permits key-based authentication, but we want instead to
21 bind authenticators to human-comprehensible user identities.  This
22 switch from raw keys to User IDs makes it possible for administrators
23 to see intuitively who has access to an account, and it also enables
24 end users to transition keys (and revoke compromised ones)
25 automatically across all \fBMonkeysphere\fP-enabled hosts.  The User
26 IDs and certifications that the \fBMonkeysphere\fP relies on are found
27 in the OpenPGP Web of Trust.
28
29 However, in order to establish this binding, each host must know whose
30 cerifications to trust.  Someone who a host trusts to certify User
31 Identities is called an Identity Certifier.  A host must have at least
32 one Identity Certifier in order to bind User IDs to keys.  Commonly,
33 every ID Certifier would be trusted by the host to fully identify any
34 User ID, but more nuanced approaches are possible as well.  For
35 example, a given host could specify a dozen ID certifiers, but assign
36 them all "marginal" trust.  Then any given User ID would need to be
37 certified in the OpenPGP Web of Trust by at least three of those
38 certifiers. 
39
40 It is also possible to limit the scope of trust for a given ID
41 Certifier to a particular domain.  That is, a host can be configured
42 to fully (or marginally) trust a particular ID Certifier only when
43 they certify identities within, say, example.org (based on the e-mail
44 address in the User ID).
45
46 .SH KEY ACCEPTABILITY
47
48 The monkeysphere commands work from a set of user IDs to determine
49 acceptable keys for ssh and TLS authentication.  OpenPGP keys are
50 considered acceptable if the following criteria are met:
51 .TP
52 .B capability
53 The key must have the `authentication' (`a') usage flag set.
54 .TP
55 .B validity
56 The key itself must be valid, i.e. it must be well-formed, not
57 expired, and not revoked.
58 .TP
59 .B certification
60 The relevant user ID must be signed by a trusted identity certifier.
61
62 .SH HOST IDENTIFICATION
63
64 The OpenPGP keys for hosts have associated `service names` (OpenPGP
65 user IDs) that are based on URI specifications for the service.  Some
66 examples:
67 .TP
68 .B ssh:
69 ssh://host.example.com[:port]
70 .TP
71 .B https:
72 https://host.example.com[:port]
73
74 .SH AUTHOR
75
76 Written by:
77 Jameson Rollins <jrollins@finestructure.net>,
78 Daniel Kahn Gillmor <dkg@fifthhorseman.net>
79
80 .SH SEE ALSO
81
82 .BR monkeysphere (1),
83 .BR monkeysphere\-host (8),
84 .BR monkeysphere\-authentication (8),
85 .BR openpgp2ssh (1),
86 .BR pem2openpgp (1),
87 .BR gpg (1),
88 .BR http://tools.ietf.org/html/rfc4880,
89 .BR ssh (1),
90 .BR http://tools.ietf.org/wg/secsh/draft\-ietf\-secsh\-scp\-sftp\-ssh\-uri/