Class CShake128

Namespace

CryptoHives.Foundation.Security.Cryptography.Hash

Assembly

CryptoHives.Foundation.Security.Cryptography.dll

Computes a customizable SHAKE128 (cSHAKE128) output.

public sealed class CShake128 : KeccakCore, ICryptoTransform, IDisposable, IResettable, IExtendableOutput

Inheritance

object

HashAlgorithm

HashAlgorithm

KeccakCore

CShake128

Implements

ICryptoTransform

IDisposable

IResettable

IExtendableOutput

Inherited Members

HashAlgorithm.Create(string, bool)

HashAlgorithm.Create(string)

HashAlgorithm.TryComputeHash(ReadOnlySpan<byte>, Span<byte>, out int)

HashAlgorithm.AppendData(ReadOnlySpan<byte>)

HashAlgorithm.AppendData(in ReadOnlySequence<byte>)

HashAlgorithm.TryGetHashAndReset(Span<byte>, out int)

HashAlgorithm.TryReset()

HashAlgorithm.ComputeHash(Stream)

HashAlgorithm.ComputeHash(byte[])

HashAlgorithm.ComputeHash(byte[], int, int)

HashAlgorithm.TransformBlock(byte[], int, int, byte[], int)

HashAlgorithm.TransformFinalBlock(byte[], int, int)

HashAlgorithm.Dispose()

HashAlgorithm.Clear()

HashAlgorithm.HashSize

HashAlgorithm.Hash

HashAlgorithm.InputBlockSize

HashAlgorithm.OutputBlockSize

HashAlgorithm.CanTransformMultipleBlocks

HashAlgorithm.CanReuseTransform

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Remarks

This is a fully managed implementation of cSHAKE128 based on the Keccak sponge construction. It does not rely on OS or hardware cryptographic APIs, ensuring deterministic behavior across all platforms and runtimes.

cSHAKE128 is a customizable variant of SHAKE128 defined in NIST SP 800-185. It supports function name (N) and customization string (S) parameters for domain separation.

When both N and S are empty, cSHAKE128 is equivalent to SHAKE128.

Constructors

CShake128(int, byte[]?, byte[]?)

Initializes a new instance of the CShake128 class with byte array parameters.

public CShake128(int outputBytes, byte[]? functionName, byte[]? customization)

Parameters

outputBytes int

The desired output size in bytes.

functionName byte[]

The function name bytes N.

customization byte[]

The customization bytes S.

CShake128(int, string?, string?)

Initializes a new instance of the CShake128 class.

public CShake128(int outputBytes = 32, string? functionName = null, string? customization = null)

Parameters

outputBytes int

The desired output size in bytes.

functionName string

The function name string N (for NIST-defined functions).

customization string

The customization string S.

Fields

CapacityBytes

The capacity in bytes (256 bits for cSHAKE128).

public const int CapacityBytes = 32

Field Value

int

DefaultOutputBits

The default output size in bits.

public const int DefaultOutputBits = 256

Field Value

int

EncodeBufferLength

The minimum buffer size needed to call a TryEncodeLeft or TryEncodeRight function.

public const int EncodeBufferLength = 9

Field Value

int

RateBytes

The rate in bytes (1344 bits for cSHAKE128).

public const int RateBytes = 168

Field Value

int

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

Absorb(ReadOnlySpan<byte>)

Absorbs input data into the XOF state.

public void Absorb(ReadOnlySpan<byte> input)

Parameters

input ReadOnlySpan<byte>

The input data to absorb.

Exceptions

InvalidOperationException

Thrown when data is added after output has been squeezed.

Create()

Creates a new instance of the CShake128 class with default parameters.

public static CShake128 Create()

Returns

CShake128

Create(int, byte[]?, byte[]?)

Creates a new instance of the CShake128 hash function with the specified output length, function name, and customization string.

public static CShake128 Create(int outputBytes, byte[]? functionName = null, byte[]? customization = null)

Parameters

outputBytes int

The desired length, in bytes, of the hash output. Must be a positive integer.

functionName byte[]

An optional function name as a byte array, used to domain-separate the hash function. Can be null if no function name is required.

customization byte[]

An optional customization string as a byte array, used to further parameterize the hash function. Can be null if no customization is required.

Returns

CShake128

A new CShake128 instance configured with the specified output length, function name, and customization string.

Create(int, string, string?)

Creates a new instance of the CShake128 class with specified parameters.

public static CShake128 Create(int outputBytes, string functionName, string? customization = null)

Parameters

outputBytes int

The desired output size in bytes.

functionName string

The function name N (for NIST-defined functions).

customization string

The customization string S (user-defined).

Returns

CShake128

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.

Initialize()

Initializes an implementation of the HashAlgorithm class.

public override void Initialize()

Exceptions

ObjectDisposedException

Thrown when the instance has been disposed.

Reset()

Resets the XOF state so the instance can be reused for a new computation.

public void Reset()

Remarks

After calling this method, the instance is in the same state as a newly constructed one. All previously absorbed data and squeezed output are discarded.

Squeeze(Span<byte>)

Squeezes output bytes from the XOF state.

public void Squeeze(Span<byte> output)

Parameters

output Span<byte>

The buffer to receive the output.

Exceptions

ObjectDisposedException

Thrown when the instance has been disposed.

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.