From 183707701287f59deb63489ad33771602c9545bb Mon Sep 17 00:00:00 2001 From: Daniel Huigens Date: Tue, 20 Jul 2021 19:41:10 +0200 Subject: [PATCH] 5.0.0-4 --- docs/AEADEncryptedDataPacket.html | 14 +- docs/CleartextMessage.html | 18 +- docs/CompressedDataPacket.html | 20 +- docs/Key.html | 380 ++++--- docs/LiteralDataPacket.html | 22 +- docs/MarkerPacket.html | 6 +- docs/Message.html | 126 ++- docs/OnePassSignaturePacket.html | 20 +- docs/PacketList.html | 16 +- docs/PrivateKey.html | 134 +-- docs/PublicKey.html | 122 +-- docs/PublicKeyEncryptedSessionKeyPacket.html | 14 +- docs/PublicKeyPacket.html | 48 +- docs/PublicSubkeyPacket.html | 48 +- docs/SecretKeyPacket.html | 72 +- docs/SecretSubkeyPacket.html | 72 +- docs/Signature.html | 120 ++- docs/SignaturePacket.html | 156 +-- ...EncryptedIntegrityProtectedDataPacket.html | 8 +- docs/SymEncryptedSessionKeyPacket.html | 12 +- docs/SymmetricallyEncryptedDataPacket.html | 12 +- docs/TrustPacket.html | 6 +- docs/UserAttributePacket.html | 10 +- docs/UserIDPacket.html | 12 +- docs/global.html | 873 ++++++++++++++-- docs/index.html | 146 +-- docs/module-config.html | 60 +- docs/module-crypto_random-RandomBuffer.html | 10 +- docs/module-enums.html | 38 +- ...Key.html => module-key_Subkey-Subkey.html} | 366 ++++--- docs/module-key_User-User.html | 960 +++++++++++------- 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 | 2 +- package.json | 2 +- 36 files changed, 2556 insertions(+), 1411 deletions(-) rename docs/{module-key_SubKey-SubKey.html => module-key_Subkey-Subkey.html} (77%) diff --git a/docs/AEADEncryptedDataPacket.html b/docs/AEADEncryptedDataPacket.html index 3d591533..3a4c0d63 100644 --- a/docs/AEADEncryptedDataPacket.html +++ b/docs/AEADEncryptedDataPacket.html @@ -98,7 +98,7 @@ AEAD Protected Data Packet

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

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

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

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

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

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


diff --git a/docs/CleartextMessage.html b/docs/CleartextMessage.html index a9eef555..30d89b87 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:
@@ -937,7 +937,7 @@ See https://tools.ietf.o
Source:
@@ -995,7 +995,7 @@ See https://tools.ietf.o -

(async) verify(keys, dateopt, configopt) → {Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<Boolean>}>>}

+

(async) verify(keys, dateopt, configopt) → {Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<true>}>>}

@@ -1174,7 +1174,7 @@ See https://tools.ietf.o
Source:
@@ -1214,7 +1214,7 @@ See https://tools.ietf.o
-Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<Boolean>}>> +Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<true>}>>
@@ -1242,7 +1242,7 @@ See https://tools.ietf.o
diff --git a/docs/CompressedDataPacket.html b/docs/CompressedDataPacket.html index 5fbf9451..6daa6411 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 64717493..823bc4a9 100644 --- a/docs/Key.html +++ b/docs/Key.html @@ -96,7 +96,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.

Source:
@@ -152,7 +152,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.

-

(async) applyRevocationCertificate(revocationCertificate, configopt) → {Promise.<Key>}

+

(async) applyRevocationCertificate(revocationCertificate, dateopt, configopt) → {Promise.<Key>}

@@ -229,6 +229,39 @@ if it is a valid revocation signature.

+ + + date + + + + + +Date + + + + + + + + + <optional>
+ + + + + + + + + + +

Date to verify the certificate

+ + + + config @@ -300,7 +333,7 @@ if it is a valid revocation signature.

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

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

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

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

-

(async) getEncryptionKey(keyID,, date,, userID,, configopt) → {Promise.<(Key|SubKey)>}

+

(async) getEncryptionKey(keyIDopt, dateopt, userIDopt, configopt) → {Promise.<(Key|Subkey)>}

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

- keyID, + keyID @@ -820,6 +853,8 @@ if it is a valid revocation signature.

+ <optional>
+ @@ -829,14 +864,14 @@ if it is a valid revocation signature.

-

optional

+

key ID of a specific key to retrieve

- date, + date @@ -851,6 +886,8 @@ if it is a valid revocation signature.

+ <optional>
+ @@ -860,20 +897,20 @@ if it is a valid revocation signature.

-

optional

+

use the fiven date date to to check key validity instead of the current date

- userID, + userID -String +Object @@ -882,6 +919,8 @@ if it is a valid revocation signature.

+ <optional>
+ @@ -891,7 +930,7 @@ if it is a valid revocation signature.

-

optional

+

filter keys for the given user ID

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

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

-Promise.<(Key|SubKey)> +Promise.<(Key|Subkey)>
@@ -1037,7 +1076,7 @@ if it is a valid revocation signature.

-

(async) getExpirationTime(capabilities,, keyID,, userID,, configopt) → {Promise.<(Date|Infinity|null)>}

+

(async) getExpirationTime(userIDopt, configopt) → {Promise.<(Date|Infinity|null)>}

@@ -1045,10 +1084,8 @@ if it is a valid revocation signature.

-

