Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc,crypto: add missing algorithms and types to webcrypto documentation #44876

Closed
wants to merge 2 commits into from
Closed

doc,crypto: add missing algorithms and types to webcrypto documentation #44876

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d2ac63
doc,crypto: add null length to crypto.subtle.deriveBits
panva Oct 3, 2022
ffdd070
doc,crypto: add missing CFRG curve algorithms to supported lists
panva Oct 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 20 additions & 4 deletions doc/api/webcrypto.md
View file
Open in desktop
Expand Up @@ -575,20 +575,30 @@ changes:

* `algorithm`: {AlgorithmIdentifier|EcdhKeyDeriveParams|HkdfParams|Pbkdf2Params}
* `baseKey`: {CryptoKey}
* `length`: {number}
* `length`: {number|null}
* Returns: {Promise} containing {ArrayBuffer}

<!--lint enable maximum-line-length remark-lint-->

Using the method and parameters specified in `algorithm` and the keying
material provided by `baseKey`, `subtle.deriveBits()` attempts to generate
`length` bits. The Node.js implementation requires that `length` is a
multiple of `8`. If successful, the returned promise will be resolved with
an {ArrayBuffer} containing the generated data.
`length` bits.

The Node.js implementation requires that when `length` is a
number it must be multiple of `8`.

When `length` is `null` the maximum number of bits for a given algorithm is
generated. This is allowed for the `'ECDH'`, `'X25519'`[^1], and `'X448'`[^1]
algorithms.

If successful, the returned promise will be resolved with an {ArrayBuffer}
containing the generated data.

The algorithms currently supported include:

* `'ECDH'`
* `'X25519'`[^1]
* `'X448'`[^1]
* `'HKDF'`
* `'PBKDF2'`

Expand Down Expand Up @@ -627,6 +637,8 @@ generate raw keying material, then passing the result into the
The algorithms currently supported include:

* `'ECDH'`
* `'X25519'`[^1]
* `'X448'`[^1]
* `'HKDF'`
* `'PBKDF2'`

Expand Down Expand Up @@ -902,7 +914,11 @@ The unwrapped key algorithms supported include:
* `'RSA-PSS'`
* `'RSA-OAEP'`
* `'ECDSA'`
* `'Ed25519'`[^1]
* `'Ed448'`[^1]
* `'ECDH'`
* `'X25519'`[^1]
* `'X448'`[^1]
* `'HMAC'`
* `'AES-CTR'`
* `'AES-CBC'`
Expand Down