From 0307111993f51ce58a4ce13c1fe8ab510ed78e92 Mon Sep 17 00:00:00 2001 From: Daniel Huigens Date: Thu, 16 Feb 2023 14:32:01 +0100 Subject: [PATCH] 5.6.0 --- docs/AEADEncryptedDataPacket.html | 18 +- docs/CleartextMessage.html | 53 +- docs/CompressedDataPacket.html | 20 +- docs/Key.html | 64 +- docs/LiteralDataPacket.html | 22 +- docs/MarkerPacket.html | 6 +- docs/Message.html | 120 +++- docs/OnePassSignaturePacket.html | 20 +- docs/PacketList.html | 16 +- docs/PrivateKey.html | 22 +- docs/PublicKey.html | 10 +- docs/PublicKeyEncryptedSessionKeyPacket.html | 16 +- docs/PublicKeyPacket.html | 48 +- docs/PublicSubkeyPacket.html | 48 +- docs/SecretKeyPacket.html | 72 +-- docs/SecretSubkeyPacket.html | 72 +-- docs/Signature.html | 10 +- docs/SignaturePacket.html | 26 +- ...EncryptedIntegrityProtectedDataPacket.html | 8 +- docs/SymEncryptedSessionKeyPacket.html | 18 +- docs/SymmetricallyEncryptedDataPacket.html | 12 +- docs/TrustPacket.html | 6 +- docs/UserAttributePacket.html | 10 +- docs/UserIDPacket.html | 12 +- docs/global.html | 142 ++++- docs/index.html | 7 +- docs/module-config.html | 70 +-- docs/module-crypto_random-RandomBuffer.html | 593 ------------------ docs/module-enums.html | 38 +- docs/module-key_Subkey-Subkey.html | 42 +- docs/module-key_User-User.html | 358 ++++++++++- docs/module-type_kdf_params-KDFParams.html | 8 +- docs/module-type_keyid-KeyID.html | 16 +- docs/module-type_s2k-S2K.html | 18 +- package-lock.json | 4 +- package.json | 2 +- 36 files changed, 986 insertions(+), 1041 deletions(-) delete mode 100644 docs/module-crypto_random-RandomBuffer.html diff --git a/docs/AEADEncryptedDataPacket.html b/docs/AEADEncryptedDataPacket.html index be6c7ee6..011d967b 100644 --- a/docs/AEADEncryptedDataPacket.html +++ b/docs/AEADEncryptedDataPacket.html @@ -98,7 +98,7 @@ AEAD Protected Data Packet

Source:
@@ -200,7 +200,7 @@ AEAD Protected Data Packet

Source:
@@ -270,7 +270,7 @@ AEAD Protected Data Packet

Source:
@@ -453,7 +453,7 @@ AEAD Protected Data Packet

Source:
@@ -684,7 +684,7 @@ AEAD Protected Data Packet

Source:
@@ -926,7 +926,7 @@ AEAD Protected Data Packet

Source:
@@ -1097,7 +1097,7 @@ AEAD Protected Data Packet

Source:
@@ -1216,7 +1216,7 @@ AEAD Protected Data Packet

Source:
@@ -1287,7 +1287,7 @@ AEAD Protected Data Packet


diff --git a/docs/CleartextMessage.html b/docs/CleartextMessage.html index ff0b629e..bdbc7d4b 100644 --- a/docs/CleartextMessage.html +++ b/docs/CleartextMessage.html @@ -168,7 +168,7 @@ See https://tools.ietf.o
Source:
@@ -346,7 +346,7 @@ See https://tools.ietf.o
Source:
@@ -461,7 +461,7 @@ See https://tools.ietf.o
Source:
@@ -573,7 +573,7 @@ See https://tools.ietf.o
Source:
@@ -631,7 +631,7 @@ See https://tools.ietf.o -

(async) sign(privateKeys, signatureopt, signingKeyIDsopt, dateopt, userIDsopt, configopt) → {Promise.<CleartextMessage>}

+

(async) sign(privateKeys, signatureopt, signingKeyIDsopt, dateopt, userIDsopt, notationsopt, configopt) → {Promise.<CleartextMessage>}

@@ -862,6 +862,43 @@ See https://tools.ietf.o + + + notations + + + + + +Array + + + + + + + + + <optional>
+ + + + + + + + + + + + + + +

Notation Data to add to the signatures, e.g. [{ name: 'test@example.org', value: new TextEncoder().encode('test'), humanReadable: true }]

+ + + + config @@ -937,7 +974,7 @@ See https://tools.ietf.o
Source:
@@ -1174,7 +1211,7 @@ See https://tools.ietf.o
Source:
@@ -1242,7 +1279,7 @@ See https://tools.ietf.o
diff --git a/docs/CompressedDataPacket.html b/docs/CompressedDataPacket.html index 61f6161a..b73e0818 100644 --- a/docs/CompressedDataPacket.html +++ b/docs/CompressedDataPacket.html @@ -160,7 +160,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.

Source:
@@ -266,7 +266,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.

Source:
@@ -343,7 +343,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.

Source:
@@ -407,7 +407,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.

Source:
@@ -481,7 +481,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.

Source:
@@ -563,7 +563,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.

Source:
@@ -715,7 +715,7 @@ read by read_packet

Source:
@@ -900,7 +900,7 @@ read by read_packet

Source:
@@ -990,7 +990,7 @@ read by read_packet

Source:
@@ -1061,7 +1061,7 @@ read by read_packet


diff --git a/docs/Key.html b/docs/Key.html index b30c5b9c..a5d0d9ac 100644 --- a/docs/Key.html +++ b/docs/Key.html @@ -96,7 +96,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.

Source:
@@ -333,7 +333,7 @@ if it is a valid revocation signature.

Source:
@@ -391,7 +391,7 @@ if it is a valid revocation signature.

