64 lines
2.6 KiB
Markdown
64 lines
2.6 KiB
Markdown
OpenPGP.js
|
|
==========
|
|
|
|
[OpenPGP.js](http://openpgpjs.org/) is a Javascript implementation of the OpenPGP protocol. This is defined in [RFC 4880](http://tools.ietf.org/html/rfc4880).
|
|
|
|
[](http://travis-ci.org/openpgpjs/openpgpjs)
|
|
|
|
### Usage node.js
|
|
|
|
For server side use, install via npm:
|
|
|
|
npm install openpgpjs
|
|
|
|
Then simply:
|
|
|
|
var openpgp = require('openpgpjs);
|
|
var key = '-----BEGIN PGP PUBLIC KEY BLOCK ... END PGP PUBLIC KEY BLOCK-----';
|
|
var publicKey = openpgp.key.readArmored(key);
|
|
var pgpMessage = openpgp.encryptMessage(publicKey.keys, 'Hello, World!');
|
|
|
|
### Browser support
|
|
|
|
Fetch a minified build under [releases](https://github.com/openpgpjs/openpgpjs/releases). The library supports AMD/require.js or access via 'window.openpgp'.
|
|
|
|
OpenPGP.js currently only fully supports browsers that implement `window.crypto.getRandomValues`. If you can help us support more browsers and runtimes, please chip in!
|
|
|
|
### To build
|
|
|
|
npm install && grunt
|
|
|
|
Then take `dist/openpgp.min.js` to use in your project.
|
|
|
|
### Run tests
|
|
|
|
npm install && npm test
|
|
|
|
### Documentation
|
|
|
|
A jsdoc build of our code comments is available at [doc/index.html](doc/index.html). Public calls should generally be made through the OpenPGP object [doc/openpgp.html](doc/openpgp.html).
|
|
|
|
### Mailing List
|
|
|
|
You can [sign up](http://list.openpgpjs.org/) for our mailing list and ask for help there. We've recently worked on getting our [archive up and running](http://www.mail-archive.com/list@openpgpjs.org/).
|
|
|
|
### How do I get involved?
|
|
|
|
You want to help, great! Go ahead and fork our repo, make your changes and send us a pull request.
|
|
|
|
### License
|
|
|
|
GNU Lesser General Public License (2.1). Please take a look at the [LICENSE](LICENSE) file for more information.
|
|
|
|
### Resources
|
|
|
|
Below is a collection of resources, many of these were projects that were in someway a precursor to the current OpenPGP.js project. If you'd like to add your link here, please do so in a pull request or email to the list.
|
|
|
|
* [http://www.hanewin.net/encrypt/](http://www.hanewin.net/encrypt/)
|
|
* [https://github.com/seancolyer/gmail-crypt](https://github.com/seancolyer/gmail-crypt)
|
|
* [https://github.com/mete0r/openpgp-js](https://github.com/mete0r/openpgp-js)
|
|
* [http://fitblip.github.com/JSPGP-Stuffs/](http://fitblip.github.com/JSPGP-Stuffs/)
|
|
* [http://qooxdoo.org/contrib/project/crypto](http://qooxdoo.org/contrib/project/crypto)
|
|
* [https://github.com/GPGTools/Mobile/wiki/Introduction](https://github.com/GPGTools/Mobile/wiki/Introduction)
|
|
* [http://gpg4browsers.recurity.com/](http://gpg4browsers.recurity.com/)
|