blob: 1f63c5720d9e1ed32f14ede7d1c69aa9d7bb84eb [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>
Willy Tarreaubaaee002006-06-26 02:48:02 +020026#include <types/proto_http.h>
Willy Tarreau87b09662015-04-03 00:22:06 +020027#include <types/stream.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020028#include <types/task.h>
29
Willy Tarreau58f10d72006-12-04 02:26:12 +010030/*
31 * some macros used for the request parsing.
32 * from RFC2616:
33 * CTL = <any US-ASCII control character (octets 0 - 31) and DEL (127)>
Willy Tarreau8d5d7f22007-01-21 19:16:41 +010034 * SEP = one of the 17 defined separators or SP or HT
35 * LWS = CR, LF, SP or HT
36 * SPHT = SP or HT. Use this macro and not a boolean expression for best speed.
37 * CRLF = CR or LF. Use this macro and not a boolean expression for best speed.
38 * 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 +010039 *
40 * added for ease of use:
41 * ver_token = 'H', 'P', 'T', '/', '.', and digits.
Willy Tarreau58f10d72006-12-04 02:26:12 +010042 */
Willy Tarreau58f10d72006-12-04 02:26:12 +010043
Willy Tarreau8d5d7f22007-01-21 19:16:41 +010044extern const char http_is_ctl[256];
45extern const char http_is_sep[256];
46extern const char http_is_lws[256];
47extern const char http_is_spht[256];
48extern const char http_is_crlf[256];
49extern const char http_is_token[256];
Willy Tarreau4b89ad42007-03-04 18:13:58 +010050extern const char http_is_ver_token[256];
Willy Tarreau8d5d7f22007-01-21 19:16:41 +010051
Willy Tarreau436d9ed2011-05-11 16:10:11 +020052extern const int http_err_codes[HTTP_ERR_SIZE];
53extern struct chunk http_err_chunks[HTTP_ERR_SIZE];
54extern const char *HTTP_302;
55extern const char *HTTP_303;
Willy Tarreau7e2c6472012-10-29 20:44:36 +010056extern char *get_http_auth_buff;
Willy Tarreau436d9ed2011-05-11 16:10:11 +020057
Willy Tarreau8d5d7f22007-01-21 19:16:41 +010058#define HTTP_IS_CTL(x) (http_is_ctl[(unsigned char)(x)])
59#define HTTP_IS_SEP(x) (http_is_sep[(unsigned char)(x)])
60#define HTTP_IS_LWS(x) (http_is_lws[(unsigned char)(x)])
61#define HTTP_IS_SPHT(x) (http_is_spht[(unsigned char)(x)])
62#define HTTP_IS_CRLF(x) (http_is_crlf[(unsigned char)(x)])
63#define HTTP_IS_TOKEN(x) (http_is_token[(unsigned char)(x)])
Willy Tarreau4b89ad42007-03-04 18:13:58 +010064#define HTTP_IS_VER_TOKEN(x) (http_is_ver_token[(unsigned char)(x)])
Willy Tarreaubaaee002006-06-26 02:48:02 +020065
Willy Tarreau87b09662015-04-03 00:22:06 +020066int process_cli(struct stream *s);
67int process_srv_data(struct stream *s);
68int process_srv_conn(struct stream *s);
69int http_wait_for_request(struct stream *s, struct channel *req, int an_bit);
70int http_process_req_common(struct stream *s, struct channel *req, int an_bit, struct proxy *px);
71int http_process_request(struct stream *s, struct channel *req, int an_bit);
72int http_process_tarpit(struct stream *s, struct channel *req, int an_bit);
73int http_wait_for_request_body(struct stream *s, struct channel *req, int an_bit);
Willy Tarreau45c0d982012-03-09 12:11:57 +010074int http_send_name_header(struct http_txn *txn, struct proxy* be, const char* svr_name);
Willy Tarreau87b09662015-04-03 00:22:06 +020075int http_wait_for_response(struct stream *s, struct channel *rep, int an_bit);
76int http_process_res_common(struct stream *s, struct channel *rep, int an_bit, struct proxy *px);
77int http_request_forward_body(struct stream *s, struct channel *req, int an_bit);
78int http_response_forward_body(struct stream *s, struct channel *res, int an_bit);
Willy Tarreaubaaee002006-06-26 02:48:02 +020079
Willy Tarreau87b09662015-04-03 00:22:06 +020080void debug_hdr(const char *dir, struct stream *s, const char *start, const char *end);
Willy Tarreau87b09662015-04-03 00:22:06 +020081int apply_filter_to_req_headers(struct stream *s, struct channel *req, struct hdr_exp *exp);
82int apply_filter_to_req_line(struct stream *s, struct channel *req, struct hdr_exp *exp);
83int apply_filters_to_request(struct stream *s, struct channel *req, struct proxy *px);
84int apply_filters_to_response(struct stream *s, struct channel *rtr, struct proxy *px);
Willy Tarreau87b09662015-04-03 00:22:06 +020085void manage_client_side_cookies(struct stream *s, struct channel *req);
86void manage_server_side_cookies(struct stream *s, struct channel *rtr);
87void check_response_for_cacheability(struct stream *s, struct channel *rtr);
Willy Tarreau295a8372011-03-10 11:25:07 +010088int stats_check_uri(struct stream_interface *si, struct http_txn *txn, struct proxy *backend);
Willy Tarreau80587432006-12-24 17:47:20 +010089void init_proto_http();
Willy Tarreau04ff9f12013-06-10 18:39:42 +020090int http_find_full_header2(const char *name, int len,
91 char *sol, struct hdr_idx *idx,
92 struct hdr_ctx *ctx);
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +020093int http_find_header2(const char *name, int len,
Willy Tarreau68085d82010-01-18 14:54:04 +010094 char *sol, struct hdr_idx *idx,
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +020095 struct hdr_ctx *ctx);
Thierry FOURNIERde6617b2013-10-15 11:43:19 +020096char *find_hdr_value_end(char *s, const char *e);
97int http_header_match2(const char *hdr, const char *end, const char *name, int len);
98int http_remove_header2(struct http_msg *msg, struct hdr_idx *idx, struct hdr_ctx *ctx);
99int 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 +0200100int http_replace_req_line(int action, const char *replace, int len, struct proxy *px, struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200101int http_transform_header_str(struct stream* s, struct http_msg *msg, const char* name,
Thierry FOURNIER5531f872015-03-16 11:15:50 +0100102 unsigned int name_len, const char *str, struct my_regex *re,
103 int action);
Thierry FOURNIER7fe75e02015-03-16 12:03:44 +0100104void inet_set_tos(int fd, struct sockaddr_storage from, int tos);
Willy Tarreau87b09662015-04-03 00:22:06 +0200105void http_perform_server_redirect(struct stream *s, struct stream_interface *si);
106void http_return_srv_error(struct stream *s, struct stream_interface *si);
107void http_capture_bad_message(struct error_snapshot *es, struct stream *s,
Willy Tarreau8a0cef22012-03-09 13:39:23 +0100108 struct http_msg *msg,
Willy Tarreau3770f232013-12-07 00:01:53 +0100109 enum ht_state state, struct proxy *other_end);
Willy Tarreau185b5c42012-04-26 15:11:51 +0200110unsigned int http_get_hdr(const struct http_msg *msg, const char *hname, int hlen,
Willy Tarreau294c4732011-12-16 21:35:50 +0100111 struct hdr_idx *idx, int occ,
112 struct hdr_ctx *ctx, char **vptr, int *vlen);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200113
Willy Tarreaueee5b512015-04-03 23:46:31 +0200114struct http_txn *http_alloc_txn(struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200115void http_init_txn(struct stream *s);
116void http_end_txn(struct stream *s);
117void http_reset_txn(struct stream *s);
118void http_adjust_conn_mode(struct stream *s, struct http_txn *txn, struct http_msg *msg);
Willy Tarreau0937bc42009-12-22 15:03:09 +0100119
Thierry FOURNIERa28a9422015-08-04 19:35:46 +0200120struct act_rule *parse_http_req_cond(const char **args, const char *file, int linenum, struct proxy *proxy);
121struct act_rule *parse_http_res_cond(const char **args, const char *file, int linenum, struct proxy *proxy);
Willy Tarreauff011f22011-01-06 17:51:27 +0100122void free_http_req_rules(struct list *r);
Sasha Pachev218f0642014-06-16 12:05:59 -0600123void free_http_res_rules(struct list *r);
Willy Tarreau87b09662015-04-03 00:22:06 +0200124struct chunk *http_error_message(struct stream *s, int msgnum);
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +0100125struct redirect_rule *http_parse_redirect_rule(const char *file, int linenum, struct proxy *curproxy,
Willy Tarreaube4653b2015-05-28 15:26:58 +0200126 const char **args, char **errmsg, int use_fmt, int dir);
Thierry FOURNIER0786d052015-05-11 15:42:45 +0200127int smp_fetch_cookie(const struct arg *args, struct sample *smp, const char *kw, void *private);
128int smp_fetch_base32(const struct arg *args, struct sample *smp, const char *kw, void *private);
Willy Tarreauff011f22011-01-06 17:51:27 +0100129
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100130enum http_meth_t find_http_meth(const char *str, const int len);
131
William Lallemand73025dd2014-04-24 14:38:37 +0200132struct http_req_action_kw *action_http_req_custom(const char *kw);
133struct http_res_action_kw *action_http_res_custom(const char *kw);
Thierry FOURNIER49f45af2014-12-08 19:50:43 +0100134int val_hdr(struct arg *arg, char **err_msg);
William Lallemand73025dd2014-04-24 14:38:37 +0200135
136static inline void http_req_keywords_register(struct http_req_action_kw_list *kw_list)
137{
138 LIST_ADDQ(&http_req_keywords.list, &kw_list->list);
139}
140
141static inline void http_res_keywords_register(struct http_res_action_kw_list *kw_list)
142{
143 LIST_ADDQ(&http_res_keywords.list, &kw_list->list);
144}
145
146
Willy Tarreaufa355d42009-11-29 18:12:29 +0100147/* to be used when contents change in an HTTP message */
148#define http_msg_move_end(msg, bytes) do { \
149 unsigned int _bytes = (bytes); \
Willy Tarreaua458b672012-03-05 11:17:50 +0100150 (msg)->next += (_bytes); \
Willy Tarreaufa355d42009-11-29 18:12:29 +0100151 (msg)->sov += (_bytes); \
152 (msg)->eoh += (_bytes); \
153 } while (0)
154
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200155
Willy Tarreau211cdec2014-04-17 20:18:08 +0200156/* Return the amount of bytes that need to be rewound before buf->p to access
157 * the current message's headers. The purpose is to be able to easily fetch
158 * the message's beginning before headers are forwarded, as well as after.
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200159 * The principle is that msg->eoh and msg->eol are immutable while msg->sov
160 * equals the sum of the two before forwarding and is zero after forwarding,
161 * so the difference cancels the rewinding.
Willy Tarreau211cdec2014-04-17 20:18:08 +0200162 */
163static inline int http_hdr_rewind(const struct http_msg *msg)
164{
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200165 return msg->eoh + msg->eol - msg->sov;
Willy Tarreau211cdec2014-04-17 20:18:08 +0200166}
167
Willy Tarreauda6eed62014-04-17 20:24:24 +0200168/* Return the amount of bytes that need to be rewound before buf->p to access
169 * the current message's URI. The purpose is to be able to easily fetch
170 * the message's beginning before headers are forwarded, as well as after.
171 */
172static inline int http_uri_rewind(const struct http_msg *msg)
173{
174 return http_hdr_rewind(msg) - msg->sl.rq.u;
175}
176
Willy Tarreau0d090502014-04-17 20:31:44 +0200177/* Return the amount of bytes that need to be rewound before buf->p to access
178 * the current message's BODY. The purpose is to be able to easily fetch
179 * the message's beginning before headers are forwarded, as well as after.
180 */
181static inline int http_body_rewind(const struct http_msg *msg)
182{
183 return http_hdr_rewind(msg) - msg->eoh - msg->eol;
184}
185
186/* Return the amount of bytes that need to be rewound before buf->p to access
187 * the current message's DATA. The difference with the function above is that
188 * if a chunk is present and has already been parsed, its size is skipped so
189 * that the byte pointed to is the first byte of actual data. The function is
190 * safe for use in state HTTP_MSG_DATA regardless of whether the headers were
191 * already forwarded or not.
192 */
193static inline int http_data_rewind(const struct http_msg *msg)
194{
195 return http_body_rewind(msg) - msg->sol;
196}
197
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200198/* Return the maximum amount of bytes that may be read after the beginning of
199 * the message body, according to the advertised length. The function is safe
200 * for use between HTTP_MSG_BODY and HTTP_MSG_DATA regardless of whether the
201 * headers were already forwarded or not.
202 */
203static inline int http_body_bytes(const struct http_msg *msg)
204{
205 int len;
206
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200207 len = msg->chn->buf->i - msg->sov - msg->sol;
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200208 if (len > msg->body_len)
209 len = msg->body_len;
210 return len;
211}
212
Willy Tarreau09448f72014-06-25 18:12:15 +0200213/* for an http-request action HTTP_REQ_ACT_TRK_*, return a tracking index
214 * starting at zero for SC0. Unknown actions also return zero.
215 */
216static inline int http_req_trk_idx(int trk_action)
217{
218 return trk_action - HTTP_REQ_ACT_TRK_SC0;
219}
220
Willy Tarreau88c6d812012-11-21 21:50:04 +0100221/* for debugging, reports the HTTP message state name */
222static inline const char *http_msg_state_str(int msg_state)
223{
224 switch (msg_state) {
225 case HTTP_MSG_RQBEFORE: return "MSG_RQBEFORE";
226 case HTTP_MSG_RQBEFORE_CR: return "MSG_RQBEFORE_CR";
227 case HTTP_MSG_RQMETH: return "MSG_RQMETH";
228 case HTTP_MSG_RQMETH_SP: return "MSG_RQMETH_SP";
229 case HTTP_MSG_RQURI: return "MSG_RQURI";
230 case HTTP_MSG_RQURI_SP: return "MSG_RQURI_SP";
231 case HTTP_MSG_RQVER: return "MSG_RQVER";
232 case HTTP_MSG_RQLINE_END: return "MSG_RQLINE_END";
233 case HTTP_MSG_RPBEFORE: return "MSG_RPBEFORE";
234 case HTTP_MSG_RPBEFORE_CR: return "MSG_RPBEFORE_CR";
235 case HTTP_MSG_RPVER: return "MSG_RPVER";
236 case HTTP_MSG_RPVER_SP: return "MSG_RPVER_SP";
237 case HTTP_MSG_RPCODE: return "MSG_RPCODE";
238 case HTTP_MSG_RPCODE_SP: return "MSG_RPCODE_SP";
239 case HTTP_MSG_RPREASON: return "MSG_RPREASON";
240 case HTTP_MSG_RPLINE_END: return "MSG_RPLINE_END";
241 case HTTP_MSG_HDR_FIRST: return "MSG_HDR_FIRST";
242 case HTTP_MSG_HDR_NAME: return "MSG_HDR_NAME";
243 case HTTP_MSG_HDR_COL: return "MSG_HDR_COL";
244 case HTTP_MSG_HDR_L1_SP: return "MSG_HDR_L1_SP";
245 case HTTP_MSG_HDR_L1_LF: return "MSG_HDR_L1_LF";
246 case HTTP_MSG_HDR_L1_LWS: return "MSG_HDR_L1_LWS";
247 case HTTP_MSG_HDR_VAL: return "MSG_HDR_VAL";
248 case HTTP_MSG_HDR_L2_LF: return "MSG_HDR_L2_LF";
249 case HTTP_MSG_HDR_L2_LWS: return "MSG_HDR_L2_LWS";
250 case HTTP_MSG_LAST_LF: return "MSG_LAST_LF";
251 case HTTP_MSG_ERROR: return "MSG_ERROR";
252 case HTTP_MSG_BODY: return "MSG_BODY";
253 case HTTP_MSG_100_SENT: return "MSG_100_SENT";
254 case HTTP_MSG_CHUNK_SIZE: return "MSG_CHUNK_SIZE";
255 case HTTP_MSG_DATA: return "MSG_DATA";
256 case HTTP_MSG_CHUNK_CRLF: return "MSG_CHUNK_CRLF";
257 case HTTP_MSG_TRAILERS: return "MSG_TRAILERS";
258 case HTTP_MSG_DONE: return "MSG_DONE";
259 case HTTP_MSG_CLOSING: return "MSG_CLOSING";
260 case HTTP_MSG_CLOSED: return "MSG_CLOSED";
261 case HTTP_MSG_TUNNEL: return "MSG_TUNNEL";
262 default: return "MSG_??????";
263 }
264}
265
Willy Tarreaubaaee002006-06-26 02:48:02 +0200266#endif /* _PROTO_PROTO_HTTP_H */
267
268/*
269 * Local variables:
270 * c-indent-level: 8
271 * c-basic-offset: 8
272 * End:
273 */