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