SauceControl.Blake2Fast
1.0.0
Prefix Reserved
See the version list below for details.
dotnet add package SauceControl.Blake2Fast --version 1.0.0
NuGet\Install-Package SauceControl.Blake2Fast -Version 1.0.0
<PackageReference Include="SauceControl.Blake2Fast" Version="1.0.0" />
paket add SauceControl.Blake2Fast --version 1.0.0
#r "nuget: SauceControl.Blake2Fast, 1.0.0"
// Install SauceControl.Blake2Fast as a Cake Addin #addin nuget:?package=SauceControl.Blake2Fast&version=1.0.0 // Install SauceControl.Blake2Fast as a Cake Tool #tool nuget:?package=SauceControl.Blake2Fast&version=1.0.0
These RFC 7693-compliant BLAKE2 implementations have been tuned for high speed and low memory usage. The .NET Core 2.1 and 3.0 builds use the new x86 SIMD Intrinsics for even greater speed. Span{byte}
is used throughout for lower memory overhead compared to byte[]
based APIs.
On .NET Core 2.1, Blake2Fast uses an SSE4.1 SIMD-accelerated implementation for both BLAKE2b and BLAKE2s.
On .NET Core 3.0, a faster AVX2 implementation of BLAKE2b is available (with SSE4.1 fallback for older processors), while BLAKE2s uses the same SSE4.1 implementation.
Usage
All-at-Once Hashing
The simplest and lightest-weight way to calculate a hash is the all-at-once ComputeHash
method.
var hash = Blake2b.ComputeHash(data);
BLAKE2 supports variable digest lengths from 1 to 32 bytes for BLAKE2s or 1 to 64 bytes for BLAKE2b.
var hash = Blake2b.ComputeHash(42, data);
BLAKE2 also natively supports keyed hashing.
var hash = Blake2b.ComputeHash(key, data);
Incremental Hashing
BLAKE2 hashes can be incrementally updated if you do not have the data available all at once.
async Task<byte[]> ComputeHashAsync(Stream data)
{
var hasher = Blake2b.CreateIncrementalHasher();
var buffer = ArrayPool<byte>.Shared.Rent(4096);
int bytesRead;
while ((bytesRead = await data.ReadAsync(buffer, 0, buffer.Length)) > 0)
hasher.Update(new Span<byte>(buffer, 0, bytesRead));
ArrayPool<byte>.Shared.Return(buffer);
return hasher.Finish();
}
Allocation-Free Hashing
The output hash digest can be written to an existing buffer to avoid allocating a new array each time.
Span<byte> buffer = stackalloc byte[Blake2b.DefaultDigestLength];
Blake2b.ComputeAndWriteHash(data, buffer);
This is especially useful when performing an iterative hash, as might be used in a key derivation function.
byte[] DeriveBytes(string password, ReadOnlySpan<byte> salt)
{
// Create key from password, then hash the salt using the key
var pwkey = Blake2b.ComputeHash(Encoding.UTF8.GetBytes(password));
var hbuff = Blake2b.ComputeHash(pwkey, salt);
// Hash the hash lots of times, re-using the same buffer
for (int i = 0; i < 999_999; i++)
Blake2b.ComputeAndWriteHash(pwkey, hbuff, hbuff);
return hbuff;
}
System.Security.Cryptography Interop
For interoperating with code that uses System.Security.Cryptography
primitives, Blake2Fast can create a HashAlgorithm
wrapper. The wrapper inherits from HMAC
in case keyed hashing is required.
HashAlgorithm
is less efficient than the above methods, so use it only when necessary for compatibility.
byte[] WriteDataAndCalculateHash(byte[] data, string outFile)
{
using (var hashAlg = Blake2b.CreateHashAlgorithm())
using (var fileStream = new FileStream(outFile, FileMode.Create))
using (var cryptoStream = new CryptoStream(fileStream, hashAlg, CryptoStreamMode.Write))
{
cryptoStream.Write(data, 0, data.Length);
cryptoStream.FlushFinalBlock();
return hashAlg.Hash;
}
}
SIMD Intrinsics Warning
This warning applies only to .NET Core 2.1; the older build targets use only the scalar code, and SIMD intrinsics are fully supported on .NET Core 3.0.
The x86 SIMD Intrinsics used in the .NET Core 2.1 build are not officially supported by Microsoft. Although the specific SSE Intrinsics used by Blake2Fast have been well-tested, the JIT support for the x86 Intrinsics in general is experimental in .NET Core 2.1.
If you are uncomfortable using unsupported functionality, you can make a custom build of Blake2Fast by removing the USE_INTRINSICS
define constant in the project file.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp1.0 was computed. netcoreapp1.1 was computed. netcoreapp2.0 was computed. netcoreapp2.1 is compatible. netcoreapp2.2 was computed. netcoreapp3.0 is compatible. netcoreapp3.1 was computed. |
.NET Standard | netstandard1.1 is compatible. netstandard1.2 was computed. netstandard1.3 is compatible. netstandard1.4 was computed. netstandard1.5 was computed. netstandard1.6 was computed. netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net45 is compatible. net451 was computed. net452 was computed. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen30 was computed. tizen40 was computed. tizen60 was computed. |
Universal Windows Platform | uap was computed. uap10.0 was computed. |
Windows Phone | wpa81 was computed. |
Windows Store | netcore was computed. netcore45 was computed. netcore451 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETCoreApp 2.1
- System.Runtime.CompilerServices.Unsafe (>= 4.5.2)
- System.Runtime.Intrinsics.Experimental (>= 4.5.0-rc1)
-
.NETCoreApp 3.0
- No dependencies.
-
.NETFramework 4.5
- System.Memory (>= 4.5.3)
- System.Runtime.CompilerServices.Unsafe (>= 4.5.2)
-
.NETStandard 1.1
- NETStandard.Library (>= 1.6.1)
- System.Memory (>= 4.5.3)
- System.Runtime.CompilerServices.Unsafe (>= 4.5.2)
-
.NETStandard 1.3
- NETStandard.Library (>= 1.6.1)
- System.Memory (>= 4.5.3)
- System.Runtime.CompilerServices.Unsafe (>= 4.5.2)
-
.NETStandard 2.0
- System.Memory (>= 4.5.3)
- System.Runtime.CompilerServices.Unsafe (>= 4.5.2)
NuGet packages (17)
Showing the top 5 NuGet packages that depend on SauceControl.Blake2Fast:
Package | Downloads |
---|---|
CardanoSharp.Wallet
Package Description |
|
Orion.CardanoSharp.Wallet
Package Description |
|
ActualChat.Core
Package Description |
|
FleetSharp
Package Description |
|
NextGenSoftware.Holochain.HoloNET.Client
The world's first .NET & Unity client for Holochain. |
GitHub repositories (3)
Showing the top 3 popular GitHub repositories that depend on SauceControl.Blake2Fast:
Repository | Stars |
---|---|
baking-bad/tzkt
😼 Awesome Tezos blockchain indexer and API
|
|
xoofx/Blake3.NET
Blake3.NET is a fast managed wrapper around the SIMD Rust implementations of the BLAKE3 cryptographic hash function.
|
|
CardanoSharp/cardanosharp-wallet
CardanoSharp.Wallet is a Cardano Cryptographic and Serialization library for .NET applications.
|
See https://github.com/saucecontrol/Blake2Fast/releases for release-specific notes.