@metamask-previews/kyc-controller 0.0.0-preview-823dcff → 0.0.0-preview-e57e5c3dc

package/dist/ukyc/wrapUserKey.mjs

@@ -0,0 +1,76 @@
+import { base64ToBytes } from "@metamask/utils";
+import { gcm } from "@noble/ciphers/aes";
+import { x25519 } from "@noble/curves/ed25519";
+import { hkdf } from "@noble/hashes/hkdf";
+import { sha256 } from "@noble/hashes/sha2";
+import { hexToBytes, randomBytes } from "@noble/hashes/utils";
+import { toBase64Url } from "../encoding.mjs";
+/**
+ * Wraps (encrypts) a symmetric key so that only the holder of a given X25519
+ * private key can recover it — used to seal the `data_encryption_key` for the
+ * idOS Relay before it is handed to the UKYC API as `wrappedUserKey`.
+ */
+/** X25519 public/private keys and AES-256-GCM keys are all 32 bytes. */
+const X25519_KEY_SIZE_BYTES = 32;
+/** 96-bit IV, the AES-GCM standard nonce size. */
+const IV_SIZE_BYTES = 12;
+/**
+ * Decodes an X25519 public key presented as either hex or base64/base64url.
+ *
+ * @param recipientPublicKey - The recipient's 32-byte X25519 public key.
+ * @returns The raw 32-byte public key.
+ */
+function decodePublicKey(recipientPublicKey) {
+    const isHex = recipientPublicKey.length === X25519_KEY_SIZE_BYTES * 2 &&
+        /^[0-9a-fA-F]+$/u.test(recipientPublicKey);
+    const bytes = isHex
+        ? hexToBytes(recipientPublicKey)
+        : base64ToBytes(recipientPublicKey
+            .replace(/-/gu, '+')
+            .replace(/_/gu, '/')
+            .padEnd(recipientPublicKey.length +
+            ((4 - (recipientPublicKey.length % 4)) % 4), '='));
+    if (bytes.length !== X25519_KEY_SIZE_BYTES) {
+        throw new Error(`UKYC: wrappingPublicKey has unexpected length ${bytes.length}, expected ${X25519_KEY_SIZE_BYTES}.`);
+    }
+    return bytes;
+}
+/**
+ * Wraps `keyToWrap` for the holder of `recipientPublicKey` using an
+ * ephemeral-static ECDH + AES-256-GCM sealed-box scheme:
+ *
+ *   ephemeral = fresh X25519 keypair (one per call)
+ *   shared    = X25519(ephemeralPrivate, recipientPublic)
+ *   aeadKey   = HKDF-SHA256(shared, 32 bytes)
+ *   iv        = 12 random bytes
+ *   ct        = AES-256-GCM(aeadKey, iv).encrypt(keyToWrap)   // ct includes tag
+ *
+ * The recipient reverses it with their private key:
+ *
+ *   shared  = X25519(recipientPrivate, ephemeralPublic)
+ *   aeadKey = HKDF-SHA256(shared, 32 bytes)
+ *   key     = AES-256-GCM(aeadKey, iv).decrypt(ct)
+ *
+ * This mirrors the X25519 + AES-256-GCM/HKDF decryption used for MoonPay
+ * Check/Auth-frame credentials, so both directions share one primitive.
+ *
+ * @param recipientPublicKey - The recipient's X25519 public key (hex or base64).
+ * @param keyToWrap - The raw symmetric key bytes to encrypt (e.g. the
+ * `data_encryption_key`).
+ * @returns Base64url of `ephemeralPublicKey(32) || iv(12) || ciphertext+tag`.
+ */
+export function wrapUserKey(recipientPublicKey, keyToWrap) {
+    const recipient = decodePublicKey(recipientPublicKey);
+    const ephemeralPrivateKey = x25519.utils.randomSecretKey();
+    const ephemeralPublicKey = x25519.getPublicKey(ephemeralPrivateKey);
+    const shared = x25519.getSharedSecret(ephemeralPrivateKey, recipient);
+    const aeadKey = hkdf(sha256, shared, undefined, undefined, 32);
+    const iv = randomBytes(IV_SIZE_BYTES);
+    const ciphertext = gcm(aeadKey, iv).encrypt(keyToWrap);
+    const blob = new Uint8Array(ephemeralPublicKey.length + iv.length + ciphertext.length);
+    blob.set(ephemeralPublicKey, 0);
+    blob.set(iv, ephemeralPublicKey.length);
+    blob.set(ciphertext, ephemeralPublicKey.length + iv.length);
+    return toBase64Url(blob);
+}
+//# sourceMappingURL=wrapUserKey.mjs.map

