Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 1 | /* |
Willy Tarreau | 3667d5d | 2009-10-18 19:50:43 +0200 | [diff] [blame] | 2 | * include/types/proto_http.h |
| 3 | * This file contains HTTP protocol definitions. |
| 4 | * |
Willy Tarreau | ff011f2 | 2011-01-06 17:51:27 +0100 | [diff] [blame] | 5 | * Copyright (C) 2000-2011 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 3667d5d | 2009-10-18 19:50:43 +0200 | [diff] [blame] | 6 | * |
| 7 | * This library is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU Lesser General Public |
| 9 | * License as published by the Free Software Foundation, version 2.1 |
| 10 | * exclusively. |
| 11 | * |
| 12 | * This library is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | * Lesser General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU Lesser General Public |
| 18 | * License along with this library; if not, write to the Free Software |
| 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 21 | |
| 22 | #ifndef _TYPES_PROTO_HTTP_H |
| 23 | #define _TYPES_PROTO_HTTP_H |
| 24 | |
Willy Tarreau | 35b51c6 | 2018-09-10 15:38:55 +0200 | [diff] [blame] | 25 | #include <common/buf.h> |
Willy Tarreau | e3ba5f0 | 2006-06-29 18:54:54 +0200 | [diff] [blame] | 26 | #include <common/config.h> |
Willy Tarreau | 35b51c6 | 2018-09-10 15:38:55 +0200 | [diff] [blame] | 27 | #include <common/http.h> |
Thierry FOURNIER | a054d41 | 2013-10-16 16:19:38 +0200 | [diff] [blame] | 28 | #include <common/mini-clist.h> |
Thierry FOURNIER | f4e6129 | 2014-06-19 13:37:01 +0200 | [diff] [blame] | 29 | #include <common/regex.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 30 | |
Willy Tarreau | db4893d | 2017-09-21 08:40:02 +0200 | [diff] [blame] | 31 | #include <types/channel.h> |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 32 | #include <types/hdr_idx.h> |
Christopher Faulet | d7c9196 | 2015-04-30 11:48:27 +0200 | [diff] [blame] | 33 | #include <types/filters.h> |
Willy Tarreau | 35b51c6 | 2018-09-10 15:38:55 +0200 | [diff] [blame] | 34 | //#include <types/sample.h> |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 35 | |
Willy Tarreau | fcffa69 | 2010-01-10 14:21:19 +0100 | [diff] [blame] | 36 | /* These are the flags that are found in txn->flags */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 37 | |
| 38 | /* action flags */ |
| 39 | #define TX_CLDENY 0x00000001 /* a client header matches a deny regex */ |
| 40 | #define TX_CLALLOW 0x00000002 /* a client header matches an allow regex */ |
| 41 | #define TX_SVDENY 0x00000004 /* a server header matches a deny regex */ |
| 42 | #define TX_SVALLOW 0x00000008 /* a server header matches an allow regex */ |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 43 | #define TX_CLTARPIT 0x00000010 /* the transaction is tarpitted (anti-dos) */ |
Willy Tarreau | b608feb | 2010-01-02 22:47:18 +0100 | [diff] [blame] | 44 | |
Willy Tarreau | 92954fd | 2010-10-06 19:38:55 +0200 | [diff] [blame] | 45 | /* transaction flags dedicated to cookies : bits values 0x20 to 0x80 (0-7 shift 5) */ |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 46 | #define TX_CK_NONE 0x00000000 /* this transaction had no cookie */ |
| 47 | #define TX_CK_INVALID 0x00000020 /* this transaction had a cookie which matches no server */ |
| 48 | #define TX_CK_DOWN 0x00000040 /* this transaction had cookie matching a down server */ |
| 49 | #define TX_CK_VALID 0x00000060 /* this transaction had cookie matching a valid server */ |
| 50 | #define TX_CK_EXPIRED 0x00000080 /* this transaction had an expired cookie (idle for too long) */ |
| 51 | #define TX_CK_OLD 0x000000A0 /* this transaction had too old a cookie (offered too long ago) */ |
| 52 | #define TX_CK_UNUSED 0x000000C0 /* this transaction had a cookie but it was not used (eg: use-server was preferred) */ |
| 53 | #define TX_CK_MASK 0x000000E0 /* mask to get this transaction's cookie flags */ |
Willy Tarreau | 92954fd | 2010-10-06 19:38:55 +0200 | [diff] [blame] | 54 | #define TX_CK_SHIFT 5 /* bit shift */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 55 | |
Willy Tarreau | f134831 | 2010-10-07 15:54:11 +0200 | [diff] [blame] | 56 | /* response cookie information, bits values 0x100 to 0x700 (0-7 shift 8) */ |
| 57 | #define TX_SCK_NONE 0x00000000 /* no cookie found in the response */ |
| 58 | #define TX_SCK_FOUND 0x00000100 /* a persistence cookie was found and forwarded */ |
| 59 | #define TX_SCK_DELETED 0x00000200 /* an existing persistence cookie was deleted */ |
| 60 | #define TX_SCK_INSERTED 0x00000300 /* a persistence cookie was inserted */ |
| 61 | #define TX_SCK_REPLACED 0x00000400 /* a persistence cookie was present and rewritten */ |
| 62 | #define TX_SCK_UPDATED 0x00000500 /* an expirable persistence cookie was updated */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 63 | #define TX_SCK_MASK 0x00000700 /* mask to get the set-cookie field */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 64 | #define TX_SCK_SHIFT 8 /* bit shift */ |
Willy Tarreau | f134831 | 2010-10-07 15:54:11 +0200 | [diff] [blame] | 65 | |
| 66 | #define TX_SCK_PRESENT 0x00000800 /* a cookie was found in the server's response */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 67 | |
| 68 | /* cacheability management, bits values 0x1000 to 0x3000 (0-3 shift 12) */ |
| 69 | #define TX_CACHEABLE 0x00001000 /* at least part of the response is cacheable */ |
| 70 | #define TX_CACHE_COOK 0x00002000 /* a cookie in the response is cacheable */ |
Willy Tarreau | 0ad8e0d | 2017-12-22 15:03:36 +0100 | [diff] [blame] | 71 | #define TX_CACHE_IGNORE 0x00004000 /* do not retrieve object from cache */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 72 | #define TX_CACHE_SHIFT 12 /* bit shift */ |
| 73 | |
Willy Tarreau | 0ad8e0d | 2017-12-22 15:03:36 +0100 | [diff] [blame] | 74 | /* Unused: 0x8000 */ |
Christopher Faulet | e600624 | 2017-03-10 11:52:44 +0100 | [diff] [blame] | 75 | |
| 76 | #define TX_WAIT_CLEANUP 0x0010000 /* this transaction is waiting for a clean up */ |
| 77 | |
| 78 | /* Unused: 0x20000, 0x80000 */ |
| 79 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 80 | |
Willy Tarreau | 5b15447 | 2009-12-21 20:11:07 +0100 | [diff] [blame] | 81 | /* indicate how we *want* the connection to behave, regardless of what is in |
| 82 | * the headers. We have 4 possible values right now : |
Godbach | f2dd68d | 2014-12-10 10:21:30 +0800 | [diff] [blame] | 83 | * - WANT_KAL : try to maintain keep-alive (default when nothing configured) |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 84 | * - WANT_TUN : will be a tunnel (CONNECT). |
Willy Tarreau | 5b15447 | 2009-12-21 20:11:07 +0100 | [diff] [blame] | 85 | * - WANT_SCL : enforce close on the server side |
| 86 | * - WANT_CLO : enforce close on both sides |
| 87 | */ |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 88 | #define TX_CON_WANT_KAL 0x00000000 /* note: it's important that it is 0 (init) */ |
| 89 | #define TX_CON_WANT_TUN 0x00100000 |
Willy Tarreau | 5b15447 | 2009-12-21 20:11:07 +0100 | [diff] [blame] | 90 | #define TX_CON_WANT_SCL 0x00200000 |
| 91 | #define TX_CON_WANT_CLO 0x00300000 |
| 92 | #define TX_CON_WANT_MSK 0x00300000 /* this is the mask to get the bits */ |
| 93 | |
Willy Tarreau | bbf0b37 | 2010-01-18 16:54:40 +0100 | [diff] [blame] | 94 | #define TX_CON_CLO_SET 0x00400000 /* "connection: close" is now set */ |
| 95 | #define TX_CON_KAL_SET 0x00800000 /* "connection: keep-alive" is now set */ |
Willy Tarreau | 5b15447 | 2009-12-21 20:11:07 +0100 | [diff] [blame] | 96 | |
Willy Tarreau | 068621e | 2013-12-23 15:11:25 +0100 | [diff] [blame] | 97 | #define TX_PREFER_LAST 0x01000000 /* try to stay on same server if possible (eg: after 401) */ |
Willy Tarreau | a36fc4d | 2012-02-17 17:39:37 +0100 | [diff] [blame] | 98 | |
Willy Tarreau | 50fc777 | 2012-11-11 22:19:57 +0100 | [diff] [blame] | 99 | #define TX_HDR_CONN_UPG 0x02000000 /* The "Upgrade" token was found in the "Connection" header */ |
Willy Tarreau | fcffa69 | 2010-01-10 14:21:19 +0100 | [diff] [blame] | 100 | #define TX_WAIT_NEXT_RQ 0x04000000 /* waiting for the second request to start, use keep-alive timeout */ |
Willy Tarreau | 5b15447 | 2009-12-21 20:11:07 +0100 | [diff] [blame] | 101 | |
Willy Tarreau | bbf0b37 | 2010-01-18 16:54:40 +0100 | [diff] [blame] | 102 | #define TX_HDR_CONN_PRS 0x08000000 /* "connection" header already parsed (req or res), results below */ |
| 103 | #define TX_HDR_CONN_CLO 0x10000000 /* "Connection: close" was present at least once */ |
| 104 | #define TX_HDR_CONN_KAL 0x20000000 /* "Connection: keep-alive" was present at least once */ |
Willy Tarreau | 88d349d | 2010-01-25 12:15:43 +0100 | [diff] [blame] | 105 | #define TX_USE_PX_CONN 0x40000000 /* Use "Proxy-Connection" instead of "Connection" */ |
Willy Tarreau | bbf0b37 | 2010-01-18 16:54:40 +0100 | [diff] [blame] | 106 | |
Willy Tarreau | 92954fd | 2010-10-06 19:38:55 +0200 | [diff] [blame] | 107 | /* used only for keep-alive purposes, to indicate we're on a second transaction */ |
| 108 | #define TX_NOT_FIRST 0x80000000 /* the transaction is not the first one */ |
| 109 | /* no more room for transaction flags ! */ |
Willy Tarreau | bbf0b37 | 2010-01-18 16:54:40 +0100 | [diff] [blame] | 110 | |
Willy Tarreau | 8d5d7f2 | 2007-01-21 19:16:41 +0100 | [diff] [blame] | 111 | /* The HTTP parser is more complex than it looks like, because we have to |
| 112 | * support multi-line headers and any number of spaces between the colon and |
| 113 | * the value. |
| 114 | * |
| 115 | * All those examples must work : |
| 116 | |
| 117 | Hdr1:val1\r\n |
| 118 | Hdr1: val1\r\n |
| 119 | Hdr1:\t val1\r\n |
| 120 | Hdr1: \r\n |
| 121 | val1\r\n |
| 122 | Hdr1:\r\n |
| 123 | val1\n |
| 124 | \tval2\r\n |
| 125 | val3\n |
| 126 | |
| 127 | * |
| 128 | */ |
| 129 | |
Willy Tarreau | a36fc4d | 2012-02-17 17:39:37 +0100 | [diff] [blame] | 130 | /* |
| 131 | * HTTP message status flags (msg->flags) |
| 132 | */ |
Willy Tarreau | a36fc4d | 2012-02-17 17:39:37 +0100 | [diff] [blame] | 133 | #define HTTP_MSGF_CNT_LEN 0x00000001 /* content-length was found in the message */ |
| 134 | #define HTTP_MSGF_TE_CHNK 0x00000002 /* transfer-encoding: chunked was found */ |
| 135 | |
| 136 | /* if this flags is not set in either direction, we may be forced to complete a |
| 137 | * connection as a half-way tunnel (eg if no content-length appears in a 1.1 |
| 138 | * response, but the request is correctly sized) |
| 139 | */ |
| 140 | #define HTTP_MSGF_XFER_LEN 0x00000004 /* message xfer size can be determined */ |
| 141 | #define HTTP_MSGF_VER_11 0x00000008 /* the message is HTTP/1.1 or above */ |
| 142 | |
Willy Tarreau | 80a92c0 | 2014-03-12 10:41:13 +0100 | [diff] [blame] | 143 | /* If this flag is set, we don't process the body until the connect() is confirmed. |
| 144 | * This is only used by the request forwarding function to protect the buffer |
| 145 | * contents if something needs them during a redispatch. |
| 146 | */ |
| 147 | #define HTTP_MSGF_WAIT_CONN 0x00000010 /* Wait for connect() to be confirmed before processing body */ |
Christopher Faulet | d7c9196 | 2015-04-30 11:48:27 +0200 | [diff] [blame] | 148 | #define HTTP_MSGF_COMPRESSING 0x00000020 /* data compression is in progress */ |
Willy Tarreau | a36fc4d | 2012-02-17 17:39:37 +0100 | [diff] [blame] | 149 | |
Christopher Faulet | b2db4fa | 2018-11-27 16:51:09 +0100 | [diff] [blame] | 150 | #define HTTP_MSGF_BODYLESS 0x00000040 /* The message has no body (content-length = 0) */ |
| 151 | |
Willy Tarreau | a36fc4d | 2012-02-17 17:39:37 +0100 | [diff] [blame] | 152 | |
Willy Tarreau | 79da469 | 2008-11-19 20:03:04 +0100 | [diff] [blame] | 153 | /* Redirect flags */ |
| 154 | enum { |
| 155 | REDIRECT_FLAG_NONE = 0, |
| 156 | REDIRECT_FLAG_DROP_QS = 1, /* drop query string */ |
Willy Tarreau | 81e3b4f | 2010-01-10 00:42:19 +0100 | [diff] [blame] | 157 | REDIRECT_FLAG_APPEND_SLASH = 2, /* append a slash if missing at the end */ |
Willy Tarreau | 79da469 | 2008-11-19 20:03:04 +0100 | [diff] [blame] | 158 | }; |
Willy Tarreau | b463dfb | 2008-06-07 23:08:56 +0200 | [diff] [blame] | 159 | |
| 160 | /* Redirect types (location, prefix, extended ) */ |
| 161 | enum { |
| 162 | REDIRECT_TYPE_NONE = 0, /* no redirection */ |
| 163 | REDIRECT_TYPE_LOCATION, /* location redirect */ |
| 164 | REDIRECT_TYPE_PREFIX, /* prefix redirect */ |
Willy Tarreau | 2e1dca8 | 2012-09-12 08:43:15 +0200 | [diff] [blame] | 165 | REDIRECT_TYPE_SCHEME, /* scheme redirect (eg: switch from http to https) */ |
Willy Tarreau | b463dfb | 2008-06-07 23:08:56 +0200 | [diff] [blame] | 166 | }; |
| 167 | |
Cyril Bonté | 47fdd8e | 2010-04-25 00:00:51 +0200 | [diff] [blame] | 168 | /* Perist types (force-persist, ignore-persist) */ |
| 169 | enum { |
| 170 | PERSIST_TYPE_NONE = 0, /* no persistence */ |
| 171 | PERSIST_TYPE_FORCE, /* force-persist */ |
| 172 | PERSIST_TYPE_IGNORE, /* ignore-persist */ |
| 173 | }; |
| 174 | |
Willy Tarreau | 0b74833 | 2014-04-29 00:13:29 +0200 | [diff] [blame] | 175 | /* final results for http-request rules */ |
| 176 | enum rule_result { |
| 177 | HTTP_RULE_RES_CONT = 0, /* nothing special, continue rules evaluation */ |
Thierry FOURNIER | bc4c1ac | 2015-02-25 13:36:14 +0100 | [diff] [blame] | 178 | HTTP_RULE_RES_YIELD, /* call me later because some data is missing. */ |
Willy Tarreau | 0b74833 | 2014-04-29 00:13:29 +0200 | [diff] [blame] | 179 | HTTP_RULE_RES_STOP, /* stopped processing on an accept */ |
| 180 | HTTP_RULE_RES_DENY, /* deny (or tarpit if TX_CLTARPIT) */ |
| 181 | HTTP_RULE_RES_ABRT, /* abort request, msg already sent (eg: auth) */ |
| 182 | HTTP_RULE_RES_DONE, /* processing done, stop processing (eg: redirect) */ |
| 183 | HTTP_RULE_RES_BADREQ, /* bad request */ |
| 184 | }; |
| 185 | |
Cyril Bonté | 19979e1 | 2012-04-04 12:57:21 +0200 | [diff] [blame] | 186 | /* status codes available for the stats admin page */ |
| 187 | enum { |
| 188 | STAT_STATUS_INIT = 0, |
| 189 | STAT_STATUS_DENY, /* action denied */ |
| 190 | STAT_STATUS_DONE, /* the action is successful */ |
Joseph Herlant | 5ba8025 | 2018-11-15 09:25:36 -0800 | [diff] [blame] | 191 | STAT_STATUS_ERRP, /* an error occurred due to invalid values in parameters */ |
| 192 | STAT_STATUS_EXCD, /* an error occurred because the buffer couldn't store all data */ |
Cyril Bonté | 19979e1 | 2012-04-04 12:57:21 +0200 | [diff] [blame] | 193 | STAT_STATUS_NONE, /* nothing happened (no action chosen or servers state didn't change) */ |
| 194 | STAT_STATUS_PART, /* the action is partially successful */ |
Joseph Herlant | 5ba8025 | 2018-11-15 09:25:36 -0800 | [diff] [blame] | 195 | STAT_STATUS_UNKN, /* an unknown error occurred, shouldn't happen */ |
Cyril Bonté | 19979e1 | 2012-04-04 12:57:21 +0200 | [diff] [blame] | 196 | STAT_STATUS_SIZE |
| 197 | }; |
| 198 | |
Willy Tarreau | 326e27e | 2018-12-11 11:04:56 +0100 | [diff] [blame] | 199 | /* Legacy version of the HTTP/1 message state, used by the channels, should |
| 200 | * ultimately be removed. |
| 201 | */ |
| 202 | enum h1_state { |
| 203 | HTTP_MSG_RQBEFORE = 0, // request: leading LF, before start line |
| 204 | HTTP_MSG_RQBEFORE_CR = 1, // request: leading CRLF, before start line |
| 205 | /* these ones define a request start line */ |
| 206 | HTTP_MSG_RQMETH = 2, // parsing the Method |
| 207 | HTTP_MSG_RQMETH_SP = 3, // space(s) after the Method |
| 208 | HTTP_MSG_RQURI = 4, // parsing the Request URI |
| 209 | HTTP_MSG_RQURI_SP = 5, // space(s) after the Request URI |
| 210 | HTTP_MSG_RQVER = 6, // parsing the Request Version |
| 211 | HTTP_MSG_RQLINE_END = 7, // end of request line (CR or LF) |
| 212 | |
| 213 | HTTP_MSG_RPBEFORE = 8, // response: leading LF, before start line |
| 214 | HTTP_MSG_RPBEFORE_CR = 9, // response: leading CRLF, before start line |
| 215 | |
| 216 | /* these ones define a response start line */ |
| 217 | HTTP_MSG_RPVER = 10, // parsing the Response Version |
| 218 | HTTP_MSG_RPVER_SP = 11, // space(s) after the Response Version |
| 219 | HTTP_MSG_RPCODE = 12, // response code |
| 220 | HTTP_MSG_RPCODE_SP = 13, // space(s) after the response code |
| 221 | HTTP_MSG_RPREASON = 14, // response reason |
| 222 | HTTP_MSG_RPLINE_END = 15, // end of response line (CR or LF) |
| 223 | |
| 224 | /* common header processing */ |
| 225 | HTTP_MSG_HDR_FIRST = 16, // waiting for first header or last CRLF (no LWS possible) |
| 226 | HTTP_MSG_HDR_NAME = 17, // parsing header name |
| 227 | HTTP_MSG_HDR_COL = 18, // parsing header colon |
| 228 | HTTP_MSG_HDR_L1_SP = 19, // parsing header LWS (SP|HT) before value |
| 229 | HTTP_MSG_HDR_L1_LF = 20, // parsing header LWS (LF) before value |
| 230 | HTTP_MSG_HDR_L1_LWS = 21, // checking whether it's a new header or an LWS |
| 231 | HTTP_MSG_HDR_VAL = 22, // parsing header value |
| 232 | HTTP_MSG_HDR_L2_LF = 23, // parsing header LWS (LF) inside/after value |
| 233 | HTTP_MSG_HDR_L2_LWS = 24, // checking whether it's a new header or an LWS |
| 234 | |
| 235 | HTTP_MSG_LAST_LF = 25, // parsing last LF |
| 236 | |
| 237 | /* error state : must be before HTTP_MSG_BODY so that (>=BODY) always indicates |
| 238 | * that data are being processed. |
| 239 | */ |
| 240 | HTTP_MSG_ERROR = 26, // an error occurred |
| 241 | /* Body processing. |
| 242 | * The state HTTP_MSG_BODY is a delimiter to know if we're waiting for headers |
| 243 | * or body. All the sub-states below also indicate we're processing the body, |
| 244 | * with some additional information. |
| 245 | */ |
| 246 | HTTP_MSG_BODY = 27, // parsing body at end of headers |
| 247 | HTTP_MSG_100_SENT = 28, // parsing body after a 100-Continue was sent |
| 248 | HTTP_MSG_CHUNK_SIZE = 29, // parsing the chunk size (RFC7230 #4.1) |
| 249 | HTTP_MSG_DATA = 30, // skipping data chunk / content-length data |
| 250 | HTTP_MSG_CHUNK_CRLF = 31, // skipping CRLF after data chunk |
| 251 | HTTP_MSG_TRAILERS = 32, // trailers (post-data entity headers) |
| 252 | /* we enter this state when we've received the end of the current message */ |
| 253 | HTTP_MSG_ENDING = 33, // message end received, wait that the filters end too |
| 254 | HTTP_MSG_DONE = 34, // message end received, waiting for resync or close |
| 255 | HTTP_MSG_CLOSING = 35, // shutdown_w done, not all bytes sent yet |
| 256 | HTTP_MSG_CLOSED = 36, // shutdown_w done, all bytes sent |
| 257 | HTTP_MSG_TUNNEL = 37, // tunneled data after DONE |
| 258 | } __attribute__((packed)); |
| 259 | |
| 260 | |
Lukas Tribus | 2395368 | 2017-04-28 13:24:30 +0000 | [diff] [blame] | 261 | /* This is an HTTP message, as described in RFC7230. It can be either a request |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 262 | * message or a response message. |
| 263 | * |
| 264 | * The values there are a little bit obscure, because their meaning can change |
Willy Tarreau | bb2e669 | 2014-07-10 19:06:10 +0200 | [diff] [blame] | 265 | * during the parsing. Please read carefully doc/internal/body-parsing.txt if |
| 266 | * you need to manipulate them. Quick reminder : |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 267 | * |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 268 | * - eoh (End of Headers) : relative offset in the buffer of first byte that |
| 269 | * is not part of a completely processed header. |
| 270 | * During parsing, it points to last header seen |
Willy Tarreau | fa355d4 | 2009-11-29 18:12:29 +0100 | [diff] [blame] | 271 | * for states after START. When in HTTP_MSG_BODY, |
| 272 | * eoh points to the first byte of the last CRLF |
Joseph Herlant | 5ba8025 | 2018-11-15 09:25:36 -0800 | [diff] [blame] | 273 | * preceding data. Relative to buffer's origin. |
Willy Tarreau | 0558a02 | 2014-03-13 15:48:45 +0100 | [diff] [blame] | 274 | * This value then remains unchanged till the end |
| 275 | * so that we can rewind the buffer to change some |
| 276 | * headers if needed (eg: http-send-name-header). |
| 277 | * |
Willy Tarreau | 877e78d | 2013-04-07 18:48:08 +0200 | [diff] [blame] | 278 | * - sov (start of value) : Before HTTP_MSG_BODY, points to the value of |
| 279 | * the header being parsed. Starting from |
| 280 | * HTTP_MSG_BODY, will point to the start of the |
Willy Tarreau | bb2e669 | 2014-07-10 19:06:10 +0200 | [diff] [blame] | 281 | * body (relative to buffer's origin). It can be |
| 282 | * negative when forwarding data. It stops growing |
| 283 | * once data start to leave the buffer. |
Willy Tarreau | 877e78d | 2013-04-07 18:48:08 +0200 | [diff] [blame] | 284 | * |
| 285 | * - next (parse pointer) : next relative byte to be parsed. Always points |
| 286 | * to a byte matching the current state. |
| 287 | * |
Willy Tarreau | 30fe818 | 2015-05-01 23:14:54 +0200 | [diff] [blame] | 288 | * - sol (start of line) : start of current line before MSG_BODY. Starting |
Christopher Faulet | 113f7de | 2015-12-14 14:52:13 +0100 | [diff] [blame] | 289 | * from MSG_BODY and until MSG_TRAILERS, contains |
| 290 | * the length of the last parsed chunk size so that |
| 291 | * when added to sov it always points to the |
| 292 | * beginning of the current data chunk. |
| 293 | * in MSG_TRAILERS state, it contains the length of |
| 294 | * the last parsed part of the trailer headers. |
Willy Tarreau | 0558a02 | 2014-03-13 15:48:45 +0100 | [diff] [blame] | 295 | * |
| 296 | * - eol (End of Line) : Before HTTP_MSG_BODY, relative offset in the |
| 297 | * buffer of the first byte which marks the end of |
| 298 | * the line current (LF or CRLF). |
| 299 | * From HTTP_MSG_BODY to the end, contains the |
| 300 | * length of the last CRLF (1 for a plain LF, or 2 |
| 301 | * for a true CRLF). So eoh+eol always contain the |
| 302 | * exact size of the header size. |
| 303 | * |
Willy Tarreau | ea1175a | 2012-03-05 15:52:30 +0100 | [diff] [blame] | 304 | * Note that all offsets are relative to the origin of the buffer (buf->p) |
| 305 | * which always points to the beginning of the message (request or response). |
| 306 | * Since a message may not wrap, pointer computations may be one without any |
| 307 | * care for wrapping (no addition overflow nor subtract underflow). |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 308 | */ |
| 309 | struct http_msg { |
Willy Tarreau | 0da5b3b | 2017-09-21 09:30:46 +0200 | [diff] [blame] | 310 | enum h1_state msg_state; /* where we are in the current message parsing */ |
| 311 | enum h1_state err_state; /* the state where the parsing error was detected, only is MSG_ERROR */ |
Willy Tarreau | 3770f23 | 2013-12-07 00:01:53 +0100 | [diff] [blame] | 312 | unsigned char flags; /* flags describing the message (HTTP version, ...) */ |
Willy Tarreau | 10e61cb | 2017-01-04 14:51:22 +0100 | [diff] [blame] | 313 | /* 5 bytes unused here */ |
Willy Tarreau | 394db37 | 2012-10-12 22:40:39 +0200 | [diff] [blame] | 314 | struct channel *chn; /* pointer to the channel transporting the message */ |
Willy Tarreau | a458b67 | 2012-03-05 11:17:50 +0100 | [diff] [blame] | 315 | unsigned int next; /* pointer to next byte to parse, relative to buf->p */ |
Willy Tarreau | bb2e669 | 2014-07-10 19:06:10 +0200 | [diff] [blame] | 316 | int sov; /* current header: start of value ; data: start of body */ |
Willy Tarreau | fa355d4 | 2009-11-29 18:12:29 +0100 | [diff] [blame] | 317 | unsigned int eoh; /* End Of Headers, relative to buffer */ |
Willy Tarreau | 09d1e25 | 2012-05-18 22:36:34 +0200 | [diff] [blame] | 318 | unsigned int sol; /* start of current line during parsing otherwise zero */ |
Willy Tarreau | 12e48b3 | 2012-03-05 16:57:34 +0100 | [diff] [blame] | 319 | unsigned int eol; /* end of line */ |
Willy Tarreau | fa355d4 | 2009-11-29 18:12:29 +0100 | [diff] [blame] | 320 | int err_pos; /* err handling: -2=block, -1=pass, 0+=detected */ |
Willy Tarreau | 962c3f4 | 2010-01-10 00:15:35 +0100 | [diff] [blame] | 321 | union { /* useful start line pointers, relative to ->sol */ |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 322 | struct { |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 323 | int l; /* request line length (not including CR) */ |
Willy Tarreau | 2692736 | 2012-05-18 23:22:52 +0200 | [diff] [blame] | 324 | int m_l; /* METHOD length (method starts at buf->p) */ |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 325 | int u, u_l; /* URI, length */ |
| 326 | int v, v_l; /* VERSION, length */ |
| 327 | } rq; /* request line : field, length */ |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 328 | struct { |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 329 | int l; /* status line length (not including CR) */ |
Willy Tarreau | 2692736 | 2012-05-18 23:22:52 +0200 | [diff] [blame] | 330 | int v_l; /* VERSION length (version starts at buf->p) */ |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 331 | int c, c_l; /* CODE, length */ |
| 332 | int r, r_l; /* REASON, length */ |
| 333 | } st; /* status line : field, length */ |
| 334 | } sl; /* start line */ |
Willy Tarreau | 124d991 | 2011-03-01 20:30:48 +0100 | [diff] [blame] | 335 | unsigned long long chunk_len; /* cache for last chunk size or content-length header value */ |
| 336 | unsigned long long body_len; /* total known length of the body, excluding encoding */ |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 337 | }; |
| 338 | |
William Lallemand | 73025dd | 2014-04-24 14:38:37 +0200 | [diff] [blame] | 339 | struct proxy; |
| 340 | struct http_txn; |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 341 | struct stream; |
William Lallemand | 73025dd | 2014-04-24 14:38:37 +0200 | [diff] [blame] | 342 | |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 343 | /* This is an HTTP transaction. It contains both a request message and a |
| 344 | * response message (which can be empty). |
| 345 | */ |
| 346 | struct http_txn { |
Willy Tarreau | ac1932d | 2011-10-24 19:14:41 +0200 | [diff] [blame] | 347 | struct hdr_idx hdr_idx; /* array of header indexes (max: global.tune.max_http_hdr) */ |
Willy Tarreau | 520bbb2 | 2010-01-10 11:31:22 +0100 | [diff] [blame] | 348 | struct http_msg rsp; /* HTTP response message */ |
Willy Tarreau | c8987b3 | 2013-12-06 23:43:17 +0100 | [diff] [blame] | 349 | struct http_msg req; /* HTTP request message */ |
| 350 | unsigned int flags; /* transaction flags */ |
| 351 | enum http_meth_t meth; /* HTTP method */ |
| 352 | /* 1 unused byte here */ |
| 353 | short status; /* HTTP status from the server, negative if from proxy */ |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 354 | |
William Lallemand | f528fff | 2017-11-23 19:43:17 +0100 | [diff] [blame] | 355 | char cache_hash[20]; /* Store the cache hash */ |
Willy Tarreau | 520bbb2 | 2010-01-10 11:31:22 +0100 | [diff] [blame] | 356 | char *uri; /* first line if log needed, NULL otherwise */ |
| 357 | char *cli_cookie; /* cookie presented by the client, in capture mode */ |
| 358 | char *srv_cookie; /* cookie presented by the server, in capture mode */ |
Willy Tarreau | f64d141 | 2010-10-07 20:06:11 +0200 | [diff] [blame] | 359 | int cookie_first_date; /* if non-zero, first date the expirable cookie was set/seen */ |
| 360 | int cookie_last_date; /* if non-zero, last date the expirable cookie was set/seen */ |
Willy Tarreau | 520bbb2 | 2010-01-10 11:31:22 +0100 | [diff] [blame] | 361 | |
Krzysztof Piotr Oledzki | f9423ae | 2010-01-29 19:26:18 +0100 | [diff] [blame] | 362 | struct http_auth_data auth; /* HTTP auth data */ |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 363 | }; |
| 364 | |
William Lallemand | 73025dd | 2014-04-24 14:38:37 +0200 | [diff] [blame] | 365 | |
Willy Tarreau | 33a7e69 | 2007-06-10 19:45:56 +0200 | [diff] [blame] | 366 | /* This structure is used by http_find_header() to return values of headers. |
Willy Tarreau | 588bd4f | 2011-09-01 22:22:28 +0200 | [diff] [blame] | 367 | * The header starts at <line>, the value (excluding leading and trailing white |
| 368 | * spaces) at <line>+<val> for <vlen> bytes, followed by optional <tws> trailing |
| 369 | * white spaces, and sets <line>+<del> to point to the last delimitor (colon or |
| 370 | * comma) before this value. <prev> points to the index of the header whose next |
| 371 | * is this one. |
Willy Tarreau | 33a7e69 | 2007-06-10 19:45:56 +0200 | [diff] [blame] | 372 | */ |
| 373 | struct hdr_ctx { |
Willy Tarreau | 68085d8 | 2010-01-18 14:54:04 +0100 | [diff] [blame] | 374 | char *line; |
Willy Tarreau | 33a7e69 | 2007-06-10 19:45:56 +0200 | [diff] [blame] | 375 | int idx; |
Willy Tarreau | 588bd4f | 2011-09-01 22:22:28 +0200 | [diff] [blame] | 376 | int val; /* relative to line, may skip some leading white spaces */ |
| 377 | int vlen; /* relative to line+val, stops before trailing white spaces */ |
| 378 | int tws; /* added to vlen if some trailing white spaces are present */ |
Willy Tarreau | 68085d8 | 2010-01-18 14:54:04 +0100 | [diff] [blame] | 379 | int del; /* relative to line */ |
| 380 | int prev; /* index of previous header */ |
Willy Tarreau | 33a7e69 | 2007-06-10 19:45:56 +0200 | [diff] [blame] | 381 | }; |
Willy Tarreau | 58f10d7 | 2006-12-04 02:26:12 +0100 | [diff] [blame] | 382 | |
Willy Tarreau | bafbe01 | 2017-11-24 17:34:44 +0100 | [diff] [blame] | 383 | extern struct pool_head *pool_head_http_txn; |
Willy Tarreau | eee5b51 | 2015-04-03 23:46:31 +0200 | [diff] [blame] | 384 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 385 | #endif /* _TYPES_PROTO_HTTP_H */ |
| 386 | |
| 387 | /* |
| 388 | * Local variables: |
| 389 | * c-indent-level: 8 |
| 390 | * c-basic-offset: 8 |
| 391 | * End: |
| 392 | */ |