Data.HashFunction has been superseded by HashifyNET, the new version (4.x.x) of Data.HashFunction. Please move to HashifyNET for further support with security, bug fixes, and new features.
This project was originally maintained at brandondahler/Data.HashFunction before 05/11/2022 (PT). It is maintained by Deskasoft International since then.
Join our Discord at https://discord.gg/PrKery9 to discuss about our projects.
Data.HashFunction is a C# library to create a common interface to non-cryptographic hash functions and provide implementations of public hash functions. It is licensed under the permissive and OSI approved MIT license.
All functionality of the library is tested using xUnit. A primary requirement for each release is 100% code coverage by these tests.
All code within the libarary is commented using Visual Studio-compatible XML comments.
CRC - Generalized implementation to allow any CRC parameters between 1 and 64 bits.
CRCStandards - 71 implementations on top of CRC that use the parameters defined by their respective standard. Standards and their parameters provided by CRC RevEng's catalogue.
Each family of hash functions is contained within its own project and NuGet package.
Usage
The usage for all hash functions has been standardized and is accessible via the System.Data.HashFunction.IHashFunction and System.Data.HashFunction.IHashFunctionAsync interfaces. The core package, Data.HashFunction.Core, only contains abstract hash function implementations and base functionality for the library. In order to use a specific hashing algorithms, you will need to reference its implementation packages.
IHashFunction implementations should be immutable and stateles. All IHashFunction methods and members should be thread safe.
using System;
using System.Data.HashFunction;
using System.Data.HashFunction.Jenkins;
public class Program
{
public static readonly IJenkinsOneAtATime _jenkinsOneAtATime = JenkinsOneAtATimeFactory.Instance.Create();
public static void Main()
{
var hashValue = _jenkinsOneAtATime.ComputeHash("foobar");
Console.WriteLine(hashValue.AsHexString());
}
}
This library generally abides by Semantic Versioning. Packages are published in MAJOR.MINOR.PATCH version format.
Patch component
An increment of the PATCH component always indicates that an internal-only change was made, generally a bug fix. These changes will not affect the public-facing API in any way, and are always guaranteed to be forward/backwards-compatible with your codebase, any pre-compiled dependencies of your codebase.
Minor component
An increment of the MINOR component indicates that some addition was made to the library,
and this addition may not be backwards-compatible with prior versions.
Major component
An increment of the MAJOR component indicates that breaking changes have been made to the library;
consumers should check the release notes to determine what changes need to be made.
Contributing
Feel free to propose changes, notify of issues, or contribute code using GitHub! Submit issues and/or pull requests as necessary.
There are no special requirements for change proposal or issue notifications.
Code contributions should follow existing code's methodologies and style, along with XML comments for all public and protected namespaces, classes, and functions added.
