openpgp

OpenPGP.js is a Javascript implementation of the OpenPGP protocol. This is defined in RFC 4880.

npm install openpgp
8 downloads in the last day
67 downloads in the last week
222 downloads in the last month

OpenPGP.js

OpenPGP.js is a Javascript implementation of the OpenPGP protocol. This is defined in RFC 4880.

Build Status

Node support

For server side use, install via npm:

npm install openpgp

Example:

var openpgp = require('openpgp');
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 can be loaded via AMD/require.js or accessed globally 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!

Security recommendations

It should be noted that js crypto apps deployed via regular web hosting (a.k.a. host-based security) provide users with less security than installable apps with auditable static versions. Installable apps can be deployed as a Firefox or Chrome packaged app. These apps are basically signed zip files and their runtimes typically enforce a strict Content Security Policy (CSP) to protect users against XSS. This blogpost explains the trust model of the web quite well.

It is also recommended to set a strong passphrase that protects the user's private key on disk.

Development

To create your own build of the library, just run the following command after cloning the git repo. This will download all dependencies, run the tests and create a minifed bundle under dist/openpgp.min.js to use in your project:

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.

npm loves you