+/*
+ * Copyright (C) 1996-2018 The Squid Software Foundation and contributors
+ *
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
+ */
+
#ifndef SQUID_HTTP_REGISTEREDHEADERS_H
#define SQUID_HTTP_REGISTEREDHEADERS_H
+#include "base/LookupTable.h"
+
+#include <iosfwd>
+#include <vector>
+
+namespace Http
+{
/// recognized or "known" header fields; and the RFC which defines them (or not)
-typedef enum {
- HDR_BAD_HDR = -1,
- HDR_ACCEPT = 0, /**< RFC 2608, 2616 */
- HDR_ACCEPT_CHARSET, /**< RFC 2608, 2616 */
- HDR_ACCEPT_ENCODING, /**< RFC 2608, 2616 */
- /*HDR_ACCEPT_FEATURES,*/ /* experimental RFC 2295 */
- HDR_ACCEPT_LANGUAGE, /**< RFC 2608, 2616 */
- HDR_ACCEPT_RANGES, /**< RFC 2608, 2616 */
- HDR_AGE, /**< RFC 2608, 2616 */
- HDR_ALLOW, /**< RFC 2608, 2616 */
- /*HDR_ALTERNATES,*/ /* deprecated RFC 2068, 2295 */
- HDR_AUTHORIZATION, /**< RFC 2608, 2616, 4559 */
- HDR_CACHE_CONTROL, /**< RFC 2608, 2616 */
- HDR_CONNECTION, /**< RFC 2608, 2616 */
- HDR_CONTENT_BASE, /**< RFC 2608 */
- HDR_CONTENT_DISPOSITION, /**< RFC 2183, 2616 */
- HDR_CONTENT_ENCODING, /**< RFC 2608, 2616 */
- HDR_CONTENT_LANGUAGE, /**< RFC 2608, 2616 */
- HDR_CONTENT_LENGTH, /**< RFC 2608, 2616 */
- HDR_CONTENT_LOCATION, /**< RFC 2608, 2616 */
- HDR_CONTENT_MD5, /**< RFC 2608, 2616 */
- HDR_CONTENT_RANGE, /**< RFC 2608, 2616 */
- HDR_CONTENT_TYPE, /**< RFC 2608, 2616 */
- /*HDR_CONTENT_VERSION,*/ /* deprecated RFC 2608 header. */
- HDR_COOKIE, /**< de-facto and RFC 2965 header we may need to erase */
- HDR_COOKIE2, /**< obsolete RFC 2965 header we may need to erase */
- HDR_DATE, /**< RFC 2608, 2616 */
- /*HDR_DAV,*/ /* RFC 2518 */
- /*HDR_DEPTH,*/ /* RFC 2518 */
- /*HDR_DERIVED_FROM,*/ /* deprecated RFC 2608 */
- /*HDR_DESTINATION,*/ /* RFC 2518 */
- HDR_ETAG, /**< RFC 2608, 2616 */
- HDR_EXPECT, /**< RFC 2608, 2616 */
- HDR_EXPIRES, /**< RFC 2608, 2616 */
- HDR_FROM, /**< RFC 2608, 2616 */
- HDR_HOST, /**< RFC 2608, 2616 */
- HDR_HTTP2_SETTINGS, /**< HTTP/2.0 upgrade header. see draft-ietf-httpbis-http2-04 */
- /*HDR_IF,*/ /* RFC 2518 */
- HDR_IF_MATCH, /**< RFC 2608, 2616 */
- HDR_IF_MODIFIED_SINCE, /**< RFC 2608, 2616 */
- HDR_IF_NONE_MATCH, /**< RFC 2608, 2616 */
- HDR_IF_RANGE, /**< RFC 2608, 2616 */
- /*HDR_IF_UNMODIFIED_SINCE,*/ /* RFC 2608, 2616 */
- HDR_KEEP_ALIVE, /**< obsolete HTTP/1.0 header we may need to erase */
- HDR_KEY, /**< experimental RFC Draft draft-fielding-http-key-02 */
- HDR_LAST_MODIFIED, /**< RFC 2608, 2616 */
- HDR_LINK, /**< RFC 2068 */
- HDR_LOCATION, /**< RFC 2608, 2616 */
- /*HDR_LOCK_TOKEN,*/ /* RFC 2518 */
- HDR_MAX_FORWARDS, /**< RFC 2608, 2616 */
- HDR_MIME_VERSION, /**< RFC 2626 */
- HDR_NEGOTIATE, /**< experimental RFC 2295. Why only this one from 2295? */
- /*HDR_OVERWRITE,*/ /* RFC 2518 */
- HDR_ORIGIN, /* CORS Draft specification (see http://www.w3.org/TR/cors/) */
- HDR_PRAGMA, /**< deprecated RFC 2068,2616 header we may need to erase */
- HDR_PROXY_AUTHENTICATE, /**< RFC 2608, 2616, 2617 */
- HDR_PROXY_AUTHENTICATION_INFO, /**< RFC 2617 */
- HDR_PROXY_AUTHORIZATION, /**< RFC 2608, 2616, 2617 */
- HDR_PROXY_CONNECTION, /**< obsolete Netscape header we may need to erase. */
- HDR_PROXY_SUPPORT, /**< RFC 4559 */
- HDR_PUBLIC, /**< RFC 2608 */
- HDR_RANGE, /**< RFC 2608, 2616 */
- HDR_REFERER, /**< RFC 2608, 2616 */
- HDR_REQUEST_RANGE, /**< some clients use this, sigh */
- HDR_RETRY_AFTER, /**< RFC 2608, 2616 */
- HDR_SERVER, /**< RFC 2608, 2616 */
- HDR_SET_COOKIE, /**< de-facto standard header we may need to erase */
- HDR_SET_COOKIE2, /**< obsolete RFC 2965 header we may need to erase */
- /*HDR_STATUS_URI,*/ /* RFC 2518 */
- /*HDR_TCN,*/ /* experimental RFC 2295 */
- HDR_TE, /**< RFC 2616 */
- /*HDR_TIMEOUT,*/ /* RFC 2518 */
- HDR_TITLE, /**< obsolete draft suggested header */
- HDR_TRAILER, /**< RFC 2616 */
- HDR_TRANSFER_ENCODING, /**< RFC 2608, 2616 */
- HDR_TRANSLATE, /**< IIS custom header we may need to erase */
- HDR_UNLESS_MODIFIED_SINCE, /**< IIS custom header we may need to erase */
- HDR_UPGRADE, /**< RFC 2608, 2616 */
- /*HDR_URI,*/ /* obsolete RFC 2068 header */
- HDR_USER_AGENT, /**< RFC 2608, 2616 */
- /*HDR_VARIANT_VARY,*/ /* experimental RFC 2295 */
- HDR_VARY, /**< RFC 2608, 2616 */
- HDR_VIA, /**< RFC 2608, 2616 */
- HDR_WARNING, /**< RFC 2608, 2616 */
- HDR_WWW_AUTHENTICATE, /**< RFC 2608, 2616, 2617, 4559 */
- HDR_AUTHENTICATION_INFO, /**< RFC 2617 */
- HDR_X_CACHE, /**< Squid custom header */
- HDR_X_CACHE_LOOKUP, /**< Squid custom header. temporary hack that became de-facto. TODO remove */
- HDR_X_FORWARDED_FOR, /**< Squid custom header */
- HDR_X_REQUEST_URI, /**< Squid custom header appended if ADD_X_REQUEST_URI is defined */
- HDR_X_SQUID_ERROR, /**< Squid custom header on generated error responses */
-#if X_ACCELERATOR_VARY
+/// http://www.iana.org/assignments/message-headers/message-headers.xhtml
+enum HdrType {
+ enumBegin_ = 0, // service value for WholeEnum iteration
+ ACCEPT = enumBegin_, /**< RFC 7231 */ /* MUST BE FIRST */
+ ACCEPT_CHARSET, /**< RFC 7231 */
+ ACCEPT_ENCODING, /**< RFC 7231 */
+ /*ACCEPT_FEATURES,*/ /* RFC 2295 */
+ ACCEPT_LANGUAGE, /**< RFC 7231 */
+ ACCEPT_RANGES, /**< RFC 7233 */
+ AGE, /**< RFC 7234 */
+ ALLOW, /**< RFC 7231 */
+ ALTERNATE_PROTOCOL, /**< GFE custom header we may have to erase */
+ AUTHENTICATION_INFO, /**< RFC 2617 */
+ AUTHORIZATION, /**< RFC 7235, 4559 */
+ CACHE_CONTROL, /**< RFC 7234 */
+ CONNECTION, /**< RFC 7230 */
+ CONTENT_BASE, /**< obsoleted RFC 2068 */
+ CONTENT_DISPOSITION, /**< RFC 2183, 6266 */
+ CONTENT_ENCODING, /**< RFC 7231 */
+ CONTENT_LANGUAGE, /**< RFC 7231 */
+ CONTENT_LENGTH, /**< RFC 7230 */
+ CONTENT_LOCATION, /**< RFC 7231 */
+ CONTENT_MD5, /**< deprecated, RFC 2616 */
+ CONTENT_RANGE, /**< RFC 7233 */
+ CONTENT_TYPE, /**< RFC 7231 */
+ COOKIE, /**< RFC 6265 header we may need to erase */
+ COOKIE2, /**< obsolete RFC 2965 header we may need to erase */
+ DATE, /**< RFC 7231 */
+ /*DAV,*/ /* RFC 2518 */
+ /*DEPTH,*/ /* RFC 2518 */
+ /*DERIVED_FROM,*/ /* deprecated RFC 2068 */
+ /*DESTINATION,*/ /* RFC 2518 */
+ ETAG, /**< RFC 7232 */
+ EXPECT, /**< RFC 7231 */
+ EXPIRES, /**< RFC 7234 */
+ FORWARDED, /**< RFC 7239 */
+ FROM, /**< RFC 7231 */
+ HOST, /**< RFC 7230 */
+ HTTP2_SETTINGS, /**< RFC 7540 */
+ /*IF,*/ /* RFC 2518 */
+ IF_MATCH, /**< RFC 7232 */
+ IF_MODIFIED_SINCE, /**< RFC 7232 */
+ IF_NONE_MATCH, /**< RFC 7232 */
+ IF_RANGE, /**< RFC 7233 */
+ IF_UNMODIFIED_SINCE, /**< RFC 7232 */
+ KEEP_ALIVE, /**< obsoleted RFC 2068 header we may need to erase */
+ KEY, /**< experimental RFC Draft draft-fielding-http-key-02 */
+ LAST_MODIFIED, /**< RFC 7232 */
+ LINK, /**< RFC 5988 */
+ LOCATION, /**< RFC 7231 */
+ /*LOCK_TOKEN,*/ /* RFC 2518 */
+ MAX_FORWARDS, /**< RFC 7231 */
+ MIME_VERSION, /**< RFC 2045, 7231 */
+ NEGOTIATE, /**< experimental RFC 2295. Why only this one from 2295? */
+ /*OVERWRITE,*/ /* RFC 2518 */
+ ORIGIN, /* CORS Draft specification (see http://www.w3.org/TR/cors/) */
+ PRAGMA, /**< RFC 7234 */
+ PROXY_AUTHENTICATE, /**< RFC 7235 */
+ PROXY_AUTHENTICATION_INFO, /**< RFC 2617 */
+ PROXY_AUTHORIZATION, /**< RFC 7235 */
+ PROXY_CONNECTION, /**< obsolete Netscape header we may need to erase. */
+ PROXY_SUPPORT, /**< RFC 4559 */
+ PUBLIC, /**< RFC 2068 */
+ RANGE, /**< RFC 7233 */
+ REFERER, /**< RFC 7231 */
+ REQUEST_RANGE, /**< some clients use this, sigh */
+ RETRY_AFTER, /**< RFC 7231 */
+ SERVER, /**< RFC 7231 */
+ SET_COOKIE, /**< RFC 6265 header we may need to erase */
+ SET_COOKIE2, /**< obsoleted RFC 2965 header we may need to erase */
+ /*STATUS_URI,*/ /* RFC 2518 */
+ /*TCN,*/ /* experimental RFC 2295 */
+ TE, /**< RFC 7230 */
+ /*TIMEOUT,*/ /* RFC 2518 */
+ TITLE, /* obsolete draft suggested header */
+ TRAILER, /**< RFC 7230 */
+ TRANSFER_ENCODING, /**< RFC 7230 */
+ TRANSLATE, /**< IIS custom header we may need to erase */
+ UNLESS_MODIFIED_SINCE, /**< IIS custom header we may need to erase */
+ UPGRADE, /**< RFC 7230 */
+ USER_AGENT, /**< RFC 7231 */
+ /*VARIANT_VARY,*/ /* experimental RFC 2295 */
+ VARY, /**< RFC 7231 */
+ VIA, /**< RFC 7230 */
+ WARNING, /**< RFC 7234 */
+ WWW_AUTHENTICATE, /**< RFC 7235, 4559 */
+ X_CACHE, /**< Squid custom header */
+ X_CACHE_LOOKUP, /**< Squid custom header. temporary hack that became de-facto. TODO remove */
+ X_FORWARDED_FOR, /**< obsolete Squid custom header, RFC 7239 */
+ X_REQUEST_URI, /**< Squid custom header appended if ADD_X_REQUEST_URI is defined */
+ X_SQUID_ERROR, /**< Squid custom header on generated error responses */
HDR_X_ACCELERATOR_VARY, /**< obsolete Squid custom header. */
-#endif
-#if USE_ADAPTATION
- HDR_X_NEXT_SERVICES, /**< Squid custom ICAP header */
-#endif
- HDR_SURROGATE_CAPABILITY, /**< Edge Side Includes (ESI) header */
- HDR_SURROGATE_CONTROL, /**< Edge Side Includes (ESI) header */
- HDR_FRONT_END_HTTPS, /**< MS Exchange custom header we may have to add */
- HDR_OTHER, /**< internal tag value for "unknown" headers */
- HDR_ENUM_END
-} http_hdr_type;
+ X_NEXT_SERVICES, /**< Squid custom ICAP header */
+ SURROGATE_CAPABILITY, /**< Edge Side Includes (ESI) header */
+ SURROGATE_CONTROL, /**< Edge Side Includes (ESI) header */
+ FRONT_END_HTTPS, /**< MS Exchange custom header we may have to add */
+ FTP_COMMAND, /**< Internal header for FTP command */
+ FTP_ARGUMENTS, /**< Internal header for FTP command arguments */
+ FTP_PRE, /**< Internal header containing leading FTP control response lines */
+ FTP_STATUS, /**< Internal header for FTP reply status */
+ FTP_REASON, /**< Internal header for FTP reply reason */
+ OTHER, /**< internal tag value for "unknown" headers */
+ BAD_HDR, /**< Invalid header */
+ enumEnd_ // internal tag for end-of-headers
+};
+
+/** possible types for http header fields */
+enum class HdrFieldType {
+ ftInvalid, /**< to catch nasty errors with hdr_id<->fld_type clashes */
+ ftInt,
+ ftInt64,
+ ftStr,
+ ftDate_1123,
+ ftETag,
+ ftPCc,
+ ftPContRange,
+ ftPRange,
+ ftPSc,
+ ftDate_1123_or_ETag
+};
+
+enum HdrKind {
+ None = 0,
+ ListHeader = 1,
+ RequestHeader = 1 << 1,
+ ReplyHeader = 1 << 2,
+ HopByHopHeader = 1 << 3,
+ Denied304Header = 1 << 4, //see comment in HttpReply.cc for meaning
+ GeneralHeader = RequestHeader | ReplyHeader,
+ EntityHeader = RequestHeader | ReplyHeader
+};
+
+/* POD for HeaderTable */
+class HeaderTableRecord {
+public:
+ HeaderTableRecord();
+ HeaderTableRecord(const char *n);
+ HeaderTableRecord(const char *, Http::HdrType, Http::HdrFieldType, int /* HdrKind */);
+
+public:
+ const char *name;
+ Http::HdrType id;
+ Http::HdrFieldType type;
+ // flags set by constructor from HdrKind parameter
+ bool list; ///<header with field values defined as #(values) in HTTP/1.1
+ bool request; ///<header is a request header
+ bool reply; ///<header is a reply header
+ bool hopbyhop; ///<header is hop by hop
+ bool denied304; ///<header is not to be updated on receiving a 304 in cache revalidation (see HttpReply.cc)
+};
+
+/** Class for looking up registered header definitions
+ *
+ * Look up HeaderTableRecord's by name or registered header ID.
+ *
+ * Actual records are defined in file RegisteredHeadersHash.gperf, which is
+ * compiled using gperf to RegisteredHeadersHash.cci which is then included
+ * in RegisteredHeaders.cc.
+ */
+class HeaderLookupTable_t {
+public:
+ HeaderLookupTable_t();
+ /// look record type up by name (C-string and length)
+ const HeaderTableRecord& lookup (const char *buf, const std::size_t len) const;
+ /// look record type up by name (std::string)
+ const HeaderTableRecord& lookup (const std::string &key) const {
+ return lookup(key.data(), key.length());
+ }
+ /// look record type up by name (SBuf)
+ const HeaderTableRecord& lookup (const SBuf &key) const {
+ return lookup(key.rawContent(), key.length());
+ }
+ /// look record type up by header ID
+ const HeaderTableRecord& lookup (Http::HdrType id) const {
+ return *(idCache[static_cast<int>(id)]);
+ }
+
+private:
+ void initCache();
+ std::vector<const HeaderTableRecord *> idCache;
+ static const HeaderTableRecord BadHdr; ///<used to signal "not found" from lookups
+};
+extern const HeaderLookupTable_t HeaderLookupTable;
+
+/// match any known header type, including OTHER and BAD
+inline bool
+any_HdrType_enum_value (const Http::HdrType id)
+{
+ return (id >= Http::HdrType::enumBegin_ && id < Http::HdrType::enumEnd_);
+}
+
+/// match any valid header type, including OTHER but not BAD
+inline bool
+any_valid_header (const Http::HdrType id)
+{
+ return (id >= Http::HdrType::ACCEPT && id < Http::HdrType::BAD_HDR);
+}
+
+/// match any registered header type (headers squid knows how to handle),
+/// thus excluding OTHER and BAD
+inline bool
+any_registered_header (const Http::HdrType id)
+{
+ return (id >= Http::HdrType::ACCEPT && id < Http::HdrType::OTHER);
+}
+
+}; /* namespace Http */
+
+/* ostream output for Http::HdrType */
+std::ostream &
+operator<< (std::ostream&, Http::HdrType);
#endif /* SQUID_HTTP_REGISTEREDHEADERS_H */
+
projects / thirdparty / squid.git / blobdiff