Skip to content

node:tls: ignore onread when the TLS socket wraps an existing socket - #42425

Closed
robobun wants to merge 6 commits into
mainfrom
robobun/df0d3475/tls-wrapped-socket-ignores-onread
Closed

robobun wants to merge 6 commits into
mainfrom
robobun/df0d3475/tls-wrapped-socket-ignores-onread

Conversation

@robobun

@robobun robobun commented Sep 12, 2026 •

Copy link
Copy Markdown
Collaborator

Problem

  • tls.connect({ socket, onread }) hands the decrypted bytes to onread.callback. Node ignores onread when the TLS socket wraps an existing socket and emits 'data'. Node logs [ 'data 5' ], bun logs [ "onread 5" ] for the script in node:tls: tls.connect({ socket, onread }) uses onread, node ignores it for a wrapped socket #42419.
  • The cause is the TLSSocket constructor (src/js/node/tls.ts:757). It forwards the caller's options object to net.Socket, so onread reaches net.Socket for a wrapped socket too. Node passes onread: !socket ? tlsOptions.onread : null (wrap.js#L596).

Fix

  • Set onread: null in the two branches that already rebuild the options for a wrapped socket (new TLSSocket(socket, ...) and options.socket). The dialed path (tls.connect({ host, port, onread })) is unchanged.
  • Correct because both branches match the one condition Node uses (a wrapped socket), and net.Socket treats onread: null as absent.
  • Verified: test/js/node/tls/node-tls-upgrade.test.ts (one new test fails on stock bun with ["onread 5"], one covers the server-side new TLSSocket(socket, { isServer: true, onread }) form). Also ran node-tls-connect.test.ts, node-tls-server.test.ts, node-tls-context.test.ts.

Background

  • tls.connect({ socket }) wraps an already-connected net.Socket. The TLS socket reads the ciphertext from that socket and exposes the plaintext itself.
  • onread is a net.Socket option. It replaces 'data' events with a callback that fills a caller-owned buffer. Bun implements it in the net.Socket constructor (src/js/node/net.ts, the kOnreadDeliver handler).
Notes
  • Fail-before: USE_SYSTEM_BUN=1 bun test test/js/node/tls/node-tls-upgrade.test.ts -t 42419 fails with ["onread 5"] on bun 1.4.3.
  • The server-side test passes on stock bun too. The server upgrade path installs its own handlers. It is there to cover the first-argument branch of the change.
  • Four tests in node-tls-connect.test.ts and node-tls-server.test.ts time out in this container both with and without the change (SNICallback runs even when..., destroySoon follows end, a client paused while connecting x2).
  • Node also drops every other option from the net.Socket call and passes a fixed set. This change does not go that far. It fixes the one option the issue reports.

[human-review] gate passed · iteration 1 · 2 files touched

fails on main (without fix)
ASAN without fix: 1 FAILED
$ BUN_DEBUG_QUIET_LOGS=1 bun scripts/build.ts --profile=debug --quiet test "--reporter=junit" "--reporter-outfile=/tmp/pr_gate.xml" test/js/node/tls/node-tls-upgrade.test.ts
bun test v1.4.3 (6a92015fc)

test/js/node/tls/node-tls-upgrade.test.ts:
(pass) should be able to upgrade a paused socket and also have backpressure on it #15438 [1511.93ms]
(pass) tls.connect({ socket }) over a net.Socket with readable: false keeps the TLS bytes off the wrapped socket [282.09ms]
(pass) tls.connect({ socket }) over a net.Socket with an onread buffer keeps the TLS bytes off the wrapped socket [110.95ms]
(pass) tls.connect({ socket }) over a net.Socket with no reader keeps the TLS bytes off the wrapped socket [105.57ms]
129 |       onread: { buffer: Buffer.alloc(16), callback: (n: number) => log.push(`onread ${n}`) },
130 |     });
131 |     tlsSocket.on("data", data => log.push(`data ${data.length}`));
132 |     tlsSocket.on("error", () => {});
133 |     await once(tlsSocket, "close");
134 |     expect(log).toEqual(["data 5"]);
                      ^
error: expect(received).toEqual(expected)

  [
-   "data 5",
+   "onread 5",
  ]

- Expected  - 1
+ Received  + 1

      at <anonym
... (truncated)

release without fix: all passed
bun test v1.4.3-canary.1 (1e0a6f351)

