reorganize headers on documentation page, try out table of contents plugin.
[monkeysphere.git] / website / doc.mdwn
index 3464455f45820a8394618177888c72c048867483..a7d2229853d1261fb1265f37001da9aaa90c2422 100644 (file)
@@ -1,11 +1,15 @@
 [[!template id="nav"]]
-
+[[meta title="Documentation"]]
 # Monkeysphere Documentation #
-
+[[!toc]]
 
 ## Dependencies ##
 
- * Monkeysphere relies on [GnuTLS](http://gnutls.org/) version 2.4.0 or later.
+Monkeysphere relies on:
+
+ * [GnuTLS](http://gnutls.org/) version 2.4.0 or later
+ * [OpenSSH](http://openssh.com/)
+ * [GnuPG](http://gnupg.org/)
 
 ## Getting started ##
 
@@ -29,10 +33,17 @@ All of the other projects we've found so far require a patched version
 of OpenSSH, which makes adoption more difficult.  Most people don't
 build their own software, and simply overlaying a patched binary is
 associated with significant maintenance (and therefore security)
-problems.  A PKI becomes more useful the more people participate in
-it, so widespread adoption is important.
+problems.  
 
-### `openssh-gpg` ###
+While ultimately contributing a patch to
+[OpenSSH](http://openssh.com/) (or any
+[free](http://www.chiark.greenend.org.uk/~sgtatham/putty/)
+[SSH](http://www.lysator.liu.se/~nisse/lsh/)
+[implementation](http://matt.ucc.asn.au/dropbear/dropbear.html)) is
+not a bad thing, we hope to be able to better establish the use of a
+PKI without resorting to source modification.
+
+### openssh-gpg ###
 
 [openssh-gpg](http://www.red-bean.com/~nemo/openssh-gpg/) is a patch
 against OpenSSH to support OpenPGP certificates.  According to its
@@ -42,9 +53,8 @@ IETF](http://tools.ietf.org/html/rfc4253#section-6.6).
 
 Some concerns with `openssh-gpg`:
 
- * This patch is significantly old; it doesn't appear to have been
-   maintained beyond OpenSSH 3.6p1.  As of this writing, OpenSSH is on
-   version 5.1p1.
+ * This patch is old; it doesn't appear to have been maintained beyond
+   OpenSSH 3.6p1.  As of this writing, OpenSSH 5.1p1 is current.
 
  * It only provides infrastructure in one direction: the user
    authenticating the host by name.  There doesn't seem to be a
@@ -61,23 +71,23 @@ Some concerns with `openssh-gpg`:
    to avoid collisions with existing use.
 
  * It's not clear that `openssh-gpg` acknowledges or respects the
-   usage flags on the host keys.
-
- * It requires patching OpenSSH.
-
+   [usage flags](http://tools.ietf.org/html/rfc4880#section-5.2.3.21)
+   on the host keys.  This means that it could accept a "sign-only"
+   key as suitable for authenticating a host, despite the
+   clearly-marked intentions of the key-holder.
 
 ### Perspectives OpenSSH client ###
 
 [The Perspectives project](http://www.cs.cmu.edu/~perspectives/) at
 CMU has released an [openssh client that uses network
 notaries](http://www.cs.cmu.edu/~perspectives/openssh.html) to bolster
-your confidence in new keys.  This offers a defense against a narrow
-MITM attack (e.g. by someone who controls your local gateway) by
-simply verifying that other machines from around the network see the
-same keys for the remote host that you're seeing.
+your confidence in newly-seen keys.  This offers a defense against a
+narrow MITM attack (e.g. by someone who controls your local gateway)
+by simply verifying that other machines from around the network see
+the same keys for the remote host that you're seeing.
 
-This is quite useful, but doesn't take the system as far as it could
-go, and doesn't tie into the existing web of trust.
+This tactic is quite useful, but doesn't take the system as far as it
+could go, and doesn't tie into any existing web of trust.
 
 Some concerns with the Perspectives OpenSSH client:
 
@@ -94,13 +104,14 @@ Some concerns with the Perspectives OpenSSH client:
    with identifying users by name, or allowing users to globally
    revoke or change keys.
 
- * It requires patching OpenSSH
+ * It doesn't provide any mechanism for key rotation or revocation:
+   Perspectives won't help you if you need to re-key your machine.
 
 ### OpenSSH with X.509v3 certificates ###
 
 Roumen Petrov [maintains a patch to OpenSSH that works with the X.509
 PKI model](http://www.roumenpetrov.info/openssh/).  This is the
-certificate hierarchy commonly used by TLS (and SSL before that).
+certificate hierarchy commonly used by TLS (and SSL).
 
 Some concerns about OpenSSH with X.509v3:
 
@@ -120,4 +131,15 @@ Some concerns about OpenSSH with X.509v3:
    model is more flexible and more adaptable to represent real-world
    trust than X.509's rigid hierarchy.
 
- * It requires patching OpenSSH.
+ * X.509 certificates can identify hosts by name, but not by
+   individual service.  This means that a compromised web or e-mail
+   server with access to the X.509 key for that service could re-use
+   its certificate as an SSH server, and it would be able to
+   masquerade successfully.
+
+   The monkeysphere uses [User IDs of the form
+   `ssh://foo.example.net`](http://tools.ietf.org/wg/secsh/draft-ietf-secsh-scp-sftp-ssh-uri/),
+   so they are not by-default shared across services on the same host
+   (you can still share a key across services on the same host if you
+   like, but the service User IDs can be certified independently of
+   one another).