[PM-1320] Argon2 SIMD support #4921

quexten · 2023-03-03T19:04:10Z

Type of change

- [ ] Bug fix
- [ ] New feature development
- [x] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
- [ ] Build/deploy pipeline (DevOps)
- [ ] Other

Objective

This PR changes the argon2-browser dependency to argon2-browser-bw (a fork I created since argon2-browser does not seem to be under active development at the moment). The fork is different in that it includes wasm binaries compiled using a newer Emscripten compiler version, which leads to significantly faster binaries (exact differences can be found on this GitHub branch). Furthermore, it adds automatic detection for SIMD support, and loads the correct WASM module. This makes unlock times on high argon2 configurations a lot more bearable.

On my system the unlock times are as follows (10 iterations, 1 parallelism, 1024MiB memory)
Current implementation in Bitwarden (non-SIMD): 26 seconds
argon2-browser SIMD: 14 seconds
argon2-browser-bw (also SIMD): 10 seconds

The SIMD improvements work on all modern chromium and firefox based browsers and the Electron desktop client. Safari support should arrive in version 16.4.

Code changes

webpack.main.js: Add the simd webassembly to be copied to the desktop build
webCryptoFunction.service.ts: Replace the dependency
package-lock.json: Replace the dependency, wasm-feature-detect is added as a further package my argon2-browser-bw
package.json: Replace the dependency

bitwarden-bot · 2023-03-03T19:04:31Z

Thank you for your contribution! We've added this to our internal Community PR board for review.
ID: PM-1320

MGibson1 · 2023-03-09T20:49:15Z

Discussed elsewhere as well, but the upstream solution would be preferable.

quexten · 2023-03-09T21:58:13Z

As also discussed in the discussion, the upstream argon2-browser library seems currently unmaintained for the foreseeable future.

