@protontech/openpgp 4.10.6 → 5.4.0

package/README.md

@@ -1,28 +1,26 @@
-OpenPGP.js [![Build Status](https://travis-ci.org/openpgpjs/openpgpjs.svg?branch=master)](https://travis-ci.org/openpgpjs/openpgpjs) [![BrowserStack Status](https://automate.browserstack.com/badge.svg?badge_key=eEkxVVM1TytwOGJNWEdnTjk4Y0VNUUNyR3pXcEtJUGRXOVFBRjVNT1JpUT0tLTZYUlZaMWdtQWs4Z0ROS3grRXc2bFE9PQ==--4a9cac0d6ea009d81aff66de0dbb239edd1aef3c)](https://automate.browserstack.com/public-build/eEkxVVM1TytwOGJNWEdnTjk4Y0VNUUNyR3pXcEtJUGRXOVFBRjVNT1JpUT0tLTZYUlZaMWdtQWs4Z0ROS3grRXc2bFE9PQ==--4a9cac0d6ea009d81aff66de0dbb239edd1aef3c) [![Join the chat on Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/openpgpjs/openpgpjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+OpenPGP.js [![BrowserStack Status](https://automate.browserstack.com/badge.svg?badge_key=N1l2eHFOanVBMU9wYWxJM3ZnWERnc1lidkt5UkRqa3BralV3SWVhOGpGTT0tLVljSjE4Z3dzVmdiQjl6RWgxb2c3T2c9PQ==--5864052cd523f751b6b907d547ac9c4c5f88c8a3)](https://automate.browserstack.com/public-build/N1l2eHFOanVBMU9wYWxJM3ZnWERnc1lidkt5UkRqa3BralV3SWVhOGpGTT0tLVljSjE4Z3dzVmdiQjl6RWgxb2c3T2c9PQ==--5864052cd523f751b6b907d547ac9c4c5f88c8a3) [![Join the chat on Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/openpgpjs/openpgpjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 ==========
 
-[OpenPGP.js](https://openpgpjs.org/) is a JavaScript implementation of the OpenPGP protocol. This is defined in [RFC 4880](https://tools.ietf.org/html/rfc4880).
+[OpenPGP.js](https://openpgpjs.org/) is a JavaScript implementation of the OpenPGP protocol. It implements [RFC4880](https://tools.ietf.org/html/rfc4880) and parts of [RFC4880bis](https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-10).
 
-<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again -->
 **Table of Contents**
 
 - [OpenPGP.js](#openpgpjs)
     - [Platform Support](#platform-support)
     - [Performance](#performance)
     - [Getting started](#getting-started)
-        - [Npm](#npm)
-        - [Bower](#bower)
+        - [Node.js](#nodejs)
+        - [Deno (experimental)](#deno-experimental)
+        - [Browser (webpack)](#browser-webpack)
+        - [Browser (plain files)](#browser-plain-files)
     - [Examples](#examples)
-        - [Set up](#set-up)
         - [Encrypt and decrypt *Uint8Array* data with a password](#encrypt-and-decrypt-uint8array-data-with-a-password)
         - [Encrypt and decrypt *String* data with PGP keys](#encrypt-and-decrypt-string-data-with-pgp-keys)
-        - [Encrypt with compression](#encrypt-with-compression)
+        - [Encrypt symmetrically with compression](#encrypt-symmetrically-with-compression)
         - [Streaming encrypt *Uint8Array* data with a password](#streaming-encrypt-uint8array-data-with-a-password)
         - [Streaming encrypt and decrypt *String* data with PGP keys](#streaming-encrypt-and-decrypt-string-data-with-pgp-keys)
         - [Generate new key pair](#generate-new-key-pair)
         - [Revoke a key](#revoke-a-key)
-        - [Lookup public key on HKP server](#lookup-public-key-on-hkp-server)
-        - [Upload public key to HKP server](#upload-public-key-to-hkp-server)
         - [Sign and verify cleartext messages](#sign-and-verify-cleartext-messages)
         - [Create and verify *detached* signatures](#create-and-verify-detached-signatures)
         - [Streaming sign and verify *Uint8Array* data](#streaming-sign-and-verify-uint8array-data)
@@ -32,17 +30,12 @@ OpenPGP.js [![Build Status](https://travis-ci.org/openpgpjs/openpgpjs.svg?branch
     - [Development](#development)
     - [How do I get involved?](#how-do-i-get-involved)
     - [License](#license)
-    - [Resources](#resources)
-
-<!-- markdown-toc end -->
 
 ### Platform Support
 
-* The `dist/openpgp.min.js` bundle works well with recent versions of Chrome, Firefox, Safari and Edge. It also works in Node.js 8+.
-
-* The `dist/compat/openpgp.min.js` bundle also works with Internet Explorer 11 and old versions of Safari. Please note that this bundle overwrites the global `Promise` with a polyfill version even in some cases where it already exists, which may cause issues. It also adds some built-in prototype functions if they don't exist, such as `Array.prototype.includes`.
+* The `dist/openpgp.min.js` bundle works well with recent versions of Chrome, Firefox, Safari and Edge.
 
-* If you wish, you could even load one or the other depending on which browser the user is using. However, if you're using the Web Worker, keep in mind that you also need to pass `{ path: 'compat/openpgp.worker.min.js' }` to `initWorker` whenever you load `compat/openpgp.min.js`.
+* The `dist/node/openpgp.min.js` bundle works well in Node.js. It is used by default when you `require('openpgp')` in Node.js.
 
 * Currently, Chrome, Safari and Edge have partial implementations of the
 [Streams specification](https://streams.spec.whatwg.org/), and Firefox
@@ -60,119 +53,150 @@ library to convert back and forth between them.
 
 ### Performance
 
-* Version 3.0.0 of the library introduces support for public-key cryptography using [elliptic curves](https://wiki.gnupg.org/ECC). We use native implementations on browsers and Node.js when available or [Elliptic](https://github.com/indutny/elliptic) otherwise. Elliptic curve cryptography provides stronger security per bits of key, which allows for much faster operations. Currently the following curves are supported (* = when available):
+* Version 3.0.0 of the library introduces support for public-key cryptography using [elliptic curves](https://wiki.gnupg.org/ECC). 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:
 
+    | Curve           | Encryption | Signature | NodeCrypto | WebCrypto | Constant-Time     |
+    |:---------------:|:----------:|:---------:|:----------:|:---------:|:-----------------:|
+    | curve25519      | ECDH       | N/A       | No         | No        | Algorithmically** |
+    | ed25519         | N/A        | EdDSA     | No         | No        | Algorithmically** |
+    | p256            | ECDH       | ECDSA     | Yes*       | Yes*      | If native***      |
+    | p384            | ECDH       | ECDSA     | Yes*       | Yes*      | If native***      |
+    | p521            | ECDH       | ECDSA     | Yes*       | Yes*      | If native***      |
+    | brainpoolP256r1 | ECDH       | ECDSA     | Yes*       | No        | If native***      |
+    | brainpoolP384r1 | ECDH       | ECDSA     | Yes*       | No        | If native***      |
+    | brainpoolP512r1 | ECDH       | ECDSA     | Yes*       | No        | If native***      |
+    | secp256k1       | ECDH       | ECDSA     | Yes*       | No        | If native***      |
 
-    | Curve           | Encryption | Signature | Elliptic | NodeCrypto | WebCrypto |
-    |:--------------- |:----------:|:---------:|:--------:|:----------:|:---------:|
-    | p256            | ECDH       | ECDSA     | Yes      | Yes*       | Yes*      |
-    | p384            | ECDH       | ECDSA     | Yes      | Yes*       | Yes*      |
-    | p521            | ECDH       | ECDSA     | Yes      | Yes*       | Yes*      |
-    | secp256k1       | ECDH       | ECDSA     | Yes      | Yes*       | No        |
-    | brainpoolP256r1 | ECDH       | ECDSA     | Yes      | Yes*       | No        |
-    | brainpoolP384r1 | ECDH       | ECDSA     | Yes      | Yes*       | No        |
-    | brainpoolP512r1 | ECDH       | ECDSA     | Yes      | Yes*       | No        |
-    | curve25519      | ECDH       | N/A       | Yes      | No         | No        |
-    | ed25519         | N/A        | EdDSA     | Yes      | No         | No        |
+   \* when available  
+   \** the curve25519 and ed25519 implementations are algorithmically constant-time, but may not be constant-time after optimizations of the JavaScript compiler  
+   \*** these curves are only constant-time if the underlying native implementation is available and constant-time
 
 * 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.
 
-* If the user's browser supports [native WebCrypto](https://caniuse.com/#feat=cryptography) via the `window.crypto.subtle` API, this will be used. Under Node.js the native [crypto module](https://nodejs.org/api/crypto.html#crypto_crypto) is used. This can be deactivated by setting `openpgp.config.use_native = false`.
+* If the user's browser supports [native WebCrypto](https://caniuse.com/#feat=cryptography) via the `window.crypto.subtle` API, this will be used. Under Node.js the native [crypto module](https://nodejs.org/api/crypto.html#crypto_crypto) is used.
 
-* The library implements the [IETF proposal](https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-07) 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. **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.** You can enable it by setting `openpgp.config.aead_protect = true`.
+* The library implements the [IETF proposal](https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-10) 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. **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.** You can enable it by setting `openpgp.config.aeadProtect = true`.
 
   You can change the AEAD mode by setting one of the following options:
 
   ```
-  openpgp.config.aead_mode = openpgp.enums.aead.eax // Default, native
-  openpgp.config.aead_mode = openpgp.enums.aead.ocb // Non-native
-  openpgp.config.aead_mode = openpgp.enums.aead.experimental_gcm // **Non-standard**, fastest
+  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
   ```
 
-* For environments that don't provide native crypto, the library falls back to [asm.js](https://caniuse.com/#feat=asmjs) implementations of AES, SHA-1, and SHA-256. We use [Rusha](https://github.com/srijs/rusha) and [asmCrypto Lite](https://github.com/openpgpjs/asmcrypto-lite) (a minimal subset of asmCrypto.js built specifically for OpenPGP.js).
+* For environments that don't provide native crypto, the library falls back to [asm.js](https://caniuse.com/#feat=asmjs) implementations of AES, SHA-1, and SHA-256.
 
 
 ### Getting started
 
-#### Npm
+#### Node.js
 
-    npm install --save openpgp
+Install OpenPGP.js using npm and save it in your dependencies:
 
-#### Bower
-
-    bower install --save openpgp
+```sh
+npm install --save openpgp
+```
 
-Or just fetch a minified build under [dist](https://github.com/openpgpjs/openpgpjs/tree/master/dist).
+And import it as a CommonJS module:
 
+```js
+const openpgp = require('openpgp');
+```
 
-### Examples
+Or as an ES6 module, from an .mjs file:
 
-Here are some examples of how to use the v2.x+ API. For more elaborate examples and working code, please check out the [public API unit tests](https://github.com/openpgpjs/openpgpjs/blob/master/test/general/openpgp.js). If you're upgrading from v1.x it might help to check out the [documentation](https://github.com/openpgpjs/openpgpjs#documentation).
+```js
+import * as openpgp from 'openpgp';
+```
 
-#### Set up
+#### Deno (experimental)
 
-##### Node.js
+Import as an ES6 module, using /dist/openpgp.mjs.
 
 ```js
-const openpgp = require('openpgp');
+import * as openpgp from './openpgpjs/dist/openpgp.mjs';
 ```
 
-##### Browser
+#### Browser (webpack)
 
-Copy `dist/openpgp.min.js` or `dist/compat/openpgp.min.js` (depending on the browser support you need, see [Platform Support](#platform-support)) to your project folder, and load it in a script tag:
+Install OpenPGP.js using npm and save it in your devDependencies:
 
-```html
-<script src="openpgp.min.js"></script>
+```sh
+npm install --save-dev openpgp
 ```
 
-If you want to use the built-in Web Worker, to offload cryptographic operations off the main thread:
+And import it as an ES6 module:
 
 ```js
-await openpgp.initWorker({ path: 'openpgp.worker.js' }); // set the relative web worker path
+import * as openpgp from 'openpgp';
 ```
 
-On logout, be sure to destroy the worker again, to clear private keys from memory:
+You can also only import the functions you need, as follows:
 
 ```js
-await openpgp.destroyWorker();
+import { readMessage, decrypt } from 'openpgp';
 ```
 
-Alternatively, you can also implement a Web Worker in your application and load OpenPGP.js from there. This can be more performant if you store or fetch keys and messages directly inside the Worker, so that they don't have to be `postMessage`d there.
-
-If you want to use the lightweight build (which is smaller, and lazily loads non-default curves on demand), copy `dist/lightweight/openpgp.min.js` and `dist/lightweight/elliptic.min.js`, load the former in a script tag, and point `openpgp.config.indutny_elliptic_path` to the latter:
+Or, if you want to use the lightweight build (which is smaller, and lazily loads non-default curves on demand):
 
-```html
-<script src="lightweight/openpgp.min.js"></script>
-<script>
-openpgp.config.indutny_elliptic_path = 'lightweight/elliptic.min.js';
-</script>
+```js
+import * as openpgp from 'openpgp/lightweight';
 ```
 
-To test whether the lazy loading works, try:
+To test whether the lazy loading works, try to generate a key with a non-standard curve:
 
 ```js
-await openpgp.generateKey({ curve: 'brainpoolP512r1',  userIds: [{ name: 'Test', email: 'test@test.com' }] });
+import { generateKey } from 'openpgp/lightweight';
+await generateKey({ curve: 'brainpoolP512r1',  userIDs: [{ name: 'Test', email: 'test@test.com' }] });
 ```
 
 For more examples of how to generate a key, see [Generate new key pair](#generate-new-key-pair). It is recommended to use `curve25519` instead of `brainpoolP512r1` by default.
 
+
+#### Browser (plain files)
+
+Grab `openpgp.min.js` from [unpkg.com/openpgp/dist](https://unpkg.com/openpgp/dist/), and load it in a script tag:
+
+```html
+<script src="openpgp.min.js"></script>
+```
+
+Or, to load OpenPGP.js as an ES6 module, grab `openpgp.min.mjs` from [unpkg.com/openpgp/dist](https://unpkg.com/openpgp/dist/), and import it as follows:
+
+```html
+<script type="module">
+import * as openpgp from './openpgp.min.mjs';
+</script>
+```
+
+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 `test/worker/worker_example.js`.
+
+### Examples
+
+Here are some examples of how to use OpenPGP.js v5. For more elaborate examples and working code, please check out the [public API unit tests](https://github.com/openpgpjs/openpgpjs/blob/main/test/general/openpgp.js). If you're upgrading from v4 it might help to check out the [changelog](https://github.com/openpgpjs/openpgpjs/wiki/V5-Changelog) and [documentation](https://github.com/openpgpjs/openpgpjs#documentation).
+
 #### Encrypt and decrypt *Uint8Array* data with a password
 
-Encryption will use the algorithm specified in config.encryption_cipher (defaults to aes256), and decryption will use the algorithm used for encryption.
+Encryption will use the algorithm specified in config.preferredSymmetricAlgorithm (defaults to aes256), and decryption will use the algorithm used for encryption.
 
 ```js
 (async () => {
-    const { message } = await openpgp.encrypt({
-        message: openpgp.message.fromBinary(new Uint8Array([0x01, 0x01, 0x01])), // input as Message object
-        passwords: ['secret stuff'],                                             // multiple passwords possible
-        armor: false                                                             // don't ASCII armor (for Uint8Array output)
+    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)
     });
-    const encrypted = message.packets.write(); // get raw encrypted packets as Uint8Array
+    console.log(encrypted); // Uint8Array
 
+    const encryptedMessage = await openpgp.readMessage({
+        binaryMessage: encrypted // parse encrypted bytes
+    });
     const { data: decrypted } = await openpgp.decrypt({
-        message: await openpgp.message.read(encrypted), // parse encrypted bytes
-        passwords: ['secret stuff'],                    // decrypt with password
-        format: 'binary'                                // output as Uint8Array
+        message: encryptedMessage,
+        passwords: ['secret stuff'], // decrypt with password
+        format: 'binary' // output as Uint8Array
     });
     console.log(decrypted); // Uint8Array([0x01, 0x01, 0x01])
 })();
@@ -180,14 +204,12 @@ Encryption will use the algorithm specified in config.encryption_cipher (default
 
 #### Encrypt and decrypt *String* data with PGP keys
 
-Encryption will use the algorithm preferred by the public key (defaults to aes256 for keys generated in OpenPGP.js), and decryption will use the algorithm used for encryption.
+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.
 
 ```js
 const openpgp = require('openpgp'); // use as CommonJS, AMD, ES6 module or via window.openpgp
 
 (async () => {
-    await openpgp.initWorker({ path: 'openpgp.worker.js' }); // set the relative web worker path
-
     // put keys in backtick (``) to avoid errors caused by spaces or tabs
     const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
 ...
@@ -197,25 +219,40 @@ const openpgp = require('openpgp'); // use as CommonJS, AMD, ES6 module or via w
 -----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
     const passphrase = `yourPassphrase`; // what the private key is encrypted with
 
-    const { keys: [privateKey] } = await openpgp.key.readArmored(privateKeyArmored);
-    await privateKey.decrypt(passphrase);
+    const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
+
+    const privateKey = await openpgp.decryptKey({
+        privateKey: await openpgp.readPrivateKey({ armoredKey: privateKeyArmored }),
+        passphrase
+    });
 
-    const { data: encrypted } = await openpgp.encrypt({
-        message: openpgp.message.fromText('Hello, World!'),                 // input as Message object
-        publicKeys: (await openpgp.key.readArmored(publicKeyArmored)).keys, // for encryption
-        privateKeys: [privateKey]                                           // for signing (optional)
+    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 { data: decrypted } = await openpgp.decrypt({
-        message: await openpgp.message.readArmored(encrypted),              // parse armored message
-        publicKeys: (await openpgp.key.readArmored(publicKeyArmored)).keys, // for verification (optional)
-        privateKeys: [privateKey]                                           // for decryption
+
+    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);
+    }
 })();
 ```
 
-Encrypt with multiple public keys:
+Encrypt to multiple public keys:
 
 ```js
 (async () => {
@@ -231,49 +268,88 @@ Encrypt with multiple public keys:
 ...
 -----END PGP PRIVATE KEY BLOCK-----`;    // encrypted private key
     const passphrase = `yourPassphrase`; // what the private key is encrypted with
-    const message = 'Hello, World!';
+    const plaintext = 'Hello, World!';
 
-    const { keys: [privateKey] } = await openpgp.key.readArmored(privateKeyArmored);
-    await privateKey.decrypt(passphrase)
+    const publicKeys = await Promise.all(publicKeysArmored.map(armoredKey => openpgp.readKey({ armoredKey })));
 
-    const publicKeys = await Promise.all(publicKeysArmored.map(async (key) => {
-        return (await openpgp.key.readArmored(key)).keys[0];
-    }));
+    const privateKey = await openpgp.decryptKey({
+        privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }),
+        passphrase
+    });
 
-    const { data: encrypted } = await openpgp.encrypt({
-        message: openpgp.message.fromText(message),   // input as Message object
-        publicKeys,                                   // for encryption
-        privateKeys: [privateKey]                     // for signing (optional)
+    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-----'
 })();
 ```
 
-#### Encrypt with compression
+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 `expectSigned = true`, so that the decryption operation will fail if no valid signature is found:
+```js
+(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!'
+})();
+```
 
-By default, `encrypt` will not use any compression. It's possible to override that behavior in two ways:
+#### Encrypt symmetrically with compression
 
-Either set the `compression` parameter in the options object when calling `encrypt`.
+By default, `encrypt` will not use any compression when encrypting symmetrically only (i.e. when no `encryptionKeys` are given).
+It's possible to change that behaviour by enabling compression through the config, either for the single encryption:
 
 ```js
 (async () => {
+    const message = await openpgp.createMessage({ binary: new Uint8Array([0x01, 0x02, 0x03]) }); // or createMessage({ text: 'string' })
     const encrypted = await openpgp.encrypt({
-        message: openpgp.message.fromBinary(new Uint8Array([0x01, 0x02, 0x03])), // or .fromText('string')
-        passwords: ['secret stuff'],                                             // multiple passwords possible
-        compression: openpgp.enums.compression.zip                               // compress the data with zip
+        message,
+        passwords: ['secret stuff'], // multiple passwords possible
+        config: { preferredCompressionAlgorithm: openpgp.enums.compression.zlib } // compress the data with zlib
     });
 })();
 ```
 
-Or, override the config to enable compression:
-
+or by changing the default global configuration:
 ```js
-openpgp.config.compression = openpgp.enums.compression.zlib;
+openpgp.config.preferredCompressionAlgorithm = openpgp.enums.compression.zlib
 ```
 
 Where the value can be any of:
  * `openpgp.enums.compression.zip`
  * `openpgp.enums.compression.zlib`
+ * `openpgp.enums.compression.uncompressed` (default)
+
 
 
 #### Streaming encrypt *Uint8Array* data with a password
@@ -287,33 +363,29 @@ Where the value can be any of:
         }
     });
 
-    const { message } = await openpgp.encrypt({
-        message: openpgp.message.fromBinary(readableStream), // input as Message object
-        passwords: ['secret stuff'],                         // multiple passwords possible
-        armor: false                                         // don't ASCII armor (for Uint8Array output)
+    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)
     });
-    const encrypted = message.packets.write(); // get raw encrypted packets as ReadableStream<Uint8Array>
+    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:
-    const reader = openpgp.stream.getReader(encrypted);
-    while (true) {
-        const { done, value } = await reader.read();
-        if (done) break;
-        console.log('new chunk:', value); // Uint8Array
+    for await (const chunk of encrypted) {
+        console.log('new chunk:', chunk); // Uint8Array
     }
-
-    // Or, in Node.js, you can pipe the above stream as follows:
-    const nodeStream = openpgp.stream.webToNode(encrypted);
-    nodeStream.pipe(nodeWritableStream);
 })();
 ```
 
-For more information on creating ReadableStreams, see [the MDN Documentation on `new
-ReadableStream()`](https://developer.mozilla.org/docs/Web/API/ReadableStream/ReadableStream).
-For more information on reading streams using `openpgp.stream`, see the documentation of
-[the web-stream-tools dependency](https://openpgpjs.org/web-stream-tools/), particularly
-its [Reader class](https://openpgpjs.org/web-stream-tools/Reader.html).
+For more information on using ReadableStreams, see [the MDN Documentation on the
+Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API).
+
+You can also pass a [Node.js `Readable`
+stream](https://nodejs.org/api/stream.html#stream_class_stream_readable), in
+which case OpenPGP.js will return a Node.js `Readable` stream as well, which you
+can `.pipe()` to a `Writable` stream, for example.
 
 
 #### Streaming encrypt and decrypt *String* data with PGP keys
@@ -323,13 +395,17 @@ its [Reader class](https://openpgpjs.org/web-stream-tools/Reader.html).
     const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
 ...
 -----END PGP PUBLIC KEY BLOCK-----`; // Public key
-    const [privateKeyArmored] = `-----BEGIN PGP PRIVATE KEY BLOCK-----
+    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 privateKey = (await openpgp.key.readArmored([privateKeyArmored])).keys[0];
-    await privateKey.decrypt(passphrase);
+    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) {
@@ -339,53 +415,64 @@ its [Reader class](https://openpgpjs.org/web-stream-tools/Reader.html).
     });
 
     const encrypted = await openpgp.encrypt({
-        message: openpgp.message.fromText(readableStream),                  // input as Message object
-        publicKeys: (await openpgp.key.readArmored(publicKeyArmored)).keys, // for encryption
-        privateKeys: [privateKey]                                           // for signing (optional)
+        message: await openpgp.createMessage({ text: readableStream }), // input as Message object
+        encryptionKeys: publicKey,
+        signingKeys: privateKey // optional
     });
-    const ciphertext = encrypted.data; // ReadableStream containing '-----BEGIN PGP MESSAGE ... END PGP MESSAGE-----'
+    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: await openpgp.message.readArmored(ciphertext),             // parse armored message
-        publicKeys: (await openpgp.key.readArmored(publicKeyArmored)).keys, // for verification (optional)
-        privateKeys: [privateKey]                                           // for decryption
+        message,
+        verificationKeys: publicKey, // optional
+        decryptionKeys: privateKey
     });
-    const plaintext = await openpgp.stream.readToEnd(decrypted.data); // 'Hello, World!'
+    const chunks = [];
+    for await (const chunk of decrypted.data) {
+        chunks.push(chunk);
+    }
+    const plaintext = chunks.join('');
+    console.log(plaintext); // 'Hello, World!'
 })();
 ```
 
 
 #### Generate new key pair
 
-ECC keys:
+ECC keys (smaller and faster to generate):
 
-Possible values for `curve` are: `curve25519`, `ed25519`, `p256`, `p384`, `p521`, `secp256k1`,
-`brainpoolP256r1`, `brainpoolP384r1`, or `brainpoolP512r1`.
+Possible values for `curve` are: `curve25519`, `ed25519`, `p256`, `p384`, `p521`,
+`brainpoolP256r1`, `brainpoolP384r1`, `brainpoolP512r1`, and `secp256k1`.
 Note that both the `curve25519` and `ed25519` options generate a primary key for signing using Ed25519
 and a subkey for encryption using Curve25519.
 
 ```js
 (async () => {
-    const { privateKeyArmored, publicKeyArmored, revocationCertificate } = await openpgp.generateKey({
-        userIds: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs
-        curve: 'ed25519',                                           // ECC curve name
-        passphrase: 'super long and hard to guess secret'           // protects the private key
+    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(privateKeyArmored);     // '-----BEGIN PGP PRIVATE KEY BLOCK ... '
-    console.log(publicKeyArmored);      // '-----BEGIN PGP PUBLIC KEY BLOCK ... '
+    console.log(privateKey);     // '-----BEGIN PGP PRIVATE KEY BLOCK ... '
+    console.log(publicKey);      // '-----BEGIN PGP PUBLIC KEY BLOCK ... '
     console.log(revocationCertificate); // '-----BEGIN PGP PUBLIC KEY BLOCK ... '
 })();
 ```
 
-RSA keys:
+RSA keys (increased compatibility):
 
 ```js
 (async () => {
-    const key = await openpgp.generateKey({
-        userIds: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs
-        rsaBits: 4096,                                              // RSA key size
-        passphrase: 'super long and hard to guess secret'           // protects the private key
+    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
     });
 })();
 ```
@@ -395,9 +482,10 @@ RSA keys:
 Using a revocation certificate:
 ```js
 (async () => {
-    const { publicKeyArmored: revokedKeyArmored } = await openpgp.revokeKey({
-        key: (await openpgp.key.readArmored(publicKeyArmored)).keys[0],
-        revocationCertificate
+    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 ... '
 })();
@@ -406,36 +494,11 @@ Using a revocation certificate:
 Using the private key:
 ```js
 (async () => {
-    const { publicKeyArmored, publicKey } = await openpgp.revokeKey({
-        key: (await openpgp.key.readArmored(privateKeyArmored)).keys[0]
+    const { publicKey: revokedKeyArmored } = await openpgp.revokeKey({
+        key: await openpgp.readKey({ armoredKey: privateKeyArmored }),
+        format: 'armored' // output armored keys
     });
-})();
-```
-
-#### Lookup public key on HKP server
-
-```js
-(async () => {
-    var hkp = new openpgp.HKP(); // Defaults to https://keyserver.ubuntu.com, or pass another keyserver URL as a string
-
-    let publicKeyArmored = await hkp.lookup({
-        query: 'alice@example.com'
-    });
-    var { keys: [publicKey] } = await openpgp.key.readArmored(publicKeyArmored);
-})();
-```
-
-#### Upload public key to HKP server
-
-```js
-(async () => {
-    var hkp = new openpgp.HKP('https://pgp.mit.edu');
-
-    var publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
-...
------END PGP PUBLIC KEY BLOCK-----`;
-
-    await hkp.upload(publicKeyArmored);
+    console.log(revokedKeyArmored); // '-----BEGIN PGP PUBLIC KEY BLOCK ... '
 })();
 ```
 
@@ -451,24 +514,33 @@ Using the private key:
 -----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
     const passphrase = `yourPassphrase`; // what the private key is encrypted with
 
-    const { keys: [privateKey] } = await openpgp.key.readArmored(privateKeyArmored);
-    await privateKey.decrypt(passphrase);
+    const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
+
+    const privateKey = await openpgp.decryptKey({
+        privateKey: await openpgp.readPrivateKey({ armoredKey: privateKeyArmored }),
+        passphrase
+    });
 
-    const { data: cleartext } = await openpgp.sign({
-        message: openpgp.cleartext.fromText('Hello, World!'), // CleartextMessage or Message object
-        privateKeys: [privateKey]                             // for signing
+    const unsignedMessage = await openpgp.createCleartextMessage({ text: 'Hello, World!' });
+    const cleartextMessage = await openpgp.sign({
+        message: unsignedMessage, // CleartextMessage or Message object
+        signingKeys: privateKey
     });
-    console.log(cleartext); // '-----BEGIN PGP SIGNED MESSAGE ... END PGP SIGNATURE-----'
+    console.log(cleartextMessage); // '-----BEGIN PGP SIGNED MESSAGE ... END PGP SIGNATURE-----'
 
-    const verified = await openpgp.verify({
-        message: await openpgp.cleartext.readArmored(cleartext),           // parse armored message
-        publicKeys: (await openpgp.key.readArmored(publicKeyArmored)).keys // for verification
+    const signedMessage = await openpgp.readCleartextMessage({
+        cleartextMessage // parse armored message
     });
-    const { valid } = verified.signatures[0];
-    if (valid) {
-        console.log('signed by key id ' + verified.signatures[0].keyid.toHex());
-    } else {
-        throw new Error('signature could not be verified');
+    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);
     }
 })();
 ```
@@ -485,26 +557,35 @@ Using the private key:
 -----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
     const passphrase = `yourPassphrase`; // what the private key is encrypted with
 
-    const { keys: [privateKey] } = await openpgp.key.readArmored(privateKeyArmored);
-    await privateKey.decrypt(passphrase);
+    const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
+
+    const privateKey = await openpgp.decryptKey({
+        privateKey: await openpgp.readPrivateKey({ armoredKey: privateKeyArmored }),
+        passphrase
+    });
 
-    const { signature: detachedSignature } = await openpgp.sign({
-        message: openpgp.cleartext.fromText('Hello, World!'), // CleartextMessage or Message object
-        privateKeys: [privateKey],                            // for signing
+    const message = await openpgp.createMessage({ text: 'Hello, World!' });
+    const detachedSignature = await openpgp.sign({
+        message, // Message object
+        signingKeys: privateKey,
         detached: true
     });
     console.log(detachedSignature);
 
-    const verified = await openpgp.verify({
-        message: openpgp.cleartext.fromText('Hello, World!'),              // CleartextMessage or Message object
-        signature: await openpgp.signature.readArmored(detachedSignature), // parse detached signature
-        publicKeys: (await openpgp.key.readArmored(publicKeyArmored)).keys // for verification
+    const signature = await openpgp.readSignature({
+        armoredSignature: detachedSignature // parse detached signature
     });
-    const { valid } = verified.signatures[0];
-    if (valid) {
-        console.log('signed by key id ' + verified.signatures[0].keyid.toHex());
-    } else {
-        throw new Error('signature could not be verified');
+    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);
     }
 })();
 ```
@@ -528,39 +609,40 @@ Using the private key:
 -----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
     const passphrase = `yourPassphrase`; // what the private key is encrypted with
 
-    const { keys: [privateKey] } = await openpgp.key.readArmored(privateKeyArmored);
-    await privateKey.decrypt(passphrase);
+    const privateKey = await openpgp.decryptKey({
+        privateKey: await openpgp.readPrivateKey({ armoredKey: privateKeyArmored }),
+        passphrase
+    });
 
-    const { data: signatureArmored } = await openpgp.sign({
-        message: openpgp.message.fromBinary(readableStream),  // or .fromText(readableStream: ReadableStream<String>)
-        privateKeys: [privateKey]                             // for signing
+    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 verified = await openpgp.verify({
-        message: await openpgp.message.readArmored(signatureArmored),       // parse armored signature
-        publicKeys: (await openpgp.key.readArmored(publicKeyArmored)).keys  // for verification
+    const verificationResult = await openpgp.verify({
+        message: await openpgp.readMessage({ armoredMessage: signatureArmored }), // parse armored signature
+        verificationKeys: await openpgp.readKey({ armoredKey: publicKeyArmored })
     });
 
-    await openpgp.stream.readToEnd(verified.data);
-    // Note: you *have* to read `verified.data` in some way or other,
+    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.
 
-    const { valid } = verified.signatures[0];
-    if (valid) {
-        console.log('signed by key id ' + verified.signatures[0].keyid.toHex());
-    } else {
-        throw new Error('signature could not be verified');
+    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);
     }
 })();
 ```
 
 ### Documentation
 
-A jsdoc build of our code comments is available at [doc/index.html](https://openpgpjs.org/openpgpjs/doc/index.html). Public calls should generally be made through the OpenPGP object [doc/openpgp.html](https://openpgpjs.org/openpgpjs/doc/module-openpgp.html).
-
-For the documentation of `openpgp.stream`, see the documentation of [the web-stream-tools dependency](https://openpgpjs.org/web-stream-tools/).
+The full documentation is available at [openpgpjs.org](https://docs.openpgpjs.org/).
 
 ### Security Audit
 
@@ -578,9 +660,9 @@ To create your own build of the library, just run the following command after cl
 
     npm install && npm test
 
-For debugging browser errors, you can open `test/unittests.html` in a browser or, after running the following command, open [`http://localhost:3000/test/unittests.html`](http://localhost:3000/test/unittests.html):
+For debugging browser errors, you can run `npm start` and open [`http://localhost:8080/test/unittests.html`](http://localhost:8080/test/unittests.html) in a browser, or run the following command:
 
-    grunt browsertest
+    npm run browsertest
 
 ### How do I get involved?
 
@@ -589,13 +671,3 @@ You want to help, great! It's probably best to send us a message on [Gitter](htt
 ### License
 
 [GNU Lesser General Public License](https://www.gnu.org/licenses/lgpl-3.0.en.html) (3.0 or any later version). Please take a look at the [LICENSE](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.
-
-* [https://www.hanewin.net/encrypt/](https://www.hanewin.net/encrypt/)
-* [https://github.com/seancolyer/gmail-crypt](https://github.com/seancolyer/gmail-crypt)
-* [https://github.com/mete0r/jspg](https://github.com/mete0r/jspg)
-* [https://github.com/GPGTools/Mobile/wiki/Introduction](https://github.com/GPGTools/Mobile/wiki/Introduction)
-* [https://github.com/gmontalvoriv/mailock](https://github.com/gmontalvoriv/mailock)