Adds Brainpool Curves + tests + docs

README.md

@@ -49,13 +49,16 @@ OpenPGP.js [![Build Status](https://travis-ci.org/openpgpjs/openpgpjs.svg?branch
 
 
     | Curve           | Encryption | Signature | Elliptic | NodeCrypto | WebCrypto |
-    |:---------- |:----------:|:---------:|:--------:|:----------:|:---------:|
+    |:--------------- |:----------:|:---------:|:--------:|:----------:|:---------:|
     | p256            | ECDH       | ECDSA     | Yes      | Yes*       | Yes*      |
     | p384            | ECDH       | ECDSA     | Yes      | Yes*       | Yes*      |
     | p521            | ECDH       | ECDSA     | Yes      | Yes*       | Yes*      |
     | secp256k1       | ECDH       | ECDSA     | Yes      | Yes*       | No        |
-    | curve25519 | ECDH       | N/A       | Yes      | No         | No        |
+    | curve25519      | ECDH       | N/A       | Yes      | No (TODO)  | No        |
-    | ed25519    | N/A        | EdDSA     | Yes      | No         | No        |
+    | ed25519         | N/A        | EdDSA     | Yes      | No (TODO)  | No        |
+    | brainpoolP256r1 | ECDH       | ECDSA     | Yes      | No (TODO)  | No        |
+    | brainpoolP384r1 | ECDH       | ECDSA     | Yes      | No (TODO)  | No        |
+    | brainpoolP512r1 | ECDH       | ECDSA     | Yes      | No (TODO)  | No        |
 
 * Version 2.x of the library has been built from the ground up with Uint8Arrays. This allows for much better performance and memory usage than strings.
 
@@ -199,8 +202,9 @@ var options = {
 
 ECC keys:
 
-Possible values for curve are curve25519, ed25519, p256, p384, p521, or secp256k1.
+Possible values for curve are: `curve25519`, `ed25519`, `p256`, `p384`, `p521`, `secp256k1`,
-Note that options both curve25519 and ed25519 generate a primary key for signing using Ed25519
+`brainpoolP256r1`, `brainpoolP384r1`, or `brainpoolP512r1`.
+Note that options both `curve25519` and `ed25519` generate a primary key for signing using Ed25519
 and a subkey for encryption using Curve25519.
 
 ```js

src/crypto/public_key/dsa.js

@@ -14,10 +14,9 @@
 // You should have received a copy of the GNU Lesser General Public
 // License along with this library; if not, write to the Free Software
 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-//
-// A Digital signature algorithm implementation
 
 /**
+ * @fileoverview A Digital signature algorithm implementation
  * @requires bn.js
  * @requires crypto/hash
  * @requires crypto/random

src/crypto/public_key/elgamal.js

@@ -14,10 +14,9 @@
 // You should have received a copy of the GNU Lesser General Public
 // License along with this library; if not, write to the Free Software
 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-//
-// ElGamal implementation
 
 /**
+ * @fileoverview ElGamal implementation
  * @requires bn.js
  * @requires crypto/random
  * @module crypto/public_key/elgamal

src/crypto/public_key/elliptic/curves.js

@@ -38,20 +38,23 @@ import OID from '../../../type/oid';
 const webCrypto = util.getWebCrypto();
 const nodeCrypto = util.getNodeCrypto();
 
-const nodeCurves = {};
 const webCurves = {
   'p256': 'P-256',
   'p384': 'P-384',
   'p521': 'P-521'
 };
-if (nodeCrypto) {
+const knownCurves = nodeCrypto ? nodeCrypto.getCurves() : [];
-  const knownCurves = nodeCrypto.getCurves();
+const nodeCurves = nodeCrypto ? {
-  nodeCurves.secp256k1 = knownCurves.includes('secp256k1') ? 'secp256k1' : undefined;
+  secp256k1: knownCurves.includes('secp256k1') ? 'secp256k1' : undefined,
-  nodeCurves.p256 = knownCurves.includes('prime256v1') ? 'prime256v1' : undefined;
+  p256: knownCurves.includes('prime256v1') ? 'prime256v1' : undefined,
-  nodeCurves.p384 = knownCurves.includes('secp384r1') ? 'secp384r1' : undefined;
+  p384: knownCurves.includes('secp384r1') ? 'secp384r1' : undefined,
-  nodeCurves.p521 = knownCurves.includes('secp521r1') ? 'secp521r1' : undefined;
+  p521: knownCurves.includes('secp521r1') ? 'secp521r1' : undefined,
-  // TODO add more here
+  ed25519: knownCurves.includes('ED25519') ? 'ED25519' : undefined,
-}
+  curve25519: knownCurves.includes('X25519') ? 'X25519' : undefined,
+  brainpoolP256r1: knownCurves.includes('brainpoolP256r1') ? 'brainpoolP256r1' : undefined,
+  brainpoolP384r1: knownCurves.includes('brainpoolP384r1') ? 'brainpoolP384r1' : undefined,
+  brainpoolP512r1: knownCurves.includes('brainpoolP512r1') ? 'brainpoolP512r1' : undefined
+} : {};
 
 const curves = {
   p256: {
@@ -92,22 +95,35 @@ const curves = {
     oid: [0x06, 0x09, 0x2B, 0x06, 0x01, 0x04, 0x01, 0xDA, 0x47, 0x0F, 0x01],
     keyType: enums.publicKey.eddsa,
     hash: enums.hash.sha512,
-    payloadSize: 32
+    node: false // nodeCurves.ed25519 TODO
   },
   curve25519: {
     oid: [0x06, 0x08, 0x2B, 0x06, 0x01, 0x04, 0x01, 0x97, 0x55, 0x01, 0x05, 0x01],
     keyType: enums.publicKey.ecdsa,
     hash: enums.hash.sha256,
-    cipher: enums.symmetric.aes128
+    cipher: enums.symmetric.aes128,
+    node: false // nodeCurves.curve25519 TODO
   },
-  brainpoolP256r1: { // TODO 1.3.36.3.3.2.8.1.1.7
+  brainpoolP256r1: {
-    oid: [0x06, 0x07, 0x2B, 0x24, 0x03, 0x03, 0x02, 0x08, 0x01, 0x01, 0x07]
+    oid: [0x06, 0x07, 0x2B, 0x24, 0x03, 0x03, 0x02, 0x08, 0x01, 0x01, 0x07],
+    keyType: enums.publicKey.ecdsa,
+    hash: enums.hash.sha256,
+    cipher: enums.symmetric.aes128,
+    node: false // nodeCurves.brainpoolP256r1 TODO
   },
-  brainpoolP384r1: { // TODO 1.3.36.3.3.2.8.1.1.11
+  brainpoolP384r1: {
-    oid: [0x06, 0x07, 0x2B, 0x24, 0x03, 0x03, 0x02, 0x08, 0x01, 0x01, 0x0B]
+    oid: [0x06, 0x07, 0x2B, 0x24, 0x03, 0x03, 0x02, 0x08, 0x01, 0x01, 0x0B],
+    keyType: enums.publicKey.ecdsa,
+    hash: enums.hash.sha384,
+    cipher: enums.symmetric.aes192,
+    node: false // nodeCurves.brainpoolP384r1 TODO
   },
-  brainpoolP512r1: { // TODO 1.3.36.3.3.2.8.1.1.13
+  brainpoolP512r1: {
-    oid: [0x06, 0x07, 0x2B, 0x24, 0x03, 0x03, 0x02, 0x08, 0x01, 0x01, 0x0D]
+    oid: [0x06, 0x07, 0x2B, 0x24, 0x03, 0x03, 0x02, 0x08, 0x01, 0x01, 0x0D],
+    keyType: enums.publicKey.ecdsa,
+    hash: enums.hash.sha512,
+    cipher: enums.symmetric.aes256,
+    node: false // nodeCurves.brainpoolP512r1 TODO
   }
 };
 

src/crypto/public_key/rsa.js

@@ -14,10 +14,9 @@
 // You should have received a copy of the GNU Lesser General Public
 // License along with this library; if not, write to the Free Software
 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-//
-// RSA implementation
 
 /**
+ * @fileoverview RSA implementation
  * @requires bn.js
  * @requires crypto/public_key/prime
  * @requires crypto/random

src/enums.js

@@ -5,6 +5,7 @@
 export default {
 
   /** Maps curve names under various standards to one
+   * @see {@link https://wiki.gnupg.org/ECC|ECC - GnuPG wiki}
    * @enum {String}
    * @readonly
    */
@@ -34,13 +35,14 @@ export default {
     "2b81040023":   "p521",
     "2B81040023":   "p521",
 
-    /** SECP256k1 Curve */
+    /** SECG SECP256k1 Curve */
     "secp256k1":    "secp256k1",
     "1.3.132.0.10": "secp256k1",
     "2b8104000a":   "secp256k1",
     "2B8104000A":   "secp256k1",
 
-    /** Ed25519 Curve */
+    /** Ed25519 */
+    "ED25519":                "ed25519",
     "ed25519":                "ed25519",
     "Ed25519":                "ed25519",
     "1.3.6.1.4.1.11591.15.1": "ed25519",
@@ -48,12 +50,31 @@ export default {
     "2B06010401DA470F01":     "ed25519",
 
     /** Curve25519 */
+    "X25519":                 "curve25519",
     "cv25519":                "curve25519",
     "curve25519":             "curve25519",
     "Curve25519":             "curve25519",
     "1.3.6.1.4.1.3029.1.5.1": "curve25519",
     "2b060104019755010501":   "curve25519",
-    "2B060104019755010501":   "curve25519"
+    "2B060104019755010501":   "curve25519",
+
+    /** BrainpoolP256r1 Curve */
+    "brainpoolP256r1":       "brainpoolP256r1",
+    "1.3.36.3.3.2.8.1.1.7":  "brainpoolP256r1",
+    "2b2403030208010107":    "brainpoolP256r1",
+    "2B2403030208010107":    "brainpoolP256r1",
+
+    /** BrainpoolP384r1 Curve */
+    "brainpoolP384r1":       "brainpoolP384r1",
+    "1.3.36.3.3.2.8.1.1.11": "brainpoolP384r1",
+    "2b240303020801010b":    "brainpoolP384r1",
+    "2B240303020801010B":    "brainpoolP384r1",
+
+    /** BrainpoolP512r1 Curve */
+    "brainpoolP512r1":       "brainpoolP512r1",
+    "1.3.36.3.3.2.8.1.1.13": "brainpoolP512r1",
+    "2b240303020801010d":    "brainpoolP512r1",
+    "2B240303020801010D":    "brainpoolP512r1"
   },
 
   /** A string to key specifier type

src/openpgp.js

@@ -99,7 +99,9 @@ export function destroyWorker() {
  * @param  {Array<Object>} userIds   array of user IDs e.g. [{ name:'Phil Zimmermann', email:'phil@openpgp.org' }]
  * @param  {String} passphrase       (optional) The passphrase used to encrypt the resulting private key
  * @param  {Number} numBits          (optional) number of bits for RSA keys: 2048 or 4096.
- * @param  {String} curve            (optional) elliptic curve for ECC keys: curve25519, p256, p384, p521, or secp256k1
+ * @param  {String} curve            (optional) elliptic curve for ECC keys:
+ *                                              curve25519, p256, p384, p521, secp256k1,
+ *                                              brainpoolP256r1, brainpoolP384r1, or brainpoolP512r1.
  * @param  {Boolean} unlocked        (optional) If the returned secret part of the generated key is unlocked
  * @param  {Number} keyExpirationTime (optional) The number of seconds after the key creation time that the key expires
  * @returns {Promise<Object>}         The generated key object in the form:

test/crypto/elliptic.js

@@ -139,22 +139,14 @@ describe('Elliptic Curve Cryptography', function () {
     }
   };
   describe('Basic Operations', function () {
-    it('Creating curve with name', function (done) {
+    it('Creating curve from name or oid', function (done) {
-      const names = ['p256', 'p384', 'p521', 'secp256k1', 'curve25519'];
+      for (let name_or_oid in openpgp.enums.curves) {
-      names.forEach(function (name) {
+        expect(new elliptic_curves.Curve(name_or_oid)).to.exist;
-        expect(new elliptic_curves.Curve(name)).to.exist;
+      }
-      });
-      done();
-    });
-    it('Creating curve from oid', function (done) {
-      const oids = ['2A8648CE3D030107', '2B81040022', '2B81040023', '2B8104000A'];
-      oids.forEach(function (oid) {
-        expect(new elliptic_curves.Curve(oid)).to.exist;
-      });
       done();
     });
     it('Creating KeyPair', function () {
-      const names = ['p256', 'p384', 'p521', 'secp256k1', 'curve25519'];
+      const names = ['p256', 'p384', 'p521', 'secp256k1', 'curve25519', 'brainpoolP256r1', 'brainpoolP384r1', 'brainpoolP512r1'];
       return Promise.all(names.map(function (name) {
         const curve = new elliptic_curves.Curve(name);
         return curve.genKeyPair().then(keyPair => {

test/general/brainpool.js

@@ -0,0 +1,83 @@
+/* globals tryTests: true */
+
+const openpgp = typeof window !== 'undefined' && window.openpgp ? window.openpgp : require('../../dist/openpgp');
+
+const chai = require('chai');
+chai.use(require('chai-as-promised'));
+
+const expect = chai.expect;
+
+describe('Brainpool Cryptography', function () {
+  // TODO add test vectors encrypted and signed by GnuPG or other implementation
+
+  function omnibus() {
+    it('Omnibus BrainpoolP256r1 Test', function () {
+      const options = { userIds: {name: "Hi", email: "hi@hel.lo"}, curve: "brainpoolP256r1" };
+      return openpgp.generateKey(options).then(function (firstKey) {
+        const hi = firstKey.key;
+        const pubHi = hi.toPublic();
+
+        const options = { userIds: { name: "Bye", email: "bye@good.bye" }, curve: "brainpoolP256r1" };
+        return openpgp.generateKey(options).then(function (secondKey) {
+          const bye = secondKey.key;
+          const pubBye = bye.toPublic();
+
+          return Promise.all([
+            // Signing message
+            openpgp.sign(
+              { data: 'Hi, this is me, Hi!', privateKeys: hi }
+            ).then(signed => {
+              const msg = openpgp.cleartext.readArmored(signed.data);
+              // Verifying signed message
+              return Promise.all([
+                openpgp.verify(
+                  { message: msg, publicKeys: pubHi }
+                ).then(output => expect(output.signatures[0].valid).to.be.true),
+                // Verifying detached signature
+                openpgp.verify(
+                  { message: openpgp.message.fromText('Hi, this is me, Hi!'),
+                    publicKeys: pubHi,
+                    signature: openpgp.signature.readArmored(signed.data) }
+                ).then(output => expect(output.signatures[0].valid).to.be.true)
+              ]);
+            }),
+            // Encrypting and signing
+            openpgp.encrypt(
+              { data: 'Hi, Hi wrote this but only Bye can read it!',
+                publicKeys: [pubBye],
+                privateKeys: [hi] }
+            ).then(encrypted => {
+              const msg = openpgp.message.readArmored(encrypted.data);
+              // Decrypting and verifying
+              return openpgp.decrypt(
+                { message: msg,
+                  privateKeys: bye,
+                  publicKeys: [pubHi] }
+              ).then(output => {
+                expect(output.data).to.equal('Hi, Hi wrote this but only Bye can read it!');
+                expect(output.signatures[0].valid).to.be.true;
+              });
+            })
+          ]);
+        });
+      });
+    });
+  }
+
+  omnibus();
+
+  tryTests('Brainpool Worker Tests', omnibus, {
+    if: typeof window !== 'undefined' && window.Worker,
+    before: function() {
+      openpgp.initWorker({ path:'../dist/openpgp.worker.js' });
+    },
+    beforeEach: function() {
+      openpgp.config.use_native = true;
+    },
+    after: function() {
+      openpgp.destroyWorker();
+    }
+  });
+
+  // TODO find test vectors
+});

test/general/index.js

@@ -10,6 +10,7 @@ describe('General', function () {
   require('./oid.js');
   require('./ecc_nist.js');
   require('./x25519.js');
+  require('./brainpool.js');
   require('./decompression.js');
 });