From 5ee4dcd179299247ff20900b95f3b2012bd8c746 Mon Sep 17 00:00:00 2001 From: thecookingsenpai Date: Tue, 6 Feb 2024 16:26:32 +0100 Subject: [PATCH] better documentation --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 264415b..45211d2 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,11 @@ On Ubuntu 23.10 (untested on other platforms and flavors): sudo apt install libcbor-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 - 2fa encryption/decryption using RSA deterministic Key Derivation @@ -68,9 +73,13 @@ That .keyfile will be used by the various scripts. ## 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. +### Standalone tools + +You can also use the standalone tools in the root folder to encrypt / decrypt files and strings. + ### Documentation 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 ## Disclaimer + 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.