Class MessageSignature

Namespace

Dev.Sigstore.Common.V1

Assembly

Sigstore.dll

MessageSignature stores the computed signature over a message.

public sealed class MessageSignature : IMessage<MessageSignature>, IEquatable<MessageSignature>, IDeepCloneable<MessageSignature>, IBufferMessage, IMessage

Inheritance

object

MessageSignature

Implements

IMessage<MessageSignature>

IEquatable<MessageSignature>

IDeepCloneable<MessageSignature>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

MessageSignature()

public MessageSignature()

MessageSignature(MessageSignature)

public MessageSignature(MessageSignature other)

Parameters

other MessageSignature

Fields

MessageDigestFieldNumber

Field number for the "message_digest" field.

public const int MessageDigestFieldNumber = 1

Field Value

int

SignatureFieldNumber

Field number for the "signature" field.

public const int SignatureFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

MessageDigest

Message digest can be used to identify the artifact. Clients MUST NOT attempt to use this digest to verify the associated signature; it is intended solely for identification.

public HashOutput MessageDigest { get; set; }

Property Value

HashOutput

Parser

public static MessageParser<MessageSignature> Parser { get; }

Property Value

MessageParser<MessageSignature>

Signature

The raw bytes as returned from the signature algorithm. The signature algorithm (and so the format of the signature bytes) are determined by the contents of the 'verification_material', either a key-pair or a certificate. If using a certificate, the certificate contains the required information on the signature algorithm. When using a key pair, the algorithm MUST be part of the public key, which MUST be communicated out-of-band.

public ByteString Signature { get; set; }

Property Value

ByteString

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public MessageSignature Clone()

Returns

MessageSignature

A deep clone of this object.

Equals(MessageSignature)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(MessageSignature other)

Parameters

other MessageSignature

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(MessageSignature)

Merges the given message into this one.

public void MergeFrom(MessageSignature other)

Parameters

other MessageSignature

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.