blob: 1b8da066181654379e3ee3f078ecb0bb2ccc22ff [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>
Willy Tarreau3ee83442018-06-15 16:42:02 +020030#include <proto/channel.h>
Willy Tarreau0da5b3b2017-09-21 09:30:46 +020031#include <proto/h1.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020032
Willy Tarreau58f10d72006-12-04 02:26:12 +010033/*
34 * some macros used for the request parsing.
Lukas Tribus23953682017-04-28 13:24:30 +000035 * from RFC7230:
Willy Tarreau58f10d72006-12-04 02:26:12 +010036 * CTL = <any US-ASCII control character (octets 0 - 31) and DEL (127)>
Willy Tarreau8d5d7f22007-01-21 19:16:41 +010037 * SEP = one of the 17 defined separators or SP or HT
38 * LWS = CR, LF, SP or HT
39 * SPHT = SP or HT. Use this macro and not a boolean expression for best speed.
40 * CRLF = CR or LF. Use this macro and not a boolean expression for best speed.
41 * 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 +010042 *
43 * added for ease of use:
44 * ver_token = 'H', 'P', 'T', '/', '.', and digits.
Willy Tarreau58f10d72006-12-04 02:26:12 +010045 */
Willy Tarreau58f10d72006-12-04 02:26:12 +010046
Willy Tarreau87b09662015-04-03 00:22:06 +020047int process_cli(struct stream *s);
48int process_srv_data(struct stream *s);
49int process_srv_conn(struct stream *s);
50int http_wait_for_request(struct stream *s, struct channel *req, int an_bit);
51int http_process_req_common(struct stream *s, struct channel *req, int an_bit, struct proxy *px);
52int http_process_request(struct stream *s, struct channel *req, int an_bit);
53int http_process_tarpit(struct stream *s, struct channel *req, int an_bit);
54int http_wait_for_request_body(struct stream *s, struct channel *req, int an_bit);
Willy Tarreau45c0d982012-03-09 12:11:57 +010055int http_send_name_header(struct http_txn *txn, struct proxy* be, const char* svr_name);
Willy Tarreau87b09662015-04-03 00:22:06 +020056int http_wait_for_response(struct stream *s, struct channel *rep, int an_bit);
57int http_process_res_common(struct stream *s, struct channel *rep, int an_bit, struct proxy *px);
58int http_request_forward_body(struct stream *s, struct channel *req, int an_bit);
59int http_response_forward_body(struct stream *s, struct channel *res, int an_bit);
Thierry FOURNIER8d16de02015-09-25 11:06:37 +020060void http_msg_analyzer(struct http_msg *msg, struct hdr_idx *idx);
Thierry FOURNIERfd50f0b2015-09-25 18:53:18 +020061void http_txn_reset_req(struct http_txn *txn);
62void http_txn_reset_res(struct http_txn *txn);
Willy Tarreaubaaee002006-06-26 02:48:02 +020063
Willy Tarreau87b09662015-04-03 00:22:06 +020064void debug_hdr(const char *dir, struct stream *s, const char *start, const char *end);
Willy Tarreau87b09662015-04-03 00:22:06 +020065int apply_filter_to_req_headers(struct stream *s, struct channel *req, struct hdr_exp *exp);
66int apply_filter_to_req_line(struct stream *s, struct channel *req, struct hdr_exp *exp);
67int apply_filters_to_request(struct stream *s, struct channel *req, struct proxy *px);
68int apply_filters_to_response(struct stream *s, struct channel *rtr, struct proxy *px);
Willy Tarreau87b09662015-04-03 00:22:06 +020069void manage_client_side_cookies(struct stream *s, struct channel *req);
70void manage_server_side_cookies(struct stream *s, struct channel *rtr);
Willy Tarreau0ad8e0d2017-12-22 15:03:36 +010071void check_request_for_cacheability(struct stream *s, struct channel *chn);
Willy Tarreau87b09662015-04-03 00:22:06 +020072void check_response_for_cacheability(struct stream *s, struct channel *rtr);
Willy Tarreau295a8372011-03-10 11:25:07 +010073int stats_check_uri(struct stream_interface *si, struct http_txn *txn, struct proxy *backend);
Willy Tarreau80587432006-12-24 17:47:20 +010074void init_proto_http();
Willy Tarreau04ff9f12013-06-10 18:39:42 +020075int http_find_full_header2(const char *name, int len,
76 char *sol, struct hdr_idx *idx,
77 struct hdr_ctx *ctx);
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +020078int http_find_header2(const char *name, int len,
Willy Tarreau68085d82010-01-18 14:54:04 +010079 char *sol, struct hdr_idx *idx,
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +020080 struct hdr_ctx *ctx);
David Carlier4686f792015-09-25 14:10:50 +010081int http_find_next_header(char *sol, struct hdr_idx *idx,
82 struct hdr_ctx *ctx);
Thierry FOURNIERde6617b2013-10-15 11:43:19 +020083char *find_hdr_value_end(char *s, const char *e);
David Carlier4686f792015-09-25 14:10:50 +010084char *extract_cookie_value(char *hdr, const char *hdr_end, char *cookie_name,
Willy Tarreau843b7cb2018-07-13 10:54:26 +020085 size_t cookie_name_l, int list, char **value, size_t *value_l);
Thierry FOURNIERde6617b2013-10-15 11:43:19 +020086int http_header_match2(const char *hdr, const char *end, const char *name, int len);
87int http_remove_header2(struct http_msg *msg, struct hdr_idx *idx, struct hdr_ctx *ctx);
88int 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 +020089int 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 -080090void http_set_status(unsigned int status, const char *reason, struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +020091int http_transform_header_str(struct stream* s, struct http_msg *msg, const char* name,
Thierry FOURNIER5531f872015-03-16 11:15:50 +010092 unsigned int name_len, const char *str, struct my_regex *re,
93 int action);
Vincent Bernat6e615892016-05-18 16:17:44 +020094void inet_set_tos(int fd, const struct sockaddr_storage *from, int tos);
Willy Tarreau87b09662015-04-03 00:22:06 +020095void http_perform_server_redirect(struct stream *s, struct stream_interface *si);
96void http_return_srv_error(struct stream *s, struct stream_interface *si);
Willy Tarreaufd9419d2018-09-07 18:01:03 +020097void http_capture_bad_message(struct proxy *proxy, struct stream *s,
Willy Tarreau8a0cef22012-03-09 13:39:23 +010098 struct http_msg *msg,
Willy Tarreau0da5b3b2017-09-21 09:30:46 +020099 enum h1_state state, struct proxy *other_end);
Willy Tarreau185b5c42012-04-26 15:11:51 +0200100unsigned int http_get_hdr(const struct http_msg *msg, const char *hname, int hlen,
Willy Tarreau294c4732011-12-16 21:35:50 +0100101 struct hdr_idx *idx, int occ,
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200102 struct hdr_ctx *ctx, char **vptr, size_t *vlen);
Willy Tarreau6b952c82018-09-10 17:45:34 +0200103char *http_txn_get_path(const struct http_txn *txn);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200104
Willy Tarreaueee5b512015-04-03 23:46:31 +0200105struct http_txn *http_alloc_txn(struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200106void http_init_txn(struct stream *s);
107void http_end_txn(struct stream *s);
108void http_reset_txn(struct stream *s);
Christopher Fauletd7c91962015-04-30 11:48:27 +0200109void http_end_txn_clean_session(struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200110void http_adjust_conn_mode(struct stream *s, struct http_txn *txn, struct http_msg *msg);
Willy Tarreau0937bc42009-12-22 15:03:09 +0100111
Thierry FOURNIERa28a9422015-08-04 19:35:46 +0200112struct act_rule *parse_http_req_cond(const char **args, const char *file, int linenum, struct proxy *proxy);
113struct act_rule *parse_http_res_cond(const char **args, const char *file, int linenum, struct proxy *proxy);
Willy Tarreauff011f22011-01-06 17:51:27 +0100114void free_http_req_rules(struct list *r);
Sasha Pachev218f0642014-06-16 12:05:59 -0600115void free_http_res_rules(struct list *r);
Willy Tarreau83061a82018-07-13 11:56:34 +0200116void http_reply_and_close(struct stream *s, short status, struct buffer *msg);
117struct buffer *http_error_message(struct stream *s);
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +0100118struct redirect_rule *http_parse_redirect_rule(const char *file, int linenum, struct proxy *curproxy,
Willy Tarreaube4653b2015-05-28 15:26:58 +0200119 const char **args, char **errmsg, int use_fmt, int dir);
Thierry FOURNIER0786d052015-05-11 15:42:45 +0200120int smp_fetch_cookie(const struct arg *args, struct sample *smp, const char *kw, void *private);
121int smp_fetch_base32(const struct arg *args, struct sample *smp, const char *kw, void *private);
Willy Tarreauff011f22011-01-06 17:51:27 +0100122
Thierry FOURNIER36481b82015-08-19 09:01:53 +0200123struct action_kw *action_http_req_custom(const char *kw);
124struct action_kw *action_http_res_custom(const char *kw);
Thierry FOURNIER49f45af2014-12-08 19:50:43 +0100125int val_hdr(struct arg *arg, char **err_msg);
William Lallemand73025dd2014-04-24 14:38:37 +0200126
James Rosewell91a41cb2015-09-18 17:11:16 +0100127int smp_prefetch_http(struct proxy *px, struct stream *s, unsigned int opt,
128 const struct arg *args, struct sample *smp, int req_vol);
129
Baptiste Assmanne9544932015-11-03 23:31:35 +0100130enum act_return http_action_req_capture_by_id(struct act_rule *rule, struct proxy *px,
131 struct session *sess, struct stream *s, int flags);
132enum act_return http_action_res_capture_by_id(struct act_rule *rule, struct proxy *px,
133 struct session *sess, struct stream *s, int flags);
134
Christopher Faulet3d97c902015-12-09 14:59:38 +0100135int parse_qvalue(const char *qvalue, const char **end);
136
James Rosewell91a41cb2015-09-18 17:11:16 +0100137/* Note: these functions *do* modify the sample. Even in case of success, at
138 * least the type and uint value are modified.
139 */
140#define CHECK_HTTP_MESSAGE_FIRST() \
141 do { int r = smp_prefetch_http(smp->px, smp->strm, smp->opt, args, smp, 1); if (r <= 0) return r; } while (0)
142
143#define CHECK_HTTP_MESSAGE_FIRST_PERM() \
144 do { int r = smp_prefetch_http(smp->px, smp->strm, smp->opt, args, smp, 0); if (r <= 0) return r; } while (0)
145
Thierry FOURNIER36481b82015-08-19 09:01:53 +0200146static inline void http_req_keywords_register(struct action_kw_list *kw_list)
William Lallemand73025dd2014-04-24 14:38:37 +0200147{
148 LIST_ADDQ(&http_req_keywords.list, &kw_list->list);
149}
150
Thierry FOURNIER36481b82015-08-19 09:01:53 +0200151static inline void http_res_keywords_register(struct action_kw_list *kw_list)
William Lallemand73025dd2014-04-24 14:38:37 +0200152{
153 LIST_ADDQ(&http_res_keywords.list, &kw_list->list);
154}
155
156
Willy Tarreaufa355d42009-11-29 18:12:29 +0100157/* to be used when contents change in an HTTP message */
158#define http_msg_move_end(msg, bytes) do { \
159 unsigned int _bytes = (bytes); \
Willy Tarreaua458b672012-03-05 11:17:50 +0100160 (msg)->next += (_bytes); \
Willy Tarreaufa355d42009-11-29 18:12:29 +0100161 (msg)->sov += (_bytes); \
162 (msg)->eoh += (_bytes); \
163 } while (0)
164
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200165
Willy Tarreau211cdec2014-04-17 20:18:08 +0200166/* Return the amount of bytes that need to be rewound before buf->p to access
167 * the current message's headers. The purpose is to be able to easily fetch
168 * the message's beginning before headers are forwarded, as well as after.
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200169 * The principle is that msg->eoh and msg->eol are immutable while msg->sov
170 * equals the sum of the two before forwarding and is zero after forwarding,
171 * so the difference cancels the rewinding.
Willy Tarreau211cdec2014-04-17 20:18:08 +0200172 */
173static inline int http_hdr_rewind(const struct http_msg *msg)
174{
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200175 return msg->eoh + msg->eol - msg->sov;
Willy Tarreau211cdec2014-04-17 20:18:08 +0200176}
177
Willy Tarreauda6eed62014-04-17 20:24:24 +0200178/* Return the amount of bytes that need to be rewound before buf->p to access
179 * the current message's URI. The purpose is to be able to easily fetch
180 * the message's beginning before headers are forwarded, as well as after.
181 */
182static inline int http_uri_rewind(const struct http_msg *msg)
183{
184 return http_hdr_rewind(msg) - msg->sl.rq.u;
185}
186
Willy Tarreau0d090502014-04-17 20:31:44 +0200187/* Return the amount of bytes that need to be rewound before buf->p to access
188 * the current message's BODY. The purpose is to be able to easily fetch
189 * the message's beginning before headers are forwarded, as well as after.
190 */
191static inline int http_body_rewind(const struct http_msg *msg)
192{
193 return http_hdr_rewind(msg) - msg->eoh - msg->eol;
194}
195
196/* Return the amount of bytes that need to be rewound before buf->p to access
197 * the current message's DATA. The difference with the function above is that
198 * if a chunk is present and has already been parsed, its size is skipped so
199 * that the byte pointed to is the first byte of actual data. The function is
200 * safe for use in state HTTP_MSG_DATA regardless of whether the headers were
201 * already forwarded or not.
202 */
203static inline int http_data_rewind(const struct http_msg *msg)
204{
205 return http_body_rewind(msg) - msg->sol;
206}
207
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200208/* Return the maximum amount of bytes that may be read after the beginning of
209 * the message body, according to the advertised length. The function is safe
210 * for use between HTTP_MSG_BODY and HTTP_MSG_DATA regardless of whether the
211 * headers were already forwarded or not.
212 */
213static inline int http_body_bytes(const struct http_msg *msg)
214{
215 int len;
216
Willy Tarreau3ee83442018-06-15 16:42:02 +0200217 len = ci_data(msg->chn) - msg->sov - msg->sol;
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200218 if (len > msg->body_len)
219 len = msg->body_len;
220 return len;
221}
222
Willy Tarreaubaaee002006-06-26 02:48:02 +0200223#endif /* _PROTO_PROTO_HTTP_H */
224
225/*
226 * Local variables:
227 * c-indent-level: 8
228 * c-basic-offset: 8
229 * End:
230 */