aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTobias Nießen <tniessen@tnie.de>2018-02-07 16:20:21 +0100
committerRuben Bridgewater <ruben@bridgewater.de>2018-02-10 15:58:46 +0100
commit38bac4266a4f7adcfdd9832934aa57c564da1179 (patch)
treeaad8c985e4340fd35076669d20bc23324e2e7a16 /doc
parentcf52ab19dc9632e59b38744ebd0614b4d8ac151b (diff)
downloadandroid-node-v8-38bac4266a4f7adcfdd9832934aa57c564da1179.tar.gz
android-node-v8-38bac4266a4f7adcfdd9832934aa57c564da1179.tar.bz2
android-node-v8-38bac4266a4f7adcfdd9832934aa57c564da1179.zip
crypto: allow passing null as IV unless required
PR-URL: https://github.com/nodejs/node/pull/18644 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/crypto.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index 3eb4519d9f..9adc9082fc 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -1286,6 +1286,11 @@ Adversaries][] for details.
### crypto.createCipheriv(algorithm, key, iv[, options])
<!-- YAML
added: v0.1.94
+changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/18644
+ description: The `iv` parameter may now be `null` for ciphers which do not
+ need an initialization vector.
-->
- `algorithm` {string}
- `key` {string | Buffer | TypedArray | DataView}
@@ -1301,7 +1306,8 @@ available cipher algorithms.
The `key` is the raw key used by the `algorithm` and `iv` is an
[initialization vector][]. Both arguments must be `'utf8'` encoded strings,
-[Buffers][`Buffer`], `TypedArray`, or `DataView`s.
+[Buffers][`Buffer`], `TypedArray`, or `DataView`s. If the cipher does not need
+an initialization vector, `iv` may be `null`.
### crypto.createCredentials(details)
<!-- YAML
@@ -1347,6 +1353,11 @@ to create the `Decipher` object.
### crypto.createDecipheriv(algorithm, key, iv[, options])
<!-- YAML
added: v0.1.94
+changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/18644
+ description: The `iv` parameter may now be `null` for ciphers which do not
+ need an initialization vector.
-->
- `algorithm` {string}
- `key` {string | Buffer | TypedArray | DataView}
@@ -1363,7 +1374,8 @@ available cipher algorithms.
The `key` is the raw key used by the `algorithm` and `iv` is an
[initialization vector][]. Both arguments must be `'utf8'` encoded strings,
-[Buffers][`Buffer`], `TypedArray`, or `DataView`s.
+[Buffers][`Buffer`], `TypedArray`, or `DataView`s. If the cipher does not need
+an initialization vector, `iv` may be `null`.
### crypto.createDiffieHellman(prime[, primeEncoding][, generator][, generatorEncoding])
<!-- YAML