src/http/Message.h

   1 /*
   2  * Copyright (C) 1996-2018 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_HTTP_MESSAGE_H
  10 #define SQUID_HTTP_MESSAGE_H
  11
  12 #include "base/Lock.h"
  13 #include "BodyPipe.h"
  14 #include "enums.h"
  15 #include "http/forward.h"
  16 #include "http/ProtocolVersion.h"
  17 #include "http/StatusCode.h"
  18 #include "HttpHeader.h"
  19
  20 namespace Http
  21 {
  22
  23 /// common parts of HttpRequest and HttpReply
  24 class Message : public RefCountable
  25 {
  26 public:
  27     /// Who may have created or modified this message?
  28     enum Sources {
  29         srcUnknown = 0,
  30
  31         /* flags in 0xFFFF zone are for "secure" or "encrypted" sources */
  32         srcHttps = 1 << 0, ///< https_port or bumped http_port tunnel; HTTPS server
  33         srcFtps = 1 << 1, ///< ftps_port or SFTP server; currently unused
  34         srcIcaps = 1 << 2, ///< Secure ICAP service
  35         srcEcaps = 1 << 3, ///< eCAP service that is considered secure; currently unused
  36
  37         /* these flags "taint" the message: it may have been observed or mangled outside Squid */
  38         srcHttp = 1 << (16 + 0), ///< http_port or HTTP server
  39         srcFtp = 1 << (16 + 1), ///< ftp_port or FTP server
  40         srcIcap = 1 << (16 + 2), ///< traditional ICAP service without encryption
  41         srcEcap = 1 << (16 + 3), ///< eCAP service that uses insecure libraries/daemons
  42         srcGopher = 1 << (16 + 14), ///< Gopher server
  43         srcWhois = 1 << (16 + 15), ///< Whois server
  44         srcUnsafe = 0xFFFF0000,  ///< Unsafe sources mask
  45         srcSafe = 0x0000FFFF ///< Safe sources mask
  46     };
  47
  48     Message(http_hdr_owner_type);
  49     virtual ~Message();
  50
  51     virtual void reset() = 0; // will have body when http*Clean()s are gone
  52
  53     void packInto(Packable *, bool full_uri) const;
  54
  55     ///< produce a message copy, except for a few connection-specific settings
  56     virtual Http::Message *clone() const = 0; // TODO rename: not a true copy?
  57
  58     /// [re]sets Content-Length header and cached value
  59     void setContentLength(int64_t);
  60
  61     /**
  62      * \retval true  the message sender asks to keep the connection open.
  63      * \retval false the message sender will close the connection.
  64      *
  65      * Factors other than the headers may result in connection closure.
  66      */
  67     bool persistent() const;
  68
  69 public:
  70     /// HTTP-Version field in the first line of the message.
  71     /// see RFC 7230 section 3.1
  72     AnyP::ProtocolVersion http_ver;
  73
  74     HttpHeader header;
  75
  76     HttpHdrCc *cache_control = nullptr;
  77
  78     /* Unsupported, writable, may disappear/change in the future
  79      * For replies, sums _stored_ status-line, headers, and <CRLF>.
  80      * Also used to report parsed header size if parse() is successful */
  81     int hdr_sz = 0;
  82
  83     int64_t content_length = 0;
  84
  85     /// parse state of HttpReply or HttpRequest
  86     enum ParseState {
  87         psReadyToParseStartLine = 0,
  88         psReadyToParseHeaders,
  89         psParsed,
  90         psError
  91     };
  92
  93     /// the current parsing state
  94     ParseState pstate = Http::Message::psReadyToParseStartLine;
  95
  96     /// optional pipeline to receive message body
  97     BodyPipe::Pointer body_pipe;
  98
  99     uint32_t sources = 0; ///< The message sources
 100
 101     /// copies Cache-Control header to this message
 102     void putCc(const HttpHdrCc *otherCc);
 103
 104     // returns true and sets hdr_sz on success
 105     // returns false and sets *error to zero when needs more data
 106     // returns false and sets *error to a positive Http::StatusCode on error
 107     bool parse(const char *buf, const size_t sz, bool eol, Http::StatusCode *error);
 108
 109     bool parseCharBuf(const char *buf, ssize_t end);
 110
 111     int httpMsgParseStep(const char *buf, int len, int atEnd);
 112
 113     virtual int httpMsgParseError();
 114
 115     // Parser-NG transitional parsing of mime headers
 116     bool parseHeader(Http1::Parser &); // TODO move this function to the parser
 117
 118     virtual bool expectingBody(const HttpRequestMethod&, int64_t&) const = 0;
 119
 120     void firstLineBuf(MemBuf&);
 121
 122     virtual bool inheritProperties(const Http::Message *) = 0;
 123
 124 protected:
 125     /**
 126      * Validate the message start line is syntactically correct.
 127      * Set HTTP error status according to problems found.
 128      *
 129      * \retval true   Status line has no serious problems.
 130      * \retval false  Status line has a serious problem. Correct response is indicated by error.
 131      */
 132     virtual bool sanityCheckStartLine(const char *buf, const size_t hdr_len, Http::StatusCode *error) = 0;
 133
 134     virtual void packFirstLineInto(Packable * p, bool full_uri) const = 0;
 135
 136     virtual bool parseFirstLine(const char *blk_start, const char *blk_end) = 0;
 137
 138     virtual void hdrCacheInit();
 139 };
 140
 141 } // namespace Http
 142
 143 inline void
 144 HTTPMSGUNLOCK(Http::Message *a)
 145 {
 146     if (a) {
 147         if (a->unlock() == 0)
 148             delete a;
 149         a = nullptr;
 150     }
 151 }
 152
 153 inline void
 154 HTTPMSGLOCK(Http::Message *a)
 155 {
 156     if (a)
 157         a->lock();
 158 }
 159
 160 #endif /* SQUID_HTTPMSG_H */
 161