Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
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 build
- now
target/debug/peroxs
will be simply referred to asperoxs
Create a peroxs-db.json
and enroll a keyfile
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)
Full usage
verbatim from peroxs.rs
Usage:
peroxs enroll (keyfile <keyfile> | passphrase | yubikey [hybrid] --slot=<slot>) [new --cipher=<cipher> --hash=<hash> --key-bits=<key-bits>] <device-or-uuid>... --iteration-ms=<iteration-ms> [--backup-db=<backup-db>] [--name=<name>] [at <db>]
peroxs init <db-type> [at <db>]
peroxs open <device-or-uuid>... [--name=<name>] [at <db>]
peroxs (--help | --version)
Actions:
enroll Enroll a new or existing LUKS disk(s) with a given key type and parameters
init Create a new database of the specified type
open Open an existing LUKS disk(s) with parameters from the database
Enrollment types:
keyfile An existing key file with randomness inside
passphrase A password or passphrase
yubikey A Yubikey (combined with challenge)
yubikey hybrid A Yubikey (combined with challenge) and a secondary passphrase
Arguments:
<db> The path to the database
<db-type> The database type (used when creating). One of: operation,backup
<device-or-uuid> The path to the device or the uuid of the device
<keyfile> The path to the key file
Options:
--help Show this message
--version Show the version of peroxs and libraries.
--backup-db <backup-db> The path to the backup database to use (if any)
-c <cipher>, --cipher <cipher> Cipher to use for new LUKS container
-i <ms>, --iteration-ms <ms> Number of milliseconds to wait for the PBKDF2 function iterations
-h <hash>, --hash <hash> Hash function to use for new LUKS container
-n <name>, --name <name> Name for the device being enrolled
-s <key-bits>, --key-bits <key-bits> Number of key bits to use for new LUKS container
-S <slot>, --slot <slot> Slot in Yubikey to use
Roadmap
There's no official roadmap, but have a look in TASKS.todo for a list of current tasks.
Development
You will require the following packages installed:
libsodium-devel
ykpers-devel
FIXME
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 process.