-

clone(deepopt) → {Promise.<Key>}

+

clone(clonePrivateParamsopt) → {Promise.<Key>}

@@ -399,7 +399,7 @@ if it is a valid revocation signature.

-

Clones the key object

+

Clones the key object. The copy is shallow, as it references the same packet objects as the original. However, if the top-level API is used, the two key instances are effectively independent.

@@ -439,7 +439,7 @@ if it is a valid revocation signature.

- deep + clonePrivateParams @@ -471,7 +471,7 @@ if it is a valid revocation signature.

-

Whether to return a deep clone

+

Only relevant for private keys: whether the secret key paramenters should be deeply copied. This is needed if e.g. encrypt() is to be called either on the clone or the original key.

@@ -514,7 +514,7 @@ if it is a valid revocation signature.

Source:
@@ -626,7 +626,7 @@ if it is a valid revocation signature.

Source:
@@ -738,7 +738,7 @@ if it is a valid revocation signature.

Source:
@@ -1006,7 +1006,7 @@ if it is a valid revocation signature.

Source:
@@ -1225,7 +1225,7 @@ Returns Infinity if the key doesn't expire, or null if
Source:
@@ -1333,7 +1333,7 @@ Returns Infinity if the key doesn't expire, or null if
Source:
@@ -1445,7 +1445,7 @@ Returns Infinity if the key doesn't expire, or null if
Source:
@@ -1557,7 +1557,7 @@ Returns Infinity if the key doesn't expire, or null if
Source:
@@ -1735,7 +1735,7 @@ If no keyID is given, returns all keys, starting with the primary key.

Source:
@@ -1978,7 +1978,7 @@ If no keyID is given, returns all keys, starting with the primary key.

Source:
@@ -2183,7 +2183,7 @@ If no keyID is given, returns all keys, starting with the primary key.

Source:
@@ -2475,7 +2475,7 @@ If no keyID is given, returns all keys, starting with the primary key.

Source:
@@ -2669,7 +2669,7 @@ If no keyID is given, returns all subkeys.

Source:
@@ -2781,7 +2781,7 @@ If no keyID is given, returns all subkeys.

Source:
@@ -2893,7 +2893,7 @@ If no keyID is given, returns all subkeys.

Source:
@@ -3170,7 +3170,7 @@ If no keyID is given, returns all subkeys.

Source:
@@ -3354,7 +3354,7 @@ If no keyID is given, returns all subkeys.

Source:
@@ -3569,7 +3569,7 @@ If no keyID is given, returns all subkeys.

Source:
@@ -3839,7 +3839,7 @@ If no keyID is given, returns all subkeys.

Source:
@@ -3951,7 +3951,7 @@ If no keyID is given, returns all subkeys.

Source:
@@ -4192,7 +4192,7 @@ a private key is returned.

Source:
@@ -4435,7 +4435,7 @@ a private key is returned.

Source:
@@ -4676,7 +4676,7 @@ and valid self signature. Throws if the primary key is invalid.

Source:
@@ -4959,7 +4959,7 @@ and valid self signature. Throws if the primary key is invalid.

Source:
@@ -5072,7 +5072,7 @@ Signature validity is null if the verification keys do not correspond to the cer
Source:
@@ -5140,7 +5140,7 @@ Signature validity is null if the verification keys do not correspond to the cer
diff --git a/docs/LiteralDataPacket.html b/docs/LiteralDataPacket.html index ff80a6fe..3247cccd 100644 --- a/docs/LiteralDataPacket.html +++ b/docs/LiteralDataPacket.html @@ -147,7 +147,7 @@ further interpreted.

Source:
@@ -326,7 +326,7 @@ further interpreted.

Source:
@@ -441,7 +441,7 @@ further interpreted.

Source:
@@ -623,7 +623,7 @@ with normalized end of line to \n

Source:
@@ -790,7 +790,7 @@ with normalized end of line to \n

Source:
@@ -977,7 +977,7 @@ with normalized end of line to \n

Source:
@@ -1116,7 +1116,7 @@ with normalized end of line to \n

Source:
@@ -1302,7 +1302,7 @@ will be normalized to \r\n and by default text is converted to UTF8

Source:
@@ -1392,7 +1392,7 @@ will be normalized to \r\n and by default text is converted to UTF8

Source:
@@ -1507,7 +1507,7 @@ will be normalized to \r\n and by default text is converted to UTF8

Source:
@@ -1575,7 +1575,7 @@ will be normalized to \r\n and by default text is converted to UTF8


diff --git a/docs/MarkerPacket.html b/docs/MarkerPacket.html index 4617771d..4b1f1692 100644 --- a/docs/MarkerPacket.html +++ b/docs/MarkerPacket.html @@ -106,7 +106,7 @@ software is necessary to process the message.

Source:
@@ -265,7 +265,7 @@ software is necessary to process the message.

Source:
@@ -333,7 +333,7 @@ software is necessary to process the message.


diff --git a/docs/Message.html b/docs/Message.html index 242f07aa..5cf81dd8 100644 --- a/docs/Message.html +++ b/docs/Message.html @@ -146,7 +146,7 @@ See https://tools.iet
Source:
@@ -661,7 +661,7 @@ See https://tools.iet
Source:
@@ -933,7 +933,7 @@ See https://tools.iet
Source:
@@ -1140,7 +1140,7 @@ See https://tools.iet
Source:
@@ -1291,7 +1291,7 @@ See https://tools.iet
Source:
@@ -1495,7 +1495,7 @@ See https://tools.iet
Source:
@@ -1800,7 +1800,7 @@ See https://tools.iet
Source:
@@ -2072,7 +2072,7 @@ See https://tools.iet
Source:
@@ -2512,7 +2512,7 @@ See https://tools.iet
Source:
@@ -2624,7 +2624,7 @@ See https://tools.iet
Source:
@@ -2736,7 +2736,7 @@ See https://tools.iet
Source:
@@ -2851,7 +2851,7 @@ See https://tools.iet
Source:
@@ -2966,7 +2966,7 @@ See https://tools.iet
Source:
@@ -3078,7 +3078,7 @@ See https://tools.iet
Source:
@@ -3139,7 +3139,7 @@ See https://tools.iet -

