Skip to content

docs(format): update LTX format specification - #92

Merged
corylanou merged 2 commits into
mainfrom
issue-83-docs-file-checksum-covers-the-logical-decompressed-page-stre
Aug 12, 2026
Merged

docs(format): update LTX format specification#92
corylanou merged 2 commits into
mainfrom
issue-83-docs-file-checksum-covers-the-logical-decompressed-page-stre

Conversation

@corylanou

Copy link
Copy Markdown
Collaborator

Summary

Fixes #83

Test Plan

  • Run the full Go test suite.
  • Verify Go formatting and whitespace checks.

Document the current v3 header, flags, compressed page frames, page
index, and trailer layout. Clarify that the file checksum covers
decompressed page data and structural bytes instead of the raw compressed
file stream.

Refs #83

@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: bf82b4a34a

ℹ️ 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".

Comment thread README.md Outdated
@corylanou
corylanou merged commit 8cb8f8e into main Aug 12, 2026
3 checks passed
@corylanou
corylanou deleted the issue-83-docs-file-checksum-covers-the-logical-decompressed-page-stre branch August 12, 2026 16:14
corylanou added a commit that referenced this pull request Aug 12, 2026
The README rewritten in #92 says LTX carries no on-disk version field and a
reader cannot determine the version from the file. Version 4 changes the
magic to LTX4, so both statements became wrong on this branch, and nothing
described encryption at all.

Covers the LTX1/LTX4 split and why unencrypted output stays v3, the v4
header fields and encryption flag, the recipient block and key derivation,
encrypted page frame layout and AAD binding, the page index auth tag, and
the fact that encrypted files hash ciphertext so integrity is verifiable
without a key.
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.

Docs: file checksum covers the logical (decompressed-page) stream, not raw file bytes

2 participants