cpace-ts 0.1.0 → 0.1.2

package/README.md

@@ -5,7 +5,7 @@
 [![types](https://img.shields.io/badge/types-.d.ts-blue.svg)](#)
 [![license](https://img.shields.io/badge/license-MIT-green.svg)](#)
 
-**What is it?** Minimal, audit-friendly implementation in strict accordance with version 15 of the [IETF draft](https://datatracker.ietf.org/doc/draft-irtf-cfrg-cpace/) CPace for TS
+**What is it?** Minimal, audit-friendly implementation in strict accordance with version 18 of the [IETF draft](https://datatracker.ietf.org/doc/draft-irtf-cfrg-cpace/) CPace for TS
 **Why?** Clean API, strict validation, audit hooks, test-driven.
 
 ## Features
@@ -18,3 +18,83 @@
 ## Install
 ```bash
 pnpm add cpace-ts
+```
+
+## Usage
+
+```ts
+import {
+  type CPaceMessage,
+  type CPaceMode,
+  type CPaceRole,
+  CPaceSession,
+  G_X25519,
+  sha512,
+} from 'cpace-ts';
+
+const EMPTY_AD = new Uint8Array(0);
+
+export function newSession(role: CPaceRole, prs: Uint8Array): CPaceSession {
+  const suite = {
+    name: 'CPACE-X25519-SHA512',
+    group: G_X25519,
+    hash: sha512,
+  } as const;
+
+  const mode: CPaceMode = 'initiator-responder';
+
+  const s = new CPaceSession({
+    prs,
+    suite,
+    mode,
+    role,
+  });
+
+  return s;
+}
+
+export async function start(s: CPaceSession): Promise<Uint8Array> {
+  const msg = await s.start();
+  if (!msg) throw new Error('CPaceSession.start() returned null/undefined');
+  return msg.payload;
+}
+
+export async function receive(
+  s: CPaceSession,
+  payload: Uint8Array,
+): Promise<Uint8Array> {
+  const inbound: CPaceMessage = {
+    type: 'msg',
+    payload,
+    ad: EMPTY_AD,
+  };
+
+  const out = await s.receive(inbound);
+  return out.payload;
+}
+
+export function exportISK(s: CPaceSession): Uint8Array {
+  return s.exportISK();
+}
+
+async function runFullHandshake() {
+  const prs = new Uint8Array([...]); // Pre-shared secret
+
+  // Setup both parties
+  const initiator = newSession('initiator', prs);
+  const responder = newSession('responder', prs);
+
+  // 1. Initiator starts and sends message to Responder
+  const msg1 = await start(initiator);
+
+  // 2. Responder receives message and sends a reply
+  const msg2 = await receive(responder, msg1);
+
+  // 3. Initiator receives the reply
+  await receive(initiator, msg2);
+
+  // Handshake complete, keys can be exported
+  const initiatorKey = exportISK(initiator);
+  const responderKey = exportISK(responder);
+}
+```

package/package.json

@@ -1,58 +1,59 @@
 {
-  "name": "cpace-ts",
-  "version": "0.1.0",
-  "description": "CPace for TypeScript",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/slava-nikulin/cpace-ts.git"
-  },
-  "license": "MIT",
-  "keywords": [
-    "cpace",
-    "pake"
-  ],
-  "devDependencies": {
-    "@biomejs/biome": "2.3.2",
-    "@types/node": "^24.9.2",
-    "@typescript-eslint/parser": "^8.46.2",
-    "rimraf": "^6.1.0",
-    "ts-node": "^10.9.2",
-    "tsup": "^8.5.0",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.4"
-  },
-  "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    },
-    "./wasm": {
-      "types": "./wasm/pkg/cpace_wasm.d.ts",
-      "import": "./wasm/pkg/cpace_wasm.js"
-    }
-  },
-  "files": [
-    "dist/**",
-    "wasm/pkg/**",
-    "README.md",
-    "LICENSE"
-  ],
-  "dependencies": {
-    "@noble/curves": "^2.0.1"
-  },
-  "scripts": {
-    "build": "pnpm clean && pnpm build:wasm && tsup",
-    "build:wasm": "wasm-pack build crates/cpace-wasm --target web --release --out-dir ../../wasm/pkg",
-    "dev": "tsup --watch",
-    "typecheck": "tsc -p tsconfig.json",
-    "clean": "rimraf dist",
-    "test:unit": "vitest run --project unit",
-    "test:int": "vitest run --project integration",
-    "test": "pnpm test:unit && pnpm test:int"
-  }
+	"name": "cpace-ts",
+	"version": "0.1.2",
+	"description": "CPace for TypeScript",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/slava-nikulin/cpace-ts.git"
+	},
+	"license": "MIT",
+	"keywords": [
+		"cpace",
+		"pake"
+	],
+	"devDependencies": {
+		"@biomejs/biome": "2.3.2",
+		"@types/node": "^24.9.2",
+		"@typescript-eslint/parser": "^8.46.2",
+		"rimraf": "^6.1.0",
+		"ts-node": "^10.9.2",
+		"tsup": "^8.5.0",
+		"typescript": "^5.9.3",
+		"vitest": "^4.0.4"
+	},
+	"type": "module",
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"require": "./dist/index.cjs"
+		},
+		"./wasm": {
+			"types": "./wasm/pkg/cpace_wasm.d.ts",
+			"import": "./wasm/pkg/cpace_wasm.js"
+		}
+	},
+	"files": [
+		"dist/**",
+		"wasm/pkg/**",
+		"README.md",
+		"LICENSE"
+	],
+	"scripts": {
+		"prepack": "pnpm build",
+		"build": "pnpm clean && pnpm build:wasm && tsup",
+		"build:wasm": "wasm-pack build crates/cpace-wasm --target web --release --out-dir ../../wasm/pkg",
+		"dev": "tsup --watch",
+		"typecheck": "tsc -p tsconfig.json",
+		"clean": "rimraf dist",
+		"test:unit": "vitest run --project unit",
+		"test:int": "vitest run --project integration",
+		"test": "pnpm test:unit && pnpm test:int"
+	},
+	"dependencies": {
+		"@noble/curves": "^2.0.1"
+	}
 }

package/wasm/pkg/.gitignore

@@ -1 +0,0 @@
-*

package/wasm/pkg/cpace_wasm.d.ts

@@ -1,38 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-
-export function elligator2_curve25519_u(rep: Uint8Array): Uint8Array;
-
-export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
-
-export interface InitOutput {
-    readonly memory: WebAssembly.Memory;
-    readonly elligator2_curve25519_u: (a: number, b: number) => [number, number, number, number];
-    readonly __wbindgen_externrefs: WebAssembly.Table;
-    readonly __wbindgen_malloc: (a: number, b: number) => number;
-    readonly __externref_table_dealloc: (a: number) => void;
-    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
-    readonly __wbindgen_start: () => void;
-}
-
-export type SyncInitInput = BufferSource | WebAssembly.Module;
-
-/**
- * Instantiates the given `module`, which can either be bytes or
- * a precompiled `WebAssembly.Module`.
- *
- * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
- *
- * @returns {InitOutput}
- */
-export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
-
-/**
- * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
- * for everything else, calls `WebAssembly.instantiate` directly.
- *
- * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
- *
- * @returns {Promise<InitOutput>}
- */
-export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/wasm/pkg/cpace_wasm.js

@@ -1,180 +0,0 @@
-/* @ts-self-types="./cpace_wasm.d.ts" */
-
-/**
- * @param {Uint8Array} rep
- * @returns {Uint8Array}
- */
-export function elligator2_curve25519_u(rep) {
-    const ptr0 = passArray8ToWasm0(rep, wasm.__wbindgen_malloc);
-    const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.elligator2_curve25519_u(ptr0, len0);
-    if (ret[3]) {
-        throw takeFromExternrefTable0(ret[2]);
-    }
-    var v2 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
-    wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
-    return v2;
-}
-
-function __wbg_get_imports() {
-    const import0 = {
-        __proto__: null,
-        __wbindgen_cast_0000000000000001: function(arg0, arg1) {
-            // Cast intrinsic for `Ref(String) -> Externref`.
-            const ret = getStringFromWasm0(arg0, arg1);
-            return ret;
-        },
-        __wbindgen_init_externref_table: function() {
-            const table = wasm.__wbindgen_externrefs;
-            const offset = table.grow(4);
-            table.set(0, undefined);
-            table.set(offset + 0, undefined);
-            table.set(offset + 1, null);
-            table.set(offset + 2, true);
-            table.set(offset + 3, false);
-        },
-    };
-    return {
-        __proto__: null,
-        "./cpace_wasm_bg.js": import0,
-    };
-}
-
-function getArrayU8FromWasm0(ptr, len) {
-    ptr = ptr >>> 0;
-    return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
-}
-
-function getStringFromWasm0(ptr, len) {
-    ptr = ptr >>> 0;
-    return decodeText(ptr, len);
-}
-
-let cachedUint8ArrayMemory0 = null;
-function getUint8ArrayMemory0() {
-    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
-        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
-    }
-    return cachedUint8ArrayMemory0;
-}
-
-function passArray8ToWasm0(arg, malloc) {
-    const ptr = malloc(arg.length * 1, 1) >>> 0;
-    getUint8ArrayMemory0().set(arg, ptr / 1);
-    WASM_VECTOR_LEN = arg.length;
-    return ptr;
-}
-
-function takeFromExternrefTable0(idx) {
-    const value = wasm.__wbindgen_externrefs.get(idx);
-    wasm.__externref_table_dealloc(idx);
-    return value;
-}
-
-let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
-cachedTextDecoder.decode();
-const MAX_SAFARI_DECODE_BYTES = 2146435072;
-let numBytesDecoded = 0;
-function decodeText(ptr, len) {
-    numBytesDecoded += len;
-    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
-        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
-        cachedTextDecoder.decode();
-        numBytesDecoded = len;
-    }
-    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
-}
-
-let WASM_VECTOR_LEN = 0;
-
-let wasmModule, wasm;
-function __wbg_finalize_init(instance, module) {
-    wasm = instance.exports;
-    wasmModule = module;
-    cachedUint8ArrayMemory0 = null;
-    wasm.__wbindgen_start();
-    return wasm;
-}
-
-async function __wbg_load(module, imports) {
-    if (typeof Response === 'function' && module instanceof Response) {
-        if (typeof WebAssembly.instantiateStreaming === 'function') {
-            try {
-                return await WebAssembly.instantiateStreaming(module, imports);
-            } catch (e) {
-                const validResponse = module.ok && expectedResponseType(module.type);
-
-                if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
-                    console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
-
-                } else { throw e; }
-            }
-        }
-
-        const bytes = await module.arrayBuffer();
-        return await WebAssembly.instantiate(bytes, imports);
-    } else {
-        const instance = await WebAssembly.instantiate(module, imports);
-
-        if (instance instanceof WebAssembly.Instance) {
-            return { instance, module };
-        } else {
-            return instance;
-        }
-    }
-
-    function expectedResponseType(type) {
-        switch (type) {
-            case 'basic': case 'cors': case 'default': return true;
-        }
-        return false;
-    }
-}
-
-function initSync(module) {
-    if (wasm !== undefined) return wasm;
-
-
-    if (module !== undefined) {
-        if (Object.getPrototypeOf(module) === Object.prototype) {
-            ({module} = module)
-        } else {
-            console.warn('using deprecated parameters for `initSync()`; pass a single object instead')
-        }
-    }
-
-    const imports = __wbg_get_imports();
-    if (!(module instanceof WebAssembly.Module)) {
-        module = new WebAssembly.Module(module);
-    }
-    const instance = new WebAssembly.Instance(module, imports);
-    return __wbg_finalize_init(instance, module);
-}
-
-async function __wbg_init(module_or_path) {
-    if (wasm !== undefined) return wasm;
-
-
-    if (module_or_path !== undefined) {
-        if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
-            ({module_or_path} = module_or_path)
-        } else {
-            console.warn('using deprecated parameters for the initialization function; pass a single object instead')
-        }
-    }
-
-    if (module_or_path === undefined) {
-        module_or_path = new URL('cpace_wasm_bg.wasm', import.meta.url);
-    }
-    const imports = __wbg_get_imports();
-
-    if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
-        module_or_path = fetch(module_or_path);
-    }
-
-    const { instance, module } = await __wbg_load(await module_or_path, imports);
-
-    return __wbg_finalize_init(instance, module);
-}
-
-export { initSync, __wbg_init as default };

