Package io.envoyproxy.envoy.extensions.filters.network.tcp_proxy.v3

Class TcpProxy.TunnelingConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.TunnelingConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TcpProxy.TunnelingConfigOrBuilder, Serializable
Enclosing class:
TcpProxy
public static final class TcpProxy.TunnelingConfig extends com.google.protobuf.GeneratedMessageV3 implements TcpProxy.TunnelingConfigOrBuilder
 Configuration for tunneling TCP over other transports or application layers.
 Tunneling is supported over HTTP/1.1 and HTTP/2. The upstream protocol is
 determined by the cluster configuration.
 [#next-free-field: 10]
Protobuf type envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.TunnelingConfig
See Also:

  • Field Details

    • HOSTNAME_FIELD_NUMBER

      public static final int HOSTNAME_FIELD_NUMBER
      See Also:

    • USE_POST_FIELD_NUMBER

      public static final int USE_POST_FIELD_NUMBER
      See Also:

    • HEADERS_TO_ADD_FIELD_NUMBER

      public static final int HEADERS_TO_ADD_FIELD_NUMBER
      See Also:

    • PROPAGATE_RESPONSE_HEADERS_FIELD_NUMBER

      public static final int PROPAGATE_RESPONSE_HEADERS_FIELD_NUMBER
      See Also:

    • POST_PATH_FIELD_NUMBER

      public static final int POST_PATH_FIELD_NUMBER
      See Also:

    • PROPAGATE_RESPONSE_TRAILERS_FIELD_NUMBER

      public static final int PROPAGATE_RESPONSE_TRAILERS_FIELD_NUMBER
      See Also:

    • REQUEST_ID_EXTENSION_FIELD_NUMBER

      public static final int REQUEST_ID_EXTENSION_FIELD_NUMBER
      See Also:

    • REQUEST_ID_HEADER_FIELD_NUMBER

      public static final int REQUEST_ID_HEADER_FIELD_NUMBER
      See Also:

    • REQUEST_ID_METADATA_KEY_FIELD_NUMBER

      public static final int REQUEST_ID_METADATA_KEY_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getHostname

      public String getHostname()
       The hostname to send in the synthesized CONNECT headers to the upstream proxy.
 This field evaluates command operators if present; otherwise, the value is used as-is.

 For example, dynamically set the hostname using downstream SNI:

 .. code-block:: yaml

    tunneling_config:
      hostname: "%REQUESTED_SERVER_NAME%:443"

 For example, dynamically set the hostname using dynamic metadata:

 .. code-block:: yaml

    tunneling_config:
      hostname: "%DYNAMIC_METADATA(tunnel:address)%"
      string hostname = 1 [(.validate.rules) = { ... }
      Specified by:
      getHostname in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The hostname.

    • getHostnameBytes

      public com.google.protobuf.ByteString getHostnameBytes()
       The hostname to send in the synthesized CONNECT headers to the upstream proxy.
 This field evaluates command operators if present; otherwise, the value is used as-is.

 For example, dynamically set the hostname using downstream SNI:

 .. code-block:: yaml

    tunneling_config:
      hostname: "%REQUESTED_SERVER_NAME%:443"

 For example, dynamically set the hostname using dynamic metadata:

 .. code-block:: yaml

    tunneling_config:
      hostname: "%DYNAMIC_METADATA(tunnel:address)%"
      string hostname = 1 [(.validate.rules) = { ... }
      Specified by:
      getHostnameBytes in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The bytes for hostname.

    • getUsePost

      public boolean getUsePost()
       Use the ``POST`` method instead of the ``CONNECT`` method to tunnel the TCP stream.
 The ``protocol: bytestream`` header is not set for HTTP/2 to comply with the specification.

 The upstream proxy is expected to interpret the POST payload as raw TCP.
      bool use_post = 2;
      Specified by:
      getUsePost in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The usePost.

    • getHeadersToAddList

      public List<HeaderValueOption> getHeadersToAddList()
       Additional request headers to send to the upstream proxy. This is mainly used to
 trigger the upstream to convert POST requests back to CONNECT requests.

 Neither ``:``-prefixed pseudo-headers like ``:path`` nor the ``host`` header can be overridden.
      repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 3 [(.validate.rules) = { ... }
      Specified by:
      getHeadersToAddList in interface TcpProxy.TunnelingConfigOrBuilder

    • getHeadersToAddOrBuilderList

      public List<? extends HeaderValueOptionOrBuilder> getHeadersToAddOrBuilderList()
       Additional request headers to send to the upstream proxy. This is mainly used to
 trigger the upstream to convert POST requests back to CONNECT requests.

 Neither ``:``-prefixed pseudo-headers like ``:path`` nor the ``host`` header can be overridden.
      repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 3 [(.validate.rules) = { ... }
      Specified by:
      getHeadersToAddOrBuilderList in interface TcpProxy.TunnelingConfigOrBuilder

    • getHeadersToAddCount

      public int getHeadersToAddCount()
       Additional request headers to send to the upstream proxy. This is mainly used to
 trigger the upstream to convert POST requests back to CONNECT requests.

 Neither ``:``-prefixed pseudo-headers like ``:path`` nor the ``host`` header can be overridden.
      repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 3 [(.validate.rules) = { ... }
      Specified by:
      getHeadersToAddCount in interface TcpProxy.TunnelingConfigOrBuilder

    • getHeadersToAdd

      public HeaderValueOption getHeadersToAdd(int index)
       Additional request headers to send to the upstream proxy. This is mainly used to
 trigger the upstream to convert POST requests back to CONNECT requests.

 Neither ``:``-prefixed pseudo-headers like ``:path`` nor the ``host`` header can be overridden.
      repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 3 [(.validate.rules) = { ... }
      Specified by:
      getHeadersToAdd in interface TcpProxy.TunnelingConfigOrBuilder

    • getHeadersToAddOrBuilder

      public HeaderValueOptionOrBuilder getHeadersToAddOrBuilder(int index)
       Additional request headers to send to the upstream proxy. This is mainly used to
 trigger the upstream to convert POST requests back to CONNECT requests.

 Neither ``:``-prefixed pseudo-headers like ``:path`` nor the ``host`` header can be overridden.
      repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 3 [(.validate.rules) = { ... }
      Specified by:
      getHeadersToAddOrBuilder in interface TcpProxy.TunnelingConfigOrBuilder

    • getPropagateResponseHeaders

      public boolean getPropagateResponseHeaders()
       Save response headers to the downstream connection's filter state for consumption
 by network filters. The filter state key is ``envoy.tcp_proxy.propagate_response_headers``.
      bool propagate_response_headers = 4;
      Specified by:
      getPropagateResponseHeaders in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The propagateResponseHeaders.

    • getPostPath

      public String getPostPath()
       The path used with the POST method. The default path is ``/``. If this field is specified and
 :ref:`use_post field <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TunnelingConfig.use_post>`
 is not set to true, the configuration will be rejected.
      string post_path = 5;
      Specified by:
      getPostPath in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The postPath.

    • getPostPathBytes

      public com.google.protobuf.ByteString getPostPathBytes()
       The path used with the POST method. The default path is ``/``. If this field is specified and
 :ref:`use_post field <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TunnelingConfig.use_post>`
 is not set to true, the configuration will be rejected.
      string post_path = 5;
      Specified by:
      getPostPathBytes in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The bytes for postPath.

    • getPropagateResponseTrailers

      public boolean getPropagateResponseTrailers()
       Save response trailers to the downstream connection's filter state for consumption
 by network filters. The filter state key is ``envoy.tcp_proxy.propagate_response_trailers``.
      bool propagate_response_trailers = 6;
      Specified by:
      getPropagateResponseTrailers in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The propagateResponseTrailers.

    • hasRequestIdExtension

      public boolean hasRequestIdExtension()
       The configuration of the request ID extension used for generation, validation, and
 associated tracing operations when tunneling.

 If this field is set, a request ID is generated using the specified extension. If
 this field is not set, no request ID is generated.

 When a request ID is generated, it is also stored in the downstream connection's
 dynamic metadata under the namespace ``envoy.filters.network.tcp_proxy`` with the key
 ``tunnel_request_id`` to allow emission from TCP proxy access logs via the
 ``%DYNAMIC_METADATA(envoy.filters.network.tcp_proxy:tunnel_request_id)%`` formatter.
 [#extension-category: envoy.request_id]
      .envoy.extensions.filters.network.http_connection_manager.v3.RequestIDExtension request_id_extension = 7;
      Specified by:
      hasRequestIdExtension in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      Whether the requestIdExtension field is set.

    • getRequestIdExtension

      public RequestIDExtension getRequestIdExtension()
       The configuration of the request ID extension used for generation, validation, and
 associated tracing operations when tunneling.

 If this field is set, a request ID is generated using the specified extension. If
 this field is not set, no request ID is generated.

 When a request ID is generated, it is also stored in the downstream connection's
 dynamic metadata under the namespace ``envoy.filters.network.tcp_proxy`` with the key
 ``tunnel_request_id`` to allow emission from TCP proxy access logs via the
 ``%DYNAMIC_METADATA(envoy.filters.network.tcp_proxy:tunnel_request_id)%`` formatter.
 [#extension-category: envoy.request_id]
      .envoy.extensions.filters.network.http_connection_manager.v3.RequestIDExtension request_id_extension = 7;
      Specified by:
      getRequestIdExtension in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The requestIdExtension.

    • getRequestIdExtensionOrBuilder

      public RequestIDExtensionOrBuilder getRequestIdExtensionOrBuilder()
       The configuration of the request ID extension used for generation, validation, and
 associated tracing operations when tunneling.

 If this field is set, a request ID is generated using the specified extension. If
 this field is not set, no request ID is generated.

 When a request ID is generated, it is also stored in the downstream connection's
 dynamic metadata under the namespace ``envoy.filters.network.tcp_proxy`` with the key
 ``tunnel_request_id`` to allow emission from TCP proxy access logs via the
 ``%DYNAMIC_METADATA(envoy.filters.network.tcp_proxy:tunnel_request_id)%`` formatter.
 [#extension-category: envoy.request_id]
      .envoy.extensions.filters.network.http_connection_manager.v3.RequestIDExtension request_id_extension = 7;
      Specified by:
      getRequestIdExtensionOrBuilder in interface TcpProxy.TunnelingConfigOrBuilder

    • getRequestIdHeader

      public String getRequestIdHeader()
       The request header name to use for emitting the generated request ID on the tunneling
 HTTP request.

 If not specified or set to an empty string, the default header name ``x-request-id`` is
 used.

 .. note::
   This setting does not alter the internal request ID handling elsewhere in Envoy and
   only controls the header emitted on the tunneling request.
      string request_id_header = 8;
      Specified by:
      getRequestIdHeader in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The requestIdHeader.

    • getRequestIdHeaderBytes

      public com.google.protobuf.ByteString getRequestIdHeaderBytes()
       The request header name to use for emitting the generated request ID on the tunneling
 HTTP request.

 If not specified or set to an empty string, the default header name ``x-request-id`` is
 used.

 .. note::
   This setting does not alter the internal request ID handling elsewhere in Envoy and
   only controls the header emitted on the tunneling request.
      string request_id_header = 8;
      Specified by:
      getRequestIdHeaderBytes in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The bytes for requestIdHeader.

    • getRequestIdMetadataKey

      public String getRequestIdMetadataKey()
       The dynamic metadata key to use when storing the generated request ID. The metadata is
 stored under the namespace ``envoy.filters.network.tcp_proxy``.

 If not specified or set to an empty string, the default key ``tunnel_request_id`` is used.
 This enables customizing the key used by access log formatters such as
 ``%DYNAMIC_METADATA(envoy.filters.network.tcp_proxy:<key>)%``.
      string request_id_metadata_key = 9;
      Specified by:
      getRequestIdMetadataKey in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The requestIdMetadataKey.

    • getRequestIdMetadataKeyBytes

      public com.google.protobuf.ByteString getRequestIdMetadataKeyBytes()
       The dynamic metadata key to use when storing the generated request ID. The metadata is
 stored under the namespace ``envoy.filters.network.tcp_proxy``.

 If not specified or set to an empty string, the default key ``tunnel_request_id`` is used.
 This enables customizing the key used by access log formatters such as
 ``%DYNAMIC_METADATA(envoy.filters.network.tcp_proxy:<key>)%``.
      string request_id_metadata_key = 9;
      Specified by:
      getRequestIdMetadataKeyBytes in interface TcpProxy.TunnelingConfigOrBuilder
      Returns:
      The bytes for requestIdMetadataKey.

    • 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 TcpProxy.TunnelingConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static TcpProxy.TunnelingConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static TcpProxy.TunnelingConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TcpProxy.TunnelingConfig.Builder newBuilder()

    • newBuilder

      public static TcpProxy.TunnelingConfig.Builder newBuilder(TcpProxy.TunnelingConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected TcpProxy.TunnelingConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static TcpProxy.TunnelingConfig getDefaultInstance()

    • parser

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

    • getParserForType

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