@verii/cose-key 1.0.0-pre.1753171788

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1 @@
+Copyright 2025 Velocity Team Authors

package/index.js

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2025 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+module.exports = {
+  ...require('./src/derive-ec-y-values'),
+  ...require('./src/cose-key'),
+  ...require('./src/cose-iana'),
+  ...require('./src/jwk-converters'),
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@verii/cose-key",
+  "version": "1.0.0-pre.1753171788",
+  "description": "Set of cose key functions used in Verii projects",
+  "repository": "https://github.com/LFDT-Verii/core",
+  "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --config ./jest.config.js --runInBand --coverage",
+    "lint": "eslint . --format json >> eslint.json",
+    "lint:fix": "eslint --fix --ext .js ."
+  },
+  "author": "Velocity Team",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "bigint-crypto-utils": "3.3.0",
+    "cborg": "4.2.12",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@verii/crypto": "1.0.0-pre.1753171788",
+    "eslint": "8.57.1",
+    "eslint-config-airbnb-base": "14.2.1",
+    "eslint-config-prettier": "8.10.0",
+    "eslint-plugin-autofix": "1.1.0",
+    "eslint-plugin-better-mutation": "1.7.0",
+    "eslint-plugin-import": "2.32.0",
+    "eslint-plugin-prefer-arrow-functions": "3.6.2",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-watch": "7.0.0",
+    "jest": "29.7.0",
+    "prettier": "2.8.8"
+  },
+  "nx": {
+    "tags": [
+      "lib"
+    ]
+  },
+  "gitHead": "e6116b2410d04efa61841268ab1b378e1c1c6060"
+}

package/src/cose-iana.js

@@ -0,0 +1,259 @@
+/*
+ * Copyright 2025 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// Code snippet inspired by: https://github.com/ldclabs/cose-ts
+
+// IANA-registered COSE common key parameters.
+//
+// From IANA registry <https://www.iana.org/assignments/cose/cose.xhtml#key-common-parameters>
+// as of 2022-12-19.
+
+const KeyParameters = {
+  Reserved: 0,
+  Kty: 1,
+  Kid: 2,
+  Alg: 3,
+  KeyOps: 4,
+  BaseIV: 5,
+};
+
+const KeyTypes = {
+  Reserved: 0,
+  OKP: 1,
+  EC2: 2,
+  RSA: 3,
+  Symmetric: 4,
+  HSS_LMS: 5,
+  WalnutDSA: 6,
+};
+
+const OKPKeyParameters = {
+  Crv: -1,
+  X: -2,
+  D: -4,
+};
+
+const EC2KeyParameters = {
+  Crv: -1,
+  X: -2,
+  Y: -3,
+  D: -4,
+};
+
+const RSAKeyParameters = {
+  N: -1,
+  E: -2,
+  D: -3,
+  P: -4,
+  Q: -5,
+  DP: -6,
+  DQ: -7,
+  QInv: -8,
+  Other: -9,
+  RI: -10,
+  DI: -11,
+  TI: -12,
+};
+
+const SymmetricKeyParameters = {
+  K: -1,
+};
+
+const HSSLMSKeyParameters = {
+  Pub: -1,
+};
+
+const WalnutDSAKeyParameters = {
+  N: -1,
+  Q: -2,
+  TValues: -3,
+  Matrix1: -4,
+  Permutation1: -5,
+  Matrix2: -6,
+};
+
+const Algorithms = {
+  RS1: -65535,
+  WalnutDSA: -260,
+  RS512: -259,
+  RS384: -258,
+  RS256: -257,
+  ES256K: -47,
+  HSS_LMS: -46,
+  SHAKE256: -45,
+  SHA_512: -44,
+  SHA_384: -43,
+  RSAES_OAEP_SHA_512: -42,
+  RSAES_OAEP_SHA_256: -41,
+  RSAES_OAEP_RFC_8017_default: -40,
+  PS512: -39,
+  PS384: -38,
+  PS256: -37,
+  ES512: -36,
+  ES384: -35,
+  ECDH_SS_A256KW: -34,
+  ECDH_SS_A192KW: -33,
+  ECDH_SS_A128KW: -32,
+  ECDH_ES_A256KW: -31,
+  ECDH_ES_A192KW: -30,
+  ECDH_ES_A128KW: -29,
+  ECDH_SS_HKDF_512: -28,
+  ECDH_SS_HKDF_256: -27,
+  ECDH_ES_HKDF_512: -26,
+  ECDH_ES_HKDF_256: -25,
+  SHAKE128: -18,
+  SHA_512_256: -17,
+  SHA_256: -16,
+  SHA_256_64: -15,
+  SHA_1: -14,
+  Direct_HKDF_AES_256: -13,
+  Direct_HKDF_AES_128: -12,
+  Direct_HKDF_SHA_512: -11,
+  Direct_HKDF_SHA_256: -10,
+  EdDSA: -8,
+  ES256: -7,
+  Direct: -6,
+  A256KW: -5,
+  A192KW: -4,
+  A128KW: -3,
+  Reserved: 0,
+  A128GCM: 1,
+  A192GCM: 2,
+  A256GCM: 3,
+  HMAC_256_64: 4,
+  HMAC_256_256: 5,
+  HMAC_384_384: 6,
+  HMAC_512_512: 7,
+  AES_CCM_16_64_128: 10,
+  AES_CCM_16_64_256: 11,
+  AES_CCM_64_64_128: 12,
+  AES_CCM_64_64_256: 13,
+  AES_MAC_128_64: 14,
+  AES_MAC_256_64: 15,
+  ChaCha20Poly1305: 24,
+  AES_MAC_128_128: 25,
+  AES_MAC_256_128: 26,
+  AES_CCM_16_128_128: 30,
+  AES_CCM_16_128_256: 31,
+  AES_CCM_64_128_128: 32,
+  AES_CCM_64_128_256: 33,
+  IV_GENERATION: 34,
+};
+
+const EllipticCurves = {
+  Reserved: 0,
+  P_256: 1,
+  P_384: 2,
+  P_521: 3,
+  X25519: 4,
+  X448: 5,
+  Ed25519: 6,
+  Ed448: 7,
+  Secp256k1: 8,
+};
+
+const HeaderParameters = {
+  Reserved: 0,
+  Alg: 1,
+  Crit: 2,
+  ContentType: 3,
+  Kid: 4,
+  IV: 5,
+  PartialIV: 6,
+  CounterSignature: 7,
+  CounterSignature0: 9,
+  KidContext: 10,
+  CountersignatureV2: 11,
+  Countersignature0V2: 11,
+  X5Bag: 32,
+  X5Chain: 33,
+  X5T: 34,
+  X5U: 35,
+  CuphNonce: 256,
+  CuphOwnerPubKey: 257,
+};
+
+const HeaderAlgorithmParameters = {
+  X5ChainSender: -29,
+  X5USender: -28,
+  X5TSender: -27,
+  PartyVOther: -26,
+  PartyVNonce: -25,
+  PartyVIdentity: -24,
+  PartyUOther: -23,
+  PartyUNonce: -22,
+  PartyUIdentity: -21,
+  Salt: -20,
+  StaticKeyId: -3,
+  StaticKey: -2,
+  EphemeralKey: -1,
+};
+
+const KeyOperations = {
+  Sign: 1,
+  Verify: 2,
+  Encrypt: 3,
+  Decrypt: 4,
+  WrapKey: 5,
+  UnwrapKey: 6,
+  DeriveKey: 7,
+  DeriveBits: 8,
+  MacCreate: 9,
+  MacVerify: 10,
+};
+
+const CBORTags = {
+  COSEEncrypt0: 16,
+  COSEMac0: 17,
+  COSESign1: 18,
+  CWT: 61,
+  COSEEncrypt: 96,
+  COSEMac: 97,
+  COSESign: 98,
+};
+
+const CWTClaims = {
+  Reserved: 0,
+  Iss: 1,
+  Sub: 2,
+  Aud: 3,
+  Exp: 4,
+  Nbf: 5,
+  Iat: 6,
+  Cti: 7,
+  Cnf: 8,
+  Scope: 9,
+  Nonce: 10,
+};
+
+module.exports = {
+  KeyParameters,
+  KeyTypes,
+  OKPKeyParameters,
+  EC2KeyParameters,
+  RSAKeyParameters,
+  SymmetricKeyParameters,
+  HSSLMSKeyParameters,
+  WalnutDSAKeyParameters,
+  Algorithms,
+  EllipticCurves,
+  HeaderParameters,
+  HeaderAlgorithmParameters,
+  KeyOperations,
+  CBORTags,
+  CWTClaims,
+};

package/src/cose-key.js

@@ -0,0 +1,148 @@
+/*
+ * Copyright 2025 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// Code snippet inspired by: https://github.com/ldclabs/cose-ts
+const { KeyParameters, KeyTypes, EC2KeyParameters } = require('./cose-iana');
+
+const { decodeCBOR } = require('./cose-utils');
+
+const { KVMap, assertBytes, assertIntOrText } = require('./kv-map');
+
+/**
+ * Interface for encryption/decryption.
+ * @typedef {Object} Encryptor
+ * @property {function(): number} nonceSize
+ * @property {function(Uint8Array, Uint8Array, Uint8Array=): Promise<Uint8Array>} encrypt
+ * @property {function(Uint8Array, Uint8Array, Uint8Array=): Promise<Uint8Array>} decrypt
+ */
+
+/**
+ * Interface for MAC generation.
+ * @typedef {Object} MACer
+ * @property {function(Uint8Array): Uint8Array} mac
+ */
+
+/**
+ * Interface for signing.
+ * @typedef {Object} Signer
+ * @property {function(Uint8Array): Uint8Array} sign
+ */
+
+/**
+ * Interface for signature verification.
+ * @typedef {Object} Verifier
+ * @property {function(Uint8Array, Uint8Array): boolean} verify
+ */
+
+/**
+ * Interface for ECDH key exchange.
+ * @typedef {Object} ECDHer
+ * @property {function(CoseKey): Uint8Array} ecdh
+ */
+
+/**
+ * COSE CoseKey representation based on RFC9052 and RFC9053.
+ * @see https://datatracker.ietf.org/doc/html/rfc9052
+ * @see https://datatracker.ietf.org/doc/html/rfc9053
+ */
+class CoseKey extends KVMap {
+  /**
+   * Decode a CoseKey from CBOR bytes.
+   * @param {Uint8Array} data
+   * @returns {Promise<CoseKey>}
+   */
+  static async fromBytes(data) {
+    return new CoseKey(await decodeCBOR(data));
+  }
+
+  /**
+   * @param {Map<any, any>} [kv=new Map()]
+   */
+  constructor(kv = new Map()) {
+    super(kv);
+  }
+
+  /** @returns {number|string} */
+  get kty() {
+    return this.getType(KeyParameters.Kty, assertIntOrText, 'kty');
+  }
+
+  /** @param {number|string} kty */
+  set kty(kty) {
+    this.setParam(KeyParameters.Kty, assertIntOrText(kty, 'kty'));
+  }
+
+  /** @returns {Uint8Array} */
+  get kid() {
+    return this.getBytes(KeyParameters.Kid, 'kid');
+  }
+
+  /** @param {Uint8Array} kid */
+  set kid(kid) {
+    this.setParam(KeyParameters.Kid, assertBytes(kid, 'kid'));
+  }
+
+  /** @returns {number|string} */
+  get alg() {
+    return this.getType(KeyParameters.Alg, assertIntOrText, 'alg');
+  }
+
+  /** @param {number|string} alg */
+  set alg(alg) {
+    this.setParam(KeyParameters.Alg, assertIntOrText(alg, 'alg'));
+  }
+
+  /** @returns {(number|string)[]} */
+  get ops() {
+    return this.getArray(KeyParameters.KeyOps, assertIntOrText, 'ops');
+  }
+
+  /** @param {(number|string)[]} ops */
+  set ops(ops) {
+    if (!Array.isArray(ops)) {
+      throw new TypeError('ops must be an array');
+    }
+    ops.forEach((op) => assertIntOrText(op, 'ops'));
+    this.setParam(KeyParameters.KeyOps, ops);
+  }
+
+  /** @returns {Uint8Array} */
+  get baseIV() {
+    return this.getBytes(KeyParameters.BaseIV, 'Base IV');
+  }
+
+  /** @param {Uint8Array} iv */
+  set baseIV(iv) {
+    this.setParam(KeyParameters.BaseIV, assertBytes(iv, 'Base IV'));
+  }
+
+  /**
+   * Get the key material (secret) depending on key type.
+   * @returns {Uint8Array}
+   * @throws {Error} If the key type is not supported.
+   */
+  getSecret() {
+    switch (this.kty) {
+      case KeyTypes.EC2:
+        return this.getBytes(EC2KeyParameters.D, 'd');
+      default:
+        throw new Error('unsupported key type');
+    }
+  }
+}
+
+module.exports = { CoseKey };

