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

clarifying comments

Browse Source
This commit is contained in:
Sanjana Rajan 2018-04-30 13:30:48 -07:00
parent d562c147f9
commit 9a5583fd25
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/config/config.js
View File

@ -47,6 +47,7 @@ export default {
/** /**
* Use Authenticated Encryption with Additional Data (AEAD) protection for symmetric encryption. * Use Authenticated Encryption with Additional Data (AEAD) protection for symmetric encryption.
* **NOT INTEROPERABLE WITH OTHER OPENPGP IMPLEMENTATIONS** * **NOT INTEROPERABLE WITH OTHER OPENPGP IMPLEMENTATIONS**
* **FUTURE OPENPGP.JS VERSIONS MAY BREAK COMPATIBILITY WHEN USING THIS OPTION**
* @memberof module:config * @memberof module:config
* @property {Boolean} aead_protect * @property {Boolean} aead_protect
*/ */
@ -55,7 +56,7 @@ export default {
* Use Authenticated Encryption with Additional Data (AEAD) protection for symmetric encryption. * Use Authenticated Encryption with Additional Data (AEAD) protection for symmetric encryption.
* 0 means we implement a variant of {@link https://tools.ietf.org/html/draft-ford-openpgp-format-00|this IETF draft}. * 0 means we implement a variant of {@link https://tools.ietf.org/html/draft-ford-openpgp-format-00|this IETF draft}.
* 4 means we implement {@link https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-04|RFC4880bis-04}. * 4 means we implement {@link https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-04|RFC4880bis-04}.
* Only has an effect when aead_protect is set to true. * Note that this determines how AEAD packets are parsed even when aead_protect is set to false
* @memberof module:config * @memberof module:config
* @property {Integer} aead_protect_version * @property {Integer} aead_protect_version
*/ */
@ -63,7 +64,6 @@ export default {
/** /**
* Default Authenticated Encryption with Additional Data (AEAD) encryption mode * Default Authenticated Encryption with Additional Data (AEAD) encryption mode
* Only has an effect when aead_protect is set to true. * Only has an effect when aead_protect is set to true.
* **FUTURE OPENPGP.JS VERSIONS MAY BREAK COMPATIBILITY WHEN USING THIS OPTION**
* @memberof module:config * @memberof module:config
* @property {Integer} aead_mode Default AEAD mode {@link module:enums.aead} * @property {Integer} aead_mode Default AEAD mode {@link module:enums.aead}
*/ */