Class Checkpoint

Namespace

Dev.Sigstore.Rekor.V1

Assembly

Sigstore.dll

The checkpoint MUST contain an origin string as a unique log identifier, the tree size, and the root hash. It MAY also be followed by optional data, and clients MUST NOT assume optional data. The checkpoint MUST also contain a signature over the root hash (tree head). The checkpoint MAY contain additional signatures, but the first SHOULD be the signature from the log. Checkpoint contents are concatenated with newlines into a single string. The checkpoint format is described in https://github.com/transparency-dev/formats/blob/main/log/README.md and https://github.com/C2SP/C2SP/blob/main/tlog-checkpoint.md. An example implementation can be found in https://github.com/sigstore/rekor/blob/main/pkg/util/signed_note.go

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

Inheritance

object

Checkpoint

Implements

IMessage<Checkpoint>

IEquatable<Checkpoint>

IDeepCloneable<Checkpoint>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Checkpoint()

public Checkpoint()

Checkpoint(Checkpoint)

public Checkpoint(Checkpoint other)

Parameters

other Checkpoint

Fields

EnvelopeFieldNumber

Field number for the "envelope" field.

public const int EnvelopeFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Envelope

public string Envelope { get; set; }

Property Value

string

Parser

public static MessageParser<Checkpoint> Parser { get; }

Property Value

MessageParser<Checkpoint>

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 Checkpoint Clone()

Returns

Checkpoint

A deep clone of this object.

Equals(Checkpoint)

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

public bool Equals(Checkpoint other)

Parameters

other Checkpoint

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(Checkpoint)

Merges the given message into this one.

public void MergeFrom(Checkpoint other)

Parameters

other Checkpoint

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.