mail/README.md

44 lines
2.7 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 05:27:48 -05:00
Whiteout Mail is a mail client with full IMAP, SMTP, TLS and OpenPGP support written in pure JavaScript. The Client is distributed as a [Chrome Packaged App](https://developer.chrome.com/apps/about_apps.html) since it requires [TCP sockets](http://developer.chrome.com/apps/socket.html). Download the official version under [whiteout.io](http://whiteout.io).
### Security
2014-01-16 05:30:04 -05:00
* The app is deployed as an auditable packaged app with static versions in order to prevent [problems with host-based security](http://tonyarcieri.com/whats-wrong-with-webcrypto).
2014-01-16 05:27:48 -05:00
* [Content Securit Policy (CSP)](http://www.html5rocks.com/en/tutorials/security/content-security-policy/) is enforced to prevent against injection attacks.
* The code is still under heavy development and is yet not recommended for production use. That being said, we have done multiple code audits and penetration tests (which will be published as soon as 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
* We will launch a bug bounty program later on the compensate security researchers. If you find any security vulnerabilites, don't hesitate to contact us [security@whiteout.io](mailto:security@whiteout.io).
2014-01-16 05:39:35 -05:00
* You can also just create an [issue](https://github.com/whiteout-io/mail-html5/issues) if you're missing a feature or just want to give us feedback.
2014-01-16 05:38:32 -05:00
### Testing
2014-01-15 11:57:18 -05:00
2014-01-15 12:01:17 -05:00
You can download a prebuilt bundle under [releases](https://github.com/whiteout-io/mail-html5/releases) or build your own:
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 05:38:32 -05:00
To run the unit tests locally run:
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 05:27:48 -05:00
Many of the libraries we use are licensed under an open source license. Here are some of the libraries we use (for a complete list please take a look at the code):
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 04:59:41 -05:00
* [node-shims](https://github.com/whiteout-io/node-shims): A basic set shims of commonly used node API for use in the browser