In case that does not change, would it be better to apply the auto-loading of the SIMD WebAssembly change as a patch instead of switching to my fork? That way the original package is still used, instead of my fork, the changes are applied, and can be easily undone once / if upstream is merged. (https://www.npmjs.com/package/patch-package, a solution as recommended f.e here: https://stackoverflow.com/a/62567504).

MGibson1 · 2023-03-13T12:20:53Z

I've never seen patch-package before, but I like it a lot. It seems like a reasonable way to solve our issue without implicitly getting us in the business of maintaining an npm package.

Hinton · 2023-03-13T14:18:04Z

@MGibson1 we used patches to handle some issues with electron-builder a long time ago. bitwarden/desktop#803 Main annoyance is updating the patch when the package is updated, which doesn't seem likely in this case.

quexten · 2023-04-04T21:42:42Z

Finally got to revisit this PR. I have re-based to latest master and changed it to just use a small patch to add automatic detection and loading of the SIMD binary instead of the forked package.

This also means that the Webassembly binaries are still the same ones from argon2-browser which are somewhat slower than ones newly compiled using the latest Emscripten version. But there is not much that can be done about this aside from getting a new release compiled upstream (or adding a post-install script that copies the binaries).

I also tested the argon2-browser's SIMD implementation on Safari 16.4. It seems to run, but is not actually faster than the regular implementation though this was on arm (A12Z Bionic).

Finally, since #5072 also applies a patch to argon2-browser, I will update it (or this PR depending on which is merged first) to apply both changes.

MGibson1

This looks ready to go to me, but I do have a (hopefully) quick question about your min simd module check.

I'll get QA started testing in any case, though.

MGibson1 · 2023-05-04T15:48:45Z

patches/argon2-browser+1.18.0.patch

+        try {
+            if (typeof WebAssembly === "object" && typeof WebAssembly.instantiate === "function") {
+                const module = new WebAssembly.Module(
+                    Uint8Array.of(0x00, 0x61, 0x73, 0x6d, 0x01, 0x00, 0x00, 0x00, 0x01, 0x05, 0x01, 0x60, 0x00, 0x01, 0x7b, 0x03, 0x02, 0x01, 0x00, 0x0a, 0x0a, 0x01, 0x08, 0x00, 0x41, 0x00, 0xfd, 0x0f, 0xfd, 0x62, 0x0b)


Going through wat2wasm, I end up with

(0x00, 0x61, 0x73, 0x6d, 0x01, 0x00, 0x00, 0x00, 0x01, 0x05, 0x01, 0x60, 0x00, 0x01, 0x7b, 0x03, 0x02, 0x01, 0x00, 0x0a, 0x0a, 0x01, 0x08, 0x00, 0x41, 0x00, 0xfd, 0x0f, 0xfd, 0x62, 0x0b, 0x00, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x02, 0x03, 0x01, 0x00, 0x00)

which differs from this with yours by appending 0x00, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x02, 0x03, 0x01, 0x00, 0x00 to the end of your hex string. Do you know what this difference is?

No Idea what the difference is. I just ran with version 1.0.32 on Fedora 38 and end up with the same result as before:

Could be due to a different wat2wasm version.

Running both your result and the one I get through wasm2wat, I end up with the same result.

weird, whatever. Thanks for checking

MGibson1

g2g, Passed QA and just merged up!

Thank you again for your continued support on the argon front, @quexten! I want to send you some swag for all your help here, is the email address you have listed on GitHub a good one to send a giftcard?

quexten · 2023-06-12T20:49:04Z

Thanks @MGibson1 for taking the time for reviewing it, getting it QA'd and merged :)

No need for a giftcard, I already received one previously from Kyle, but thank you for the offer.

I'll re-base the some-what related #5072 onto the current master some time later this week as it was in conflict with this branch.

bitwarden-bot changed the title ~~Argon2 SIMD support~~ [PM-1320] Argon2 SIMD support Mar 3, 2023

bitwarden-bot added the community-pr label Mar 3, 2023

quexten mentioned this pull request Mar 8, 2023

Argon2id is single threaded on desktop app and web vault #4779

Open

1 task

Automatically load SIMD binary for argon2

39ec767

quexten force-pushed the feature/argon2-simd branch from d908071 to 39ec767 Compare April 4, 2023 21:25

MGibson1 reviewed May 4, 2023

View reviewed changes

MGibson1 self-assigned this May 4, 2023

MGibson1 mentioned this pull request May 4, 2023

[PM-1320] Automatically load SIMD binary for argon2 #5368

Closed

MGibson1 added the needs-qa Marks a PR as requiring QA approval label May 4, 2023

Merge remote-tracking branch 'origin/master' into feature/argon2-simd

8145063

MGibson1 approved these changes Jun 12, 2023

View reviewed changes

MGibson1 removed the needs-qa Marks a PR as requiring QA approval label Jun 12, 2023

MGibson1 merged commit cd85a4c into bitwarden:master Jun 12, 2023
32 of 38 checks passed

quexten mentioned this pull request Aug 2, 2023

[PM-3284] Fix argon2 simd loading for desktop clients #5938

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PM-1320] Argon2 SIMD support #4921

[PM-1320] Argon2 SIMD support #4921

quexten commented Mar 3, 2023 •

edited

Loading

bitwarden-bot commented Mar 3, 2023

MGibson1 commented Mar 9, 2023

quexten commented Mar 9, 2023 •

edited

Loading

MGibson1 commented Mar 13, 2023

Hinton commented Mar 13, 2023 •

edited

Loading

quexten commented Apr 4, 2023 •

edited

Loading

MGibson1 left a comment

MGibson1 May 4, 2023

quexten May 4, 2023

quexten May 4, 2023

MGibson1 May 4, 2023

MGibson1 left a comment •

edited

Loading

quexten commented Jun 12, 2023

[PM-1320] Argon2 SIMD support #4921

[PM-1320] Argon2 SIMD support #4921

Conversation

quexten commented Mar 3, 2023 • edited Loading

Type of change

Objective

Code changes

bitwarden-bot commented Mar 3, 2023

MGibson1 commented Mar 9, 2023

quexten commented Mar 9, 2023 • edited Loading

MGibson1 commented Mar 13, 2023

Hinton commented Mar 13, 2023 • edited Loading

quexten commented Apr 4, 2023 • edited Loading

MGibson1 left a comment

Choose a reason for hiding this comment

MGibson1 May 4, 2023

Choose a reason for hiding this comment

quexten May 4, 2023

Choose a reason for hiding this comment

quexten May 4, 2023

Choose a reason for hiding this comment

MGibson1 May 4, 2023

Choose a reason for hiding this comment

MGibson1 left a comment • edited Loading

Choose a reason for hiding this comment

quexten commented Jun 12, 2023

quexten commented Mar 3, 2023 •

edited

Loading

quexten commented Mar 9, 2023 •

edited

Loading

Hinton commented Mar 13, 2023 •

edited

Loading

quexten commented Apr 4, 2023 •

edited

Loading

MGibson1 left a comment •

edited

Loading