Returns the latest date when the key can be used for encrypting, signing, or both, depending on the capabilities paramater. -When capabilities is null, defaults to returning the expiry date of the primary key. -Returns null if capabilities is passed and the key does not have the specified capabilities or is revoked or invalid. -Returns Infinity if the key doesn't expire.

+

Returns the expiration date of the primary key, considering self-certifications and direct-key signatures. +Returns Infinity if the key doesn't expire, or null if the key is revoked or invalid.

@@ -1086,75 +1123,7 @@ Returns Infinity if the key doesn't expire.

- capabilities, - - - - - -encrypt -| - -sign -| - -encrypt_sign - - - - - - - - - - - - - - - - - -

optional

- - - - - - - keyID, - - - - - -module:type/keyid~KeyID - - - - - - - - - - - - - - - - - -

optional

- - - - - - - userID, + userID @@ -1169,6 +1138,8 @@ Returns Infinity if the key doesn't expire.

+ <optional>
+ @@ -1178,7 +1149,7 @@ Returns Infinity if the key doesn't expire.

-

optional user ID

+

User ID to consider instead of the primary user

@@ -1254,7 +1225,7 @@ Returns Infinity if the key doesn't expire.

Source:
@@ -1362,7 +1333,7 @@ Returns Infinity if the key doesn't expire.

Source:
@@ -1474,7 +1445,7 @@ Returns Infinity if the key doesn't expire.

Source:
@@ -1586,7 +1557,7 @@ Returns Infinity if the key doesn't expire.

Source:
@@ -1640,7 +1611,7 @@ Returns Infinity if the key doesn't expire.

-

getKeys(keyIDopt) → {Array.<(Key|SubKey)>}

+

getKeys(keyIDopt) → {Array.<(Key|Subkey)>}

@@ -1764,7 +1735,7 @@ If no keyID is given, returns all keys, starting with the primary key.

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

-Array.<(Key|SubKey)> +Array.<(Key|Subkey)>
@@ -2007,7 +1978,7 @@ If no keyID is given, returns all keys, starting with the primary key.

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

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

-

(async) getSigningKey(keyID,, dateopt, userID,, configopt) → {Promise.<(Key|SubKey)>}

+

(async) getSigningKey(keyIDopt, dateopt, userIDopt, configopt) → {Promise.<(Key|Subkey)>}

@@ -2306,6 +2277,8 @@ If no keyID is given, returns all keys, starting with the primary key.

+ Default + Description @@ -2316,7 +2289,7 @@ If no keyID is given, returns all keys, starting with the primary key.

- keyID, + keyID @@ -2331,6 +2304,8 @@ If no keyID is given, returns all keys, starting with the primary key.

+ <optional>
+ @@ -2339,8 +2314,14 @@ If no keyID is given, returns all keys, starting with the primary key.

+ + + null + + + -

optional

+

key ID of a specific key to retrieve

@@ -2372,15 +2353,19 @@ If no keyID is given, returns all keys, starting with the primary key.

+ + + + -

Use the given date for verification instead of the current time

+

use the fiven date date to to check key validity instead of the current date

- userID, + userID @@ -2395,6 +2380,8 @@ If no keyID is given, returns all keys, starting with the primary key.

+ <optional>
+ @@ -2403,8 +2390,12 @@ If no keyID is given, returns all keys, starting with the primary key.

+ + + + -

optional user ID

+

filter keys for the given user ID

@@ -2436,6 +2427,10 @@ If no keyID is given, returns all keys, starting with the primary key.

+ + + +

Full configuration, defaults to openpgp.config

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

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

-Promise.<(Key|SubKey)> +Promise.<(Key|Subkey)>
@@ -2550,7 +2545,7 @@ If no keyID is given, returns all keys, starting with the primary key.

-

getSubkeys(keyIDopt) → {Array.<SubKey>}

+

getSubkeys(keyIDopt) → {Array.<Subkey>}

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

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

-Array.<SubKey> +Array.<Subkey>
@@ -2786,7 +2781,7 @@ If no keyID is given, returns all subkeys.

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

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

-

(async) isRevoked(signature, key,, date, configopt) → {Promise.<Boolean>}

+

(async) isRevoked(signature, key,, dateopt, configopt) → {Promise.<Boolean>}

@@ -3088,6 +3083,8 @@ If no keyID is given, returns all subkeys.

+ <optional>
+ @@ -3097,7 +3094,7 @@ If no keyID is given, returns all subkeys.

-

Use the given date instead of the current time

+

Use the given date for verification, instead of the current time

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

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

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

-

(async) signAllUsers(privateKeys, configopt) → {Promise.<Key>}

+

(async) signAllUsers(privateKeys, dateopt, configopt) → {Promise.<Key>}

@@ -3468,6 +3465,39 @@ If no keyID is given, returns all subkeys.

+ + + date + + + + + +Date + + + + + + + + + <optional>
+ + + + + + + + + + +

Use the given date for signing, instead of the current time

+ + + + config @@ -3539,7 +3569,7 @@ If no keyID is given, returns all subkeys.

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

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

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

-

(async) update(sourceKey, configopt) → {Promise.<Key>}

+

(async) update(sourceKey, dateopt, configopt) → {Promise.<Key>}

@@ -4058,6 +4088,39 @@ a private key is returned.

+ + + date + + + + + +Date + + + + + + + + + <optional>
+ + + + + + + + + + +

Date to verify validity of signatures and keys

+ + + + config @@ -4129,7 +4192,7 @@ a private key is returned.

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

-

(async) verifyAllUsers(keys, configopt) → {Promise.<Array.<{userID: String, keyID: module:type/keyid~KeyID, valid: Boolean}>>}

+

(async) verifyAllUsers(verificationKeysopt, dateopt, configopt) → {Promise.<Array.<{userID: String, keyID: module:type/keyid~KeyID, valid: (Boolean|null)}>>}

@@ -4237,13 +4300,13 @@ a private key is returned.

- keys + verificationKeys -Array.<Key> +Array.<PublicKey> @@ -4252,6 +4315,8 @@ a private key is returned.

+ <optional>
+ @@ -4266,6 +4331,39 @@ a private key is returned.

+ + + date + + + + + +Date + + + + + + + + + <optional>
+ + + + + + + + + + +

Use the given date for verification instead of the current time

+ + + + config @@ -4337,7 +4435,7 @@ a private key is returned.

Source:
@@ -4366,7 +4464,8 @@ a private key is returned.

-

List of userID, signer's keyID and validity of signature

+

List of userID, signer's keyID and validity of signature. +Signature validity is null if the verification keys do not correspond to the certificate.

@@ -4377,7 +4476,7 @@ a private key is returned.

-Promise.<Array.<{userID: String, keyID: module:type/keyid~KeyID, valid: Boolean}>> +Promise.<Array.<{userID: String, keyID: module:type/keyid~KeyID, valid: (Boolean|null)}>>
@@ -4577,7 +4676,7 @@ and valid self signature. Throws if the primary key is invalid.

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

-

(async) verifyPrimaryUser(keys, dateopt, userIDopt, configopt) → {Promise.<Array.<{keyID: module:type/keyid~KeyID, valid: Boolean}>>}

+

(async) verifyPrimaryUser(verificationKeysopt, dateopt, userIDopt, configopt) → {Promise.<Array.<{keyID: module:type/keyid~KeyID, valid: (Boolean|null)}>>}

@@ -4692,13 +4791,13 @@ and valid self signature. Throws if the primary key is invalid.

- keys + verificationKeys -Array.<Key> +Array.<PublicKey> @@ -4707,6 +4806,8 @@ and valid self signature. Throws if the primary key is invalid.

+ <optional>
+ @@ -4716,7 +4817,7 @@ and valid self signature. Throws if the primary key is invalid.

-

array of keys to verify certificate signatures

+

array of keys to verify certificate signatures, instead of the primary key

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

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

-

List of signer's keyID and validity of signature

+

List of signer's keyID and validity of signature. +Signature validity is null if the verification keys do not correspond to the certificate.

@@ -4898,7 +5000,7 @@ and valid self signature. Throws if the primary key is invalid.

-Promise.<Array.<{keyID: module:type/keyid~KeyID, valid: Boolean}>> +Promise.<Array.<{keyID: module:type/keyid~KeyID, valid: (Boolean|null)}>>
@@ -4970,7 +5072,7 @@ and valid self signature. Throws if the primary key is invalid.

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


diff --git a/docs/LiteralDataPacket.html b/docs/LiteralDataPacket.html index 654c1767..58b7e34e 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:
@@ -986,7 +986,7 @@ with normalized end of line to \n

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

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

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

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

Source:
@@ -1605,7 +1605,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 811ed826..25e4702b 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 2b1f849e..aa7e2a42 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:
@@ -719,7 +719,7 @@ See https://tools.iet -

(async, static) generateSessionKey(encryptionKeysopt, dateopt, userIDsopt, configopt) → {Promise.<{data: Uint8Array, algorithm: String}>}

+

(async, static) generateSessionKey(encryptionKeysopt, dateopt, userIDsopt, configopt) → {Promise.<{data: Uint8Array, algorithm: String, aeadAlgorithm: (undefined|String)}>}

@@ -933,7 +933,7 @@ See https://tools.iet
Source:
@@ -962,7 +962,7 @@ See https://tools.iet
-

Object with session key data and algorithm.

+

Object with session key data and algorithms.

@@ -973,7 +973,7 @@ See https://tools.iet
-Promise.<{data: Uint8Array, algorithm: String}> +Promise.<{data: Uint8Array, algorithm: String, aeadAlgorithm: (undefined|String)}>
@@ -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:
@@ -1553,7 +1553,7 @@ See https://tools.iet -

(async) decrypt(decryptionKeysopt, passwordsopt, sessionKeysopt, configopt) → {Promise.<Message>}

+

(async) decrypt(decryptionKeysopt, passwordsopt, sessionKeysopt, dateopt, configopt) → {Promise.<Message>}

@@ -1696,6 +1696,39 @@ See https://tools.iet + + + date + + + + + +Date + + + + + + + + + <optional>
+ + + + + + + + + + +

Use the given date for key verification instead of the current time

+ + + + config @@ -1767,7 +1800,7 @@ See https://tools.iet
Source:
@@ -1825,7 +1858,7 @@ See https://tools.iet -

(async) decryptSessionKeys(decryptionKeysopt, passwordsopt, configopt) → {Promise.<Array.<{data: Uint8Array, algorithm: String}>>}

+

(async) decryptSessionKeys(decryptionKeysopt, passwordsopt, dateopt, configopt) → {Promise.<Array.<{data: Uint8Array, algorithm: String}>>}

@@ -1935,6 +1968,39 @@ See https://tools.iet + + + date + + + + + +Date + + + + + + + + + <optional>
+ + + + + + + + + + +

