From 0eb083935a691c60a9b6967e632c93d7dd53a112 Mon Sep 17 00:00:00 2001 From: larabr <7375870+larabr@users.noreply.github.com> Date: Wed, 14 Feb 2024 13:20:13 +0100 Subject: [PATCH] 5.11.1-0 --- docs/AEADEncryptedDataPacket.html | 18 +- docs/Argon2S2K.html | 986 ++++++++++++++++++ docs/CleartextMessage.html | 14 +- docs/CompressedDataPacket.html | 20 +- docs/Key.html | 58 +- docs/LiteralDataPacket.html | 22 +- docs/MarkerPacket.html | 6 +- docs/Message.html | 42 +- docs/OnePassSignaturePacket.html | 20 +- docs/PacketList.html | 16 +- docs/PrivateKey.html | 45 +- docs/PublicKey.html | 10 +- docs/PublicKeyEncryptedSessionKeyPacket.html | 16 +- docs/PublicKeyPacket.html | 50 +- docs/PublicSubkeyPacket.html | 50 +- docs/SecretKeyPacket.html | 76 +- docs/SecretSubkeyPacket.html | 76 +- 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 | 571 +++++++++- docs/index.html | 2 +- docs/module-config.html | 532 +++++++++- docs/module-enums.html | 280 ++++- docs/module-key_Subkey-Subkey.html | 46 +- docs/module-key_User-User.html | 22 +- docs/module-type_kdf_params-KDFParams.html | 121 ++- docs/module-type_keyid-KeyID.html | 16 +- ...K.html => module-type_s2k-GenericS2K.html} | 26 +- docs/module-type_x25519x448_symkey.html | 4 +- docs/type_enum.module_js.html | 616 +++++++++++ package-lock.json | 4 +- package.json | 2 +- 38 files changed, 3405 insertions(+), 464 deletions(-) create mode 100644 docs/Argon2S2K.html rename docs/{module-type_s2k-S2K.html => module-type_s2k-GenericS2K.html} (64%) create mode 100644 docs/type_enum.module_js.html diff --git a/docs/AEADEncryptedDataPacket.html b/docs/AEADEncryptedDataPacket.html index cd95975d1..bda596f96 100644 --- a/docs/AEADEncryptedDataPacket.html +++ b/docs/AEADEncryptedDataPacket.html @@ -98,7 +98,7 @@

Source:
@@ -200,7 +200,7 @@
Type:
Source:
@@ -270,7 +270,7 @@
Type:
Source:
@@ -453,7 +453,7 @@
Parameters:
Source:
@@ -684,7 +684,7 @@
Parameters:
Source:
@@ -926,7 +926,7 @@
Parameters:
Source:
@@ -1097,7 +1097,7 @@
Parameters:
Source:
@@ -1216,7 +1216,7 @@

writeSource:
@@ -1287,7 +1287,7 @@
Returns:

diff --git a/docs/Argon2S2K.html b/docs/Argon2S2K.html new file mode 100644 index 000000000..9b1d7f0df --- /dev/null +++ b/docs/Argon2S2K.html @@ -0,0 +1,986 @@ + + + + + JSDoc: Class: Argon2S2K + + + + + + + + + + +
+ +

Class: Argon2S2K

+ + + + + + +
+ +
+ +

Argon2S2K(configopt)

+ + +
+ +
+
+ + + + + + +

new Argon2S2K(configopt)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
config + + +Object + + + + + + <optional>
+ + + + + +

Full configuration, defaults to openpgp.config

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

encodedM :Integer

+ + + + +
+

exponent indicating memory size

+
+ + + +
Type:
+
    +
  • + +Integer + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

p :Integer

+ + + + +
+

degree of parallelism (lanes)

+
+ + + +
Type:
+
    +
  • + +Integer + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

salt :Uint8Array

+ + + + +
+

16 bytes of salt

+
+ + + +
Type:
+
    +
  • + +Uint8Array + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

t :Integer

+ + + + +
+

number of passes

+
+ + + +
Type:
+
    +
  • + +Integer + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + + +

(async) produceKey(passphrase) → {Promise.<Uint8Array>}

+ + + + + + +
+

Produces a key using the specified passphrase and the defined +hashAlgorithm

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
passphrase + + +String + + + +

Passphrase containing user input

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Throws:
+ + + +
+ + +Argon2OutOfMemoryError +| + +Errors + + + +
+ + + + + +
Returns:
+ + +
+

Produced key with a length corresponding to keySize

+
+ + + +
+
+ Type +
+
+ +Promise.<Uint8Array> + + +
+
+ + + + + + + + + + + + + +

read(bytes) → {Integer}

+ + + + + + +
+

Parsing function for argon2 string-to-key specifier.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
bytes + + +Uint8Array + + + +

Payload of argon2 string-to-key specifier

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

Actual length of the object.

+
+ + + +
+
+ Type +
+
+ +Integer + + +
+
+ + + + + + + + + + + + + +

write() → {Uint8Array}

+ + + + + + +
+

Serializes s2k information

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

Binary representation of s2k.

+
+ + + +
+
+ Type +
+
+ +Uint8Array + + +
+
+ + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/CleartextMessage.html b/docs/CleartextMessage.html index f58f77cc0..8309a413a 100644 --- a/docs/CleartextMessage.html +++ b/docs/CleartextMessage.html @@ -168,7 +168,7 @@
Parameters:
Source:
@@ -346,7 +346,7 @@
Parameters:
Source:
@@ -461,7 +461,7 @@

getSi
Source:
@@ -573,7 +573,7 @@

getTextSource:
@@ -974,7 +974,7 @@
Parameters:
Source:
@@ -1211,7 +1211,7 @@
Parameters:
Source:
@@ -1279,7 +1279,7 @@
Returns:

diff --git a/docs/CompressedDataPacket.html b/docs/CompressedDataPacket.html index f6c10968a..85a857d52 100644 --- a/docs/CompressedDataPacket.html +++ b/docs/CompressedDataPacket.html @@ -160,7 +160,7 @@
Parameters:
Source:
@@ -266,7 +266,7 @@
Type:
Source:
@@ -343,7 +343,7 @@
Type:
Source:
@@ -407,7 +407,7 @@

deflateLe
Source:
@@ -481,7 +481,7 @@

