@road-labs/ocmf-crypto 0.0.1 → 0.0.4

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2025 Road B.V.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @road-labs/ocmf-crypto
+
+This is a shared crypto package that defines core crypto types and helper functions, particularly for ASN.1 parsing.

package/package.json

@@ -1,10 +1,20 @@
 {
   "name": "@road-labs/ocmf-crypto",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "main": "build/cjs/index.js",
   "module": "build/es2022/index.js",
   "types": "build/types/index.d.ts",
-  "keywords": [],
+  "files": [
+    "build/**/*",
+    "README.md"
+  ],
+  "keywords": [
+    "ocmf"
+  ],
+  "bugs": {
+    "url": "https://github.com/road-labs/ocmf-js/issues"
+  },
+  "homepage": "https://github.com/road-labs/ocmf-js/tree/main/packages/ocmf-crypto#readme",
   "author": "",
   "license": "MIT",
   "description": "",

package/jest.config.js

@@ -1,11 +0,0 @@
-const { createDefaultPreset } = require('ts-jest');
-
-const tsJestTransformCfg = createDefaultPreset().transform;
-
-/** @type {import("jest").Config} **/
-module.exports = {
-  testEnvironment: 'node',
-  transform: {
-    ...tsJestTransformCfg,
-  },
-};

package/src/asn1.ts

@@ -1,159 +0,0 @@
-import { AsnConvert, AsnParser } from '@peculiar/asn1-schema';
-import { PrivateKeyInfo } from '@peculiar/asn1-pkcs8';
-import {
-  ECDSASigValue,
-  ECParameters,
-  ECPrivateKey,
-  id_ecPublicKey,
-  id_secp192r1,
-  id_secp256r1,
-  id_secp384r1,
-} from '@peculiar/asn1-ecc';
-import { AlgorithmIdentifier, SubjectPublicKeyInfo } from '@peculiar/asn1-x509';
-import { Curve } from './types';
-
-export const oidEllipticCurveKey = id_ecPublicKey;
-
-const id_brainpool256r1 = '1.3.36.3.3.2.8.1.1.7';
-const id_brainpool384r1 = '1.3.36.3.3.2.8.1.1.11';
-const id_secp192k1 = '1.3.132.0.31';
-const id_secp256k1 = '1.3.132.0.10';
-
-export const oidToCurve = new Map<string, Curve>([
-  [id_brainpool256r1, 'brainpool256r1'],
-  [id_brainpool384r1, 'brainpool384r1'],
-  [id_secp192k1, 'secp192k1'],
-  [id_secp192r1, 'secp192r1'],
-  [id_secp256k1, 'secp256k1'],
-  [id_secp256r1, 'secp256r1'],
-  [id_secp384r1, 'secp384r1'],
-]);
-
-export const curveToOid = new Map<Curve, string>([
-  ['brainpool256r1', id_brainpool256r1],
-  ['brainpool384r1', id_brainpool384r1],
-  ['secp192k1', id_secp192k1],
-  ['secp192r1', id_secp192r1],
-  ['secp256k1', id_secp256k1],
-  ['secp256r1', id_secp256r1],
-  ['secp384r1', id_secp384r1],
-]);
-
-export interface Pkcs8PrivateKeyInfo {
-  version: number;
-  privateKeyAlgorithm: {
-    algorithm: string;
-  };
-  privateKey: {
-    version: number;
-    privateKey: Uint8Array;
-    parameters?: {
-      namedCurve?: string;
-    };
-    publicKey?: Uint8Array;
-  };
-}
-
-export interface PkixSubjectPublicKeyInfo {
-  algorithm: {
-    algorithm: string;
-    parameters?: {
-      namedCurve?: string;
-    };
-  };
-  subjectPublicKey: Uint8Array;
-}
-
-export interface PkixEcdsaSigValue {
-  r: Uint8Array;
-  s: Uint8Array;
-}
-
-export function decodePkcs8PrivateKeyInfo(
-  value: Uint8Array
-): Pkcs8PrivateKeyInfo {
-  const privateKeyInfo = AsnParser.parse(value, PrivateKeyInfo);
-  if (privateKeyInfo?.privateKeyAlgorithm?.algorithm !== oidEllipticCurveKey) {
-    throw new Error(
-      `Unexpected private key algorithm: ${privateKeyInfo?.privateKeyAlgorithm?.algorithm}`
-    );
-  }
-
-  const privateKey = AsnParser.parse(
-    privateKeyInfo.privateKey.buffer,
-    ECPrivateKey
-  );
-
-  return {
-    version: privateKeyInfo.version,
-    privateKeyAlgorithm: privateKeyInfo.privateKeyAlgorithm,
-    privateKey: {
-      version: privateKey.version,
-      parameters: privateKey.parameters,
-      privateKey: new Uint8Array(privateKey.privateKey.buffer),
-      publicKey: privateKey.publicKey
-        ? new Uint8Array(privateKey.publicKey)
-        : undefined,
-    },
-  };
-}
-
-export function encodePkixSubjectPublicKeyInfo(
-  keyInfo: PkixSubjectPublicKeyInfo
-): Uint8Array {
-  const asn1 = new SubjectPublicKeyInfo({
-    algorithm: new AlgorithmIdentifier({
-      algorithm: keyInfo.algorithm.algorithm,
-      parameters: AsnConvert.serialize(
-        new ECParameters(keyInfo.algorithm.parameters)
-      ),
-    }),
-    subjectPublicKey: keyInfo.subjectPublicKey,
-  });
-  return new Uint8Array(AsnConvert.serialize(asn1));
-}
-
-export function decodePkixSubjectPublicKeyInfo(
-  value: Uint8Array
-): PkixSubjectPublicKeyInfo {
-  const subjectPublicKeyInfo = AsnParser.parse(value, SubjectPublicKeyInfo);
-  if (subjectPublicKeyInfo?.algorithm?.algorithm !== oidEllipticCurveKey) {
-    throw new Error(
-      `Unexpected public key algorithm: ${subjectPublicKeyInfo?.algorithm?.algorithm}`
-    );
-  }
-
-  let parameters: PkixSubjectPublicKeyInfo['algorithm']['parameters'];
-  if (subjectPublicKeyInfo.algorithm.parameters) {
-    parameters = AsnParser.parse(
-      subjectPublicKeyInfo.algorithm.parameters,
-      ECParameters
-    );
-  }
-
-  return {
-    algorithm: {
-      algorithm: subjectPublicKeyInfo.algorithm.algorithm,
-      parameters,
-    },
-    subjectPublicKey: new Uint8Array(subjectPublicKeyInfo.subjectPublicKey),
-  };
-}
-
-export function encodePkixEcdsaSigValue(
-  sigValue: PkixEcdsaSigValue
-): Uint8Array {
-  const asn1 = new ECDSASigValue({
-    r: sigValue.r,
-    s: sigValue.s,
-  });
-  return new Uint8Array(AsnConvert.serialize(asn1));
-}
-
-export function decodePkixEcdsaSigValue(value: Uint8Array): PkixEcdsaSigValue {
-  const subjectPublicKeyInfo = AsnParser.parse(value, ECDSASigValue);
-  return {
-    r: new Uint8Array(subjectPublicKeyInfo.r),
-    s: new Uint8Array(subjectPublicKeyInfo.s),
-  };
-}

package/src/crypto.ts

@@ -1,101 +0,0 @@
-import {
-  Curve,
-  Hash,
-  PrivateKeyFormat,
-  PublicKeyFormat,
-  SignatureFormat,
-} from './types';
-
-export class UnsupportedCurveError extends Error {}
-export class UnsupportedHashError extends Error {}
-export class UnsupportedPrivateKeyFormatError extends Error {}
-export class UnsupportedPublicKeyFormatError extends Error {}
-export class UnsupportedSignatureFormatError extends Error {}
-
-export interface CryptoAdapter {
-  /**
-   * @param value - Encoded private key value
-   * @param format - Encoding format
-   * @return A private key instance
-   * @throws UnsupportedCurveError
-   * @throws UnsupportedPrivateKeyFormatError
-   * @throws Error
-   */
-  decodeEcPrivateKey(
-    value: Uint8Array,
-    format: PrivateKeyFormat
-  ): EcPrivateKey | Promise<EcPrivateKey>;
-
-  /**
-   * @param value - Encoded public key value
-   * @param format - Encoding format
-   * @return A public key instance
-   * @throws UnsupportedCurveError
-   * @throws UnsupportedPublicKeyFormatError
-   * @throws Error
-   */
-  decodeEcPublicKey(
-    value: Uint8Array,
-    format: PublicKeyFormat
-  ): EcPublicKey | Promise<EcPublicKey>;
-
-  /**
-   * @param data - Data to be signed
-   * @param privateKey - Private key to use for signing
-   * @param hash - Hash to apply
-   * @param format - Format to return the signature in
-   * @return Signature encoded in the specified format
-   * @throws UnsupportedHashError
-   * @throws UnsupportedSignatureFormatError
-   * @throws Error
-   */
-  sign(
-    data: Uint8Array,
-    privateKey: EcPrivateKey,
-    hash: Hash,
-    format: SignatureFormat
-  ): Uint8Array | Promise<Uint8Array>;
-
-  /**
-   * @param signature - X.509 ECDSASigValue ASN.1 type DER encoded
-   * @param data - Raw value
-   * @param key - The public key to verify against
-   * @param hash - Hash to apply
-   * @param format - Format the signature is encoded in
-   * @return true if the signature is valid
-   * @throws UnsupportedSignatureFormatError
-   * @throws Error
-   */
-  verify(
-    signature: Uint8Array,
-    data: Uint8Array,
-    key: EcPublicKey,
-    hash: Hash,
-    format: SignatureFormat
-  ): boolean | Promise<boolean>;
-}
-
-export interface EcPublicKey {
-  /**
-   * @return The curve of the public key
-   */
-  getCurve(): Curve;
-
-  /**
-   * @param format - Format to encode with
-   * @return Encoded public key
-   */
-  encode(format: PublicKeyFormat): Uint8Array | Promise<Uint8Array>;
-}
-
-export interface EcPrivateKey {
-  /**
-   * @return The curve of the private key
-   */
-  getCurve(): Curve;
-
-  /**
-   * @return The public key, if available
-   */
-  getPublicKey(): EcPublicKey | null;
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './types';
-export * from './asn1';
-export * from './crypto';

package/src/types.ts

@@ -1,13 +0,0 @@
-export type Curve =
-  | 'brainpool256r1'
-  | 'brainpool384r1'
-  | 'secp192k1'
-  | 'secp192r1'
-  | 'secp256k1'
-  | 'secp256r1'
-  | 'secp384r1';
-
-export type PrivateKeyFormat = 'pkcs8-der'; // PKCS#8 PrivateKeyInfo ASN.1 type DER encoded
-export type PublicKeyFormat = 'spki-der'; // X.509 SubjectPublicKeyInfo ASN.1 type DER encoded
-export type SignatureFormat = 'sigvalue-der'; // X.509 ECDSASigValue ASN.1 type DER encoded
-export type Hash = 'SHA-256';

package/tsconfig.json

@@ -1,4 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "include": ["src/**/*"]
-}