Use the given date for key verification, instead of current time

+ + + + config @@ -2006,7 +2072,7 @@ See https://tools.iet
Source:
@@ -2446,7 +2512,7 @@ See https://tools.iet
Source:
@@ -2558,7 +2624,7 @@ See https://tools.iet
Source:
@@ -2670,7 +2736,7 @@ See https://tools.iet
Source:
@@ -2785,7 +2851,7 @@ See https://tools.iet
Source:
@@ -2900,7 +2966,7 @@ See https://tools.iet
Source:
@@ -3012,7 +3078,7 @@ See https://tools.iet
Source:
@@ -3379,7 +3445,7 @@ See https://tools.iet
Source:
@@ -3743,7 +3809,7 @@ See https://tools.iet
Source:
@@ -3855,7 +3921,7 @@ See https://tools.iet
Source:
@@ -3913,7 +3979,7 @@ See https://tools.iet -

(async) verify(verificationKeys, dateopt, configopt) → {Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<Boolean>}>>}

+

(async) verify(verificationKeys, dateopt, configopt) → {Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<true>}>>}

@@ -4092,7 +4158,7 @@ See https://tools.iet
Source:
@@ -4132,7 +4198,7 @@ See https://tools.iet
-Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<Boolean>}>> +Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<true>}>>
@@ -4150,7 +4216,7 @@ See https://tools.iet -

(async) verifyDetached(verificationKeys, signature, date, configopt) → {Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<Boolean>}>>}

+

(async) verifyDetached(verificationKeys, signature, date, configopt) → {Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<true>}>>}

@@ -4358,7 +4424,7 @@ See https://tools.iet
Source:
@@ -4398,7 +4464,7 @@ See https://tools.iet
-Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<Boolean>}>> +Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<true>}>>
@@ -4470,7 +4536,7 @@ See https://tools.iet
Source:
@@ -4538,7 +4604,7 @@ See https://tools.iet
diff --git a/docs/OnePassSignaturePacket.html b/docs/OnePassSignaturePacket.html index 12d28c66..fce2ba9f 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:
@@ -263,7 +263,7 @@ that describes another signature to be applied to the same message data.

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

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

Source:
@@ -471,7 +471,7 @@ Signature types are described in
Source:
@@ -535,7 +535,7 @@ Signature types are described in
Source:
@@ -666,7 +666,7 @@ Signature types are described in
Source:
@@ -778,7 +778,7 @@ Signature types are described in
Source:
@@ -846,7 +846,7 @@ Signature types are described in
diff --git a/docs/PacketList.html b/docs/PacketList.html index a138d589..25b8ef25 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 2512a5b2..bc044cb3 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:
@@ -762,7 +762,7 @@ Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the p -

(async) getDecryptionKeys(keyID,, date,, userID,, configopt) → {Promise.<Array.<(Key|SubKey)>>}

+

(async) getDecryptionKeys(keyID,, date,, userID,, configopt) → {Promise.<Array.<(Key|Subkey)>>}

@@ -971,7 +971,7 @@ This is useful to retrieve keys for session key decryption

Source:
@@ -1011,7 +1011,7 @@ This is useful to retrieve keys for session key decryption

-Promise.<Array.<(Key|SubKey)>> +Promise.<Array.<(Key|Subkey)>>
@@ -1084,7 +1084,7 @@ A dummy key is considered encrypted.

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

Source:
- - - - - - - - - - - - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Boolean - - -
-
- - - - - - - - - - - - - -

isPublic() → {Boolean}

- - - - - - -
-

Returns true if this is a public key

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

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

Source:
@@ -1874,7 +1766,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err
Source:
@@ -1949,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 400aa114..f05ff378 100644 --- a/docs/PublicKey.html +++ b/docs/PublicKey.html @@ -144,7 +144,7 @@
Source:
@@ -315,7 +315,7 @@
Source:
@@ -373,7 +373,7 @@ -

isPrivate() → {Boolean}

+

isPrivate() → {false}

@@ -427,7 +427,7 @@
Source:
@@ -463,115 +463,7 @@
-Boolean - - -
-
- - - - - - - - - - - - - -

isPublic() → {Boolean}

- - - - - - -
-

Returns true if this is a public key

-
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Boolean +false
@@ -643,7 +535,7 @@
Source:
@@ -711,7 +603,7 @@
diff --git a/docs/PublicKeyEncryptedSessionKeyPacket.html b/docs/PublicKeyEncryptedSessionKeyPacket.html index 81c9baa2..a5693be9 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:
@@ -341,7 +341,7 @@ packets (tag 1)

Source:
@@ -509,7 +509,7 @@ packets (tag 1)

Source:
@@ -677,7 +677,7 @@ packets (tag 1)

Source:
@@ -767,7 +767,7 @@ packets (tag 1)

Source:
@@ -835,7 +835,7 @@ packets (tag 1)


diff --git a/docs/PublicKeyPacket.html b/docs/PublicKeyPacket.html index 024e9471..78ee59b5 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 2ecfc067..dc1fba2e 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 9971d485..c89ad634 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 b30bb05c..dde5d4b4 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 4bb1f435..beefca20 100644 --- a/docs/Signature.html +++ b/docs/Signature.html @@ -144,7 +144,7 @@
Source:
@@ -322,7 +322,7 @@
Source:
@@ -380,6 +380,118 @@ +

getSigningKeyIDs() → {Array.<KeyID>}

+ + + + + + +
+

Returns an array of KeyIDs of all of the issuers who created this signature

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

The Key IDs of the signing keys

+
+ + + +
+
+ Type +
+
+ +Array.<KeyID> + + +
+
+ + + + + + + + + + + + +

write() → {ReadableStream.<Uint8Array>}

@@ -434,7 +546,7 @@
Source:
@@ -502,7 +614,7 @@
diff --git a/docs/SignaturePacket.html b/docs/SignaturePacket.html index 402ca222..3151c49c 100644 --- a/docs/SignaturePacket.html +++ b/docs/SignaturePacket.html @@ -28,7 +28,7 @@
-

SignaturePacket(date)

+

SignaturePacket()

Implementation of the Signature Packet (Tag 2)

RFC4480 5.2: @@ -49,7 +49,7 @@ block of text, and a signature that is a certification of a User ID.

-

new SignaturePacket(date)

+

new SignaturePacket()

@@ -64,55 +64,6 @@ block of text, and a signature that is a certification of a User ID.

-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
date - - -Date - - - -

The creation date of the signature

- - @@ -148,7 +99,7 @@ block of text, and a signature that is a certification of a User ID.

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

-

getExpirationTime() → {Date}

+

getExpirationTime() → {Date|Infinity}

@@ -258,7 +209,7 @@ block of text, and a signature that is a certification of a User ID.

Source:
@@ -299,6 +250,9 @@ block of text, and a signature that is a certification of a User ID.

Date +| + +Infinity
@@ -431,7 +385,7 @@ block of text, and a signature that is a certification of a User ID.

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

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

-

(async) sign(key, data, detachedopt)

+

(async) sign(key, data, dateopt, detachedopt)

@@ -766,6 +720,43 @@ block of text, and a signature that is a certification of a User ID.

+ + + date + + + + + +Date + + + + + + + + + <optional>
+ + + + + + + + + + + + + + +

The signature creation time.

+ + + + detached @@ -843,7 +834,7 @@ block of text, and a signature that is a certification of a User ID.

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

-

(async) verify(key, signatureType, data, detachedopt, configopt)

+

(async) verify(key, signatureType, data, dateopt, detachedopt, configopt)

@@ -1071,6 +1062,43 @@ block of text, and a signature that is a certification of a User ID.

+ + + date + + + + + +Date + + + + + + + + + <optional>
+ + + + + + + + + + + + + + +

Use the given date instead of the current time to check for signature validity and expiration

+ + + + detached @@ -1185,7 +1213,7 @@ block of text, and a signature that is a certification of a User ID.

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

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

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

Source:
@@ -1591,7 +1619,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 0f6e8c78..59f6e202 100644 --- a/docs/SymEncryptedIntegrityProtectedDataPacket.html +++ b/docs/SymEncryptedIntegrityProtectedDataPacket.html @@ -101,7 +101,7 @@ packet.

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

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

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


diff --git a/docs/SymEncryptedSessionKeyPacket.html b/docs/SymEncryptedSessionKeyPacket.html index 05b60e36..d74cbecc 100644 --- a/docs/SymEncryptedSessionKeyPacket.html +++ b/docs/SymEncryptedSessionKeyPacket.html @@ -165,7 +165,7 @@ the Symmetric-Key Encrypted Session Key packet.

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

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

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

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

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


diff --git a/docs/SymmetricallyEncryptedDataPacket.html b/docs/SymmetricallyEncryptedDataPacket.html index d20fc3e8..79915158 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 80c54ec2..054c4b63 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 24642114..4b598bb1 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 0052d4c7..749295d9 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 d5bca1e9..65cf2edc 100644 --- a/docs/global.html +++ b/docs/global.html @@ -352,7 +352,7 @@
Source:
@@ -565,7 +565,7 @@
Source:
@@ -704,7 +704,7 @@
Source:
@@ -1113,7 +1113,7 @@
Source:
@@ -1179,8 +1179,8 @@
-

Decrypts a message with the user's private key, a session key or a password. Either a private key, -a session key or a password must be specified.

+

Decrypts a message with the user's private key, a session key or a password. +One of decryptionKeys, sessionkeys or passwords must be specified (passing a combination of these options is not supported).

@@ -1694,7 +1694,7 @@ a session key or a password must be specified.

Source:
@@ -1731,8 +1731,8 @@ a session key or a password must be specified.

signatures: [ { keyID: module:type/keyid~KeyID, - verified: Promise<Boolean>, - valid: Boolean (if `message` was not created from a stream) + verified: Promise<true>, + signature: Promise<Signature> }, ... ] } @@ -1994,7 +1994,7 @@ This method does not change the original key.

Source:
@@ -2052,7 +2052,7 @@ This method does not change the original key.

-

(async) decryptSessionKeys(options) → {Promise.<Object>}

+

(async) decryptSessionKeys(options) → {Promise.<Array.<Object>>}

@@ -2060,8 +2060,8 @@ This method does not change the original key.

-

Decrypt symmetric session keys with a private key or password. Either a private key or -a password must be specified.

+

Decrypt symmetric session keys using private keys or passwords (not both). +One of decryptionKeys or passwords must be specified.

@@ -2242,6 +2242,39 @@ a password must be specified.

+ + + date + + + + + +Date + + + + + + + + + <optional>
+ + + + + + + + + + +

Date to use for key verification instead of the current time

+ + + + config @@ -2320,7 +2353,7 @@ a password must be specified.

Source:
@@ -2373,7 +2406,7 @@ a password must be specified.

-Promise.<Object> +Promise.<Array.<Object>>
@@ -2399,7 +2432,7 @@ a password must be specified.

-

Encrypts message text/data with public keys, passwords or both at once. At least either encryption keys or passwords +

Encrypts a message using public keys, passwords or both at once. At least one of encryptionKeys or passwords must be specified. If signing keys are specified, those will be used to sign the message.

@@ -2674,13 +2707,19 @@ must be specified. If signing keys are specified, those will be used to sign the - armor + format -Boolean +'armored' +| + +'binary' +| + +'object' @@ -2701,12 +2740,12 @@ must be specified. If signing keys are specified, those will be used to sign the - true + 'armored' -

Whether the return values should be ascii armored (true, the default) or binary (false)

+

Format of the returned message

@@ -2795,7 +2834,10 @@ must be specified. If signing keys are specified, those will be used to sign the -Array.<module:type/keyid~KeyID> +KeyID +| + +Array.<KeyID> @@ -2834,7 +2876,10 @@ must be specified. If signing keys are specified, those will be used to sign the -Array.<module:type/keyid~KeyID> +KeyID +| + +Array.<KeyID> @@ -2912,6 +2957,9 @@ must be specified. If signing keys are specified, those will be used to sign the +Object +| + Array.<Object> @@ -2951,6 +2999,9 @@ must be specified. If signing keys are specified, those will be used to sign the +Object +| + Array.<Object> @@ -3064,7 +3115,7 @@ must be specified. If signing keys are specified, those will be used to sign the
Source:
@@ -3352,7 +3403,7 @@ This method does not change the original key.

Source:
@@ -3418,8 +3469,8 @@ This method does not change the original key.

-

Encrypt a symmetric session key with public keys, passwords, or both at once. At least either public keys -or passwords must be specified.

+

Encrypt a symmetric session key with public keys, passwords, or both at once. +At least one of encryptionKeys or passwords must be specified.

@@ -3688,13 +3739,16 @@ or passwords must be specified.

- armor + format -Boolean +'armored' +| + +'binary' @@ -3715,12 +3769,12 @@ or passwords must be specified.

- true + 'armored' -

Whether the return values should be ascii armored (true, the default) or binary (false)

+

Format of the returned value

@@ -3772,7 +3826,10 @@ or passwords must be specified.

-Array.<module:type/keyid~KeyID> +KeyID +| + +Array.<KeyID> @@ -3850,7 +3907,10 @@ or passwords must be specified.

-Array +Object +| + +Array.<Object> @@ -3963,7 +4023,7 @@ or passwords must be specified.

Source:
@@ -4021,6 +4081,224 @@ or passwords must be specified.

+

formatObject(object, format, config) → {String|Uint8Array|Object}

+ + + + + + +
+

Convert the object to the given format

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
object + + +Key +| + +Message + + + +
format + + +'armored' +| + +'binary' +| + +'object' + + + +
config + + +Object + + + +

Full configuration

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +String +| + +Uint8Array +| + +Object + + +
+
+ + + + + + + + + + + + +

(async) generateKey(options) → {Promise.<Object>}

@@ -4029,7 +4307,8 @@ or passwords must be specified.

-

Generates a new OpenPGP key pair. Supports RSA and ECC keys. By default, primary and subkeys will be of same type.

+

Generates a new OpenPGP key pair. Supports RSA and ECC keys. By default, primary and subkeys will be of same type. +The generated primary key will have signing capabilities. By default, one subkey with encryption capabilities is also generated.

@@ -4426,6 +4705,51 @@ default to main key options, except for sign parameter that default + + + format + + + + + +'armored' +| + +'binary' +| + +'object' + + + + + + + + + <optional>
+ + + + + + + + + + + + 'armored' + + + + +

format of the output keys

+ + + + config @@ -4508,7 +4832,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -4538,7 +4862,7 @@ default to main key options, except for sign parameter that default

The generated key object in the form: -{ key:PrivateKey, privateKeyArmored:String, publicKeyArmored:String, revocationCertificate:String }

+{ privateKey:PrivateKey|Uint8Array|String, publicKey:PublicKey|Uint8Array|String, revocationCertificate:String }

@@ -4740,7 +5064,10 @@ default to main key options, except for sign parameter that default -Array +Object +| + +Array.<Object> @@ -4853,7 +5180,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -5037,7 +5364,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -5060,6 +5387,38 @@ default to main key options, except for sign parameter that default +
Throws:
+ + + +
+
+
+

for disallowed or unknown packets

+
+
+
+
+
+
+ Type +
+
+ +Error +| + +UnsupportedError + + +
+
+
+
+
+ + +
Returns:
@@ -5290,7 +5649,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -5578,7 +5937,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -5866,7 +6225,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -6160,7 +6519,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -6448,7 +6807,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -6736,7 +7095,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -7024,7 +7383,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -7358,6 +7717,51 @@ default to main key options, except for sign parameter that default + + + format + + + + + +'armored' +| + +'binary' +| + +'object' + + + + + + + + + <optional>
+ + + + + + + + + + + + 'armored' + + + + +

format of the output keys

+ + + + config @@ -7440,7 +7844,7 @@ default to main key options, except for sign parameter that default
Source:
@@ -7470,7 +7874,7 @@ default to main key options, except for sign parameter that default

The generated key object in the form: -{ key:PrivateKey, privateKeyArmored:String, publicKeyArmored:String, revocationCertificate:String }

+{ privateKey:PrivateKey|Uint8Array|String, publicKey:PublicKey|Uint8Array|String, revocationCertificate:String }

@@ -7578,6 +7982,8 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be + Default + Description @@ -7611,6 +8017,10 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be + + + +

Public or private key to revoke

@@ -7644,6 +8054,10 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be + + + +

Revocation certificate to revoke the key with

@@ -7677,6 +8091,10 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be + + + +

Object indicating the reason for revocation

Properties
@@ -7791,6 +8209,88 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be + + + date + + + + + +Date + + + + + + + + + <optional>
+ + + + + + + + + + + + + + +

Use the given date instead of the current time to verify validity of revocation certificate (if provided), or as creation time of the revocation signature

+ + + + + + + format + + + + + +'armored' +| + +'binary' +| + +'object' + + + + + + + + + <optional>
+ + + + + + + + + + + + 'armored' + + + + +

format of the output key(s)

+ + + + config @@ -7818,6 +8318,10 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be + + + +

Custom configuration settings to overwrite those in config

@@ -7869,7 +8373,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
Source:
@@ -7898,9 +8402,9 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
-

The revoked key object in the form: -{ privateKey:PrivateKey, privateKeyArmored:String, publicKey:PublicKey, publicKeyArmored:String } -(if private key is passed) or { publicKey:PublicKey, publicKeyArmored:String } (otherwise)

+

The revoked key in the form: +{ privateKey:PrivateKey|Uint8Array|String, publicKey:PublicKey|Uint8Array|String } if private key is passed, or +{ privateKey: null, publicKey:PublicKey|Uint8Array|String } otherwise

@@ -7929,7 +8433,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be -

(async) sign(options) → {Promise.<(MaybeStream.<String>|MaybeStream.<Uint8Array>)>}

+

(async) sign(options) → {Promise.<MaybeStream.<(String|Uint8Array)>>}

@@ -8095,13 +8599,19 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be - armor + format -Boolean +'armored' +| + +'binary' +| + +'object' @@ -8122,12 +8632,12 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be - true + 'armored' -

Whether the return values should be ascii armored (true, the default) or binary (false)

+

Format of the returned message

@@ -8179,7 +8689,10 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be -Array.<module:type/keyid~KeyID> +KeyID +| + +Array.<KeyID> @@ -8257,6 +8770,9 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be +Object +| + Array.<Object> @@ -8370,7 +8886,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
Source:
@@ -8410,7 +8926,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
-Promise.<(MaybeStream.<String>|MaybeStream.<Uint8Array>)> +Promise.<MaybeStream.<(String|Uint8Array)>>
@@ -8532,7 +9048,7 @@ the encoded bytes

Source:
@@ -8994,7 +9510,7 @@ an attribute "data" containing a stream of bytes and "type"
Source:
@@ -9030,8 +9546,8 @@ an attribute "data" containing a stream of bytes and "type" signatures: [ { keyID: module:type/keyid~KeyID, - verified: Promise<Boolean>, - valid: Boolean (if `message` was not created from a stream) + verified: Promise<true>, + signature: Promise<Signature> }, ... ] } @@ -9058,6 +9574,233 @@ an attribute "data" containing a stream of bytes and "type" + + + + + +

(async) wrapKeyObject(secretKeyPacket, secretSubkeyPackets, options, config) → {PrivateKey}

+ + + + + + +
+

Construct PrivateKey object from the given key packets, add certification signatures and set passphrase protection +The new key includes a revocation certificate that must be removed before returning the key, otherwise the key is considered revoked.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
secretKeyPacket + + +SecretKeyPacket + + + +
secretSubkeyPackets + + +SecretSubkeyPacket + + + +
options + + +Object + + + +
config + + +Object + + + +

Full configuration

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +PrivateKey + + +
+
+ + + + + + + + @@ -9073,7 +9816,7 @@ an attribute "data" containing a stream of bytes and "type"
diff --git a/docs/index.html b/docs/index.html index 6be921e4..4938bd4d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -43,7 +43,7 @@
-

OpenPGP.js BrowserStack Status Join the chat on Gitter

+

OpenPGP.js BrowserStack Status Join the chat on Gitter

OpenPGP.js is a JavaScript implementation of the OpenPGP protocol. It implements RFC4880 and parts of RFC4880bis.

Table of Contents

+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

New user with new certifications.

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

clone() → {User}

+ + + + + + +
+

Shallow clone

+
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +User + + +
+
+ + + + + + + + + + + + + +

(async) isRevoked(certificate, keyPacketopt, dateopt, config) → {Promise.<Boolean>}

+ + + + + + +
+

Checks if a given certificate of the user is revoked

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
certificate + + +SignaturePacket + + + + + + + + + +

The certificate to verify

keyPacket + + +PublicSubkeyPacket +| + +SecretSubkeyPacket +| + +PublicKeyPacket +| + +SecretKeyPacket + + + + + + <optional>
+ + + + + +

The key packet to verify the signature, instead of the primary key

date + + +Date + + + + + + <optional>
+ + + + + +

Use the given date for verification instead of the current time

config + + +Object + + + + + + + + + +

Full configuration

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -416,216 +846,6 @@ -

(async) sign(primaryKey, privateKeys, config) → {Promise.<Key>}

- - - - - - -
-

Signs user

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
primaryKey - - -SecretKeyPacket -| - -PublicKeyPacket - - - -

The primary key packet

privateKeys - - -Array.<Key> - - - -

Decrypted private keys for signing

config - - -Object - - - -

Full configuration

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

New user with new certificate signatures.

-
- - - -
-
- Type -
-
- -Promise.<Key> - - -
-
- - - - - - - - - - - - -

toPacketList() → {PacketList}

@@ -680,7 +900,7 @@
Source:
@@ -734,7 +954,7 @@ -

(async) update(user, primaryKey, config) → {Promise.<undefined>}

+

(async) update(sourceUser, date, config) → {Promise.<undefined>}

@@ -778,7 +998,7 @@ - user + sourceUser @@ -801,16 +1021,13 @@ - primaryKey + date -SecretKeyPacket -| - -SecretSubkeyPacket +Date @@ -820,7 +1037,7 @@ -

primary key used for validation

+

Date to verify the validity of signatures

@@ -886,7 +1103,7 @@
Source:
@@ -940,7 +1157,7 @@ -

(async) verify(primaryKey, date, config) → {Promise.<true>}

+

(async) verify(date, config) → {Promise.<true>}

@@ -983,32 +1200,6 @@ and validity of self signature.

- - - primaryKey - - - - - -SecretKeyPacket -| - -PublicKeyPacket - - - - - - - - - -

The primary key packet

- - - - date @@ -1093,7 +1284,7 @@ and validity of self signature.

Source:
@@ -1180,7 +1371,7 @@ and validity of self signature.

-

(async) verifyAllCertifications(primaryKey, keys, date, config) → {Promise.<Array.<{keyID: module:type/keyid~KeyID, valid: Boolean}>>}

+

(async) verifyAllCertifications(verificationKeys, dateopt, config) → {Promise.<Array.<{keyID: module:type/keyid~KeyID, valid: (Boolean|null)}>>}

@@ -1212,6 +1403,8 @@ and validity of self signature.

Type + Attributes + @@ -1224,44 +1417,26 @@ and validity of self signature.

- primaryKey + verificationKeys -SecretKeyPacket -| - -PublicKeyPacket +Array.<PublicKey> - - - -

The primary key packet

- - - - - - - keys - - - - + -Array.<Key> + - - - + + @@ -1286,6 +1461,16 @@ and validity of self signature.

+ + + <optional>
+ + + + + + + @@ -1309,6 +1494,14 @@ and validity of self signature.

+ + + + + + + + @@ -1355,7 +1548,7 @@ and validity of self signature.

Source:
@@ -1384,7 +1577,8 @@ and validity of self signature.

-

List of signer's keyID and validity of signature

+

List of signer's keyID and validity of signature. +Signature validity is null if the verification keys do not correspond to the certificate.

@@ -1395,7 +1589,7 @@ and validity of self signature.

-Promise.<Array.<{keyID: module:type/keyid~KeyID, valid: Boolean}>> +Promise.<Array.<{keyID: module:type/keyid~KeyID, valid: (Boolean|null)}>>
@@ -1413,7 +1607,7 @@ and validity of self signature.

-

(async) verifyCertificate(primaryKey, certificate, keys, date, config) → {Promise.<(true|null)>}

+

(async) verifyCertificate(certificate, verificationKeys, dateopt, config) → {Promise.<(true|null)>}

@@ -1421,7 +1615,7 @@ and validity of self signature.

-

Verifies the user certificate. Throws if the user certificate is invalid.

+

Verifies the user certificate.

@@ -1445,6 +1639,8 @@ and validity of self signature.

Type + Attributes + @@ -1455,32 +1651,6 @@ and validity of self signature.

- - - primaryKey - - - - - -SecretKeyPacket -| - -PublicKeyPacket - - - - - - - - - -

The primary key packet

- - - - certificate @@ -1496,6 +1666,14 @@ and validity of self signature.

+ + + + + + + + @@ -1506,19 +1684,27 @@ and validity of self signature.

- keys + verificationKeys -Array.<Key> +Array.<PublicKey> + + + + + + + + @@ -1542,6 +1728,16 @@ and validity of self signature.

+ + + <optional>
+ + + + + + + @@ -1565,6 +1761,14 @@ and validity of self signature.

+ + + + + + + + @@ -1611,7 +1815,7 @@ and validity of self signature.

Source:
@@ -1634,13 +1838,25 @@ and validity of self signature.

+
Throws:
+ + + +
+ +

if the user certificate is invalid.

+ +
+ + +
Returns:
-

Status of the certificate.

+

true if the certificate could be verified, or null if the verification keys do not correspond to the certificate

@@ -1679,7 +1895,7 @@ and validity of self signature.


diff --git a/docs/module-type_kdf_params-KDFParams.html b/docs/module-type_kdf_params-KDFParams.html index a2078855..425a71dd 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 1ea545bf..4cb0f6c9 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 854a44be..1310da5b 100644 --- a/docs/module-type_s2k-S2K.html +++ b/docs/module-type_s2k-S2K.html @@ -152,7 +152,7 @@
Source:
@@ -254,7 +254,7 @@
Source:
@@ -324,7 +324,7 @@
Source:
@@ -398,7 +398,7 @@
Source:
@@ -468,7 +468,7 @@
Source:
@@ -600,7 +600,7 @@ hashAlgorithm

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

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

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


diff --git a/package-lock.json b/package-lock.json index a35f5c9f..90416ef8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "openpgp", - "version": "5.0.0-3", + "version": "5.0.0-4", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index c1524879..76ffd498 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.0-3", + "version": "5.0.0-4", "license": "LGPL-3.0+", "homepage": "https://openpgpjs.org/", "engines": {