Skip to content

fix(api): prevent Responses WebSockets from following redirects - #2513

Merged
apcha-oai merged 1 commit into
mainfrom
castiron/promotions/pr-87
Aug 28, 2026
Merged

fix(api): prevent Responses WebSockets from following redirects#2513
apcha-oai merged 1 commit into
mainfrom
castiron/promotions/pr-87

Conversation

@apcha-oai

@apcha-oai apcha-oai commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Responses WebSockets now consistently refuse HTTP redirects, even when followRedirects: true is supplied by the caller. This closes the remaining path where credentials or other caller-provided request state could be replayed to a redirect destination.

The first response is surfaced directly as an error (for example, Unexpected server response: 302), no redirect event is emitted, and no request reaches the destination. The initial request may still carry its configured credentials; the security boundary is that those credentials never leave the original endpoint.

Implementation details

Both stable and beta Responses WebSockets apply followRedirects: false after caller options. The redirect-security tests assert the unconditional policy, including benign-header and Bedrock cases. The packed-package source-navigation peer shim models the standard ws redirect option for TypeScript 4.9. Selective filtering used by other WebSocket surfaces remains unchanged.

Castiron-Internal-PR: openai/openai-node-internal#87
Castiron-Source-SHA: 87734e0d859d6c35195ec7e0019a787fad7f12c6
Castiron-Public-Base-SHA: 222f3d7
@github-actions

github-actions Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

32 mixed files remain; 0 existing customizations changed.

Compared 222f3d7dffd91764410f356a. Generated baselines verified.

32 existing customizations unchanged
  • api.md
  • scripts/castiron/README.md
  • scripts/castiron/custom_code_report.py
  • scripts/castiron/test_custom_code_report.py
  • src/client.ts
  • src/resources/audio/transcriptions.ts
  • src/resources/audio/translations.ts
  • src/resources/beta/assistants.ts
  • src/resources/beta/beta.ts
  • src/resources/beta/index.ts
  • src/resources/beta/responses/internal-base.ts
  • src/resources/beta/responses/responses.ts
  • src/resources/beta/threads/index.ts
  • src/resources/beta/threads/runs/index.ts
  • src/resources/beta/threads/runs/runs.ts
  • src/resources/beta/threads/threads.ts
  • src/resources/chat/completions/completions.ts
  • src/resources/chat/completions/index.ts
  • src/resources/conversations/index.ts
  • src/resources/embeddings.ts
  • src/resources/files.ts
  • src/resources/fine-tuning/checkpoints/permissions.ts
  • src/resources/images.ts
  • src/resources/responses/internal-base.ts
  • src/resources/responses/responses.ts
  • src/resources/skills/skills.ts
  • src/resources/skills/versions/versions.ts
  • src/resources/vector-stores/file-batches.ts
  • src/resources/vector-stores/files.ts
  • src/resources/webhooks/index.ts
  • src/resources/webhooks/webhooks.ts
  • tests/lib/data-residency.test.ts

A changed generated baseline means this report cannot reliably identify which handwritten lines changed.

Inspect the custom-code diff

Download the exact patch produced by this run (requires repository access):

gh run download 33195245898 --repo openai/openai-node \
  --name castiron-custom-code-33195245898-1 --dir /tmp/castiron-custom-code-33195245898-1
git apply --stat /tmp/castiron-custom-code-33195245898-1/custom-code.patch
cat /tmp/castiron-custom-code-33195245898-1/custom-code.patch

Or reproduce it from an SDK checkout containing the vendored reporter:

git fetch --no-tags origin 222f3d7dffd9fd3d3d183473e1a7810e5e027d7e 1764410f356ac669fa109587e56dabb814f852b2
python3 scripts/castiron/custom_code_report.py report \
  --base 222f3d7dffd9fd3d3d183473e1a7810e5e027d7e \
  --head 1764410f356ac669fa109587e56dabb814f852b2 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-1764410f356a
cat /tmp/castiron-custom-code-1764410f356a/custom-code.patch

This is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR.

Full report and patch

@apcha-oai
apcha-oai marked this pull request as ready for review August 28, 2026 17:32
@apcha-oai
apcha-oai requested a review from a team as a code owner August 28, 2026 17:32
@apcha-oai apcha-oai changed the title fix(api)!: prevent Responses WebSockets from following redirects fix(api): prevent Responses WebSockets from following redirects Aug 28, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Aug 28, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-08-28T17:34:31.430960Z 1764410 Draft marked ready
🔒 Security Review Completed 2026-08-28T17:34:15.700986Z 1764410 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@openai-sdks

openai-sdks Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

OkTest Summary

237/237 SDK tests passed in 10.225s for Node SDK PR #2513.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 137ms
tests/chat-completions-create.test.ts ✅ Passed 254ms
tests/chat-completions-stream.test.ts ✅ Passed 245ms
tests/files-content-binary.test.ts ✅ Passed 155ms
tests/files-create-multipart.test.ts ✅ Passed 152ms
tests/files-list-pagination.test.ts ✅ Passed 160ms
tests/initialize-config.test.ts ✅ Passed 228ms
tests/instance-isolation.test.ts ✅ Passed 101ms
tests/models-list.test.ts ✅ Passed 126ms
tests/responses-background-lifecycle.test.ts ✅ Passed 226ms
tests/responses-body-method-errors.test.ts ✅ Passed 312ms
tests/responses-cancel-timeout.test.ts ✅ Passed 197ms
tests/responses-cancel.test.ts ✅ Passed 240ms
tests/responses-compact-retries.test.ts ✅ Passed 294ms
tests/responses-compact.test.ts ✅ Passed 234ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 130ms
tests/responses-create-advanced.test.ts ✅ Passed 185ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.255s
tests/responses-create-errors.test.ts ✅ Passed 194ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 133ms
tests/responses-create-retries.test.ts ✅ Passed 267ms
tests/responses-create-stream-failures.test.ts ✅ Passed 204ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 2.154s
tests/responses-create-stream-wire.test.ts ✅ Passed 2.467s
tests/responses-create-stream.test.ts ✅ Passed 67ms
tests/responses-create-terminal-states.test.ts ✅ Passed 279ms
tests/responses-create-timeout.test.ts ✅ Passed 188ms
tests/responses-create.test.ts ✅ Passed 139ms
tests/responses-delete.test.ts ✅ Passed 191ms
tests/responses-input-items-errors.test.ts ✅ Passed 249ms
tests/responses-input-items-list.test.ts ✅ Passed 183ms
tests/responses-input-items-options.test.ts ✅ Passed 119ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 252ms
tests/responses-input-tokens-count.test.ts ✅ Passed 220ms
tests/responses-malformed-inputs.test.ts ✅ Passed 2.09s
tests/responses-not-found-errors.test.ts ✅ Passed 243ms
tests/responses-parse.test.ts ✅ Passed 174ms
tests/responses-retrieve-retries.test.ts ✅ Passed 255ms
tests/responses-retrieve.test.ts ✅ Passed 196ms
tests/responses-stored-method-errors.test.ts ✅ Passed 549ms
tests/retry-behavior.test.ts ✅ Passed 2.871s
tests/sdk-error-shape.test.ts ✅ Passed 272ms

View OkTest run #33195167191

SDK merge (acca6dc040c8) · head (1764410f356a) · base (222f3d7dffd9) · OkTest (2b1bdfd25e98)

@apcha-oai
apcha-oai enabled auto-merge August 28, 2026 17:33

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1764410f35

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

...authHeaders,
...this._wsOptions?.headers,
},
followRedirects: false,

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Document that Responses redirects are always disabled

Callers still see followRedirects as a supported field because ResponsesWSClientOptions extends WS.ClientOptions, but this override now silently ignores followRedirects: true on both stable and beta surfaces. Existing applications relying on same-origin or credential-free redirects will fail with the redirect response, while the canonical Responses WebSocket documentation merely says that WebSocket options can be passed through. Document this new invariant in the public JSDoc or canonical guide so the intentional breaking contract is discoverable.

AGENTS.md reference: AGENTS.md:L72-L74

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

expected for now; can followup if confusing

@apcha-oai apcha-oai Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

context: WS.ClientOptions is node behavior so there's not a nice way to remove the key unless we exclude it or override with an inline deprecated marker.

this is blocking some things. Might do that separately to enforce followRedirects?: false only but punting for now to unblock downstream work

@jbeckwith-oai jbeckwith-oai 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.

Reviewed the exact current head, including the stable/beta option ordering, reconnect path, Node adapter behavior, redirect event/error behavior, Bedrock/no-auth coverage, and credential/noncredential redirect tests. followRedirects: false is applied after all caller options on every Responses socket creation, so caller credentials and request state cannot be replayed to a redirect target. No blocking security or correctness findings. The existing public-option documentation thread is a worthwhile follow-up but does not weaken this security boundary.

@apcha-oai
apcha-oai added this pull request to the merge queue Aug 28, 2026
Merged via the queue into main with commit 0a4fb1b Aug 28, 2026
78 checks passed
@apcha-oai
apcha-oai deleted the castiron/promotions/pr-87 branch August 28, 2026 18:00
@openai-sdks openai-sdks Bot mentioned this pull request Aug 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants