edhoc 1.4.0 → 2.0.0

package/.clang-format

@@ -0,0 +1,79 @@
+# Defines the Chromium style for automatic reformatting.
+# http://clang.llvm.org/docs/ClangFormatStyleOptions.html
+BasedOnStyle: Chromium
+# This defaults to 'Auto'. Explicitly set it for a while, so that
+# 'vector<vector<int> >' in existing files gets formatted to
+# 'vector<vector<int>>'. ('Auto' means that clang-format will only use
+# 'int>>' if the file already contains at least one such instance.)
+ColumnLimit: 120
+Standard: Cpp11
+# TODO(crbug.com/1392808): Remove when InsertBraces has been upstreamed into
+# the Chromium style (is implied by BasedOnStyle: Chromium).
+InsertBraces: true
+InsertNewlineAtEOF: true
+# Sort #includes by following
+# https://google.github.io/styleguide/cppguide.html#Names_and_Order_of_Includes
+#
+# ref: https://clang.llvm.org/docs/ClangFormatStyleOptions.html#includeblocks
+IncludeBlocks: Regroup
+# ref: https://clang.llvm.org/docs/ClangFormatStyleOptions.html#includecategories
+IncludeCategories:
+  # The win32 api has all sorts of implicit include order dependencies :-/
+  # Give a few headers special priorities that make sure they appear before
+  # all other headers.
+  # Sync this with SerializeIncludes in tools/add_header.py.
+  # TODO(crbug.com/329138753): remove include sorting from tools/add_header.py
+  # after confirming clang-format sort works well.
+  # LINT.IfChange(winheader)
+  - Regex:           '^<objbase\.h>' # This has to be before initguid.h.
+    Priority:        1
+  - Regex:           '^<(atlbase|initguid|mmdeviceapi|ocidl|ole2|shobjidl|tchar|unknwn|windows|winsock2|winternl|ws2tcpip)\.h>'
+    Priority:        2
+  # LINT.ThenChange(/tools/add_header.py:winheader)
+  # UIAutomation*.h needs to be after base/win/atl.h.
+  # Note the low priority number.
+  - Regex:           '^<UIAutomation.*\.h>'
+    Priority:        6
+  # Other C system headers.
+  - Regex:           '^<.*\.h>'
+    Priority:        3
+  # C++ standard library headers.
+  - Regex:           '^<.*>'
+    Priority:        4
+  # windows_h_disallowed.h should appear last. Note the low priority number.
+  - Regex:           '"(.*/)?windows_h_disallowed\.h"'
+    Priority:        7
+  # Other libraries.
+  - Regex:           '.*'
+    Priority:        5
+# ref: https://clang.llvm.org/docs/ClangFormatStyleOptions.html#includeismainregex
+IncludeIsMainRegex: "\
+(_(32|64|android|apple|chromeos|freebsd|fuchsia|fuzzer|ios|linux|mac|nacl|openbsd|posix|stubs?|win))?\
+(_(unit|browser|perf)?tests?)?$"
+# Make sure code like:
+# IPC_BEGIN_MESSAGE_MAP()
+#   IPC_MESSAGE_HANDLER(WidgetHostViewHost_Update, OnUpdate)
+# IPC_END_MESSAGE_MAP()
+# gets correctly indented.
+MacroBlockBegin: "^\
+BEGIN_MSG_MAP|\
+BEGIN_MSG_MAP_EX|\
+BEGIN_SAFE_MSG_MAP_EX|\
+CR_BEGIN_MSG_MAP_EX|\
+IPC_BEGIN_MESSAGE_MAP|\
+IPC_BEGIN_MESSAGE_MAP_WITH_PARAM|\
+IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN|\
+IPC_STRUCT_BEGIN|\
+IPC_STRUCT_BEGIN_WITH_PARENT|\
+IPC_STRUCT_TRAITS_BEGIN|\
+POLPARAMS_BEGIN|\
+PPAPI_BEGIN_MESSAGE_MAP$"
+MacroBlockEnd: "^\
+CR_END_MSG_MAP|\
+END_MSG_MAP|\
+IPC_END_MESSAGE_MAP|\
+IPC_PROTOBUF_MESSAGE_TRAITS_END|\
+IPC_STRUCT_END|\
+IPC_STRUCT_TRAITS_END|\
+POLPARAMS_END|\
+PPAPI_END_MESSAGE_MAP$"

package/README.md

