https://gitlab.com/solidninja/peroxide-cryptsetup
cli utility for managing cryptsetup disks on Linux
https://gitlab.com/solidninja/peroxide-cryptsetup
cryptsetup linux rust yubikey
Last synced: 9 months ago
JSON representation
cli utility for managing cryptsetup disks on Linux
- Host: gitlab.com
- URL: https://gitlab.com/solidninja/peroxide-cryptsetup
- Owner: solidninja
- License: gpl-3.0
- Created: 2019-10-09T23:15:18.678Z (over 6 years ago)
- Default Branch: main
- Last Synced: 2025-04-23T23:48:04.124Z (9 months ago)
- Topics: cryptsetup, linux, rust, yubikey
- Stars: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://gitlab.com/solidninja/peroxide-cryptsetup/commits/main)
[](https://crates.io/crates/peroxide-cryptsetup)
_**peroxide-cryptsetup**_
* _(peroxide) a viscous liquid with strong oxidizing properties._
# peroxide-cryptsetup - cli utility for managing cryptsetup disks on Linux
_**WARNING: alpha quality**_
## Description
`peroxs` is a command-line utility for managing cryptsetup disks on Linux. More precisely,
it helps you to manage key enrollment for devices and add backup keys in case your operational keys get
lost. It only supports LUKS devices currently.
## Usage
Documentation is currently a bit light, but this will get you started:
* `cargo install peroxide-cryptsetup`
Alternatively, clone this repository and build from source:
* `cargo build`
* now `target/debug/peroxs` will be simply referred to as `peroxs`
### Enrolling your first disk
Enrollment is the term used throughout for adding a new keyslot to either an existing or new LUKS disk.
Pick a block device (disk). We will use `/dev/your-disk` as an example.
* `cd /secure/key/storage/location`
* `peroxs init backup` (create the db)
* `peroxs enroll keyfile secret.key /dev/your-disk --name=awesome --iteration-ms=1000`
The above assumes that `/dev/your-disk` has already been `cryptsetup luksFormat`ed. If you need to format
an entirely new device:
* `peroxs enroll keyfile secret.key new --cipher aes-xts-plain --hash sha256 --key-bits 256 /dev/your-disk --name=awesome --iteration-ms=1000`
For more information on the values of `--cipher`, `--hash` and `--key-bits` see `man cryptsetup`.
### Open a device that is already enrolled
* `cd /location/of/peroxs/db`
* `peroxs open /dev/your-disk` (alternative, can use uuid of disk)
### Register an existing keyfile or passphrase for a disk
* `peroxs register keyfile secret.key /dev/your-disk --name=awesome`
### List disks in the database and their status
* `peroxs list --all`
### Full usage
(Copied from the clap-generated usage):
```
USAGE:
peroxs [OPTIONS]
OPTIONS:
-d, --database
The database to use[default: peroxs-db.json]
[aliases: db]
-h, --help
Print help information
-V, --version
Print version information
SUBCOMMANDS:
enroll
Enroll a new or existing LUKS disk(s) in the database (adding a new keyslot)
help
Print this message or the help of the given subcommand(s)
init
Initialize a new peroxide-db database
list
List disks enrolled in a database
open
Open enrolled LUKS disk(s)
register
Register an existing entry in the database (without adding a new keyslot)
```
#### `enroll`
```
USAGE:
peroxs enroll [OPTIONS]
OPTIONS:
-d, --database
The database to use[default: peroxs-db.json]
[aliases: db]
-h, --help
Print help information
SUBCOMMANDS:
help
Print this message or the help of the given subcommand(s)
keyfile
Enroll using a keyfile
passphrase
Enroll using a passphrase
yubikey
Enroll using a Yubikey token
```
#### `init`
```
USAGE:
peroxs init [OPTIONS]
ARGS:
Database type to enroll[possible values: operation, backup]
OPTIONS:
-d, --database
The database to use[default: peroxs-db.json]
[aliases: db]
-h, --help
Print help information
```
#### `list`
```
USAGE:
peroxs list [OPTIONS]
OPTIONS:
--all
List all devices in database, regardless of whether they can be found to be attached to
the system currently
-d, --database
The database to use[default: peroxs-db.json]
[aliases: db]
-h, --help
Print help information
```
#### `open`
```
USAGE:
peroxs open [OPTIONS] [DEVICE_OR_UUID]...
ARGS:
...
The path(s) to the device or the LUKS UUID(s) of the device
OPTIONS:
-d, --database
The database to use[default: peroxs-db.json]
[aliases: db]
-h, --help
Print help information
-n, --name
Override name specified in database (if any) when activating the device
```
#### `register`
```
USAGE:
peroxs register [OPTIONS]
OPTIONS:
-d, --database
The database to use[default: peroxs-db.json]
[aliases: db]
-h, --help
Print help information
SUBCOMMANDS:
help
Print this message or the help of the given subcommand(s)
keyfile
Register an existing keyfile
passphrase
Register an existing passphrase
```
## Development
You will require the following packages installed:
* `libcryptsetup-devel`
* `libsodium-devel`
* `ykpers-devel`
(Your distribution's package names may vary)
## Contributing
`peroxide-cryptsetup` is the work of its contributors and is a free software project licensed under the
GPLv3 or later.
If you would like to contribute, please follow the [C4](http://rfc.zeromq.org/spec:22) process.