Home

Awesome

Deskasoft International has officially taken over maintenance and ongoing development of this library at https://github.com/Deskasoft/Data.HashFunction.


Data.HashFunction License

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.

Status

Master

Build Status Test Status

NuGet

NameNormal
Data.HashFunction.InterfacesVersion Status
Data.HashFunction.CoreVersion Status
Data.HashFunction.BernsteinHashVersion Status
Data.HashFunction.Blake2Version Status
Data.HashFunction.BuzhashVersion Status
Data.HashFunction.CityHashVersion Status
Data.HashFunction.CRCVersion Status
Data.HashFunction.ELF64Version Status
Data.HashFunction.FNVVersion Status
Data.HashFunction.HashAlgorithmVersion Status
Data.HashFunction.JenkinsVersion Status
Data.HashFunction.MurmurHashVersion Status
Data.HashFunction.PearsonVersion Status
Data.HashFunction.SpookyHashVersion Status
Data.HashFunction.xxHashVersion Status

Implementations

All implementation packages depend on the Data.HashFunction.Interfaces and Data.HashFunction.Core NuGet packages.

The following hash functions have been implemented from the most reliable reference that could be found.

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());
    }
}

Release Notes

See Release Notes wiki page.

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.

License

Data.HashFunction is released under the terms of the MIT license. See LICENSE for more information or see http://opensource.org/licenses/MIT.