mirror of
https://github.com/freemkv/freemkv-unlock.git
synced 2026-10-07 18:13:11 +00:00
Matthew Jackson
74936ad892
Fixed - ld/profile: find_by_drive_id no longer mis-binds a drive whose reported product_id is real but uncatalogued to a sibling model's profile (and its wrong LibreDrive microcode); the product-id-blind loose match is gated on an empty id. Docs / CI - Third-party NOTICE for the LibreDrive microcode bundled in profiles.json; cargo-deny gate (#15) and audience-based comment-guard (#17).
49 lines
2.1 KiB
Markdown
49 lines
2.1 KiB
Markdown
[](LICENSE)
|
|
[](https://github.com/freemkv/freemkv-unlock/actions/workflows/ci.yml)
|
|
[](https://codecov.io/gh/freemkv/freemkv-unlock)
|
|
|
|
# freemkv-unlock
|
|
|
|
The unlock layer for the freemkv toolchain.
|
|
|
|
An **unlocker removes a drive-level bus-encryption barrier** so the drive serves
|
|
readable (de-bus'd / de-scrambled) sectors. Content-key decryption is a separate
|
|
concern — the consumer's job.
|
|
|
|
This crate defines the `Unlocker` contract and a generic SCSI transport
|
|
contract, and holds the self-contained unlocker modules. The consumer
|
|
([libfreemkv](https://github.com/freemkv/libfreemkv)) depends on this crate and
|
|
dispatches through `all_unlockers()`; it never names an individual unlocker, and
|
|
clients of libfreemkv are oblivious to unlockers entirely (as they are to the
|
|
SCSI layer).
|
|
|
|
```rust
|
|
use freemkv_unlock::UnlockError;
|
|
|
|
// Drive-prep: try each unlocker's feature unlock until one claims the drive.
|
|
// `NotApplicable` means "not this unlocker's drive" — move on; a transport
|
|
// error means a dead bus — abort. `unlock_bus` follows the same contract for
|
|
// removing per-disc bus encryption.
|
|
for u in freemkv_unlock::all_unlockers() {
|
|
match u.unlock_features(&mut scsi, &ctx) {
|
|
Ok(unlocked) => return Ok(unlocked),
|
|
Err(UnlockError::NotApplicable) => continue,
|
|
Err(e) => return Err(e),
|
|
}
|
|
}
|
|
```
|
|
|
|
To remove an unlocker, delete its module directory and its one line in
|
|
`all_unlockers()` — nothing else changes.
|
|
|
|
## License
|
|
|
|
freemkv-unlock's own source is MIT — see [LICENSE](LICENSE).
|
|
|
|
`src/ld/profiles.json` bundles volatile, RAM-only **LibreDrive** microcode
|
|
authored and owned by the **MakeMKV team** (GuinpinSoft inc.) — *Copyright (c)
|
|
MakeMKV team, all rights reserved.* That microcode is third-party proprietary
|
|
material, **not** covered by the MIT license; no ownership is claimed. See
|
|
[`NOTICE`](NOTICE). With thanks to the MakeMKV team for
|
|
[LibreDrive](http://www.makemkv.com/libredrive/).
|