blob: 54169a111700efaa6efc8aad43731f59c275a36d [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>
Willy Tarreau0da5b3b2017-09-21 09:30:46 +020030#include <proto/h1.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 Tarreaubaaee002006-06-26 02:48:02 +020054
Christopher Fauletf2824e62018-10-01 12:12:37 +020055/* Export HTX analyzers and helpers */
Christopher Faulet0f226952018-10-22 09:29:56 +020056// FIXME: Rename all these functions http_* once legacy code will be removed
57
Christopher Faulete0768eb2018-10-03 16:38:02 +020058int htx_wait_for_request(struct stream *s, struct channel *req, int an_bit);
59int htx_process_req_common(struct stream *s, struct channel *req, int an_bit, struct proxy *px);
60int htx_process_request(struct stream *s, struct channel *req, int an_bit);
61int htx_process_tarpit(struct stream *s, struct channel *req, int an_bit);
62int htx_wait_for_request_body(struct stream *s, struct channel *req, int an_bit);
63int htx_send_name_header(struct http_txn *txn, struct proxy* be, const char* svr_name);
64int htx_wait_for_response(struct stream *s, struct channel *rep, int an_bit);
65int htx_process_res_common(struct stream *s, struct channel *rep, int an_bit, struct proxy *px);
66int htx_request_forward_body(struct stream *s, struct channel *req, int an_bit);
67int htx_response_forward_body(struct stream *s, struct channel *res, int an_bit);
Christopher Faulet0f226952018-10-22 09:29:56 +020068void htx_adjust_conn_mode(struct stream *s, struct http_txn *txn);
Christopher Fauletf2824e62018-10-01 12:12:37 +020069int htx_apply_redirect_rule(struct redirect_rule *rule, struct stream *s, struct http_txn *txn);
Christopher Faulet0f226952018-10-22 09:29:56 +020070void htx_server_error(struct stream *s, struct stream_interface *si, int err, int finst, const struct buffer *msg);
71void htx_reply_and_close(struct stream *s, short status, struct buffer *msg);
72
Christopher Faulete0768eb2018-10-03 16:38:02 +020073
Willy Tarreau87b09662015-04-03 00:22:06 +020074void debug_hdr(const char *dir, struct stream *s, const char *start, const char *end);
Willy Tarreau87b09662015-04-03 00:22:06 +020075int apply_filter_to_req_headers(struct stream *s, struct channel *req, struct hdr_exp *exp);
76int apply_filter_to_req_line(struct stream *s, struct channel *req, struct hdr_exp *exp);
77int apply_filters_to_request(struct stream *s, struct channel *req, struct proxy *px);
78int apply_filters_to_response(struct stream *s, struct channel *rtr, struct proxy *px);
Willy Tarreau87b09662015-04-03 00:22:06 +020079void manage_client_side_cookies(struct stream *s, struct channel *req);
80void manage_server_side_cookies(struct stream *s, struct channel *rtr);
Willy Tarreau0ad8e0d2017-12-22 15:03:36 +010081void check_request_for_cacheability(struct stream *s, struct channel *chn);
Willy Tarreau87b09662015-04-03 00:22:06 +020082void check_response_for_cacheability(struct stream *s, struct channel *rtr);
Willy Tarreau295a8372011-03-10 11:25:07 +010083int stats_check_uri(struct stream_interface *si, struct http_txn *txn, struct proxy *backend);
Willy Tarreau80587432006-12-24 17:47:20 +010084void init_proto_http();
Willy Tarreau04ff9f12013-06-10 18:39:42 +020085int http_find_full_header2(const char *name, int len,
86 char *sol, struct hdr_idx *idx,
87 struct hdr_ctx *ctx);
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +020088int http_find_header2(const char *name, int len,
Willy Tarreau68085d82010-01-18 14:54:04 +010089 char *sol, struct hdr_idx *idx,
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +020090 struct hdr_ctx *ctx);
David Carlier4686f792015-09-25 14:10:50 +010091int http_find_next_header(char *sol, struct hdr_idx *idx,
92 struct hdr_ctx *ctx);
Thierry FOURNIERde6617b2013-10-15 11:43:19 +020093int http_remove_header2(struct http_msg *msg, struct hdr_idx *idx, struct hdr_ctx *ctx);
94int 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 +020095int 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 -080096void http_set_status(unsigned int status, const char *reason, struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +020097int http_transform_header_str(struct stream* s, struct http_msg *msg, const char* name,
Thierry FOURNIER5531f872015-03-16 11:15:50 +010098 unsigned int name_len, const char *str, struct my_regex *re,
99 int action);
Vincent Bernat6e615892016-05-18 16:17:44 +0200100void inet_set_tos(int fd, const struct sockaddr_storage *from, int tos);
Christopher Faulet10079f52018-10-03 15:17:28 +0200101int http_handle_stats(struct stream *s, struct channel *req);
102enum rule_result http_req_get_intercept_rule(struct proxy *px, struct list *rules,
103 struct stream *s, int *deny_status);
104enum rule_result http_res_get_intercept_rule(struct proxy *px, struct list *rules,
105 struct stream *s);
106int http_apply_redirect_rule(struct redirect_rule *rule, struct stream *s, struct http_txn *txn);
Willy Tarreau87b09662015-04-03 00:22:06 +0200107void http_perform_server_redirect(struct stream *s, struct stream_interface *si);
108void http_return_srv_error(struct stream *s, struct stream_interface *si);
Christopher Faulet10079f52018-10-03 15:17:28 +0200109void http_capture_headers(char *som, struct hdr_idx *idx,
110 char **cap, struct cap_hdr *cap_hdr);
Willy Tarreaufd9419d2018-09-07 18:01:03 +0200111void http_capture_bad_message(struct proxy *proxy, struct stream *s,
Willy Tarreau8a0cef22012-03-09 13:39:23 +0100112 struct http_msg *msg,
Willy Tarreau0da5b3b2017-09-21 09:30:46 +0200113 enum h1_state state, struct proxy *other_end);
Willy Tarreau185b5c42012-04-26 15:11:51 +0200114unsigned int http_get_hdr(const struct http_msg *msg, const char *hname, int hlen,
Willy Tarreau294c4732011-12-16 21:35:50 +0100115 struct hdr_idx *idx, int occ,
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200116 struct hdr_ctx *ctx, char **vptr, size_t *vlen);
Willy Tarreau79e57332018-10-02 16:01:16 +0200117unsigned int http_get_fhdr(const struct http_msg *msg, const char *hname, int hlen,
118 struct hdr_idx *idx, int occ,
119 struct hdr_ctx *ctx, char **vptr, size_t *vlen);
Willy Tarreau6b952c82018-09-10 17:45:34 +0200120char *http_txn_get_path(const struct http_txn *txn);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200121
Willy Tarreaueee5b512015-04-03 23:46:31 +0200122struct http_txn *http_alloc_txn(struct stream *s);
Willy Tarreau87b09662015-04-03 00:22:06 +0200123void http_init_txn(struct stream *s);
124void http_end_txn(struct stream *s);
125void http_reset_txn(struct stream *s);
Christopher Fauletd7c91962015-04-30 11:48:27 +0200126void http_end_txn_clean_session(struct stream *s);
Christopher Faulet10079f52018-10-03 15:17:28 +0200127void http_resync_states(struct stream *s);
128void http_parse_connection_header(struct http_txn *txn, struct http_msg *msg, int to_del);
129void http_change_connection_header(struct http_txn *txn, struct http_msg *msg, int wanted);
Willy Tarreau87b09662015-04-03 00:22:06 +0200130void http_adjust_conn_mode(struct stream *s, struct http_txn *txn, struct http_msg *msg);
Willy Tarreau0937bc42009-12-22 15:03:09 +0100131
Christopher Faulet10079f52018-10-03 15:17:28 +0200132int http_msg_forward_body(struct stream *s, struct http_msg *msg);
133int http_msg_forward_chunked_body(struct stream *s, struct http_msg *msg);
134
Willy Tarreau83061a82018-07-13 11:56:34 +0200135void http_reply_and_close(struct stream *s, short status, struct buffer *msg);
136struct buffer *http_error_message(struct stream *s);
William Lallemand73025dd2014-04-24 14:38:37 +0200137
Willy Tarreaufa355d42009-11-29 18:12:29 +0100138/* to be used when contents change in an HTTP message */
139#define http_msg_move_end(msg, bytes) do { \
140 unsigned int _bytes = (bytes); \
Willy Tarreaua458b672012-03-05 11:17:50 +0100141 (msg)->next += (_bytes); \
Willy Tarreaufa355d42009-11-29 18:12:29 +0100142 (msg)->sov += (_bytes); \
143 (msg)->eoh += (_bytes); \
144 } while (0)
145
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200146
Willy Tarreau211cdec2014-04-17 20:18:08 +0200147/* Return the amount of bytes that need to be rewound before buf->p to access
148 * the current message's headers. The purpose is to be able to easily fetch
149 * the message's beginning before headers are forwarded, as well as after.
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200150 * The principle is that msg->eoh and msg->eol are immutable while msg->sov
151 * equals the sum of the two before forwarding and is zero after forwarding,
152 * so the difference cancels the rewinding.
Willy Tarreau211cdec2014-04-17 20:18:08 +0200153 */
154static inline int http_hdr_rewind(const struct http_msg *msg)
155{
Willy Tarreau1234f4a2014-04-17 21:14:47 +0200156 return msg->eoh + msg->eol - msg->sov;
Willy Tarreau211cdec2014-04-17 20:18:08 +0200157}
158
Willy Tarreauda6eed62014-04-17 20:24:24 +0200159/* Return the amount of bytes that need to be rewound before buf->p to access
160 * the current message's URI. The purpose is to be able to easily fetch
161 * the message's beginning before headers are forwarded, as well as after.
162 */
163static inline int http_uri_rewind(const struct http_msg *msg)
164{
165 return http_hdr_rewind(msg) - msg->sl.rq.u;
166}
167
Willy Tarreau0d090502014-04-17 20:31:44 +0200168/* Return the amount of bytes that need to be rewound before buf->p to access
169 * the current message's BODY. 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_body_rewind(const struct http_msg *msg)
173{
174 return http_hdr_rewind(msg) - msg->eoh - msg->eol;
175}
176
177/* Return the amount of bytes that need to be rewound before buf->p to access
178 * the current message's DATA. The difference with the function above is that
179 * if a chunk is present and has already been parsed, its size is skipped so
180 * that the byte pointed to is the first byte of actual data. The function is
181 * safe for use in state HTTP_MSG_DATA regardless of whether the headers were
182 * already forwarded or not.
183 */
184static inline int http_data_rewind(const struct http_msg *msg)
185{
186 return http_body_rewind(msg) - msg->sol;
187}
188
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200189/* Return the maximum amount of bytes that may be read after the beginning of
190 * the message body, according to the advertised length. The function is safe
191 * for use between HTTP_MSG_BODY and HTTP_MSG_DATA regardless of whether the
192 * headers were already forwarded or not.
193 */
194static inline int http_body_bytes(const struct http_msg *msg)
195{
196 int len;
197
Willy Tarreau3ee83442018-06-15 16:42:02 +0200198 len = ci_data(msg->chn) - msg->sov - msg->sol;
Willy Tarreau2d8e4852014-04-17 20:08:17 +0200199 if (len > msg->body_len)
200 len = msg->body_len;
201 return len;
202}
203
Willy Tarreaubaaee002006-06-26 02:48:02 +0200204#endif /* _PROTO_PROTO_HTTP_H */
205
206/*
207 * Local variables:
208 * c-indent-level: 8
209 * c-basic-offset: 8
210 * End:
211 */