From 1bff8aad50a1a33406832952a61af4c82dd963e5 Mon Sep 17 00:00:00 2001 From: Daniel Huigens Date: Fri, 28 May 2021 17:36:43 +0200 Subject: [PATCH] 5.0.0-3 --- docs/AEADEncryptedDataPacket.html | 67 +- docs/CleartextMessage.html | 14 +- docs/CompressedDataPacket.html | 316 +- docs/Key.html | 2572 +---------------- docs/LiteralDataPacket.html | 22 +- docs/MarkerPacket.html | 72 +- docs/Message.html | 155 +- docs/OnePassSignaturePacket.html | 20 +- docs/PacketList.html | 847 ++++-- docs/PrivateKey.html | 1964 +++++++++++++ docs/PublicKey.html | 726 +++++ docs/PublicKeyEncryptedSessionKeyPacket.html | 78 +- docs/PublicKeyPacket.html | 461 ++- docs/PublicSubkeyPacket.html | 471 ++- docs/SecretKeyPacket.html | 331 ++- docs/SecretSubkeyPacket.html | 331 ++- docs/Signature.html | 8 +- docs/SignaturePacket.html | 20 +- ...EncryptedIntegrityProtectedDataPacket.html | 152 +- docs/SymEncryptedSessionKeyPacket.html | 12 +- docs/SymmetricallyEncryptedDataPacket.html | 12 +- docs/TrustPacket.html | 57 +- docs/UserAttributePacket.html | 10 +- docs/UserIDPacket.html | 12 +- docs/global.html | 981 ++++++- docs/index.html | 39 +- docs/module-config.html | 60 +- docs/module-crypto_random-RandomBuffer.html | 10 +- docs/module-enums.html | 38 +- docs/module-key_SubKey-SubKey.html | 58 +- 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 | 18 +- package-lock.json | 2 +- package.json | 2 +- 36 files changed, 6333 insertions(+), 3649 deletions(-) create mode 100644 docs/PrivateKey.html create mode 100644 docs/PublicKey.html diff --git a/docs/AEADEncryptedDataPacket.html b/docs/AEADEncryptedDataPacket.html index b77e9cc0..3d591533 100644 --- a/docs/AEADEncryptedDataPacket.html +++ b/docs/AEADEncryptedDataPacket.html @@ -98,7 +98,7 @@ AEAD Protected Data Packet

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

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

-

(async) decrypt(sessionKeyAlgorithm, key)

+

(async) decrypt(sessionKeyAlgorithm, key, configopt)

@@ -395,6 +395,8 @@ AEAD Protected Data Packet

Type + Attributes + @@ -420,6 +422,14 @@ AEAD Protected Data Packet

+ + + + + + + + @@ -443,6 +453,14 @@ AEAD Protected Data Packet

+ + + + + + + + @@ -450,6 +468,39 @@ AEAD Protected Data Packet

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

Full configuration, defaults to openpgp.config

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

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

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

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

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


diff --git a/docs/CleartextMessage.html b/docs/CleartextMessage.html index 7918d80d..a9eef555 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 10f34045..5fbf9451 100644 --- a/docs/CompressedDataPacket.html +++ b/docs/CompressedDataPacket.html @@ -160,7 +160,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.

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

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

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

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

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

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

(async) decompress() +

(async) decompress(configopt)

@@ -619,96 +619,6 @@ read by read_packet

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

(async) read(bytes)

- - - - - - -
-

Parsing function for the packet.

-
- - - - - - - - -
Parameters:
@@ -722,6 +632,8 @@ read by read_packet

Type + Attributes + @@ -734,26 +646,33 @@ read by read_packet

- bytes + config -Uint8Array -| - -ReadableStream.<Uint8Array> +Object + + + <optional>
+ + + + + + + -

Payload of a tag 8 packet

+

Full configuration, defaults to openpgp.config

@@ -796,7 +715,192 @@ read by read_packet

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

(async) read(bytes, configopt)

+ + + + + + +
+

Parsing function for the packet.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
bytes + + +Uint8Array +| + +ReadableStream.<Uint8Array> + + + + + + + + + +

Payload of a tag 8 packet

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

Full configuration, defaults to openpgp.config

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

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


diff --git a/docs/Key.html b/docs/Key.html index b3c93523..64717493 100644 --- a/docs/Key.html +++ b/docs/Key.html @@ -28,9 +28,9 @@
-

Key(packetlist)

+

Key()

-

Class that represents an OpenPGP key. Must contain a primary key. +

Abstract class that represents an OpenPGP key. Must contain a primary key. Can contain additional subkeys, signatures, user ids, user attributes.

@@ -46,7 +46,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.

-

new Key(packetlist)

+

new Key()

@@ -61,55 +61,6 @@ Can contain additional subkeys, signatures, user ids, user attributes.

-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
packetlist - - -PacketList - - - -

The packets that form this key

- - @@ -145,7 +96,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.

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

-

(async) addSubkey() → {Promise.<Key>}

- - - - - - -
-

Generates a new OpenPGP subkey, and returns a clone of the Key object with the new subkey added. -Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the primary key. DSA primary keys default to RSA subkeys.

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
options.type - - -ecc -| - -rsa - - - -

The subkey algorithm: ECC or RSA

options.curve - - -String - - - -

(optional) Elliptic curve for ECC keys

options.rsaBits - - -Integer - - - -

(optional) Number of bits for RSA subkeys

options.keyExpirationTime - - -Number - - - -

(optional) Number of seconds from the key creation time after which the key expires

options.date - - -Date - - - -

(optional) Override the creation date of the key and the key signatures

options.sign - - -Boolean - - - -

(optional) Indicates whether the subkey should sign rather than encrypt. Defaults to false

options.config - - -Object - - - -

(optional) custom configuration settings to overwrite those in config

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Promise.<Key> - - -
-
- - - - - - - - - - - - -

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

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

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

-

New revoked key.

+

Revoked key.

@@ -706,270 +358,7 @@ if it is a valid revocation signature.

-

armor(configopt) → {ReadableStream.<String>}

- - - - - - -
-

Returns ASCII armored text of key

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

Full configuration, defaults to openpgp.config

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

ASCII armor.

-
- - - -
-
- Type -
-
- -ReadableStream.<String> - - -
-
- - - - - - - - - - - - - -

clearPrivateParams()

- - - - - - -
-

Clear private key parameters

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

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

+

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

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

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

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

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

-
- - - -
-
- Type -
-
- -Object - - -
-
- - - - - - - - - - - - - -

getAlgorithmInfo() → {Object}

- - - - - - -
-

Returns algorithm information

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

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

-

getCreationTime() → {Date}

- - - - - - -
-

Returns the creation time of the key

-
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -Date - - -
-
- - - - - - - - - - - - - -

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

- - - - - - -
-

Returns all keys that are available for decryption, matching the keyID when given -This is useful to retrieve keys for session key decryption

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

optional

date, - - -Date - - - - - - - - - -

optional

userID, - - -String - - - - - - - - - -

optional

config - - -Object - - - - - - <optional>
- - - - - -

Full configuration, defaults to openpgp.config

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

Array of decryption keys.

-
- - - -
-
- Type -
-
- -Promise.<Array.<(Key|SubKey)>> - - -
-
- - - - - - - - - - - - - -

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

+

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

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

Source:
@@ -2088,13 +990,25 @@ This is useful to retrieve keys for session key decryption

+
Throws:
+ + + +
+ +

if no valid encryption key was found

+ +
+ + +
Returns:
-

Key or null if no encryption key has been found.

+

encryption key

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

-Promise.<(Key|SubKey|null)> +Promise.<(Key|SubKey)>
@@ -2340,7 +1254,7 @@ Returns Infinity if the key doesn't expire.

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

-

Calculates the fingerprint of the key

+

Calculates and returns the fingerprint of the key, as a string

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

Source:
@@ -2477,119 +1391,7 @@ Returns Infinity if the key doesn't expire.

-

A string containing the fingerprint in lowercase hex.

-
- - - -
-
- Type -
-
- -String - - -
-
- - - - - - - - - - - - - -

getFingerprint() → {String}

- - - - - - -
-

Calculates the fingerprint of the key

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

A string containing the fingerprint in lowercase hex.

+

A string containing the fingerprint in lowercase hex

@@ -2626,7 +1428,7 @@ Returns Infinity if the key doesn't expire.

-

Calculates the key id of the key

+

Return the key ID of the key

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

Source:
@@ -2701,119 +1503,7 @@ Returns Infinity if the key doesn't expire.

-

A 8 byte key id.

-
- - - -
-
- Type -
-
- -module:type/keyid~KeyID - - -
-
- - - - - - - - - - - - - -

