487bb31d45
* Relax CSP to allow iframe assets to load * Integrate socket.io proxy * go to /# when controllers not initiated * Add offline caching using AppCache manifest
4.5 KiB
Whiteout Mail 
Whiteout Mail is an easy to use email client with integrated OpenPGP encryption written in pure JavaScript. Download the official version under whiteout.io.
Features
You can read about product features and our future roadmap in our FAQ.
Privacy and Security
We take the privacy of your data very seriously. Here are some of the technical details:
-
Messages are encrypted end-to-end using the OpenPGP standard. This means that only you and the recipient can read your mail. Your messages and private PGP key are stored encrypted on your computer.
-
Users have the option to use encrypted private key sync if they want to use Whiteout on multiple devices.
-
Like most native email clients whiteout mail uses raw TCP sockets to communicate directly with your mail server via IMAP/SMTP.
-
The app is deployed as a Chrome Packaged App with auditable static versions in order to prevent problems with host-based security.
-
Content Security Policy (CSP) is enforced to prevent injection attacks.
-
HTML mails are sanitized with DOMPurify and are rendered in a sandboxed iframe.
-
Displaying mail images is optional and opt-in by default.
Reporting bugs and feature requests
-
We will launch a bug bounty program later on for independant security researchers. If you find any security vulnerabilities, don't hesitate to contact us security@whiteout.io.
-
You can also just create an issue on GitHub if you're missing a feature or just want to give us feedback. It would be much appreciated!
Testing
You can download a prebuilt bundle under releases or build your own from source (requires node.js, grunt and sass):
npm install && npm test
This will download all dependencies, run the tests and build the Chrome Packaged App bundle DEV.zip which can be installed under chrome://extensions in developer mode.
Development
For development you can start a connect dev server:
grunt dev
Then visit http://localhost:8580/dist/#/desktop?dev=true for front-end code or http://localhost:8580/test/unit/ to test JavaScript changes. You can also start a watch task so you don't have rebuild everytime you make a change:
grunt watch
Releasing Chrome App
grunt release-test --release=0.0.0.x
grunt release-stable --release=0.x.0
Deploying Web App
First build and generate the dist/ directory:
grunt
Then deploy that directoy by adding it to a local git branch. Push that branch to your node.js server and then start the server:
npm start
License
Copyright © 2014, Whiteout Networks GmbH. All rights reserved.
The code is open for inspection and peer review by the security community.
The code is currently not licensed under an open source license. If you're
interested in contributing or getting a license, please get in touch with
us (info@whiteout.io).
Third party libraries
We work together with existing open source projects wherever possible and contribute any changes we make back upstream. Many of theses libraries are licensed under an open source license. Here are some of them:
- OpenPGP.js (LGPL license): An implementation of OpenPGP in Javascript
- email.js (MIT license): IMAP, SMTP, MIME-building and MIME-parsing engine
- Forge (BSD license): An implementation of TLS in JavaScript