Use browser crypto for SCRAM #988
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since all supported platforms support browser-compatible crypto, remove the extraneous adapters and standardize on the browser API. This requires a flag for Node v18 to enable the browser global `--experimental-global-webcrypto`, but this is already required by a few other libraries in our ecosystem.
Node 18 hides the `crypto` global behind a flag, so make note of that in the main README.
Since our CI still runs on Node 18, ensure we run with this flag on which is a no-op for newer versions
There is some security reason we are specifically not allowed to set NODE_OPTIONS in GITHUB_ENV.
Is this needed still?
scotttrinh
force-pushed
the
use-browser-crypto-everywhere
branch
from
6e07128
to
627eeef
Compare
elprans
reviewed
May 1, 2024
README.md
Outdated
| @@ -39,6 +39,9 @@ writing some simple queries. | |||
| ### Requirements | |||
|
|
|||
| - Node.js 18+ | |||
| - The driver requires the Browser API `crypto` to be available as a global. | |||
| Therefore, for Node 18, you _must_ run `node` with the special command line | |||
There was a problem hiding this comment.
Since you mention 18+ above, I would rephrase this to clarify that only 18 needs the flag, as the feature stabilized in 20+
There was a problem hiding this comment.
Instead of "Therefore, for Node 18," maybe "Therefore, for Node 18 only,"?
There was a problem hiding this comment.
Or maybe "Therefore, for Node versions before 19,"?
|
I'm going to sit on this for a while. Feels like something that we'd want to require a major version bump 😰 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since all supported platforms support browser-compatible crypto, remove
the extraneous adapters and standardize on the browser API. This
requires a flag for Node v18 to enable the browser global
--experimental-global-webcrypto, but this is already required by a fewother libraries in our ecosystem.