Skip to content

Commit

Permalink
factor out features to its own doc to make "index" more of an "index".
Browse files Browse the repository at this point in the history
  • Loading branch information
hpk42 committed Dec 21, 2016
1 parent 1a43627 commit 7bd0a0f
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 50 deletions.
39 changes: 39 additions & 0 deletions doc/features.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

Features of the Autocrypt effort
--------------------------------

End-to-end encrypted e-mail has been around for decades, but has failed
to see wide adoption outside of specialist communities, in large part
because of difficulties user experience and certification models.
To better understand how the fresh autocrypt effort is different
from previous ones here are some of its features:

- **Protect first against passive data-collecting adversaries**,
resist the temptation to early-add complexity which aim to
prevent active attacks. See `RFC7435 A New Perspective
<https://tools.ietf.org/html/rfc7435#section-1.2>`_ for some
motivation of this and the next points.

- **Focus on incremental deployment**, always consider that there
will be both autocrypt-enabled MUAs and traditional plain ones,
interacting with each other.

- **Don't ask users anything about keys, ever.** And minimize and
useability-test what needs to be decided by users and include
resulting UI guidance in the specs. Minimize friction for people
using multiple mail apps with their accounts.

- **Go for mail app changes, don't require changes from mail providers**,
allowing fluid development of deployable code and specs.

- **Use decentralized, in-band key discovery.** Make mail apps
tell each other how and when to encrypt to each other
by attaching neccessary information along with mails.

- **Implement and specify "level0" support in several MUAs in spring
2017.** Keep level0 minimal enough that it's easy for developers to
adopt it and we can start to drive efforts from real-life experiences.
Currently involved are developers from K9/Android, Enigmail, Mailpile,
Bitmask/LEAP and others who are interested to add support for OSX
or write reference "MUA bots" in Python or Go.

63 changes: 13 additions & 50 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,64 +15,22 @@ and researchers who are willing to take fresh approaches, learn from
past mistakes, and collectively aim to increase the overall encryption
of E-Mail in the net. The group effort was born and named "autocrypt"
on December 17th 2016 by ~20 people during a 5-day meeting at the
OnionSpace in berlin. It's a dynamic, fun process which is open to
new influences, contributions and people. No need to tweet btw but
please do join our `autocrypt mailing list`_ :)

Features of the Autocrypt effort
--------------------------------

End-to-end encrypted e-mail has been around for decades, but has failed
to see wide adoption outside of specialist communities, in large part
because of difficulties user experience and certification models.
To better understand how the fresh autocrypt effort is different
from previous ones here are some of its features:

- **Protect first against passive data-collecting adversaries**,
resist the temptation to early-add complexity which aim to
prevent active attacks. See `RFC7435 A New Perspective
<https://tools.ietf.org/html/rfc7435#section-1.2>`_ for some
motivation of this and the next points.

- **Focus on incremental deployment**, always consider that there
will be both autocrypt-enabled MUAs and traditional plain ones,
interacting with each other.

- **Don't ask users anything about keys, ever.** And minimize and
useability-test what needs to be decided by users and include
resulting UI guidance in the specs. Minimize friction for people
using multiple mail apps with their accounts.

- **Go for mail app changes, don't require changes from mail providers**,
allowing fluid development of deployable code and specs.

- **Use decentralized, in-band key discovery.** Make mail apps
tell each other how and when to encrypt to each other
by attaching neccessary information along with mails.

- **Implement and specify "level0" support in several MUAs in spring
2017.** Keep level0 minimal enough that it's easy for developers to
adopt it and we can start to drive efforts from real-life experiences.
Currently involved are developers from K9/Android, Enigmail, Mailpile,
Bitmask/LEAP and others who are interested to add support for OSX
or write reference "MUA bots" in Python or Go.

OnionSpace in Berlin. It's a dynamic, fun process which is open to
new people, influences and contributions. No need to tweet but
you may join our `autocrypt mailing list`_ :)

Current docs (work-in-progress)
-------------------------------

The following in-progress documents are written for software developers
and privacy enthusiasts.

:doc:`Autocrypt key discovery <mua-keydiscovery>`
presents and discusses how mail programs negotiate encryption
with each other.

:doc:`Autocrypt key format <key-formats>`
discusses the precise header and key format.
:doc:`features`
discusses how the Autocrypt efforts is different from past
e2e encryption efforts.

:doc:`Autocrypt levels <levels>`
discusses level0 and level1 support.
:doc:`Autocrypt key discovery <key-discovery>`
discusses how mail programs negotiate encryption with each other.

:doc:`Autocrypt MUA internals <mua-internals>`
discusses requirements, operations and the state MUAs need to
Expand All @@ -86,6 +44,11 @@ and privacy enthusiasts.
unsorted collection of docs and fragments
+++++++++++++++++++++++++++++++++++++++++++++++

The following docs need refinement and incorporation into
our sorted, maintained collection.

:doc:`Autocrypt levels <levels>`

:doc:`muaa-state`

:doc:`multi-device`
Expand Down

0 comments on commit 7bd0a0f

Please sign in to comment.