@darkbio/crypto 0.18.0 → 0.19.1

package/dist/cwt.d.ts

@@ -1,9 +1,7 @@
 import { Codec, Decodable, Encodable } from './cbor.js';
 import * as xdsa from "./xdsa.js";
 import * as xhpke from "./xhpke.js";
-/**
- * Debug port state per RFC 9711 Section 4.2.9.
- */
+/** The debug port state, per RFC 9711 Section 4.2.9. */
 export declare enum DebugState {
     /** Debug is currently enabled. */
     Enabled = 0,
@@ -11,14 +9,19 @@ export declare enum DebugState {
     Disabled = 1,
     /** Debug was disabled at boot and has not been enabled since. */
     DisabledSinceBoot = 2,
-    /** Debug is disabled and cannot be re-enabled. */
+    /**
+     * All debug has been disabled since boot. End users and developers cannot
+     * re-enable it, but the manufacturer identified by `oemid` may do so. The
+     * `oemid` claim must be present, and the application must enforce this.
+     */
     DisabledPermanently = 3,
-    /** All debug, including DMA-based, is permanently disabled. */
+    /**
+     * All debug facilities are permanently disabled, including manufacturer
+     * facilities, and none can be re-enabled.
+     */
     DisabledFullyPermanently = 4
 }
-/**
- * Token intended purpose per RFC 9711 Section 4.3.3.
- */
+/** The token's intended purpose, per RFC 9711 Section 4.3.3. */
 export declare enum IntendedUse {
     /** General-purpose attestation. */
     Generic = 1,
@@ -32,9 +35,11 @@ export declare enum IntendedUse {
     ProofOfPossession = 5
 }
 /**
- * An OEM identifier in one of the three forms RFC 9711 allows, an IANA
- * private enterprise number, a 3 byte IEEE organisationally unique identifier
- * or a 16 byte random identifier.
+ * An OEM identifier in one of the three forms RFC 9711 allows:
+ *
+ * - `pen`, an IANA private enterprise number
+ * - `ieee`, a 3-byte IEEE organizationally unique identifier
+ * - `random`, a 16-byte random identifier
  */
 export type Oemid = {
     pen: bigint;
@@ -46,16 +51,21 @@ export type Oemid = {
 /** Codec of an OEM identifier, an unsigned integer or 3 or 16 bytes. */
 export declare const oemid: Codec<Oemid>;
 /**
- * Codec of a version, the text wrapped in a one element array as RFC 9711
+ * Codec of a version, the text wrapped in a one-element array as RFC 9711
  * has it. The optional scheme element is not supported.
  */
 export declare const version: Codec<string>;
 /**
- * Codec of a confirmation, a public key the token's subject holds, wrapped in
- * a COSE_Key of exactly the key type and the key bytes (RFC 8747).
+ * Codec of a confirmation, a public key the token's subject holds (RFC 8747).
+ * The key is wrapped in a COSE_Key of exactly the key type and the key bytes.
+ *
+ * A verified token authenticates this key binding, but does not prove that
+ * the presenter holds the matching secret key. Applications must check that
+ * separately using their protocol's proof-of-possession mechanism.
  *
  * @param algorithm - The COSE algorithm identifier of the key type
  * @param key - The codec of the key
+ * @returns The codec
  */
 export declare function confirmation<K>(algorithm: number, key: Codec<K>): Codec<K>;
 /**
@@ -69,91 +79,141 @@ export declare const claims: {
     subject: import('./cbor.js').Field<string>;
     /** The audience, the recipients the token is meant for (key 3). */
     audience: import('./cbor.js').Field<string>;
-    /** The expiration, Unix seconds the token is valid until, exclusive (key 4). */
+    /**
+     * The expiration time in seconds since the Unix epoch. The token is
+     * rejected at or after it (key 4).
+     */
     expiration: import('./cbor.js').Field<bigint>;
-    /** The not before time, Unix seconds the token is valid from (key 5). */
+    /**
+     * The not-before time in seconds since the Unix epoch. The token is
+     * rejected before it (key 5).
+     */
     notBefore: import('./cbor.js').Field<bigint>;
-    /** The issue time, Unix seconds the token was issued (key 6). */
+    /** The issue time in seconds since the Unix epoch (key 6). */
     issuedAt: import('./cbor.js').Field<bigint>;
-    /** The token identifier, unique to the token (key 7). */
+    /** The token identifier, opaque bytes unique to the token (key 7). */
     tokenId: import('./cbor.js').Field<Uint8Array<ArrayBufferLike>>;
-    /** The confirmation, an xDSA public key the subject holds (key 8). */
+    /**
+     * The confirmation, an xDSA public key the subject holds (key 8). A
+     * verified token does not prove that the presenter holds the secret key.
+     */
     confirmXdsa: import('./cbor.js').Field<xdsa.PublicKey>;
-    /** The confirmation, an xHPKE public key the subject holds (key 8). */
+    /**
+     * The confirmation, an xHPKE public key the subject holds (key 8). A
+     * verified token does not prove that the presenter holds the secret key.
+     */
     confirmXhpke: import('./cbor.js').Field<xhpke.PublicKey>;
-    /** The Entity Attestation Token claims of RFC 9711. */
+    /**
+     * The Entity Attestation Token claims of RFC 9711.
+     *
+     * These declare the claims and check their wire representations.
+     * Applications must evaluate the claims against their attestation policy and
+     * enforce RFC 9711's relationships between claims. For example, `hwModel`
+     * and `oemBoot` require `oemid`, `hwVersion` requires `hwModel`, and
+     * `swVersion` requires `swName`. {@link DebugState.DisabledPermanently} also
+     * requires `oemid`. {@link verify} does not check these relationships.
+     */
     eat: {
-        /** Universal entity identifier (key 256). */
+        /**
+         * The universal entity identifier, a globally unique device identifier
+         * such as a serial number or IMEI (key 256). Its first byte is the type
+         * prefix of RFC 9711 Section 4.2.1.
+         *
+         * A RAND UEID uses prefix 0x01 followed by 16, 24 or 32 bytes of random
+         * identifier data, provisioned once for the device. The bytes are carried
+         * as supplied, so callers must check the prefix, length and identifier
+         * policy.
+         */
         ueid: import('./cbor.js').Field<Uint8Array<ArrayBufferLike>>;
-        /** OEM identifier (key 258). */
+        /** The hardware manufacturer, in one of the {@link Oemid} forms (key 258). */
         oemid: import('./cbor.js').Field<Oemid>;
-        /** Hardware model (key 259). */
+        /** The product or board model identifier, as the manufacturer defines it (key 259). */
         hwModel: import('./cbor.js').Field<Uint8Array<ArrayBufferLike>>;
-        /** Hardware version (key 260). */
+        /** The hardware revision identifier (key 260). */
         hwVersion: import('./cbor.js').Field<string>;
-        /** Seconds since boot (key 261). */
+        /** The number of seconds since the last boot (key 261). */
         uptime: import('./cbor.js').Field<bigint>;
-        /** Whether the entity booted OEM authorised software (key 262). */
+        /** Whether every boot stage was OEM authorized, so secure boot passed (key 262). */
         oemBoot: import('./cbor.js').Field<boolean>;
-        /** Debug state of the entity (key 263). */
+        /** The state of the device's debug facilities at attestation time (key 263). */
         debugStatus: import('./cbor.js').Field<DebugState>;
-        /** Number of boots (key 267). */
+        /** The number of times the device has booted, never decreasing (key 267). */
         bootCount: import('./cbor.js').Field<bigint>;
-        /** Random seed of the boot (key 268). */
+        /** Random bytes drawn at boot, the same in every token of one boot cycle (key 268). */
         bootSeed: import('./cbor.js').Field<Uint8Array<ArrayBufferLike>>;
-        /** Software name (key 270). */
+        /** The name of the firmware or software running on the device (key 270). */
         swName: import('./cbor.js').Field<string>;
-        /** Software version (key 271). */
+        /** The software version identifier (key 271). */
         swVersion: import('./cbor.js').Field<string>;
-        /** Intended use of the token (key 275). */
+        /** The purpose the token was issued for (key 275). */
         intendedUse: import('./cbor.js').Field<IntendedUse>;
     };
 };
 /**
  * Issues a CWT by signing the claims with COSE Sign1.
  *
- * Uses the current system time as the COSE signature timestamp.
+ * The claims must encode as a CBOR map, such as a `cbor.map` of the
+ * {@link claims} fields. Uses the current system time as the COSE signature
+ * timestamp.
  *
  * @param claims - The claims to include in the token
  * @param signer - The xDSA secret key to sign with
- * @param domain - Application-specific domain separator
+ * @param domain - Application domain for separating protocol purposes
  * @returns The serialized CWT
+ * @throws CodecError if the claims do not fit their codec
+ * @throws If the claims do not encode as a CBOR map
  */
 export declare function issue<C>(claims: Encodable<C>, signer: xdsa.SecretKey, domain: Uint8Array): Promise<Uint8Array>;
 /**
  * Verifies a CWT's COSE signature and temporal validity, then returns the
  * decoded claims.
  *
- * When `now` is provided (Unix timestamp in seconds), temporal claims are
- * validated: nbf must be present and `nbf <= now`, and if exp is present
- * then `now < exp`. When `now` is undefined, temporal validation is skipped.
+ * When `now` is given, the `nbf` claim (key 5) must be present and
+ * `nbf <= now`. If the `exp` claim (key 4) is present too, `now < exp` must
+ * also hold. When `now` is undefined, temporal validation is skipped entirely.
  *
- * @param token - The serialized CWT
+ * The COSE signature timestamp is not checked, since temporal validity comes
+ * from the CWT claims. The codec determines the accepted claim schema.
+ * Successful verification does not establish issuer trust, enforce an
+ * audience, evaluate attestation policy or EAT claim relationships, or prove
+ * possession of a confirmation key. The application must perform those checks.
+ *
+ * @param token - The serialized CWT, bound to the codec of its claims
  * @param verifier - The xDSA public key to verify against
- * @param domain - Application-specific domain separator
- * @param now - Current Unix timestamp for temporal validation (undefined to skip)
+ * @param domain - Application domain for separating protocol purposes
+ * @param now - Time of the check in seconds since the Unix epoch, with
+ *   fractions rounded down, or undefined to skip the time checks
  * @returns The decoded claims
+ * @throws If the token is malformed, does not verify for this key and
+ *   `domain`, or fails a time check
+ * @throws If `now` is negative or beyond 64 bits
+ * @throws CodecError if the claims do not fit their codec
  */
 export declare function verify<C>(token: Decodable<C>, verifier: xdsa.PublicKey, domain: Uint8Array, now?: number | bigint): Promise<C>;
 /**
- * Extracts the signer's fingerprint from a CWT without verifying.
+ * Extracts the signer's fingerprint from a CWT without verifying the
+ * signature.
  *
- * The returned data is unauthenticated. Use this to look up the appropriate
+ * The fingerprint is unauthenticated. Use it to look up the appropriate
  * verification key before calling {@link verify}.
  *
  * @param token - The serialized CWT
- * @returns The signer fingerprint
+ * @returns The signer's fingerprint
+ * @throws If the token is malformed
  */
 export declare function signer(token: Uint8Array): Promise<xdsa.Fingerprint>;
 /**
- * Extracts claims from a CWT without verifying the signature.
+ * Extracts and decodes the claims from a CWT without verifying the signature.
  *
- * **Warning**: The returned payload is unauthenticated and should not be
- * trusted until verified with {@link verify}. Use {@link signer} to extract
- * the signer's fingerprint for key lookup.
+ * The claims are unauthenticated and must not be trusted until verified with
+ * {@link verify}. Use {@link signer} to extract the signer's fingerprint for
+ * key lookup. The one intended use of this function is self-signed key
+ * discovery.
  *
- * @param token - The serialized CWT
- * @returns The decoded (but unverified) claims
+ * @param token - The serialized CWT, bound to the codec of its claims
+ * @returns The decoded, unverified claims
+ * @throws If the token is malformed
+ * @throws CodecError if the claims do not fit their codec
  */
 export declare function peek<C>(token: Decodable<C>): Promise<C>;
 //# sourceMappingURL=cwt.d.ts.map

package/dist/cwt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cwt.d.ts","sourceRoot":"","sources":["../src/cwt.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AAEH,OAAO,EAUL,KAAK,KAAK,EACV,KAAK,SAAS,EACd,KAAK,SAAS,EACf,MAAM,WAAW,CAAC;AAUnB,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AAEpC;;GAEG;AACH,oBAAY,UAAU;IACpB,kCAAkC;IAClC,OAAO,IAAI;IACX,mCAAmC;IACnC,QAAQ,IAAI;IACZ,iEAAiE;IACjE,iBAAiB,IAAI;IACrB,kDAAkD;IAClD,mBAAmB,IAAI;IACvB,+DAA+D;IAC/D,wBAAwB,IAAI;CAC7B;AAED;;GAEG;AACH,oBAAY,WAAW;IACrB,mCAAmC;IACnC,OAAO,IAAI;IACX,4CAA4C;IAC5C,YAAY,IAAI;IAChB,oDAAoD;IACpD,YAAY,IAAI;IAChB,oDAAoD;IACpD,YAAY,IAAI;IAChB,sDAAsD;IACtD,iBAAiB,IAAI;CACtB;AAED;;;;GAIG;AACH,MAAM,MAAM,KAAK,GACf;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC;AAElE,wEAAwE;AACxE,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CA2C9B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE,KAAK,CAAC,MAAM,CAYjC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAU1E;AASD;;;GAGG;AACH,eAAO,MAAM,MAAM;IACjB,+DAA+D;;IAE/D,6DAA6D;;IAE7D,mEAAmE;;IAEnE,gFAAgF;;IAEhF,yEAAyE;;IAEzE,iEAAiE;;IAEjE,yDAAyD;;IAEzD,sEAAsE;;IAEtE,uEAAuE;;IAEvE,uDAAuD;;QAErD,6CAA6C;;QAE7C,gCAAgC;;QAEhC,gCAAgC;;QAEhC,kCAAkC;;QAElC,oCAAoC;;QAEpC,mEAAmE;;QAEnE,2CAA2C;;QAE3C,iCAAiC;;QAEjC,yCAAyC;;QAEzC,+BAA+B;;QAE/B,kCAAkC;;QAElC,2CAA2C;;;CAG9C,CAAC;AAkBF;;;;;;;;;GASG;AACH,wBAAsB,KAAK,CAAC,CAAC,EAC3B,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EACpB,MAAM,EAAE,IAAI,CAAC,SAAS,EACtB,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,UAAU,CAAC,CAGrB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,MAAM,CAAC,CAAC,EAC5B,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EACnB,QAAQ,EAAE,IAAI,CAAC,SAAS,EACxB,MAAM,EAAE,UAAU,EAClB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GACpB,OAAO,CAAC,CAAC,CAAC,CASZ;AAED;;;;;;;;GAQG;AACH,wBAAsB,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAGzE;AAED;;;;;;;;;GASG;AACH,wBAAsB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAG7D"}
+{"version":3,"file":"cwt.d.ts","sourceRoot":"","sources":["../src/cwt.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AAEH,OAAO,EAUL,KAAK,KAAK,EACV,KAAK,SAAS,EACd,KAAK,SAAS,EACf,MAAM,WAAW,CAAC;AAUnB,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AAEpC,wDAAwD;AACxD,oBAAY,UAAU;IACpB,kCAAkC;IAClC,OAAO,IAAI;IACX,mCAAmC;IACnC,QAAQ,IAAI;IACZ,iEAAiE;IACjE,iBAAiB,IAAI;IACrB;;;;OAIG;IACH,mBAAmB,IAAI;IACvB;;;OAGG;IACH,wBAAwB,IAAI;CAC7B;AAED,gEAAgE;AAChE,oBAAY,WAAW;IACrB,mCAAmC;IACnC,OAAO,IAAI;IACX,4CAA4C;IAC5C,YAAY,IAAI;IAChB,oDAAoD;IACpD,YAAY,IAAI;IAChB,oDAAoD;IACpD,YAAY,IAAI;IAChB,sDAAsD;IACtD,iBAAiB,IAAI;CACtB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,KAAK,GACf;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC;AAElE,wEAAwE;AACxE,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CA2C9B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE,KAAK,CAAC,MAAM,CAYjC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAU1E;AASD;;;GAGG;AACH,eAAO,MAAM,MAAM;IACjB,+DAA+D;;IAE/D,6DAA6D;;IAE7D,mEAAmE;;IAEnE;;;OAGG;;IAEH;;;OAGG;;IAEH,8DAA8D;;IAE9D,sEAAsE;;IAEtE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;;;;;;OASG;;QAED;;;;;;;;;WASG;;QAEH,8EAA8E;;QAE9E,uFAAuF;;QAEvF,kDAAkD;;QAElD,2DAA2D;;QAE3D,oFAAoF;;QAEpF,gFAAgF;;QAEhF,6EAA6E;;QAE7E,uFAAuF;;QAEvF,4EAA4E;;QAE5E,iDAAiD;;QAEjD,sDAAsD;;;CAGzD,CAAC;AAkBF;;;;;;;;;;;;;GAaG;AACH,wBAAsB,KAAK,CAAC,CAAC,EAC3B,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EACpB,MAAM,EAAE,IAAI,CAAC,SAAS,EACtB,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,UAAU,CAAC,CAGrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,MAAM,CAAC,CAAC,EAC5B,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EACnB,QAAQ,EAAE,IAAI,CAAC,SAAS,EACxB,MAAM,EAAE,UAAU,EAClB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GACpB,OAAO,CAAC,CAAC,CAAC,CASZ;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAGzE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAG7D"}

package/dist/hkdf.d.ts

@@ -1,34 +1,41 @@
 /**
- * Derive a key from secret, salt, and info using HKDF-SHA256.
+ * Derives a key from the secret, salt and info using HKDF-SHA256.
  *
- * @param secret - The input keying material
- * @param salt - Optional salt value (can be empty)
- * @param info - Optional context/application-specific info (can be empty)
- * @param outLen - Desired output length in bytes (max 8160)
+ * @param secret - The input keying material, already high entropy
+ * @param salt - Optional salt, empty for none
+ * @param info - Context the key is bound to, empty for none
+ * @param outLen - Length of the key in bytes, at most 8160
  * @returns The derived key
+ * @throws If `outLen` is not a whole number between 0 and 8160
  */
 export declare function key(secret: Uint8Array, salt: Uint8Array, info: Uint8Array, outLen: number): Promise<Uint8Array>;
 /**
- * Extract a pseudorandom key from secret and salt using HKDF-SHA256.
+ * Extracts a 32-byte pseudorandom key from the secret and salt, for use with
+ * {@link expand}.
  *
- * Only use this if you need to reuse the extracted key with multiple
- * expand invocations. Most scenarios should use `key` instead.
+ * Only use this to reuse the extracted key with multiple {@link expand} calls
+ * and different contexts. Most scenarios, including the derivation of multiple
+ * keys, should use {@link key} instead.
  *
- * @param secret - The input keying material
- * @param salt - Optional salt value (can be empty)
+ * @param secret - The input keying material, already high entropy
+ * @param salt - Optional salt, empty for none
  * @returns A 32-byte pseudorandom key
  */
 export declare function extract(secret: Uint8Array, salt: Uint8Array): Promise<Uint8Array>;
 /**
- * Expand a pseudorandom key with info using HKDF-SHA256.
+ * Derives a key from a pseudorandom key and context info, skipping the
+ * extraction step.
  *
- * The prk should have been generated by `extract` or be a uniformly
- * random 32-byte key.
+ * The pseudorandom key should come from {@link extract}, or be a uniformly
+ * random or pseudorandom cryptographically strong key. See RFC 5869 Section
+ * 3.3. Most scenarios should use {@link key} instead.
  *
  * @param prk - A 32-byte pseudorandom key
- * @param info - Optional context/application-specific info (can be empty)
- * @param outLen - Desired output length in bytes (max 8160)
+ * @param info - Context the key is bound to, empty for none
+ * @param outLen - Length of the key in bytes, at most 8160
  * @returns The derived key
+ * @throws If `prk` is not 32 bytes, or `outLen` is not a whole number between
+ *   0 and 8160
  */
 export declare function expand(prk: Uint8Array, info: Uint8Array, outLen: number): Promise<Uint8Array>;
 //# sourceMappingURL=hkdf.d.ts.map

package/dist/hkdf.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hkdf.d.ts","sourceRoot":"","sources":["../src/hkdf.ts"],"names":[],"mappings":"AAcA;;;;;;;;GAQG;AACH,wBAAsB,GAAG,CACvB,MAAM,EAAE,UAAU,EAClB,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,CAAC,CAGrB;AAED;;;;;;;;;GASG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,UAAU,EAClB,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,UAAU,CAAC,CAGrB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,MAAM,CAC1B,GAAG,EAAE,UAAU,EACf,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,CAAC,CAGrB"}
+{"version":3,"file":"hkdf.d.ts","sourceRoot":"","sources":["../src/hkdf.ts"],"names":[],"mappings":"AAuCA;;;;;;;;;GASG;AACH,wBAAsB,GAAG,CACvB,MAAM,EAAE,UAAU,EAClB,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,CAAC,CAGrB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,UAAU,EAClB,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,UAAU,CAAC,CAGrB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,MAAM,CAC1B,GAAG,EAAE,UAAU,EACf,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,CAAC,CAGrB"}

package/dist/index.d.ts

@@ -1,9 +1,29 @@
+/**
+ * Post-quantum cryptography for the Dark Bio ecosystem, the Rust library
+ * compiled to WASM behind a typed API.
+ *
+ * Signatures come from `xdsa`, encryption from `xhpke`, and `cose` wraps both
+ * into COSE envelopes using the Dark Bio wire profile. Payloads and
+ * authenticated messages are bound to a `cbor` codec, which declares their
+ * shape. The WASM module loads on the first call of any async function, so
+ * there is no separate setup step.
+ *
+ * @module
+ */
+/** Random bytes from the runtime's secure random source. */
 export * as rand from './rand.js';
+/** HKDF-SHA256 key derivation. */
 export * as hkdf from './hkdf.js';
+/** Argon2id key derivation from passwords. */
 export * as argon2 from './argon2.js';
+/** Typed codecs over the restricted CBOR type system. */
 export * as cbor from './cbor.js';
+/** Composite ML-DSA-65 + Ed25519 digital signatures. */
 export * as xdsa from './xdsa.js';
+/** X-Wing HPKE encryption. */
 export * as xhpke from './xhpke.js';
+/** COSE signing and encryption with xDSA and xHPKE. */
 export * as cose from './cose.js';
+/** CBOR Web Tokens on top of COSE Sign1. */
 export * as cwt from './cwt.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AACtC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;GAWG;AAEH,4DAA4D;AAC5D,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,kCAAkC;AAClC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,8CAA8C;AAC9C,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AACtC,yDAAyD;AACzD,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,wDAAwD;AACxD,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,8BAA8B;AAC9B,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,uDAAuD;AACvD,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,4CAA4C;AAC5C,OAAO,KAAK,GAAG,MAAM,UAAU,CAAC"}