feat: add secp256k1 EC Key curve and ES256K

panva · panva · commit 211d7af5db50 · 2019-07-08T22:04:29.000+02:00
This is as per - https://tools.ietf.org/html/draft-ietf-cose-webauthn-algorithms-01 - https://mailarchive.ietf.org/arch/msg/cose/91MouVA43DefbpQOB7l5daCEeIc
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,7 +30,7 @@ calculation loop when the private key's private exponent was outright
 invalid or tampered with.
 
 The new methods still allow to import private RSA keys with these
-optimization key parameters missing but its disabled by default and one
+optimization key parameters missing but it is disabled by default and one
 should choose to enable it when working with keys from trusted sources
 
 It is recommended not to use @panva/jose versions with this feature in
diff --git a/P-256K/index.js b/P-256K/index.js
@@ -0,0 +1,6 @@
+// rename 'secp256k1' to 'P-256K'
+
+const { rename } = require('../lib/jwk/key/secp256k1_crv')
+rename('P-256K')
+
+module.exports = require('../lib')
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ The following specifications are implemented by @panva/jose
 - JSON Web Key Thumbprint - [RFC7638][spec-thumbprint]
 - JWS Unencoded Payload Option - [RFC7797][spec-b64]
 - CFRG Elliptic Curve Signatures (EdDSA) - [RFC8037][spec-okp]
+- secp256k1 curve EC Key support - [JOSE Registrations for WebAuthn Algorithms][draft-secp256k1]
 
 The test suite utilizes examples defined in [RFC7520][spec-cookbook] to confirm its JOSE
 implementation is correct.
@@ -47,7 +48,7 @@ Legend:
 | -- | -- | -- |
 | RSASSA-PKCS1-v1_5 | ✓ | RS256, RS384, RS512 |
 | RSASSA-PSS | ✓ | PS256, PS384, PS512 |
-| ECDSA | ✓ | ES256, ES384, ES512 |
+| ECDSA | ✓ | ES256, ES256K, ES384, ES512 |
 | Edwards-curve DSA | ✓ | EdDSA |
 | HMAC with SHA-2 | ✓ | HS256, HS384, HS512 |
 
