blob: c53c7fdd4b813c14b9e812e30a0aab428ef72d44 [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>
31
Willy Tarreaufcffa692010-01-10 14:21:19 +010032/* These are the flags that are found in txn->flags */
Willy Tarreau3d300592007-03-18 18:34:41 +010033
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 */
39#define TX_CLTARPIT 0x00000010 /* the session is tarpitted (anti-dos) */
Willy Tarreaub608feb2010-01-02 22:47:18 +010040
Willy Tarreau92954fd2010-10-06 19:38:55 +020041/* transaction flags dedicated to cookies : bits values 0x20 to 0x80 (0-7 shift 5) */
Willy Tarreau3d300592007-03-18 18:34:41 +010042#define TX_CK_NONE 0x00000000 /* this session had no cookie */
Willy Tarreau92954fd2010-10-06 19:38:55 +020043#define TX_CK_INVALID 0x00000020 /* this session had a cookie which matches no server */
44#define TX_CK_DOWN 0x00000040 /* this session had cookie matching a down server */
45#define TX_CK_VALID 0x00000060 /* this session had cookie matching a valid server */
Willy Tarreaub761ec42010-10-07 15:28:23 +020046#define TX_CK_EXPIRED 0x00000080 /* this session had an expired cookie (idle for too long) */
47#define TX_CK_OLD 0x000000A0 /* this session had too old a cookie (offered too long ago) */
Willy Tarreauc89ccb62012-04-05 21:18:22 +020048#define TX_CK_UNUSED 0x000000C0 /* this session had a cookie but it was not used (eg: use-server was preferred) */
Willy Tarreau92954fd2010-10-06 19:38:55 +020049#define TX_CK_MASK 0x000000E0 /* mask to get this session's cookie flags */
50#define TX_CK_SHIFT 5 /* bit shift */
Willy Tarreau3d300592007-03-18 18:34:41 +010051
Willy Tarreauf1348312010-10-07 15:54:11 +020052/* 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 Tarreau3d300592007-03-18 18:34:41 +010059#define TX_SCK_MASK 0x00000700 /* mask to get the set-cookie field */
Willy Tarreau3d300592007-03-18 18:34:41 +010060#define TX_SCK_SHIFT 8 /* bit shift */
Willy Tarreauf1348312010-10-07 15:54:11 +020061
62#define TX_SCK_PRESENT 0x00000800 /* a cookie was found in the server's response */
Willy Tarreau3d300592007-03-18 18:34:41 +010063
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 Tarreaua36fc4d2012-02-17 17:39:37 +010069/* Unused: 0x4000, 0x8000, 0x10000, 0x20000, 0x80000 */
Willy Tarreaubaaee002006-06-26 02:48:02 +020070
Willy Tarreau5b154472009-12-21 20:11:07 +010071/* indicate how we *want* the connection to behave, regardless of what is in
72 * the headers. We have 4 possible values right now :
Willy Tarreau70dffda2014-01-30 03:07:23 +010073 * - WANT_KAL : try to maintain keep-alive (default hwen nothing configured)
74 * - WANT_TUN : will be a tunnel (CONNECT).
Willy Tarreau5b154472009-12-21 20:11:07 +010075 * - WANT_SCL : enforce close on the server side
76 * - WANT_CLO : enforce close on both sides
77 */
Willy Tarreau70dffda2014-01-30 03:07:23 +010078#define TX_CON_WANT_KAL 0x00000000 /* note: it's important that it is 0 (init) */
79#define TX_CON_WANT_TUN 0x00100000
Willy Tarreau5b154472009-12-21 20:11:07 +010080#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 Tarreaubbf0b372010-01-18 16:54:40 +010084#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 Tarreau5b154472009-12-21 20:11:07 +010086
Willy Tarreau068621e2013-12-23 15:11:25 +010087#define TX_PREFER_LAST 0x01000000 /* try to stay on same server if possible (eg: after 401) */
Willy Tarreaua36fc4d2012-02-17 17:39:37 +010088
Willy Tarreau50fc7772012-11-11 22:19:57 +010089#define TX_HDR_CONN_UPG 0x02000000 /* The "Upgrade" token was found in the "Connection" header */
Willy Tarreaufcffa692010-01-10 14:21:19 +010090#define TX_WAIT_NEXT_RQ 0x04000000 /* waiting for the second request to start, use keep-alive timeout */
Willy Tarreau5b154472009-12-21 20:11:07 +010091
Willy Tarreaubbf0b372010-01-18 16:54:40 +010092#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 Tarreau88d349d2010-01-25 12:15:43 +010095#define TX_USE_PX_CONN 0x40000000 /* Use "Proxy-Connection" instead of "Connection" */
Willy Tarreaubbf0b372010-01-18 16:54:40 +010096
Willy Tarreau92954fd2010-10-06 19:38:55 +020097/* 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 Tarreaubbf0b372010-01-18 16:54:40 +0100100
Willy Tarreau8d5d7f22007-01-21 19:16:41 +0100101/* 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 Tarreau58f10d72006-12-04 02:26:12 +0100120/* Possible states while parsing HTTP messages (request|response) */
Willy Tarreau3770f232013-12-07 00:01:53 +0100121enum 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 Tarreau8d5d7f22007-01-21 19:16:41 +0100131
Willy Tarreau3770f232013-12-07 00:01:53 +0100132 HTTP_MSG_RPBEFORE = 8, // response: leading LF, before start line
133 HTTP_MSG_RPBEFORE_CR = 9, // response: leading CRLF, before start line
Willy Tarreau8d5d7f22007-01-21 19:16:41 +0100134
Willy Tarreau3770f232013-12-07 00:01:53 +0100135 /* 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 Tarreau8d5d7f22007-01-21 19:16:41 +0100142
Willy Tarreau3770f232013-12-07 00:01:53 +0100143 /* 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 Tarreau8d5d7f22007-01-21 19:16:41 +0100153
Willy Tarreau3770f232013-12-07 00:01:53 +0100154 HTTP_MSG_LAST_LF = 25, // parsing last LF
Willy Tarreau8d5d7f22007-01-21 19:16:41 +0100155
Willy Tarreau3770f232013-12-07 00:01:53 +0100156 /* 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 Tarreaua36fc4d2012-02-17 17:39:37 +0100177
178/*
179 * HTTP message status flags (msg->flags)
180 */
Willy Tarreaua36fc4d2012-02-17 17:39:37 +0100181#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 Tarreau80a92c02014-03-12 10:41:13 +0100191/* 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 Tarreaua36fc4d2012-02-17 17:39:37 +0100196
197
Willy Tarreau79da4692008-11-19 20:03:04 +0100198/* Redirect flags */
199enum {
200 REDIRECT_FLAG_NONE = 0,
201 REDIRECT_FLAG_DROP_QS = 1, /* drop query string */
Willy Tarreau81e3b4f2010-01-10 00:42:19 +0100202 REDIRECT_FLAG_APPEND_SLASH = 2, /* append a slash if missing at the end */
Willy Tarreau79da4692008-11-19 20:03:04 +0100203};
Willy Tarreaub463dfb2008-06-07 23:08:56 +0200204
205/* Redirect types (location, prefix, extended ) */
206enum {
207 REDIRECT_TYPE_NONE = 0, /* no redirection */
208 REDIRECT_TYPE_LOCATION, /* location redirect */
209 REDIRECT_TYPE_PREFIX, /* prefix redirect */
Willy Tarreau2e1dca82012-09-12 08:43:15 +0200210 REDIRECT_TYPE_SCHEME, /* scheme redirect (eg: switch from http to https) */
Willy Tarreaub463dfb2008-06-07 23:08:56 +0200211};
212
Cyril Bonté47fdd8e2010-04-25 00:00:51 +0200213/* Perist types (force-persist, ignore-persist) */
214enum {
215 PERSIST_TYPE_NONE = 0, /* no persistence */
216 PERSIST_TYPE_FORCE, /* force-persist */
217 PERSIST_TYPE_IGNORE, /* ignore-persist */
218};
219
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100220/* Known HTTP methods */
Willy Tarreauc8987b32013-12-06 23:43:17 +0100221enum http_meth_t {
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100222 HTTP_METH_NONE = 0,
223 HTTP_METH_OPTIONS,
224 HTTP_METH_GET,
225 HTTP_METH_HEAD,
226 HTTP_METH_POST,
227 HTTP_METH_PUT,
228 HTTP_METH_DELETE,
229 HTTP_METH_TRACE,
230 HTTP_METH_CONNECT,
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100231 HTTP_METH_OTHER, /* Must be the last entry */
Willy Tarreauc8987b32013-12-06 23:43:17 +0100232} __attribute__((packed));
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100233
Willy Tarreau5735d7e2013-12-07 00:18:34 +0100234enum ht_auth_m {
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +0100235 HTTP_AUTH_WRONG = -1, /* missing or unknown */
236 HTTP_AUTH_UNKNOWN = 0,
237 HTTP_AUTH_BASIC,
238 HTTP_AUTH_DIGEST,
Willy Tarreau5735d7e2013-12-07 00:18:34 +0100239} __attribute__((packed));
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +0100240
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200241/* actions for "http-request" */
Willy Tarreauff011f22011-01-06 17:51:27 +0100242enum {
243 HTTP_REQ_ACT_UNKNOWN = 0,
244 HTTP_REQ_ACT_ALLOW,
245 HTTP_REQ_ACT_DENY,
Willy Tarreauccbcc372012-12-27 12:37:57 +0100246 HTTP_REQ_ACT_TARPIT,
Willy Tarreau20b0de52012-12-24 15:45:22 +0100247 HTTP_REQ_ACT_AUTH,
248 HTTP_REQ_ACT_ADD_HDR,
249 HTTP_REQ_ACT_SET_HDR,
Thierry FOURNIERdad3d1d2014-04-22 18:07:25 +0200250 HTTP_REQ_ACT_DEL_HDR,
Sasha Pachev218f0642014-06-16 12:05:59 -0600251 HTTP_REQ_ACT_REPLACE_HDR,
252 HTTP_REQ_ACT_REPLACE_VAL,
Willy Tarreau81499eb2012-12-27 12:19:02 +0100253 HTTP_REQ_ACT_REDIR,
Willy Tarreauf4c43c12013-06-11 17:01:13 +0200254 HTTP_REQ_ACT_SET_NICE,
Willy Tarreau9a355ec2013-06-11 17:45:46 +0200255 HTTP_REQ_ACT_SET_LOGL,
Willy Tarreau42cf39e2013-06-11 18:51:32 +0200256 HTTP_REQ_ACT_SET_TOS,
Willy Tarreau51347ed2013-06-11 19:34:13 +0200257 HTTP_REQ_ACT_SET_MARK,
Baptiste Assmannfabcbe02014-04-24 22:16:59 +0200258 HTTP_REQ_ACT_ADD_ACL,
259 HTTP_REQ_ACT_DEL_ACL,
260 HTTP_REQ_ACT_DEL_MAP,
261 HTTP_REQ_ACT_SET_MAP,
William Lallemand73025dd2014-04-24 14:38:37 +0200262 HTTP_REQ_ACT_CUSTOM_STOP,
263 HTTP_REQ_ACT_CUSTOM_CONT,
Willy Tarreau20b0de52012-12-24 15:45:22 +0100264 HTTP_REQ_ACT_MAX /* must always be last */
Willy Tarreauff011f22011-01-06 17:51:27 +0100265};
266
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200267/* actions for "http-response" */
268enum {
269 HTTP_RES_ACT_UNKNOWN = 0,
270 HTTP_RES_ACT_ALLOW,
271 HTTP_RES_ACT_DENY,
272 HTTP_RES_ACT_ADD_HDR,
Sasha Pachev218f0642014-06-16 12:05:59 -0600273 HTTP_RES_ACT_REPLACE_HDR,
274 HTTP_RES_ACT_REPLACE_VAL,
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200275 HTTP_RES_ACT_SET_HDR,
Thierry FOURNIERdad3d1d2014-04-22 18:07:25 +0200276 HTTP_RES_ACT_DEL_HDR,
Willy Tarreauf4c43c12013-06-11 17:01:13 +0200277 HTTP_RES_ACT_SET_NICE,
Willy Tarreau9a355ec2013-06-11 17:45:46 +0200278 HTTP_RES_ACT_SET_LOGL,
Willy Tarreau42cf39e2013-06-11 18:51:32 +0200279 HTTP_RES_ACT_SET_TOS,
Willy Tarreau51347ed2013-06-11 19:34:13 +0200280 HTTP_RES_ACT_SET_MARK,
Baptiste Assmannfabcbe02014-04-24 22:16:59 +0200281 HTTP_RES_ACT_ADD_ACL,
282 HTTP_RES_ACT_DEL_ACL,
283 HTTP_RES_ACT_DEL_MAP,
284 HTTP_RES_ACT_SET_MAP,
William Lallemand73025dd2014-04-24 14:38:37 +0200285 HTTP_RES_ACT_CUSTOM_STOP, /* used for module keywords */
286 HTTP_RES_ACT_CUSTOM_CONT, /* used for module keywords */
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200287 HTTP_RES_ACT_MAX /* must always be last */
288};
289
Willy Tarreau0b748332014-04-29 00:13:29 +0200290/* final results for http-request rules */
291enum rule_result {
292 HTTP_RULE_RES_CONT = 0, /* nothing special, continue rules evaluation */
293 HTTP_RULE_RES_STOP, /* stopped processing on an accept */
294 HTTP_RULE_RES_DENY, /* deny (or tarpit if TX_CLTARPIT) */
295 HTTP_RULE_RES_ABRT, /* abort request, msg already sent (eg: auth) */
296 HTTP_RULE_RES_DONE, /* processing done, stop processing (eg: redirect) */
297 HTTP_RULE_RES_BADREQ, /* bad request */
298};
299
Willy Tarreau436d9ed2011-05-11 16:10:11 +0200300/*
301 * All implemented return codes
302 */
303enum {
Willy Tarreauae94d4d2011-05-11 16:28:49 +0200304 HTTP_ERR_200 = 0,
305 HTTP_ERR_400,
Willy Tarreau436d9ed2011-05-11 16:10:11 +0200306 HTTP_ERR_403,
307 HTTP_ERR_408,
308 HTTP_ERR_500,
309 HTTP_ERR_502,
310 HTTP_ERR_503,
311 HTTP_ERR_504,
312 HTTP_ERR_SIZE
313};
314
Cyril Bonté19979e12012-04-04 12:57:21 +0200315/* status codes available for the stats admin page */
316enum {
317 STAT_STATUS_INIT = 0,
318 STAT_STATUS_DENY, /* action denied */
319 STAT_STATUS_DONE, /* the action is successful */
320 STAT_STATUS_ERRP, /* an error occured due to invalid values in parameters */
321 STAT_STATUS_EXCD, /* an error occured because the buffer couldn't store all data */
322 STAT_STATUS_NONE, /* nothing happened (no action chosen or servers state didn't change) */
323 STAT_STATUS_PART, /* the action is partially successful */
324 STAT_STATUS_UNKN, /* an unknown error occured, shouldn't happen */
325 STAT_STATUS_SIZE
326};
327
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100328/* This is an HTTP message, as described in RFC2616. It can be either a request
329 * message or a response message.
330 *
331 * The values there are a little bit obscure, because their meaning can change
Willy Tarreau5bebcd02014-07-10 19:06:10 +0200332 * during the parsing. Please read carefully doc/internal/body-parsing.txt if
333 * you need to manipulate them. Quick reminder :
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100334 *
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100335 * - eoh (End of Headers) : relative offset in the buffer of first byte that
336 * is not part of a completely processed header.
337 * During parsing, it points to last header seen
Willy Tarreaufa355d42009-11-29 18:12:29 +0100338 * for states after START. When in HTTP_MSG_BODY,
339 * eoh points to the first byte of the last CRLF
Willy Tarreauea1175a2012-03-05 15:52:30 +0100340 * preceeding data. Relative to buffer's origin.
Willy Tarreau0558a022014-03-13 15:48:45 +0100341 * This value then remains unchanged till the end
342 * so that we can rewind the buffer to change some
343 * headers if needed (eg: http-send-name-header).
344 *
Willy Tarreau877e78d2013-04-07 18:48:08 +0200345 * - sov (start of value) : Before HTTP_MSG_BODY, points to the value of
346 * the header being parsed. Starting from
347 * HTTP_MSG_BODY, will point to the start of the
Willy Tarreau5bebcd02014-07-10 19:06:10 +0200348 * body (relative to buffer's origin). It can be
349 * negative when forwarding data. It stops growing
350 * once data start to leave the buffer.
Willy Tarreau877e78d2013-04-07 18:48:08 +0200351 *
352 * - next (parse pointer) : next relative byte to be parsed. Always points
353 * to a byte matching the current state.
354 *
355 * - sol (start of line) : start of current line before MSG_BODY, or zero.
Willy Tarreau0558a022014-03-13 15:48:45 +0100356 *
357 * - eol (End of Line) : Before HTTP_MSG_BODY, relative offset in the
358 * buffer of the first byte which marks the end of
359 * the line current (LF or CRLF).
360 * From HTTP_MSG_BODY to the end, contains the
361 * length of the last CRLF (1 for a plain LF, or 2
362 * for a true CRLF). So eoh+eol always contain the
363 * exact size of the header size.
364 *
Willy Tarreauea1175a2012-03-05 15:52:30 +0100365 * Note that all offsets are relative to the origin of the buffer (buf->p)
366 * which always points to the beginning of the message (request or response).
367 * Since a message may not wrap, pointer computations may be one without any
368 * care for wrapping (no addition overflow nor subtract underflow).
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100369 */
370struct http_msg {
Willy Tarreau3770f232013-12-07 00:01:53 +0100371 enum ht_state msg_state; /* where we are in the current message parsing */
372 unsigned char flags; /* flags describing the message (HTTP version, ...) */
373 /* 6 bytes unused here */
Willy Tarreau394db372012-10-12 22:40:39 +0200374 struct channel *chn; /* pointer to the channel transporting the message */
Willy Tarreaua458b672012-03-05 11:17:50 +0100375 unsigned int next; /* pointer to next byte to parse, relative to buf->p */
Willy Tarreau5bebcd02014-07-10 19:06:10 +0200376 int sov; /* current header: start of value ; data: start of body */
Willy Tarreaufa355d42009-11-29 18:12:29 +0100377 unsigned int eoh; /* End Of Headers, relative to buffer */
Willy Tarreau09d1e252012-05-18 22:36:34 +0200378 unsigned int sol; /* start of current line during parsing otherwise zero */
Willy Tarreau12e48b32012-03-05 16:57:34 +0100379 unsigned int eol; /* end of line */
Willy Tarreaufa355d42009-11-29 18:12:29 +0100380 int err_pos; /* err handling: -2=block, -1=pass, 0+=detected */
Willy Tarreau962c3f42010-01-10 00:15:35 +0100381 union { /* useful start line pointers, relative to ->sol */
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100382 struct {
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200383 int l; /* request line length (not including CR) */
Willy Tarreau26927362012-05-18 23:22:52 +0200384 int m_l; /* METHOD length (method starts at buf->p) */
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200385 int u, u_l; /* URI, length */
386 int v, v_l; /* VERSION, length */
387 } rq; /* request line : field, length */
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100388 struct {
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200389 int l; /* status line length (not including CR) */
Willy Tarreau26927362012-05-18 23:22:52 +0200390 int v_l; /* VERSION length (version starts at buf->p) */
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200391 int c, c_l; /* CODE, length */
392 int r, r_l; /* REASON, length */
393 } st; /* status line : field, length */
394 } sl; /* start line */
Willy Tarreau124d9912011-03-01 20:30:48 +0100395 unsigned long long chunk_len; /* cache for last chunk size or content-length header value */
396 unsigned long long body_len; /* total known length of the body, excluding encoding */
Willy Tarreaufa355d42009-11-29 18:12:29 +0100397 char **cap; /* array of captured headers (may be NULL) */
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100398};
399
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +0100400struct http_auth_data {
Willy Tarreau5735d7e2013-12-07 00:18:34 +0100401 enum ht_auth_m method; /* one of HTTP_AUTH_* */
402 /* 7 bytes unused here */
403 struct chunk method_data; /* points to the creditial part from 'Authorization:' header */
404 char *user, *pass; /* extracted username & password */
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +0100405};
406
William Lallemand73025dd2014-04-24 14:38:37 +0200407struct proxy;
408struct http_txn;
409struct session;
410
Willy Tarreauff011f22011-01-06 17:51:27 +0100411struct http_req_rule {
412 struct list list;
Willy Tarreau5c2e1982012-12-24 12:00:25 +0100413 struct acl_cond *cond; /* acl condition to meet */
414 unsigned int action; /* HTTP_REQ_* */
William Lallemand73025dd2014-04-24 14:38:37 +0200415 int (*action_ptr)(struct http_req_rule *rule, struct proxy *px, struct session *s, struct http_txn *http_txn); /* ptr to custom action */
Willy Tarreau5c2e1982012-12-24 12:00:25 +0100416 union {
417 struct {
418 char *realm;
419 } auth; /* arg used by "auth" */
Willy Tarreau20b0de52012-12-24 15:45:22 +0100420 struct {
421 char *name; /* header name */
422 int name_len; /* header name's length */
423 struct list fmt; /* log-format compatible expression */
Thierry FOURNIER09af0d62014-06-18 11:35:54 +0200424 struct my_regex re; /* used by replace-header and replace-value */
Willy Tarreau20b0de52012-12-24 15:45:22 +0100425 } hdr_add; /* args used by "add-header" and "set-header" */
Willy Tarreau81499eb2012-12-27 12:19:02 +0100426 struct redirect_rule *redir; /* redirect rule or "http-request redirect" */
Willy Tarreauf4c43c12013-06-11 17:01:13 +0200427 int nice; /* nice value for HTTP_REQ_ACT_SET_NICE */
Willy Tarreau9a355ec2013-06-11 17:45:46 +0200428 int loglevel; /* log-level value for HTTP_REQ_ACT_SET_LOGL */
Willy Tarreau42cf39e2013-06-11 18:51:32 +0200429 int tos; /* tos value for HTTP_REQ_ACT_SET_TOS */
Willy Tarreau51347ed2013-06-11 19:34:13 +0200430 int mark; /* nfmark value for HTTP_REQ_ACT_SET_MARK */
William Lallemand2a831112014-05-06 18:43:27 +0200431 void *data; /* generic pointer for module or external rule */
Baptiste Assmannfabcbe02014-04-24 22:16:59 +0200432 struct {
433 char *ref; /* MAP or ACL file name to update */
434 struct list key; /* pattern to retrieve MAP or ACL key */
435 struct list value; /* pattern to retrieve MAP value */
436 } map;
Willy Tarreau5c2e1982012-12-24 12:00:25 +0100437 } arg; /* arguments used by some actions */
Willy Tarreauff011f22011-01-06 17:51:27 +0100438};
439
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200440struct http_res_rule {
441 struct list list;
442 struct acl_cond *cond; /* acl condition to meet */
443 unsigned int action; /* HTTP_RES_* */
William Lallemand73025dd2014-04-24 14:38:37 +0200444 int (*action_ptr)(struct http_res_rule *rule, struct proxy *px, struct session *s, struct http_txn *http_txn); /* ptr to custom action */
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200445 union {
446 struct {
447 char *name; /* header name */
448 int name_len; /* header name's length */
449 struct list fmt; /* log-format compatible expression */
Thierry FOURNIER09af0d62014-06-18 11:35:54 +0200450 struct my_regex re; /* used by replace-header and replace-value */
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200451 } hdr_add; /* args used by "add-header" and "set-header" */
Willy Tarreauf4c43c12013-06-11 17:01:13 +0200452 int nice; /* nice value for HTTP_RES_ACT_SET_NICE */
Willy Tarreau9a355ec2013-06-11 17:45:46 +0200453 int loglevel; /* log-level value for HTTP_RES_ACT_SET_LOGL */
Willy Tarreau42cf39e2013-06-11 18:51:32 +0200454 int tos; /* tos value for HTTP_RES_ACT_SET_TOS */
Willy Tarreau51347ed2013-06-11 19:34:13 +0200455 int mark; /* nfmark value for HTTP_RES_ACT_SET_MARK */
William Lallemand2a831112014-05-06 18:43:27 +0200456 void *data; /* generic pointer for module or external rule */
Baptiste Assmannfabcbe02014-04-24 22:16:59 +0200457 struct {
458 char *ref; /* MAP or ACL file name to update */
459 struct list key; /* pattern to retrieve MAP or ACL key */
460 struct list value; /* pattern to retrieve MAP value */
461 } map;
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200462 } arg; /* arguments used by some actions */
463};
464
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100465/* This is an HTTP transaction. It contains both a request message and a
466 * response message (which can be empty).
467 */
468struct http_txn {
Willy Tarreauac1932d2011-10-24 19:14:41 +0200469 struct hdr_idx hdr_idx; /* array of header indexes (max: global.tune.max_http_hdr) */
Willy Tarreau520bbb22010-01-10 11:31:22 +0100470 struct http_msg rsp; /* HTTP response message */
Willy Tarreauc8987b32013-12-06 23:43:17 +0100471 struct http_msg req; /* HTTP request message */
472 unsigned int flags; /* transaction flags */
473 enum http_meth_t meth; /* HTTP method */
474 /* 1 unused byte here */
475 short status; /* HTTP status from the server, negative if from proxy */
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100476
Willy Tarreau520bbb22010-01-10 11:31:22 +0100477 char *uri; /* first line if log needed, NULL otherwise */
478 char *cli_cookie; /* cookie presented by the client, in capture mode */
479 char *srv_cookie; /* cookie presented by the server, in capture mode */
Willy Tarreaua3377ee2010-01-10 10:49:11 +0100480 char *sessid; /* the appsession id, if found in the request or in the response */
Willy Tarreauf64d1412010-10-07 20:06:11 +0200481 int cookie_first_date; /* if non-zero, first date the expirable cookie was set/seen */
482 int cookie_last_date; /* if non-zero, last date the expirable cookie was set/seen */
Willy Tarreau520bbb22010-01-10 11:31:22 +0100483
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +0100484 struct http_auth_data auth; /* HTTP auth data */
Willy Tarreau3bac9ff2007-03-18 17:31:28 +0100485};
486
William Lallemand73025dd2014-04-24 14:38:37 +0200487
Willy Tarreau33a7e692007-06-10 19:45:56 +0200488/* This structure is used by http_find_header() to return values of headers.
Willy Tarreau588bd4f2011-09-01 22:22:28 +0200489 * The header starts at <line>, the value (excluding leading and trailing white
490 * spaces) at <line>+<val> for <vlen> bytes, followed by optional <tws> trailing
491 * white spaces, and sets <line>+<del> to point to the last delimitor (colon or
492 * comma) before this value. <prev> points to the index of the header whose next
493 * is this one.
Willy Tarreau33a7e692007-06-10 19:45:56 +0200494 */
495struct hdr_ctx {
Willy Tarreau68085d82010-01-18 14:54:04 +0100496 char *line;
Willy Tarreau33a7e692007-06-10 19:45:56 +0200497 int idx;
Willy Tarreau588bd4f2011-09-01 22:22:28 +0200498 int val; /* relative to line, may skip some leading white spaces */
499 int vlen; /* relative to line+val, stops before trailing white spaces */
500 int tws; /* added to vlen if some trailing white spaces are present */
Willy Tarreau68085d82010-01-18 14:54:04 +0100501 int del; /* relative to line */
502 int prev; /* index of previous header */
Willy Tarreau33a7e692007-06-10 19:45:56 +0200503};
Willy Tarreau58f10d72006-12-04 02:26:12 +0100504
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100505struct http_method_name {
506 char *name;
507 int len;
508};
509
William Lallemand73025dd2014-04-24 14:38:37 +0200510struct http_req_action_kw {
511 const char *kw;
512 int (*parse)(const char **args, int *cur_arg, struct proxy *px, struct http_req_rule *rule, char **err);
513};
514
515struct http_res_action_kw {
516 const char *kw;
517 int (*parse)(const char **args, int *cur_arg, struct proxy *px, struct http_res_rule *rule, char **err);
518};
519
520struct http_req_action_kw_list {
521 const char *scope;
522 struct list list;
523 struct http_req_action_kw kw[VAR_ARRAY];
524};
525
526struct http_res_action_kw_list {
527 const char *scope;
528 struct list list;
529 struct http_res_action_kw kw[VAR_ARRAY];
530};
531
532extern struct http_req_action_kw_list http_req_keywords;
533extern struct http_res_action_kw_list http_res_keywords;
534
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100535extern const struct http_method_name http_known_methods[HTTP_METH_OTHER];
536
Willy Tarreaubaaee002006-06-26 02:48:02 +0200537#endif /* _TYPES_PROTO_HTTP_H */
538
539/*
540 * Local variables:
541 * c-indent-level: 8
542 * c-basic-offset: 8
543 * End:
544 */