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
read 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.
emitChecksumWhether to compute and include the CRC checksum +(NB: some types of data must not include it, but compliance is left as responsibility of the caller: this function does not carry out any checks)
configFull configuration, defaults to openpgp.config
decryptionKeys, sessionkeys or passwords<
Source:
-
- openpgp.js, line 343
+ openpgp.js, line 343
Source:
-
- openpgp.js, line 181
+ openpgp.js, line 181
decryptionKeys or passwords must be specified.<
Source:
-
- openpgp.js, line 596
+ openpgp.js, line 596
Source:
Source:
-
- openpgp.js, line 274
+ openpgp.js, line 274
Source:
-
- openpgp.js, line 215
+ openpgp.js, line 215
encryptionKeys or passwords must be sp
Source:
-
- openpgp.js, line 562
+ openpgp.js, line 562
encryptionKeys or passwords must be sp
Source:
-
- openpgp.js, line 718
+ openpgp.js, line 718
sign parameter that default
Source:
-
- openpgp.js, line 58
+ openpgp.js, line 58
sign parameter that default
Source:
-
- openpgp.js, line 529
+ openpgp.js, line 529
sign parameter that default
Source:
sign parameter that default
Source:
sign parameter that default
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
-
- message.js, line 842
+ message.js, line 848
Source:
Source:
Source:
Source:
-
- openpgp.js, line 109
+ openpgp.js, line 109
Source:
-
- openpgp.js, line 150
+ openpgp.js, line 150
Source:
Source:
-
- openpgp.js, line 406
+ openpgp.js, line 406
Source:
Source:
-
- openpgp.js, line 475
+ openpgp.js, line 475
Source:
Source:
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 v5, which implemented support for a provisional version of AEAD from RFC4880bis, which was modified in a later draft of the crypto refresh.
+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.
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
@@ -265,7 +265,7 @@ import * as openpgp from './openpgp.min.mjs';
If you notice missing or incorrect type definitions, feel free to open a PR.
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 v6. 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 () => {
diff --git a/docs/module-config.html b/docs/module-config.html
index 55a40273..cd13962b 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:
-
- config/config.js, line 282
-
(static) revocationsExpire
-
-
-
-
-
-
-
-
-
-
- Properties:
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- revocationsExpire
-
-
-Boolean
-
-
-
-
-
-
-
-
-
- If true, expired revocation signatures are ignored
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - 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:
Cipher algorithm
Cipher algorithm (v3 only)
- 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:
- 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:
- 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:
-
- type/oid.js, line 18
+ type/oid.js, line 18
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source:
- Source: