src/HttpHeader.h

   1 /*
   2  * Copyright (C) 1996-2020 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 #ifndef SQUID_HTTPHEADER_H
  10 #define SQUID_HTTPHEADER_H
  11
  12 #include "anyp/ProtocolVersion.h"
  13 #include "base/LookupTable.h"
  14 #include "http/RegisteredHeaders.h"
  15 /* because we pass a spec by value */
  16 #include "HttpHeaderMask.h"
  17 #include "mem/PoolingAllocator.h"
  18 #include "sbuf/forward.h"
  19 #include "SquidString.h"
  20
  21 #include <vector>
  22
  23 /* class forward declarations */
  24 class HttpHdrCc;
  25 class HttpHdrContRange;
  26 class HttpHdrRange;
  27 class HttpHdrSc;
  28 class Packable;
  29
  30 /** Possible owners of http header */
  31 typedef enum {
  32     hoNone =0,
  33 #if USE_HTCP
  34     hoHtcpReply,
  35 #endif
  36     hoRequest,
  37     hoReply,
  38 #if USE_OPENSSL
  39     hoErrorDetail,
  40 #endif
  41     hoEnd
  42 } http_hdr_owner_type;
  43
  44 /** Iteration for headers; use HttpHeaderPos as opaque type, do not interpret */
  45 typedef ssize_t HttpHeaderPos;
  46
  47 /* use this and only this to initialize HttpHeaderPos */
  48 #define HttpHeaderInitPos (-1)
  49
  50 class HttpHeaderEntry
  51 {
  52     MEMPROXY_CLASS(HttpHeaderEntry);
  53
  54 public:
  55     HttpHeaderEntry(Http::HdrType id, const SBuf &name, const char *value);
  56     ~HttpHeaderEntry();
  57     static HttpHeaderEntry *parse(const char *field_start, const char *field_end, const http_hdr_owner_type msgType);
  58     HttpHeaderEntry *clone() const;
  59     void packInto(Packable *p) const;
  60     int getInt() const;
  61     int64_t getInt64() const;
  62
  63     Http::HdrType id;
  64     SBuf name;
  65     String value;
  66 };
  67
  68 class ETag;
  69 class TimeOrTag;
  70
  71 class HttpHeader
  72 {
  73
  74 public:
  75     HttpHeader();
  76     explicit HttpHeader(const http_hdr_owner_type owner);
  77     HttpHeader(const HttpHeader &other);
  78     ~HttpHeader();
  79
  80     HttpHeader &operator =(const HttpHeader &other);
  81
  82     /* Interface functions */
  83     void clean();
  84     void append(const HttpHeader * src);
  85     /// replaces fields with matching names and adds fresh fields with new names
  86     /// also updates Http::HdrType::WARNINGs, assuming `fresh` is a 304 reply
  87     /// TODO: Refactor most callers to avoid special handling of WARNINGs.
  88     void update(const HttpHeader *fresh);
  89     /// \returns whether calling update(fresh) would change our set of fields
  90     bool needUpdate(const HttpHeader *fresh) const;
  91     void compact();
  92     int parse(const char *header_start, size_t len, Http::ContentLengthInterpreter &interpreter);
  93     /// Parses headers stored in a buffer.
  94     /// \returns 1 and sets hdr_sz on success
  95     /// \returns 0 when needs more data
  96     /// \returns -1 on error
  97     int parse(const char *buf, size_t buf_len, bool atEnd, size_t &hdr_sz, Http::ContentLengthInterpreter &interpreter);
  98     void packInto(Packable * p, bool mask_sensitive_info=false) const;
  99     HttpHeaderEntry *getEntry(HttpHeaderPos * pos) const;
 100     HttpHeaderEntry *findEntry(Http::HdrType id) const;
 101     /// deletes all fields with a given name, if any.
 102     /// \return #fields deleted
 103     int delByName(const SBuf &name);
 104     /// \deprecated use SBuf method instead. performance regression: reallocates
 105     int delByName(const char *name) { return delByName(SBuf(name)); }
 106     int delById(Http::HdrType id);
 107     void delAt(HttpHeaderPos pos, int &headers_deleted);
 108     void refreshMask();
 109     void addEntry(HttpHeaderEntry * e);
 110     void insertEntry(HttpHeaderEntry * e);
 111     String getList(Http::HdrType id) const;
 112     bool getList(Http::HdrType id, String *s) const;
 113     bool conflictingContentLength() const { return conflictingContentLength_; }
 114     String getStrOrList(Http::HdrType id) const;
 115     String getByName(const SBuf &name) const;
 116     String getByName(const char *name) const;
 117     String getById(Http::HdrType id) const;
 118     /// returns true iff a [possibly empty] field identified by id is there
 119     /// when returning true, also sets the `result` parameter (if it is not nil)
 120     bool getByIdIfPresent(Http::HdrType id, String *result) const;
 121     /// returns true iff a [possibly empty] named field is there
 122     /// when returning true, also sets the `value` parameter (if it is not nil)
 123     bool hasNamed(const SBuf &s, String *value = 0) const;
 124     /// \deprecated use SBuf method instead.
 125     bool hasNamed(const char *name, unsigned int namelen, String *value = 0) const;
 126     /// searches for the first matching key=value pair within the name-identified field
 127     /// \returns the value of the found pair or an empty string
 128     SBuf getByNameListMember(const char *name, const char *member, const char separator) const;
 129     /// searches for the first matching key=value pair within the field
 130     /// \returns the value of the found pair or an empty string
 131     SBuf getListMember(Http::HdrType id, const char *member, const char separator) const;
 132     int has(Http::HdrType id) const;
 133     /// Appends "this cache" information to VIA header field.
 134     /// Takes the initial VIA value from "from" parameter, if provided.
 135     void addVia(const AnyP::ProtocolVersion &ver, const HttpHeader *from = 0);
 136     void putInt(Http::HdrType id, int number);
 137     void putInt64(Http::HdrType id, int64_t number);
 138     void putTime(Http::HdrType id, time_t htime);
 139     void putStr(Http::HdrType id, const char *str);
 140     void putAuth(const char *auth_scheme, const char *realm);
 141     void putCc(const HttpHdrCc * cc);
 142     void putContRange(const HttpHdrContRange * cr);
 143     void putRange(const HttpHdrRange * range);
 144     void putSc(HttpHdrSc *sc);
 145     void putWarning(const int code, const char *const text); ///< add a Warning header
 146     void putExt(const char *name, const char *value);
 147     int getInt(Http::HdrType id) const;
 148     int64_t getInt64(Http::HdrType id) const;
 149     time_t getTime(Http::HdrType id) const;
 150     const char *getStr(Http::HdrType id) const;
 151     const char *getLastStr(Http::HdrType id) const;
 152     HttpHdrCc *getCc() const;
 153     HttpHdrRange *getRange() const;
 154     HttpHdrSc *getSc() const;
 155     HttpHdrContRange *getContRange() const;
 156     SBuf getAuthToken(Http::HdrType id, const char *auth_scheme) const;
 157     ETag getETag(Http::HdrType id) const;
 158     TimeOrTag getTimeOrTag(Http::HdrType id) const;
 159     int hasListMember(Http::HdrType id, const char *member, const char separator) const;
 160     int hasByNameListMember(const char *name, const char *member, const char separator) const;
 161     void removeHopByHopEntries();
 162     inline bool chunked() const; ///< whether message uses chunked Transfer-Encoding
 163
 164     /* protected, do not use these, use interface functions instead */
 165     std::vector<HttpHeaderEntry*, PoolingAllocator<HttpHeaderEntry*> > entries; /**< parsed fields in raw format */
 166     HttpHeaderMask mask;    /**< bit set <=> entry present */
 167     http_hdr_owner_type owner;  /**< request or reply */
 168     int len;            /**< length when packed, not counting terminating null-byte */
 169
 170 protected:
 171     /** \deprecated Public access replaced by removeHopByHopEntries() */
 172     void removeConnectionHeaderEntries();
 173     /// either finds the end of headers or returns false
 174     /// If the end was found:
 175     /// *parse_start points to the first character after the header delimiter
 176     /// *blk_start points to the first header character (i.e. old parse_start value)
 177     /// *blk_end points to the first header delimiter character (CR or LF in CR?LF).
 178     /// If block starts where it ends, then there are no fields in the header.
 179     static bool Isolate(const char **parse_start, size_t l, const char **blk_start, const char **blk_end);
 180     bool skipUpdateHeader(const Http::HdrType id) const;
 181     void updateWarnings();
 182
 183 private:
 184     HttpHeaderEntry *findLastEntry(Http::HdrType id) const;
 185     bool conflictingContentLength_; ///< found different Content-Length fields
 186 };
 187
 188 int httpHeaderParseQuotedString(const char *start, const int len, String *val);
 189
 190 /// quotes string using RFC 7230 quoted-string rules
 191 SBuf httpHeaderQuoteString(const char *raw);
 192
 193 void httpHeaderCalcMask(HttpHeaderMask * mask, Http::HdrType http_hdr_type_enums[], size_t count);
 194
 195 inline bool
 196 HttpHeader::chunked() const
 197 {
 198     return has(Http::HdrType::TRANSFER_ENCODING) &&
 199            hasListMember(Http::HdrType::TRANSFER_ENCODING, "chunked", ',');
 200 }
 201
 202 void httpHeaderInitModule(void);
 203
 204 #endif /* SQUID_HTTPHEADER_H */
 205