2.8 KiB
OpenPGP.js
OpenPGP.js is a Javascript implementation of the OpenPGP protocol. This is defined in RFC 4880.
Installation
Node.js
npm install openpgpjs
Browser
The library has AMD support but can also be accessed via 'window.openpgp'.
Prebuilt minified release
You can download a prebuilt minified version of the library under releases.
Build the library yourself
npm install && grunt
Then take dist/openpgp.min.js to use in your project.
#Usage It's best the check the documentation for detailed API information. There are also alot of useful examples under 'test/'.
Documentation
A jsdoc build of our code comments is available at doc/index.html. Public calls should generally be made through the OpenPGP object doc/openpgp.html.
I need some help
Mailing List
You can sign up for our mailing list and ask for help there. We've recently worked on getting our archive up and running.
How do I get involved?
You want to help, great! Go ahead and fork our repo, make your changes and make a pull request.
It is extra awesome if you write tests for the code you change. Our test coverage is relatively weak, so if you can add cases that is great.
What License do you use?
GNU Lesser General Public License (2.1). Please take a look at the LICENSE file for more information.
What are the requirements to use it?
OpenPGP.js currently only fully supports Chrome. Firefox support should be coming soon with the advent of Firefox 23 with native javascript support for window.crypto.getRandomValues. If you can help us support more browsers and situations, please chip in!
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.