From df6b554414a5956a6c80ceeb622c9bb2bc662612 Mon Sep 17 00:00:00 2001 From: larabr <7375870+larabr@users.noreply.github.com> Date: Fri, 1 Mar 2024 15:07:41 +0100 Subject: [PATCH] 6.0.0-alpha.1.patch.0 --- docs/AEADEncryptedDataPacket.html | 16 +- docs/Argon2S2K.html | 18 +- docs/CleartextMessage.html | 14 +- docs/CompressedDataPacket.html | 18 +- docs/Key.html | 60 +- docs/LiteralDataPacket.html | 22 +- docs/MarkerPacket.html | 6 +- docs/Message.html | 42 +- docs/OnePassSignaturePacket.html | 24 +- docs/PacketList.html | 16 +- docs/PaddingPacket.html | 10 +- docs/PrivateKey.html | 71 +- 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 | 12 +- docs/SymEncryptedSessionKeyPacket.html | 18 +- docs/SymmetricallyEncryptedDataPacket.html | 12 +- docs/TrustPacket.html | 6 +- docs/UserAttributePacket.html | 10 +- docs/UserIDPacket.html | 12 +- docs/global.html | 151 +++-- docs/index.html | 6 +- docs/module-config.html | 187 +++++- docs/module-crypto.html | 4 +- docs/module-crypto_aes_kw.html | 8 +- docs/module-crypto_cmac.html | 8 +- docs/module-crypto_crypto.html | 89 ++- docs/module-crypto_hash.html | 171 ++++- docs/module-crypto_hkdf.html | 4 +- docs/module-crypto_mode.html | 12 +- docs/module-crypto_mode_cfb.html | 6 +- docs/module-crypto_mode_eax.html | 10 +- docs/module-crypto_mode_gcm.html | 6 +- docs/module-crypto_mode_ocb.html | 10 +- docs/module-crypto_pkcs1.html | 12 +- docs/module-crypto_public_key.html | 79 ++- docs/module-crypto_public_key_dsa.html | 12 +- docs/module-crypto_public_key_elgamal.html | 12 +- docs/module-crypto_public_key_elliptic.html | 4 +- ...dule-crypto_public_key_elliptic_curve.html | 14 +- ...odule-crypto_public_key_elliptic_ecdh.html | 70 +- ...dule-crypto_public_key_elliptic_ecdsa.html | 12 +- ...dule-crypto_public_key_elliptic_eddsa.html | 12 +- ...ypto_public_key_elliptic_eddsa_legacy.html | 10 +- docs/module-crypto_public_key_prime.html | 12 +- docs/module-crypto_public_key_rsa.html | 22 +- docs/module-crypto_random.html | 8 +- docs/module-crypto_signature.html | 35 +- docs/module-encoding_base64.html | 10 +- docs/module-enums.html | 257 +++++++- docs/module-key_Subkey-Subkey.html | 46 +- docs/module-key_Subkey.html | 2 +- docs/module-key_User-User.html | 22 +- docs/module-key_User.html | 2 +- docs/module-key_helper.html | 24 +- docs/module-packet_packet.html | 12 +- docs/module-type_ecdh_symkey.html | 4 +- docs/module-type_kdf_params-KDFParams.html | 122 +++- docs/module-type_kdf_params.html | 179 +++++ docs/module-type_keyid-KeyID.html | 16 +- docs/module-type_keyid.html | 2 +- docs/module-type_oid.html | 4 +- docs/module-type_s2k-GenericS2K.html | 18 +- docs/module-type_s2k.html | 4 +- docs/module-type_x25519x448_symkey.html | 4 +- docs/module-util.html | 4 +- docs/type_enum.module_js.html | 616 ++++++++++++++++++ package-lock.json | 4 +- package.json | 2 +- 75 files changed, 2351 insertions(+), 690 deletions(-) create mode 100644 docs/module-type_kdf_params.html create mode 100644 docs/type_enum.module_js.html diff --git a/docs/AEADEncryptedDataPacket.html b/docs/AEADEncryptedDataPacket.html index 1ebb55a7e..6beb5d263 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:
@@ -475,7 +475,7 @@
Parameters:
Source:
@@ -717,7 +717,7 @@
Parameters:
Source:
@@ -888,7 +888,7 @@
Parameters:
Source:
@@ -1007,7 +1007,7 @@

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

diff --git a/docs/Argon2S2K.html b/docs/Argon2S2K.html index 2f363b7e0..542b1ad4e 100644 --- a/docs/Argon2S2K.html +++ b/docs/Argon2S2K.html @@ -152,7 +152,7 @@
Parameters:
Source:
@@ -258,7 +258,7 @@
Type:
Source:
@@ -332,7 +332,7 @@
Type:
Source:
@@ -406,7 +406,7 @@
Type:
Source:
@@ -480,7 +480,7 @@
Type:
Source:
@@ -612,7 +612,7 @@
Parameters:
Source:
@@ -791,7 +791,7 @@
Parameters:
Source:
@@ -903,7 +903,7 @@

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

diff --git a/docs/CleartextMessage.html b/docs/CleartextMessage.html index a75988501..b51698e7a 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 45d85ebbb..f6a654330 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:
@@ -417,7 +417,7 @@
Type:
Source:
@@ -499,7 +499,7 @@

compressSource:
@@ -651,7 +651,7 @@
Parameters:
Source:
@@ -836,7 +836,7 @@
Parameters:
Source:
@@ -926,7 +926,7 @@

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

diff --git a/docs/Key.html b/docs/Key.html index e306f07cf..be712b099 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:
@@ -1977,7 +1977,7 @@
Parameters:
Source:
@@ -2220,7 +2220,7 @@
Parameters:
Source:
@@ -2425,7 +2425,7 @@
Parameters:
Source:
@@ -2717,7 +2717,7 @@
Parameters:
Source:
@@ -2911,7 +2911,7 @@
Parameters:
Source:
@@ -3023,7 +3023,7 @@

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

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

Parameters:
Source:
@@ -3596,7 +3596,7 @@
Parameters:
Source:
@@ -3811,7 +3811,7 @@
Parameters:
Source:
@@ -4081,7 +4081,7 @@
Parameters:
Source:
@@ -4193,7 +4193,7 @@

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

Parameters:
Source:
@@ -4677,7 +4677,7 @@
Parameters:
Source:
@@ -4918,7 +4918,7 @@
Parameters:
Source:
@@ -5201,7 +5201,7 @@
Parameters:
Source:
@@ -5314,7 +5314,7 @@

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

