quiche/balsa/http_validation_policy.h - quiche.git - Git at Google


            
            // Copyright 2022 The Chromium Authors. All rights reserved.

            
            // Use of this source code is governed by a BSD-style license that can be

            
            // found in the LICENSE file.


            #ifndef QUICHE_BALSA_HTTP_VALIDATION_POLICY_H_

            
            #define QUICHE_BALSA_HTTP_VALIDATION_POLICY_H_


            #include <cstdint>


            #include "absl/strings/str_format.h"

            
            #include "quiche/common/platform/api/quiche_export.h"


            namespace quiche {


            // An HttpValidationPolicy captures policy choices affecting parsing of HTTP

            
            // requests.  It offers individual Boolean members to be consulted during the

            
            // parsing of an HTTP request.  For historical reasons, every member is set up

            
            // such that `true` means more strict validation.

            
            //

            
            // NOTE: When modifying this struct's members, please update `AbslStringify()`

            
            // below and `ArbitraryHttpValidationPolicy()` in balsa_fuzz_util.h.

            
            struct QUICHE_EXPORT HttpValidationPolicy {

            
              // https://tools.ietf.org/html/rfc7230#section-3.2.4 deprecates "folding"

            
              // of long header lines onto continuation lines.

            
              bool disallow_header_continuation_lines = false;


              // A valid header line requires a header name and a colon.

            
              bool require_header_colon = false;


              // https://tools.ietf.org/html/rfc7230#section-3.3.2 disallows multiple

            
              // Content-Length header fields with the same value.

            
              bool disallow_multiple_content_length = false;


              // https://tools.ietf.org/html/rfc7230#section-3.3.2 disallows

            
              // Transfer-Encoding and Content-Length header fields together.

            
              bool disallow_transfer_encoding_with_content_length = false;


              // If true, signal an error if Transfer-Encoding has a value other than

            
              // "chunked" or "identity", or if there are multiple Transfer-Encoding field

            
              // lines. If false, ignore inconsistencies with Transfer-Encoding field lines,

            
              // also force `disallow_transfer_encoding_with_content_length` to false, but

            
              // still make an effort to determine whether chunked transfer encoding is

            
              // indicated.

            
              bool validate_transfer_encoding = true;


              // If true, signal a REQUIRED_BODY_BUT_NO_CONTENT_LENGTH error if a request

            
              // with a method POST or PUT, which requires a body, has neither a

            
              // "Content-Length" nor a "Transfer-Encoding: chunked" header.

            
              bool require_content_length_if_body_required = true;


              // If true, signal an INVALID_HEADER_NAME_CHARACTER or

            
              // INVALID_TRAILER_NAME_CHARACTER error if the header or trailer name contains

            
              // the character '"'.

            
              bool disallow_double_quote_in_header_name = false;


              // TODO(b/314138604): remove this field once upstream Envoy stops using it

            
              // If true, then signal an INVALID_HEADER_CHARACTER warning or error, or

            
              // neither, depending on InvalidCharsLevel, if a response header contains an

            
              // invalid character. Invalid characters are always disallowed according to

            
              // InvalidCharsLevel in request headers.

            
              bool disallow_invalid_header_characters_in_response = false;


              // If true, then signal an INVALID_HEADER_CHARACTER warning or error, or

            
              // neither, depending on InvalidCharsLevel, if a request header value contains

            
              // a carriage return that is not succeeded by a line feed.

            
              bool disallow_lone_cr_in_request_headers = false;


              // The RFC is quite specific about chunk extensions formatting, but we only

            
              // verify that there are no CR without a subsequent LF.

            
              bool disallow_lone_cr_in_chunk_extension = false;


              // If true, then requests with a target URI that is invalid will be rejected.

            
              bool disallow_invalid_target_uris = false;


              // If SANITIZE, a request-line containing tab or carriage return will have

            
              // those characters replaced with space. If REJECT, a request-line containing

            
              // tab or carriage return will be rejected.

            
              enum class FirstLineValidationOption : uint8_t {

            
                NONE,

            
                SANITIZE,

            
                REJECT,

            
                kMinValue = NONE,

            
                kMaxValue = REJECT,

            
              };

            
              FirstLineValidationOption sanitize_cr_tab_in_first_line =

            
                  FirstLineValidationOption::NONE;


              // If true, rejects messages with `obs-text` in header field names. RFC 9110

            
              // allows obs-text in header field values, but not names.

            
              bool disallow_obs_text_in_field_names = false;


              // If true, the parser rejects messages where there is a lone LF not preceded

            
              // by CR.

            
              bool disallow_lone_lf_in_chunk_extension = true;


              // If true, the parser rejects chunked messages that don't end with

            
              // CR_LF_CR_LF.

            
              bool require_chunked_body_end_with_crlf_crlf = false;


              // If SANITIZE, the parser will replace multiple consecutive spaces with

            
              // a single space in the HTTP/1 first line. If REJECT, a first line

            
              // containing multiple consecutive spaces will be rejected.

            
              FirstLineValidationOption sanitize_firstline_spaces =

            
                  FirstLineValidationOption::NONE;


              // If true, the parser will replace obs-fold in header field values with one

            
              // or more space characters.

            
              bool sanitize_obs_fold_in_header_values = false;


              // If true, disallow HTTP request methods that do not conform to RFC

            
              // 9110, Section 5.6.2.

            
              // https://datatracker.ietf.org/doc/html/rfc9110#section-5.6.2

            
              bool disallow_invalid_request_methods = false;


              template <typename Sink>

            
              friend void AbslStringify(Sink& sink, FirstLineValidationOption option) {

            
                switch (option) {

            
                  case FirstLineValidationOption::NONE:

            
                    sink.Append("NONE");

            
                    return;

            
                  case FirstLineValidationOption::SANITIZE:

            
                    sink.Append("SANITIZE");

            
                    return;

            
                  case FirstLineValidationOption::REJECT:

            
                    sink.Append("REJECT");

            
                    return;

            
                }

            
                sink.Append("UNKNOWN");

            
              }


              template <typename Sink>

            
              friend void AbslStringify(Sink& sink, const HttpValidationPolicy& policy) {

            
                absl::Format(&sink,

            
                             "{disallow_header_continuation_lines=%v, "

            
                             "require_header_colon=%v, "

            
                             "disallow_multiple_content_length=%v, "

            
                             "disallow_transfer_encoding_with_content_length=%v, "

            
                             "validate_transfer_encoding=%v, "

            
                             "require_content_length_if_body_required=%v, "

            
                             "disallow_double_quote_in_header_name=%v, "

            
                             "disallow_invalid_header_characters_in_response=%v, "

            
                             "disallow_lone_cr_in_request_headers=%v, "

            
                             "disallow_lone_cr_in_chunk_extension=%v, "

            
                             "disallow_invalid_target_uris=%v, "

            
                             "sanitize_cr_tab_in_first_line=%v, "

            
                             "disallow_obs_text_in_field_names=%v, "

            
                             "disallow_lone_lf_in_chunk_extension=%v, "

            
                             "require_chunked_body_end_with_crlf_crlf=%v, "

            
                             "sanitize_firstline_spaces=%v, "

            
                             "sanitize_obs_fold_in_header_values=%v, "

            
                             "disallow_invalid_request_methods=%v}",

            
                             policy.disallow_header_continuation_lines,

            
                             policy.require_header_colon,

            
                             policy.disallow_multiple_content_length,

            
                             policy.disallow_transfer_encoding_with_content_length,

            
                             policy.validate_transfer_encoding,

            
                             policy.require_content_length_if_body_required,

            
                             policy.disallow_double_quote_in_header_name,

            
                             policy.disallow_invalid_header_characters_in_response,

            
                             policy.disallow_lone_cr_in_request_headers,

            
                             policy.disallow_lone_cr_in_chunk_extension,

            
                             policy.disallow_invalid_target_uris,

            
                             policy.sanitize_cr_tab_in_first_line,

            
                             policy.disallow_obs_text_in_field_names,

            
                             policy.disallow_lone_lf_in_chunk_extension,

            
                             policy.require_chunked_body_end_with_crlf_crlf,

            
                             policy.sanitize_firstline_spaces,

            
                             policy.sanitize_obs_fold_in_header_values,

            
                             policy.disallow_invalid_request_methods);

            
              }

            
            };


            }  // namespace quiche


            #endif  // QUICHE_BALSA_HTTP_VALIDATION_POLICY_H_
	// Copyright 2022 The Chromium Authors. All rights reserved.
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	#ifndef QUICHE_BALSA_HTTP_VALIDATION_POLICY_H_
	#define QUICHE_BALSA_HTTP_VALIDATION_POLICY_H_

	#include <cstdint>

	#include "absl/strings/str_format.h"
	#include "quiche/common/platform/api/quiche_export.h"

	namespace quiche {

	// An HttpValidationPolicy captures policy choices affecting parsing of HTTP
	// requests. It offers individual Boolean members to be consulted during the
	// parsing of an HTTP request. For historical reasons, every member is set up
	// such that `true` means more strict validation.
	//
	// NOTE: When modifying this struct's members, please update `AbslStringify()`
	// below and `ArbitraryHttpValidationPolicy()` in balsa_fuzz_util.h.
	struct QUICHE_EXPORT HttpValidationPolicy {
	// https://tools.ietf.org/html/rfc7230#section-3.2.4 deprecates "folding"
	// of long header lines onto continuation lines.
	bool disallow_header_continuation_lines = false;

	// A valid header line requires a header name and a colon.
	bool require_header_colon = false;

	// https://tools.ietf.org/html/rfc7230#section-3.3.2 disallows multiple
	// Content-Length header fields with the same value.
	bool disallow_multiple_content_length = false;

	// https://tools.ietf.org/html/rfc7230#section-3.3.2 disallows
	// Transfer-Encoding and Content-Length header fields together.
	bool disallow_transfer_encoding_with_content_length = false;

	// If true, signal an error if Transfer-Encoding has a value other than
	// "chunked" or "identity", or if there are multiple Transfer-Encoding field
	// lines. If false, ignore inconsistencies with Transfer-Encoding field lines,
	// also force `disallow_transfer_encoding_with_content_length` to false, but
	// still make an effort to determine whether chunked transfer encoding is
	// indicated.
	bool validate_transfer_encoding = true;

	// If true, signal a REQUIRED_BODY_BUT_NO_CONTENT_LENGTH error if a request
	// with a method POST or PUT, which requires a body, has neither a
	// "Content-Length" nor a "Transfer-Encoding: chunked" header.
	bool require_content_length_if_body_required = true;

	// If true, signal an INVALID_HEADER_NAME_CHARACTER or
	// INVALID_TRAILER_NAME_CHARACTER error if the header or trailer name contains
	// the character '"'.
	bool disallow_double_quote_in_header_name = false;

	// TODO(b/314138604): remove this field once upstream Envoy stops using it
	// If true, then signal an INVALID_HEADER_CHARACTER warning or error, or
	// neither, depending on InvalidCharsLevel, if a response header contains an
	// invalid character. Invalid characters are always disallowed according to
	// InvalidCharsLevel in request headers.
	bool disallow_invalid_header_characters_in_response = false;

	// If true, then signal an INVALID_HEADER_CHARACTER warning or error, or
	// neither, depending on InvalidCharsLevel, if a request header value contains
	// a carriage return that is not succeeded by a line feed.
	bool disallow_lone_cr_in_request_headers = false;

	// The RFC is quite specific about chunk extensions formatting, but we only
	// verify that there are no CR without a subsequent LF.
	bool disallow_lone_cr_in_chunk_extension = false;

	// If true, then requests with a target URI that is invalid will be rejected.
	bool disallow_invalid_target_uris = false;

	// If SANITIZE, a request-line containing tab or carriage return will have
	// those characters replaced with space. If REJECT, a request-line containing
	// tab or carriage return will be rejected.
	enum class FirstLineValidationOption : uint8_t {
	NONE,
	SANITIZE,
	REJECT,
	kMinValue = NONE,
	kMaxValue = REJECT,
	};
	FirstLineValidationOption sanitize_cr_tab_in_first_line =
	FirstLineValidationOption::NONE;

	// If true, rejects messages with `obs-text` in header field names. RFC 9110
	// allows obs-text in header field values, but not names.
	bool disallow_obs_text_in_field_names = false;

	// If true, the parser rejects messages where there is a lone LF not preceded
	// by CR.
	bool disallow_lone_lf_in_chunk_extension = true;

	// If true, the parser rejects chunked messages that don't end with
	// CR_LF_CR_LF.
	bool require_chunked_body_end_with_crlf_crlf = false;

	// If SANITIZE, the parser will replace multiple consecutive spaces with
	// a single space in the HTTP/1 first line. If REJECT, a first line
	// containing multiple consecutive spaces will be rejected.
	FirstLineValidationOption sanitize_firstline_spaces =
	FirstLineValidationOption::NONE;

	// If true, the parser will replace obs-fold in header field values with one
	// or more space characters.
	bool sanitize_obs_fold_in_header_values = false;

	// If true, disallow HTTP request methods that do not conform to RFC
	// 9110, Section 5.6.2.
	// https://datatracker.ietf.org/doc/html/rfc9110#section-5.6.2
	bool disallow_invalid_request_methods = false;

	template <typename Sink>
	friend void AbslStringify(Sink& sink, FirstLineValidationOption option) {
	switch (option) {
	case FirstLineValidationOption::NONE:
	sink.Append("NONE");
	return;
	case FirstLineValidationOption::SANITIZE:
	sink.Append("SANITIZE");
	return;
	case FirstLineValidationOption::REJECT:
	sink.Append("REJECT");
	return;
	}
	sink.Append("UNKNOWN");
	}

	template <typename Sink>
	friend void AbslStringify(Sink& sink, const HttpValidationPolicy& policy) {
	absl::Format(&sink,
	"{disallow_header_continuation_lines=%v, "
	"require_header_colon=%v, "
	"disallow_multiple_content_length=%v, "
	"disallow_transfer_encoding_with_content_length=%v, "
	"validate_transfer_encoding=%v, "
	"require_content_length_if_body_required=%v, "
	"disallow_double_quote_in_header_name=%v, "
	"disallow_invalid_header_characters_in_response=%v, "
	"disallow_lone_cr_in_request_headers=%v, "
	"disallow_lone_cr_in_chunk_extension=%v, "
	"disallow_invalid_target_uris=%v, "
	"sanitize_cr_tab_in_first_line=%v, "
	"disallow_obs_text_in_field_names=%v, "
	"disallow_lone_lf_in_chunk_extension=%v, "
	"require_chunked_body_end_with_crlf_crlf=%v, "
	"sanitize_firstline_spaces=%v, "
	"sanitize_obs_fold_in_header_values=%v, "
	"disallow_invalid_request_methods=%v}",
	policy.disallow_header_continuation_lines,
	policy.require_header_colon,
	policy.disallow_multiple_content_length,
	policy.disallow_transfer_encoding_with_content_length,
	policy.validate_transfer_encoding,
	policy.require_content_length_if_body_required,
	policy.disallow_double_quote_in_header_name,
	policy.disallow_invalid_header_characters_in_response,
	policy.disallow_lone_cr_in_request_headers,
	policy.disallow_lone_cr_in_chunk_extension,
	policy.disallow_invalid_target_uris,
	policy.sanitize_cr_tab_in_first_line,
	policy.disallow_obs_text_in_field_names,
	policy.disallow_lone_lf_in_chunk_extension,
	policy.require_chunked_body_end_with_crlf_crlf,
	policy.sanitize_firstline_spaces,
	policy.sanitize_obs_fold_in_header_values,
	policy.disallow_invalid_request_methods);
	}
	};

	} // namespace quiche

	#endif // QUICHE_BALSA_HTTP_VALIDATION_POLICY_H_