(async) sign(signingKeys, signatureopt, signingKeyIDsopt, dateopt, userIDsopt, configopt) → {Promise.<Message>}

+

(async) sign(signingKeys, signatureopt, signingKeyIDsopt, dateopt, userIDsopt, notationsopt, configopt) → {Promise.<Message>}

@@ -3370,6 +3370,43 @@ See https://tools.iet + + + notations + + + + + +Array + + + + + + + + + <optional>
+ + + + + + + + + + + + + + +

Notation Data to add to the signatures, e.g. [{ name: 'test@example.org', value: new TextEncoder().encode('test'), humanReadable: true }]

+ + + + config @@ -3445,7 +3482,7 @@ See https://tools.iet
Source:
@@ -3503,7 +3540,7 @@ See https://tools.iet -

(async) signDetached(signingKeys, signatureopt, signingKeyIDsopt, dateopt, userIDsopt, configopt) → {Promise.<Signature>}

+

(async) signDetached(signingKeys, signatureopt, signingKeyIDsopt, dateopt, userIDsopt, notationsopt, configopt) → {Promise.<Signature>}

@@ -3734,6 +3771,43 @@ See https://tools.iet + + + notations + + + + + +Array + + + + + + + + + <optional>
+ + + + + + + + + + + + + + +

Notation Data to add to the signatures, e.g. [{ name: 'test@example.org', value: new TextEncoder().encode('test'), humanReadable: true }]

+ + + + config @@ -3809,7 +3883,7 @@ See https://tools.iet
Source:
@@ -3921,7 +3995,7 @@ See https://tools.iet
Source:
@@ -4158,7 +4232,7 @@ See https://tools.iet
Source:
@@ -4424,7 +4498,7 @@ See https://tools.iet
Source:
@@ -4536,7 +4610,7 @@ See https://tools.iet
Source:
@@ -4604,7 +4678,7 @@ See https://tools.iet
diff --git a/docs/OnePassSignaturePacket.html b/docs/OnePassSignaturePacket.html index 64414768..580e1335 100644 --- a/docs/OnePassSignaturePacket.html +++ b/docs/OnePassSignaturePacket.html @@ -101,7 +101,7 @@ can compute the entire signed message in one pass.

Source:
@@ -199,7 +199,7 @@ that describes another signature to be applied to the same message data.

Source:
@@ -273,7 +273,7 @@ that describes another signature to be applied to the same message data.

Source:
@@ -344,7 +344,7 @@ that describes another signature to be applied to the same message data.

Source:
@@ -418,7 +418,7 @@ that describes another signature to be applied to the same message data.

Source:
@@ -501,7 +501,7 @@ Signature types are described in
Source:
@@ -565,7 +565,7 @@ Signature types are described in
Source:
@@ -696,7 +696,7 @@ Signature types are described in
Source:
@@ -808,7 +808,7 @@ Signature types are described in
Source:
@@ -876,7 +876,7 @@ Signature types are described in
diff --git a/docs/PacketList.html b/docs/PacketList.html index 763416b5..f3a9c90b 100644 --- a/docs/PacketList.html +++ b/docs/PacketList.html @@ -97,7 +97,7 @@ are stored as numerical indices.

Source:
@@ -345,7 +345,7 @@ Equivalent to calling read on an empty PacketList instance.

Source:
@@ -530,7 +530,7 @@ Equivalent to calling read on an empty PacketList instance.

Source:
@@ -687,7 +687,7 @@ Equivalent to calling read on an empty PacketList instance.

Source:
@@ -859,7 +859,7 @@ Equivalent to calling read on an empty PacketList instance.

Source:
@@ -1097,7 +1097,7 @@ Equivalent to calling read on an empty PacketList instance.

Source:
@@ -1200,7 +1200,7 @@ class instance.

Source:
@@ -1268,7 +1268,7 @@ class instance.


diff --git a/docs/PrivateKey.html b/docs/PrivateKey.html index fe89c247..cebd53e7 100644 --- a/docs/PrivateKey.html +++ b/docs/PrivateKey.html @@ -144,7 +144,7 @@
Source:
@@ -445,7 +445,7 @@ Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the p
Source:
@@ -614,7 +614,7 @@ Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the p
Source:
@@ -726,7 +726,7 @@ Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the p
Source:
@@ -971,7 +971,7 @@ This is useful to retrieve keys for session key decryption

Source:
@@ -1084,7 +1084,7 @@ A dummy key is considered encrypted.

Source:
@@ -1174,7 +1174,7 @@ A dummy key is considered encrypted.

Source:
@@ -1477,7 +1477,7 @@ A dummy key is considered encrypted.

Source:
@@ -1589,7 +1589,7 @@ A dummy key is considered encrypted.

Source:
@@ -1766,7 +1766,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err
Source:
@@ -1841,7 +1841,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err
diff --git a/docs/PublicKey.html b/docs/PublicKey.html index d839aa4b..3ba04b09 100644 --- a/docs/PublicKey.html +++ b/docs/PublicKey.html @@ -144,7 +144,7 @@
Source:
@@ -315,7 +315,7 @@
Source:
@@ -427,7 +427,7 @@
Source:
@@ -535,7 +535,7 @@
Source:
@@ -603,7 +603,7 @@
diff --git a/docs/PublicKeyEncryptedSessionKeyPacket.html b/docs/PublicKeyEncryptedSessionKeyPacket.html index cb4f62d8..cb69cf94 100644 --- a/docs/PublicKeyEncryptedSessionKeyPacket.html +++ b/docs/PublicKeyEncryptedSessionKeyPacket.html @@ -107,7 +107,7 @@ decrypt the message.

Source:
@@ -209,7 +209,7 @@ decrypt the message.

Source:
@@ -283,7 +283,7 @@ decrypt the message.

Source:
@@ -458,7 +458,7 @@ This is needed for constant-time processing. Expected object of the form: { sess
Source:
@@ -626,7 +626,7 @@ This is needed for constant-time processing. Expected object of the form: { sess
Source:
@@ -794,7 +794,7 @@ This is needed for constant-time processing. Expected object of the form: { sess
Source:
@@ -884,7 +884,7 @@ This is needed for constant-time processing. Expected object of the form: { sess
Source:
@@ -952,7 +952,7 @@ This is needed for constant-time processing. Expected object of the form: { sess
diff --git a/docs/PublicKeyPacket.html b/docs/PublicKeyPacket.html index 4539d576..7b1078aa 100644 --- a/docs/PublicKeyPacket.html +++ b/docs/PublicKeyPacket.html @@ -195,7 +195,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -301,7 +301,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -375,7 +375,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -449,7 +449,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -523,7 +523,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -597,7 +597,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -671,7 +671,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -735,7 +735,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -816,7 +816,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -880,7 +880,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -1018,7 +1018,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -1130,7 +1130,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -1220,7 +1220,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -1310,7 +1310,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -1422,7 +1422,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -1530,7 +1530,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -1642,7 +1642,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -1754,7 +1754,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -1866,7 +1866,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -1978,7 +1978,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -2138,7 +2138,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -2250,7 +2250,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -2411,7 +2411,7 @@ key (sometimes called an OpenPGP certificate).

Source:
@@ -2457,7 +2457,7 @@ key (sometimes called an OpenPGP certificate).


diff --git a/docs/PublicSubkeyPacket.html b/docs/PublicSubkeyPacket.html index 1804dbd7..cafa9935 100644 --- a/docs/PublicSubkeyPacket.html +++ b/docs/PublicSubkeyPacket.html @@ -193,7 +193,7 @@ services.

Source:
@@ -315,7 +315,7 @@ services.

Source:
@@ -394,7 +394,7 @@ services.

Source:
@@ -473,7 +473,7 @@ services.

Source:
@@ -552,7 +552,7 @@ services.

Source:
@@ -631,7 +631,7 @@ services.

Source:
@@ -710,7 +710,7 @@ services.

Source:
@@ -779,7 +779,7 @@ services.

Source:
@@ -865,7 +865,7 @@ services.

Source:
@@ -934,7 +934,7 @@ services.

Source:
@@ -1072,7 +1072,7 @@ services.

Source:
@@ -1189,7 +1189,7 @@ services.

Source:
@@ -1284,7 +1284,7 @@ services.

Source:
@@ -1379,7 +1379,7 @@ services.

Source:
@@ -1496,7 +1496,7 @@ services.

Source:
@@ -1609,7 +1609,7 @@ services.

Source:
@@ -1726,7 +1726,7 @@ services.

Source:
@@ -1843,7 +1843,7 @@ services.

Source:
@@ -1960,7 +1960,7 @@ services.

Source:
@@ -2077,7 +2077,7 @@ services.

Source:
@@ -2242,7 +2242,7 @@ services.

Source:
@@ -2359,7 +2359,7 @@ services.

Source:
@@ -2525,7 +2525,7 @@ services.

Source:
@@ -2571,7 +2571,7 @@ services.


diff --git a/docs/SecretKeyPacket.html b/docs/SecretKeyPacket.html index 05d303c1..0f67561c 100644 --- a/docs/SecretKeyPacket.html +++ b/docs/SecretKeyPacket.html @@ -191,7 +191,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -308,7 +308,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -387,7 +387,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -466,7 +466,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -545,7 +545,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -624,7 +624,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -688,7 +688,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -767,7 +767,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -831,7 +831,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -905,7 +905,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -984,7 +984,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1053,7 +1053,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1134,7 +1134,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1208,7 +1208,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1282,7 +1282,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1361,7 +1361,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1430,7 +1430,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1519,7 +1519,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1614,7 +1614,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1709,7 +1709,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1851,7 +1851,7 @@ otherwise calls to this function will throw an error.

Source:
@@ -2065,7 +2065,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2189,7 +2189,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2306,7 +2306,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2419,7 +2419,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2536,7 +2536,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2653,7 +2653,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2770,7 +2770,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2888,7 +2888,7 @@ Returns false for gnu-dummy keys and null for public keys.

Source:
@@ -2999,7 +2999,7 @@ Returns false for gnu-dummy keys and null for public keys.

Source:
@@ -3169,7 +3169,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3314,7 +3314,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3404,7 +3404,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3528,7 +3528,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3694,7 +3694,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3740,7 +3740,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
diff --git a/docs/SecretSubkeyPacket.html b/docs/SecretSubkeyPacket.html index 3517f0bc..9d540a41 100644 --- a/docs/SecretSubkeyPacket.html +++ b/docs/SecretSubkeyPacket.html @@ -190,7 +190,7 @@ Key packet and has exactly the same format.

Source:
@@ -312,7 +312,7 @@ Key packet and has exactly the same format.

Source:
@@ -391,7 +391,7 @@ Key packet and has exactly the same format.

Source:
@@ -470,7 +470,7 @@ Key packet and has exactly the same format.

Source:
@@ -549,7 +549,7 @@ Key packet and has exactly the same format.

Source:
@@ -628,7 +628,7 @@ Key packet and has exactly the same format.

Source:
@@ -697,7 +697,7 @@ Key packet and has exactly the same format.

Source:
@@ -776,7 +776,7 @@ Key packet and has exactly the same format.

Source:
@@ -845,7 +845,7 @@ Key packet and has exactly the same format.

Source:
@@ -924,7 +924,7 @@ Key packet and has exactly the same format.

Source:
@@ -1003,7 +1003,7 @@ Key packet and has exactly the same format.

Source:
@@ -1072,7 +1072,7 @@ Key packet and has exactly the same format.

Source:
@@ -1158,7 +1158,7 @@ Key packet and has exactly the same format.

Source:
@@ -1237,7 +1237,7 @@ Key packet and has exactly the same format.

Source:
@@ -1316,7 +1316,7 @@ Key packet and has exactly the same format.

Source:
@@ -1395,7 +1395,7 @@ Key packet and has exactly the same format.

Source:
@@ -1464,7 +1464,7 @@ Key packet and has exactly the same format.

Source:
@@ -1558,7 +1558,7 @@ Key packet and has exactly the same format.

Source:
@@ -1653,7 +1653,7 @@ Key packet and has exactly the same format.

Source:
@@ -1748,7 +1748,7 @@ Key packet and has exactly the same format.

Source:
@@ -1895,7 +1895,7 @@ otherwise calls to this function will throw an error.

Source:
@@ -2114,7 +2114,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2238,7 +2238,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2355,7 +2355,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2468,7 +2468,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2585,7 +2585,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2702,7 +2702,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2819,7 +2819,7 @@ This can be used to remove passphrase protection after calling decrypt().

Source:
@@ -2937,7 +2937,7 @@ Returns false for gnu-dummy keys and null for public keys.

Source:
@@ -3053,7 +3053,7 @@ Returns false for gnu-dummy keys and null for public keys.

Source:
@@ -3228,7 +3228,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3373,7 +3373,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3468,7 +3468,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3592,7 +3592,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3758,7 +3758,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3804,7 +3804,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
diff --git a/docs/Signature.html b/docs/Signature.html index a8746570..399e8423 100644 --- a/docs/Signature.html +++ b/docs/Signature.html @@ -144,7 +144,7 @@
Source:
@@ -322,7 +322,7 @@
Source:
@@ -434,7 +434,7 @@
Source:
@@ -546,7 +546,7 @@
Source:
@@ -614,7 +614,7 @@
diff --git a/docs/SignaturePacket.html b/docs/SignaturePacket.html index 2bb3c4a2..1fb2e0fe 100644 --- a/docs/SignaturePacket.html +++ b/docs/SignaturePacket.html @@ -99,7 +99,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -201,7 +201,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -271,7 +271,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -341,7 +341,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -423,7 +423,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -599,7 +599,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -760,7 +760,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -1048,7 +1048,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -1427,7 +1427,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -1546,7 +1546,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -1654,7 +1654,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -1765,7 +1765,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -1833,7 +1833,7 @@ block of text, and a signature that is a certification of a User ID.


diff --git a/docs/SymEncryptedIntegrityProtectedDataPacket.html b/docs/SymEncryptedIntegrityProtectedDataPacket.html index a48caa82..8229ff11 100644 --- a/docs/SymEncryptedIntegrityProtectedDataPacket.html +++ b/docs/SymEncryptedIntegrityProtectedDataPacket.html @@ -101,7 +101,7 @@ packet.

Source:
@@ -334,7 +334,7 @@ packet.

Source:
@@ -594,7 +594,7 @@ packet.

Source:
@@ -687,7 +687,7 @@ packet.


diff --git a/docs/SymEncryptedSessionKeyPacket.html b/docs/SymEncryptedSessionKeyPacket.html index c9e724e7..3db04ea1 100644 --- a/docs/SymEncryptedSessionKeyPacket.html +++ b/docs/SymEncryptedSessionKeyPacket.html @@ -165,7 +165,7 @@ the Symmetric-Key Encrypted Session Key packet.

Source:
@@ -271,7 +271,7 @@ the Symmetric-Key Encrypted Session Key packet.

Source:
@@ -345,7 +345,7 @@ the Symmetric-Key Encrypted Session Key packet.

Source:
@@ -419,7 +419,7 @@ the Symmetric-Key Encrypted Session Key packet.

Source:
@@ -550,7 +550,7 @@ the Symmetric-Key Encrypted Session Key packet.

Source:
@@ -761,7 +761,7 @@ the Symmetric-Key Encrypted Session Key packet.

Source:
@@ -929,7 +929,7 @@ the Symmetric-Key Encrypted Session Key packet.

Source:
@@ -1019,7 +1019,7 @@ the Symmetric-Key Encrypted Session Key packet.

Source:
@@ -1087,7 +1087,7 @@ the Symmetric-Key Encrypted Session Key packet.


diff --git a/docs/SymmetricallyEncryptedDataPacket.html b/docs/SymmetricallyEncryptedDataPacket.html index e99e2586..218456cf 100644 --- a/docs/SymmetricallyEncryptedDataPacket.html +++ b/docs/SymmetricallyEncryptedDataPacket.html @@ -101,7 +101,7 @@ that form whole OpenPGP messages).

Source:
@@ -197,7 +197,7 @@ that form whole OpenPGP messages).

Source:
@@ -271,7 +271,7 @@ that form whole OpenPGP messages).

Source:
@@ -477,7 +477,7 @@ See RFC 4880 9.2 f
Source:
@@ -720,7 +720,7 @@ See RFC 4880 9.2 f
Source:
@@ -795,7 +795,7 @@ See RFC 4880 9.2 f
diff --git a/docs/TrustPacket.html b/docs/TrustPacket.html index 7fb8782a..d59fa55f 100644 --- a/docs/TrustPacket.html +++ b/docs/TrustPacket.html @@ -105,7 +105,7 @@ other than local keyring files.

Source:
@@ -216,7 +216,7 @@ Currently not implemented as we ignore trust packets

Source:
@@ -262,7 +262,7 @@ Currently not implemented as we ignore trust packets


diff --git a/docs/UserAttributePacket.html b/docs/UserAttributePacket.html index 7d27b0f8..c6d1698a 100644 --- a/docs/UserAttributePacket.html +++ b/docs/UserAttributePacket.html @@ -107,7 +107,7 @@ an implementation may use any method desired.

Source:
@@ -266,7 +266,7 @@ an implementation may use any method desired.

Source:
@@ -427,7 +427,7 @@ an implementation may use any method desired.

Source:
@@ -517,7 +517,7 @@ an implementation may use any method desired.

Source:
@@ -585,7 +585,7 @@ an implementation may use any method desired.


diff --git a/docs/UserIDPacket.html b/docs/UserIDPacket.html index 3823928b..8972a080 100644 --- a/docs/UserIDPacket.html +++ b/docs/UserIDPacket.html @@ -100,7 +100,7 @@ specifies the length of the User ID.

Source:
@@ -207,7 +207,7 @@ John Doe john@example.com

Source:
@@ -338,7 +338,7 @@ John Doe john@example.com

Source:
@@ -495,7 +495,7 @@ John Doe john@example.com

Source:
@@ -585,7 +585,7 @@ John Doe john@example.com

Source:
@@ -653,7 +653,7 @@ John Doe john@example.com


diff --git a/docs/global.html b/docs/global.html index 616b2ad9..cdee46d5 100644 --- a/docs/global.html +++ b/docs/global.html @@ -161,7 +161,7 @@ This is used as fallback if the native Crypto APIs are not available.

Source:
@@ -443,7 +443,7 @@ This is used as fallback if the native Crypto APIs are not available.

Source:
@@ -656,7 +656,7 @@ This is used as fallback if the native Crypto APIs are not available.

Source:
@@ -795,7 +795,7 @@ This is used as fallback if the native Crypto APIs are not available.

Source:
@@ -1204,7 +1204,7 @@ This is used as fallback if the native Crypto APIs are not available.

Source:
@@ -1785,7 +1785,7 @@ One of decryptionKeys, sessionkeys or passwords<
Source:
@@ -2087,7 +2087,7 @@ This method does not change the original key.

Source:
@@ -2446,7 +2446,7 @@ One of decryptionKeys or passwords must be specified.<
Source:
@@ -3126,6 +3126,48 @@ must be specified. If signing keys are specified, those will be used to sign the + + + signatureNotations + + + + + +Object +| + +Array.<Object> + + + + + + + + + <optional>
+ + + + + + + + + + + + [] + + + + +

Array of notations to add to the signatures, e.g. [{ name: 'test@example.org', value: new TextEncoder().encode('test'), humanReadable: true }]

+ + + + config @@ -3208,7 +3250,7 @@ must be specified. If signing keys are specified, those will be used to sign the
Source:
@@ -3496,7 +3538,7 @@ This method does not change the original key.

Source:
@@ -4116,7 +4158,7 @@ At least one of encryptionKeys or passwords must be sp
Source:
@@ -4332,7 +4374,7 @@ At least one of encryptionKeys or passwords must be sp
Source:
@@ -4925,7 +4967,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -5273,7 +5315,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -5457,7 +5499,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -5742,7 +5784,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -6030,7 +6072,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -6318,7 +6360,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -6612,7 +6654,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -6900,7 +6942,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -7188,7 +7230,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -7476,7 +7518,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -7938,7 +7980,7 @@ to set the same date as the key creation time to ensure that old message signatu
Source:
@@ -8467,7 +8509,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
Source:
@@ -8898,6 +8940,48 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be + + + signatureNotations + + + + + +Object +| + +Array.<Object> + + + + + + + + + <optional>
+ + + + + + + + + + + + [] + + + + +

Array of notations to add to the signatures, e.g. [{ name: 'test@example.org', value: new TextEncoder().encode('test'), humanReadable: true }]

+ + + + config @@ -8980,7 +9064,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
Source:
@@ -9142,7 +9226,7 @@ the encoded bytes

Source:
@@ -9604,7 +9688,7 @@ an attribute "data" containing a stream of bytes and "type"
Source:
@@ -9848,7 +9932,7 @@ The new key includes a revocation certificate that must be removed before return
Source:
@@ -9912,7 +9996,7 @@ The new key includes a revocation certificate that must be removed before return
diff --git a/docs/index.html b/docs/index.html index f228e3ce..8dc5488f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -261,6 +261,11 @@ 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.

+

TypeScript

+

Since TS is not fully integrated in the library, TS-only dependencies are currently listed as devDependencies, so to compile the project you’ll need to add @openpgp/web-stream-tools manually:

+
npm install --save-dev @openpgp/web-stream-tools
+
+

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.

Encrypt and decrypt Uint8Array data with a password

@@ -703,7 +708,7 @@ and a subkey for encryption using Curve25519.


diff --git a/docs/module-config.html b/docs/module-config.html index 597d47cf..b0d2dbfa 100644 --- a/docs/module-config.html +++ b/docs/module-config.html @@ -89,7 +89,7 @@
Source:
@@ -247,7 +247,7 @@ Must be an integer value from 0 to 56.

Source:
@@ -365,7 +365,7 @@ Note: not all OpenPGP implementations are compatible with this option.
Source:
@@ -490,7 +490,7 @@ where key flags were ignored when selecting a key for encryption.

Source:
@@ -609,7 +609,7 @@ and have self-signature's creation date that does not match the primary key crea
Source:
@@ -730,7 +730,7 @@ This is an insecure setting:

Source:
@@ -849,7 +849,7 @@ and deferring checking their integrity until the decrypted stream has been read
Source:
@@ -961,7 +961,7 @@ and deferring checking their integrity until the decrypted stream has been read
Source:
@@ -1073,7 +1073,7 @@ and deferring checking their integrity until the decrypted stream has been read
Source:
@@ -1195,7 +1195,7 @@ See also constantTimePKCS1DecryptionSupportedSymmetricAlgorithms.Source:
@@ -1313,7 +1313,7 @@ However, the more algorithms are added, the slower the decryption procedure beco
Source:
@@ -1425,7 +1425,7 @@ However, the more algorithms are added, the slower the decryption procedure beco
Source:
@@ -1537,7 +1537,7 @@ However, the more algorithms are added, the slower the decryption procedure beco
Source:
@@ -1649,7 +1649,7 @@ However, the more algorithms are added, the slower the decryption procedure beco
Source:
@@ -1766,7 +1766,7 @@ validation error when the notation is marked as critical.

Source:
@@ -1882,7 +1882,7 @@ validation error when the notation is marked as critical.

Source:
@@ -1994,7 +1994,7 @@ validation error when the notation is marked as critical.

Source:
@@ -2111,7 +2111,7 @@ The default is 2047 since due to a bug, previous versions of OpenPGP.js could ge
Source:
@@ -2228,7 +2228,7 @@ The default is 2047 since due to a bug, previous versions of OpenPGP.js could ge
Source:
@@ -2345,7 +2345,7 @@ Only has an effect when aeadProtect is set to true.

Source:
@@ -2457,7 +2457,7 @@ Only has an effect when aeadProtect is set to true.

Source:
@@ -2569,7 +2569,7 @@ Only has an effect when aeadProtect is set to true.

Source:
@@ -2681,7 +2681,7 @@ Only has an effect when aeadProtect is set to true.

Source:
@@ -2797,7 +2797,7 @@ Only has an effect when aeadProtect is set to true.

Source:
@@ -2913,7 +2913,7 @@ Only has an effect when aeadProtect is set to true.

Source:
@@ -3029,7 +3029,7 @@ Only has an effect when aeadProtect is set to true.

Source:
@@ -3145,7 +3145,7 @@ Only has an effect when aeadProtect is set to true.

Source:
@@ -3257,7 +3257,7 @@ Only has an effect when aeadProtect is set to true.

Source:
@@ -3374,7 +3374,7 @@ Iteration Count Byte for S2K (String to Key)

Source:
@@ -3486,7 +3486,7 @@ Iteration Count Byte for S2K (String to Key)

Source:
@@ -3598,7 +3598,7 @@ Iteration Count Byte for S2K (String to Key)

Source:
@@ -3716,7 +3716,7 @@ Note: the indutny/elliptic curve library is not designed to be constant time.

Source:
@@ -3834,7 +3834,7 @@ Note: not all OpenPGP implementations are compatible with this option.
Source:
@@ -3946,7 +3946,7 @@ Note: not all OpenPGP implementations are compatible with this option.
Source:
@@ -3980,7 +3980,7 @@ Note: not all OpenPGP implementations are compatible with this option.
diff --git a/docs/module-crypto_random-RandomBuffer.html b/docs/module-crypto_random-RandomBuffer.html deleted file mode 100644 index e7bf38ae..00000000 --- a/docs/module-crypto_random-RandomBuffer.html +++ /dev/null @@ -1,593 +0,0 @@ - - - - - JSDoc: Class: RandomBuffer - - - - - - - - - - -
- -

Class: RandomBuffer

- - - - - - -
- -
- -

RandomBuffer()

- -

Buffer for secure random numbers

- - -
- -
-
- - - - -

Constructor

- - - -

new RandomBuffer()

- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - -

Methods

- - - - - - - -

(async) get(buf)

- - - - - - -
-

Take numbers out of buffer and copy to array

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
buf - - -Uint8Array - - - -

The destination array

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

init(size)

- - - - - - -
-

Initialize buffer

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
size - - -Integer - - - -

size of buffer

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

set(buf)

- - - - - - -
-

Concat array of secure random numbers to buffer

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
buf - - -Uint8Array - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/docs/module-enums.html b/docs/module-enums.html index 89622290..73e17db0 100644 --- a/docs/module-enums.html +++ b/docs/module-enums.html @@ -212,7 +212,7 @@
Source:
@@ -476,7 +476,7 @@
Source:
@@ -671,7 +671,7 @@
Source:
@@ -1878,7 +1878,7 @@
Source:
@@ -2059,7 +2059,7 @@ fingerprint format

Source:
@@ -2323,7 +2323,7 @@ fingerprint format

Source:
@@ -2589,7 +2589,7 @@ possession of more than one person.

Source:
@@ -2784,7 +2784,7 @@ possession of more than one person.

Source:
@@ -3301,7 +3301,7 @@ possession of more than one person.

Source:
@@ -3635,7 +3635,7 @@ possession of more than one person.

Source:
@@ -3853,7 +3853,7 @@ possession of more than one person.

Source:
@@ -4048,7 +4048,7 @@ possession of more than one person.

Source:
@@ -4565,7 +4565,7 @@ document) that cannot include a target subpacket.

Source:
@@ -5266,7 +5266,7 @@ document) that cannot include a target subpacket.

Source:
@@ -5576,7 +5576,7 @@ document) that cannot include a target subpacket.

Source:
@@ -5772,7 +5772,7 @@ document) that cannot include a target subpacket.

Source:
@@ -5926,7 +5926,7 @@ document) that cannot include a target subpacket.

Source:
@@ -6142,7 +6142,7 @@ document) that cannot include a target subpacket.

Source:
@@ -6239,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 9b729407..97e856fb 100644 --- a/docs/module-key_Subkey-Subkey.html +++ b/docs/module-key_Subkey-Subkey.html @@ -170,7 +170,7 @@
Source:
@@ -280,7 +280,7 @@
Source:
@@ -393,7 +393,7 @@
Source:
@@ -510,7 +510,7 @@
Source:
@@ -627,7 +627,7 @@
Source:
@@ -740,7 +740,7 @@
Source:
@@ -941,7 +941,7 @@ Returns null if the subkey is invalid.

Source:
@@ -1054,7 +1054,7 @@ Returns null if the subkey is invalid.

Source:
@@ -1171,7 +1171,7 @@ Returns null if the subkey is invalid.

Source:
@@ -1288,7 +1288,7 @@ Returns null if the subkey is invalid.

Source:
@@ -1405,7 +1405,7 @@ Returns null if the subkey is invalid.

