Skip to content

Commit d27c983

Browse files
committed
doc: add changelogs for crypto
PR-URL: #11489 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Sam Roberts <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Italo A. Casas <[email protected]>
1 parent 7b5a4ba commit d27c983

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

doc/api/crypto.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,10 @@ Returns `this` for method chaining.
232232
### cipher.update(data[, input_encoding][, output_encoding])
233233
<!-- YAML
234234
added: v0.1.94
235+
changes:
236+
- version: v6.0.0
237+
pr-url: https://github.com/nodejs/node/pull/5522
238+
description: The default `input_encoding` changed from `binary` to `utf8`.
235239
-->
236240

237241
Updates the cipher with `data`. If the `input_encoding` argument is given,
@@ -330,6 +334,10 @@ than once will result in an error being thrown.
330334
### decipher.setAAD(buffer)
331335
<!-- YAML
332336
added: v1.0.0
337+
changes:
338+
- version: v7.2.0
339+
pr-url: https://github.com/nodejs/node/pull/9398
340+
description: This method now returns a reference to `decipher`.
333341
-->
334342

335343
When using an authenticated encryption mode (only `GCM` is currently
@@ -343,6 +351,10 @@ Returns `this` for method chaining.
343351
### decipher.setAuthTag(buffer)
344352
<!-- YAML
345353
added: v1.0.0
354+
changes:
355+
- version: v7.2.0
356+
pr-url: https://github.com/nodejs/node/pull/9398
357+
description: This method now returns a reference to `decipher`.
346358
-->
347359

348360
When using an authenticated encryption mode (only `GCM` is currently
@@ -376,6 +388,10 @@ Returns `this` for method chaining.
376388
### decipher.update(data[, input_encoding][, output_encoding])
377389
<!-- YAML
378390
added: v0.1.94
391+
changes:
392+
- version: v6.0.0
393+
pr-url: https://github.com/nodejs/node/pull/5522
394+
description: The default `input_encoding` changed from `binary` to `utf8`.
379395
-->
380396

381397
Updates the decipher with `data`. If the `input_encoding` argument is given,
@@ -556,6 +572,10 @@ assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));
556572
### ecdh.computeSecret(other_public_key[, input_encoding][, output_encoding])
557573
<!-- YAML
558574
added: v0.11.14
575+
changes:
576+
- version: v6.0.0
577+
pr-url: https://github.com/nodejs/node/pull/5522
578+
description: The default `input_encoding` changed from `binary` to `utf8`.
559579
-->
560580

561581
Computes the shared secret using `other_public_key` as the other
@@ -739,6 +759,10 @@ called. Multiple calls will cause an error to be thrown.
739759
### hash.update(data[, input_encoding])
740760
<!-- YAML
741761
added: v0.1.92
762+
changes:
763+
- version: v6.0.0
764+
pr-url: https://github.com/nodejs/node/pull/5522
765+
description: The default `input_encoding` changed from `binary` to `utf8`.
742766
-->
743767

744768
Updates the hash content with the given `data`, the encoding of which
@@ -821,6 +845,10 @@ called. Multiple calls to `hmac.digest()` will result in an error being thrown.
821845
### hmac.update(data[, input_encoding])
822846
<!-- YAML
823847
added: v0.1.94
848+
changes:
849+
- version: v6.0.0
850+
pr-url: https://github.com/nodejs/node/pull/5522
851+
description: The default `input_encoding` changed from `binary` to `utf8`.
824852
-->
825853

826854
Updates the `Hmac` content with the given `data`, the encoding of which
@@ -922,6 +950,10 @@ called. Multiple calls to `sign.sign()` will result in an error being thrown.
922950
### sign.update(data[, input_encoding])
923951
<!-- YAML
924952
added: v0.1.92
953+
changes:
954+
- version: v6.0.0
955+
pr-url: https://github.com/nodejs/node/pull/5522
956+
description: The default `input_encoding` changed from `binary` to `utf8`.
925957
-->
926958

927959
Updates the `Sign` content with the given `data`, the encoding of which
@@ -980,6 +1012,10 @@ console.log(verify.verify(publicKey, signature));
9801012
### verifier.update(data[, input_encoding])
9811013
<!-- YAML
9821014
added: v0.1.92
1015+
changes:
1016+
- version: v6.0.0
1017+
pr-url: https://github.com/nodejs/node/pull/5522
1018+
description: The default `input_encoding` changed from `binary` to `utf8`.
9831019
-->
9841020

9851021
Updates the `Verify` content with the given `data`, the encoding of which
@@ -1141,6 +1177,11 @@ The `key` is the raw key used by the `algorithm` and `iv` is an
11411177
### crypto.createDiffieHellman(prime[, prime_encoding][, generator][, generator_encoding])
11421178
<!-- YAML
11431179
added: v0.11.12
1180+
changes:
1181+
- version: v6.0.0
1182+
pr-url: https://github.com/nodejs/node/pull/5522
1183+
description: The default for the encoding parameters changed
1184+
from `binary` to `utf8`.
11441185
-->
11451186

11461187
Creates a `DiffieHellman` key exchange object using the supplied `prime` and an
@@ -1342,6 +1383,15 @@ console.log(hashes); // ['DSA', 'DSA-SHA', 'DSA-SHA1', ...]
13421383
### crypto.pbkdf2(password, salt, iterations, keylen, digest, callback)
13431384
<!-- YAML
13441385
added: v0.5.5
1386+
changes:
1387+
- version: v6.0.0
1388+
pr-url: https://github.com/nodejs/node/pull/4047
1389+
description: Calling this function without passing the `digest` parameter
1390+
is deprecated now and will emit a warning.
1391+
- version: v6.0.0
1392+
pr-url: https://github.com/nodejs/node/pull/5522
1393+
description: The default encoding for `password` if it is a string changed
1394+
from `binary` to `utf8`.
13451395
-->
13461396

13471397
Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2)
@@ -1377,6 +1427,15 @@ An array of supported digest functions can be retrieved using
13771427
### crypto.pbkdf2Sync(password, salt, iterations, keylen, digest)
13781428
<!-- YAML
13791429
added: v0.9.3
1430+
changes:
1431+
- version: v6.0.0
1432+
pr-url: https://github.com/nodejs/node/pull/4047
1433+
description: Calling this function without passing the `digest` parameter
1434+
is deprecated now and will emit a warning.
1435+
- version: v6.0.0
1436+
pr-url: https://github.com/nodejs/node/pull/5522
1437+
description: The default encoding for `password` if it is a string changed
1438+
from `binary` to `utf8`.
13801439
-->
13811440

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

0 commit comments

Comments
 (0)