test/js/node/tls/node-tls-upgrade.test.ts:
(pass) should be able to upgrade a paused socket and also have backpressure on it #15438 [39.34ms]
(pass) tls.connect({ socket }) over a net.Socket with readable: false keeps the TLS bytes off the wrapped socket [8.04ms]
(pass) tls.connect({ socket }) over a net.Socket with an onread buffer keeps the TLS bytes off the wrapped socket [4.22ms]
(pass) tls.connect({ socket }) over a net.Socket with no reader keeps the TLS bytes off the wrapped socket [4.02ms]
(pass) tls.connect({ socket, onread }) ignores onread and emits 'data' (#42419) [4.02ms]
(pass) new tls.TLSSocket(socket, { isServer: true, onread }) ignores onread and emits 'data' (#42419) [4.47ms]
(pass) a STARTTLS exchange hands no TLS bytes to the 'data' listeners of the wrapped sockets (#32239) [4.51ms]

 7 pass
 0 fail
 14 expect() calls
Ran 7 tests across 1 file. [173.00ms]
__F:0:S:0
passes on PR (with fix)
ASAN with fix: all passed
$ BUN_DEBUG_QUIET_LOGS=1 bun scripts/build.ts --profile=debug --quiet test "--reporter=junit" "--reporter-outfile=/tmp/pr_gate.xml" test/js/node/tls/node-tls-upgrade.test.ts
bun test v1.4.3 (6a92015fc)

test/js/node/tls/node-tls-upgrade.test.ts:
(pass) should be able to upgrade a paused socket and also have backpressure on it #15438 [1314.16ms]
(pass) tls.connect({ socket }) over a net.Socket with readable: false keeps the TLS bytes off the wrapped socket [297.34ms]
(pass) tls.connect({ socket }) over a net.Socket with an onread buffer keeps the TLS bytes off the wrapped socket [117.43ms]
(pass) tls.connect({ socket }) over a net.Socket with no reader keeps the TLS bytes off the wrapped socket [101.39ms]
(pass) tls.connect({ socket, onread }) ignores onread and emits 'data' (#42419) [94.06ms]
(pass) new tls.TLSSocket(socket, { isServer: true, onread }) ignores onread and emits 'data' (#42419) [160.37ms]
(pass) a STARTTLS exchange hands no TLS bytes to the 'data' listeners of the wrapped sockets (#32239) [144.43ms]

 7 pass
 0 fail
 14 expect() calls
Ran 7 tests across 1 file. [5.62s]
__F:0:S:0

release with fix: all passed
$ bun scripts/build.ts --profile=release
[configured] bun-profile → bun (stripped) in 934ms (unchanged)
ninja: Entering directory `/workspace/bun/build/release'
[1/124] gen cpp.rs (cppbind)
[2/124] gen JS modules (bundle-modules)
Preprocess modules (10739ms)
Bundle modules (122ms)
Postprocesss modules (198ms)
Bundle Functions (738ms)
Generate Code (51ms)

[11.86s] Bundled "src/js" for production
  2600 kb
  197 internal modules
  13 native modules
  50 internal functions across 16 files
[2/123] cargo bun_runtime → libbun_runtime.a
�[1m�[92m   Compiling�[0m bun_runtime v0.0.0 (/workspace/bun/src/runtime)
�[1m�[92m    Finished�[0m `release` profile [optimized + debuginfo] target(s) in 8m 10s
[119/123] cxx obj/unified/UnifiedSource-src_jsc_bindings_webcore-0.cpp.o
[120/123] link bun-profile
[122/123] strip bun
[122/123] bun-profile --revision
1.4.3-canary.1+3c0a16802
[build] done
bun test v1.4.3-canary.1 (3c0a16802)

test/js/node/tls/node-tls-upgrade.test.ts:
(pass) should be able to upgrade a paused socket and also have backpressure on it #15438 [77.72ms]
(pass) tls.connect({ socket }) over a net.Socket with readable: false keeps the TLS bytes off the wrapped sock
... (truncated)
diff hotspot
src/js/node/tls.ts                        |  6 +--
 test/js/node/tls/node-tls-upgrade.test.ts | 66 ++++++++++++++++++++++++++++++-
 2 files changed, 68 insertions(+), 4 deletions(-)

gate history · 1 passed · 1 rejected · iteration 1

evidence per changed file
file                                       reads  edits  tests
src/js/node/tls.ts                             2      3     14
test/js/node/tls/node-tls-upgrade.test.ts      5      7     14

root cause · written by the author bot

Bun's TLSSocket forwarded the caller's options object, including onread, to the net.Socket constructor even when wrapping an existing socket, so decrypted bytes were delivered to onread.callback instead of being emitted as 'data' events, whereas Node only honors onread when the TLS socket dials its own connection. The fix sets onread: null in the rebuilt options on both wrap paths (the positional socket argument and options.socket), matching Node's !socket ? tlsOptions.onread : null condition in lib/internal/tls/wrap.js, while leaving the dialed path untouched so `tls.co…

Node passes onread to net.Socket only when the TLS socket dials its own
connection. Over a wrapped socket it passes null, so decrypted bytes
arrive as 'data' events. Bun forwarded the caller's onread in both
cases. Drop it in the two wrapped-socket branches of the TLSSocket
constructor.

Fixes #42419
@coderabbitai

coderabbitai Bot commented Sep 12, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Essentials

Run ID: 2b3f6fad-2524-4289-9020-d00e89ac3d8e

📥 Commits

Reviewing files that changed from the base of the PR and between 90f04ca and f3123d2.

📒 Files selected for processing (1)
  • test/js/node/tls/node-tls-upgrade.test.ts

Included review availability: Your plan provides up to 10 included reviews per hour; 1 remains after this review.


Walkthrough

TLSSocket now clears onread when wrapping a Duplex and preserves allowHalfOpen. Regression tests cover client and server upgrades and verify TLS payloads arrive through 'data' events.

Changes

TLS socket upgrade behavior

Layer / File(s) Summary
Wrapped socket option normalization
src/js/node/tls.ts
TLSSocket clears onread and preserves the wrapped socket’s allowHalfOpen setting.
Client and server regression coverage
test/js/node/tls/node-tls-upgrade.test.ts
Tests verify that supplied onread callbacks are ignored and TLS payloads are emitted through 'data' events for both upgrade paths. The backpressure test uses 20 round trips with the updated timeout expectation.

Suggested reviewers: cirospaciari

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to 3c0a1

The TLS upgrade behavior is covered for both client and server paths, with no remaining merge-blocking concerns.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely describes the primary change: ignoring onread when TLSSocket wraps an existing socket.
Description check ✅ Passed The description is detailed and on topic. It explains the problem, fix, scope, verification steps, regression coverage, and known test limitations. It does not use the exact template headings, but it …

Comment @coderabbitai help to get the list of available commands.

@robobun

robobun commented Sep 12, 2026

Copy link
Copy Markdown
Collaborator Author

The automated review raised no findings. No open review threads. Waiting on the Buildkite build (#114580).

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing blocking. The comments below are optional suggestions. There is no need to push a fix for them before merging.

Comment thread test/js/node/tls/node-tls-upgrade.test.ts Outdated
@robobun

robobun commented Sep 12, 2026

Copy link
Copy Markdown
Collaborator Author

Addressed the review nit in 79c461b: the test now destroys the client in the finally block, so a failed assertion does not leave the connection open.

Comment thread src/js/node/tls.ts Outdated
@robobun

robobun commented Sep 12, 2026 •

Copy link
Copy Markdown
Collaborator Author
Updated 1:33 AM PT - Sep 12th, 2026

✅ @robobun, your commit 3c0a168024d99eaa7ce8f3e5c4e5f065d90a0985 passed in Build #114616! 🎉


🧪   To try this PR locally:

bunx bun-pr 42425

That installs a local version of the PR into your bun-42425 executable, so you can run:

bun-42425 --bun

@robobun

robobun commented Sep 12, 2026

Copy link
Copy Markdown
Collaborator Author

Pushed 1e0a6f3: the comment on the wrapped-socket branch is now one line. No open review threads. Buildkite build #114585 is running.

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — the client-cleanup nit is addressed (client?.destroy() now runs in finally), and the comment was tightened.

What was reviewed:

  • Both TLSSocket constructor branches that rebuild options for a wrapped socket now set onread: null, matching Node's !socket ? tlsOptions.onread : null in wrap.js; the dialed-connection path is untouched so tls.connect({ host, port, onread }) still works.
  • onread is a data-delivery hook, not a TLS/security flag — dropping it on wrap is strictly a compat fix with no auth/verification impact.
  • New tests cover both entry points (options.socket and positional socket with isServer: true), use port: 0 / 127.0.0.1, wire error events to reject, and clean up in finally.
Extended reasoning...

Overview

The PR changes two lines in src/js/node/tls.ts (the TLSSocket constructor) to add onread: null to the options object when wrapping an existing net.Socket/Duplex, in both the positional-argument branch and the options.socket branch. It also updates the adjacent comment's Node source link to cover lines 592-596. Two tests are added to test/js/node/tls/node-tls-upgrade.test.ts exercising each branch and asserting that onread.callback is never invoked and the payload arrives via 'data'.

Security risks

None identified. onread is a net.Socket data-delivery option (buffer + callback in place of 'data' events), not a TLS verification, cipher, or certificate flag. Nulling it on the wrapped-socket path makes the TLS socket fall back to the standard 'data' event flow, which is what Node does. No security guard is weakened or removed; rejectUnauthorized, ca, servername, etc. are untouched.

Level of scrutiny

Low-to-moderate. The change is a two-line option override in a spot that already rebuilds the options object for the same reason (allowHalfOpen), and it is backed by a Node source permalink showing the exact conditional (onread: !socket ? tlsOptions.onread : null). The PR description correctly notes that the direct-dial path (tls.connect({ host, port, onread })) is left alone, and I confirmed neither modified branch is reachable without a wrapped socket. No CODEOWNERS entry covers these files.

Other factors

Since my prior review, commit 79c461b moved client.destroy() into the finally block (guarded with ?.), addressing the resource-leak-on-failure nit I raised. Commit 1e0a6f3 shortened the source comment. The tests follow harness conventions: port: 0, 127.0.0.1, once(...) for listening/connect, Promise.withResolvers with error handlers wired to reject, and cleanup in finally registered before assertions. The first test awaits the socket's 'close' event before asserting, so the connection is already torn down by the time the assertion runs. The bug-hunt exit reason was dry_streak with no findings.

The test takes 3.5 to 5 s under a debug ASAN build with or without the
fix in this branch, so it sometimes hits the 5 s default.
@robobun

robobun commented Sep 12, 2026

Copy link
Copy Markdown
Collaborator Author

Pushed 90f04ca: the existing #15438 backpressure test in this file takes 3.5 to 5 s under the debug ASAN build with or without this change, so it now has a 30 s timeout. No open review threads. Buildkite build #114603 is running.

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing blocking. The comments below are optional suggestions. There is no need to push a fix for them before merging.

Comment thread test/js/node/tls/node-tls-upgrade.test.ts Outdated
20 round trips take about 1.5 s on a debug ASAN build. 100 took up to 5 s.
@robobun

robobun commented Sep 12, 2026

Copy link
Copy Markdown
Collaborator Author

Pushed f3123d2: the #15438 backpressure test now runs 20 round trips instead of 100 and has no explicit timeout. It takes about 1.5 s on a debug ASAN build. No open review threads.

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — both earlier nits are addressed (client cleanup moved into finally, and the backpressure test's workload was reduced to 20 iterations instead of raising the timeout).

What was reviewed:

  • src/js/node/tls.ts: onread: null set on both wrap-socket branches, matching the cited Node wrap.js#L596 condition; the dialed path (no wrapped socket) still passes onread through unchanged.
  • New tests use port: 0, await events (once(..., "close") / a resolved promise) rather than sleeping, wire error to reject, and clean up in finally.
  • The 100→20 iteration reduction still moves ~2.5 MiB through a paused TLS socket, so the backpressure path the test guards is still exercised.
Extended reasoning...

Overview

Two-line runtime change in src/js/node/tls.ts: when TLSSocket wraps an existing net.Socket/Duplex (either as the positional first argument or as options.socket), the rebuilt options object now sets onread: null so a caller-supplied onread handler is dropped and 'data' events fire on the TLS wrapper. This mirrors Node's !socket ? tlsOptions.onread : null at lib/internal/tls/wrap.js#L596, and the comment is updated to cite that range. Two new tests in test/js/node/tls/node-tls-upgrade.test.ts cover both branches (client-side tls.connect({ socket, onread }) and server-side new tls.TLSSocket(socket, { isServer: true, onread })), and an existing backpressure test's loop count is cut from 100 to 20 with an explanatory comment.

Security risks

None. This drops an option in a wrap path rather than adding one; it does not touch certificate validation, rejectUnauthorized, SNI, or the secure-context setup. onread is a net.Socket data-delivery convenience, not a security boundary.

Level of scrutiny

Low-to-medium. The runtime change is two symmetric one-line edits to option objects that were already being rebuilt for the wrap case, with a Node source permalink justifying the behavior. The bug-class rule ("fix every sibling site") is satisfied — both wrap branches are updated. The dialed path (else branch when options.socket is not a Duplex) is untouched, so tls.connect({ host, port, onread }) still honors onread as before.

Other factors

This is my fifth pass on the PR. Earlier feedback (client socket not destroyed on the failure path; a 30 s per-test timeout added to absorb debug-ASAN latency) has been addressed in follow-up commits: client?.destroy() now runs in finally before server.close(), and the timeout arg was removed in favor of shrinking the workload to 20 iterations (still ~2.5 MiB over a paused TLS socket, enough to hit the backpressure path the original test guards). Tests use port: 0, local servers only, once()/Promise.withResolvers to await real events, and toEqual on the exact log array. No outstanding third-party CHANGES_REQUESTED reviews are visible in the timeline.

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code review found no issues

No high-confidence issues detected in this change.

@Jarred-Sumner

Copy link
Copy Markdown
Collaborator

Superseded by #44618, which consolidates the open TLS pull requests. This fix and its tests are in there, either as written, rewritten smaller, or merged with the other PRs that patched the same cause (see the "By area" list in that PR). Closing in favor of it.

Jarred-Sumner added a commit that referenced this pull request Oct 6, 2026
…42425)

Node passes `onread: !socket ? tlsOptions.onread : null` to net.Socket, so a
wrap always emits 'data'. Bun honored onread there and 'data' never fired.
Jarred-Sumner added a commit that referenced this pull request Oct 7, 2026
…42425)

Node passes `onread: !socket ? tlsOptions.onread : null` to net.Socket, so a
wrap always emits 'data'. Bun honored onread there and 'data' never fired.
Jarred-Sumner added a commit that referenced this pull request Oct 8, 2026
…42425)

Node passes `onread: !socket ? tlsOptions.onread : null` to net.Socket, so a
wrap always emits 'data'. Bun honored onread there and 'data' never fired.
Jarred-Sumner added a commit that referenced this pull request Oct 10, 2026
…42425)

Node passes `onread: !socket ? tlsOptions.onread : null` to net.Socket, so a
wrap always emits 'data'. Bun honored onread there and 'data' never fired.
Jarred-Sumner added a commit that referenced this pull request Oct 10, 2026
…ps, WebSocket, SQL) (#44618)

### What does this PR do?

Consolidates the open TLS pull requests into one. Each was reproduced on
`main` and, for `node:*` behavior, on Node v26.3.0 first. About a third
are ported as written, the rest are rewritten smaller or merged into one
fix where several PRs patched the same cause. One commit per fix, so it
can be read commit by commit.

Fixes #43520, fixes #31396, fixes #43635, fixes #37193, fixes #43846,
fixes #17932, fixes #41061, fixes #36887, fixes #31810, fixes #35240,
fixes #32234, fixes #44365, fixes #43807, fixes #42280, fixes #44517.
Addresses #41856 (SNI and `servername`; not `checkServerIdentity` for
SQL), #24845 (the spin is gone, shown with fault injection on Linux; not
run on macOS), #19754 (node-fetch forwards the agent's TLS options; the
Kubernetes client itself was not run).

#### The ones that matter most

| | On `main` | PRs |
|---|---|---|
| Client certificate disclosure | `https.request()` with a client
certificate sends it to a server it then refuses (wrong name,
`checkServerIdentity`, `destroy()` in `'secureConnect'`, `terminate()`
in `handshake`). A server can force it with a junk record behind its
Finished | #43946 |
| False `authorized` | Over a Duplex, `secureConnect` with `authorized
=== true` for a peer that failed the key proof; `secureConnect` for a
plaintext peer with `rejectUnauthorized: false` | #44422, #32929 |
| Cleartext https | `https.createServer()` without a usable key/cert
answers plain HTTP | #41672, #33539 |
| Revoked client certificates | An https mTLS server never sees `crl`,
so a revoked client is `authorized` | #41641 |
| Pooled sockets | Requests with different client certificates or CAs
share an `https.Agent` socket and session | #42498 |
| Silent plaintext | `tls: [...]` given to `Bun.listen` / `Bun.connect`
is plain TCP | #41490 |
| Server weakened by a client knob | `NODE_TLS_REJECT_UNAUTHORIZED=0`
turns off a server's client-certificate enforcement | #35245 |
| Pins never checked | `WebSocket` never calls `tls.checkServerIdentity`
and ignores `tls.serverName` | #41648 |
| `verify-full` dropped | `PGSSLMODE=verify-*` is lost next to a `TLS_*`
URL variable; `tls: true` sends no SNI | #44498 |
| Crashes | use-after-free from `destroy()` in `ALPNCallback` over a
Duplex; `abort()` on a late `setSession()`; SIGABRT in `fetch` with an
https proxy from the environment and a `Bun.file()` body | #44462,
#41671, #44458 |
| Stream corruption | A TLS `write()` can lose 16 KiB it reported as
written while another socket on the loop is stalled | #44529 |
| Hangs and spins | 100% CPU on a failing `send()`; a fatal `SSL_write`
leaves the socket open forever; `idleTimeout` never sheds a TLS client
that ignores `close_notify` | #34510, #38176, #42336 |
| Wrong certificate (regression since 1.3.14) | Connections accepted
before `stop()` / `close()` get the default certificate and skip their
entry's `requestCert` / `ca` | #42355 |
| Quadratic Duplex / proxy tunnel | Reading one chunk over a Duplex,
CPU: 8 MB 0.88 s → 0.14 s, 16 MB 3.18 s → 0.23 s, 32 MB 11.75 s → 0.39
s; `fetch` upload through CONNECT: 1.7 s → 0.18 s (debug build) | #44464
|

#### By area

- **fd engine, write path** (`openssl.c`, `socket.c`): #42352, #34510 +
#38176 + #42336 as one change, #44529, #44458, #44192. A rejected
`send()` ends the write side only and closes at the next writable event
unless the peer's bytes are still queued (a 413 sent before a reset is
still read). No new per-socket state. Also, on kqueue, **a FIN no longer
ends a socket that waits in the low-priority queue** (`loop.c`): with
more than 5 TLS handshakes at once, a client that ended right after its
handshake could be reset and its server socket report `socket hang up`,
because the eof that the sentinel read knote reports was acted on ahead
of the unread Finished. That is on `main` too (the macOS entry for
`node-tls-server.test.ts` in `test/flaky-tests.txt`: 7 of 48 recent
builds of other branches), and this branch made it likelier (6 of 8
builds), since Finished now leaves in one segment with the close_notify.
- **Error reporting, both engines**: #44422, #32929, #44516, #37094,
#41272 + #42324 + #44223 as one change, #44021, #37472, #43946, #33630.
One channel: a fatal error on an established session is reported, then
**the engine closes the connection itself**, whatever the owner does
with the report. `test/js/bun/net/tls-fatal-error-closes.test.ts`
asserts closed-and-nothing-delivered for every owner (node:tls,
`Bun.connect`, `Bun.listen`, `fetch` direct and through CONNECT,
`Bun.serve`, `WebSocket` direct and through a proxy, Postgres, MySQL,
Valkey, Duplex).
- **Duplex engine** (`SSLWrapper`, `UpgradedDuplex`): #44462, #43529,
#42332, #44464. #43877 + #44394 were in and are **out again**, see
"Worth a look" 5.
- **node:tls wrap lifecycle** (`net.ts`, `tls.ts`): #38007, #38058,
#38028 + #38122 + #38076 as one change (six copies of the attach code
become two helpers), #38311, #39008, #38154, #42340 + #42343 + #42339 +
#42453 as one change, #43791, #42425, #44085, #42683, #39088, #39040,
#40375, and what was still real of #36534.
- **SNI, ALPN, server contexts**: #43080, #42050, #37195 + #43849 as one
change (**one** SNI matcher for TCP and HTTP/3), #42355, #42285, #33253,
part of #37896, part of #37013. A `tls.Server` has one `SSL_CTX`.
- **Verification and options**: #44738, #41490, #37005 + the cwd pin of
#40984, #31811, #43982, #33483 + #35245, #41810, #32235, #44441, #38092.
- **node:tls API and CA store**: #41671, #38145, #32824, #43594, #39997,
#41696, #33534, #34748, #42991, #42996, #42970.
- **node:https, Agent, `ws`, node-fetch**: #41672 (https half), #41641,
#38261, #42498, #44346, #35609, #31397, #42325.
- **WebSocket client**: #41648, #37487 + #43048 as one change.
- **SQL, Redis**: #33666, #41711, #44498, part of #42054.
- **Tests only**: #41426, #40040, #44395, #44016, #37860, #40591,
#44440, #41424.

Found on the way and fixed here: an upload that a TLS 1.2 server
interrupts with a renegotiation never completes on `main` (0 of 32 runs
over `https.request`, `fetch`, `node:tls` and `Bun.connect`: the
renegotiation ClientHello lands inside an application record that is
still unsent, or the socket gets no `drain` again) and completes here,
with two tests from robobun; the fix for #40653 (final flight and first
write in one segment) stopped working whenever another TLS socket on the
loop was stalled, on `main` too; the `tls.Server` prototype pinned the
last server constructed and every `SSL_CTX` it owned;
`Object.create(process.env).NODE_TLS_REJECT_UNAUTHORIZED = "0"` turned
verification off process-wide once a `SHARE_ENV` worker existed; two
debug panics when wrapping a shut-down or still-connecting socket; a
`fetch` POST through a proxy sent its headers twice when the origin
renegotiated; `BlockList` ignored IPv6 zone ids; a test now ties
`root_certs.der` to `certdata.txt`.

#### Behavior changes

- **A server's `ca` without `requestCert` no longer asks for a client
certificate** (`Bun.serve`, `Bun.listen`, HTTP/3, node:tls). It matches
the docs and Node. On `main` such a server refused clients with no
certificate but served any unrelated self-signed one, so it was never
authentication. **Set `requestCert: true` to require a certificate.** A
matrix test pins that `requestCert: true` still refuses no certificate
and an untrusted one on 8 kinds of server, TLS 1.2 and 1.3, with
`NODE_TLS_REJECT_UNAUTHORIZED` unset and `0`.
- `NODE_TLS_REJECT_UNAUTHORIZED=0` no longer relaxes a server.
- `Bun.connect` / `Bun.listen` hear of a fatal TLS error after the
handshake through `error(socket, err)`. With no `error` handler the
socket just closes.
- HTTP/3 server names match like TCP: `*.` covers exactly one label,
case is ignored, a trailing dot is ignored, the last registration of a
name wins.
- `requestCert` on node:https is `=== true`, as in Node.
- An array where a generated options dictionary is expected throws
(`tls: []`, `jest.useFakeTimers([])`).
- `key` / `cert` arrays serve every identity. A client that can use both
gets ECDSA, where `main` served whichever pair came last.
- `ecdhCurve` is forwarded by node:https, `ws` and node-fetch now, so a
group BoringSSL lacks (`X448`) throws there as it already does in
`tls.createServer`.
- A wrapped socket's error is re-emitted on the TLS socket as in Node,
so `raw.destroy(err)` with a listener on `raw` only is uncaught, as in
Node.
- `sql.options.tls` is always an object, never `true`. `RedisClient`
sends SNI.
- `tls: { secureContext }` alone asks for TLS on `Bun.listen` /
`Bun.connect` (it was plain TCP), and a value that is not a
`SecureContext` throws. The context is served as it is: the
`requestCert` / `rejectUnauthorized` it was created with hold whatever
the options next to it say, and `requestCert` in the options over a
context that does not ask throws at `listen()`.
- `tls.DEFAULT_CIPHERS` reaches every client once assigned (`fetch`,
`WebSocket`, `Bun.connect`, `RedisClient`, `Bun.SQL`, `S3Client`, proxy
tunnels) and servers again. A list that selects no cipher throws
`ERR_SSL_NO_CIPHER_MATCH` at the assignment. `fetch.preconnect()` dials
nothing after an assignment.
- The warning for an unreadable `NODE_EXTRA_CA_CERTS` is Node's one
line, without the `warn:` prefix.
- `BUN_CONFIG_WS_CLOSE_TIMEOUT` (default 30 s): how long a `WebSocket`
client waits for the server to close the connection after the closing
handshake.

#### Worth a look in review

1. **#44529**: the kernel-refused remainder of a TLS write moves from
the loop's one slot onto the connection (in the existing rare struct),
so the write BIO never refuses a sealed record. Nothing is allocated on
an unstalled path (200 writes: 0 appends, same `send()` count as
`main`), memory with 16 stalled writers is lower than on `main` (276 KB
vs 340 KB, which `main` holds inside BoringSSL's buffers), `us_socket_t`
stays 80 bytes. It needs a bound on how long a deferred close waits, or
a peer that stops reading pins the fd past `destroy()`:
`US_SSL_CLOSE_AFTER_SPILL_TIMEOUT` is a fixed 10 s, not re-armed on
progress. Separate commits, but the fix that keeps the client
certificate off the wire beside a stalled socket builds on them.
2. **The default name check of node:tls also runs inside the
handshake**, so a wrong-name server gets no client certificate on TLS
1.2 either. JS still runs it after every successful handshake, so a
difference between the two matchers can only refuse. Error objects are
byte-identical.
3. **#44441** widens trust by design: a self-issued leaf whose
`keyUsage` lacks `keyCertSign` (`dotnet dev-certs`) is its own anchor
when the store holds a byte-identical copy. No BoringSSL change. Expired
pin, same subject with another key, wrong EKU and a pinned intermediate
are tested to fail.
4. **#32235** only adds Ed25519 and ECDSA P-521 to the verify list. A
captured ClientHello shows `main`'s list with the two inserted;
`rsa_pkcs1_sha1` stays.

5. **A stream that a TLS socket wraps, when that TLS socket closes.** An
earlier state of this branch lost data here while CI was green (found by
#44709's report): with the peer closing first, 4 of 8 MiB arrived with
TLS in TLS, 4 of 32 MiB on the http2 `emit("connection")` path, and a
`write()` with no `'error'` listener ended the process. Three
Node-parity changes only hold together: destroying the wrapped stream at
the close (#38028 + #38122 + #38076, #38154) is safe only if every write
has really completed (#43877), which in turn needs Node's handling of
the peer's close_notify, which needs half-open sockets that the GC can
collect. So:
- #43877 + #44394 are reverted and reopened. A write over a stream
completes once the stream has taken the ciphertext, as on `main`.
- Until the verdict on the peer lets the session through, the
application cannot have written over it. There the wrapped stream is
destroyed as in Node, with the sessions below it. That keeps the release
of the connection after a failed handshake, a rejected certificate and
an early `destroy()`. The same for an http2 socket the application never
got, and for `resetAndDestroy()`.
- After that it is `main`'s teardown: a `net.Socket` only gets the
engine's `end()`, closes at its peer's FIN, keeps its own timeout and
reports its own errors. Any other stream is destroyed with the TLS
socket.

The regular suites cannot see any of this (999 files were green on every
broken variant), so it was steered by eleven seeded differential fuzzers
run on this build, `main`, Node v26.3.0 and the earlier state: close,
`end()`, `destroy()`, `destroySoon()`, resets, hung and half-open peers,
paused writers, timeouts, two and three sessions deep, over TCP and over
Duplexes, before, at and after the handshake, and http2 requests. See
"How did you verify".

#### Known limits

- `fetch` with a `checkServerIdentity` function still sends the client
certificate (not the request) to a server the function refuses. On TLS
1.2 any verdict a JS callback gives is too late, as in Node.
- `addContext()` / `SNICallback` still do not apply to a server-side
socket on the stream engine (`emit("connection", duplex)`, TLS in TLS,
unflushed writes, named pipes), as on `main`.
- A CA bundled in a pfx extends an explicit `ca` only, for `ws` /
node-fetch / `WebSocket`: the native `ca` can only replace the default
store, and that store keeps `SSL_CERT_FILE` / `SSL_CERT_DIR`.
- P-521 leaves work on TLS 1.3 only. TLS 1.2 needs secp521r1 in every
ClientHello (`it.todo`).
- Once `tls.DEFAULT_CIPHERS` is assigned, `fetch(url, { protocol:
"http3" })` is `HTTP3Unsupported`, as with an explicit `ciphers`.
- `addCACert()` by hand does not extend the chains of a context with
several identities.
- A throwing `ALPNCallback` sends `no_application_protocol` on both
engines. Node sends nothing and its client sees `ECONNRESET`.
- TLS in TLS, peer FIN while the outer handshake runs: the inner socket
gets one `write EPIPE`, where Node gives `ECONNRESET` (`main` gives it
no error at all).
- `@SECLEVEL` in `ciphers` is dropped by the `ws` / node-fetch shims,
which used to ignore `ciphers`. node:tls keeps throwing
`ERR_SSL_INVALID_COMMAND`.
- Beside a stalled TLS socket only the first record (16 KiB) of the
first write leaves with the handshake flight. The rest goes record by
record, which is what bounds the memory of stalled writers.
- After a fatal error on an established session the socket emits
`'error'` and then `'close'`. Node emits `'error'` and leaves the socket
open.
- A paused reader whose own write the kernel rejects loses what it had
not read yet, with an `EPIPE`, as on Node. `main` reports no error there
and delivers it.
- On `main` too: a `Bun.listen` socket without `allowHalfOpen` that has
unsent ciphertext when the client's `shutdown()` arrives loses that
ciphertext (32 KiB), and over plain TCP `end()` with the peer still
sending is a close over unread input, so a reset.
- Differences from both `main` and Node that the differential runs below
found and that stay, all with a peer that aborts: `ECONNRESET` instead
of a clean `'end'` after the socket's own `'finish'` when the peer
destroyed with unread data; under TLS 1.2, a zero-length `write()`
followed by `destroy()` in `'secureConnection'` leaves the client
without `'secureConnect'` (a plain `destroy()` there matches Node); a
TLS 1.2 client that destroys in `'secureConnect'` gets no `'session'`; a
`ClientRequest` whose handshake fails with an alert emits `'error'` and
`'close'` but no `'finish'` (`writableFinished` is true).
- Once `tls.DEFAULT_CIPHERS` is assigned, `fetch.preconnect()` opens
nothing: `fetch()` then uses a context of its own, and a socket warmed
under the default one would never be picked up.
- A TLS `send()` that the kernel refuses outside a `write()` call (the
drain of unsent ciphertext) is reported with the close, as `read EPIPE`
/ `read ECONNRESET`. Node says `write EPIPE`. `main` does not report it
at all.
- Once the application has a session over a `net.Socket` (TLS in TLS,
http2 `emit("connection")`), a peer that never sends its FIN holds that
socket after the TLS socket closed, as on `main`. Node destroys it. Two
tests of #38154 are `todo` for this. Closing it any earlier (at its
`'finish'`, say) makes the kernel drop what it has not sent yet as soon
as the peer's close_notify arrives.
- Plaintext that was queued on a socket before it was wrapped (STARTTLS
with a backlog) is dropped when the TLS socket is destroyed, or its
handshake fails, before the session is accepted. Node drops it too,
except on `destroySoon()`. `main` sends it.
- Over a stream that is no `net.Socket`, `end()` can still cut what that
stream has buffered, and there is no backpressure, both as on `main`
(#43877).
- `tls.secureContext` (the undocumented door node:tls uses) is not read
by a Windows named pipe listener, which builds its context from the
options. On `upgradeTLS({ isServer: true })` the options next to it are
the policy, as with Node's `SetVerifyMode`.
- `selectServerName()` rebuilds the name tree per ClientHello for
injected sockets of a server with `addContext()` entries: 0.4 µs for 1
entry, 3.7 µs for 10, 41 µs for 100, against 631–1111 µs for a
handshake.

#### Not included

Left open, because they need a decision or are not TLS: #43877 + #44394
(see "Worth a look" 5; #43874 stays open with them), #38548, #38591
(both shrink who is trusted), #41589 (`verify-full` vs
`NODE_TLS_REJECT_UNAUTHORIZED=0`), #37197, #41706, #43216, #33487,
#33545, #36707, #32435, #37255, #28691, #40275, #30314 (features),
#38120 (needs the BoringSSL fork, as did #33517, which the stale bot has
closed since), #38529 (needs a Windows measurement), #34342, #38232,
#43089, #44454, #40451, #42710, #44527, #38088, #38093, #41898. #37896,
#42054 and #37013 stay open for the halves not taken.
`http.createServer({ key, cert })` keeps serving TLS on purpose.

One open question: `tls: {}` (an object that names no TLS option) is
plain TCP on `Bun.listen` / `Bun.connect`, here and on `main`. It is the
same trap as `tls: []`, but changing it changes a Bun default, so it is
left alone.

### How did you verify your code works?

- Every new test fails on `main` for the stated reason and passes here,
except guards that pin existing behavior, each shown to fail when its
clause is removed. `node:*` tests also pass on Node v26.3.0; the few
that cannot say which Node version has the behavior.
- 212 test files that touch TLS, sockets, http, http2, fetch, WebSocket,
SQL, Valkey and workers: 6154 pass, 2 fail. Both are seen on `main` too:
`serve.test.ts` "root range port" (the box runs as root), and
`worker_threads.test.ts` "terminate(): nothing of the worker's runs
after the request", which is flaky there and passed in the run below.
- 58 of those files the way the ASAN lane runs them (LeakSanitizer +
`BUN_JSC_validateExceptionChecks`): 58 files, 48 of them with leak
checking, 4132 pass, 3 fail. All three also fail on `main`:
`serve.test.ts` "root range port", `node-net.test.ts` "should not leak
when connect({path}) fails synchronously on a reused handle" (times out
under this environment), `worker_threads.test.ts` "process.exit() with a
shell cp in flight" (a `ShellCpTask` leak).
- 647 vendored `test-tls-*`, `test-https-*`, `test-net-*`,
`test-http2-*`: the only two failures also fail on `main`.
- The SNI matcher was diffed against both old matchers: 3 seeds × 1.23 M
lookups × 3 registration flavours, every difference in one of the
intended classes, TCP and HTTP/3 identical on every lookup.
- The headline rows were also driven by hand with scripts against this
build, `main` and Node v26.3.0: cleartext https, `crl`, `tls: []` / `{
secureContext }`, the `ca` / `requestCert` matrix, the client
certificate on a wrong-name server, late `setSession()`, `destroy()` in
`ALPNCallback`, `[rsa, ec]` identities with an intermediate from `ca`,
`WebSocket` `checkServerIdentity`, a corrupted record, the Duplex read
above, `tls.DEFAULT_CIPHERS`.
- The `setSession()` guard was checked against the real `abort()` at 43
handshake states.
- `bun run rust:check-all`: 12 of 12 targets. `tsc`, oxlint, source
lints, prettier, rustfmt, mordant clean.
- usockets' `_Nonnull` is compiled out of debug builds, so 105 of those
files were also run on a local release ASAN build with the CI runner's
environment (92 with leak checking): 4595 pass, 1 fail,
`child_process.test.ts` "spawn reports EPERM after dropping privileges",
which cannot pass as root and fails on `main` too.
- The close of a TLS socket over another stream ("Worth a look" 5):
eleven seeded differential fuzzers, 8,424 scenarios compared, each run
on a release ASAN build of this branch, on `main`, on Node v26.3.0 and
on the earlier state of the branch. Against `main`:
- Data that `main` delivers in full is cut in 5 scenarios, and about 150
that `main` cuts arrive in full. Of the 5, in 2 `main` never notices the
peer's close and keeps the socket for good, 2 call `end()` on the middle
one of three sessions over an in-memory Duplex, and 1 does the same on
Node.
- No dead timeout, no silent reset and no uncaught error that `main`
does not have (4 uncaught errors fewer).
- A socket stays open where `main` closes it in 109, and closes where
`main` keeps it in 295. 92 of the 109 do the same on Node or on the
earlier state (a `destroy()` that an in-memory Duplex does not show its
peer, half-open peers). 14 wait for a peer that paused reading and so
does not read the FIN (#42332's backpressure, as in Node); the socket's
own timeout fires there. 3 are left: one on a 5 ms timer, two with three
sessions over an in-memory Duplex.
- The earlier state of the branch cut data in 173 of the 400 scenarios
of one of them, where `main` cuts none and this cuts none.
- 23 new tests pin what they found. Each earlier attempt at this fix
fails the ones that describe it, the earlier state of the branch fails
7, and all pass on Node.
- After that change: 999 test files on the release ASAN build (20,246
pass; the 11 files that fail need a database, Docker, DNS or a non-root
user, or share a temp directory with a parallel run and pass alone), 61
on the debug build.
- TLS over a file descriptor (`openssl.c`, the path of `fetch`,
`Bun.serve`, `tls.connect`, `Bun.connect`) got the same treatment after
the rebase: seeded differential fuzzers on CI's release build of this
branch, on `main` and, for `node:*`, on Node v26.3.0. Every runtime also
against itself for the noise floor, injected faults and known bugs of
`main` as positive controls, and a difference counts only if it shows in
5 of 5 fresh processes.
- `node:tls` over TCP: 11,500 scenarios (one connection with Node as the
oracle line by line; 2 to 60 connections beside stalled neighbours; raw
peers that break the handshake). HTTPS: about 136,000 runs over
`Bun.serve` + `fetch`, `node:https`, `node:http2` and `wss://`, also
with the two ends in different runtimes. `Bun.connect` / `Bun.listen` /
`upgradeTLS`: 11,500 scenarios and 720 slow connections, with writers
driven by what `write()` returns, beside up to 6 stalled, dripping,
closing or resetting neighbours, and plain TCP as a second oracle. No
crash, hang, duplication, reordering or silent truncation, and no change
in time or in connection reuse.
- They found six things that `main` does better, none of which any test
showed. All are fixed, each with a test that fails on the build before:
what the peer sent lost behind a rejected `send()` (23 scenarios, and an
early HTTPS response lost with only `EPIPE`), the same silently for a
paused reader, `server.close()` never calling back on a half-open server
after a ClientHello and a reset (17), `closeAllConnections()` taking 12
s with a stalled client, `end()` losing up to 1.3 of 4 MiB that
`write()` had reported while the peer still uploads, and `end()` a
little after a stall never closing beside other stalled TLS sockets. The
last two fixes also deliver the 1 to 2 MiB that `main` loses there, and
close the socket that `main` keeps for good without such neighbours.
- All of them again after every fix, on CI's release build of it. That
caught one regression of a fix itself (a reader stopped for backpressure
lost 86,385 bytes, 1 of 6,000 scenarios), fixed too. On the last build:
scenarios that lose data where `main` does not 23 → 2, and Node loses it
in both, with the same `EPIPE`; `server.close()` that never calls back
17 → 0; connections held 4 → 0; requests that end in an error only where
`main` has a response 6 → 0. With a Node server in another process, a
request ends in an error only in 8 and 10 of 1,500 scenarios here, 5 and
3 on `main`, 10 with Node as the client.
- `Bun.connect` / `Bun.listen` on the last build against `main`, in
scenarios: hangs 0 against 1,031, sockets and fds never released 0
against 965, corrupted data 0 against 345, `abort()` 0 against 26
(`setSession()` after the handshake), writers that never close 0 against
101 of 720 connections. No kind of failure shows here and not on `main`.
About a third of the slow connections close later than on `main`, in 1
to 16 s instead of at once, waiting for unsent ciphertext or for the
peer's close_notify, and 79 more of them deliver all that `write()`
reported. RSS and time with 16 to 256 stalled writers are the same.
- What they found that `main` does worse: a `WebSocket` that calls
`close()` with sends pending loses messages in 81 of 999 scenarios (0
here), 37 server sockets left open, 10 `server.close()` that never call
back, 20 write callbacks that never run.
- The kqueue fix cannot be run on Linux. The `connectionListener` count
test now says what became of a missing connection, which is how the
cause was found (`'tlsClientError'` "socket hang up", then `read
ECONNRESET` at the client of the same port, after its
`'secureConnect'`). On macOS x64 it failed every attempt of the three
builds before the fix and passed at the first attempt of the build with
it.
- Windows and macOS were only run by CI. Four new tests asserted what
only the Linux kernel does (a FIN read ahead of a reset, unread bytes
surviving a reset, loopback buffer sizes, `fstat()` on a socket) and now
say so per platform.

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: robobun <117481402+robobun@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants