Enum HttpProtocolOptions.HeadersWithUnderscoresAction

java.lang.Object
java.lang.Enum<HttpProtocolOptions.HeadersWithUnderscoresAction>
io.envoyproxy.envoy.config.core.v3.HttpProtocolOptions.HeadersWithUnderscoresAction
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<HttpProtocolOptions.HeadersWithUnderscoresAction>
Enclosing class:
HttpProtocolOptions

public static enum HttpProtocolOptions.HeadersWithUnderscoresAction extends Enum<HttpProtocolOptions.HeadersWithUnderscoresAction> implements com.google.protobuf.ProtocolMessageEnum
 Action to take when Envoy receives client request with header names containing underscore
 characters.
 Underscore character is allowed in header names by the RFC-7230 and this behavior is implemented
 as a security measure due to systems that treat '_' and '-' as interchangeable. Envoy by default allows client request headers with underscore
 characters.
 
Protobuf enum envoy.config.core.v3.HttpProtocolOptions.HeadersWithUnderscoresAction
  • Enum Constant Details

    • ALLOW

       Allow headers with underscores. This is the default behavior.
       
      ALLOW = 0;
    • REJECT_REQUEST

      public static final HttpProtocolOptions.HeadersWithUnderscoresAction REJECT_REQUEST
       Reject client request. HTTP/1 requests are rejected with the 400 status. HTTP/2 requests
       end with the stream reset. The "httpN.requests_rejected_with_underscores_in_headers" counter
       is incremented for each rejected request.
       
      REJECT_REQUEST = 1;
    • DROP_HEADER

      public static final HttpProtocolOptions.HeadersWithUnderscoresAction DROP_HEADER
       Drop the client header with name containing underscores. The header is dropped before the filter chain is
       invoked and as such filters will not see dropped headers. The
       "httpN.dropped_headers_with_underscores" is incremented for each dropped header.
       
      DROP_HEADER = 2;
    • UNRECOGNIZED

      public static final HttpProtocolOptions.HeadersWithUnderscoresAction UNRECOGNIZED
  • Field Details

    • ALLOW_VALUE

      public static final int ALLOW_VALUE
       Allow headers with underscores. This is the default behavior.
       
      ALLOW = 0;
      See Also:
    • REJECT_REQUEST_VALUE

      public static final int REJECT_REQUEST_VALUE
       Reject client request. HTTP/1 requests are rejected with the 400 status. HTTP/2 requests
       end with the stream reset. The "httpN.requests_rejected_with_underscores_in_headers" counter
       is incremented for each rejected request.
       
      REJECT_REQUEST = 1;
      See Also:
    • DROP_HEADER_VALUE

      public static final int DROP_HEADER_VALUE
       Drop the client header with name containing underscores. The header is dropped before the filter chain is
       invoked and as such filters will not see dropped headers. The
       "httpN.dropped_headers_with_underscores" is incremented for each dropped header.
       
      DROP_HEADER = 2;
      See Also:
    • internalValueMap

      private static final com.google.protobuf.Internal.EnumLiteMap<HttpProtocolOptions.HeadersWithUnderscoresAction> internalValueMap
    • VALUES

      private static final HttpProtocolOptions.HeadersWithUnderscoresAction[] VALUES
    • value

      private final int value
  • Constructor Details

    • HeadersWithUnderscoresAction

      private HeadersWithUnderscoresAction(int value)
  • Method Details

    • values

      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum
    • valueOf

      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • forNumber

      public static HttpProtocolOptions.HeadersWithUnderscoresAction forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.
    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<HttpProtocolOptions.HeadersWithUnderscoresAction> internalGetValueMap()
    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum
    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum
    • getDescriptor

      public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
    • valueOf

      public static HttpProtocolOptions.HeadersWithUnderscoresAction valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null