Source:
@@ -1522,7 +1522,7 @@ Returns null if the subkey is invalid.

Source:
@@ -1639,7 +1639,7 @@ Returns null if the subkey is invalid.

Source:
@@ -1756,7 +1756,7 @@ Returns null if the subkey is invalid.

Source:
@@ -1872,7 +1872,7 @@ Returns null if the subkey is invalid.

Source:
@@ -2148,7 +2148,7 @@ Returns null if the subkey is invalid.

Source:
@@ -2486,7 +2486,7 @@ Returns null if the subkey is invalid.

Source:
@@ -2598,7 +2598,7 @@ Returns null if the subkey is invalid.

Source:
@@ -2831,7 +2831,7 @@ Returns null if the subkey is invalid.

Source:
@@ -3043,7 +3043,7 @@ and valid binding signature.

Source:
@@ -3136,7 +3136,7 @@ and valid binding signature.


diff --git a/docs/module-key_User-User.html b/docs/module-key_User-User.html index 5faee5fc..7732ad8d 100644 --- a/docs/module-key_User-User.html +++ b/docs/module-key_User-User.html @@ -170,7 +170,7 @@
Source:
@@ -403,7 +403,7 @@
Source:
@@ -515,7 +515,7 @@
Source:
@@ -788,7 +788,7 @@
Source:
@@ -846,6 +846,344 @@ +

