summaryrefslogtreecommitdiff
path: root/doc/api/deprecations.md
diff options
context:
space:
mode:
authorTobias Nießen <tniessen@tnie.de>2018-08-04 18:13:05 +0200
committerTobias Nießen <tniessen@tnie.de>2018-08-10 12:41:02 +0200
commit39dd3a443064a6bce0e919aee04903398f16c39a (patch)
tree76edd973c5c983fb3497df687dd176a6fdd475ec /doc/api/deprecations.md
parent34f56e2d711aaff10838167aa4ece77d278cfa09 (diff)
downloadandroid-node-v8-39dd3a443064a6bce0e919aee04903398f16c39a.tar.gz
android-node-v8-39dd3a443064a6bce0e919aee04903398f16c39a.tar.bz2
android-node-v8-39dd3a443064a6bce0e919aee04903398f16c39a.zip
crypto: deprecate useless crypto APIs
The APIs were probably exposed by accident. getAuthTag and setAuthTag are not a usual getter/setter pair: Getting the authentication tag only makes sense in the context of encryption, setting it only makes sense in the context of decryption. Currently, both functions throw. Neither has been documented publicly. PR-URL: https://github.com/nodejs/node/pull/22126 Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/deprecations.md')
-rw-r--r--doc/api/deprecations.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
index 6262fe4cf5..56935574e6 100644
--- a/doc/api/deprecations.md
+++ b/doc/api/deprecations.md
@@ -1021,6 +1021,16 @@ accessed outside of Node.js core: `Socket.prototype._handle`,
`Socket.prototype._healthCheck()`, `Socket.prototype._stopReceiving()`, and
`dgram._createSocketHandle()`.
+<a id="DEP0113"></a>
+### DEP0113: Cipher.setAuthTag(), Decipher.getAuthTag()
+
+Type: Runtime
+
+With the current crypto API, having `Cipher.setAuthTag()` and
+`Decipher.getAuthTag()` is not helpful and both functions will throw an error
+when called. They have never been documented and will be removed in a future
+release.
+
[`--pending-deprecation`]: cli.html#cli_pending_deprecation
[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size
[`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array