The session key's cipher algorithm e.g. 'aes128'
The session key's cipher algorithm
Encrypt the packet list payload.
+Encrypt the packet payload.
The session key's cipher algorithm e.g. 'aes128'
The session key's cipher algorithm
on parsing failure
+Infinity if the key doesn't expire, or null if
Infinity if the key doesn't expire, or null if
Infinity if the key doesn't expire, or null if
Infinity if the key doesn't expire, or null if
Any native javascript string
The format of the string of bytes
algorithmalgorithmNameaeadAlgorithmaeadAlgorithmNameread on an empty PacketList instance.
read on an empty PacketList instance.
read on an empty PacketList instance.
read on an empty PacketList instance.
read on an empty PacketList instance.
Algorithm to encrypt the message with
+Decrypts the session key (only for public key encrypted session key -packets (tag 1)
+Decrypts the session key (only for public key encrypted session key packets (tag 1)
randomSessionKeyBogus session key to use in case of sensitive decryption error, or if the decrypted session key is of a different type/size. +This is needed for constant-time processing. Expected object of the form: { sessionKey: Uint8Array, sessionKeyAlgorithm: enums.symmetric }
if decryption failed
+if decryption failed, unless randomSessionKey is given
AEAD algorithm
+AEAD algorithm to encrypt the key with (if AEAD protection is enabled)
Symmetric algorithm
+Symmetric algorithm to encrypt the key with
AEAD algorithm
+AEAD algorithm to encrypt the key with (if AEAD protection is enabled)
Symmetric algorithm
+Symmetric algorithm to encrypt the key with
The selected symmetric encryption algorithm to be used e.g. 'aes128'
The selected symmetric encryption algorithm to be used
on decryption failure
+The selected symmetric encryption algorithm to be used e.g. 'aes128'
The symmetric encryption algorithm to use
on encryption failure
+AEAD mode to encrypt the session key with (if AEAD protection is enabled)
+Algorithm to encrypt the message with
+Algorithm to encrypt the session key with
+Decrypts the session key
+Decrypts the session key with the given passphrase
Encrypts the session key
+Encrypts the session key with the given passphrase
Javascript AES implementation. +This is used as fallback if the native Crypto APIs are not available.
+decryptionKeys, sessionkeys or passwords<
Source:
-
- openpgp.js, line 333
+ openpgp.js, line 333
Source:
-
- openpgp.js, line 172
+ openpgp.js, line 172
decryptionKeys or passwords must be specified.<
Source:
-
- openpgp.js, line 581
+ openpgp.js, line 581
Source:
-
- openpgp.js, line 264
+ openpgp.js, line 264
Source:
-
- openpgp.js, line 206
+ openpgp.js, line 206
encryptionKeys or passwords must be sp
Source:
-
- openpgp.js, line 551
+ openpgp.js, line 551
encryptionKeys or passwords must be sp
Source:
-
- openpgp.js, line 713
+ openpgp.js, line 713
sign parameter that default
Source:
-
- openpgp.js, line 56
+ openpgp.js, line 56
sign parameter that default
Source:
-
- openpgp.js, line 518
+ openpgp.js, line 518
sign parameter that default
Source:
sign parameter that default
Source:
sign parameter that default
Source:
sign parameter that default
Source:
sign parameter that default
Source:
-
- message.js, line 805
+ message.js, line 853
sign parameter that default
Source:
sign parameter that default
Source:
sign parameter that default
Source:
Source:
-
- openpgp.js, line 100
+ openpgp.js, line 100
Source:
-
- openpgp.js, line 141
+ openpgp.js, line 141
Source:
-
- openpgp.js, line 395
+ openpgp.js, line 395
Source:
Source:
-
- openpgp.js, line 464
+ openpgp.js, line 464
Source:
diff --git a/docs/index.html b/docs/index.html
index 4938bd4d..f228e3ce 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -54,6 +54,7 @@
Getting started
@@ -228,6 +229,10 @@ openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.experimentalGCM // **
Or as an ES6 module, from an .mjs file:
import * as openpgp from 'openpgp';
+Deno (experimental)
+Import as an ES6 module, using /dist/openpgp.mjs.
+import * as openpgp from './openpgpjs/dist/openpgp.mjs';
+
Browser (webpack)
Install OpenPGP.js using npm and save it in your devDependencies:
npm install --save-dev openpgp
@@ -257,7 +262,7 @@ import * as openpgp from './openpgp.min.mjs';
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. If you're upgrading from v4 it might help to check out the changelog and documentation.
+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. If you're upgrading from v4 it might help to check out the changelog and documentation.
Encrypt and decrypt Uint8Array data with a password
Encryption will use the algorithm specified in config.preferredSymmetricAlgorithm (defaults to aes256), and decryption will use the algorithm used for encryption.
(async () => {
@@ -671,7 +676,7 @@ and a subkey for encryption using Curve25519.
})();
Documentation
-The full documentation is available at openpgpjs.org.
+The full documentation is available at openpgpjs.org.
Security Audit
To date the OpenPGP.js code base has undergone two complete security audits from Cure53. The first audit's report has been published here.
Security recommendations
@@ -698,7 +703,7 @@ and a subkey for encryption using Curve25519.
diff --git a/docs/module-config.html b/docs/module-config.html
index 439ec253..1c669330 100644
--- a/docs/module-config.html
+++ b/docs/module-config.html
@@ -89,7 +89,7 @@
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
(static) constantTimePKCS1Decryption
+
+
+
+
+
+ Enable constant-time decryption of RSA- and ElGamal-encrypted session keys, to hinder Bleichenbacher-like attacks (https://link.springer.com/chapter/10.1007/BFb0055716).
+This setting has measurable performance impact and it is only helpful in application scenarios where both of the following conditions apply:
+
+- new/incoming messages are automatically decrypted (without user interaction);
+- an attacker can determine how long it takes to decrypt each message (e.g. due to decryption errors being logged remotely).
+See also
constantTimePKCS1DecryptionSupportedSymmetricAlgorithms.
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ constantTimePKCS1Decryption
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ config/config.js, line 152
+
+
+
+
+
+
+
+
+
+(static) constantTimePKCS1DecryptionSupportedSymmetricAlgorithms
+
+
+
+
+
+ This setting is only meaningful if constantTimePKCS1Decryption is enabled.
+Decryption of RSA- and ElGamal-encrypted session keys of symmetric algorithms different from the ones specified here will fail.
+However, the more algorithms are added, the slower the decryption procedure becomes.
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ constantTimePKCS1DecryptionSupportedSymmetricAlgorithms
+
+
+Set.<Integer>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ - Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
diff --git a/docs/module-crypto_random-RandomBuffer.html b/docs/module-crypto_random-RandomBuffer.html
index 9073aade..6f58ca88 100644
--- a/docs/module-crypto_random-RandomBuffer.html
+++ b/docs/module-crypto_random-RandomBuffer.html
@@ -95,7 +95,7 @@
- Source:
- Source:
- Source:
- Source:
diff --git a/docs/module-enums.html b/docs/module-enums.html
index 22a1f3d5..995f2093 100644
--- a/docs/module-enums.html
+++ b/docs/module-enums.html
@@ -212,7 +212,7 @@
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
(static) read()
+ (static) read(type, e) → {String}
@@ -5808,7 +5808,7 @@ document) that cannot include a target subpacket.
- Converts from an integer to string.
+ Converts enum integer value to the corresponding string, if it exists.
@@ -5819,6 +5819,78 @@ document) that cannot include a target subpacket.
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ type
+
+
+Object
+
+
+
+
+
+
+
+
+
+ target enum type
+
+
+
+
+
+ e
+
+
+Integer
+
+
+
+
+
+
+
+
+
+ value to convert
+
+
+
+
+
+
@@ -5854,7 +5926,7 @@ document) that cannot include a target subpacket.
- Source:
Throws:
+
+
+
+
+ -
+
+
if the value is invalid
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+Error
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ name of enum value if it exists
+
+
+
+
+
+ -
+ Type
+
+ -
+
+String
+
+
+
+
+
+
@@ -5890,7 +6013,7 @@ document) that cannot include a target subpacket.
- (static) write()
+ (static) write(type, e) → {Integer}
@@ -5898,7 +6021,7 @@ document) that cannot include a target subpacket.
- Asserts validity and converts from string/integer to integer.
+ Asserts validity of given value and converts from string/integer to integer.
@@ -5909,6 +6032,81 @@ document) that cannot include a target subpacket.
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ type
+
+
+Object
+
+
+
+
+
+
+
+
+
+ target enum type
+
+
+
+
+
+ e
+
+
+String
+|
+
+Integer
+
+
+
+
+
+
+
+
+
+ value to check and/or convert
+
+
+
+
+
+
@@ -5944,7 +6142,7 @@ document) that cannot include a target subpacket.
- Source:
Throws:
+
+
+
+
+ -
+
+
if the value is invalid
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+Error
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ enum value if it exists
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Integer
+
+
+
+
+
+
@@ -5990,7 +6239,7 @@ document) that cannot include a target subpacket.
diff --git a/docs/module-key_Subkey-Subkey.html b/docs/module-key_Subkey-Subkey.html
index 9006a042..e14718e9 100644
--- a/docs/module-key_Subkey-Subkey.html
+++ b/docs/module-key_Subkey-Subkey.html
@@ -170,7 +170,7 @@
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
diff --git a/docs/module-key_User-User.html b/docs/module-key_User-User.html
index ea5affd9..940fa81e 100644
--- a/docs/module-key_User-User.html
+++ b/docs/module-key_User-User.html
@@ -170,7 +170,7 @@
- Source:
-
- key/user.js, line 17
+ key/user.js, line 17
- 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:
-
- key/user.js, line 30
+ key/user.js, line 30
- Source:
- Source:
- Source:
- Source:
diff --git a/docs/module-type_kdf_params-KDFParams.html b/docs/module-type_kdf_params-KDFParams.html
index 3c6391df..ee131114 100644
--- a/docs/module-type_kdf_params-KDFParams.html
+++ b/docs/module-type_kdf_params-KDFParams.html
@@ -163,7 +163,7 @@
- Source:
- Source:
- Source:
diff --git a/docs/module-type_keyid-KeyID.html b/docs/module-type_keyid-KeyID.html
index fcb47aa1..2de4bf7c 100644
--- a/docs/module-type_keyid-KeyID.html
+++ b/docs/module-type_keyid-KeyID.html
@@ -100,7 +100,7 @@ formed.
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
diff --git a/docs/module-type_s2k-S2K.html b/docs/module-type_s2k-S2K.html
index e5729cd8..22466ee4 100644
--- a/docs/module-type_s2k-S2K.html
+++ b/docs/module-type_s2k-S2K.html
@@ -152,7 +152,7 @@
- Source:
-
- type/s2k.js, line 40
+ type/s2k.js, line 40
algorithm :module:enums.hash
+algorithm :module:enums.hash|0
+
+ Hash function identifier, or 0 for gnu-dummy keys
+
+
Type:
@@ -214,6 +218,9 @@
module:enums.hash
+|
+
+0
@@ -254,7 +261,7 @@
Source:
-
- type/s2k.js, line 42
+ type/s2k.js, line 45
Source:
-
- type/s2k.js, line 46
+ type/s2k.js, line 52
salt :String
+salt :Uint8Array
@@ -353,6 +360,80 @@
+ Type:
+
+ -
+
+Uint8Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ type/s2k.js, line 56
+
+
+
+
+
+
+
+
+
+type :String
+
+
+
+
+
+ enums.s2k identifier or 'gnu-dummy'
+
+
+
+
Type:
-
@@ -398,77 +479,7 @@
- Source:
-
- type/s2k.js, line 50
-
type :module:enums.s2k
-
-
-
-
-
-
- Type:
-
- -
-
-module:enums.s2k
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
- -
- type/s2k.js, line 44
+ type/s2k.js, line 50
- Source:
-String
+Uint8Array
@@ -762,7 +773,7 @@ hashAlgorithm hash length
- Source:
-
- type/s2k.js, line 65
+ type/s2k.js, line 71
- Source:
diff --git a/package-lock.json b/package-lock.json
index b23b2a5a..18b7512e 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
{
"name": "openpgp",
- "version": "5.0.1",
+ "version": "5.1.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
diff --git a/package.json b/package.json
index 217aef74..d060864e 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
{
"name": "openpgp",
"description": "OpenPGP.js is a Javascript implementation of the OpenPGP protocol. This is defined in RFC 4880.",
- "version": "5.0.1",
+ "version": "5.1.0",
"license": "LGPL-3.0+",
"homepage": "https://openpgpjs.org/",
"engines": {