luks 0.2.4

Pure-Rust Library for the Linux Unified Key Setup
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# luks-rs

[![Crates.io](https://img.shields.io/crates/v/luks.svg)](https://crates.io/crates/luks)
[![Documentation](https://docs.rs/luks/badge.svg)](https://docs.rs/luks/)
[![Build Status](https://github.com/louib/luks-rs/actions/workflows/on-merge.yaml/badge.svg?branch=main)](https://github.com/louib/luks-rs/actions/workflows/on-merge.yaml)

> [!CAUTION]
> This library is still experimental and under active development. APIs may change and it should not yet be used for production data without careful consideration.

Pure-Rust Library for the Linux Unified Key Setup

## Examples

Check the [examples](examples/) directory for usage. You can run them with:

```bash
cargo run --example read_header -- /dev/sda1
```

## Features

- **Pure-Rust**: The library is implemented entirely in Rust, which allows for easy static compilation, for example, using the `musl` target. This simplifies deployment and integration in various environments.
- **Custom Token Types**: The library introduces its own specialized token type, `luks-rs-keyring`. While it currently shares the same structure as the standard `luks2-keyring`, this unique identifier allows the library to recognize and handle tokens specifically created for its use.

## References

- [LUKS2 On-Disk Format Specification](https://gitlab.com/cryptsetup/LUKS2-docs/blob/main/luks2_doc_wip.pdf)
- [LUKS1 On-Disk Format Specification](https://cdn.kernel.org/pub/linux/utils/cryptsetup/LUKS_docs/on-disk-format.pdf)
- [New Methods in Hard Disk Encryption](https://clemens.endorphin.org/nmihde/nmihde-A4-ds.pdf)
- [TKS1 - An anti-forensic, two level, and iterated key setup scheme](https://www.kernel.org/pub/linux/utils/cryptsetup/LUKS_docs/TKS1-draft.pdf)