tcsenpai/hmacrypt
1
0
Fork 0
mirror of https://github.com/tcsenpai/hmacrypt.git synced 2025-06-07 11:25:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

better documentation

Browse Source
This commit is contained in:
thecookingsenpai 2024-02-06 16:26:32 +01:00
parent a370ae66c3
commit 5ee4dcd179
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -27,6 +27,11 @@ On Ubuntu 23.10 (untested on other platforms and flavors):
sudo apt install libcbor-dev sudo apt install libcbor-dev
sudo apt install libsodium-dev sudo apt install libsodium-dev
## FAQ
- A .keyfile without the passphrase AND the hardware key is not usable and won't be recoverable
- Remember to always "conda activate ./hmaenv" prior to running anything from here
## Features ## Features
- 2fa encryption/decryption using RSA deterministic Key Derivation - 2fa encryption/decryption using RSA deterministic Key Derivation
@ -68,9 +73,13 @@ That .keyfile will be used by the various scripts.
## Documentation and Examples ## Documentation and Examples
The present repository contains various easy to use examples in the root folder. The present repository contains various easy to use examples in the examples folder.
Once you have finished setting up your environment (either with the install.sh script or with conda or manually), you can grasp a quick view of this library by executing the examples below. Once you have finished setting up your environment (either with the install.sh script or with conda or manually), you can grasp a quick view of this library by executing the examples below.
### Standalone tools
You can also use the standalone tools in the root folder to encrypt / decrypt files and strings.
### Documentation ### Documentation
This is the documentation for hmacrypt.py library (you can find it in src). This is the documentation for hmacrypt.py library (you can find it in src).
@ -171,6 +180,7 @@ This is a creativity test for you: it is a generic file encryptor that uses the
- Python 3.11 breaks things in building pycrypto, that's why the prepared env is Python 3.10 - Python 3.11 breaks things in building pycrypto, that's why the prepared env is Python 3.10
## Disclaimer ## Disclaimer
This is just an experiment. While it should be safe, please review every step involved before using this in production. This is just an experiment. While it should be safe, please review every step involved before using this in production.
Also note that your encryption is as secure as your passphrase and your habits. Also note that your encryption is as secure as your passphrase and your habits.