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

Class ProxyProtocol

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ProxyProtocolOrBuilder, Serializable
public final class ProxyProtocol extends com.google.protobuf.GeneratedMessageV3 implements ProxyProtocolOrBuilder
 [#next-free-field: 7]
Protobuf type envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol
See Also:

  • Field Details

    • RULES_FIELD_NUMBER

      public static final int RULES_FIELD_NUMBER
      See Also:

    • ALLOW_REQUESTS_WITHOUT_PROXY_PROTOCOL_FIELD_NUMBER

      public static final int ALLOW_REQUESTS_WITHOUT_PROXY_PROTOCOL_FIELD_NUMBER
      See Also:

    • PASS_THROUGH_TLVS_FIELD_NUMBER

      public static final int PASS_THROUGH_TLVS_FIELD_NUMBER
      See Also:

    • DISALLOWED_VERSIONS_FIELD_NUMBER

      public static final int DISALLOWED_VERSIONS_FIELD_NUMBER
      See Also:

    • STAT_PREFIX_FIELD_NUMBER

      public static final int STAT_PREFIX_FIELD_NUMBER
      See Also:

    • TLV_LOCATION_FIELD_NUMBER

      public static final int TLV_LOCATION_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

    • getRulesList

      public List<ProxyProtocol.Rule> getRulesList()
       The list of rules to apply to requests.
      repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;
      Specified by:
      getRulesList in interface ProxyProtocolOrBuilder

    • getRulesOrBuilderList

      public List<? extends ProxyProtocol.RuleOrBuilder> getRulesOrBuilderList()
       The list of rules to apply to requests.
      repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;
      Specified by:
      getRulesOrBuilderList in interface ProxyProtocolOrBuilder

    • getRulesCount

      public int getRulesCount()
       The list of rules to apply to requests.
      repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;
      Specified by:
      getRulesCount in interface ProxyProtocolOrBuilder

    • getRules

      public ProxyProtocol.Rule getRules(int index)
       The list of rules to apply to requests.
      repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;
      Specified by:
      getRules in interface ProxyProtocolOrBuilder

    • getRulesOrBuilder

      public ProxyProtocol.RuleOrBuilder getRulesOrBuilder(int index)
       The list of rules to apply to requests.
      repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;
      Specified by:
      getRulesOrBuilder in interface ProxyProtocolOrBuilder

    • getAllowRequestsWithoutProxyProtocol

      public boolean getAllowRequestsWithoutProxyProtocol()
       Allow requests through that don't use proxy protocol. Defaults to false.

 .. attention::

   This breaks conformance with the specification.
   Only enable if ALL traffic to the listener comes from a trusted source.
   For more information on the security implications of this feature, see
   https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt

 .. attention::

   Requests of 12 or fewer bytes that match the proxy protocol v2 signature
   and requests of 6 or fewer bytes that match the proxy protocol v1
   signature will timeout (Envoy is unable to differentiate these requests
   from incomplete proxy protocol requests).
      bool allow_requests_without_proxy_protocol = 2;
      Specified by:
      getAllowRequestsWithoutProxyProtocol in interface ProxyProtocolOrBuilder
      Returns:
      The allowRequestsWithoutProxyProtocol.

    • hasPassThroughTlvs

      public boolean hasPassThroughTlvs()
       This config controls which TLVs can be passed to filter state if it is Proxy Protocol
 V2 header. If there is no setting for this field, no TLVs will be passed through.

 .. note::

   If this is configured, you likely also want to set
   :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>`,
   which controls pass-through for the upstream.
      .envoy.config.core.v3.ProxyProtocolPassThroughTLVs pass_through_tlvs = 3;
      Specified by:
      hasPassThroughTlvs in interface ProxyProtocolOrBuilder
      Returns:
      Whether the passThroughTlvs field is set.

    • getPassThroughTlvs

      public ProxyProtocolPassThroughTLVs getPassThroughTlvs()
       This config controls which TLVs can be passed to filter state if it is Proxy Protocol
 V2 header. If there is no setting for this field, no TLVs will be passed through.

 .. note::

   If this is configured, you likely also want to set
   :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>`,
   which controls pass-through for the upstream.
      .envoy.config.core.v3.ProxyProtocolPassThroughTLVs pass_through_tlvs = 3;
      Specified by:
      getPassThroughTlvs in interface ProxyProtocolOrBuilder
      Returns:
      The passThroughTlvs.

    • getPassThroughTlvsOrBuilder

      public ProxyProtocolPassThroughTLVsOrBuilder getPassThroughTlvsOrBuilder()
       This config controls which TLVs can be passed to filter state if it is Proxy Protocol
 V2 header. If there is no setting for this field, no TLVs will be passed through.

 .. note::

   If this is configured, you likely also want to set
   :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>`,
   which controls pass-through for the upstream.
      .envoy.config.core.v3.ProxyProtocolPassThroughTLVs pass_through_tlvs = 3;
      Specified by:
      getPassThroughTlvsOrBuilder in interface ProxyProtocolOrBuilder

    • getDisallowedVersionsList

      public List<ProxyProtocolConfig.Version> getDisallowedVersionsList()
       The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter.

 When the filter receives PROXY protocol data that is disallowed, it will reject the connection.
 By default, the filter will match all PROXY protocol versions.
 See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details.

 .. attention::

   When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`,
   the filter will not attempt to match signatures for the disallowed versions.
   For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``,
   and an incoming request matches the V2 signature, the filter will allow the request through without any modification.
   The filter treats this request as if it did not have any PROXY protocol information.
      repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;
      Specified by:
      getDisallowedVersionsList in interface ProxyProtocolOrBuilder
      Returns:
      A list containing the disallowedVersions.

    • getDisallowedVersionsCount

      public int getDisallowedVersionsCount()
       The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter.

 When the filter receives PROXY protocol data that is disallowed, it will reject the connection.
 By default, the filter will match all PROXY protocol versions.
 See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details.

 .. attention::

   When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`,
   the filter will not attempt to match signatures for the disallowed versions.
   For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``,
   and an incoming request matches the V2 signature, the filter will allow the request through without any modification.
   The filter treats this request as if it did not have any PROXY protocol information.
      repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;
      Specified by:
      getDisallowedVersionsCount in interface ProxyProtocolOrBuilder
      Returns:
      The count of disallowedVersions.

    • getDisallowedVersions

      public ProxyProtocolConfig.Version getDisallowedVersions(int index)
       The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter.

 When the filter receives PROXY protocol data that is disallowed, it will reject the connection.
 By default, the filter will match all PROXY protocol versions.
 See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details.

 .. attention::

   When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`,
   the filter will not attempt to match signatures for the disallowed versions.
   For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``,
   and an incoming request matches the V2 signature, the filter will allow the request through without any modification.
   The filter treats this request as if it did not have any PROXY protocol information.
      repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;
      Specified by:
      getDisallowedVersions in interface ProxyProtocolOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The disallowedVersions at the given index.

    • getDisallowedVersionsValueList

      public List<Integer> getDisallowedVersionsValueList()
       The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter.

 When the filter receives PROXY protocol data that is disallowed, it will reject the connection.
 By default, the filter will match all PROXY protocol versions.
 See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details.

 .. attention::

   When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`,
   the filter will not attempt to match signatures for the disallowed versions.
   For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``,
   and an incoming request matches the V2 signature, the filter will allow the request through without any modification.
   The filter treats this request as if it did not have any PROXY protocol information.
      repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;
      Specified by:
      getDisallowedVersionsValueList in interface ProxyProtocolOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for disallowedVersions.

    • getDisallowedVersionsValue

      public int getDisallowedVersionsValue(int index)
       The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter.

 When the filter receives PROXY protocol data that is disallowed, it will reject the connection.
 By default, the filter will match all PROXY protocol versions.
 See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details.

 .. attention::

   When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`,
   the filter will not attempt to match signatures for the disallowed versions.
   For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``,
   and an incoming request matches the V2 signature, the filter will allow the request through without any modification.
   The filter treats this request as if it did not have any PROXY protocol information.
      repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;
      Specified by:
      getDisallowedVersionsValue in interface ProxyProtocolOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of disallowedVersions at the given index.

    • getStatPrefix

      public String getStatPrefix()
       The human readable prefix to use when emitting statistics for the filter.
 If not configured, statistics will be emitted without the prefix segment.
 See the :ref:`filter's statistics documentation <config_listener_filters_proxy_protocol>` for
 more information.
      string stat_prefix = 5;
      Specified by:
      getStatPrefix in interface ProxyProtocolOrBuilder
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      public com.google.protobuf.ByteString getStatPrefixBytes()
       The human readable prefix to use when emitting statistics for the filter.
 If not configured, statistics will be emitted without the prefix segment.
 See the :ref:`filter's statistics documentation <config_listener_filters_proxy_protocol>` for
 more information.
      string stat_prefix = 5;
      Specified by:
      getStatPrefixBytes in interface ProxyProtocolOrBuilder
      Returns:
      The bytes for statPrefix.

    • getTlvLocationValue

      public int getTlvLocationValue()
       Controls where TLV values are stored when rules match. Defaults to DYNAMIC_METADATA.
      .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.TlvLocation tlv_location = 6;
      Specified by:
      getTlvLocationValue in interface ProxyProtocolOrBuilder
      Returns:
      The enum numeric value on the wire for tlvLocation.

    • getTlvLocation

      public ProxyProtocol.TlvLocation getTlvLocation()
       Controls where TLV values are stored when rules match. Defaults to DYNAMIC_METADATA.
      .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.TlvLocation tlv_location = 6;
      Specified by:
      getTlvLocation in interface ProxyProtocolOrBuilder
      Returns:
      The tlvLocation.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ProxyProtocol.Builder newBuilder()

    • newBuilder

      public static ProxyProtocol.Builder newBuilder(ProxyProtocol prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ProxyProtocol getDefaultInstance()

    • parser

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

    • getParserForType

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