@@ -1,6 +1,6 @@
 # EDHOC for Node.js
 
-A TypeScript Node.js library implemented as a native addon, built on top of the C library [`libedhoc`](https://github.com/kamil-kielbasa/libedhoc/). It provides an efficient and lightweight way to use the Ephemeral Diffie-Hellman Over COSE (EDHOC) protocol, as specified in [RFC 9528](https://datatracker.ietf.org/doc/rfc9528/).
+A pure TypeScript implementation of the Ephemeral Diffie-Hellman Over COSE (EDHOC) protocol, as specified in [RFC 9528](https://datatracker.ietf.org/doc/rfc9528/). It provides an efficient and lightweight way to establish secure communication with minimal overhead.
 
 ## Overview
 
@@ -9,8 +9,9 @@ EDHOC is designed for lightweight communication and is particularly suitable for
 ## Features
 
 - Full implementation of the EDHOC protocol (RFC 9528)
-- TypeScript support for type safety and better developer experience
-- Based on [`libedhoc`](https://github.com/kamil-kielbasa/libedhoc), a proven C implementation
+- Pure TypeScript implementation with no native dependencies
+- Type safety and excellent developer experience
+- Software-based cryptography using [`@noble/curves`](https://www.npmjs.com/package/@noble/curves)
 
 ## Installation
 
@@ -143,7 +144,6 @@ For more detailed examples and API documentation, please refer to our [API Docum
 For detailed documentation, refer to:
 
 - [EDHOC Specification (RFC 9528)](https://datatracker.ietf.org/doc/rfc9528/)
-- [API Documentation](#) *(TODO: Link to generated API docs if available)*
 
 ## Contributing
 
@@ -162,7 +162,8 @@ This project is licensed under the [MIT License](LICENSE).
 
 ## Related Projects
 
-- [libedhoc](https://github.com/kamil-kielbasa/libedhoc/) - A C implementation of the Ephemeral Diffie-Hellman Over COSE
+- [@noble/curves](https://github.com/paulmillr/noble-curves) - Audited & minimal JS implementation of elliptic curve cryptography
+- [OSCORE](https://datatracker.ietf.org/doc/rfc8613/) - Object Security for Constrained RESTful Environments
 
 ## Acknowledgments
 

package/dist/cbor-utils.d.ts

@@ -0,0 +1,30 @@
+import { EdhocCredentials, EdhocConnectionID, EdhocEAD, EdhocSuite } from './edhoc';
+/** Encode a CBOR sequence (concatenated CBOR items) */
+export declare function encodeCborSequence(...items: unknown[]): Buffer;
+/** Decode N items from a CBOR sequence buffer */
+export declare function decodeCborSequence(buf: Buffer, count?: number): unknown[];
+/** Encode SUITES_I: single int if one suite, array if multiple (selected last) */
+export declare function encodeSuites(suites: EdhocSuite[], selected: EdhocSuite): number | number[];
+/** Convert a connection ID to its raw byte representation (for OSCORE IDs) */
+export declare function connectionIdToBytes(cid: EdhocConnectionID): Buffer;
+/** Decode a CBOR-decoded value back to an EdhocConnectionID */
+export declare function connectionIdFromCbor(value: unknown): EdhocConnectionID;
+/** Encode ID_CRED_x for PLAINTEXT / context embedding (already CBOR) */
+export declare function encodeIdCred(credentials: EdhocCredentials): Buffer;
+/** Decode an ID_CRED_x value (already CBOR-decoded) into partial credentials */
+export declare function decodeIdCred(value: unknown): EdhocCredentials;
+/** Get the raw credential bytes (CRED_x) from credentials */
+export declare function getCredBytes(credentials: EdhocCredentials): Buffer;
+/** Encode PLAINTEXT_2/3: ID_CRED_x, Signature_or_MAC_x, ?EAD */
+export declare function encodePlaintext(idCredCbor: Buffer, signatureOrMac: Buffer, ead?: EdhocEAD[]): Buffer;
+/** Parse PLAINTEXT_2/3 into { idCredRaw, signatureOrMac, ead } */
+export declare function parsePlaintext(data: Buffer): {
+    idCredRaw: unknown;
+    signatureOrMac: Buffer;
+    ead: EdhocEAD[];
+};
+/** Encode EAD tokens as a CBOR sequence of (label, ?value) pairs */
+export declare function encodeEadItems(tokens: EdhocEAD[]): Buffer;
+/** Parse EAD items from decoded CBOR values */
+export declare function parseEadItems(items: unknown[]): EdhocEAD[];
+//# sourceMappingURL=cbor-utils.d.ts.map

package/dist/cbor-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cbor-utils.d.ts","sourceRoot":"","sources":["../lib/cbor-utils.ts"],"names":[],"mappings":"AACA,OAAO,EACH,gBAAgB,EAKhB,iBAAiB,EACjB,QAAQ,EACR,UAAU,EACb,MAAM,SAAS,CAAC;AAEjB,uDAAuD;AACvD,wBAAgB,kBAAkB,CAAC,GAAG,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,CAE9D;AAED,iDAAiD;AACjD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,EAAE,CASzE;AAED,kFAAkF;AAClF,wBAAgB,YAAY,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,GAAG,MAAM,GAAG,MAAM,EAAE,CAK1F;AAED,8EAA8E;AAC9E,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,iBAAiB,GAAG,MAAM,CAIlE;AAED,+DAA+D;AAC/D,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,iBAAiB,CAKtE;AAED,wEAAwE;AACxE,wBAAgB,YAAY,CAAC,WAAW,EAAE,gBAAgB,GAAG,MAAM,CAqBlE;AAED,gFAAgF;AAChF,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CA6B7D;AAED,6DAA6D;AAC7D,wBAAgB,YAAY,CAAC,WAAW,EAAE,gBAAgB,GAAG,MAAM,CAiBlE;AAED,gEAAgE;AAChE,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,GAAG,MAAM,CAIpG;AAED,kEAAkE;AAClE,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG;IAAE,SAAS,EAAE,OAAO,CAAC;IAAC,cAAc,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,QAAQ,EAAE,CAAA;CAAE,CAS5G;AAED,oEAAoE;AACpE,wBAAgB,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAOzD;AAED,+CAA+C;AAC/C,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,CAc1D"}

package/dist/cbor-utils.js

@@ -0,0 +1,179 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeCborSequence = encodeCborSequence;
+exports.decodeCborSequence = decodeCborSequence;
+exports.encodeSuites = encodeSuites;
+exports.connectionIdToBytes = connectionIdToBytes;
+exports.connectionIdFromCbor = connectionIdFromCbor;
+exports.encodeIdCred = encodeIdCred;
+exports.decodeIdCred = decodeIdCred;
+exports.getCredBytes = getCredBytes;
+exports.encodePlaintext = encodePlaintext;
+exports.parsePlaintext = parsePlaintext;
+exports.encodeEadItems = encodeEadItems;
+exports.parseEadItems = parseEadItems;
+const cbor_1 = __importDefault(require("cbor"));
+const edhoc_1 = require("./edhoc");
+/** Encode a CBOR sequence (concatenated CBOR items) */
+function encodeCborSequence(...items) {
+    return Buffer.concat(items.map(item => cbor_1.default.encode(item)));
+}
+/** Decode N items from a CBOR sequence buffer */
+function decodeCborSequence(buf, count) {
+    const results = [];
+    let offset = 0;
+    while (offset < buf.length && (count === undefined || results.length < count)) {
+        const result = cbor_1.default.decodeFirstSync(buf.subarray(offset), { extendedResults: true });
+        results.push(result.value);
+        offset += result.length;
+    }
+    return results;
+}
+/** Encode SUITES_I: single int if one suite, array if multiple (selected last) */
+function encodeSuites(suites, selected) {
+    if (suites.length === 1)
+        return suites[0];
+    const rest = suites.filter(s => s !== selected);
+    rest.push(selected);
+    return rest;
+}
+/** Convert a connection ID to its raw byte representation (for OSCORE IDs) */
+function connectionIdToBytes(cid) {
+    if (Buffer.isBuffer(cid))
+        return cid;
+    // RFC 9528 §3.3.2: integer n maps to one-byte bstr with value n + 24
+    return Buffer.from([cid + 24]);
+}
+/** Decode a CBOR-decoded value back to an EdhocConnectionID */
+function connectionIdFromCbor(value) {
+    if (typeof value === 'number')
+        return value;
+    if (Buffer.isBuffer(value))
+        return value;
+    if (value instanceof Uint8Array)
+        return Buffer.from(value);
+    throw new Error(`Invalid connection ID: ${typeof value}`);
+}
+/** Encode ID_CRED_x for PLAINTEXT / context embedding (already CBOR) */
+function encodeIdCred(credentials) {
+    switch (credentials.format) {
+        case edhoc_1.EdhocCredentialsFormat.kid: {
+            const kid = credentials.kid.kid;
+            return cbor_1.default.encode(kid);
+        }
+        case edhoc_1.EdhocCredentialsFormat.x5chain: {
+            const certs = credentials.x5chain.certificates;
+            const map = new Map();
+            map.set(edhoc_1.EdhocCredentialsFormat.x5chain, certs.length === 1 ? certs[0] : certs);
+            return cbor_1.default.encode(map);
+        }
+        case edhoc_1.EdhocCredentialsFormat.x5t: {
+            const x5t = credentials.x5t;
+            const map = new Map();
+            map.set(edhoc_1.EdhocCredentialsFormat.x5t, [x5t.hashAlgorithm, x5t.hash]);
+            return cbor_1.default.encode(map);
+        }
+        default:
+            throw new Error(`Unsupported credential format`);
+    }
+}
+/** Decode an ID_CRED_x value (already CBOR-decoded) into partial credentials */
+function decodeIdCred(value) {
+    if (typeof value === 'number' || Buffer.isBuffer(value) || value instanceof Uint8Array) {
+        const kid = Buffer.isBuffer(value) || value instanceof Uint8Array
+            ? Buffer.from(value) : value;
+        return { format: edhoc_1.EdhocCredentialsFormat.kid, kid: { kid } };
+    }
+    if (value instanceof Map) {
+        if (value.has(edhoc_1.EdhocCredentialsFormat.x5chain)) {
+            const d = value.get(edhoc_1.EdhocCredentialsFormat.x5chain);
+            const certificates = Array.isArray(d)
+                ? d.map((c) => Buffer.from(c))
+                : [Buffer.from(d)];
+            return { format: edhoc_1.EdhocCredentialsFormat.x5chain, x5chain: { certificates } };
+        }
+        if (value.has(edhoc_1.EdhocCredentialsFormat.x5t)) {
+            const arr = value.get(edhoc_1.EdhocCredentialsFormat.x5t);
+            return {
+                format: edhoc_1.EdhocCredentialsFormat.x5t,
+                x5t: { hashAlgorithm: arr[0], hash: Buffer.from(arr[1]) },
+            };
+        }
+        if (value.has(edhoc_1.EdhocCredentialsFormat.kid)) {
+            return {
+                format: edhoc_1.EdhocCredentialsFormat.kid,
+                kid: { kid: value.get(edhoc_1.EdhocCredentialsFormat.kid) },
+            };
+        }
+    }
+    throw new Error(`Cannot decode ID_CRED_x`);
+}
+/** Get the raw credential bytes (CRED_x) from credentials */
+function getCredBytes(credentials) {
+    switch (credentials.format) {
+        case edhoc_1.EdhocCredentialsFormat.kid: {
+            const c = credentials.kid.credentials;
+            if (!c)
+                throw new Error('KID credentials require credential data');
+            return c;
+        }
+        case edhoc_1.EdhocCredentialsFormat.x5chain:
+            return credentials.x5chain.certificates[0];
+        case edhoc_1.EdhocCredentialsFormat.x5t: {
+            const cert = credentials.x5t.certificate;
+            if (!cert)
+                throw new Error('x5t credentials require the certificate');
+            return cert;
+        }
+        default:
+            throw new Error(`Unsupported credential format for CRED_x`);
+    }
+}
+/** Encode PLAINTEXT_2/3: ID_CRED_x, Signature_or_MAC_x, ?EAD */
+function encodePlaintext(idCredCbor, signatureOrMac, ead) {
+    const parts = [idCredCbor, cbor_1.default.encode(signatureOrMac)];
+    if (ead && ead.length > 0)
+        parts.push(encodeEadItems(ead));
+    return Buffer.concat(parts);
+}
+/** Parse PLAINTEXT_2/3 into { idCredRaw, signatureOrMac, ead } */
+function parsePlaintext(data) {
+    const items = decodeCborSequence(data);
+    if (items.length < 2)
+        throw new Error('PLAINTEXT must contain at least 2 items');
+    const sigRaw = items[1];
+    return {
+        idCredRaw: items[0],
+        signatureOrMac: Buffer.isBuffer(sigRaw) ? sigRaw : Buffer.from(sigRaw),
+        ead: items.length > 2 ? parseEadItems(items.slice(2)) : [],
+    };
+}
+/** Encode EAD tokens as a CBOR sequence of (label, ?value) pairs */
+function encodeEadItems(tokens) {
+    const parts = [];
+    for (const t of tokens) {
+        parts.push(cbor_1.default.encode(t.label));
+        if (t.value && t.value.length > 0)
+            parts.push(cbor_1.default.encode(t.value));
+    }
+    return Buffer.concat(parts);
+}
+/** Parse EAD items from decoded CBOR values */
+function parseEadItems(items) {
+    const result = [];
+    let i = 0;
+    while (i < items.length) {
+        const label = items[i];
+        i++;
+        let value = Buffer.alloc(0);
+        if (i < items.length && typeof items[i] !== 'number') {
+            value = Buffer.isBuffer(items[i]) ? items[i] : Buffer.from(items[i]);
+            i++;
+        }
+        result.push({ label, value });
+    }
+    return result;
+}

package/dist/cipher-suites.d.ts

@@ -0,0 +1,13 @@
+export interface CipherSuiteParams {
+    id: number;
+    aeadAlgorithm: string;
+    aeadKeyLength: number;
+    aeadTagLength: number;
+    aeadIvLength: number;
+    hashLength: number;
+    macLength: number;
+    eccKeyLength: number;
+    eccSignLength: number;
+}
+export declare function getCipherSuiteParams(suite: number): CipherSuiteParams;
+//# sourceMappingURL=cipher-suites.d.ts.map

package/dist/cipher-suites.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cipher-suites.d.ts","sourceRoot":"","sources":["../lib/cipher-suites.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACzB;AAgBD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAIrE"}

package/dist/cipher-suites.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCipherSuiteParams = getCipherSuiteParams;
+// RFC 9528 Section 3.6 - Cipher Suites
+// Uses literal keys to avoid circular dependency with edhoc.ts
+const CIPHER_SUITES = {
+    0: { id: 0, aeadAlgorithm: 'AES-CCM-16-64-128', aeadKeyLength: 16, aeadTagLength: 8, aeadIvLength: 13, hashLength: 32, macLength: 8, eccKeyLength: 32, eccSignLength: 64 },
+    1: { id: 1, aeadAlgorithm: 'AES-CCM-16-128-128', aeadKeyLength: 16, aeadTagLength: 16, aeadIvLength: 13, hashLength: 32, macLength: 16, eccKeyLength: 32, eccSignLength: 64 },
+    2: { id: 2, aeadAlgorithm: 'AES-CCM-16-64-128', aeadKeyLength: 16, aeadTagLength: 8, aeadIvLength: 13, hashLength: 32, macLength: 8, eccKeyLength: 32, eccSignLength: 64 },
+    3: { id: 3, aeadAlgorithm: 'AES-CCM-16-128-128', aeadKeyLength: 16, aeadTagLength: 16, aeadIvLength: 13, hashLength: 32, macLength: 16, eccKeyLength: 32, eccSignLength: 64 },
+    4: { id: 4, aeadAlgorithm: 'ChaCha20/Poly1305', aeadKeyLength: 32, aeadTagLength: 16, aeadIvLength: 12, hashLength: 32, macLength: 16, eccKeyLength: 32, eccSignLength: 64 },
+    5: { id: 5, aeadAlgorithm: 'ChaCha20/Poly1305', aeadKeyLength: 32, aeadTagLength: 16, aeadIvLength: 12, hashLength: 32, macLength: 16, eccKeyLength: 32, eccSignLength: 64 },
+    6: { id: 6, aeadAlgorithm: 'AES-GCM-128', aeadKeyLength: 16, aeadTagLength: 16, aeadIvLength: 12, hashLength: 32, macLength: 16, eccKeyLength: 32, eccSignLength: 64 },
+    24: { id: 24, aeadAlgorithm: 'AES-GCM-256', aeadKeyLength: 32, aeadTagLength: 16, aeadIvLength: 12, hashLength: 48, macLength: 16, eccKeyLength: 56, eccSignLength: 114 },
+    25: { id: 25, aeadAlgorithm: 'ChaCha20/Poly1305', aeadKeyLength: 32, aeadTagLength: 16, aeadIvLength: 12, hashLength: 32, macLength: 16, eccKeyLength: 32, eccSignLength: 64 },
+};
+function getCipherSuiteParams(suite) {
+    const params = CIPHER_SUITES[suite];
+    if (!params)
+        throw new Error(`Unsupported cipher suite: ${suite}`);
+    return params;
+}