@metamask-previews/kyc-controller 0.0.0-preview-e68ab1498 → 0.0.0-preview-4b37525

package/dist/ukyc/wrapEncryptionKey.d.mts

@@ -1,34 +1,41 @@
 /**
- * Wraps the `data_encryption_key` for the UKYC session server using NaCl's
- * `crypto_box` (X25519 + XSalsa20-Poly1305) established with the server's
- * per-session wrapping key.
+ * Wraps a secret for the UKYC session server using NaCl's `crypto_box`
+ * (X25519 + XSalsa20-Poly1305) established with a per-secret wrapping key
+ * returned inside an encryption schema from `createUkycSession`.
  *
  * Unlike {@link wrapUserKey} (which generates a fresh ephemeral keypair per
- * call), this uses the session client keypair whose public half was already
- * handed to the server via `POST /wrapping-key`. The server therefore already
- * knows our public key and can derive the same shared secret from its session
- * private key, so only `{ encryptedKey, nonce }` need be transmitted.
+ * call), this reuses a session client keypair. There is no prior wrapping-key
+ * exchange to register that public key, so `data` is
+ * `clientPublicKey (32) || ciphertext+tag` and only `{ data, nonce }` need be
+ * transmitted. Used for both the `data_encryption_key` and the
+ * `ukyc_capability_token`.
  */
 /**
- * The transmitted portion of a wrapped encryption key: the `crypto_box`
- * ciphertext (which includes the 16-byte Poly1305 auth tag) and the nonce,
- * both unpadded base64url-encoded.
+ * The transmitted portion of a wrapped secret: the sender public key prefixed
+ * to the `crypto_box` ciphertext (which includes the 16-byte Poly1305 auth
+ * tag), and the nonce, both unpadded base64url-encoded. Matches the KYC API
+ * `CapabilityAuthorization` wire shape.
  */
 export type WrappedEncryptionKeyParts = {
-    encryptedKey: string;
+    data: string;
     nonce: string;
 };
 /**
- * Wraps `keyToWrap` for the UKYC session server.
+ * Wraps `plaintext` for the UKYC session server.
  *
  * The box is sealed with NaCl's `crypto_box`, keyed by the X25519 shared secret
  * between our session client private key and the session server public key
- * returned by `getWrappingKey`.
+ * from an encryption schema (`encryptionDataKey` or `ukycCapabilityToken`)
+ * returned by `createUkycSession`. The 32-byte client public key is prefixed
+ * onto `data` so the server can open the box without a prior key-registration
+ * step.
  *
  * @param sessionClientPrivateKey - Our session's X25519 private key.
  * @param sessionServerPublicKey - The server's X25519 public key (base64url).
- * @param keyToWrap - The raw symmetric key bytes to encrypt.
- * @returns The base64url `encryptedKey` (ciphertext + tag) and `nonce`.
+ * @param plaintext - The raw bytes to encrypt (e.g. the `data_encryption_key`
+ * or the encoded `ukyc_capability_token`).
+ * @returns The base64url `data` (`clientPublicKey || ciphertext+tag`) and
+ * `nonce`.
  */
-export declare function wrapEncryptionKey(sessionClientPrivateKey: Uint8Array, sessionServerPublicKey: string, keyToWrap: Uint8Array): WrappedEncryptionKeyParts;
+export declare function wrapEncryptionKey(sessionClientPrivateKey: Uint8Array, sessionServerPublicKey: string, plaintext: Uint8Array): WrappedEncryptionKeyParts;
 //# sourceMappingURL=wrapEncryptionKey.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"wrapEncryptionKey.d.mts","sourceRoot":"","sources":["../../src/ukyc/wrapEncryptionKey.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;GAUG;AAEH;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAC/B,uBAAuB,EAAE,UAAU,EACnC,sBAAsB,EAAE,MAAM,EAC9B,SAAS,EAAE,UAAU,GACpB,yBAAyB,CAa3B"}