@@ -247,6 +248,32 @@ jose.JWE.decrypt(
 )
 ```
 
+#### secp256k1
+
+Note: the secp256k1 JOSE parameters registration and the RFC is still in a draft state. If the WG
+draft changes its mind about the parameter names again the new values will be propagated as a MINOR
+library version.
+
+When you require `@panva/jose` you can work with `secp256k1` EC keys right away, the EC JWK `crv`
+used is as per the specification `secp256k1`.
+
+```js
+const jose = require('@panva/jose')
+let key = jose.JWK.generateSync('EC', 'secp256k1')
+key = jose.JWK.asKey(fs.readFileSync('path/to/key/file'))
+key.crv === 'secp256k1'
+```
+
+For legacy reasons the unregistered EC JWK `crv` value `P-256K` is also supported but you must
+require `@panva/jose` like so to use it:
+
+```js
+const jose = require('@panva/jose/P-256K')
+let key = jose.JWK.generateSync('EC', 'P-256K')
+key = jose.JWK.asKey(fs.readFileSync('path/to/key/file'))
+key.crv === 'P-256K'
+```
+
 ## FAQ
 
 #### Semver?
@@ -315,6 +342,7 @@ in terms of performance and API (not having well defined errors).
 [spec-jws]: https://tools.ietf.org/html/rfc7515
 [spec-jwt]: https://tools.ietf.org/html/rfc7519
 [spec-okp]: https://tools.ietf.org/html/rfc8037
+[draft-secp256k1]: https://tools.ietf.org/html/draft-ietf-cose-webauthn-algorithms-01
 [spec-thumbprint]: https://tools.ietf.org/html/rfc7638
 [suggest-feature]: https://github.com/panva/jose/issues/new?labels=enhancement&template=feature-request.md&title=proposal%3A+
 [support-patreon]: https://www.patreon.com/panva
diff --git a/lib/help/consts.js b/lib/help/consts.js
@@ -1,3 +1,5 @@
+const { name: secp256k1 } = require('../jwk/key/secp256k1_crv')
+
 module.exports.KEYOBJECT = Symbol('KEYOBJECT')
 module.exports.PRIVATE_MEMBERS = Symbol('PRIVATE_MEMBERS')
 module.exports.PUBLIC_MEMBERS = Symbol('PUBLIC_MEMBERS')
@@ -18,7 +20,7 @@ module.exports.OPS = OPS
 module.exports.USES = USES
 
 module.exports.OKP_CURVES = new Set(['Ed25519', 'Ed448', 'X25519', 'X448'])
-module.exports.EC_CURVES = new Set(['P-256', 'P-384', 'P-521'])
+module.exports.EC_CURVES = new Set(['P-256', secp256k1, 'P-384', 'P-521'])
 module.exports.ECDH_ALGS = ['ECDH-ES', 'ECDH-ES+A128KW', 'ECDH-ES+A192KW', 'ECDH-ES+A256KW']
 
 module.exports.KEYLENGTHS = {
diff --git a/lib/help/ecdsa_signatures.js b/lib/help/ecdsa_signatures.js
@@ -10,6 +10,7 @@ const getParamSize = keySize => ((keySize / 8) | 0) + (keySize % 8 === 0 ? 0 : 1
 
 const paramBytesForAlg = {
   ES256: getParamSize(256),
+  ES256K: getParamSize(256),
   ES384: getParamSize(384),
   ES512: getParamSize(521)
 }
diff --git a/lib/help/key_utils.js b/lib/help/key_utils.js
@@ -1,24 +1,29 @@
 const { createPublicKey } = require('crypto')
 
-const base64url = require('./base64url')
+const { name: secp256k1 } = require('../jwk/key/secp256k1_crv')
 const errors = require('../errors')
+
+const base64url = require('./base64url')
 const asn1 = require('./asn1')
 const computePrimes = require('./rsa_primes')
 const { OKP_CURVES, EC_CURVES } = require('./consts')
 
 const oidHexToCurve = new Map([
   ['06082a8648ce3d030107', 'P-256'],
+  ['06052b8104000a', secp256k1],
   ['06052b81040022', 'P-384'],
   ['06052b81040023', 'P-521']
 ])
 const EC_KEY_OID = '1.2.840.10045.2.1'.split('.')
 const crvToOid = new Map([
   ['P-256', '1.2.840.10045.3.1.7'.split('.')],
+  [secp256k1, '1.3.132.0.10'.split('.')],
   ['P-384', '1.3.132.0.34'.split('.')],
   ['P-521', '1.3.132.0.35'.split('.')]
 ])
 const crvToOidBuf = new Map([
   ['P-256', Buffer.from('06082a8648ce3d030107', 'hex')],
+  [secp256k1, Buffer.from('06052b8104000a', 'hex')],
   ['P-384', Buffer.from('06052b81040022', 'hex')],
   ['P-521', Buffer.from('06052b81040023', 'hex')]
 ])
diff --git a/lib/help/node_alg.js b/lib/help/node_alg.js
@@ -1 +1 @@
-module.exports = alg => `sha${alg.substr(-3)}`
+module.exports = alg => `sha${alg.substr(2, 3)}`
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -15,7 +15,7 @@ interface KeyParameters extends BasicParameters {
     x5t?: string
     'x5t#S256'?: string
 }
-type ECCurve = 'P-256' | 'P-384' | 'P-521'
+type ECCurve = 'P-256' | 'secp256k1' | 'P-384' | 'P-521'
 type OKPCurve = 'Ed25519' | 'Ed448' | 'X25519' | 'X448'
 type keyType = 'RSA' | 'EC' | 'OKP' | 'oct'
 type asymmetricKeyObjectTypes = 'private' | 'public'
diff --git a/lib/jwa/ecdh/derive.js b/lib/jwa/ecdh/derive.js
@@ -1,6 +1,7 @@
 const { createECDH, createHash, constants: { POINT_CONVERSION_UNCOMPRESSED } } = require('crypto')
 
 const base64url = require('../../help/base64url')
+const { name: secp256k1 } = require('../../jwk/key/secp256k1_crv')
 
 const crvToCurve = (crv) => {
   switch (crv) {
@@ -10,9 +11,12 @@ const crvToCurve = (crv) => {
       return 'secp384r1'
     case 'P-521':
       return 'secp521r1'
+    case 'secp256k1':
     case 'X448':
     case 'X25519':
       return crv
+    case secp256k1:
+      return 'secp256k1'
   }
 }
 
diff --git a/lib/jwa/ecdsa.js b/lib/jwa/ecdsa.js
@@ -18,7 +18,7 @@ const verify = (jwaAlg, nodeAlg, { [KEYOBJECT]: keyObject }, payload, signature)
 }
 
 module.exports = (JWA) => {
-  ['ES256', 'ES384', 'ES512'].forEach((jwaAlg) => {
+  ['ES256', 'ES384', 'ES512', 'ES256K'].forEach((jwaAlg) => {
     const nodeAlg = resolveNodeAlg(jwaAlg)
 
     assert(!JWA.sign.has(jwaAlg), `sign alg ${jwaAlg} already registered`)
diff --git a/lib/jwk/key/ec.js b/lib/jwk/key/ec.js
@@ -7,6 +7,7 @@ const {
 } = require('../../help/consts')
 
 const errors = require('../../errors')
+const { name: secp256k1 } = require('./secp256k1_crv')
 
 const Key = require('./base')
 
@@ -21,6 +22,8 @@ const crvToDSA = (crv) => {
   switch (crv) {
     case 'P-256':
       return 'ES256'
+    case secp256k1:
+      return 'ES256K'
     case 'P-384':
       return 'ES384'
     case 'P-521':
@@ -115,6 +118,10 @@ class ECKey extends Key {
       throw new errors.JOSENotSupported(`unsupported EC key curve: ${crv}`)
     }
 
+    if (crv === secp256k1 && crv !== 'secp256k1') {
+      crv = 'secp256k1'
+    }
+
     const { privateKey, publicKey } = await generateKeyPair('ec', { namedCurve: crv })
 
     return privat ? privateKey : publicKey
@@ -125,6 +132,10 @@ class ECKey extends Key {
       throw new errors.JOSENotSupported(`unsupported EC key curve: ${crv}`)
     }
 
+    if (crv === secp256k1 && crv !== 'secp256k1') {
+      crv = 'secp256k1'
+    }
+
     const { privateKey, publicKey } = generateKeyPairSync('ec', { namedCurve: crv })
 
     return privat ? privateKey : publicKey
diff --git a/lib/jwk/key/secp256k1_crv.js b/lib/jwk/key/secp256k1_crv.js
@@ -0,0 +1,6 @@
+module.exports = {
+  name: 'secp256k1',
+  rename (value) {
+    module.exports.name = value
+  }
+}
diff --git a/package.json b/package.json
@@ -19,6 +19,7 @@
     "jwks",
     "jws",
     "jwt",
+    "secp256k1",
     "sign",
     "verify"
   ],
diff --git a/test/fixtures/index.js b/test/fixtures/index.js
@@ -56,6 +56,22 @@ module.exports.JWK = {
     d: '_i_1Ac5oVmbBxGvEvOEFHMpzMXKZi8voUx8I3Gl6IxY'
   },
 
+  'secp256k1': {
+    kty: 'EC',
+    crv: 'secp256k1',
+    x: 'VRaLqtMjg_JRaDzkbfit7zonkOGDZ42qbZyljhqsg3U',
+    y: '5qgTxoRAf0hJxcphVg1NE9r0Xv-HHZyVIJxEbo6SAsQ',
+    d: 'xTAmXNRL8ksBlr-F3yXDrUdRDn1gyIvY_PC2e_iUK7c'
+  },
+
+  'P-256K': {
+    kty: 'EC',
+    crv: 'P-256K',
+    x: 'VRaLqtMjg_JRaDzkbfit7zonkOGDZ42qbZyljhqsg3U',
+    y: '5qgTxoRAf0hJxcphVg1NE9r0Xv-HHZyVIJxEbo6SAsQ',
+    d: 'xTAmXNRL8ksBlr-F3yXDrUdRDn1gyIvY_PC2e_iUK7c'
+  },
+
   'P-384': {
     kty: 'EC',
     crv: 'P-384',
@@ -100,6 +116,14 @@ module.exports.PEM = {
     private: readFileSync(join(__dirname, 'P-256.key')),
     public: readFileSync(join(__dirname, 'P-256.pem'))
   },
+  'secp256k1': {
+    private: readFileSync(join(__dirname, 'secp256k1.key')),
+    public: readFileSync(join(__dirname, 'secp256k1.pem'))
+  },
+  'P-256K': {
+    private: readFileSync(join(__dirname, 'secp256k1.key')),
+    public: readFileSync(join(__dirname, 'secp256k1.pem'))
+  },
   'P-384': {
     private: readFileSync(join(__dirname, 'P-384.key')),
     public: readFileSync(join(__dirname, 'P-384.pem'))
diff --git a/test/fixtures/secp256k1.key b/test/fixtures/secp256k1.key
@@ -0,0 +1,5 @@
+-----BEGIN PRIVATE KEY-----
+MIGEAgEAMBAGByqGSM49AgEGBSuBBAAKBG0wawIBAQQgxTAmXNRL8ksBlr+F3yXD
+rUdRDn1gyIvY/PC2e/iUK7ehRANCAARVFouq0yOD8lFoPORt+K3vOieQ4YNnjapt
+nKWOGqyDdeaoE8aEQH9IScXKYVYNTRPa9F7/hx2clSCcRG6OkgLE
+-----END PRIVATE KEY-----
diff --git a/test/fixtures/secp256k1.pem b/test/fixtures/secp256k1.pem
@@ -0,0 +1,4 @@
+-----BEGIN PUBLIC KEY-----
+MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEVRaLqtMjg/JRaDzkbfit7zonkOGDZ42q
+bZyljhqsg3XmqBPGhEB/SEnFymFWDU0T2vRe/4cdnJUgnERujpICxA==
+-----END PUBLIC KEY-----
diff --git a/test/help/P-256K.key_utils.test.js b/test/help/P-256K.key_utils.test.js
@@ -0,0 +1,26 @@
+// require 'secp256k1' renamed to 'P-256K'
+require('../../P-256K')
+
+const test = require('ava')
+const { createPublicKey, createPrivateKey } = require('crypto')
+
+const { keyObjectToJWK, jwkToPem } = require('../../lib/help/key_utils')
+const { JWK: fixtures } = require('../fixtures')
+const clone = obj => JSON.parse(JSON.stringify(obj))
+
+test('EC P-256K Public key', t => {
+  const expected = clone(fixtures['P-256K'])
+  delete expected.d
+  const pem = createPublicKey(jwkToPem(expected))
+  const actual = keyObjectToJWK(pem)
+
+  t.deepEqual(actual, expected)
+})
+
+test('EC P-256K Private key', t => {
+  const expected = fixtures['P-256K']
+  const pem = createPrivateKey(jwkToPem(expected))
+  const actual = keyObjectToJWK(pem)
+
+  t.deepEqual(actual, expected)
+})
diff --git a/test/jwe/smoke.P-256K.test.js b/test/jwe/smoke.P-256K.test.js
@@ -0,0 +1,31 @@
+// require 'secp256k1' renamed to 'P-256K'
+require('../../P-256K')
+
+const test = require('ava')
+
+const { JWK: { asKey } } = require('../..')
+
+const ENCS = [
+  'A128GCM',
+  'A192GCM',
+  'A256GCM',
+  'A128CBC-HS256',
+  'A192CBC-HS384',
+  'A256CBC-HS512'
+]
+
+const type = 'P-256K'
+const { private: key, public: pub } = require('../fixtures').PEM[type]
+
+const { JWE: { success, failure } } = require('../macros')
+
+const eKey = asKey(pub)
+const dKey = asKey(key)
+
+;[...eKey.algorithms('wrapKey'), ...eKey.algorithms('deriveKey')].forEach((alg) => {
+  ENCS.forEach((enc) => {
+    if (alg === 'ECDH-ES' && ['A192CBC-HS384', 'A256CBC-HS512'].includes(enc)) return
+    test(`key ${type} > alg ${alg} > ${enc}`, success, eKey, dKey, alg, enc)
+    test(`key ${type} > alg ${alg} > ${enc} (negative cases)`, failure, eKey, dKey, alg, enc)
+  })
+})
diff --git a/test/jwe/smoke.test.js b/test/jwe/smoke.test.js
diff --git a/test/jwk/P-256K.import.test.js b/test/jwk/P-256K.import.test.js
diff --git a/test/jwk/ec.test.js b/test/jwk/ec.test.js
diff --git a/test/jwk/generate.test.js b/test/jwk/generate.test.js
diff --git a/test/jwk/import.test.js b/test/jwk/import.test.js
diff --git a/test/jws/smoke.P-256K.test.js b/test/jws/smoke.P-256K.test.js
diff --git a/test/jws/smoke.test.js b/test/jws/smoke.test.js
diff --git a/test/macros/index.js b/test/macros/index.js

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ const getParamSize = keySize => ((keySize / 8) \| 0) + (keySize % 8 === 0 ? 0 : 1`
`10`	`10`
`11`	`11`	`const paramBytesForAlg = {`
`12`	`12`	`ES256: getParamSize(256),`
	`13`	`+ ES256K: getParamSize(256),`
