Package dev.sigstore.proto.bundle.v1

Class Bundle

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BundleOrBuilder, java.io.Serializable
    public final class Bundle
extends com.google.protobuf.GeneratedMessage
implements BundleOrBuilder
    Protobuf type dev.sigstore.bundle.v1.Bundle
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Bundle.Builder
      Protobuf type dev.sigstore.bundle.v1.Bundle
      static class  Bundle.ContentCase  

      • 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)  
      Bundle.ContentCase getContentCase()  
      static Bundle getDefaultInstance()  
      Bundle getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      EnvelopeOuterClass.Envelope getDsseEnvelope()
      A DSSE envelope can contain arbitrary payloads.
      EnvelopeOuterClass.EnvelopeOrBuilder getDsseEnvelopeOrBuilder()
      A DSSE envelope can contain arbitrary payloads.
      java.lang.String getMediaType()
      MUST be application/vnd.dev.sigstore.bundle.v0.3+json when when encoded as JSON.
      com.google.protobuf.ByteString getMediaTypeBytes()
      MUST be application/vnd.dev.sigstore.bundle.v0.3+json when when encoded as JSON.
      MessageSignature getMessageSignature()
      .dev.sigstore.common.v1.MessageSignature message_signature = 3 [(.google.api.field_behavior) = REQUIRED];
      MessageSignatureOrBuilder getMessageSignatureOrBuilder()
      .dev.sigstore.common.v1.MessageSignature message_signature = 3 [(.google.api.field_behavior) = REQUIRED];
      com.google.protobuf.Parser<Bundle> getParserForType()  
      int getSerializedSize()  
      VerificationMaterial getVerificationMaterial()
      When a signer is identified by a X.509 certificate, a verifier MUST verify that the signature was computed at the time the certificate was valid as described in the Sigstore client spec: "Verification using a Bundle".
      VerificationMaterialOrBuilder getVerificationMaterialOrBuilder()
      When a signer is identified by a X.509 certificate, a verifier MUST verify that the signature was computed at the time the certificate was valid as described in the Sigstore client spec: "Verification using a Bundle".
      boolean hasDsseEnvelope()
      A DSSE envelope can contain arbitrary payloads.
      int hashCode()  
      boolean hasMessageSignature()
      .dev.sigstore.common.v1.MessageSignature message_signature = 3 [(.google.api.field_behavior) = REQUIRED];
      boolean hasVerificationMaterial()
      When a signer is identified by a X.509 certificate, a verifier MUST verify that the signature was computed at the time the certificate was valid as described in the Sigstore client spec: "Verification using a Bundle".
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Bundle.Builder newBuilder()  
      static Bundle.Builder newBuilder​(Bundle prototype)  
      Bundle.Builder newBuilderForType()  
      protected Bundle.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static Bundle parseDelimitedFrom​(java.io.InputStream input)  
      static Bundle parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Bundle parseFrom​(byte[] data)  
      static Bundle parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Bundle parseFrom​(com.google.protobuf.ByteString data)  
      static Bundle parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Bundle parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Bundle parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Bundle parseFrom​(java.io.InputStream input)  
      static Bundle parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Bundle parseFrom​(java.nio.ByteBuffer data)  
      static Bundle parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Bundle> parser()  
      Bundle.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

    • Field Detail

      • MEDIA_TYPE_FIELD_NUMBER

        public static final int MEDIA_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VERIFICATION_MATERIAL_FIELD_NUMBER

        public static final int VERIFICATION_MATERIAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MESSAGE_SIGNATURE_FIELD_NUMBER

        public static final int MESSAGE_SIGNATURE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DSSE_ENVELOPE_FIELD_NUMBER

        public static final int DSSE_ENVELOPE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • getMediaType

        public java.lang.String getMediaType()
         MUST be application/vnd.dev.sigstore.bundle.v0.3+json when
 when encoded as JSON.
 Clients must to be able to accept media type using the previously
 defined formats:
 * application/vnd.dev.sigstore.bundle+json;version=0.1
 * application/vnd.dev.sigstore.bundle+json;version=0.2
 * application/vnd.dev.sigstore.bundle+json;version=0.3
        string media_type = 1;
        Specified by:
        getMediaType in interface BundleOrBuilder
        Returns:
        The mediaType.

      • getMediaTypeBytes

        public com.google.protobuf.ByteString getMediaTypeBytes()
         MUST be application/vnd.dev.sigstore.bundle.v0.3+json when
 when encoded as JSON.
 Clients must to be able to accept media type using the previously
 defined formats:
 * application/vnd.dev.sigstore.bundle+json;version=0.1
 * application/vnd.dev.sigstore.bundle+json;version=0.2
 * application/vnd.dev.sigstore.bundle+json;version=0.3
        string media_type = 1;
        Specified by:
        getMediaTypeBytes in interface BundleOrBuilder
        Returns:
        The bytes for mediaType.

      • hasVerificationMaterial

        public boolean hasVerificationMaterial()
         When a signer is identified by a X.509 certificate, a verifier MUST
 verify that the signature was computed at the time the certificate
 was valid as described in the Sigstore client spec: "Verification
 using a Bundle".
 <https://docs.google.com/document/d/1kbhK2qyPPk8SLavHzYSDM8-Ueul9_oxIMVFuWMWKz0E/edit#heading=h.x8bduppe89ln>
 If the verification material contains a public key identifier
 (key hint) and the `content` is a DSSE envelope, the key hints
 MUST be exactly the same in the verification material and in the
 DSSE envelope.
        .dev.sigstore.bundle.v1.VerificationMaterial verification_material = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasVerificationMaterial in interface BundleOrBuilder
        Returns:
        Whether the verificationMaterial field is set.

      • getVerificationMaterial

        public VerificationMaterial getVerificationMaterial()
         When a signer is identified by a X.509 certificate, a verifier MUST
 verify that the signature was computed at the time the certificate
 was valid as described in the Sigstore client spec: "Verification
 using a Bundle".
 <https://docs.google.com/document/d/1kbhK2qyPPk8SLavHzYSDM8-Ueul9_oxIMVFuWMWKz0E/edit#heading=h.x8bduppe89ln>
 If the verification material contains a public key identifier
 (key hint) and the `content` is a DSSE envelope, the key hints
 MUST be exactly the same in the verification material and in the
 DSSE envelope.
        .dev.sigstore.bundle.v1.VerificationMaterial verification_material = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getVerificationMaterial in interface BundleOrBuilder
        Returns:
        The verificationMaterial.

      • getVerificationMaterialOrBuilder

        public VerificationMaterialOrBuilder getVerificationMaterialOrBuilder()
         When a signer is identified by a X.509 certificate, a verifier MUST
 verify that the signature was computed at the time the certificate
 was valid as described in the Sigstore client spec: "Verification
 using a Bundle".
 <https://docs.google.com/document/d/1kbhK2qyPPk8SLavHzYSDM8-Ueul9_oxIMVFuWMWKz0E/edit#heading=h.x8bduppe89ln>
 If the verification material contains a public key identifier
 (key hint) and the `content` is a DSSE envelope, the key hints
 MUST be exactly the same in the verification material and in the
 DSSE envelope.
        .dev.sigstore.bundle.v1.VerificationMaterial verification_material = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getVerificationMaterialOrBuilder in interface BundleOrBuilder

      • hasMessageSignature

        public boolean hasMessageSignature()
        .dev.sigstore.common.v1.MessageSignature message_signature = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasMessageSignature in interface BundleOrBuilder
        Returns:
        Whether the messageSignature field is set.

      • getMessageSignature

        public MessageSignature getMessageSignature()
        .dev.sigstore.common.v1.MessageSignature message_signature = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMessageSignature in interface BundleOrBuilder
        Returns:
        The messageSignature.

      • hasDsseEnvelope

        public boolean hasDsseEnvelope()
         A DSSE envelope can contain arbitrary payloads.
 Verifiers must verify that the payload type is a
 supported and expected type. This is part of the DSSE
 protocol which is defined here:
 <https://github.com/secure-systems-lab/dsse/blob/master/protocol.md>
 DSSE envelopes in a bundle MUST have exactly one signture.
 This is a limitation from the DSSE spec, as it can contain
 multiple signatures. There are two primary reasons:
 1. It simplfies the verification logic and policy
 2. The bundle (currently) can only contain a single
 instance of the required verification materials
 During verification a client MUST reject an envelope if
 the number of signatures is not equal to one.
        .io.intoto.Envelope dsse_envelope = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasDsseEnvelope in interface BundleOrBuilder
        Returns:
        Whether the dsseEnvelope field is set.

      • getDsseEnvelope

        public EnvelopeOuterClass.Envelope getDsseEnvelope()
         A DSSE envelope can contain arbitrary payloads.
 Verifiers must verify that the payload type is a
 supported and expected type. This is part of the DSSE
 protocol which is defined here:
 <https://github.com/secure-systems-lab/dsse/blob/master/protocol.md>
 DSSE envelopes in a bundle MUST have exactly one signture.
 This is a limitation from the DSSE spec, as it can contain
 multiple signatures. There are two primary reasons:
 1. It simplfies the verification logic and policy
 2. The bundle (currently) can only contain a single
 instance of the required verification materials
 During verification a client MUST reject an envelope if
 the number of signatures is not equal to one.
        .io.intoto.Envelope dsse_envelope = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDsseEnvelope in interface BundleOrBuilder
        Returns:
        The dsseEnvelope.

      • getDsseEnvelopeOrBuilder

        public EnvelopeOuterClass.EnvelopeOrBuilder getDsseEnvelopeOrBuilder()
         A DSSE envelope can contain arbitrary payloads.
 Verifiers must verify that the payload type is a
 supported and expected type. This is part of the DSSE
 protocol which is defined here:
 <https://github.com/secure-systems-lab/dsse/blob/master/protocol.md>
 DSSE envelopes in a bundle MUST have exactly one signture.
 This is a limitation from the DSSE spec, as it can contain
 multiple signatures. There are two primary reasons:
 1. It simplfies the verification logic and policy
 2. The bundle (currently) can only contain a single
 instance of the required verification materials
 During verification a client MUST reject an envelope if
 the number of signatures is not equal to one.
        .io.intoto.Envelope dsse_envelope = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDsseEnvelopeOrBuilder in interface BundleOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Bundle getDefaultInstance()

      • parser

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

      • getParserForType

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