Nethermind.Multiformats.Hash 1.5.2-preview.1

Multiformats Multihash

Multibase implementation in C#.

This is not a general purpose hashing library, but a library to encode/decode Multihashes which is a "container" describing what hash algorithm the digest is calculated with. The library also support calculating the digest, but that is not it's main purpose. If you're looking for a library that supports many algorithms and only want the raw digest, try BouncyCastle or the built-ins of the .net framework.

To be clear, when you calculate a digest (using Sum) with this library, you will get a byte array including a prefix with the properties of the algorithm used (type and length).

There's a CLI version that you can use to compute files or direct input from the command line. This CLI tool passes the sharness tests here.

Table of Contents

• Install
• Usage
• Supported hash algorithms
• Maintainers
• Contribute
• License

Install

PM> Install-Package Multiformats.Hash

dotnet add package Multiformats.Hash

Usage

// decode a multihash formatted byte array
Multihash mh = Multihash.Decode(bytes);

// decode a multihash formatted string
Multihash mh = Multihash.Parse(str);
bool ok = Multihash.TryParse(str, out mh);

// encode a digest to multiformat byte array
byte[] bytes = Multihash.Encode(digest, HashType.SHA1);
byte[] bytes = Multihash.Encode<SHA1>(digest);

// calculate digest
Multihash mh = Multihash.Sum<SHA1>(bytes);

// verify
bool isValid = mh.Verify(bytes);

Supported hash algorithms

• ID
• MD4
• MD5
• SHA1
• SHA2_256
• SHA2_512
• SHA3_224
• SHA3_256
• SHA3_384
• SHA3_512
• SHAKE_128
• SHAKE_256
• KECCAK_224
• KECCAK_256
• KECCAK_384
• KECCAK_512
• BLAKE2B-(bits) (8-512)
• BLAKE2S-(bits) (8-256)
• DBL_SHA2_256
• MURMUR3_32/128
• SKEIN256-(bits) (8-256)
• SKEIN512-(bits) (8-512)
• SKEIN1024-(bits) (8-1024)