Table of Contents

Class Lsh256

Namespace
CryptoHives.Foundation.Security.Cryptography.Hash
Assembly
CryptoHives.Foundation.Security.Cryptography.dll

Computes the LSH-256 hash for the input data.

public sealed class Lsh256 : HashAlgorithm, ICryptoTransform, IDisposable, IResettable
Inheritance
Lsh256
Implements
Inherited Members

Remarks

This is a fully managed implementation of LSH-256 that does not rely on OS or hardware cryptographic APIs, ensuring deterministic behavior across all platforms and runtimes.

LSH is the Korean national cryptographic hash standard defined in KS X 3262. The LSH-256 family uses 32-bit words and supports output sizes of 224 or 256 bits.

The algorithm uses a wide-pipe Merkle-Damgård construction with 26 steps, each consisting of message addition, a mixing function with rotation-based diffusion, and a word permutation.

Implementation follows the specification published by KISA (Korea Internet & Security Agency) and the official reference implementation.

Constructors

Lsh256()

Initializes a new instance of the Lsh256 class with 256-bit output.

public Lsh256()

Lsh256(int)

Initializes a new instance of the Lsh256 class.

public Lsh256(int hashSizeBytes)

Parameters

hashSizeBytes int

The desired output size in bytes (28 or 32).

Exceptions

ArgumentException

Thrown when hashSizeBytes is not 28 or 32.

Properties

AlgorithmName

Gets the name of the hash algorithm.

public override string AlgorithmName { get; }

Property Value

string

BlockSize

Gets the block size in bytes used by the hash algorithm.

public override int BlockSize { get; }

Property Value

int

Methods

Create()

Creates a new instance with default 256-bit output.

public static Lsh256 Create()

Returns

Lsh256

A new Lsh256 instance.

Create(int)

Creates a new instance with specified output size.

public static Lsh256 Create(int hashSizeBytes)

Parameters

hashSizeBytes int

The hash size in bytes (28 or 32).

Returns

Lsh256

A new Lsh256 instance.

Dispose(bool)

Releases the unmanaged resources used by the HashAlgorithm and optionally releases the managed resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

HashCore(ReadOnlySpan<byte>)

When overridden in a derived class, routes data written to the object into the hash algorithm for computing the hash.

protected override void HashCore(ReadOnlySpan<byte> source)

Parameters

source ReadOnlySpan<byte>

The input to compute the hash code for.

Exceptions

ObjectDisposedException

Thrown when the instance has been disposed.

HashData(in ReadOnlySequence<byte>, int)

Computes the LSH-256 hash of source and returns it as a new byte array.

public static byte[] HashData(in ReadOnlySequence<byte> source, int hashSizeBytes)

Parameters

source ReadOnlySequence<byte>

The (possibly multi-segment) input sequence to hash.

hashSizeBytes int

The desired output size in bytes (28 or 32).

Returns

byte[]

A new byte array containing the LSH-256 hash.

Exceptions

ArgumentException

Thrown when hashSizeBytes is not 28 or 32.

HashData(ReadOnlySpan<byte>, int)

Computes the LSH-256 hash of source and returns it as a new byte array.

public static byte[] HashData(ReadOnlySpan<byte> source, int hashSizeBytes)

Parameters

source ReadOnlySpan<byte>

The input data to hash.

hashSizeBytes int

The desired output size in bytes (28 or 32).

Returns

byte[]

A new byte array containing the LSH-256 hash.

Exceptions

ArgumentException

Thrown when hashSizeBytes is not 28 or 32.

Initialize()

Initializes an implementation of the HashAlgorithm class.

public override void Initialize()

Exceptions

ObjectDisposedException

Thrown when the instance has been disposed.

TryHashData(in ReadOnlySequence<byte>, Span<byte>, int, out int)

Computes the LSH-256 hash of source and writes it into destination.

public static bool TryHashData(in ReadOnlySequence<byte> source, Span<byte> destination, int hashSizeBytes, out int bytesWritten)

Parameters

source ReadOnlySequence<byte>

The (possibly multi-segment) input sequence to hash.

destination Span<byte>

The buffer to receive the hash value. Must be at least hashSizeBytes bytes.

hashSizeBytes int

The desired output size in bytes (28 or 32).

bytesWritten int

When this method returns, the number of bytes written into destination.

Returns

bool

true if destination was large enough; otherwise, false.

Exceptions

ArgumentException

Thrown when hashSizeBytes is not 28 or 32.

TryHashData(ReadOnlySpan<byte>, Span<byte>, int, out int)

Computes the LSH-256 hash of source and writes it into destination.

public static bool TryHashData(ReadOnlySpan<byte> source, Span<byte> destination, int hashSizeBytes, out int bytesWritten)

Parameters

source ReadOnlySpan<byte>

The input data to hash.

destination Span<byte>

The buffer to receive the hash value. Must be at least hashSizeBytes bytes.

hashSizeBytes int

The desired output size in bytes (28 or 32).

bytesWritten int

When this method returns, the number of bytes written into destination.

Returns

bool

true if destination was large enough; otherwise, false.

Exceptions

ArgumentException

Thrown when hashSizeBytes is not 28 or 32.

TryHashFinal(Span<byte>, out int)

When overridden in a derived class, finalizes the hash computation and writes the result into the provided buffer.

protected override bool TryHashFinal(Span<byte> destination, out int bytesWritten)

Parameters

destination Span<byte>

The target buffer to write the hash to.

bytesWritten int

The number of bytes written into the buffer.

Returns

bool

true if the destination buffer was large enough; otherwise false.

Exceptions

ObjectDisposedException

Thrown when the instance has been disposed.

Edit this page