Type:
Source:
@@ -563,7 +563,7 @@

compressSource:
@@ -715,7 +715,7 @@
Parameters:
Source:
@@ -900,7 +900,7 @@
Parameters:
Source:
@@ -990,7 +990,7 @@

writeSource:
@@ -1061,7 +1061,7 @@
Returns:

diff --git a/docs/Key.html b/docs/Key.html index 96d8e75ab..29b8da434 100644 --- a/docs/Key.html +++ b/docs/Key.html @@ -96,7 +96,7 @@

new KeySource:
@@ -333,7 +333,7 @@
Parameters:
Source:
@@ -514,7 +514,7 @@
Parameters:
Source:
@@ -626,7 +626,7 @@

getAl
Source:
@@ -655,7 +655,7 @@

Returns:
-

An object of the form {algorithm: String, bits:int, curve:String}.

+

An object of the form {algorithm: String, bits:int, curve:String, symmetric:String}.

@@ -738,7 +738,7 @@

getCre
Source:
@@ -1006,7 +1006,7 @@

Parameters:
Source:
@@ -1225,7 +1225,7 @@
Parameters:
Source:
@@ -1333,7 +1333,7 @@

getFing
Source:
@@ -1445,7 +1445,7 @@

getKeyIDSource:
@@ -1557,7 +1557,7 @@

getKeyIDsSource:
@@ -1735,7 +1735,7 @@
Parameters:
Source:
@@ -1978,7 +1978,7 @@
Parameters:
Source:
@@ -2183,7 +2183,7 @@
Parameters:
Source:
@@ -2475,7 +2475,7 @@
Parameters:
Source:
@@ -2669,7 +2669,7 @@
Parameters:
Source:
@@ -2781,7 +2781,7 @@

getUserIDs<
Source:
@@ -2893,7 +2893,7 @@

h
Source:
@@ -3170,7 +3170,7 @@

Parameters:
Source:
@@ -3354,7 +3354,7 @@
Parameters:
Source:
@@ -3569,7 +3569,7 @@
Parameters:
Source:
@@ -3839,7 +3839,7 @@
Parameters:
Source:
@@ -3951,7 +3951,7 @@

toPacketL
Source:
@@ -4192,7 +4192,7 @@

Parameters:
Source:
@@ -4435,7 +4435,7 @@
Parameters:
Source:
@@ -4676,7 +4676,7 @@
Parameters:
Source:
@@ -4959,7 +4959,7 @@
Parameters:
Source:
@@ -5072,7 +5072,7 @@

writeSource:
@@ -5140,7 +5140,7 @@
Returns:

diff --git a/docs/LiteralDataPacket.html b/docs/LiteralDataPacket.html index 91a1c9a0a..d32dfad6c 100644 --- a/docs/LiteralDataPacket.html +++ b/docs/LiteralDataPacket.html @@ -147,7 +147,7 @@
Parameters:
Source:
@@ -326,7 +326,7 @@
Parameters:
Source:
@@ -441,7 +441,7 @@

getFilenam
Source:
@@ -623,7 +623,7 @@

Parameters:
Source:
@@ -790,7 +790,7 @@
Parameters:
Source:
@@ -977,7 +977,7 @@
Parameters:
Source:
@@ -1116,7 +1116,7 @@
Parameters:
Source:
@@ -1302,7 +1302,7 @@
Parameters:
Source:
@@ -1392,7 +1392,7 @@

writeSource:
@@ -1507,7 +1507,7 @@

writeHeade
Source:
@@ -1575,7 +1575,7 @@

Returns:

diff --git a/docs/MarkerPacket.html b/docs/MarkerPacket.html index c93faeec4..f29c1082a 100644 --- a/docs/MarkerPacket.html +++ b/docs/MarkerPacket.html @@ -106,7 +106,7 @@

new Marke
Source:
@@ -265,7 +265,7 @@

Parameters:
Source:
@@ -333,7 +333,7 @@
Returns:

diff --git a/docs/Message.html b/docs/Message.html index d01d613e0..9aadd6417 100644 --- a/docs/Message.html +++ b/docs/Message.html @@ -146,7 +146,7 @@
Parameters:
Source:
@@ -661,7 +661,7 @@
Parameters:
Source:
@@ -933,7 +933,7 @@
Parameters:
Source:
@@ -1140,7 +1140,7 @@
Parameters:
Source:
@@ -1291,7 +1291,7 @@
Parameters:
Source:
@@ -1495,7 +1495,7 @@
Parameters:
Source:
@@ -1800,7 +1800,7 @@
Parameters:
Source:
@@ -2072,7 +2072,7 @@
Parameters:
Source:
@@ -2512,7 +2512,7 @@
Parameters:
Source:
@@ -2624,7 +2624,7 @@

ge
Source:
@@ -2736,7 +2736,7 @@

getFilenam
Source:
@@ -2851,7 +2851,7 @@

getLite
Source:
@@ -2966,7 +2966,7 @@

getSi
Source:
@@ -3078,7 +3078,7 @@

getTextSource:
@@ -3482,7 +3482,7 @@
Parameters:
Source:
@@ -3883,7 +3883,7 @@
Parameters:
Source:
@@ -3995,7 +3995,7 @@

unwra
Source:
@@ -4232,7 +4232,7 @@

Parameters:
Source:
@@ -4498,7 +4498,7 @@
Parameters:
Source:
@@ -4610,7 +4610,7 @@

writeSource:
@@ -4678,7 +4678,7 @@
Returns:

diff --git a/docs/OnePassSignaturePacket.html b/docs/OnePassSignaturePacket.html index 75d42badd..08dd451ea 100644 --- a/docs/OnePassSignaturePacket.html +++ b/docs/OnePassSignaturePacket.html @@ -101,7 +101,7 @@

Source:
@@ -199,7 +199,7 @@

flagsSource:
@@ -273,7 +273,7 @@
Type:
Source:
@@ -344,7 +344,7 @@

issuerKeyI
Source:
@@ -418,7 +418,7 @@

Type:
Source:
@@ -501,7 +501,7 @@
Type:
Source:
@@ -565,7 +565,7 @@

versionSource:
@@ -696,7 +696,7 @@
Parameters:
Source:
@@ -808,7 +808,7 @@

writeSource:
@@ -876,7 +876,7 @@
Returns:

