suzanne.soy/fork-openpgpjs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revert "Don't mark async function as returning a Promise explicitly"

Browse Source 
This reverts commit 9e85f75519.

It made VS Code / TypeScript complain about unnecessary `await`s.
This commit is contained in:
Daniel Huigens 2021-03-28 15:39:19 +02:00
parent b8c07d6343
commit e3cfa4f9dd
23 changed files with 98 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/cleartext.js
View File

@ -65,7 +65,7 @@ export class CleartextMessage {
* @param {Date} [date] - The creation time of the signature that should be created
* @param {Array} [userIDs] - User IDs to sign with, e.g. [{ name:'Steve Sender', email:'steve@openpgp.org' }]
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {CleartextMessage} New cleartext message with signed content.
* @returns {Promise<CleartextMessage>} New cleartext message with signed content.
* @async
*/
async sign(privateKeys, signature = null, signingKeyIDs = [], date = new Date(), userIDs = [], config = defaultConfig) {
@ -80,9 +80,11 @@ export class CleartextMessage {
* @param {Array<Key>} keys - Array of keys to verify signatures
* @param {Date} [date] - Verify the signature against the given date, i.e. check signature creation time < date < expiration time
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Array<{keyID: module:type/keyid~KeyID,
* signature: Promise<Signature>,
* verified: Promise<Boolean>}>} List of signer's keyID and validity of signature.
* @returns {Promise<Array<{
* keyID: module:type/keyid~KeyID,
* signature: Promise<Signature>,
* verified: Promise<Boolean>
* }>>} List of signer's keyID and validity of signature.
* @async
*/
verify(keys, date = new Date(), config = defaultConfig) {

2
src/crypto/crypto.js
View File

@ -298,7 +298,7 @@ export function generateParams(algo, bits, oid) {
* @param {module:enums.publicKey} algo - The public key algorithm
* @param {Object} publicParams - Algorithm-specific public key parameters
* @param {Object} privateParams - Algorithm-specific private key parameters
* @returns {Boolean} Whether the parameters are valid.
* @returns {Promise<Boolean>} Whether the parameters are valid.
* @async
*/
export async function validateParams(algo, publicParams, privateParams) {

3
src/crypto/hash/index.js
View File

@ -106,8 +106,7 @@ export default {
* Create a hash on the specified data using the specified algorithm
* @param {module:enums.hash} algo - Hash algorithm type (see {@link https://tools.ietf.org/html/rfc4880#section-9.4|RFC 4880 9.4})
* @param {Uint8Array} data - Data to be hashed
* @returns {Uint8Array} Hash value.
* @async
* @returns {Promise<Uint8Array>} Hash value.
*/
digest: function(algo, data) {
switch (algo) {

6
src/crypto/mode/eax.js
View File

@ -96,8 +96,7 @@ async function EAX(cipher, key) {
* @param {Uint8Array} plaintext - The cleartext input to be encrypted
* @param {Uint8Array} nonce - The nonce (16 bytes)
* @param {Uint8Array} adata - Associated data to sign
* @returns {Uint8Array} The ciphertext output.
* @async
* @returns {Promise<Uint8Array>} The ciphertext output.
*/
encrypt: async function(plaintext, nonce, adata) {
const [
@ -121,8 +120,7 @@ async function EAX(cipher, key) {
* @param {Uint8Array} ciphertext - The ciphertext input to be decrypted
* @param {Uint8Array} nonce - The nonce (16 bytes)
* @param {Uint8Array} adata - Associated data to verify
* @returns {Uint8Array} The plaintext output.
* @async
* @returns {Promise<Uint8Array>} The plaintext output.
*/
decrypt: async function(ciphertext, nonce, adata) {
if (ciphertext.length < tagLength) throw new Error('Invalid EAX ciphertext');

8
src/crypto/mode/ocb.js
View File

@ -136,7 +136,7 @@ async function OCB(cipher, key) {
* @param {Uint8Array} text - The cleartext or ciphertext (without tag) input
* @param {Uint8Array} nonce - The nonce (15 bytes)
* @param {Uint8Array} adata - Associated data to sign
* @returns {Uint8Array} The ciphertext or plaintext output, with tag appended in both cases.
* @returns {Promise<Uint8Array>} The ciphertext or plaintext output, with tag appended in both cases.
*/
function crypt(fn, text, nonce, adata) {
//
@ -223,8 +223,7 @@ async function OCB(cipher, key) {
* @param {Uint8Array} plaintext - The cleartext input to be encrypted
* @param {Uint8Array} nonce - The nonce (15 bytes)
* @param {Uint8Array} adata - Associated data to sign
* @returns {Uint8Array} The ciphertext output.
* @async
* @returns {Promise<Uint8Array>} The ciphertext output.
*/
encrypt: async function(plaintext, nonce, adata) {
return crypt(encipher, plaintext, nonce, adata);
@ -235,8 +234,7 @@ async function OCB(cipher, key) {
* @param {Uint8Array} ciphertext - The ciphertext input to be decrypted
* @param {Uint8Array} nonce - The nonce (15 bytes)
* @param {Uint8Array} adata - Associated data to sign
* @returns {Uint8Array} The ciphertext output.
* @async
* @returns {Promise<Uint8Array>} The ciphertext output.
*/
decrypt: async function(ciphertext, nonce, adata) {
if (ciphertext.length < tagLength) throw new Error('Invalid OCB ciphertext');

2
src/crypto/pkcs1.js
View File

@ -71,7 +71,7 @@ async function getPKCS1Padding(length) {
* @see {@link https://tools.ietf.org/html/rfc4880#section-13.1.1|RFC 4880 13.1.1}
* @param {Uint8Array} message - Message to be encoded
* @param {Integer} keyLength - The length in octets of the key modulus
* @returns {Uint8Array} EME-PKCS1 padded message.
* @returns {Promise<Uint8Array>} EME-PKCS1 padded message.
* @async
*/
export async function emeEncode(message, keyLength) {

2
src/crypto/public_key/dsa.js
View File

@ -140,7 +140,7 @@ export async function verify(hashAlgo, r, s, hashed, g, p, q, y) {
* @param {Uint8Array} g - DSA sub-group generator
* @param {Uint8Array} y - DSA public key
* @param {Uint8Array} x - DSA private key
* @returns {Boolean} Whether params are valid.
* @returns {Promise<Boolean>} Whether params are valid.
* @async
*/
export async function validateParams(p, q, g, y, x) {

2
src/crypto/public_key/elgamal.js
View File

@ -79,7 +79,7 @@ export async function decrypt(c1, c2, p, x) {
* @param {Uint8Array} g - ElGamal group generator
* @param {Uint8Array} y - ElGamal public key
* @param {Uint8Array} x - ElGamal private exponent
* @returns {Boolean} Whether params are valid.
* @returns {Promise<Boolean>} Whether params are valid.
* @async
*/
export async function validateParams(p, g, y, x) {

2
src/crypto/public_key/elliptic/curves.js
View File

@ -231,7 +231,7 @@ function getPreferredHashAlgo(oid) {
* @param {module:type/oid} oid - EC object identifier
* @param {Uint8Array} Q - EC public point
* @param {Uint8Array} d - EC secret scalar
* @returns {Boolean} Whether params are valid.
* @returns {Promise<Boolean>} Whether params are valid.
* @async
*/
async function validateStandardParams(algo, oid, Q, d) {

22
src/crypto/public_key/elliptic/ecdh.js
View File

@ -41,7 +41,7 @@ const nodeCrypto = util.getNodeCrypto();
* @param {module:type/oid} oid - Elliptic curve object identifier
* @param {Uint8Array} Q - ECDH public point
* @param {Uint8Array} d - ECDH secret scalar
* @returns {Boolean} Whether params are valid.
* @returns {Promise<Boolean>} Whether params are valid.
* @async
*/
export async function validateParams(oid, Q, d) {
@ -88,7 +88,7 @@ async function kdf(hashAlgo, X, length, param, stripLeading = false, stripTraili
*
* @param {Curve} curve - Elliptic curve object
* @param {Uint8Array} Q - Recipient public key
* @returns {{publicKey: Uint8Array, sharedKey: Uint8Array}}
* @returns {Promise<{publicKey: Uint8Array, sharedKey: Uint8Array}>}
* @async
*/
async function genPublicEphemeralKey(curve, Q) {
@ -123,7 +123,7 @@ async function genPublicEphemeralKey(curve, Q) {
* @param {Uint8Array} data - Unpadded session key data
* @param {Uint8Array} Q - Recipient public key
* @param {Uint8Array} fingerprint - Recipient fingerprint
* @returns {{publicKey: Uint8Array, wrappedKey: Uint8Array}}
* @returns {Promise<{publicKey: Uint8Array, wrappedKey: Uint8Array}>}
* @async
*/
export async function encrypt(oid, kdfParams, data, Q, fingerprint) {
@ -145,7 +145,7 @@ export async function encrypt(oid, kdfParams, data, Q, fingerprint) {
* @param {Uint8Array} V - Public part of ephemeral key
* @param {Uint8Array} Q - Recipient public key
* @param {Uint8Array} d - Recipient private key
* @returns {{secretKey: Uint8Array, sharedKey: Uint8Array}}
* @returns {Promise<{secretKey: Uint8Array, sharedKey: Uint8Array}>}
* @async
*/
async function genPrivateEphemeralKey(curve, V, Q, d) {
@ -185,7 +185,7 @@ async function genPrivateEphemeralKey(curve, V, Q, d) {
* @param {Uint8Array} Q - Recipient public key
* @param {Uint8Array} d - Recipient private key
* @param {Uint8Array} fingerprint - Recipient fingerprint
* @returns {Uint8Array} Value derived from session key.
* @returns {Promise<Uint8Array>} Value derived from session key.
* @async
*/
export async function decrypt(oid, kdfParams, V, C, Q, d, fingerprint) {
@ -213,7 +213,7 @@ export async function decrypt(oid, kdfParams, V, C, Q, d, fingerprint) {
* @param {Uint8Array} V - Public part of ephemeral key
* @param {Uint8Array} Q - Recipient public key
* @param {Uint8Array} d - Recipient private key
* @returns {{secretKey: Uint8Array, sharedKey: Uint8Array}}
* @returns {Promise<{secretKey: Uint8Array, sharedKey: Uint8Array}>}
* @async
*/
async function webPrivateEphemeralKey(curve, V, Q, d) {
@ -264,7 +264,7 @@ async function webPrivateEphemeralKey(curve, V, Q, d) {
*
* @param {Curve} curve - Elliptic curve object
* @param {Uint8Array} Q - Recipient public key
* @returns {{publicKey: Uint8Array, sharedKey: Uint8Array}}
* @returns {Promise<{publicKey: Uint8Array, sharedKey: Uint8Array}>}
* @async
*/
async function webPublicEphemeralKey(curve, Q) {
@ -313,7 +313,7 @@ async function webPublicEphemeralKey(curve, Q) {
* @param {Curve} curve - Elliptic curve object
* @param {Uint8Array} V - Public part of ephemeral key
* @param {Uint8Array} d - Recipient private key
* @returns {{secretKey: Uint8Array, sharedKey: Uint8Array}}
* @returns {Promise<{secretKey: Uint8Array, sharedKey: Uint8Array}>}
* @async
*/
async function ellipticPrivateEphemeralKey(curve, V, d) {
@ -332,7 +332,7 @@ async function ellipticPrivateEphemeralKey(curve, V, d) {
*
* @param {Curve} curve - Elliptic curve object
* @param {Uint8Array} Q - Recipient public key
* @returns {{publicKey: Uint8Array, sharedKey: Uint8Array}}
* @returns {Promise<{publicKey: Uint8Array, sharedKey: Uint8Array}>}
* @async
*/
async function ellipticPublicEphemeralKey(curve, Q) {
@ -353,7 +353,7 @@ async function ellipticPublicEphemeralKey(curve, Q) {
* @param {Curve} curve - Elliptic curve object
* @param {Uint8Array} V - Public part of ephemeral key
* @param {Uint8Array} d - Recipient private key
* @returns {{secretKey: Uint8Array, sharedKey: Uint8Array}}
* @returns {Promise<{secretKey: Uint8Array, sharedKey: Uint8Array}>}
* @async
*/
async function nodePrivateEphemeralKey(curve, V, d) {
@ -369,7 +369,7 @@ async function nodePrivateEphemeralKey(curve, V, d) {
*
* @param {Curve} curve - Elliptic curve object
* @param {Uint8Array} Q - Recipient public key
* @returns {{publicKey: Uint8Array, sharedKey: Uint8Array}}
* @returns {Promise<{publicKey: Uint8Array, sharedKey: Uint8Array}>}
* @async
*/
async function nodePublicEphemeralKey(curve, Q) {

2
src/crypto/public_key/elliptic/ecdsa.js
View File

@ -119,7 +119,7 @@ export async function verify(oid, hashAlgo, signature, message, publicKey, hashe
* @param {module:type/oid} oid - Elliptic curve object identifier
* @param {Uint8Array} Q - EcDSA public point
* @param {Uint8Array} d - EcDSA secret scalar
* @returns {Boolean} Whether params are valid.
* @returns {Promise<Boolean>} Whether params are valid.
* @async
*/
export async function validateParams(oid, Q, d) {

2
src/crypto/public_key/elliptic/eddsa.js
View File

@ -76,7 +76,7 @@ export async function verify(oid, hashAlgo, { r, s }, m, publicKey, hashed) {
* @param {module:type/oid} oid - Elliptic curve object identifier
* @param {Uint8Array} Q - EdDSA public point
* @param {Uint8Array} k - EdDSA secret seed
* @returns {Boolean} Whether params are valid.
* @returns {Promise<Boolean>} Whether params are valid.
* @async
*/
export async function validateParams(oid, Q, k) {

2
src/crypto/public_key/rsa.js
View File

@ -288,7 +288,7 @@ export async function generate(bits, e) {
* @param {Uint8Array} p - RSA private prime p
* @param {Uint8Array} q - RSA private prime q
* @param {Uint8Array} u - RSA inverse of p w.r.t. q
* @returns {Boolean} Whether params are valid.
* @returns {Promise<Boolean>} Whether params are valid.
* @async
*/
export async function validateParams(n, e, d, p, q, u) {

2
src/encoding/armor.js
View File

@ -223,7 +223,7 @@ function splitChecksum(text) {
* Dearmor an OpenPGP armored message; verify the checksum and return
* the encoded bytes
* @param {String} input - OpenPGP armored message
* @returns {Object} An object with attribute "text" containing the message text,
* @returns {Promise<Object>} An object with attribute "text" containing the message text,
* an attribute "data" containing a stream of bytes and "type" for the ASCII armor type
* @async
* @static

8
src/key/factory.js
View File

@ -56,7 +56,7 @@ const allowedKeyPackets = /*#__PURE__*/ util.constructAllowedPackets([
* @param {Object} config - Full configuration
* @param {Array<Object>} options.subkeys (optional) options for each subkey, default to main key options. e.g. [{sign: true, passphrase: '123'}]
* sign parameter defaults to false, and indicates whether the subkey should sign rather than encrypt
* @returns {Key}
* @returns {Promise<Key>}
* @async
* @static
* @private
@ -80,7 +80,7 @@ export async function generate(options, config) {
* @param {Array<Object>} options.subkeys (optional) options for each subkey, default to main key options. e.g. [{sign: true, passphrase: '123'}]
* @param {Object} config - Full configuration
*
* @returns {Key}
* @returns {Promise<Key>}
* @async
* @static
* @private
@ -256,7 +256,7 @@ async function wrapKeyObject(secretKeyPacket, secretSubkeyPackets, options, conf
* @param {String} [options.armoredKey] - Armored key to be parsed
* @param {Uint8Array} [options.binaryKey] - Binary key to be parsed
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Key} Key object.
* @returns {Promise<Key>} Key object.
* @async
* @static
*/
@ -292,7 +292,7 @@ export async function readKey({ armoredKey, binaryKey, config }) {
* @param {String} [options.armoredKeys] - Armored keys to be parsed
* @param {Uint8Array} [options.binaryKeys] - Binary keys to be parsed
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Array<Key>} Key objects.
* @returns {Promise<Array<Key>>} Key objects.
* @async
* @static
*/

13
src/key/helper.js
View File

@ -37,7 +37,7 @@ export async function generateSecretKey(options, config) {
* @param {Array<SignaturePacket>} signatures - List of signatures
* @param {Date} date - Use the given date instead of the current time
* @param {Object} config - full configuration
* @returns {SignaturePacket} The latest valid signature.
* @returns {Promise<SignaturePacket>} The latest valid signature.
* @async
*/
export async function getLatestValidSignature(signatures, primaryKey, signatureType, dataToVerify, date = new Date(), config) {
@ -116,7 +116,7 @@ export async function createBindingSignature(subkey, primaryKey, options, config
* @param {Date} [date] - Use the given date for verification instead of the current time
* @param {Object} [userID] - User ID
* @param {Object} config - full configuration
* @returns {String}
* @returns {Promise<String>}
* @async
*/
export async function getPreferredHashAlgo(key, keyPacket, date = new Date(), userID = {}, config) {
@ -153,7 +153,7 @@ export async function getPreferredHashAlgo(key, keyPacket, date = new Date(), us
* @param {Date} [date] - Use the given date for verification instead of the current time
* @param {Array} [userIDs] - User IDs
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {module:enums.symmetric|aead|compression} Preferred algorithm
* @returns {Promise<module:enums.symmetric|aead|compression>} Preferred algorithm
* @async
*/
export async function getPreferredAlgo(type, keys = [], date = new Date(), userIDs = [], config = defaultConfig) {
@ -194,8 +194,7 @@ export async function getPreferredAlgo(type, keys = [], date = new Date(), userI
* @param {Object} [userID] - User ID
* @param {Object} [detached] - Whether to create a detached signature packet
* @param {Object} config - full configuration
* @returns {SignaturePacket} Signature packet.
* @async
* @returns {Promise<SignaturePacket>} Signature packet.
*/
export async function createSignaturePacket(dataToSign, privateKey, signingKeyPacket, signatureProperties, date, userID, detached = false, config) {
if (signingKeyPacket.isDummy()) {
@ -250,7 +249,7 @@ export async function mergeSignatures(source, dest, attr, checkFn) {
* SecretKeyPacket} key, optional The key packet to check the signature
* @param {Date} date - Use the given date instead of the current time
* @param {Object} config - Full configuration
* @returns {Boolean} True if the signature revokes the data.
* @returns {Promise<Boolean>} True if the signature revokes the data.
* @async
*/
export async function isDataRevoked(primaryKey, signatureType, dataToVerify, revocations, signature, key, date = new Date(), config) {
@ -302,7 +301,7 @@ export function getExpirationTime(keyPacket, signature) {
* @param {Date} [date] - Use the given date for verification instead of the current time
* @param {Array} [userIDs] - User IDs
* @param {Object} config - full configuration
* @returns {Boolean}
* @returns {Promise<Boolean>}
* @async
*/
export async function isAEADSupported(keys, date = new Date(), userIDs = [], config = defaultConfig) {

26
src/key/key.js
View File

@ -159,7 +159,7 @@ class Key {
/**
* Clones the key object
* @returns {Key} Shallow clone of the key.
* @returns {Promise<Key>} Shallow clone of the key.
* @async
*/
async clone() {
@ -286,7 +286,7 @@ class Key {
* @param {Date} [date] - Use the given date for verification instead of the current time
* @param {Object} userID, optional user ID
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Key|SubKey|null} Key or null if no signing key has been found.
* @returns {Promise<Key|SubKey|null>} Key or null if no signing key has been found.
* @async
*/
async getSigningKey(keyID = null, date = new Date(), userID = {}, config = defaultConfig) {
@ -339,7 +339,7 @@ class Key {
* @param {Date} date, optional
* @param {String} userID, optional
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Key|SubKey|null} Key or null if no encryption key has been found.
* @returns {Promise<Key|SubKey|null>} Key or null if no encryption key has been found.
* @async
*/
async getEncryptionKey(keyID, date = new Date(), userID = {}, config = defaultConfig) {
@ -385,7 +385,7 @@ class Key {
* @param {Date} date, optional
* @param {String} userID, optional
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Array<Key|SubKey>} Array of decryption keys.
* @returns {Promise<Array<Key|SubKey>>} Array of decryption keys.
* @async
*/
async getDecryptionKeys(keyID, date = new Date(), userID = {}, config = defaultConfig) {
@ -551,7 +551,7 @@ class Key {
* SecretKeyPacket} key, optional The key to verify the signature
* @param {Date} date - Use the given date instead of the current time
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Boolean} True if the certificate is revoked.
* @returns {Promise<Boolean>} True if the certificate is revoked.
* @async
*/
async isRevoked(signature, key, date = new Date(), config = defaultConfig) {
@ -592,7 +592,7 @@ class Key {
* @param {module:type/keyid~KeyID} keyID, optional
* @param {Object} userID, optional user ID
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Date | Infinity | null}
* @returns {Promise<Date | Infinity | null>}
* @async
*/
async getExpirationTime(capabilities, keyID, userID, config = defaultConfig) {
@ -683,7 +683,7 @@ class Key {
* the destination key is transformed to a private key.
* @param {Key} key - Source key to merge
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {undefined}
* @returns {Promise<undefined>}
* @async
*/
async update(key, config = defaultConfig) {
@ -748,7 +748,7 @@ class Key {
* @param {String} reasonForRevocation.string optional, string explaining the reason for revocation
* @param {Date} date - optional, override the creationtime of the revocation signature
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Key} New key with revocation signature.
* @returns {Promise<Key>} New key with revocation signature.
* @async
*/
async revoke(
@ -777,7 +777,7 @@ class Key {
* (To get a revocation certificate for an unrevoked key, call revoke() first.)
* @param {Date} date - Use the given date instead of the current time
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {String} Armored revocation certificate.
* @returns {Promise<String>} Armored revocation certificate.
* @async
*/
async getRevocationCertificate(date = new Date(), config = defaultConfig) {
@ -794,7 +794,7 @@ class Key {
* if it is a valid revocation signature.
* @param {String} revocationCertificate - armored revocation certificate
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Key} New revoked key.
* @returns {Promise<Key>} New revoked key.
* @async
*/
async applyRevocationCertificate(revocationCertificate, config = defaultConfig) {
@ -827,7 +827,7 @@ class Key {
* @param {Date} [date] - Use the given date for verification instead of the current time
* @param {Object} [userID] - User ID to get instead of the primary user, if it exists
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Key} New public key with new certificate signature.
* @returns {Promise<Key>} New public key with new certificate signature.
* @async
*/
async signPrimaryUser(privateKeys, date, userID, config = defaultConfig) {
@ -842,7 +842,7 @@ class Key {
* Signs all users of key
* @param {Array<Key>} privateKeys - decrypted private keys for signing
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Key} New public key with new certificate signature.
* @returns {Promise<Key>} New public key with new certificate signature.
* @async
*/
async signAllUsers(privateKeys, config = defaultConfig) {
@ -912,7 +912,7 @@ class Key {
* @param {Date} options.date (optional) Override the creation date of the key and the key signatures
* @param {Boolean} options.sign (optional) Indicates whether the subkey should sign rather than encrypt. Defaults to false
* @param {Object} options.config (optional) custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Key}
* @returns {Promise<Key>}
* @async
*/
async addSubkey(options = {}) {

8
src/key/subkey.js
View File

@ -50,7 +50,7 @@ class SubKey {
* SecretKeyPacket} key, optional The key to verify the signature
* @param {Date} date - Use the given date instead of the current time
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Boolean} True if the binding signature is revoked.
* @returns {Promise<Boolean>} True if the binding signature is revoked.
* @async
*/
async isRevoked(primaryKey, signature, key, date = new Date(), config = defaultConfig) {
@ -69,7 +69,7 @@ class SubKey {
* PublicKeyPacket} primaryKey The primary key packet
* @param {Date} date - Use the given date instead of the current time
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {SignaturePacket}
* @returns {Promise<SignaturePacket>}
* @throws {Error} if the subkey is invalid.
* @async
*/
@ -95,7 +95,7 @@ class SubKey {
* PublicKeyPacket} primaryKey The primary key packet
* @param {Date} date - Use the given date instead of the current time
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Date | Infinity | null}
* @returns {Promise<Date | Infinity | null>}
* @async
*/
async getExpirationTime(primaryKey, date = new Date(), config = defaultConfig) {
@ -162,7 +162,7 @@ class SubKey {
* @param {String} reasonForRevocation.string optional, string explaining the reason for revocation
* @param {Date} date - optional, override the creationtime of the revocation signature
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {SubKey} New subkey with revocation signature.
* @returns {Promise<SubKey>} New subkey with revocation signature.
* @async
*/
async revoke(

10
src/key/user.js
View File

@ -42,7 +42,7 @@ class User {
* PublicKeyPacket} primaryKey The primary key packet
* @param {Array<Key>} privateKeys - Decrypted private keys for signing
* @param {Object} config - Full configuration
* @returns {Key} New user with new certificate signatures.
* @returns {Promise<Key>} New user with new certificate signatures.
* @async
*/
async sign(primaryKey, privateKeys, config) {
@ -81,7 +81,7 @@ class User {
* SecretKeyPacket} key, optional The key to verify the signature
* @param {Date} date - Use the given date instead of the current time
* @param {Object} config - Full configuration
* @returns {Boolean} True if the certificate is revoked.
* @returns {Promise<Boolean>} True if the certificate is revoked.
* @async
*/
async isRevoked(primaryKey, certificate, key, date = new Date(), config) {
@ -102,7 +102,7 @@ class User {
* @param {Array<Key>} keys - Array of keys to verify certificate signatures
* @param {Date} date - Use the given date instead of the current time
* @param {Object} config - Full configuration
* @returns {true|null} Status of the certificate.
* @returns {Promise<true|null>} Status of the certificate.
* @async
*/
async verifyCertificate(primaryKey, certificate, keys, date = new Date(), config) {
@ -163,7 +163,7 @@ class User {
* PublicKeyPacket} primaryKey The primary key packet
* @param {Date} date - Use the given date instead of the current time
* @param {Object} config - Full configuration
* @returns {true} Status of user.
* @returns {Promise<true>} Status of user.
* @throws {Error} if there are no valid self signatures.
* @async
*/
@ -207,7 +207,7 @@ class User {
* @param {SecretKeyPacket|
* SecretSubkeyPacket} primaryKey primary key used for validation
* @param {Object} config - Full configuration
* @returns {undefined}
* @returns {Promise<undefined>}
* @async
*/
async update(user, primaryKey, config) {

32
src/message.js
View File

@ -108,7 +108,7 @@ export class Message {
* @param {Array<String>} [passwords] - Passwords used to decrypt
* @param {Array<Object>} [sessionKeys] - Session keys in the form: { data:Uint8Array, algorithm:String, [aeadAlgorithm:String] }
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Message} New message with decrypted content.
* @returns {Promise<Message>} New message with decrypted content.
* @async
*/
async decrypt(privateKeys, passwords, sessionKeys, config = defaultConfig) {
@ -294,7 +294,7 @@ export class Message {
* @param {Date} [date] - Date to select algorithm preferences at
* @param {Array<Object>} [userIDs] - User IDs to select algorithm preferences for
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {{ data: Uint8Array, algorithm: String }} Object with session key data and algorithm.
* @returns {Promise<{ data: Uint8Array, algorithm: String }>} Object with session key data and algorithm.
* @async
*/
static async generateSessionKey(keys = [], date = new Date(), userIDs = [], config = defaultConfig) {
@ -317,7 +317,7 @@ export class Message {
* @param {Date} [date] - Override the creation date of the literal package
* @param {Array<Object>} [userIDs] - User IDs to encrypt for, e.g. [{ name:'Robert Receiver', email:'robert@openpgp.org' }]
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Message} New message with encrypted content.
* @returns {Promise<Message>} New message with encrypted content.
* @async
*/
async encrypt(keys, passwords, sessionKey, wildcard = false, encryptionKeyIDs = [], date = new Date(), userIDs = [], config = defaultConfig) {
@ -365,7 +365,7 @@ export class Message {
* @param {Date} [date] - Override the date
* @param {Array} [userIDs] - User IDs to encrypt for, e.g. [{ name:'Robert Receiver', email:'robert@openpgp.org' }]
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Message} New message with encrypted content.
* @returns {Promise<Message>} New message with encrypted content.
* @async
*/
static async encryptSessionKey(sessionKey, algorithm, aeadAlgorithm, publicKeys, passwords, wildcard = false, encryptionKeyIDs = [], date = new Date(), userIDs = [], config = defaultConfig) {
@ -432,7 +432,7 @@ export class Message {
* @param {Date} [date] - Override the creation time of the signature
* @param {Array} [userIDs] - User IDs to sign with, e.g. [{ name:'Steve Sender', email:'steve@openpgp.org' }]
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Message} New message with signed content.
* @returns {Promise<Message>} New message with signed content.
* @async
*/
async sign(privateKeys = [], signature = null, signingKeyIDs = [], date = new Date(), userIDs = [], config = defaultConfig) {
@ -519,7 +519,7 @@ export class Message {
* @param {Date} [date] - Override the creation time of the signature
* @param {Array} [userIDs] - User IDs to sign with, e.g. [{ name:'Steve Sender', email:'steve@openpgp.org' }]
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Signature} New detached signature of message content.
* @returns {Promise<Signature>} New detached signature of message content.
* @async
*/
async signDetached(privateKeys = [], signature = null, signingKeyIds = [], date = new Date(), userIDs = [], config = defaultConfig) {
@ -535,9 +535,11 @@ export class Message {
* @param {Array<Key>} keys - Array of keys to verify signatures
* @param {Date} [date] - Verify the signature against the given date, i.e. check signature creation time < date < expiration time
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Array<{keyID: module:type/keyid~KeyID,
* signature: Promise<Signature>,
* verified: Promise<Boolean>}>} List of signer's keyID and validity of signatures.
* @returns {Promise<Array<{
* keyID: module:type/keyid~KeyID,
* signature: Promise<Signature>,
* verified: Promise<Boolean>
* }>>} List of signer's keyID and validity of signatures.
* @async
*/
async verify(keys, date = new Date(), config = defaultConfig) {
@ -590,9 +592,11 @@ export class Message {
* @param {Signature} signature
* @param {Date} date - Verify the signature against the given date, i.e. check signature creation time < date < expiration time
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Array<{keyID: module:type/keyid~KeyID,
* signature: Promise<Signature>,
* verified: Promise<Boolean>}>} List of signer's keyID and validity of signature.
* @returns {Promise<Array<{
* keyID: module:type/keyid~KeyID,
* signature: Promise<Signature>,
* verified: Promise<Boolean>
* }>} List of signer's keyID and validity of signature.
* @async
*/
verifyDetached(signature, keys, date = new Date(), config = defaultConfig) {
@ -656,7 +660,7 @@ export class Message {
* @param {Array} [userIDs] - User IDs to sign with, e.g. [{ name:'Steve Sender', email:'steve@openpgp.org' }]
* @param {Boolean} [detached] - Whether to create detached signature packets
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {PacketList} List of signature packets.
* @returns {Promise<PacketList>} List of signature packets.
* @async
* @private
*/
@ -788,7 +792,7 @@ export async function createVerificationObjects(signatureList, literalDataList,
* @param {String | ReadableStream<String>} [options.armoredMessage] - Armored message to be parsed
* @param {Uint8Array | ReadableStream<Uint8Array>} [options.binaryMessage] - Binary to be parsed
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Message} New message object.
* @returns {Promise<Message>} New message object.
* @async
* @static
*/

24
src/openpgp.js
View File

@ -45,7 +45,7 @@ import util from './util';
* @param {Array<Object>} [options.subkeys=a single encryption subkey] - Options for each subkey, default to main key options. e.g. `[{sign: true, passphrase: '123'}]`
* sign parameter defaults to false, and indicates whether the subkey should sign rather than encrypt
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Object} The generated key object in the form:
* @returns {Promise<Object>} The generated key object in the form:
* { key:Key, privateKeyArmored:String, publicKeyArmored:String, revocationCertificate:String }
* @async
* @static
@ -81,7 +81,7 @@ export function generateKey({ userIDs = [], passphrase = "", type = "ecc", rsaBi
* @param {String} [options.passphrase=(not protected)] - The passphrase used to encrypt the generated private key
* @param {Number} [options.keyExpirationTime=0 (never expires)] - Number of seconds from the key creation time after which the key expires
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Object} The generated key object in the form:
* @returns {Promise<Object>} The generated key object in the form:
* { key:Key, privateKeyArmored:String, publicKeyArmored:String, revocationCertificate:String }
* @async
* @static
@ -116,7 +116,7 @@ export function reformatKey({ privateKey, userIDs = [], passphrase = "", keyExpi
* @param {module:enums.reasonForRevocation} [options.reasonForRevocation.flag=[noReason]{@link module:enums.reasonForRevocation}] - Flag indicating the reason for revocation
* @param {String} [options.reasonForRevocation.string=""] - String explaining the reason for revocation
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Object} The revoked key object in the form:
* @returns {Promise<Object>} The revoked key object in the form:
* `{ privateKey:Key, privateKeyArmored:String, publicKey:Key, publicKeyArmored:String }`
* (if private key is passed) or `{ publicKey:Key, publicKeyArmored:String }` (otherwise)
* @async
@ -154,7 +154,7 @@ export function revokeKey({ key, revocationCertificate, reasonForRevocation, con
* @param {Key} options.privateKey - The private key to decrypt
* @param {String|Array<String>} options.passphrase - The user's passphrase(s)
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Key} The unlocked key object.
* @returns {Promise<Key>} The unlocked key object.
* @async
*/
export async function decryptKey({ privateKey, passphrase, config }) {
@ -183,7 +183,7 @@ export async function decryptKey({ privateKey, passphrase, config }) {
* @param {Key} options.privateKey - The private key to encrypt
* @param {String|Array<String>} options.passphrase - If multiple passphrases, they should be in the same order as the packets each should encrypt
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Key} The locked key object.
* @returns {Promise<Key>} The locked key object.
* @async
*/
export async function encryptKey({ privateKey, passphrase, config }) {
@ -238,7 +238,7 @@ export async function encryptKey({ privateKey, passphrase, config }) {
* @param {Array<Object>} [options.fromUserIDs=primary user IDs] - Array of user IDs to sign with, one per key in `privateKeys`, e.g. `[{ name: 'Steve Sender', email: 'steve@openpgp.org' }]`
* @param {Array<Object>} [options.toUserIDs=primary user IDs] - Array of user IDs to encrypt for, one per key in `publicKeys`, e.g. `[{ name: 'Robert Receiver', email: 'robert@openpgp.org' }]`
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {String|ReadableStream<String>|NodeStream<String>|Uint8Array|ReadableStream<Uint8Array>|NodeStream<Uint8Array>} Encrypted message (string if `armor` was true, the default; Uint8Array if `armor` was false).
* @returns {Promise<String|ReadableStream<String>|NodeStream<String>|Uint8Array|ReadableStream<Uint8Array>|NodeStream<Uint8Array>>} Encrypted message (string if `armor` was true, the default; Uint8Array if `armor` was false).
* @async
* @static
*/
@ -280,7 +280,7 @@ export function encrypt({ message, publicKeys, privateKeys, passwords, sessionKe
* @param {Signature} [options.signature] - Detached signature for verification
* @param {Date} [options.date=current date] - Use the given date for verification instead of the current time
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Object} Object containing decrypted and verified message in the form:
* @returns {Promise<Object>} Object containing decrypted and verified message in the form:
*
* {
* data: String|ReadableStream<String>|NodeStream, (if format was 'utf8', the default)
@ -336,7 +336,7 @@ export function decrypt({ message, privateKeys, passwords, sessionKeys, publicKe
* @param {Date} [options.date=current date] - Override the creation date of the signature
* @param {Array<Object>} [options.fromUserIDs=primary user IDs] - Array of user IDs to sign with, one per key in `privateKeys`, e.g. `[{ name: 'Steve Sender', email: 'steve@openpgp.org' }]`
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {String|ReadableStream<String>|NodeStream<String>|Uint8Array|ReadableStream<Uint8Array>|NodeStream<Uint8Array>} Signed message (string if `armor` was true, the default; Uint8Array if `armor` was false).
* @returns {Promise<String|ReadableStream<String>|NodeStream<String>|Uint8Array|ReadableStream<Uint8Array>|NodeStream<Uint8Array>>} Signed message (string if `armor` was true, the default; Uint8Array if `armor` was false).
* @async
* @static
*/
@ -376,7 +376,7 @@ export function sign({ message, privateKeys, armor = true, detached = false, sig
* @param {Signature} [options.signature] - Detached signature for verification
* @param {Date} [options.date=current date] - Use the given date for verification instead of the current time
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Object} Object containing verified message in the form:
* @returns {Promise<Object>} Object containing verified message in the form:
*
* {
* data: String|ReadableStream<String>|NodeStream, (if `message` was a CleartextMessage)
@ -428,7 +428,7 @@ export function verify({ message, publicKeys, format = 'utf8', signature = null,
* @param {Date} [options.date=current date] - Date to select algorithm preferences at
* @param {Array} [options.toUserIDs=primary user IDs] - User IDs to select algorithm preferences for
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {{ data: Uint8Array, algorithm: String }} Object with session key data and algorithm.
* @returns {Promise<{ data: Uint8Array, algorithm: String }>} Object with session key data and algorithm.
* @async
* @static
*/
@ -458,7 +458,7 @@ export function generateSessionKey({ publicKeys, date = new Date(), toUserIDs =
* @param {Date} [options.date=current date] - Override the date
* @param {Array} [options.toUserIDs=primary user IDs] - Array of user IDs to encrypt for, one per key in `publicKeys`, e.g. `[{ name: 'Phil Zimmermann', email: 'phil@openpgp.org' }]`
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {String|Uint8Array} Encrypted session keys (string if `armor` was true, the default; Uint8Array if `armor` was false).
* @returns {Promise<String|Uint8Array>} Encrypted session keys (string if `armor` was true, the default; Uint8Array if `armor` was false).
* @async
* @static
*/
@ -482,7 +482,7 @@ export function encryptSessionKey({ data, algorithm, aeadAlgorithm, publicKeys,
* @param {Key|Array<Key>} [options.privateKeys] - Private keys with decrypted secret key data
* @param {String|Array<String>} [options.passwords] - Passwords to decrypt the session key
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
* @returns {Object|undefined} Array of decrypted session key, algorithm pairs in the form:
* @returns {Promise<Object|undefined>} Array of decrypted session key, algorithm pairs in the form:
* { data:Uint8Array, algorithm:String }
* or 'undefined' if no key packets found
* @async

4
src/packet/public_key_encrypted_session_key.js
View File

@ -89,7 +89,7 @@ class PublicKeyEncryptedSessionKeyPacket {
/**
* Encrypt session key packet
* @param {PublicKeyPacket} key - Public key
* @returns {Boolean}
* @returns {Promise<Boolean>}
* @async
*/
async encrypt(key) {
@ -110,7 +110,7 @@ class PublicKeyEncryptedSessionKeyPacket {
*
* @param {SecretKeyPacket} key
* Private key with secret params unlocked
* @returns {Boolean}
* @returns {Promise<Boolean>}
* @async
*/
async decrypt(key) {

4
src/packet/sym_encrypted_integrity_protected_data.js
View File

@ -89,7 +89,7 @@ class SymEncryptedIntegrityProtectedDataPacket {
* @param {String} sessionKeyAlgorithm - The selected symmetric encryption algorithm to be used e.g. 'aes128'
* @param {Uint8Array} key - The key of cipher blocksize length to be used
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Boolean}
* @returns {Promise<Boolean>}
* @async
*/
async encrypt(sessionKeyAlgorithm, key, config = defaultConfig) {
@ -111,7 +111,7 @@ class SymEncryptedIntegrityProtectedDataPacket {
* @param {String} sessionKeyAlgorithm - The selected symmetric encryption algorithm to be used e.g. 'aes128'
* @param {Uint8Array} key - The key of cipher blocksize length to be used
* @param {Object} [config] - Full configuration, defaults to openpgp.config
* @returns {Boolean}
* @returns {Promise<Boolean>}
* @async
*/
async decrypt(sessionKeyAlgorithm, key, config = defaultConfig) {