package/dist/ukyc/wrapUserKey.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrapUserKey.mjs","sourceRoot":"","sources":["../../src/ukyc/wrapUserKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,wBAAwB;AAChD,OAAO,EAAE,GAAG,EAAE,2BAA2B;AACzC,OAAO,EAAE,MAAM,EAAE,8BAA8B;AAC/C,OAAO,EAAE,IAAI,EAAE,2BAA2B;AAC1C,OAAO,EAAE,MAAM,EAAE,2BAA2B;AAC5C,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,4BAA4B;AAE9D,OAAO,EAAE,WAAW,EAAE,wBAAuB;AAE7C;;;;GAIG;AAEH,wEAAwE;AACxE,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC,kDAAkD;AAClD,MAAM,aAAa,GAAG,EAAE,CAAC;AAEzB;;;;;GAKG;AACH,SAAS,eAAe,CAAC,kBAA0B;IACjD,MAAM,KAAK,GACT,kBAAkB,CAAC,MAAM,KAAK,qBAAqB,GAAG,CAAC;QACvD,iBAAiB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAE7C,MAAM,KAAK,GAAG,KAAK;QACjB,CAAC,CAAC,UAAU,CAAC,kBAAkB,CAAC;QAChC,CAAC,CAAC,aAAa,CACX,kBAAkB;aACf,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,MAAM,CACL,kBAAkB,CAAC,MAAM;YACvB,CAAC,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAC7C,GAAG,CACJ,CACJ,CAAC;IAEN,IAAI,KAAK,CAAC,MAAM,KAAK,qBAAqB,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CACb,iDAAiD,KAAK,CAAC,MAAM,cAAc,qBAAqB,GAAG,CACpG,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,WAAW,CACzB,kBAA0B,EAC1B,SAAqB;IAErB,MAAM,SAAS,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;IAEtD,MAAM,mBAAmB,GAAG,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC;IAC3D,MAAM,kBAAkB,GAAG,MAAM,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;IAEpE,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC,mBAAmB,EAAE,SAAS,CAAC,CAAC;IACtE,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IAE/D,MAAM,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IACtC,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAEvD,MAAM,IAAI,GAAG,IAAI,UAAU,CACzB,kBAAkB,CAAC,MAAM,GAAG,EAAE,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAC1D,CAAC;IACF,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;IAChC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACxC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,kBAAkB,CAAC,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;IAE5D,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC","sourcesContent":["import { base64ToBytes } from '@metamask/utils';\nimport { gcm } from '@noble/ciphers/aes';\nimport { x25519 } from '@noble/curves/ed25519';\nimport { hkdf } from '@noble/hashes/hkdf';\nimport { sha256 } from '@noble/hashes/sha2';\nimport { hexToBytes, randomBytes } from '@noble/hashes/utils';\n\nimport { toBase64Url } from '../encoding.js';\n\n/**\n * Wraps (encrypts) a symmetric key so that only the holder of a given X25519\n * private key can recover it — used to seal the `data_encryption_key` for the\n * idOS Relay before it is handed to the UKYC API as `wrappedUserKey`.\n */\n\n/** X25519 public/private keys and AES-256-GCM keys are all 32 bytes. */\nconst X25519_KEY_SIZE_BYTES = 32;\n\n/** 96-bit IV, the AES-GCM standard nonce size. */\nconst IV_SIZE_BYTES = 12;\n\n/**\n * Decodes an X25519 public key presented as either hex or base64/base64url.\n *\n * @param recipientPublicKey - The recipient's 32-byte X25519 public key.\n * @returns The raw 32-byte public key.\n */\nfunction decodePublicKey(recipientPublicKey: string): Uint8Array {\n  const isHex =\n    recipientPublicKey.length === X25519_KEY_SIZE_BYTES * 2 &&\n    /^[0-9a-fA-F]+$/u.test(recipientPublicKey);\n\n  const bytes = isHex\n    ? hexToBytes(recipientPublicKey)\n    : base64ToBytes(\n        recipientPublicKey\n          .replace(/-/gu, '+')\n          .replace(/_/gu, '/')\n          .padEnd(\n            recipientPublicKey.length +\n              ((4 - (recipientPublicKey.length % 4)) % 4),\n            '=',\n          ),\n      );\n\n  if (bytes.length !== X25519_KEY_SIZE_BYTES) {\n    throw new Error(\n      `UKYC: wrappingPublicKey has unexpected length ${bytes.length}, expected ${X25519_KEY_SIZE_BYTES}.`,\n    );\n  }\n  return bytes;\n}\n\n/**\n * Wraps `keyToWrap` for the holder of `recipientPublicKey` using an\n * ephemeral-static ECDH + AES-256-GCM sealed-box scheme:\n *\n *   ephemeral = fresh X25519 keypair (one per call)\n *   shared    = X25519(ephemeralPrivate, recipientPublic)\n *   aeadKey   = HKDF-SHA256(shared, 32 bytes)\n *   iv        = 12 random bytes\n *   ct        = AES-256-GCM(aeadKey, iv).encrypt(keyToWrap)   // ct includes tag\n *\n * The recipient reverses it with their private key:\n *\n *   shared  = X25519(recipientPrivate, ephemeralPublic)\n *   aeadKey = HKDF-SHA256(shared, 32 bytes)\n *   key     = AES-256-GCM(aeadKey, iv).decrypt(ct)\n *\n * This mirrors the X25519 + AES-256-GCM/HKDF decryption used for MoonPay\n * Check/Auth-frame credentials, so both directions share one primitive.\n *\n * @param recipientPublicKey - The recipient's X25519 public key (hex or base64).\n * @param keyToWrap - The raw symmetric key bytes to encrypt (e.g. the\n * `data_encryption_key`).\n * @returns Base64url of `ephemeralPublicKey(32) || iv(12) || ciphertext+tag`.\n */\nexport function wrapUserKey(\n  recipientPublicKey: string,\n  keyToWrap: Uint8Array,\n): string {\n  const recipient = decodePublicKey(recipientPublicKey);\n\n  const ephemeralPrivateKey = x25519.utils.randomSecretKey();\n  const ephemeralPublicKey = x25519.getPublicKey(ephemeralPrivateKey);\n\n  const shared = x25519.getSharedSecret(ephemeralPrivateKey, recipient);\n  const aeadKey = hkdf(sha256, shared, undefined, undefined, 32);\n\n  const iv = randomBytes(IV_SIZE_BYTES);\n  const ciphertext = gcm(aeadKey, iv).encrypt(keyToWrap);\n\n  const blob = new Uint8Array(\n    ephemeralPublicKey.length + iv.length + ciphertext.length,\n  );\n  blob.set(ephemeralPublicKey, 0);\n  blob.set(iv, ephemeralPublicKey.length);\n  blob.set(ciphertext, ephemeralPublicKey.length + iv.length);\n\n  return toBase64Url(blob);\n}\n"]}

package/dist/ukyc/wrappedRelayPayload.cjs

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildWrappedRelayPayload = void 0;
+const encoding_js_1 = require("../encoding.cjs");
+/**
+ * Assembles the `wrapped_relay_payload` from derived client material and a
+ * Relay-presented `storage_access_token`.
+ *
+ * The token must be scoped for the Relay to present (`presenter: 'idos-relay'`)
+ * and must not authorize `delete`, which is never delegated to the Relay.
+ *
+ * @param material - Client material derived from `local_user_secret`.
+ * @param storageAccessToken - A `read`/`write`-scoped, Relay-presented token.
+ * @returns The `wrapped_relay_payload` to send to the Relay via the UKYC API.
+ */
+function buildWrappedRelayPayload(material, storageAccessToken) {
+    const { presenter, operations } = storageAccessToken.payload;
+    if (presenter !== 'idos-relay') {
+        throw new Error('UKYC: wrapped_relay_payload requires a Relay-presented storage_access_token.');
+    }
+    if (operations.includes('delete')) {
+        throw new Error('UKYC: wrapped_relay_payload must not carry a delete-scoped storage_access_token.');
+    }
+    return {
+        storage_id: (0, encoding_js_1.toBase64Url)(material.storageId),
+        data_encryption_key: (0, encoding_js_1.toBase64Url)(material.dataEncryptionKey),
+        signing_public_key: (0, encoding_js_1.toBase64Url)(material.signingPublicKey),
+        storage_access_token: storageAccessToken,
+    };
+}
+exports.buildWrappedRelayPayload = buildWrappedRelayPayload;
+//# sourceMappingURL=wrappedRelayPayload.cjs.map

