crypto: add cipher update/final methods encoding validation by vitpavlenko · Pull Request #45990 · nodejs/node

vitpavlenko · 2022-12-27T21:21:20Z

Adds encoding validation to update and final cipher methods.

nodejs-github-bot · 2022-12-27T21:21:24Z

Review requested:

@nodejs/crypto

Changes addressed

vitpavlenko · 2022-12-28T16:35:35Z

Sorry, some-how missed js lint error in test. Fixed it, also updated first commit message. Please approve run @VoltrexKeyva

vitpavlenko · 2023-01-01T12:57:37Z

@VoltrexKeyva any chance to approve?)

nodejs-github-bot · 2023-01-01T18:07:15Z

CI: https://ci.nodejs.org/job/node-test-pull-request/48796/

nodejs-github-bot · 2023-01-01T19:55:12Z

CI: https://ci.nodejs.org/job/node-test-pull-request/48797/

nodejs-github-bot · 2023-01-02T09:21:49Z

CI: https://ci.nodejs.org/job/node-test-pull-request/48802/

panva

~~We can do perfectly fine without a new error. Here's a combined diff of my suggested changes.~~

nodejs-github-bot · 2023-01-13T13:03:23Z

CI: https://ci.nodejs.org/job/node-test-pull-request/48968/

vitpavlenko · 2023-01-16T16:38:00Z

+    if (normalizedEncoding === undefined) {
+      throw new ERR_UNKNOWN_ENCODING(encoding);
+    }
+    assert(false, 'Cannot change encoding');


why throw error by assert? it will be some internal error, no?

We can replace the assert with a coded error in a follow up semver-major PRs that contain breaking changes and should be released in the next major version. PR.

I think it is better to have a coded error, can I make the change? @panva

Sure, best wait until this change lands.

nodejs-github-bot · 2023-01-17T17:39:15Z

Landed in 5a7d4a7

Refs #45189 PR-URL: #45990 Refs: #45189 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Filip Skokan <panva.ip@gmail.com>

Cipher.update(string, badEncoding, ...) and Decipher.update with the same shape silently produced incorrect output: the binding skipped the unrecognized encoding and fell back to a default, giving the user wrong ciphertext or plaintext with no signal. Sub-cases 1 and 2 from issue #45189 (bad output encoding to update/final) were addressed in PR #45990. This commit completes the fix for sub-case 3 (bad input encoding) per panva's comment deferring it to a follow-up PR for CITGM testing. When `data` is a string and `inputEncoding` is non-null but does not normalize to a known encoding, throw ERR_UNKNOWN_ENCODING. Buffer / TypedArray / DataView data paths are unaffected (the binding ignores `inputEncoding` for non-string data anyway). Fixes: #45189 Refs: #45990 Signed-off-by: Maruthan G <maruthang4@gmail.com> PR-URL: #66247 Reviewed-By: Xuguang Mei <meixuguang@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Move unknown encoding validation into validateEncoding so Hash, Hmac, Sign, and Verify reject invalid string input encodings alongside Cipher and Decipher. Preserve ignored encodings for buffer inputs. Signed-off-by: Filip Skokan <panva.ip@gmail.com> Assisted-by: Codex PR-URL: #66247 Fixes: #45189 Refs: #45990 Reviewed-By: Xuguang Mei <meixuguang@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Reject unknown Hash and Hmac digest encodings before finalizing the operation instead of silently returning a Buffer. Preserve buffer output aliases and existing encoding coercion. Signed-off-by: Filip Skokan <panva.ip@gmail.com> Assisted-by: Codex PR-URL: #66247 Fixes: #45189 Refs: #45990 Reviewed-By: Xuguang Mei <meixuguang@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Pass an encoding rather than a string length to FileHandle.write. Cover invalid encodings in fs.write, fs.writeSync, and FileHandle.write, along with valid encodings and unchanged files after rejected writes. Rejecting previously accepted invalid encodings is an intentional semver-major bug fix shared with the crypto validation changes. Signed-off-by: Filip Skokan <panva.ip@gmail.com> Assisted-by: Codex PR-URL: #66247 Fixes: #45189 Refs: #45990 Reviewed-By: Xuguang Mei <meixuguang@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

nodejs-github-bot added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to Node.js documentation. errors Issues and PRs related to JavaScript errors originating in Node.js core. needs-ci PRs that need a full CI run. labels Dec 27, 2022

VoltrexKeyva previously requested changes Dec 28, 2022

View reviewed changes

Comment thread README.md Outdated

VoltrexKeyva reviewed Dec 28, 2022

View reviewed changes

Comment thread lib/internal/crypto/cipher.js Outdated

Comment thread lib/internal/validators.js Outdated

vitpavlenko force-pushed the bugfix/45189-encoding-validation branch from eba9755 to 9bbecff Compare December 28, 2022 12:16

vitpavlenko force-pushed the bugfix/45189-encoding-validation branch from 9bbecff to 449cc81 Compare December 28, 2022 16:34

