tls: convertProtocols() error handling by pugbyte · Pull Request #23606 · nodejs/node

pugbyte · 2018-10-12T18:46:54Z

The convertProtocols() function now throws a range error when the byte
length of a protocol is too long to fit in a Buffer.

Also added a test case in test/parallel/test-tls-basic-validations.js
to cover this.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

The convertProtocols() function now throws a range error when the byte length of a protocol is too long to fit in a Buffer. Also added a test case in test/parallel/test-tls-basic-validations.js to cover this.

lib/tls.js

Changed the byte length error message for protocol to correctly state that the length must be <= 255 not < 255 Amended the test case in test/parallel/test-tls-basic-validations.js

addaleax

Thanks!

addaleax · 2018-10-12T20:19:32Z

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

We may or may not consider this semver-major; on the one hand, this adds a new error, on the other hand, output before this patch would have been completely broken and would have failed at another point.

jasnell · 2018-10-12T20:32:26Z

hmm... I think we need to mark as semver-major but let's see if there's @nodejs/tsc consensus on downgrading it.

mcollina

LGTM

Trott · 2018-10-12T23:34:27Z

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

test/parallel/test-tls-basic-validations.js

BridgeAR · 2018-10-12T23:50:12Z

I don't think that this has to be semver major since it was broken before otherwise.

Also changed corresponding usage in lib/tls.js Amended the test case in test/parallel/test-tls-basic-validations.js

lib/tls.js

Trott · 2018-10-13T13:34:40Z

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

addaleax · 2018-10-16T11:55:33Z

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

Trott · 2018-10-16T21:40:24Z

I think this should land as patch rather than major. I think the reason is as stated by @BridgeAR above, but I'm willing to supply more detail to the argument if there's disagreement about this.

BridgeAR · 2018-10-17T08:27:26Z

lib/tls.js

    var len = Buffer.byteLength(c);
