blob: 0fe779090e02ce49f052759424a5d2b00959fd7f [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
Willy Tarreaub0c9bc42009-10-04 15:56:38 +02002 * include/proto/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 Tarreaub0c9bc42009-10-04 15:56:38 +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 _PROTO_PROTO_HTTP_H
23#define _PROTO_PROTO_HTTP_H
24
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020025#include <common/config.h>
Thierry FOURNIERec3c37d2015-09-10 18:28:10 +020026#include <types/action.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020027#include <types/proto_http.h>
Willy Tarreau87b09662015-04-03 00:22:06 +020028#include <types/stream.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020029#include <types/task.h>
30
Willy Tarreau58f10d72006-12-04 02:26:12 +010031/*
32 * some macros used for the request parsing.
Lukas Tribus23953682017-04-28 13:24:30 +000033 * from RFC7230:
Willy Tarreau58f10d72006-12-04 02:26:12 +010034 * CTL = <any US-ASCII control character (octets 0 - 31) and DEL (127)>
Willy Tarreau8d5d7f22007-01-21 19:16:41 +010035 * SEP = one of the 17 defined separators or SP or HT
36 * LWS = CR, LF, SP or HT
37 * SPHT = SP or HT. Use this macro and not a boolean expression for best speed.
38 * CRLF = CR or LF. Use this macro and not a boolean expression for best speed.
39 * token = any CHAR except CTL or SEP. Use this macro and not a boolean expression for best speed.
Willy Tarreau4b89ad42007-03-04 18:13:58 +010040 *
41 * added for ease of use:
42 * ver_token = 'H', 'P', 'T', '/', '.', and digits.
Willy Tarreau58f10d72006-12-04 02:26:12 +010043 */
Willy Tarreau58f10d72006-12-04 02:26:12 +010044
Willy Tarreau2235b262016-11-05 15:50:20 +010045extern const unsigned char http_char_classes[256];
46
47#define HTTP_FLG_CTL 0x01
48#define HTTP_FLG_SEP 0x02
49#define HTTP_FLG_LWS 0x04
50#define HTTP_FLG_SPHT 0x08
51#define HTTP_FLG_CRLF 0x10
52#define HTTP_FLG_TOK 0x20
53#define HTTP_FLG_VER 0x40
54
55#define HTTP_IS_CTL(x) (http_char_classes[(unsigned char)(x)] & HTTP_FLG_CTL)
56#define HTTP_IS_SEP(x) (http_char_classes[(unsigned char)(x)] & HTTP_FLG_SEP)
57#define HTTP_IS_LWS(x) (http_char_classes[(unsigned char)(x)] & HTTP_FLG_LWS)
58#define HTTP_IS_SPHT(x) (http_char_classes[(unsigned char)(x)] & HTTP_FLG_SPHT)
59#define HTTP_IS_CRLF(x) (http_char_classes[(unsigned char)(x)] & HTTP_FLG_CRLF)
60#define HTTP_IS_TOKEN(x) (http_char_classes[(unsigned char)(x)] & HTTP_FLG_TOK)
61#define HTTP_IS_VER_TOKEN(x) (http_char_classes[(unsigned char)(x)] & HTTP_FLG_VER)
Willy Tarreau8d5d7f22007-01-21 19:16:41 +010062
Willy Tarreaua5480692017-07-26 08:07:15 +020063/* Macros used in the HTTP parser, to check for the expected presence of
64 * certain bytes (ef: LF) or to skip to next byte and yield in case of failure.
65 */
66
67
68/* Expects to find an LF at <ptr>. If not, set <state> to <where> and jump to
69 * <bad>.
70 */
71#define EXPECT_LF_HERE(ptr, bad, state, where) \
72 do { \
73 if (unlikely(*(ptr) != '\n')) { \
74 state = (where); \
75 goto bad; \
76 } \
77 } while (0)
78
79/* Increments pointer <ptr>, continues to label <more> if it's still below
80 * pointer <end>, or goes to <stop> and sets <state> to <where> if the end
81 * of buffer was reached.
82 */
83#define EAT_AND_JUMP_OR_RETURN(ptr, end, more, stop, state, where) \
84 do { \
85 if (likely(++(ptr) < (end))) \
86 goto more; \
87 else { \
88 state = (where); \
89 goto stop; \
90 } \
91 } while (0)
92
93
Willy Tarreau436d9ed2011-05-11 16:10:11 +020094extern const int http_err_codes[HTTP_ERR_SIZE];
95extern struct chunk http_err_chunks[HTTP_ERR_SIZE];
96extern const char *HTTP_302;
97extern const char *HTTP_303;
98
Willy Tarreau87b09662015-04-03 00:22:06 +020099int process_cli(struct stream *s);
100int process_srv_data(struct stream *s);
101int process_srv_conn(struct stream *s);
102int http_wait_for_request(struct stream *s, struct channel *req, int an_bit);
103int http_process_req_common(struct stream *s, struct channel *req, int an_bit, struct proxy *px);
104int http_process_request(struct stream *s, struct channel *req, int an_bit);
105int http_process_tarpit(struct stream *s, struct channel *req, int an_bit);
106int http_wait_for_request_body(struct stream *s, struct channel *req, int an_bit);
Willy Tarreau45c0d982012-03-09 12:11:57 +0100107int http_send_name_header(struct http_txn *txn, struct proxy* be, const char* svr_name);
Willy Tarreau87b09662015-04-03 00:22:06 +0200108int http_wait_for_response(struct stream *s, struct channel *rep, int an_bit);
109int http_process_res_common(struct stream *s, struct channel *rep, int an_bit, struct proxy *px);
110int http_request_forward_body(struct stream *s, struct channel *req, int an_bit);
111int http_response_forward_body(struct stream *s, struct channel *res, int an_bit);
Thierry FOURNIER8d16de02015-09-25 11:06:37 +0200112void http_msg_analyzer(struct http_msg *msg, struct hdr_idx *idx);
Thierry FOURNIERfd50f0b2015-09-25 18:53:18 +0200113void http_txn_reset_req(struct http_txn *txn);
114void http_txn_reset_res(struct http_txn *txn);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200115
Willy Tarreau87b09662015-04-03 00:22:06 +0200116void debug_hdr(const char *dir, struct stream *s, const char *start, const char *end);
Willy Tarreau87b09662015-04-03 00:22:06 +0200117int apply_filter_to_req_headers(struct stream *s, struct channel *req, struct hdr_exp *exp);
118int apply_filter_to_req_line(struct stream *s, struct channel *req, struct hdr_exp *exp);
119int apply_filters_to_request(struct stream *s, struct channel *req, struct proxy *px);
120int apply_filters_to_response(struct stream *s, struct channel *rtr, struct proxy *px);
Willy Tarreau87b09662015-04-03 00:22:06 +0200121void manage_client_side_cookies(struct stream *s, struct channel *req);
122void manage_server_side_cookies(struct stream *s, struct channel *rtr);
123void check_response_for_cacheability(struct stream *s, struct channel *rtr);
Willy Tarreau295a8372011-03-10 11:25:07 +0100124int stats_check_uri(struct stream_interface *si, struct http_txn *txn, struct proxy *backend);
Willy Tarreau80587432006-12-24 17:47:20 +0100125void init_proto_http();
Willy Tarreau04ff9f12013-06-10 18:39:42 +0200126int http_find_full_header2(const char *name, int len,
127 char *sol, struct hdr_idx *idx,
128 struct hdr_ctx *ctx);
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200129int http_find_header2(const char *name, int len,
Willy Tarreau68085d82010-01-18 14:54:04 +0100130 char *sol, struct hdr_idx *idx,
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200131 struct hdr_ctx *ctx);
David Carlier4686f792015-09-25 14:10:50 +0100132int http_find_next_header(char *sol, struct hdr_idx *idx,
133 struct hdr_ctx *ctx);
Thierry FOURNIERde6617b2013-10-15 11:43:19 +0200134char *find_hdr_value_end(char *s, const char *e);
David Carlier4686f792015-09-25 14:10:50 +0100135char *extract_cookie_value(char *hdr, const char *hdr_end, char *cookie_name,
136 size_t cookie_name_l, int list, char **value, int *value_l);
Thierry FOURNIERde6617b2013-10-15 11:43:19 +0200137int http_header_match2(const char *hdr, const char *end, const char *name, int len);
138int http_remove_header2(struct http_msg *msg, struct hdr_idx *idx, struct hdr_ctx *ctx);
139int http_header_add_tail2(struct http_msg *msg, struct hdr_idx *hdr_idx, const char *text, int len);
Willy Tarreau987e3fb2015-04-04 01:09:08 +0200140int http_replace_req_line(int action, const char *replace, int len, struct proxy *px, struct stream *s);
Robin H. Johnson52f5db22017-01-01 13:10:52 -0800141void http_set_status(unsigned int status, const char *reason, struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200142int http_transform_header_str(struct stream* s, struct http_msg *msg, const char* name,
Thierry FOURNIER5531f872015-03-16 11:15:50 +0100143 unsigned int name_len, const char *str, struct my_regex *re,
144 int action);
Vincent Bernat6e615892016-05-18 16:17:44 +0200145void inet_set_tos(int fd, const struct sockaddr_storage *from, int tos);
Willy Tarreau87b09662015-04-03 00:22:06 +0200146void http_perform_server_redirect(struct stream *s, struct stream_interface *si);
147void http_return_srv_error(struct stream *s, struct stream_interface *si);
148void http_capture_bad_message(struct error_snapshot *es, struct stream *s,
Willy Tarreau8a0cef22012-03-09 13:39:23 +0100149 struct http_msg *msg,
Willy Tarreau3770f232013-12-07 00:01:53 +0100150 enum ht_state state, struct proxy *other_end);
Willy Tarreau185b5c42012-04-26 15:11:51 +0200151unsigned int http_get_hdr(const struct http_msg *msg, const char *hname, int hlen,
Willy Tarreau294c4732011-12-16 21:35:50 +0100152 struct hdr_idx *idx, int occ,
153 struct hdr_ctx *ctx, char **vptr, int *vlen);
Thierry FOURNIER3c331782015-09-17 19:33:35 +0200154char *http_get_path(struct http_txn *txn);
Thierry FOURNIER127169e2015-09-18 17:59:23 +0200155const char *get_reason(unsigned int status);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200156
Willy Tarreaueee5b512015-04-03 23:46:31 +0200157struct http_txn *http_alloc_txn(struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200158void http_init_txn(struct stream *s);
159void http_end_txn(struct stream *s);
160void http_reset_txn(struct stream *s);
Christopher Fauletd7c91962015-04-30 11:48:27 +0200161void http_end_txn_clean_session(struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200162void http_adjust_conn_mode(struct stream *s, struct http_txn *txn, struct http_msg *msg);
Willy Tarreau0937bc42009-12-22 15:03:09 +0100163
Thierry FOURNIERa28a9422015-08-04 19:35:46 +0200164struct act_rule *parse_http_req_cond(const char **args, const char *file, int linenum, struct proxy *proxy);
165struct act_rule *parse_http_res_cond(const char **args, const char *file, int linenum, struct proxy *proxy);
Willy Tarreauff011f22011-01-06 17:51:27 +0100166void free_http_req_rules(struct list *r);
Sasha Pachev218f0642014-06-16 12:05:59 -0600167void free_http_res_rules(struct list *r);
Christopher Fauleta94e5a52015-12-09 15:55:06 +0100168void http_reply_and_close(struct stream *s, short status, struct chunk *msg);
Jarno Huuskonen9e6906b2017-03-06 14:21:49 +0200169struct chunk *http_error_message(struct stream *s);
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +0100170struct redirect_rule *http_parse_redirect_rule(const char *file, int linenum, struct proxy *curproxy,
Willy Tarreaube4653b2015-05-28 15:26:58 +0200171 const char **args, char **errmsg, int use_fmt, int dir);
Thierry FOURNIER0786d052015-05-11 15:42:45 +0200172int smp_fetch_cookie(const struct arg *args, struct sample *smp, const char *kw, void *private);
173int smp_fetch_base32(const struct arg *args, struct sample *smp, const char *kw, void *private);
Willy Tarreauff011f22011-01-06 17:51:27 +0100174
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100175enum http_meth_t find_http_meth(const char *str, const int len);
176
Thierry FOURNIER36481b82015-08-19 09:01:53 +0200177struct action_kw *action_http_req_custom(const char *kw);
178struct action_kw *action_http_res_custom(const char *kw);
Thierry FOURNIER49f45af2014-12-08 19:50:43 +0100179int val_hdr(struct arg *arg, char **err_msg);
William Lallemand73025dd2014-04-24 14:38:37 +0200180
James Rosewell91a41cb2015-09-18 17:11:16 +0100181int smp_prefetch_http(struct proxy *px, struct stream *s, unsigned int opt,
182 const struct arg *args, struct sample *smp, int req_vol);
183
Baptiste Assmanne9544932015-11-03 23:31:35 +0100184enum act_return http_action_req_capture_by_id(struct act_rule *rule, struct proxy *px,
185 struct session *sess, struct stream *s, int flags);
186enum act_return http_action_res_capture_by_id(struct act_rule *rule, struct proxy *px,
187 struct session *sess, struct stream *s, int flags);
188
Christopher Faulet3d97c902015-12-09 14:59:38 +0100189int parse_qvalue(const char *qvalue, const char **end);
190
James Rosewell91a41cb2015-09-18 17:11:16 +0100191/* Note: these functions *do* modify the sample. Even in case of success, at
192 * least the type and uint value are modified.
193 */
194#define CHECK_HTTP_MESSAGE_FIRST() \
195 do { int r = smp_prefetch_http(smp->px, smp->strm, smp->opt, args, smp, 1); if (r <= 0) return r; } while (0)
196
197#define CHECK_HTTP_MESSAGE_FIRST_PERM() \
198 do { int r = smp_prefetch_http(smp->px, smp->strm, smp->opt, args, smp, 0); if (r <= 0) return r; } while (0)
199
Thierry FOURNIER36481b82015-08-19 09:01:53 +0200200static inline void http_req_keywords_register(struct action_kw_list *kw_list)
William Lallemand73025dd2014-04-24 14:38:37 +0200201{
202 LIST_ADDQ(&http_req_keywords.list, &kw_list->list);
203}
204
Thierry FOURNIER36481b82015-08-19 09:01:53 +0200205static inline void http_res_keywords_register(struct action_kw_list *kw_list)
William Lallemand73025dd2014-04-24 14:38:37 +0200206{
207 LIST_ADDQ(&http_res_keywords.list, &kw_list->list);
208}
209
210
Willy Tarreaufa355d42009-11-29 18:12:29 +0100211/* to be used when contents change in an HTTP message */
212#define http_msg_move_end(msg, bytes) do { \
213 unsigned int _bytes = (bytes); \
Willy Tarreaua458b672012-03-05 11:17:50 +0100214 (msg)->next += (_bytes); \
Willy Tarreaufa355d42009-11-29 18:12:29 +0100215 (msg)->sov += (_bytes); \
216 (msg)->eoh += (_bytes); \
217 } while (0)
218
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200219
Willy Tarreau211cdec2014-04-17 20:18:08 +0200220/* Return the amount of bytes that need to be rewound before buf->p to access
221 * the current message's headers. The purpose is to be able to easily fetch
222 * the message's beginning before headers are forwarded, as well as after.
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200223 * The principle is that msg->eoh and msg->eol are immutable while msg->sov
224 * equals the sum of the two before forwarding and is zero after forwarding,
225 * so the difference cancels the rewinding.
Willy Tarreau211cdec2014-04-17 20:18:08 +0200226 */
227static inline int http_hdr_rewind(const struct http_msg *msg)
228{
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200229 return msg->eoh + msg->eol - msg->sov;
Willy Tarreau211cdec2014-04-17 20:18:08 +0200230}
231
Willy Tarreauda6eed62014-04-17 20:24:24 +0200232/* Return the amount of bytes that need to be rewound before buf->p to access
233 * the current message's URI. The purpose is to be able to easily fetch
234 * the message's beginning before headers are forwarded, as well as after.
235 */
236static inline int http_uri_rewind(const struct http_msg *msg)
237{
238 return http_hdr_rewind(msg) - msg->sl.rq.u;
239}
240
Willy Tarreau0d090502014-04-17 20:31:44 +0200241/* Return the amount of bytes that need to be rewound before buf->p to access
242 * the current message's BODY. The purpose is to be able to easily fetch
243 * the message's beginning before headers are forwarded, as well as after.
244 */
245static inline int http_body_rewind(const struct http_msg *msg)
246{
247 return http_hdr_rewind(msg) - msg->eoh - msg->eol;
248}
249
250/* Return the amount of bytes that need to be rewound before buf->p to access
251 * the current message's DATA. The difference with the function above is that
252 * if a chunk is present and has already been parsed, its size is skipped so
253 * that the byte pointed to is the first byte of actual data. The function is
254 * safe for use in state HTTP_MSG_DATA regardless of whether the headers were
255 * already forwarded or not.
256 */
257static inline int http_data_rewind(const struct http_msg *msg)
258{
259 return http_body_rewind(msg) - msg->sol;
260}
261
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200262/* Return the maximum amount of bytes that may be read after the beginning of
263 * the message body, according to the advertised length. The function is safe
264 * for use between HTTP_MSG_BODY and HTTP_MSG_DATA regardless of whether the
265 * headers were already forwarded or not.
266 */
267static inline int http_body_bytes(const struct http_msg *msg)
268{
269 int len;
270
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200271 len = msg->chn->buf->i - msg->sov - msg->sol;
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200272 if (len > msg->body_len)
273 len = msg->body_len;
274 return len;
275}
276
Ruoshan Huange4edc6b2016-07-14 15:07:45 +0800277/* for an http-request/response action ACT_ACTION_TRK_SC*, return a tracking index
Willy Tarreau09448f72014-06-25 18:12:15 +0200278 * starting at zero for SC0. Unknown actions also return zero.
279 */
Ruoshan Huange4edc6b2016-07-14 15:07:45 +0800280static inline int http_trk_idx(int trk_action)
Willy Tarreau09448f72014-06-25 18:12:15 +0200281{
Thierry FOURNIER0ea5c7f2015-08-05 19:05:19 +0200282 return trk_action - ACT_ACTION_TRK_SC0;
Willy Tarreau09448f72014-06-25 18:12:15 +0200283}
284
Willy Tarreau88c6d812012-11-21 21:50:04 +0100285/* for debugging, reports the HTTP message state name */
286static inline const char *http_msg_state_str(int msg_state)
287{
288 switch (msg_state) {
289 case HTTP_MSG_RQBEFORE: return "MSG_RQBEFORE";
290 case HTTP_MSG_RQBEFORE_CR: return "MSG_RQBEFORE_CR";
291 case HTTP_MSG_RQMETH: return "MSG_RQMETH";
292 case HTTP_MSG_RQMETH_SP: return "MSG_RQMETH_SP";
293 case HTTP_MSG_RQURI: return "MSG_RQURI";
294 case HTTP_MSG_RQURI_SP: return "MSG_RQURI_SP";
295 case HTTP_MSG_RQVER: return "MSG_RQVER";
296 case HTTP_MSG_RQLINE_END: return "MSG_RQLINE_END";
297 case HTTP_MSG_RPBEFORE: return "MSG_RPBEFORE";
298 case HTTP_MSG_RPBEFORE_CR: return "MSG_RPBEFORE_CR";
299 case HTTP_MSG_RPVER: return "MSG_RPVER";
300 case HTTP_MSG_RPVER_SP: return "MSG_RPVER_SP";
301 case HTTP_MSG_RPCODE: return "MSG_RPCODE";
302 case HTTP_MSG_RPCODE_SP: return "MSG_RPCODE_SP";
303 case HTTP_MSG_RPREASON: return "MSG_RPREASON";
304 case HTTP_MSG_RPLINE_END: return "MSG_RPLINE_END";
305 case HTTP_MSG_HDR_FIRST: return "MSG_HDR_FIRST";
306 case HTTP_MSG_HDR_NAME: return "MSG_HDR_NAME";
307 case HTTP_MSG_HDR_COL: return "MSG_HDR_COL";
308 case HTTP_MSG_HDR_L1_SP: return "MSG_HDR_L1_SP";
309 case HTTP_MSG_HDR_L1_LF: return "MSG_HDR_L1_LF";
310 case HTTP_MSG_HDR_L1_LWS: return "MSG_HDR_L1_LWS";
311 case HTTP_MSG_HDR_VAL: return "MSG_HDR_VAL";
312 case HTTP_MSG_HDR_L2_LF: return "MSG_HDR_L2_LF";
313 case HTTP_MSG_HDR_L2_LWS: return "MSG_HDR_L2_LWS";
314 case HTTP_MSG_LAST_LF: return "MSG_LAST_LF";
315 case HTTP_MSG_ERROR: return "MSG_ERROR";
316 case HTTP_MSG_BODY: return "MSG_BODY";
317 case HTTP_MSG_100_SENT: return "MSG_100_SENT";
318 case HTTP_MSG_CHUNK_SIZE: return "MSG_CHUNK_SIZE";
319 case HTTP_MSG_DATA: return "MSG_DATA";
320 case HTTP_MSG_CHUNK_CRLF: return "MSG_CHUNK_CRLF";
321 case HTTP_MSG_TRAILERS: return "MSG_TRAILERS";
Christopher Fauletd7c91962015-04-30 11:48:27 +0200322 case HTTP_MSG_ENDING: return "MSG_ENDING";
Willy Tarreau88c6d812012-11-21 21:50:04 +0100323 case HTTP_MSG_DONE: return "MSG_DONE";
324 case HTTP_MSG_CLOSING: return "MSG_CLOSING";
325 case HTTP_MSG_CLOSED: return "MSG_CLOSED";
326 case HTTP_MSG_TUNNEL: return "MSG_TUNNEL";
327 default: return "MSG_??????";
328 }
329}
330
Willy Tarreaubaaee002006-06-26 02:48:02 +0200331#endif /* _PROTO_PROTO_HTTP_H */
332
333/*
334 * Local variables:
335 * c-indent-level: 8
336 * c-basic-offset: 8
337 * End:
338 */