From 2d07c43030ad01e065a36c961912a881a123250c Mon Sep 17 00:00:00 2001 From: Daniel Huigens Date: Tue, 27 Apr 2021 14:00:54 +0200 Subject: [PATCH] 5.0.0-2 --- docs/AEADEncryptedDataPacket.html | 102 +- docs/CleartextMessage.html | 778 +--------- docs/CompressedDataPacket.html | 94 +- docs/Key.html | 947 ++++-------- docs/LiteralDataPacket.html | 26 +- docs/MarkerPacket.html | 6 +- docs/Message.html | 952 ++---------- docs/OnePassSignaturePacket.html | 96 +- docs/PacketList.html | 18 +- docs/PublicKeyEncryptedSessionKeyPacket.html | 22 +- docs/PublicKeyPacket.html | 126 +- docs/PublicSubkeyPacket.html | 135 +- docs/SecretKeyPacket.html | 166 +- docs/SecretSubkeyPacket.html | 168 +-- docs/Signature.html | 8 +- docs/SignaturePacket.html | 108 +- ...EncryptedIntegrityProtectedDataPacket.html | 82 +- docs/SymEncryptedSessionKeyPacket.html | 12 +- docs/SymmetricallyEncryptedDataPacket.html | 86 +- docs/TrustPacket.html | 6 +- docs/UserAttributePacket.html | 10 +- docs/UserIDPacket.html | 20 +- docs/global.html | 1342 ++++++++++++----- docs/index.html | 131 +- docs/module-config.html | 882 ++++++----- docs/module-crypto_random-RandomBuffer.html | 10 +- docs/module-enums.html | 52 +- docs/module-key_SubKey-SubKey.html | 74 +- docs/module-key_User-User.html | 47 +- docs/module-type_kdf_params-KDFParams.html | 8 +- ...eyid.html => module-type_keyid-KeyID.html} | 32 +- docs/module-type_s2k-S2K.html | 22 +- package-lock.json | 2 +- package.json | 2 +- 34 files changed, 2361 insertions(+), 4211 deletions(-) rename docs/{module-type_keyid-Keyid.html => module-type_keyid-KeyID.html} (65%) diff --git a/docs/AEADEncryptedDataPacket.html b/docs/AEADEncryptedDataPacket.html index c6fa9645..b77e9cc0 100644 --- a/docs/AEADEncryptedDataPacket.html +++ b/docs/AEADEncryptedDataPacket.html @@ -98,7 +98,7 @@ AEAD Protected Data Packet

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

-

(async) crypt(fn, key, data, streaming) → {Uint8Array|ReadableStream.<Uint8Array>}

+

(async) crypt(fn, key, data) → {Promise.<(Uint8Array|ReadableStream.<Uint8Array>)>}

@@ -270,29 +270,6 @@ AEAD Protected Data Packet

- - - - streaming - - - - - -Boolean - - - - - - - - - -

Whether the top-level function will return a stream

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

Source:
@@ -368,10 +345,7 @@ AEAD Protected Data Packet

-Uint8Array -| - -ReadableStream.<Uint8Array> +Promise.<(Uint8Array|ReadableStream.<Uint8Array>)>
@@ -389,7 +363,7 @@ AEAD Protected Data Packet

-

(async) decrypt(sessionKeyAlgorithm, key, streaming)

+

(async) decrypt(sessionKeyAlgorithm, key)

@@ -476,29 +450,6 @@ AEAD Protected Data Packet

- - - - streaming - - - - - -Boolean - - - - - - - - - -

Whether the top-level function will return a stream

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

Source:
@@ -603,7 +554,7 @@ AEAD Protected Data Packet

-

(async) encrypt(sessionKeyAlgorithm, key, streaming, configopt)

+

(async) encrypt(sessionKeyAlgorithm, key, configopt)

@@ -709,37 +660,6 @@ AEAD Protected Data Packet

- - - streaming - - - - - -Boolean - - - - - - - - - - - - - - - - - -

Whether the top-level function will return a stream

- - - - config @@ -811,7 +731,7 @@ AEAD Protected Data Packet

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

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

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


diff --git a/docs/CleartextMessage.html b/docs/CleartextMessage.html index c940e543..7918d80d 100644 --- a/docs/CleartextMessage.html +++ b/docs/CleartextMessage.html @@ -168,7 +168,7 @@ See https://tools.ietf.o
Source:
@@ -225,145 +225,6 @@ See https://tools.ietf.o

Methods

- - - - - - -

(static) fromText(text)

- - - - - - -
-

Creates a new CleartextMessage object from text

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
text - - -String - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - @@ -485,7 +346,7 @@ See https://tools.ietf.o
Source:
@@ -546,7 +407,7 @@ See https://tools.ietf.o -

getSigningKeyIds() → {Array.<module:type/keyid~Keyid>}

+

getSigningKeyIDs() → {Array.<module:type/keyid~KeyID>}

@@ -600,7 +461,7 @@ See https://tools.ietf.o
Source:
@@ -629,7 +490,7 @@ See https://tools.ietf.o
-

Array of keyid objects.

+

Array of keyID objects.

@@ -640,7 +501,7 @@ See https://tools.ietf.o
-Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID>
@@ -712,7 +573,7 @@ See https://tools.ietf.o
Source:
@@ -770,7 +631,7 @@ See https://tools.ietf.o -

(async) sign(privateKeys, signatureopt, signingKeyIdsopt, dateopt, userIdsopt, configopt) → {CleartextMessage}

+

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

@@ -892,13 +753,13 @@ See https://tools.ietf.o - signingKeyIds + signingKeyIDs -Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID> @@ -922,7 +783,7 @@ See https://tools.ietf.o -

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 privateKeys[i]

@@ -966,7 +827,7 @@ See https://tools.ietf.o - userIds + userIDs @@ -1076,7 +937,7 @@ See https://tools.ietf.o
Source:
@@ -1116,7 +977,7 @@ See https://tools.ietf.o
-CleartextMessage +Promise.<CleartextMessage>
@@ -1134,371 +995,7 @@ See https://tools.ietf.o -

(async) signDetached(privateKeys, signatureopt, signingKeyIdsopt, dateopt, userIdsopt, configopt) → {Signature}

- - - - - - -
-

Sign the cleartext message

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
privateKeys - - -Array.<Key> - - - - - - - - - - - -

private keys with decrypted secret key data for signing

signature - - -Signature - - - - - - <optional>
- - - - - - 		- - null - -

Any existing detached signature

signingKeyIds - - -Array.<module:type/keyid~Keyid> - - - - - - <optional>
- - - - - - 		- -

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

date - - -Date - - - - - - <optional>
- - - - - - 		- -

The creation time of the signature that should be created

userIds - - -Array - - - - - - <optional>
- - - - - - 		- -

User IDs to sign with, e.g. [{ name:'Steve Sender', email:'steve@openpgp.org' }]

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

Full configuration, defaults to openpgp.config

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

New detached signature of message content.

-
- - - -
-
- Type -
-
- -Signature - - -
-
- - - - - - - - - - - - - -

(async) verify(keys, dateopt, configopt) → {Array.<{keyid: module:type/keyid~Keyid, valid: Boolean}>}

+

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

@@ -1677,7 +1174,7 @@ See https://tools.ietf.o
Source:
@@ -1706,7 +1203,7 @@ See https://tools.ietf.o
-

List of signer's keyid and validity of signature.

+

List of signer's keyID and validity of signature.

@@ -1717,244 +1214,7 @@ See https://tools.ietf.o
-Array.<{keyid: module:type/keyid~Keyid, valid: Boolean}> - - -
- - - - - - - - - - - - - - -

(async) verifyDetached(keys, dateopt, configopt) → {Array.<{keyid: module:type/keyid~Keyid, valid: Boolean}>}

- - - - - - -
-

Verify signatures of cleartext signed message

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
keys - - -Array.<Key> - - - - - - - - - -

Array of keys to verify signatures

date - - -Date - - - - - - <optional>
- - - - - -

Verify the signature against the given date, i.e. check signature creation time < date < expiration time

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

Full configuration, defaults to openpgp.config

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

List of signer's keyid and validity of signature.

-
- - - -
-
- Type -
-
- -Array.<{keyid: module:type/keyid~Keyid, valid: Boolean}> +Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<Boolean>}>>
@@ -1982,7 +1242,7 @@ See https://tools.ietf.o
diff --git a/docs/CompressedDataPacket.html b/docs/CompressedDataPacket.html index 9eef81fa..10f34045 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,81 +481,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.

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

tag :module:enums.packet

- - - - -
-

Packet type

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

Source:
@@ -728,7 +654,7 @@ read by read_packet

Source:
@@ -870,7 +796,7 @@ read by read_packet

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

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


diff --git a/docs/Key.html b/docs/Key.html index bbbbde65..b3c93523 100644 --- a/docs/Key.html +++ b/docs/Key.html @@ -145,7 +145,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.

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

-

(async) addSubkey() → {Key}

+

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

@@ -446,7 +446,7 @@ Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the p
Source:
@@ -482,7 +482,7 @@ Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the p
-Key +Promise.<Key>
@@ -500,7 +500,7 @@ Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the p -

(async) applyRevocationCertificate(revocationCertificate, configopt) → {Key}

+

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

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

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

-Key +Promise.<Key>
@@ -821,7 +821,7 @@ if it is a valid revocation signature.

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

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

-

(async) clone() → {Key}

+

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

