Commit ff82606
authored
crypto: move DEP0182 to runtime deprecation
This introduces a runtime deprecation for using GCM authentication tags
that are shorter than the cipher's block size, unless the user
specified the authTagLength option. This behavior has been doc-only
deprecated since 8f61b65.
Refs: #52327
Refs: #52345
PR-URL: #52552
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>1 parent 6f738b3 commit ff82606
4 files changed
Lines changed: 9 additions & 9 deletions
File tree
- doc/api
- src/crypto
- test/parallel
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3078,10 +3078,9 @@ and initialization vector (`iv`). | |||
| 3078 | 3078 | The `options` argument controls stream behavior and is optional except when a | |
| 3079 | 3079 | cipher in CCM or OCB mode (e.g. `'aes-128-ccm'`) is used. In that case, the | |
| 3080 | 3080 | `authTagLength` option is required and specifies the length of the | |
| 3081 | - authentication tag in bytes, see [CCM mode][]. In GCM mode, the `authTagLength` | ||
| 3082 | - option is not required but can be used to restrict accepted authentication tags | ||
| 3083 | - to those with the specified length. | ||
| 3084 | - For `chacha20-poly1305`, the `authTagLength` option defaults to 16 bytes. | ||
| 3081 | + authentication tag in bytes, see [CCM mode][]. | ||
| 3082 | + For AES-GCM and `chacha20-poly1305`, the `authTagLength` option defaults to 16 | ||
| 3083 | + bytes and must be set to a different value if a different length is used. | ||
| 3085 | 3084 | ||
| 3086 | 3085 | The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On | |
| 3087 | 3086 | recent OpenSSL releases, `openssl list -cipher-algorithms` will | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3623,15 +3623,18 @@ Please use the [`crypto.createHmac()`][] method to create Hmac instances. | |||
| 3623 | 3623 | ||
| 3624 | 3624 | <!-- YAML | |
| 3625 | 3625 | changes: | |
| 3626 | + - version: REPLACEME | ||
| 3627 | + pr-url: https://github.com/nodejs/node/pull/52552 | ||
| 3628 | + description: Runtime deprecation. | ||
| 3626 | 3629 | - version: REPLACEME | |
| 3627 | 3630 | pr-url: https://github.com/nodejs/node/pull/52345 | |
| 3628 | 3631 | description: Documentation-only deprecation. | |
| 3629 | 3632 | --> | |
| 3630 | 3633 | ||
| 3631 | - Type: Documentation-only (supports [`--pending-deprecation`][]) | ||
| 3634 | + Type: Runtime | ||
| 3632 | 3635 | ||
| 3633 | 3636 | Applications that intend to use authentication tags that are shorter than the | |
| 3634 | - default authentication tag length should set the `authTagLength` option of the | ||
| 3637 | + default authentication tag length must set the `authTagLength` option of the | ||
| 3635 | 3638 | [`crypto.createDecipheriv()`][] function to the appropriate length. | |
| 3636 | 3639 | ||
| 3637 | 3640 | For ciphers in GCM mode, the [`decipher.setAuthTag()`][] function accepts | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -698,8 +698,7 @@ void CipherBase::SetAuthTag(const FunctionCallbackInfo<Value>& args) { | |||
| 698 | 698 | } | |
| 699 | 699 | ||
| 700 | 700 | if (mode == EVP_CIPH_GCM_MODE && cipher->auth_tag_len_ == kNoAuthTagLength && | |
| 701 | - tag_len != 16 && env->options()->pending_deprecation && | ||
| 702 | - env->EmitProcessEnvWarning()) { | ||
| 701 | + tag_len != 16 && env->EmitProcessEnvWarning()) { | ||
| 703 | 702 | if (ProcessEmitDeprecationWarning( | |
| 704 | 703 | env, | |
| 705 | 704 | "Using AES-GCM authentication tags of less than 128 bits without " | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,4 +1,3 @@ | |||
| 1 | - // Flags: --pending-deprecation | ||
| 2 | 1 | 'use strict'; | |
| 3 | 2 | const common = require('../common'); | |
| 4 | 3 | if (!common.hasCrypto) | |
0 commit comments