diff options
| -rw-r--r-- | AUTHORS | 16 | ||||
| -rw-r--r-- | Makefile | 3 | ||||
| -rw-r--r-- | NEWS | 17 | ||||
| -rw-r--r-- | docs/authors.rst | 34 | ||||
| -rw-r--r-- | docs/bitmask-mail-index.rst | 96 | ||||
| -rw-r--r-- | docs/bonafide/index.rst | 14 | ||||
| -rw-r--r-- | docs/changelog-next.rst (renamed from docs/next-changelog.rst) | 4 | ||||
| -rw-r--r-- | docs/changelog.rst | 3 | ||||
| -rw-r--r-- | docs/cli/index.rst | 13 | ||||
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rwxr-xr-x | docs/core/core_api_contract (renamed from docs/core_api_contract) | 0 | ||||
| -rw-r--r-- | docs/core/index.rst | 13 | ||||
| -rw-r--r-- | docs/designdocs/index.rst | 13 | ||||
| -rw-r--r-- | docs/hacking/index.rst | 77 | ||||
| -rw-r--r-- | docs/hacking/release.rst | 102 | ||||
| -rwxr-xr-x | docs/hooks/leap-autopep8.post-commit.hook (renamed from docs/leap-autopep8.post-commit.hook) | 0 | ||||
| -rwxr-xr-x | docs/hooks/leap-autopep8.post-commit.hook.ADD (renamed from docs/leap-autopep8.post-commit.hook.ADD) | 0 | ||||
| -rw-r--r-- | docs/hooks/leap-commit-template (renamed from docs/leap-commit-template) | 0 | ||||
| -rw-r--r-- | docs/hooks/leap-commit-template.README (renamed from docs/leap-commit-template.README) | 0 | ||||
| -rwxr-xr-x | docs/hooks/leap-flake8.pre-commit.hook (renamed from docs/leap-flake8.pre-commit.hook) | 0 | ||||
| -rw-r--r-- | docs/index.rst | 75 | ||||
| -rw-r--r-- | docs/installation/index.rst | 48 | ||||
| -rw-r--r-- | docs/keymanager/index.rst (renamed from docs/keymanager-soledad-docs.rst) | 7 | ||||
| -rw-r--r-- | docs/knownissues.rst (renamed from KNOWN_ISSUES) | 9 | ||||
| -rw-r--r-- | docs/mail/hacking.rst (renamed from docs/mail-hacking.rst) | 70 | ||||
| -rw-r--r-- | docs/mail/index.rst | 88 | ||||
| -rw-r--r-- | docs/mail/journey.rst (renamed from docs/mail-journey.rst) | 8 | ||||
| -rw-r--r-- | docs/release_checklist.wiki | 90 | ||||
| -rw-r--r-- | docs/testing/index.rst (renamed from docs/testing-rcs.README) | 41 | ||||
| -rw-r--r-- | pkg/branding/bitmask-logo.svg | 19 | ||||
| -rw-r--r-- | pkg/branding/bitmask-sidebar.png | bin | 0 -> 25946 bytes |
31 files changed, 589 insertions, 275 deletions
diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index cbd35da3..00000000 --- a/AUTHORS +++ /dev/null @@ -1,16 +0,0 @@ -Tomás Touceda <chiiph@leap.se> -Ivan Alejandro <ivanalejandro0@gmail.com> -Kali Kaneko <kali@leap.se> -drebs <drebs@leap.se> -antialias <antialias@leap.se> -elijah <elijah@riseup.net> -Ruben Pollan <meskio@sindominio.net> -k clair <kclair@riseup.net> -Jaromil <jaromil@dyne.org> -kwadronaut <kwadronaut@leap.se> -Duda Dornelles <ddornell@thoughtworks.com> -Bruno Wagner Goncalves <bwagner@thoughtworks.com> -Parménides GV <parmegv@sdf.org> -Neissi Lima <neissi.lima@gmail.com> -Micah Anderson <micah@riseup.net> -irregulator <irregulator@riseup.net> @@ -16,3 +16,6 @@ dev-all: uninstall: pip uninstall leap.bitmask + +doc: + cd docs && make html @@ -0,0 +1,17 @@ +Ticket numbers in this file can be looked up by visiting +http://leap.se/code/issues/<number> + +Bitmask 0.10.0 +============== + +Features +-------- + +Bugfixes +-------- + +Documentation +------------- + +Other +----- diff --git a/docs/authors.rst b/docs/authors.rst new file mode 100644 index 00000000..37f31227 --- /dev/null +++ b/docs/authors.rst @@ -0,0 +1,34 @@ +.. _authors: + +List of contributors +================================================ +The following people have contributed in the history of Bitmask. + +All the Code is Copyright 2012-2016 LEAP Encryption Access Project + +* Ruben Pollan meskio at sindominio dot net +* drebs drebs at leap dot se +* elijah elijah at riseup dot net +* Tomás Touceda chiiph at leap dot se +* Ivan Alejandro ivanalejandro0 at gmail dot com +* Kali Kaneko kali at leap dot se +* Micah Anderson micah at riseup dot net +* kwadronaut kwadronaut at leap dot se +* Duda Dornelles ddornell at thoughtworks dot com +* Bruno Wagner Goncalves bwagner at thoughtworks.com +* Parménides GV parmegv at sdf dot org +* irregulator irregulator at riseup dot net +* Paixu Aabuizia PaixuAabuizia at users dot noreply at github dot com +* Neissi Lima neissi.lima at gmail dot com +* k clair kclair at riseup dot net +* antialias antialias at leap dot se +* Jaromil jaromil at dyne dot org + +Updating the authors file +------------------------- + +From the root of the ``bitmask-dev`` repo:: + + pkg/tools/get_authors.sh + +However, beware that some of the codebase from the legacy bitmask_client repo has not been preserved with the original authorship. Do not remove people here just because you don't see the commits they made :) diff --git a/docs/bitmask-mail-index.rst b/docs/bitmask-mail-index.rst deleted file mode 100644 index a2133f48..00000000 --- a/docs/bitmask-mail-index.rst +++ /dev/null @@ -1,96 +0,0 @@ -.. leap.mail documentation master file, created by - sphinx-quickstart on Mon Aug 25 19:19:48 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -leap.mail -========= - -*decentralized and secure mail delivery and synchronization* - -This is the documentation for the ``leap.mail`` module. It is a `twisted`_ -package that allows to receive, process, send and access existing messages using -the `LEAP`_ platform. - -One way to use this library is to let it launch two standard mail services, -``smtp`` and ``imap``, that run as local proxies and interact with a remote -``LEAP`` provider that offers *a soledad syncronization endpoint* and receives -the outgoing email. This is what `Bitmask`_ client does. - -From the release 0.4.0 on, it's also possible to use a protocol-agnostic email -public API, so that third party mail clients can manipulate the data layer. This -is what the awesome MUA in the `Pixelated`_ project is using. - -.. _`twisted`: https://twistedmatrix.com/trac/ -.. _`LEAP`: https://leap.se/en/docs -.. _`Bitmask`: https://bitmask.net/en/features#email -.. _`Pixelated`: https://pixelated-project.org/ - -How does this all work? ------------------------ - -All the underlying data storage and sync is handled by a library called -`soledad`_, which handles encryption, storage and sync. Based on `u1db`_, -documents are stored locally as local ``sqlcipher`` tables, and syncs against -the soledad sync service in the provider. - -OpenPGP key generation and keyring management are handled by another leap -python library: `keymanager`_. - -See :ref:`the life cycle of a leap email <mail_journey>` for an overview of the life cycle -of an email through ``LEAP`` providers. - -.. _`Soledad`: https://leap.se/en/docs/design/soledad -.. _`u1db`: https://en.wikipedia.org/wiki/U1DB -.. _`keymanager`: https://github.com/leapcode/keymanager/ - - -Data model ----------- -.. TODO clear document types documentation. - -The data model at the present moment consists of several *document types* that split email into -different documents that are stored in ``Soledad``. The idea behind this is to -keep clear the separation between *mutable* and *inmutable* parts, and still being able to -reconstruct arbitrarily nested email structures easily. - -Documentation index -=================== - -.. -.. Contents: -.. toctree:: - :maxdepth: 2 - - hacking - -.. intro -.. tutorial - - -API documentation ------------------ - -If you were looking for the documentation of the ``leap.mail`` module, you will -find it here. - -Of special interest is the `public mail api`_, which should remain relatively -stable across the next few releases. - -.. _`public mail api`: api/mail.html#module-mail - - -.. toctree:: - :maxdepth: 2 - - api/leap.mail - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/docs/bonafide/index.rst b/docs/bonafide/index.rst new file mode 100644 index 00000000..1939a617 --- /dev/null +++ b/docs/bonafide/index.rst @@ -0,0 +1,14 @@ +:LastChangedDate: $LastChangedDate$ +:LastChangedRevision: $LastChangedRevision$ +:LastChangedBy: $LastChangedBy$ + +.. _bonafide: + + +Bonafide +================================ +blah blah + +Using the library +-------------------------------- + diff --git a/docs/next-changelog.rst b/docs/changelog-next.rst index f57e2ae4..36b915bd 100644 --- a/docs/next-changelog.rst +++ b/docs/changelog-next.rst @@ -26,8 +26,8 @@ Bugfixes - `#1235 <https://leap.se/code/issues/1235>`_: Description for the fixed stuff corresponding with issue #1235. - Bugfix without related issue number. -Misc -~~~~ +Other +~~~~~ - `#1236 <https://leap.se/code/issues/1236>`_: Description of the new feature corresponding with issue #1236. - Some change without issue number. diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 00000000..34ee31fd --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,3 @@ +Full Changelog +-------------- +TODO: port here the changelog from the legacy repo. diff --git a/docs/cli/index.rst b/docs/cli/index.rst new file mode 100644 index 00000000..130a1601 --- /dev/null +++ b/docs/cli/index.rst @@ -0,0 +1,13 @@ +:LastChangedDate: $LastChangedDate$ +:LastChangedRevision: $LastChangedRevision$ +:LastChangedBy: $LastChangedBy$ + +.. _cli: + + +Bitmask CLI +================================ +The command line interface + +Using bitmask from the command line +----------------------------------- diff --git a/docs/conf.py b/docs/conf.py index 52d24504..0339aca2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,7 +51,7 @@ master_doc = 'index' # General information about the project. project = u'Bitmask' -copyright = u'2016, LEAP Encryption Access Project' +copyright = u'2012-2016, LEAP Encryption Access Project' author = u'LEAP Encryption Access Project' # The version info for the project you're documenting, acts as replacement for @@ -144,7 +144,7 @@ html_theme = 'alabaster' # The name of an image file (relative to this directory) to place at the top # of the sidebar. # -# html_logo = None +html_logo = '../pkg/branding/bitmask-sidebar.png' # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 diff --git a/docs/core_api_contract b/docs/core/core_api_contract index b70fb8fa..b70fb8fa 100755 --- a/docs/core_api_contract +++ b/docs/core/core_api_contract diff --git a/docs/core/index.rst b/docs/core/index.rst new file mode 100644 index 00000000..c52dcc17 --- /dev/null +++ b/docs/core/index.rst @@ -0,0 +1,13 @@ +:LastChangedDate: $LastChangedDate$ +:LastChangedRevision: $LastChangedRevision$ +:LastChangedBy: $LastChangedBy$ + +.. _bitmask_core: + +Bitmask Core +================================ +blah blah + +API documentation +-------------------------------- + diff --git a/docs/designdocs/index.rst b/docs/designdocs/index.rst new file mode 100644 index 00000000..b6dd6362 --- /dev/null +++ b/docs/designdocs/index.rst @@ -0,0 +1,13 @@ +:LastChangedDate: $LastChangedDate$ +:LastChangedRevision: $LastChangedRevision$ +:LastChangedBy: $LastChangedBy$ + +.. _designdocs: + +List of design docs +=================== + +Here you can find a list of links to authoritative sources for the design documents + +* (lots of links to leap.se/docs) +* Paper on the LEAP architecture https://satsymposium.org/papers/leap.pdf diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst new file mode 100644 index 00000000..f1991afd --- /dev/null +++ b/docs/hacking/index.rst @@ -0,0 +1,77 @@ +:LastChangedDate: $LastChangedDate$ +:LastChangedRevision: $LastChangedRevision$ +:LastChangedBy: $LastChangedBy$ + +Hacking +================================= +blah blah + +Running tests +--------------------------------- + +Tox is all you need:: + + tox + +Test when changes are made to common/soledad +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +If you modify soledad or leap.common packages:: + + tox -e py27-dev + +Setting up the development environment +-------------------------------------- + +Dependencies:: + + apt install ... + +There are different requirements files:: + + ... + +How to contribute +--------------------------------- + +Merge requests to https://0xacab/leap/bitmask-dev + +Coding conventions +--------------------------------- +* pep8 +* pre-commit hook (more utils in docs/hooks folder) + +Pinning +---------------------------------- +Only in the requirements files. + +Signing your commits +--------------------------------- +* For contributors with commit access + +Developing on the gui +--------------------------------- +blah blah. see some other README + +Developing on the Javascript UI +--------------------------------- +blah blah. see the main README + +Developing on the Thunderbird Extension +--------------------------------------- +blah blah + +Making a new release +-------------------- +A checklist for the release process can be found :ref:`here <release>` + +Contribution ideas +------------------ +Want to help? + +Some areas in which we always need contribution are: + +* Localization of the client (talk to elijah). +* Multiplatform gitlab runners +* Windows and OSX packaging +* Windows Firewall integration for VPN +* Migrating components to py3 (look for vshyba or kali). diff --git a/docs/hacking/release.rst b/docs/hacking/release.rst new file mode 100644 index 00000000..20f7c6eb --- /dev/null +++ b/docs/hacking/release.rst @@ -0,0 +1,102 @@ +.. _release: + +Bitmask Release Checklist +========================= + +CI check +-------- +* [ ] Check that all tests are passing! +* [ ] Fix any broken tests. + +Version bumps and Tagging +------------------------- +* [ ] Update pkg/next-release +* [ ] Update release-notes.rst in leap.bitmask if needed. +* [ ] Update version in bitmask_client/pkg/linux/bitmask-root if needed. + +* [ ] Tag everything. Should be done for the following packages, in order: +* [ ] 1. leap.common +* [ ] 2. leap.keymanager +* [ ] 3. leap.soledad +* [ ] 4. leap.mail +* [ ] 5. leap.bitmask +* [ ] 6. leap.mx + +* NOTE: It's assumed that origin is the leap.se repo + +* [ ] git fetch origin +* [ ] git tag -l, and see the latest tagged version (unless it's not a minor version bump, in which case, just bump to it) +* [ ] export version: export RELEASE=0.9.0 +* [ ] git checkout `release/0.9.x` +- NOTE: the release branch is created when the first release candidate + is tagged, after that the bugfixes and features that are meant to be + shipped with the specific version that we are targetting are merged in that branch +* [ ] git checkout -b release/$RELEASE (this is a LOCAL branch, never published). +* [ ] (maybe) cherry-pick specific commits +* [ ] (maybe) add special fixes for this release + +* [ ] Review pkg/requirements.pip for everything, update if needed (that's why the order). + - See whatever has been introduced in changes/VERSION_COMPAT + - Reset changes/VERSION_COMPAT + - Bump all the leap-requirements altogether. +* [ ] git commit -am "Update requirements file" + +* [ ] Merge changes/next-changelog.rst into the CHANGELOG + - NOTE: in leap.soledad, 3 sections (common, client, server). +* [ ] reset changes/next-changelog.rst +* [ ] git commit -S -m "[pkg] Update changelog" + +* [ ] git tag --sign $RELEASE -m "Tag version $RELEASE" + +* If everything went ok, push the changes, and merge back into master&develop: +* [ ] git checkout release/0.9.x && git merge $RELEASE +* [ ] git push origin release/0.9.x +* [ ] git push origin $RELEASE +* [ ] git checkout master && git pull origin master && git merge --no-edit $RELEASE +* [ ] git checkout develop && git merge $RELEASE && git push origin develop + +Bundles +------- +* [ ] Build and upload bundles +* [ ] Use 'make pyinst-linux' to build bundles. +* [ ] Sign: make pyinst-sign +* [ ] Upload bundle and signature to downloads.leap.se/client/<os>/Bitmask-<os>-<ver>.(tar.bz2,dmg,zip) +* [ ] make pyinst-upload +* [ ] Update symbolic link for latest upload and signature: +* [ ] ~/public/client/Bitmask-<os>-latest +* [ ] ~/public/client/Bitmask-<os>-latest.asc + +TUF: Relese candidate bundles: RC# (skipped for now) +---------------------------------------------------- + +* [ ] Upload the TUF unstable repo +* [ ] Upload bundle to staging for release-candidate +* [ ] Sign the bundles, move it to client downloads (micah) +* [ ] Update symlinks for -latest +* [ ] Fix all show stoppers + +TUF: Stable bundles (skipped for now) +------------------------------------- +* [ ] Upload the TUF Stable Repo to staging +* [ ] Upload bundle to staging for stable +* [ ] move and sign the TUF repo (kwadro) +* [ ] Sign the bundles, move it to client downloads (micah) +* [ ] Update symlinks for -latest + +Debian packages +--------------- +* TBD... + +Pypi upload +--------------- +* [ ] python setup.py sdist upload --sign -i kali@leap.se -r pypi + +Announcing +--------------- +* [ ] Announce (use release-notes.rst) + * [ ] Mail leap@lists.riseup.net + * [ ] Twitter + * [ ] Gnusocial + * [ ] Post in leap.se + * [ ] reddit + * [ ] hackernews diff --git a/docs/leap-autopep8.post-commit.hook b/docs/hooks/leap-autopep8.post-commit.hook index cffb1d53..cffb1d53 100755 --- a/docs/leap-autopep8.post-commit.hook +++ b/docs/hooks/leap-autopep8.post-commit.hook diff --git a/docs/leap-autopep8.post-commit.hook.ADD b/docs/hooks/leap-autopep8.post-commit.hook.ADD index b6e07ae5..b6e07ae5 100755 --- a/docs/leap-autopep8.post-commit.hook.ADD +++ b/docs/hooks/leap-autopep8.post-commit.hook.ADD diff --git a/docs/leap-commit-template b/docs/hooks/leap-commit-template index 8a5c7cd0..8a5c7cd0 100644 --- a/docs/leap-commit-template +++ b/docs/hooks/leap-commit-template diff --git a/docs/leap-commit-template.README b/docs/hooks/leap-commit-template.README index ce8809e7..ce8809e7 100644 --- a/docs/leap-commit-template.README +++ b/docs/hooks/leap-commit-template.README diff --git a/docs/leap-flake8.pre-commit.hook b/docs/hooks/leap-flake8.pre-commit.hook index b00fd08a..b00fd08a 100755 --- a/docs/leap-flake8.pre-commit.hook +++ b/docs/hooks/leap-flake8.pre-commit.hook diff --git a/docs/index.rst b/docs/index.rst index ad574794..ecd9d603 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,21 +3,76 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Bitmask -=================================== -**your internet encryption toolkit** +Bitmask: your internet encryption toolkit +========================================= -Contents: +Release v\ |version|. (:ref:`Installation <install>` and :ref:`Known Issues +<issues>`) -.. toctree:: - :maxdepth: 2 +What is Bitmask? +----------------------------------------- +**Bitmask** is the client for the services offered by `the LEAP Platform`_. The +services currently deployed are Encrypted Internet Proxy (VPN) and Encrypted Mail. + +Bitmask offers a **command-line interface** and a **multiplatform desktop +client**. It can be also used as a **set of libraries** to communicate with the +different services from third party applications. + +Bitmask is written in python using `Twisted`_ and licensed under the `GPL3`_. The +Graphical User Interface is written in html+js and uses `PyQt5`_ for serving the +application. + +.. _`the LEAP Platform`: https://github.com/leapcode/leap_platform +.. _`Twisted`: https://twistedmatrix.com +.. _`PyQt5`: https://pypi.python.org/pypi/PyQt5 +.. _`GPL3`: http://www.gnu.org/licenses/gpl.txt + +Understood! Show me the docs! +----------------------------------------- + +These documents that you are reading are, mostly, a **guide for developers** that want to contribute to the development of Bitmask, and seek to understand better the code organization and the contribution process. + +The **authoritative users guide** lives at `bitmask.net`_. + +Other important documents about the LEAP Project can be found at the `Official LEAP documentation`_ site. If you ever need an offline copy, you can clone the `repo for the LEAP Docs site`_. That repo contains also the related LEAP Platform documentation and all the latest design documents. Enhancement contributions and new translations are always welcome! Just open a new merge request. +On the contrary, this developers documentation you are reading right now is maintained in the `bitmask-dev`_ git repo itself, and `can also be checked online`_. +Building the docs +~~~~~~~~~~~~~~~~~ + +if you want to build these docs locally, you can do:: + + make doc + +from the topmost folder in the `bitmask-dev`_ repo. Note that you need to have sphinx installed. + +.. _`bitmask.net`: https://bitmask.net/ +.. _`Official LEAP documentation`: https://leap.se/docs/ +.. _`repo for the LEAP Docs site`: https://0xacab.org/leap/leap_se +.. _`bitmask-dev`: https://0xacab.org/leap/bitmask-dev +.. _`can also be checked online`: https://bitmask.readthedocs.io + + +Contents +-------- + +.. toctree:: + :maxdepth: 2 -Indices and tables -================== + installation/index + testing/index + knownissues + hacking/index + bundles/index + cli/index + core/index + bonafide/index + keymanager/index + mail/index + changelog + designdocs/index + authors -* :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff --git a/docs/installation/index.rst b/docs/installation/index.rst new file mode 100644 index 00000000..ce119e69 --- /dev/null +++ b/docs/installation/index.rst @@ -0,0 +1,48 @@ +:LastChangedDate: $LastChangedDate$ +:LastChangedRevision: $LastChangedRevision$ +:LastChangedBy: $LastChangedBy$ + +.. _install: + + +Installation +================== + +Users: go to the Bitmask Install guide https://bitmask.net/en/install + +Translators: improved/new translations welcome! + + +.. toctree:: + :hidden: + +Running latest code +------------------- +blah blah + +Building new bundles +-------------------- +blah blah... +nightly builds... +building bleeding edge bundles... + +Debian packages +--------------- + +ubuntu: +https://bitmask.net/en/install/linux#ubuntu-packages + +debian: +https://bitmask.net/en/install/linux#debian-packages + +Experimental repo ... + +Building latest packages (TBD). + + +Archlinux +--------- + +Not officially supported, but DoctorJellyFace maintains a PKGBUILD that can be found in the `AUR`_ repo. + +.. _`AUR`: https://aur.archlinux.org/packages/bitmask_client/ diff --git a/docs/keymanager-soledad-docs.rst b/docs/keymanager/index.rst index 67055b2f..fa3f0c83 100644 --- a/docs/keymanager-soledad-docs.rst +++ b/docs/keymanager/index.rst @@ -1,7 +1,12 @@ +.. _keymanager: + ================= -Soledad Documents +Keymanager ================= +Soledad documents +----------------- + KeyManager uses two types of documents for the keyring: * key document, that stores each gpg key. diff --git a/KNOWN_ISSUES b/docs/knownissues.rst index ce2c2e40..fed28bd1 100644 --- a/KNOWN_ISSUES +++ b/docs/knownissues.rst @@ -1,16 +1,25 @@ +.. _issues: + +=================== +Known Issues +=================== + VPN +------------------- * No VPN UI yet. * Only email is supported, but wizard allows you to login to providers that only support VPN. Wizard +------------------- * In the wizard log in / sign up page, the username field gets deselected. * The list of providers should have icons, be sortable, filterable. * The wizard should look more pretty. Main window +------------------- * UI doesn't subscribe to events yet, won't get updated if user has logged out via the command line interface. diff --git a/docs/mail-hacking.rst b/docs/mail/hacking.rst index 6c49c211..27087e52 100644 --- a/docs/mail-hacking.rst +++ b/docs/mail/hacking.rst @@ -1,14 +1,14 @@ .. _hacking: -======== -Hacking -======== +Hacking on Bitmask Mail +======================== Some hints oriented to `leap.mail` hackers. These notes are mostly related to the imap server, although they probably will be useful for other pieces too. Don't panic! Just manhole into it -================================= +--------------------------------- + If you want to inspect the objects living in your application memory, in realtime, you can manhole into it. @@ -29,7 +29,8 @@ Did I mention how *awesome* twisted is?? ``:)`` Profiling -========= +---------- + If using ``twistd`` to launch the server, you can use twisted profiling capabities:: @@ -44,16 +45,9 @@ commands:: LEAP_PROFILE_IMAPCMD=1 bitmask --debug -Offline mode -============ - -The client has an ``--offline`` flag that will make the Mail services (imap, -currently) not try to sync with remote replicas. Very useful during development, -although you need to login with the remote server at least once before being -able to use it. Mutt config -=========== +------------ You cannot live without mutt? You're lucky! Use the following minimal config with the imap service:: @@ -65,30 +59,10 @@ with the imap service:: set imap_pass=MAHSIKRET -Running the service with twistd -=============================== - -In order to run the mail service (currently, the imap server only), you will -need a config with this info:: - - [leap_mail] - userid = "user@provider" - uuid = "deadbeefdeadabad" - passwd = "foobar" # Optional - -In the ``LEAP_MAIL_CONFIG`` enviroment variable. If you do not specify a password -parameter, you'll be prompted for it. -In order to get the user uid (uuid), look into the -``~/.config/leap/leap-backend.conf`` file after you have logged in into your -provider at least once. - -Run the twisted service:: - - LEAP_MAIL_CONFIG=~/.leapmailrc twistd -n -y imap-server.tac - -Now you can telnet into your local IMAP server and read your mail like a real -programmer™:: +Debugging IMAP +------------------------------ +After IMAP service is running, you can telnet into your local IMAP server and read your mail like a real programmer™:: % telnet localhost 1984 Trying 127.0.0.1... @@ -112,6 +86,20 @@ Although you probably prefer to use ``offlineimap`` for tests:: offlineimap -c LEAPofflineimapRC-tests +Use ``ngrep`` to obtain live logs of the commands and responses:: + + sudo ngrep -d lo -W byline port 1984 + + +Thunderbird +--------------------------- + +To get verbose output from thunderbird/icedove, set the following environment +variable:: + + NSPR_LOG_MODULES="imap:5" icedove + + Minimal offlineimap configuration --------------------------------- @@ -182,14 +170,4 @@ running:: You can find several message samples in the ``leap/mail/tests`` folder. -Debugging IMAP commands -======================= -Use ``ngrep`` to obtain logs of the commands:: - - sudo ngrep -d lo -W byline port 1984 - -To get verbose output from thunderbird/icedove, set the following environment -variable:: - - NSPR_LOG_MODULES="imap:5" icedove diff --git a/docs/mail/index.rst b/docs/mail/index.rst new file mode 100644 index 00000000..22bdcf4d --- /dev/null +++ b/docs/mail/index.rst @@ -0,0 +1,88 @@ +:LastChangedDate: $LastChangedDate$ +:LastChangedRevision: $LastChangedRevision$ +:LastChangedBy: $LastChangedBy$ + +.. _mail: + +Bitmask Mail +================================ +*decentralized and secure mail delivery and synchronization* + +This is the documentation for the ``leap.mail`` module. It is a `twisted`_ +module, hanging from the ``leap.bitmask`` namespace, that allows to receive, process, send and access existing messages using the `LEAP`_ platform. + +One way to use this library is to let it launch two standard mail services, +``smtp`` and ``imap``, that run as local proxies and interact with a remote +``LEAP`` provider that offers *a soledad syncronization endpoint* and receives +the outgoing email. This is what `Bitmask`_ client does. + +From the mail release 0.4.0 on, it's also possible to use a protocol-agnostic email +public API, so that third party mail clients can manipulate the data layer. This +is what the awesome MUA in the `Pixelated`_ project is using. + +From release 0.10 on, the Bitmask Bundles will also ship a branded version of +the Pixelated User Agent, that will be served locally. This will be one of the +recommended ways of accessing the user emails. The other will be Thunderbird, by +using the `Bitmask Thunderbird Extension`_. + +Note that this used to be a standalone python package, under the ``leap.mail`` +namespace. It was merged into bitmask repo, so it now lives in the +``leap.bitmask.mail`` namespace. The `legacy repo`_ will no longer be updated. + +.. _`twisted`: https://twistedmatrix.com/trac/ +.. _`LEAP`: https://leap.se/en/docs +.. _`Bitmask`: https://bitmask.net/en/features#email +.. _`Pixelated`: https://pixelated-project.org/ +.. _`legacy repo`: https://github.com/leapcode/leap_mail/ +.. _`Bitmask Thunderbird Extension`: https://addons.mozilla.org/en-US/thunderbird/addon/bitmask/ + +How does Bitmask Mail work? +---------------------------- + +All the underlying data storage and sync is handled by a library called +`soledad`_, which handles encryption, storage and sync. Based on `u1db`_, +documents are stored locally as local ``sqlcipher`` tables, and syncs against +the soledad sync service in the provider. + +OpenPGP key generation and keyring management are handled by another leap +python library: `keymanager`_. + +See :ref:`the life cycle of a leap email <mail_journey>` for an overview of the life cycle +of an email through ``LEAP`` providers. + +.. _`Soledad`: https://leap.se/en/docs/design/soledad +.. _`u1db`: https://en.wikipedia.org/wiki/U1DB +.. _`keymanager`: https://github.com/leapcode/keymanager/ + +The life cycle of a LEAP Email +------------------------------ + +For a better picture, you are invited to read about :ref:`the whole journey of a mail in the LEAP system <journey>`. + + +Data model +-------------------- + +.. TODO clear document types documentation. + +The data model at the present moment consists of several *document types* that split email into different documents that are stored in ``Soledad``. The idea behind this is to +keep clear the separation between *mutable* and *inmutable* parts, and still being able to +reconstruct arbitrarily nested email structures easily. + +Authentication +--------------------- +Currently, IMAP and SMTP are twisted services that are binded to ``localhost``. These services be initialized by the bitmask.core daemon, but they are not tied to any user session. When an use attempts to log in to those services, a ``twisted.cred`` pluggable authentication plugin will try to lookup a ``mail token`` that is stored inside the soledad encrypted storage. + + + + +Mail development resources +-------------------------- + +Some old notes that might help you while developing or debugging bitmask mail +issues. + +.. toctree:: + + hacking + diff --git a/docs/mail-journey.rst b/docs/mail/journey.rst index 7e64f186..20fdf465 100644 --- a/docs/mail-journey.rst +++ b/docs/mail/journey.rst @@ -1,7 +1,13 @@ -.. _mail_journey: +:LastChangedDate: $LastChangedDate$ +:LastChangedRevision: $LastChangedRevision$ +:LastChangedBy: $LastChangedBy$ + +.. _journey: + The life cycle of a LEAP Email ============================== + The following are just some notes to facilitate the understanding of the leap.mail internals to developers and collaborators. diff --git a/docs/release_checklist.wiki b/docs/release_checklist.wiki deleted file mode 100644 index 95ff2204..00000000 --- a/docs/release_checklist.wiki +++ /dev/null @@ -1,90 +0,0 @@ -= Bitmask Release Checklist = - - == CI check == - * [ ] Check that all tests are passing! - * [ ] Fix any broken tests. - - == Version bumps and Tagging == - * [ ] Update pkg/next-release - * [ ] Update release-notes.rst in leap.bitmask if needed. - * [ ] Update version in bitmask_client/pkg/linux/bitmask-root if needed. - - * [ ] Tag everything. Should be done for the following packages, in order: - * [ ] 1. leap.common - * [ ] 2. leap.keymanager - * [ ] 3. leap.soledad - * [ ] 4. leap.mail - * [ ] 5. leap.bitmask - * [ ] 6. leap.mx - - * NOTE: It's assumed that origin is the leap.se repo - - * [ ] git fetch origin - * [ ] git tag -l, and see the latest tagged version (unless it's not a minor version bump, in which case, just bump to it) - * [ ] export version: export RELEASE=0.9.0 - * [ ] git checkout `release/0.9.x` - - NOTE: the release branch is created when the first release candidate - is tagged, after that the bugfixes and features that are meant to be - shipped with the specific version that we are targetting are merged in that branch - * [ ] git checkout -b release/$RELEASE (this is a LOCAL branch, never published). - * [ ] (maybe) cherry-pick specific commits - * [ ] (maybe) add special fixes for this release - - * [ ] Review pkg/requirements.pip for everything, update if needed (that's why the order). - - See whatever has been introduced in changes/VERSION_COMPAT - - Reset changes/VERSION_COMPAT - - Bump all the leap-requirements altogether. - * [ ] git commit -am "Update requirements file" - - * [ ] Merge changes/next-changelog.rst into the CHANGELOG - - NOTE: in leap.soledad, 3 sections (common, client, server). - * [ ] reset changes/next-changelog.rst - * [ ] git commit -S -m "[pkg] Update changelog" - - * [ ] git tag --sign $RELEASE -m "Tag version $RELEASE" - - * If everything went ok, push the changes, and merge back into master&develop: - * [ ] git checkout release/0.9.x && git merge $RELEASE - * [ ] git push origin release/0.9.x - * [ ] git push origin $RELEASE - * [ ] git checkout master && git pull origin master && git merge --no-edit $RELEASE - * [ ] git checkout develop && git merge $RELEASE && git push origin develop - - == Bundles == - * [ ] Build and upload bundles - * [ ] Use 'make pyinst-linux' to build bundles. - * [ ] Sign: make pyinst-sign - * [ ] Upload bundle and signature to downloads.leap.se/client/<os>/Bitmask-<os>-<ver>.(tar.bz2,dmg,zip) - * [ ] make pyinst-upload - * [ ] Update symbolic link for latest upload and signature: - * [ ] ~/public/client/Bitmask-<os>-latest - * [ ] ~/public/client/Bitmask-<os>-latest.asc - - === TUF: Relese candidate bundles: RC# (skipped for now) === - * [ ] Upload the TUF unstable repo - * [ ] Upload bundle to staging for release-candidate - * [ ] Sign the bundles, move it to client downloads (micah) - * [ ] Update symlinks for -latest - * [ ] Fix all show stoppers - - === TUF: Stable bundles (skipped for now) === - * [ ] Upload the TUF Stable Repo to staging - * [ ] Upload bundle to staging for stable - * [ ] move and sign the TUF repo (kwadro) - * [ ] Sign the bundles, move it to client downloads (micah) - * [ ] Update symlinks for -latest - - == Debian packages == - * TBD... - - == Pypi upload == - * [ ] python setup.py sdist upload --sign -i kali@leap.se -r pypi - - == Announcing == - * [ ] Announce (use release-notes.rst) - * [ ] Mail leap@lists.riseup.net - * [ ] Twitter - * [ ] Gnusocial - * [ ] Post in leap.se - * [ ] reddit - * [ ] hackernews diff --git a/docs/testing-rcs.README b/docs/testing/index.rst index b0340f0a..1adedbad 100644 --- a/docs/testing-rcs.README +++ b/docs/testing/index.rst @@ -1,5 +1,25 @@ +:LastChangedDate: $LastChangedDate$ +:LastChangedRevision: $LastChangedRevision$ +:LastChangedBy: $LastChangedBy$ + +.. _qa: + +Testing and Reporting +================================ + +Reporting bugs +-------------------------------- + +* Bug reports go into our `Issue Tracker`_. +* `Here`_ is some very good read about what constitutes a `good bug report`_. +* Have also a look at the :ref:`Known Issues <issues>` page. + +.. _`Issue Tracker`: https://leap.se/code +.. _`Here`: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html +.. _`good bug report`: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html + Tips for QA ------------- +-------------------------------- From time to time, we'll ask the community for help testing a new alpha release or a release candidate. Normally, we'll offer a link for the download of a @@ -9,27 +29,26 @@ bugs. If you want to give a hand in this process, please follow the following tips: -- Focus all your efforts, if possible, on whatever is *the* golden distro at - the time of the release. This currently is: Ubuntu 14.04.x LTS, 64bits, with -Unity as the default desktop environment. +* Focus all your efforts, if possible, on whatever is *the* golden distro at + the time of the release. This currently is: Ubuntu 16.04.x LTS, 64bits, with + Unity as the default desktop environment. It's very important to have a reference environment as bug-free as possible, before trying to solve issues that are present in other distributions or window managers. -- Identify all issues that need help in the QA phase. You can do that going to +* Identify all issues that need help in the QA phase. You can do that going to the bug tracker, and filtering all the issues for a given release that are in the QA state. -- If the issue is solved in your tests for this alpha release, please add a +* If the issue is solved in your tests for this alpha release, please add a comment to the issue stating the results of your tests, and the platform and desktop environment in which your tests took place. But please do not change the QA status on the issue. We generally leave this role to the author of the original issue, or to the person playing the role of the release QA master. -- Always test with a newly created account (specially relevant when testing +* Always test with a newly created account (specially relevant when testing email candidates) -- Always test with the reference Mail User Agent (currently, Thunderbird, in +* Always test with the reference Mail User Agent (currently, Thunderbird, in whatever version is present in the reference distribution). -- Remove also any thunderbird configuration, start a freshly configured account. -- If you find a new bug, please make sure that it hasn't already been reported +* Remove also any thunderbird configuration, start a freshly configured account. +* If you find a new bug, please make sure that it hasn't already been reported in the issue tracker. If you are absolutely certain that you have found a new bug, please attach a log of a new bitmask session, which should contain *only* the behaviour needed to reproduce the bug you are reporting. - diff --git a/pkg/branding/bitmask-logo.svg b/pkg/branding/bitmask-logo.svg new file mode 100644 index 00000000..0eccc057 --- /dev/null +++ b/pkg/branding/bitmask-logo.svg @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg xmlns="http://www.w3.org/2000/svg" version="1.1" id="Layer_1" x="0px" y="0px" viewBox="30.4 627.3 612 171.1" enable-background="new 30.4 627.3 612 171.1" xml:space="preserve"> +<g> + <path fill="#3E3B38" d="m 233.99276,705.92697 q 3.69186,0 5.59865,-1.90576 1.90679,-1.90575 1.90679,-5.62198 0,-3.66857 -1.90679,-5.57433 -1.90679,-1.95339 -5.59865,-1.95339 l -8.64139,0 0,15.05546 8.64139,0 z m 0.52741,31.11145 q 4.70611,0 7.05917,-2.33455 2.39362,-2.33456 2.39362,-7.0513 0,-4.62145 -2.35305,-6.90836 -2.35306,-2.33455 -7.09974,-2.33455 l -9.1688,0 0,18.62876 9.1688,0 z m 14.52403,-25.58477 q 5.03067,1.71519 7.78943,6.33664 2.75875,4.62146 2.75875,11.33924 0,10.29108 -5.92321,15.34132 -5.92321,5.05026 -18.01304,5.05026 l -25.92418,0 0,-71.1323 23.44941,0 q 12.61725,0 18.25646,4.47852 5.67979,4.47853 5.67979,14.34081 0,5.19318 -2.06906,8.86176 -2.06906,3.62093 -6.00435,5.38375 z" /> + <path fill="#3E3B38" d="m 263.627,678.38881 15.61943,0 0,71.1323 -15.61943,0 0,-71.1323 z" /> + <path fill="#3E3B38" d="m 282.6846,678.38881 55.82421,0 0,13.86437 -20.08211,0 0,57.26793 -15.61943,0 0,-57.26793 -20.12267,0 0,-13.86437 z" /> + <path fill="#3E3B38" d="m 341.82528,678.38881 19.87926,0 13.79377,38.06745 13.87492,-38.06745 19.83869,0 0,71.1323 -14.76745,0 0,-52.02711 -13.95605,38.35332 -9.89906,0 -13.95606,-38.35332 0,52.02711 -14.80802,0 0,-71.1323 z" /> + <path fill="#3E3B38" d="m 456.62789,736.56198 -24.42309,0 -3.85415,12.95913 -15.70056,0 22.43518,-71.1323 18.62158,0 22.43517,71.1323 -15.70055,0 -3.81358,-12.95913 z m -20.52838,-13.19736 16.5931,0 -8.27627,-28.30046 -8.31683,28.30046 z" /> + <path fill="#3E3B38" d="m 521.57008,680.62807 0,15.05547 q -4.9901,-2.62042 -9.73679,-3.95445 -4.74667,-1.33402 -8.96595,-1.33402 -5.59865,0 -8.27626,1.81046 -2.67762,1.81047 -2.67762,5.62198 0,2.85863 1.78509,4.47852 1.82563,1.57225 6.57232,2.71571 l 6.65347,1.57225 q 10.1019,2.38219 14.36175,7.24186 4.25984,4.85968 4.25984,13.81672 0,11.76804 -5.96378,17.53295 -5.92321,5.71726 -18.13476,5.71726 -5.76093,0 -11.56242,-1.28638 -5.8015,-1.28638 -11.603,-3.81151 l 0,-15.48426 q 5.8015,3.62093 11.1973,5.47904 5.43637,1.81047 10.46704,1.81047 5.11181,0 7.83,-2.00104 2.71818,-2.00104 2.71818,-5.71727 0,-3.33507 -1.86622,-5.14554 -1.82565,-1.81046 -7.34316,-3.23977 l -6.04491,-1.57226 q -9.08767,-2.2869 -13.30694,-7.28951 -4.1787,-5.00261 -4.1787,-13.48321 0,-10.62458 5.84207,-16.34184 5.84207,-5.71728 16.79595,-5.71728 4.9901,0 10.26419,0.90524 5.27409,0.85759 10.91331,2.62041 z" /> + <path fill="#3E3B38" d="m 529.68237,678.38881 15.61942,0 0,25.96591 22.51631,-25.96591 18.13475,0 -29.16977,33.68421 32.17195,37.44809 -19.55471,0 -24.09853,-28.01459 0,28.01459 -15.61942,0 0,-71.1323 z" /> + <path fill="#3E3B38" d="m 105.9,627.20077 -75.5,42.70117 0,85.79883 75.5,42.69922 75.5,-42.69922 0,-85.79883 -75.5,-42.70117 z m -32.06836,63.70508 -0.002,0.0976 c 4.21029,0.3754 7.67856,2.66948 11.22851,4.17579 5.587227,2.37079 9.140367,5.17357 14.253907,6.73437 2.529723,0.7722 4.122153,0.59681 5.978523,0.63281 l 0.004,0 c -0.008,-2e-4 0.0371,3e-4 0.0527,0 1.85774,-0.0365 3.45562,0.13969 5.98632,-0.63281 5.11354,-1.5608 8.66863,-4.36357 14.25586,-6.73437 3.80753,-1.61561 7.50206,-4.16896 12.14063,-4.25196 2.62211,-0.0472 5.77411,0.4276 7.9082,2.5918 4.02062,4.0774 5.05182,10.36502 4.81836,15.70312 -0.31466,7.1947 -3.34042,14.43571 -7.94726,19.91211 -3.21011,3.8161 -7.79539,7.87699 -13.29102,8.05469 -4.31698,0.1397 -7.55863,-3.15065 -10.25195,-5.24805 -2.24435,-1.7478 -5.32382,-3.79215 -8.14453,-4.96875 -2.7399,-1.1429 -5.50339,-1.15234 -5.49219,-1.15234 l -0.002,0 -0.0137,0 -0.004,0 c 0.0694,3e-4 -2.74684,0.01 -5.486333,1.15234 -2.8212,1.1768 -5.90485,3.22155 -8.14844,4.96875 -2.6927,2.0969 -5.929147,5.38775 -10.246087,5.24805 -5.49562,-0.1777 -10.08285,-4.23859 -13.29297,-8.05469 -4.60683,-5.4764 -7.63261,-12.71741 -7.94727,-19.91211 -0.23346,-5.3381 0.79774,-11.62572 4.81836,-15.70312 1.99925,-2.0275 4.90008,-2.56866 7.40625,-2.59766 l 1.41797,-0.0156 z m 2.22852,16.40625 c -0.40471,0.008 -0.79685,0.0358 -1.18555,0.0898 -0.93568,0.1303 -2.80387,1.0037 -4.26953,1.875 -0.62959,0.3742 -1.14469,0.71251 -1.58789,1.00781 0.35713,0.6424 0.85002,1.5059 1.42578,2.4375 1.16857,1.8908 2.74114,4.05049 3.72656,4.83789 4.74234,3.695 13.045167,4.66926 19.001957,-0.43554 0.83821,-0.6427 1.5034,-1.21185 2.08593,-1.71485 -1.06931,-0.6782 -2.15957,-1.38346 -3.21875,-2.00586 -2.49446,-1.4657 -4.73528,-3.08627 -7.113277,-3.95507 -2.99838,-1.0955 -6.05879,-2.18772 -8.86523,-2.13672 z m 58.22265,0 c -2.72231,0.0254 -5.66946,1.08042 -8.56054,2.13672 -2.37801,0.8688 -4.61882,2.48927 -7.11328,3.95507 -1.05934,0.6224 -2.15146,1.32766 -3.22071,2.00586 0.58205,0.5028 1.24645,1.07235 2.08399,1.71485 1.98552,1.5232 4.5424,3.12162 6.22851,3.51562 4.73565,1.1065 8.46108,0.36762 12.77539,-3.08008 0.98542,-0.7874 2.55996,-2.94904 3.72852,-4.83984 0.57576,-0.9316 1.06865,-1.79315 1.42578,-2.43555 -0.4432,-0.2953 -0.95829,-0.63361 -1.58789,-1.00781 -1.46565,-0.8713 -3.33385,-1.7447 -4.26953,-1.875 -0.48446,-0.067 -0.98075,-0.0898 -1.49024,-0.0898 z" /> +</g> +<polygon id="clock1" fill="#3E3B38" points="105.8,657.8 105.8,628 105.8,627.3 181.4,669.9 152.5,683.1 " /> +<polygon id="clock2" fill="#3E3B38" points="152.5,683.1 181.4,669.9 181.4,755.7 152.5,743 " /> +<polygon id="clock3" fill="#3E3B38" points="105.9,798.3 105.9,769 152.5,743 181.4,755.7 " /> +<polygon id="clock4" fill="#3E3B38" points="58.7,743.1 105.9,769 105.9,798.3 30.4,755.7 " /> +<polygon id="clock5" fill="#3E3B38" points="30.4,669.9 58.6,683.1 58.7,743.1 30.4,755.7 " /> +<polygon id="clock6" fill="#3E3B38" points="105.8,628 105.8,657.8 58.6,683.1 30.4,669.9 105.8,627.3 " /> +</svg>
\ No newline at end of file diff --git a/pkg/branding/bitmask-sidebar.png b/pkg/branding/bitmask-sidebar.png Binary files differnew file mode 100644 index 00000000..76ab6b7b --- /dev/null +++ b/pkg/branding/bitmask-sidebar.png |
