Skip to content

Commit e23598d

Browse files
committed
doc: add changelogs for crypto
PR-URL: #11489 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com>
1 parent 296e22a commit e23598d

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

doc/api/crypto.md

+59
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,10 @@ Returns `this` for method chaining.
229229
### cipher.update(data[, input_encoding][, output_encoding])
230230
<!-- YAML
231231
added: v0.1.94
232+
changes:
233+
- version: v6.0.0
234+
pr-url: https://github.com/nodejs/node/pull/5522
235+
description: The default `input_encoding` changed from `binary` to `utf8`.
232236
-->
233237

234238
Updates the cipher with `data`. If the `input_encoding` argument is given,
@@ -327,6 +331,10 @@ than once will result in an error being thrown.
327331
### decipher.setAAD(buffer)
328332
<!-- YAML
329333
added: v1.0.0
334+
changes:
335+
- version: v7.2.0
336+
pr-url: https://github.com/nodejs/node/pull/9398
337+
description: This method now returns a reference to `decipher`.
330338
-->
331339

332340
When using an authenticated encryption mode (only `GCM` is currently
@@ -338,6 +346,10 @@ Returns `this` for method chaining.
338346
### decipher.setAuthTag(buffer)
339347
<!-- YAML
340348
added: v1.0.0
349+
changes:
350+
- version: v7.2.0
351+
pr-url: https://github.com/nodejs/node/pull/9398
352+
description: This method now returns a reference to `decipher`.
341353
-->
342354

343355
When using an authenticated encryption mode (only `GCM` is currently
@@ -368,6 +380,10 @@ Returns `this` for method chaining.
368380
### decipher.update(data[, input_encoding][, output_encoding])
369381
<!-- YAML
370382
added: v0.1.94
383+
changes:
384+
- version: v6.0.0
385+
pr-url: https://github.com/nodejs/node/pull/5522
386+
description: The default `input_encoding` changed from `binary` to `utf8`.
371387
-->
372388

373389
Updates the decipher with `data`. If the `input_encoding` argument is given,
@@ -548,6 +564,10 @@ assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));
548564
### ecdh.computeSecret(other_public_key[, input_encoding][, output_encoding])
549565
<!-- YAML
550566
added: v0.11.14
567+
changes:
568+
- version: v6.0.0
569+
pr-url: https://github.com/nodejs/node/pull/5522
570+
description: The default `input_encoding` changed from `binary` to `utf8`.
551571
-->
552572

553573
Computes the shared secret using `other_public_key` as the other
@@ -731,6 +751,10 @@ called. Multiple calls will cause an error to be thrown.
731751
### hash.update(data[, input_encoding])
732752
<!-- YAML
733753
added: v0.1.92
754+
changes:
755+
- version: v6.0.0
756+
pr-url: https://github.com/nodejs/node/pull/5522
757+
description: The default `input_encoding` changed from `binary` to `utf8`.
734758
-->
735759

736760
Updates the hash content with the given `data`, the encoding of which
@@ -813,6 +837,10 @@ called. Multiple calls to `hmac.digest()` will result in an error being thrown.
813837
### hmac.update(data[, input_encoding])
814838
<!-- YAML
815839
added: v0.1.94
840+
changes:
841+
- version: v6.0.0
842+
pr-url: https://github.com/nodejs/node/pull/5522
843+
description: The default `input_encoding` changed from `binary` to `utf8`.
816844
-->
817845

818846
Updates the `Hmac` content with the given `data`, the encoding of which
@@ -914,6 +942,10 @@ called. Multiple calls to `sign.sign()` will result in an error being thrown.
914942
### sign.update(data[, input_encoding])
915943
<!-- YAML
916944
added: v0.1.92
945+
changes:
946+
- version: v6.0.0
947+
pr-url: https://github.com/nodejs/node/pull/5522
948+
description: The default `input_encoding` changed from `binary` to `utf8`.
917949
-->
918950

919951
Updates the `Sign` content with the given `data`, the encoding of which
@@ -972,6 +1004,10 @@ console.log(verify.verify(publicKey, signature));
9721004
### verifier.update(data[, input_encoding])
9731005
<!-- YAML
9741006
added: v0.1.92
1007+
changes:
1008+
- version: v6.0.0
1009+
pr-url: https://github.com/nodejs/node/pull/5522
1010+
description: The default `input_encoding` changed from `binary` to `utf8`.
9751011
-->
9761012

9771013
Updates the `Verify` content with the given `data`, the encoding of which
@@ -1133,6 +1169,11 @@ The `key` is the raw key used by the `algorithm` and `iv` is an
11331169
### crypto.createDiffieHellman(prime[, prime_encoding][, generator][, generator_encoding])
11341170
<!-- YAML
11351171
added: v0.11.12
1172+
changes:
1173+
- version: v6.0.0
1174+
pr-url: https://github.com/nodejs/node/pull/5522
1175+
description: The default for the encoding parameters changed
1176+
from `binary` to `utf8`.
11361177
-->
11371178

11381179
Creates a `DiffieHellman` key exchange object using the supplied `prime` and an
@@ -1334,6 +1375,15 @@ console.log(hashes); // ['DSA', 'DSA-SHA', 'DSA-SHA1', ...]
13341375
### crypto.pbkdf2(password, salt, iterations, keylen, digest, callback)
13351376
<!-- YAML
13361377
added: v0.5.5
1378+
changes:
1379+
- version: v6.0.0
1380+
pr-url: https://github.com/nodejs/node/pull/4047
1381+
description: Calling this function without passing the `digest` parameter
1382+
is deprecated now and will emit a warning.
1383+
- version: v6.0.0
1384+
pr-url: https://github.com/nodejs/node/pull/5522
1385+
description: The default encoding for `password` if it is a string changed
1386+
from `binary` to `utf8`.
13371387
-->
13381388

13391389
Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2)
@@ -1369,6 +1419,15 @@ An array of supported digest functions can be retrieved using
13691419
### crypto.pbkdf2Sync(password, salt, iterations, keylen, digest)
13701420
<!-- YAML
13711421
added: v0.9.3
1422+
changes:
1423+
- version: v6.0.0
1424+
pr-url: https://github.com/nodejs/node/pull/4047
1425+
description: Calling this function without passing the `digest` parameter
1426+
is deprecated now and will emit a warning.
1427+
- version: v6.0.0
1428+
pr-url: https://github.com/nodejs/node/pull/5522
1429+
description: The default encoding for `password` if it is a string changed
1430+
from `binary` to `utf8`.
13721431
-->
13731432

13741433
Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2)

0 commit comments

Comments
 (0)