2.6 KiB
OpenPGP.js
OpenPGP.js is a Javascript implementation of the OpenPGP protocol. This is defined in RFC 4880.
Node support
For server side use, install via npm:
npm install openpgpjs
Example:
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. 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. Public calls should generally be made through the OpenPGP object doc/openpgp.html.
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 send us a pull request.
License
GNU Lesser General Public License (2.1). Please take a look at the 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.