Class Signature

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SignatureOrBuilder, Serializable

    public final class Signature
    extends com.google.protobuf.GeneratedMessageV3
    implements SignatureOrBuilder
     Verifiers (e.g. Kritis implementations) MUST verify signatures
     with respect to the trust anchors defined in policy (e.g. a Kritis policy).
     Typically this means that the verifier has been configured with a map from
     `public_key_id` to public key material (and any required parameters, e.g.
     signing algorithm).
     In particular, verification implementations MUST NOT treat the signature
     `public_key_id` as anything more than a key lookup hint. The `public_key_id`
     DOES NOT validate or authenticate a public key; it only provides a mechanism
     for quickly selecting a public key ALREADY CONFIGURED on the verifier through
     a trusted channel. Verification implementations MUST reject signatures in any
     of the following circumstances:
       * The `public_key_id` is not recognized by the verifier.
       * The public key that `public_key_id` refers to does not verify the
         signature with respect to the payload.
     The `signature` contents SHOULD NOT be "attached" (where the payload is
     included with the serialized `signature` bytes). Verifiers MUST ignore any
     "attached" payload and only verify signatures with respect to explicitly
     provided payload (e.g. a `payload` field on the proto message that holds
     this Signature, or the canonical serialization of the proto message that
     holds this signature).
     
    Protobuf type grafeas.v1beta1.Signature
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Signature.Builder
      Verifiers (e.g.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int PUBLIC_KEY_ID_FIELD_NUMBER  
      static int SIGNATURE_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static Signature getDefaultInstance()  
      Signature getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<Signature> getParserForType()  
      String getPublicKeyId()
      The identifier for the public key that verifies this signature.
      com.google.protobuf.ByteString getPublicKeyIdBytes()
      The identifier for the public key that verifies this signature.
      int getSerializedSize()  
      com.google.protobuf.ByteString getSignature()
      The content of the signature, an opaque bytestring.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Signature.Builder newBuilder()  
      static Signature.Builder newBuilder​(Signature prototype)  
      Signature.Builder newBuilderForType()  
      protected Signature.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Signature parseDelimitedFrom​(InputStream input)  
      static Signature parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Signature parseFrom​(byte[] data)  
      static Signature parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Signature parseFrom​(com.google.protobuf.ByteString data)  
      static Signature parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Signature parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Signature parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Signature parseFrom​(InputStream input)  
      static Signature parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Signature parseFrom​(ByteBuffer data)  
      static Signature parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Signature> parser()  
      Signature.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • 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, hasField, hasOneof
    • Field Detail

      • PUBLIC_KEY_ID_FIELD_NUMBER

        public static final int PUBLIC_KEY_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getSignature

        public com.google.protobuf.ByteString getSignature()
         The content of the signature, an opaque bytestring.
         The payload that this signature verifies MUST be unambiguously provided
         with the Signature during verification. A wrapper message might provide
         the payload explicitly. Alternatively, a message might have a canonical
         serialization that can always be unambiguously computed to derive the
         payload.
         
        bytes signature = 1;
        Specified by:
        getSignature in interface SignatureOrBuilder
        Returns:
        The signature.
      • getPublicKeyId

        public String getPublicKeyId()
         The identifier for the public key that verifies this signature.
           * The `public_key_id` is required.
           * The `public_key_id` MUST be an RFC3986 conformant URI.
           * When possible, the `public_key_id` SHOULD be an immutable reference,
             such as a cryptographic digest.
         Examples of valid `public_key_id`s:
         OpenPGP V4 public key fingerprint:
           * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA"
         See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more
         details on this scheme.
         RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER
         serialization):
           * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU"
           * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
         
        string public_key_id = 2;
        Specified by:
        getPublicKeyId in interface SignatureOrBuilder
        Returns:
        The publicKeyId.
      • getPublicKeyIdBytes

        public com.google.protobuf.ByteString getPublicKeyIdBytes()
         The identifier for the public key that verifies this signature.
           * The `public_key_id` is required.
           * The `public_key_id` MUST be an RFC3986 conformant URI.
           * When possible, the `public_key_id` SHOULD be an immutable reference,
             such as a cryptographic digest.
         Examples of valid `public_key_id`s:
         OpenPGP V4 public key fingerprint:
           * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA"
         See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more
         details on this scheme.
         RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER
         serialization):
           * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU"
           * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
         
        string public_key_id = 2;
        Specified by:
        getPublicKeyIdBytes in interface SignatureOrBuilder
        Returns:
        The bytes for publicKeyId.
      • isInitialized

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

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

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

        public boolean equals​(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 Signature parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Signature parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

        public static Signature parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected Signature.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Signature getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Signature> parser()
      • getParserForType

        public com.google.protobuf.Parser<Signature> 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.GeneratedMessageV3
      • getDefaultInstanceForType

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