getKeyID() → {module:type/keyid~KeyID}

- - - - - - -
-

Calculates the key id of the key

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

A 8 byte key id.

+

The 8-byte key ID

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

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

-

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

+

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

@@ -2959,7 +1649,7 @@ Returns Infinity if the key doesn't expire.

Returns an array containing all public or private keys matching keyID. -If keyID is not present, returns all keys starting with the primary key.

+If no keyID is given, returns all keys, starting with the primary key.

@@ -2983,6 +1673,8 @@ If keyID is not present, returns all keys starting with the primary key.

Type + Attributes + Default @@ -3003,13 +1695,23 @@ If keyID is not present, returns all keys starting with the primary key.

-type/keyid +type/keyid~KeyID + + + <optional>
+ + + + + + + @@ -3019,7 +1721,7 @@ If keyID is not present, returns all keys starting with the primary key.

- +

key ID to look for

@@ -3062,7 +1764,7 @@ If keyID is not present, returns all keys starting with the primary key.

Source:
@@ -3090,6 +1792,10 @@ If keyID is not present, returns all keys starting with the primary key.

Returns:
+
+

array of keys

+
+
@@ -3301,7 +2007,7 @@ If keyID is not present, returns all keys starting with the primary key.

Source:
@@ -3506,7 +2212,7 @@ If keyID is not present, returns all keys starting with the primary key.

Source:
@@ -3564,7 +2270,7 @@ If keyID is not present, returns all keys starting with the primary key.

-

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

+

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

@@ -3774,7 +2480,7 @@ If keyID is not present, returns all keys starting with the primary key.

Source:
@@ -3797,13 +2503,25 @@ If keyID is not present, returns all keys starting with the primary key.

+
Throws:
+ + + +
+ +

if no valid signing key was found

+ +
+ + +
Returns:
-

Key or null if no signing key has been found.

+

signing key

@@ -3814,7 +2532,7 @@ If keyID is not present, returns all keys starting with the primary key.

-Promise.<(Key|SubKey|null)> +Promise.<(Key|SubKey)>
@@ -3832,7 +2550,7 @@ If keyID is not present, returns all keys starting with the primary key.

-

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

+

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

@@ -3841,7 +2559,7 @@ If keyID is not present, returns all keys starting with the primary key.

Returns an array containing all public or private subkeys matching keyID; -If keyID is not present, returns all subkeys.

+If no keyID is given, returns all subkeys.

@@ -3865,6 +2583,8 @@ If keyID is not present, returns all subkeys.

Type + Attributes + Default @@ -3885,13 +2605,23 @@ If keyID is not present, returns all subkeys.

-type/keyid +type/keyID + + + <optional>
+ + + + + + + @@ -3901,7 +2631,7 @@ If keyID is not present, returns all subkeys.

- +

key ID to look for

@@ -3944,7 +2674,7 @@ If keyID is not present, returns all subkeys.

Source:
@@ -3972,6 +2702,10 @@ If keyID is not present, returns all subkeys.

Returns:
+
+

array of subkeys

+
+
@@ -4052,7 +2786,7 @@ If keyID is not present, returns all subkeys.

Source:
@@ -4164,7 +2898,7 @@ If keyID is not present, returns all subkeys.

Source:
@@ -4222,425 +2956,6 @@ If keyID is not present, returns all subkeys.

-

hasSameFingerprintAs() → {Boolean}

- - - - - - -
-

Calculates whether two keys have the same fingerprint without actually calculating the fingerprint

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

Whether the two keys have the same version and public key data.

-
- - - -
-
- Type -
-
- -Boolean - - -
-
- - - - - - - - - - - - - -

isDecrypted()

- - - - - - -
-

Returns true if the primary key or any subkey is decrypted. -A dummy key is considered encrypted.

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

isPrivate() → {Boolean}

- - - - - - -
-

Returns true if this is a private key

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

isPublic() → {Boolean}

- - - - - - -
-

Returns true if this is a public key

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

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

@@ -4858,7 +3173,7 @@ A dummy key is considered encrypted.

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

-

packetlist2structure(packetlist)

+

packetListToStructure(packetlist, disallowedPackets)

@@ -4980,184 +3295,16 @@ A dummy key is considered encrypted.

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

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

- - - - - - -
-

Revokes the key

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -5304,7 +3357,7 @@ A dummy key is considered encrypted.

Source:
@@ -5329,28 +3382,6 @@ A dummy key is considered encrypted.

-
Returns:
- - -
-

New key with revocation signature.

-
- - - -
-
- Type -
-
- -Promise.<Key> - - -
-
- - @@ -5414,7 +3445,7 @@ A dummy key is considered encrypted.

- + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
reasonForRevocationdisallowedPackets -Object - - - - - - - - - -

optional, object indicating the reason for revocation

-
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
flag - - -module:enums.reasonForRevocation +Set.<enums.packet> @@ -5167,101 +3314,7 @@ A dummy key is considered encrypted.

-

optional, flag indicating the reason for revocation

string - - -String - - - -

optional, string explaining the reason for revocation

- -
date - - -Date - - - - - - - - - -

optional, override the creationtime of the revocation signature

config - - -Object - - - - - - <optional>
- - - - - -

Full configuration, defaults to openpgp.config

disallowed packet tags
-Array.<Key> +Array.<PrivateKey> @@ -5508,7 +3539,7 @@ A dummy key is considered encrypted.

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

-

New public key with new certificate signature.

+

Key with new certificate signature.

@@ -5618,7 +3649,7 @@ A dummy key is considered encrypted.

 -Array.<Key> +Array.<PrivateKey> @@ -5778,7 +3809,7 @@ A dummy key is considered encrypted.

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

-

New public key with new certificate signature.

+

Key with new certificate signature.

@@ -5836,7 +3867,7 @@ A dummy key is considered encrypted.

-

toPacketlist() → {PacketList}

+

toPacketList() → {PacketList}

@@ -5890,7 +3921,7 @@ A dummy key is considered encrypted.

Source:
@@ -5948,180 +3979,7 @@ A dummy key is considered encrypted.

-

toPublic(configopt) → {Key}

- - - - - - -
-

Returns key as public key (shallow copy)

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

Full configuration, defaults to openpgp.config

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

New public Key.

-
- - - -
-
- Type -
-
- -Key - - -
-
- - - - - - - - - - - - - -

(async) update(key, configopt) → {Promise.<undefined>}

+

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

@@ -6132,8 +3990,8 @@ A dummy key is considered encrypted.

Update key with new components from specified key with same key ID: users, subkeys, certificates are merged into the destination key, duplicates and expired signatures are ignored.

-

If the specified key is a private key and the destination key is public, -the destination key is transformed to a private key.

+

If the source key is a private key and the destination key is public, +a private key is returned.

@@ -6171,7 +4029,7 @@ the destination key is transformed to a private key.

keysourceKey @@ -6271,7 +4129,7 @@ the destination key is transformed to a private key.

Source:
@@ -6299,6 +4157,10 @@ the destination key is transformed to a private key.

Returns:
+
+

updated key

+
+
@@ -6307,7 +4169,7 @@ the destination key is transformed to a private key.

-Promise.<undefined> +Promise.<Key>
@@ -6325,190 +4187,6 @@ the destination key is transformed to a private key.

-

(async) validate(configopt)

- - - - - - -
-

Check whether the private and public primary key parameters correspond -Together with verification of binding signatures, this guarantees key integrity -In case of gnu-dummy primary key, it is enough to validate any signing subkeys -otherwise all encryption subkeys are validated -If only gnu-dummy keys are found, we cannot properly validate so we throw an error

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

Full configuration, defaults to openpgp.config

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - -
Throws:
- - - -
-
-
-

if validation was not successful and the key cannot be trusted

-
-
-
-
-
-
- Type -
-
- -Error - - -
-
-
-
-
- - - - - - - - - - - - - - - -

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

@@ -6659,7 +4337,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err
Source:
@@ -6899,7 +4577,7 @@ and valid self signature. Throws if the primary key is invalid.

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

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

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


diff --git a/docs/LiteralDataPacket.html b/docs/LiteralDataPacket.html index 91c7e7a2..654c1767 100644 --- a/docs/LiteralDataPacket.html +++ b/docs/LiteralDataPacket.html @@ -147,7 +147,7 @@ further interpreted.

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

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

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

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

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

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

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

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

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

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


diff --git a/docs/MarkerPacket.html b/docs/MarkerPacket.html index a6173698..811ed826 100644 --- a/docs/MarkerPacket.html +++ b/docs/MarkerPacket.html @@ -36,7 +36,12 @@ An experimental version of PGP used this packet as the Literal packet, but no released version of PGP generated Literal packets with this tag. With PGP 5.x, this packet has been reassigned and is reserved for use as the Marker packet.

