Class CanonicalPayloadOptions

Namespace

AsiBackbone.Core.Signing

Assembly

AsiBackbone.Core.dll

Configures canonical payload construction and hashing behavior.

public sealed class CanonicalPayloadOptions

Inheritance

object

CanonicalPayloadOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Metadata is excluded from canonical payloads unless an explicit allow-list is supplied. This prevents host-specific diagnostics from silently changing signing payloads.

Fields

DefaultCanonicalizationVersion

Gets the default canonicalization version for deterministic AsiBackbone JSON signing payloads.

public const string DefaultCanonicalizationVersion = "asibackbone.canonical-json.v1"

Field Value

string

DefaultHashAlgorithm

Gets the default hash algorithm used by the provider-neutral payload hasher.

public const string DefaultHashAlgorithm = "SHA-256"

Field Value

string

Properties

CanonicalizationVersion

Gets the canonicalization version stamped onto payloads.

public string CanonicalizationVersion { get; }

Property Value

string

Default

Gets default canonical payload options.

public static CanonicalPayloadOptions Default { get; }

Property Value

CanonicalPayloadOptions

HashAlgorithm

Gets the hash algorithm descriptor used by CanonicalPayloadHasher.

public string HashAlgorithm { get; }

Property Value

string

MetadataKeyAllowList

Gets the metadata keys that may be included in canonical payloads.

public IReadOnlyCollection<string> MetadataKeyAllowList { get; }

Property Value

IReadOnlyCollection<string>

Methods

AllowsMetadataKey(string)

Determines whether the supplied metadata key may be included in a canonical payload.

public bool AllowsMetadataKey(string key)

Parameters

key string

Returns

bool

Create(IEnumerable<string>?, string?, string?)

Creates canonical payload options.

public static CanonicalPayloadOptions Create(IEnumerable<string>? metadataKeyAllowList = null, string? canonicalizationVersion = null, string? hashAlgorithm = null)

Parameters

metadataKeyAllowList IEnumerable<string>

canonicalizationVersion string

hashAlgorithm string

Returns

CanonicalPayloadOptions