SabreTools/SabreTools.Hashing
1
0
Fork 0
mirror of https://github.com/SabreTools/SabreTools.Hashing.git synced 2026-09-22 06:45:09 +00:00
Code Issues 1 Packages Projects Releases 15 Wiki Activity

Minor tweaks

Browse Source
This commit is contained in:
Matt Nadareski
2025-09-23 14:18:50 -04:00
parent 32cd0e73ed
commit cbaa79b284
2 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/build_and_test.yml vendored
View File

@@ -25,7 +25,7 @@ jobs:
run: dotnet test
- name: Run publish script
run: ./publish-nix.sh
run: ./publish-nix.sh -d
- name: Upload to rolling
uses: ncipollo/release-action@v1.14.0

38
README.MD
View File

@@ -12,6 +12,25 @@ For the most recent stable build, download the latest release here: [Releases Pa
For the latest WIP build here: [Rolling Release](https://github.com/SabreTools/SabreTools.Hashing/releases/rolling)
## Hasher
**Hasher** is a reference implementation for hashing and checksumming features of the library, packaged as a standalone executable for all supported platforms. It will attempt to select the correct hashing types based on input and then print the calculated values to standard output.
```
Hasher <options> file|directory ...
Options:
-?, -h, --help Display this help text and quit
-d, --debug Enable debug mode
-l, --list List all available hashes and quit
-t, --type [TYPE] Output file hashes
If no hash types are provided, this tool will default
to outputting CRC-32, MD5, SHA-1, and SHA-256.
Optionally, all supported hashes can be output
by specifying a value of 'all'.
```
## Internal Implementations
All hash and checksum types here have been written to ensure compatibility across all .NET versions. Some may have been adapted to ensure this compatibility. These can be treated as reference implementations, not always optimized.
@@ -39,22 +58,3 @@ External implementations of hash and checksum types may not be compatible with a
| [System.Security.Cryptography](https://learn.microsoft.com/en-us/dotnet/api/system.security.cryptography) | MD5, SHA-1, SHA-256, SHA-384, SHA-512, SHA3-256, SHA3-384, SHA3-512, SHAKE128, SHAKE256 | Built-in library; SHA3-256, SHA3-384, SHA3-512, SHAKE128, and SHAKE256 are `net8.0` and above only for [supported platforms](https://learn.microsoft.com/en-us/dotnet/standard/security/cross-platform-cryptography) |
**Note:** If all you care about is performance, I encourage you to forego this library and use the ones listed above directly instead.
## Hasher
**Hasher** is a reference implementation for hashing and checksumming features of the library, packaged as a standalone executable for all supported platforms. It will attempt to select the correct hashing types based on input and then print the calculated values to standard output.
```
Hasher <options> file|directory ...
Options:
-?, -h, --help Display this help text and quit
-d, --debug Enable debug mode
-l, --list List all available hashes and quit
-t, --type [TYPE] Output file hashes
If no hash types are provided, this tool will default
to outputting CRC-32, MD5, SHA-1, and SHA-256.
Optionally, all supported hashes can be output
by specifying a value of 'all'.
```