diff --git a/docs/LiteralDataPacket.html b/docs/LiteralDataPacket.html index 1b5ec55a9..1c59fddb9 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 bf14fa5d4..bbfe3974e 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 146ae170b..c61942867 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:
@@ -2105,7 +2105,7 @@
Parameters:
Source:
@@ -2545,7 +2545,7 @@
Parameters:
Source:
@@ -2657,7 +2657,7 @@

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

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

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

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

getTextSource:
@@ -3515,7 +3515,7 @@
Parameters:
Source:
@@ -3916,7 +3916,7 @@
Parameters:
Source:
@@ -4028,7 +4028,7 @@

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

Parameters:
Source:
@@ -4531,7 +4531,7 @@
Parameters:
Source:
@@ -4643,7 +4643,7 @@

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

diff --git a/docs/OnePassSignaturePacket.html b/docs/OnePassSignaturePacket.html index 0f2bdf570..dd86fb59c 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 @@

issu
Source:
@@ -408,7 +408,7 @@

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

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

saltSource:
@@ -629,7 +629,7 @@
Type:
Source:
@@ -693,7 +693,7 @@

versionSource:
@@ -824,7 +824,7 @@
Parameters:
Source:
@@ -936,7 +936,7 @@

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

diff --git a/docs/PacketList.html b/docs/PacketList.html index dc87bd44e..f394a0553 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/PaddingPacket.html b/docs/PaddingPacket.html index 6f9faa6a3..bef97119c 100644 --- a/docs/PaddingPacket.html +++ b/docs/PaddingPacket.html @@ -97,7 +97,7 @@

new Padd
Source:
@@ -256,7 +256,7 @@

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

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

diff --git a/docs/PrivateKey.html b/docs/PrivateKey.html index 8cf63e1cf..55e35fe94 100644 --- a/docs/PrivateKey.html +++ b/docs/PrivateKey.html @@ -144,7 +144,7 @@
Parameters:
Source:
@@ -262,6 +262,9 @@
Parameters:
| curve448 +| + +symmetric @@ -323,6 +326,52 @@
Parameters:
+ + + options.symmetricCipher + + + + + +String + + + + + + + + + +

(optional) Symmetric algorithm for persistent symmetric aead keys

+ + + + + + + options.symmetricHash + + + + + +String + + + + + + + + + +

(optional)Hash lgorithm for persistent symmetric hmac keys

+ + + + options.keyExpirationTime @@ -453,7 +502,7 @@
Parameters:
Source:
@@ -622,7 +671,7 @@
Parameters:
Source:
@@ -734,7 +783,7 @@

cle
Source:
@@ -979,7 +1028,7 @@

Parameters:
Source:
@@ -1092,7 +1141,7 @@

isDecrypte
Source:
@@ -1182,7 +1231,7 @@

isPrivateSource:
@@ -1485,7 +1534,7 @@
Properties
Source:
@@ -1597,7 +1646,7 @@

toPublicSource:
@@ -1774,7 +1823,7 @@
Parameters:
Source:
@@ -1849,7 +1898,7 @@
Throws:

diff --git a/docs/PublicKey.html b/docs/PublicKey.html index 99a3d8d44..121af855b 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 db373e3b6..e7873fce9 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 c0d1ed6f1..7e54a53ed 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 1a11c8a2b..6e8641506 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 d51ed4de9..b5104ea32 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 a3a608b02..4c3fd4835 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 7431d9448..f71e7ba26 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 a8e1c2b23..d732db24b 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 1824c4aff..8ebc1915a 100644 --- a/docs/SymEncryptedIntegrityProtectedDataPacket.html +++ b/docs/SymEncryptedIntegrityProtectedDataPacket.html @@ -101,7 +101,7 @@

Source:
@@ -203,7 +203,7 @@
Type:
Source:
@@ -273,7 +273,7 @@
Type:
Source:
@@ -478,7 +478,7 @@
Parameters:
Source:
@@ -738,7 +738,7 @@
Parameters:
Source:
@@ -831,7 +831,7 @@
Returns:

diff --git a/docs/SymEncryptedSessionKeyPacket.html b/docs/SymEncryptedSessionKeyPacket.html index 64f22f5a9..6a6c02673 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 dc4f9d2c7..c14d771b5 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 07ec3afd0..e313b54c3 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 f5e8797f3..4f90484d7 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 8bdb89881..dc0b5b710 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 6514b8a26..86aa36df9 100644 --- a/docs/global.html +++ b/docs/global.html @@ -352,7 +352,7 @@
Parameters:
Source:
@@ -565,7 +565,7 @@
Properties
Source:
@@ -704,7 +704,7 @@
Parameters:
Source:
@@ -1113,7 +1113,7 @@
Properties
Source:
@@ -1694,7 +1694,7 @@
Properties
Source:
@@ -1997,7 +1997,7 @@
Properties
Source:
@@ -2356,7 +2356,7 @@
Properties
Source:
@@ -2488,7 +2488,7 @@

detectBig
Source:
@@ -3257,7 +3257,7 @@

Properties
Source:
@@ -3545,7 +3545,7 @@
Properties
Source:
@@ -4165,7 +4165,7 @@
Properties
Source:
@@ -4381,7 +4381,7 @@
Parameters:
Source:
@@ -4587,6 +4587,9 @@
Properties
| 'curve25519' +| + +'symmetric' @@ -4612,7 +4615,7 @@
Properties
-

The primary key algorithm type: ECC (default for v4 keys), RSA, Curve448 or Curve25519 (new format, default for v6 keys). +

The primary key algorithm type: ECC (default for v4 keys), RSA, Curve448, Curve25519 (new format, default for v6 keys) or symmetric. Note: Curve448 and Curve25519 (new format) are not widely supported yet.

@@ -4737,6 +4740,76 @@
Properties
+ + + symmetricCipher + + + + + +String + + + + + + + + + + + + + + + + + + + + + +

(optional) Symmetric algorithm for persistent symmetric aead keys

+ + + + + + + symmetricHash + + + + + +String + + + + + + + + + + + + + + + + + + + + + +

(optional)Hash lgorithm for persistent symmetric hmac keys

+ + + + date @@ -4982,7 +5055,7 @@
Properties
Source:
@@ -5332,7 +5405,7 @@
Properties
Source:
@@ -5493,7 +5566,7 @@
Parameters:
Source:
@@ -5632,7 +5705,7 @@
Parameters:
Source:
@@ -5771,7 +5844,7 @@
Parameters:
Source:
@@ -5921,7 +5994,7 @@
Parameters:
Source:
@@ -6101,7 +6174,7 @@
Parameters:
Source:
@@ -6245,7 +6318,7 @@

newS2
Source:
@@ -6435,7 +6508,7 @@

