Git-Mirrors/shufflecake
1
0
Fork 0
mirror of https://codeberg.org/shufflecake/shufflecake-c.git synced 2026-01-19 01:08:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs:Add bit more of description context in README

Browse source
This commit is contained in:
Tommaso Gagliardoni 2025-12-14 11:50:44 +01:00
parent 384587c0ae
commit b91ed7d2df
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -14,9 +14,9 @@
# Shufflecake - Full C Implementation - v0.5.6
_Shufflecake_ is a plausible deniability (hidden storage) layer for Linux. You can consider Shufflecake a spiritual successor of tools like TrueCrypt and VeraCrypt, but vastly improved, both in terms of security and functionality. Official website: <https://www.shufflecake.net>.
_Shufflecake_ is a plausible deniability (hidden storage) layer for Linux. It allows to convincingly lie to an adversary about the existence of secret data on your device in the case that you are forced, e.g., to reveal your password. This is useful for people at high risk of being targeted by coercive interrogation methods, such as investigative journalists, activists, whistleblowers, repressed minorities. You can consider Shufflecake as a spiritual successor of tools like TrueCrypt and VeraCrypt, but vastly improved, both in terms of security and functionality. Official website: <https://www.shufflecake.net>.
This repository contains C source code and documentation to use and manage Shufflecake volumes.
This repository contains C source code and documentation to build and run the software, and to use and manage Shufflecake volumes.
__WARNING__: Shufflecake is a strong encryption and plausible deniability solution. The mere presence of Shufflecake on your device might put you at risk of being targeted, accused of crime or foul play, arrested, or worse. In Shufflecake there is no easy way to convince an adversary that you have given up all your passwords. Please consider carefully your threat model before using Shufflecake. In any case, this is still experimental software, please do not rely on its security or stability.
@ -97,7 +97,7 @@ For now there is no `make install` option, if you want you can install Shuffleca
### Tests <a id="user-content-tests"></a>
Tests are provided to check pre-install consistency. Run `sudo make test` to compile and run all the checks (`sudo` is requires to load a kernel module and perform block device operations, although local disk partitions are not touched, all tests are done using file-backed loop devices), or just `make test` to only check the cryptography layer. You can also run test scripts in a standalone way from the [`tests`](tests) directory. Remember to `make clean` afterwards.
Tests are provided to check pre-install consistency. Run `sudo make test` to compile and run all the checks (`sudo` is required to load a kernel module and perform block device operations, although local disk partitions are not touched, all tests are done using file-backed loop devices), or just `make test` to only check the cryptography layer. You can also run test scripts in a standalone way from the [`tests`](tests) directory. Remember to `make clean` afterwards.
### Benchmarks <a id="user-content-benchmarks"></a>