Use built-in PBKDF2 implementation for browsers (#295)

* add pbkdf2 browser implementation * use webcrypto in pbkdf2 * rename pbkdf2 file * use pbkdf2 * add changeset * revert rename * remove browser field from package.json * use `resolve.alias` for pbkdf2 if test * use `mode` in vite.config.ts Co-authored-by: Felicio Mununga <[email protected]>
status-im · Jul 19, 2022 · 1f567e1 · 1f567e1
1 parent e68ea9d
commit 1f567e1
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 3 deletions.
diff --git a/.changeset/itchy-apes-sin.md b/.changeset/itchy-apes-sin.md
@@ -0,0 +1,5 @@
+---
+'@status-im/js': patch
+---
+
+use built-in crypto for pbkdf2
diff --git a/packages/status-js/src/crypto/pbkdf2.browser.ts b/packages/status-js/src/crypto/pbkdf2.browser.ts
@@ -0,0 +1,33 @@
+import type { pbkdf2 as pbkdf2Type } from 'ethereum-cryptography/pbkdf2'
+
+type PBKDF2 = typeof pbkdf2Type
+
+export const pbkdf2: PBKDF2 = async (
+  password: Uint8Array,
+  salt: Uint8Array,
+  iterations: number,
+  keylen: number
+): Promise<Uint8Array> => {
+  const cryptoKey = await window.crypto.subtle.importKey(
+    'raw',
+    password,
+    { name: 'PBKDF2' },
+    false,
+    ['deriveBits']
+  )
+
+  const derivedKey = await window.crypto.subtle.deriveBits(
+    {
+      name: 'PBKDF2',
+      salt,
+      iterations,
+      hash: {
+        name: 'SHA-256',
+      },
+    },
+    cryptoKey,
+    keylen << 3
+  )
+
+  return new Uint8Array(derivedKey)
+}
diff --git a/packages/status-js/src/utils/generate-key-from-password.ts b/packages/status-js/src/utils/generate-key-from-password.ts
@@ -1,6 +1,7 @@
-import { pbkdf2 } from 'ethereum-cryptography/pbkdf2'
 import { utf8ToBytes } from 'ethereum-cryptography/utils'
 
+import { pbkdf2 } from '../crypto/pbkdf2.browser'
+
 const AES_KEY_LENGTH = 32 // bytes
 
 /**

diff --git a/packages/status-js/vite.config.ts b/packages/status-js/vite.config.ts
@@ -4,12 +4,26 @@ import { defineConfig } from 'vite'
 
 import { dependencies } from './package.json'
 
+import type { Alias } from 'vite'
+
 const external = [
   ...Object.keys(dependencies || {}),
   // ...Object.keys(peerDependencies || {}),
 ].map(name => new RegExp(`^${name}(/.*)?`))
 
 export default defineConfig(({ mode }) => {
+  const alias: Alias[] = []
+
+  if (mode === 'test') {
+    alias.push({
+      /**
+       * Note: `happy-dom` nor `jsdom` have Crypto implemented (@see https://github.com/jsdom/jsdom/issues/1612)
+       */
+      find: /^.*\/crypto\/pbkdf2.browser$/,
+      replacement: 'ethereum-cryptography/pbkdf2',
+    })
+  }
+
   return {
     build: {
       target: 'es2020',
@@ -24,9 +38,11 @@ export default defineConfig(({ mode }) => {
         external,
       },
     },
-
+    resolve: {
+      alias,
+    },
     test: {
-      // environment: 'happy-dom',
+      environment: 'happy-dom',
     },
   }
 })