Parameters:
Source:
@@ -6827,7 +6900,7 @@
Parameters:
Source:
@@ -7068,7 +7141,7 @@
Properties
Source:
@@ -7356,7 +7429,7 @@
Properties
Source:
@@ -7644,7 +7717,7 @@
Properties
Source:
@@ -7938,7 +8011,7 @@
Properties
Source:
@@ -8226,7 +8299,7 @@
Properties
Source:
@@ -8514,7 +8587,7 @@
Properties
Source:
@@ -8802,7 +8875,7 @@
Properties
Source:
@@ -9264,7 +9337,7 @@
Properties
Source:
@@ -9793,7 +9866,7 @@
Properties
Source:
@@ -10008,7 +10081,7 @@
Parameters:
Source:
@@ -10557,7 +10630,7 @@
Properties
Source:
@@ -10719,7 +10792,7 @@
Parameters:
Source:
@@ -11181,7 +11254,7 @@
Properties
Source:
@@ -11426,7 +11499,7 @@
Parameters:
Source:
@@ -11606,7 +11679,7 @@
Parameters:
Source:
@@ -11674,7 +11747,7 @@
Returns:

diff --git a/docs/index.html b/docs/index.html index e20f21eda..f21849975 100644 --- a/docs/index.html +++ b/docs/index.html @@ -205,7 +205,7 @@

Performance

  • The library implements authenticated encryption (AEAD) as per the "crypto refresh" draft standard using AES-OCB, EAX, or GCM. This makes symmetric encryption faster on platforms with native implementations. However, since the specification is very recent and other OpenPGP implementations are in the process of adopting it, the feature is currently behind a flag. Note: activating this setting can break compatibility with other OpenPGP implementations which have yet to implement the feature. You can enable it by setting openpgp.config.aeadProtect = true. -Note that this setting has a different effect from the one in OpenPGP.js v5, which implemented support for a provisional version of AEAD from RFC4880bis, which was modified in a later draft of the crypto refresh.

    +Note that this setting has a different effect from the one in OpenPGP.js v6, which implemented support for a provisional version of AEAD from RFC4880bis, which was modified in a later draft of the crypto refresh.

    You can change the AEAD mode by setting one of the following options:

    openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.ocb; // Default (widest ecosystem support), non-native
     openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.gcm; // Native in WebCrypto and Node.js
    @@ -265,7 +265,7 @@ 

    TypeScript

    If you notice missing or incorrect type definitions, feel free to open a PR.

    Examples

    -

    Here are some examples of how to use OpenPGP.js v5. For more elaborate examples and working code, please check out the public API unit tests. If you're upgrading from v4 it might help to check out the changelog and documentation.

    +

    Here are some examples of how to use OpenPGP.js v6. For more elaborate examples and working code, please check out the public API unit tests. If you're upgrading from v4 it might help to check out the changelog and documentation.

    Encrypt and decrypt Uint8Array data with a password

    Encryption will use the algorithm specified in config.preferredSymmetricAlgorithm (defaults to aes256), and decryption will use the algorithm used for encryption.

    (async () => {
    @@ -706,7 +706,7 @@ 

    License


    diff --git a/docs/module-config.html b/docs/module-config.html index 55a40273b..e6ad3daa5 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:
    @@ -489,7 +489,7 @@
    Properties:
    Source:
    @@ -514,6 +514,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

    @@ -614,7 +731,7 @@
    Properties:
    Source:
    @@ -733,7 +850,7 @@
    Properties:
    Source:
    @@ -854,7 +971,7 @@
    Properties:
    Source:
    @@ -979,7 +1096,7 @@
    Properties:
    Source:
    @@ -1091,7 +1208,7 @@
    Properties:
    Source:
    @@ -1213,7 +1330,7 @@
    Properties:
    Source:
    @@ -1331,7 +1448,7 @@
    Properties:
    Source:
    @@ -1443,7 +1560,7 @@
    Properties:
    Source:
    @@ -1555,7 +1672,7 @@
    Properties:
    Source:
    @@ -1672,7 +1789,7 @@
    Properties:
    Source:
    @@ -1788,7 +1905,7 @@
    Properties:
    Source:
    @@ -1905,7 +2022,7 @@
    Properties:
    Source:
    @@ -2022,7 +2139,7 @@
    Properties:
    Source:
    @@ -2139,7 +2256,7 @@
    Properties:
    Source:
    @@ -2251,7 +2368,7 @@
    Properties:
    Source:
    @@ -2363,7 +2480,7 @@
    Properties:
    Source:
    @@ -2475,7 +2592,7 @@
    Properties:
    Source:
    @@ -2591,7 +2708,7 @@
    Properties:
    Source:
    @@ -2707,7 +2824,7 @@
    Properties:
    Source:
    @@ -2823,7 +2940,7 @@
    Properties:
    Source:
    @@ -2939,7 +3056,7 @@
    Properties:
    Source:
    @@ -3051,7 +3168,7 @@
    Properties:
    Source:
    @@ -3266,7 +3383,7 @@
    Properties
    Source:
    @@ -3385,7 +3502,7 @@
    Properties:
    Source:
    @@ -3507,7 +3624,7 @@
    Properties:
    Source:
    @@ -3619,7 +3736,7 @@
    Properties:
    Source:
    @@ -3731,7 +3848,7 @@
    Properties:
    Source:
    @@ -3848,7 +3965,7 @@
    Properties:
    Source:
    @@ -3966,7 +4083,7 @@
    Properties:
    Source:
    @@ -4078,7 +4195,7 @@
    Properties:
    Source:
    @@ -4112,7 +4229,7 @@
    Properties:

    diff --git a/docs/module-crypto.html b/docs/module-crypto.html index b6f6f44f9..393798a1c 100644 --- a/docs/module-crypto.html +++ b/docs/module-crypto.html @@ -89,7 +89,7 @@

    Module: crypto

    Source:
    @@ -169,7 +169,7 @@

    Module: crypto


    diff --git a/docs/module-crypto_aes_kw.html b/docs/module-crypto_aes_kw.html index 86b2ee47c..eb0c6de73 100644 --- a/docs/module-crypto_aes_kw.html +++ b/docs/module-crypto_aes_kw.html @@ -89,7 +89,7 @@

    Module: crypto/aes_kw

    Source:
    @@ -308,7 +308,7 @@
    Parameters:
    Source:
    @@ -521,7 +521,7 @@
    Parameters:
    Source:
    @@ -589,7 +589,7 @@
    Returns:

    diff --git a/docs/module-crypto_cmac.html b/docs/module-crypto_cmac.html index 51430d3ef..3e3fb2c84 100644 --- a/docs/module-crypto_cmac.html +++ b/docs/module-crypto_cmac.html @@ -90,7 +90,7 @@

    Module: crypto/cmac

    Source:
    @@ -195,7 +195,7 @@

    (inner, constant
    Source:
    @@ -352,7 +352,7 @@
    Parameters:
    Source:
    @@ -398,7 +398,7 @@
    Parameters:

    diff --git a/docs/module-crypto_crypto.html b/docs/module-crypto_crypto.html index a79a85c7f..43699fcb9 100644 --- a/docs/module-crypto_crypto.html +++ b/docs/module-crypto_crypto.html @@ -90,7 +90,7 @@

    Module: crypto/crypto

    Source:
    @@ -147,7 +147,7 @@

    Methods

    -

    (async, static) generateParams(algo, bits, oid) → {Promise.<{publicParams: {Object}, privateParams: {Object}}>}

    +

    (async, static) generateParams(algo, bits, oid, symmetric) → {Promise.<{publicParams: {Object}, privateParams: {Object}}>}

    @@ -257,6 +257,32 @@
    Parameters:
    + + + + symmetric + + + + + +module:enums.symmetric +| + +enums.hash + + + + + + + + + +

    Hash or cipher algorithm for symmetric keys

    + + + @@ -296,7 +322,7 @@
    Parameters:
    Source:
    @@ -458,7 +484,7 @@
    Parameters:
    Source:
    @@ -619,7 +645,7 @@
    Parameters:
    Source:
    @@ -848,7 +874,7 @@
    Parameters:
    Source:
    @@ -1030,7 +1056,7 @@
    Parameters:
    Source:
    @@ -1170,7 +1196,7 @@
    Parameters:
    Source:
    @@ -1354,7 +1380,7 @@
    Parameters:
    Source:
    @@ -1518,7 +1544,7 @@
    Parameters:
    -

    (ECC only) public params, needed to format some private params

    +

    (ECC and symmetric only) public params, needed to format some private params

    @@ -1561,7 +1587,7 @@
    Parameters:
    Source:
    @@ -1745,7 +1771,7 @@
    Parameters:
    Source:
    @@ -2075,7 +2101,7 @@
    Parameters:
    Source:
    @@ -2162,7 +2188,7 @@
    Returns:
    -

    (async, static) publicKeyEncrypt(keyAlgo, symmetricAlgo, publicParams, data, fingerprint) → {Promise.<Object>}

    +

    (async, static) publicKeyEncrypt(keyAlgo, symmetricAlgo, publicParams, privateParams, data, fingerprint) → {Promise.<Object>}

    @@ -2274,6 +2300,29 @@
    Parameters:
    + + + privateParams + + + + + +Object + + + + + + + + + +

    Algorithm-specific private key parameters

    + + + + data @@ -2292,7 +2341,7 @@
    Parameters:
    -

    Session key data to be encrypted

    +

    Data to be encrypted

    @@ -2358,7 +2407,7 @@
    Parameters:
    Source:
    @@ -2542,7 +2591,7 @@
    Parameters:
    Source:
    @@ -2749,7 +2798,7 @@
    Parameters:
    Source:
    @@ -2910,7 +2959,7 @@
    Parameters:
    Source:
    @@ -2985,7 +3034,7 @@
    Throws:

    diff --git a/docs/module-crypto_hash.html b/docs/module-crypto_hash.html index 58d2f69e8..7497bc1da 100644 --- a/docs/module-crypto_hash.html +++ b/docs/module-crypto_hash.html @@ -89,7 +89,7 @@

    Module: crypto/hash

    Source:
    @@ -191,7 +191,7 @@

    (static) md5Source:
    @@ -352,7 +352,7 @@
    Parameters:
    Source:
    @@ -410,6 +410,167 @@
    Returns:
    +

    (static) getBlockSize(algo) → {Integer}

    + + + + + + +
    +

    Returns the internal block size in bytes of the specified hash algorithm type

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

    Hash algorithm type (See RFC 4880 9.4)

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

    Underlying block size in bytes.

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

    (static) getHashByteLength(algo) → {Integer}

    @@ -513,7 +674,7 @@
    Parameters:
    Source:
    @@ -581,7 +742,7 @@
    Returns:

    diff --git a/docs/module-crypto_hkdf.html b/docs/module-crypto_hkdf.html index 1e3d190a4..b8a64061a 100644 --- a/docs/module-crypto_hkdf.html +++ b/docs/module-crypto_hkdf.html @@ -89,7 +89,7 @@

    Module: crypto/hkdf

    Source:
    @@ -152,7 +152,7 @@

    Module: crypto/hkdf


    diff --git a/docs/module-crypto_mode.html b/docs/module-crypto_mode.html index a5f994397..ed2fd9a5e 100644 --- a/docs/module-crypto_mode.html +++ b/docs/module-crypto_mode.html @@ -89,7 +89,7 @@

    Module: crypto/mode

    Source:
    @@ -182,7 +182,7 @@

    (static) cfbSource:
    @@ -249,7 +249,7 @@

    (static) eaxSource:
    @@ -316,7 +316,7 @@

    (static) gcmSource:
    @@ -383,7 +383,7 @@

    (static) ocbSource:
    @@ -424,7 +424,7 @@

    (static) ocb
    diff --git a/docs/module-crypto_mode_cfb.html b/docs/module-crypto_mode_cfb.html index 1b25c348c..b168cb537 100644 --- a/docs/module-crypto_mode_cfb.html +++ b/docs/module-crypto_mode_cfb.html @@ -236,7 +236,7 @@
    Parameters:
    Source:
    @@ -477,7 +477,7 @@
    Parameters:
    Source:
    @@ -533,7 +533,7 @@
    Returns:

    diff --git a/docs/module-crypto_mode_eax.html b/docs/module-crypto_mode_eax.html index 50d977210..f201bfc7e 100644 --- a/docs/module-crypto_mode_eax.html +++ b/docs/module-crypto_mode_eax.html @@ -90,7 +90,7 @@

    Module: crypto/mode/eax

    Source:
    @@ -296,7 +296,7 @@
    Parameters:
    Source:
    @@ -480,7 +480,7 @@
    Parameters:
    Source:
    @@ -665,7 +665,7 @@
    Parameters:
    Source:
    @@ -733,7 +733,7 @@
    Returns:

    diff --git a/docs/module-crypto_mode_gcm.html b/docs/module-crypto_mode_gcm.html index 9264ae90b..59f160a05 100644 --- a/docs/module-crypto_mode_gcm.html +++ b/docs/module-crypto_mode_gcm.html @@ -90,7 +90,7 @@

    Module: crypto/mode/gcm

    Source:
    @@ -273,7 +273,7 @@
    Parameters:
    Source:
    @@ -319,7 +319,7 @@
    Parameters:

    diff --git a/docs/module-crypto_mode_ocb.html b/docs/module-crypto_mode_ocb.html index 15b9f96ea..fba040707 100644 --- a/docs/module-crypto_mode_ocb.html +++ b/docs/module-crypto_mode_ocb.html @@ -89,7 +89,7 @@

    Module: crypto/mode/ocb

    Source:
    @@ -295,7 +295,7 @@
    Parameters:
    Source:
    @@ -502,7 +502,7 @@
    Parameters:
    Source:
    @@ -686,7 +686,7 @@
    Parameters:
    Source:
    @@ -732,7 +732,7 @@
    Parameters:

    diff --git a/docs/module-crypto_pkcs1.html b/docs/module-crypto_pkcs1.html index 77b6196dc..6a784e501 100644 --- a/docs/module-crypto_pkcs1.html +++ b/docs/module-crypto_pkcs1.html @@ -89,7 +89,7 @@

    Module: crypto/pkcs1

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

    (inner, constan
    Source:
    @@ -358,7 +358,7 @@
    Parameters:
    Source:
    @@ -578,7 +578,7 @@
    Parameters:
    Source:
    @@ -792,7 +792,7 @@
    Parameters:
    Source:
    @@ -867,7 +867,7 @@
    Returns:

    diff --git a/docs/module-crypto_public_key.html b/docs/module-crypto_public_key.html index 44230499d..6d186cfd0 100644 --- a/docs/module-crypto_public_key.html +++ b/docs/module-crypto_public_key.html @@ -89,7 +89,7 @@

    Module: crypto/public_key

    Source:
    @@ -182,7 +182,7 @@

    (static) dsaSource:
    @@ -249,7 +249,7 @@

    (static) elga
    Source:
    @@ -316,7 +316,7 @@

    (static) ell
    Source:
    @@ -341,6 +341,73 @@

    (static) ell +

    (static) hmac

    + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + + + + + +
    See:
    +
    +
      +
    • module:crypto/public_key/hmac
    • +
    +
    + + + +
    + + + + + + + +

    (static) rsa

    @@ -383,7 +450,7 @@

    (static) rsaSource:
    @@ -424,7 +491,7 @@

    (static) rsa
    diff --git a/docs/module-crypto_public_key_dsa.html b/docs/module-crypto_public_key_dsa.html index 477c975dd..ea87c4e03 100644 --- a/docs/module-crypto_public_key_dsa.html +++ b/docs/module-crypto_public_key_dsa.html @@ -89,7 +89,7 @@

    Module: crypto/public_key/dsa

    Source:
    @@ -188,7 +188,7 @@

    (inner) xSource:
    @@ -434,7 +434,7 @@
    Parameters:
    Source:
    @@ -683,7 +683,7 @@
    Parameters:
    Source:
    @@ -1005,7 +1005,7 @@
    Parameters:
    Source:
    @@ -1069,7 +1069,7 @@
    Returns:

    diff --git a/docs/module-crypto_public_key_elgamal.html b/docs/module-crypto_public_key_elgamal.html index 8bc4483ce..ac6838a02 100644 --- a/docs/module-crypto_public_key_elgamal.html +++ b/docs/module-crypto_public_key_elgamal.html @@ -89,7 +89,7 @@

    Module: crypto/public_key/elgamal

    Source:
    @@ -188,7 +188,7 @@

    (inner) xSource:
    @@ -412,7 +412,7 @@
    Parameters:
    Source:
    @@ -672,7 +672,7 @@
    Parameters:
    Source:
    @@ -898,7 +898,7 @@
    Parameters:
    Source:
    @@ -966,7 +966,7 @@
    Returns:

    diff --git a/docs/module-crypto_public_key_elliptic.html b/docs/module-crypto_public_key_elliptic.html index bdbb779e7..20188882f 100644 --- a/docs/module-crypto_public_key_elliptic.html +++ b/docs/module-crypto_public_key_elliptic.html @@ -89,7 +89,7 @@

    Module: crypto/public_key/elliptic

    Source:
    @@ -165,7 +165,7 @@

    Module: crypto/public_key/elliptic


    diff --git a/docs/module-crypto_public_key_elliptic_curve.html b/docs/module-crypto_public_key_elliptic_curve.html index 9bb3ccd5e..bf3460ee4 100644 --- a/docs/module-crypto_public_key_elliptic_curve.html +++ b/docs/module-crypto_public_key_elliptic_curve.html @@ -89,7 +89,7 @@

    Module: crypto/public_key/elliptic/curve

    Source:
    @@ -249,7 +249,7 @@
    Parameters:
    Source:
    @@ -406,7 +406,7 @@
    Parameters:
    Source:
    @@ -632,7 +632,7 @@
    Parameters:
    Source:
    @@ -835,7 +835,7 @@
    Parameters:
    Source:
    @@ -1066,7 +1066,7 @@
    Parameters:
    Source:
    @@ -1134,7 +1134,7 @@
    Returns:

    diff --git a/docs/module-crypto_public_key_elliptic_ecdh.html b/docs/module-crypto_public_key_elliptic_ecdh.html index 585f2f1f5..d7de01d62 100644 --- a/docs/module-crypto_public_key_elliptic_ecdh.html +++ b/docs/module-crypto_public_key_elliptic_ecdh.html @@ -91,7 +91,7 @@

    Module: crypto/public_key/elliptic/ecdh

    Source:
    @@ -169,7 +169,7 @@

    Module: crypto/public_key/elliptic/ecdh

    Source:
    @@ -299,7 +299,7 @@
    Parameters:
    -module:type/kdf_params +module:type/kdf_params @@ -467,7 +467,7 @@
    Parameters:
    Source:
    @@ -720,7 +720,7 @@
    Parameters:
    Source:
    @@ -851,7 +851,7 @@
    Parameters:
    -module:type/kdf_params +module:type/kdf_params @@ -973,7 +973,7 @@
    Parameters:
    Source:
    @@ -1176,7 +1176,7 @@
    Parameters:
    Source:
    @@ -1337,7 +1337,7 @@
    Parameters:
    Source:
    @@ -1540,7 +1540,7 @@
    Parameters:
    Source:
    @@ -1747,7 +1747,7 @@
    Parameters:
    Source:
    @@ -1977,7 +1977,7 @@
    Parameters:
    Source:
    @@ -2157,7 +2157,7 @@
    Parameters:
    Source:
    @@ -2360,7 +2360,7 @@
    Parameters:
    Source:
    @@ -2540,7 +2540,7 @@
    Parameters:
    Source:
    @@ -2766,7 +2766,7 @@
    Parameters:
    Source:
    @@ -2946,7 +2946,7 @@
    Parameters:
    Source:
    @@ -3077,7 +3077,7 @@
    Returns:
    Source:
    @@ -3155,7 +3155,7 @@
    Returns:
    Source:
    @@ -3285,7 +3285,7 @@
    Parameters:
    -module:type/kdf_params +module:type/kdf_params @@ -3453,7 +3453,7 @@
    Parameters:
    Source:
    @@ -3706,7 +3706,7 @@
    Parameters:
    Source:
    @@ -3837,7 +3837,7 @@
    Parameters:
    -module:type/kdf_params +module:type/kdf_params @@ -3959,7 +3959,7 @@
    Parameters:
    Source:
    @@ -4162,7 +4162,7 @@
    Parameters:
    Source:
    @@ -4323,7 +4323,7 @@
    Parameters:
    Source:
    @@ -4526,7 +4526,7 @@
    Parameters:
    Source:
    @@ -4733,7 +4733,7 @@
    Parameters:
    Source:
    @@ -4963,7 +4963,7 @@
    Parameters:
    Source:
    @@ -5143,7 +5143,7 @@
    Parameters:
    Source:
    @@ -5346,7 +5346,7 @@
    Parameters:
    Source:
    @@ -5526,7 +5526,7 @@
    Parameters:
    Source:
    @@ -5752,7 +5752,7 @@
    Parameters:
    Source:
    @@ -5932,7 +5932,7 @@
    Parameters:
    Source:
    @@ -5996,7 +5996,7 @@
    Returns:

    diff --git a/docs/module-crypto_public_key_elliptic_ecdsa.html b/docs/module-crypto_public_key_elliptic_ecdsa.html index ec2cb35c7..936115a97 100644 --- a/docs/module-crypto_public_key_elliptic_ecdsa.html +++ b/docs/module-crypto_public_key_elliptic_ecdsa.html @@ -89,7 +89,7 @@

    Module: crypto/public_key/elliptic/ecdsa

    Source:
    @@ -364,7 +364,7 @@
    Parameters:
    Source:
    @@ -571,7 +571,7 @@
    Parameters:
    Source:
    @@ -847,7 +847,7 @@
    Parameters:
    Source:
    @@ -956,7 +956,7 @@

    (async, inner) Source:
    @@ -1002,7 +1002,7 @@

    (async, inner)
    diff --git a/docs/module-crypto_public_key_elliptic_eddsa.html b/docs/module-crypto_public_key_elliptic_eddsa.html index 1f8c76be9..6565958db 100644 --- a/docs/module-crypto_public_key_elliptic_eddsa.html +++ b/docs/module-crypto_public_key_elliptic_eddsa.html @@ -89,7 +89,7 @@

    Module: crypto/public_key/elliptic/eddsa

    Source:
    @@ -249,7 +249,7 @@
    Parameters:
    Source:
    @@ -521,7 +521,7 @@
    Parameters:
    Source:
    @@ -751,7 +751,7 @@
    Parameters:
    Source:
    @@ -1027,7 +1027,7 @@
    Parameters:
    Source:
    @@ -1091,7 +1091,7 @@
    Returns:

    diff --git a/docs/module-crypto_public_key_elliptic_eddsa_legacy.html b/docs/module-crypto_public_key_elliptic_eddsa_legacy.html index efeafadbf..9eb62af03 100644 --- a/docs/module-crypto_public_key_elliptic_eddsa_legacy.html +++ b/docs/module-crypto_public_key_elliptic_eddsa_legacy.html @@ -90,7 +90,7 @@

    Module: crypto/public_key/elliptic/eddsa_legacy

    Source:
    @@ -365,7 +365,7 @@
    Parameters:
    Source:
    @@ -572,7 +572,7 @@
    Parameters:
    Source:
    @@ -848,7 +848,7 @@
    Parameters:
    Source:
    @@ -912,7 +912,7 @@
    Returns:

    diff --git a/docs/module-crypto_public_key_prime.html b/docs/module-crypto_public_key_prime.html index abbe4ce7e..a71625035 100644 --- a/docs/module-crypto_public_key_prime.html +++ b/docs/module-crypto_public_key_prime.html @@ -89,7 +89,7 @@

    Module: crypto/public_key/prime

    Source:
    @@ -273,7 +273,7 @@
    Parameters:
    Source:
    @@ -476,7 +476,7 @@
    Parameters:
    Source:
    @@ -680,7 +680,7 @@
    Parameters:
    Source:
    @@ -883,7 +883,7 @@
    Parameters:
    Source:
    @@ -939,7 +939,7 @@
    Returns:

    diff --git a/docs/module-crypto_public_key_rsa.html b/docs/module-crypto_public_key_rsa.html index f25799940..3c082aaf4 100644 --- a/docs/module-crypto_public_key_rsa.html +++ b/docs/module-crypto_public_key_rsa.html @@ -89,7 +89,7 @@

    Module: crypto/public_key/rsa

    Source:
    @@ -411,7 +411,7 @@
    Parameters:
    Source:
    @@ -647,7 +647,7 @@
    Parameters:
    Source:
    @@ -833,7 +833,7 @@
    Parameters:
    Source:
    @@ -1186,7 +1186,7 @@
    Parameters:
    Source:
    @@ -1462,7 +1462,7 @@
    Parameters:
    Source:
    @@ -1738,7 +1738,7 @@
    Parameters:
    Source:
    @@ -1846,7 +1846,7 @@

    (inner)
    Source:
    @@ -2123,7 +2123,7 @@

    Parameters:
    Source:
    @@ -2308,7 +2308,7 @@
    Parameters:
    Source:
    @@ -2354,7 +2354,7 @@
    Parameters:

    diff --git a/docs/module-crypto_random.html b/docs/module-crypto_random.html index bce5b5f0f..3864ceb37 100644 --- a/docs/module-crypto_random.html +++ b/docs/module-crypto_random.html @@ -89,7 +89,7 @@

    Module: crypto/random

    Source:
    @@ -272,7 +272,7 @@
    Parameters:
    Source:
    @@ -433,7 +433,7 @@
    Parameters:
    Source:
    @@ -501,7 +501,7 @@
    Returns:

    diff --git a/docs/module-crypto_signature.html b/docs/module-crypto_signature.html index 9871733f1..285f2b88a 100644 --- a/docs/module-crypto_signature.html +++ b/docs/module-crypto_signature.html @@ -89,7 +89,7 @@

    Module: crypto/signature

    Source:
    @@ -276,7 +276,7 @@
    Parameters:
    Source:
    @@ -555,7 +555,7 @@
    Parameters:
    Source:
    @@ -613,7 +613,7 @@
    Returns:
    -

    (async, static) verify(algo, hashAlgo, signature, publicParams, data, hashed) → {Promise.<Boolean>}

    +

    (async, static) verify(algo, hashAlgo, signature, publicParams, privateParams, data, hashed) → {Promise.<Boolean>}

    @@ -750,6 +750,29 @@
    Parameters:
    + + + privateParams + + + + + +Object + + + + + + + + + +

    Algorithm-specific private key parameters

    + + + + data @@ -834,7 +857,7 @@
    Parameters:
    Source:
    @@ -902,7 +925,7 @@
    Returns:

    diff --git a/docs/module-encoding_base64.html b/docs/module-encoding_base64.html index 50e2f9c1a..e0a78a541 100644 --- a/docs/module-encoding_base64.html +++ b/docs/module-encoding_base64.html @@ -168,7 +168,7 @@
    Parameters:
    Source:
    @@ -332,7 +332,7 @@
    Parameters:
    Source:
    @@ -499,7 +499,7 @@
    Parameters:
    Source:
    @@ -686,7 +686,7 @@
    Parameters:
    Source:
    @@ -754,7 +754,7 @@
    Returns:

    diff --git a/docs/module-enums.html b/docs/module-enums.html index 00325c0f1..994f73134 100644 --- a/docs/module-enums.html +++ b/docs/module-enums.html @@ -235,7 +235,7 @@
    Properties:
    Source:
    @@ -499,7 +499,7 @@
    Properties:
    Source:
    @@ -694,7 +694,7 @@
    Properties:
    Source:
    @@ -1119,7 +1119,7 @@
    Properties:
    Source:
    @@ -1323,7 +1323,7 @@
    Properties:
    Source:
    @@ -1633,7 +1633,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:
    +
    @@ -1839,6 +1989,29 @@
    Properties:
    + + + forwardedCommunication + + + + + +Integer + + + + + + + + + +

    This key may be used for forwarded communications

    + + + + sharedPrivateKey @@ -1899,7 +2072,7 @@
    Properties:
    Source:
    @@ -2094,7 +2267,7 @@
    Properties:
    Source:
    @@ -2634,7 +2807,7 @@
    Properties:
    Source:
    @@ -3023,6 +3196,52 @@
    Properties:
    + + + + aead + + + + + +Integer + + + + + + + + + +

    Persistent symmetric keys: encryption algorithm

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

    Persistent symmetric keys: authentication algorithm

    + + + @@ -3060,7 +3279,7 @@
    Properties:
    Source:
    @@ -3278,7 +3497,7 @@
    Properties:
    Source:
    @@ -3496,7 +3715,7 @@
    Properties:
    Source:
    @@ -4013,7 +4232,7 @@
    Properties:
    Source:
    @@ -4737,7 +4956,7 @@
    Properties:
    Source:
    @@ -5024,7 +5243,7 @@
    Properties:
    Source:
    @@ -5220,7 +5439,7 @@
    Properties:
    Source:
    @@ -5374,7 +5593,7 @@
    Parameters:
    Source:
    @@ -5590,7 +5809,7 @@
    Parameters:
    Source:
    @@ -5687,7 +5906,7 @@
    Returns:

    diff --git a/docs/module-key_Subkey-Subkey.html b/docs/module-key_Subkey-Subkey.html index d8ef91ccd..fc322b2f2 100644 --- a/docs/module-key_Subkey-Subkey.html +++ b/docs/module-key_Subkey-Subkey.html @@ -171,7 +171,7 @@
    Parameters:
    Source:
    @@ -281,7 +281,7 @@

    cloneSource:
    @@ -394,7 +394,7 @@

    getAl
    Source:
    @@ -423,7 +423,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}.

    @@ -511,7 +511,7 @@

    getAl
    Source:
    @@ -540,7 +540,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}.

    @@ -628,7 +628,7 @@

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

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

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

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

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

    getKeyIDSource:
    @@ -1406,7 +1406,7 @@

    getKeyIDSource:
    @@ -1523,7 +1523,7 @@

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

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

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

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

    Parameters:
    Source:
    @@ -2487,7 +2487,7 @@
    Properties
    Source:
    @@ -2599,7 +2599,7 @@

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

    Parameters:
    Source:
    @@ -3044,7 +3044,7 @@
    Parameters:
    Source:
    @@ -3137,7 +3137,7 @@
    Returns:

    diff --git a/docs/module-key_Subkey.html b/docs/module-key_Subkey.html index da7d59b71..5191f9b85 100644 --- a/docs/module-key_Subkey.html +++ b/docs/module-key_Subkey.html @@ -77,7 +77,7 @@

    Classes


    diff --git a/docs/module-key_User-User.html b/docs/module-key_User-User.html index 8e8ef7859..195249454 100644 --- a/docs/module-key_User-User.html +++ b/docs/module-key_User-User.html @@ -171,7 +171,7 @@
    Parameters:
    Source:
    @@ -404,7 +404,7 @@
    Parameters:
    Source:
    @@ -516,7 +516,7 @@

    cloneSource:
    @@ -789,7 +789,7 @@
    Parameters:
    Source:
    @@ -1127,7 +1127,7 @@
    Properties
    Source:
    @@ -1239,7 +1239,7 @@

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

    Parameters:
    Source:
    @@ -1623,7 +1623,7 @@
    Parameters:
    Source:
    @@ -1887,7 +1887,7 @@
    Parameters:
    Source:
    @@ -2154,7 +2154,7 @@
    Parameters:
    Source:
    @@ -2234,7 +2234,7 @@
    Returns:

    diff --git a/docs/module-key_User.html b/docs/module-key_User.html index 8daa79567..cb5079710 100644 --- a/docs/module-key_User.html +++ b/docs/module-key_User.html @@ -77,7 +77,7 @@

    Classes


    diff --git a/docs/module-key_helper.html b/docs/module-key_helper.html index df586d3f3..327d5315c 100644 --- a/docs/module-key_helper.html +++ b/docs/module-key_helper.html @@ -89,7 +89,7 @@

    Module: key/helper

    Source:
    @@ -281,7 +281,7 @@
    Parameters:
    Source:
    @@ -518,7 +518,7 @@
    Parameters:
    Source:
    @@ -928,7 +928,7 @@
    Parameters:
    Source:
    @@ -1116,7 +1116,7 @@
    Parameters:
    Source:
    @@ -1352,7 +1352,7 @@
    Parameters:
    Source:
    @@ -1624,7 +1624,7 @@
    Parameters:
    Source:
    @@ -1896,7 +1896,7 @@
    Parameters:
    Source:
    @@ -2200,7 +2200,7 @@
    Parameters:
    Source:
    @@ -2507,7 +2507,7 @@
    Parameters:
    Source:
    @@ -2806,7 +2806,7 @@
    Parameters:
    Source:
    @@ -2852,7 +2852,7 @@
    Parameters:

    diff --git a/docs/module-packet_packet.html b/docs/module-packet_packet.html index 4ed6b6e49..d1b5c2225 100644 --- a/docs/module-packet_packet.html +++ b/docs/module-packet_packet.html @@ -89,7 +89,7 @@

    Module: packet/packet

    Source:
    @@ -275,7 +275,7 @@
    Parameters:
    Source:
    @@ -436,7 +436,7 @@
    Parameters:
    Source:
    @@ -621,7 +621,7 @@
    Parameters:
    Source:
    @@ -783,7 +783,7 @@
    Parameters:
    Source:
    @@ -851,7 +851,7 @@
    Returns:

    diff --git a/docs/module-type_ecdh_symkey.html b/docs/module-type_ecdh_symkey.html index b6fe97e6f..00062b60d 100644 --- a/docs/module-type_ecdh_symkey.html +++ b/docs/module-type_ecdh_symkey.html @@ -89,7 +89,7 @@

    Module: type/ecdh_symkey

    Source:
    @@ -152,7 +152,7 @@

    Module: type/ecdh_symkey


    diff --git a/docs/module-type_kdf_params-KDFParams.html b/docs/module-type_kdf_params-KDFParams.html index 87d5ca38d..f5ab92017 100644 --- a/docs/module-type_kdf_params-KDFParams.html +++ b/docs/module-type_kdf_params-KDFParams.html @@ -28,7 +28,8 @@

    Class: KDFParams

    -

    KDFParams(hash, cipher)

    +

    + type/kdf_params~KDFParams(version, hash, cipher, replacementFingerprint)

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

    KDFParamsnew KDFParams(hash, cipher)

    +

    new KDFParams(version, hash, cipher, replacementFingerprint)

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

    Version, defaults to 1

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

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

    + + + @@ -163,7 +210,7 @@
    Parameters:
    Source:
    @@ -322,7 +369,7 @@
    Parameters:
    Source:
    @@ -380,7 +427,7 @@
    Returns:
    -

    write() → {Uint8Array}

    +

    write(forReplacementParamsopt) → {Uint8Array}

    @@ -399,6 +446,67 @@

    writeParameters:

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

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

    + + @@ -434,7 +542,7 @@

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

    diff --git a/docs/module-type_kdf_params.html b/docs/module-type_kdf_params.html new file mode 100644 index 000000000..7c76db231 --- /dev/null +++ b/docs/module-type_kdf_params.html @@ -0,0 +1,179 @@ + + + + + JSDoc: Module: type/kdf_params + + + + + + + + + + +
    + +

    Module: type/kdf_params

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

    Implementation of type KDF parameters

    +

    RFC 6637 7: +A key derivation function (KDF) is necessary to implement the EC +encryption. The Concatenation Key Derivation Function (Approved +Alternative 1) [NIST-SP800-56A] with the KDF hash function that is +SHA2-256 [FIPS-180-3] or stronger is REQUIRED.

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

    Classes

    + +
    +
    KDFParams
    +
    +
    + + + + + + + + + + + + + + + +
    + +
    + + + + +
    + + + +
    + + + + + + + \ No newline at end of file diff --git a/docs/module-type_keyid-KeyID.html b/docs/module-type_keyid-KeyID.html index 9cdefc538..747906c37 100644 --- a/docs/module-type_keyid-KeyID.html +++ b/docs/module-type_keyid-KeyID.html @@ -101,7 +101,7 @@

    new KeyIDSource:
    @@ -295,7 +295,7 @@
    Parameters:
    Source:
    @@ -385,7 +385,7 @@

    isNullSource:
    @@ -497,7 +497,7 @@

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

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

    toHexSource:
    @@ -860,7 +860,7 @@

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

    diff --git a/docs/module-type_keyid.html b/docs/module-type_keyid.html index 9a78068bf..1a46dba24 100644 --- a/docs/module-type_keyid.html +++ b/docs/module-type_keyid.html @@ -77,7 +77,7 @@

    Classes


    diff --git a/docs/module-type_oid.html b/docs/module-type_oid.html index 8d23ee8aa..d11bf8bd4 100644 --- a/docs/module-type_oid.html +++ b/docs/module-type_oid.html @@ -100,7 +100,7 @@

    Module: type/oid

    Source:
    @@ -163,7 +163,7 @@

    Module: type/oid


    diff --git a/docs/module-type_s2k-GenericS2K.html b/docs/module-type_s2k-GenericS2K.html index 18af6ab1a..7f7bb0d74 100644 --- a/docs/module-type_s2k-GenericS2K.html +++ b/docs/module-type_s2k-GenericS2K.html @@ -153,7 +153,7 @@
    Parameters:
    Source:
    @@ -262,7 +262,7 @@
    Type:
    Source:
    @@ -332,7 +332,7 @@
    Type:
    Source:
    @@ -406,7 +406,7 @@
    Type:
    Source:
    @@ -480,7 +480,7 @@
    Type:
    Source:
    @@ -612,7 +612,7 @@
    Parameters:
    Source:
    @@ -774,7 +774,7 @@
    Parameters:
    Source:
    @@ -886,7 +886,7 @@

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

    diff --git a/docs/module-type_s2k.html b/docs/module-type_s2k.html index afc40e6a9..e70aff8f3 100644 --- a/docs/module-type_s2k.html +++ b/docs/module-type_s2k.html @@ -95,7 +95,7 @@

    Module: type/s2k

    Source:
    @@ -165,7 +165,7 @@

    Classes


    diff --git a/docs/module-type_x25519x448_symkey.html b/docs/module-type_x25519x448_symkey.html index cd9071b43..bf49dc9b9 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/module-util.html b/docs/module-util.html index fa68cd6a5..055b1c7d7 100644 --- a/docs/module-util.html +++ b/docs/module-util.html @@ -89,7 +89,7 @@

    Module: util

    Source:
    @@ -152,7 +152,7 @@

    Module: util


    diff --git a/docs/type_enum.module_js.html b/docs/type_enum.module_js.html new file mode 100644 index 000000000..e4cd9f2a4 --- /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 a2f322aa2..58aa3160e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@protontech/openpgp", - "version": "6.0.0-alpha.1", + "version": "6.0.0-alpha.1.patch.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@protontech/openpgp", - "version": "6.0.0-alpha.1", + "version": "6.0.0-alpha.1.patch.0", "license": "LGPL-3.0+", "devDependencies": { "@openpgp/asmcrypto.js": "^3.1.0", diff --git a/package.json b/package.json index 9ab98ab51..b19f0e61e 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": "6.0.0-alpha.1", + "version": "6.0.0-alpha.1.patch.0", "license": "LGPL-3.0+", "homepage": "https://openpgpjs.org/", "engines": {