blob: 07301608da622e7a234db245777aaeef6625880f [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 Tarreau436d9ed2011-05-11 16:10:11 +020047extern const int http_err_codes[HTTP_ERR_SIZE];
48extern struct chunk http_err_chunks[HTTP_ERR_SIZE];
49extern const char *HTTP_302;
50extern const char *HTTP_303;
51
Willy Tarreau87b09662015-04-03 00:22:06 +020052int process_cli(struct stream *s);
53int process_srv_data(struct stream *s);
54int process_srv_conn(struct stream *s);
55int http_wait_for_request(struct stream *s, struct channel *req, int an_bit);
56int http_process_req_common(struct stream *s, struct channel *req, int an_bit, struct proxy *px);
57int http_process_request(struct stream *s, struct channel *req, int an_bit);
58int http_process_tarpit(struct stream *s, struct channel *req, int an_bit);
59int http_wait_for_request_body(struct stream *s, struct channel *req, int an_bit);
Willy Tarreau45c0d982012-03-09 12:11:57 +010060int http_send_name_header(struct http_txn *txn, struct proxy* be, const char* svr_name);
Willy Tarreau87b09662015-04-03 00:22:06 +020061int http_wait_for_response(struct stream *s, struct channel *rep, int an_bit);
62int http_process_res_common(struct stream *s, struct channel *rep, int an_bit, struct proxy *px);
63int http_request_forward_body(struct stream *s, struct channel *req, int an_bit);
64int http_response_forward_body(struct stream *s, struct channel *res, int an_bit);
Thierry FOURNIER8d16de02015-09-25 11:06:37 +020065void http_msg_analyzer(struct http_msg *msg, struct hdr_idx *idx);
Thierry FOURNIERfd50f0b2015-09-25 18:53:18 +020066void http_txn_reset_req(struct http_txn *txn);
67void http_txn_reset_res(struct http_txn *txn);
Willy Tarreaubaaee002006-06-26 02:48:02 +020068
Willy Tarreau87b09662015-04-03 00:22:06 +020069void debug_hdr(const char *dir, struct stream *s, const char *start, const char *end);
Willy Tarreau87b09662015-04-03 00:22:06 +020070int apply_filter_to_req_headers(struct stream *s, struct channel *req, struct hdr_exp *exp);
71int apply_filter_to_req_line(struct stream *s, struct channel *req, struct hdr_exp *exp);
72int apply_filters_to_request(struct stream *s, struct channel *req, struct proxy *px);
73int apply_filters_to_response(struct stream *s, struct channel *rtr, struct proxy *px);
Willy Tarreau87b09662015-04-03 00:22:06 +020074void manage_client_side_cookies(struct stream *s, struct channel *req);
75void manage_server_side_cookies(struct stream *s, struct channel *rtr);
Willy Tarreau0ad8e0d2017-12-22 15:03:36 +010076void check_request_for_cacheability(struct stream *s, struct channel *chn);
Willy Tarreau87b09662015-04-03 00:22:06 +020077void check_response_for_cacheability(struct stream *s, struct channel *rtr);
Willy Tarreau295a8372011-03-10 11:25:07 +010078int stats_check_uri(struct stream_interface *si, struct http_txn *txn, struct proxy *backend);
Willy Tarreau80587432006-12-24 17:47:20 +010079void init_proto_http();
Willy Tarreau04ff9f12013-06-10 18:39:42 +020080int http_find_full_header2(const char *name, int len,
81 char *sol, struct hdr_idx *idx,
82 struct hdr_ctx *ctx);
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +020083int http_find_header2(const char *name, int len,
Willy Tarreau68085d82010-01-18 14:54:04 +010084 char *sol, struct hdr_idx *idx,
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +020085 struct hdr_ctx *ctx);
David Carlier4686f792015-09-25 14:10:50 +010086int http_find_next_header(char *sol, struct hdr_idx *idx,
87 struct hdr_ctx *ctx);
Thierry FOURNIERde6617b2013-10-15 11:43:19 +020088char *find_hdr_value_end(char *s, const char *e);
David Carlier4686f792015-09-25 14:10:50 +010089char *extract_cookie_value(char *hdr, const char *hdr_end, char *cookie_name,
90 size_t cookie_name_l, int list, char **value, int *value_l);
Thierry FOURNIERde6617b2013-10-15 11:43:19 +020091int http_header_match2(const char *hdr, const char *end, const char *name, int len);
92int http_remove_header2(struct http_msg *msg, struct hdr_idx *idx, struct hdr_ctx *ctx);
93int 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 +020094int 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 -080095void http_set_status(unsigned int status, const char *reason, struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +020096int http_transform_header_str(struct stream* s, struct http_msg *msg, const char* name,
Thierry FOURNIER5531f872015-03-16 11:15:50 +010097 unsigned int name_len, const char *str, struct my_regex *re,
98 int action);
Vincent Bernat6e615892016-05-18 16:17:44 +020099void inet_set_tos(int fd, const struct sockaddr_storage *from, int tos);
Willy Tarreau87b09662015-04-03 00:22:06 +0200100void http_perform_server_redirect(struct stream *s, struct stream_interface *si);
101void http_return_srv_error(struct stream *s, struct stream_interface *si);
Emeric Brun8c1aaa22017-06-15 11:30:06 +0200102void http_capture_bad_message(struct proxy *proxy, struct error_snapshot *es, struct stream *s,
Willy Tarreau8a0cef22012-03-09 13:39:23 +0100103 struct http_msg *msg,
Willy Tarreau0da5b3b2017-09-21 09:30:46 +0200104 enum h1_state state, struct proxy *other_end);
Willy Tarreau185b5c42012-04-26 15:11:51 +0200105unsigned int http_get_hdr(const struct http_msg *msg, const char *hname, int hlen,
Willy Tarreau294c4732011-12-16 21:35:50 +0100106 struct hdr_idx *idx, int occ,
107 struct hdr_ctx *ctx, char **vptr, int *vlen);
Thierry FOURNIER3c331782015-09-17 19:33:35 +0200108char *http_get_path(struct http_txn *txn);
Thierry FOURNIER127169e2015-09-18 17:59:23 +0200109const char *get_reason(unsigned int status);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200110
Willy Tarreaueee5b512015-04-03 23:46:31 +0200111struct http_txn *http_alloc_txn(struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200112void http_init_txn(struct stream *s);
113void http_end_txn(struct stream *s);
114void http_reset_txn(struct stream *s);
Christopher Fauletd7c91962015-04-30 11:48:27 +0200115void http_end_txn_clean_session(struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200116void http_adjust_conn_mode(struct stream *s, struct http_txn *txn, struct http_msg *msg);
Willy Tarreau0937bc42009-12-22 15:03:09 +0100117
Thierry FOURNIERa28a9422015-08-04 19:35:46 +0200118struct act_rule *parse_http_req_cond(const char **args, const char *file, int linenum, struct proxy *proxy);
119struct act_rule *parse_http_res_cond(const char **args, const char *file, int linenum, struct proxy *proxy);
Willy Tarreauff011f22011-01-06 17:51:27 +0100120void free_http_req_rules(struct list *r);
Sasha Pachev218f0642014-06-16 12:05:59 -0600121void free_http_res_rules(struct list *r);
Christopher Fauleta94e5a52015-12-09 15:55:06 +0100122void http_reply_and_close(struct stream *s, short status, struct chunk *msg);
Jarno Huuskonen9e6906b2017-03-06 14:21:49 +0200123struct chunk *http_error_message(struct stream *s);
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +0100124struct redirect_rule *http_parse_redirect_rule(const char *file, int linenum, struct proxy *curproxy,
Willy Tarreaube4653b2015-05-28 15:26:58 +0200125 const char **args, char **errmsg, int use_fmt, int dir);
Thierry FOURNIER0786d052015-05-11 15:42:45 +0200126int smp_fetch_cookie(const struct arg *args, struct sample *smp, const char *kw, void *private);
127int smp_fetch_base32(const struct arg *args, struct sample *smp, const char *kw, void *private);
Willy Tarreauff011f22011-01-06 17:51:27 +0100128
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100129enum http_meth_t find_http_meth(const char *str, const int len);
130
Thierry FOURNIER36481b82015-08-19 09:01:53 +0200131struct action_kw *action_http_req_custom(const char *kw);
132struct action_kw *action_http_res_custom(const char *kw);
Thierry FOURNIER49f45af2014-12-08 19:50:43 +0100133int val_hdr(struct arg *arg, char **err_msg);
William Lallemand73025dd2014-04-24 14:38:37 +0200134
James Rosewell91a41cb2015-09-18 17:11:16 +0100135int smp_prefetch_http(struct proxy *px, struct stream *s, unsigned int opt,
136 const struct arg *args, struct sample *smp, int req_vol);
137
Baptiste Assmanne9544932015-11-03 23:31:35 +0100138enum act_return http_action_req_capture_by_id(struct act_rule *rule, struct proxy *px,
139 struct session *sess, struct stream *s, int flags);
140enum act_return http_action_res_capture_by_id(struct act_rule *rule, struct proxy *px,
141 struct session *sess, struct stream *s, int flags);
142
Christopher Faulet3d97c902015-12-09 14:59:38 +0100143int parse_qvalue(const char *qvalue, const char **end);
144
James Rosewell91a41cb2015-09-18 17:11:16 +0100145/* Note: these functions *do* modify the sample. Even in case of success, at
146 * least the type and uint value are modified.
147 */
148#define CHECK_HTTP_MESSAGE_FIRST() \
149 do { int r = smp_prefetch_http(smp->px, smp->strm, smp->opt, args, smp, 1); if (r <= 0) return r; } while (0)
150
151#define CHECK_HTTP_MESSAGE_FIRST_PERM() \
152 do { int r = smp_prefetch_http(smp->px, smp->strm, smp->opt, args, smp, 0); if (r <= 0) return r; } while (0)
153
Thierry FOURNIER36481b82015-08-19 09:01:53 +0200154static inline void http_req_keywords_register(struct action_kw_list *kw_list)
William Lallemand73025dd2014-04-24 14:38:37 +0200155{
156 LIST_ADDQ(&http_req_keywords.list, &kw_list->list);
157}
158
Thierry FOURNIER36481b82015-08-19 09:01:53 +0200159static inline void http_res_keywords_register(struct action_kw_list *kw_list)
William Lallemand73025dd2014-04-24 14:38:37 +0200160{
161 LIST_ADDQ(&http_res_keywords.list, &kw_list->list);
162}
163
164
Willy Tarreaufa355d42009-11-29 18:12:29 +0100165/* to be used when contents change in an HTTP message */
166#define http_msg_move_end(msg, bytes) do { \
167 unsigned int _bytes = (bytes); \
Willy Tarreaua458b672012-03-05 11:17:50 +0100168 (msg)->next += (_bytes); \
Willy Tarreaufa355d42009-11-29 18:12:29 +0100169 (msg)->sov += (_bytes); \
170 (msg)->eoh += (_bytes); \
171 } while (0)
172
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200173
Willy Tarreau211cdec2014-04-17 20:18:08 +0200174/* Return the amount of bytes that need to be rewound before buf->p to access
175 * the current message's headers. The purpose is to be able to easily fetch
176 * the message's beginning before headers are forwarded, as well as after.
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200177 * The principle is that msg->eoh and msg->eol are immutable while msg->sov
178 * equals the sum of the two before forwarding and is zero after forwarding,
179 * so the difference cancels the rewinding.
Willy Tarreau211cdec2014-04-17 20:18:08 +0200180 */
181static inline int http_hdr_rewind(const struct http_msg *msg)
182{
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200183 return msg->eoh + msg->eol - msg->sov;
Willy Tarreau211cdec2014-04-17 20:18:08 +0200184}
185
Willy Tarreauda6eed62014-04-17 20:24:24 +0200186/* Return the amount of bytes that need to be rewound before buf->p to access
187 * the current message's URI. The purpose is to be able to easily fetch
188 * the message's beginning before headers are forwarded, as well as after.
189 */
190static inline int http_uri_rewind(const struct http_msg *msg)
191{
192 return http_hdr_rewind(msg) - msg->sl.rq.u;
193}
194
Willy Tarreau0d090502014-04-17 20:31:44 +0200195/* Return the amount of bytes that need to be rewound before buf->p to access
196 * the current message's BODY. The purpose is to be able to easily fetch
197 * the message's beginning before headers are forwarded, as well as after.
198 */
199static inline int http_body_rewind(const struct http_msg *msg)
200{
201 return http_hdr_rewind(msg) - msg->eoh - msg->eol;
202}
203
204/* Return the amount of bytes that need to be rewound before buf->p to access
205 * the current message's DATA. The difference with the function above is that
206 * if a chunk is present and has already been parsed, its size is skipped so
207 * that the byte pointed to is the first byte of actual data. The function is
208 * safe for use in state HTTP_MSG_DATA regardless of whether the headers were
209 * already forwarded or not.
210 */
211static inline int http_data_rewind(const struct http_msg *msg)
212{
213 return http_body_rewind(msg) - msg->sol;
214}
215
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200216/* Return the maximum amount of bytes that may be read after the beginning of
217 * the message body, according to the advertised length. The function is safe
218 * for use between HTTP_MSG_BODY and HTTP_MSG_DATA regardless of whether the
219 * headers were already forwarded or not.
220 */
221static inline int http_body_bytes(const struct http_msg *msg)
222{
223 int len;
224
Willy Tarreau3ee83442018-06-15 16:42:02 +0200225 len = ci_data(msg->chn) - msg->sov - msg->sol;
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200226 if (len > msg->body_len)
227 len = msg->body_len;
228 return len;
229}
230
Willy Tarreaubaaee002006-06-26 02:48:02 +0200231#endif /* _PROTO_PROTO_HTTP_H */
232
233/*
234 * Local variables:
235 * c-indent-level: 8
236 * c-basic-offset: 8
237 * End:
238 */