feat: add EC P-256K JWK and ES256K sign/verify support

Author: panva

README.md

@@ -43,7 +43,7 @@ Legend:
 | -- | -- | -- |
 | RSASSA-PKCS1-v1_5 | ✓ | RS256, RS384, RS512 |
 | RSASSA-PSS | ✓ | PS256, PS384, PS512 |
-| ECDSA | ✓ | ES256, ES384, ES512 |
+| ECDSA | ✓ | ES256, ES256K, ES384, ES512 |
 | HMAC with SHA-2 | ✓ | HS256, HS384, HS512 |
 
 | JWE Key Management Algorithms | Supported ||

lib/help/asn1/index.js

@@ -21,4 +21,3 @@ const RSAPublicKey = asn1.define('RSAPublicKey', require('./rsa_public_key'))
 types.set('RSAPublicKey', RSAPublicKey)
 
 module.exports = types
-module.exports.BN = asn1.bignum

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)
 }

lib/help/key_utils.js

@@ -2,21 +2,29 @@ const base64url = require('./base64url')
 const errors = require('../errors')
 const asn1 = require('./asn1')
 
-const EC_CURVES = new Set(['P-256', 'P-384', 'P-521'])
+const EC_CURVES = new Set([
+  'P-256',
+  'P-256K',
+  'P-384',
+  'P-521'
+])
 
 const oidHexToCurve = new Map([
   ['06082a8648ce3d030107', 'P-256'],
+  ['06052b8104000a', 'P-256K'],
   ['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('.')],
+  ['P-256K', '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')],
+  ['P-256K', Buffer.from('06052b8104000a', 'hex')],
   ['P-384', Buffer.from('06052b81040022', 'hex')],
   ['P-521', Buffer.from('06052b81040023', 'hex')]
 ])

lib/help/node_alg.js

@@ -4,6 +4,7 @@ module.exports = (alg) => {
     case 'PS256':
     case 'HS256':
     case 'ES256':
+    case 'ES256K':
       return 'sha256'
     case 'RS384':
     case 'PS384':

lib/index.d.ts

@@ -8,7 +8,7 @@ interface KeyParameters {
     use?: use
     kid?: string
 }
-type curve = 'P-256' | 'P-384' | 'P-521'
+type curve = 'P-256' | 'P-256K' | 'P-384' | 'P-521'
 type keyType = 'RSA' | 'EC' | 'oct'
 type keyOperation = 'encrypt' | 'decrypt' | 'sign' | 'verify' | 'wrapKey' | 'unwrapKey'
 

lib/jwa/ecdh/derive.js

@@ -6,6 +6,8 @@ const crvToCurve = (crv) => {
   switch (crv) {
     case 'P-256':
       return 'prime256v1'
+    case 'P-256K':
+      return 'secp256k1'
     case 'P-384':
       return 'secp384r1'
     case 'P-521':

lib/jwa/ecdsa.js

@@ -23,7 +23,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`)

lib/jwk/key/ec.js

@@ -18,6 +18,8 @@ const crvToDSA = (crv) => {
   switch (crv) {
     case 'P-256':
       return 'ES256'
+    case 'P-256K':
+      return 'ES256K'
     case 'P-384':
       return 'ES384'
     case 'P-521':
@@ -93,12 +95,18 @@ class ECKey extends Key {
   }
 
   static async generate (crv = 'P-256', privat = true) {
+    if (crv === 'P-256K') {
+      crv = 'secp256k1'
+    }
     const { privateKey, publicKey } = await generateKeyPair('ec', { namedCurve: crv })
 
     return privat ? privateKey : publicKey
   }
 
   static generateSync (crv = 'P-256', privat = true) {
+    if (crv === 'P-256K') {
+      crv = 'secp256k1'
+    }
     const { privateKey, publicKey } = generateKeyPairSync('ec', { namedCurve: crv })
 
     return privat ? privateKey : publicKey

test/fixtures/P-256K.key

@@ -0,0 +1,5 @@
+-----BEGIN PRIVATE KEY-----
+MIGEAgEAMBAGByqGSM49AgEGBSuBBAAKBG0wawIBAQQgxTAmXNRL8ksBlr+F3yXD
+rUdRDn1gyIvY/PC2e/iUK7ehRANCAARVFouq0yOD8lFoPORt+K3vOieQ4YNnjapt
+nKWOGqyDdeaoE8aEQH9IScXKYVYNTRPa9F7/hx2clSCcRG6OkgLE
+-----END PRIVATE KEY-----