(async) revoke(primaryKey, reasonForRevocation, date, configopt) → {Promise.<User>}

+ + + + + + +
+

Revokes the user

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
primaryKey + + +SecretKeyPacket + + + + + + + + + +

decrypted private primary key for revocation

reasonForRevocation + + +Object + + + + + + + + + +

optional, object indicating the reason for revocation

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
flag + + +module:enums.reasonForRevocation + + + +

optional, flag indicating the reason for revocation

string + + +String + + + +

optional, string explaining the reason for revocation

+ +
date + + +Date + + + + + + + + + +

optional, override the creationtime of the revocation signature

config + + +Object + + + + + + <optional>
+ + + + + +

Full configuration, defaults to openpgp.config

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

New user with revocation signature.

+
+ + + +
+
+ Type +
+
+ +Promise.<User> + + +
+
+ + + + + + + + + + + + +

toPacketList() → {PacketList}

@@ -900,7 +1238,7 @@
Source:
@@ -1103,7 +1441,7 @@
Source:
@@ -1284,7 +1622,7 @@ and validity of self signature.

Source:
@@ -1548,7 +1886,7 @@ and validity of self signature.

Source:
@@ -1815,7 +2153,7 @@ Signature validity is null if the verification keys do not correspond to the cer
Source:
@@ -1895,7 +2233,7 @@ Signature validity is null if the verification keys do not correspond to the cer
diff --git a/docs/module-type_kdf_params-KDFParams.html b/docs/module-type_kdf_params-KDFParams.html index 7e9841e2..85bed5d0 100644 --- a/docs/module-type_kdf_params-KDFParams.html +++ b/docs/module-type_kdf_params-KDFParams.html @@ -163,7 +163,7 @@
Source:
@@ -322,7 +322,7 @@
Source:
@@ -434,7 +434,7 @@
Source:
@@ -502,7 +502,7 @@
diff --git a/docs/module-type_keyid-KeyID.html b/docs/module-type_keyid-KeyID.html index d78a34b3..892a7b31 100644 --- a/docs/module-type_keyid-KeyID.html +++ b/docs/module-type_keyid-KeyID.html @@ -100,7 +100,7 @@ formed.

