Skip to content

Commit

Permalink
Note, in the README, that polyfilled CryptoKeys can not be stored i…
Browse files Browse the repository at this point in the history
…n IndexedDB

Closes #1911
  • Loading branch information
steveluscher committed Dec 8, 2023
1 parent 24870d6 commit 2e55f78
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions packages/webcrypto-ed25519-polyfill/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ This package contains a polyfill that enables Ed25519 key manipulation in enviro
> [!WARNING]
> Because this package's implementation of Ed25519 key generation exists in userspace, it can't guarantee that the keys you generate with it are non-exportable. Untrusted code running in your JavaScript context may still be able to gain access to and/or exfiltrate secret key material.
> [!CAUTION]
> Native `CryptoKeys` can be stored in IndexedDB but the keys created by this polyfill can not. This is because, unlike native `CryptoKeys`, our polyfilled key objects can not implement the [structured clone algorithm](https://www.w3.org/TR/WebCryptoAPI/#cryptokey-interface-clone).
## Usage

Environments that support Ed25519 (see https://github.com/WICG/webcrypto-secure-curves/issues/20) do not require this polyfill.
Expand Down

0 comments on commit 2e55f78

Please sign in to comment.