Package io.envoyproxy.envoy.extensions.http.header_validators.envoy_default.v3

Interface HeaderValidatorConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HeaderValidatorConfig, HeaderValidatorConfig.Builder
public interface HeaderValidatorConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasHttp1ProtocolOptions

      boolean hasHttp1ProtocolOptions()
       HTTP/1 protocol specific options.
 These settings control HTTP/1 specific validation behaviors.
      .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.Http1ProtocolOptions http1_protocol_options = 1;
      Returns:
      Whether the http1ProtocolOptions field is set.

    • getHttp1ProtocolOptions

      HeaderValidatorConfig.Http1ProtocolOptions getHttp1ProtocolOptions()
       HTTP/1 protocol specific options.
 These settings control HTTP/1 specific validation behaviors.
      .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.Http1ProtocolOptions http1_protocol_options = 1;
      Returns:
      The http1ProtocolOptions.

    • getHttp1ProtocolOptionsOrBuilder

      HeaderValidatorConfig.Http1ProtocolOptionsOrBuilder getHttp1ProtocolOptionsOrBuilder()
       HTTP/1 protocol specific options.
 These settings control HTTP/1 specific validation behaviors.
      .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.Http1ProtocolOptions http1_protocol_options = 1;

    • hasUriPathNormalizationOptions

      boolean hasUriPathNormalizationOptions()
       The URI path normalization options.

 By default Envoy normalizes URI path using the default values of the :ref:`UriPathNormalizationOptions
 <envoy_v3_api_msg_extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.UriPathNormalizationOptions>`.
 URI path transformations specified by the ``uri_path_normalization_options`` configuration can be applied to a portion
 of requests by setting the ``envoy_default_header_validator.uri_path_transformations`` runtime value.

 .. attention::

   Disabling path normalization may lead to path confusion vulnerabilities in access control or incorrect service
   selection.
      .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.UriPathNormalizationOptions uri_path_normalization_options = 2;
      Returns:
      Whether the uriPathNormalizationOptions field is set.

    • getUriPathNormalizationOptions

      HeaderValidatorConfig.UriPathNormalizationOptions getUriPathNormalizationOptions()
       The URI path normalization options.

 By default Envoy normalizes URI path using the default values of the :ref:`UriPathNormalizationOptions
 <envoy_v3_api_msg_extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.UriPathNormalizationOptions>`.
 URI path transformations specified by the ``uri_path_normalization_options`` configuration can be applied to a portion
 of requests by setting the ``envoy_default_header_validator.uri_path_transformations`` runtime value.

 .. attention::

   Disabling path normalization may lead to path confusion vulnerabilities in access control or incorrect service
   selection.
      .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.UriPathNormalizationOptions uri_path_normalization_options = 2;
      Returns:
      The uriPathNormalizationOptions.

    • getUriPathNormalizationOptionsOrBuilder

      HeaderValidatorConfig.UriPathNormalizationOptionsOrBuilder getUriPathNormalizationOptionsOrBuilder()
       The URI path normalization options.

 By default Envoy normalizes URI path using the default values of the :ref:`UriPathNormalizationOptions
 <envoy_v3_api_msg_extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.UriPathNormalizationOptions>`.
 URI path transformations specified by the ``uri_path_normalization_options`` configuration can be applied to a portion
 of requests by setting the ``envoy_default_header_validator.uri_path_transformations`` runtime value.

 .. attention::

   Disabling path normalization may lead to path confusion vulnerabilities in access control or incorrect service
   selection.
      .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.UriPathNormalizationOptions uri_path_normalization_options = 2;

    • getRestrictHttpMethods

      boolean getRestrictHttpMethods()
       Restrict HTTP methods to these defined in the `RFC 7231 section 4.1 <https://datatracker.ietf.org/doc/html/rfc7231#section-4.1>`_.

 Envoy will respond with 400 to requests with disallowed methods.
 By default methods with arbitrary names are accepted.

 This setting helps enforce HTTP compliance and can prevent attacks that rely on
 non-standard HTTP methods.
      bool restrict_http_methods = 3;
      Returns:
      The restrictHttpMethods.

    • getHeadersWithUnderscoresActionValue

      int getHeadersWithUnderscoresActionValue()
       Action to take when a client request with a header name containing underscore characters is received.

 If this setting is not specified, the value defaults to ``ALLOW``.

 This setting provides security control over headers with underscores, which can be a source
 of security issues when different systems interpret underscores and hyphens differently.
      .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.HeadersWithUnderscoresAction headers_with_underscores_action = 4;
      Returns:
      The enum numeric value on the wire for headersWithUnderscoresAction.

    • getHeadersWithUnderscoresAction

      HeaderValidatorConfig.HeadersWithUnderscoresAction getHeadersWithUnderscoresAction()
       Action to take when a client request with a header name containing underscore characters is received.

 If this setting is not specified, the value defaults to ``ALLOW``.

 This setting provides security control over headers with underscores, which can be a source
 of security issues when different systems interpret underscores and hyphens differently.
      .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.HeadersWithUnderscoresAction headers_with_underscores_action = 4;
      Returns:
      The headersWithUnderscoresAction.

    • getStripFragmentFromPath

      boolean getStripFragmentFromPath()
       Allow requests with fragment in URL path and strip the fragment before request processing.

 By default Envoy rejects requests with fragment in URL path. When this option is enabled,
 the fragment portion (everything after ``#``) will be removed from the path before
 further processing.

 Fragments are typically used by client-side applications and should not normally
 be sent to the server, so stripping them can help normalize requests.
      bool strip_fragment_from_path = 5;
      Returns:
      The stripFragmentFromPath.