+    if (len > 255) {
+      throw new ERR_OUT_OF_RANGE('', '<= 255', len, 'The byte length of the ' +
+        `protocol at index ${i} exceeds the maximum length.`);


When looking at this signature it looks like a mistake that the first argument is an empty string.

I suggest to use the following instead:

ERR_OUT_OF_RANGE(str, range, input, replaceDefaultBoolean)

Using booleans as arguments is not great either but that way the first argument is at least used properly and the reader will hopefully be less surprised (as I would be). We might also use a different more expressive value than a boolean but that could be more error prone.

I've refactored as per your suggestion. Check it out.

BridgeAR · 2018-10-17T08:30:18Z

I removed the semver-major label due to the comments above. // cc @nodejs/tsc

addaleax · 2018-10-21T04:09:25Z

Fresh CI to include the latest changes: https://ci.nodejs.org/job/node-test-pull-request/18020/

Trott · 2018-10-24T04:06:13Z

Landed in cdba3c1.

Thanks for the contribution! 🎉

(If you're interested in other possible contributions to Node.js but don't have a good idea of where to start looking, some ideas are posted at https://www.nodetodo.org/next-steps/.)

The convertProtocols() function now throws a range error when the byte length of a protocol is too long to fit in a Buffer. Also added a test case in test/parallel/test-tls-basic-validations.js to cover this. PR-URL: #23606 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

pugbyte · 2018-10-25T14:05:46Z

Thank you for the opportunity. This has been really eye-opening and I'll be much less shy about contributing to open-source projects in the future.

MylesBorins · 2018-11-26T20:30:42Z

it seems like there was some debate regarding if this was Semver-Major or not. As such i'm unsure if it should be backported to LTS

thoughts?

The convertProtocols() function now throws a range error when the byte length of a protocol is too long to fit in a Buffer. Also added a test case in test/parallel/test-tls-basic-validations.js to cover this. PR-URL: #23606 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

* doc: * add oyyd to collaborators (Ouyang Yadong) [#24300](#24300) * tls: * throw if protocol too long (Andre Jodat-Danbrani) [#23606](#23606)

* doc: * add oyyd to collaborators (Ouyang Yadong) [#24300](#24300) * tls: * throw if protocol too long (Andre Jodat-Danbrani) [#23606](#23606) PR-URL: #25346

tls: convertProtocols() error handling

c72e9c3

The convertProtocols() function now throws a range error when the byte length of a protocol is too long to fit in a Buffer. Also added a test case in test/parallel/test-tls-basic-validations.js to cover this.

nodejs-github-bot added the tls Issues and PRs related to the tls subsystem. label Oct 12, 2018

addaleax reviewed Oct 12, 2018

View reviewed changes

lib/tls.js Outdated Show resolved Hide resolved

addaleax approved these changes Oct 12, 2018

View reviewed changes

tls: convertProtocols() amended an error message

85d2428

Changed the byte length error message for protocol to correctly state that the length must be <= 255 not < 255 Amended the test case in test/parallel/test-tls-basic-validations.js

addaleax approved these changes Oct 12, 2018

View reviewed changes

addaleax added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 12, 2018

jasnell approved these changes Oct 12, 2018

View reviewed changes

jasnell added the semver-major PRs that contain breaking changes and should be released in the next major version. label Oct 12, 2018

mcollina approved these changes Oct 12, 2018

View reviewed changes

Trott added the code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. label Oct 12, 2018

BridgeAR reviewed Oct 12, 2018

View reviewed changes

test/parallel/test-tls-basic-validations.js Outdated Show resolved Hide resolved

BridgeAR removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 12, 2018

lib: added override for msg in ERR_OUT_OF_RANGE

5c4e7d8

Also changed corresponding usage in lib/tls.js Amended the test case in test/parallel/test-tls-basic-validations.js

thefourtheye approved these changes Oct 13, 2018

View reviewed changes

lib/tls.js Outdated Show resolved Hide resolved

tls: minor change to error message in convertProtocols()

951692e

addaleax added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 16, 2018

BridgeAR reviewed Oct 17, 2018

View reviewed changes

BridgeAR removed the semver-major PRs that contain breaking changes and should be released in the next major version. label Oct 17, 2018

lib: refactored the signature of ERROR_OUT_OF_RANGE

ca17a24

targos mentioned this pull request Oct 27, 2018

Release proposal: v11.1.0 #23922

Merged

MylesBorins added lts-watch-v8.x labels Nov 26, 2018

codebytere removed the lts-watch-v8.x label Dec 13, 2018

codebytere added backported-to-v10.x and removed lts-watch-v10.x labels Dec 13, 2018

codebytere mentioned this pull request Jan 4, 2019

v10.15.1 proposal #25346

Merged

codebytere added a commit that referenced this pull request Jan 29, 2019

2019-01-29, Version 10.15.1 'Dubnium' (LTS)

3867ef0

* doc: * add oyyd to collaborators (Ouyang Yadong) [#24300](#24300) * tls: * throw if protocol too long (Andre Jodat-Danbrani) [#23606](#23606)

codebytere added a commit that referenced this pull request Jan 29, 2019

2019-01-29, Version 10.15.1 'Dubnium' (LTS)

d56212e

* doc: * add oyyd to collaborators (Ouyang Yadong) [#24300](#24300) * tls: * throw if protocol too long (Andre Jodat-Danbrani) [#23606](#23606) PR-URL: #25346

Uh oh!

Conversation

pugbyte commented Oct 12, 2018

Checklist

Uh oh!

Uh oh!

addaleax left a comment

Choose a reason for hiding this comment

Uh oh!

addaleax commented Oct 12, 2018

Uh oh!

jasnell commented Oct 12, 2018

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

Trott commented Oct 12, 2018

Uh oh!

Uh oh!

BridgeAR commented Oct 12, 2018

Uh oh!

Uh oh!

Trott commented Oct 13, 2018

Uh oh!

addaleax commented Oct 16, 2018

Uh oh!

Trott commented Oct 16, 2018

Uh oh!

BridgeAR Oct 17, 2018

Choose a reason for hiding this comment

Uh oh!

pugbyte Oct 17, 2018

Choose a reason for hiding this comment

Uh oh!

BridgeAR commented Oct 17, 2018

Uh oh!

addaleax commented Oct 21, 2018

Uh oh!

Trott commented Oct 24, 2018

Uh oh!

pugbyte commented Oct 25, 2018

Uh oh!

MylesBorins commented Nov 26, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants