From 075352158cbf1d4353f83c99dc60d9764c86a67b Mon Sep 17 00:00:00 2001 From: Matthew Jackson <1085847+MattJackson@users.noreply.github.com> Date: Fri, 10 Jul 2026 14:35:44 -0700 Subject: [PATCH] ld: restore module README with LibreDrive credit to Mike Chen + the MakeMKV team --- src/ld/README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 src/ld/README.md diff --git a/src/ld/README.md b/src/ld/README.md new file mode 100644 index 0000000..f9e671c --- /dev/null +++ b/src/ld/README.md @@ -0,0 +1,27 @@ +# ld — the LibreDrive unlocker + +The **LibreDrive** unlocker module for freemkv-unlock. + +freemkv-unlock defines the generic `Unlocker` contract; this module is one +implementation of it. It recognizes a bundled catalog of supported drives +(`profiles.json`) and, for a matching drive, lifts the drive-level +bus-encryption barrier so the drive serves readable sectors. Content-key +decryption is a separate concern, handled by the consumer. + +Clients never name this module directly — +[libfreemkv](https://github.com/freemkv/libfreemkv) dispatches through +`freemkv_unlock::all_unlockers()`, and this module answers `matches()` / +`unlock()` when the drive identity is one it supports. + +## Scope: non-persistent unlock only + +This module performs only the **non-persistent** unlock — the access state it +sets up lives in drive RAM and is gone on power cycle. The one-time, permanent +drive preparation is the drive owner's own manual step and is **never** +automated here. + +## Credits + +LibreDrive was created by **Mike Chen** and the **MakeMKV team**. This module +builds on their work — our thanks and full credit to them for the LibreDrive +capabilities.