Crate volaris_tools

What is it?

volaris-tools is a library used for managing the corecrypto logic behind volaris, and any applications that require easy integration with the volaris format.

Security

volaris-tools is built on top of volaris-crypto - which uses modern, secure and audited¹ AEADs for encryption and decryption.

You may find the audits for both AES-256-GCM and XChaCha20-Poly1305 on the NCC Group’s website.

¹ Deoxys-II-256 does not have an official audit, so use it at your own risk

Who uses Volaris-Tools?

This library is implemented by volaris, a secure command-line file encryption utility.

This crate was made to separate the logic away from the end-user application.

It also allows for more things to be built on top of the corecrypto functionality, such as a GUI application.

You can read more about volaris, volaris-crypto, volaris-tools and the technical details in the project’s main documentation!

Modules

decrypt

This provides functionality for decryption that adheres to the volaris format.

encrypt

This provides functionality for encryption that adheres to the volaris format.

erase

This provides functionality for “shredding” a file.

erase_dir

This provides functionality for “shredding” a directory. It first traverses the directory, and then calls shred on all files.

hash

This provides functionality for hashing a file with BLAKE3, using a stream reader to keep memory usage low.

hasher

header

This module contains all volaris header-related functions, such as dumping the header, restoring a dumped header, or stripping it entirely.

key

overwrite

This contains the actual logic for “shredding” a file.

pack

This contains the logic for traversing a given directory, placing all of the files within a zip file, and encrypting the zip file. The temporary zip file is then erased with one pass.

storage

unpack

This contains the logic for decrypting a zip file, and extracting each file to the target directory. The temporary zip file is then erased with one pass.

utils