Skip to content

Commit 981ce96

Browse files
panvaaduh95
panva
authored and
aduh95
committed
doc: fix typos and inconsistencies in crypto.md and webcrypto.md
Signed-off-by: Filip Skokan <panva.ip@gmail.com> PR-URL: #62828 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
1 parent b992962 commit 981ce96

2 files changed

Lines changed: 22 additions & 22 deletions

File tree

‎doc/api/crypto.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1172,7 +1172,7 @@ changes:
11721172
* `options` {Object} [`stream.transform` options][]
11731173
* `plaintextLength` {number}
11741174
* `encoding` {string} String encoding to use when `buffer` is a string.
1175-
* Returns: {Decipheriv} The same Decipher for method chaining.
1175+
* Returns: {Decipheriv} The same `Decipheriv` instance for method chaining.
11761176

11771177
When using an authenticated encryption mode (`GCM`, `CCM`, `OCB`, and
11781178
`chacha20-poly1305` are
@@ -1219,7 +1219,7 @@ changes:
12191219

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

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

12471247
* `autoPadding` {boolean} **Default:** `true`
1248-
* Returns: {Decipheriv} The same Decipher for method chaining.
1248+
* Returns: {Decipheriv} The same `Decipheriv` instance for method chaining.
12491249

12501250
When data has been encrypted without standard block padding, calling
12511251
`decipher.setAutoPadding(false)` will disable automatic padding to prevent
@@ -5335,7 +5335,7 @@ changes:
53355335

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

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

53415341
If `key` is not a [`KeyObject`][], this function behaves as if

‎doc/api/webcrypto.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -513,8 +513,8 @@ const decrypted = new TextDecoder().decode(await crypto.subtle.decrypt(
513513
514514
## Algorithm matrix
515515
516-
The tables details the algorithms supported by the Node.js Web Crypto API
517-
implementation and the APIs supported for each:
516+
The following tables detail the algorithms supported by the Node.js Web
517+
Crypto API implementation and the APIs supported for each:
518518
519519
### Key Management APIs
520520
@@ -755,7 +755,7 @@ Valid key usages depend on the key algorithm (identified by
755755
| `'ECDSA'` | | ✔ | | | |
756756
| `'Ed25519'` | | ✔ | | | |
757757
| `'Ed448'`[^secure-curves] | | ✔ | | | |
758-
| `'HDKF'` | | | ✔ | | |
758+
| `'HKDF'` | | | ✔ | | |
759759
| `'HMAC'` | | ✔ | | | |
760760
| `'KMAC128'`[^modern-algos] | | ✔ | | | |
761761
| `'KMAC256'`[^modern-algos] | | ✔ | | | |
@@ -992,7 +992,7 @@ a new {CryptoKey} based on the method and parameters in `derivedKeyAlgorithm`.
992992
993993
Calling this method is equivalent to calling [`subtle.deriveBits()`][] to
994994
generate raw keying material, then passing the result into the
995-
[`subtle.importKey()`][] method using the `deriveKeyAlgorithm`, `extractable`, and
995+
[`subtle.importKey()`][] method using the `derivedKeyAlgorithm`, `extractable`, and
996996
`keyUsages` parameters as input.
997997
998998
The algorithms currently supported include:
@@ -1346,7 +1346,7 @@ The algorithms currently supported include:
13461346
| `'ECDSA'` | ✔ | ✔ | ✔ | ✔ | | ✔ | |
13471347
| `'Ed25519'` | ✔ | ✔ | ✔ | ✔ | | ✔ | |
13481348
| `'Ed448'`[^secure-curves] | ✔ | ✔ | ✔ | ✔ | | ✔ | |
1349-
| `'HDKF'` | | | | ✔ | ✔ | | |
1349+
| `'HKDF'` | | | | ✔ | ✔ | | |
13501350
| `'HMAC'` | | | ✔ | ✔ | ✔ | | |
13511351
| `'KMAC128'`[^modern-algos] | | | ✔ | | ✔ | | |
13521352
| `'KMAC256'`[^modern-algos] | | | ✔ | | ✔ | | |
@@ -1470,14 +1470,14 @@ The unwrapped key algorithms supported include:
14701470
* `'Ed25519'`
14711471
* `'Ed448'`[^secure-curves]
14721472
* `'HMAC'`
1473-
* `'KMAC128'`[^secure-curves]
1474-
* `'KMAC256'`[^secure-curves]
1473+
* `'KMAC128'`[^modern-algos]
1474+
* `'KMAC256'`[^modern-algos]
14751475
* `'ML-DSA-44'`[^modern-algos]
14761476
* `'ML-DSA-65'`[^modern-algos]
14771477
* `'ML-DSA-87'`[^modern-algos]
14781478
* `'ML-KEM-512'`[^modern-algos]
14791479
* `'ML-KEM-768'`[^modern-algos]
1480-
* `'ML-KEM-1024'`[^modern-algos]v
1480+
* `'ML-KEM-1024'`[^modern-algos]
14811481
* `'RSA-OAEP'`
14821482
* `'RSA-PSS'`
14831483
* `'RSASSA-PKCS1-v1_5'`
@@ -1523,8 +1523,8 @@ The algorithms currently supported include:
15231523
* `'Ed25519'`
15241524
* `'Ed448'`[^secure-curves]
15251525
* `'HMAC'`
1526-
* `'KMAC128'`[^secure-curves]
1527-
* `'KMAC256'`[^secure-curves]
1526+
* `'KMAC128'`[^modern-algos]
1527+
* `'KMAC256'`[^modern-algos]
15281528
* `'ML-DSA-44'`[^modern-algos]
15291529
* `'ML-DSA-65'`[^modern-algos]
15301530
* `'ML-DSA-87'`[^modern-algos]
@@ -1871,7 +1871,7 @@ added: v24.7.0
18711871
added: v24.7.0
18721872
-->
18731873
1874-
* Type: {string} Must be `Ed448`[^secure-curves], `'ML-DSA-44'`[^modern-algos],
1874+
* Type: {string} Must be `'Ed448'`[^secure-curves], `'ML-DSA-44'`[^modern-algos],
18751875
`'ML-DSA-65'`[^modern-algos], or `'ML-DSA-87'`[^modern-algos].
18761876
18771877
#### `contextParams.context`
@@ -1905,7 +1905,7 @@ changes:
19051905
added: v24.7.0
19061906
-->
19071907
1908-
* Type: {string} Must be `'cSHAKE128'`[^modern-algos] or `'cSHAKE256'`[^modern-algos]
1908+
* Type: {string} Must be `'cSHAKE128'`[^modern-algos] or `'cSHAKE256'`[^modern-algos].
19091909
19101910
#### `cShakeParams.outputLength`
19111911
@@ -1923,7 +1923,7 @@ added: v24.7.0
19231923
19241924
* Type: {ArrayBuffer|TypedArray|DataView|Buffer|undefined}
19251925
1926-
The `functionName` member represents represents the function name, used by NIST to define
1926+
The `functionName` member represents the function name, used by NIST to define
19271927
functions based on cSHAKE.
19281928
The Node.js Web Crypto API implementation only supports zero-length functionName
19291929
which is equivalent to not providing functionName at all.
@@ -1962,9 +1962,9 @@ added: v15.0.0
19621962
19631963
* Type: {CryptoKey}
19641964
1965-
ECDH key derivation operates by taking as input one parties private key and
1966-
another parties public key -- using both to generate a common shared secret.
1967-
The `ecdhKeyDeriveParams.public` property is set to the other parties public
1965+
ECDH key derivation operates by taking as input one party's private key and
1966+
another party's public key -- using both to generate a common shared secret.
1967+
The `ecdhKeyDeriveParams.public` property is set to the other party's public
19681968
key.
19691969
19701970
### Class: `EcdsaParams`
@@ -2358,7 +2358,7 @@ The optional customization string for KangarooTwelve.
23582358
added: v26.0.0
23592359
-->
23602360
2361-
* Type: {string} Must be `'KT128'`[^modern-algos] or `'KT256'`[^modern-algos]
2361+
* Type: {string} Must be `'KT128'`[^modern-algos] or `'KT256'`[^modern-algos].
23622362
23632363
#### `kangarooTwelveParams.outputLength`
23642364
@@ -2760,7 +2760,7 @@ The optional domain separation byte (0x01-0x7f). Defaults to `0x1f`.
27602760
added: v26.0.0
27612761
-->
27622762
2763-
* Type: {string} Must be `'TurboSHAKE128'`[^modern-algos] or `'TurboSHAKE256'`[^modern-algos]
2763+
* Type: {string} Must be `'TurboSHAKE128'`[^modern-algos] or `'TurboSHAKE256'`[^modern-algos].
27642764
27652765
#### `turboShakeParams.outputLength`
27662766

0 commit comments

Comments
 (0)