-

Such a packet MUST be ignored when received.

+

The body of this packet consists of: +The three octets 0x50, 0x47, 0x50 (which spell "PGP" in UTF-8).

+

Such a packet MUST be ignored when received. It may be placed at the +beginning of a message that uses features not available in PGP +version 2.6 in order to cause that version to report that newer +software is necessary to process the message.

@@ -101,7 +106,7 @@ the Marker packet.

Source:
@@ -157,7 +162,7 @@ the Marker packet.

-

read(input, position, len) → {MarkerPacket}

+

read(bytes) → {Boolean}

@@ -165,7 +170,7 @@ the Marker packet.

-

Parsing function for a literal data packet (tag 10).

+

Parsing function for a marker data packet (tag 10).

@@ -201,13 +206,13 @@ the Marker packet.

inputbytes -String +Uint8Array @@ -221,53 +226,6 @@ the Marker packet.

position - - -Integer - - - -

Position to start reading from the input string

len - - -Integer - - - -

Length of the packet or the remaining length of -input at position
@@ -307,7 +265,7 @@ input at position

Source:
@@ -336,7 +294,7 @@ input at position

-

Object representation.

+

whether the packet payload contains "PGP"

@@ -347,7 +305,7 @@ input at position

-MarkerPacket +Boolean
@@ -375,7 +333,7 @@ input at position


diff --git a/docs/Message.html b/docs/Message.html index 4490019a..2b1f849e 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, publicKeysopt, passwordsopt, wildcardopt, encryptionKeyIDsopt, dateopt, userIDsopt, configopt) → {Promise.<Message>}

+

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

@@ -364,13 +364,13 @@ See https://tools.iet - publicKeys + encryptionKeys -Array.<Key> +Array.<PublicKey> @@ -507,7 +507,7 @@ See https://tools.iet -

Array of key IDs to use for encryption. Each encryptionKeyIDs[i] corresponds to publicKeys[i]

+

Array of key IDs to use for encryption. Each encryptionKeyIDs[i] corresponds to encryptionKeys[i]

@@ -661,7 +661,7 @@ See https://tools.iet
Source:
@@ -719,7 +719,7 @@ See https://tools.iet -

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

+

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

@@ -727,7 +727,7 @@ See https://tools.iet
-

Generate a new session key object, taking the algorithm preferences of the passed public keys into account, if any.

+

Generate a new session key object, taking the algorithm preferences of the passed encryption keys into account, if any.

@@ -765,13 +765,13 @@ See https://tools.iet - keys + encryptionKeys -Array.<Key> +Array.<PublicKey> @@ -933,7 +933,7 @@ See https://tools.iet
Source:
@@ -991,7 +991,7 @@ See https://tools.iet -

(async) appendSignature(detachedSignature)

+

(async) appendSignature(detachedSignature, configopt)

@@ -1023,6 +1023,8 @@ See https://tools.iet Type + Attributes + @@ -1051,6 +1053,14 @@ See https://tools.iet + + + + + + + + @@ -1058,6 +1068,39 @@ See https://tools.iet + + + + config + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + +

Full configuration, defaults to openpgp.config

+ + + @@ -1097,7 +1140,7 @@ See https://tools.iet
Source:
@@ -1248,7 +1291,7 @@ See https://tools.iet
Source:
@@ -1452,7 +1495,7 @@ See https://tools.iet
Source:
@@ -1510,7 +1553,7 @@ See https://tools.iet -

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

+

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

@@ -1556,13 +1599,13 @@ See https://tools.iet - privateKeys + decryptionKeys -Array.<Key> +Array.<PrivateKey> @@ -1724,7 +1767,7 @@ See https://tools.iet
Source:
@@ -1782,7 +1825,7 @@ See https://tools.iet -

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

+

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

@@ -1828,13 +1871,13 @@ See https://tools.iet - privateKeys + decryptionKeys -Array.<Key> +Array.<PrivateKey> @@ -1963,7 +2006,7 @@ See https://tools.iet
Source:
@@ -2021,7 +2064,7 @@ See https://tools.iet -

(async) encrypt(keysopt, passwordsopt, sessionKeyopt, wildcardopt, encryptionKeyIDsopt, dateopt, userIDsopt, configopt) → {Promise.<Message>}

+

(async) encrypt(encryptionKeysopt, passwordsopt, sessionKeyopt, wildcardopt, encryptionKeyIDsopt, dateopt, userIDsopt, configopt) → {Promise.<Message>}

@@ -2069,13 +2112,13 @@ See https://tools.iet - keys + encryptionKeys -Array.<Key> +Array.<PublicKey> @@ -2249,7 +2292,7 @@ See https://tools.iet -

Array of key IDs to use for encryption. Each encryptionKeyIDs[i] corresponds to publicKeys[i]

+

Array of key IDs to use for encryption. Each encryptionKeyIDs[i] corresponds to keys[i]

@@ -2403,7 +2446,7 @@ See https://tools.iet
Source:
@@ -2515,7 +2558,7 @@ See https://tools.iet
Source:
@@ -2627,7 +2670,7 @@ See https://tools.iet
Source:
@@ -2742,7 +2785,7 @@ See https://tools.iet
Source:
@@ -2857,7 +2900,7 @@ See https://tools.iet
Source:
@@ -2969,7 +3012,7 @@ See https://tools.iet
Source:
@@ -3030,7 +3073,7 @@ See https://tools.iet -

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

+

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

@@ -3078,13 +3121,13 @@ See https://tools.iet - privateKeys + signingKeys -Array.<Key> +Array.<PrivateKey> @@ -3182,7 +3225,7 @@ See https://tools.iet -

Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to privateKeys[i]

+

Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to signingKeys[i]

@@ -3336,7 +3379,7 @@ See https://tools.iet
Source:
@@ -3394,7 +3437,7 @@ See https://tools.iet -

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

+

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

@@ -3442,13 +3485,13 @@ See https://tools.iet - privateKeys + signingKeys -Array.<Key> +Array.<PrivateKey> @@ -3546,7 +3589,7 @@ See https://tools.iet -

Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to privateKeys[i]

+

Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to signingKeys[i]

@@ -3700,7 +3743,7 @@ See https://tools.iet
Source:
@@ -3812,7 +3855,7 @@ See https://tools.iet
Source:
@@ -3870,7 +3913,7 @@ See https://tools.iet -

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

+

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

@@ -3916,13 +3959,13 @@ See https://tools.iet - keys + verificationKeys -Array.<Key> +Array.<PublicKey> @@ -3940,7 +3983,7 @@ See https://tools.iet -

Array of keys to verify signatures

+

Array of public keys to verify signatures

@@ -4049,7 +4092,7 @@ See https://tools.iet
Source:
@@ -4107,7 +4150,7 @@ See https://tools.iet -

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

+

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

@@ -4153,13 +4196,13 @@ See https://tools.iet - keys + verificationKeys -Array.<Key> +Array.<PublicKey> @@ -4177,7 +4220,7 @@ See https://tools.iet -

Array of keys to verify signatures

+

Array of public keys to verify signatures

@@ -4315,7 +4358,7 @@ See https://tools.iet
Source:
@@ -4427,7 +4470,7 @@ See https://tools.iet
Source:
@@ -4495,7 +4538,7 @@ See https://tools.iet
diff --git a/docs/OnePassSignaturePacket.html b/docs/OnePassSignaturePacket.html index f33797b0..12d28c66 100644 --- a/docs/OnePassSignaturePacket.html +++ b/docs/OnePassSignaturePacket.html @@ -101,7 +101,7 @@ can compute the entire signed message in one pass.

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

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

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

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

Source:
@@ -471,7 +471,7 @@ Signature types are described in
Source:
@@ -535,7 +535,7 @@ Signature types are described in
Source:
@@ -666,7 +666,7 @@ Signature types are described in
Source:
@@ -778,7 +778,7 @@ Signature types are described in
Source:
@@ -846,7 +846,7 @@ Signature types are described in
diff --git a/docs/PacketList.html b/docs/PacketList.html index ce15ca72..a138d589 100644 --- a/docs/PacketList.html +++ b/docs/PacketList.html @@ -97,7 +97,7 @@ are stored as numerical indices.

Source:
@@ -164,7 +164,7 @@ are stored as numerical indices.

-

concat()

+

(async, static) fromBinary(bytes, allowedPackets, configopt) → {PacketList}

@@ -172,187 +172,8 @@ are stored as numerical indices.

-

Concatenates packetlist or array of packets

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

filterByTag()

- - - - - - -
-

Creates a new PacketList with all packets from the given types

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

findPacket(type) → {Packet|undefined}