@@ -988,6 +988,75 @@ if it is a valid revocation signature.

+
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
deep + + +Boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

Whether to return a deep clone

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

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

-

Shallow clone of the key.

+

Clone of the key.

@@ -1063,7 +1132,7 @@ if it is a valid revocation signature.

-Key +Promise.<Key>
@@ -1081,528 +1150,6 @@ if it is a valid revocation signature.

-

(async) decrypt(passphrases, keyId, configopt)

- - - - - - -
-

Decrypts all secret key and subkey packets matching keyId

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
passphrases - - -String -| - -Array.<String> - - - - - - - - - - - -
keyId - - -module:type/keyid~Keyid - - - - - - - - - - - - null - -
config - - -Object - - - - - - <optional>
- - - - - - 		- -

Full configuration, defaults to openpgp.config

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

if any matching key or subkey packets did not decrypt successfully

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

(async) encrypt(passphrases, keyId, configopt)

- - - - - - -
-

Encrypts all secret key and subkey packets matching keyId

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
passphrases - - -String -| - -Array.<String> - - - - - - - - - - - -

If multiple passphrases, then should be in same order as packets each should encrypt

keyId - - -module:type/keyid~Keyid - - - - - - - - - - - - null - -
config - - -Object - - - - - - <optional>
- - - - - - 		- -

Full configuration, defaults to openpgp.config

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

if encryption failed for any key or subkey

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

getAlgorithmInfo() → {Object}

@@ -1657,7 +1204,7 @@ if it is a valid revocation signature.

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

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

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

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

-

(async) getDecryptionKeys(keyId,, date,, userId,, configopt) → {Array.<(Key|SubKey)>}

+

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

@@ -2051,7 +1598,7 @@ if it is a valid revocation signature.

-

Returns all keys that are available for decryption, matching the keyId when given +

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

@@ -2090,13 +1637,13 @@ This is useful to retrieve keys for session key decryption

- keyId, + keyID, -module:type/keyid~Keyid +module:type/keyid~KeyID @@ -2152,7 +1699,7 @@ This is useful to retrieve keys for session key decryption

- userId, + userID, @@ -2252,7 +1799,7 @@ This is useful to retrieve keys for session key decryption

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

-Array.<(Key|SubKey)> +Promise.<Array.<(Key|SubKey)>>
@@ -2310,7 +1857,7 @@ This is useful to retrieve keys for session key decryption

-

(async) getEncryptionKey(keyId,, date,, userId,, configopt) → {Key|SubKey|null}

+

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

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

-

Returns last created key or key by given keyId that is available for encryption or decryption

+

Returns last created key or key by given keyID that is available for encryption or decryption

@@ -2356,13 +1903,13 @@ This is useful to retrieve keys for session key decryption

- keyId, + keyID, -module:type/keyid~Keyid +module:type/keyid~KeyID @@ -2418,7 +1965,7 @@ This is useful to retrieve keys for session key decryption

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

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

-Key -| - -SubKey -| - -null +Promise.<(Key|SubKey|null)>
@@ -2582,7 +2123,7 @@ This is useful to retrieve keys for session key decryption

-

(async) getExpirationTime(capabilities,, keyId,, userId,, configopt) → {Date|Infinity|null}

+

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

@@ -2668,13 +2209,13 @@ Returns Infinity if the key doesn't expire.

- keyId, + keyID, -module:type/keyid~Keyid +module:type/keyid~KeyID @@ -2699,7 +2240,7 @@ Returns Infinity if the key doesn't expire.

- userId, + userID, @@ -2799,7 +2340,7 @@ Returns Infinity if the key doesn't expire.

Source:
@@ -2835,13 +2376,7 @@ Returns Infinity if the key doesn't expire.

-Date -| - -Infinity -| - -null +Promise.<(Date|Infinity|null)>
@@ -2913,7 +2448,7 @@ Returns Infinity if the key doesn't expire.

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

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

-

getKeyId() → {module:type/keyid~Keyid}

+

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

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

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

-module:type/keyid~Keyid +module:type/keyid~KeyID
@@ -3195,7 +2730,7 @@ Returns Infinity if the key doesn't expire.

-

getKeyId() → {module:type/keyid~Keyid}

+

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

@@ -3249,7 +2784,7 @@ Returns Infinity if the key doesn't expire.

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

-module:type/keyid~Keyid +module:type/keyid~KeyID
@@ -3307,7 +2842,7 @@ Returns Infinity if the key doesn't expire.

-

getKeyIds() → {Array.<module:type/keyid~Keyid>}

+

getKeyIDs() → {Array.<module:type/keyid~KeyID>}

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

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

-Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID>
@@ -3415,7 +2950,7 @@ Returns Infinity if the key doesn't expire.

-

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

+

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

@@ -3423,8 +2958,8 @@ 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.

+

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

@@ -3462,7 +2997,7 @@ If keyId is not present, returns all keys starting with the primary key.

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

Source:
@@ -3581,7 +3116,7 @@ If keyId is not present, returns all keys starting with the primary key.

-

(async) getPrimaryUser(dateopt, userIdopt, configopt) → {Promise.<{user: User, selfCertification: SignaturePacket}>}

+

(async) getPrimaryUser(dateopt, userIDopt, configopt) → {Promise.<{user: User, selfCertification: SignaturePacket}>}

@@ -3664,7 +3199,7 @@ If keyId is not present, returns all keys starting with the primary key.

- userId + userID @@ -3766,7 +3301,7 @@ If keyId is not present, returns all keys starting with the primary key.

Source:
@@ -3824,7 +3359,7 @@ If keyId is not present, returns all keys starting with the primary key.

-

(async) getRevocationCertificate(date, configopt) → {String}

+

(async) getRevocationCertificate(date, configopt) → {Promise.<String>}

@@ -3971,7 +3506,7 @@ If keyId is not present, returns all keys starting with the primary key.

Source:
@@ -4011,7 +3546,7 @@ If keyId is not present, returns all keys starting with the primary key.

-String +Promise.<String>
@@ -4029,7 +3564,7 @@ If keyId is not present, returns all keys starting with the primary key.

-

(async) getSigningKey(keyId,, dateopt, userId,, configopt) → {Key|SubKey|null}

+

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

@@ -4037,7 +3572,7 @@ If keyId is not present, returns all keys starting with the primary key.

-

Returns last created key or key by given keyId that is available for signing and verification

+

Returns last created key or key by given keyID that is available for signing and verification

@@ -4075,13 +3610,13 @@ If keyId is not present, returns all keys starting with the primary key.

- keyId, + keyID, -module:type/keyid~Keyid +module:type/keyid~KeyID @@ -4139,7 +3674,7 @@ If keyId is not present, returns all keys starting with the primary key.

- userId, + userID, @@ -4239,7 +3774,7 @@ If keyId is not present, returns all keys starting with the primary key.

Source:
@@ -4279,13 +3814,7 @@ If keyId is not present, returns all keys starting with the primary key.

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

-

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

+

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

@@ -4311,8 +3840,8 @@ 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.

+

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

@@ -4350,7 +3879,7 @@ If keyId is not present, returns all subkeys.

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

Source:
@@ -4469,7 +3998,7 @@ If keyId is not present, returns all subkeys.

-

getUserIds() → {Array.<string>}

+

getUserIDs() → {Array.<string>}

@@ -4477,7 +4006,7 @@ If keyId is not present, returns all subkeys.

-

Returns userids

+

Returns userIDs

@@ -4523,7 +4052,7 @@ If keyId is not present, returns all subkeys.

Source:
@@ -4552,7 +4081,7 @@ If keyId is not present, returns all subkeys.

-

Array of userids.

+

Array of userIDs.

@@ -4635,7 +4164,7 @@ If keyId is not present, returns all subkeys.

Source:
@@ -4747,7 +4276,7 @@ If keyId is not present, returns all subkeys.

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

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

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

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

-

(async) isRevoked(signature, key,, date, configopt) → {Boolean}

+

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

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

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

-Boolean +Promise.<Boolean>
@@ -5490,7 +5019,7 @@ A dummy key is considered encrypted.

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

-

(async) revoke(reasonForRevocation, date, configopt) → {Key}

+

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

@@ -5775,7 +5304,7 @@ A dummy key is considered encrypted.

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

-Key +Promise.<Key>
@@ -5833,7 +5362,7 @@ A dummy key is considered encrypted.

-

(async) signAllUsers(privateKeys, configopt) → {Key}

+

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

@@ -5979,7 +5508,7 @@ A dummy key is considered encrypted.

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

-Key +Promise.<Key>
@@ -6037,7 +5566,7 @@ A dummy key is considered encrypted.

-

(async) signPrimaryUser(privateKeys, dateopt, userIdopt, configopt) → {Key}

+

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

@@ -6147,7 +5676,7 @@ A dummy key is considered encrypted.

- userId + userID @@ -6249,7 +5778,7 @@ A dummy key is considered encrypted.

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

-Key +Promise.<Key>
@@ -6361,7 +5890,7 @@ A dummy key is considered encrypted.

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

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

-

(async) update(key, configopt) → {undefined}

+

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

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

Source:
@@ -6778,7 +6307,7 @@ the destination key is transformed to a private key.

-undefined +Promise.<undefined>
@@ -6915,7 +6444,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err
Source:
@@ -6980,7 +6509,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err -

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

+

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

@@ -7130,7 +6659,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err
Source:
@@ -7159,7 +6688,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err
-

list of userid, signer's keyid and validity of signature