package/src/cose-utils.js

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2025 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// Code snippet inspired by: https://github.com/ldclabs/cose-ts
+
+// TODO convert to use ESM directly and remove the async from all cbor code and clients
+
+/**
+ * Decodes a CBOR-encoded Uint8Array into a JavaScript value.
+ *
+ * @template T
+ * @param {Uint8Array} data - The CBOR-encoded data to decode.
+ * @returns {T} The decoded JavaScript value.
+ * @throws {Error} If decoding fails or duplicate keys are encountered.
+ */
+const decodeCBOR = async (data) => {
+  const { decode } = await import('cborg');
+  return decode(data, {
+    useMaps: true,
+    rejectDuplicateMapKeys: true,
+  });
+};
+
+/**
+ * Encodes a JavaScript value into CBOR format.
+ *
+ * @param {unknown} data - The JavaScript value to encode (e.g., Map, Array, Object).
+ * @returns {Uint8Array} The CBOR-encoded result.
+ */
+const encodeCBOR = async (data) => {
+  const { encode } = await import('cborg');
+  return encode(data, {});
+};
+
+module.exports = { decodeCBOR, encodeCBOR };

package/src/derive-ec-y-values.js

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2025 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+const { modPow } = require('bigint-crypto-utils');
+const { padCharsStart } = require('lodash/fp');
+/**
+ * Is an even coordinate
+ * @param {Buffer} y hex coordinate
+ * @return {boolean} true it is even
+ */
+const isEcYValueEven = (y) => {
+  return y[y.length - 1] % 2 === 0;
+};
+
+const bigIntToHex = (bigint) => {
+  const hex = bigint.toString(16);
+  if (hex.length % 2 === 1) {
+    return `0${hex}`;
+  }
+
+  return hex;
+};
+
+/**
+ * Is an even coordinate
+ * @param {string} crv the crv P-256 or secp256k1
+ * @param {Buffer} x coordinate
+ * @param {boolean} true if the Y coordinate is even
+ * @return {Buffer} y coordinate
+ */
+const deriveEcYValue = (crv, x, yIsEven) => {
+  const expectedMod = yIsEven ? 0n : 1n;
+  const bigX = BigInt(`0x${x.toString('hex')}`);
+
+  // y^2 = x^3 - ax + b
+  let bigY = modPow(
+    bigX ** 3n - bigX * curveParams[crv].a + curveParams[crv].b,
+    curveParams[crv].pIdent,
+    curveParams[crv].prime
+  );
+
+  // If the parity doesn't match it's the *other* root
+  if (bigY % 2n !== expectedMod) {
+    bigY = curveParams[crv].prime - bigY;
+  }
+
+  const hexY = padCharsStart('0', 64, bigIntToHex(bigY));
+
+  return Buffer.from(hexY, 'hex');
+};
+
+const curveParams = {
+  'P-256': {
+    prime: 2n ** 256n - 2n ** 224n + 2n ** 192n + 2n ** 96n - 1n,
+    a: 3n,
+    b: 41058363725152142129326129780047268409114441015993725554835256314039467401291n,
+  },
+  secp256k1: {
+    prime:
+      2n ** 256n -
+      2n ** 32n -
+      2n ** 9n -
+      2n ** 8n -
+      2n ** 7n -
+      2n ** 6n -
+      2n ** 4n -
+      1n,
+    a: 0n,
+    b: 7n,
+  },
+};
+
+const calcPIdent = ({ prime }) => (prime + 1n) / 4n;
+curveParams['P-256'].pIdent = calcPIdent(curveParams['P-256']);
+curveParams.secp256k1.pIdent = calcPIdent(curveParams.secp256k1);
+
+module.exports = {
+  isEcYValueEven,
+  deriveEcYValue,
+};

