@hpke/hybridkem-x-wing 0.1.0 → 0.4.0

package/README.md

@@ -22,57 +22,46 @@ Documentation: [jsr.io](https://jsr.io/@hpke/hybridkem-x-wing/doc) |
   - [Node.js](#nodejs)
   - [Deno](#deno)
   - [Web Browsers](#web-browsers)
-  - [Cloudflare Workers](#cloudflare-workers)
 - [Usage](#usage)
 - [Contributing](#contributing)
 
 ## Installation
 
+`@hpke/hybridkem-x-wing` needs to be used with
+[@hpke/core](https://github.com/dajiaji/hpke-js/blob/main/packages/core/README.md),
+which can be installed in the same manner as desribed below.
+
 ### Node.js
 
-Using npm:
+You can install the package with npm, yarn or pnpm.
 
 ```sh
+# Using npm:
 npm install @hpke/hybridkem-x-wing
-```
-
-Using yarn:
-
-```sh
 yarn add @hpke/hybridkem-x-wing
+pnpm install @hpke/hybridkem-x-wing
+# Using jsr:
+npx jsr add @hpke/hybridkem-x-wing
+yarn dlx jsr add @hpke/hybridkem-x-wing
+pnpm dlx jsr add @@hpke/hybridkem-x-wing
 ```
 
-### Deno
-
-Starting from version 1.3.0, hpke-js packages are available from the JSR
-registry. From this version onwards, please use JSR import instead of HTTPS
-import in Deno.
-
-**JSR imoprt (recommended on `>=1.3.0`):**
-
-Add hpke-js packages using the commands below:
-
-```sh
-deno add @hpke/core
-deno add @hpke/hybridkem-x-wing
-```
+The above manner can be used with other JavaScript runtimes that support npm,
+such as Cloudflare Workers and Bun.
 
 Then, you can use the module from code like this:
 
 ```ts
-import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
-import { HybridkemXWing } from "@hpke/hybridkem-x-wing";
+import { Aes256Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
+import { XWing } from "@hpke/hybridkem-x-wing";
 ```
 
-**HTTPS imoprt (deprecated):**
+### Deno
 
-```ts
-import {
-  Aes128Gcm,
-  CipherSuite,
-  HkdfSha256,
-} from "https://deno.land/x/hpke/core/mod.ts";
-import { HybridkemXWing } from "https://deno.land/x/hpke/x/hybridkem-x-wing/mod.ts";
+For Deno, it is recommended to use the jsr.io registry.
+
+```sh
+deno add jsr:@hpke/hybridkem-x-wing
 ```
 
 ### Web Browsers
@@ -85,15 +74,23 @@ Using esm.sh:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://esm.sh/@hpke/core@<SEMVER>";
-  import * as kyber from "https://esm.sh/@hpke/hybridkem-x-wing@<SEMVER>";
+  import {
+    Aes256Gcm,
+    CipherSuite,
+    HkdfSha256,
+  } from "https://esm.sh/@hpke/core@<SEMVER>";
+  import { XWing } from "https://esm.sh/@hpke/hybridkem-x-wing@<SEMVER>";
   // ...
 </script>
 
 <!-- use the latest stable version -->
 <script type="module">
-  import * as hpke from "https://esm.sh/@hpke/core";
-  import * as kyber from "https://esm.sh/@hpke/hybridkem-x-wing";
+  import {
+    Aes256Gcm,
+    CipherSuite,
+    HkdfSha256,
+  } from "https://esm.sh/@hpke/core";
+  import { XWing } from "https://esm.sh/@hpke/hybridkem-x-wing";
   // ...
 </script>
 ```
@@ -103,22 +100,16 @@ Using unpkg:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
-  import * as kyber from "https://unpkg.com/@hpke/hybridkem-x-wing@<SEMVER>/esm/mod.js";
+  import {
+    Aes256Gcm,
+    CipherSuite,
+    HkdfSha256,
+  } from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
+  import { XWing } from "https://unpkg.com/@hpke/hybridkem-x-wing@<SEMVER>/esm/mod.js";
   // ...
 </script>
 ```
 
-### Cloudflare Workers
-
-```sh
-git clone git@github.com:dajiaji/hpke-js.git
-cd hpke-js/x/hybridkem-x-wing
-npm install -g esbuild
-deno task dnt
-deno task minify > $YOUR_SRC_PATH/hpke-hybridkem-x-wing.js
-```
-
 ## Usage
 
 This section shows some typical usage examples.
@@ -126,34 +117,34 @@ This section shows some typical usage examples.
 ### Node.js
 
 ```js
-import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
-import { HybridkemXWing } from "@hpke/hybridkem-x-wing";
-// const { HybridkemXWing } = require("@hpke/hybridkem-x-wing");
+import { Aes256Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
+import { XWing } from "@hpke/hybridkem-x-wing";
 
 async function doHpke() {
   // setup
   const suite = new CipherSuite({
-    kem: new HybridkemXWing(),
+    kem: new XWing(),
     kdf: new HkdfSha256(),
-    aead: new Aes128Gcm(),
+    aead: new Aes256Gcm(),
   });
 
   const rkp = await suite.kem.generateKeyPair();
 
+  // Note that the `ct` (ciphertext) resulting from X-Wing Encapsulate() is set to `sender.enc`.
   const sender = await suite.createSenderContext({
     recipientPublicKey: rkp.publicKey,
   });
 
   // encrypt
-  const ct = await sender.seal(new TextEncoder().encode("Hello world!"));
+  const encrypted = await sender.seal(new TextEncoder().encode("Hello world!"));
 
   const recipient = await suite.createRecipientContext({
     recipientKey: rkp.privateKey,
-    enc: sender.enc,
+    enc: sender.enc, // == `ct` (ciphertext) in the context of X-Wing
   });
 
   // decrypt
-  const pt = await recipient.open(ct);
+  const pt = await recipient.open(encrypted);
 
   // Hello world!
   console.log(new TextDecoder().decode(pt));
@@ -169,33 +160,34 @@ try {
 ### Deno
 
 ```ts
-import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
-import { HybridkemXWing } from "@hpke/hybridkem-x-wing";
+import { Aes256Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
+import { XWing } from "@hpke/hybridkem-x-wing";
 
 async function doHpke() {
   // setup
   const suite = new CipherSuite({
-    kem: new HybridkemXWing(),
+    kem: new XWing(),
     kdf: new HkdfSha256(),
-    aead: new Aes128Gcm(),
+    aead: new Aes256Gcm(),
   });
 
   const rkp = await suite.kem.generateKeyPair();
 
+  // Note that the `ct` (ciphertext) resulting from X-Wing::Encapsulate() is set to `sender.enc`.
   const sender = await suite.createSenderContext({
     recipientPublicKey: rkp.publicKey,
   });
 
   // encrypt
-  const ct = await sender.seal(new TextEncoder().encode("Hello world!"));
+  const encrypted = await sender.seal(new TextEncoder().encode("Hello world!"));
 
   const recipient = await suite.createRecipientContext({
     recipientKey: rkp.privateKey,
-    enc: sender.enc,
+    enc: sender.enc, // == `ct` (ciphertext) in the context of X-Wing
   });
 
   // decrypt
-  const pt = await recipient.open(ct);
+  const pt = await recipient.open(encrypted);
 
   // Hello world!
   console.log(new TextDecoder().decode(pt));
@@ -208,7 +200,7 @@ try {
 }
 ```
 
-### Browsers
+### Web Browsers
 
 ```html
 <html>
@@ -216,35 +208,38 @@ try {
   <body>
     <script type="module">
       import {
-        Aes128Gcm,
+        Aes256Gcm,
         CipherSuite,
         HkdfSha256,
-      } from "https://esm.sh/@hpke/core@<SEMVER>";
-      import { HybridkemXWing } from "https://esm.sh/@hpke/hybridkem-x-wing@<SEMVER>";
+      } from "https://esm.sh/@hpke/core";
+      import { XWing } from "https://esm.sh/@hpke/hybridkem-x-wing";
 
       globalThis.doHpke = async () => {
         try {
           const suite = new CipherSuite({
-            kem: new HybridkemXWing(),
+            kem: new XWing(),
             kdf: new HkdfSha256(),
-            aead: new Aes128Gcm(),
+            aead: new Aes256Gcm(),
           });
 
           const rkp = await suite.kem.generateKeyPair();
 
+          // Note that the `ct` resulting from X-Wing::Encapsulate() is set to `sender.enc`.
           const sender = await suite.createSenderContext({
             recipientPublicKey: rkp.publicKey,
           });
           // encrypt
-          const ct = await sender.seal(new TextEncoder().encode("Hello world!"));
+          const encrypted = await sender.seal(
+            new TextEncoder().encode("Hello world!"),
+          );
 
           const recipient = await suite.createRecipientContext({
             recipientKey: rkp.privateKey, // rkp (CryptoKeyPair) is also acceptable.
-            enc: sender.enc,
+            enc: sender.enc, // == `ct` (ciphertext) in the context of X-Wing
           });
 
           // decrypt
-          const pt = await recipient.open(ct);
+          const pt = await recipient.open(encrypted);
 
           // Hello world!
           alert(new TextDecoder().decode(pt));

package/esm/mod.d.ts

@@ -1,2 +1,2 @@
-export { HybridkemXWing } from "./src/hybridkemXWing.js";
+export { XWing } from "./src/xWing.js";
 //# sourceMappingURL=mod.d.ts.map

package/esm/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC"}

package/esm/mod.js

@@ -1 +1 @@
-export { HybridkemXWing } from "./src/hybridkemXWing.js";
+export { XWing } from "./src/xWing.js";

package/esm/src/{hybridkemXWing.d.ts → xWing.d.ts}

@@ -15,15 +15,15 @@ import { X25519 } from "@hpke/dhkem-x25519";
  *
  * ```ts
  * import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
- * import { HybridkemXWing } from "@hpke/hybridkem-x-wing";
+ * import { XWing } from "@hpke/hybridkem-x-wing";
  * const suite = new CipherSuite({
- *   kem: new HybridkemXWing(),
+ *   kem: new XWing(),
  *   kdf: new HkdfSha256(),
  *   aead: new Aes128Gcm(),
  * });
  * ```
  */
-export declare class HybridkemXWing implements KemInterface {
+export declare class XWing implements KemInterface {
     readonly id: KemId;
     readonly name: string;
     readonly secretSize: number;
@@ -63,10 +63,26 @@ export declare class HybridkemXWing implements KemInterface {
      */
     deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
     importKey(_format: "raw" | "jwk", _key: ArrayBuffer | JsonWebKey, _isPublic?: boolean): Promise<CryptoKey>;
+    /**
+     * Encapsulates the shared secret and the `ct` (ciphertext) as `enc`.
+     * @param params The parameters for encapsulation.
+     * @returns {Promise<{ sharedSecret: ArrayBuffer; enc: ArrayBuffer }>} A promise that resolves with the `ss` (shared secret) as `sharedSecret` and the `ct` (ciphertext) as `enc`.
+     * @throws {InvalidParamError} Thrown if the length of the `ekm` is not 64 bytes.
+     * @throws {EncapError} Thrown if the shared secret cannot be encapsulated.
+     */
     encap(params: SenderContextParams): Promise<{
         sharedSecret: ArrayBuffer;
         enc: ArrayBuffer;
     }>;
+    /**
+     * Decapsulates the `ss` (shared secret) from the `enc` and the recipient's private key.
+     * The `enc` is the same as the `ct` (ciphertext) resulting from `X-Wing::Encapsulate(),
+     * which is executed under the `encap()`.
+     * @param params The parameters for decapsulation.
+     * @returns {Promise<ArrayBuffer>} A promise that resolves with the shared secret.
+     * @throws {InvalidParamError} Thrown if the length of the `enc` is not 1120 bytes.
+     * @throws {DecapError} Thrown if the shared secret cannot be decapsulated.
+     */
     decap(params: RecipientContextParams): Promise<ArrayBuffer>;
     /**
      * Sets up the MlKemBase instance by loading the necessary crypto library.
@@ -91,4 +107,4 @@ export declare class HybridkemXWing implements KemInterface {
     private _serializePrivateKey;
     private _deserializePrivateKey;
 }
-//# sourceMappingURL=hybridkemXWing.d.ts.map
+//# sourceMappingURL=xWing.d.ts.map

package/esm/src/xWing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xWing.d.ts","sourceRoot":"","sources":["../../src/src/xWing.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,KAAK,EACV,YAAY,EACZ,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAQL,KAAK,EAKN,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAc,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAwCxD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,KAAM,YAAW,YAAY;IACxC,SAAgB,EAAE,EAAE,KAAK,CAAe;IACxC,SAAgB,IAAI,EAAE,MAAM,CAAY;IACxC,SAAgB,UAAU,EAAE,MAAM,CAAM;IACxC,SAAgB,OAAO,EAAE,MAAM,CAAQ;IACvC,SAAgB,aAAa,EAAE,MAAM,CAAQ;IAC7C,SAAgB,cAAc,EAAE,MAAM,CAAM;IAC5C,SAAgB,IAAI,EAAE,OAAO,CAAS;IACtC,SAAS,CAAC,EAAE,EAAE,QAAQ,CAAC;IACvB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,IAAI,CAAiC;;IAOhC,kBAAkB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IASxD,oBAAoB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;IAS1D,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IASzD,qBAAqB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;IASxE;;;;OAIG;IACU,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC;IAkBtD;;;;;;OAMG;IACU,qBAAqB,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;IAc1E;;;;;;;OAOG;IACU,aAAa,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;IAevD,SAAS,CACpB,OAAO,EAAE,KAAK,GAAG,KAAK,EACtB,IAAI,EAAE,WAAW,GAAG,UAAU,EAC9B,SAAS,UAAO,GACf,OAAO,CAAC,SAAS,CAAC;IAcrB;;;;;;OAMG;IACU,KAAK,CAChB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC;QAAE,YAAY,EAAE,WAAW,CAAC;QAAC,GAAG,EAAE,WAAW,CAAA;KAAE,CAAC;IA4C3D;;;;;;;;OAQG;IACU,KAAK,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAyBxE;;;;OAIG;YACW,MAAM;IAOpB;;;;OAIG;YACW,sBAAsB;IAOpC;;;;OAIG;YACW,uBAAuB;IAUrC,OAAO,CAAC,mBAAmB;IAe3B,OAAO,CAAC,qBAAqB;IAS7B,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,sBAAsB;CAU/B"}

package/esm/src/{hybridkemXWing.js → xWing.js}

@@ -15,7 +15,7 @@ const X25519_BASE = new Uint8Array([
 //   "/^\",
 // );
 // deno-fmt-ignore
-const XWING_LABEL = new Uint8Array([46, 47, 47, 94, 92]);
+const XWING_LABEL = new Uint8Array([92, 46, 47, 47, 94, 92]);
 function emitNotSupported() {
     return new Promise((_resolve, reject) => {
         reject(new NotSupportedError("Not supported"));
@@ -43,21 +43,21 @@ function combiner(ssM, ssX, ctX, pkX) {
  *
  * ```ts
  * import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
- * import { HybridkemXWing } from "@hpke/hybridkem-x-wing";
+ * import { XWing } from "@hpke/hybridkem-x-wing";
  * const suite = new CipherSuite({
- *   kem: new HybridkemXWing(),
+ *   kem: new XWing(),
  *   kdf: new HkdfSha256(),
  *   aead: new Aes128Gcm(),
  * });
  * ```
  */
-export class HybridkemXWing {
+export class XWing {
     constructor() {
         Object.defineProperty(this, "id", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: KemId.HybridkemXWing
+            value: KemId.XWing
         });
         Object.defineProperty(this, "name", {
             enumerable: true,
@@ -233,6 +233,13 @@ export class HybridkemXWing {
         // }
         // return await this.deserializePrivateKey(key as ArrayBuffer);
     }
+    /**
+     * Encapsulates the shared secret and the `ct` (ciphertext) as `enc`.
+     * @param params The parameters for encapsulation.
+     * @returns {Promise<{ sharedSecret: ArrayBuffer; enc: ArrayBuffer }>} A promise that resolves with the `ss` (shared secret) as `sharedSecret` and the `ct` (ciphertext) as `enc`.
+     * @throws {InvalidParamError} Thrown if the length of the `ekm` is not 64 bytes.
+     * @throws {EncapError} Thrown if the shared secret cannot be encapsulated.
+     */
     async encap(params) {
         let ekm = undefined;
         if (params.ekm !== undefined && !isCryptoKeyPair(params.ekm)) {
@@ -277,6 +284,15 @@ export class HybridkemXWing {
             throw new EncapError(e);
         }
     }
+    /**
+     * Decapsulates the `ss` (shared secret) from the `enc` and the recipient's private key.
+     * The `enc` is the same as the `ct` (ciphertext) resulting from `X-Wing::Encapsulate(),
+     * which is executed under the `encap()`.
+     * @param params The parameters for decapsulation.
+     * @returns {Promise<ArrayBuffer>} A promise that resolves with the shared secret.
+     * @throws {InvalidParamError} Thrown if the length of the `enc` is not 1120 bytes.
+     * @throws {DecapError} Thrown if the shared secret cannot be decapsulated.
+     */
     async decap(params) {
         const rSk = isCryptoKeyPair(params.recipientKey)
             ? params.recipientKey.privateKey

package/esm/test/testVectors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testVectors.d.ts","sourceRoot":"","sources":["../../src/test/testVectors.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,UAAU,CAY1C,CAAC"}
+{"version":3,"file":"testVectors.d.ts","sourceRoot":"","sources":["../../src/test/testVectors.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,UAAU,CAkC1C,CAAC"}

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@hpke/hybridkem-x-wing",
-  "version": "0.1.0",
-  "description": "A Hybrid Public Key Encryption (HPKE) module extension for a hybrid post-quantum KEM, X25519Kyber768Draft00",
+  "version": "0.4.0",
+  "description": "A Hybrid Public Key Encryption (HPKE) module extension for X-Wing: general-purpose hybrid post-quantum KEM.",
   "keywords": [
     "hpke",
-    "rfc9180",
-    "kem",
+    "ml-kem",
     "kyber",
     "x25519",
     "post-quantum",
+    "pqc",
+    "x-wing",
     "security",
     "encryption"
   ],
@@ -40,15 +41,15 @@
     "node": ">=16.0.0"
   },
   "dependencies": {
-    "@hpke/common": "^1.4.3",
-    "@hpke/dhkem-x25519": "^1.4.3",
-    "@noble/hashes": "^1.4.0",
-    "mlkem": "^2.2.0"
+    "@hpke/common": "^1.6.1",
+    "@hpke/dhkem-x25519": "^1.6.0",
+    "@noble/hashes": "^1.5.0",
+    "mlkem": "^2.3.0"
   },
   "devDependencies": {
     "@types/node": "^20.9.0",
     "picocolors": "^1.0.0",
-    "@hpke/core": "^1.4.3",
+    "@hpke/core": "^1.6.0",
     "@deno/shim-deno": "~0.18.0"
   },
   "_generatedBy": "dnt@dev"

package/script/mod.d.ts

@@ -1,2 +1,2 @@
-export { HybridkemXWing } from "./src/hybridkemXWing.js";
+export { XWing } from "./src/xWing.js";
 //# sourceMappingURL=mod.d.ts.map

package/script/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC"}

package/script/mod.js

@@ -4,12 +4,12 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "./src/hybridkemXWing.js"], factory);
+        define(["require", "exports", "./src/xWing.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.HybridkemXWing = void 0;
-    var hybridkemXWing_js_1 = require("./src/hybridkemXWing.js");
-    Object.defineProperty(exports, "HybridkemXWing", { enumerable: true, get: function () { return hybridkemXWing_js_1.HybridkemXWing; } });
+    exports.XWing = void 0;
+    var xWing_js_1 = require("./src/xWing.js");
+    Object.defineProperty(exports, "XWing", { enumerable: true, get: function () { return xWing_js_1.XWing; } });
 });

package/script/src/{hybridkemXWing.d.ts → xWing.d.ts}

@@ -15,15 +15,15 @@ import { X25519 } from "@hpke/dhkem-x25519";
  *
  * ```ts
  * import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
- * import { HybridkemXWing } from "@hpke/hybridkem-x-wing";
+ * import { XWing } from "@hpke/hybridkem-x-wing";
  * const suite = new CipherSuite({
- *   kem: new HybridkemXWing(),
+ *   kem: new XWing(),
  *   kdf: new HkdfSha256(),
  *   aead: new Aes128Gcm(),
  * });
  * ```
  */
-export declare class HybridkemXWing implements KemInterface {
+export declare class XWing implements KemInterface {
     readonly id: KemId;
     readonly name: string;
     readonly secretSize: number;
@@ -63,10 +63,26 @@ export declare class HybridkemXWing implements KemInterface {
      */
     deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
     importKey(_format: "raw" | "jwk", _key: ArrayBuffer | JsonWebKey, _isPublic?: boolean): Promise<CryptoKey>;
+    /**
+     * Encapsulates the shared secret and the `ct` (ciphertext) as `enc`.
+     * @param params The parameters for encapsulation.
+     * @returns {Promise<{ sharedSecret: ArrayBuffer; enc: ArrayBuffer }>} A promise that resolves with the `ss` (shared secret) as `sharedSecret` and the `ct` (ciphertext) as `enc`.
+     * @throws {InvalidParamError} Thrown if the length of the `ekm` is not 64 bytes.
+     * @throws {EncapError} Thrown if the shared secret cannot be encapsulated.
+     */
     encap(params: SenderContextParams): Promise<{
         sharedSecret: ArrayBuffer;
         enc: ArrayBuffer;
     }>;
+    /**
+     * Decapsulates the `ss` (shared secret) from the `enc` and the recipient's private key.
+     * The `enc` is the same as the `ct` (ciphertext) resulting from `X-Wing::Encapsulate(),
+     * which is executed under the `encap()`.
+     * @param params The parameters for decapsulation.
+     * @returns {Promise<ArrayBuffer>} A promise that resolves with the shared secret.
+     * @throws {InvalidParamError} Thrown if the length of the `enc` is not 1120 bytes.
+     * @throws {DecapError} Thrown if the shared secret cannot be decapsulated.
+     */
     decap(params: RecipientContextParams): Promise<ArrayBuffer>;
     /**
      * Sets up the MlKemBase instance by loading the necessary crypto library.
@@ -91,4 +107,4 @@ export declare class HybridkemXWing implements KemInterface {
     private _serializePrivateKey;
     private _deserializePrivateKey;
 }
-//# sourceMappingURL=hybridkemXWing.d.ts.map
+//# sourceMappingURL=xWing.d.ts.map

package/script/src/xWing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xWing.d.ts","sourceRoot":"","sources":["../../src/src/xWing.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,KAAK,EACV,YAAY,EACZ,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAQL,KAAK,EAKN,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAc,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAwCxD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,KAAM,YAAW,YAAY;IACxC,SAAgB,EAAE,EAAE,KAAK,CAAe;IACxC,SAAgB,IAAI,EAAE,MAAM,CAAY;IACxC,SAAgB,UAAU,EAAE,MAAM,CAAM;IACxC,SAAgB,OAAO,EAAE,MAAM,CAAQ;IACvC,SAAgB,aAAa,EAAE,MAAM,CAAQ;IAC7C,SAAgB,cAAc,EAAE,MAAM,CAAM;IAC5C,SAAgB,IAAI,EAAE,OAAO,CAAS;IACtC,SAAS,CAAC,EAAE,EAAE,QAAQ,CAAC;IACvB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,IAAI,CAAiC;;IAOhC,kBAAkB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IASxD,oBAAoB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;IAS1D,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IASzD,qBAAqB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;IASxE;;;;OAIG;IACU,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC;IAkBtD;;;;;;OAMG;IACU,qBAAqB,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;IAc1E;;;;;;;OAOG;IACU,aAAa,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;IAevD,SAAS,CACpB,OAAO,EAAE,KAAK,GAAG,KAAK,EACtB,IAAI,EAAE,WAAW,GAAG,UAAU,EAC9B,SAAS,UAAO,GACf,OAAO,CAAC,SAAS,CAAC;IAcrB;;;;;;OAMG;IACU,KAAK,CAChB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC;QAAE,YAAY,EAAE,WAAW,CAAC;QAAC,GAAG,EAAE,WAAW,CAAA;KAAE,CAAC;IA4C3D;;;;;;;;OAQG;IACU,KAAK,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAyBxE;;;;OAIG;YACW,MAAM;IAOpB;;;;OAIG;YACW,sBAAsB;IAOpC;;;;OAIG;YACW,uBAAuB;IAUrC,OAAO,CAAC,mBAAmB;IAe3B,OAAO,CAAC,qBAAqB;IAS7B,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,sBAAsB;CAU/B"}

package/script/src/{hybridkemXWing.js → xWing.js}

@@ -9,7 +9,7 @@
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.HybridkemXWing = void 0;
+    exports.XWing = void 0;
     const sha3_1 = require("@noble/hashes/sha3");
     // @ts-ignore: Unreachable code error
     const mlkem_1 = require("mlkem");
@@ -27,7 +27,7 @@
     //   "/^\",
     // );
     // deno-fmt-ignore
-    const XWING_LABEL = new Uint8Array([46, 47, 47, 94, 92]);
+    const XWING_LABEL = new Uint8Array([92, 46, 47, 47, 94, 92]);
     function emitNotSupported() {
         return new Promise((_resolve, reject) => {
             reject(new common_1.NotSupportedError("Not supported"));
@@ -55,21 +55,21 @@
      *
      * ```ts
      * import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
-     * import { HybridkemXWing } from "@hpke/hybridkem-x-wing";
+     * import { XWing } from "@hpke/hybridkem-x-wing";
      * const suite = new CipherSuite({
-     *   kem: new HybridkemXWing(),
+     *   kem: new XWing(),
      *   kdf: new HkdfSha256(),
      *   aead: new Aes128Gcm(),
      * });
      * ```
      */
-    class HybridkemXWing {
+    class XWing {
         constructor() {
             Object.defineProperty(this, "id", {
                 enumerable: true,
                 configurable: true,
                 writable: true,
-                value: common_1.KemId.HybridkemXWing
+                value: common_1.KemId.XWing
             });
             Object.defineProperty(this, "name", {
                 enumerable: true,
@@ -245,6 +245,13 @@
             // }
             // return await this.deserializePrivateKey(key as ArrayBuffer);
         }
+        /**
+         * Encapsulates the shared secret and the `ct` (ciphertext) as `enc`.
+         * @param params The parameters for encapsulation.
+         * @returns {Promise<{ sharedSecret: ArrayBuffer; enc: ArrayBuffer }>} A promise that resolves with the `ss` (shared secret) as `sharedSecret` and the `ct` (ciphertext) as `enc`.
+         * @throws {InvalidParamError} Thrown if the length of the `ekm` is not 64 bytes.
+         * @throws {EncapError} Thrown if the shared secret cannot be encapsulated.
+         */
         async encap(params) {
             let ekm = undefined;
             if (params.ekm !== undefined && !(0, common_1.isCryptoKeyPair)(params.ekm)) {
@@ -289,6 +296,15 @@
                 throw new common_1.EncapError(e);
             }
         }
+        /**
+         * Decapsulates the `ss` (shared secret) from the `enc` and the recipient's private key.
+         * The `enc` is the same as the `ct` (ciphertext) resulting from `X-Wing::Encapsulate(),
+         * which is executed under the `encap()`.
+         * @param params The parameters for decapsulation.
+         * @returns {Promise<ArrayBuffer>} A promise that resolves with the shared secret.
+         * @throws {InvalidParamError} Thrown if the length of the `enc` is not 1120 bytes.
+         * @throws {DecapError} Thrown if the shared secret cannot be decapsulated.
+         */
         async decap(params) {
             const rSk = (0, common_1.isCryptoKeyPair)(params.recipientKey)
                 ? params.recipientKey.privateKey
@@ -391,5 +407,5 @@
             });
         }
     }
-    exports.HybridkemXWing = HybridkemXWing;
+    exports.XWing = XWing;
 });

package/script/test/testVectors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testVectors.d.ts","sourceRoot":"","sources":["../../src/test/testVectors.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,UAAU,CAY1C,CAAC"}
+{"version":3,"file":"testVectors.d.ts","sourceRoot":"","sources":["../../src/test/testVectors.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,UAAU,CAkC1C,CAAC"}

package/esm/src/hybridkemXWing.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"hybridkemXWing.d.ts","sourceRoot":"","sources":["../../src/src/hybridkemXWing.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,KAAK,EACV,YAAY,EACZ,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAQL,KAAK,EAKN,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAc,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAwCxD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,cAAe,YAAW,YAAY;IACjD,SAAgB,EAAE,EAAE,KAAK,CAAwB;IACjD,SAAgB,IAAI,EAAE,MAAM,CAAY;IACxC,SAAgB,UAAU,EAAE,MAAM,CAAM;IACxC,SAAgB,OAAO,EAAE,MAAM,CAAQ;IACvC,SAAgB,aAAa,EAAE,MAAM,CAAQ;IAC7C,SAAgB,cAAc,EAAE,MAAM,CAAM;IAC5C,SAAgB,IAAI,EAAE,OAAO,CAAS;IACtC,SAAS,CAAC,EAAE,EAAE,QAAQ,CAAC;IACvB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,IAAI,CAAiC;;IAOhC,kBAAkB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IASxD,oBAAoB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;IAS1D,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IASzD,qBAAqB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;IASxE;;;;OAIG;IACU,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC;IAkBtD;;;;;;OAMG;IACU,qBAAqB,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;IAc1E;;;;;;;OAOG;IACU,aAAa,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;IAevD,SAAS,CACpB,OAAO,EAAE,KAAK,GAAG,KAAK,EACtB,IAAI,EAAE,WAAW,GAAG,UAAU,EAC9B,SAAS,UAAO,GACf,OAAO,CAAC,SAAS,CAAC;IAcR,KAAK,CAChB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC;QAAE,YAAY,EAAE,WAAW,CAAC;QAAC,GAAG,EAAE,WAAW,CAAA;KAAE,CAAC;IA4C9C,KAAK,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAyBxE;;;;OAIG;YACW,MAAM;IAOpB;;;;OAIG;YACW,sBAAsB;IAOpC;;;;OAIG;YACW,uBAAuB;IAUrC,OAAO,CAAC,mBAAmB;IAe3B,OAAO,CAAC,qBAAqB;IAS7B,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,sBAAsB;CAU/B"}

package/script/src/hybridkemXWing.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"hybridkemXWing.d.ts","sourceRoot":"","sources":["../../src/src/hybridkemXWing.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,KAAK,EACV,YAAY,EACZ,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAQL,KAAK,EAKN,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAc,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAwCxD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,cAAe,YAAW,YAAY;IACjD,SAAgB,EAAE,EAAE,KAAK,CAAwB;IACjD,SAAgB,IAAI,EAAE,MAAM,CAAY;IACxC,SAAgB,UAAU,EAAE,MAAM,CAAM;IACxC,SAAgB,OAAO,EAAE,MAAM,CAAQ;IACvC,SAAgB,aAAa,EAAE,MAAM,CAAQ;IAC7C,SAAgB,cAAc,EAAE,MAAM,CAAM;IAC5C,SAAgB,IAAI,EAAE,OAAO,CAAS;IACtC,SAAS,CAAC,EAAE,EAAE,QAAQ,CAAC;IACvB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,IAAI,CAAiC;;IAOhC,kBAAkB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IASxD,oBAAoB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;IAS1D,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IASzD,qBAAqB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;IASxE;;;;OAIG;IACU,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC;IAkBtD;;;;;;OAMG;IACU,qBAAqB,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;IAc1E;;;;;;;OAOG;IACU,aAAa,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;IAevD,SAAS,CACpB,OAAO,EAAE,KAAK,GAAG,KAAK,EACtB,IAAI,EAAE,WAAW,GAAG,UAAU,EAC9B,SAAS,UAAO,GACf,OAAO,CAAC,SAAS,CAAC;IAcR,KAAK,CAChB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC;QAAE,YAAY,EAAE,WAAW,CAAC;QAAC,GAAG,EAAE,WAAW,CAAA;KAAE,CAAC;IA4C9C,KAAK,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAyBxE;;;;OAIG;YACW,MAAM;IAOpB;;;;OAIG;YACW,sBAAsB;IAOpC;;;;OAIG;YACW,uBAAuB;IAUrC,OAAO,CAAC,mBAAmB;IAe3B,OAAO,CAAC,qBAAqB;IAS7B,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,sBAAsB;CAU/B"}