Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

crypto: remove legacy native handles #27011

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2237,18 +2237,21 @@ use the [WHATWG URL API][] instead.
### DEP0117: Native crypto handles
<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/27011
description: End-of-Life.
- version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22747
description: Runtime deprecation.
-->

Type: Runtime
Type: End-of-Life

Previous versions of Node.js exposed handles to internal native objects through
the `_handle` property of the `Cipher`, `Decipher`, `DiffieHellman`,
`DiffieHellmanGroup`, `ECDH`, `Hash`, `Hmac`, `Sign`, and `Verify` classes.
Using the `_handle` property to access the native object is deprecated because
improper use of the native object can lead to crashing the application.
The `_handle` property has been removed because improper use of the native
object can lead to crashing the application.

<a id="DEP0118"></a>
### DEP0118: dns.lookup() support for a falsy hostname
Expand Down
6 changes: 0 additions & 6 deletions lib/internal/crypto/cipher.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ const {
const {
getDefaultEncoding,
kHandle,
legacyNativeHandle,
toBuf
} = require('internal/crypto/util');

Expand Down Expand Up @@ -219,8 +218,6 @@ Cipher.prototype.setAAD = function setAAD(aadbuf, options) {
return this;
};

legacyNativeHandle(Cipher);

function Cipheriv(cipher, key, iv, options) {
if (!(this instanceof Cipheriv))
return new Cipheriv(cipher, key, iv, options);
Expand All @@ -245,7 +242,6 @@ function addCipherPrototypeFunctions(constructor) {
Object.setPrototypeOf(Cipheriv.prototype, LazyTransform.prototype);
Object.setPrototypeOf(Cipheriv, LazyTransform);
addCipherPrototypeFunctions(Cipheriv);
legacyNativeHandle(Cipheriv);

function Decipher(cipher, password, options) {
if (!(this instanceof Decipher))
Expand All @@ -257,7 +253,6 @@ function Decipher(cipher, password, options) {
Object.setPrototypeOf(Decipher.prototype, LazyTransform.prototype);
Object.setPrototypeOf(Decipher, LazyTransform);
addCipherPrototypeFunctions(Decipher);
legacyNativeHandle(Decipher);


function Decipheriv(cipher, key, iv, options) {
Expand All @@ -270,7 +265,6 @@ function Decipheriv(cipher, key, iv, options) {
Object.setPrototypeOf(Decipheriv.prototype, LazyTransform.prototype);
Object.setPrototypeOf(Decipheriv, LazyTransform);
addCipherPrototypeFunctions(Decipheriv);
legacyNativeHandle(Decipheriv);

module.exports = {
Cipher,
Expand Down
6 changes: 0 additions & 6 deletions lib/internal/crypto/diffiehellman.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ const { isArrayBufferView } = require('internal/util/types');
const {
getDefaultEncoding,
kHandle,
legacyNativeHandle,
toBuf
} = require('internal/crypto/util');
const {
Expand Down Expand Up @@ -165,9 +164,6 @@ DiffieHellman.prototype.setPrivateKey = function setPrivateKey(key, encoding) {
return this;
};

legacyNativeHandle(DiffieHellman);
legacyNativeHandle(DiffieHellmanGroup);


function ECDH(curve) {
if (!(this instanceof ECDH))
Expand Down Expand Up @@ -195,8 +191,6 @@ ECDH.prototype.getPublicKey = function getPublicKey(encoding, format) {
return encode(key, encoding);
};

legacyNativeHandle(ECDH);

ECDH.convertKey = function convertKey(key, curve, inEnc, outEnc, format) {
if (typeof key !== 'string' && !isArrayBufferView(key)) {
throw new ERR_INVALID_ARG_TYPE(
Expand Down
5 changes: 0 additions & 5 deletions lib/internal/crypto/hash.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ const {
const {
getDefaultEncoding,
kHandle,
legacyNativeHandle,
toBuf
} = require('internal/crypto/util');

Expand Down Expand Up @@ -89,8 +88,6 @@ Hash.prototype.digest = function digest(outputEncoding) {
return ret;
};

legacyNativeHandle(Hash);


function Hmac(hmac, key, options) {
if (!(this instanceof Hmac))
Expand Down Expand Up @@ -130,8 +127,6 @@ Hmac.prototype.digest = function digest(outputEncoding) {
Hmac.prototype._flush = Hash.prototype._flush;
Hmac.prototype._transform = Hash.prototype._transform;

legacyNativeHandle(Hmac);

module.exports = {
Hash,
Hmac
Expand Down
5 changes: 0 additions & 5 deletions lib/internal/crypto/sig.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ const {
const {
getDefaultEncoding,
kHandle,
legacyNativeHandle,
toBuf,
validateArrayBufferView,
} = require('internal/crypto/util');
Expand Down Expand Up @@ -56,8 +55,6 @@ Sign.prototype.update = function update(data, encoding) {
return this;
};

legacyNativeHandle(Sign);

function getPadding(options) {
return getIntOption('padding', RSA_PKCS1_PADDING, options);
}
Expand Down Expand Up @@ -166,8 +163,6 @@ Verify.prototype.verify = function verify(options, signature, sigEncoding) {
rsaPadding, pssSaltLength);
};

legacyNativeHandle(Verify);

function verifyOneShot(algorithm, data, key, signature) {
if (algorithm != null)
validateString(algorithm, 'algorithm');
Expand Down
14 changes: 0 additions & 14 deletions lib/internal/crypto/util.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ const { validateString } = require('internal/validators');
const { Buffer } = require('buffer');
const {
cachedResult,
deprecate,
filterDuplicateStrings
} = require('internal/util');
const {
Expand All @@ -30,18 +29,6 @@ const {

const kHandle = Symbol('kHandle');

function legacyNativeHandle(clazz) {
Object.defineProperty(clazz.prototype, '_handle', {
get: deprecate(function() { return this[kHandle]; },
`${clazz.name}._handle is deprecated. Use the public API ` +
'instead.', 'DEP0117'),
set: deprecate(function(h) { this[kHandle] = h; },
`${clazz.name}._handle is deprecated. Use the public API ` +
'instead.', 'DEP0117'),
enumerable: false
});
}

var defaultEncoding = 'buffer';

function setDefaultEncoding(val) {
Expand Down Expand Up @@ -116,7 +103,6 @@ module.exports = {
getDefaultEncoding,
getHashes,
kHandle,
legacyNativeHandle,
setDefaultEncoding,
setEngine,
timingSafeEqual,
Expand Down