blob: 088c74868091d9db5f53c67ac2b3b9db15bb2516 [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
Willy Tarreau3667d5d2009-10-18 19:50:43 +02002 * include/types/proto_http.h
3 * This file contains HTTP protocol definitions.
4 *
Willy Tarreauff011f22011-01-06 17:51:27 +01005 * Copyright (C) 2000-2011 Willy Tarreau - w@1wt.eu
Willy Tarreau3667d5d2009-10-18 19:50:43 +02006 *
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 Tarreaubaaee002006-06-26 02:48:02 +020021
22#ifndef _TYPES_PROTO_HTTP_H
23#define _TYPES_PROTO_HTTP_H
24
Willy Tarreauc7e42382012-08-24 19:22:53 +020025#include <common/chunk.h>
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020026#include <common/config.h>
Thierry FOURNIERa054d412013-10-16 16:19:38 +020027#include <common/mini-clist.h>
Thierry FOURNIERf4e61292014-06-19 13:37:01 +020028#include <common/regex.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020029
Willy Tarreau3bac9ff2007-03-18 17:31:28 +010030#include <types/hdr_idx.h>
Willy Tarreau09448f72014-06-25 18:12:15 +020031#include <types/stick_table.h>
Willy Tarreau3bac9ff2007-03-18 17:31:28 +010032
Willy Tarreaufcffa692010-01-10 14:21:19 +010033/* These are the flags that are found in txn->flags */
Willy Tarreau3d300592007-03-18 18:34:41 +010034
35/* action flags */
36#define TX_CLDENY 0x00000001 /* a client header matches a deny regex */
37#define TX_CLALLOW 0x00000002 /* a client header matches an allow regex */
38#define TX_SVDENY 0x00000004 /* a server header matches a deny regex */
39#define TX_SVALLOW 0x00000008 /* a server header matches an allow regex */
Willy Tarreau87b09662015-04-03 00:22:06 +020040#define TX_CLTARPIT 0x00000010 /* the transaction is tarpitted (anti-dos) */
Willy Tarreaub608feb2010-01-02 22:47:18 +010041
Willy Tarreau92954fd2010-10-06 19:38:55 +020042/* transaction flags dedicated to cookies : bits values 0x20 to 0x80 (0-7 shift 5) */
Willy Tarreau87b09662015-04-03 00:22:06 +020043#define TX_CK_NONE 0x00000000 /* this transaction had no cookie */
44#define TX_CK_INVALID 0x00000020 /* this transaction had a cookie which matches no server */
45#define TX_CK_DOWN 0x00000040 /* this transaction had cookie matching a down server */
46#define TX_CK_VALID 0x00000060 /* this transaction had cookie matching a valid server */
47#define TX_CK_EXPIRED 0x00000080 /* this transaction had an expired cookie (idle for too long) */
48#define TX_CK_OLD 0x000000A0 /* this transaction had too old a cookie (offered too long ago) */
49#define TX_CK_UNUSED 0x000000C0 /* this transaction had a cookie but it was not used (eg: use-server was preferred) */
50#define TX_CK_MASK 0x000000E0 /* mask to get this transaction's cookie flags */
Willy Tarreau92954fd2010-10-06 19:38:55 +020051#define TX_CK_SHIFT 5 /* bit shift */
Willy Tarreau3d300592007-03-18 18:34:41 +010052
Willy Tarreauf1348312010-10-07 15:54:11 +020053/* response cookie information, bits values 0x100 to 0x700 (0-7 shift 8) */
54#define TX_SCK_NONE 0x00000000 /* no cookie found in the response */
55#define TX_SCK_FOUND 0x00000100 /* a persistence cookie was found and forwarded */
56#define TX_SCK_DELETED 0x00000200 /* an existing persistence cookie was deleted */
57#define TX_SCK_INSERTED 0x00000300 /* a persistence cookie was inserted */
58#define TX_SCK_REPLACED 0x00000400 /* a persistence cookie was present and rewritten */
59#define TX_SCK_UPDATED 0x00000500 /* an expirable persistence cookie was updated */
Willy Tarreau3d300592007-03-18 18:34:41 +010060#define TX_SCK_MASK 0x00000700 /* mask to get the set-cookie field */
Willy Tarreau3d300592007-03-18 18:34:41 +010061#define TX_SCK_SHIFT 8 /* bit shift */
Willy Tarreauf1348312010-10-07 15:54:11 +020062
63#define TX_SCK_PRESENT 0x00000800 /* a cookie was found in the server's response */
Willy Tarreau3d300592007-03-18 18:34:41 +010064
65/* cacheability management, bits values 0x1000 to 0x3000 (0-3 shift 12) */
66#define TX_CACHEABLE 0x00001000 /* at least part of the response is cacheable */
67#define TX_CACHE_COOK 0x00002000 /* a cookie in the response is cacheable */
68#define TX_CACHE_SHIFT 12 /* bit shift */
69
Willy Tarreaua36fc4d2012-02-17 17:39:37 +010070/* Unused: 0x4000, 0x8000, 0x10000, 0x20000, 0x80000 */
Willy Tarreaubaaee002006-06-26 02:48:02 +020071
Willy Tarreau5b154472009-12-21 20:11:07 +010072/* indicate how we *want* the connection to behave, regardless of what is in
73 * the headers. We have 4 possible values right now :
Godbachf2dd68d2014-12-10 10:21:30 +080074 * - WANT_KAL : try to maintain keep-alive (default when nothing configured)
Willy Tarreau70dffda2014-01-30 03:07:23 +010075 * - WANT_TUN : will be a tunnel (CONNECT).
Willy Tarreau5b154472009-12-21 20:11:07 +010076 * - WANT_SCL : enforce close on the server side
77 * - WANT_CLO : enforce close on both sides
78 */
Willy Tarreau70dffda2014-01-30 03:07:23 +010079#define TX_CON_WANT_KAL 0x00000000 /* note: it's important that it is 0 (init) */
80#define TX_CON_WANT_TUN 0x00100000
Willy Tarreau5b154472009-12-21 20:11:07 +010081#define TX_CON_WANT_SCL 0x00200000
82#define TX_CON_WANT_CLO 0x00300000
83#define TX_CON_WANT_MSK 0x00300000 /* this is the mask to get the bits */
84
Willy Tarreaubbf0b372010-01-18 16:54:40 +010085#define TX_CON_CLO_SET 0x00400000 /* "connection: close" is now set */
86#define TX_CON_KAL_SET 0x00800000 /* "connection: keep-alive" is now set */
Willy Tarreau5b154472009-12-21 20:11:07 +010087
Willy Tarreau068621e2013-12-23 15:11:25 +010088#define TX_PREFER_LAST 0x01000000 /* try to stay on same server if possible (eg: after 401) */
Willy Tarreaua36fc4d2012-02-17 17:39:37 +010089
Willy Tarreau50fc7772012-11-11 22:19:57 +010090#define TX_HDR_CONN_UPG 0x02000000 /* The "Upgrade" token was found in the "Connection" header */
Willy Tarreaufcffa692010-01-10 14:21:19 +010091#define TX_WAIT_NEXT_RQ 0x04000000 /* waiting for the second request to start, use keep-alive timeout */
Willy Tarreau5b154472009-12-21 20:11:07 +010092
Willy Tarreaubbf0b372010-01-18 16:54:40 +010093#define TX_HDR_CONN_PRS 0x08000000 /* "connection" header already parsed (req or res), results below */
94#define TX_HDR_CONN_CLO 0x10000000 /* "Connection: close" was present at least once */
95#define TX_HDR_CONN_KAL 0x20000000 /* "Connection: keep-alive" was present at least once */
Willy Tarreau88d349d2010-01-25 12:15:43 +010096#define TX_USE_PX_CONN 0x40000000 /* Use "Proxy-Connection" instead of "Connection" */
Willy Tarreaubbf0b372010-01-18 16:54:40 +010097
Willy Tarreau92954fd2010-10-06 19:38:55 +020098/* used only for keep-alive purposes, to indicate we're on a second transaction */
99#define TX_NOT_FIRST 0x80000000 /* the transaction is not the first one */
100/* no more room for transaction flags ! */
Willy Tarreaubbf0b372010-01-18 16:54:40 +0100101
Willy Tarreau8d5d7f22007-01-21 19:16:41 +0100102/* The HTTP parser is more complex than it looks like, because we have to
103 * support multi-line headers and any number of spaces between the colon and
104 * the value.
105 *
106 * All those examples must work :
107
108 Hdr1:val1\r\n
109 Hdr1: val1\r\n
110 Hdr1:\t val1\r\n
111 Hdr1: \r\n
112 val1\r\n
113 Hdr1:\r\n
114 val1\n
115 \tval2\r\n
116 val3\n
117
118 *
119 */
120
Willy Tarreau58f10d72006-12-04 02:26:12 +0100121/* Possible states while parsing HTTP messages (request|response) */
Willy Tarreau3770f232013-12-07 00:01:53 +0100122enum ht_state {
123 HTTP_MSG_RQBEFORE = 0, // request: leading LF, before start line
124 HTTP_MSG_RQBEFORE_CR = 1, // request: leading CRLF, before start line
125 /* these ones define a request start line */
126 HTTP_MSG_RQMETH = 2, // parsing the Method
127 HTTP_MSG_RQMETH_SP = 3, // space(s) after the Method
128 HTTP_MSG_RQURI = 4, // parsing the Request URI
129 HTTP_MSG_RQURI_SP = 5, // space(s) after the Request URI
130 HTTP_MSG_RQVER = 6, // parsing the Request Version
131 HTTP_MSG_RQLINE_END = 7, // end of request line (CR or LF)
Willy Tarreau8d5d7f22007-01-21 19:16:41 +0100132
Willy Tarreau3770f232013-12-07 00:01:53 +0100133 HTTP_MSG_RPBEFORE = 8, // response: leading LF, before start line
134 HTTP_MSG_RPBEFORE_CR = 9, // response: leading CRLF, before start line
Willy Tarreau8d5d7f22007-01-21 19:16:41 +0100135
Willy Tarreau3770f232013-12-07 00:01:53 +0100136 /* these ones define a response start line */
137 HTTP_MSG_RPVER = 10, // parsing the Response Version
138 HTTP_MSG_RPVER_SP = 11, // space(s) after the Response Version
139 HTTP_MSG_RPCODE = 12, // response code
140 HTTP_MSG_RPCODE_SP = 13, // space(s) after the response code
141 HTTP_MSG_RPREASON = 14, // response reason
142 HTTP_MSG_RPLINE_END = 15, // end of response line (CR or LF)
Willy Tarreau8d5d7f22007-01-21 19:16:41 +0100143
Willy Tarreau3770f232013-12-07 00:01:53 +0100144 /* common header processing */
145 HTTP_MSG_HDR_FIRST = 16, // waiting for first header or last CRLF (no LWS possible)
146 HTTP_MSG_HDR_NAME = 17, // parsing header name
147 HTTP_MSG_HDR_COL = 18, // parsing header colon
148 HTTP_MSG_HDR_L1_SP = 19, // parsing header LWS (SP|HT) before value
149 HTTP_MSG_HDR_L1_LF = 20, // parsing header LWS (LF) before value
150 HTTP_MSG_HDR_L1_LWS = 21, // checking whether it's a new header or an LWS
151 HTTP_MSG_HDR_VAL = 22, // parsing header value
152 HTTP_MSG_HDR_L2_LF = 23, // parsing header LWS (LF) inside/after value
153 HTTP_MSG_HDR_L2_LWS = 24, // checking whether it's a new header or an LWS
Willy Tarreau8d5d7f22007-01-21 19:16:41 +0100154
Willy Tarreau3770f232013-12-07 00:01:53 +0100155 HTTP_MSG_LAST_LF = 25, // parsing last LF
Willy Tarreau8d5d7f22007-01-21 19:16:41 +0100156
Willy Tarreau3770f232013-12-07 00:01:53 +0100157 /* error state : must be before HTTP_MSG_BODY so that (>=BODY) always indicates
158 * that data are being processed.
159 */
160 HTTP_MSG_ERROR = 26, // an error occurred
161 /* Body processing.
162 * The state HTTP_MSG_BODY is a delimiter to know if we're waiting for headers
163 * or body. All the sub-states below also indicate we're processing the body,
164 * with some additional information.
165 */
166 HTTP_MSG_BODY = 27, // parsing body at end of headers
167 HTTP_MSG_100_SENT = 28, // parsing body after a 100-Continue was sent
168 HTTP_MSG_CHUNK_SIZE = 29, // parsing the chunk size (RFC2616 #3.6.1)
169 HTTP_MSG_DATA = 30, // skipping data chunk / content-length data
170 HTTP_MSG_CHUNK_CRLF = 31, // skipping CRLF after data chunk
171 HTTP_MSG_TRAILERS = 32, // trailers (post-data entity headers)
172 /* we enter this state when we've received the end of the current message */
173 HTTP_MSG_DONE = 33, // message end received, waiting for resync or close
174 HTTP_MSG_CLOSING = 34, // shutdown_w done, not all bytes sent yet
175 HTTP_MSG_CLOSED = 35, // shutdown_w done, all bytes sent
176 HTTP_MSG_TUNNEL = 36, // tunneled data after DONE
177} __attribute__((packed));
Willy Tarreaua36fc4d2012-02-17 17:39:37 +0100178
179/*
180 * HTTP message status flags (msg->flags)
181 */
Willy Tarreaua36fc4d2012-02-17 17:39:37 +0100182#define HTTP_MSGF_CNT_LEN 0x00000001 /* content-length was found in the message */
183#define HTTP_MSGF_TE_CHNK 0x00000002 /* transfer-encoding: chunked was found */
184
185/* if this flags is not set in either direction, we may be forced to complete a
186 * connection as a half-way tunnel (eg if no content-length appears in a 1.1
187 * response, but the request is correctly sized)
188 */
189#define HTTP_MSGF_XFER_LEN 0x00000004 /* message xfer size can be determined */
190#define HTTP_MSGF_VER_11 0x00000008 /* the message is HTTP/1.1 or above */
191
Willy Tarreau80a92c02014-03-12 10:41:13 +0100192/* If this flag is set, we don't process the body until the connect() is confirmed.
193 * This is only used by the request forwarding function to protect the buffer
194 * contents if something needs them during a redispatch.
195 */
196#define HTTP_MSGF_WAIT_CONN 0x00000010 /* Wait for connect() to be confirmed before processing body */
Willy Tarreaua36fc4d2012-02-17 17:39:37 +0100197
198
Willy Tarreau79da4692008-11-19 20:03:04 +0100199/* Redirect flags */
200enum {
201 REDIRECT_FLAG_NONE = 0,
202 REDIRECT_FLAG_DROP_QS = 1, /* drop query string */
Willy Tarreau81e3b4f2010-01-10 00:42:19 +0100203 REDIRECT_FLAG_APPEND_SLASH = 2, /* append a slash if missing at the end */
Willy Tarreau79da4692008-11-19 20:03:04 +0100204};
Willy Tarreaub463dfb2008-06-07 23:08:56 +0200205
206/* Redirect types (location, prefix, extended ) */
207enum {
208 REDIRECT_TYPE_NONE = 0, /* no redirection */
209 REDIRECT_TYPE_LOCATION, /* location redirect */
210 REDIRECT_TYPE_PREFIX, /* prefix redirect */
Willy Tarreau2e1dca82012-09-12 08:43:15 +0200211 REDIRECT_TYPE_SCHEME, /* scheme redirect (eg: switch from http to https) */
Willy Tarreaub463dfb2008-06-07 23:08:56 +0200212};
213
Cyril Bonté47fdd8e2010-04-25 00:00:51 +0200214/* Perist types (force-persist, ignore-persist) */
215enum {
216 PERSIST_TYPE_NONE = 0, /* no persistence */
217 PERSIST_TYPE_FORCE, /* force-persist */
218 PERSIST_TYPE_IGNORE, /* ignore-persist */
219};
220
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100221/* Known HTTP methods */
Willy Tarreauc8987b32013-12-06 23:43:17 +0100222enum http_meth_t {
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100223 HTTP_METH_NONE = 0,
224 HTTP_METH_OPTIONS,
225 HTTP_METH_GET,
226 HTTP_METH_HEAD,
227 HTTP_METH_POST,
228 HTTP_METH_PUT,
229 HTTP_METH_DELETE,
230 HTTP_METH_TRACE,
231 HTTP_METH_CONNECT,
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100232 HTTP_METH_OTHER, /* Must be the last entry */
Willy Tarreauc8987b32013-12-06 23:43:17 +0100233} __attribute__((packed));
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100234
Willy Tarreau5735d7e2013-12-07 00:18:34 +0100235enum ht_auth_m {
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +0100236 HTTP_AUTH_WRONG = -1, /* missing or unknown */
237 HTTP_AUTH_UNKNOWN = 0,
238 HTTP_AUTH_BASIC,
239 HTTP_AUTH_DIGEST,
Willy Tarreau5735d7e2013-12-07 00:18:34 +0100240} __attribute__((packed));
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +0100241
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200242/* actions for "http-request" */
Willy Tarreauff011f22011-01-06 17:51:27 +0100243enum {
244 HTTP_REQ_ACT_UNKNOWN = 0,
245 HTTP_REQ_ACT_ALLOW,
246 HTTP_REQ_ACT_DENY,
Willy Tarreauccbcc372012-12-27 12:37:57 +0100247 HTTP_REQ_ACT_TARPIT,
Willy Tarreau20b0de52012-12-24 15:45:22 +0100248 HTTP_REQ_ACT_AUTH,
249 HTTP_REQ_ACT_ADD_HDR,
250 HTTP_REQ_ACT_SET_HDR,
Thierry FOURNIERdad3d1d2014-04-22 18:07:25 +0200251 HTTP_REQ_ACT_DEL_HDR,
Sasha Pachev218f0642014-06-16 12:05:59 -0600252 HTTP_REQ_ACT_REPLACE_HDR,
253 HTTP_REQ_ACT_REPLACE_VAL,
Willy Tarreau81499eb2012-12-27 12:19:02 +0100254 HTTP_REQ_ACT_REDIR,
Willy Tarreauf4c43c12013-06-11 17:01:13 +0200255 HTTP_REQ_ACT_SET_NICE,
Willy Tarreau9a355ec2013-06-11 17:45:46 +0200256 HTTP_REQ_ACT_SET_LOGL,
Willy Tarreau42cf39e2013-06-11 18:51:32 +0200257 HTTP_REQ_ACT_SET_TOS,
Willy Tarreau51347ed2013-06-11 19:34:13 +0200258 HTTP_REQ_ACT_SET_MARK,
Baptiste Assmannfabcbe02014-04-24 22:16:59 +0200259 HTTP_REQ_ACT_ADD_ACL,
260 HTTP_REQ_ACT_DEL_ACL,
261 HTTP_REQ_ACT_DEL_MAP,
262 HTTP_REQ_ACT_SET_MAP,
William Lallemand73025dd2014-04-24 14:38:37 +0200263 HTTP_REQ_ACT_CUSTOM_STOP,
264 HTTP_REQ_ACT_CUSTOM_CONT,
Adis Nezirovic2fbcafc2015-07-06 15:44:30 +0200265 HTTP_REQ_ACT_SET_SRC,
Willy Tarreau09448f72014-06-25 18:12:15 +0200266 HTTP_REQ_ACT_TRK_SC0,
267 /* SC1, SC2, ... SCn */
268 HTTP_REQ_ACT_TRK_SCMAX = HTTP_REQ_ACT_TRK_SC0 + MAX_SESS_STKCTR - 1,
Willy Tarreau20b0de52012-12-24 15:45:22 +0100269 HTTP_REQ_ACT_MAX /* must always be last */
Willy Tarreauff011f22011-01-06 17:51:27 +0100270};
271
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200272/* actions for "http-response" */
273enum {
274 HTTP_RES_ACT_UNKNOWN = 0,
275 HTTP_RES_ACT_ALLOW,
276 HTTP_RES_ACT_DENY,
277 HTTP_RES_ACT_ADD_HDR,
Sasha Pachev218f0642014-06-16 12:05:59 -0600278 HTTP_RES_ACT_REPLACE_HDR,
279 HTTP_RES_ACT_REPLACE_VAL,
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200280 HTTP_RES_ACT_SET_HDR,
Thierry FOURNIERdad3d1d2014-04-22 18:07:25 +0200281 HTTP_RES_ACT_DEL_HDR,
Willy Tarreauf4c43c12013-06-11 17:01:13 +0200282 HTTP_RES_ACT_SET_NICE,
Willy Tarreau9a355ec2013-06-11 17:45:46 +0200283 HTTP_RES_ACT_SET_LOGL,
Willy Tarreau42cf39e2013-06-11 18:51:32 +0200284 HTTP_RES_ACT_SET_TOS,
Willy Tarreau51347ed2013-06-11 19:34:13 +0200285 HTTP_RES_ACT_SET_MARK,
Baptiste Assmannfabcbe02014-04-24 22:16:59 +0200286 HTTP_RES_ACT_ADD_ACL,
287 HTTP_RES_ACT_DEL_ACL,
288 HTTP_RES_ACT_DEL_MAP,
289 HTTP_RES_ACT_SET_MAP,
Willy Tarreau51d861a2015-05-22 17:30:48 +0200290 HTTP_RES_ACT_REDIR,
William Lallemand73025dd2014-04-24 14:38:37 +0200291 HTTP_RES_ACT_CUSTOM_STOP, /* used for module keywords */
292 HTTP_RES_ACT_CUSTOM_CONT, /* used for module keywords */
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200293 HTTP_RES_ACT_MAX /* must always be last */
294};
295
Willy Tarreau0b748332014-04-29 00:13:29 +0200296/* final results for http-request rules */
297enum rule_result {
298 HTTP_RULE_RES_CONT = 0, /* nothing special, continue rules evaluation */
Thierry FOURNIERbc4c1ac2015-02-25 13:36:14 +0100299 HTTP_RULE_RES_YIELD, /* call me later because some data is missing. */
Willy Tarreau0b748332014-04-29 00:13:29 +0200300 HTTP_RULE_RES_STOP, /* stopped processing on an accept */
301 HTTP_RULE_RES_DENY, /* deny (or tarpit if TX_CLTARPIT) */
302 HTTP_RULE_RES_ABRT, /* abort request, msg already sent (eg: auth) */
303 HTTP_RULE_RES_DONE, /* processing done, stop processing (eg: redirect) */
304 HTTP_RULE_RES_BADREQ, /* bad request */
305};
306
Willy Tarreau436d9ed2011-05-11 16:10:11 +0200307/*
308 * All implemented return codes
309 */
310enum {
Willy Tarreauae94d4d2011-05-11 16:28:49 +0200311 HTTP_ERR_200 = 0,
312 HTTP_ERR_400,
Willy Tarreau436d9ed2011-05-11 16:10:11 +0200313 HTTP_ERR_403,
CJ Ess108b1dd2015-04-07 12:03:37 -0400314 HTTP_ERR_405,
Willy Tarreau436d9ed2011-05-11 16:10:11 +0200315 HTTP_ERR_408,
CJ Ess108b1dd2015-04-07 12:03:37 -0400316 HTTP_ERR_429,
Willy Tarreau436d9ed2011-05-11 16:10:11 +0200317 HTTP_ERR_500,
318 HTTP_ERR_502,
319 HTTP_ERR_503,
320 HTTP_ERR_504,
321 HTTP_ERR_SIZE
322};
323
Cyril Bonté19979e12012-04-04 12:57:21 +0200324/* status codes available for the stats admin page */
325enum {
326 STAT_STATUS_INIT = 0,
327 STAT_STATUS_DENY, /* action denied */
328 STAT_STATUS_DONE, /* the action is successful */
329 STAT_STATUS_ERRP, /* an error occured due to invalid values in parameters */
330 STAT_STATUS_EXCD, /* an error occured because the buffer couldn't store all data */
331 STAT_STATUS_NONE, /* nothing happened (no action chosen or servers state didn't change) */
332 STAT_STATUS_PART, /* the action is partially successful */
333 STAT_STATUS_UNKN, /* an unknown error occured, shouldn't happen */
334 STAT_STATUS_SIZE
335};
336
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100337/* This is an HTTP message, as described in RFC2616. It can be either a request
338 * message or a response message.
339 *
340 * The values there are a little bit obscure, because their meaning can change
Willy Tarreaubb2e6692014-07-10 19:06:10 +0200341 * during the parsing. Please read carefully doc/internal/body-parsing.txt if
342 * you need to manipulate them. Quick reminder :
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100343 *
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100344 * - eoh (End of Headers) : relative offset in the buffer of first byte that
345 * is not part of a completely processed header.
346 * During parsing, it points to last header seen
Willy Tarreaufa355d42009-11-29 18:12:29 +0100347 * for states after START. When in HTTP_MSG_BODY,
348 * eoh points to the first byte of the last CRLF
Willy Tarreauea1175a2012-03-05 15:52:30 +0100349 * preceeding data. Relative to buffer's origin.
Willy Tarreau0558a022014-03-13 15:48:45 +0100350 * This value then remains unchanged till the end
351 * so that we can rewind the buffer to change some
352 * headers if needed (eg: http-send-name-header).
353 *
Willy Tarreau877e78d2013-04-07 18:48:08 +0200354 * - sov (start of value) : Before HTTP_MSG_BODY, points to the value of
355 * the header being parsed. Starting from
356 * HTTP_MSG_BODY, will point to the start of the
Willy Tarreaubb2e6692014-07-10 19:06:10 +0200357 * body (relative to buffer's origin). It can be
358 * negative when forwarding data. It stops growing
359 * once data start to leave the buffer.
Willy Tarreau877e78d2013-04-07 18:48:08 +0200360 *
361 * - next (parse pointer) : next relative byte to be parsed. Always points
362 * to a byte matching the current state.
363 *
Willy Tarreau30fe8182015-05-01 23:14:54 +0200364 * - sol (start of line) : start of current line before MSG_BODY. Starting
365 * from MSG_BODY, contains the length of the last
366 * parsed chunk size so that when added to sov it
367 * always points to the beginning of the current
368 * data chunk.
Willy Tarreau0558a022014-03-13 15:48:45 +0100369 *
370 * - eol (End of Line) : Before HTTP_MSG_BODY, relative offset in the
371 * buffer of the first byte which marks the end of
372 * the line current (LF or CRLF).
373 * From HTTP_MSG_BODY to the end, contains the
374 * length of the last CRLF (1 for a plain LF, or 2
375 * for a true CRLF). So eoh+eol always contain the
376 * exact size of the header size.
377 *
Willy Tarreauea1175a2012-03-05 15:52:30 +0100378 * Note that all offsets are relative to the origin of the buffer (buf->p)
379 * which always points to the beginning of the message (request or response).
380 * Since a message may not wrap, pointer computations may be one without any
381 * care for wrapping (no addition overflow nor subtract underflow).
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100382 */
383struct http_msg {
Willy Tarreau3770f232013-12-07 00:01:53 +0100384 enum ht_state msg_state; /* where we are in the current message parsing */
385 unsigned char flags; /* flags describing the message (HTTP version, ...) */
386 /* 6 bytes unused here */
Willy Tarreau394db372012-10-12 22:40:39 +0200387 struct channel *chn; /* pointer to the channel transporting the message */
Willy Tarreaua458b672012-03-05 11:17:50 +0100388 unsigned int next; /* pointer to next byte to parse, relative to buf->p */
Willy Tarreaubb2e6692014-07-10 19:06:10 +0200389 int sov; /* current header: start of value ; data: start of body */
Willy Tarreaufa355d42009-11-29 18:12:29 +0100390 unsigned int eoh; /* End Of Headers, relative to buffer */
Willy Tarreau09d1e252012-05-18 22:36:34 +0200391 unsigned int sol; /* start of current line during parsing otherwise zero */
Willy Tarreau12e48b32012-03-05 16:57:34 +0100392 unsigned int eol; /* end of line */
Willy Tarreaufa355d42009-11-29 18:12:29 +0100393 int err_pos; /* err handling: -2=block, -1=pass, 0+=detected */
Willy Tarreau962c3f42010-01-10 00:15:35 +0100394 union { /* useful start line pointers, relative to ->sol */
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100395 struct {
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200396 int l; /* request line length (not including CR) */
Willy Tarreau26927362012-05-18 23:22:52 +0200397 int m_l; /* METHOD length (method starts at buf->p) */
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200398 int u, u_l; /* URI, length */
399 int v, v_l; /* VERSION, length */
400 } rq; /* request line : field, length */
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100401 struct {
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200402 int l; /* status line length (not including CR) */
Willy Tarreau26927362012-05-18 23:22:52 +0200403 int v_l; /* VERSION length (version starts at buf->p) */
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200404 int c, c_l; /* CODE, length */
405 int r, r_l; /* REASON, length */
406 } st; /* status line : field, length */
407 } sl; /* start line */
Willy Tarreau124d9912011-03-01 20:30:48 +0100408 unsigned long long chunk_len; /* cache for last chunk size or content-length header value */
409 unsigned long long body_len; /* total known length of the body, excluding encoding */
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100410};
411
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +0100412struct http_auth_data {
Willy Tarreau5735d7e2013-12-07 00:18:34 +0100413 enum ht_auth_m method; /* one of HTTP_AUTH_* */
414 /* 7 bytes unused here */
415 struct chunk method_data; /* points to the creditial part from 'Authorization:' header */
416 char *user, *pass; /* extracted username & password */
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +0100417};
418
William Lallemand73025dd2014-04-24 14:38:37 +0200419struct proxy;
420struct http_txn;
Willy Tarreau87b09662015-04-03 00:22:06 +0200421struct stream;
William Lallemand73025dd2014-04-24 14:38:37 +0200422
Willy Tarreauff011f22011-01-06 17:51:27 +0100423struct http_req_rule {
424 struct list list;
Willy Tarreau5c2e1982012-12-24 12:00:25 +0100425 struct acl_cond *cond; /* acl condition to meet */
426 unsigned int action; /* HTTP_REQ_* */
CJ Ess108b1dd2015-04-07 12:03:37 -0400427 short deny_status; /* HTTP status to return to user when denying */
Willy Tarreau987e3fb2015-04-04 01:09:08 +0200428 int (*action_ptr)(struct http_req_rule *rule, struct proxy *px, struct stream *s); /* ptr to custom action */
Willy Tarreau5c2e1982012-12-24 12:00:25 +0100429 union {
430 struct {
431 char *realm;
432 } auth; /* arg used by "auth" */
Willy Tarreau20b0de52012-12-24 15:45:22 +0100433 struct {
434 char *name; /* header name */
435 int name_len; /* header name's length */
436 struct list fmt; /* log-format compatible expression */
Thierry FOURNIER09af0d62014-06-18 11:35:54 +0200437 struct my_regex re; /* used by replace-header and replace-value */
Willy Tarreau20b0de52012-12-24 15:45:22 +0100438 } hdr_add; /* args used by "add-header" and "set-header" */
Willy Tarreau81499eb2012-12-27 12:19:02 +0100439 struct redirect_rule *redir; /* redirect rule or "http-request redirect" */
Willy Tarreauf4c43c12013-06-11 17:01:13 +0200440 int nice; /* nice value for HTTP_REQ_ACT_SET_NICE */
Willy Tarreau9a355ec2013-06-11 17:45:46 +0200441 int loglevel; /* log-level value for HTTP_REQ_ACT_SET_LOGL */
Willy Tarreau42cf39e2013-06-11 18:51:32 +0200442 int tos; /* tos value for HTTP_REQ_ACT_SET_TOS */
Willy Tarreau51347ed2013-06-11 19:34:13 +0200443 int mark; /* nfmark value for HTTP_REQ_ACT_SET_MARK */
William Lallemand2a831112014-05-06 18:43:27 +0200444 void *data; /* generic pointer for module or external rule */
Baptiste Assmannfabcbe02014-04-24 22:16:59 +0200445 struct {
446 char *ref; /* MAP or ACL file name to update */
447 struct list key; /* pattern to retrieve MAP or ACL key */
448 struct list value; /* pattern to retrieve MAP value */
449 } map;
Willy Tarreaua0dc23f2015-01-22 20:46:11 +0100450 struct {
451 void *p[4];
452 } act; /* generic pointers to be used by custom actions */
Willy Tarreau5c2e1982012-12-24 12:00:25 +0100453 } arg; /* arguments used by some actions */
Willy Tarreau09448f72014-06-25 18:12:15 +0200454
455 union {
456 struct track_ctr_prm trk_ctr;
457 } act_prm;
Willy Tarreauff011f22011-01-06 17:51:27 +0100458};
459
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200460struct http_res_rule {
461 struct list list;
462 struct acl_cond *cond; /* acl condition to meet */
463 unsigned int action; /* HTTP_RES_* */
Willy Tarreau987e3fb2015-04-04 01:09:08 +0200464 int (*action_ptr)(struct http_res_rule *rule, struct proxy *px, struct stream *s); /* ptr to custom action */
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200465 union {
466 struct {
467 char *name; /* header name */
468 int name_len; /* header name's length */
469 struct list fmt; /* log-format compatible expression */
Thierry FOURNIER09af0d62014-06-18 11:35:54 +0200470 struct my_regex re; /* used by replace-header and replace-value */
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200471 } hdr_add; /* args used by "add-header" and "set-header" */
Willy Tarreau51d861a2015-05-22 17:30:48 +0200472 struct redirect_rule *redir; /* redirect rule or "http-request redirect" */
Willy Tarreauf4c43c12013-06-11 17:01:13 +0200473 int nice; /* nice value for HTTP_RES_ACT_SET_NICE */
Willy Tarreau9a355ec2013-06-11 17:45:46 +0200474 int loglevel; /* log-level value for HTTP_RES_ACT_SET_LOGL */
Willy Tarreau42cf39e2013-06-11 18:51:32 +0200475 int tos; /* tos value for HTTP_RES_ACT_SET_TOS */
Willy Tarreau51347ed2013-06-11 19:34:13 +0200476 int mark; /* nfmark value for HTTP_RES_ACT_SET_MARK */
William Lallemand2a831112014-05-06 18:43:27 +0200477 void *data; /* generic pointer for module or external rule */
Baptiste Assmannfabcbe02014-04-24 22:16:59 +0200478 struct {
479 char *ref; /* MAP or ACL file name to update */
480 struct list key; /* pattern to retrieve MAP or ACL key */
481 struct list value; /* pattern to retrieve MAP value */
482 } map;
Thierry FOURNIERcdb67ca2015-05-26 17:38:47 +0200483 struct {
484 void *p[4];
485 } act; /* generic pointers to be used by custom actions */
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200486 } arg; /* arguments used by some actions */
487};
488
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100489/* This is an HTTP transaction. It contains both a request message and a
490 * response message (which can be empty).
491 */
492struct http_txn {
Willy Tarreauac1932d2011-10-24 19:14:41 +0200493 struct hdr_idx hdr_idx; /* array of header indexes (max: global.tune.max_http_hdr) */
Willy Tarreau520bbb22010-01-10 11:31:22 +0100494 struct http_msg rsp; /* HTTP response message */
Willy Tarreauc8987b32013-12-06 23:43:17 +0100495 struct http_msg req; /* HTTP request message */
496 unsigned int flags; /* transaction flags */
497 enum http_meth_t meth; /* HTTP method */
498 /* 1 unused byte here */
CJ Ess108b1dd2015-04-07 12:03:37 -0400499 short rule_deny_status; /* HTTP status from rule when denying */
Willy Tarreauc8987b32013-12-06 23:43:17 +0100500 short status; /* HTTP status from the server, negative if from proxy */
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100501
Willy Tarreau520bbb22010-01-10 11:31:22 +0100502 char *uri; /* first line if log needed, NULL otherwise */
503 char *cli_cookie; /* cookie presented by the client, in capture mode */
504 char *srv_cookie; /* cookie presented by the server, in capture mode */
Willy Tarreauf64d1412010-10-07 20:06:11 +0200505 int cookie_first_date; /* if non-zero, first date the expirable cookie was set/seen */
506 int cookie_last_date; /* if non-zero, last date the expirable cookie was set/seen */
Willy Tarreau520bbb22010-01-10 11:31:22 +0100507
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +0100508 struct http_auth_data auth; /* HTTP auth data */
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100509};
510
William Lallemand73025dd2014-04-24 14:38:37 +0200511
Willy Tarreau33a7e692007-06-10 19:45:56 +0200512/* This structure is used by http_find_header() to return values of headers.
Willy Tarreau588bd4f2011-09-01 22:22:28 +0200513 * The header starts at <line>, the value (excluding leading and trailing white
514 * spaces) at <line>+<val> for <vlen> bytes, followed by optional <tws> trailing
515 * white spaces, and sets <line>+<del> to point to the last delimitor (colon or
516 * comma) before this value. <prev> points to the index of the header whose next
517 * is this one.
Willy Tarreau33a7e692007-06-10 19:45:56 +0200518 */
519struct hdr_ctx {
Willy Tarreau68085d82010-01-18 14:54:04 +0100520 char *line;
Willy Tarreau33a7e692007-06-10 19:45:56 +0200521 int idx;
Willy Tarreau588bd4f2011-09-01 22:22:28 +0200522 int val; /* relative to line, may skip some leading white spaces */
523 int vlen; /* relative to line+val, stops before trailing white spaces */
524 int tws; /* added to vlen if some trailing white spaces are present */
Willy Tarreau68085d82010-01-18 14:54:04 +0100525 int del; /* relative to line */
526 int prev; /* index of previous header */
Willy Tarreau33a7e692007-06-10 19:45:56 +0200527};
Willy Tarreau58f10d72006-12-04 02:26:12 +0100528
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100529struct http_method_name {
530 char *name;
531 int len;
532};
533
William Lallemand73025dd2014-04-24 14:38:37 +0200534struct http_req_action_kw {
535 const char *kw;
536 int (*parse)(const char **args, int *cur_arg, struct proxy *px, struct http_req_rule *rule, char **err);
Thierry FOURNIER0e118632015-06-04 11:44:06 +0200537 int match_pfx;
William Lallemand73025dd2014-04-24 14:38:37 +0200538};
539
540struct http_res_action_kw {
541 const char *kw;
542 int (*parse)(const char **args, int *cur_arg, struct proxy *px, struct http_res_rule *rule, char **err);
Thierry FOURNIER0e118632015-06-04 11:44:06 +0200543 int match_pfx;
William Lallemand73025dd2014-04-24 14:38:37 +0200544};
545
546struct http_req_action_kw_list {
547 const char *scope;
548 struct list list;
549 struct http_req_action_kw kw[VAR_ARRAY];
550};
551
552struct http_res_action_kw_list {
553 const char *scope;
554 struct list list;
555 struct http_res_action_kw kw[VAR_ARRAY];
556};
557
558extern struct http_req_action_kw_list http_req_keywords;
559extern struct http_res_action_kw_list http_res_keywords;
560
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100561extern const struct http_method_name http_known_methods[HTTP_METH_OTHER];
562
Willy Tarreaueee5b512015-04-03 23:46:31 +0200563extern struct pool_head *pool2_http_txn;
564
Willy Tarreaubaaee002006-06-26 02:48:02 +0200565#endif /* _TYPES_PROTO_HTTP_H */
566
567/*
568 * Local variables:
569 * c-indent-level: 8
570 * c-basic-offset: 8
571 * End:
572 */