package/wasm/pkg/cpace_wasm_bg.js

@@ -1,81 +0,0 @@
-/**
- * @param {Uint8Array} rep
- * @returns {Uint8Array}
- */
-export function elligator2_curve25519_u(rep) {
-    const ptr0 = passArray8ToWasm0(rep, wasm.__wbindgen_malloc);
-    const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.elligator2_curve25519_u(ptr0, len0);
-    if (ret[3]) {
-        throw takeFromExternrefTable0(ret[2]);
-    }
-    var v2 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
-    wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
-    return v2;
-}
-export function __wbindgen_cast_0000000000000001(arg0, arg1) {
-    // Cast intrinsic for `Ref(String) -> Externref`.
-    const ret = getStringFromWasm0(arg0, arg1);
-    return ret;
-}
-export function __wbindgen_init_externref_table() {
-    const table = wasm.__wbindgen_externrefs;
-    const offset = table.grow(4);
-    table.set(0, undefined);
-    table.set(offset + 0, undefined);
-    table.set(offset + 1, null);
-    table.set(offset + 2, true);
-    table.set(offset + 3, false);
-}
-function getArrayU8FromWasm0(ptr, len) {
-    ptr = ptr >>> 0;
-    return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
-}
-
-function getStringFromWasm0(ptr, len) {
-    ptr = ptr >>> 0;
-    return decodeText(ptr, len);
-}
-
-let cachedUint8ArrayMemory0 = null;
-function getUint8ArrayMemory0() {
-    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
-        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
-    }
-    return cachedUint8ArrayMemory0;
-}
-
-function passArray8ToWasm0(arg, malloc) {
-    const ptr = malloc(arg.length * 1, 1) >>> 0;
-    getUint8ArrayMemory0().set(arg, ptr / 1);
-    WASM_VECTOR_LEN = arg.length;
-    return ptr;
-}
-
-function takeFromExternrefTable0(idx) {
-    const value = wasm.__wbindgen_externrefs.get(idx);
-    wasm.__externref_table_dealloc(idx);
-    return value;
-}
-
-let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
-cachedTextDecoder.decode();
-const MAX_SAFARI_DECODE_BYTES = 2146435072;
-let numBytesDecoded = 0;
-function decodeText(ptr, len) {
-    numBytesDecoded += len;
-    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
-        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
-        cachedTextDecoder.decode();
-        numBytesDecoded = len;
-    }
-    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
-}
-
-let WASM_VECTOR_LEN = 0;
-
-
-let wasm;
-export function __wbg_set_wasm(val) {
-    wasm = val;
-}

package/wasm/pkg/cpace_wasm_bg.wasm.d.ts

@@ -1,9 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-export const memory: WebAssembly.Memory;
-export const elligator2_curve25519_u: (a: number, b: number) => [number, number, number, number];
-export const __wbindgen_externrefs: WebAssembly.Table;
-export const __wbindgen_malloc: (a: number, b: number) => number;
-export const __externref_table_dealloc: (a: number) => void;
-export const __wbindgen_free: (a: number, b: number, c: number) => void;
-export const __wbindgen_start: () => void;

package/wasm/pkg/package.json

@@ -1,15 +0,0 @@
-{
-  "name": "cpace-wasm",
-  "type": "module",
-  "version": "0.1.0",
-  "files": [
-    "cpace_wasm_bg.wasm",
-    "cpace_wasm.js",
-    "cpace_wasm.d.ts"
-  ],
-  "main": "cpace_wasm.js",
-  "types": "cpace_wasm.d.ts",
-  "sideEffects": [
-    "./snippets/*"
-  ]
-}