suzanne.soy/fork-openpgpjs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #237 from alessioalex/master

Browse Source 
Update README.md to add decryption example
This commit is contained in:
Tankred Hase 2014-06-28 16:46:07 +02:00
commit f0e4128324
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -11,13 +11,25 @@ For server side use, install via npm:
npm install openpgp
Example:
Examples:
Encryption
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!');
Decryption:
var openpgp = require('openpgp');
var key = '-----BEGIN PGP PRIVATE KEY BLOCK ... END PGP PRIVATE KEY BLOCK-----';
var privateKey = openpgp.key.readArmored(key).keys[0];
privateKey.decrypt('password');
var message = '-----BEGIN PGP MESSAGE ... END PGP MESSAGE-----';
message = openpgp.message.readArmored(message);
var pgpMessage = openpgp.decryptMessage(privateKey, message);
### Browser support
Fetch a minified build under [releases](https://github.com/openpgpjs/openpgpjs/releases). The library can be loaded via AMD/require.js or accessed globally via `window.openpgp`.