Package dev.sigstore.proto.rekor.v1

Class InclusionProof

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, InclusionProofOrBuilder, java.io.Serializable
    public final class InclusionProof
extends com.google.protobuf.GeneratedMessage
implements InclusionProofOrBuilder
     InclusionProof is the proof returned from the transparency log. Can
 be used for offline or online verification against the log.
    Protobuf type dev.sigstore.rekor.v1.InclusionProof
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  InclusionProof.Builder
      InclusionProof is the proof returned from the transparency log.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      Checkpoint getCheckpoint()
      Signature of the tree head, as of the time of this proof was generated.
      CheckpointOrBuilder getCheckpointOrBuilder()
      Signature of the tree head, as of the time of this proof was generated.
      static InclusionProof getDefaultInstance()  
      InclusionProof getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.ByteString getHashes​(int index)
      A list of hashes required to compute the inclusion proof, sorted in order from leaf to root.
      int getHashesCount()
      A list of hashes required to compute the inclusion proof, sorted in order from leaf to root.
      java.util.List<com.google.protobuf.ByteString> getHashesList()
      A list of hashes required to compute the inclusion proof, sorted in order from leaf to root.
      long getLogIndex()
      The index of the entry in the tree it was written to.
      com.google.protobuf.Parser<InclusionProof> getParserForType()  
      com.google.protobuf.ByteString getRootHash()
      The hash digest stored at the root of the merkle tree at the time the proof was generated.
      int getSerializedSize()  
      long getTreeSize()
      The size of the merkle tree at the time the proof was generated.
      boolean hasCheckpoint()
      Signature of the tree head, as of the time of this proof was generated.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static InclusionProof.Builder newBuilder()  
      static InclusionProof.Builder newBuilder​(InclusionProof prototype)  
      InclusionProof.Builder newBuilderForType()  
      protected InclusionProof.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static InclusionProof parseDelimitedFrom​(java.io.InputStream input)  
      static InclusionProof parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static InclusionProof parseFrom​(byte[] data)  
      static InclusionProof parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static InclusionProof parseFrom​(com.google.protobuf.ByteString data)  
      static InclusionProof parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static InclusionProof parseFrom​(com.google.protobuf.CodedInputStream input)  
      static InclusionProof parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static InclusionProof parseFrom​(java.io.InputStream input)  
      static InclusionProof parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static InclusionProof parseFrom​(java.nio.ByteBuffer data)  
      static InclusionProof parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<InclusionProof> parser()  
      InclusionProof.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • getLogIndex

        public long getLogIndex()
         The index of the entry in the tree it was written to.
        int64 log_index = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLogIndex in interface InclusionProofOrBuilder
        Returns:
        The logIndex.

      • getRootHash

        public com.google.protobuf.ByteString getRootHash()
         The hash digest stored at the root of the merkle tree at the time
 the proof was generated.
        bytes root_hash = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getRootHash in interface InclusionProofOrBuilder
        Returns:
        The rootHash.

      • getTreeSize

        public long getTreeSize()
         The size of the merkle tree at the time the proof was generated.
        int64 tree_size = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTreeSize in interface InclusionProofOrBuilder
        Returns:
        The treeSize.

      • getHashesList

        public java.util.List<com.google.protobuf.ByteString> getHashesList()
         A list of hashes required to compute the inclusion proof, sorted
 in order from leaf to root.
 Note that leaf and root hashes are not included.
 The root hash is available separately in this message, and the
 leaf hash should be calculated by the client.
        repeated bytes hashes = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getHashesList in interface InclusionProofOrBuilder
        Returns:
        A list containing the hashes.

      • getHashesCount

        public int getHashesCount()
         A list of hashes required to compute the inclusion proof, sorted
 in order from leaf to root.
 Note that leaf and root hashes are not included.
 The root hash is available separately in this message, and the
 leaf hash should be calculated by the client.
        repeated bytes hashes = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getHashesCount in interface InclusionProofOrBuilder
        Returns:
        The count of hashes.

      • getHashes

        public com.google.protobuf.ByteString getHashes​(int index)
         A list of hashes required to compute the inclusion proof, sorted
 in order from leaf to root.
 Note that leaf and root hashes are not included.
 The root hash is available separately in this message, and the
 leaf hash should be calculated by the client.
        repeated bytes hashes = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getHashes in interface InclusionProofOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The hashes at the given index.

      • hasCheckpoint

        public boolean hasCheckpoint()
         Signature of the tree head, as of the time of this proof was
 generated. See above info on 'Checkpoint' for more details.
        .dev.sigstore.rekor.v1.Checkpoint checkpoint = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasCheckpoint in interface InclusionProofOrBuilder
        Returns:
        Whether the checkpoint field is set.

      • getCheckpoint

        public Checkpoint getCheckpoint()
         Signature of the tree head, as of the time of this proof was
 generated. See above info on 'Checkpoint' for more details.
        .dev.sigstore.rekor.v1.Checkpoint checkpoint = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCheckpoint in interface InclusionProofOrBuilder
        Returns:
        The checkpoint.

      • getCheckpointOrBuilder

        public CheckpointOrBuilder getCheckpointOrBuilder()
         Signature of the tree head, as of the time of this proof was
 generated. See above info on 'Checkpoint' for more details.
        .dev.sigstore.rekor.v1.Checkpoint checkpoint = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCheckpointOrBuilder in interface InclusionProofOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static InclusionProof parseFrom​(java.nio.ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static InclusionProof parseFrom​(java.nio.ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static InclusionProof parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static InclusionProof parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static InclusionProof parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static InclusionProof parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static InclusionProof parseFrom​(java.io.InputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static InclusionProof parseFrom​(java.io.InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static InclusionProof parseDelimitedFrom​(java.io.InputStream input)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static InclusionProof parseDelimitedFrom​(java.io.InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static InclusionProof parseFrom​(com.google.protobuf.CodedInputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static InclusionProof parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public InclusionProof.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public InclusionProof.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected InclusionProof.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getDefaultInstance

        public static InclusionProof getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<InclusionProof> parser()

      • getParserForType

        public com.google.protobuf.Parser<InclusionProof> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage

      • getDefaultInstanceForType

        public InclusionProof getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder