blob: 97e4652002010734cb052a3599418dc00373e51b [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>
27#include <types/session.h>
28#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 Tarreaubaaee002006-06-26 02:48:02 +020066int process_cli(struct session *t);
Willy Tarreaufa7e1022008-10-19 07:30:41 +020067int process_srv_data(struct session *t);
68int process_srv_conn(struct session *t);
Willy Tarreau7421efb2012-07-02 15:11:27 +020069int http_wait_for_request(struct session *s, struct channel *req, int an_bit);
70int http_process_req_common(struct session *s, struct channel *req, int an_bit, struct proxy *px);
71int http_process_request(struct session *t, struct channel *req, int an_bit);
72int http_process_tarpit(struct session *s, struct channel *req, int an_bit);
73int http_process_request_body(struct session *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 Tarreau7421efb2012-07-02 15:11:27 +020075int http_wait_for_response(struct session *s, struct channel *rep, int an_bit);
76int http_process_res_common(struct session *t, struct channel *rep, int an_bit, struct proxy *px);
77int http_request_forward_body(struct session *s, struct channel *req, int an_bit);
78int http_response_forward_body(struct session *s, struct channel *res, int an_bit);
Willy Tarreaubaaee002006-06-26 02:48:02 +020079
Willy Tarreau58f10d72006-12-04 02:26:12 +010080void debug_hdr(const char *dir, struct session *t, const char *start, const char *end);
Willy Tarreau8d5d7f22007-01-21 19:16:41 +010081void get_srv_from_appsession(struct session *t, const char *begin, int len);
Willy Tarreau7421efb2012-07-02 15:11:27 +020082int apply_filter_to_req_headers(struct session *t, struct channel *req, struct hdr_exp *exp);
83int apply_filter_to_req_line(struct session *t, struct channel *req, struct hdr_exp *exp);
84int apply_filters_to_request(struct session *s, struct channel *req, struct proxy *px);
85int apply_filters_to_response(struct session *t, struct channel *rtr, struct proxy *px);
Cyril Bontéb21570a2009-11-29 20:04:48 +010086void manage_client_side_appsession(struct session *t, const char *buf, int len);
Willy Tarreau7421efb2012-07-02 15:11:27 +020087void manage_client_side_cookies(struct session *t, struct channel *req);
88void manage_server_side_cookies(struct session *t, struct channel *rtr);
89void check_response_for_cacheability(struct session *t, struct channel *rtr);
Willy Tarreau295a8372011-03-10 11:25:07 +010090int stats_check_uri(struct stream_interface *si, struct http_txn *txn, struct proxy *backend);
Willy Tarreau80587432006-12-24 17:47:20 +010091void init_proto_http();
Willy Tarreau04ff9f12013-06-10 18:39:42 +020092int http_find_full_header2(const char *name, int len,
93 char *sol, struct hdr_idx *idx,
94 struct hdr_ctx *ctx);
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +020095int http_find_header2(const char *name, int len,
Willy Tarreau68085d82010-01-18 14:54:04 +010096 char *sol, struct hdr_idx *idx,
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +020097 struct hdr_ctx *ctx);
Thierry FOURNIERde6617b2013-10-15 11:43:19 +020098char *find_hdr_value_end(char *s, const char *e);
99int http_header_match2(const char *hdr, const char *end, const char *name, int len);
100int http_remove_header2(struct http_msg *msg, struct hdr_idx *idx, struct hdr_ctx *ctx);
101int http_header_add_tail2(struct http_msg *msg, struct hdr_idx *hdr_idx, const char *text, int len);
Willy Tarreau55a8d0e2008-11-30 18:47:21 +0100102void http_sess_log(struct session *s);
Willy Tarreau71241ab2012-12-27 11:30:54 +0100103void http_perform_server_redirect(struct session *s, struct stream_interface *si);
Willy Tarreau0cac36f2008-11-30 20:44:17 +0100104void http_return_srv_error(struct session *s, struct stream_interface *si);
Willy Tarreau4076a152009-04-02 15:18:36 +0200105void http_capture_bad_message(struct error_snapshot *es, struct session *s,
Willy Tarreau8a0cef22012-03-09 13:39:23 +0100106 struct http_msg *msg,
Willy Tarreau078272e2010-12-12 12:46:33 +0100107 int state, struct proxy *other_end);
Willy Tarreau185b5c42012-04-26 15:11:51 +0200108unsigned int http_get_hdr(const struct http_msg *msg, const char *hname, int hlen,
Willy Tarreau294c4732011-12-16 21:35:50 +0100109 struct hdr_idx *idx, int occ,
110 struct hdr_ctx *ctx, char **vptr, int *vlen);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200111
Willy Tarreau0937bc42009-12-22 15:03:09 +0100112void http_init_txn(struct session *s);
113void http_end_txn(struct session *s);
114void http_reset_txn(struct session *s);
115
Willy Tarreauff011f22011-01-06 17:51:27 +0100116struct http_req_rule *parse_http_req_cond(const char **args, const char *file, int linenum, struct proxy *proxy);
Willy Tarreaue365c0b2013-06-11 16:06:12 +0200117struct http_res_rule *parse_http_res_cond(const char **args, const char *file, int linenum, struct proxy *proxy);
Willy Tarreauff011f22011-01-06 17:51:27 +0100118void free_http_req_rules(struct list *r);
Willy Tarreau783f2582012-09-04 12:19:04 +0200119struct chunk *http_error_message(struct session *s, int msgnum);
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +0100120struct redirect_rule *http_parse_redirect_rule(const char *file, int linenum, struct proxy *curproxy,
121 const char **args, char **errmsg, int use_fmt);
Willy Tarreauff011f22011-01-06 17:51:27 +0100122
Willy Tarreaufa355d42009-11-29 18:12:29 +0100123/* to be used when contents change in an HTTP message */
124#define http_msg_move_end(msg, bytes) do { \
125 unsigned int _bytes = (bytes); \
Willy Tarreaua458b672012-03-05 11:17:50 +0100126 (msg)->next += (_bytes); \
Willy Tarreaufa355d42009-11-29 18:12:29 +0100127 (msg)->sov += (_bytes); \
128 (msg)->eoh += (_bytes); \
129 } while (0)
130
Willy Tarreau88c6d812012-11-21 21:50:04 +0100131/* for debugging, reports the HTTP message state name */
132static inline const char *http_msg_state_str(int msg_state)
133{
134 switch (msg_state) {
135 case HTTP_MSG_RQBEFORE: return "MSG_RQBEFORE";
136 case HTTP_MSG_RQBEFORE_CR: return "MSG_RQBEFORE_CR";
137 case HTTP_MSG_RQMETH: return "MSG_RQMETH";
138 case HTTP_MSG_RQMETH_SP: return "MSG_RQMETH_SP";
139 case HTTP_MSG_RQURI: return "MSG_RQURI";
140 case HTTP_MSG_RQURI_SP: return "MSG_RQURI_SP";
141 case HTTP_MSG_RQVER: return "MSG_RQVER";
142 case HTTP_MSG_RQLINE_END: return "MSG_RQLINE_END";
143 case HTTP_MSG_RPBEFORE: return "MSG_RPBEFORE";
144 case HTTP_MSG_RPBEFORE_CR: return "MSG_RPBEFORE_CR";
145 case HTTP_MSG_RPVER: return "MSG_RPVER";
146 case HTTP_MSG_RPVER_SP: return "MSG_RPVER_SP";
147 case HTTP_MSG_RPCODE: return "MSG_RPCODE";
148 case HTTP_MSG_RPCODE_SP: return "MSG_RPCODE_SP";
149 case HTTP_MSG_RPREASON: return "MSG_RPREASON";
150 case HTTP_MSG_RPLINE_END: return "MSG_RPLINE_END";
151 case HTTP_MSG_HDR_FIRST: return "MSG_HDR_FIRST";
152 case HTTP_MSG_HDR_NAME: return "MSG_HDR_NAME";
153 case HTTP_MSG_HDR_COL: return "MSG_HDR_COL";
154 case HTTP_MSG_HDR_L1_SP: return "MSG_HDR_L1_SP";
155 case HTTP_MSG_HDR_L1_LF: return "MSG_HDR_L1_LF";
156 case HTTP_MSG_HDR_L1_LWS: return "MSG_HDR_L1_LWS";
157 case HTTP_MSG_HDR_VAL: return "MSG_HDR_VAL";
158 case HTTP_MSG_HDR_L2_LF: return "MSG_HDR_L2_LF";
159 case HTTP_MSG_HDR_L2_LWS: return "MSG_HDR_L2_LWS";
160 case HTTP_MSG_LAST_LF: return "MSG_LAST_LF";
161 case HTTP_MSG_ERROR: return "MSG_ERROR";
162 case HTTP_MSG_BODY: return "MSG_BODY";
163 case HTTP_MSG_100_SENT: return "MSG_100_SENT";
164 case HTTP_MSG_CHUNK_SIZE: return "MSG_CHUNK_SIZE";
165 case HTTP_MSG_DATA: return "MSG_DATA";
166 case HTTP_MSG_CHUNK_CRLF: return "MSG_CHUNK_CRLF";
167 case HTTP_MSG_TRAILERS: return "MSG_TRAILERS";
168 case HTTP_MSG_DONE: return "MSG_DONE";
169 case HTTP_MSG_CLOSING: return "MSG_CLOSING";
170 case HTTP_MSG_CLOSED: return "MSG_CLOSED";
171 case HTTP_MSG_TUNNEL: return "MSG_TUNNEL";
172 default: return "MSG_??????";
173 }
174}
175
Willy Tarreaubaaee002006-06-26 02:48:02 +0200176#endif /* _PROTO_PROTO_HTTP_H */
177
178/*
179 * Local variables:
180 * c-indent-level: 8
181 * c-basic-offset: 8
182 * End:
183 */