diff --git a/docs/PacketList.html b/docs/PacketList.html index 2b1e97445..efa1f2de4 100644 --- a/docs/PacketList.html +++ b/docs/PacketList.html @@ -97,7 +97,7 @@

new PacketL
Source:
@@ -345,7 +345,7 @@

Parameters:
Source:
@@ -530,7 +530,7 @@
Parameters:
Source:
@@ -687,7 +687,7 @@
Parameters:
Source:
@@ -859,7 +859,7 @@
Parameters:
Source:
@@ -1097,7 +1097,7 @@
Parameters:
Source:
@@ -1200,7 +1200,7 @@

writeSource:
@@ -1268,7 +1268,7 @@
Returns:

diff --git a/docs/PrivateKey.html b/docs/PrivateKey.html index 8b9799c3b..246ba7a38 100644 --- a/docs/PrivateKey.html +++ b/docs/PrivateKey.html @@ -144,7 +144,7 @@
Parameters:
Source:
@@ -361,6 +361,29 @@
Parameters:
+ + + options.symmetric + + + + + +String + + + + + + + + + +

(optional) Symmetric algorithm for aead/cmac keys

+ + + + options.sign @@ -445,7 +468,7 @@
Parameters:
Source:
@@ -614,7 +637,7 @@
Parameters:
Source:
@@ -726,7 +749,7 @@

cle
Source:
@@ -971,7 +994,7 @@

Parameters:
Source:
@@ -1084,7 +1107,7 @@

isDecrypte
Source:
@@ -1174,7 +1197,7 @@

isPrivateSource:
@@ -1477,7 +1500,7 @@
Properties
Source:
@@ -1589,7 +1612,7 @@

toPublicSource:
@@ -1766,7 +1789,7 @@
Parameters:
Source:
@@ -1841,7 +1864,7 @@
Throws:

diff --git a/docs/PublicKey.html b/docs/PublicKey.html index c8edd749c..c11aef5e1 100644 --- a/docs/PublicKey.html +++ b/docs/PublicKey.html @@ -144,7 +144,7 @@
Parameters:
Source:
@@ -315,7 +315,7 @@
Parameters:
Source:
@@ -427,7 +427,7 @@

isPrivateSource:
@@ -535,7 +535,7 @@

toPublicSource:
@@ -603,7 +603,7 @@
Returns:

diff --git a/docs/PublicKeyEncryptedSessionKeyPacket.html b/docs/PublicKeyEncryptedSessionKeyPacket.html index 337ea927a..3f0f7cb1d 100644 --- a/docs/PublicKeyEncryptedSessionKeyPacket.html +++ b/docs/PublicKeyEncryptedSessionKeyPacket.html @@ -107,7 +107,7 @@

Source:
@@ -209,7 +209,7 @@
Type:
Source:
@@ -283,7 +283,7 @@
Type:
Source:
@@ -458,7 +458,7 @@
Parameters:
Source:
@@ -626,7 +626,7 @@
Parameters:
Source:
@@ -794,7 +794,7 @@
Parameters:
Source:
@@ -884,7 +884,7 @@

writeSource:
@@ -952,7 +952,7 @@
Returns:

diff --git a/docs/PublicKeyPacket.html b/docs/PublicKeyPacket.html index a3063b295..29310d020 100644 --- a/docs/PublicKeyPacket.html +++ b/docs/PublicKeyPacket.html @@ -195,7 +195,7 @@
Parameters:
Source:
@@ -301,7 +301,7 @@
Type:
Source:
@@ -375,7 +375,7 @@
Type:
Source:
@@ -449,7 +449,7 @@
Type:
Source:
@@ -523,7 +523,7 @@
Type:
Source:
@@ -597,7 +597,7 @@
Type:
Source:
@@ -671,7 +671,7 @@
Type:
Source:
@@ -735,7 +735,7 @@

readPubl
Source:
@@ -816,7 +816,7 @@

Type:
Source:
@@ -880,7 +880,7 @@

writePu
Source:
@@ -1018,7 +1018,7 @@

Parameters:
Source:
@@ -1130,7 +1130,7 @@

(async) Source:
@@ -1220,7 +1220,7 @@