package/dist/ukyc/wrappedRelayPayload.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrappedRelayPayload.cjs","sourceRoot":"","sources":["../../src/ukyc/wrappedRelayPayload.ts"],"names":[],"mappings":";;;AACA,iDAA6C;AA4B7C;;;;;;;;;;GAUG;AACH,SAAgB,wBAAwB,CACtC,QAA4B,EAC5B,kBAA0C;IAE1C,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC;IAE7D,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,8EAA8E,CAC/E,CAAC;IACJ,CAAC;IAED,IAAI,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,UAAU,EAAE,IAAA,yBAAW,EAAC,QAAQ,CAAC,SAAS,CAAC;QAC3C,mBAAmB,EAAE,IAAA,yBAAW,EAAC,QAAQ,CAAC,iBAAiB,CAAC;QAC5D,kBAAkB,EAAE,IAAA,yBAAW,EAAC,QAAQ,CAAC,gBAAgB,CAAC;QAC1D,oBAAoB,EAAE,kBAAkB;KACzC,CAAC;AACJ,CAAC;AAxBD,4DAwBC","sourcesContent":["import type { UkycClientMaterial } from './deriveClientMaterial.js';\nimport { toBase64Url } from '../encoding.js';\nimport type { UkycStorageAccessToken } from './storageAccessToken.js';\n\n/**\n * Builds the `wrapped_relay_payload` — the only client-derived material that\n * leaves the device. It is sent to the idOS Relay (through the UKYC API) so the\n * Relay can encrypt/decrypt and store KYC payloads on the user's behalf. See the\n * architecture doc, section \"Client-Derived Material\".\n *\n * Neither `local_user_secret` nor the private `signing_key` are ever included.\n * The `data_encryption_key` *is* included: it is intentionally shared with the\n * Relay so it can encrypt/decrypt payloads transiently.\n */\n\n/**\n * The Relay-facing bundle. `data_encryption_key` is base64url-encoded secret\n * material shared with the Relay; the other fields are non-secret.\n */\nexport type UkycWrappedRelayPayload = {\n  // Wire-shape fields are snake_case.\n  /* eslint-disable @typescript-eslint/naming-convention */\n  storage_id: string;\n  data_encryption_key: string;\n  signing_public_key: string;\n  storage_access_token: UkycStorageAccessToken;\n  /* eslint-enable @typescript-eslint/naming-convention */\n};\n\n/**\n * Assembles the `wrapped_relay_payload` from derived client material and a\n * Relay-presented `storage_access_token`.\n *\n * The token must be scoped for the Relay to present (`presenter: 'idos-relay'`)\n * and must not authorize `delete`, which is never delegated to the Relay.\n *\n * @param material - Client material derived from `local_user_secret`.\n * @param storageAccessToken - A `read`/`write`-scoped, Relay-presented token.\n * @returns The `wrapped_relay_payload` to send to the Relay via the UKYC API.\n */\nexport function buildWrappedRelayPayload(\n  material: UkycClientMaterial,\n  storageAccessToken: UkycStorageAccessToken,\n): UkycWrappedRelayPayload {\n  const { presenter, operations } = storageAccessToken.payload;\n\n  if (presenter !== 'idos-relay') {\n    throw new Error(\n      'UKYC: wrapped_relay_payload requires a Relay-presented storage_access_token.',\n    );\n  }\n\n  if (operations.includes('delete')) {\n    throw new Error(\n      'UKYC: wrapped_relay_payload must not carry a delete-scoped storage_access_token.',\n    );\n  }\n\n  return {\n    storage_id: toBase64Url(material.storageId),\n    data_encryption_key: toBase64Url(material.dataEncryptionKey),\n    signing_public_key: toBase64Url(material.signingPublicKey),\n    storage_access_token: storageAccessToken,\n  };\n}\n"]}

package/dist/ukyc/wrappedRelayPayload.d.cts

@@ -0,0 +1,35 @@
+import type { UkycClientMaterial } from "./deriveClientMaterial.cjs";
+import type { UkycStorageAccessToken } from "./storageAccessToken.cjs";
+/**
+ * Builds the `wrapped_relay_payload` — the only client-derived material that
+ * leaves the device. It is sent to the idOS Relay (through the UKYC API) so the
+ * Relay can encrypt/decrypt and store KYC payloads on the user's behalf. See the
+ * architecture doc, section "Client-Derived Material".
+ *
+ * Neither `local_user_secret` nor the private `signing_key` are ever included.
+ * The `data_encryption_key` *is* included: it is intentionally shared with the
+ * Relay so it can encrypt/decrypt payloads transiently.
+ */
+/**
+ * The Relay-facing bundle. `data_encryption_key` is base64url-encoded secret
+ * material shared with the Relay; the other fields are non-secret.
+ */
+export type UkycWrappedRelayPayload = {
+    storage_id: string;
+    data_encryption_key: string;
+    signing_public_key: string;
+    storage_access_token: UkycStorageAccessToken;
+};
+/**
+ * Assembles the `wrapped_relay_payload` from derived client material and a
+ * Relay-presented `storage_access_token`.
+ *
+ * The token must be scoped for the Relay to present (`presenter: 'idos-relay'`)
+ * and must not authorize `delete`, which is never delegated to the Relay.
+ *
+ * @param material - Client material derived from `local_user_secret`.
+ * @param storageAccessToken - A `read`/`write`-scoped, Relay-presented token.
+ * @returns The `wrapped_relay_payload` to send to the Relay via the UKYC API.
+ */
+export declare function buildWrappedRelayPayload(material: UkycClientMaterial, storageAccessToken: UkycStorageAccessToken): UkycWrappedRelayPayload;
+//# sourceMappingURL=wrappedRelayPayload.d.cts.map

package/dist/ukyc/wrappedRelayPayload.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrappedRelayPayload.d.cts","sourceRoot":"","sources":["../../src/ukyc/wrappedRelayPayload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,mCAAkC;AAEpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,iCAAgC;AAEtE;;;;;;;;;GASG;AAEH;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IAGpC,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,oBAAoB,EAAE,sBAAsB,CAAC;CAE9C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,kBAAkB,EAC5B,kBAAkB,EAAE,sBAAsB,GACzC,uBAAuB,CAqBzB"}

package/dist/ukyc/wrappedRelayPayload.d.mts

@@ -0,0 +1,35 @@
+import type { UkycClientMaterial } from "./deriveClientMaterial.mjs";
+import type { UkycStorageAccessToken } from "./storageAccessToken.mjs";
+/**
+ * Builds the `wrapped_relay_payload` — the only client-derived material that
+ * leaves the device. It is sent to the idOS Relay (through the UKYC API) so the
+ * Relay can encrypt/decrypt and store KYC payloads on the user's behalf. See the
+ * architecture doc, section "Client-Derived Material".
+ *
+ * Neither `local_user_secret` nor the private `signing_key` are ever included.
+ * The `data_encryption_key` *is* included: it is intentionally shared with the
+ * Relay so it can encrypt/decrypt payloads transiently.
+ */
+/**
+ * The Relay-facing bundle. `data_encryption_key` is base64url-encoded secret
+ * material shared with the Relay; the other fields are non-secret.
+ */
+export type UkycWrappedRelayPayload = {
+    storage_id: string;
+    data_encryption_key: string;
+    signing_public_key: string;
+    storage_access_token: UkycStorageAccessToken;
+};
+/**
+ * Assembles the `wrapped_relay_payload` from derived client material and a
+ * Relay-presented `storage_access_token`.
+ *
+ * The token must be scoped for the Relay to present (`presenter: 'idos-relay'`)
+ * and must not authorize `delete`, which is never delegated to the Relay.
+ *
+ * @param material - Client material derived from `local_user_secret`.
+ * @param storageAccessToken - A `read`/`write`-scoped, Relay-presented token.
+ * @returns The `wrapped_relay_payload` to send to the Relay via the UKYC API.
+ */
+export declare function buildWrappedRelayPayload(material: UkycClientMaterial, storageAccessToken: UkycStorageAccessToken): UkycWrappedRelayPayload;
+//# sourceMappingURL=wrappedRelayPayload.d.mts.map

package/dist/ukyc/wrappedRelayPayload.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrappedRelayPayload.d.mts","sourceRoot":"","sources":["../../src/ukyc/wrappedRelayPayload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,mCAAkC;AAEpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,iCAAgC;AAEtE;;;;;;;;;GASG;AAEH;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IAGpC,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,oBAAoB,EAAE,sBAAsB,CAAC;CAE9C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,kBAAkB,EAC5B,kBAAkB,EAAE,sBAAsB,GACzC,uBAAuB,CAqBzB"}

package/dist/ukyc/wrappedRelayPayload.mjs

@@ -0,0 +1,28 @@
+import { toBase64Url } from "../encoding.mjs";
+/**
+ * Assembles the `wrapped_relay_payload` from derived client material and a
+ * Relay-presented `storage_access_token`.
+ *
+ * The token must be scoped for the Relay to present (`presenter: 'idos-relay'`)
+ * and must not authorize `delete`, which is never delegated to the Relay.
+ *
+ * @param material - Client material derived from `local_user_secret`.
+ * @param storageAccessToken - A `read`/`write`-scoped, Relay-presented token.
+ * @returns The `wrapped_relay_payload` to send to the Relay via the UKYC API.
+ */
+export function buildWrappedRelayPayload(material, storageAccessToken) {
+    const { presenter, operations } = storageAccessToken.payload;
+    if (presenter !== 'idos-relay') {
+        throw new Error('UKYC: wrapped_relay_payload requires a Relay-presented storage_access_token.');
+    }
+    if (operations.includes('delete')) {
+        throw new Error('UKYC: wrapped_relay_payload must not carry a delete-scoped storage_access_token.');
+    }
+    return {
+        storage_id: toBase64Url(material.storageId),
+        data_encryption_key: toBase64Url(material.dataEncryptionKey),
+        signing_public_key: toBase64Url(material.signingPublicKey),
+        storage_access_token: storageAccessToken,
+    };
+}
+//# sourceMappingURL=wrappedRelayPayload.mjs.map

package/dist/ukyc/wrappedRelayPayload.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrappedRelayPayload.mjs","sourceRoot":"","sources":["../../src/ukyc/wrappedRelayPayload.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,wBAAuB;AA4B7C;;;;;;;;;;GAUG;AACH,MAAM,UAAU,wBAAwB,CACtC,QAA4B,EAC5B,kBAA0C;IAE1C,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC;IAE7D,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,8EAA8E,CAC/E,CAAC;IACJ,CAAC;IAED,IAAI,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,UAAU,EAAE,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC;QAC3C,mBAAmB,EAAE,WAAW,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QAC5D,kBAAkB,EAAE,WAAW,CAAC,QAAQ,CAAC,gBAAgB,CAAC;QAC1D,oBAAoB,EAAE,kBAAkB;KACzC,CAAC;AACJ,CAAC","sourcesContent":["import type { UkycClientMaterial } from './deriveClientMaterial.js';\nimport { toBase64Url } from '../encoding.js';\nimport type { UkycStorageAccessToken } from './storageAccessToken.js';\n\n/**\n * Builds the `wrapped_relay_payload` — the only client-derived material that\n * leaves the device. It is sent to the idOS Relay (through the UKYC API) so the\n * Relay can encrypt/decrypt and store KYC payloads on the user's behalf. See the\n * architecture doc, section \"Client-Derived Material\".\n *\n * Neither `local_user_secret` nor the private `signing_key` are ever included.\n * The `data_encryption_key` *is* included: it is intentionally shared with the\n * Relay so it can encrypt/decrypt payloads transiently.\n */\n\n/**\n * The Relay-facing bundle. `data_encryption_key` is base64url-encoded secret\n * material shared with the Relay; the other fields are non-secret.\n */\nexport type UkycWrappedRelayPayload = {\n  // Wire-shape fields are snake_case.\n  /* eslint-disable @typescript-eslint/naming-convention */\n  storage_id: string;\n  data_encryption_key: string;\n  signing_public_key: string;\n  storage_access_token: UkycStorageAccessToken;\n  /* eslint-enable @typescript-eslint/naming-convention */\n};\n\n/**\n * Assembles the `wrapped_relay_payload` from derived client material and a\n * Relay-presented `storage_access_token`.\n *\n * The token must be scoped for the Relay to present (`presenter: 'idos-relay'`)\n * and must not authorize `delete`, which is never delegated to the Relay.\n *\n * @param material - Client material derived from `local_user_secret`.\n * @param storageAccessToken - A `read`/`write`-scoped, Relay-presented token.\n * @returns The `wrapped_relay_payload` to send to the Relay via the UKYC API.\n */\nexport function buildWrappedRelayPayload(\n  material: UkycClientMaterial,\n  storageAccessToken: UkycStorageAccessToken,\n): UkycWrappedRelayPayload {\n  const { presenter, operations } = storageAccessToken.payload;\n\n  if (presenter !== 'idos-relay') {\n    throw new Error(\n      'UKYC: wrapped_relay_payload requires a Relay-presented storage_access_token.',\n    );\n  }\n\n  if (operations.includes('delete')) {\n    throw new Error(\n      'UKYC: wrapped_relay_payload must not carry a delete-scoped storage_access_token.',\n    );\n  }\n\n  return {\n    storage_id: toBase64Url(material.storageId),\n    data_encryption_key: toBase64Url(material.dataEncryptionKey),\n    signing_public_key: toBase64Url(material.signingPublicKey),\n    storage_access_token: storageAccessToken,\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/kyc-controller",
-  "version": "0.0.0-preview-823dcff",
+  "version": "0.0.0-preview-e57e5c3dc",
   "description": "Shared KYC / identity verification controller used across MetaMask clients",
   "keywords": [
     "Ethereum",
@@ -42,24 +42,45 @@
     "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
     "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
     "build:docs": "typedoc",
+    "build:watch": "yarn build && chokidar 'src/**/*.ts' -c 'ts-bridge --project tsconfig.build.json --verbose --no-references' --initial",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/kyc-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/kyc-controller",
     "lint:tsconfigs": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts",
     "lint:tsconfigs:fix": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts --fix",
-    "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --check",
-    "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --generate",
+    "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --esm --check",
+    "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --esm --generate",
+    "mint:ukyc-token": "tsx scripts/mint-ukyc-test-token.ts",
     "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
     "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
     "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
+  "dependencies": {
+    "@metamask/base-controller": "^9.1.0",
+    "@metamask/base-data-service": "^0.1.3",
+    "@metamask/controller-utils": "^12.3.0",
+    "@metamask/geolocation-controller": "^1.0.0",
+    "@metamask/messenger": "^2.0.0",
+    "@metamask/profile-sync-controller": "^29.0.0",
+    "@metamask/superstruct": "^3.4.1",
+    "@metamask/utils": "^11.11.0",
+    "@noble/ciphers": "^1.3.0",
+    "@noble/curves": "^1.9.2",
+    "@noble/hashes": "^1.8.0",
+    "@scure/base": "^1.2.6",
+    "@tanstack/query-core": "^4.43.0",
+    "reselect": "^5.1.1",
+    "tweetnacl": "^1.0.3"
+  },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.1.0",
     "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^30.0.0",
+    "chokidar-cli": "^3.0.0",
     "deepmerge": "^4.2.2",
     "jest": "^30.4.2",
+    "nock": "^13.3.1",
     "ts-jest": "^29.4.11",
     "tsx": "^4.20.5",
     "typedoc": "^0.25.13",