@metamask-previews/cryptography 0.0.0-preview-ed70ef231 → 0.0.0-preview-ff2ab0583

package/CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Initial release ([#10282](https://github.com/MetaMask/core/pull/10282))
+- Initial release ([#10282](https://github.com/MetaMask/core/pull/10282), [#10431](https://github.com/MetaMask/core/pull/10431))
+  - Add `sha256`, `sha384`, and `sha512` functions for computing SHA digests
+  - Add `hmacSha256`, `hmacSha384`, and `hmacSha512` functions for computing HMAC digests
 
 [Unreleased]: https://github.com/MetaMask/core/

package/dist/hmac.d.ts

@@ -0,0 +1,35 @@
+export type HmacOptions = {
+    /**
+     * Skip the minimum key length check. Using a key shorter than the hash
+     * output length reduces the effective security strength of HMAC (RFC 2104).
+     */
+    unsafeKeyLength?: boolean;
+};
+/**
+ * Compute the HMAC-SHA-256 of the given data using the given key.
+ *
+ * @param key - The key to use.
+ * @param data - The data to hash.
+ * @param options - Additional configuration options.
+ * @returns The HMAC-SHA-256 of the data.
+ */
+export declare function hmacSha256(key: BufferSource, data: BufferSource, options?: HmacOptions): Promise<Uint8Array>;
+/**
+ * Compute the HMAC-SHA-384 of the given data using the given key.
+ *
+ * @param key - The key to use.
+ * @param data - The data to hash.
+ * @param options - Additional configuration options.
+ * @returns The HMAC-SHA-384 of the data.
+ */
+export declare function hmacSha384(key: BufferSource, data: BufferSource, options?: HmacOptions): Promise<Uint8Array>;
+/**
+ * Compute the HMAC-SHA-512 of the given data using the given key.
+ *
+ * @param key - The key to use.
+ * @param data - The data to hash.
+ * @param options - Additional configuration options.
+ * @returns The HMAC-SHA-512 of the data.
+ */
+export declare function hmacSha512(key: BufferSource, data: BufferSource, options?: HmacOptions): Promise<Uint8Array>;
+//# sourceMappingURL=hmac.d.ts.map

package/dist/hmac.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hmac.d.ts","sourceRoot":"","sources":["../src/hmac.ts"],"names":[],"mappings":"AASA,MAAM,MAAM,WAAW,GAAG;IACxB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAC9B,GAAG,EAAE,YAAY,EACjB,IAAI,EAAE,YAAY,EAClB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,UAAU,CAAC,CAErB;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAC9B,GAAG,EAAE,YAAY,EACjB,IAAI,EAAE,YAAY,EAClB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,UAAU,CAAC,CAErB;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAC9B,GAAG,EAAE,YAAY,EACjB,IAAI,EAAE,YAAY,EAClB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,UAAU,CAAC,CAErB"}

package/dist/hmac.js

@@ -0,0 +1,60 @@
+// https://datatracker.ietf.org/doc/html/rfc2104#section-3
+const MIN_KEY_LENGTH = {
+    'SHA-256': 32,
+    'SHA-384': 48,
+    'SHA-512': 64,
+};
+/**
+ * Compute the HMAC-SHA-256 of the given data using the given key.
+ *
+ * @param key - The key to use.
+ * @param data - The data to hash.
+ * @param options - Additional configuration options.
+ * @returns The HMAC-SHA-256 of the data.
+ */
+export async function hmacSha256(key, data, options) {
+    return hmac(key, 'SHA-256', data, options);
+}
+/**
+ * Compute the HMAC-SHA-384 of the given data using the given key.
+ *
+ * @param key - The key to use.
+ * @param data - The data to hash.
+ * @param options - Additional configuration options.
+ * @returns The HMAC-SHA-384 of the data.
+ */
+export async function hmacSha384(key, data, options) {
+    return hmac(key, 'SHA-384', data, options);
+}
+/**
+ * Compute the HMAC-SHA-512 of the given data using the given key.
+ *
+ * @param key - The key to use.
+ * @param data - The data to hash.
+ * @param options - Additional configuration options.
+ * @returns The HMAC-SHA-512 of the data.
+ */
+export async function hmacSha512(key, data, options) {
+    return hmac(key, 'SHA-512', data, options);
+}
+/**
+ * Compute the HMAC-SHA of the given data using the given key.
+ *
+ * @param key - The key to use.
+ * @param hash - The hash to use.
+ * @param data - The data to hash.
+ * @param options - Additional configuration options..
+ * @returns The HMAC-SHA of the data.
+ */
+async function hmac(key, hash, data, options = {}) {
+    if (key.byteLength === 0) {
+        throw new Error(`Unsafe key length: Key must not be zero bytes for HMAC-${hash}.`);
+    }
+    if (!options.unsafeKeyLength && key.byteLength < MIN_KEY_LENGTH[hash]) {
+        throw new Error(`Unsafe key length: Key must be at least ${MIN_KEY_LENGTH[hash]} bytes for HMAC-${hash}. To bypass this check, set the \`unsafeKeyLength\` option to \`true\`.`);
+    }
+    const subtleKey = await globalThis.crypto.subtle.importKey('raw', key, { name: 'HMAC', hash }, false, ['sign']);
+    const result = await globalThis.crypto.subtle.sign('HMAC', subtleKey, data);
+    return new Uint8Array(result);
+}
+//# sourceMappingURL=hmac.js.map

package/dist/hmac.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hmac.js","sourceRoot":"","sources":["../src/hmac.ts"],"names":[],"mappings":"AAEA,0DAA0D;AAC1D,MAAM,cAAc,GAAiC;IACnD,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;CACd,CAAC;AAUF;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,GAAiB,EACjB,IAAkB,EAClB,OAAqB;IAErB,OAAO,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,GAAiB,EACjB,IAAkB,EAClB,OAAqB;IAErB,OAAO,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,GAAiB,EACjB,IAAkB,EAClB,OAAqB;IAErB,OAAO,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,IAAI,CACjB,GAAiB,EACjB,IAAkB,EAClB,IAAkB,EAClB,OAAO,GAAgB,EAAE;IAEzB,IAAI,GAAG,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,0DAA0D,IAAI,GAAG,CAClE,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,GAAG,CAAC,UAAU,GAAG,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QACtE,MAAM,IAAI,KAAK,CACb,2CAA2C,cAAc,CAAC,IAAI,CAAC,mBAAmB,IAAI,yEAAyE,CAChK,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CACxD,KAAK,EACL,GAAG,EACH,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EACtB,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IAC5E,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC","sourcesContent":["import type { HashFunction } from './types.js';\n\n// https://datatracker.ietf.org/doc/html/rfc2104#section-3\nconst MIN_KEY_LENGTH: Record<HashFunction, number> = {\n  'SHA-256': 32,\n  'SHA-384': 48,\n  'SHA-512': 64,\n};\n\nexport type HmacOptions = {\n  /**\n   * Skip the minimum key length check. Using a key shorter than the hash\n   * output length reduces the effective security strength of HMAC (RFC 2104).\n   */\n  unsafeKeyLength?: boolean;\n};\n\n/**\n * Compute the HMAC-SHA-256 of the given data using the given key.\n *\n * @param key - The key to use.\n * @param data - The data to hash.\n * @param options - Additional configuration options.\n * @returns The HMAC-SHA-256 of the data.\n */\nexport async function hmacSha256(\n  key: BufferSource,\n  data: BufferSource,\n  options?: HmacOptions,\n): Promise<Uint8Array> {\n  return hmac(key, 'SHA-256', data, options);\n}\n\n/**\n * Compute the HMAC-SHA-384 of the given data using the given key.\n *\n * @param key - The key to use.\n * @param data - The data to hash.\n * @param options - Additional configuration options.\n * @returns The HMAC-SHA-384 of the data.\n */\nexport async function hmacSha384(\n  key: BufferSource,\n  data: BufferSource,\n  options?: HmacOptions,\n): Promise<Uint8Array> {\n  return hmac(key, 'SHA-384', data, options);\n}\n\n/**\n * Compute the HMAC-SHA-512 of the given data using the given key.\n *\n * @param key - The key to use.\n * @param data - The data to hash.\n * @param options - Additional configuration options.\n * @returns The HMAC-SHA-512 of the data.\n */\nexport async function hmacSha512(\n  key: BufferSource,\n  data: BufferSource,\n  options?: HmacOptions,\n): Promise<Uint8Array> {\n  return hmac(key, 'SHA-512', data, options);\n}\n\n/**\n * Compute the HMAC-SHA of the given data using the given key.\n *\n * @param key - The key to use.\n * @param hash - The hash to use.\n * @param data - The data to hash.\n * @param options - Additional configuration options..\n * @returns The HMAC-SHA of the data.\n */\nasync function hmac(\n  key: BufferSource,\n  hash: HashFunction,\n  data: BufferSource,\n  options: HmacOptions = {},\n): Promise<Uint8Array> {\n  if (key.byteLength === 0) {\n    throw new Error(\n      `Unsafe key length: Key must not be zero bytes for HMAC-${hash}.`,\n    );\n  }\n\n  if (!options.unsafeKeyLength && key.byteLength < MIN_KEY_LENGTH[hash]) {\n    throw new Error(\n      `Unsafe key length: Key must be at least ${MIN_KEY_LENGTH[hash]} bytes for HMAC-${hash}. To bypass this check, set the \\`unsafeKeyLength\\` option to \\`true\\`.`,\n    );\n  }\n\n  const subtleKey = await globalThis.crypto.subtle.importKey(\n    'raw',\n    key,\n    { name: 'HMAC', hash },\n    false,\n    ['sign'],\n  );\n\n  const result = await globalThis.crypto.subtle.sign('HMAC', subtleKey, data);\n  return new Uint8Array(result);\n}\n"]}

package/dist/index.d.ts

@@ -1,2 +1,4 @@
+export * from './hmac.js';
 export * from './sha.js';
+export type * from './types.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":"AAAA,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,mBAAmB,YAAY,CAAC"}

package/dist/index.js

@@ -1,2 +1,3 @@
+export * from './hmac.js';
 export * from './sha.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC","sourcesContent":["export * from './sha.js';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC","sourcesContent":["export * from './hmac.js';\nexport * from './sha.js';\nexport type * from './types.js';\n"]}

package/dist/types.d.ts

@@ -0,0 +1,2 @@
+export type HashFunction = 'SHA-256' | 'SHA-384' | 'SHA-512';
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["export type HashFunction = 'SHA-256' | 'SHA-384' | 'SHA-512';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/cryptography",
-  "version": "0.0.0-preview-ed70ef231",
+  "version": "0.0.0-preview-ff2ab0583",
   "description": "Provides optimized versions of commonly used cryptography functions for MetaMask clients",
   "keywords": [
     "Ethereum",
@@ -54,7 +54,7 @@
     "@metamask/utils": "^12.0.0",
     "@types/jest": "^30.0.0",
     "@typescript/native": "npm:typescript@^7.0.2",
-    "deepmerge": "^4.2.2",
+    "deepmerge": "^4.3.1",
     "jest": "^30.4.2",
     "rimraf": "^6.1.3",
     "ts-jest": "^29.4.12",