Source:
@@ -294,7 +294,7 @@ formed.

Source:
@@ -384,7 +384,7 @@ formed.

Source:
@@ -496,7 +496,7 @@ formed.

Source:
@@ -657,7 +657,7 @@ formed.

Source:
@@ -747,7 +747,7 @@ formed.

Source:
@@ -859,7 +859,7 @@ formed.

Source:
@@ -927,7 +927,7 @@ formed.


diff --git a/docs/module-type_s2k-S2K.html b/docs/module-type_s2k-S2K.html index fced1364..5b4d2ef2 100644 --- a/docs/module-type_s2k-S2K.html +++ b/docs/module-type_s2k-S2K.html @@ -152,7 +152,7 @@
Source:
@@ -261,7 +261,7 @@
Source:
@@ -331,7 +331,7 @@
Source:
@@ -405,7 +405,7 @@
Source:
@@ -479,7 +479,7 @@
Source:
@@ -611,7 +611,7 @@ hashAlgorithm

Source:
@@ -773,7 +773,7 @@ hashAlgorithm hash length

Source:
@@ -885,7 +885,7 @@ hashAlgorithm hash length

Source:
@@ -953,7 +953,7 @@ hashAlgorithm hash length


diff --git a/package-lock.json b/package-lock.json index 5d739de4..37c3b773 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "openpgp", - "version": "5.5.0", + "version": "5.6.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "openpgp", - "version": "5.5.0", + "version": "5.6.0", "license": "LGPL-3.0+", "dependencies": { "asn1.js": "^5.0.0" diff --git a/package.json b/package.json index 7af118ed..52dc7d87 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.5.0", + "version": "5.6.0", "license": "LGPL-3.0+", "homepage": "https://openpgpjs.org/", "engines": {