Package io.envoyproxy.envoy.extensions.filters.listener.tls_inspector.v3

Class TlsInspector.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>
io.envoyproxy.envoy.extensions.filters.listener.tls_inspector.v3.TlsInspector.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TlsInspectorOrBuilder, Cloneable
Enclosing class:
TlsInspector
public static final class TlsInspector.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder> implements TlsInspectorOrBuilder
 [#next-free-field: 6]
Protobuf type envoy.extensions.filters.listener.tls_inspector.v3.TlsInspector

  • Method Details

    • 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.Builder<TlsInspector.Builder>

    • clear

      public TlsInspector.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>

    • getDefaultInstanceForType

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

    • build

      public TlsInspector build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public TlsInspector buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public TlsInspector.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>

    • setField

      public TlsInspector.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>

    • clearField

      public TlsInspector.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>

    • clearOneof

      public TlsInspector.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>

    • setRepeatedField

      public TlsInspector.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>

    • addRepeatedField

      public TlsInspector.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>

    • mergeFrom

      public TlsInspector.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TlsInspector.Builder>

    • mergeFrom

      public TlsInspector.Builder mergeFrom(TlsInspector other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>

    • mergeFrom

      public TlsInspector.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TlsInspector.Builder>
      Throws:
      IOException

    • hasEnableJa3Fingerprinting

      public boolean hasEnableJa3Fingerprinting()
       Populate ``JA3`` fingerprint hash using data from the TLS Client Hello packet. Default is false.
      .google.protobuf.BoolValue enable_ja3_fingerprinting = 1;
      Specified by:
      hasEnableJa3Fingerprinting in interface TlsInspectorOrBuilder
      Returns:
      Whether the enableJa3Fingerprinting field is set.

    • getEnableJa3Fingerprinting

      public com.google.protobuf.BoolValue getEnableJa3Fingerprinting()
       Populate ``JA3`` fingerprint hash using data from the TLS Client Hello packet. Default is false.
      .google.protobuf.BoolValue enable_ja3_fingerprinting = 1;
      Specified by:
      getEnableJa3Fingerprinting in interface TlsInspectorOrBuilder
      Returns:
      The enableJa3Fingerprinting.

    • setEnableJa3Fingerprinting

      public TlsInspector.Builder setEnableJa3Fingerprinting(com.google.protobuf.BoolValue value)
       Populate ``JA3`` fingerprint hash using data from the TLS Client Hello packet. Default is false.
      .google.protobuf.BoolValue enable_ja3_fingerprinting = 1;

    • setEnableJa3Fingerprinting

      public TlsInspector.Builder setEnableJa3Fingerprinting(com.google.protobuf.BoolValue.Builder builderForValue)
       Populate ``JA3`` fingerprint hash using data from the TLS Client Hello packet. Default is false.
      .google.protobuf.BoolValue enable_ja3_fingerprinting = 1;

    • mergeEnableJa3Fingerprinting

      public TlsInspector.Builder mergeEnableJa3Fingerprinting(com.google.protobuf.BoolValue value)
       Populate ``JA3`` fingerprint hash using data from the TLS Client Hello packet. Default is false.
      .google.protobuf.BoolValue enable_ja3_fingerprinting = 1;

    • clearEnableJa3Fingerprinting

      public TlsInspector.Builder clearEnableJa3Fingerprinting()
       Populate ``JA3`` fingerprint hash using data from the TLS Client Hello packet. Default is false.
      .google.protobuf.BoolValue enable_ja3_fingerprinting = 1;

    • getEnableJa3FingerprintingBuilder

      public com.google.protobuf.BoolValue.Builder getEnableJa3FingerprintingBuilder()
       Populate ``JA3`` fingerprint hash using data from the TLS Client Hello packet. Default is false.
      .google.protobuf.BoolValue enable_ja3_fingerprinting = 1;

    • getEnableJa3FingerprintingOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getEnableJa3FingerprintingOrBuilder()
       Populate ``JA3`` fingerprint hash using data from the TLS Client Hello packet. Default is false.
      .google.protobuf.BoolValue enable_ja3_fingerprinting = 1;
      Specified by:
      getEnableJa3FingerprintingOrBuilder in interface TlsInspectorOrBuilder

    • hasEnableJa4Fingerprinting

      public boolean hasEnableJa4Fingerprinting()
       Populate ``JA4`` fingerprint hash using data from the TLS Client Hello packet.
 ``JA4`` is an improved version of ``JA3`` that includes TLS version, ciphers, extensions,
 and ALPN information in a hex format. Default is false.
      .google.protobuf.BoolValue enable_ja4_fingerprinting = 3;
      Specified by:
      hasEnableJa4Fingerprinting in interface TlsInspectorOrBuilder
      Returns:
      Whether the enableJa4Fingerprinting field is set.

    • getEnableJa4Fingerprinting

      public com.google.protobuf.BoolValue getEnableJa4Fingerprinting()
       Populate ``JA4`` fingerprint hash using data from the TLS Client Hello packet.
 ``JA4`` is an improved version of ``JA3`` that includes TLS version, ciphers, extensions,
 and ALPN information in a hex format. Default is false.
      .google.protobuf.BoolValue enable_ja4_fingerprinting = 3;
      Specified by:
      getEnableJa4Fingerprinting in interface TlsInspectorOrBuilder
      Returns:
      The enableJa4Fingerprinting.

    • setEnableJa4Fingerprinting

      public TlsInspector.Builder setEnableJa4Fingerprinting(com.google.protobuf.BoolValue value)
       Populate ``JA4`` fingerprint hash using data from the TLS Client Hello packet.
 ``JA4`` is an improved version of ``JA3`` that includes TLS version, ciphers, extensions,
 and ALPN information in a hex format. Default is false.
      .google.protobuf.BoolValue enable_ja4_fingerprinting = 3;

    • setEnableJa4Fingerprinting

      public TlsInspector.Builder setEnableJa4Fingerprinting(com.google.protobuf.BoolValue.Builder builderForValue)
       Populate ``JA4`` fingerprint hash using data from the TLS Client Hello packet.
 ``JA4`` is an improved version of ``JA3`` that includes TLS version, ciphers, extensions,
 and ALPN information in a hex format. Default is false.
      .google.protobuf.BoolValue enable_ja4_fingerprinting = 3;

    • mergeEnableJa4Fingerprinting

      public TlsInspector.Builder mergeEnableJa4Fingerprinting(com.google.protobuf.BoolValue value)
       Populate ``JA4`` fingerprint hash using data from the TLS Client Hello packet.
 ``JA4`` is an improved version of ``JA3`` that includes TLS version, ciphers, extensions,
 and ALPN information in a hex format. Default is false.
      .google.protobuf.BoolValue enable_ja4_fingerprinting = 3;

    • clearEnableJa4Fingerprinting

      public TlsInspector.Builder clearEnableJa4Fingerprinting()
       Populate ``JA4`` fingerprint hash using data from the TLS Client Hello packet.
 ``JA4`` is an improved version of ``JA3`` that includes TLS version, ciphers, extensions,
 and ALPN information in a hex format. Default is false.
      .google.protobuf.BoolValue enable_ja4_fingerprinting = 3;

    • getEnableJa4FingerprintingBuilder

      public com.google.protobuf.BoolValue.Builder getEnableJa4FingerprintingBuilder()
       Populate ``JA4`` fingerprint hash using data from the TLS Client Hello packet.
 ``JA4`` is an improved version of ``JA3`` that includes TLS version, ciphers, extensions,
 and ALPN information in a hex format. Default is false.
      .google.protobuf.BoolValue enable_ja4_fingerprinting = 3;

    • getEnableJa4FingerprintingOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getEnableJa4FingerprintingOrBuilder()
       Populate ``JA4`` fingerprint hash using data from the TLS Client Hello packet.
 ``JA4`` is an improved version of ``JA3`` that includes TLS version, ciphers, extensions,
 and ALPN information in a hex format. Default is false.
      .google.protobuf.BoolValue enable_ja4_fingerprinting = 3;
      Specified by:
      getEnableJa4FingerprintingOrBuilder in interface TlsInspectorOrBuilder

    • hasInitialReadBufferSize

      public boolean hasInitialReadBufferSize()
       The size in bytes of the initial buffer requested by the tls_inspector.
 If the filter needs to read additional bytes from the socket, the
 filter will double the buffer up to it's default maximum of 16KiB.
 If this size is not defined, defaults to maximum 16KiB that the
 tls inspector will consume.
      .google.protobuf.UInt32Value initial_read_buffer_size = 2 [(.validate.rules) = { ... }
      Specified by:
      hasInitialReadBufferSize in interface TlsInspectorOrBuilder
      Returns:
      Whether the initialReadBufferSize field is set.

    • getInitialReadBufferSize

      public com.google.protobuf.UInt32Value getInitialReadBufferSize()
       The size in bytes of the initial buffer requested by the tls_inspector.
 If the filter needs to read additional bytes from the socket, the
 filter will double the buffer up to it's default maximum of 16KiB.
 If this size is not defined, defaults to maximum 16KiB that the
 tls inspector will consume.
      .google.protobuf.UInt32Value initial_read_buffer_size = 2 [(.validate.rules) = { ... }
      Specified by:
      getInitialReadBufferSize in interface TlsInspectorOrBuilder
      Returns:
      The initialReadBufferSize.

    • setInitialReadBufferSize

      public TlsInspector.Builder setInitialReadBufferSize(com.google.protobuf.UInt32Value value)
       The size in bytes of the initial buffer requested by the tls_inspector.
 If the filter needs to read additional bytes from the socket, the
 filter will double the buffer up to it's default maximum of 16KiB.
 If this size is not defined, defaults to maximum 16KiB that the
 tls inspector will consume.
      .google.protobuf.UInt32Value initial_read_buffer_size = 2 [(.validate.rules) = { ... }

    • setInitialReadBufferSize

      public TlsInspector.Builder setInitialReadBufferSize(com.google.protobuf.UInt32Value.Builder builderForValue)
       The size in bytes of the initial buffer requested by the tls_inspector.
 If the filter needs to read additional bytes from the socket, the
 filter will double the buffer up to it's default maximum of 16KiB.
 If this size is not defined, defaults to maximum 16KiB that the
 tls inspector will consume.
      .google.protobuf.UInt32Value initial_read_buffer_size = 2 [(.validate.rules) = { ... }

    • mergeInitialReadBufferSize

      public TlsInspector.Builder mergeInitialReadBufferSize(com.google.protobuf.UInt32Value value)
       The size in bytes of the initial buffer requested by the tls_inspector.
 If the filter needs to read additional bytes from the socket, the
 filter will double the buffer up to it's default maximum of 16KiB.
 If this size is not defined, defaults to maximum 16KiB that the
 tls inspector will consume.
      .google.protobuf.UInt32Value initial_read_buffer_size = 2 [(.validate.rules) = { ... }

    • clearInitialReadBufferSize

      public TlsInspector.Builder clearInitialReadBufferSize()
       The size in bytes of the initial buffer requested by the tls_inspector.
 If the filter needs to read additional bytes from the socket, the
 filter will double the buffer up to it's default maximum of 16KiB.
 If this size is not defined, defaults to maximum 16KiB that the
 tls inspector will consume.
      .google.protobuf.UInt32Value initial_read_buffer_size = 2 [(.validate.rules) = { ... }

    • getInitialReadBufferSizeBuilder

      public com.google.protobuf.UInt32Value.Builder getInitialReadBufferSizeBuilder()
       The size in bytes of the initial buffer requested by the tls_inspector.
 If the filter needs to read additional bytes from the socket, the
 filter will double the buffer up to it's default maximum of 16KiB.
 If this size is not defined, defaults to maximum 16KiB that the
 tls inspector will consume.
      .google.protobuf.UInt32Value initial_read_buffer_size = 2 [(.validate.rules) = { ... }

    • getInitialReadBufferSizeOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getInitialReadBufferSizeOrBuilder()
       The size in bytes of the initial buffer requested by the tls_inspector.
 If the filter needs to read additional bytes from the socket, the
 filter will double the buffer up to it's default maximum of 16KiB.
 If this size is not defined, defaults to maximum 16KiB that the
 tls inspector will consume.
      .google.protobuf.UInt32Value initial_read_buffer_size = 2 [(.validate.rules) = { ... }
      Specified by:
      getInitialReadBufferSizeOrBuilder in interface TlsInspectorOrBuilder

    • getCloseConnectionOnClientHelloParsingErrors

      public boolean getCloseConnectionOnClientHelloParsingErrors()
       Close connection when TLS ClientHello message could not be parsed.
 This flag should be enabled only if it is known that incoming connections are expected to use
 TLS protocol, as Envoy does not distinguish between a plain text message or a malformed TLS
 ClientHello message.
 By default this flag is false and TLS ClientHello parsing errors are interpreted as a
 plain text connection.
 Setting this to true will cause connections to be terminated and the ``client_hello_too_large``
 counter to be incremented if the ClientHello message is over implementation defined limit
 (currently 16Kb).
      bool close_connection_on_client_hello_parsing_errors = 4;
      Specified by:
      getCloseConnectionOnClientHelloParsingErrors in interface TlsInspectorOrBuilder
      Returns:
      The closeConnectionOnClientHelloParsingErrors.

    • setCloseConnectionOnClientHelloParsingErrors

      public TlsInspector.Builder setCloseConnectionOnClientHelloParsingErrors(boolean value)
       Close connection when TLS ClientHello message could not be parsed.
 This flag should be enabled only if it is known that incoming connections are expected to use
 TLS protocol, as Envoy does not distinguish between a plain text message or a malformed TLS
 ClientHello message.
 By default this flag is false and TLS ClientHello parsing errors are interpreted as a
 plain text connection.
 Setting this to true will cause connections to be terminated and the ``client_hello_too_large``
 counter to be incremented if the ClientHello message is over implementation defined limit
 (currently 16Kb).
      bool close_connection_on_client_hello_parsing_errors = 4;
      Parameters:
      value - The closeConnectionOnClientHelloParsingErrors to set.
      Returns:
      This builder for chaining.

    • clearCloseConnectionOnClientHelloParsingErrors

      public TlsInspector.Builder clearCloseConnectionOnClientHelloParsingErrors()
       Close connection when TLS ClientHello message could not be parsed.
 This flag should be enabled only if it is known that incoming connections are expected to use
 TLS protocol, as Envoy does not distinguish between a plain text message or a malformed TLS
 ClientHello message.
 By default this flag is false and TLS ClientHello parsing errors are interpreted as a
 plain text connection.
 Setting this to true will cause connections to be terminated and the ``client_hello_too_large``
 counter to be incremented if the ClientHello message is over implementation defined limit
 (currently 16Kb).
      bool close_connection_on_client_hello_parsing_errors = 4;
      Returns:
      This builder for chaining.

    • hasMaxClientHelloSize

      public boolean hasMaxClientHelloSize()
       The maximum size in bytes of the ClientHello that the tls_inspector will
 process. If the ClientHello is larger than this size, the tls_inspector
 will stop processing and indicate failure. If not defined, defaults to
 16KiB.
      .google.protobuf.UInt32Value max_client_hello_size = 5 [(.validate.rules) = { ... }
      Specified by:
      hasMaxClientHelloSize in interface TlsInspectorOrBuilder
      Returns:
      Whether the maxClientHelloSize field is set.

    • getMaxClientHelloSize

      public com.google.protobuf.UInt32Value getMaxClientHelloSize()
       The maximum size in bytes of the ClientHello that the tls_inspector will
 process. If the ClientHello is larger than this size, the tls_inspector
 will stop processing and indicate failure. If not defined, defaults to
 16KiB.
      .google.protobuf.UInt32Value max_client_hello_size = 5 [(.validate.rules) = { ... }
      Specified by:
      getMaxClientHelloSize in interface TlsInspectorOrBuilder
      Returns:
      The maxClientHelloSize.

    • setMaxClientHelloSize

      public TlsInspector.Builder setMaxClientHelloSize(com.google.protobuf.UInt32Value value)
       The maximum size in bytes of the ClientHello that the tls_inspector will
 process. If the ClientHello is larger than this size, the tls_inspector
 will stop processing and indicate failure. If not defined, defaults to
 16KiB.
      .google.protobuf.UInt32Value max_client_hello_size = 5 [(.validate.rules) = { ... }

    • setMaxClientHelloSize

      public TlsInspector.Builder setMaxClientHelloSize(com.google.protobuf.UInt32Value.Builder builderForValue)
       The maximum size in bytes of the ClientHello that the tls_inspector will
 process. If the ClientHello is larger than this size, the tls_inspector
 will stop processing and indicate failure. If not defined, defaults to
 16KiB.
      .google.protobuf.UInt32Value max_client_hello_size = 5 [(.validate.rules) = { ... }

    • mergeMaxClientHelloSize

      public TlsInspector.Builder mergeMaxClientHelloSize(com.google.protobuf.UInt32Value value)
       The maximum size in bytes of the ClientHello that the tls_inspector will
 process. If the ClientHello is larger than this size, the tls_inspector
 will stop processing and indicate failure. If not defined, defaults to
 16KiB.
      .google.protobuf.UInt32Value max_client_hello_size = 5 [(.validate.rules) = { ... }

    • clearMaxClientHelloSize

      public TlsInspector.Builder clearMaxClientHelloSize()
       The maximum size in bytes of the ClientHello that the tls_inspector will
 process. If the ClientHello is larger than this size, the tls_inspector
 will stop processing and indicate failure. If not defined, defaults to
 16KiB.
      .google.protobuf.UInt32Value max_client_hello_size = 5 [(.validate.rules) = { ... }

    • getMaxClientHelloSizeBuilder

      public com.google.protobuf.UInt32Value.Builder getMaxClientHelloSizeBuilder()
       The maximum size in bytes of the ClientHello that the tls_inspector will
 process. If the ClientHello is larger than this size, the tls_inspector
 will stop processing and indicate failure. If not defined, defaults to
 16KiB.
      .google.protobuf.UInt32Value max_client_hello_size = 5 [(.validate.rules) = { ... }

    • getMaxClientHelloSizeOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getMaxClientHelloSizeOrBuilder()
       The maximum size in bytes of the ClientHello that the tls_inspector will
 process. If the ClientHello is larger than this size, the tls_inspector
 will stop processing and indicate failure. If not defined, defaults to
 16KiB.
      .google.protobuf.UInt32Value max_client_hello_size = 5 [(.validate.rules) = { ... }
      Specified by:
      getMaxClientHelloSizeOrBuilder in interface TlsInspectorOrBuilder

    • setUnknownFields

      public final TlsInspector.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>

    • mergeUnknownFields

      public final TlsInspector.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TlsInspector.Builder>