+{"version":3,"file":"wrapEncryptionKey.d.mts","sourceRoot":"","sources":["../../src/ukyc/wrapEncryptionKey.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,iBAAiB,CAC/B,uBAAuB,EAAE,UAAU,EACnC,sBAAsB,EAAE,MAAM,EAC9B,SAAS,EAAE,UAAU,GACpB,yBAAyB,CAmB3B"}

package/dist/ukyc/wrapEncryptionKey.mjs

@@ -2,23 +2,32 @@ import $tweetnacl from "tweetnacl";
 const { randomBytes, box } = $tweetnacl;
 import { base64UrlToBytes, toBase64Url } from "../encoding.mjs";
 /**
- * Wraps `keyToWrap` for the UKYC session server.
+ * Wraps `plaintext` for the UKYC session server.
  *
  * The box is sealed with NaCl's `crypto_box`, keyed by the X25519 shared secret
  * between our session client private key and the session server public key
- * returned by `getWrappingKey`.
+ * from an encryption schema (`encryptionDataKey` or `ukycCapabilityToken`)
+ * returned by `createUkycSession`. The 32-byte client public key is prefixed
+ * onto `data` so the server can open the box without a prior key-registration
+ * step.
  *
  * @param sessionClientPrivateKey - Our session's X25519 private key.
  * @param sessionServerPublicKey - The server's X25519 public key (base64url).
- * @param keyToWrap - The raw symmetric key bytes to encrypt.
- * @returns The base64url `encryptedKey` (ciphertext + tag) and `nonce`.
+ * @param plaintext - The raw bytes to encrypt (e.g. the `data_encryption_key`
+ * or the encoded `ukyc_capability_token`).
+ * @returns The base64url `data` (`clientPublicKey || ciphertext+tag`) and
+ * `nonce`.
  */
-export function wrapEncryptionKey(sessionClientPrivateKey, sessionServerPublicKey, keyToWrap) {
+export function wrapEncryptionKey(sessionClientPrivateKey, sessionServerPublicKey, plaintext) {
     const serverPublicKey = base64UrlToBytes(sessionServerPublicKey);
+    const { publicKey: clientPublicKey } = box.keyPair.fromSecretKey(sessionClientPrivateKey);
     const nonce = randomBytes(box.nonceLength);
-    const encryptedKey = box(keyToWrap, nonce, serverPublicKey, sessionClientPrivateKey);
+    const ciphertext = box(plaintext, nonce, serverPublicKey, sessionClientPrivateKey);
+    const data = new Uint8Array(clientPublicKey.length + ciphertext.length);
+    data.set(clientPublicKey, 0);
+    data.set(ciphertext, clientPublicKey.length);
     return {
-        encryptedKey: toBase64Url(encryptedKey),
+        data: toBase64Url(data),
         nonce: toBase64Url(nonce),
     };
 }

package/dist/ukyc/wrapEncryptionKey.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"wrapEncryptionKey.mjs","sourceRoot":"","sources":["../../src/ukyc/wrapEncryptionKey.ts"],"names":[],"mappings":";;AAEA,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,wBAAuB;AAwB/D;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,iBAAiB,CAC/B,uBAAmC,EACnC,sBAA8B,EAC9B,SAAqB;IAErB,MAAM,eAAe,GAAG,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;IACjE,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC3C,MAAM,YAAY,GAAG,GAAG,CACtB,SAAS,EACT,KAAK,EACL,eAAe,EACf,uBAAuB,CACxB,CAAC;IACF,OAAO;QACL,YAAY,EAAE,WAAW,CAAC,YAAY,CAAC;QACvC,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC;KAC1B,CAAC;AACJ,CAAC","sourcesContent":["import { randomBytes, box } from 'tweetnacl';\n\nimport { base64UrlToBytes, toBase64Url } from '../encoding.js';\n\n/**\n * Wraps the `data_encryption_key` for the UKYC session server using NaCl's\n * `crypto_box` (X25519 + XSalsa20-Poly1305) established with the server's\n * per-session wrapping key.\n *\n * Unlike {@link wrapUserKey} (which generates a fresh ephemeral keypair per\n * call), this uses the session client keypair whose public half was already\n * handed to the server via `POST /wrapping-key`. The server therefore already\n * knows our public key and can derive the same shared secret from its session\n * private key, so only `{ encryptedKey, nonce }` need be transmitted.\n */\n\n/**\n * The transmitted portion of a wrapped encryption key: the `crypto_box`\n * ciphertext (which includes the 16-byte Poly1305 auth tag) and the nonce,\n * both unpadded base64url-encoded.\n */\nexport type WrappedEncryptionKeyParts = {\n  encryptedKey: string;\n  nonce: string;\n};\n\n/**\n * Wraps `keyToWrap` for the UKYC session server.\n *\n * The box is sealed with NaCl's `crypto_box`, keyed by the X25519 shared secret\n * between our session client private key and the session server public key\n * returned by `getWrappingKey`.\n *\n * @param sessionClientPrivateKey - Our session's X25519 private key.\n * @param sessionServerPublicKey - The server's X25519 public key (base64url).\n * @param keyToWrap - The raw symmetric key bytes to encrypt.\n * @returns The base64url `encryptedKey` (ciphertext + tag) and `nonce`.\n */\nexport function wrapEncryptionKey(\n  sessionClientPrivateKey: Uint8Array,\n  sessionServerPublicKey: string,\n  keyToWrap: Uint8Array,\n): WrappedEncryptionKeyParts {\n  const serverPublicKey = base64UrlToBytes(sessionServerPublicKey);\n  const nonce = randomBytes(box.nonceLength);\n  const encryptedKey = box(\n    keyToWrap,\n    nonce,\n    serverPublicKey,\n    sessionClientPrivateKey,\n  );\n  return {\n    encryptedKey: toBase64Url(encryptedKey),\n    nonce: toBase64Url(nonce),\n  };\n}\n"]}
+{"version":3,"file":"wrapEncryptionKey.mjs","sourceRoot":"","sources":["../../src/ukyc/wrapEncryptionKey.ts"],"names":[],"mappings":";;AAEA,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,wBAAuB;AA0B/D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,iBAAiB,CAC/B,uBAAmC,EACnC,sBAA8B,EAC9B,SAAqB;IAErB,MAAM,eAAe,GAAG,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;IACjE,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAC9D,uBAAuB,CACxB,CAAC;IACF,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC3C,MAAM,UAAU,GAAG,GAAG,CACpB,SAAS,EACT,KAAK,EACL,eAAe,EACf,uBAAuB,CACxB,CAAC;IACF,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,eAAe,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACxE,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;IAC7B,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IAC7C,OAAO;QACL,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;QACvB,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC;KAC1B,CAAC;AACJ,CAAC","sourcesContent":["import { randomBytes, box } from 'tweetnacl';\n\nimport { base64UrlToBytes, toBase64Url } from '../encoding.js';\n\n/**\n * Wraps a secret for the UKYC session server using NaCl's `crypto_box`\n * (X25519 + XSalsa20-Poly1305) established with a per-secret wrapping key\n * returned inside an encryption schema from `createUkycSession`.\n *\n * Unlike {@link wrapUserKey} (which generates a fresh ephemeral keypair per\n * call), this reuses a session client keypair. There is no prior wrapping-key\n * exchange to register that public key, so `data` is\n * `clientPublicKey (32) || ciphertext+tag` and only `{ data, nonce }` need be\n * transmitted. Used for both the `data_encryption_key` and the\n * `ukyc_capability_token`.\n */\n\n/**\n * The transmitted portion of a wrapped secret: the sender public key prefixed\n * to the `crypto_box` ciphertext (which includes the 16-byte Poly1305 auth\n * tag), and the nonce, both unpadded base64url-encoded. Matches the KYC API\n * `CapabilityAuthorization` wire shape.\n */\nexport type WrappedEncryptionKeyParts = {\n  data: string;\n  nonce: string;\n};\n\n/**\n * Wraps `plaintext` for the UKYC session server.\n *\n * The box is sealed with NaCl's `crypto_box`, keyed by the X25519 shared secret\n * between our session client private key and the session server public key\n * from an encryption schema (`encryptionDataKey` or `ukycCapabilityToken`)\n * returned by `createUkycSession`. The 32-byte client public key is prefixed\n * onto `data` so the server can open the box without a prior key-registration\n * step.\n *\n * @param sessionClientPrivateKey - Our session's X25519 private key.\n * @param sessionServerPublicKey - The server's X25519 public key (base64url).\n * @param plaintext - The raw bytes to encrypt (e.g. the `data_encryption_key`\n * or the encoded `ukyc_capability_token`).\n * @returns The base64url `data` (`clientPublicKey || ciphertext+tag`) and\n * `nonce`.\n */\nexport function wrapEncryptionKey(\n  sessionClientPrivateKey: Uint8Array,\n  sessionServerPublicKey: string,\n  plaintext: Uint8Array,\n): WrappedEncryptionKeyParts {\n  const serverPublicKey = base64UrlToBytes(sessionServerPublicKey);\n  const { publicKey: clientPublicKey } = box.keyPair.fromSecretKey(\n    sessionClientPrivateKey,\n  );\n  const nonce = randomBytes(box.nonceLength);\n  const ciphertext = box(\n    plaintext,\n    nonce,\n    serverPublicKey,\n    sessionClientPrivateKey,\n  );\n  const data = new Uint8Array(clientPublicKey.length + ciphertext.length);\n  data.set(clientPublicKey, 0);\n  data.set(ciphertext, clientPublicKey.length);\n  return {\n    data: toBase64Url(data),\n    nonce: toBase64Url(nonce),\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/kyc-controller",
-  "version": "0.0.0-preview-e68ab1498",
+  "version": "0.0.0-preview-4b37525",
   "description": "Shared KYC / identity verification controller used across MetaMask clients",
   "keywords": [
     "Ethereum",