- - - - - - -
-

Traverses packet tree and returns first matching packet

+

Parses the given binary data and returns a list of packets. +Equivalent to calling read on an empty PacketList instance.

@@ -376,6 +197,8 @@ are stored as numerical indices.

Type + Attributes + @@ -388,23 +211,98 @@ are stored as numerical indices.

- type + bytes -module:enums.packet +Uint8Array +| + +ReadableStream.<Uint8Array> + + + + + + + + -

The packet type

+

binary data to parse

+ + + + + + + allowedPackets + + + + + +Object + + + + + + + + + + + + + + + + + +

mapping where keys are allowed packet tags, pointing to their Packet class

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

full configuration, defaults to openpgp.config

@@ -447,7 +345,349 @@ are stored as numerical indices.

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

on parsing errors

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

parsed list of packets

+
+ + + +
+
+ Type +
+
+ +PacketList + + +
+
+ + + + + + + + + + + + + +

filterByTag(…tags) → {PacketList}

+ + + + + + +
+

Creates a new PacketList with all packets matching the given tag(s)

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
tags + + +module:enums.packet + + + + + + + + + + <repeatable>
+ +

packet tags to look for

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +PacketList + + +
+
+ + + + + + + + + + + + + +

findPacket(tag) → {Packet|undefined}

+ + + + + + +
+

Traverses packet list and returns first packet with matching tag

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
tag + + +module:enums.packet + + + +

The packet tag

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -504,7 +744,7 @@ are stored as numerical indices.

-

indexOfTag()

+

indexOfTag(…tags) → {Array.<Integer>}

@@ -512,98 +752,7 @@ are stored as numerical indices.

-

Returns array of found indices by tag

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

push(packet)

- - - - - - -
-

Adds a packet to the list. This is the only supported method of doing so; -writing to packetlist[i] directly will result in an error.

+

Find indices of packets with the given tag(s)

@@ -627,6 +776,8 @@ writing to packetlist[i] directly will result in an error.

Type + Attributes + @@ -639,23 +790,33 @@ writing to packetlist[i] directly will result in an error.

- packet + tags -Object +module:enums.packet + + + + + + + <repeatable>
+ + + -

Packet to push

+

packet tags to look for

@@ -698,7 +859,7 @@ writing to packetlist[i] directly will result in an error.

Source:
@@ -723,6 +884,28 @@ writing to packetlist[i] directly will result in an error.

+
Returns:
+ + +
+

packet indices

+
+ + + +
+
+ Type +
+
+ +Array.<Integer> + + +
+
+ + @@ -734,7 +917,7 @@ writing to packetlist[i] directly will result in an error.

-

(async) read(bytes)

+

(async) read(bytes, allowedPackets, configopt)

@@ -766,6 +949,8 @@ writing to packetlist[i] directly will result in an error.

Type + Attributes + @@ -794,10 +979,82 @@ writing to packetlist[i] directly will result in an error.

+ + + + + + + + -

A Uint8Array of bytes.

+

binary data to parse

+ + + + + + + allowedPackets + + + + + +Object + + + + + + + + + + + + + + + + + +

mapping where keys are allowed packet tags, pointing to their Packet class

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

full configuration, defaults to openpgp.config

@@ -840,7 +1097,7 @@ writing to packetlist[i] directly will result in an error.

Source:
@@ -863,6 +1120,18 @@ writing to packetlist[i] directly will result in an error.

+
Throws:
+ + + +
+ +

on parsing errors

+ +
+ + + @@ -931,7 +1200,7 @@ class instance.

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


diff --git a/docs/PrivateKey.html b/docs/PrivateKey.html new file mode 100644 index 00000000..2512a5b2 --- /dev/null +++ b/docs/PrivateKey.html @@ -0,0 +1,1964 @@ + + + + + JSDoc: Class: PrivateKey + + + + + + + + + + +
+ +

Class: PrivateKey

+ + + + + + +
+ +
+ +

PrivateKey(packetlist)

+ +

Class that represents an OpenPGP Private key

+ + +
+ +
+
+ + + + +

Constructor

+ + + +

new PrivateKey(packetlist)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
packetlist + + +PacketList + + + +

The packets that form this key

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

Methods

+ + + + + + + +

(async) addSubkey() → {Promise.<PrivateKey>}

+ + + + + + +
+

Generates a new OpenPGP subkey, and returns a clone of the Key object with the new subkey added. +Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the primary key. DSA primary keys default to RSA subkeys.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options.type + + +ecc +| + +rsa + + + +

The subkey algorithm: ECC or RSA

options.curve + + +String + + + +

(optional) Elliptic curve for ECC keys

options.rsaBits + + +Integer + + + +

(optional) Number of bits for RSA subkeys

options.keyExpirationTime + + +Number + + + +

(optional) Number of seconds from the key creation time after which the key expires

options.date + + +Date + + + +

(optional) Override the creation date of the key and the key signatures

options.sign + + +Boolean + + + +

(optional) Indicates whether the subkey should sign rather than encrypt. Defaults to false

options.config + + +Object + + + +

(optional) custom configuration settings to overwrite those in config

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Promise.<PrivateKey> + + +
+
+ + + + + + + + + + + + + +

armor(configopt) → {ReadableStream.<String>}

+ + + + + + +
+

Returns ASCII armored text of key

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

Full configuration, defaults to openpgp.config

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

ASCII armor.

+
+ + + +
+
+ Type +
+
+ +ReadableStream.<String> + + +
+
+ + + + + + + + + + + + + +

clearPrivateParams()

+ + + + + + +
+

Clear private key parameters

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

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

+ + + + + + +
+

Returns all keys that are available for decryption, matching the keyID when given +This is useful to retrieve keys for session key decryption

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
keyID, + + +module:type/keyid~KeyID + + + + + + + + + +

optional

date, + + +Date + + + + + + + + + +

optional

userID, + + +String + + + + + + + + + +

optional

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

Full configuration, defaults to openpgp.config

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

Array of decryption keys.

+
+ + + +
+
+ Type +
+
+ +Promise.<Array.<(Key|SubKey)>> + + +
+
+ + + + + + + + + + + + + +

isDecrypted()

+ + + + + + +
+

Returns true if the primary key or any subkey is decrypted. +A dummy key is considered encrypted.

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

isPrivate() → {Boolean}

+ + + + + + +
+

Returns true if this is a private key

+
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + + + + + + + + + + +

isPublic() → {Boolean}

+ + + + + + +
+

Returns true if this is a public key

+
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + + + + + + + + + + +

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

+ + + + + + +
+

Revokes the key

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
reasonForRevocation + + +Object + + + + + + + + + +

optional, object indicating the reason for revocation

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

optional, flag indicating the reason for revocation

string + + +String + + + +

optional, string explaining the reason for revocation

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

optional, override the creationtime of the revocation signature

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

Full configuration, defaults to openpgp.config

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

New key with revocation signature.

+
+ + + +
+
+ Type +
+
+ +Promise.<PrivateKey> + + +
+
+ + + + + + + + + + + + + +

toPublic() → {PublicKey}

+ + + + + + +
+

Returns key as public key (shallow copy)

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

New public Key

+
+ + + +
+
+ Type +
+
+ +PublicKey + + +
+
+ + + + + + + + + + + + + +

(async) validate(configopt)

+ + + + + + +
+

Check whether the private and public primary key parameters correspond +Together with verification of binding signatures, this guarantees key integrity +In case of gnu-dummy primary key, it is enough to validate any signing subkeys +otherwise all encryption subkeys are validated +If only gnu-dummy keys are found, we cannot properly validate so we throw an error

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

Full configuration, defaults to openpgp.config

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

if validation was not successful and the key cannot be trusted

+
+
+
+
+
+
+ Type +
+
+ +Error + + +
+
+
+
+
+ + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/PublicKey.html b/docs/PublicKey.html new file mode 100644 index 00000000..400aa114 --- /dev/null +++ b/docs/PublicKey.html @@ -0,0 +1,726 @@ + + + + + JSDoc: Class: PublicKey + + + + + + + + + + +
+ +

Class: PublicKey

+ + + + + + +
+ +
+ +

PublicKey(packetlist)

+ +

Class that represents an OpenPGP Public Key

+ + +
+ +
+
+ + + + +

Constructor

+ + + +

new PublicKey(packetlist)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
packetlist + + +PacketList + + + +

The packets that form this key

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

Methods

+ + + + + + + +

armor(configopt) → {ReadableStream.<String>}

+ + + + + + +
+

Returns ASCII armored text of key

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

Full configuration, defaults to openpgp.config

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

ASCII armor.

+
+ + + +
+
+ Type +
+
+ +ReadableStream.<String> + + +
+
+ + + + + + + + + + + + + +

isPrivate() → {Boolean}

+ + + + + + +
+

Returns true if this is a private key

+
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + + + + + + + + + + +

isPublic() → {Boolean}

+ + + + + + +
+

Returns true if this is a public key

+
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + + + + + + + + + + +

toPublic() → {PublicKey}

+ + + + + + +
+

Returns key as public key (shallow copy)

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

New public Key

+
+ + + +
+
+ Type +
+
+ +PublicKey + + +
+
+ + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/PublicKeyEncryptedSessionKeyPacket.html b/docs/PublicKeyEncryptedSessionKeyPacket.html index 0d71b39d..81c9baa2 100644 --- a/docs/PublicKeyEncryptedSessionKeyPacket.html +++ b/docs/PublicKeyEncryptedSessionKeyPacket.html @@ -107,7 +107,7 @@ decrypt the message.

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

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

-

(async) decrypt(key) → {Promise.<Boolean>}

+

(async) decrypt(key)

@@ -298,7 +298,7 @@ packets (tag 1)

-

Private key with secret params unlocked

+

decrypted private key

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

Source:
@@ -364,38 +364,49 @@ packets (tag 1)

- - -
Returns:
+
Throws:
-
- Type +
+

if decryption failed

+
-
- -Promise.<Boolean> +
+
+
+
+ Type +
+
+ +Error -
+ +
+
+
+ + + -

(async) encrypt(key) → {Promise.<Boolean>}

+

(async) encrypt(key)

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

Source:
@@ -521,31 +532,42 @@ packets (tag 1)

- - -
Returns:
+
Throws:
-
- Type +
+

if encryption failed

+
-
- -Promise.<Boolean> +
+
+
+
+ Type +
+
+ +Error -
+ +
+
+
+ + + @@ -655,7 +677,7 @@ packets (tag 1)

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

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


diff --git a/docs/PublicKeyPacket.html b/docs/PublicKeyPacket.html index 8e2c76f6..024e9471 100644 --- a/docs/PublicKeyPacket.html +++ b/docs/PublicKeyPacket.html @@ -195,7 +195,7 @@ key (sometimes called an OpenPGP certificate).

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

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

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

Source:
@@ -467,13 +467,13 @@ key (sometimes called an OpenPGP certificate).

-

fingerprint :String

+

fingerprint :Uint8Array

-

Fingerprint in lowercase hex

+

Fingerprint bytes

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

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

(async) computeFingerprint()

+ + + + + + +
+

Computes and set the fingerprint of the key

+
+ + + + + + + + + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

(async) computeFingerprintAndKeyID()

+ + + + + + +
+

Computes and set the key ID and fingerprint of the key

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

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

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

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

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

-

Calculates the fingerprint of the key

+

Calculates and returns the fingerprint of the key, as a string

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

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

-

A string containing the fingerprint in lowercase hex.

+

A string containing the fingerprint in lowercase hex

@@ -2295,7 +2485,7 @@ This can be used to remove passphrase protection after calling decrypt().

-

Calculates the fingerprint of the key

+

Returns the fingerprint of the key, as an array of bytes

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

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

-

A Uint8Array containing the fingerprint.

+

A Uint8Array containing the fingerprint

@@ -2412,7 +2602,7 @@ This can be used to remove passphrase protection after calling decrypt().

-

Calculates the key id of the key

+

Return the key ID of the key

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

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

-

A 8 byte key id.

+

The 8-byte key ID

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

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

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

Source:
@@ -2979,7 +3169,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3015,7 +3205,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig -

read(bytes)

+

(async) read(bytes)

@@ -3124,7 +3314,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3214,7 +3404,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3338,7 +3528,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3396,7 +3586,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig -

writeForHash()

+

writeForHash(version)

@@ -3404,7 +3594,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
-

Write packet in order to be hashed; either for a signature or a fingerprint.

+

Write packet in order to be hashed; either for a signature or a fingerprint

@@ -3415,6 +3605,55 @@ The resulting key cannot be used for signing/decrypting but can still verify sig +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
version + + +Integer + + + +

target version of signature or key

+ + @@ -3455,7 +3694,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3501,7 +3740,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
diff --git a/docs/SecretSubkeyPacket.html b/docs/SecretSubkeyPacket.html index 2f67e505..b30bb05c 100644 --- a/docs/SecretSubkeyPacket.html +++ b/docs/SecretSubkeyPacket.html @@ -190,7 +190,7 @@ Key packet and has exactly the same format.

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

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

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

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

Source:
@@ -567,13 +567,13 @@ Key packet and has exactly the same format.

-

fingerprint :String

+

fingerprint :Uint8Array

-

Fingerprint in lowercase hex

+

Fingerprint bytes

@@ -582,7 +582,7 @@ Key packet and has exactly the same format.

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

(async) computeFingerprint()

+ + + + + + +
+

Computes and set the fingerprint of the key

+
+ + + + + + + + + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

(async) computeFingerprintAndKeyID()

+ + + + + + +
+

Computes and set the key ID and fingerprint of the key

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

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

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

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

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

-

Calculates the fingerprint of the key

+

Calculates and returns the fingerprint of the key, as a string

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

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

-

A string containing the fingerprint in lowercase hex.

+

A string containing the fingerprint in lowercase hex

@@ -2344,7 +2534,7 @@ This can be used to remove passphrase protection after calling decrypt().

-

Calculates the fingerprint of the key

+

Returns the fingerprint of the key, as an array of bytes

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

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

-

A Uint8Array containing the fingerprint.

+

A Uint8Array containing the fingerprint

@@ -2461,7 +2651,7 @@ This can be used to remove passphrase protection after calling decrypt().

-

Calculates the key id of the key

+

Return the key ID of the key

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

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

-

A 8 byte key id.

+

The 8-byte key ID

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

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

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

Source:
@@ -3038,7 +3228,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3074,7 +3264,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig -

read(bytes)

+

(async) read(bytes)

@@ -3183,7 +3373,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3278,7 +3468,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3402,7 +3592,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3460,7 +3650,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig -

writeForHash()

+

writeForHash(version)

@@ -3468,7 +3658,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
-

Write packet in order to be hashed; either for a signature or a fingerprint.

+

Write packet in order to be hashed; either for a signature or a fingerprint

@@ -3479,6 +3669,55 @@ The resulting key cannot be used for signing/decrypting but can still verify sig +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
version + + +Integer + + + +

target version of signature or key

+ + @@ -3519,7 +3758,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3565,7 +3804,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
diff --git a/docs/Signature.html b/docs/Signature.html index da3b3abd..4bb1f435 100644 --- a/docs/Signature.html +++ b/docs/Signature.html @@ -144,7 +144,7 @@
Source:
@@ -322,7 +322,7 @@
Source:
@@ -434,7 +434,7 @@
Source:
@@ -502,7 +502,7 @@
diff --git a/docs/SignaturePacket.html b/docs/SignaturePacket.html index 3a0a6cae..402ca222 100644 --- a/docs/SignaturePacket.html +++ b/docs/SignaturePacket.html @@ -148,7 +148,7 @@ block of text, and a signature that is a certification of a User ID.

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

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

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

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

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

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

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

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

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


diff --git a/docs/SymEncryptedIntegrityProtectedDataPacket.html b/docs/SymEncryptedIntegrityProtectedDataPacket.html index a5ea6f5c..0f6e8c78 100644 --- a/docs/SymEncryptedIntegrityProtectedDataPacket.html +++ b/docs/SymEncryptedIntegrityProtectedDataPacket.html @@ -101,7 +101,7 @@ packet.

Source:
@@ -147,150 +147,6 @@ packet.

-

Members

- - - -

encrypted

- - - - -
-

The encrypted payload.

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

modification :Boolean

- - - - -
-

If after decrypting the packet this is set to true, -a modification has been detected and thus the contents -should be discarded.

-
- - - -
Type:
-
    -
  • - -Boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - -

Methods

@@ -478,7 +334,7 @@ should be discarded.

Source:
@@ -709,7 +565,7 @@ should be discarded.

Source:
@@ -773,7 +629,7 @@ should be discarded.


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

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

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

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

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

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


diff --git a/docs/SymmetricallyEncryptedDataPacket.html b/docs/SymmetricallyEncryptedDataPacket.html index 81c63777..d20fc3e8 100644 --- a/docs/SymmetricallyEncryptedDataPacket.html +++ b/docs/SymmetricallyEncryptedDataPacket.html @@ -101,7 +101,7 @@ that form whole OpenPGP messages).

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

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

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

Source:
@@ -161,7 +161,7 @@ other than local keyring files.

-

read(byptes)

+

read()

@@ -181,55 +181,6 @@ Currently not implemented as we ignore trust packets

-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
byptes - - -String - - - -

Payload of a tag 12 packet

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

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


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

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

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

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

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


diff --git a/docs/UserIDPacket.html b/docs/UserIDPacket.html index 06b7bbaa..0052d4c7 100644 --- a/docs/UserIDPacket.html +++ b/docs/UserIDPacket.html @@ -100,7 +100,7 @@ specifies the length of the User ID.

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

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

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

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

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


diff --git a/docs/global.html b/docs/global.html index 5c01c7c8..d5bca1e9 100644 --- a/docs/global.html +++ b/docs/global.html @@ -352,7 +352,7 @@
Source:
@@ -565,7 +565,7 @@
Source:
@@ -595,6 +595,179 @@ + + + + + + +

createKey(packetlist) → {Key}

+ + + + + + +
+

Creates a PublicKey or PrivateKey depending on the packetlist in input

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
packetlist + + +PacketList + + + +

packets to parse

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

if no key packet was found

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

parsed key

+
+ + + +
+
+ Type +
+
+ +Key + + +
+
+ + + + + + + @@ -940,7 +1113,7 @@
Source:
@@ -1124,16 +1297,16 @@ a session key or a password must be specified.

- privateKeys + decryptionKeys -Key +PrivateKey | -Array.<Key> +Array.<PrivateKey> @@ -1244,16 +1417,16 @@ a session key or a password must be specified.

- publicKeys + verificationKeys -Key +PublicKey | -Array.<Key> +Array.<PublicKey> @@ -1521,7 +1694,7 @@ a session key or a password must be specified.

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

Object containing decrypted and verified message in the form:

{
-  data: String|ReadableStream<String>|NodeStream, (if format was 'utf8', the default)
-  data: Uint8Array|ReadableStream<Uint8Array>|NodeStream, (if format was 'binary')
+  data: MaybeStream<String>, (if format was 'utf8', the default)
+  data: MaybeStream<Uint8Array>, (if format was 'binary')
   filename: String,
   signatures: [
     {
@@ -1591,7 +1764,7 @@ a session key or a password must be specified.

     
 
     
-    
(async) decryptKey(options) → {Promise.<Key>}

+    
(async) decryptKey(options) → {Promise.<PrivateKey>}

     
 
     
@@ -1686,7 +1859,7 @@ This method does not change the original key.

             
             
                 
-Key
+PrivateKey
 
 
             
@@ -1821,7 +1994,7 @@ This method does not change the original key.

     
     
Source:

     

     
 
@@ -1861,7 +2034,7 @@ This method does not change the original key.

     
     

         
-Promise.<Key>
+Promise.<PrivateKey>
 
 
     

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

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

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

     
 
     
@@ -1999,16 +2172,16 @@ a password must be specified.

 
         
             
-                privateKeys
+                decryptionKeys
             
 
             
             
                 
-Key
+PrivateKey
 |
 
-Array.<Key>
+Array.<PrivateKey>
 
 
             
@@ -2147,7 +2320,7 @@ a password must be specified.

     
     
Source:

     

     
 
@@ -2170,6 +2343,18 @@ a password must be specified.

 
 
 
+
Throws:

+
+        
+
+    

+    
+        
if no session key could be found or decrypted

+    
+    

+
+
+    
 
 
 
Returns:

@@ -2177,8 +2362,7 @@ a password must be specified.

         
 

     
Array of decrypted session key, algorithm pairs in the form:
-{ data:Uint8Array, algorithm:String }
-or 'undefined' if no key packets found

+{ data:Uint8Array, algorithm:String }

 

 
 
@@ -2189,7 +2373,7 @@ or 'undefined' if no key packets found

     
     

         
-Promise.<(Object|undefined)>
+Promise.<Object>
 
 
     

@@ -2207,7 +2391,7 @@ or 'undefined' if no key packets found

     
 
     
-    
(async) encrypt(options) → {Promise.<(String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>)>}

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

     
 
     
@@ -2215,8 +2399,8 @@ or 'undefined' if no key packets found

 
 
 

-    
Encrypts message text/data with public keys, passwords or both at once. At least either public keys or passwords
-must be specified. If private keys are specified, those will be used to sign the message.

+    
Encrypts message text/data with public keys, passwords or both at once. At least either encryption keys or passwords
+must be specified. If signing keys are specified, those will be used to sign the message.

 

 
 
@@ -2333,16 +2517,16 @@ must be specified. If private keys are specified, those will be used to sign the
 
         
             
-                publicKeys
+                encryptionKeys
             
 
             
             
                 
-Key
+PublicKey
 |
 
-Array.<Key>
+Array.<PublicKey>
 
 
             
@@ -2373,16 +2557,16 @@ must be specified. If private keys are specified, those will be used to sign the
 
         
             
-                privateKeys
+                signingKeys
             
 
             
             
                 
-Key
+PrivateKey
 |
 
-Array.<Key>
+Array.<PrivateKey>
 
 
             
@@ -2637,7 +2821,7 @@ must be specified. If private keys are specified, those will be used to sign the
                 
             
 
-            
Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to privateKeys[i]

+            
Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to signingKeys[i]

         
 
     
@@ -2676,7 +2860,7 @@ must be specified. If private keys are specified, those will be used to sign the
                 
             
 
-            
Array of key IDs to use for encryption. Each encryptionKeyIDs[i] corresponds to publicKeys[i]

+            
Array of key IDs to use for encryption. Each encryptionKeyIDs[i] corresponds to encryptionKeys[i]

         
 
     
@@ -2722,7 +2906,7 @@ must be specified. If private keys are specified, those will be used to sign the
 
         
             
-                fromUserIDs
+                signingUserIDs
             
 
             
@@ -2754,14 +2938,14 @@ must be specified. If private keys are specified, those will be used to sign the
                 
             
 
-            
Array of user IDs to sign with, one per key in privateKeys, e.g. [{ name: 'Steve Sender', email: 'steve@openpgp.org' }]

+            
Array of user IDs to sign with, one per key in signingKeys, e.g. [{ name: 'Steve Sender', email: 'steve@openpgp.org' }]

         
 
     
 
         
             
-                toUserIDs
+                encryptionUserIDs
             
 
             
@@ -2793,7 +2977,7 @@ must be specified. If private keys are specified, those will be used to sign the
                 
             
 
-            
Array of user IDs to encrypt for, one per key in publicKeys, e.g. [{ name: 'Robert Receiver', email: 'robert@openpgp.org' }]

+            
Array of user IDs to encrypt for, one per key in encryptionKeys, e.g. [{ name: 'Robert Receiver', email: 'robert@openpgp.org' }]

         
 
     
@@ -2880,7 +3064,7 @@ must be specified. If private keys are specified, those will be used to sign the
     
     
Source:

     

     
 
@@ -2920,7 +3104,7 @@ must be specified. If private keys are specified, those will be used to sign the
     
     

         
-Promise.<(String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>)>
+Promise.<(MaybeStream.<String>|MaybeStream.<Uint8Array>)>
 
 
     

@@ -2938,7 +3122,7 @@ must be specified. If private keys are specified, those will be used to sign the
     
 
     
-    
(async) encryptKey(options) → {Promise.<Key>}

+    
(async) encryptKey(options) → {Promise.<PrivateKey>}

     
 
     
@@ -3033,7 +3217,7 @@ This method does not change the original key.

             
             
                 
-Key
+PrivateKey
 
 
             
@@ -3168,7 +3352,7 @@ This method does not change the original key.

     
     
Source:

     

     
 
@@ -3208,7 +3392,7 @@ This method does not change the original key.

     
     

         
-Promise.<Key>
+Promise.<PrivateKey>
 
 
     

@@ -3424,16 +3608,16 @@ or passwords must be specified.

 
         
             
-                publicKeys
+                encryptionKeys
             
 
             
             
                 
-Key
+PublicKey
 |
 
-Array.<Key>
+Array.<PublicKey>
 
 
             
@@ -3614,7 +3798,7 @@ or passwords must be specified.

                 
             
 
-            
Array of key IDs to use for encryption. Each encryptionKeyIDs[i] corresponds to publicKeys[i]

+            
Array of key IDs to use for encryption. Each encryptionKeyIDs[i] corresponds to encryptionKeys[i]

         
 
     
@@ -3660,7 +3844,7 @@ or passwords must be specified.

 
         
             
-                toUserIDs
+                encryptionUserIDs
             
 
             
@@ -3692,7 +3876,7 @@ or passwords must be specified.

                 
             
 
-            
Array of user IDs to encrypt for, one per key in publicKeys, e.g. [{ name: 'Phil Zimmermann', email: 'phil@openpgp.org' }]

+            
Array of user IDs to encrypt for, one per key in encryptionKeys, e.g. [{ name: 'Phil Zimmermann', email: 'phil@openpgp.org' }]

         
 
     
@@ -3779,7 +3963,7 @@ or passwords must be specified.

     
     
Source:

     

     
 
@@ -4039,7 +4223,7 @@ or passwords must be specified.

                 
             
 
-            
The passphrase used to encrypt the generated private key

+            
The passphrase used to encrypt the generated private key. If omitted, the key won't be encrypted.

         
 
     
@@ -4236,8 +4420,8 @@ brainpoolP256r1, brainpoolP384r1, or brainpoolP512r1

                 
             
 
-            
Options for each subkey, default to main key options. e.g. [{sign: true, passphrase: '123'}]
-sign parameter defaults to false, and indicates whether the subkey should sign rather than encrypt

+            
Options for each subkey e.g. [{sign: true, passphrase: '123'}]
+default to main key options, except for sign parameter that defaults to false, and indicates whether the subkey should sign rather than encrypt

         
 
     
@@ -4324,7 +4508,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
     
     
Source:

     

     
 
@@ -4354,7 +4538,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
         
 

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

+{ key:PrivateKey, privateKeyArmored:String, publicKeyArmored:String, revocationCertificate:String }

 

 
 
@@ -4473,16 +4657,16 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
 
         
             
-                publicKeys
+                encryptionKeys
             
 
             
             
                 
-Key
+PublicKey
 |
 
-Array.<Key>
+Array.<PublicKey>
 
 
             
@@ -4550,7 +4734,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
 
         
             
-                toUserIDs
+                encryptionUserIDs
             
 
             
@@ -4669,7 +4853,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
     
     
Source:

     

     
 
@@ -4853,7 +5037,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
     
     
Source:

     

     
 
@@ -5106,7 +5290,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
     
     
Source:

     

     
 
@@ -5394,7 +5578,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
     
     
Source:

     

     
 
@@ -5682,7 +5866,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
     
     
Source:

     

     
 
@@ -5976,7 +6160,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
     
     
Source:

     

     
 
@@ -6034,6 +6218,582 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
     
 
     
+    
(async) readPrivateKey(options) → {Promise.<PrivateKey>}

+    
+
+    
+
+
+
+

+    
Reads an (optionally armored) OpenPGP private key and returns a PrivateKey object

+

+
+
+
+
+
+
+
+
+
+    
Parameters:

+    
+
+
+    
+    
+        
+        
+        
+
+        
+
+        
+
+        
+
+        
+    
+    
+
+    
+    
+
+        
+            
+                
+            
+
+            
+
+            
+
+            
+
+            
+        
+
+    
+    
+
NameTypeDescription
options
+            
+                
+Object
+
+
+            
+            
+                
Properties

+                
+
+
+    
+    
+        
+        
+        
+
+        
+
+        
+        
+        
+
+        
+
+        
+    
+    
+
+    
+    
+
+        
+            
+                
+            
+
+            
+
+            
+                
+            
+
+            
+
+            
+        
+
+    
+
+        
+            
+                
+            
+
+            
+
+            
+                
+            
+
+            
+
+            
+        
+
+    
+
+        
+            
+                
+            
+
+            
+
+            
+                
+            
+
+            
+
+            
+        
+
+    
+    
+
NameTypeAttributesDescription
armoredKey
+            
+                
+String
+
+
+            
+            
+                
+                    <optional>

+                
+
+                
+
+                
+                
Armored key to be parsed
binaryKey
+            
+                
+Uint8Array
+
+
+            
+            
+                
+                    <optional>

+                
+
+                
+
+                
+                
Binary key to be parsed
config
+            
+                
+Object
+
+
+            
+            
+                
+                    <optional>

+                
+
+                
+
+                
+                
Custom configuration settings to overwrite those in config

+
+            

+
+
+
+
+
+
+

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

+    

+    
+
+    
+
+    
+
+    
+

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

+
+        
+

+    
Key object.

+

+
+
+
+

+    

+        Type
+    

+    

+        
+Promise.<PrivateKey>
+
+
+    

+

+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    
(async) readPrivateKeys(options) → {Promise.<Array.<PrivateKey>>}

+    
+
+    
+
+
+
+

+    
Reads an (optionally armored) OpenPGP private key block and returns a list of PrivateKey objects

+

+
+
+
+
+
+
+
+
+
+    
Parameters:

+    
+
+
+    
+    
+        
+        
+        
+
+        
+
+        
+
+        
+
+        
+    
+    
+
+    
+    
+
+        
+            
+                
+            
+
+            
+
+            
+
+            
+
+            
+        
+
+    
+    
+
NameTypeDescription
options
+            
+                
+Object
+
+
+            
+            
+                
Properties

+                
+
+
+    
+    
+        
+        
+        
+
+        
+
+        
+        
+        
+
+        
+
+        
+    
+    
+
+    
+    
+
+        
+            
+                
+            
+
+            
+
+            
+                
+            
+
+            
+
+            
+        
+
+    
+
+        
+            
+                
+            
+
+            
+
+            
+                
+            
+
+            
+
+            
+        
+
+    
+
+        
+            
+                
+            
+
+            
+
+            
+                
+            
+
+            
+
+            
+        
+
+    
+    
+
NameTypeAttributesDescription
armoredKeys
+            
+                
+String
+
+
+            
+            
+                
+                    <optional>

+                
+
+                
+
+                
+                
Armored keys to be parsed
binaryKeys
+            
+                
+Uint8Array
+
+
+            
+            
+                
+                    <optional>

+                
+
+                
+
+                
+                
Binary keys to be parsed
config
+            
+                
+Object
+
+
+            
+            
+                
+                    <optional>

+                
+
+                
+
+                
+                
Custom configuration settings to overwrite those in config

+
+            

+
+
+
+
+
+
+

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

+    

+    
+
+    
+
+    
+
+    
+

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

+
+        
+

+    
Key objects.

+

+
+
+
+

+    

+        Type
+    

+    

+        
+Promise.<Array.<PrivateKey>>
+
+
+    

+

+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
     
(async) readSignature(options) → {Promise.<Signature>}

     
 
@@ -6264,7 +7024,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
     
     
Source:

     

     
 
@@ -6418,7 +7178,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
             
             
                 
-Key
+PrivateKey
 
 
             
@@ -6517,7 +7277,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
                 
             
 
-            
The passphrase used to encrypt the generated private key

+            
The passphrase used to encrypt the reformatted private key. If omitted, the key won't be encrypted.

         
 
     
@@ -6561,6 +7321,43 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
 
     
 
+        
+            
+                date
+            
+
+            
+            
+                
+Date
+
+
+            
+            
+
+            
+                
+                
+                    <optional>

+                
+
+                
+
+                
+                
+            
+
+            
+                
+                
+                
+            
+
+            
Override the creation date of the key signatures

+        
+
+    
+
         
             
                 config
@@ -6643,7 +7440,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
     
     
Source:

     

     
 
@@ -6673,7 +7470,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
         
 

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

+{ key:PrivateKey, privateKeyArmored:String, publicKeyArmored:String, revocationCertificate:String }

 

 
 
@@ -7072,7 +7869,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
     
     
Source:

     

     
 
@@ -7102,8 +7899,8 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
         
 

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

+{ privateKey:PrivateKey, privateKeyArmored:String, publicKey:PublicKey, publicKeyArmored:String }
+(if private key is passed) or { publicKey:PublicKey, publicKeyArmored:String } (otherwise)

 

 
 
@@ -7132,7 +7929,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
     
 
     
-    
(async) sign(options) → {Promise.<(String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>)>}

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

     
 
     
@@ -7260,16 +8057,16 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
 
         
             
-                privateKeys
+                signingKeys
             
 
             
             
                 
-Key
+PrivateKey
 |
 
-Array.<Key>
+Array.<PrivateKey>
 
 
             
@@ -7408,7 +8205,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
                 
             
 
-            
Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to privateKeys[i]

+            
Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to signingKeys[i]

         
 
     
@@ -7454,7 +8251,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
 
         
             
-                fromUserIDs
+                signingUserIDs
             
 
             
@@ -7486,7 +8283,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
                 
             
 
-            
Array of user IDs to sign with, one per key in privateKeys, e.g. [{ name: 'Steve Sender', email: 'steve@openpgp.org' }]

+            
Array of user IDs to sign with, one per key in signingKeys, e.g. [{ name: 'Steve Sender', email: 'steve@openpgp.org' }]

         
 
     
@@ -7573,7 +8370,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
     
     
Source:

     

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

         
-Promise.<(String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>)>
+Promise.<(MaybeStream.<String>|MaybeStream.<Uint8Array>)>
 
 
     

@@ -7735,7 +8532,7 @@ the encoded bytes

     
     
Source:

     

     
 
@@ -7922,16 +8719,16 @@ an attribute "data" containing a stream of bytes and "type"
 
         
             
-                publicKeys
+                verificationKeys
             
 
             
             
                 
-Key
+PublicKey
 |
 
-Array.<Key>
+Array.<PublicKey>
 
 
             
@@ -8197,7 +8994,7 @@ an attribute "data" containing a stream of bytes and "type"
     
     
Source:

     

     
 
@@ -8228,8 +9025,8 @@ an attribute "data" containing a stream of bytes and "type"
 

     
Object containing verified message in the form:

 
{
-  data: String|ReadableStream<String>|NodeStream, (if `message` was a CleartextMessage)
-  data: Uint8Array|ReadableStream<Uint8Array>|NodeStream, (if `message` was a Message)
+  data: MaybeStream<String>, (if `message` was a CleartextMessage)
+  data: MaybeStream<Uint8Array>, (if `message` was a Message)
   signatures: [
     {
       keyID: module:type/keyid~KeyID,
@@ -8276,7 +9073,7 @@ an attribute "data" containing a stream of bytes and "type"
 

 
 
 
 

diff --git a/docs/index.html b/docs/index.html
index f475e984..6be921e4 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -62,7 +62,7 @@
 
 
Streaming encrypt Uint8Array data with a password

 
(async () => {
-    const readableStream = new openpgp.stream.ReadableStream({
+    const readableStream = new ReadableStream({
         start(controller) {
             controller.enqueue(new Uint8Array([0x01, 0x02, 0x03]));
             controller.close();
@@ -427,22 +427,17 @@ It's possible to change that behaviour by enabling compression through the confi
 
     // Either pipe the above stream somewhere, pass it to another function,
     // or read it manually as follows:
-    const reader = openpgp.stream.getReader(encrypted);
-    while (true) {
-        const { done, value } = await reader.read();
-        if (done) break;
-        console.log('new chunk:', value); // Uint8Array
+    for await (const chunk of encrypted) {
+        console.log('new chunk:', chunk); // Uint8Array
     }
-
-    // Or, in Node.js, you can pipe the above stream as follows:
-    const nodeStream = openpgp.stream.webToNode(encrypted);
-    nodeStream.pipe(nodeWritableStream);
 })();
 

-
For more information on creating ReadableStreams, see the MDN Documentation on new ReadableStream().
-For more information on reading streams using openpgp.stream, see the documentation of
-the web-stream-tools dependency, particularly
-its Reader class.

+
For more information on using ReadableStreams, see the MDN Documentation on the
+Streams API.

+
You can also pass a Node.js Readable
+stream, in
+which case OpenPGP.js will return a Node.js Readable stream as well, which you
+can .pipe() to a Writable stream, for example.

 
Streaming encrypt and decrypt String data with PGP keys

 
(async () => {
     const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
@@ -460,7 +455,7 @@ its Reader classReader class

@@ -614,7 +613,7 @@ and a subkey for encryption using Curve25519.

Streaming sign and verify Uint8Array data

(async () => {
-    var readableStream = new openpgp.stream.ReadableStream({
+    var readableStream = new ReadableStream({
         start(controller) {
             controller.enqueue(new Uint8Array([0x01, 0x02, 0x03]));
             controller.close();
@@ -646,7 +645,7 @@ and a subkey for encryption using Curve25519.

         publicKeys: await openpgp.readKey({ armoredKey: publicKeyArmored })   // for verification
     });
 
-    await openpgp.stream.readToEnd(verified.data);
+    for await (const chunk of verified.data) {}
     // Note: you *have* to read `verified.data` in some way or other,
     // even if you don't need it, as that is what triggers the
     // verification of the data.
@@ -687,7 +686,7 @@ and a subkey for encryption using Curve25519.

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

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

Source:
@@ -611,7 +611,7 @@ This is an insecure setting:

Source:
@@ -728,7 +728,7 @@ This setting is insecure if the partially decrypted message is
Source:
@@ -840,7 +840,7 @@ This setting is insecure if the partially decrypted message is
Source:
@@ -952,7 +952,7 @@ This setting is insecure if the partially decrypted message is
Source:
@@ -1064,7 +1064,7 @@ This setting is insecure if the partially decrypted message is
Source:
@@ -1181,7 +1181,7 @@ validation error when the notation is marked as critical.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Source:
@@ -3234,7 +3234,7 @@ Note: not all OpenPGP implementations are compatible with this option.
Source:
@@ -3346,7 +3346,7 @@ Note: not all OpenPGP implementations are compatible with this option.
Source:
@@ -3380,7 +3380,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 685f8e8f..6d565c43 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 6994587d..1c9348b7 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:
@@ -5854,7 +5854,7 @@ document) that cannot include a target subpacket.

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

Source:
@@ -5990,7 +5990,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 9281f167..94cf743a 100644 --- a/docs/module-key_SubKey-SubKey.html +++ b/docs/module-key_SubKey-SubKey.html @@ -95,7 +95,7 @@
Source:
@@ -210,7 +210,7 @@
Source:
@@ -327,7 +327,7 @@
Source:
@@ -444,7 +444,7 @@
Source:
@@ -557,7 +557,7 @@
Source:
@@ -792,7 +792,7 @@ Returns null if the subkey is invalid.

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

-

Calculates the fingerprint of the key

+

Calculates and returns the fingerprint of the key, as a string

@@ -905,7 +905,7 @@ Returns null if the subkey is invalid.

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

-

A string containing the fingerprint in lowercase hex.

+

A string containing the fingerprint in lowercase hex

@@ -971,7 +971,7 @@ Returns null if the subkey is invalid.

-

Calculates the fingerprint of the key

+

Calculates and returns the fingerprint of the key, as a string

@@ -1022,7 +1022,7 @@ Returns null if the subkey is invalid.

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

-

A string containing the fingerprint in lowercase hex.

+

A string containing the fingerprint in lowercase hex

@@ -1088,7 +1088,7 @@ Returns null if the subkey is invalid.

-

Calculates the key id of the key

+

Return the key ID of the key

@@ -1139,7 +1139,7 @@ Returns null if the subkey is invalid.

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

-

A 8 byte key id.

+

The 8-byte key ID

@@ -1205,7 +1205,7 @@ Returns null if the subkey is invalid.

-

Calculates the key id of the key

+

Return the key ID of the key

@@ -1256,7 +1256,7 @@ Returns null if the subkey is invalid.

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

-

A 8 byte key id.

+

The 8-byte key ID

@@ -1373,7 +1373,7 @@ Returns null if the subkey is invalid.

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

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

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

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

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

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

-

toPacketlist() → {PacketList}

+

toPacketList() → {PacketList}

@@ -2481,7 +2481,7 @@ Returns null if the subkey is invalid.

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

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

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


diff --git a/docs/module-key_User-User.html b/docs/module-key_User-User.html index c1c237b9..8258fffa 100644 --- a/docs/module-key_User-User.html +++ b/docs/module-key_User-User.html @@ -95,7 +95,7 @@
Source:
@@ -358,7 +358,7 @@
Source:
@@ -568,7 +568,7 @@
Source:
@@ -626,7 +626,7 @@ -

toPacketlist() → {PacketList}

+

toPacketList() → {PacketList}

@@ -680,7 +680,7 @@
Source:
@@ -886,7 +886,7 @@
Source:
@@ -1093,7 +1093,7 @@ and validity of self signature.

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

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

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


diff --git a/docs/module-type_kdf_params-KDFParams.html b/docs/module-type_kdf_params-KDFParams.html index 776a22fc..a2078855 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 c3f8882a..1ea545bf 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 686f612e..854a44be 100644 --- a/docs/module-type_s2k-S2K.html +++ b/docs/module-type_s2k-S2K.html @@ -152,7 +152,7 @@
Source:
@@ -254,7 +254,7 @@
Source:
@@ -324,7 +324,7 @@
Source:
@@ -398,7 +398,7 @@
Source:
@@ -468,7 +468,7 @@
Source:
@@ -600,7 +600,7 @@ hashAlgorithm

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

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

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


diff --git a/package-lock.json b/package-lock.json index 2327dad1..4093715e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "openpgp", - "version": "5.0.0-2", + "version": "5.0.0-3", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 57ff16f2..9c967c57 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "openpgp", "description": "OpenPGP.js is a Javascript implementation of the OpenPGP protocol. This is defined in RFC 4880.", - "version": "5.0.0-2", + "version": "5.0.0-3", "license": "LGPL-3.0+", "homepage": "https://openpgpjs.org/", "engines": {