Package io.envoyproxy.envoy.extensions.transport_sockets.tls.v3

Class SubjectAltNameMatcher

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SubjectAltNameMatcherOrBuilder, Serializable
@Generated public final class SubjectAltNameMatcher extends com.google.protobuf.GeneratedMessage implements SubjectAltNameMatcherOrBuilder
 Matcher for subject alternative names, to match both type and value of the SAN.
Protobuf type envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SubjectAltNameMatcher.Builder
    Matcher for subject alternative names, to match both type and value of the SAN.
    static enum 
    SubjectAltNameMatcher.SanType
    Indicates the choice of GeneralName as defined in section 4.2.1.5 of RFC 5280 to match against.

    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>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MATCHER_FIELD_NUMBER
     
    static final int
    OID_FIELD_NUMBER
     
    static final int
    SAN_TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static SubjectAltNameMatcher
    getDefaultInstance()
     
    SubjectAltNameMatcher
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    StringMatcher
    getMatcher()
    Matcher for SAN value.
    StringMatcherOrBuilder
    getMatcherOrBuilder()
    Matcher for SAN value.
    String
    getOid()
    OID Value which is required if OTHER_NAME SAN type is used.
    com.google.protobuf.ByteString
    getOidBytes()
    OID Value which is required if OTHER_NAME SAN type is used.
    com.google.protobuf.Parser<SubjectAltNameMatcher>
    getParserForType()
     
    SubjectAltNameMatcher.SanType
    getSanType()
    Specification of type of SAN.
    int
    getSanTypeValue()
    Specification of type of SAN.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasMatcher()
    Matcher for SAN value.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SubjectAltNameMatcher.Builder
    newBuilder()
     
    static SubjectAltNameMatcher.Builder
    newBuilder(SubjectAltNameMatcher prototype)
     
    SubjectAltNameMatcher.Builder
    newBuilderForType()
     
    protected SubjectAltNameMatcher.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SubjectAltNameMatcher
    parseDelimitedFrom(InputStream input)
     
    static SubjectAltNameMatcher
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SubjectAltNameMatcher
    parseFrom(byte[] data)
     
    static SubjectAltNameMatcher
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SubjectAltNameMatcher
    parseFrom(com.google.protobuf.ByteString data)
     
    static SubjectAltNameMatcher
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SubjectAltNameMatcher
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SubjectAltNameMatcher
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SubjectAltNameMatcher
    parseFrom(InputStream input)
     
    static SubjectAltNameMatcher
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SubjectAltNameMatcher
    parseFrom(ByteBuffer data)
     
    static SubjectAltNameMatcher
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SubjectAltNameMatcher>
    parser()
     
    SubjectAltNameMatcher.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getSanTypeValue

      public int getSanTypeValue()
       Specification of type of SAN. Note that the default enum value is an invalid choice.
      .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher.SanType san_type = 1 [(.validate.rules) = { ... }
      Specified by:
      getSanTypeValue in interface SubjectAltNameMatcherOrBuilder
      Returns:
      The enum numeric value on the wire for sanType.

    • getSanType

      public SubjectAltNameMatcher.SanType getSanType()
       Specification of type of SAN. Note that the default enum value is an invalid choice.
      .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher.SanType san_type = 1 [(.validate.rules) = { ... }
      Specified by:
      getSanType in interface SubjectAltNameMatcherOrBuilder
      Returns:
      The sanType.

    • hasMatcher

      public boolean hasMatcher()
       Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
      .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }
      Specified by:
      hasMatcher in interface SubjectAltNameMatcherOrBuilder
      Returns:
      Whether the matcher field is set.

    • getMatcher

      public StringMatcher getMatcher()
       Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
      .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }
      Specified by:
      getMatcher in interface SubjectAltNameMatcherOrBuilder
      Returns:
      The matcher.

    • getMatcherOrBuilder

      public StringMatcherOrBuilder getMatcherOrBuilder()
       Matcher for SAN value.

 The string matching for OTHER_NAME SAN values depends on their ASN.1 type:

 * OBJECT: Validated against its dotted numeric notation (e.g., "1.2.3.4")
 * BOOLEAN: Validated against strings "true" or "false"
 * INTEGER/ENUMERATED: Validated against a string containing the integer value
 * NULL: Validated against an empty string
 * Other types: Validated directly against the string value
      .envoy.type.matcher.v3.StringMatcher matcher = 2 [(.validate.rules) = { ... }
      Specified by:
      getMatcherOrBuilder in interface SubjectAltNameMatcherOrBuilder

    • getOid

      public String getOid()
       OID Value which is required if OTHER_NAME SAN type is used.
 For example, UPN OID is 1.3.6.1.4.1.311.20.2.3
 (Reference: http://oid-info.com/get/1.3.6.1.4.1.311.20.2.3).

 If set for SAN types other than OTHER_NAME, it will be ignored.
      string oid = 3;
      Specified by:
      getOid in interface SubjectAltNameMatcherOrBuilder
      Returns:
      The oid.

    • getOidBytes

      public com.google.protobuf.ByteString getOidBytes()
       OID Value which is required if OTHER_NAME SAN type is used.
 For example, UPN OID is 1.3.6.1.4.1.311.20.2.3
 (Reference: http://oid-info.com/get/1.3.6.1.4.1.311.20.2.3).

 If set for SAN types other than OTHER_NAME, it will be ignored.
      string oid = 3;
      Specified by:
      getOidBytes in interface SubjectAltNameMatcherOrBuilder
      Returns:
      The bytes for oid.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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 SubjectAltNameMatcher parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SubjectAltNameMatcher parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SubjectAltNameMatcher parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SubjectAltNameMatcher parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SubjectAltNameMatcher parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SubjectAltNameMatcher parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SubjectAltNameMatcher parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static SubjectAltNameMatcher.Builder newBuilder()

    • newBuilder

      public static SubjectAltNameMatcher.Builder newBuilder(SubjectAltNameMatcher prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SubjectAltNameMatcher getDefaultInstance()

    • parser

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

    • getParserForType

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