From bd13edfc884cf6b6b7f715099529ac6a656733c6 Mon Sep 17 00:00:00 2001 From: Daniel Huigens Date: Mon, 24 Jan 2022 18:38:46 +0100 Subject: [PATCH] 5.1.0 --- docs/AEADEncryptedDataPacket.html | 197 ++++++++++- docs/CNAME | 1 - docs/CleartextMessage.html | 14 +- docs/CompressedDataPacket.html | 24 +- docs/Key.html | 56 ++-- docs/LiteralDataPacket.html | 56 +--- docs/MarkerPacket.html | 6 +- docs/Message.html | 48 +-- docs/OnePassSignaturePacket.html | 56 +++- docs/PacketList.html | 16 +- docs/PrivateKey.html | 22 +- docs/PublicKey.html | 10 +- docs/PublicKeyEncryptedSessionKeyPacket.html | 139 +++++++- docs/PublicKeyPacket.html | 52 +-- docs/PublicSubkeyPacket.html | 52 +-- docs/SecretKeyPacket.html | 94 +++--- docs/SecretSubkeyPacket.html | 94 +++--- docs/Signature.html | 10 +- docs/SignaturePacket.html | 234 +++++++++++++- ...EncryptedIntegrityProtectedDataPacket.html | 74 ++++- docs/SymEncryptedSessionKeyPacket.html | 242 +++++++++++++- docs/SymmetricallyEncryptedDataPacket.html | 12 +- docs/TrustPacket.html | 6 +- docs/UserAttributePacket.html | 10 +- docs/UserIDPacket.html | 12 +- docs/global.html | 147 +++++++-- docs/index.html | 11 +- docs/module-config.html | 306 ++++++++++++++++-- docs/module-crypto_random-RandomBuffer.html | 10 +- docs/module-enums.html | 295 +++++++++++++++-- docs/module-key_Subkey-Subkey.html | 42 +-- docs/module-key_User-User.html | 20 +- docs/module-type_kdf_params-KDFParams.html | 8 +- docs/module-type_keyid-KeyID.html | 16 +- docs/module-type_s2k-S2K.html | 173 +++++----- package-lock.json | 2 +- package.json | 2 +- 37 files changed, 1976 insertions(+), 593 deletions(-) delete mode 100644 docs/CNAME diff --git a/docs/AEADEncryptedDataPacket.html b/docs/AEADEncryptedDataPacket.html index 58dd788f..3bc86f13 100644 --- a/docs/AEADEncryptedDataPacket.html +++ b/docs/AEADEncryptedDataPacket.html @@ -98,7 +98,7 @@ AEAD Protected Data Packet

Source:
@@ -144,6 +144,150 @@ AEAD Protected Data Packet

+

Members

+ + + +

aeadAlgorithm :enums.aead

+ + + + + + +
Type:
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

cipherAlgorithm :enums.symmetric

+ + + + + + +
Type:
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

Methods

@@ -309,7 +453,7 @@ AEAD Protected Data Packet

Source:
@@ -415,7 +559,7 @@ AEAD Protected Data Packet

-String +enums.symmetric @@ -433,7 +577,7 @@ AEAD Protected Data Packet

-

The session key's cipher algorithm e.g. 'aes128'

+

The session key's cipher algorithm

@@ -540,7 +684,7 @@ AEAD Protected Data Packet

Source:
@@ -613,7 +757,7 @@ AEAD Protected Data Packet

-

Encrypt the packet list payload.

+

Encrypt the packet payload.

@@ -657,7 +801,7 @@ AEAD Protected Data Packet

-String +enums.symmetric @@ -675,7 +819,7 @@ AEAD Protected Data Packet

-

The session key's cipher algorithm e.g. 'aes128'

+

The session key's cipher algorithm

@@ -782,7 +926,7 @@ AEAD Protected Data Packet

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

Source:
@@ -976,6 +1120,35 @@ AEAD Protected Data Packet

+
Throws:
+ + + +
+
+
+

on parsing failure

+
+
+
+
+
+
+ Type +
+
+ +Error + + +
+
+
+
+
+ + + @@ -1043,7 +1216,7 @@ AEAD Protected Data Packet

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


diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index 7e306b72..00000000 --- a/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -docs.openpgpjs.org \ No newline at end of file diff --git a/docs/CleartextMessage.html b/docs/CleartextMessage.html index f812573b..9e518ab7 100644 --- a/docs/CleartextMessage.html +++ b/docs/CleartextMessage.html @@ -168,7 +168,7 @@ See https://tools.ietf.o
Source:
@@ -346,7 +346,7 @@ See https://tools.ietf.o
Source:
@@ -461,7 +461,7 @@ See https://tools.ietf.o
Source:
@@ -573,7 +573,7 @@ See https://tools.ietf.o
Source:
@@ -937,7 +937,7 @@ See https://tools.ietf.o
Source:
@@ -1174,7 +1174,7 @@ See https://tools.ietf.o
Source:
@@ -1242,7 +1242,7 @@ See https://tools.ietf.o
diff --git a/docs/CompressedDataPacket.html b/docs/CompressedDataPacket.html index 56f4d537..0f2b95ed 100644 --- a/docs/CompressedDataPacket.html +++ b/docs/CompressedDataPacket.html @@ -160,7 +160,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.

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

algorithm :compression +

algorithm :enums.compression

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

  • -compression +enums.compression
    • @@ -266,7 +266,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    -utf8 -| - -binary -| - -text -| - -mime +enums.literal @@ -986,7 +977,7 @@ with normalized end of line to \n

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

    Source:
    @@ -1198,8 +1189,6 @@ will be normalized to \r\n and by default text is converted to UTF8

    - Default - Description @@ -1236,10 +1225,6 @@ will be normalized to \r\n and by default text is converted to UTF8

    - - - -

    Any native javascript string

    @@ -1254,16 +1239,7 @@ will be normalized to \r\n and by default text is converted to UTF8

    -utf8 -| - -binary -| - -text -| - -mime +enums.literal @@ -1282,12 +1258,6 @@ will be normalized to \r\n and by default text is converted to UTF8

    - - - utf8 - - -

    The format of the string of bytes

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

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

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

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


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

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

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


    diff --git a/docs/Message.html b/docs/Message.html index 35bd06bd..d8ffd4ef 100644 --- a/docs/Message.html +++ b/docs/Message.html @@ -146,7 +146,7 @@ See https://tools.iet
    Source:
    @@ -209,7 +209,7 @@ See https://tools.iet -

    (async, static) encryptSessionKey(sessionKey, algorithm, aeadAlgorithmopt, encryptionKeysopt, passwordsopt, wildcardopt, encryptionKeyIDsopt, dateopt, userIDsopt, configopt) → {Promise.<Message>}

    +

    (async, static) encryptSessionKey(sessionKey, algorithmName, aeadAlgorithmNameopt, encryptionKeysopt, passwordsopt, wildcardopt, encryptionKeyIDsopt, dateopt, userIDsopt, configopt) → {Promise.<Message>}

    @@ -292,7 +292,7 @@ See https://tools.iet - algorithm + algorithmName @@ -327,7 +327,7 @@ See https://tools.iet - aeadAlgorithm + aeadAlgorithmName @@ -661,7 +661,7 @@ See https://tools.iet
    Source:
    @@ -933,7 +933,7 @@ See https://tools.iet
    Source:
    @@ -1140,7 +1140,7 @@ See https://tools.iet
    Source:
    @@ -1291,7 +1291,7 @@ See https://tools.iet
    Source:
    @@ -1495,7 +1495,7 @@ See https://tools.iet
    Source:
    @@ -1800,7 +1800,7 @@ See https://tools.iet
    Source:
    @@ -2072,7 +2072,7 @@ See https://tools.iet
    Source:
    @@ -2512,7 +2512,7 @@ See https://tools.iet
    Source:
    @@ -2624,7 +2624,7 @@ See https://tools.iet
    Source:
    @@ -2736,7 +2736,7 @@ See https://tools.iet
    Source:
    @@ -2851,7 +2851,7 @@ See https://tools.iet
    Source:
    @@ -2966,7 +2966,7 @@ See https://tools.iet
    Source:
    @@ -3078,7 +3078,7 @@ See https://tools.iet
    Source:
    @@ -3445,7 +3445,7 @@ See https://tools.iet
    Source:
    @@ -3809,7 +3809,7 @@ See https://tools.iet
    Source:
    @@ -3921,7 +3921,7 @@ See https://tools.iet
    Source:
    @@ -4158,7 +4158,7 @@ See https://tools.iet
    Source:
    @@ -4424,7 +4424,7 @@ See https://tools.iet
    Source:
    @@ -4536,7 +4536,7 @@ See https://tools.iet
    Source:
    @@ -4604,7 +4604,7 @@ See https://tools.iet
    diff --git a/docs/OnePassSignaturePacket.html b/docs/OnePassSignaturePacket.html index bc239098..9b41388c 100644 --- a/docs/OnePassSignaturePacket.html +++ b/docs/OnePassSignaturePacket.html @@ -101,7 +101,7 @@ can compute the entire signed message in one pass.

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

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

    -

    hashAlgorithm

    +

    hashAlgorithm :enums.hash

    @@ -228,6 +228,16 @@ that describes another signature to be applied to the same message data.

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

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

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

    -

    publicKeyAlgorithm

    +

    publicKeyAlgorithm :enums.publicKey

    @@ -363,6 +373,16 @@ that describes another signature to be applied to the same message data.

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

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

    -

    signatureType

    +

    signatureType :enums.signature

    @@ -436,6 +456,16 @@ Signature types are described in +
    Type:
    + + @@ -471,7 +501,7 @@ Signature types are described in
    Source:
    @@ -535,7 +565,7 @@ Signature types are described in
    Source:
    @@ -666,7 +696,7 @@ Signature types are described in
    Source:
    @@ -778,7 +808,7 @@ Signature types are described in
    Source:
    @@ -846,7 +876,7 @@ Signature types are described in
    diff --git a/docs/PacketList.html b/docs/PacketList.html index 4af33789..88644098 100644 --- a/docs/PacketList.html +++ b/docs/PacketList.html @@ -97,7 +97,7 @@ are stored as numerical indices.

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

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

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

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

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

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

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


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

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

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

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

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

    Source:
    @@ -1766,7 +1766,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err
    Source:
    @@ -1841,7 +1841,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err
    diff --git a/docs/PublicKey.html b/docs/PublicKey.html index 27d3b11f..59e54e13 100644 --- a/docs/PublicKey.html +++ b/docs/PublicKey.html @@ -144,7 +144,7 @@
    Source:
    @@ -315,7 +315,7 @@
    Source:
    @@ -427,7 +427,7 @@
    Source:
    @@ -535,7 +535,7 @@
    Source:
    @@ -603,7 +603,7 @@
    diff --git a/docs/PublicKeyEncryptedSessionKeyPacket.html b/docs/PublicKeyEncryptedSessionKeyPacket.html index b9febf3f..69cbdad6 100644 --- a/docs/PublicKeyEncryptedSessionKeyPacket.html +++ b/docs/PublicKeyEncryptedSessionKeyPacket.html @@ -107,7 +107,7 @@ decrypt the message.

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

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

    sessionKeyAlgorithm :enums.symmetric

    + + + + +
    +

    Algorithm to encrypt the message with

    +
    + + + +
    Type:
    + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    @@ -237,7 +311,7 @@ decrypt the message.

    -

    (async) decrypt(key)

    +

    (async) decrypt(key, randomSessionKeyopt)

    @@ -245,8 +319,7 @@ decrypt the message.

    -

    Decrypts the session key (only for public key encrypted session key -packets (tag 1)

    +

    Decrypts the session key (only for public key encrypted session key packets (tag 1)

    @@ -270,6 +343,8 @@ packets (tag 1)

    Type + Attributes + @@ -295,6 +370,14 @@ packets (tag 1)

    + + + + + + + + @@ -302,6 +385,40 @@ packets (tag 1)

    + + + + randomSessionKey + + + + + +Object + + + + + + + + + <optional>
    + + + + + + + + + + +

    Bogus session key to use in case of sensitive decryption error, or if the decrypted session key is of a different type/size. +This is needed for constant-time processing. Expected object of the form: { sessionKey: Uint8Array, sessionKeyAlgorithm: enums.symmetric }

    + + + @@ -341,7 +458,7 @@ packets (tag 1)

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

    -

    if decryption failed

    +

    if decryption failed, unless randomSessionKey is given

    @@ -509,7 +626,7 @@ packets (tag 1)

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

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

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


    diff --git a/docs/PublicKeyPacket.html b/docs/PublicKeyPacket.html index 4b0ed6dc..941abeba 100644 --- a/docs/PublicKeyPacket.html +++ b/docs/PublicKeyPacket.html @@ -195,7 +195,7 @@ key (sometimes called an OpenPGP certificate).

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

    -

    algorithm :String

    +

    algorithm :enums.publicKey

    @@ -260,7 +260,7 @@ key (sometimes called an OpenPGP certificate).

    + + + + + + + + +

    (static) constantTimePKCS1Decryption

    + + + + +
    +

    Enable constant-time decryption of RSA- and ElGamal-encrypted session keys, to hinder Bleichenbacher-like attacks (https://link.springer.com/chapter/10.1007/BFb0055716). +This setting has measurable performance impact and it is only helpful in application scenarios where both of the following conditions apply:

    +
      +
    • new/incoming messages are automatically decrypted (without user interaction);
      • +
    • an attacker can determine how long it takes to decrypt each message (e.g. due to decryption errors being logged remotely). +See also constantTimePKCS1DecryptionSupportedSymmetricAlgorithms.
      • +
    +
    + + + + + + + +
    Properties:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    constantTimePKCS1Decryption + + +Boolean + + + +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + + + + + + + +
    + + + + + + + + +

    (static) constantTimePKCS1DecryptionSupportedSymmetricAlgorithms

    + + + + +
    +

    This setting is only meaningful if constantTimePKCS1Decryption is enabled. +Decryption of RSA- and ElGamal-encrypted session keys of symmetric algorithms different from the ones specified here will fail. +However, the more algorithms are added, the slower the decryption procedure becomes.

    +
    + + + + + + + +
    Properties:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    constantTimePKCS1DecryptionSupportedSymmetricAlgorithms + + +Set.<Integer> + + + +

    module:enums.symmetric

    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    @@ -1183,7 +1423,7 @@ This setting is insecure if the partially decrypted message is
    Source:
    @@ -1295,7 +1535,7 @@ This setting is insecure if the partially decrypted message is
    Source:
    @@ -1407,7 +1647,7 @@ This setting is insecure if the partially decrypted message is
    Source:
    @@ -1524,7 +1764,7 @@ validation error when the notation is marked as critical.

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

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

    Source:
    @@ -1869,7 +2109,7 @@ The default is 2047 since due to a bug, previous versions of OpenPGP.js could ge
    Source:
    @@ -1986,7 +2226,7 @@ The default is 2047 since due to a bug, previous versions of OpenPGP.js could ge
    Source:
    @@ -2103,7 +2343,7 @@ Only has an effect when aeadProtect is set to true.

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

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

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

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

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

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

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

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

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

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

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

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

    Source:
    @@ -3592,7 +3832,7 @@ Note: not all OpenPGP implementations are compatible with this option.
    Source:
    @@ -3704,7 +3944,7 @@ Note: not all OpenPGP implementations are compatible with this option.
    Source:
    @@ -3738,7 +3978,7 @@ Note: not all OpenPGP implementations are compatible with this option.
    diff --git a/docs/module-crypto_random-RandomBuffer.html b/docs/module-crypto_random-RandomBuffer.html index 9073aade..6f58ca88 100644 --- a/docs/module-crypto_random-RandomBuffer.html +++ b/docs/module-crypto_random-RandomBuffer.html @@ -95,7 +95,7 @@
    Source:
    @@ -254,7 +254,7 @@
    Source:
    @@ -393,7 +393,7 @@
    Source:
    @@ -532,7 +532,7 @@
    Source:
    @@ -578,7 +578,7 @@
    diff --git a/docs/module-enums.html b/docs/module-enums.html index 22a1f3d5..995f2093 100644 --- a/docs/module-enums.html +++ b/docs/module-enums.html @@ -212,7 +212,7 @@
    Source:
    @@ -476,7 +476,7 @@
    Source:
    @@ -671,7 +671,7 @@
    Source:
    @@ -1878,7 +1878,7 @@
    Source:
    @@ -2059,7 +2059,7 @@ fingerprint format

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

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

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

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

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

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

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

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

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

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

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

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

    -

    (static) read()

    +

    (static) read(type, e) → {String}

    @@ -5808,7 +5808,7 @@ document) that cannot include a target subpacket.

    -

    Converts from an integer to string.

    +

    Converts enum integer value to the corresponding string, if it exists.

    @@ -5819,6 +5819,78 @@ document) that cannot include a target subpacket.

    +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    type + + +Object + + + +

    target enum type

    e + + +Integer + + + +

    value to convert

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

    Source:
    @@ -5877,8 +5949,59 @@ document) that cannot include a target subpacket.

    +
    Throws:
    + + + +
    +
    +
    +

    if the value is invalid

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

    name of enum value if it exists

    +
    + + + +
    +
    + Type +
    +
    + +String + + +
    +
    + + @@ -5890,7 +6013,7 @@ document) that cannot include a target subpacket.

    -

    (static) write()

    +

    (static) write(type, e) → {Integer}

    @@ -5898,7 +6021,7 @@ document) that cannot include a target subpacket.

    -

    Asserts validity and converts from string/integer to integer.

    +

    Asserts validity of given value and converts from string/integer to integer.

    @@ -5909,6 +6032,81 @@ document) that cannot include a target subpacket.

    +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    type + + +Object + + + +

    target enum type

    e + + +String +| + +Integer + + + +

    value to check and/or convert

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

    Source:
    @@ -5967,8 +6165,59 @@ document) that cannot include a target subpacket.

    +
    Throws:
    + + + +
    +
    +
    +

    if the value is invalid

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

    enum value if it exists

    +
    + + + +
    +
    + Type +
    +
    + +Integer + + +
    +
    + + @@ -5990,7 +6239,7 @@ document) that cannot include a target subpacket.


    diff --git a/docs/module-key_Subkey-Subkey.html b/docs/module-key_Subkey-Subkey.html index 9006a042..e14718e9 100644 --- a/docs/module-key_Subkey-Subkey.html +++ b/docs/module-key_Subkey-Subkey.html @@ -170,7 +170,7 @@
    Source:
    @@ -280,7 +280,7 @@
    Source:
    @@ -393,7 +393,7 @@
    Source:
    @@ -510,7 +510,7 @@
    Source:
    @@ -627,7 +627,7 @@
    Source:
    @@ -740,7 +740,7 @@
    Source:
    @@ -941,7 +941,7 @@ Returns null if the subkey is invalid.

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

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

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

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

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

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

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

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

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

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

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

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

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

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


    diff --git a/docs/module-key_User-User.html b/docs/module-key_User-User.html index ea5affd9..940fa81e 100644 --- a/docs/module-key_User-User.html +++ b/docs/module-key_User-User.html @@ -170,7 +170,7 @@
    Source:
    @@ -403,7 +403,7 @@
    Source:
    @@ -515,7 +515,7 @@
    Source:
    @@ -788,7 +788,7 @@
    Source:
    @@ -900,7 +900,7 @@
    Source:
    @@ -1103,7 +1103,7 @@
    Source:
    @@ -1284,7 +1284,7 @@ and validity of self signature.

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

    Source:
    @@ -1815,7 +1815,7 @@ Signature validity is null if the verification keys do not correspond to the cer
    Source:
    @@ -1895,7 +1895,7 @@ Signature validity is null if the verification keys do not correspond to the cer
    diff --git a/docs/module-type_kdf_params-KDFParams.html b/docs/module-type_kdf_params-KDFParams.html index 3c6391df..ee131114 100644 --- a/docs/module-type_kdf_params-KDFParams.html +++ b/docs/module-type_kdf_params-KDFParams.html @@ -163,7 +163,7 @@
    Source:
    @@ -322,7 +322,7 @@
    Source:
    @@ -434,7 +434,7 @@
    Source:
    @@ -502,7 +502,7 @@
    diff --git a/docs/module-type_keyid-KeyID.html b/docs/module-type_keyid-KeyID.html index fcb47aa1..2de4bf7c 100644 --- a/docs/module-type_keyid-KeyID.html +++ b/docs/module-type_keyid-KeyID.html @@ -100,7 +100,7 @@ formed.

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

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

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

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

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

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

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


    diff --git a/docs/module-type_s2k-S2K.html b/docs/module-type_s2k-S2K.html index e5729cd8..22466ee4 100644 --- a/docs/module-type_s2k-S2K.html +++ b/docs/module-type_s2k-S2K.html @@ -152,7 +152,7 @@
    Source:
    @@ -202,11 +202,15 @@ -

    algorithm :module:enums.hash

    +

    algorithm :module:enums.hash|0

    +
    +

    Hash function identifier, or 0 for gnu-dummy keys

    +
    +
    Type:
    @@ -214,6 +218,9 @@
  • module:enums.hash +| + +0
    • @@ -254,7 +261,7 @@
    Source:
    @@ -324,7 +331,7 @@
    Source:
    @@ -342,7 +349,7 @@ -

    salt :String

    +

    salt :Uint8Array

    @@ -353,6 +360,80 @@ +
    Type:
    +
      +
    • + +Uint8Array + + +
      • +
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + + + + + + + +
    + + + + + + + + +

    type :String

    + + + + +
    +

    enums.s2k identifier or 'gnu-dummy'

    +
    + + +
    Type:
    - - - - - - - - -

    type :module:enums.s2k

    - - - - - - -
    Type:
    - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Source:
    -
    @@ -600,7 +611,7 @@ hashAlgorithm

    Source:
    @@ -709,7 +720,7 @@ hashAlgorithm hash length

    -String +Uint8Array @@ -762,7 +773,7 @@ hashAlgorithm hash length

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

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


    diff --git a/package-lock.json b/package-lock.json index b23b2a5a..18b7512e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "openpgp", - "version": "5.0.1", + "version": "5.1.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 217aef74..d060864e 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "openpgp", "description": "OpenPGP.js is a Javascript implementation of the OpenPGP protocol. This is defined in RFC 4880.", - "version": "5.0.1", + "version": "5.1.0", "license": "LGPL-3.0+", "homepage": "https://openpgpjs.org/", "engines": {