Skip to content

doc: fix typos and inconsistencies in crypto.md and webcrypto.md #62828

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

Open
panva wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −22
Open

doc: fix typos and inconsistencies in crypto.md and webcrypto.md #62828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/api/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1172,7 +1172,7 @@ changes:
* `options` {Object} [`stream.transform` options][]
* `plaintextLength` {number}
* `encoding` {string} String encoding to use when `buffer` is a string.
* Returns: {Decipheriv} The same Decipher for method chaining.
* Returns: {Decipheriv} The same `Decipheriv` instance for method chaining.

When using an authenticated encryption mode (`GCM`, `CCM`, `OCB`, and
`chacha20-poly1305` are
Expand Down Expand Up @@ -1219,7 +1219,7 @@ changes:

* `buffer` {string|Buffer|ArrayBuffer|TypedArray|DataView}
* `encoding` {string} String encoding to use when `buffer` is a string.
* Returns: {Decipheriv} The same Decipher for method chaining.
* Returns: {Decipheriv} The same `Decipheriv` instance for method chaining.

When using an authenticated encryption mode (`GCM`, `CCM`, `OCB`, and
`chacha20-poly1305` are
Expand All @@ -1245,7 +1245,7 @@ added: v0.7.1
-->

* `autoPadding` {boolean} **Default:** `true`
* Returns: {Decipheriv} The same Decipher for method chaining.
* Returns: {Decipheriv} The same `Decipheriv` instance for method chaining.

When data has been encrypted without standard block padding, calling
`decipher.setAutoPadding(false)` will disable automatic padding to prevent
Expand Down Expand Up @@ -5333,7 +5333,7 @@ changes:

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

Decrypts `buffer` with `key`.`buffer` was previously encrypted using
Decrypts `buffer` with `key`. `buffer` was previously encrypted using
the corresponding private key, for example using [`crypto.privateEncrypt()`][].

If `key` is not a [`KeyObject`][], this function behaves as if
Expand Down
36 changes: 18 additions & 18 deletions doc/api/webcrypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,8 +513,8 @@ const decrypted = new TextDecoder().decode(await crypto.subtle.decrypt(

## Algorithm matrix

The tables details the algorithms supported by the Node.js Web Crypto API
implementation and the APIs supported for each:
The following tables detail the algorithms supported by the Node.js Web
Crypto API implementation and the APIs supported for each:

### Key Management APIs

Expand Down Expand Up @@ -755,7 +755,7 @@ Valid key usages depend on the key algorithm (identified by
| `'ECDSA'` | | ✔ | | | |
| `'Ed25519'` | | ✔ | | | |
| `'Ed448'`[^secure-curves] | | ✔ | | | |
| `'HDKF'` | | | ✔ | | |
| `'HKDF'` | | | ✔ | | |
| `'HMAC'` | | ✔ | | | |
| `'KMAC128'`[^modern-algos] | | ✔ | | | |
| `'KMAC256'`[^modern-algos] | | ✔ | | | |
Expand Down Expand Up @@ -992,7 +992,7 @@ a new {CryptoKey} based on the method and parameters in `derivedKeyAlgorithm`.

Calling this method is equivalent to calling [`subtle.deriveBits()`][] to
generate raw keying material, then passing the result into the
[`subtle.importKey()`][] method using the `deriveKeyAlgorithm`, `extractable`, and
[`subtle.importKey()`][] method using the `derivedKeyAlgorithm`, `extractable`, and
`keyUsages` parameters as input.

The algorithms currently supported include:
Expand Down Expand Up @@ -1348,7 +1348,7 @@ The algorithms currently supported include:
| `'ECDSA'` | ✔ | ✔ | ✔ | ✔ | | ✔ | |
| `'Ed25519'` | ✔ | ✔ | ✔ | ✔ | | ✔ | |
| `'Ed448'`[^secure-curves] | ✔ | ✔ | ✔ | ✔ | | ✔ | |
| `'HDKF'` | | | | ✔ | ✔ | | |
| `'HKDF'` | | | | ✔ | ✔ | | |
| `'HMAC'` | | | ✔ | ✔ | ✔ | | |
| `'KMAC128'`[^modern-algos] | | | ✔ | | ✔ | | |
| `'KMAC256'`[^modern-algos] | | | ✔ | | ✔ | | |
Expand Down Expand Up @@ -1472,14 +1472,14 @@ The unwrapped key algorithms supported include:
* `'Ed25519'`
* `'Ed448'`[^secure-curves]
* `'HMAC'`
* `'KMAC128'`[^secure-curves]
* `'KMAC256'`[^secure-curves]
* `'KMAC128'`[^modern-algos]
* `'KMAC256'`[^modern-algos]
* `'ML-DSA-44'`[^modern-algos]
* `'ML-DSA-65'`[^modern-algos]
* `'ML-DSA-87'`[^modern-algos]
* `'ML-KEM-512'`[^modern-algos]
* `'ML-KEM-768'`[^modern-algos]
* `'ML-KEM-1024'`[^modern-algos]v
* `'ML-KEM-1024'`[^modern-algos]
* `'RSA-OAEP'`
* `'RSA-PSS'`
* `'RSASSA-PKCS1-v1_5'`
Expand Down Expand Up @@ -1525,8 +1525,8 @@ The algorithms currently supported include:
* `'Ed25519'`
* `'Ed448'`[^secure-curves]
* `'HMAC'`
* `'KMAC128'`[^secure-curves]
* `'KMAC256'`[^secure-curves]
* `'KMAC128'`[^modern-algos]
* `'KMAC256'`[^modern-algos]
* `'ML-DSA-44'`[^modern-algos]
* `'ML-DSA-65'`[^modern-algos]
* `'ML-DSA-87'`[^modern-algos]
Expand Down Expand Up @@ -1873,7 +1873,7 @@ added: v24.7.0
added: v24.7.0
-->

* Type: {string} Must be `Ed448`[^secure-curves], `'ML-DSA-44'`[^modern-algos],
* Type: {string} Must be `'Ed448'`[^secure-curves], `'ML-DSA-44'`[^modern-algos],
`'ML-DSA-65'`[^modern-algos], or `'ML-DSA-87'`[^modern-algos].

#### `contextParams.context`
Expand Down Expand Up @@ -1909,7 +1909,7 @@ changes:
added: v24.7.0
-->

* Type: {string} Must be `'cSHAKE128'`[^modern-algos] or `'cSHAKE256'`[^modern-algos]
* Type: {string} Must be `'cSHAKE128'`[^modern-algos] or `'cSHAKE256'`[^modern-algos].

#### `cShakeParams.outputLength`

Expand All @@ -1929,7 +1929,7 @@ added: v24.7.0

* Type: {ArrayBuffer|TypedArray|DataView|Buffer|undefined}

The `functionName` member represents represents the function name, used by NIST to define
The `functionName` member represents the function name, used by NIST to define
functions based on cSHAKE.
The Node.js Web Crypto API implementation only supports zero-length functionName
which is equivalent to not providing functionName at all.
Expand Down Expand Up @@ -1968,9 +1968,9 @@ added: v15.0.0

* Type: {CryptoKey}

ECDH key derivation operates by taking as input one parties private key and
another parties public key -- using both to generate a common shared secret.
The `ecdhKeyDeriveParams.public` property is set to the other parties public
ECDH key derivation operates by taking as input one party's private key and
another party's public key -- using both to generate a common shared secret.
The `ecdhKeyDeriveParams.public` property is set to the other party's public
key.

### Class: `EcdsaParams`
Expand Down Expand Up @@ -2364,7 +2364,7 @@ The optional customization string for KangarooTwelve.
added: v25.9.0
-->

* Type: {string} Must be `'KT128'`[^modern-algos] or `'KT256'`[^modern-algos]
* Type: {string} Must be `'KT128'`[^modern-algos] or `'KT256'`[^modern-algos].

#### `kangarooTwelveParams.outputLength`

Expand Down Expand Up @@ -2770,7 +2770,7 @@ The optional domain separation byte (0x01-0x7f). Defaults to `0x1f`.
added: v25.9.0
-->

* Type: {string} Must be `'TurboSHAKE128'`[^modern-algos] or `'TurboSHAKE256'`[^modern-algos]
* Type: {string} Must be `'TurboSHAKE128'`[^modern-algos] or `'TurboSHAKE256'`[^modern-algos].

#### `turboShakeParams.outputLength`

Expand Down
Loading