diff --git a/src/openpgp.js b/src/openpgp.js index b3f21ade..a3d302f9 100644 --- a/src/openpgp.js +++ b/src/openpgp.js @@ -391,14 +391,11 @@ export function verify({ message, publicKeys, format = 'utf8', streaming = messa /////////////////////////////////////////////// /** - * Decrypt symmetric session keys with a private key or password. Either a private key or - * a password must be specified. - * @param {Message} message a message object containing the encrypted session key packets - * @param {Key|Array} privateKeys (optional) private keys with decrypted secret key data - * @param {String|Array} passwords (optional) passwords to decrypt the session key - * @returns {Promise} Array of decrypted session key, algorithm pairs in form: - * { data:Uint8Array, algorithm:String } - * or 'undefined' if no key packets found + * Generate a new session key object, taking the algorithm preferences of the passed public keys into account. + * @param {Key|Array} publicKeys array of public keys or single key used to select algorithm preferences for + * @param {Date} date (optional) date to select algorithm preferences at + * @param {Array} toUserIds (optional) user IDs to select algorithm preferences for + * @returns {Promise<{ data: Uint8Array, algorithm: String }>} object with session key data and algorithm * @async * @static */