https://github.com/timothymeadows/blake2b.net
Blake2b.Net provides an implementation of the cryptographic hash and MAC functions of the BLAKE2b algorithm, optimized for SIMD hardware instructions and PinnedMemory support.
https://github.com/timothymeadows/blake2b.net
Last synced: 4 months ago
JSON representation
Blake2b.Net provides an implementation of the cryptographic hash and MAC functions of the BLAKE2b algorithm, optimized for SIMD hardware instructions and PinnedMemory support.
- Host: GitHub
- URL: https://github.com/timothymeadows/blake2b.net
- Owner: TimothyMeadows
- License: mit
- Created: 2024-10-16T03:20:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-16T04:05:56.000Z (over 1 year ago)
- Last Synced: 2025-03-29T04:49:13.691Z (about 1 year ago)
- Language: C#
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Blake2b.Net
[](https://opensource.org/licenses/MIT) [](https://www.nuget.org/packages/Blake2b.Net/)
Blake2b.Net provides an implementation of the cryptographic hash and MAC functions of the [BLAKE2b](https://tools.ietf.org/html/draft-saarinen-blake2-02) algorithm, optimized for SIMD hardware instructions and [PinnedMemory](https://github.com/TimothyMeadows/PinnedMemory) support.
## Features
- Supports cryptographic hash generation using BLAKE2b.
- MAC (Message Authentication Code) functionality with key and salt.
- Optimized for SIMD instructions to ensure fast performance on supported hardware.
- Secure key and buffer management with PinnedMemory to avoid sensitive data leaks.
## Installation
You can install the package via NuGet:
### .NET CLI
```bash
dotnet add package Blake2b.Net
```
### Package Manager
```bash
Install-Package Blake2b.Net
```
### NuGet Website
You can also search for and install the package via the NuGet UI or from the following link:
[Blake2b.Net on NuGet](https://www.nuget.org/packages/Blake2b.Net/)
## Usage Examples
### Hashing Example:
```csharp
var digest = new Blake2b();
using var exampleHash = new PinnedMemory(new byte[digest.GetLength()]);
digest.UpdateBlock(new PinnedMemory(new byte[] {63, 61, 77, 20, 63, 61, 77, 20, 63, 61, 77}, false), 0, 11);
digest.DoFinal(exampleHash, 0);
```
### MAC Example:
```csharp
var digest = new Blake2bMac(new PinnedMemory(new byte[] {63, 61, 77, 20, 63, 61, 77}, false));
using var exampleHash = new PinnedMemory(new byte[digest.GetLength()]);
digest.UpdateBlock(new PinnedMemory(new byte[] {63, 61, 77, 20, 63, 61, 77, 20, 63, 61, 77}, false), 0, 11);
digest.DoFinal(exampleHash, 0);
```
## API Documentation
### Constructors
#### `Blake2b(int digestSize = 512)`
- Initializes a new instance of the `Blake2b` class with the specified digest size.
- Supported digest sizes: 160, 256, 384, 512 bits.
- Default size: 512 bits.
#### `Blake2bMac(PinnedMemory key)`
- Initializes a new instance of the `Blake2bMac` class with the specified key for MAC generation.
- The key should be provided in the form of a `PinnedMemory` object.
#### `Blake2bMac(PinnedMemory key, byte[] salt, int digestSize = 512)`
- Initializes a new instance of the `Blake2bMac` class with the specified key, salt, and digest size.
- Supported digest sizes: 160, 256, 384, 512 bits.
- Default size: 512 bits.
- The salt must be 16 bytes long.
### Methods
#### `void Update(byte b)`
- Updates the message digest with a single byte.
#### `void UpdateBlock(PinnedMemory message, int offset, int len)`
- Updates the message digest with a pinned memory byte array.
#### `void UpdateBlock(byte[] message, int offset, int len)`
- Updates the message digest with a regular byte array.
#### `void DoFinal(PinnedMemory output, int outOffset)`
- Produces the final digest value and outputs it to the specified `PinnedMemory` buffer.
#### `void Reset()`
- Resets the digest to its initial state for further processing.
- The key and salt remain until the object is disposed.
#### `void Dispose()`
- Clears the key and salt, resets the digest to its initial state, and releases resources.
## Performance Considerations
The BLAKE2b algorithm is optimized for modern SIMD instructions (such as AVX and SSE) to provide enhanced performance on supported hardware. This ensures that hashing and MAC operations are processed efficiently, even with large datasets.
## Security Considerations
This library utilizes `PinnedMemory` to ensure that sensitive data such as keys and message buffers are not moved by the garbage collector, reducing the risk of memory leaks. Ensure that you call `Dispose()` on any `PinnedMemory` object or classes that use it to securely clear and free memory after use.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.