Skip to content

docs/redaction: document hash salting and redactSalt override#2950

Merged
jwhartley merged 1 commit into
masterfrom
james/docs-redaction-salt
May 23, 2026
Merged

docs/redaction: document hash salting and redactSalt override#2950
jwhartley merged 1 commit into
masterfrom
james/docs-redaction-salt

Conversation

@jwhartley
Copy link
Copy Markdown
Contributor

Summary

  • Update the Hash strategy bullet to make clear that SHA-256 hashes are salted, and link to a new section explaining why.
  • Add a Hashing salt section documenting that Estuary generates and manages a per-task salt automatically, with stable hashing across publications.
  • Document the top-level redactSalt field on captures and derivations as the escape hatch for customers who need to share hashed values across tasks or supply their own salt.

Why

A customer asked in Slack (thread) whether Estuary supports only unsalted SHA-256 hashing, citing rainbow-table risk. The behavior in #2383 actually salts every hash and exposes a redactSalt override — but features/redaction.md doesn't mention any of that today.

Test plan

  • Visual review on the deploy preview — confirm the new section renders, the in-page link from the Hash bullet works, and the YAML examples are readable.

Customer question in Slack flagged that the redaction doc only mentions
SHA-256 and not the salt that's appended before hashing. Update the
Hash strategy description and add a new "Hashing salt" section
covering automatic per-task salt management and the optional
top-level `redactSalt` override on captures and derivations.

Behavior reference: flow PR #2383.
@jwhartley jwhartley requested a review from aeluce May 15, 2026 21:22
@github-actions
Copy link
Copy Markdown

🚀 Preview deployed to https://docs.estuary.dev/pr-preview/pr-2950/

📄 Changed pages:

Comment thread site/docs/features/redaction.md
@jwhartley jwhartley requested a review from aeluce May 20, 2026 07:18
@jwhartley jwhartley merged commit 70181bd into master May 23, 2026
8 checks passed
@jwhartley jwhartley deleted the james/docs-redaction-salt branch May 23, 2026 10:27
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