1
0
mirror of https://github.com/moparisthebest/mail synced 2024-11-10 11:15:01 -05:00
mail/README.md

53 lines
3.5 KiB
Markdown
Raw Normal View History

mail-html5 [![Build Status](https://travis-ci.org/whiteout-io/mail-html5.png)](https://travis-ci.org/whiteout-io/mail-html5)
2013-03-13 11:50:46 -04:00
==========
2014-01-16 06:03:14 -05:00
Whiteout Mail is an easy to use email client with integrated OpenPGP encryption written in pure JavaScript. Download the official version under [whiteout.io](http://whiteout.io).
2014-01-16 05:27:48 -05:00
2014-01-16 06:03:14 -05:00
### Privacy and Security
2014-01-16 05:27:48 -05:00
2014-01-16 06:03:14 -05:00
* We take the privacy of your data very seriously. Messages are [encrypted end-to-end ](http://en.wikipedia.org/wiki/End-to-end_encryption) using the [OpenPGP](http://en.wikipedia.org/wiki/Pretty_Good_Privacy) protocol. This means that only you and your correspondents can read your mail.
2014-01-16 06:12:13 -05:00
2014-01-16 06:06:38 -05:00
* The client talks directly via IMAP/SMTP to your mail server. Your messages and private PGP key are stored encrypted on your computer and are never sent to our our servers.
2014-01-16 06:12:13 -05:00
2014-01-16 06:08:43 -05:00
* The app is deployed as a [Chrome Packaged App](https://developer.chrome.com/apps/about_apps.html) with auditable static versions in order to prevent [problems with host-based security](http://tonyarcieri.com/whats-wrong-with-webcrypto). It uses raw [TCP sockets](http://developer.chrome.com/apps/socket.html) to communicate with the mail server.
2014-01-16 06:12:13 -05:00
* Mail server [SSL certificates are pinned](http://security.stackexchange.com/questions/29988/what-is-certificate-pinning) under [`src/ca/`](https://github.com/whiteout-io/mail-html5/tree/master/src/ca) in order to protect against SSL stripping and other man in the middle attacks.
2014-01-16 06:03:14 -05:00
* [Content Securit Policy (CSP)](http://www.html5rocks.com/en/tutorials/security/content-security-policy/) is enforced to prevent against injection attacks.
2014-01-16 06:12:13 -05:00
2014-01-16 05:45:57 -05:00
* The code is still under heavy development and is not yet recommended for production use. That being said, we have done multiple code audits and penetration tests (which will be published regularly once all reported vulnerabilities are fixed).
2013-04-01 17:23:25 -04:00
2014-01-16 05:38:32 -05:00
### Reporting bugs and feature requests
2014-01-16 06:03:14 -05:00
* We will launch a bug bounty program later on the compensate security researchers. If you find any security vulnerabilities, don't hesitate to contact us [security@whiteout.io](mailto:security@whiteout.io).
2014-01-16 06:13:03 -05:00
2014-01-16 05:45:57 -05:00
* You can also just create an [issue](https://github.com/whiteout-io/mail-html5/issues) on GitHub if you're missing a feature or just want to give us feedback. It would be much appreciated!
2014-01-16 05:38:32 -05:00
### Testing
2014-01-15 11:57:18 -05:00
2014-01-16 06:03:14 -05:00
You can download a prebuilt bundle under [releases](https://github.com/whiteout-io/mail-html5/releases) or build your own from source:
2013-04-01 17:23:25 -04:00
2014-01-15 11:28:58 -05:00
npm install && grunt
2013-04-01 17:23:25 -04:00
2014-01-15 12:02:29 -05:00
This builds the Chrome Packaged App bundle **DEV.zip** which can be installed under [chrome://extensions](chrome://extensions) in developer mode.
2014-01-15 11:48:15 -05:00
2014-01-16 06:03:14 -05:00
Run the unit tests locally:
2014-01-16 05:02:52 -05:00
npm test
2014-01-15 11:48:15 -05:00
## License
2014-01-16 04:59:41 -05:00
Copyright © 2013, Whiteout Networks GmbH. All rights reserved.
2014-01-16 05:02:52 -05:00
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
2014-01-16 05:04:39 -05:00
us (info@whiteout.io).
2014-01-16 04:59:41 -05:00
2014-01-16 06:17:17 -05:00
Many of the libraries we use are licensed under an open source license. Here are some of them:
2014-01-16 04:59:41 -05:00
2014-01-16 05:00:46 -05:00
* [OpenPGP.js](http://openpgpjs.org): An implementation of OpenPGP in Javascript
2014-01-16 04:59:41 -05:00
* [Inbox](https://github.com/andris9/inbox): Simple IMAP client for node.js
* [Nodemailer](http://www.nodemailer.com): SMTP client for node.js
2014-01-16 05:00:46 -05:00
* [Forge](https://github.com/digitalbazaar/forge): An implementation of TLS in Javascript
2014-01-16 06:22:02 -05:00
* [node-shims](https://github.com/whiteout-io/node-shims): Shims for wrapping node's net/tls (TCP socket) APIs around chrome.socket