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