Package dev.sigstore.proto.trustroot.v1

Class TransparencyLogInstance

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransparencyLogInstanceOrBuilder, java.io.Serializable
    public final class TransparencyLogInstance
extends com.google.protobuf.GeneratedMessage
implements TransparencyLogInstanceOrBuilder
     TransparencyLogInstance describes the immutable parameters from a
 transparency log.
 See https://www.rfc-editor.org/rfc/rfc9162.html#name-log-parameters
 for more details.
 The included parameters are the minimal set required to identify a log,
 and verify an inclusion proof/promise.
    Protobuf type dev.sigstore.trustroot.v1.TransparencyLogInstance
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TransparencyLogInstance.Builder
      TransparencyLogInstance describes the immutable parameters from a 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 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

      • getBaseUrl

        public java.lang.String getBaseUrl()
         The base URL at which can be used to URLs for the client.
        string base_url = 1;
        Specified by:
        getBaseUrl in interface TransparencyLogInstanceOrBuilder
        Returns:
        The baseUrl.

      • getBaseUrlBytes

        public com.google.protobuf.ByteString getBaseUrlBytes()
         The base URL at which can be used to URLs for the client.
        string base_url = 1;
        Specified by:
        getBaseUrlBytes in interface TransparencyLogInstanceOrBuilder
        Returns:
        The bytes for baseUrl.

      • getHashAlgorithmValue

        public int getHashAlgorithmValue()
         The hash algorithm used for the Merkle Tree.
        .dev.sigstore.common.v1.HashAlgorithm hash_algorithm = 2;
        Specified by:
        getHashAlgorithmValue in interface TransparencyLogInstanceOrBuilder
        Returns:
        The enum numeric value on the wire for hashAlgorithm.

      • hasPublicKey

        public boolean hasPublicKey()
         The public key used to verify signatures generated by the log.
 This attribute contains the signature algorithm used by the log.
        .dev.sigstore.common.v1.PublicKey public_key = 3;
        Specified by:
        hasPublicKey in interface TransparencyLogInstanceOrBuilder
        Returns:
        Whether the publicKey field is set.

      • getPublicKey

        public PublicKey getPublicKey()
         The public key used to verify signatures generated by the log.
 This attribute contains the signature algorithm used by the log.
        .dev.sigstore.common.v1.PublicKey public_key = 3;
        Specified by:
        getPublicKey in interface TransparencyLogInstanceOrBuilder
        Returns:
        The publicKey.

      • hasLogId

        public boolean hasLogId()
         The unique identifier for this transparency log.
 Represented as the SHA-256 hash of the log's public key,
 calculated over the DER encoding of the key represented as
 SubjectPublicKeyInfo.
 See https://www.rfc-editor.org/rfc/rfc6962#section-3.2
        .dev.sigstore.common.v1.LogId log_id = 4;
        Specified by:
        hasLogId in interface TransparencyLogInstanceOrBuilder
        Returns:
        Whether the logId field is set.

      • getLogId

        public LogId getLogId()
         The unique identifier for this transparency log.
 Represented as the SHA-256 hash of the log's public key,
 calculated over the DER encoding of the key represented as
 SubjectPublicKeyInfo.
 See https://www.rfc-editor.org/rfc/rfc6962#section-3.2
        .dev.sigstore.common.v1.LogId log_id = 4;
        Specified by:
        getLogId in interface TransparencyLogInstanceOrBuilder
        Returns:
        The logId.

      • getLogIdOrBuilder

        public LogIdOrBuilder getLogIdOrBuilder()
         The unique identifier for this transparency log.
 Represented as the SHA-256 hash of the log's public key,
 calculated over the DER encoding of the key represented as
 SubjectPublicKeyInfo.
 See https://www.rfc-editor.org/rfc/rfc6962#section-3.2
        .dev.sigstore.common.v1.LogId log_id = 4;
        Specified by:
        getLogIdOrBuilder in interface TransparencyLogInstanceOrBuilder

      • hasCheckpointKeyId

        public boolean hasCheckpointKeyId()
         The checkpoint key identifier for the log used in a checkpoint.
 Optional, not provided for logs that do not generate checkpoints.
 For logs that do generate checkpoints, if not set, assume
 log_id equals checkpoint_key_id.
 Follows the specification described here
 for ECDSA and Ed25519 signatures:
 https://github.com/C2SP/C2SP/blob/main/signed-note.md#signatures
 For RSA signatures, the key ID will match the ECDSA format, the
 hashed DER-encoded SPKI public key. Publicly witnessed logs MUST NOT
 use RSA-signed checkpoints, since witnesses do not support
 RSA signatures.
 This is provided for convenience. Clients can also calculate the
 checkpoint key ID given the log's public key.
 SHOULD be set for logs generating Ed25519 signatures.
 SHOULD be 4 bytes long, as a truncated hash.
        .dev.sigstore.common.v1.LogId checkpoint_key_id = 5;
        Specified by:
        hasCheckpointKeyId in interface TransparencyLogInstanceOrBuilder
        Returns:
        Whether the checkpointKeyId field is set.

      • getCheckpointKeyId

        public LogId getCheckpointKeyId()
         The checkpoint key identifier for the log used in a checkpoint.
 Optional, not provided for logs that do not generate checkpoints.
 For logs that do generate checkpoints, if not set, assume
 log_id equals checkpoint_key_id.
 Follows the specification described here
 for ECDSA and Ed25519 signatures:
 https://github.com/C2SP/C2SP/blob/main/signed-note.md#signatures
 For RSA signatures, the key ID will match the ECDSA format, the
 hashed DER-encoded SPKI public key. Publicly witnessed logs MUST NOT
 use RSA-signed checkpoints, since witnesses do not support
 RSA signatures.
 This is provided for convenience. Clients can also calculate the
 checkpoint key ID given the log's public key.
 SHOULD be set for logs generating Ed25519 signatures.
 SHOULD be 4 bytes long, as a truncated hash.
        .dev.sigstore.common.v1.LogId checkpoint_key_id = 5;
        Specified by:
        getCheckpointKeyId in interface TransparencyLogInstanceOrBuilder
        Returns:
        The checkpointKeyId.

      • getCheckpointKeyIdOrBuilder

        public LogIdOrBuilder getCheckpointKeyIdOrBuilder()
         The checkpoint key identifier for the log used in a checkpoint.
 Optional, not provided for logs that do not generate checkpoints.
 For logs that do generate checkpoints, if not set, assume
 log_id equals checkpoint_key_id.
 Follows the specification described here
 for ECDSA and Ed25519 signatures:
 https://github.com/C2SP/C2SP/blob/main/signed-note.md#signatures
 For RSA signatures, the key ID will match the ECDSA format, the
 hashed DER-encoded SPKI public key. Publicly witnessed logs MUST NOT
 use RSA-signed checkpoints, since witnesses do not support
 RSA signatures.
 This is provided for convenience. Clients can also calculate the
 checkpoint key ID given the log's public key.
 SHOULD be set for logs generating Ed25519 signatures.
 SHOULD be 4 bytes long, as a truncated hash.
        .dev.sigstore.common.v1.LogId checkpoint_key_id = 5;
        Specified by:
        getCheckpointKeyIdOrBuilder in interface TransparencyLogInstanceOrBuilder

      • 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 TransparencyLogInstance parseFrom​(java.nio.ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<TransparencyLogInstance> 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 TransparencyLogInstance getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder