docs: cross-host decryption guide and comment cleanup#614
Merged
Conversation
Cover the dumpkeys/archive/restore commands and keys.json secret-handling, and mark Windows-only forks as decryptable on any OS. Also fix the default format (json) and Arc support in the matrix.
Apply the no-internal-citation and WHY-not-WHAT rules to source comments; correct stale identifiers (NewBrowser, PBKDF2Key) and RFC facts (Yandex ciphertext, Firefox PBKDF2 password).
There was a problem hiding this comment.
Pull request overview
This PR updates repository documentation (README + RFCs) to describe cross-host decryption (dumpkeys → archive → restore) and refreshes/cleans up inline comments and RFC details to match the current implementation (no functional logic changes).
Changes:
- Adds a detailed “Cross-host decryption” guide to the README and updates CLI defaults/documentation (notably default output format =
json). - Refreshes multiple RFCs to reflect the implemented archive/restore/key retrieval architecture and corrects a handful of technical details.
- Removes/adjusts stale or overly-internal inline comments across Go/C source files.
Reviewed changes
Copilot reviewed 31 out of 31 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds cross-host decryption workflow documentation and updates CLI help/default format notes. |
| rfcs/013-cli-redesign-cross-host.md | Updates status and references (archive/restore) and aligns terminology (ZipDir). |
| rfcs/012-yandex-decryption.md | Corrects data layout wording (ciphertext vs plaintext). |
| rfcs/011-safari-data-storage.md | Updates Safari file coverage and aligns query/library/details with current extractor behavior. |
| rfcs/010-chrome-abe-integration.md | Updates architecture notes and identifiers to match current code organization and APIs. |
| rfcs/009-windows-locked-file-bypass.md | Clarifies handle/mapping flow and adds a missing field in the result table. |
| rfcs/008-file-acquisition-and-platform-quirks.md | Tweaks the Acquire flow diagram wording/layout. |
| rfcs/007-cli-and-output-design.md | Updates documented subcommands, defaults, and clarifies list/detail behavior and Extract return shape. |
| rfcs/006-key-retrieval-mechanisms.md | Updates interface names, clarifies ChainRetriever rationale, and keychain password sourcing note. |
| rfcs/005-firefox-encryption.md | Corrects/clarifies passwordCheckPBE derivation detail (PBKDF2 password input). |
| rfcs/004-firefox-data-storage.md | Adds missing timestamp unit detail for downloads endTime. |
| rfcs/003-chromium-encryption.md | Adds v12 “known gap” note and updates v20/v10/v11 decryption flow documentation. |
| rfcs/002-chromium-data-storage.md | Updates Yandex support status and corrects query/AAD-related notes. |
| rfcs/001-project-architecture.md | Updates supported engines/structure notes and refreshes a dependency version in the doc table. |
| utils/fileutil/fileutil.go | Removes a redundant comment in CompressDir (no behavior change). |
| masterkey/gcoredump_darwin.go | Removes redundant inline comments (no behavior change). |
| filemanager/copy_other.go | Updates platform note comment about Windows locked-cookie behavior. |
| crypto/yandex.go | Removes an RFC cross-reference from a comment. |
| crypto/windows/abe_native/bootstrap_layout.h | Clarifies the comment describing the target process/context. |
| crypto/version.go | Removes redundant internal comments around prefix handling. |
| crypto/pbkdf2.go | Updates example comment to use the local PBKDF2Key wrapper. |
| crypto/crypto.go | Removes/rephrases a few internal helper comments for brevity/clarity. |
| crypto/asn1pbe.go | Renames a struct header comment to match the type’s role. |
| browser/safari/safari.go | Rewords the maxCoreDataSeconds comment for clarity/precision. |
| browser/safari/safari_test.go | Fixes a stale section header comment identifier. |
| browser/safari/profiles_test.go | Fixes stale comment references to the constructor name. |
| browser/firefox/profile.go | Removes redundant function header comments. |
| browser/firefox/masterkey.go | Removes redundant table-read comments. |
| browser/chromium/yandex.go | Removes RFC cross-reference from comments. |
| browser/chromium/extract_password.go | Removes RFC cross-reference from comment. |
| browser/chromium/extract_creditcard.go | Removes RFC cross-reference from comment. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
dumpkeys→archive→restore), mark Windows-only forks as decryptable on any OS, fix the default format tojson.Docs- and comment-only — no functional change.