panva added the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Jan 1, 2023

panva reviewed Jan 1, 2023

View reviewed changes

Comment thread test/parallel/test-crypto-encoding-validation-error.js Outdated

Comment thread test/parallel/test-crypto-encoding-validation-error.js Outdated

Comment thread test/parallel/test-crypto-encoding-validation-error.js Outdated

panva removed the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Jan 1, 2023

panva requested a review from targos January 1, 2023 16:43

panva changed the title ~~cipher: add cipher update/final methods encoding validation~~ crypto: add cipher update/final methods encoding validation Jan 1, 2023

panva added the commit-queue-squash PRs the Commit Queue should land as one squashed commit. label Jan 1, 2023

vitpavlenko force-pushed the bugfix/45189-encoding-validation branch from 449cc81 to 1853424 Compare January 1, 2023 17:20

panva added the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Jan 1, 2023

github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Jan 1, 2023

github-actions Bot mentioned this pull request Jan 2, 2023

CI Reliability 2023-01-02 nodejs/reliability#476

Open

22 tasks

This was referenced Jan 3, 2023

CI Reliability 2023-01-03 nodejs/reliability#477

Open

CI Reliability 2023-01-04 nodejs/reliability#478

Open

CI Reliability 2023-01-05 nodejs/reliability#479

Open

panva added the review wanted PRs that need review. label Jan 5, 2023

panva previously requested changes Jan 6, 2023

View reviewed changes

panva added author ready PRs with CI started, the required approvals, and no outstanding review comments. request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. and removed doc Issues and PRs related to Node.js documentation. labels Jan 13, 2023

github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Jan 13, 2023

This comment was marked as outdated.

Sign in to view

This was referenced Jan 14, 2023

CI Reliability 2023-01-14 nodejs/reliability#483

Open

CI Reliability 2023-01-15 nodejs/reliability#484

Open

CI Reliability 2023-01-16 nodejs/reliability#485

Open

vitpavlenko commented Jan 16, 2023

View reviewed changes

github-actions Bot mentioned this pull request Jan 17, 2023

CI Reliability 2023-01-17 nodejs/reliability#486

Open

17 tasks

panva approved these changes Jan 17, 2023

View reviewed changes

panva added the commit-queue PRs queued for automated landing through the Commit Queue. label Jan 17, 2023

nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Jan 17, 2023

nodejs-github-bot merged commit 5a7d4a7 into nodejs:main Jan 17, 2023

This was referenced Jan 18, 2023

CI Reliability 2023-01-18 nodejs/reliability#487

Open

CI Reliability 2023-01-19 nodejs/reliability#488

Open

RafaelGSS pushed a commit that referenced this pull request Jan 20, 2023

crypto: add cipher update/final methods encoding validation

78be87b

Refs #45189 PR-URL: #45990 Refs: #45189 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Filip Skokan <panva.ip@gmail.com>

RafaelGSS mentioned this pull request Jan 20, 2023

v19.5.0 proposal #46286

Merged

juanarbol pushed a commit that referenced this pull request Jan 26, 2023

crypto: add cipher update/final methods encoding validation

5f6aab3

Refs #45189 PR-URL: #45990 Refs: #45189 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Filip Skokan <panva.ip@gmail.com>

juanarbol mentioned this pull request Jan 28, 2023

V18.14.0 proposal #46396

Merged

juanarbol pushed a commit that referenced this pull request Jan 31, 2023

crypto: add cipher update/final methods encoding validation

a558774

Refs #45189 PR-URL: #45990 Refs: #45189 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Filip Skokan <panva.ip@gmail.com>

maruthang mentioned this pull request Apr 25, 2026

crypto: validate inputEncoding in Cipher/Decipher update #62954

Closed

panva mentioned this pull request Sep 24, 2026

crypto,fs: reject invalid encodings #66247

Closed

Uh oh!

Conversation

vitpavlenko commented Dec 27, 2022 • edited by panva Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nodejs-github-bot commented Dec 27, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vitpavlenko commented Dec 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vitpavlenko commented Jan 1, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nodejs-github-bot commented Jan 1, 2023

Uh oh!

nodejs-github-bot commented Jan 1, 2023

Uh oh!

nodejs-github-bot commented Jan 2, 2023

Uh oh!

panva left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

nodejs-github-bot commented Jan 13, 2023

Uh oh!

vitpavlenko Jan 16, 2023

Choose a reason for hiding this comment

Uh oh!

panva Jan 17, 2023

Choose a reason for hiding this comment

Uh oh!

vitpavlenko Jan 17, 2023

Choose a reason for hiding this comment

Uh oh!

panva Jan 17, 2023

Choose a reason for hiding this comment

Uh oh!

nodejs-github-bot commented Jan 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

vitpavlenko commented Dec 27, 2022 •

edited by panva

Loading

vitpavlenko commented Dec 28, 2022 •

edited

Loading

panva left a comment •

edited

Loading