(a
Source:
@@ -1310,7 +1310,7 @@

getAl
Source:
@@ -1339,7 +1339,7 @@

Returns:
-

An object of the form {algorithm: String, bits:int, curve:String}.

+

An object of the form {algorithm: String, bits:int, curve:String, symmetric:String}.

@@ -1422,7 +1422,7 @@

getCre
Source:
@@ -1530,7 +1530,7 @@

getFing
Source:
@@ -1642,7 +1642,7 @@

ge
Source:
@@ -1754,7 +1754,7 @@

getKeyIDSource:
@@ -1866,7 +1866,7 @@

h
Source:
@@ -1978,7 +1978,7 @@

isDecrypte
Source:
@@ -2138,7 +2138,7 @@

Parameters:
Source:
@@ -2250,7 +2250,7 @@

writeSource:
@@ -2411,7 +2411,7 @@
Parameters:
Source:
@@ -2457,7 +2457,7 @@
Parameters:

diff --git a/docs/PublicSubkeyPacket.html b/docs/PublicSubkeyPacket.html index 4b8380833..1f84f0a3d 100644 --- a/docs/PublicSubkeyPacket.html +++ b/docs/PublicSubkeyPacket.html @@ -193,7 +193,7 @@
Parameters:
Source:
@@ -315,7 +315,7 @@
Type:
Source:
@@ -394,7 +394,7 @@
Type:
Source:
@@ -473,7 +473,7 @@
Type:
Source:
@@ -552,7 +552,7 @@
Type:
Source:
@@ -631,7 +631,7 @@
Type:
Source:
@@ -710,7 +710,7 @@
Type:
Source:
@@ -779,7 +779,7 @@

readPubl
Source:
@@ -865,7 +865,7 @@

Type:
Source:
@@ -934,7 +934,7 @@

writePu
Source:
@@ -1072,7 +1072,7 @@

Parameters:
Source:
@@ -1189,7 +1189,7 @@

(async) Source:
@@ -1284,7 +1284,7 @@

(a
Source:
@@ -1379,7 +1379,7 @@

getAl
Source:
@@ -1408,7 +1408,7 @@

Returns:
-

An object of the form {algorithm: String, bits:int, curve:String}.

+

An object of the form {algorithm: String, bits:int, curve:String, symmetric:String}.

@@ -1496,7 +1496,7 @@

getCre
Source:
@@ -1609,7 +1609,7 @@

getFing
Source:
@@ -1726,7 +1726,7 @@

ge
Source:
@@ -1843,7 +1843,7 @@

getKeyIDSource:
@@ -1960,7 +1960,7 @@

h
Source:
@@ -2077,7 +2077,7 @@

isDecrypte
Source:
@@ -2242,7 +2242,7 @@

Parameters:
Source:
@@ -2359,7 +2359,7 @@

writeSource:
@@ -2525,7 +2525,7 @@
Parameters:
Source:
@@ -2571,7 +2571,7 @@
Parameters:

diff --git a/docs/SecretKeyPacket.html b/docs/SecretKeyPacket.html index b87b7bdf2..0e4bec92e 100644 --- a/docs/SecretKeyPacket.html +++ b/docs/SecretKeyPacket.html @@ -191,7 +191,7 @@
Parameters:
Source:
@@ -308,7 +308,7 @@
Type:
Source:
@@ -387,7 +387,7 @@
Type:
Source:
@@ -466,7 +466,7 @@
Type:
Source:
@@ -545,7 +545,7 @@
Type:
Source:
@@ -624,7 +624,7 @@
Type:
Source:
@@ -688,7 +688,7 @@

isEncrypte
Source:
@@ -767,7 +767,7 @@

Type:
Source:
@@ -831,7 +831,7 @@

keyMateria
Source:
@@ -905,7 +905,7 @@

Type:
Source:
@@ -984,7 +984,7 @@
Type:
Source:
@@ -1053,7 +1053,7 @@

readPubl
Source:
@@ -1134,7 +1134,7 @@

Type:
Source:
@@ -1208,7 +1208,7 @@
Type:
Source:
@@ -1282,7 +1282,7 @@
Type:
Source:
@@ -1361,7 +1361,7 @@
Type:
Source:
@@ -1430,7 +1430,7 @@

writePu
Source:
@@ -1519,7 +1519,7 @@

cle
Source:
@@ -1614,7 +1614,7 @@

(async) Source:
@@ -1709,7 +1709,7 @@

(a
Source:
@@ -1851,7 +1851,7 @@
Parameters:
Source:
@@ -2065,7 +2065,7 @@
Parameters:
Source:
@@ -2189,7 +2189,7 @@

getAl
Source:
@@ -2218,7 +2218,7 @@

Returns:
-

An object of the form {algorithm: String, bits:int, curve:String}.

+

An object of the form {algorithm: String, bits:int, curve:String, symmetric:String}.

@@ -2306,7 +2306,7 @@

getCre
Source:
@@ -2419,7 +2419,7 @@

getFing
Source:
@@ -2536,7 +2536,7 @@

ge
Source:
@@ -2653,7 +2653,7 @@

getKeyIDSource:
@@ -2770,7 +2770,7 @@

h
Source:
@@ -2888,7 +2888,7 @@

isDecrypte
Source:
@@ -2999,7 +2999,7 @@

isDummySource:
@@ -3114,7 +3114,7 @@

Source:
@@ -3266,7 +3266,7 @@
Parameters:
Source:
@@ -3411,7 +3411,7 @@
Parameters:
Source:
@@ -3501,7 +3501,7 @@

(async) valid
Source:
@@ -3625,7 +3625,7 @@

writeSource:
@@ -3791,7 +3791,7 @@
Parameters:
Source:
@@ -3837,7 +3837,7 @@
Parameters:

diff --git a/docs/SecretSubkeyPacket.html b/docs/SecretSubkeyPacket.html index 1c2050af3..a0185ecdf 100644 --- a/docs/SecretSubkeyPacket.html +++ b/docs/SecretSubkeyPacket.html @@ -190,7 +190,7 @@
Parameters:
Source:
@@ -312,7 +312,7 @@
Type:
Source:
@@ -391,7 +391,7 @@
Type:
Source:
@@ -470,7 +470,7 @@
Type:
Source:
@@ -549,7 +549,7 @@
Type:
Source:
@@ -628,7 +628,7 @@
Type:
Source:
@@ -697,7 +697,7 @@

isEncrypte
Source:
@@ -776,7 +776,7 @@

Type:
Source:
@@ -845,7 +845,7 @@

keyMateria
Source:
@@ -924,7 +924,7 @@

Type:
Source:
@@ -1003,7 +1003,7 @@
Type:
Source:
@@ -1072,7 +1072,7 @@

readPubl
Source:
@@ -1158,7 +1158,7 @@

Type:
Source:
@@ -1237,7 +1237,7 @@
Type:
Source:
@@ -1316,7 +1316,7 @@
Type:
Source:
@@ -1395,7 +1395,7 @@
Type:
Source:
@@ -1464,7 +1464,7 @@

writePu
Source:
@@ -1558,7 +1558,7 @@

cle
Source:
@@ -1653,7 +1653,7 @@

(async) Source:
@@ -1748,7 +1748,7 @@

(a
Source:
@@ -1895,7 +1895,7 @@
Parameters:
Source:
@@ -2114,7 +2114,7 @@
Parameters:
Source:
@@ -2238,7 +2238,7 @@

getAl
Source:
@@ -2267,7 +2267,7 @@

Returns:
-

An object of the form {algorithm: String, bits:int, curve:String}.

+

An object of the form {algorithm: String, bits:int, curve:String, symmetric:String}.

@@ -2355,7 +2355,7 @@

getCre
Source:
@@ -2468,7 +2468,7 @@

getFing
Source:
@@ -2585,7 +2585,7 @@

ge
Source:
@@ -2702,7 +2702,7 @@

getKeyIDSource:
@@ -2819,7 +2819,7 @@

h
Source:
@@ -2937,7 +2937,7 @@

isDecrypte
Source:
@@ -3053,7 +3053,7 @@

isDummySource:
@@ -3173,7 +3173,7 @@

Source:
@@ -3330,7 +3330,7 @@
Parameters:
Source:
@@ -3475,7 +3475,7 @@
Parameters:
Source:
@@ -3570,7 +3570,7 @@

(async) valid
Source:
@@ -3694,7 +3694,7 @@

writeSource:
@@ -3860,7 +3860,7 @@
Parameters:
Source:
@@ -3906,7 +3906,7 @@
Parameters:

diff --git a/docs/Signature.html b/docs/Signature.html index 71ab0cc24..cd1250865 100644 --- a/docs/Signature.html +++ b/docs/Signature.html @@ -144,7 +144,7 @@
Parameters:
Source:
@@ -322,7 +322,7 @@
Parameters:
Source:
@@ -434,7 +434,7 @@

getSi
Source:
@@ -546,7 +546,7 @@

writeSource:
@@ -614,7 +614,7 @@
Returns:

diff --git a/docs/SignaturePacket.html b/docs/SignaturePacket.html index 6adcfe0b0..38b5c9a5a 100644 --- a/docs/SignaturePacket.html +++ b/docs/SignaturePacket.html @@ -99,7 +99,7 @@

new Si
Source:
@@ -201,7 +201,7 @@

Type:
Source:
@@ -271,7 +271,7 @@
Type:
Source:
@@ -341,7 +341,7 @@
Type:
Source:
@@ -423,7 +423,7 @@

getE
Source:
@@ -599,7 +599,7 @@

Parameters:
Source:
@@ -760,7 +760,7 @@
Parameters:
Source:
@@ -1048,7 +1048,7 @@
Parameters:
Source:
@@ -1427,7 +1427,7 @@
Parameters:
Source:
@@ -1546,7 +1546,7 @@

Source:
@@ -1654,7 +1654,7 @@

writeParam
Source:
@@ -1765,7 +1765,7 @@

Source:
@@ -1833,7 +1833,7 @@
Returns:

diff --git a/docs/SymEncryptedIntegrityProtectedDataPacket.html b/docs/SymEncryptedIntegrityProtectedDataPacket.html index f3c948c27..4d59139ea 100644 --- a/docs/SymEncryptedIntegrityProtectedDataPacket.html +++ b/docs/SymEncryptedIntegrityProtectedDataPacket.html @@ -101,7 +101,7 @@

Source:
@@ -334,7 +334,7 @@
Parameters:
Source:
@@ -594,7 +594,7 @@
Parameters:
Source:
@@ -687,7 +687,7 @@
Returns:

diff --git a/docs/SymEncryptedSessionKeyPacket.html b/docs/SymEncryptedSessionKeyPacket.html index 370d50d71..98da796ee 100644 --- a/docs/SymEncryptedSessionKeyPacket.html +++ b/docs/SymEncryptedSessionKeyPacket.html @@ -165,7 +165,7 @@
Parameters:
Source:
@@ -271,7 +271,7 @@
Type:
Source:
@@ -345,7 +345,7 @@
Type:
Source:
@@ -419,7 +419,7 @@
Type:
Source:
@@ -550,7 +550,7 @@
Parameters:
Source:
@@ -761,7 +761,7 @@
Parameters:
Source:
@@ -929,7 +929,7 @@
Parameters:
Source:
@@ -1019,7 +1019,7 @@

writeSource:
@@ -1087,7 +1087,7 @@
Returns:

diff --git a/docs/SymmetricallyEncryptedDataPacket.html b/docs/SymmetricallyEncryptedDataPacket.html index 557183157..6b1f71ba7 100644 --- a/docs/SymmetricallyEncryptedDataPacket.html +++ b/docs/SymmetricallyEncryptedDataPacket.html @@ -101,7 +101,7 @@

Source:
@@ -197,7 +197,7 @@

encryptedSource:
@@ -271,7 +271,7 @@
Type:
Source:
@@ -477,7 +477,7 @@
Parameters:
Source:
@@ -720,7 +720,7 @@
Parameters:
Source:
@@ -795,7 +795,7 @@
Throws:

diff --git a/docs/TrustPacket.html b/docs/TrustPacket.html index b2cbafa4f..21a2020bb 100644 --- a/docs/TrustPacket.html +++ b/docs/TrustPacket.html @@ -105,7 +105,7 @@

new TrustP
Source:
@@ -216,7 +216,7 @@

readSource:
@@ -262,7 +262,7 @@

readHome

Functions

Modules

Classes

+

Home

Functions

Modules

Classes


diff --git a/docs/UserAttributePacket.html b/docs/UserAttributePacket.html index d48d39066..83128860f 100644 --- a/docs/UserAttributePacket.html +++ b/docs/UserAttributePacket.html @@ -107,7 +107,7 @@

ne
Source:
@@ -266,7 +266,7 @@

Parameters:
Source:
@@ -427,7 +427,7 @@
Parameters:
Source:
@@ -517,7 +517,7 @@

writeSource:
@@ -585,7 +585,7 @@
Returns:

diff --git a/docs/UserIDPacket.html b/docs/UserIDPacket.html index 746a07790..d4f2c3dba 100644 --- a/docs/UserIDPacket.html +++ b/docs/UserIDPacket.html @@ -100,7 +100,7 @@

new UserI
Source:
@@ -207,7 +207,7 @@

Type:
Source:
@@ -338,7 +338,7 @@
Parameters:
Source:
@@ -495,7 +495,7 @@
Parameters:
Source:
@@ -585,7 +585,7 @@

writeSource:
@@ -653,7 +653,7 @@
Returns:

diff --git a/docs/global.html b/docs/global.html index 53c0c87b8..b2c1dce3c 100644 --- a/docs/global.html +++ b/docs/global.html @@ -161,7 +161,7 @@

aesSource:
@@ -443,7 +443,7 @@
Parameters:
Source:
@@ -656,7 +656,7 @@
Properties
Source:
@@ -795,7 +795,7 @@
Parameters:
Source:
@@ -1204,7 +1204,7 @@
Properties
Source:
@@ -1785,7 +1785,7 @@
Properties
Source:
@@ -2087,7 +2087,7 @@
Properties
Source:
@@ -2446,7 +2446,7 @@
Properties
Source:
@@ -3250,7 +3250,7 @@
Properties
Source:
@@ -3538,7 +3538,7 @@
Properties
Source:
@@ -4158,7 +4158,7 @@
Properties
Source:
@@ -4374,7 +4374,7 @@
Parameters:
Source:
@@ -4434,7 +4434,7 @@
Returns:
-

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

+

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

@@ -4928,6 +4928,29 @@
Properties
+ + + + symmetric + + + + + +String + + + + + + + + + +

(optional) symmetric algorithm for aead/cmac keys

+ + + @@ -4967,7 +4990,7 @@
Properties
Source:
@@ -5317,7 +5340,7 @@
Properties
Source:
@@ -5369,6 +5392,163 @@
Returns:
+ + + + + + +

module:crypto/hmac(algo, Uint8Array)

+ + + + + + +
+

Creats an HMAC object for data authentication

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
algo + + +module:enums.hash + + + +

The hash algorithm to be used in the hmac

Uint8Array + +

key - The key for the hmac computation

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + @@ -5501,7 +5681,7 @@
Parameters:
Source:
@@ -5591,6 +5771,337 @@
Returns:
+

newS2KFromConfig() → {Object}

+ + + + + + +
+

Instantiate a new S2K instance based on the config settings

+
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Throws:
+ + + +
+
+
+

for unknown or unsupported types

+
+
+
+
+
+
+ Type +
+
+ +Error + + +
+
+
+
+
+ + + + + +
Returns:
+ + +
+

New s2k object

+
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + + + + +

newS2KFromType(type) → {Object}

+ + + + + + +
+

Instantiate a new S2K instance of the given type

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +module:enums.s2k + + + +
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Throws:
+ + + +
+
+
+

for unknown or unsupported types

+
+
+
+
+
+
+ Type +
+
+ +Error + + +
+
+
+
+
+ + + + + +
Returns:
+ + +
+

New s2k object

+
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + + + +

(async) readCleartextMessage(options) → {Promise.<CleartextMessage>}

@@ -5786,7 +6297,7 @@
Properties
Source:
@@ -6074,7 +6585,7 @@
Properties
Source:
@@ -6362,7 +6873,7 @@
Properties
Source:
@@ -6656,7 +7167,7 @@
Properties
Source:
@@ -6944,7 +7455,7 @@
Properties
Source:
@@ -7232,7 +7743,7 @@
Properties
Source:
@@ -7520,7 +8031,7 @@
Properties
Source:
@@ -7982,7 +8493,7 @@
Properties
Source:
@@ -8511,7 +9022,7 @@
Properties
Source:
@@ -9066,7 +9577,7 @@
Properties
Source:
@@ -9228,7 +9739,7 @@
Parameters:
Source:
@@ -9690,7 +10201,7 @@
Properties
Source:
@@ -9934,7 +10445,7 @@
Parameters:
Source:
@@ -9998,7 +10509,7 @@
Returns:

diff --git a/docs/index.html b/docs/index.html index 8a2c2ba62..4d33f9170 100644 --- a/docs/index.html +++ b/docs/index.html @@ -708,7 +708,7 @@

License


diff --git a/docs/module-config.html b/docs/module-config.html index 51fef1bbe..8b7a87f25 100644 --- a/docs/module-config.html +++ b/docs/module-config.html @@ -89,7 +89,7 @@

Module: config

Source:
@@ -247,7 +247,7 @@
Properties:
Source:
@@ -365,7 +365,7 @@
Properties:
Source:
@@ -483,7 +483,7 @@
Properties:
Source:
@@ -508,6 +508,123 @@
Properties:
+

(static) allowForwardedMessages

+ + + + +
+

Allow decrypting forwarded messages, using keys with 0x40 ('forwarded communication') flag. +Note: this is related to a non-standard feature.

+
+ + + + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
allowForwardedMessages + + +Boolean + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

(static) allowInsecureDecryptionWithSigningKeys

@@ -608,7 +725,7 @@
Properties:
Source:
@@ -727,7 +844,7 @@
Properties:
Source:
@@ -848,7 +965,7 @@
Properties:
Source:
@@ -967,7 +1084,7 @@
Properties:
Source:
@@ -1079,7 +1196,7 @@
Properties:
Source:
@@ -1191,7 +1308,7 @@
Properties:
Source:
@@ -1313,7 +1430,7 @@
Properties:
Source:
@@ -1431,7 +1548,7 @@
Properties:
Source:
@@ -1543,7 +1660,7 @@
Properties:
Source:
@@ -1655,7 +1772,7 @@
Properties:
Source:
@@ -1767,7 +1884,7 @@
Properties:
Source:
@@ -1884,7 +2001,7 @@
Properties:
Source:
@@ -2000,7 +2117,7 @@
Properties:
Source:
@@ -2112,7 +2229,7 @@
Properties:
Source:
@@ -2229,7 +2346,7 @@
Properties:
Source:
@@ -2346,7 +2463,7 @@
Properties:
Source:
@@ -2463,7 +2580,7 @@
Properties:
Source:
@@ -2575,7 +2692,7 @@
Properties:
Source:
@@ -2687,7 +2804,7 @@
Properties:
Source:
@@ -2799,7 +2916,7 @@
Properties:
Source:
@@ -2915,7 +3032,7 @@
Properties:
Source:
@@ -3031,7 +3148,7 @@
Properties:
Source:
@@ -3147,7 +3264,7 @@
Properties:
Source:
@@ -3263,7 +3380,7 @@
Properties:
Source:
@@ -3375,7 +3492,222 @@
Properties:
Source:
+ + + + + + + + + + + + + + + + +

(static) s2kArgon2Params

+ + + + +
+

draft-crypto-refresh 3.7.1.4: +Argon2 parameters for S2K (String to Key). +Only relevant if config.s2kType is set to enums.s2k.argon2. +Default settings correspond to the second recommendation from RFC9106 ("uniformly safe option"), +to ensure compatibility with memory-constrained environments. +For more details on the choice of parameters, see https://tools.ietf.org/html/rfc9106#section-4.

+
+ + + + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
passes + + +Integer + + + +

number of iterations t

parallelism + + +Integer + + + +

degree of parallelism p

memoryExponent + + +Integer + + + +

one-octet exponent indicating the memory size, which will be: 2**memoryExponent kibibytes.

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -3399,8 +3731,10 @@

(stati
-

RFC4880 3.7.1.3: -Iteration Count Byte for S2K (String to Key)

+

RFC4880 3.7.1.3: +Iteration Count Byte for Iterated and Salted S2K (String to Key). +Only relevant if config.s2kType is set to enums.s2k.iterated. +Note: this is the exponent value, not the final number of iterations (refer to specs for more details).

@@ -3492,7 +3826,129 @@
Properties:
Source:
+ + + + + + + +

+ + + + + + + + +

(static) s2kType

+ + + + +
+

S2K (String to Key) type, used for key derivation in the context of secret key encryption +and password-encrypted data. Weaker s2k options are not allowed. +Note: Argon2 is the strongest option but not all OpenPGP implementations are compatible with it +(pending standardisation).

+
+ + + + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
s2kType + + +enums.s2k.argon2 +| + +enums.s2k.iterated + + + +

module:enums.s2k

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -3604,7 +4060,7 @@
Properties:
Source:
@@ -3716,7 +4172,7 @@
Properties:
Source:
@@ -3834,7 +4290,7 @@
Properties:
Source:
@@ -3952,7 +4408,7 @@
Properties:
Source:
@@ -4064,7 +4520,7 @@
Properties:
Source:
@@ -4098,7 +4554,7 @@
Properties:

diff --git a/docs/module-enums.html b/docs/module-enums.html index 848ff7295..33c1a8c1c 100644 --- a/docs/module-enums.html +++ b/docs/module-enums.html @@ -212,7 +212,7 @@
Properties:
Source:
@@ -476,7 +476,7 @@
Properties:
Source:
@@ -671,7 +671,7 @@
Properties:
Source:
@@ -1924,7 +1924,7 @@
Properties:
Source:
@@ -2105,7 +2105,7 @@
Properties:
Source:
@@ -2369,7 +2369,157 @@
Properties:
Source:
+ + + + + + + +
+ + + + + + + + +

(static, readonly) kdfFlags :Integer

+ + + + +
+

KDF parameters flags +Non-standard extensions (for now) to allow email forwarding

+
+ + + +
Type:
+
    +
  • + +Integer + + +
    • +
+ + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
replace_fingerprint + + +Integer + + + +

Specify fingerprint to use instead of the recipient's

replace_kdf_params + + +Integer + + + +

Specify custom parameters to use in the KDF digest computation

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -2575,6 +2725,29 @@
Properties:
+ + + forwardedCommunication + + + + + +Integer + + + + + + + + + +

This key may be used for forwarded communications

+ + + + sharedPrivateKey @@ -2635,7 +2808,7 @@
Properties:
Source:
@@ -2830,7 +3003,7 @@
Properties:
Source:
@@ -3347,7 +3520,7 @@
Properties:
Source:
@@ -3782,6 +3955,52 @@
Properties:
+ + + + aead + + + + + +Integer + + + + + + + + + +

Symmetric authenticated encryption algorithms

+ + + + + + + hmac + + + + + +Integer + + + + + + + + + +

Authentication using CMAC

+ + + @@ -3819,7 +4038,7 @@
Properties:
Source:
@@ -4037,7 +4256,7 @@
Properties:
Source:
@@ -4168,6 +4387,29 @@
Properties:
+ + + + + + + + argon2 + + + + + +Integer + + + + + + + + + @@ -4232,7 +4474,7 @@
Properties:
Source:
@@ -4749,7 +4991,7 @@
Properties:
Source:
@@ -5450,7 +5692,7 @@
Properties:
Source:
@@ -5760,7 +6002,7 @@
Properties:
Source:
@@ -5956,7 +6198,7 @@
Properties:
Source:
@@ -6110,7 +6352,7 @@
Parameters:
Source:
@@ -6326,7 +6568,7 @@
Parameters:
Source:
@@ -6423,7 +6665,7 @@
Returns:

diff --git a/docs/module-key_Subkey-Subkey.html b/docs/module-key_Subkey-Subkey.html index 5f486957b..523a99825 100644 --- a/docs/module-key_Subkey-Subkey.html +++ b/docs/module-key_Subkey-Subkey.html @@ -170,7 +170,7 @@
Parameters:
Source:
@@ -280,7 +280,7 @@

cloneSource:
@@ -393,7 +393,7 @@

getAl
Source:
@@ -422,7 +422,7 @@

Returns:
-

An object of the form {algorithm: String, bits:int, curve:String}.

+

An object of the form {algorithm: String, bits:int, curve:String, symmetric:String}.

@@ -510,7 +510,7 @@

getAl
Source:
@@ -539,7 +539,7 @@

Returns:
-

An object of the form {algorithm: String, bits:int, curve:String}.

+

An object of the form {algorithm: String, bits:int, curve:String, symmetric:String}.

@@ -627,7 +627,7 @@

getCre
Source:
@@ -740,7 +740,7 @@

getCre
Source:
@@ -941,7 +941,7 @@

Parameters:
Source:
@@ -1054,7 +1054,7 @@

getFing
Source:
@@ -1171,7 +1171,7 @@

getFing
Source:
@@ -1288,7 +1288,7 @@

getKeyIDSource:
@@ -1405,7 +1405,7 @@

getKeyIDSource:
@@ -1522,7 +1522,7 @@

h
Source:
@@ -1639,7 +1639,7 @@

h
Source:
@@ -1756,7 +1756,7 @@

isDecrypte
Source:
@@ -1872,7 +1872,7 @@

isDecrypte
Source:
@@ -2148,7 +2148,7 @@

Parameters:
Source:
@@ -2486,7 +2486,7 @@
Properties
Source:
@@ -2598,7 +2598,7 @@

toPacketL
Source:
@@ -2831,7 +2831,7 @@

Parameters:
Source:
@@ -3043,7 +3043,7 @@
Parameters:
Source:
@@ -3136,7 +3136,7 @@
Returns:

diff --git a/docs/module-key_User-User.html b/docs/module-key_User-User.html index 363373c95..4d24a97db 100644 --- a/docs/module-key_User-User.html +++ b/docs/module-key_User-User.html @@ -170,7 +170,7 @@
Parameters:
Source:
@@ -403,7 +403,7 @@
Parameters:
Source:
@@ -515,7 +515,7 @@

cloneSource:
@@ -788,7 +788,7 @@
Parameters:
Source:
@@ -1126,7 +1126,7 @@
Properties
Source:
@@ -1238,7 +1238,7 @@

toPacketL
Source:
@@ -1441,7 +1441,7 @@

Parameters:
Source:
@@ -1622,7 +1622,7 @@
Parameters:
Source:
@@ -1886,7 +1886,7 @@
Parameters:
Source:
@@ -2153,7 +2153,7 @@
Parameters:
Source:
@@ -2233,7 +2233,7 @@
Returns:

diff --git a/docs/module-type_kdf_params-KDFParams.html b/docs/module-type_kdf_params-KDFParams.html index 62c650747..432e4fa40 100644 --- a/docs/module-type_kdf_params-KDFParams.html +++ b/docs/module-type_kdf_params-KDFParams.html @@ -28,7 +28,7 @@

Class: KDFParams

-

KDFParams(hash, cipher)

+

KDFParams(version, hash, cipher, replacementFingerprint)

@@ -41,7 +41,7 @@

KDFParamsnew KDFParams(hash, cipher)

+

new KDFParams(version, hash, cipher, replacementFingerprint)

@@ -79,6 +79,29 @@
Parameters:
+ + + version + + + + + +Integer + + + + + + + + + +

Version, defaults to 1

+ + + + hash @@ -124,6 +147,29 @@
Parameters:
+ + + + replacementFingerprint + + + + + +Uint8Array + + + + + + + + + +

(forwarding only) fingerprint to use instead of recipient one (v5 keys, the 20 leftmost bytes of the fingerprint)

+ + + @@ -163,7 +209,7 @@
Parameters:
Source:
@@ -322,7 +368,7 @@
Parameters:
Source:
@@ -380,7 +426,7 @@
Returns:
-

write() → {Uint8Array}

+

write(forReplacementParamsopt) → {Uint8Array}

@@ -399,6 +445,67 @@

writeParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
forReplacementParams + + +Boolean + + + + + + <optional>
+ + + + + +

forwarding only: whether to serialize data to use for replacement params

+ + @@ -434,7 +541,7 @@

writeSource:
@@ -502,7 +609,7 @@
Returns:

diff --git a/docs/module-type_keyid-KeyID.html b/docs/module-type_keyid-KeyID.html index fc2120c42..37d265b0e 100644 --- a/docs/module-type_keyid-KeyID.html +++ b/docs/module-type_keyid-KeyID.html @@ -100,7 +100,7 @@

new KeyIDSource:
@@ -294,7 +294,7 @@
Parameters:
Source:
@@ -384,7 +384,7 @@

isNullSource:
@@ -496,7 +496,7 @@

isWildcard<
Source:
@@ -657,7 +657,7 @@

Parameters:
Source:
@@ -747,7 +747,7 @@

toHexSource:
@@ -859,7 +859,7 @@

writeSource:
@@ -927,7 +927,7 @@
Returns:

diff --git a/docs/module-type_s2k-S2K.html b/docs/module-type_s2k-GenericS2K.html similarity index 64% rename from docs/module-type_s2k-S2K.html rename to docs/module-type_s2k-GenericS2K.html index 502333469..dc45db8ed 100644 --- a/docs/module-type_s2k-S2K.html +++ b/docs/module-type_s2k-GenericS2K.html @@ -2,7 +2,7 @@ - JSDoc: Class: S2K + JSDoc: Class: GenericS2K @@ -17,7 +17,7 @@
-

Class: S2K

+

Class: GenericS2K

@@ -28,7 +28,7 @@

Class: S2K

-

S2K(configopt)

+

GenericS2K(configopt)

@@ -41,7 +41,7 @@

S2Knew S2K(configopt)

+

new GenericS2K(configopt)

@@ -152,7 +152,7 @@
Parameters:
Source:
@@ -261,7 +261,7 @@
Type:
Source:
@@ -331,7 +331,7 @@
Type:
Source:
@@ -405,7 +405,7 @@
Type:
Source:
@@ -479,7 +479,7 @@
Type:
Source:
@@ -611,7 +611,7 @@
Parameters:
Source:
@@ -773,7 +773,7 @@
Parameters:
Source:
@@ -885,7 +885,7 @@

writeSource:
@@ -953,7 +953,7 @@
Returns:


diff --git a/docs/module-type_x25519x448_symkey.html b/docs/module-type_x25519x448_symkey.html index 76ed380ed..60c07a549 100644 --- a/docs/module-type_x25519x448_symkey.html +++ b/docs/module-type_x25519x448_symkey.html @@ -91,7 +91,7 @@

Module: type/x25519x448_symkey

Source:
@@ -154,7 +154,7 @@

Module: type/x25519x448_symkey


diff --git a/docs/type_enum.module_js.html b/docs/type_enum.module_js.html new file mode 100644 index 000000000..a3a13544c --- /dev/null +++ b/docs/type_enum.module_js.html @@ -0,0 +1,616 @@ + + + + + JSDoc: Module: js + + + + + + + + + + +
+ +

Module: js

+ + + + + + +
+ +
+ +
+ +
+
+ + +

Wrapper for enums

+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + +

Requires

+ + + + + + + + + + + + + + + +

Methods

+ + + + + + + +

getName() → {string}

+ + + + + + +
+

Get the name of the enum entry

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

The name string

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + + + + +

getValue() → {Number}

+ + + + + + +
+

Get the integer value of the enum entry

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

The integer value

+
+ + + +
+
+ Type +
+
+ +Number + + +
+
+ + + + + + + + + + + + + +

read(input)

+ + + + + + +
+

Read an enum entry

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
input + + +Uint8Array + + + +

Where to read the symmetric algo from

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

write() → {Uint8Array}

+ + + + + + +
+

Write an enum as an integer

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

An integer representing the algorithm

+
+ + + +
+
+ Type +
+
+ +Uint8Array + + +
+
+ + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index dd20207fb..76ed63d1e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@protontech/openpgp", - "version": "5.11.0", + "version": "5.11.1-0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@protontech/openpgp", - "version": "5.11.0", + "version": "5.11.1-0", "license": "LGPL-3.0+", "dependencies": { "asn1.js": "^5.0.0" diff --git a/package.json b/package.json index 980c801a7..b626ba7a6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@protontech/openpgp", "description": "OpenPGP.js is a Javascript implementation of the OpenPGP protocol. This is defined in RFC 4880.", - "version": "5.11.0", + "version": "5.11.1-0", "license": "LGPL-3.0+", "homepage": "https://openpgpjs.org/", "engines": {