berkus
/
false-bottom
mirror of https://codeberg.org/skran/false-bottom.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

README: Updated Todo, usage and introduction

This commit is contained in:
K Shiva Kiran 2024-05-01 11:16:39 +05:30
parent 340c439c5c
commit 2b63047eb9
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,29 +1,30 @@
# False Bottom: A deniable encryption scheme
False Bottom is a [deniable encryption](https://en.wikipedia.org/wiki/Deniable_encryption) scheme.
The name “False-Bottom” alludes to well-known equipment of stage magicians, who have boxes that can be opened to appear empty or with something inside, hidden under a false bottom. This scheme is designed for the same effect, hence the name.
As such, unlike traditional encryption algorithms, False Bottom allows for the encryption and decryption of multiple messages to and from a single ciphertext.
Each message gets a corresponding key which can only be used to decrypt it.
Each addition returns a message specific key which can only be used to decrypt the correspoding message added.
Link to Technical Paper: [here](https://doi.org/10.1109/ACCESS.2023.3288285)
**Security Note:** This library has not been audited. Use it at your own risk.
## Usage and Documentation
To use this library in your Rust program, add the following line under your `Cargo.toml` dependencies:
```toml
[dependencies]
false-bottom = "0.2.0"
Run the following command in your project directory to add this library.
```sh
cargo add false-bottom
```
Check out the [crates.io](https://crates.io/crates/false-bottom) page to check the latest version of this library.
Refer to the documentation at [docs.rs](https://docs.rs/false-bottom).
Or alternatively, check out the [crates.io](https://crates.io/crates/false-bottom) to add this library to your project using the `Cargo.toml` file.
The documentation is available at [docs.rs](https://docs.rs/false-bottom).
## Run the examples
Refer to the [examples](./examples) directory.
You can run the provided examples using the following command:
These are provided in the [examples](./examples) directory.
Run them using the following command:
```sh
cargo run --example <filename>
```
## Todo
- Add more block sizes.
- [x] Add more block sizes.
- [ ] Add capabilities to edit and delete added messages in the ciphertext.
## License
Copyright © 2024 K Shiva Kiran <*shiva_kr at riseup dot net*>.