Class InclusionPromise

Namespace

Dev.Sigstore.Rekor.V1

Assembly

Sigstore.dll

The inclusion promise is calculated by Rekor. It's calculated as a signature over a canonical JSON serialization of the persisted entry, the log ID, log index and the integration timestamp. See https://github.com/sigstore/rekor/blob/a6e58f72b6b18cc06cefe61808efd562b9726330/pkg/api/entries.go#L54 The format of the signature depends on the transparency log's public key. If the signature algorithm requires a hash function and/or a signature scheme (e.g. RSA) those has to be retrieved out-of-band from the log's operators, together with the public key. This is used to verify the integration timestamp's value and that the log has promised to include the entry.

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

Inheritance

object

InclusionPromise

Implements

IMessage<InclusionPromise>

IEquatable<InclusionPromise>

IDeepCloneable<InclusionPromise>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

InclusionPromise()

public InclusionPromise()

InclusionPromise(InclusionPromise)

public InclusionPromise(InclusionPromise other)

Parameters

other InclusionPromise

Fields

SignedEntryTimestampFieldNumber

Field number for the "signed_entry_timestamp" field.

public const int SignedEntryTimestampFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<InclusionPromise> Parser { get; }

Property Value

MessageParser<InclusionPromise>

SignedEntryTimestamp

public ByteString SignedEntryTimestamp { 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 InclusionPromise Clone()

Returns

InclusionPromise

A deep clone of this object.

Equals(InclusionPromise)

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

public bool Equals(InclusionPromise other)

Parameters

other InclusionPromise

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

Merges the given message into this one.

public void MergeFrom(InclusionPromise other)

Parameters

other InclusionPromise

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.