`13`	`14`	`ES384: getParamSize(384),`
`14`	`15`	`ES512: getParamSize(521)`
`15`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-module.exports = alg => `sha${alg.substr(-3)}`
	`1`	+module.exports = alg => `sha${alg.substr(2, 3)}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ interface KeyParameters extends BasicParameters {`
`15`	`15`	`x5t?: string`
`16`	`16`	`'x5t#S256'?: string`
`17`	`17`	`}`
`18`		`-type ECCurve = 'P-256' \| 'P-384' \| 'P-521'`
	`18`	`+type ECCurve = 'P-256' \| 'secp256k1' \| 'P-384' \| 'P-521'`
`19`	`19`	`type OKPCurve = 'Ed25519' \| 'Ed448' \| 'X25519' \| 'X448'`
`20`	`20`	`type keyType = 'RSA' \| 'EC' \| 'OKP' \| 'oct'`
`21`	`21`	`type asymmetricKeyObjectTypes = 'private' \| 'public'`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ const verify = (jwaAlg, nodeAlg, { [KEYOBJECT]: keyObject }, payload, signature)`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`module.exports = (JWA) => {`
`21`		`- ['ES256', 'ES384', 'ES512'].forEach((jwaAlg) => {`
	`21`	`+ ['ES256', 'ES384', 'ES512', 'ES256K'].forEach((jwaAlg) => {`
`22`	`22`	`const nodeAlg = resolveNodeAlg(jwaAlg)`
`23`	`23`
`24`	`24`	assert(!JWA.sign.has(jwaAlg), `sign alg ${jwaAlg} already registered`)