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

Rename enums.aead.gcm to experimental_gcm

Browse Source 
So that (1) if the spec ever defines GCM differently than we do, we have a
clean upgrade path and (2) it makes it clear that it's experimental.
This commit is contained in:
Daniel Huigens 2018-04-26 16:52:49 +02:00
parent bbf71d149b
commit 04651e359a
6 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -76,7 +76,7 @@ OpenPGP.js [![Build Status](https://travis-ci.org/openpgpjs/openpgpjs.svg?branch
``` ```
openpgp.config.aead_mode = openpgp.enums.aead.eax // Default, native openpgp.config.aead_mode = openpgp.enums.aead.eax // Default, native
openpgp.config.aead_mode = openpgp.enums.aead.ocb // Non-native openpgp.config.aead_mode = openpgp.enums.aead.ocb // Non-native
openpgp.config.aead_mode = openpgp.enums.aead.gcm // **Non-standard**, fastest openpgp.config.aead_mode = openpgp.enums.aead.experimental_gcm // **Non-standard**, fastest
``` ```
We previously also implemented an [earlier version](https://tools.ietf.org/html/draft-ford-openpgp-format-00) of the draft (using GCM), which you could enable by simply setting `openpgp.config.aead_protect = true`. If you need to stay compatible with that version, don't set `openpgp.config.aead_protect_version = 4`. We previously also implemented an [earlier version](https://tools.ietf.org/html/draft-ford-openpgp-format-00) of the draft (using GCM), which you could enable by simply setting `openpgp.config.aead_protect = true`. If you need to stay compatible with that version, don't set `openpgp.config.aead_protect_version = 4`.

1
src/crypto/index.js
View File

@ -33,6 +33,7 @@ const mod = {
cfb: cfb, cfb: cfb,
/** @see module:crypto/gcm */ /** @see module:crypto/gcm */
gcm: gcm, gcm: gcm,
experimental_gcm: gcm,
/** @see module:crypto/eax */ /** @see module:crypto/eax */
eax: eax, eax: eax,
/** @see module:crypto/ocb */ /** @see module:crypto/ocb */

2
src/enums.js
View File

@ -178,7 +178,7 @@ export default {
aead: { aead: {
eax: 1, eax: 1,
ocb: 2, ocb: 2,
gcm: 100 // Private algorithm experimental_gcm: 100 // Private algorithm
}, },
/** A list of packet types and numeric tags associated with them. /** A list of packet types and numeric tags associated with them.

2
src/openpgp.js
View File

@ -591,7 +591,7 @@ function onError(message, error) {
*/ */
function nativeAEAD() { function nativeAEAD() {
return config.aead_protect && ( return config.aead_protect && (
((config.aead_protect_version !== 4 || config.aead_mode === enums.aead.gcm) && util.getWebCrypto()) || ((config.aead_protect_version !== 4 || config.aead_mode === enums.aead.experimental_gcm) && util.getWebCrypto()) ||
(config.aead_protect_version === 4 && config.aead_mode === enums.aead.eax && util.getWebCryptoAll()) (config.aead_protect_version === 4 && config.aead_mode === enums.aead.eax && util.getWebCryptoAll())
); );
} }

4
src/packet/sym_encrypted_aead_protected.js
View File

@ -66,7 +66,7 @@ SymEncryptedAEADProtected.prototype.read = function (bytes) {
this.aeadAlgo = bytes[offset++]; this.aeadAlgo = bytes[offset++];
this.chunkSizeByte = bytes[offset++]; this.chunkSizeByte = bytes[offset++];
} else { } else {
this.aeadAlgo = enums.aead.gcm; this.aeadAlgo = enums.aead.experimental_gcm;
} }
const mode = crypto[enums.read(enums.aead, this.aeadAlgo)]; const mode = crypto[enums.read(enums.aead, this.aeadAlgo)];
this.iv = bytes.subarray(offset, mode.ivLength + offset); this.iv = bytes.subarray(offset, mode.ivLength + offset);
@ -114,7 +114,7 @@ SymEncryptedAEADProtected.prototype.decrypt = async function (sessionKeyAlgorith
*/ */
SymEncryptedAEADProtected.prototype.encrypt = async function (sessionKeyAlgorithm, key) { SymEncryptedAEADProtected.prototype.encrypt = async function (sessionKeyAlgorithm, key) {
this.cipherAlgo = enums.write(enums.symmetric, sessionKeyAlgorithm); this.cipherAlgo = enums.write(enums.symmetric, sessionKeyAlgorithm);
this.aeadAlgo = config.aead_protect_version === 4 ? enums.write(enums.aead, this.aeadAlgorithm) : enums.aead.gcm; this.aeadAlgo = config.aead_protect_version === 4 ? enums.write(enums.aead, this.aeadAlgorithm) : enums.aead.experimental_gcm;
const mode = crypto[enums.read(enums.aead, this.aeadAlgo)]; const mode = crypto[enums.read(enums.aead, this.aeadAlgo)];
this.iv = await crypto.random.getRandomBytes(mode.ivLength); // generate new random IV this.iv = await crypto.random.getRandomBytes(mode.ivLength); // generate new random IV
this.chunkSizeByte = config.aead_chunk_size_byte; this.chunkSizeByte = config.aead_chunk_size_byte;

4
test/general/openpgp.js
View File

@ -683,7 +683,7 @@ describe('OpenPGP.js public api tests', function() {
openpgp.config.use_native = false; openpgp.config.use_native = false;
openpgp.config.aead_protect = true; openpgp.config.aead_protect = true;
openpgp.config.aead_protect_version = 4; openpgp.config.aead_protect_version = 4;
openpgp.config.aead_mode = openpgp.enums.aead.gcm; openpgp.config.aead_mode = openpgp.enums.aead.experimental_gcm;
// Monkey-patch AEAD feature flag // Monkey-patch AEAD feature flag
publicKey.keys[0].users[0].selfCertifications[0].features = [7]; publicKey.keys[0].users[0].selfCertifications[0].features = [7];
@ -698,7 +698,7 @@ describe('OpenPGP.js public api tests', function() {
openpgp.config.use_native = true; openpgp.config.use_native = true;
openpgp.config.aead_protect = true; openpgp.config.aead_protect = true;
openpgp.config.aead_protect_version = 4; openpgp.config.aead_protect_version = 4;
openpgp.config.aead_mode = openpgp.enums.aead.gcm; openpgp.config.aead_mode = openpgp.enums.aead.experimental_gcm;
// Monkey-patch AEAD feature flag // Monkey-patch AEAD feature flag
publicKey.keys[0].users[0].selfCertifications[0].features = [7]; publicKey.keys[0].users[0].selfCertifications[0].features = [7];