Skip to content

Clarify Temporal Proxy fail-closed encryption - #5293

Open
lukeknep wants to merge 3 commits into
mainfrom
docs/clarify-proxy-fail-closed
Open

Clarify Temporal Proxy fail-closed encryption#5293
lukeknep wants to merge 3 commits into
mainfrom
docs/clarify-proxy-fail-closed

Conversation

@lukeknep

@lukeknep lukeknep commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Define fail-closed behavior for outbound Payload encryption.
  • Clarify that encryption errors stop requests before they reach the upstream Temporal Service.
  • Document the boundaries for direct connections, migration-era plaintext responses, Search Attributes, and failure fields.
  • Correct the broader encryption claim on the Temporal Proxy overview.

Why

The existing documentation says that the default key makes encryption fail-closed, but does not explain which traffic and fields that guarantee covers. This change makes the operational and data-coverage boundaries explicit.

Validation

  • CI-scoped Vale check passes with no findings.
  • Production documentation build passes.

@lukeknep
lukeknep requested a review from a team as a code owner September 9, 2026 23:27
@vercel

vercel Bot commented Sep 9, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
temporal-documentation Ready Ready Preview Sep 10, 2026 4:44pm UTC

Request Review

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

@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: 88879edd8e

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment on lines +94 to +95
Fail-closed does not mean that every request field is encrypted. Search Attributes remain unencrypted so the Temporal
Service can index them. Failure messages and call stacks are not codec-capable Payloads by default. See

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Narrow the encryption diagram's arrow labels

When this paragraph narrows encryption to codec-capable Payloads and explains that Search Attributes and default failure fields remain unencrypted, the Mermaid diagram earlier in docs/production-deployment/temporal-proxy/encrypt-payloads.mdx still labels the entire outbound request as ciphertext and the entire upstream response as ciphertext response. Readers scanning the diagram therefore still receive the blanket guarantee this change is intended to remove; update those arrow labels to distinguish encrypted Payloads from the rest of each request or response.

AGENTS.md reference: AGENTS.md:L234-L242

Useful? React with 👍 / 👎.

Codex flagged that the ciphertext/ciphertext-response arrow labels in
the fail-closed diagram still imply the whole request and response are
encrypted, contradicting the note that Search Attributes and default
failure fields stay unencrypted.
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