Skip to content

Docs: technical reference set (protocols, file formats, security, glossary, lab, ethics) - #1

Merged
tfastdigital merged 1 commit into
mainfrom
docs/technical-reference
Sep 9, 2026
Merged

tfastdigital merged 1 commit into
mainfrom
docs/technical-reference

Conversation

@tfastdigital

Copy link
Copy Markdown
Owner

Adds an educational/technical-reference layer to the docs, grounded in the actual source (real struct offsets, protocol command names, and XML verbs read from the code — not invented).

New docs

  • docs/FILE_FORMATS.md — byte-level data structures: GPT, Samsung PIT, Unisoc PAC, MTK scatter, Android sparse, MTK seccfg, ext4 — each tied to the file that parses it.
  • docs/PROTOCOLS.md — wire protocols with Mermaid state machines: Sahara→Firehose (EDL), Odin/LOKE, BROM→DA (with the auth-bypass fork), Unisoc FDL1→FDL2, Kirin, and the ADB/fastboot fallback.
  • docs/SECURITY_CONCEPTS.md — verified boot chain, FRP, bootloader lock/seccfg, IMEI/EFS, and where crypto is real vs. obfuscation; threat-model table.
  • docs/GLOSSARY.md — every acronym/term in one place.
  • docs/LAB_SETUP.md — safe practice environment: test devices, drivers, backups, brick recovery.
  • docs/LEGAL_AND_ETHICS.md — authorized vs. prohibited use, records to keep, jurisdiction notes.

Changed

  • docs/RESOURCES.md — expanded from a link list into an annotated research bibliography.
  • README.md — new docs listed in the Documentation section and repo tree.

Docs only — no code changes.

🤖 Generated with Claude Code

… glossary, lab, ethics)

Add five new educational docs grounded in the actual source, plus two
practical guides, and wire them into the README:

- FILE_FORMATS.md  GPT, Samsung PIT, Unisoc PAC, MTK scatter, sparse,
                   seccfg and ext4 byte layouts, tied to the parsing files
- PROTOCOLS.md     Sahara/Firehose, Odin/LOKE, BROM/DA, ResearchDownload,
                   Kirin and ADB/fastboot with state machines
- SECURITY_CONCEPTS.md  verified boot, FRP, bootloader lock, IMEI, and where
                   crypto is real vs. obfuscation
- GLOSSARY.md      all acronyms and terms in one place
- RESOURCES.md     expanded into an annotated research bibliography
- LAB_SETUP.md     safe practice environment and brick recovery
- LEGAL_AND_ETHICS.md  authorized vs. prohibited use, records to keep

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@tfastdigital
tfastdigital merged commit 604f261 into main Sep 9, 2026
1 check failed
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.

1 participant