From d61468040abc4e6e4417c390f4435ad5a644ff59 Mon Sep 17 00:00:00 2001 From: Austin Ewens Date: Fri, 5 Oct 2018 23:03:01 -0500 Subject: [PATCH] Documentation for checksum tool --- Checksum/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 Checksum/README.md diff --git a/Checksum/README.md b/Checksum/README.md new file mode 100644 index 0000000..d7008a0 --- /dev/null +++ b/Checksum/README.md @@ -0,0 +1,29 @@ +# Checksum + +This script can generate checksums from md5, sha1, sha224, sha256, sha384, and sha512. +Additionally, for another layer of secret it can create signed checksums using HMAC and a provided secret. +Lastly, to provide actual value to the script it can also verify if a checksum matches the file it was generated from. + +Examples: + +Generate a sha1 checksum +``` +python checksum.py -H sha1 -f test.txt -g +# b29d28bc5239dbc2689215811b2a73588609f301 +``` + +Generate a signature +``` +python checksum.py -f test.txt -s secret +# 3YYMCthY4hFxQj1wPF3uAg== +``` + +Verify a checksum +``` +python -H sha1 -f test.txt -v b29d28bc5239dbc2689215811b2a73588609f301 +``` + +Verify a signature +``` +python -f test.txt -s secret -v 3YYMCthY4hFxQj1wPF3uAg== +```