Repository navigation
Document that fingerprints are not a security check - #27
Merged
Merged
Conversation
The fingerprint check catches random non-members, but someone who knows one key in the index can make up other keys that pass it. Looking one up returns the real key's rank and payload. Say so in spec §7.2 and §7.7, the Fingerprint and WithFingerprint godocs, and the README security note. The advice to hash keys with a secret now covers lookups as well as builds. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
🟡 Changes recommended
Documentation should clarify the minimum 16-byte output requirement and refine the security explanation.
4 open findings
What changed in this PR
This documentation-only PR clarifies that fingerprints are probabilistic checks, not security controls.
Changes:
- Updates security guidance in the specification and README.
- Expands
FingerprintandWithFingerprintdocumentation. - Explains secret-keyed hashing for build and lookup inputs.
| File | Summary |
|---|---|
streamhash-spec.md |
Expands security guidance and attack explanations. |
README.md |
Updates the security note and keyed-hashing example. |
key.go |
Updates Fingerprint documentation. |
builder_options.go |
Clarifies fingerprint behavior and false positives. |
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Standard SipHash outputs 8 bytes, which streamhash rejects as a key. Name 128-bit SipHash or HMAC-SHA256 instead, and say plainly what the lookup attack relies on. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Shaptic
approved these changes
Oct 15, 2026
tamirms
enabled auto-merge (squash)
October 16, 2026 06:37
tamirms
disabled auto-merge
October 16, 2026 06:37
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The fingerprint check catches random non-members, but someone who knows one key in the index can make up other keys that pass it. Looking one up returns the real key's rank and payload.
This PR says so in spec §7.2 and §7.7, the
FingerprintandWithFingerprintgodocs, and the README security note. The advice to hash keys with a secret now covers lookups as well as builds.🤖 Generated with Claude Code