Documentation for checksum tool

This commit is contained in:
Austin Ewens 2018-10-05 23:03:01 -05:00 committed by GitHub
parent 8b45cdccf1
commit d61468040a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

29
Checksum/README.md Normal file
View File

@ -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==
```