Repository navigation
docs: recommend checksums with dictionaries - #4846
Open
FOWEPJF255 wants to merge 1 commit into
Open
FOWEPJF255 wants to merge 1 commit into
FOWEPJF255 wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
What and why
Document that a matching
Dictionary_IDdoes not verify dictionary contents, and recommend including the optionalContent_Checksumfor dictionary-compressed frames. Clarify that checksums are partial integrity checks: decoders may ignore them, and they do not authenticate a dictionary.Related to #4845. This documents a mitigation and does not change format behavior.
Checklist
Tools used
AI assistant: reviewed the issue and drafted the documentation wording. I checked the technical claims against the format documentation and CLI defaults, reviewed the generated man-page diff, and ran
git diff --checkplus strict UTF-8 decoding.