+

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

@@ -7170,7 +6699,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err
-Promise.<Array.<{userid: String, keyid: module:type/keyid~Keyid, valid: Boolean}>> +Promise.<Array.<{userID: String, keyID: module:type/keyid~KeyID, valid: Boolean}>>
@@ -7188,7 +6717,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err -

(async) verifyPrimaryKey(dateopt, userIdopt, configopt)

+

(async) verifyPrimaryKey(dateopt, userIDopt, configopt)

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

- userId + userID @@ -7370,7 +6899,7 @@ and valid self signature. Throws if the primary key is invalid.

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

-

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

+

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

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

- userId + userID @@ -7651,7 +7180,7 @@ and valid self signature. Throws if the primary key is invalid.

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

-

List of signer's keyid and validity of signature

+

List of signer's keyID and validity of signature

@@ -7691,7 +7220,119 @@ and valid self signature. Throws if the primary key is invalid.

-Promise.<Array.<{keyid: module:type/keyid~Keyid, valid: Boolean}>> +Promise.<Array.<{keyID: module:type/keyid~KeyID, valid: Boolean}>> + + +
+
+ + + + + + + + + + + + + +

write() → {Uint8Array}

+ + + + + + +
+

Returns binary encoded key

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

Binary key.

+
+ + + +
+
+ Type +
+
+ +Uint8Array
@@ -7719,7 +7360,7 @@ and valid self signature. Throws if the primary key is invalid.


diff --git a/docs/LiteralDataPacket.html b/docs/LiteralDataPacket.html index a7a06837..91c7e7a2 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:
@@ -684,7 +684,7 @@ with normalized end of line to \n

-

(async) read(input) → {LiteralDataPacket}

+

(async) read(input) → {Promise.<LiteralDataPacket>}

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

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

-LiteralDataPacket +Promise.<LiteralDataPacket>
@@ -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 96e4b316..a6173698 100644 --- a/docs/MarkerPacket.html +++ b/docs/MarkerPacket.html @@ -101,7 +101,7 @@ the Marker packet.

Source:
@@ -307,7 +307,7 @@ input at position

Source:
@@ -375,7 +375,7 @@ input at position


diff --git a/docs/Message.html b/docs/Message.html index e7b8ec32..4490019a 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) → {Message}

+

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

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

Aead algorithm, e.g. 'eax' or 'ocb'

+

AEAD algorithm, e.g. 'eax' or 'ocb'

@@ -477,13 +477,13 @@ See https://tools.iet - encryptionKeyIds + encryptionKeyIDs -Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID> @@ -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 publicKeys[i]

@@ -551,7 +551,7 @@ See https://tools.iet - userIds + userIDs @@ -661,7 +661,7 @@ See https://tools.iet
Source:
@@ -701,7 +701,7 @@ See https://tools.iet
-Message +Promise.<Message>
@@ -719,619 +719,7 @@ See https://tools.iet -

(static) fromBinary(bytes, filenameopt, dateopt, typeopt) → {Message}

- - - - - - -
-

Creates new message object from binary data.

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
bytes - - -Uint8Array -| - -ReadableStream.<Uint8Array> - - - - - - - - - - - -

The message contents

filename - - -String - - - - - - <optional>
- - - - - - 		- - "" - -

Name of the file (if any)

date - - -Date - - - - - - <optional>
- - - - - - 		- - current date - -

Date of the message, or modification date of the file

type - - -'utf8' -| - -'binary' -| - -'text' -| - -'mime' - - - - - - <optional>
- - - - - - 		- - 'binary' - -

Data packet type

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

New message object.

-
- - - -
-
- Type -
-
- -Message - - -
-
- - - - - - - - - - - - - -

(static) fromText(text, filenameopt, dateopt, typeopt) → {Message}

- - - - - - -
-

Creates new message object from text.

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
text - - -String -| - -ReadableStream.<String> - - - - - - - - - - - -

The message contents

filename - - -String - - - - - - <optional>
- - - - - - 		- - "" - -

Name of the file (if any)

date - - -Date - - - - - - <optional>
- - - - - - 		- - current date - -

Date of the message, or modification date of the file

type - - -'utf8' -| - -'binary' -| - -'text' -| - -'mime' - - - - - - <optional>
- - - - - - 		- - 'utf8' - -

Data packet type

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

New message object.

-
- - - -
-
- Type -
-
- -Message - - -
-
- - - - - - - - - - - - - -

(async, static) generateSessionKey(keysopt, dateopt, userIdsopt, configopt) → {Object}

+

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

@@ -1443,7 +831,7 @@ See https://tools.iet - userIds + userIDs @@ -1545,7 +933,7 @@ See https://tools.iet
Source:
@@ -1585,7 +973,7 @@ See https://tools.iet
-Object +Promise.<{data: Uint8Array, algorithm: String}>
@@ -1709,7 +1097,7 @@ See https://tools.iet
Source:
@@ -1860,7 +1248,7 @@ See https://tools.iet
Source:
@@ -1918,7 +1306,7 @@ See https://tools.iet -

compress(configopt) → {Message}

+

compress(algo, configopt) → {Message}

@@ -1962,6 +1350,37 @@ See https://tools.iet + + + algo + + + + + +module:enums.compression + + + + + + + + + + + + + + + + + +

compression algorithm

+ + + + config @@ -2033,7 +1452,7 @@ See https://tools.iet
Source:
@@ -2091,7 +1510,7 @@ See https://tools.iet -

(async) decrypt(privateKeysopt, passwordsopt, sessionKeysopt, streamingopt, configopt) → {Message}

+

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

@@ -2234,39 +1653,6 @@ See https://tools.iet - - - streaming - - - - - -Boolean - - - - - - - - - <optional>
- - - - - - - - - - -

Whether to process data as a stream

- - - - config @@ -2338,7 +1724,7 @@ See https://tools.iet
Source:
@@ -2378,7 +1764,7 @@ See https://tools.iet
-Message +Promise.<Message>
@@ -2577,7 +1963,7 @@ See https://tools.iet
Source:
@@ -2635,7 +2021,7 @@ See https://tools.iet -

(async) encrypt(keysopt, passwordsopt, sessionKeyopt, wildcardopt, encryptionKeyIdsopt, dateopt, userIdsopt, streamingopt, configopt) → {Message}

+

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

@@ -2833,13 +2219,13 @@ See https://tools.iet - encryptionKeyIds + encryptionKeyIDs -Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID> @@ -2863,7 +2249,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 publicKeys[i]

@@ -2907,7 +2293,7 @@ See https://tools.iet - userIds + userIDs @@ -2942,43 +2328,6 @@ See https://tools.iet - - - streaming - - - - - -Boolean - - - - - - - - - <optional>
- - - - - - - - - - - - - - -

Whether to process data as a stream

- - - - config @@ -3054,7 +2403,7 @@ See https://tools.iet
Source:
@@ -3094,7 +2443,7 @@ See https://tools.iet
-Message +Promise.<Message>
@@ -3112,7 +2461,7 @@ See https://tools.iet -

getEncryptionKeyIds() → {Array.<module:type/keyid~Keyid>}

+

getEncryptionKeyIDs() → {Array.<module:type/keyid~KeyID>}

@@ -3166,7 +2515,7 @@ See https://tools.iet
Source:
@@ -3195,7 +2544,7 @@ See https://tools.iet
-

Array of keyid objects.

+

Array of keyID objects.

@@ -3206,7 +2555,7 @@ See https://tools.iet
-Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID>
@@ -3278,7 +2627,7 @@ See https://tools.iet
Source:
@@ -3393,7 +2742,7 @@ See https://tools.iet
Source:
@@ -3454,7 +2803,7 @@ See https://tools.iet -

getSigningKeyIds() → {Array.<module:type/keyid~Keyid>}

+

getSigningKeyIDs() → {Array.<module:type/keyid~KeyID>}

@@ -3508,7 +2857,7 @@ See https://tools.iet
Source:
@@ -3537,7 +2886,7 @@ See https://tools.iet
-

Array of keyid objects.

+

Array of keyID objects.

@@ -3548,7 +2897,7 @@ See https://tools.iet
-Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID>
@@ -3620,7 +2969,7 @@ See https://tools.iet
Source:
@@ -3681,7 +3030,7 @@ See https://tools.iet -

(async) sign(privateKeys, signatureopt, signingKeyIdsopt, dateopt, userIdsopt, streamingopt, configopt) → {Message}

+

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

@@ -3803,13 +3152,13 @@ See https://tools.iet - signingKeyIds + signingKeyIDs -Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID> @@ -3833,7 +3182,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 privateKeys[i]

@@ -3877,7 +3226,7 @@ See https://tools.iet - userIds + userIDs @@ -3912,45 +3261,6 @@ See https://tools.iet - - - streaming - - - - - -Boolean - - - - - - - - - <optional>
- - - - - - - - - - - - false - - - - -

Whether to process data as a stream

- - - - config @@ -4026,7 +3336,7 @@ See https://tools.iet
Source:
@@ -4066,7 +3376,7 @@ See https://tools.iet
-Message +Promise.<Message>
@@ -4084,7 +3394,7 @@ See https://tools.iet -

(async) signDetached(privateKeys, signatureopt, signingKeyIdsopt, dateopt, userIdsopt, streamingopt, configopt) → {Signature}

+

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

@@ -4206,13 +3516,13 @@ See https://tools.iet - signingKeyIds + signingKeyIDs -Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID> @@ -4236,7 +3546,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 privateKeys[i]

@@ -4280,7 +3590,7 @@ See https://tools.iet - userIds + userIDs @@ -4315,45 +3625,6 @@ See https://tools.iet - - - streaming - - - - - -Boolean - - - - - - - - - <optional>
- - - - - - - - - - - - false - - - - -

Whether to process data as a stream

- - - - config @@ -4429,7 +3700,7 @@ See https://tools.iet
Source:
@@ -4469,7 +3740,7 @@ See https://tools.iet
-Signature +Promise.<Signature>
@@ -4541,7 +3812,7 @@ See https://tools.iet
Source:
@@ -4599,7 +3870,7 @@ See https://tools.iet -

(async) verify(keys, dateopt, streamingopt, configopt) → {Array.<({keyid: module:type/keyid~Keyid, valid: Boolean})>}

+

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

@@ -4707,39 +3978,6 @@ See https://tools.iet - - - streaming - - - - - -Boolean - - - - - - - - - <optional>
- - - - - - - - - - -

Whether to process data as a stream

- - - - config @@ -4811,7 +4049,7 @@ See https://tools.iet
Source:
@@ -4840,7 +4078,7 @@ See https://tools.iet
-

List of signer's keyid and validity of signature.

+

List of signer's keyID and validity of signatures.

@@ -4851,7 +4089,7 @@ See https://tools.iet
-Array.<({keyid: module:type/keyid~Keyid, valid: Boolean})> +Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<Boolean>}>>
@@ -4869,7 +4107,7 @@ See https://tools.iet -

(async) verifyDetached(keys, signature, date, configopt) → {Array.<({keyid: module:type/keyid~Keyid, valid: Boolean})>}

+

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

@@ -5077,7 +4315,7 @@ See https://tools.iet
Source:
@@ -5106,7 +4344,7 @@ See https://tools.iet
-

List of signer's keyid and validity of signature.

+

List of signer's keyID and validity of signature.

@@ -5117,7 +4355,7 @@ See https://tools.iet
-Array.<({keyid: module:type/keyid~Keyid, valid: Boolean})> +Promise.<Array.<{keyID: module:type/keyid~KeyID, signature: Promise.<Signature>, verified: Promise.<Boolean>}>>
@@ -5189,7 +4427,7 @@ See https://tools.iet
Source:
@@ -5257,7 +4495,7 @@ See https://tools.iet
diff --git a/docs/OnePassSignaturePacket.html b/docs/OnePassSignaturePacket.html index e3eaf759..f33797b0 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:
@@ -288,7 +288,7 @@ that describes another signature to be applied to the same message data.

-

issuerKeyId

+

issuerKeyID

@@ -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,81 +471,7 @@ Signature types are described in
Source:
- - - - - - - -
- - - - - - - - -

tag :module:enums.packet

- - - - -
-

Packet type

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

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

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

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

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

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

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

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

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


diff --git a/docs/PublicKeyEncryptedSessionKeyPacket.html b/docs/PublicKeyEncryptedSessionKeyPacket.html index df3875ef..0d71b39d 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) → {Boolean}

+

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

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

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

-Boolean +Promise.<Boolean>
@@ -395,7 +395,7 @@ packets (tag 1)

-

(async) encrypt(key) → {Boolean}

+

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

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

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

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

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

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


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

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

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

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

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

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

-

keyid :module:type/keyid~Keyid

+

keyID :module:type/keyid~KeyID

-

Keyid

+

KeyID

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

- - - - - - - - -

tag :module:enums.packet

- - - - -
-

Packet type

-
- - - -
Type:
- - - - - - -
- - - - - - - - -
Overrides:
-
- - - - - - - - - - - - - - - - - - - - - -
Source:
-
@@ -1440,7 +1361,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1509,7 +1430,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1598,7 +1519,7 @@ includes the secret-key material after all the public-key fields.

Source:
@@ -1643,6 +1564,7 @@ includes the secret-key material after all the public-key fields.

Decrypts the private key params which are needed to use the key. +Successful decryption does not imply key integrity, call validate() to confirm that. SecretKeyPacket.isDecrypted should be false, as otherwise calls to this function will throw an error.

@@ -1739,7 +1661,7 @@ otherwise calls to this function will throw an error.

Source:
@@ -1769,7 +1691,7 @@ otherwise calls to this function will throw an error.

-

if decryption was not successful

+

if the key is already decrypted, or if decryption was not successful

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

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

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

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

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

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

-

getKeyId() → {module:type/keyid~Keyid}

+

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

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

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

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

-module:type/keyid~Keyid +module:type/keyid~KeyID
@@ -2658,7 +2580,7 @@ This can be used to remove passphrase protection after calling decrypt().

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

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

Source:
@@ -3057,7 +2979,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3202,7 +3124,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3292,7 +3214,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3416,7 +3338,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3533,7 +3455,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3579,7 +3501,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 2a19961a..2f67e505 100644 --- a/docs/SecretSubkeyPacket.html +++ b/docs/SecretSubkeyPacket.html @@ -190,7 +190,7 @@ Key packet and has exactly the same format.

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

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

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

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

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

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

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

-

keyid :module:type/keyid~Keyid

+

keyID :module:type/keyid~KeyID

-

Keyid

+

KeyID

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

- - - - - - - - -

tag :module:enums.packet

- - - - -
-

Packet type

-
- - - -
Type:
- - - - - - -
- - - - - - - - -
Overrides:
-
- - - - - - - - - - - - - - - - - - - - - -
Source:
-
@@ -1474,7 +1395,7 @@ Key packet and has exactly the same format.

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

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

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

Decrypts the private key params which are needed to use the key. +Successful decryption does not imply key integrity, call validate() to confirm that. SecretKeyPacket.isDecrypted should be false, as otherwise calls to this function will throw an error.

@@ -1783,7 +1705,7 @@ otherwise calls to this function will throw an error.

Source:
@@ -1813,7 +1735,7 @@ otherwise calls to this function will throw an error.

-

if decryption was not successful

+

if the key is already decrypted, or if decryption was not successful

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

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

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

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

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

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

-

getKeyId() → {module:type/keyid~Keyid}

+

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

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

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

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

-module:type/keyid~Keyid +module:type/keyid~KeyID
@@ -2707,7 +2629,7 @@ This can be used to remove passphrase protection after calling decrypt().

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

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

Source:
@@ -3116,7 +3038,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3261,7 +3183,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3356,7 +3278,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3480,7 +3402,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3597,7 +3519,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig
Source:
@@ -3643,7 +3565,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 82d0b4fb..da3b3abd 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 b0576890..3a0a6cae 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:
@@ -650,7 +650,7 @@ block of text, and a signature that is a certification of a User ID.

-

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

+

(async) sign(key, data, detachedopt)

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

- - - - streaming - - - - - -Boolean - - - - - - - - - <optional>
- - - - - - - - - - - - false - - - - -

Whether to process data as a stream

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

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

-

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

+

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

@@ -1149,45 +1110,6 @@ block of text, and a signature that is a certification of a User ID.

- - - streaming - - - - - -Boolean - - - - - - - - - <optional>
- - - - - - - - - - - - false - - - - -

Whether to process data as a stream

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

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

-

write_hashed_sub_packets() → {Uint8Array}

+

writeHashedSubPackets() → {Uint8Array}

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

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

-

write_params() → {Uint8Array|ReadableStream.<Uint8Array>}

+

writeParams() → {Uint8Array|ReadableStream.<Uint8Array>}

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

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

-

write_unhashed_sub_packets() → {Uint8Array}

+

writeUnhashedSubPackets() → {Uint8Array}

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

Source:
@@ -1669,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 261eb36c..a5ea6f5c 100644 --- a/docs/SymEncryptedIntegrityProtectedDataPacket.html +++ b/docs/SymEncryptedIntegrityProtectedDataPacket.html @@ -101,7 +101,7 @@ packet.

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

Source:
@@ -273,7 +273,7 @@ should be discarded.

Source:
@@ -301,7 +301,7 @@ should be discarded.

-

(async) decrypt(sessionKeyAlgorithm, key, streaming, configopt) → {Boolean}

+

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

@@ -407,37 +407,6 @@ should be discarded.

- - - streaming - - - - - -Boolean - - - - - - - - - - - - - - - - - -

Whether to read this.encrypted as a stream

- - - - config @@ -509,7 +478,7 @@ should be discarded.

Source:
@@ -545,7 +514,7 @@ should be discarded.

-Boolean +Promise.<Boolean>
@@ -563,7 +532,7 @@ should be discarded.

-

(async) encrypt(sessionKeyAlgorithm, key, streaming, configopt) → {Boolean}

+

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

@@ -669,37 +638,6 @@ should be discarded.

- - - streaming - - - - - -Boolean - - - - - - - - - - - - - - - - - -

Whether to set this.encrypted to a stream

- - - - config @@ -771,7 +709,7 @@ should be discarded.

Source:
@@ -807,7 +745,7 @@ should be discarded.

-Boolean +Promise.<Boolean>
@@ -835,7 +773,7 @@ should be discarded.


diff --git a/docs/SymEncryptedSessionKeyPacket.html b/docs/SymEncryptedSessionKeyPacket.html index 7bd44abb..d2b4fb83 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 38748242..81c63777 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,81 +271,7 @@ that form whole OpenPGP messages).

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

tag :module:enums.packet

- - - - -
-

Packet type

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

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

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


diff --git a/docs/UserAttributePacket.html b/docs/UserAttributePacket.html index 1e9c168d..3984d09e 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 05d4dd07..06b7bbaa 100644 --- a/docs/UserIDPacket.html +++ b/docs/UserIDPacket.html @@ -100,7 +100,7 @@ specifies the length of the User ID.

Source:
@@ -150,7 +150,7 @@ specifies the length of the User ID.

-

userid :String

+

userID :String

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

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

-

(static) fromObject(userId) → {UserIDPacket}

+

(static) fromObject(userID) → {UserIDPacket}

@@ -279,7 +279,7 @@ John Doe john@example.com

- userId + userID @@ -295,7 +295,7 @@ John Doe john@example.com

-

Object specifying userId name, email and comment

+

Object specifying userID name, email and comment

@@ -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 c96248e5..5c01c7c8 100644 --- a/docs/global.html +++ b/docs/global.html @@ -352,7 +352,7 @@
Source:
@@ -413,7 +413,592 @@ -

(async) decrypt(options) → {Object}

+

(async) createCleartextMessage(options)

+ + + + + + +
+

Creates a new CleartextMessage object from text

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
text + + +String + + + +
+ +
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

(async) createMessage(options) → {Promise.<Message>}

+ + + + + + +
+

Creates new message object from text or binary data.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
text + + +String +| + +ReadableStream.<String> + + + + + + <optional>
+ + + + + + 		+ +

The text message contents

binary + + +Uint8Array +| + +ReadableStream.<Uint8Array> + + + + + + <optional>
+ + + + + + 		+ +

The binary message contents

filename + + +String + + + + + + <optional>
+ + + + + + 		+ + "" + +

Name of the file (if any)

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

Date of the message, or modification date of the file

format + + +'utf8' +| + +'binary' +| + +'text' +| + +'mime' + + + + + + <optional>
+ + + + + + 		+ + 'utf8' if text is passed, 'binary' otherwise + +

Data packet type

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

New message object.

+
+ + + +
+
+ Type +
+
+ +Promise.<Message> + + +
+
+ + + + + + + + + + + + + +

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

@@ -697,6 +1282,45 @@ a session key or a password must be specified.

+ + + expectSigned + + + + + +Boolean + + + + + + + + + <optional>
+ + + + + + + + + + + + false + + + + +

If true, data decryption fails if the message is not signed with the provided publicKeys

+ + + + format @@ -739,54 +1363,6 @@ a session key or a password must be specified.

- - - streaming - - - - - -'web' -| - -'ponyfill' -| - -'node' -| - -false - - - - - - - - - <optional>
- - - - - - - - - - - - type of stream `message` was created from, if any - - - - -

Whether to return data as a stream. Defaults to the type of stream message was created from, if any.

- - - - signature @@ -945,7 +1521,7 @@ a session key or a password must be specified.

Source:
@@ -981,9 +1557,9 @@ a session key or a password must be specified.

filename: String, signatures: [ { - keyid: module:type/keyid~Keyid, + keyID: module:type/keyid~KeyID, verified: Promise<Boolean>, - valid: Boolean (if streaming was false) + valid: Boolean (if `message` was not created from a stream) }, ... ] } @@ -997,7 +1573,7 @@ a session key or a password must be specified.

-Object +Promise.<Object>
@@ -1015,7 +1591,7 @@ a session key or a password must be specified.

-

(async) decryptKey(options) → {Key}

+

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

@@ -1245,7 +1821,7 @@ This method does not change the original key.

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

-Key +Promise.<Key>
@@ -1303,7 +1879,7 @@ This method does not change the original key.

-

(async) decryptSessionKeys(options) → {Object|undefined}

+

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

@@ -1571,7 +2147,7 @@ a password must be specified.

Source:
@@ -1613,10 +2189,7 @@ or 'undefined' if no key packets found

-Object -| - -undefined +Promise.<(Object|undefined)>
@@ -1634,7 +2207,7 @@ or 'undefined' if no key packets found

-

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

+

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

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

Message to be encrypted as created by Message.fromText or Message.fromBinary

+

Message to be encrypted as created by createMessage

@@ -1954,54 +2527,6 @@ must be specified. If private keys are specified, those will be used to sign the - - - streaming - - - - - -'web' -| - -'ponyfill' -| - -'node' -| - -false - - - - - - - - - <optional>
- - - - - - - - - - - - type of stream `message` was created from, if any - - - - -

Whether to return data as a stream

- - - - signature @@ -2080,13 +2605,13 @@ must be specified. If private keys are specified, those will be used to sign the - signingKeyIds + signingKeyIDs -Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID> @@ -2112,20 +2637,20 @@ 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 privateKeys[i]

- encryptionKeyIds + encryptionKeyIDs -Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID> @@ -2151,7 +2676,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 publicKeys[i]

@@ -2197,7 +2722,7 @@ must be specified. If private keys are specified, those will be used to sign the - fromUserIds + fromUserIDs @@ -2236,7 +2761,7 @@ must be specified. If private keys are specified, those will be used to sign the - toUserIds + toUserIDs @@ -2355,7 +2880,7 @@ must be specified. If private keys are specified, those will be used to sign the
Source:
@@ -2395,22 +2920,7 @@ must be specified. If private keys are specified, those will be used to sign the
-String -| - -ReadableStream.<String> -| - -NodeStream.<String> -| - -Uint8Array -| - -ReadableStream.<Uint8Array> -| - -NodeStream.<Uint8Array> +Promise.<(String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>)>
@@ -2428,7 +2938,7 @@ must be specified. If private keys are specified, those will be used to sign the -

(async) encryptKey(options) → {Key}

+

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

@@ -2658,7 +3168,7 @@ This method does not change the original key.

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

-Key +Promise.<Key>
@@ -2716,7 +3226,7 @@ This method does not change the original key.

-

(async) encryptSessionKey(options) → {String|Uint8Array}

+

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

@@ -2907,7 +3417,7 @@ or passwords must be specified.

-

Aead algorithm, e.g. 'eax' or 'ocb'

+

AEAD algorithm, e.g. 'eax' or 'ocb'

@@ -3072,13 +3582,13 @@ or passwords must be specified.

- encryptionKeyIds + encryptionKeyIDs -Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID> @@ -3104,7 +3614,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 publicKeys[i]

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

- toUserIds + toUserIDs @@ -3269,7 +3779,7 @@ or passwords must be specified.

Source:
@@ -3309,10 +3819,7 @@ or passwords must be specified.

-String -| - -Uint8Array +Promise.<(String|Uint8Array)>
@@ -3330,7 +3837,7 @@ or passwords must be specified.

-

(async) generateKey(options) → {Object}

+

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

@@ -3418,6 +3925,44 @@ or passwords must be specified.

+ + + userIDs + + + + + +Object +| + +Array.<Object> + + + + + + + + + + + + + + + + + + + + + +

User IDs as objects: { name: 'Jo Doe', email: 'info@jo.com' }

+ + + + type @@ -3460,44 +4005,6 @@ or passwords must be specified.

- - - userIds - - - - - -Object -| - -Array.<Object> - - - - - - - - - - - - - - - - - - - - - -

User IDs as objects: { name: 'Jo Doe', email: 'info@jo.com' }

- - - - passphrase @@ -3817,7 +4324,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
Source:
@@ -3858,7 +4365,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
-Object +Promise.<Object>
@@ -3876,7 +4383,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r -

(async) generateSessionKey(options) → {Object}

+

(async) generateSessionKey(options) → {Promise.<{data: Uint8Array, algorithm: String}>}

@@ -4043,7 +4550,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r - toUserIds + toUserIDs @@ -4162,7 +4669,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
Source:
@@ -4196,6 +4703,190 @@ sign parameter defaults to false, and indicates whether the subkey should sign r +
+
+ Type +
+
+ +Promise.<{data: Uint8Array, algorithm: String}> + + +
+
+ + + + + + + + + + + + + +

newPacketFromTag(tag, allowedPackets) → {Object}

+ + + + + + +
+

Instantiate a new packet given its tag

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

Property value from module:enums.packet

allowedPackets + + +Object + + + +

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

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

New packet object with type based on tag

+
+ + +
Type @@ -4220,7 +4911,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r -

(async) readCleartextMessage(options) → {CleartextMessage}

+

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

@@ -4315,9 +5006,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r String -| - -ReadableStream.<String> @@ -4418,7 +5106,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
Source:
@@ -4458,7 +5146,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
-CleartextMessage +Promise.<CleartextMessage>
@@ -4476,7 +5164,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r -

(async) readKey(options) → {Key}

+

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

@@ -4571,9 +5259,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r String -| - -ReadableStream.<String> @@ -4607,9 +5292,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r Uint8Array -| - -ReadableStream.<Uint8Array> @@ -4712,7 +5394,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
Source:
@@ -4752,7 +5434,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
-Key +Promise.<Key>
@@ -4770,7 +5452,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r -

(async) readKeys(options) → {Array.<Key>}

+

(async) readKeys(options) → {Promise.<Array.<Key>>}

@@ -4865,9 +5547,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r String -| - -ReadableStream.<String> @@ -4901,9 +5580,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r Uint8Array -| - -ReadableStream.<Uint8Array> @@ -5006,7 +5682,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
Source:
@@ -5046,7 +5722,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
-Array.<Key> +Promise.<Array.<Key>>
@@ -5064,7 +5740,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r -

(async) readMessage(options) → {Message}

+

(async) readMessage(options) → {Promise.<Message>}

@@ -5300,7 +5976,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
Source:
@@ -5340,7 +6016,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
-Message +Promise.<Message>
@@ -5358,7 +6034,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r -

(async) readSignature(options) → {Signature}

+

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

@@ -5453,9 +6129,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r String -| - -ReadableStream.<String> @@ -5489,9 +6162,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r Uint8Array -| - -ReadableStream.<Uint8Array> @@ -5594,7 +6264,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
Source:
@@ -5634,7 +6304,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
-Signature +Promise.<Signature>
@@ -5652,7 +6322,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r -

(async) reformatKey(options) → {Object}

+

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

@@ -5777,7 +6447,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r - userIds + userIDs @@ -5973,7 +6643,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
Source:
@@ -6014,7 +6684,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r
-Object +Promise.<Object>
@@ -6032,7 +6702,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r -

(async) revokeKey(options) → {Object}

+

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

@@ -6402,7 +7072,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
Source:
@@ -6444,7 +7114,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
-Object +Promise.<Object>
@@ -6462,7 +7132,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be -

(async) sign(options) → {String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>}

+

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

@@ -6665,54 +7335,6 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be - - - streaming - - - - - -'web' -| - -'ponyfill' -| - -'node' -| - -false - - - - - - - - - <optional>
- - - - - - - - - - - - type of stream `message` was created from, if any - - - - -

Whether to return data as a stream. Defaults to the type of stream message was created from, if any.

- - - - detached @@ -6754,13 +7376,13 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be - signingKeyIds + signingKeyIDs -Array.<module:type/keyid~Keyid> +Array.<module:type/keyid~KeyID> @@ -6786,7 +7408,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 privateKeys[i]

@@ -6832,7 +7454,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be - fromUserIds + fromUserIDs @@ -6951,7 +7573,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
Source:
@@ -6991,22 +7613,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be
-String -| - -ReadableStream.<String> -| - -NodeStream.<String> -| - -Uint8Array -| - -ReadableStream.<Uint8Array> -| - -NodeStream.<Uint8Array> +Promise.<(String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>)>
@@ -7024,7 +7631,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be -

(async) unarmor(input) → {Object}

+

(async) unarmor(input) → {Promise.<Object>}

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

Source:
@@ -7169,7 +7776,7 @@ an attribute "data" containing a stream of bytes and "type"
-Object +Promise.<Object>
@@ -7187,7 +7794,7 @@ an attribute "data" containing a stream of bytes and "type" -

(async) verify(options) → {Object}

+

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

@@ -7275,6 +7882,44 @@ an attribute "data" containing a stream of bytes and "type" + + + message + + + + + +CleartextMessage +| + +Message + + + + + + + + + + + + + + + + + + + + + +

(cleartext) message object with signatures

+ + + + publicKeys @@ -7315,16 +7960,13 @@ an attribute "data" containing a stream of bytes and "type" - message + expectSigned -CleartextMessage -| - -Message +Boolean @@ -7333,6 +7975,8 @@ an attribute "data" containing a stream of bytes and "type" + <optional>
+ @@ -7343,10 +7987,12 @@ an attribute "data" containing a stream of bytes and "type" + false + -

(cleartext) message object with signatures

+

If true, verification throws if the message is not signed with the provided publicKeys

@@ -7393,54 +8039,6 @@ an attribute "data" containing a stream of bytes and "type" - - - streaming - - - - - -'web' -| - -'ponyfill' -| - -'node' -| - -false - - - - - - - - - <optional>
- - - - - - - - - - - - type of stream `message` was created from, if any - - - - -

Whether to return data as a stream. Defaults to the type of stream message was created from, if any.

- - - - signature @@ -7599,7 +8197,7 @@ an attribute "data" containing a stream of bytes and "type"
Source:
@@ -7634,9 +8232,9 @@ an attribute "data" containing a stream of bytes and "type" data: Uint8Array|ReadableStream<Uint8Array>|NodeStream, (if `message` was a Message) signatures: [ { - keyid: module:type/keyid~Keyid, + keyID: module:type/keyid~KeyID, verified: Promise<Boolean>, - valid: Boolean (if `streaming` was false) + valid: Boolean (if `message` was not created from a stream) }, ... ] } @@ -7650,7 +8248,7 @@ an attribute "data" containing a stream of bytes and "type"
-Object +Promise.<Object>
@@ -7678,7 +8276,7 @@ an attribute "data" containing a stream of bytes and "type"
diff --git a/docs/index.html b/docs/index.html index 7aeeb83a..f475e984 100644 --- a/docs/index.html +++ b/docs/index.html @@ -208,9 +208,9 @@ library to convert back and forth between them.

  • The library implements the IETF proposal for authenticated encryption using native AES-EAX, OCB, or GCM. This makes symmetric encryption up to 30x faster on supported platforms. Since the specification has not been finalized and other OpenPGP implementations haven't adopted it yet, the feature is currently behind a flag. Note: activating this setting can break compatibility with other OpenPGP implementations, and also with future versions of OpenPGP.js. Don't use it with messages you want to store on disk or in a database. You can enable it by setting openpgp.config.aeadProtect = true.

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

    -
    openpgp.config.aeadMode = openpgp.enums.aead.eax // Default, native
-openpgp.config.aeadMode = openpgp.enums.aead.ocb // Non-native
-openpgp.config.aeadMode = openpgp.enums.aead.experimentalGcm // **Non-standard**, fastest
+
    openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.eax // Default, native
+openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.ocb // Non-native
+openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.experimentalGCM // **Non-standard**, fastest
  • @@ -243,7 +243,7 @@ openpgp.config.aeadMode = openpgp.enums.aead.experimentalGcm // **Non-standard**

    To test whether the lazy loading works, try to generate a key with a non-standard curve:

    import { generateKey } from 'openpgp/lightweight';
-await generateKey({ curve: 'brainpoolP512r1',  userIds: [{ name: 'Test', email: 'test@test.com' }] });
+await generateKey({ curve: 'brainpoolP512r1',  userIDs: [{ name: 'Test', email: 'test@test.com' }] });

    For more examples of how to generate a key, see Generate new key pair. It is recommended to use curve25519 instead of brainpoolP512r1 by default.

    Browser (plain files)

    @@ -259,9 +259,9 @@ import * as openpgp from './openpgp.min.mjs';

    Examples

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

    Encrypt and decrypt Uint8Array data with a password

    -

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

    +

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

    (async () => {
-    const message = openpgp.Message.fromBinary(new Uint8Array([0x01, 0x01, 0x01]));
+    const message = await openpgp.createMessage({ binary: new Uint8Array([0x01, 0x01, 0x01]) });
     const encrypted = await openpgp.encrypt({
         message, // input as Message object
         passwords: ['secret stuff'], // multiple passwords possible
@@ -296,11 +296,13 @@ import * as openpgp from './openpgp.min.mjs';
 
     const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
 
-    const privateKey = await openpgp.readKey({ armoredKey: privateKeyArmored });
-    await privateKey.decrypt(passphrase);
+    const privateKey = await openpgp.decryptKey({
+        privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }),
+        passphrase
+    });
 
     const encrypted = await openpgp.encrypt({
-        message: openpgp.Message.fromText('Hello, World!'), // input as Message object
+        message: await openpgp.createMessage({ text: 'Hello, World!' }), // input as Message object
         publicKeys: publicKey, // for encryption
         privateKeys: privateKey // for signing (optional)
     });
@@ -309,15 +311,16 @@ import * as openpgp from './openpgp.min.mjs';
     const message = await openpgp.readMessage({
         armoredMessage: encrypted // parse armored message
     });
-    const { data: decrypted } = await openpgp.decrypt({
+    const { data: decrypted, signatures } = await openpgp.decrypt({
         message,
         publicKeys: publicKey, // for verification (optional)
         privateKeys: privateKey // for decryption
     });
     console.log(decrypted); // 'Hello, World!'
+    console.log(signatures[0].valid) // signature validity (signed messages only)
 })();
    -

    Encrypt with multiple public keys:

    +

    Encrypt to multiple public keys:

    (async () => {
     const publicKeysArmored = [
         `-----BEGIN PGP PUBLIC KEY BLOCK-----
@@ -335,10 +338,12 @@ import * as openpgp from './openpgp.min.mjs';
 
     const publicKeys = await Promise.all(publicKeysArmored.map(armoredKey => openpgp.readKey({ armoredKey })));
 
-    const privateKey = await openpgp.readKey({ armoredKey: privateKeyArmored });
-    await privateKey.decrypt(passphrase)
+    const privateKey = await openpgp.decryptKey({
+        privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }),
+        passphrase
+    });
 
-    const message = openpgp.Message.fromText(message);
+    const message = await openpgp.createMessage({ text: message });
     const encrypted = await openpgp.encrypt({
         message:, // input as Message object
         publicKeys, // for encryption
@@ -347,25 +352,61 @@ import * as openpgp from './openpgp.min.mjs';
     console.log(encrypted); // '-----BEGIN PGP MESSAGE ... END PGP MESSAGE-----'
 })();
    -

    Encrypt with compression

    -

    By default, encrypt will not use any compression. It's possible to override that behavior in two ways:

    -

    Either set the compression parameter in the options object when calling encrypt.

    +

    If you expect an encrypted message to be signed with one of the public keys you have, and do not want to trust the decrypted data otherwise, you can pass the decryption option expectSigned = true, so that the decryption operation will fail if no valid signature is found:

    (async () => {
-    const message = openpgp.Message.fromBinary(new Uint8Array([0x01, 0x02, 0x03])); // or .fromText('string')
+    // put keys in backtick (``) to avoid errors caused by spaces or tabs
+    const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK-----
+...
+-----END PGP PUBLIC KEY BLOCK-----`;
+    const privateKeyArmored = `-----BEGIN PGP PRIVATE KEY BLOCK-----
+...
+-----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
+    const passphrase = `yourPassphrase`; // what the private key is encrypted with
+
+    const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
+
+    const privateKey = await openpgp.decryptKey({
+        privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }),
+        passphrase
+    });
+
+    const encryptedAndSignedMessage = `-----BEGIN PGP MESSAGE-----
+...
+-----END PGP MESSAGE-----`;
+
+    const message = await openpgp.readMessage({
+        armoredMessage: encryptedAndSignedMessage // parse armored message
+    });
+    // decryption will fail if all signatures are invalid or missing
+    const { data: decrypted, signatures } = await openpgp.decrypt({
+        message,
+        privateKeys: privateKey // for decryption
+        expectSigned: true,
+        publicKeys: publicKey, // for verification (mandatory with expectSigned=true)
+    });
+    console.log(decrypted); // 'Hello, World!'
+})();
+
    +

    Encrypt symmetrically with compression

    +

    By default, encrypt will not use any compression when encrypting symmetrically only (i.e. when no publicKeys are given). +It's possible to change that behaviour by enabling compression through the config, either for the single encryption:

    +
    (async () => {
+    const message = await openpgp.createMessage({ binary: new Uint8Array([0x01, 0x02, 0x03]) }); // or createMessage({ text: 'string' })
     const encrypted = await openpgp.encrypt({
         message,
         passwords: ['secret stuff'], // multiple passwords possible
-        compression: openpgp.enums.compression.zip // compress the data with zip
+        config: { preferredCompressionAlgorithm: openpgp.enums.compression.zlib } // compress the data with zlib
     });
 })();
    -

    Or, override the config to enable compression:

    -
    openpgp.config.compression = openpgp.enums.compression.zlib;
+
    or by changing the default global configuration:
    
+
    openpgp.config.preferredCompressionAlgorithm = openpgp.enums.compression.zlib
 
    
 
    Where the value can be any of:
    
 
      
 
    • openpgp.enums.compression.zip
      • 
 
    • openpgp.enums.compression.zlib
      • 
+
    • openpgp.enums.compression.uncompressed (default)
      • 
 
    
 
    Streaming encrypt Uint8Array data with a password
    
 
    (async () => {
@@ -376,7 +417,7 @@ import * as openpgp from './openpgp.min.mjs';
         }
     });
 
-    const message = openpgp.Message.fromBinary(readableStream);
+    const message = await openpgp.createMessage({ binary: readableStream });
     const encrypted = await openpgp.encrypt({
         message, // input as Message object
         passwords: ['secret stuff'], // multiple passwords possible
@@ -414,8 +455,10 @@ its Reader classReader class
     const { privateKeyArmored, publicKeyArmored, revocationCertificate } = await openpgp.generateKey({
         type: 'ecc', // Type of the key, defaults to ECC
         curve: 'curve25519', // ECC curve name, defaults to curve25519
-        userIds: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs
+        userIDs: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs
         passphrase: 'super long and hard to guess secret' // protects the private key
     });
 
@@ -467,7 +510,7 @@ and a subkey for encryption using Curve25519.
    
     const key = await openpgp.generateKey({
         type: 'rsa', // Type of the key
         rsaBits: 4096, // RSA key size (defaults to 4096 bits)
-        userIds: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs
+        userIDs: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs
         passphrase: 'super long and hard to guess secret' // protects the private key
     });
 })();
@@ -501,10 +544,12 @@ and a subkey for encryption using Curve25519.
    
 
     const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
 
-    const privateKey = await openpgp.readKey({ armoredKey: privateKeyArmored });
-    await privateKey.decrypt(passphrase);
+    const privateKey = await openpgp.decryptKey({
+        privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }),
+        passphrase
+    });
 
-    const unsignedMessage = openpgp.CleartextMessage.fromText('Hello, World!');
+    const unsignedMessage = await openpgp.createCleartextMessage({ text: 'Hello, World!' });
     const cleartextMessage = await openpgp.sign({
         message: unsignedMessage, // CleartextMessage or Message object
         privateKeys: privateKey // for signing
@@ -520,7 +565,7 @@ and a subkey for encryption using Curve25519.
    
     });
     const { valid } = verified.signatures[0];
     if (valid) {
-        console.log('signed by key id ' + verified.signatures[0].keyid.toHex());
+        console.log('signed by key id ' + verified.signatures[0].keyID.toHex());
     } else {
         throw new Error('signature could not be verified');
     }
@@ -538,10 +583,12 @@ and a subkey for encryption using Curve25519.
    
 
     const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored });
 
-    const privateKey = await openpgp.readKey({ armoredKey: privateKeyArmored });
-    await privateKey.decrypt(passphrase);
+    const privateKey = await openpgp.decryptKey({
+        privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }),
+        passphrase
+    });
 
-    const cleartextMessage = openpgp.CleartextMessage.fromText('Hello, World!');
+    const cleartextMessage = await openpgp.createCleartextMessage({ text: 'Hello, World!' });
     const detachedSignature = await openpgp.sign({
         message: cleartextMessage, // CleartextMessage or Message object
         privateKeys: privateKey, // for signing
@@ -559,7 +606,7 @@ and a subkey for encryption using Curve25519.
    
     });
     const { valid } = verified.signatures[0];
     if (valid) {
-        console.log('signed by key id ' + verified.signatures[0].keyid.toHex());
+        console.log('signed by key id ' + verified.signatures[0].keyID.toHex());
     } else {
         throw new Error('signature could not be verified');
     }
@@ -582,10 +629,12 @@ and a subkey for encryption using Curve25519.
    
 -----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key
     const passphrase = `yourPassphrase`; // what the private key is encrypted with
 
-    const privateKey = await openpgp.readKey({ armoredKey: privateKeyArmored });
-    await privateKey.decrypt(passphrase);
+    const privateKey = await openpgp.decryptKey({
+        privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }),
+        passphrase
+    });
 
-    const message = openpgp.Message.fromBinary(readableStream); // or .fromText(readableStream: ReadableStream<String>)
+    const message = await openpgp.createMessage({ binary: readableStream }); // or createMessage({ text: ReadableStream<String> })
     const signatureArmored = await openpgp.sign({
         message,
         privateKeys: privateKey // for signing
@@ -602,9 +651,9 @@ and a subkey for encryption using Curve25519.
    
     // even if you don't need it, as that is what triggers the
     // verification of the data.
 
-    const { valid } = verified.signatures[0];
+    const valid = await verified.signatures[0].verified;
     if (valid) {
-        console.log('signed by key id ' + verified.signatures[0].keyid.toHex());
+        console.log('signed by key id ' + verified.signatures[0].keyID.toHex());
     } else {
         throw new Error('signature could not be verified');
     }
@@ -638,7 +687,7 @@ and a subkey for encryption using Curve25519.
    
 
 
 
 
 
    
diff --git a/docs/module-config.html b/docs/module-config.html
index a11d39a7..8853f602 100644
--- a/docs/module-config.html
+++ b/docs/module-config.html
@@ -89,7 +89,7 @@
     
     
    Source:
    
     
    
     
 
@@ -247,124 +247,7 @@ Must be an integer value from 0 to 56.
    
     
     
    Source:
    
     
    
-    
-
-    
-
-    
-
-    
-
    • - - - - - - - - -

    (static) aeadMode

    - - - - -
    -

    Default Authenticated Encryption with Additional Data (AEAD) encryption mode -Only has an effect when aeadProtect is set to true.

    -
    - - - - - - - -
    Properties:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    aeadMode - - -Integer - - - -

    Default AEAD mode module:enums.aead

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

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

    Source:
    @@ -845,7 +728,7 @@ This setting is insecure if the partially decrypted message is
    Source:
    @@ -957,7 +840,7 @@ This setting is insecure if the partially decrypted message is
    Source:
    @@ -1069,119 +952,7 @@ This setting is insecure if the partially decrypted message is
    Source:
    - - - - - - - -
    - - - - - - - - -

    (static) compression

    - - - - - - - - - - -
    Properties:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    compression - - -Integer - - - -

    Default compression algorithm module:enums.compression

    - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Source:
    -
    @@ -1293,119 +1064,7 @@ This setting is insecure if the partially decrypted message is
    Source:
    - - - - - - - -
    - - - - - - - - -

    (static) encryptionCipher

    - - - - - - - - - - -
    Properties:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    encryptionCipher - - -Integer - - - -

    Default encryption cipher module:enums.symmetric

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

    Source:
    @@ -1540,13 +1199,13 @@ validation error when the notation is marked as critical.

    -

    (static) maxUseridLength

    +

    (static) maxUserIDLength

    -

    Max userid string length (used for parsing)

    +

    Max userID string length (used for parsing)

    @@ -1581,7 +1240,7 @@ validation error when the notation is marked as critical.

    - maxUseridLength + maxUserIDLength @@ -1638,7 +1297,7 @@ validation error when the notation is marked as critical.

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

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

    -

    (static) minRsaBits

    +

    (static) minRSABits

    @@ -1805,7 +1464,7 @@ validation error when the notation is marked as critical.

    - minRsaBits + minRSABits @@ -1821,7 +1480,7 @@ validation error when the notation is marked as critical.

    -

    Minimum RSA key size allowed for key generation

    +

    Minimum RSA key size allowed for key generation and message signing, verification and encryption

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

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

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

    -

    (static) preferHashAlgorithm

    +

    (static) preferredAEADAlgorithm

    + + + + +
    +

    Default Authenticated Encryption with Additional Data (AEAD) encryption mode +Only has an effect when aeadProtect is set to true.

    +
    + + + + + + + +
    Properties:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    preferredAEADAlgorithm + + +Integer + + + +

    Default AEAD mode module:enums.aead

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

    (static) preferredCompressionAlgorithm

    @@ -2034,7 +1810,119 @@ validation error when the notation is marked as critical.

    - preferHashAlgorithm + compression + + + + + +Integer + + + + + + + + + +

    Default compression algorithm module:enums.compression

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

    (static) preferredHashAlgorithm

    + + + + + + + + + + +
    Properties:
    + + + + + + + + + + + + + + + + + + + + + + + + + + - + + @@ -2203,7 +2207,7 @@ validation error when the notation is marked as critical.

    Source:
    @@ -2226,6 +2230,10 @@ validation error when the notation is marked as critical.

    +
    +

    Reject insecure message hash algorithms

    +
    + @@ -2258,7 +2266,7 @@ validation error when the notation is marked as critical.

    - + + @@ -2315,7 +2323,123 @@ validation error when the notation is marked as critical.

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

    (static) rejectPublicKeyAlgorithms

    + + + + +
    +

    Reject insecure public key algorithms for message encryption, signing or verification

    +
    + + + + + + + +
    Properties:
    + + + +
    NameTypeDescription
    preferredHashAlgorithm @@ -2091,7 +1979,119 @@ validation error when the notation is marked as critical.

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

    (static) preferredSymmetricAlgorithm

    + + + + + + + + + + +
    Properties:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    preferredSymmetricAlgorithm + + +Integer + + + +

    Default encryption cipher module:enums.symmetric

    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    @@ -2114,6 +2114,10 @@ validation error when the notation is marked as critical.

    +
    +

    Reject insecure hash algorithms

    +
    + @@ -2146,7 +2150,7 @@ validation error when the notation is marked as critical.

    reject_hash_algorithmsrejectHashAlgorithms @@ -2162,7 +2166,7 @@ validation error when the notation is marked as critical.

    -

    Reject insecure hash algorithms module:enums.hash

    module:enums.hash
    reject_message_hash_algorithmsrejectMessageHashAlgorithms @@ -2274,7 +2282,7 @@ validation error when the notation is marked as critical.

    -

    Reject insecure message hash algorithms module:enums.hash

    module:enums.hash
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    rejectPublicKeyAlgorithms + + +Set.<Integer> + + + +

    module:enums.publicKey

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

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

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

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

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

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

    Source:
    @@ -3110,7 +3234,7 @@ Note: not all OpenPGP implementations are compatible with this option.
    Source:
    @@ -3222,7 +3346,7 @@ Note: not all OpenPGP implementations are compatible with this option.
    Source:
    @@ -3256,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 4eb93e4c..685f8e8f 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 2ea46ca7..6994587d 100644 --- a/docs/module-enums.html +++ b/docs/module-enums.html @@ -155,7 +155,7 @@ - experimentalGcm + experimentalGCM @@ -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:
    @@ -3244,7 +3244,7 @@ possession of more than one person.

    - AEADEncryptedData + aeadEncryptedData @@ -3301,7 +3301,7 @@ possession of more than one person.

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

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

    - userIdInvalid + userIDInvalid @@ -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:
    @@ -5002,7 +5002,7 @@ document) that cannot include a target subpacket.

    - primaryUserId + primaryUserID @@ -5025,7 +5025,7 @@ document) that cannot include a target subpacket.

    - policyUri + policyURI @@ -5071,7 +5071,7 @@ document) that cannot include a target subpacket.

    - signersUserId + signersUserID @@ -5209,7 +5209,7 @@ document) that cannot include a target subpacket.

    - preferredAeadAlgorithms + preferredAEADAlgorithms @@ -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 c93c3df2..9281f167 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:
    @@ -611,7 +611,7 @@ -

    (async) getExpirationTime(primaryKey, date, configopt) → {Date|Infinity|null}

    +

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

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

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

    -Date -| - -Infinity -| - -null +Promise.<(Date|Infinity|null)>
    @@ -911,7 +905,7 @@ Returns null if the subkey is invalid.

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

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

    -

    getKeyId() → {module:type/keyid~Keyid}

    +

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

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

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

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

    -module:type/keyid~Keyid +module:type/keyid~KeyID
    @@ -1203,7 +1197,7 @@ Returns null if the subkey is invalid.

    -

    getKeyId() → {module:type/keyid~Keyid}

    +

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

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

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

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

    -module:type/keyid~Keyid +module:type/keyid~KeyID
    @@ -1379,7 +1373,7 @@ Returns null if the subkey is invalid.

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

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

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

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

    -

    (async) isRevoked(primaryKey, signature, key,, date, configopt) → {Boolean}

    +

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

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

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

    -Boolean +Promise.<Boolean>
    @@ -2095,7 +2089,7 @@ Returns null if the subkey is invalid.

    -

    (async) revoke(primaryKey, reasonForRevocation, date, configopt) → {SubKey}

    +

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

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

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

    -SubKey +Promise.<SubKey>
    @@ -2487,7 +2481,7 @@ Returns null if the subkey is invalid.

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

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

    -

    (async) verify(primaryKey, date, configopt) → {SignaturePacket}

    +

    (async) verify(primaryKey, date, configopt) → {Promise.<SignaturePacket>}

    @@ -2967,7 +2961,7 @@ and valid binding signature.

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

    -SignaturePacket +Promise.<SignaturePacket>
    @@ -3060,7 +3054,7 @@ and valid binding signature.


    diff --git a/docs/module-key_User-User.html b/docs/module-key_User-User.html index b5a809c3..c1c237b9 100644 --- a/docs/module-key_User-User.html +++ b/docs/module-key_User-User.html @@ -95,7 +95,7 @@
    Source:
    @@ -151,7 +151,7 @@ -

    (async) isRevoked(primaryKey, certificate, key,, date, config) → {Boolean}

    +

    (async) isRevoked(primaryKey, certificate, key,, date, config) → {Promise.<Boolean>}

    @@ -358,7 +358,7 @@
    Source:
    @@ -398,7 +398,7 @@
    -Boolean +Promise.<Boolean>
    @@ -416,7 +416,7 @@ -

    (async) sign(primaryKey, privateKeys, config) → {Key}

    +

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

    @@ -568,7 +568,7 @@
    Source:
    @@ -608,7 +608,7 @@
    -Key +Promise.<Key>
    @@ -680,7 +680,7 @@
    Source:
    @@ -734,7 +734,7 @@ -

    (async) update(user, primaryKey, config) → {undefined}

    +

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

    @@ -886,7 +886,7 @@
    Source:
    @@ -922,7 +922,7 @@
    -undefined +Promise.<undefined>
    @@ -940,7 +940,7 @@ -

    (async) verify(primaryKey, date, config) → {true}

    +

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

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

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

    -true +Promise.<true>
    @@ -1180,7 +1180,7 @@ and validity of self signature.

    -

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

    +

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

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

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

    -

    List of signer's keyid and validity of signature

    +

    List of signer's keyID and validity of signature

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

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

    -

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

    +

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

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

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

    -true -| - -null +Promise.<(true|null)>
    @@ -1682,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 fde87145..776a22fc 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 similarity index 65% rename from docs/module-type_keyid-Keyid.html rename to docs/module-type_keyid-KeyID.html index 84d082ba..c3f8882a 100644 --- a/docs/module-type_keyid-Keyid.html +++ b/docs/module-type_keyid-KeyID.html @@ -2,7 +2,7 @@ - JSDoc: Class: Keyid + JSDoc: Class: KeyID @@ -17,7 +17,7 @@
    -

    Class: Keyid

    +

    Class: KeyID

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

    Keyid()

    +

    KeyID()

    Implementation of type key id

    RFC4880 3.3: @@ -50,7 +50,7 @@ formed.

    -

    new Keyid()

    +

    new KeyID()

    @@ -100,7 +100,7 @@ formed.

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

    -

    equals(keyid, matchWildcard)

    +

    equals(keyID, matchWildcard)

    @@ -202,13 +202,13 @@ formed.

    - keyid + keyID -Keyid +KeyID @@ -251,7 +251,7 @@ formed.

    -

    Indicates whether to check if either keyid is a wildcard

    +

    Indicates whether to check if either keyID is a wildcard

    @@ -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 5c004e97..686f612e 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:
    @@ -496,7 +496,7 @@ -

    (async) produce_key(passphrase) → {Uint8Array}

    +

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

    @@ -600,7 +600,7 @@ hashAlgorithm

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

    -Uint8Array +Promise.<Uint8Array>
    @@ -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 5af0f77c..984a37fb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "openpgp", - "version": "5.0.0-1", + "version": "5.0.0-2", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 47181903..d44f0051 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-1", + "version": "5.0.0-2", "license": "LGPL-3.0+", "homepage": "https://openpgpjs.org/", "engines": {