blob: 2e2163ee5db03e49e4dd7861cad78a20728d9bf5 [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>
Willy Tarreau3ee83442018-06-15 16:42:02 +020029#include <proto/channel.h>
Christopher Fauletf0216da2018-12-14 13:44:53 +010030#include <proto/stream.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020031
Christopher Faulet1d5b85a2018-10-03 14:25:40 +020032#define IS_HTX_STRM(strm) (strm_fe(strm)->options2 & PR_O2_USE_HTX)
33#define IS_HTX_SMP(smp) ((smp)->strm && IS_HTX_STRM((smp)->strm))
Willy Tarreau58f10d72006-12-04 02:26:12 +010034
Willy Tarreau79e57332018-10-02 16:01:16 +020035extern struct pool_head *pool_head_uniqueid;
36
Willy Tarreau87b09662015-04-03 00:22:06 +020037int process_cli(struct stream *s);
38int process_srv_data(struct stream *s);
39int process_srv_conn(struct stream *s);
40int http_wait_for_request(struct stream *s, struct channel *req, int an_bit);
41int http_process_req_common(struct stream *s, struct channel *req, int an_bit, struct proxy *px);
42int http_process_request(struct stream *s, struct channel *req, int an_bit);
43int http_process_tarpit(struct stream *s, struct channel *req, int an_bit);
44int http_wait_for_request_body(struct stream *s, struct channel *req, int an_bit);
Christopher Faulet27a3dc82018-10-23 15:34:07 +020045int http_send_name_header(struct stream *s, struct proxy* be, const char* svr_name);
Willy Tarreau87b09662015-04-03 00:22:06 +020046int http_wait_for_response(struct stream *s, struct channel *rep, int an_bit);
47int http_process_res_common(struct stream *s, struct channel *rep, int an_bit, struct proxy *px);
48int http_request_forward_body(struct stream *s, struct channel *req, int an_bit);
49int http_response_forward_body(struct stream *s, struct channel *res, int an_bit);
Willy Tarreau79e57332018-10-02 16:01:16 +020050int http_upgrade_v09_to_v10(struct http_txn *txn);
Thierry FOURNIER8d16de02015-09-25 11:06:37 +020051void http_msg_analyzer(struct http_msg *msg, struct hdr_idx *idx);
Thierry FOURNIERfd50f0b2015-09-25 18:53:18 +020052void http_txn_reset_req(struct http_txn *txn);
53void http_txn_reset_res(struct http_txn *txn);
Willy Tarreau538746a2018-12-11 10:59:20 +010054const char *http_parse_reqline(struct http_msg *msg,
55 enum h1_state state, const char *ptr, const char *end,
56 unsigned int *ret_ptr, enum h1_state *ret_state);
57const char *http_parse_stsline(struct http_msg *msg,
58 enum h1_state state, const char *ptr, const char *end,
59 unsigned int *ret_ptr, enum h1_state *ret_state);
60int http_forward_trailers(struct http_msg *msg);
Willy Tarreauc5a4fd52018-12-11 11:42:27 +010061int http_legacy_replace_header(struct hdr_idx *idx, struct http_msg *msg,
62 const char *name, unsigned int name_len,
63 const char *str, struct my_regex *re,
64 struct buffer *output);
65int http_legacy_replace_full_header(struct hdr_idx *idx, struct http_msg *msg,
66 const char *name, unsigned int name_len,
67 const char *str, struct my_regex *re,
68 struct buffer *output);
Willy Tarreaubaaee002006-06-26 02:48:02 +020069
Christopher Fauletf2824e62018-10-01 12:12:37 +020070/* Export HTX analyzers and helpers */
Christopher Faulet0f226952018-10-22 09:29:56 +020071// FIXME: Rename all these functions http_* once legacy code will be removed
Christopher Faulet72333522018-10-24 11:25:02 +020072struct htx;
Christopher Faulet0f226952018-10-22 09:29:56 +020073
Christopher Faulete0768eb2018-10-03 16:38:02 +020074int htx_wait_for_request(struct stream *s, struct channel *req, int an_bit);
75int htx_process_req_common(struct stream *s, struct channel *req, int an_bit, struct proxy *px);
76int htx_process_request(struct stream *s, struct channel *req, int an_bit);
77int htx_process_tarpit(struct stream *s, struct channel *req, int an_bit);
78int htx_wait_for_request_body(struct stream *s, struct channel *req, int an_bit);
Christopher Faulete0768eb2018-10-03 16:38:02 +020079int htx_wait_for_response(struct stream *s, struct channel *rep, int an_bit);
80int htx_process_res_common(struct stream *s, struct channel *rep, int an_bit, struct proxy *px);
81int htx_request_forward_body(struct stream *s, struct channel *req, int an_bit);
82int htx_response_forward_body(struct stream *s, struct channel *res, int an_bit);
Christopher Faulet0f226952018-10-22 09:29:56 +020083void htx_adjust_conn_mode(struct stream *s, struct http_txn *txn);
Christopher Fauletf2824e62018-10-01 12:12:37 +020084int htx_apply_redirect_rule(struct redirect_rule *rule, struct stream *s, struct http_txn *txn);
Christopher Faulet72333522018-10-24 11:25:02 +020085int htx_transform_header_str(struct stream* s, struct channel *chn, struct htx *htx,
86 struct ist name, const char *str, struct my_regex *re, int action);
Christopher Faulet8d8ac192018-10-24 11:27:39 +020087int htx_req_replace_stline(int action, const char *replace, int len,
88 struct proxy *px, struct stream *s);
89void htx_res_set_status(unsigned int status, const char *reason, struct stream *s);
Christopher Faulet25a02f62018-10-24 12:00:25 +020090void htx_check_request_for_cacheability(struct stream *s, struct channel *req);
91void htx_check_response_for_cacheability(struct stream *s, struct channel *res);
Christopher Faulet64159df2018-10-24 21:15:35 +020092int htx_send_name_header(struct stream *s, struct proxy *be, const char *srv_name);
Christopher Fauletfefc73d2018-10-24 21:18:04 +020093void htx_perform_server_redirect(struct stream *s, struct stream_interface *si);
Christopher Faulet0f226952018-10-22 09:29:56 +020094void htx_server_error(struct stream *s, struct stream_interface *si, int err, int finst, const struct buffer *msg);
95void htx_reply_and_close(struct stream *s, short status, struct buffer *msg);
Christopher Fauleta7b677c2018-11-29 16:48:49 +010096struct buffer *htx_error_message(struct stream *s);
Christopher Faulete0768eb2018-10-03 16:38:02 +020097
Willy Tarreau87b09662015-04-03 00:22:06 +020098void debug_hdr(const char *dir, struct stream *s, const char *start, const char *end);
Willy Tarreau87b09662015-04-03 00:22:06 +020099int apply_filter_to_req_headers(struct stream *s, struct channel *req, struct hdr_exp *exp);
100int apply_filter_to_req_line(struct stream *s, struct channel *req, struct hdr_exp *exp);
101int apply_filters_to_request(struct stream *s, struct channel *req, struct proxy *px);
102int apply_filters_to_response(struct stream *s, struct channel *rtr, struct proxy *px);
Willy Tarreau87b09662015-04-03 00:22:06 +0200103void manage_client_side_cookies(struct stream *s, struct channel *req);
104void manage_server_side_cookies(struct stream *s, struct channel *rtr);
Willy Tarreau0ad8e0d2017-12-22 15:03:36 +0100105void check_request_for_cacheability(struct stream *s, struct channel *chn);
Willy Tarreau87b09662015-04-03 00:22:06 +0200106void check_response_for_cacheability(struct stream *s, struct channel *rtr);
Willy Tarreau295a8372011-03-10 11:25:07 +0100107int stats_check_uri(struct stream_interface *si, struct http_txn *txn, struct proxy *backend);
Willy Tarreau04ff9f12013-06-10 18:39:42 +0200108int http_find_full_header2(const char *name, int len,
109 char *sol, struct hdr_idx *idx,
110 struct hdr_ctx *ctx);
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200111int http_find_header2(const char *name, int len,
Willy Tarreau68085d82010-01-18 14:54:04 +0100112 char *sol, struct hdr_idx *idx,
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +0200113 struct hdr_ctx *ctx);
David Carlier4686f792015-09-25 14:10:50 +0100114int http_find_next_header(char *sol, struct hdr_idx *idx,
115 struct hdr_ctx *ctx);
Thierry FOURNIERde6617b2013-10-15 11:43:19 +0200116int http_remove_header2(struct http_msg *msg, struct hdr_idx *idx, struct hdr_ctx *ctx);
117int 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 +0200118int 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 -0800119void http_set_status(unsigned int status, const char *reason, struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200120int http_transform_header_str(struct stream* s, struct http_msg *msg, const char* name,
Thierry FOURNIER5531f872015-03-16 11:15:50 +0100121 unsigned int name_len, const char *str, struct my_regex *re,
122 int action);
Christopher Faulet10079f52018-10-03 15:17:28 +0200123int http_handle_stats(struct stream *s, struct channel *req);
124enum rule_result http_req_get_intercept_rule(struct proxy *px, struct list *rules,
125 struct stream *s, int *deny_status);
126enum rule_result http_res_get_intercept_rule(struct proxy *px, struct list *rules,
127 struct stream *s);
128int http_apply_redirect_rule(struct redirect_rule *rule, struct stream *s, struct http_txn *txn);
Willy Tarreau87b09662015-04-03 00:22:06 +0200129void http_perform_server_redirect(struct stream *s, struct stream_interface *si);
130void http_return_srv_error(struct stream *s, struct stream_interface *si);
Christopher Faulet10079f52018-10-03 15:17:28 +0200131void http_capture_headers(char *som, struct hdr_idx *idx,
132 char **cap, struct cap_hdr *cap_hdr);
Willy Tarreaufd9419d2018-09-07 18:01:03 +0200133void http_capture_bad_message(struct proxy *proxy, struct stream *s,
Willy Tarreau8a0cef22012-03-09 13:39:23 +0100134 struct http_msg *msg,
Willy Tarreau0da5b3b2017-09-21 09:30:46 +0200135 enum h1_state state, struct proxy *other_end);
Willy Tarreau185b5c42012-04-26 15:11:51 +0200136unsigned int http_get_hdr(const struct http_msg *msg, const char *hname, int hlen,
Willy Tarreau294c4732011-12-16 21:35:50 +0100137 struct hdr_idx *idx, int occ,
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200138 struct hdr_ctx *ctx, char **vptr, size_t *vlen);
Willy Tarreau79e57332018-10-02 16:01:16 +0200139unsigned int http_get_fhdr(const struct http_msg *msg, const char *hname, int hlen,
140 struct hdr_idx *idx, int occ,
141 struct hdr_ctx *ctx, char **vptr, size_t *vlen);
Willy Tarreau6b952c82018-09-10 17:45:34 +0200142char *http_txn_get_path(const struct http_txn *txn);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200143
Willy Tarreaueee5b512015-04-03 23:46:31 +0200144struct http_txn *http_alloc_txn(struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200145void http_init_txn(struct stream *s);
146void http_end_txn(struct stream *s);
147void http_reset_txn(struct stream *s);
Christopher Fauletd7c91962015-04-30 11:48:27 +0200148void http_end_txn_clean_session(struct stream *s);
Christopher Faulet10079f52018-10-03 15:17:28 +0200149void http_resync_states(struct stream *s);
150void http_parse_connection_header(struct http_txn *txn, struct http_msg *msg, int to_del);
151void http_change_connection_header(struct http_txn *txn, struct http_msg *msg, int wanted);
Willy Tarreau87b09662015-04-03 00:22:06 +0200152void http_adjust_conn_mode(struct stream *s, struct http_txn *txn, struct http_msg *msg);
Willy Tarreau0937bc42009-12-22 15:03:09 +0100153
Christopher Faulet10079f52018-10-03 15:17:28 +0200154int http_msg_forward_body(struct stream *s, struct http_msg *msg);
155int http_msg_forward_chunked_body(struct stream *s, struct http_msg *msg);
156
Willy Tarreau83061a82018-07-13 11:56:34 +0200157void http_reply_and_close(struct stream *s, short status, struct buffer *msg);
158struct buffer *http_error_message(struct stream *s);
William Lallemand73025dd2014-04-24 14:38:37 +0200159
Willy Tarreaufa355d42009-11-29 18:12:29 +0100160/* to be used when contents change in an HTTP message */
161#define http_msg_move_end(msg, bytes) do { \
162 unsigned int _bytes = (bytes); \
Willy Tarreaua458b672012-03-05 11:17:50 +0100163 (msg)->next += (_bytes); \
Willy Tarreaufa355d42009-11-29 18:12:29 +0100164 (msg)->sov += (_bytes); \
165 (msg)->eoh += (_bytes); \
166 } while (0)
167
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200168
Willy Tarreau211cdec2014-04-17 20:18:08 +0200169/* Return the amount of bytes that need to be rewound before buf->p to access
170 * the current message's headers. The purpose is to be able to easily fetch
171 * the message's beginning before headers are forwarded, as well as after.
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200172 * The principle is that msg->eoh and msg->eol are immutable while msg->sov
173 * equals the sum of the two before forwarding and is zero after forwarding,
174 * so the difference cancels the rewinding.
Willy Tarreau211cdec2014-04-17 20:18:08 +0200175 */
176static inline int http_hdr_rewind(const struct http_msg *msg)
177{
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200178 return msg->eoh + msg->eol - msg->sov;
Willy Tarreau211cdec2014-04-17 20:18:08 +0200179}
180
Willy Tarreauda6eed62014-04-17 20:24:24 +0200181/* Return the amount of bytes that need to be rewound before buf->p to access
182 * the current message's URI. The purpose is to be able to easily fetch
183 * the message's beginning before headers are forwarded, as well as after.
184 */
185static inline int http_uri_rewind(const struct http_msg *msg)
186{
187 return http_hdr_rewind(msg) - msg->sl.rq.u;
188}
189
Willy Tarreau0d090502014-04-17 20:31:44 +0200190/* Return the amount of bytes that need to be rewound before buf->p to access
191 * the current message's BODY. The purpose is to be able to easily fetch
192 * the message's beginning before headers are forwarded, as well as after.
193 */
194static inline int http_body_rewind(const struct http_msg *msg)
195{
196 return http_hdr_rewind(msg) - msg->eoh - msg->eol;
197}
198
199/* Return the amount of bytes that need to be rewound before buf->p to access
200 * the current message's DATA. The difference with the function above is that
201 * if a chunk is present and has already been parsed, its size is skipped so
202 * that the byte pointed to is the first byte of actual data. The function is
203 * safe for use in state HTTP_MSG_DATA regardless of whether the headers were
204 * already forwarded or not.
205 */
206static inline int http_data_rewind(const struct http_msg *msg)
207{
208 return http_body_rewind(msg) - msg->sol;
209}
210
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200211/* Return the maximum amount of bytes that may be read after the beginning of
212 * the message body, according to the advertised length. The function is safe
213 * for use between HTTP_MSG_BODY and HTTP_MSG_DATA regardless of whether the
214 * headers were already forwarded or not.
215 */
216static inline int http_body_bytes(const struct http_msg *msg)
217{
218 int len;
219
Willy Tarreau3ee83442018-06-15 16:42:02 +0200220 len = ci_data(msg->chn) - msg->sov - msg->sol;
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200221 if (len > msg->body_len)
222 len = msg->body_len;
223 return len;
224}
225
Willy Tarreau326e27e2018-12-11 11:04:56 +0100226/* for debugging, reports the HTTP/1 message state name (legacy version) */
227static inline const char *h1_msg_state_str(enum h1_state msg_state)
228{
229 switch (msg_state) {
230 case HTTP_MSG_RQBEFORE: return "MSG_RQBEFORE";
231 case HTTP_MSG_RQBEFORE_CR: return "MSG_RQBEFORE_CR";
232 case HTTP_MSG_RQMETH: return "MSG_RQMETH";
233 case HTTP_MSG_RQMETH_SP: return "MSG_RQMETH_SP";
234 case HTTP_MSG_RQURI: return "MSG_RQURI";
235 case HTTP_MSG_RQURI_SP: return "MSG_RQURI_SP";
236 case HTTP_MSG_RQVER: return "MSG_RQVER";
237 case HTTP_MSG_RQLINE_END: return "MSG_RQLINE_END";
238 case HTTP_MSG_RPBEFORE: return "MSG_RPBEFORE";
239 case HTTP_MSG_RPBEFORE_CR: return "MSG_RPBEFORE_CR";
240 case HTTP_MSG_RPVER: return "MSG_RPVER";
241 case HTTP_MSG_RPVER_SP: return "MSG_RPVER_SP";
242 case HTTP_MSG_RPCODE: return "MSG_RPCODE";
243 case HTTP_MSG_RPCODE_SP: return "MSG_RPCODE_SP";
244 case HTTP_MSG_RPREASON: return "MSG_RPREASON";
245 case HTTP_MSG_RPLINE_END: return "MSG_RPLINE_END";
246 case HTTP_MSG_HDR_FIRST: return "MSG_HDR_FIRST";
247 case HTTP_MSG_HDR_NAME: return "MSG_HDR_NAME";
248 case HTTP_MSG_HDR_COL: return "MSG_HDR_COL";
249 case HTTP_MSG_HDR_L1_SP: return "MSG_HDR_L1_SP";
250 case HTTP_MSG_HDR_L1_LF: return "MSG_HDR_L1_LF";
251 case HTTP_MSG_HDR_L1_LWS: return "MSG_HDR_L1_LWS";
252 case HTTP_MSG_HDR_VAL: return "MSG_HDR_VAL";
253 case HTTP_MSG_HDR_L2_LF: return "MSG_HDR_L2_LF";
254 case HTTP_MSG_HDR_L2_LWS: return "MSG_HDR_L2_LWS";
255 case HTTP_MSG_LAST_LF: return "MSG_LAST_LF";
256 case HTTP_MSG_ERROR: return "MSG_ERROR";
257 case HTTP_MSG_BODY: return "MSG_BODY";
258 case HTTP_MSG_100_SENT: return "MSG_100_SENT";
259 case HTTP_MSG_CHUNK_SIZE: return "MSG_CHUNK_SIZE";
260 case HTTP_MSG_DATA: return "MSG_DATA";
261 case HTTP_MSG_CHUNK_CRLF: return "MSG_CHUNK_CRLF";
262 case HTTP_MSG_TRAILERS: return "MSG_TRAILERS";
263 case HTTP_MSG_ENDING: return "MSG_ENDING";
264 case HTTP_MSG_DONE: return "MSG_DONE";
265 case HTTP_MSG_CLOSING: return "MSG_CLOSING";
266 case HTTP_MSG_CLOSED: return "MSG_CLOSED";
267 case HTTP_MSG_TUNNEL: return "MSG_TUNNEL";
268 default: return "MSG_??????";
269 }
270}
271
Willy Tarreaubaaee002006-06-26 02:48:02 +0200272#endif /* _PROTO_PROTO_HTTP_H */
273
274/*
275 * Local variables:
276 * c-indent-level: 8
277 * c-basic-offset: 8
278 * End:
279 */