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

Update README

Browse Source
This commit is contained in:
Matt Nadareski
2024-11-09 21:32:13 -05:00
parent 6df184fa4e
commit 841f5708a3
1 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.MD
View File

@@ -1,10 +1,24 @@
# SabreTools.Hashing
This library comprises of methods and helpers to simplify the process of getting checksums and hashes from both files and streams. See the following table for information about where each of the various components comes from:
This library comprises of methods and helpers to simplify the process of getting checksums and hashes from both files and streams.
## 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.
| Hash / Checksum Type | Notes |
| --- | --- |
| CRC | All CRC values documented [here](https://reveng.sourceforge.io/crc-catalogue/all.htm#crc.legend) |
| RIPEMD | 128-, 160-, 256-, and 320-bit variants |
| Tiger | 128-, 160-, and 192-bit variants; 3- and 4-pass; `0x01` and `0x80` (Tiger2) pad-initialized |
| xxHash | xxHash-32 and xxHash-64 only |
## External Implementations
External implementations of hash and checksum types may not be compatible with all .NET versions. Please see the table below for more information about support.
| Source | Hash / Checksum Types | Notes |
| --- | --- | --- |
| \<**INTERNAL**\> | Standardized CRC implementations, RIPEMD-128, RIPEMD-160, RIPEMD-256, RIPEMD-320, Tiger-128/3, Tiger-128/4, Tiger-160/3, Tiger-160/4, Tiger-192/3, Tiger-192/4, xxHash-32, xxHash-64 | Built for compatability, written from original specifications where possible |
| [Aaru.Checksums](https://github.com/aaru-dps/Aaru.Checksums) | Adler-32, Fletcher-16, Fletcher-32, SpamSum | Some code tweaks made to support older .NET versions |
| [Blake3.NET](https://github.com/xoofx/Blake3.NET) | BLAKE3 | Used in `net7.0` and above |
| [System.IO.Hashing](https://www.nuget.org/packages/System.IO.Hashing) | XXH3, XXH128 | Used in `net462` and above |