package/src/jwk-converters.js

@@ -0,0 +1,89 @@
+/*
+ * Copyright 2025 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+const {
+  RSAKeyParameters,
+  EC2KeyParameters,
+  EllipticCurves,
+  KeyTypes,
+  KeyParameters,
+} = require('./cose-iana');
+
+const { CoseKey } = require('./cose-key');
+
+const { deriveEcYValue, isEcYValueEven } = require('./derive-ec-y-values');
+
+const toJwk = (coseKey) => {
+  const kty = coseKey.getParam(KeyParameters.Kty);
+  if (kty === KeyTypes.RSA) {
+    return {
+      kty: 'RSA',
+      n: Buffer.from(coseKey.getParam(RSAKeyParameters.N)).toString(
+        'base64url'
+      ),
+      e: Buffer.from(coseKey.getParam(RSAKeyParameters.E)).toString(
+        'base64url'
+      ),
+    };
+  }
+  if (kty === KeyTypes.EC2) {
+    const crv =
+      coseKey.getParam(EC2KeyParameters.Crv) === EllipticCurves.Secp256k1
+        ? 'secp256k1'
+        : 'P-256';
+    const x = Buffer.from(coseKey.getParam(EC2KeyParameters.X));
+    const y = deriveEcYValue(crv, x, coseKey.getParam(EC2KeyParameters.Y));
+
+    return {
+      kty: 'EC',
+      crv,
+      x: x.toString('base64url'),
+      y: y.toString('base64url'),
+    };
+  }
+
+  throw new Error('Unsupported COSE Key Type (kty)');
+};
+
+const fromJwk = (jwk) => {
+  const key = new CoseKey();
+  if (jwk.kty === 'RSA') {
+    key.kty = KeyTypes.RSA;
+    return key
+      .setParam(RSAKeyParameters.N, Buffer.from(jwk.n, 'base64url'))
+      .setParam(RSAKeyParameters.E, Buffer.from(jwk.e, 'base64url'));
+  }
+  if (jwk.kty === 'EC') {
+    const y = isEcYValueEven(Buffer.from(jwk.y, 'base64url'));
+    key.kty = KeyTypes.EC2;
+    return key
+      .setParam(
+        EC2KeyParameters.Crv,
+        jwk.crv === 'secp256k1'
+          ? EllipticCurves.Secp256k1
+          : EllipticCurves.P_256
+      )
+      .setParam(EC2KeyParameters.X, Buffer.from(jwk.x, 'base64url'))
+      .setParam(EC2KeyParameters.Y, y);
+  }
+  throw new Error('Unsupported JWK Key Type (kty)');
+};
+
+module.exports = {
+  toJwk,
+  fromJwk,
+};

package/src/kv-map.js

@@ -0,0 +1,287 @@
+/*
+ * Copyright 2025 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// Code snippet inspired by: https://github.com/ldclabs/cose-ts
+
+const { encodeCBOR, decodeCBOR } = require('./cose-utils');
+
+/**
+ * A label used as a key in the map. Can be a number or a string.
+ * @typedef {number|string} Label
+ */
+
+/**
+ * A value allowed in the map. Can be a number, string, boolean, Uint8Array, array of values, or another RawMap.
+ * @typedef {number|string|Uint8Array|boolean|Value[]|RawMap} Value
+ */
+
+/**
+ * A raw key-value map used internally by KVMap.
+ * @typedef {Map<Label, Value>} RawMap
+ */
+
+/**
+ * Assertion function that validates and returns a value of type T.
+ * @template T
+ * @callback AssertFn
+ * @param {unknown} value
+ * @param {string} name
+ * @returns {T}
+ */
+
+/**
+ * @param {unknown} value
+ * @param {string} name
+ * @returns {string}
+ * @throws {TypeError}
+ */
+const assertText = (value, name) => {
+  if (typeof value === 'string') {
+    return value;
+  }
+
+  throw new TypeError(`${name} must be a string, but got ${String(value)}`);
+};
+
+/**
+ * @param {unknown} value
+ * @param {string} name
+ * @returns {number}
+ * @throws {TypeError}
+ */
+const assertInt = (value, name) => {
+  if (Number.isSafeInteger(value)) {
+    return value;
+  }
+
+  throw new TypeError(`${name} must be an integer, but got ${String(value)}`);
+};
+
+/**
+ * @param {unknown} value
+ * @param {string} name
+ * @returns {number|string}
+ * @throws {TypeError}
+ */
+const assertIntOrText = (value, name) => {
+  if (typeof value === 'string') {
+    return value;
+  }
+
+  if (Number.isSafeInteger(value)) {
+    return value;
+  }
+
+  throw new TypeError(
+    `${name} must be an integer or string, but got ${String(value)}`
+  );
+};
+
+/**
+ * @param {unknown} value
+ * @param {string} name
+ * @returns {Uint8Array}
+ * @throws {TypeError}
+ */
+const assertBytes = (value, name) => {
+  if (value instanceof Uint8Array) {
+    return value;
+  }
+
+  throw new TypeError(`${name} must be a Uint8Array, but got ${String(value)}`);
+};
+
+/**
+ * @param {unknown} value
+ * @param {string} name
+ * @returns {boolean}
+ * @throws {TypeError}
+ */
+const assertBool = (value, name) => {
+  if (typeof value === 'boolean') {
+    return value;
+  }
+
+  throw new TypeError(`${name} must be a Boolean, but got ${String(value)}`);
+};
+
+/**
+ * @param {unknown} value
+ * @param {string} name
+ * @returns {RawMap}
+ * @throws {TypeError}
+ */
+const assertMap = (value, name) => {
+  if (value instanceof Map) {
+    return value;
+  }
+
+  throw new TypeError(`${name} must be a Map, but got ${String(value)}`);
+};
+
+/**
+ * A class representing a key-value map with typed assertions and CBOR serialization.
+ */
+class KVMap {
+  /**
+   * @param {RawMap} [kv=new Map()]
+   */
+  constructor(kv = new Map()) {
+    if (!(kv instanceof Map)) {
+      throw new TypeError('key/value must be a Map');
+    }
+    this._raw = kv;
+  }
+
+  /**
+   * Decode a KVMap from CBOR bytes.
+   * @param {Uint8Array} data
+   * @returns {KVMap}
+   */
+  static async fromBytes(data) {
+    return new KVMap(await decodeCBOR(data));
+  }
+
+  /**
+   * @param {Label} key
+   * @returns {boolean}
+   */
+  has(key) {
+    return this._raw.has(key);
+  }
+
+  /**
+   * @param {Label} key
+   * @returns {boolean}
+   */
+  delete(key) {
+    return this._raw.delete(key);
+  }
+
+  /**
+   * @param {Label} key
+   * @param {string} [name]
+   * @returns {number}
+   */
+  getInt(key, name) {
+    return assertInt(this._raw.get(key), name ?? String(key));
+  }
+
+  /**
+   * @param {Label} key
+   * @param {string} [name]
+   * @returns {string}
+   */
+  getText(key, name) {
+    return assertText(this._raw.get(key), name ?? String(key));
+  }
+
+  /**
+   * @param {Label} key
+   * @param {string} [name]
+   * @returns {Uint8Array}
+   */
+  getBytes(key, name) {
+    return assertBytes(this._raw.get(key), name ?? String(key));
+  }
+
+  /**
+   * @param {Label} key
+   * @param {string} [name]
+   * @returns {boolean}
+   */
+  getBool(key, name) {
+    return assertBool(this._raw.get(key), name ?? String(key));
+  }
+
+  /**
+   * @template T
+   * @param {Label} key
+   * @param {AssertFn<T>} assertFn
+   * @param {string} [name]
+   * @returns {T}
+   */
+  getType(key, assertFn, name) {
+    return assertFn(this._raw.get(key), name ?? String(key));
+  }
+
+  /**
+   * @template T
+   * @param {Label} key
+   * @param {AssertFn<T>} assertFn
+   * @param {string} [name]
+   * @returns {T[]}
+   * @throws {TypeError}
+   */
+  getArray(key, assertFn, name) {
+    const na = name || String(key);
+    const arr = this._raw.get(key);
+
+    if (!Array.isArray(arr)) {
+      throw new TypeError(`${na} must be an array, but got ${String(arr)}`);
+    }
+
+    for (const item of arr) {
+      assertFn(item, na);
+    }
+
+    return arr;
+  }
+
+  /**
+   * @template T
+   * @param {Label} key
+   * @returns {T | undefined}
+   */
+  getParam(key) {
+    return this._raw.get(key);
+  }
+
+  /**
+   * @param {Label} key
+   * @param {Value} value
+   * @returns {this}
+   */
+  setParam(key, value) {
+    this._raw.set(key, value);
+    return this;
+  }
+
+  /**
+   * @returns {RawMap}
+   */
+  clone() {
+    return new Map(this._raw);
+  }
+
+  /**
+   * @returns {Promise<Uint8Array>}
+   */
+  async toBytes() {
+    return encodeCBOR(this._raw);
+  }
+}
+
+module.exports = {
+  assertText,
+  assertInt,
+  assertIntOrText,
+  assertBytes,
+  assertBool,
+  assertMap,
+  KVMap,
+};