doc: add changelogs for crypto

PR-URL: https://github.com/nodejs/node/pull/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>
8 years ago · d27c9834f3
1 changed files with 59 additions and 0 deletions
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@ -232,6 +232,10 @@ Returns `this` for method chaining.
 ### cipher.update(data[, input_encoding][, output_encoding])
 <!-- YAML
 added: v0.1.94
+changes:
+  - version: v6.0.0
+    pr-url: https://github.com/nodejs/node/pull/5522
+    description: The default `input_encoding` changed from `binary` to `utf8`.
 -->

 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.
 ### decipher.setAAD(buffer)
 <!-- YAML
 added: v1.0.0
+changes:
+  - version: v7.2.0
+    pr-url: https://github.com/nodejs/node/pull/9398
+    description: This method now returns a reference to `decipher`.
 -->

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

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

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

 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.
 ### hash.update(data[, input_encoding])
 <!-- YAML
 added: v0.1.92
+changes:
+  - version: v6.0.0
+    pr-url: https://github.com/nodejs/node/pull/5522
+    description: The default `input_encoding` changed from `binary` to `utf8`.
 -->

 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.
 ### hmac.update(data[, input_encoding])
 <!-- YAML
 added: v0.1.94
+changes:
+  - version: v6.0.0
+    pr-url: https://github.com/nodejs/node/pull/5522
+    description: The default `input_encoding` changed from `binary` to `utf8`.
 -->

 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.
 ### sign.update(data[, input_encoding])
 <!-- YAML
 added: v0.1.92
+changes:
+  - version: v6.0.0
+    pr-url: https://github.com/nodejs/node/pull/5522
+    description: The default `input_encoding` changed from `binary` to `utf8`.
 -->

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

 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
 ### crypto.createDiffieHellman(prime[, prime_encoding][, generator][, generator_encoding])
 <!-- YAML
 added: v0.11.12
+changes:
+  - version: v6.0.0
+    pr-url: https://github.com/nodejs/node/pull/5522
+    description: The default for the encoding parameters changed
+                 from `binary` to `utf8`.
 -->

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

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

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