723 lines
38 KiB
HTML
723 lines
38 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<title>JSDoc: Home</title>
|
||
|
||
<script src="scripts/prettify/prettify.js"> </script>
|
||
<script src="scripts/prettify/lang-css.js"> </script>
|
||
<!--[if lt IE 9]>
|
||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||
<![endif]-->
|
||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||
</head>
|
||
|
||
<body>
|
||
|
||
<div id="main">
|
||
|
||
<h1 class="page-title">Home</h1>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3> </h3>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<section>
|
||
<article><h1 id="openpgp.js">OpenPGP.js <a href="https://automate.browserstack.com/public-build/N1l2eHFOanVBMU9wYWxJM3ZnWERnc1lidkt5UkRqa3BralV3SWVhOGpGTT0tLVljSjE4Z3dzVmdiQjl6RWgxb2c3T2c9PQ==--5864052cd523f751b6b907d547ac9c4c5f88c8a3"><img src="https://automate.browserstack.com/badge.svg?badge_key=N1l2eHFOanVBMU9wYWxJM3ZnWERnc1lidkt5UkRqa3BralV3SWVhOGpGTT0tLVljSjE4Z3dzVmdiQjl6RWgxb2c3T2c9PQ==--5864052cd523f751b6b907d547ac9c4c5f88c8a3" alt="BrowserStack Status"></a> <a href="https://gitter.im/openpgpjs/openpgpjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join the chat on Gitter"></a></h1>
|
||
<p><a href="https://openpgpjs.org/">OpenPGP.js</a> is a JavaScript implementation of the OpenPGP protocol. It implements <a href="https://tools.ietf.org/html/rfc4880">RFC4880</a> and parts of <a href="https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-10">RFC4880bis</a>.</p>
|
||
<p><strong>Table of Contents</strong></p>
|
||
<ul>
|
||
<li><a href="#openpgpjs">OpenPGP.js</a>
|
||
<ul>
|
||
<li><a href="#platform-support">Platform Support</a></li>
|
||
<li><a href="#performance">Performance</a></li>
|
||
<li><a href="#getting-started">Getting started</a>
|
||
<ul>
|
||
<li><a href="#nodejs">Node.js</a></li>
|
||
<li><a href="#deno-experimental">Deno (experimental)</a></li>
|
||
<li><a href="#browser-webpack">Browser (webpack)</a></li>
|
||
<li><a href="#browser-plain-files">Browser (plain files)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#examples">Examples</a>
|
||
<ul>
|
||
<li><a href="#encrypt-and-decrypt-uint8array-data-with-a-password">Encrypt and decrypt <em>Uint8Array</em> data with a password</a></li>
|
||
<li><a href="#encrypt-and-decrypt-string-data-with-pgp-keys">Encrypt and decrypt <em>String</em> data with PGP keys</a></li>
|
||
<li><a href="#encrypt-symmetrically-with-compression">Encrypt symmetrically with compression</a></li>
|
||
<li><a href="#streaming-encrypt-uint8array-data-with-a-password">Streaming encrypt <em>Uint8Array</em> data with a password</a></li>
|
||
<li><a href="#streaming-encrypt-and-decrypt-string-data-with-pgp-keys">Streaming encrypt and decrypt <em>String</em> data with PGP keys</a></li>
|
||
<li><a href="#generate-new-key-pair">Generate new key pair</a></li>
|
||
<li><a href="#revoke-a-key">Revoke a key</a></li>
|
||
<li><a href="#sign-and-verify-cleartext-messages">Sign and verify cleartext messages</a></li>
|
||
<li><a href="#create-and-verify-detached-signatures">Create and verify <em>detached</em> signatures</a></li>
|
||
<li><a href="#streaming-sign-and-verify-uint8array-data">Streaming sign and verify <em>Uint8Array</em> data</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#documentation">Documentation</a></li>
|
||
<li><a href="#security-audit">Security Audit</a></li>
|
||
<li><a href="#security-recommendations">Security recommendations</a></li>
|
||
<li><a href="#development">Development</a></li>
|
||
<li><a href="#how-do-i-get-involved">How do I get involved?</a></li>
|
||
<li><a href="#license">License</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id="platform-support">Platform Support</h3>
|
||
<ul>
|
||
<li>
|
||
<p>The <code>dist/openpgp.min.js</code> bundle works well with recent versions of Chrome, Firefox, Safari and Edge.</p>
|
||
</li>
|
||
<li>
|
||
<p>The <code>dist/node/openpgp.min.js</code> bundle works well in Node.js. It is used by default when you <code>require('openpgp')</code> in Node.js.</p>
|
||
</li>
|
||
<li>
|
||
<p>Currently, Chrome, Safari and Edge have partial implementations of the
|
||
<a href="https://streams.spec.whatwg.org/">Streams specification</a>, and Firefox
|
||
has a partial implementation behind feature flags. Chrome is the only
|
||
browser that implements <code>TransformStream</code>s, which we need, so we include
|
||
a <a href="https://github.com/MattiasBuelens/web-streams-polyfill">polyfill</a> for
|
||
all other browsers. Please note that in those browsers, the global
|
||
<code>ReadableStream</code> property gets overwritten with the polyfill version if
|
||
it exists. In some edge cases, you might need to use the native
|
||
<code>ReadableStream</code> (for example when using it to create a <code>Response</code>
|
||
object), in which case you should store a reference to it before loading
|
||
OpenPGP.js. There is also the
|
||
<a href="https://github.com/MattiasBuelens/web-streams-adapter">web-streams-adapter</a>
|
||
library to convert back and forth between them.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id="performance">Performance</h3>
|
||
<ul>
|
||
<li>
|
||
<p>Version 3.0.0 of the library introduces support for public-key cryptography using <a href="https://wiki.gnupg.org/ECC">elliptic curves</a>. We use native implementations on browsers and Node.js when available. Elliptic curve cryptography provides stronger security per bits of key, which allows for much faster operations. Currently the following curves are supported:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:center">Curve</th>
|
||
<th style="text-align:center">Encryption</th>
|
||
<th style="text-align:center">Signature</th>
|
||
<th style="text-align:center">NodeCrypto</th>
|
||
<th style="text-align:center">WebCrypto</th>
|
||
<th style="text-align:center">Constant-Time</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:center">curve25519</td>
|
||
<td style="text-align:center">ECDH</td>
|
||
<td style="text-align:center">N/A</td>
|
||
<td style="text-align:center">No</td>
|
||
<td style="text-align:center">No</td>
|
||
<td style="text-align:center">Algorithmically**</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:center">ed25519</td>
|
||
<td style="text-align:center">N/A</td>
|
||
<td style="text-align:center">EdDSA</td>
|
||
<td style="text-align:center">No</td>
|
||
<td style="text-align:center">No</td>
|
||
<td style="text-align:center">Algorithmically**</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:center">p256</td>
|
||
<td style="text-align:center">ECDH</td>
|
||
<td style="text-align:center">ECDSA</td>
|
||
<td style="text-align:center">Yes*</td>
|
||
<td style="text-align:center">Yes*</td>
|
||
<td style="text-align:center">If native***</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:center">p384</td>
|
||
<td style="text-align:center">ECDH</td>
|
||
<td style="text-align:center">ECDSA</td>
|
||
<td style="text-align:center">Yes*</td>
|
||
<td style="text-align:center">Yes*</td>
|
||
<td style="text-align:center">If native***</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:center">p521</td>
|
||
<td style="text-align:center">ECDH</td>
|
||
<td style="text-align:center">ECDSA</td>
|
||
<td style="text-align:center">Yes*</td>
|
||
<td style="text-align:center">Yes*</td>
|
||
<td style="text-align:center">If native***</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:center">brainpoolP256r1</td>
|
||
<td style="text-align:center">ECDH</td>
|
||
<td style="text-align:center">ECDSA</td>
|
||
<td style="text-align:center">Yes*</td>
|
||
<td style="text-align:center">No</td>
|
||
<td style="text-align:center">If native***</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:center">brainpoolP384r1</td>
|
||
<td style="text-align:center">ECDH</td>
|
||
<td style="text-align:center">ECDSA</td>
|
||
<td style="text-align:center">Yes*</td>
|
||
<td style="text-align:center">No</td>
|
||
<td style="text-align:center">If native***</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:center">brainpoolP512r1</td>
|
||
<td style="text-align:center">ECDH</td>
|
||
<td style="text-align:center">ECDSA</td>
|
||
<td style="text-align:center">Yes*</td>
|
||
<td style="text-align:center">No</td>
|
||
<td style="text-align:center">If native***</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:center">secp256k1</td>
|
||
<td style="text-align:center">ECDH</td>
|
||
<td style="text-align:center">ECDSA</td>
|
||
<td style="text-align:center">Yes*</td>
|
||
<td style="text-align:center">No</td>
|
||
<td style="text-align:center">If native***</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>* when available<br>
|
||
** the curve25519 and ed25519 implementations are algorithmically constant-time, but may not be constant-time after optimizations of the JavaScript compiler<br>
|
||
*** these curves are only constant-time if the underlying native implementation is available and constant-time</p>
|
||
</li>
|
||
<li>
|
||
<p>Version 2.x of the library has been built from the ground up with Uint8Arrays. This allows for much better performance and memory usage than strings.</p>
|
||
</li>
|
||
<li>
|
||
<p>If the user's browser supports <a href="https://caniuse.com/#feat=cryptography">native WebCrypto</a> via the <code>window.crypto.subtle</code> API, this will be used. Under Node.js the native <a href="https://nodejs.org/api/crypto.html#crypto_crypto">crypto module</a> is used.</p>
|
||
</li>
|
||
<li>
|
||
<p>The library implements the <a href="https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-10">RFC4880bis proposal</a> for authenticated encryption using native AES-EAX, OCB, or GCM. This makes symmetric encryption up to 30x faster on supported platforms. Since the specification has not been finalized and other OpenPGP implementations haven't adopted it yet, the feature is currently behind a flag. <strong>Note: activating this setting can break compatibility with other OpenPGP implementations, and also with future versions of OpenPGP.js. Don't use it with messages you want to store on disk or in a database.</strong> You can enable it by setting <code>openpgp.config.aeadProtect = true</code>.</p>
|
||
<p>You can change the AEAD mode by setting one of the following options:</p>
|
||
<pre class="prettyprint source"><code>openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.eax // Default, native
|
||
openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.ocb // Non-native
|
||
openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.experimentalGCM // **Non-standard**, fastest
|
||
</code></pre>
|
||
</li>
|
||
<li>
|
||
<p>For environments that don't provide native crypto, the library falls back to <a href="https://caniuse.com/#feat=asmjs">asm.js</a> implementations of AES, SHA-1, and SHA-256.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id="getting-started">Getting started</h3>
|
||
<h4 id="node.js">Node.js</h4>
|
||
<p>Install OpenPGP.js using npm and save it in your dependencies:</p>
|
||
<pre class="prettyprint source lang-sh"><code>npm install --save openpgp
|
||
</code></pre>
|
||
<p>And import it as a CommonJS module:</p>
|
||
<pre class="prettyprint source lang-js"><code>const openpgp = require('openpgp');
|
||
</code></pre>
|
||
<p>Or as an ES6 module, from an .mjs file:</p>
|
||
<pre class="prettyprint source lang-js"><code>import * as openpgp from 'openpgp';
|
||
</code></pre>
|
||
<h4 id="deno-(experimental)">Deno (experimental)</h4>
|
||
<p>Import as an ES6 module, using /dist/openpgp.mjs.</p>
|
||
<pre class="prettyprint source lang-js"><code>import * as openpgp from './openpgpjs/dist/openpgp.mjs';
|
||
</code></pre>
|
||
<h4 id="browser-(webpack)">Browser (webpack)</h4>
|
||
<p>Install OpenPGP.js using npm and save it in your devDependencies:</p>
|
||
<pre class="prettyprint source lang-sh"><code>npm install --save-dev openpgp
|
||
</code></pre>
|
||
<p>And import it as an ES6 module:</p>
|
||
<pre class="prettyprint source lang-js"><code>import * as openpgp from 'openpgp';
|
||
</code></pre>
|
||
<p>You can also only import the functions you need, as follows:</p>
|
||
<pre class="prettyprint source lang-js"><code>import { readMessage, decrypt } from 'openpgp';
|
||
</code></pre>
|
||
<p>Or, if you want to use the lightweight build (which is smaller, and lazily loads non-default curves on demand):</p>
|
||
<pre class="prettyprint source lang-js"><code>import * as openpgp from 'openpgp/lightweight';
|
||
</code></pre>
|
||
<p>To test whether the lazy loading works, try to generate a key with a non-standard curve:</p>
|
||
<pre class="prettyprint source lang-js"><code>import { generateKey } from 'openpgp/lightweight';
|
||
await generateKey({ curve: 'brainpoolP512r1', userIDs: [{ name: 'Test', email: 'test@test.com' }] });
|
||
</code></pre>
|
||
<p>For more examples of how to generate a key, see <a href="#generate-new-key-pair">Generate new key pair</a>. It is recommended to use <code>curve25519</code> instead of <code>brainpoolP512r1</code> by default.</p>
|
||
<h4 id="browser-(plain-files)">Browser (plain files)</h4>
|
||
<p>Grab <code>openpgp.min.js</code> from <a href="https://unpkg.com/openpgp/dist/">unpkg.com/openpgp/dist</a>, and load it in a script tag:</p>
|
||
<pre class="prettyprint source lang-html"><code><script src="openpgp.min.js"></script>
|
||
</code></pre>
|
||
<p>Or, to load OpenPGP.js as an ES6 module, grab <code>openpgp.min.mjs</code> from <a href="https://unpkg.com/openpgp/dist/">unpkg.com/openpgp/dist</a>, and import it as follows:</p>
|
||
<pre class="prettyprint source lang-html"><code><script type="module">
|
||
import * as openpgp from './openpgp.min.mjs';
|
||
</script>
|
||
</code></pre>
|
||
<p>To offload cryptographic operations off the main thread, you can implement a Web Worker in your application and load OpenPGP.js from there. For an example Worker implementation, see <code>test/worker/worker_example.js</code>.</p>
|
||
<h4 id="typescript">TypeScript</h4>
|
||
<p>Since TS is not fully integrated in the library, TS-only dependencies are currently listed as <code>devDependencies</code>, so to compile the project you’ll need to add <code>@openpgp/web-stream-tools</code> manually (NB: only versions below v0.12 are compatible with OpenPGP.js v5):</p>
|
||
<pre class="prettyprint source lang-sh"><code>npm install --save-dev @openpgp/web-stream-tools@0.0.11-patch-0
|
||
</code></pre>
|
||
<p>If you notice missing or incorrect type definitions, feel free to open a PR.</p>
|
||
<h3 id="examples">Examples</h3>
|
||
<p>Here are some examples of how to use OpenPGP.js v5. For more elaborate examples and working code, please check out the <a href="https://github.com/openpgpjs/openpgpjs/blob/main/test/general/openpgp.js">public API unit tests</a>. If you're upgrading from v4 it might help to check out the <a href="https://github.com/openpgpjs/openpgpjs/wiki/V5-Changelog">changelog</a> and <a href="https://github.com/openpgpjs/openpgpjs#documentation">documentation</a>.</p>
|
||
<h4 id="encrypt-and-decrypt-uint8array-data-with-a-password">Encrypt and decrypt <em>Uint8Array</em> data with a password</h4>
|
||
<p>Encryption will use the algorithm specified in config.preferredSymmetricAlgorithm (defaults to aes256), and decryption will use the algorithm used for encryption.</p>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
const message = await openpgp.createMessage({ binary: new Uint8Array([0x01, 0x01, 0x01]) });
|
||
const encrypted = await openpgp.encrypt({
|
||
message, // input as Message object
|
||
passwords: ['secret stuff'], // multiple passwords possible
|
||
format: 'binary' // don't ASCII armor (for Uint8Array output)
|
||
});
|
||
console.log(encrypted); // Uint8Array
|
||
|
||
const encryptedMessage = await openpgp.readMessage({
|
||
binaryMessage: encrypted // parse encrypted bytes
|
||
});
|
||
const { data: decrypted } = await openpgp.decrypt({
|
||
message: encryptedMessage,
|
||
passwords: ['secret stuff'], // decrypt with password
|
||
format: 'binary' // output as Uint8Array
|
||
});
|
||
console.log(decrypted); // Uint8Array([0x01, 0x01, 0x01])
|
||
})();
|
||
</code></pre>
|
||
<h4 id="encrypt-and-decrypt-string-data-with-pgp-keys">Encrypt and decrypt <em>String</em> data with PGP keys</h4>
|
||
<p>Encryption will use the algorithm preferred by the public (encryption) key (defaults to aes256 for keys generated in OpenPGP.js), and decryption will use the algorithm used for encryption.</p>
|
||
<pre class="prettyprint source lang-js"><code>const openpgp = require('openpgp'); // use as CommonJS, AMD, ES6 module or via window.openpgp
|
||
|
||
(async () => {
|
||
// put keys in backtick (``) to avoid errors caused by spaces or tabs
|
||
const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||
...
|
||
-----END PGP PUBLIC KEY BLOCK-----`;
|
||
const privateKeyArmored = `-----BEGIN PGP PRIVATE KEY BLOCK-----
|
||
...
|
||
-----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
|
||
const passphrase = `yourPassphrase`; // what the private key is encrypted with
|
||
|
||
const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
|
||
|
||
const privateKey = await openpgp.decryptKey({
|
||
privateKey: await openpgp.readPrivateKey({ armoredKey: privateKeyArmored }),
|
||
passphrase
|
||
});
|
||
|
||
const encrypted = await openpgp.encrypt({
|
||
message: await openpgp.createMessage({ text: 'Hello, World!' }), // input as Message object
|
||
encryptionKeys: publicKey,
|
||
signingKeys: privateKey // optional
|
||
});
|
||
console.log(encrypted); // '-----BEGIN PGP MESSAGE ... END PGP MESSAGE-----'
|
||
|
||
const message = await openpgp.readMessage({
|
||
armoredMessage: encrypted // parse armored message
|
||
});
|
||
const { data: decrypted, signatures } = await openpgp.decrypt({
|
||
message,
|
||
verificationKeys: publicKey, // optional
|
||
decryptionKeys: privateKey
|
||
});
|
||
console.log(decrypted); // 'Hello, World!'
|
||
// check signature validity (signed messages only)
|
||
try {
|
||
await signatures[0].verified; // throws on invalid signature
|
||
console.log('Signature is valid');
|
||
} catch (e) {
|
||
throw new Error('Signature could not be verified: ' + e.message);
|
||
}
|
||
})();
|
||
</code></pre>
|
||
<p>Encrypt to multiple public keys:</p>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
const publicKeysArmored = [
|
||
`-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||
...
|
||
-----END PGP PUBLIC KEY BLOCK-----`,
|
||
`-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||
...
|
||
-----END PGP PUBLIC KEY BLOCK-----`
|
||
];
|
||
const privateKeyArmored = `-----BEGIN PGP PRIVATE KEY BLOCK-----
|
||
...
|
||
-----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
|
||
const passphrase = `yourPassphrase`; // what the private key is encrypted with
|
||
const plaintext = 'Hello, World!';
|
||
|
||
const publicKeys = await Promise.all(publicKeysArmored.map(armoredKey => openpgp.readKey({ armoredKey })));
|
||
|
||
const privateKey = await openpgp.decryptKey({
|
||
privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }),
|
||
passphrase
|
||
});
|
||
|
||
const message = await openpgp.createMessage({ text: plaintext });
|
||
const encrypted = await openpgp.encrypt({
|
||
message, // input as Message object
|
||
encryptionKeys: publicKeys,
|
||
signingKeys: privateKey // optional
|
||
});
|
||
console.log(encrypted); // '-----BEGIN PGP MESSAGE ... END PGP MESSAGE-----'
|
||
})();
|
||
</code></pre>
|
||
<p>If you expect an encrypted message to be signed with one of the public keys you have, and do not want to trust the decrypted data otherwise, you can pass the decryption option <code>expectSigned = true</code>, so that the decryption operation will fail if no valid signature is found:</p>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
// put keys in backtick (``) to avoid errors caused by spaces or tabs
|
||
const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||
...
|
||
-----END PGP PUBLIC KEY BLOCK-----`;
|
||
const privateKeyArmored = `-----BEGIN PGP PRIVATE KEY BLOCK-----
|
||
...
|
||
-----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
|
||
const passphrase = `yourPassphrase`; // what the private key is encrypted with
|
||
|
||
const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
|
||
|
||
const privateKey = await openpgp.decryptKey({
|
||
privateKey: await openpgp.readPrivateKey({ armoredKey: privateKeyArmored }),
|
||
passphrase
|
||
});
|
||
|
||
const encryptedAndSignedMessage = `-----BEGIN PGP MESSAGE-----
|
||
...
|
||
-----END PGP MESSAGE-----`;
|
||
|
||
const message = await openpgp.readMessage({
|
||
armoredMessage: encryptedAndSignedMessage // parse armored message
|
||
});
|
||
// decryption will fail if all signatures are invalid or missing
|
||
const { data: decrypted, signatures } = await openpgp.decrypt({
|
||
message,
|
||
decryptionKeys: privateKey,
|
||
expectSigned: true,
|
||
verificationKeys: publicKey, // mandatory with expectSigned=true
|
||
});
|
||
console.log(decrypted); // 'Hello, World!'
|
||
})();
|
||
</code></pre>
|
||
<h4 id="encrypt-symmetrically-with-compression">Encrypt symmetrically with compression</h4>
|
||
<p>By default, <code>encrypt</code> will not use any compression when encrypting symmetrically only (i.e. when no <code>encryptionKeys</code> are given).
|
||
It's possible to change that behaviour by enabling compression through the config, either for the single encryption:</p>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
const message = await openpgp.createMessage({ binary: new Uint8Array([0x01, 0x02, 0x03]) }); // or createMessage({ text: 'string' })
|
||
const encrypted = await openpgp.encrypt({
|
||
message,
|
||
passwords: ['secret stuff'], // multiple passwords possible
|
||
config: { preferredCompressionAlgorithm: openpgp.enums.compression.zlib } // compress the data with zlib
|
||
});
|
||
})();
|
||
</code></pre>
|
||
<p>or by changing the default global configuration:</p>
|
||
<pre class="prettyprint source lang-js"><code>openpgp.config.preferredCompressionAlgorithm = openpgp.enums.compression.zlib
|
||
</code></pre>
|
||
<p>Where the value can be any of:</p>
|
||
<ul>
|
||
<li><code>openpgp.enums.compression.zip</code></li>
|
||
<li><code>openpgp.enums.compression.zlib</code></li>
|
||
<li><code>openpgp.enums.compression.uncompressed</code> (default)</li>
|
||
</ul>
|
||
<h4 id="streaming-encrypt-uint8array-data-with-a-password">Streaming encrypt <em>Uint8Array</em> data with a password</h4>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
const readableStream = new ReadableStream({
|
||
start(controller) {
|
||
controller.enqueue(new Uint8Array([0x01, 0x02, 0x03]));
|
||
controller.close();
|
||
}
|
||
});
|
||
|
||
const message = await openpgp.createMessage({ binary: readableStream });
|
||
const encrypted = await openpgp.encrypt({
|
||
message, // input as Message object
|
||
passwords: ['secret stuff'], // multiple passwords possible
|
||
format: 'binary' // don't ASCII armor (for Uint8Array output)
|
||
});
|
||
console.log(encrypted); // raw encrypted packets as ReadableStream<Uint8Array>
|
||
|
||
// Either pipe the above stream somewhere, pass it to another function,
|
||
// or read it manually as follows:
|
||
for await (const chunk of encrypted) {
|
||
console.log('new chunk:', chunk); // Uint8Array
|
||
}
|
||
})();
|
||
</code></pre>
|
||
<p>For more information on using ReadableStreams, see <a href="https://developer.mozilla.org/en-US/docs/Web/API/Streams_API">the MDN Documentation on the
|
||
Streams API</a>.</p>
|
||
<p>You can also pass a <a href="https://nodejs.org/api/stream.html#stream_class_stream_readable">Node.js <code>Readable</code>
|
||
stream</a>, in
|
||
which case OpenPGP.js will return a Node.js <code>Readable</code> stream as well, which you
|
||
can <code>.pipe()</code> to a <code>Writable</code> stream, for example.</p>
|
||
<h4 id="streaming-encrypt-and-decrypt-string-data-with-pgp-keys">Streaming encrypt and decrypt <em>String</em> data with PGP keys</h4>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||
...
|
||
-----END PGP PUBLIC KEY BLOCK-----`; // Public key
|
||
const privateKeyArmored = `-----BEGIN PGP PRIVATE KEY BLOCK-----
|
||
...
|
||
-----END PGP PRIVATE KEY BLOCK-----`; // Encrypted private key
|
||
const passphrase = `yourPassphrase`; // Password that private key is encrypted with
|
||
|
||
const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
|
||
|
||
const privateKey = await openpgp.decryptKey({
|
||
privateKey: await openpgp.readPrivateKey({ armoredKey: privateKeyArmored }),
|
||
passphrase
|
||
});
|
||
|
||
const readableStream = new ReadableStream({
|
||
start(controller) {
|
||
controller.enqueue('Hello, world!');
|
||
controller.close();
|
||
}
|
||
});
|
||
|
||
const encrypted = await openpgp.encrypt({
|
||
message: await openpgp.createMessage({ text: readableStream }), // input as Message object
|
||
encryptionKeys: publicKey,
|
||
signingKeys: privateKey // optional
|
||
});
|
||
console.log(encrypted); // ReadableStream containing '-----BEGIN PGP MESSAGE ... END PGP MESSAGE-----'
|
||
|
||
const message = await openpgp.readMessage({
|
||
armoredMessage: encrypted // parse armored message
|
||
});
|
||
const decrypted = await openpgp.decrypt({
|
||
message,
|
||
verificationKeys: publicKey, // optional
|
||
decryptionKeys: privateKey
|
||
});
|
||
const chunks = [];
|
||
for await (const chunk of decrypted.data) {
|
||
chunks.push(chunk);
|
||
}
|
||
const plaintext = chunks.join('');
|
||
console.log(plaintext); // 'Hello, World!'
|
||
})();
|
||
</code></pre>
|
||
<h4 id="generate-new-key-pair">Generate new key pair</h4>
|
||
<p>ECC keys (smaller and faster to generate):</p>
|
||
<p>Possible values for <code>curve</code> are: <code>curve25519</code>, <code>ed25519</code>, <code>p256</code>, <code>p384</code>, <code>p521</code>,
|
||
<code>brainpoolP256r1</code>, <code>brainpoolP384r1</code>, <code>brainpoolP512r1</code>, and <code>secp256k1</code>.
|
||
Note that both the <code>curve25519</code> and <code>ed25519</code> options generate a primary key for signing using Ed25519
|
||
and a subkey for encryption using Curve25519.</p>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
const { privateKey, publicKey, revocationCertificate } = await openpgp.generateKey({
|
||
type: 'ecc', // Type of the key, defaults to ECC
|
||
curve: 'curve25519', // ECC curve name, defaults to curve25519
|
||
userIDs: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs
|
||
passphrase: 'super long and hard to guess secret', // protects the private key
|
||
format: 'armored' // output key format, defaults to 'armored' (other options: 'binary' or 'object')
|
||
});
|
||
|
||
console.log(privateKey); // '-----BEGIN PGP PRIVATE KEY BLOCK ... '
|
||
console.log(publicKey); // '-----BEGIN PGP PUBLIC KEY BLOCK ... '
|
||
console.log(revocationCertificate); // '-----BEGIN PGP PUBLIC KEY BLOCK ... '
|
||
})();
|
||
</code></pre>
|
||
<p>RSA keys (increased compatibility):</p>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
const { privateKey, publicKey } = await openpgp.generateKey({
|
||
type: 'rsa', // Type of the key
|
||
rsaBits: 4096, // RSA key size (defaults to 4096 bits)
|
||
userIDs: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs
|
||
passphrase: 'super long and hard to guess secret' // protects the private key
|
||
});
|
||
})();
|
||
</code></pre>
|
||
<h4 id="revoke-a-key">Revoke a key</h4>
|
||
<p>Using a revocation certificate:</p>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
const { publicKey: revokedKeyArmored } = await openpgp.revokeKey({
|
||
key: await openpgp.readKey({ armoredKey: publicKeyArmored }),
|
||
revocationCertificate,
|
||
format: 'armored' // output armored keys
|
||
});
|
||
console.log(revokedKeyArmored); // '-----BEGIN PGP PUBLIC KEY BLOCK ... '
|
||
})();
|
||
</code></pre>
|
||
<p>Using the private key:</p>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
const { publicKey: revokedKeyArmored } = await openpgp.revokeKey({
|
||
key: await openpgp.readKey({ armoredKey: privateKeyArmored }),
|
||
format: 'armored' // output armored keys
|
||
});
|
||
console.log(revokedKeyArmored); // '-----BEGIN PGP PUBLIC KEY BLOCK ... '
|
||
})();
|
||
</code></pre>
|
||
<h4 id="sign-and-verify-cleartext-messages">Sign and verify cleartext messages</h4>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||
...
|
||
-----END PGP PUBLIC KEY BLOCK-----`;
|
||
const privateKeyArmored = `-----BEGIN PGP PRIVATE KEY BLOCK-----
|
||
...
|
||
-----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
|
||
const passphrase = `yourPassphrase`; // what the private key is encrypted with
|
||
|
||
const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
|
||
|
||
const privateKey = await openpgp.decryptKey({
|
||
privateKey: await openpgp.readPrivateKey({ armoredKey: privateKeyArmored }),
|
||
passphrase
|
||
});
|
||
|
||
const unsignedMessage = await openpgp.createCleartextMessage({ text: 'Hello, World!' });
|
||
const cleartextMessage = await openpgp.sign({
|
||
message: unsignedMessage, // CleartextMessage or Message object
|
||
signingKeys: privateKey
|
||
});
|
||
console.log(cleartextMessage); // '-----BEGIN PGP SIGNED MESSAGE ... END PGP SIGNATURE-----'
|
||
|
||
const signedMessage = await openpgp.readCleartextMessage({
|
||
cleartextMessage // parse armored message
|
||
});
|
||
const verificationResult = await openpgp.verify({
|
||
message: signedMessage,
|
||
verificationKeys: publicKey
|
||
});
|
||
const { verified, keyID } = verificationResult.signatures[0];
|
||
try {
|
||
await verified; // throws on invalid signature
|
||
console.log('Signed by key id ' + keyID.toHex());
|
||
} catch (e) {
|
||
throw new Error('Signature could not be verified: ' + e.message);
|
||
}
|
||
})();
|
||
</code></pre>
|
||
<h4 id="create-and-verify-detached-signatures">Create and verify <em>detached</em> signatures</h4>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||
...
|
||
-----END PGP PUBLIC KEY BLOCK-----`;
|
||
const privateKeyArmored = `-----BEGIN PGP PRIVATE KEY BLOCK-----
|
||
...
|
||
-----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
|
||
const passphrase = `yourPassphrase`; // what the private key is encrypted with
|
||
|
||
const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
|
||
|
||
const privateKey = await openpgp.decryptKey({
|
||
privateKey: await openpgp.readPrivateKey({ armoredKey: privateKeyArmored }),
|
||
passphrase
|
||
});
|
||
|
||
const message = await openpgp.createMessage({ text: 'Hello, World!' });
|
||
const detachedSignature = await openpgp.sign({
|
||
message, // Message object
|
||
signingKeys: privateKey,
|
||
detached: true
|
||
});
|
||
console.log(detachedSignature);
|
||
|
||
const signature = await openpgp.readSignature({
|
||
armoredSignature: detachedSignature // parse detached signature
|
||
});
|
||
const verificationResult = await openpgp.verify({
|
||
message, // Message object
|
||
signature,
|
||
verificationKeys: publicKey
|
||
});
|
||
const { verified, keyID } = verificationResult.signatures[0];
|
||
try {
|
||
await verified; // throws on invalid signature
|
||
console.log('Signed by key id ' + keyID.toHex());
|
||
} catch (e) {
|
||
throw new Error('Signature could not be verified: ' + e.message);
|
||
}
|
||
})();
|
||
</code></pre>
|
||
<h4 id="streaming-sign-and-verify-uint8array-data">Streaming sign and verify <em>Uint8Array</em> data</h4>
|
||
<pre class="prettyprint source lang-js"><code>(async () => {
|
||
var readableStream = new ReadableStream({
|
||
start(controller) {
|
||
controller.enqueue(new Uint8Array([0x01, 0x02, 0x03]));
|
||
controller.close();
|
||
}
|
||
});
|
||
|
||
const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||
...
|
||
-----END PGP PUBLIC KEY BLOCK-----`;
|
||
const privateKeyArmored = `-----BEGIN PGP PRIVATE KEY BLOCK-----
|
||
...
|
||
-----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
|
||
const passphrase = `yourPassphrase`; // what the private key is encrypted with
|
||
|
||
const privateKey = await openpgp.decryptKey({
|
||
privateKey: await openpgp.readPrivateKey({ armoredKey: privateKeyArmored }),
|
||
passphrase
|
||
});
|
||
|
||
const message = await openpgp.createMessage({ binary: readableStream }); // or createMessage({ text: ReadableStream<String> })
|
||
const signatureArmored = await openpgp.sign({
|
||
message,
|
||
signingKeys: privateKey
|
||
});
|
||
console.log(signatureArmored); // ReadableStream containing '-----BEGIN PGP MESSAGE ... END PGP MESSAGE-----'
|
||
|
||
const verificationResult = await openpgp.verify({
|
||
message: await openpgp.readMessage({ armoredMessage: signatureArmored }), // parse armored signature
|
||
verificationKeys: await openpgp.readKey({ armoredKey: publicKeyArmored })
|
||
});
|
||
|
||
for await (const chunk of verificationResult.data) {}
|
||
// Note: you *have* to read `verificationResult.data` in some way or other,
|
||
// even if you don't need it, as that is what triggers the
|
||
// verification of the data.
|
||
|
||
try {
|
||
await verificationResult.signatures[0].verified; // throws on invalid signature
|
||
console.log('Signed by key id ' + verificationResult.signatures[0].keyID.toHex());
|
||
} catch (e) {
|
||
throw new Error('Signature could not be verified: ' + e.message);
|
||
}
|
||
})();
|
||
</code></pre>
|
||
<h3 id="documentation">Documentation</h3>
|
||
<p>The full documentation is available at <a href="https://docs.openpgpjs.org/">openpgpjs.org</a>.</p>
|
||
<h3 id="security-audit">Security Audit</h3>
|
||
<p>To date the OpenPGP.js code base has undergone two complete security audits from <a href="https://cure53.de">Cure53</a>. The first audit's report has been published <a href="https://github.com/openpgpjs/openpgpjs/wiki/Cure53-security-audit">here</a>.</p>
|
||
<h3 id="security-recommendations">Security recommendations</h3>
|
||
<p>It should be noted that js crypto apps deployed via regular web hosting (a.k.a. <a href="https://www.schneier.com/blog/archives/2012/08/cryptocat.html"><strong>host-based security</strong></a>) provide users with less security than installable apps with auditable static versions. Installable apps can be deployed as a <a href="https://developer.mozilla.org/en-US/Marketplace/Options/Packaged_apps">Firefox</a> or <a href="https://developer.chrome.com/apps/about_apps.html">Chrome</a> packaged app. These apps are basically signed zip files and their runtimes typically enforce a strict <a href="https://www.html5rocks.com/en/tutorials/security/content-security-policy/">Content Security Policy (CSP)</a> to protect users against <a href="https://en.wikipedia.org/wiki/Cross-site_scripting">XSS</a>. This <a href="https://tankredhase.com/2014/04/13/heartbleed-and-javascript-crypto/">blogpost</a> explains the trust model of the web quite well.</p>
|
||
<p>It is also recommended to set a strong passphrase that protects the user's private key on disk.</p>
|
||
<h3 id="development">Development</h3>
|
||
<p>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 minified bundle under <code>dist/openpgp.min.js</code> to use in your project:</p>
|
||
<pre><code>npm install && npm test
|
||
</code></pre>
|
||
<p>For debugging browser errors, you can run <code>npm start</code> and open <a href="http://localhost:8080/test/unittests.html"><code>http://localhost:8080/test/unittests.html</code></a> in a browser, or run the following command:</p>
|
||
<pre><code>npm run browsertest
|
||
</code></pre>
|
||
<h3 id="how-do-i-get-involved%3F">How do I get involved?</h3>
|
||
<p>You want to help, great! It's probably best to send us a message on <a href="https://gitter.im/openpgpjs/openpgpjs">Gitter</a> before you start your undertaking, to make sure nobody else is working on it, and so we can discuss the best course of action. Other than that, just go ahead and fork our repo, make your changes and send us a pull request! :)</p>
|
||
<h3 id="license">License</h3>
|
||
<p><a href="https://www.gnu.org/licenses/lgpl-3.0.en.html">GNU Lesser General Public License</a> (3.0 or any later version). Please take a look at the <a href="LICENSE">LICENSE</a> file for more information.</p></article>
|
||
</section>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<nav>
|
||
<h2><a href="index.html">Home</a></h2><h3>Functions</h3><ul><li><a href="global.html#aes">aes</a></li><li><a href="global.html#armor">armor</a></li><li><a href="global.html#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createKey">createKey</a></li><li><a href="global.html#createMessage">createMessage</a></li><li><a href="global.html#decrypt">decrypt</a></li><li><a href="global.html#decryptKey">decryptKey</a></li><li><a href="global.html#decryptSessionKeys">decryptSessionKeys</a></li><li><a href="global.html#encrypt">encrypt</a></li><li><a href="global.html#encryptKey">encryptKey</a></li><li><a href="global.html#encryptSessionKey">encryptSessionKey</a></li><li><a href="global.html#formatObject">formatObject</a></li><li><a href="global.html#generateKey">generateKey</a></li><li><a href="global.html#generateSessionKey">generateSessionKey</a></li><li><a href="global.html#newPacketFromTag">newPacketFromTag</a></li><li><a href="global.html#readCleartextMessage">readCleartextMessage</a></li><li><a href="global.html#readKey">readKey</a></li><li><a href="global.html#readKeys">readKeys</a></li><li><a href="global.html#readMessage">readMessage</a></li><li><a href="global.html#readPrivateKey">readPrivateKey</a></li><li><a href="global.html#readPrivateKeys">readPrivateKeys</a></li><li><a href="global.html#readSignature">readSignature</a></li><li><a href="global.html#reformatKey">reformatKey</a></li><li><a href="global.html#revokeKey">revokeKey</a></li><li><a href="global.html#sign">sign</a></li><li><a href="global.html#unarmor">unarmor</a></li><li><a href="global.html#verify">verify</a></li><li><a href="global.html#wrapKeyObject">wrapKeyObject</a></li></ul><h3>Modules</h3><ul><li><a href="module-config.html">config</a></li><li><a href="module-enums.html">enums</a></li><li><a href="module-type_x25519x448_symkey.html">type/x25519x448_symkey</a></li></ul><h3>Classes</h3><ul><li><a href="AEADEncryptedDataPacket.html">AEADEncryptedDataPacket</a></li><li><a href="CleartextMessage.html">CleartextMessage</a></li><li><a href="CompressedDataPacket.html">CompressedDataPacket</a></li><li><a href="Key.html">Key</a></li><li><a href="LiteralDataPacket.html">LiteralDataPacket</a></li><li><a href="MarkerPacket.html">MarkerPacket</a></li><li><a href="Message.html">Message</a></li><li><a href="module-key_Subkey-Subkey.html">Subkey</a></li><li><a href="module-key_User-User.html">User</a></li><li><a href="module-type_kdf_params-KDFParams.html">KDFParams</a></li><li><a href="module-type_keyid-KeyID.html">KeyID</a></li><li><a href="module-type_s2k-S2K.html">S2K</a></li><li><a href="OnePassSignaturePacket.html">OnePassSignaturePacket</a></li><li><a href="PacketList.html">PacketList</a></li><li><a href="PrivateKey.html">PrivateKey</a></li><li><a href="PublicKey.html">PublicKey</a></li><li><a href="PublicKeyEncryptedSessionKeyPacket.html">PublicKeyEncryptedSessionKeyPacket</a></li><li><a href="PublicKeyPacket.html">PublicKeyPacket</a></li><li><a href="PublicSubkeyPacket.html">PublicSubkeyPacket</a></li><li><a href="SecretKeyPacket.html">SecretKeyPacket</a></li><li><a href="SecretSubkeyPacket.html">SecretSubkeyPacket</a></li><li><a href="Signature.html">Signature</a></li><li><a href="SignaturePacket.html">SignaturePacket</a></li><li><a href="SymEncryptedIntegrityProtectedDataPacket.html">SymEncryptedIntegrityProtectedDataPacket</a></li><li><a href="SymEncryptedSessionKeyPacket.html">SymEncryptedSessionKeyPacket</a></li><li><a href="SymmetricallyEncryptedDataPacket.html">SymmetricallyEncryptedDataPacket</a></li><li><a href="TrustPacket.html">TrustPacket</a></li><li><a href="UserAttributePacket.html">UserAttributePacket</a></li><li><a href="UserIDPacket.html">UserIDPacket</a></li></ul>
|
||
</nav>
|
||
|
||
<br class="clear">
|
||
|
||
<footer>
|
||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a>
|
||
</footer>
|
||
|
||
<script> prettyPrint(); </script>
|
||
<script src="scripts/linenumber.js"> </script>
|
||
</body>
|
||
</html> |