Update comment [skip ci]

Co-authored-by: Daniel Huigens <d.huigens@protonmail.com>
This commit is contained in:
larabr 2024-01-12 16:14:18 +01:00 committed by GitHub
parent b1619871e7
commit 5c8e490c85
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -56,8 +56,9 @@ export default {
*/ */
aeadProtect: false, aeadProtect: false,
/** /**
* When reading private keys which were encrypted by OpenPGP.js v5 (or older) using `config.aeadProtect = true` * When reading OpenPGP v4 private keys (e.g. those generated in OpenPGP.js when not setting `config.v5Keys = true`)
* and `config.v5Keys = false`, this option must be set, otherwise key parsing and/or key decryption will fail. * which were encrypted by OpenPGP.js v5 (or older) using `config.aeadProtect = true`,
* this option must be set, otherwise key parsing and/or key decryption will fail.
* Note: only set this flag if you know that the keys are of the legacy type, as non-legacy keys * Note: only set this flag if you know that the keys are of the legacy type, as non-legacy keys
* will be processed incorrectly. * will be processed incorrectly.
*/ */