OpenPGP.js 
-OpenPGP.js is a JavaScript implementation of the OpenPGP protocol. It implements the crypto-refresh (superseding RFC4880 and RFC4880bis).
+OpenPGP.js
+OpenPGP.js is a JavaScript implementation of the OpenPGP protocol. It implements RFC 9580 (superseding RFC 4880 and RFC 4880bis).
Table of Contents
- OpenPGP.js
@@ -88,28 +88,38 @@
The
dist/openpgp.min.js(or.mjs) bundle works with recent versions of Chrome, Firefox, Edge and Safari 14+. -
-
The
+dist/node/openpgp.min.mjs(or.cjs) bundle works in Node.js v18+: it is used by default when youimport ... from 'openpgp'(resp.require('openpgp')).The
dist/node/openpgp.min.mjs(or.cjs) bundle works in Node.js v18+: it is used by default when youimport ... from 'openpgp'(orrequire('openpgp'), respectively). -
-
Streaming support: the latest versions of Chrome, Firefox, Edge and Safari implement the -Streams specification, including
TransformStreams. -These are needed if you use the library with streamed inputs. -In previous versions of OpenPGP.js, WebStreams were automatically polyfilled by the library, +Support for the Web Cryptography API's
+SubtleCryptois required.-
+
- In browsers,
SubtleCryptois only available in secure contexts.
+ - In supported versions of Node.js,
SubtleCryptois always available.
+
+ - In browsers,
-
+
Support for the Web Streams API is required.
+-
+
- In browsers: the latest versions of Chrome, Firefox, Edge and Safari support Streams, including
TransformStreams. +These are needed if you use the library with stream inputs. +In previous versions of OpenPGP.js, Web Streams were automatically polyfilled by the library, but from v6 this task is left up to the library user, due to the more extensive browser support, and the -polyfilling side-effects. If you're working with older browsers versions which do not implement e.g. TransformStreams, you can manually -load WebStream polyfill. +polyfilling side-effects. If you're working with older browsers versions which do not implement e.g. TransformStreams, you can manually +load the Web Streams polyfill. Please note that when you load the polyfills, the globalReadableStreamproperty (if it exists) gets overwritten with the polyfill version. In some edge cases, you might need to use the nativeReadableStream(for example when using it to create aResponseobject), in which case you should store a reference to it before loading the polyfills. There is also the web-streams-adapter -library to convert back and forth between them. +library to convert back and forth between them.
+ - In Node.js: OpenPGP.js v6 no longer supports native Node
Readablestreams in inputs, and instead expects (and outputs) Node's Web Streams. Node v17+ includes utilities to convert from and to Web Streams.
+
- In browsers: the latest versions of Chrome, Firefox, Edge and Safari support Streams, including
Performance
-
-
Version 3.0.0 of the library introduces support for public-key cryptography using elliptic curves. 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:
+Version 3.0.0 of the library introduced support for public-key cryptography using elliptic curves. We use native implementations on browsers and Node.js when available. Compared to RSA, elliptic curve cryptography provides stronger security per bits of key, which allows for much faster operations. Currently the following curves are supported:
-@@ -127,8 +137,8 @@ library to convert back and forth between them. ECDH N/A No -Yes* -If native** +No +Algorithmically ed25519 @@ -196,24 +206,21 @@ library to convert back and forth between them.* when available +
* when available
** these curves are only constant-time if the underlying native implementation is available and constant-time -
-
If the user's browser supports native WebCrypto via the
+window.crypto.subtleAPI, this will be used. Under Node.js the native crypto module is used.The platform's native Web Crypto API is used for performance. On Node.js the native crypto module is also used, in cases where it offers additional functionality.
-
-
The library implements authenticated encryption (AEAD) as per the "crypto refresh" draft standard using AES-OCB, EAX, or GCM. This makes symmetric encryption faster on platforms with native implementations. However, since the specification is very recent and other OpenPGP implementations are in the process of adopting it, the feature is currently behind a flag. Note: activating this setting can break compatibility with other OpenPGP implementations which have yet to implement the feature. You can enable it by setting
+openpgp.config.aeadProtect = true. -Note that this setting has a different effect from the one in OpenPGP.js v6, which implemented support for a provisional version of AEAD from RFC4880bis, which was modified in a later draft of the crypto refresh.The library implements authenticated encryption (AEAD) as per RFC 9580 using AES-GCM, OCB, or EAX. This makes symmetric encryption faster on platforms with native implementations. However, since the specification is very recent and other OpenPGP implementations are in the process of adopting it, the feature is currently behind a flag. Note: activating this setting can break compatibility with other OpenPGP implementations which have yet to implement the feature. You can enable it by setting
openpgp.config.aeadProtect = true. +Note that this setting has a different effect from the one in OpenPGP.js v5, which implemented support for a provisional version of AEAD from RFC 4880bis, which was modified in RFC 9580.You can change the AEAD mode by setting one of the following options:
-openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.ocb; // Default (widest ecosystem support), non-native -openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.gcm; // Native in WebCrypto and Node.js +openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.gcm; // Default, native in WebCrypto and Node.js +openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.ocb; // Non-native, but supported across RFC 9580 implementations openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.eax; // Native in Node.js
- -
-
For environments that don't provide native crypto, the library falls back to asm.js AES and AEAD implementations.
-
Getting started
Node.js
@@ -445,12 +452,8 @@ It's possible to change that behaviour by enabling compression through the confi } })(); -For more information on using ReadableStreams, see the MDN Documentation on the -Streams API.
-You can also pass a Node.js Readable
-stream, in
-which case OpenPGP.js will return a Node.js Readable stream as well, which you
-can .pipe() to a Writable stream, for example.
For more information on using ReadableStreams (both in browsers and Node.js), see the MDN Documentation on the +Streams API .
Streaming encrypt and decrypt String data with PGP keys
(async () => {
const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
@@ -688,7 +691,7 @@ and a subkey for encryption using Curve25519.
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 dist/openpgp.min.js to use in your project:
npm install && npm test
-For debugging browser errors, you can run npm start and open http://localhost:8080/test/unittests.html in a browser, or run the following command:
+For debugging browser errors, run the following command:
npm run browsertest
How do I get involved?
diff --git a/docs/module-config.html b/docs/module-config.html
index f0eeb13f..9a214e8f 100644
--- a/docs/module-config.html
+++ b/docs/module-config.html
@@ -89,7 +89,7 @@
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
constantTimePKCS1DecryptionSupportedSymmetricAlgorithms.Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
(inner) assertNonZeroArray(sharedSecret)
+
+
+
+
+
+
+
+ x25519 and x448 produce an all-zero value when given as input a point with small order.
+This does not lead to a security issue in the context of ECDH, but it is still unexpected,
+hence we throw.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ sharedSecret
+
+
+Uint8Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2089,7 +2230,7 @@
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
(inner) assertNonZeroArray(sharedSecret)
+
+
+
+
+
+
+
+ x25519 and x448 produce an all-zero value when given as input a point with small order.
+This does not lead to a security issue in the context of ECDH, but it is still unexpected,
+hence we throw.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ sharedSecret
+
+
+Uint8Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -5187,7 +5469,7 @@
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
-
- key/user.js, line 16
+ key/user.js, line 16
Source:
-
- key/user.js, line 59
+ key/user.js, line 59
Source:
-
- key/user.js, line 43
+ key/user.js, line 43
Source:
-
- key/user.js, line 97
+ key/user.js, line 97
Source:
Source:
-
- key/user.js, line 30
+ key/user.js, line 30
Source:
Source:
Source:
Source:
Source:
Source:
Source:
(static) createSignaturePacket(dataToSign, privateKey, signingKeyPacket, signaturePropertiesopt, dateopt, userIDopt, notationsopt, detachedopt, config) → {Promise.<SignaturePacket>}
+ (static) createSignaturePacket(dataToSign, recipientKeys, signingKeyPacket, signaturePropertiesopt, dateopt, userIDopt, notationsopt, detachedopt, config) → {Promise.<SignaturePacket>}
@@ -631,13 +631,13 @@
- privateKeyrecipientKeys
-PrivateKey
+Array.<Key>
@@ -655,7 +655,7 @@
- key to get preferences from
keys to get preferences from
@@ -928,7 +928,7 @@
Source:
Source:
Source:
Source:
Source:
(async, static) getPreferredHashAlgo(keyopt, keyPacket, dateopt, userIDopt, config) → {Promise.<enums.hash>}
+ (async, static) getPreferredHashAlgo(targetKeysopt, signingKeyPacket, dateopt, targetUserIDopt, config) → {Promise.<enums.hash>}
@@ -1986,7 +1986,7 @@ The expiration time of the signature is ignored.
- Returns the preferred signature hash algorithm of a key
+ Returns the preferred signature hash algorithm for a set of keys.
@@ -2024,13 +2024,13 @@ The expiration time of the signature is ignored.
- keytargetKeys
-Key
+Array.<Key>
@@ -2050,14 +2050,14 @@ The expiration time of the signature is ignored.
- The key to get preferences from
The keys to get preferences from
- keyPacketsigningKeyPacket
@@ -2124,7 +2124,7 @@ The expiration time of the signature is ignored.
- userIDtargetUserID
@@ -2150,7 +2150,7 @@ The expiration time of the signature is ignored.
- User ID
User IDs corresponding to targetKeys to get preferences from
@@ -2224,7 +2224,7 @@ The expiration time of the signature is ignored.
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
-
- type/oid.js, line 18
+ type/oid.js, line 18
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source: