blob: 7a32c2156f6b64266a3e0aa3fd0558052b0dd539 [file] [log] [blame]
Christopher Faulet47596d32018-10-22 09:17:28 +02001/*
2 * Functions to manipulate HTTP messages using the internal representation.
3 *
4 * Copyright (C) 2018 HAProxy Technologies, Christopher Faulet <cfaulet@haproxy.com>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
Christopher Faulet5031ef52020-01-15 11:22:07 +010012#include <sys/types.h>
13#include <sys/stat.h>
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +020014#include <ctype.h>
Christopher Faulet5031ef52020-01-15 11:22:07 +010015#include <fcntl.h>
16#include <unistd.h>
17
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020018#include <haproxy/api.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020019#include <haproxy/arg.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020020#include <haproxy/cfgparse.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020021#include <haproxy/global.h>
Willy Tarreau5413a872020-06-02 19:33:08 +020022#include <haproxy/h1.h>
Willy Tarreaucd72d8c2020-06-02 19:11:26 +020023#include <haproxy/http.h>
Amaury Denoyelle2c5a7ee2022-08-17 16:33:53 +020024#include <haproxy/http-hdr.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020025#include <haproxy/http_fetch.h>
Willy Tarreau87735332020-06-04 09:08:41 +020026#include <haproxy/http_htx.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020027#include <haproxy/htx.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020028#include <haproxy/log.h>
29#include <haproxy/regex.h>
30#include <haproxy/sample.h>
Willy Tarreau4cbf62d2021-05-08 13:01:23 +020031#include <haproxy/tools.h>
Christopher Faulet47596d32018-10-22 09:17:28 +020032
Christopher Faulet47596d32018-10-22 09:17:28 +020033
Christopher Fauletf7346382019-07-17 22:02:08 +020034struct buffer http_err_chunks[HTTP_ERR_SIZE];
Christopher Faulet1b13eca2020-05-14 09:54:26 +020035struct http_reply http_err_replies[HTTP_ERR_SIZE];
36
Christopher Faulet58857752020-01-15 15:19:50 +010037struct eb_root http_error_messages = EB_ROOT;
Christopher Faulet35cd81d2020-01-15 11:22:56 +010038struct list http_errors_list = LIST_HEAD_INIT(http_errors_list);
Christopher Faulet5809e102020-05-14 17:31:52 +020039struct list http_replies_list = LIST_HEAD_INIT(http_replies_list);
Christopher Fauleta7b677c2018-11-29 16:48:49 +010040
Christopher Faulet76edc0f2020-01-13 15:52:01 +010041/* The declaration of an errorfiles/errorfile directives. Used during config
42 * parsing only. */
43struct conf_errors {
44 char type; /* directive type (0: errorfiles, 1: errorfile) */
45 union {
46 struct {
47 int status; /* the status code associated to this error */
Christopher Faulet5809e102020-05-14 17:31:52 +020048 struct http_reply *reply; /* the http reply for the errorfile */
Christopher Faulet76edc0f2020-01-13 15:52:01 +010049 } errorfile; /* describe an "errorfile" directive */
50 struct {
51 char *name; /* the http-errors section name */
52 char status[HTTP_ERR_SIZE]; /* list of status to import (0: ignore, 1: implicit import, 2: explicit import) */
53 } errorfiles; /* describe an "errorfiles" directive */
54 } info;
55
56 char *file; /* file where the directive appears */
57 int line; /* line where the directive appears */
58
59 struct list list; /* next conf_errors */
60};
61
Christopher Faulet297fbb42019-05-13 14:41:27 +020062/* Returns the next unporocessed start line in the HTX message. It returns NULL
Christopher Faulet29f17582019-05-23 11:03:26 +020063 * if the start-line is undefined (first == -1). Otherwise, it returns the
Christopher Faulet297fbb42019-05-13 14:41:27 +020064 * pointer on the htx_sl structure.
Christopher Faulet47596d32018-10-22 09:17:28 +020065 */
Tim Duesterhusb8ee8942021-04-03 20:39:20 +020066struct htx_sl *http_get_stline(const struct htx *htx)
Christopher Faulet47596d32018-10-22 09:17:28 +020067{
Christopher Faulet297fbb42019-05-13 14:41:27 +020068 struct htx_blk *blk;
Christopher Faulet573fe732018-11-28 16:55:12 +010069
Christopher Faulet29f17582019-05-23 11:03:26 +020070 blk = htx_get_first_blk(htx);
Christopher Fauleta7d6cf22021-04-15 10:25:35 +020071 if (!blk || (htx_get_blk_type(blk) != HTX_BLK_REQ_SL && htx_get_blk_type(blk) != HTX_BLK_RES_SL))
Christopher Faulet297fbb42019-05-13 14:41:27 +020072 return NULL;
73 return htx_get_blk_ptr(htx, blk);
Christopher Faulet47596d32018-10-22 09:17:28 +020074}
75
Christopher Faulet727a3f12020-02-07 16:39:41 +010076/* Returns the headers size in the HTX message */
77size_t http_get_hdrs_size(struct htx *htx)
78{
79 struct htx_blk *blk;
80 size_t sz = 0;
81
82 blk = htx_get_first_blk(htx);
83 if (!blk || htx_get_blk_type(blk) > HTX_BLK_EOH)
84 return sz;
85
86 for (; blk; blk = htx_get_next_blk(htx, blk)) {
87 sz += htx_get_blksz(blk);
88 if (htx_get_blk_type(blk) == HTX_BLK_EOH)
89 break;
90 }
91 return sz;
92}
93
Christopher Faulet8dd33e12020-05-05 07:42:42 +020094/* Finds the first or next occurrence of header matching <pattern> in the HTX
95 * message <htx> using the context <ctx>. This structure holds everything
96 * necessary to use the header and find next occurrence. If its <blk> member is
97 * NULL, the header is searched from the beginning. Otherwise, the next
98 * occurrence is returned. The function returns 1 when it finds a value, and 0
99 * when there is no more. It is designed to work with headers defined as
100 * comma-separated lists. If HTTP_FIND_FL_FULL flag is set, it works on
101 * full-line headers in whose comma is not a delimiter but is part of the
102 * syntax. A special case, if ctx->value is NULL when searching for a new values
103 * of a header, the current header is rescanned. This allows rescanning after a
104 * header deletion.
105 *
106 * The matching method is chosen by checking the flags :
107 *
108 * * HTTP_FIND_FL_MATCH_REG : <pattern> is a regex. header names matching
109 * the regex are evaluated.
110 * * HTTP_FIND_FL_MATCH_STR : <pattern> is a string. The header names equal
111 * to the string are evaluated.
112 * * HTTP_FIND_FL_MATCH_PFX : <pattern> is a string. The header names
113 * starting by the string are evaluated.
114 * * HTTP_FIND_FL_MATCH_SFX : <pattern> is a string. The header names
115 * ending by the string are evaluated.
116 * * HTTP_FIND_FL_MATCH_SUB : <pattern> is a string. The header names
117 * containing the string are evaluated.
Christopher Faulet47596d32018-10-22 09:17:28 +0200118 */
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200119
120#define HTTP_FIND_FL_MATCH_STR 0x0001
121#define HTTP_FIND_FL_MATCH_PFX 0x0002
122#define HTTP_FIND_FL_MATCH_SFX 0x0003
123#define HTTP_FIND_FL_MATCH_SUB 0x0004
124#define HTTP_FIND_FL_MATCH_REG 0x0005
125/* 0x0006..0x000f: for other matching methods */
126#define HTTP_FIND_FL_MATCH_TYPE 0x000F
127#define HTTP_FIND_FL_FULL 0x0010
128
129static int __http_find_header(const struct htx *htx, const void *pattern, struct http_hdr_ctx *ctx, int flags)
Christopher Faulet47596d32018-10-22 09:17:28 +0200130{
131 struct htx_blk *blk = ctx->blk;
132 struct ist n, v;
133 enum htx_blk_type type;
Christopher Faulet47596d32018-10-22 09:17:28 +0200134
135 if (blk) {
136 char *p;
137
Tim Duesterhused526372020-03-05 17:56:33 +0100138 if (!isttest(ctx->value))
Christopher Faulet47596d32018-10-22 09:17:28 +0200139 goto rescan_hdr;
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200140 if (flags & HTTP_FIND_FL_FULL)
Christopher Faulet47596d32018-10-22 09:17:28 +0200141 goto next_blk;
142 v = htx_get_blk_value(htx, blk);
Tim Duesterhus77508502022-03-15 13:11:06 +0100143 p = istend(ctx->value) + ctx->lws_after;
Christopher Faulet47596d32018-10-22 09:17:28 +0200144 v.len -= (p - v.ptr);
145 v.ptr = p;
146 if (!v.len)
147 goto next_blk;
148 /* Skip comma */
149 if (*(v.ptr) == ',') {
Tim Duesterhus284fbe12021-11-04 22:35:44 +0100150 v = istnext(v);
Christopher Faulet47596d32018-10-22 09:17:28 +0200151 }
152
153 goto return_hdr;
154 }
155
Christopher Faulet192c6a22019-06-11 16:32:24 +0200156 if (htx_is_empty(htx))
Christopher Faulet47596d32018-10-22 09:17:28 +0200157 return 0;
158
Christopher Fauleta3f15502019-05-13 15:27:23 +0200159 for (blk = htx_get_first_blk(htx); blk; blk = htx_get_next_blk(htx, blk)) {
Christopher Faulet47596d32018-10-22 09:17:28 +0200160 rescan_hdr:
Christopher Faulet47596d32018-10-22 09:17:28 +0200161 type = htx_get_blk_type(blk);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +0100162 if (type == HTX_BLK_EOH)
Christopher Faulet573fe732018-11-28 16:55:12 +0100163 break;
Christopher Faulet47596d32018-10-22 09:17:28 +0200164 if (type != HTX_BLK_HDR)
Christopher Faulet28f29c72019-04-30 17:55:45 +0200165 continue;
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200166
167 if ((flags & HTTP_FIND_FL_MATCH_TYPE) == HTTP_FIND_FL_MATCH_REG) {
168 const struct my_regex *re = pattern;
169
170 n = htx_get_blk_name(htx, blk);
171 if (!regex_exec2(re, n.ptr, n.len))
172 goto next_blk;
173 }
174 else {
175 const struct ist name = *(const struct ist *)(pattern);
176
Christopher Faulet47596d32018-10-22 09:17:28 +0200177 /* If no name was passed, we want any header. So skip the comparison */
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200178 if (!istlen(name))
179 goto match;
180
Christopher Faulet47596d32018-10-22 09:17:28 +0200181 n = htx_get_blk_name(htx, blk);
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200182 switch (flags & HTTP_FIND_FL_MATCH_TYPE) {
183 case HTTP_FIND_FL_MATCH_STR:
184 if (!isteqi(n, name))
185 goto next_blk;
186 break;
187 case HTTP_FIND_FL_MATCH_PFX:
188 if (istlen(n) < istlen(name))
189 goto next_blk;
190
191 n = ist2(istptr(n), istlen(name));
192 if (!isteqi(n, name))
193 goto next_blk;
194 break;
195 case HTTP_FIND_FL_MATCH_SFX:
196 if (istlen(n) < istlen(name))
197 goto next_blk;
198
Tim Duesterhus4c8f75f2021-11-06 15:14:44 +0100199 n = ist2(istend(n) - istlen(name),
200 istlen(name));
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200201 if (!isteqi(n, name))
202 goto next_blk;
203 break;
204 case HTTP_FIND_FL_MATCH_SUB:
Maciej Zdeb302b9f82020-11-20 12:12:24 +0000205 if (!strnistr(n.ptr, n.len, name.ptr, name.len))
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200206 goto next_blk;
207 break;
208 default:
Christopher Faulet47596d32018-10-22 09:17:28 +0200209 goto next_blk;
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200210 break;
211 }
Christopher Faulet47596d32018-10-22 09:17:28 +0200212 }
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200213 match:
Christopher Faulet47596d32018-10-22 09:17:28 +0200214 v = htx_get_blk_value(htx, blk);
215
216 return_hdr:
217 ctx->lws_before = 0;
218 ctx->lws_after = 0;
219 while (v.len && HTTP_IS_LWS(*v.ptr)) {
Tim Duesterhus284fbe12021-11-04 22:35:44 +0100220 v = istnext(v);
Christopher Faulet47596d32018-10-22 09:17:28 +0200221 ctx->lws_before++;
222 }
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200223 if (!(flags & HTTP_FIND_FL_FULL))
Tim Duesterhus4c8f75f2021-11-06 15:14:44 +0100224 v.len = http_find_hdr_value_end(v.ptr, istend(v)) - v.ptr;
225
226 while (v.len && HTTP_IS_LWS(*(istend(v) - 1))) {
Christopher Faulet47596d32018-10-22 09:17:28 +0200227 v.len--;
228 ctx->lws_after++;
229 }
Christopher Faulet47596d32018-10-22 09:17:28 +0200230 ctx->blk = blk;
231 ctx->value = v;
232 return 1;
233
234 next_blk:
Christopher Faulet28f29c72019-04-30 17:55:45 +0200235 ;
Christopher Faulet47596d32018-10-22 09:17:28 +0200236 }
237
238 ctx->blk = NULL;
239 ctx->value = ist("");
240 ctx->lws_before = ctx->lws_after = 0;
241 return 0;
242}
243
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200244
245/* Header names must match <name> */
246int http_find_header(const struct htx *htx, const struct ist name, struct http_hdr_ctx *ctx, int full)
247{
248 return __http_find_header(htx, &name, ctx, HTTP_FIND_FL_MATCH_STR | (full ? HTTP_FIND_FL_FULL : 0));
249}
250
251/* Header names must match <name>. Same than http_find_header */
252int http_find_str_header(const struct htx *htx, const struct ist name, struct http_hdr_ctx *ctx, int full)
253{
254 return __http_find_header(htx, &name, ctx, HTTP_FIND_FL_MATCH_STR | (full ? HTTP_FIND_FL_FULL : 0));
255}
256
257
258/* Header names must start with <prefix> */
259int http_find_pfx_header(const struct htx *htx, const struct ist prefix, struct http_hdr_ctx *ctx, int full)
260{
261 return __http_find_header(htx, &prefix, ctx, HTTP_FIND_FL_MATCH_PFX | (full ? HTTP_FIND_FL_FULL : 0));
262}
263
264/* Header names must end with <suffix> */
265int http_find_sfx_header(const struct htx *htx, const struct ist suffix, struct http_hdr_ctx *ctx, int full)
266{
267 return __http_find_header(htx, &suffix, ctx, HTTP_FIND_FL_MATCH_SFX | (full ? HTTP_FIND_FL_FULL : 0));
268}
269/* Header names must contain <sub> */
270int http_find_sub_header(const struct htx *htx, const struct ist sub, struct http_hdr_ctx *ctx, int full)
271{
272 return __http_find_header(htx, &sub, ctx, HTTP_FIND_FL_MATCH_SUB | (full ? HTTP_FIND_FL_FULL : 0));
273}
274
275/* Header names must match <re> regex*/
276int http_match_header(const struct htx *htx, const struct my_regex *re, struct http_hdr_ctx *ctx, int full)
277{
278 return __http_find_header(htx, re, ctx, HTTP_FIND_FL_MATCH_REG | (full ? HTTP_FIND_FL_FULL : 0));
279}
280
281
Christopher Faulet47596d32018-10-22 09:17:28 +0200282/* Adds a header block int the HTX message <htx>, just before the EOH block. It
283 * returns 1 on success, otherwise it returns 0.
284 */
285int http_add_header(struct htx *htx, const struct ist n, const struct ist v)
286{
287 struct htx_blk *blk;
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200288 struct htx_sl *sl;
Christopher Faulet47596d32018-10-22 09:17:28 +0200289 enum htx_blk_type type = htx_get_tail_type(htx);
290 int32_t prev;
291
292 blk = htx_add_header(htx, n, v);
293 if (!blk)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200294 goto fail;
Christopher Faulet47596d32018-10-22 09:17:28 +0200295
296 if (unlikely(type < HTX_BLK_EOH))
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200297 goto end;
Christopher Faulet47596d32018-10-22 09:17:28 +0200298
299 /* <blk> is the head, swap it iteratively with its predecessor to place
300 * it just before the end-of-header block. So blocks remains ordered. */
Christopher Faulet29f17582019-05-23 11:03:26 +0200301 for (prev = htx_get_prev(htx, htx->tail); prev != htx->first; prev = htx_get_prev(htx, prev)) {
Christopher Faulet47596d32018-10-22 09:17:28 +0200302 struct htx_blk *pblk = htx_get_blk(htx, prev);
303 enum htx_blk_type type = htx_get_blk_type(pblk);
304
305 /* Swap .addr and .info fields */
306 blk->addr ^= pblk->addr; pblk->addr ^= blk->addr; blk->addr ^= pblk->addr;
307 blk->info ^= pblk->info; pblk->info ^= blk->info; blk->info ^= pblk->info;
308
309 if (blk->addr == pblk->addr)
310 blk->addr += htx_get_blksz(pblk);
Christopher Faulet47596d32018-10-22 09:17:28 +0200311
312 /* Stop when end-of-header is reached */
313 if (type == HTX_BLK_EOH)
314 break;
315
316 blk = pblk;
317 }
Christopher Faulet05aab642019-04-11 13:43:57 +0200318
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200319 end:
320 sl = http_get_stline(htx);
Christopher Faulet3e1f7f42020-02-28 09:47:07 +0100321 if (sl && (sl->flags & HTX_SL_F_HAS_AUTHORITY) && isteqi(n, ist("host"))) {
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200322 if (!http_update_authority(htx, sl, v))
323 goto fail;
324 }
Christopher Faulet47596d32018-10-22 09:17:28 +0200325 return 1;
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200326
327 fail:
328 return 0;
Christopher Faulet47596d32018-10-22 09:17:28 +0200329}
330
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100331/* Replaces parts of the start-line of the HTX message <htx>. It returns 1 on
Christopher Faulet29f17582019-05-23 11:03:26 +0200332 * success, otherwise it returns 0.
Christopher Faulet47596d32018-10-22 09:17:28 +0200333 */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100334int http_replace_stline(struct htx *htx, const struct ist p1, const struct ist p2, const struct ist p3)
Christopher Faulet47596d32018-10-22 09:17:28 +0200335{
Christopher Faulet7b7d5072019-05-13 15:22:59 +0200336 struct htx_blk *blk;
Christopher Faulet47596d32018-10-22 09:17:28 +0200337
Christopher Faulet29f17582019-05-23 11:03:26 +0200338 blk = htx_get_first_blk(htx);
339 if (!blk || !htx_replace_stline(htx, blk, p1, p2, p3))
Christopher Faulet7b7d5072019-05-13 15:22:59 +0200340 return 0;
341 return 1;
Christopher Faulet47596d32018-10-22 09:17:28 +0200342}
343
Christopher Faulete010c802018-10-24 10:36:45 +0200344/* Replace the request method in the HTX message <htx> by <meth>. It returns 1
345 * on success, otherwise 0.
346 */
347int http_replace_req_meth(struct htx *htx, const struct ist meth)
348{
349 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200350 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100351 struct ist uri, vsn;
Christopher Faulete010c802018-10-24 10:36:45 +0200352
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100353 if (!sl)
354 return 0;
355
Christopher Faulete010c802018-10-24 10:36:45 +0200356 /* Start by copying old uri and version */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100357 chunk_memcat(temp, HTX_SL_REQ_UPTR(sl), HTX_SL_REQ_ULEN(sl)); /* uri */
358 uri = ist2(temp->area, HTX_SL_REQ_ULEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200359
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100360 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl)); /* vsn */
361 vsn = ist2(temp->area + uri.len, HTX_SL_REQ_VLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200362
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100363 /* create the new start line */
364 sl->info.req.meth = find_http_meth(meth.ptr, meth.len);
365 return http_replace_stline(htx, meth, uri, vsn);
Christopher Faulete010c802018-10-24 10:36:45 +0200366}
367
368/* Replace the request uri in the HTX message <htx> by <uri>. It returns 1 on
369 * success, otherwise 0.
370 */
371int http_replace_req_uri(struct htx *htx, const struct ist uri)
372{
373 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200374 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100375 struct ist meth, vsn;
Christopher Faulete010c802018-10-24 10:36:45 +0200376
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100377 if (!sl)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200378 goto fail;
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100379
Christopher Faulete010c802018-10-24 10:36:45 +0200380 /* Start by copying old method and version */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100381 chunk_memcat(temp, HTX_SL_REQ_MPTR(sl), HTX_SL_REQ_MLEN(sl)); /* meth */
382 meth = ist2(temp->area, HTX_SL_REQ_MLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200383
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100384 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl)); /* vsn */
385 vsn = ist2(temp->area + meth.len, HTX_SL_REQ_VLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200386
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100387 /* create the new start line */
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200388 if (!http_replace_stline(htx, meth, uri, vsn))
389 goto fail;
390
391 sl = http_get_stline(htx);
392 if (!http_update_host(htx, sl, uri))
393 goto fail;
394
395 return 1;
396 fail:
397 return 0;
Christopher Faulete010c802018-10-24 10:36:45 +0200398}
399
Christopher Fauletb8ce5052020-08-31 16:11:57 +0200400/* Replace the request path in the HTX message <htx> by <path>. The host part is
401 * preserverd. if <with_qs> is set, the query string is evaluated as part of the
402 * path and replaced. Otherwise, it is preserved too. It returns 1 on success,
403 * otherwise 0.
Christopher Faulete010c802018-10-24 10:36:45 +0200404 */
Christopher Fauletb8ce5052020-08-31 16:11:57 +0200405int http_replace_req_path(struct htx *htx, const struct ist path, int with_qs)
Christopher Faulete010c802018-10-24 10:36:45 +0200406{
407 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200408 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100409 struct ist meth, uri, vsn, p;
Christopher Faulete010c802018-10-24 10:36:45 +0200410 size_t plen = 0;
Amaury Denoyellec453f952021-07-06 11:40:12 +0200411 struct http_uri_parser parser;
Christopher Faulete010c802018-10-24 10:36:45 +0200412
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100413 if (!sl)
414 return 0;
415
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100416 uri = htx_sl_req_uri(sl);
Amaury Denoyellec453f952021-07-06 11:40:12 +0200417 parser = http_uri_parser_init(uri);
418 p = http_parse_path(&parser);
Tim Duesterhused526372020-03-05 17:56:33 +0100419 if (!isttest(p))
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100420 p = uri;
Christopher Fauletb8ce5052020-08-31 16:11:57 +0200421 if (with_qs)
422 plen = p.len;
423 else {
424 while (plen < p.len && *(p.ptr + plen) != '?')
425 plen++;
426 }
Christopher Faulete010c802018-10-24 10:36:45 +0200427
428 /* Start by copying old method and version and create the new uri */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100429 chunk_memcat(temp, HTX_SL_REQ_MPTR(sl), HTX_SL_REQ_MLEN(sl)); /* meth */
430 meth = ist2(temp->area, HTX_SL_REQ_MLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200431
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100432 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl)); /* vsn */
433 vsn = ist2(temp->area + meth.len, HTX_SL_REQ_VLEN(sl));
434
435 chunk_memcat(temp, uri.ptr, p.ptr - uri.ptr); /* uri: host part */
Tim Duesterhus9f7ed8a2021-11-08 09:05:04 +0100436 chunk_istcat(temp, path); /* uri: new path */
Christopher Faulete010c802018-10-24 10:36:45 +0200437 chunk_memcat(temp, p.ptr + plen, p.len - plen); /* uri: QS part */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100438 uri = ist2(temp->area + meth.len + vsn.len, uri.len - plen + path.len);
Christopher Faulete010c802018-10-24 10:36:45 +0200439
440 /* create the new start line */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100441 return http_replace_stline(htx, meth, uri, vsn);
Christopher Faulete010c802018-10-24 10:36:45 +0200442}
443
444/* Replace the request query-string in the HTX message <htx> by <query>. The
445 * host part and the path are preserved. It returns 1 on success, otherwise
446 * 0.
447 */
448int http_replace_req_query(struct htx *htx, const struct ist query)
449{
450 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200451 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100452 struct ist meth, uri, vsn, q;
Christopher Faulete010c802018-10-24 10:36:45 +0200453 int offset = 1;
454
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100455 if (!sl)
456 return 0;
457
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100458 uri = htx_sl_req_uri(sl);
459 q = uri;
Christopher Faulete010c802018-10-24 10:36:45 +0200460 while (q.len > 0 && *(q.ptr) != '?') {
Tim Duesterhus284fbe12021-11-04 22:35:44 +0100461 q = istnext(q);
Christopher Faulete010c802018-10-24 10:36:45 +0200462 }
463
464 /* skip the question mark or indicate that we must insert it
465 * (but only if the format string is not empty then).
466 */
467 if (q.len) {
Tim Duesterhus284fbe12021-11-04 22:35:44 +0100468 q = istnext(q);
Christopher Faulete010c802018-10-24 10:36:45 +0200469 }
470 else if (query.len > 1)
471 offset = 0;
472
473 /* Start by copying old method and version and create the new uri */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100474 chunk_memcat(temp, HTX_SL_REQ_MPTR(sl), HTX_SL_REQ_MLEN(sl)); /* meth */
475 meth = ist2(temp->area, HTX_SL_REQ_MLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200476
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100477 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl)); /* vsn */
478 vsn = ist2(temp->area + meth.len, HTX_SL_REQ_VLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200479
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100480 chunk_memcat(temp, uri.ptr, q.ptr - uri.ptr); /* uri: host + path part */
481 chunk_memcat(temp, query.ptr + offset, query.len - offset); /* uri: new QS */
482 uri = ist2(temp->area + meth.len + vsn.len, uri.len - q.len + query.len - offset);
Christopher Faulete010c802018-10-24 10:36:45 +0200483
484 /* create the new start line */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100485 return http_replace_stline(htx, meth, uri, vsn);
Christopher Faulete010c802018-10-24 10:36:45 +0200486}
487
488/* Replace the response status in the HTX message <htx> by <status>. It returns
489 * 1 on success, otherwise 0.
490*/
Christopher Fauletbde2c4c2020-08-31 16:43:34 +0200491int http_replace_res_status(struct htx *htx, const struct ist status, const struct ist reason)
Christopher Faulete010c802018-10-24 10:36:45 +0200492{
493 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200494 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletbde2c4c2020-08-31 16:43:34 +0200495 struct ist vsn, r;
Christopher Faulete010c802018-10-24 10:36:45 +0200496
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100497 if (!sl)
498 return 0;
499
Christopher Faulete010c802018-10-24 10:36:45 +0200500 /* Start by copying old uri and version */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100501 chunk_memcat(temp, HTX_SL_RES_VPTR(sl), HTX_SL_RES_VLEN(sl)); /* vsn */
502 vsn = ist2(temp->area, HTX_SL_RES_VLEN(sl));
Christopher Fauletbde2c4c2020-08-31 16:43:34 +0200503 r = reason;
504 if (!isttest(r)) {
505 chunk_memcat(temp, HTX_SL_RES_RPTR(sl), HTX_SL_RES_RLEN(sl)); /* reason */
506 r = ist2(temp->area + vsn.len, HTX_SL_RES_RLEN(sl));
507 }
Christopher Faulete010c802018-10-24 10:36:45 +0200508
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100509 /* create the new start line */
510 sl->info.res.status = strl2ui(status.ptr, status.len);
Christopher Fauletbde2c4c2020-08-31 16:43:34 +0200511 return http_replace_stline(htx, vsn, status, r);
Christopher Faulete010c802018-10-24 10:36:45 +0200512}
513
514/* Replace the response reason in the HTX message <htx> by <reason>. It returns
515 * 1 on success, otherwise 0.
516*/
517int http_replace_res_reason(struct htx *htx, const struct ist reason)
518{
519 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200520 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100521 struct ist vsn, status;
Christopher Faulete010c802018-10-24 10:36:45 +0200522
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100523 if (!sl)
524 return 0;
525
Christopher Faulete010c802018-10-24 10:36:45 +0200526 /* Start by copying old uri and version */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100527 chunk_memcat(temp, HTX_SL_RES_VPTR(sl), HTX_SL_RES_VLEN(sl)); /* vsn */
528 vsn = ist2(temp->area, HTX_SL_RES_VLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200529
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100530 chunk_memcat(temp, HTX_SL_RES_CPTR(sl), HTX_SL_RES_CLEN(sl)); /* code */
531 status = ist2(temp->area + vsn.len, HTX_SL_RES_CLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200532
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100533 /* create the new start line */
534 return http_replace_stline(htx, vsn, status, reason);
Christopher Faulete010c802018-10-24 10:36:45 +0200535}
536
Christopher Faulet47596d32018-10-22 09:17:28 +0200537/* Replaces a part of a header value referenced in the context <ctx> by
538 * <data>. It returns 1 on success, otherwise it returns 0. The context is
539 * updated if necessary.
540 */
541int http_replace_header_value(struct htx *htx, struct http_hdr_ctx *ctx, const struct ist data)
542{
543 struct htx_blk *blk = ctx->blk;
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200544 struct htx_sl *sl;
Christopher Faulet47596d32018-10-22 09:17:28 +0200545 char *start;
546 struct ist v;
547 uint32_t len, off;
548
549 if (!blk)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200550 goto fail;
Christopher Faulet47596d32018-10-22 09:17:28 +0200551
552 v = htx_get_blk_value(htx, blk);
553 start = ctx->value.ptr - ctx->lws_before;
554 len = ctx->lws_before + ctx->value.len + ctx->lws_after;
555 off = start - v.ptr;
556
557 blk = htx_replace_blk_value(htx, blk, ist2(start, len), data);
558 if (!blk)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200559 goto fail;
Christopher Faulet47596d32018-10-22 09:17:28 +0200560
561 v = htx_get_blk_value(htx, blk);
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200562
563 sl = http_get_stline(htx);
564 if (sl && (sl->flags & HTX_SL_F_HAS_AUTHORITY)) {
565 struct ist n = htx_get_blk_name(htx, blk);
566
567 if (isteq(n, ist("host"))) {
568 if (!http_update_authority(htx, sl, v))
569 goto fail;
570 ctx->blk = NULL;
571 http_find_header(htx, ist("host"), ctx, 1);
572 blk = ctx->blk;
573 v = htx_get_blk_value(htx, blk);
574 }
575 }
576
Christopher Faulet47596d32018-10-22 09:17:28 +0200577 ctx->blk = blk;
Tim Duesterhus77508502022-03-15 13:11:06 +0100578 ctx->value = ist2(v.ptr + off, data.len);
Christopher Faulet47596d32018-10-22 09:17:28 +0200579 ctx->lws_before = ctx->lws_after = 0;
580
581 return 1;
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200582 fail:
583 return 0;
Christopher Faulet47596d32018-10-22 09:17:28 +0200584}
585
586/* Fully replaces a header referenced in the context <ctx> by the name <name>
587 * with the value <value>. It returns 1 on success, otherwise it returns 0. The
588 * context is updated if necessary.
589 */
590int http_replace_header(struct htx *htx, struct http_hdr_ctx *ctx,
591 const struct ist name, const struct ist value)
592{
593 struct htx_blk *blk = ctx->blk;
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200594 struct htx_sl *sl;
Christopher Faulet47596d32018-10-22 09:17:28 +0200595
596 if (!blk)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200597 goto fail;
Christopher Faulet47596d32018-10-22 09:17:28 +0200598
599 blk = htx_replace_header(htx, blk, name, value);
600 if (!blk)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200601 goto fail;
602
603 sl = http_get_stline(htx);
Christopher Faulet3e1f7f42020-02-28 09:47:07 +0100604 if (sl && (sl->flags & HTX_SL_F_HAS_AUTHORITY) && isteqi(name, ist("host"))) {
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200605 if (!http_update_authority(htx, sl, value))
606 goto fail;
607 ctx->blk = NULL;
608 http_find_header(htx, ist("host"), ctx, 1);
609 blk = ctx->blk;
610 }
Christopher Faulet47596d32018-10-22 09:17:28 +0200611
612 ctx->blk = blk;
613 ctx->value = ist(NULL);
614 ctx->lws_before = ctx->lws_after = 0;
615
616 return 1;
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200617 fail:
618 return 0;
Christopher Faulet47596d32018-10-22 09:17:28 +0200619}
620
621/* Remove one value of a header. This only works on a <ctx> returned by
622 * http_find_header function. The value is removed, as well as surrounding commas
623 * if any. If the removed value was alone, the whole header is removed. The
624 * <ctx> is always updated accordingly, as well as the HTX message <htx>. It
625 * returns 1 on success. Otherwise, it returns 0. The <ctx> is always left in a
626 * form that can be handled by http_find_header() to find next occurrence.
627 */
628int http_remove_header(struct htx *htx, struct http_hdr_ctx *ctx)
629{
630 struct htx_blk *blk = ctx->blk;
631 char *start;
632 struct ist v;
633 uint32_t len;
634
635 if (!blk)
636 return 0;
637
638 start = ctx->value.ptr - ctx->lws_before;
639 len = ctx->lws_before + ctx->value.len + ctx->lws_after;
640
641 v = htx_get_blk_value(htx, blk);
642 if (len == v.len) {
643 blk = htx_remove_blk(htx, blk);
Christopher Faulet192c6a22019-06-11 16:32:24 +0200644 if (blk || htx_is_empty(htx)) {
Christopher Faulet47596d32018-10-22 09:17:28 +0200645 ctx->blk = blk;
Tim Duesterhus241e29e2020-03-05 17:56:30 +0100646 ctx->value = IST_NULL;
Christopher Faulet47596d32018-10-22 09:17:28 +0200647 ctx->lws_before = ctx->lws_after = 0;
648 }
649 else {
650 ctx->blk = htx_get_blk(htx, htx->tail);
651 ctx->value = htx_get_blk_value(htx, ctx->blk);
652 ctx->lws_before = ctx->lws_after = 0;
653 }
654 return 1;
655 }
656
657 /* This was not the only value of this header. We have to remove the
658 * part pointed by ctx->value. If it is the last entry of the list, we
659 * remove the last separator.
660 */
661 if (start == v.ptr) {
662 /* It's the first header part but not the only one. So remove
663 * the comma after it. */
664 len++;
665 }
666 else {
667 /* There is at least one header part before the removed one. So
668 * remove the comma between them. */
669 start--;
670 len++;
671 }
672 /* Update the block content and its len */
673 memmove(start, start+len, v.len-len);
Christopher Faulet3e2638e2019-06-18 09:49:16 +0200674 htx_change_blk_value_len(htx, blk, v.len-len);
Christopher Faulet47596d32018-10-22 09:17:28 +0200675
676 /* Finally update the ctx */
Tim Duesterhus77508502022-03-15 13:11:06 +0100677 ctx->value = ist2(start, 0);
Christopher Faulet47596d32018-10-22 09:17:28 +0200678 ctx->lws_before = ctx->lws_after = 0;
679
680 return 1;
681}
Christopher Faulet7ff1cea2018-10-24 10:39:35 +0200682
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200683/* Updates the authority part of the uri with the value <host>. It happens when
684 * the header host is modified. It returns 0 on failure and 1 on success. It is
685 * the caller responsibility to provide the start-line and to be sure the uri
686 * contains an authority. Thus, if no authority is found in the uri, an error is
687 * returned.
688 */
Christopher Faulet1543d442020-04-28 19:57:29 +0200689int http_update_authority(struct htx *htx, struct htx_sl *sl, const struct ist host)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200690{
691 struct buffer *temp = get_trash_chunk();
692 struct ist meth, vsn, uri, authority;
Amaury Denoyelle69294b22021-07-06 11:02:22 +0200693 struct http_uri_parser parser;
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200694
695 uri = htx_sl_req_uri(sl);
Amaury Denoyelle69294b22021-07-06 11:02:22 +0200696 parser = http_uri_parser_init(uri);
697 authority = http_parse_authority(&parser, 1);
Christopher Faulet34b18e42020-02-18 11:02:21 +0100698 if (!authority.len)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200699 return 0;
700
Christopher Faulet34b18e42020-02-18 11:02:21 +0100701 /* Don't update the uri if there is no change */
702 if (isteq(host, authority))
703 return 1;
704
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200705 /* Start by copying old method and version */
706 chunk_memcat(temp, HTX_SL_REQ_MPTR(sl), HTX_SL_REQ_MLEN(sl)); /* meth */
707 meth = ist2(temp->area, HTX_SL_REQ_MLEN(sl));
708
709 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl)); /* vsn */
710 vsn = ist2(temp->area + meth.len, HTX_SL_REQ_VLEN(sl));
711
712 chunk_memcat(temp, uri.ptr, authority.ptr - uri.ptr);
Tim Duesterhus9f7ed8a2021-11-08 09:05:04 +0100713 chunk_istcat(temp, host);
Tim Duesterhus4c8f75f2021-11-06 15:14:44 +0100714 chunk_memcat(temp, istend(authority), istend(uri) - istend(authority));
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200715 uri = ist2(temp->area + meth.len + vsn.len, host.len + uri.len - authority.len); /* uri */
716
717 return http_replace_stline(htx, meth, uri, vsn);
718
719}
720
721/* Update the header host by extracting the authority of the uri <uri>. flags of
722 * the start-line are also updated accordingly. For orgin-form and asterisk-form
723 * uri, the header host is not changed and the flag HTX_SL_F_HAS_AUTHORITY is
724 * removed from the flags of the start-line. Otherwise, this flag is set and the
725 * authority is used to set the value of the header host. This function returns
726 * 0 on failure and 1 on success.
727*/
Christopher Faulet1543d442020-04-28 19:57:29 +0200728int http_update_host(struct htx *htx, struct htx_sl *sl, const struct ist uri)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200729{
730 struct ist authority;
731 struct http_hdr_ctx ctx;
Amaury Denoyelle69294b22021-07-06 11:02:22 +0200732 struct http_uri_parser parser = http_uri_parser_init(uri);
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200733
Amaury Denoyelle69294b22021-07-06 11:02:22 +0200734 if (parser.format == URI_PARSER_FORMAT_EMPTY ||
735 parser.format == URI_PARSER_FORMAT_ASTERISK ||
736 parser.format == URI_PARSER_FORMAT_ABSPATH) {
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200737 sl->flags &= ~HTX_SL_F_HAS_AUTHORITY;
738 }
739 else {
740 sl->flags |= HTX_SL_F_HAS_AUTHORITY;
741 if (sl->info.req.meth != HTTP_METH_CONNECT) {
742 // absolute-form (RFC7320 #5.3.2)
743 sl->flags |= HTX_SL_F_HAS_SCHM;
744 if (uri.len > 4 && (uri.ptr[0] | 0x20) == 'h')
745 sl->flags |= ((uri.ptr[4] == ':') ? HTX_SL_F_SCHM_HTTP : HTX_SL_F_SCHM_HTTPS);
746
Amaury Denoyelle69294b22021-07-06 11:02:22 +0200747 authority = http_parse_authority(&parser, 1);
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200748 if (!authority.len)
749 goto fail;
750 }
751 else {
752 // authority-form (RFC7320 #5.3.3)
753 authority = uri;
754 }
755
756 /* Replace header host value */
757 ctx.blk = NULL;
758 while (http_find_header(htx, ist("host"), &ctx, 1)) {
759 if (!http_replace_header_value(htx, &ctx, authority))
760 goto fail;
761 }
762
763 }
764 return 1;
765 fail:
766 return 0;
767}
Christopher Faulet7ff1cea2018-10-24 10:39:35 +0200768
769/* Return in <vptr> and <vlen> the pointer and length of occurrence <occ> of
770 * header whose name is <hname> of length <hlen>. If <ctx> is null, lookup is
771 * performed over the whole headers. Otherwise it must contain a valid header
772 * context, initialised with ctx->blk=NULL for the first lookup in a series. If
773 * <occ> is positive or null, occurrence #occ from the beginning (or last ctx)
774 * is returned. Occ #0 and #1 are equivalent. If <occ> is negative (and no less
775 * than -MAX_HDR_HISTORY), the occurrence is counted from the last one which is
776 * -1. The value fetch stops at commas, so this function is suited for use with
777 * list headers.
778 * The return value is 0 if nothing was found, or non-zero otherwise.
779 */
780unsigned int http_get_htx_hdr(const struct htx *htx, const struct ist hdr,
781 int occ, struct http_hdr_ctx *ctx, char **vptr, size_t *vlen)
782{
783 struct http_hdr_ctx local_ctx;
784 struct ist val_hist[MAX_HDR_HISTORY];
785 unsigned int hist_idx;
786 int found;
787
788 if (!ctx) {
789 local_ctx.blk = NULL;
790 ctx = &local_ctx;
791 }
792
793 if (occ >= 0) {
794 /* search from the beginning */
795 while (http_find_header(htx, hdr, ctx, 0)) {
796 occ--;
797 if (occ <= 0) {
798 *vptr = ctx->value.ptr;
799 *vlen = ctx->value.len;
800 return 1;
801 }
802 }
803 return 0;
804 }
805
806 /* negative occurrence, we scan all the list then walk back */
807 if (-occ > MAX_HDR_HISTORY)
808 return 0;
809
810 found = hist_idx = 0;
811 while (http_find_header(htx, hdr, ctx, 0)) {
812 val_hist[hist_idx] = ctx->value;
813 if (++hist_idx >= MAX_HDR_HISTORY)
814 hist_idx = 0;
815 found++;
816 }
817 if (-occ > found)
818 return 0;
819
820 /* OK now we have the last occurrence in [hist_idx-1], and we need to
821 * find occurrence -occ. 0 <= hist_idx < MAX_HDR_HISTORY, and we have
822 * -10 <= occ <= -1. So we have to check [hist_idx%MAX_HDR_HISTORY+occ]
823 * to remain in the 0..9 range.
824 */
825 hist_idx += occ + MAX_HDR_HISTORY;
826 if (hist_idx >= MAX_HDR_HISTORY)
827 hist_idx -= MAX_HDR_HISTORY;
828 *vptr = val_hist[hist_idx].ptr;
829 *vlen = val_hist[hist_idx].len;
830 return 1;
831}
832
833/* Return in <vptr> and <vlen> the pointer and length of occurrence <occ> of
834 * header whose name is <hname> of length <hlen>. If <ctx> is null, lookup is
835 * performed over the whole headers. Otherwise it must contain a valid header
836 * context, initialised with ctx->blk=NULL for the first lookup in a series. If
837 * <occ> is positive or null, occurrence #occ from the beginning (or last ctx)
838 * is returned. Occ #0 and #1 are equivalent. If <occ> is negative (and no less
839 * than -MAX_HDR_HISTORY), the occurrence is counted from the last one which is
840 * -1. This function differs from http_get_hdr() in that it only returns full
841 * line header values and does not stop at commas.
842 * The return value is 0 if nothing was found, or non-zero otherwise.
843 */
844unsigned int http_get_htx_fhdr(const struct htx *htx, const struct ist hdr,
845 int occ, struct http_hdr_ctx *ctx, char **vptr, size_t *vlen)
846{
847 struct http_hdr_ctx local_ctx;
848 struct ist val_hist[MAX_HDR_HISTORY];
849 unsigned int hist_idx;
850 int found;
851
852 if (!ctx) {
853 local_ctx.blk = NULL;
854 ctx = &local_ctx;
855 }
856
857 if (occ >= 0) {
858 /* search from the beginning */
859 while (http_find_header(htx, hdr, ctx, 1)) {
860 occ--;
861 if (occ <= 0) {
862 *vptr = ctx->value.ptr;
863 *vlen = ctx->value.len;
864 return 1;
865 }
866 }
867 return 0;
868 }
869
870 /* negative occurrence, we scan all the list then walk back */
871 if (-occ > MAX_HDR_HISTORY)
872 return 0;
873
874 found = hist_idx = 0;
875 while (http_find_header(htx, hdr, ctx, 1)) {
876 val_hist[hist_idx] = ctx->value;
877 if (++hist_idx >= MAX_HDR_HISTORY)
878 hist_idx = 0;
879 found++;
880 }
881 if (-occ > found)
882 return 0;
883
884 /* OK now we have the last occurrence in [hist_idx-1], and we need to
885 * find occurrence -occ. 0 <= hist_idx < MAX_HDR_HISTORY, and we have
886 * -10 <= occ <= -1. So we have to check [hist_idx%MAX_HDR_HISTORY+occ]
887 * to remain in the 0..9 range.
888 */
889 hist_idx += occ + MAX_HDR_HISTORY;
890 if (hist_idx >= MAX_HDR_HISTORY)
891 hist_idx -= MAX_HDR_HISTORY;
892 *vptr = val_hist[hist_idx].ptr;
893 *vlen = val_hist[hist_idx].len;
894 return 1;
895}
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100896
Christopher Fauleta66adf42020-11-05 22:43:41 +0100897int http_str_to_htx(struct buffer *buf, struct ist raw, char **errmsg)
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100898{
899 struct htx *htx;
900 struct htx_sl *sl;
901 struct h1m h1m;
Christopher Faulete4ab11b2019-06-11 15:05:37 +0200902 struct http_hdr hdrs[global.tune.max_http_hdr];
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100903 union h1_sl h1sl;
904 unsigned int flags = HTX_SL_F_IS_RESP;
905 int ret = 0;
906
Christopher Faulet90cc4812019-07-22 16:49:30 +0200907 b_reset(buf);
908 if (!raw.len) {
909 buf->size = 0;
Christopher Faulet1cdc0282021-02-05 10:29:29 +0100910 buf->area = NULL;
Christopher Faulet90cc4812019-07-22 16:49:30 +0200911 return 1;
912 }
913
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100914 buf->size = global.tune.bufsize;
Tim Duesterhus403fd722021-04-08 20:05:23 +0200915 buf->area = malloc(buf->size);
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100916 if (!buf->area)
917 goto error;
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100918
919 h1m_init_res(&h1m);
920 h1m.flags |= H1_MF_NO_PHDR;
Tim Duesterhus4c8f75f2021-11-06 15:14:44 +0100921 ret = h1_headers_to_hdr_list(raw.ptr, istend(raw),
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100922 hdrs, sizeof(hdrs)/sizeof(hdrs[0]), &h1m, &h1sl);
Christopher Fauleta66adf42020-11-05 22:43:41 +0100923 if (ret <= 0) {
924 memprintf(errmsg, "unabled to parse headers (error offset: %d)", h1m.err_pos);
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100925 goto error;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100926 }
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100927
Christopher Fauleta66adf42020-11-05 22:43:41 +0100928 if (unlikely(h1sl.st.v.len != 8)) {
929 memprintf(errmsg, "invalid http version (%.*s)", (int)h1sl.st.v.len, h1sl.st.v.ptr);
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100930 goto error;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100931 }
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100932 if ((*(h1sl.st.v.ptr + 5) > '1') ||
933 ((*(h1sl.st.v.ptr + 5) == '1') && (*(h1sl.st.v.ptr + 7) >= '1')))
934 h1m.flags |= H1_MF_VER_11;
935
Christopher Fauleta66adf42020-11-05 22:43:41 +0100936 if (h1sl.st.status < 200 && (h1sl.st.status == 100 || h1sl.st.status >= 102)) {
937 memprintf(errmsg, "invalid http status code for an error message (%u)",
938 h1sl.st.status);
Christopher Faulet1d5ec092019-06-26 14:23:54 +0200939 goto error;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100940 }
Christopher Faulet1d5ec092019-06-26 14:23:54 +0200941
Christopher Fauletb8d148a2020-10-09 08:50:26 +0200942 if (h1sl.st.status == 204 || h1sl.st.status == 304) {
943 /* Responses known to have no body. */
944 h1m.flags &= ~(H1_MF_CLEN|H1_MF_CHNK);
945 h1m.flags |= H1_MF_XFER_LEN;
946 h1m.curr_len = h1m.body_len = 0;
947 }
948 else if (h1m.flags & (H1_MF_CLEN|H1_MF_CHNK))
949 h1m.flags |= H1_MF_XFER_LEN;
950
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100951 if (h1m.flags & H1_MF_VER_11)
952 flags |= HTX_SL_F_VER_11;
953 if (h1m.flags & H1_MF_XFER_ENC)
954 flags |= HTX_SL_F_XFER_ENC;
Christopher Fauletb8d148a2020-10-09 08:50:26 +0200955 if (h1m.flags & H1_MF_XFER_LEN) {
956 flags |= HTX_SL_F_XFER_LEN;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100957 if (h1m.flags & H1_MF_CHNK) {
958 memprintf(errmsg, "chunk-encoded payload not supported");
959 goto error;
960 }
Christopher Fauletb8d148a2020-10-09 08:50:26 +0200961 else if (h1m.flags & H1_MF_CLEN) {
962 flags |= HTX_SL_F_CLEN;
963 if (h1m.body_len == 0)
964 flags |= HTX_SL_F_BODYLESS;
965 }
966 else
Christopher Faulet0d4ce932019-10-16 09:09:04 +0200967 flags |= HTX_SL_F_BODYLESS;
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100968 }
Christopher Fauletb8d148a2020-10-09 08:50:26 +0200969
Christopher Fauleta66adf42020-11-05 22:43:41 +0100970 if ((flags & HTX_SL_F_BODYLESS) && raw.len > ret) {
971 memprintf(errmsg, "message payload not expected");
972 goto error;
973 }
974 if ((flags & HTX_SL_F_CLEN) && h1m.body_len != (raw.len - ret)) {
975 memprintf(errmsg, "payload size does not match the announced content-length (%lu != %lu)",
Willy Tarreau431a12c2020-11-06 14:24:02 +0100976 (unsigned long)(raw.len - ret), (unsigned long)h1m.body_len);
Christopher Fauleta66adf42020-11-05 22:43:41 +0100977 goto error;
978 }
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100979
980 htx = htx_from_buf(buf);
981 sl = htx_add_stline(htx, HTX_BLK_RES_SL, flags, h1sl.st.v, h1sl.st.c, h1sl.st.r);
Christopher Fauleta66adf42020-11-05 22:43:41 +0100982 if (!sl || !htx_add_all_headers(htx, hdrs)) {
983 memprintf(errmsg, "unable to add headers into the HTX message");
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100984 goto error;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100985 }
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100986 sl->info.res.status = h1sl.st.status;
987
Willy Tarreau0a7ef022019-05-28 10:30:11 +0200988 while (raw.len > ret) {
989 int sent = htx_add_data(htx, ist2(raw.ptr + ret, raw.len - ret));
Christopher Fauleta66adf42020-11-05 22:43:41 +0100990 if (!sent) {
991 memprintf(errmsg, "unable to add payload into the HTX message");
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100992 goto error;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100993 }
Willy Tarreau0a7ef022019-05-28 10:30:11 +0200994 ret += sent;
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100995 }
Christopher Faulet1d5ec092019-06-26 14:23:54 +0200996
Christopher Fauletd1ac2b92020-12-02 19:12:22 +0100997 htx->flags |= HTX_FL_EOM;
Christopher Faulet1d5ec092019-06-26 14:23:54 +0200998
Christopher Faulet90cc4812019-07-22 16:49:30 +0200999 return 1;
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001000
1001error:
1002 if (buf->size)
1003 free(buf->area);
Christopher Faulet90cc4812019-07-22 16:49:30 +02001004 return 0;
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001005}
1006
Christopher Faulet18630642020-05-12 18:57:28 +02001007void release_http_reply(struct http_reply *http_reply)
1008{
1009 struct logformat_node *lf, *lfb;
1010 struct http_reply_hdr *hdr, *hdrb;
1011
1012 if (!http_reply)
1013 return;
1014
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001015 ha_free(&http_reply->ctype);
Christopher Faulet18630642020-05-12 18:57:28 +02001016 list_for_each_entry_safe(hdr, hdrb, &http_reply->hdrs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001017 LIST_DELETE(&hdr->list);
Christopher Faulet18630642020-05-12 18:57:28 +02001018 list_for_each_entry_safe(lf, lfb, &hdr->value, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001019 LIST_DELETE(&lf->list);
Christopher Faulet18630642020-05-12 18:57:28 +02001020 release_sample_expr(lf->expr);
1021 free(lf->arg);
1022 free(lf);
1023 }
1024 istfree(&hdr->name);
1025 free(hdr);
1026 }
1027
1028 if (http_reply->type == HTTP_REPLY_ERRFILES) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001029 ha_free(&http_reply->body.http_errors);
Christopher Faulet18630642020-05-12 18:57:28 +02001030 }
1031 else if (http_reply->type == HTTP_REPLY_RAW)
1032 chunk_destroy(&http_reply->body.obj);
1033 else if (http_reply->type == HTTP_REPLY_LOGFMT) {
1034 list_for_each_entry_safe(lf, lfb, &http_reply->body.fmt, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001035 LIST_DELETE(&lf->list);
Christopher Faulet18630642020-05-12 18:57:28 +02001036 release_sample_expr(lf->expr);
1037 free(lf->arg);
1038 free(lf);
1039 }
1040 }
Christopher Faulet63d48242020-05-21 09:59:22 +02001041 free(http_reply);
Christopher Faulet18630642020-05-12 18:57:28 +02001042}
1043
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001044static int http_htx_init(void)
1045{
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001046 struct buffer chk;
1047 struct ist raw;
Christopher Fauleta66adf42020-11-05 22:43:41 +01001048 char *errmsg = NULL;
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001049 int rc;
1050 int err_code = 0;
1051
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001052 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
1053 if (!http_err_msgs[rc]) {
Christopher Fauleta66adf42020-11-05 22:43:41 +01001054 ha_alert("Internal error: no default message defined for HTTP return code %d", rc);
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001055 err_code |= ERR_ALERT | ERR_FATAL;
1056 continue;
1057 }
1058
Tim Duesterhus77508502022-03-15 13:11:06 +01001059 raw = ist(http_err_msgs[rc]);
Christopher Fauleta66adf42020-11-05 22:43:41 +01001060 if (!http_str_to_htx(&chk, raw, &errmsg)) {
1061 ha_alert("Internal error: invalid default message for HTTP return code %d: %s.\n",
1062 http_err_codes[rc], errmsg);
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001063 err_code |= ERR_ALERT | ERR_FATAL;
1064 }
Christopher Fauleta66adf42020-11-05 22:43:41 +01001065 else if (errmsg) {
1066 ha_warning("invalid default message for HTTP return code %d: %s.\n", http_err_codes[rc], errmsg);
1067 err_code |= ERR_WARN;
1068 }
1069
1070 /* Reset errmsg */
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001071 ha_free(&errmsg);
Christopher Fauleta66adf42020-11-05 22:43:41 +01001072
Christopher Fauletf7346382019-07-17 22:02:08 +02001073 http_err_chunks[rc] = chk;
Christopher Faulet1b13eca2020-05-14 09:54:26 +02001074 http_err_replies[rc].type = HTTP_REPLY_ERRMSG;
1075 http_err_replies[rc].status = http_err_codes[rc];
1076 http_err_replies[rc].ctype = NULL;
1077 LIST_INIT(&http_err_replies[rc].hdrs);
1078 http_err_replies[rc].body.errmsg = &http_err_chunks[rc];
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001079 }
1080end:
1081 return err_code;
1082}
1083
Christopher Faulet58857752020-01-15 15:19:50 +01001084static void http_htx_deinit(void)
1085{
Christopher Faulet35cd81d2020-01-15 11:22:56 +01001086 struct http_errors *http_errs, *http_errsb;
Christopher Faulet5809e102020-05-14 17:31:52 +02001087 struct http_reply *http_rep, *http_repb;
Christopher Faulet58857752020-01-15 15:19:50 +01001088 struct ebpt_node *node, *next;
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001089 struct http_error_msg *http_errmsg;
Christopher Fauletde30bb72020-05-14 10:03:55 +02001090 int rc;
Christopher Faulet58857752020-01-15 15:19:50 +01001091
1092 node = ebpt_first(&http_error_messages);
1093 while (node) {
1094 next = ebpt_next(node);
1095 ebpt_delete(node);
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001096 http_errmsg = container_of(node, typeof(*http_errmsg), node);
1097 chunk_destroy(&http_errmsg->msg);
Christopher Faulet58857752020-01-15 15:19:50 +01001098 free(node->key);
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001099 free(http_errmsg);
Christopher Faulet58857752020-01-15 15:19:50 +01001100 node = next;
1101 }
Christopher Faulet35cd81d2020-01-15 11:22:56 +01001102
1103 list_for_each_entry_safe(http_errs, http_errsb, &http_errors_list, list) {
1104 free(http_errs->conf.file);
1105 free(http_errs->id);
Christopher Fauletde30bb72020-05-14 10:03:55 +02001106 for (rc = 0; rc < HTTP_ERR_SIZE; rc++)
1107 release_http_reply(http_errs->replies[rc]);
Willy Tarreau2b718102021-04-21 07:32:39 +02001108 LIST_DELETE(&http_errs->list);
Christopher Faulet35cd81d2020-01-15 11:22:56 +01001109 free(http_errs);
1110 }
Christopher Faulet5809e102020-05-14 17:31:52 +02001111
1112 list_for_each_entry_safe(http_rep, http_repb, &http_replies_list, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001113 LIST_DELETE(&http_rep->list);
Christopher Faulet5809e102020-05-14 17:31:52 +02001114 release_http_reply(http_rep);
1115 }
Tim Duesterhus2b7fa9d2022-04-26 23:35:07 +02001116
1117 for (rc = 0; rc < HTTP_ERR_SIZE; rc++)
1118 chunk_destroy(&http_err_chunks[rc]);
Christopher Faulet58857752020-01-15 15:19:50 +01001119}
1120
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001121REGISTER_CONFIG_POSTPARSER("http_htx", http_htx_init);
Christopher Faulet58857752020-01-15 15:19:50 +01001122REGISTER_POST_DEINIT(http_htx_deinit);
Christopher Faulet29f72842019-12-11 15:52:32 +01001123
Christopher Faulet58857752020-01-15 15:19:50 +01001124/* Reads content of the error file <file> and convert it into an HTX message. On
1125 * success, the HTX message is returned. On error, NULL is returned and an error
1126 * message is written into the <errmsg> buffer.
Christopher Faulet5031ef52020-01-15 11:22:07 +01001127 */
Christopher Faulet58857752020-01-15 15:19:50 +01001128struct buffer *http_load_errorfile(const char *file, char **errmsg)
Christopher Faulet5031ef52020-01-15 11:22:07 +01001129{
Christopher Faulet58857752020-01-15 15:19:50 +01001130 struct buffer *buf = NULL;
1131 struct buffer chk;
1132 struct ebpt_node *node;
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001133 struct http_error_msg *http_errmsg;
Christopher Faulet5031ef52020-01-15 11:22:07 +01001134 struct stat stat;
1135 char *err = NULL;
1136 int errnum, errlen;
1137 int fd = -1;
Christopher Faulet58857752020-01-15 15:19:50 +01001138
1139 /* already loaded */
1140 node = ebis_lookup_len(&http_error_messages, file, strlen(file));
1141 if (node) {
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001142 http_errmsg = container_of(node, typeof(*http_errmsg), node);
1143 buf = &http_errmsg->msg;
Christopher Faulet58857752020-01-15 15:19:50 +01001144 goto out;
1145 }
Christopher Faulet5031ef52020-01-15 11:22:07 +01001146
Christopher Faulet58857752020-01-15 15:19:50 +01001147 /* Read the error file content */
Christopher Faulet5031ef52020-01-15 11:22:07 +01001148 fd = open(file, O_RDONLY);
1149 if ((fd < 0) || (fstat(fd, &stat) < 0)) {
1150 memprintf(errmsg, "error opening file '%s'.", file);
1151 goto out;
1152 }
1153
1154 if (stat.st_size <= global.tune.bufsize)
1155 errlen = stat.st_size;
1156 else {
1157 ha_warning("custom error message file '%s' larger than %d bytes. Truncating.\n",
1158 file, global.tune.bufsize);
1159 errlen = global.tune.bufsize;
1160 }
1161
1162 err = malloc(errlen);
1163 if (!err) {
1164 memprintf(errmsg, "out of memory.");
1165 goto out;
1166 }
1167
1168 errnum = read(fd, err, errlen);
1169 if (errnum != errlen) {
1170 memprintf(errmsg, "error reading file '%s'.", file);
1171 goto out;
1172 }
1173
Christopher Faulet58857752020-01-15 15:19:50 +01001174 /* Create the node corresponding to the error file */
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001175 http_errmsg = calloc(1, sizeof(*http_errmsg));
1176 if (!http_errmsg) {
Christopher Faulet58857752020-01-15 15:19:50 +01001177 memprintf(errmsg, "out of memory.");
1178 goto out;
1179 }
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001180 http_errmsg->node.key = strdup(file);
1181 if (!http_errmsg->node.key) {
Christopher Faulet58857752020-01-15 15:19:50 +01001182 memprintf(errmsg, "out of memory.");
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001183 free(http_errmsg);
Christopher Faulet58857752020-01-15 15:19:50 +01001184 goto out;
1185 }
1186
1187 /* Convert the error file into an HTX message */
Christopher Fauleta66adf42020-11-05 22:43:41 +01001188 if (!http_str_to_htx(&chk, ist2(err, errlen), errmsg)) {
1189 memprintf(errmsg, "'%s': %s", file, *errmsg);
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001190 free(http_errmsg->node.key);
1191 free(http_errmsg);
Christopher Faulet5031ef52020-01-15 11:22:07 +01001192 goto out;
1193 }
1194
Christopher Faulet58857752020-01-15 15:19:50 +01001195 /* Insert the node in the tree and return the HTX message */
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001196 http_errmsg->msg = chk;
1197 ebis_insert(&http_error_messages, &http_errmsg->node);
1198 buf = &http_errmsg->msg;
Christopher Faulet58857752020-01-15 15:19:50 +01001199
Christopher Faulet5031ef52020-01-15 11:22:07 +01001200 out:
1201 if (fd >= 0)
1202 close(fd);
1203 free(err);
Christopher Faulet58857752020-01-15 15:19:50 +01001204 return buf;
Christopher Faulet5031ef52020-01-15 11:22:07 +01001205}
1206
Ilya Shipitsind4259502020-04-08 01:07:56 +05001207/* Convert the raw http message <msg> into an HTX message. On success, the HTX
Christopher Faulet58857752020-01-15 15:19:50 +01001208 * message is returned. On error, NULL is returned and an error message is
1209 * written into the <errmsg> buffer.
Christopher Fauletbdf65262020-01-16 15:51:59 +01001210 */
Christopher Faulet58857752020-01-15 15:19:50 +01001211struct buffer *http_load_errormsg(const char *key, const struct ist msg, char **errmsg)
Christopher Fauletbdf65262020-01-16 15:51:59 +01001212{
Christopher Faulet58857752020-01-15 15:19:50 +01001213 struct buffer *buf = NULL;
1214 struct buffer chk;
1215 struct ebpt_node *node;
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001216 struct http_error_msg *http_errmsg;
Christopher Faulet58857752020-01-15 15:19:50 +01001217
1218 /* already loaded */
1219 node = ebis_lookup_len(&http_error_messages, key, strlen(key));
1220 if (node) {
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001221 http_errmsg = container_of(node, typeof(*http_errmsg), node);
1222 buf = &http_errmsg->msg;
Christopher Faulet58857752020-01-15 15:19:50 +01001223 goto out;
1224 }
1225 /* Create the node corresponding to the error file */
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001226 http_errmsg = calloc(1, sizeof(*http_errmsg));
1227 if (!http_errmsg) {
Christopher Faulet58857752020-01-15 15:19:50 +01001228 memprintf(errmsg, "out of memory.");
1229 goto out;
1230 }
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001231 http_errmsg->node.key = strdup(key);
1232 if (!http_errmsg->node.key) {
Christopher Faulet58857752020-01-15 15:19:50 +01001233 memprintf(errmsg, "out of memory.");
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001234 free(http_errmsg);
Christopher Faulet58857752020-01-15 15:19:50 +01001235 goto out;
1236 }
Christopher Fauletbdf65262020-01-16 15:51:59 +01001237
1238 /* Convert the error file into an HTX message */
Christopher Fauleta66adf42020-11-05 22:43:41 +01001239 if (!http_str_to_htx(&chk, msg, errmsg)) {
1240 memprintf(errmsg, "invalid error message: %s", *errmsg);
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001241 free(http_errmsg->node.key);
1242 free(http_errmsg);
Christopher Fauletbdf65262020-01-16 15:51:59 +01001243 goto out;
1244 }
Christopher Fauletbdf65262020-01-16 15:51:59 +01001245
Christopher Faulet58857752020-01-15 15:19:50 +01001246 /* Insert the node in the tree and return the HTX message */
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001247 http_errmsg->msg = chk;
1248 ebis_insert(&http_error_messages, &http_errmsg->node);
1249 buf = &http_errmsg->msg;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001250 out:
Christopher Faulet58857752020-01-15 15:19:50 +01001251 return buf;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001252}
1253
Christopher Faulet5031ef52020-01-15 11:22:07 +01001254/* This function parses the raw HTTP error file <file> for the status code
Christopher Faulet58857752020-01-15 15:19:50 +01001255 * <status>. It returns NULL if there is any error, otherwise it return the
1256 * corresponding HTX message.
Christopher Faulet5031ef52020-01-15 11:22:07 +01001257 */
Christopher Faulet58857752020-01-15 15:19:50 +01001258struct buffer *http_parse_errorfile(int status, const char *file, char **errmsg)
Christopher Faulet5031ef52020-01-15 11:22:07 +01001259{
Christopher Faulet58857752020-01-15 15:19:50 +01001260 struct buffer *buf = NULL;
1261 int rc;
Christopher Faulet5031ef52020-01-15 11:22:07 +01001262
1263 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
1264 if (http_err_codes[rc] == status) {
Christopher Faulet58857752020-01-15 15:19:50 +01001265 buf = http_load_errorfile(file, errmsg);
Christopher Faulet5031ef52020-01-15 11:22:07 +01001266 break;
1267 }
1268 }
1269
1270 if (rc >= HTTP_ERR_SIZE)
1271 memprintf(errmsg, "status code '%d' not handled.", status);
Christopher Faulet58857752020-01-15 15:19:50 +01001272 return buf;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001273}
1274
1275/* This function creates HTX error message corresponding to a redirect message
1276 * for the status code <status>. <url> is used as location url for the
Christopher Faulet58857752020-01-15 15:19:50 +01001277 * redirect. <errloc> is used to know if it is a 302 or a 303 redirect. It
1278 * returns NULL if there is any error, otherwise it return the corresponding HTX
1279 * message.
Christopher Fauletbdf65262020-01-16 15:51:59 +01001280 */
Christopher Faulet58857752020-01-15 15:19:50 +01001281struct buffer *http_parse_errorloc(int errloc, int status, const char *url, char **errmsg)
Christopher Fauletbdf65262020-01-16 15:51:59 +01001282{
Christopher Faulet0bac4cd2020-05-27 10:11:59 +02001283 static const char *HTTP_302 =
1284 "HTTP/1.1 302 Found\r\n"
1285 "Cache-Control: no-cache\r\n"
1286 "Content-length: 0\r\n"
1287 "Location: "; /* not terminated since it will be concatenated with the URL */
1288 static const char *HTTP_303 =
1289 "HTTP/1.1 303 See Other\r\n"
1290 "Cache-Control: no-cache\r\n"
1291 "Content-length: 0\r\n"
1292 "Location: "; /* not terminated since it will be concatenated with the URL */
1293
Christopher Faulet58857752020-01-15 15:19:50 +01001294 struct buffer *buf = NULL;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001295 const char *msg;
Christopher Faulet58857752020-01-15 15:19:50 +01001296 char *key = NULL, *err = NULL;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001297 int rc, errlen;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001298
1299 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
1300 if (http_err_codes[rc] == status) {
Christopher Faulet58857752020-01-15 15:19:50 +01001301 /* Create the error key */
1302 if (!memprintf(&key, "errorloc%d %s", errloc, url)) {
1303 memprintf(errmsg, "out of memory.");
1304 goto out;
1305 }
Christopher Fauletbdf65262020-01-16 15:51:59 +01001306 /* Create the error message */
1307 msg = (errloc == 302 ? HTTP_302 : HTTP_303);
1308 errlen = strlen(msg) + strlen(url) + 5;
1309 err = malloc(errlen);
1310 if (!err) {
1311 memprintf(errmsg, "out of memory.");
1312 goto out;
1313 }
1314 errlen = snprintf(err, errlen, "%s%s\r\n\r\n", msg, url);
1315
1316 /* Load it */
Christopher Faulet58857752020-01-15 15:19:50 +01001317 buf = http_load_errormsg(key, ist2(err, errlen), errmsg);
Christopher Fauletbdf65262020-01-16 15:51:59 +01001318 break;
1319 }
1320 }
1321
1322 if (rc >= HTTP_ERR_SIZE)
1323 memprintf(errmsg, "status code '%d' not handled.", status);
1324out:
Christopher Faulet58857752020-01-15 15:19:50 +01001325 free(key);
Christopher Fauletbdf65262020-01-16 15:51:59 +01001326 free(err);
Christopher Faulet58857752020-01-15 15:19:50 +01001327 return buf;
Christopher Faulet5031ef52020-01-15 11:22:07 +01001328}
1329
Christopher Faulet7eea2412020-05-13 15:02:59 +02001330/* Check an "http reply" and, for replies referencing an http-errors section,
1331 * try to find the right section and the right error message in this section. If
1332 * found, the reply is updated. If the http-errors section exists but the error
1333 * message is not found, no error message is set to fallback on the default
1334 * ones. Otherwise (unknown section) an error is returned.
1335 *
1336 * The function returns 1 in success case, otherwise, it returns 0 and errmsg is
1337 * filled.
1338 */
1339int http_check_http_reply(struct http_reply *reply, struct proxy *px, char **errmsg)
1340{
1341 struct http_errors *http_errs;
1342 int ret = 1;
1343
1344 if (reply->type != HTTP_REPLY_ERRFILES)
1345 goto end;
1346
1347 list_for_each_entry(http_errs, &http_errors_list, list) {
1348 if (strcmp(http_errs->id, reply->body.http_errors) == 0) {
Christopher Faulete29a97e2020-05-14 14:49:25 +02001349 reply->type = HTTP_REPLY_INDIRECT;
Christopher Faulet7eea2412020-05-13 15:02:59 +02001350 free(reply->body.http_errors);
Christopher Faulete29a97e2020-05-14 14:49:25 +02001351 reply->body.reply = http_errs->replies[http_get_status_idx(reply->status)];
1352 if (!reply->body.reply)
Christopher Faulet7eea2412020-05-13 15:02:59 +02001353 ha_warning("Proxy '%s': status '%d' referenced by an http reply "
1354 "not declared in http-errors section '%s'.\n",
1355 px->id, reply->status, http_errs->id);
1356 break;
1357 }
1358 }
1359
1360 if (&http_errs->list == &http_errors_list) {
1361 memprintf(errmsg, "unknown http-errors section '%s' referenced by an http reply ",
1362 reply->body.http_errors);
1363 ret = 0;
1364 }
1365
1366 end:
1367 return ret;
1368}
1369
Christopher Faulet47e791e2020-05-13 14:36:55 +02001370/* Parse an "http reply". It returns the reply on success or NULL on error. This
1371 * function creates one of the following http replies :
1372 *
1373 * - HTTP_REPLY_EMPTY : dummy response, no payload
1374 * - HTTP_REPLY_ERRMSG : implicit error message depending on the status code or explicit one
1375 * - HTTP_REPLY_ERRFILES : points on an http-errors section (resolved during post-parsing)
1376 * - HTTP_REPLY_RAW : explicit file object ('file' argument)
1377 * - HTTP_REPLY_LOGFMT : explicit log-format string ('content' argument)
1378 *
1379 * The content-type must be defined for non-empty payload. It is ignored for
1380 * error messages (implicit or explicit). When an http-errors section is
1381 * referenced (HTTP_REPLY_ERRFILES), the real error message should be resolved
1382 * during the configuration validity check or dynamically. It is the caller
1383 * responsibility to choose. If no status code is configured, <default_status>
1384 * is set.
1385 */
1386struct http_reply *http_parse_http_reply(const char **args, int *orig_arg, struct proxy *px,
1387 int default_status, char **errmsg)
1388{
1389 struct logformat_node *lf, *lfb;
1390 struct http_reply *reply = NULL;
1391 struct http_reply_hdr *hdr, *hdrb;
1392 struct stat stat;
1393 const char *act_arg = NULL;
1394 char *obj = NULL;
Christopher Faulet7a06ffb2021-10-13 17:22:17 +02001395 int cur_arg, cap = 0, objlen = 0, fd = -1;
Christopher Faulet47e791e2020-05-13 14:36:55 +02001396
1397
1398 reply = calloc(1, sizeof(*reply));
1399 if (!reply) {
1400 memprintf(errmsg, "out of memory");
1401 goto error;
1402 }
1403 LIST_INIT(&reply->hdrs);
1404 reply->type = HTTP_REPLY_EMPTY;
1405 reply->status = default_status;
1406
Christopher Faulet3b967c12020-05-15 15:47:44 +02001407 if (px->conf.args.ctx == ARGC_HERR)
1408 cap = (SMP_VAL_REQUEST | SMP_VAL_RESPONSE);
Christopher Faulet7a06ffb2021-10-13 17:22:17 +02001409 else {
1410 if (px->cap & PR_CAP_FE)
1411 cap |= ((px->conf.args.ctx == ARGC_HRQ) ? SMP_VAL_FE_HRQ_HDR : SMP_VAL_FE_HRS_HDR);
1412 if (px->cap & PR_CAP_BE)
Willy Tarreaub39e47a2021-10-16 14:41:09 +02001413 cap |= ((px->conf.args.ctx == ARGC_HRQ) ? SMP_VAL_BE_HRQ_HDR : SMP_VAL_BE_HRS_HDR);
Christopher Faulet7a06ffb2021-10-13 17:22:17 +02001414 }
Christopher Faulet47e791e2020-05-13 14:36:55 +02001415
1416 cur_arg = *orig_arg;
1417 while (*args[cur_arg]) {
1418 if (strcmp(args[cur_arg], "status") == 0) {
1419 cur_arg++;
1420 if (!*args[cur_arg]) {
1421 memprintf(errmsg, "'%s' expects <status_code> as argument", args[cur_arg-1]);
1422 goto error;
1423 }
1424 reply->status = atol(args[cur_arg]);
1425 if (reply->status < 200 || reply->status > 599) {
1426 memprintf(errmsg, "Unexpected status code '%d'", reply->status);
1427 goto error;
1428 }
1429 cur_arg++;
1430 }
1431 else if (strcmp(args[cur_arg], "content-type") == 0) {
1432 cur_arg++;
1433 if (!*args[cur_arg]) {
1434 memprintf(errmsg, "'%s' expects <ctype> as argument", args[cur_arg-1]);
1435 goto error;
1436 }
1437 free(reply->ctype);
1438 reply->ctype = strdup(args[cur_arg]);
1439 cur_arg++;
1440 }
1441 else if (strcmp(args[cur_arg], "errorfiles") == 0) {
1442 if (reply->type != HTTP_REPLY_EMPTY) {
1443 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1444 goto error;
1445 }
1446 act_arg = args[cur_arg];
1447 cur_arg++;
1448 if (!*args[cur_arg]) {
1449 memprintf(errmsg, "'%s' expects <name> as argument", args[cur_arg-1]);
1450 goto error;
1451 }
1452 reply->body.http_errors = strdup(args[cur_arg]);
1453 if (!reply->body.http_errors) {
1454 memprintf(errmsg, "out of memory");
1455 goto error;
1456 }
1457 reply->type = HTTP_REPLY_ERRFILES;
1458 cur_arg++;
1459 }
1460 else if (strcmp(args[cur_arg], "default-errorfiles") == 0) {
1461 if (reply->type != HTTP_REPLY_EMPTY) {
1462 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1463 goto error;
1464 }
1465 act_arg = args[cur_arg];
1466 reply->type = HTTP_REPLY_ERRMSG;
1467 cur_arg++;
1468 }
1469 else if (strcmp(args[cur_arg], "errorfile") == 0) {
1470 if (reply->type != HTTP_REPLY_EMPTY) {
1471 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1472 goto error;
1473 }
1474 act_arg = args[cur_arg];
1475 cur_arg++;
1476 if (!*args[cur_arg]) {
1477 memprintf(errmsg, "'%s' expects <fmt> as argument", args[cur_arg-1]);
1478 goto error;
1479 }
1480 reply->body.errmsg = http_load_errorfile(args[cur_arg], errmsg);
1481 if (!reply->body.errmsg) {
1482 goto error;
1483 }
1484 reply->type = HTTP_REPLY_ERRMSG;
1485 cur_arg++;
1486 }
1487 else if (strcmp(args[cur_arg], "file") == 0) {
1488 if (reply->type != HTTP_REPLY_EMPTY) {
1489 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1490 goto error;
1491 }
1492 act_arg = args[cur_arg];
1493 cur_arg++;
1494 if (!*args[cur_arg]) {
1495 memprintf(errmsg, "'%s' expects <file> as argument", args[cur_arg-1]);
1496 goto error;
1497 }
1498 fd = open(args[cur_arg], O_RDONLY);
1499 if ((fd < 0) || (fstat(fd, &stat) < 0)) {
1500 memprintf(errmsg, "error opening file '%s'", args[cur_arg]);
1501 goto error;
1502 }
1503 if (stat.st_size > global.tune.bufsize) {
1504 memprintf(errmsg, "file '%s' exceeds the buffer size (%lld > %d)",
1505 args[cur_arg], (long long)stat.st_size, global.tune.bufsize);
1506 goto error;
1507 }
1508 objlen = stat.st_size;
1509 obj = malloc(objlen);
1510 if (!obj || read(fd, obj, objlen) != objlen) {
1511 memprintf(errmsg, "error reading file '%s'", args[cur_arg]);
1512 goto error;
1513 }
1514 close(fd);
1515 fd = -1;
1516 reply->type = HTTP_REPLY_RAW;
1517 chunk_initlen(&reply->body.obj, obj, global.tune.bufsize, objlen);
1518 obj = NULL;
1519 cur_arg++;
1520 }
1521 else if (strcmp(args[cur_arg], "string") == 0) {
1522 if (reply->type != HTTP_REPLY_EMPTY) {
1523 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1524 goto error;
1525 }
1526 act_arg = args[cur_arg];
1527 cur_arg++;
1528 if (!*args[cur_arg]) {
1529 memprintf(errmsg, "'%s' expects <str> as argument", args[cur_arg-1]);
1530 goto error;
1531 }
1532 obj = strdup(args[cur_arg]);
1533 objlen = strlen(args[cur_arg]);
1534 if (!obj) {
1535 memprintf(errmsg, "out of memory");
1536 goto error;
1537 }
1538 reply->type = HTTP_REPLY_RAW;
1539 chunk_initlen(&reply->body.obj, obj, global.tune.bufsize, objlen);
1540 obj = NULL;
1541 cur_arg++;
1542 }
1543 else if (strcmp(args[cur_arg], "lf-file") == 0) {
1544 if (reply->type != HTTP_REPLY_EMPTY) {
1545 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1546 goto error;
1547 }
1548 act_arg = args[cur_arg];
1549 cur_arg++;
1550 if (!*args[cur_arg]) {
1551 memprintf(errmsg, "'%s' expects <file> as argument", args[cur_arg-1]);
1552 goto error;
1553 }
1554 fd = open(args[cur_arg], O_RDONLY);
1555 if ((fd < 0) || (fstat(fd, &stat) < 0)) {
1556 memprintf(errmsg, "error opening file '%s'", args[cur_arg]);
1557 goto error;
1558 }
1559 if (stat.st_size > global.tune.bufsize) {
1560 memprintf(errmsg, "file '%s' exceeds the buffer size (%lld > %d)",
1561 args[cur_arg], (long long)stat.st_size, global.tune.bufsize);
1562 goto error;
1563 }
1564 objlen = stat.st_size;
1565 obj = malloc(objlen + 1);
1566 if (!obj || read(fd, obj, objlen) != objlen) {
1567 memprintf(errmsg, "error reading file '%s'", args[cur_arg]);
1568 goto error;
1569 }
1570 close(fd);
1571 fd = -1;
1572 obj[objlen] = '\0';
1573 reply->type = HTTP_REPLY_LOGFMT;
Christopher Faulet5a3d9a72022-11-14 08:49:28 +01001574 LIST_INIT(&reply->body.fmt);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001575 cur_arg++;
1576 }
1577 else if (strcmp(args[cur_arg], "lf-string") == 0) {
1578 if (reply->type != HTTP_REPLY_EMPTY) {
1579 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1580 goto error;
1581 }
1582 act_arg = args[cur_arg];
1583 cur_arg++;
1584 if (!*args[cur_arg]) {
1585 memprintf(errmsg, "'%s' expects <fmt> as argument", args[cur_arg-1]);
1586 goto error;
1587 }
1588 obj = strdup(args[cur_arg]);
1589 objlen = strlen(args[cur_arg]);
1590 reply->type = HTTP_REPLY_LOGFMT;
Christopher Faulet5a3d9a72022-11-14 08:49:28 +01001591 LIST_INIT(&reply->body.fmt);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001592 cur_arg++;
1593 }
1594 else if (strcmp(args[cur_arg], "hdr") == 0) {
1595 cur_arg++;
1596 if (!*args[cur_arg] || !*args[cur_arg+1]) {
1597 memprintf(errmsg, "'%s' expects <name> and <value> as arguments", args[cur_arg-1]);
1598 goto error;
1599 }
1600 if (strcasecmp(args[cur_arg], "content-length") == 0 ||
1601 strcasecmp(args[cur_arg], "transfer-encoding") == 0 ||
1602 strcasecmp(args[cur_arg], "content-type") == 0) {
1603 ha_warning("parsing [%s:%d] : header '%s' always ignored by the http reply.\n",
1604 px->conf.args.file, px->conf.args.line, args[cur_arg]);
1605 cur_arg += 2;
1606 continue;
1607 }
1608 hdr = calloc(1, sizeof(*hdr));
1609 if (!hdr) {
1610 memprintf(errmsg, "'%s' : out of memory", args[cur_arg-1]);
1611 goto error;
1612 }
Willy Tarreau2b718102021-04-21 07:32:39 +02001613 LIST_APPEND(&reply->hdrs, &hdr->list);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001614 LIST_INIT(&hdr->value);
1615 hdr->name = ist(strdup(args[cur_arg]));
1616 if (!isttest(hdr->name)) {
1617 memprintf(errmsg, "out of memory");
1618 goto error;
1619 }
Christopher Faulet47e791e2020-05-13 14:36:55 +02001620 if (!parse_logformat_string(args[cur_arg+1], px, &hdr->value, LOG_OPT_HTTP, cap, errmsg))
1621 goto error;
1622
1623 free(px->conf.lfs_file);
1624 px->conf.lfs_file = strdup(px->conf.args.file);
1625 px->conf.lfs_line = px->conf.args.line;
1626 cur_arg += 2;
1627 }
1628 else
1629 break;
1630 }
1631
1632 if (reply->type == HTTP_REPLY_EMPTY) { /* no payload */
1633 if (reply->ctype) {
1634 ha_warning("parsing [%s:%d] : content-type '%s' ignored by the http reply because"
1635 " neither errorfile nor payload defined.\n",
1636 px->conf.args.file, px->conf.args.line, reply->ctype);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001637 ha_free(&reply->ctype);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001638 }
1639 }
1640 else if (reply->type == HTTP_REPLY_ERRFILES || reply->type == HTTP_REPLY_ERRMSG) { /* errorfiles or errorfile */
1641
1642 if (reply->type != HTTP_REPLY_ERRMSG || !reply->body.errmsg) {
1643 /* default errorfile or errorfiles: check the status */
1644 int rc;
1645
1646 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
1647 if (http_err_codes[rc] == reply->status)
1648 break;
1649 }
1650
1651 if (rc >= HTTP_ERR_SIZE) {
1652 memprintf(errmsg, "status code '%d' not handled by default with '%s' argument.",
1653 reply->status, act_arg);
1654 goto error;
1655 }
1656 }
1657
1658 if (reply->ctype) {
1659 ha_warning("parsing [%s:%d] : content-type '%s' ignored by the http reply when used "
1660 "with an erorrfile.\n",
1661 px->conf.args.file, px->conf.args.line, reply->ctype);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001662 ha_free(&reply->ctype);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001663 }
1664 if (!LIST_ISEMPTY(&reply->hdrs)) {
1665 ha_warning("parsing [%s:%d] : hdr parameters ignored by the http reply when used "
1666 "with an erorrfile.\n",
1667 px->conf.args.file, px->conf.args.line);
1668 list_for_each_entry_safe(hdr, hdrb, &reply->hdrs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001669 LIST_DELETE(&hdr->list);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001670 list_for_each_entry_safe(lf, lfb, &hdr->value, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001671 LIST_DELETE(&lf->list);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001672 release_sample_expr(lf->expr);
1673 free(lf->arg);
1674 free(lf);
1675 }
1676 istfree(&hdr->name);
1677 free(hdr);
1678 }
1679 }
1680 }
1681 else if (reply->type == HTTP_REPLY_RAW) { /* explicit parameter using 'file' parameter*/
Christopher Fauletb8d148a2020-10-09 08:50:26 +02001682 if ((reply->status == 204 || reply->status == 304) && objlen) {
1683 memprintf(errmsg, "No body expected for %d responses", reply->status);
1684 goto error;
1685 }
Christopher Faulet47e791e2020-05-13 14:36:55 +02001686 if (!reply->ctype && objlen) {
1687 memprintf(errmsg, "a content type must be defined when non-empty payload is configured");
1688 goto error;
1689 }
1690 if (reply->ctype && !b_data(&reply->body.obj)) {
1691 ha_warning("parsing [%s:%d] : content-type '%s' ignored by the http reply when used "
Ilya Shipitsin47d17182020-06-21 21:42:57 +05001692 "with an empty payload.\n",
Christopher Faulet47e791e2020-05-13 14:36:55 +02001693 px->conf.args.file, px->conf.args.line, reply->ctype);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001694 ha_free(&reply->ctype);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001695 }
1696 if (b_room(&reply->body.obj) < global.tune.maxrewrite) {
1697 ha_warning("parsing [%s:%d] : http reply payload runs over the buffer space reserved to headers rewriting."
1698 " It may lead to internal errors if strict rewriting mode is enabled.\n",
1699 px->conf.args.file, px->conf.args.line);
1700 }
1701 }
1702 else if (reply->type == HTTP_REPLY_LOGFMT) { /* log-format payload using 'lf-file' of 'lf-string' parameter */
1703 LIST_INIT(&reply->body.fmt);
Christopher Fauletb8d148a2020-10-09 08:50:26 +02001704 if ((reply->status == 204 || reply->status == 304)) {
1705 memprintf(errmsg, "No body expected for %d responses", reply->status);
1706 goto error;
1707 }
Christopher Faulet47e791e2020-05-13 14:36:55 +02001708 if (!reply->ctype) {
1709 memprintf(errmsg, "a content type must be defined with a log-format payload");
1710 goto error;
1711 }
1712 if (!parse_logformat_string(obj, px, &reply->body.fmt, LOG_OPT_HTTP, cap, errmsg))
1713 goto error;
1714
1715 free(px->conf.lfs_file);
1716 px->conf.lfs_file = strdup(px->conf.args.file);
1717 px->conf.lfs_line = px->conf.args.line;
1718 }
1719
1720 free(obj);
1721 *orig_arg = cur_arg;
1722 return reply;
1723
1724 error:
1725 free(obj);
1726 if (fd >= 0)
1727 close(fd);
1728 release_http_reply(reply);
1729 return NULL;
1730}
1731
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001732/* Apply schemed-based normalization as described on rfc3986 on section 6.3.2.
1733 * Returns 0 if no error has been found else non-zero.
1734 *
1735 * The normalization is processed on the target-uri at the condition that it is
1736 * in absolute-form. In the case where the target-uri was normalized, every
1737 * host headers values found are also replaced by the normalized hostname. This
1738 * assumes that the target-uri and host headers were properly identify as
1739 * similar before calling this function.
1740 */
1741int http_scheme_based_normalize(struct htx *htx)
1742{
1743 struct http_hdr_ctx ctx;
1744 struct htx_sl *sl;
1745 struct ist uri, scheme, authority, host, port;
Amaury Denoyelle8ac8cbf2021-07-06 10:52:58 +02001746 struct http_uri_parser parser;
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001747
1748 sl = http_get_stline(htx);
1749
1750 if (!sl || !(sl->flags & (HTX_SL_F_HAS_SCHM|HTX_SL_F_HAS_AUTHORITY)))
1751 return 0;
1752
1753 uri = htx_sl_req_uri(sl);
1754
Amaury Denoyelle8ac8cbf2021-07-06 10:52:58 +02001755 parser = http_uri_parser_init(uri);
1756 scheme = http_parse_scheme(&parser);
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001757 /* if no scheme found, no normalization to proceed */
1758 if (!isttest(scheme))
1759 return 0;
1760
Christopher Fauletd1d983f2022-07-05 10:24:52 +02001761 /* Extract the port if present in authority */
1762 authority = http_parse_authority(&parser, 1);
1763 port = http_get_host_port(authority);
1764 if (!isttest(port)) {
1765 /* if no port found, no normalization to proceed */
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001766 return 0;
Christopher Fauletd1d983f2022-07-05 10:24:52 +02001767 }
1768 host = isttrim(authority, istlen(authority) - istlen(port) - 1);
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001769
Christopher Fauletd1d983f2022-07-05 10:24:52 +02001770 if (istlen(port) && http_is_default_port(scheme, port)) {
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001771 /* reconstruct the uri with removal of the port */
1772 struct buffer *temp = get_trash_chunk();
Christopher Faulet0eab0502022-07-06 17:41:31 +02001773 struct ist meth, vsn;
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001774
1775 /* meth */
1776 chunk_memcat(temp, HTX_SL_REQ_MPTR(sl), HTX_SL_REQ_MLEN(sl));
1777 meth = ist2(temp->area, HTX_SL_REQ_MLEN(sl));
1778
1779 /* vsn */
1780 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl));
1781 vsn = ist2(temp->area + meth.len, HTX_SL_REQ_VLEN(sl));
1782
1783 /* reconstruct uri without port */
Christopher Faulet0eab0502022-07-06 17:41:31 +02001784 chunk_memcat(temp, uri.ptr, authority.ptr - uri.ptr);
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001785 chunk_istcat(temp, host);
Christopher Faulet0eab0502022-07-06 17:41:31 +02001786 chunk_memcat(temp, istend(authority), istend(uri) - istend(authority));
1787 uri = ist2(temp->area + meth.len + vsn.len, host.len + uri.len - authority.len); /* uri */
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001788
1789 http_replace_stline(htx, meth, uri, vsn);
1790
1791 /* replace every host headers values by the normalized host */
1792 ctx.blk = NULL;
1793 while (http_find_header(htx, ist("host"), &ctx, 0)) {
1794 if (!http_replace_header_value(htx, &ctx, host))
1795 goto fail;
1796 }
1797 }
1798
1799 return 0;
1800
1801 fail:
1802 return 1;
1803}
1804
Amaury Denoyelle2c5a7ee2022-08-17 16:33:53 +02001805/* First step function to merge multiple cookie headers in a single entry.
1806 *
1807 * Use it for each cookie header at <idx> index over HTTP headers in <list>.
1808 * <first> and <last> are state variables used internally and must be
1809 * initialized to -1 before the first invocation.
1810 */
1811void http_cookie_register(struct http_hdr *list, int idx, int *first, int *last)
1812{
1813 /* Build a linked list of cookie headers. Use header length to point to
1814 * the next one. The last entry will contains -1.
1815 */
1816
1817 /* Mark the current end of cookie linked list. */
1818 list[idx].n.len = -1;
1819 if (*first < 0) {
1820 /* Save first found cookie for http_cookie_merge call. */
1821 *first = idx;
1822 }
1823 else {
1824 /* Update linked list of cookies. */
1825 list[*last].n.len = idx;
1826 }
1827
1828 *last = idx;
1829}
1830
1831/* Second step to merge multiple cookie headers in a single entry.
1832 *
1833 * Use it when looping over HTTP headers is done and <htx> message is built.
1834 * This will concatenate each cookie headers present from <list> directly into
1835 * <htx> message. <first> is reused from previous http_cookie_register
1836 * invocation.
1837 *
1838 * Returns 0 on success else non-zero.
1839 */
1840int http_cookie_merge(struct htx *htx, struct http_hdr *list, int first)
1841{
1842 uint32_t fs; /* free space */
1843 uint32_t bs; /* block size */
1844 uint32_t vl; /* value len */
1845 uint32_t tl; /* total length */
1846 struct htx_blk *blk;
1847
1848 if (first < 0)
1849 return 0;
1850
1851 blk = htx_add_header(htx, ist("cookie"), list[first].v);
1852 if (!blk)
1853 return 1;
1854
1855 tl = list[first].v.len;
1856 fs = htx_free_data_space(htx);
1857 bs = htx_get_blksz(blk);
1858
1859 /* for each extra cookie, we'll extend the cookie's value and insert
1860 * ";" before the new value.
1861 */
1862 fs += tl; /* first one is already counted */
1863
1864 /* Loop over cookies linked list built from http_cookie_register. */
1865 while ((first = list[first].n.len) >= 0) {
1866 vl = list[first].v.len;
1867 tl += vl + 2;
1868 if (tl > fs)
1869 return 1;
1870
1871 htx_change_blk_value_len(htx, blk, tl);
1872 *(char *)(htx_get_blk_ptr(htx, blk) + bs + 0) = ';';
1873 *(char *)(htx_get_blk_ptr(htx, blk) + bs + 1) = ' ';
1874 memcpy(htx_get_blk_ptr(htx, blk) + bs + 2,
1875 list[first].v.ptr, vl);
1876 bs += vl + 2;
1877 }
1878
1879 return 0;
1880}
1881
Christopher Faulet07f41f72020-01-16 16:16:06 +01001882/* Parses the "errorloc[302|303]" proxy keyword */
1883static int proxy_parse_errorloc(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +01001884 const struct proxy *defpx, const char *file, int line,
Christopher Faulet07f41f72020-01-16 16:16:06 +01001885 char **errmsg)
1886{
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001887 struct conf_errors *conf_err;
Christopher Faulet5809e102020-05-14 17:31:52 +02001888 struct http_reply *reply;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001889 struct buffer *msg;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001890 int errloc, status;
1891 int ret = 0;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001892
1893 if (warnifnotcap(curpx, PR_CAP_FE | PR_CAP_BE, file, line, args[0], NULL)) {
1894 ret = 1;
1895 goto out;
1896 }
1897
1898 if (*(args[1]) == 0 || *(args[2]) == 0) {
1899 memprintf(errmsg, "%s : expects <status_code> and <url> as arguments.\n", args[0]);
1900 ret = -1;
1901 goto out;
1902 }
1903
1904 status = atol(args[1]);
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001905 errloc = (strcmp(args[0], "errorloc303") == 0 ? 303 : 302);
Christopher Faulet07f41f72020-01-16 16:16:06 +01001906 msg = http_parse_errorloc(errloc, status, args[2], errmsg);
1907 if (!msg) {
1908 memprintf(errmsg, "%s : %s", args[0], *errmsg);
1909 ret = -1;
1910 goto out;
1911 }
Christopher Faulet5809e102020-05-14 17:31:52 +02001912
1913 reply = calloc(1, sizeof(*reply));
1914 if (!reply) {
1915 memprintf(errmsg, "%s : out of memory.", args[0]);
1916 ret = -1;
1917 goto out;
1918 }
1919 reply->type = HTTP_REPLY_ERRMSG;
1920 reply->status = status;
1921 reply->ctype = NULL;
1922 LIST_INIT(&reply->hdrs);
1923 reply->body.errmsg = msg;
Willy Tarreau2b718102021-04-21 07:32:39 +02001924 LIST_APPEND(&http_replies_list, &reply->list);
Christopher Faulet07f41f72020-01-16 16:16:06 +01001925
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001926 conf_err = calloc(1, sizeof(*conf_err));
1927 if (!conf_err) {
1928 memprintf(errmsg, "%s : out of memory.", args[0]);
Christopher Faulet5809e102020-05-14 17:31:52 +02001929 free(reply);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001930 ret = -1;
1931 goto out;
1932 }
1933 conf_err->type = 1;
1934 conf_err->info.errorfile.status = status;
Christopher Faulet5809e102020-05-14 17:31:52 +02001935 conf_err->info.errorfile.reply = reply;
1936
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001937 conf_err->file = strdup(file);
1938 conf_err->line = line;
Willy Tarreau2b718102021-04-21 07:32:39 +02001939 LIST_APPEND(&curpx->conf.errors, &conf_err->list);
Christopher Faulet07f41f72020-01-16 16:16:06 +01001940
Christopher Fauleta66adf42020-11-05 22:43:41 +01001941 /* handle warning message */
1942 if (*errmsg)
1943 ret = 1;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001944 out:
1945 return ret;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001946
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001947}
Christopher Faulet07f41f72020-01-16 16:16:06 +01001948
1949/* Parses the "errorfile" proxy keyword */
1950static int proxy_parse_errorfile(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +01001951 const struct proxy *defpx, const char *file, int line,
Christopher Faulet07f41f72020-01-16 16:16:06 +01001952 char **errmsg)
1953{
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001954 struct conf_errors *conf_err;
Christopher Faulet5809e102020-05-14 17:31:52 +02001955 struct http_reply *reply;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001956 struct buffer *msg;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001957 int status;
1958 int ret = 0;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001959
1960 if (warnifnotcap(curpx, PR_CAP_FE | PR_CAP_BE, file, line, args[0], NULL)) {
1961 ret = 1;
1962 goto out;
1963 }
1964
1965 if (*(args[1]) == 0 || *(args[2]) == 0) {
1966 memprintf(errmsg, "%s : expects <status_code> and <file> as arguments.\n", args[0]);
1967 ret = -1;
1968 goto out;
1969 }
1970
1971 status = atol(args[1]);
1972 msg = http_parse_errorfile(status, args[2], errmsg);
1973 if (!msg) {
1974 memprintf(errmsg, "%s : %s", args[0], *errmsg);
1975 ret = -1;
1976 goto out;
1977 }
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001978
Christopher Faulet5809e102020-05-14 17:31:52 +02001979 reply = calloc(1, sizeof(*reply));
1980 if (!reply) {
1981 memprintf(errmsg, "%s : out of memory.", args[0]);
1982 ret = -1;
1983 goto out;
1984 }
1985 reply->type = HTTP_REPLY_ERRMSG;
1986 reply->status = status;
1987 reply->ctype = NULL;
1988 LIST_INIT(&reply->hdrs);
1989 reply->body.errmsg = msg;
Willy Tarreau2b718102021-04-21 07:32:39 +02001990 LIST_APPEND(&http_replies_list, &reply->list);
Christopher Faulet5809e102020-05-14 17:31:52 +02001991
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001992 conf_err = calloc(1, sizeof(*conf_err));
1993 if (!conf_err) {
1994 memprintf(errmsg, "%s : out of memory.", args[0]);
Christopher Faulet5809e102020-05-14 17:31:52 +02001995 free(reply);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001996 ret = -1;
1997 goto out;
1998 }
1999 conf_err->type = 1;
2000 conf_err->info.errorfile.status = status;
Christopher Faulet5809e102020-05-14 17:31:52 +02002001 conf_err->info.errorfile.reply = reply;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002002 conf_err->file = strdup(file);
2003 conf_err->line = line;
Willy Tarreau2b718102021-04-21 07:32:39 +02002004 LIST_APPEND(&curpx->conf.errors, &conf_err->list);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002005
Christopher Fauleta66adf42020-11-05 22:43:41 +01002006 /* handle warning message */
2007 if (*errmsg)
2008 ret = 1;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002009 out:
2010 return ret;
2011
2012}
2013
2014/* Parses the "errorfiles" proxy keyword */
2015static int proxy_parse_errorfiles(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +01002016 const struct proxy *defpx, const char *file, int line,
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002017 char **err)
2018{
2019 struct conf_errors *conf_err = NULL;
2020 char *name = NULL;
2021 int rc, ret = 0;
2022
2023 if (warnifnotcap(curpx, PR_CAP_FE | PR_CAP_BE, file, line, args[0], NULL)) {
2024 ret = 1;
2025 goto out;
2026 }
2027
2028 if (!*(args[1])) {
2029 memprintf(err, "%s : expects <name> as argument.", args[0]);
2030 ret = -1;
2031 goto out;
2032 }
2033
2034 name = strdup(args[1]);
2035 conf_err = calloc(1, sizeof(*conf_err));
2036 if (!name || !conf_err) {
2037 memprintf(err, "%s : out of memory.", args[0]);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002038 goto error;
2039 }
2040 conf_err->type = 0;
2041
2042 conf_err->info.errorfiles.name = name;
2043 if (!*(args[2])) {
2044 for (rc = 0; rc < HTTP_ERR_SIZE; rc++)
2045 conf_err->info.errorfiles.status[rc] = 1;
2046 }
2047 else {
2048 int cur_arg, status;
2049 for (cur_arg = 2; *(args[cur_arg]); cur_arg++) {
2050 status = atol(args[cur_arg]);
2051
2052 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
2053 if (http_err_codes[rc] == status) {
2054 conf_err->info.errorfiles.status[rc] = 2;
2055 break;
2056 }
2057 }
2058 if (rc >= HTTP_ERR_SIZE) {
2059 memprintf(err, "%s : status code '%d' not handled.", args[0], status);
Christopher Faulet7cde96c2020-01-21 10:10:11 +01002060 goto error;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002061 }
2062 }
2063 }
2064 conf_err->file = strdup(file);
2065 conf_err->line = line;
Willy Tarreau2b718102021-04-21 07:32:39 +02002066 LIST_APPEND(&curpx->conf.errors, &conf_err->list);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002067 out:
2068 return ret;
2069
2070 error:
2071 free(name);
2072 free(conf_err);
Christopher Faulet7cde96c2020-01-21 10:10:11 +01002073 ret = -1;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002074 goto out;
2075}
2076
Christopher Faulet3b967c12020-05-15 15:47:44 +02002077/* Parses the "http-error" proxy keyword */
2078static int proxy_parse_http_error(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +01002079 const struct proxy *defpx, const char *file, int line,
Christopher Faulet3b967c12020-05-15 15:47:44 +02002080 char **errmsg)
2081{
2082 struct conf_errors *conf_err;
2083 struct http_reply *reply = NULL;
2084 int rc, cur_arg, ret = 0;
2085
2086 if (warnifnotcap(curpx, PR_CAP_FE | PR_CAP_BE, file, line, args[0], NULL)) {
2087 ret = 1;
2088 goto out;
2089 }
2090
2091 cur_arg = 1;
2092 curpx->conf.args.ctx = ARGC_HERR;
2093 reply = http_parse_http_reply((const char **)args, &cur_arg, curpx, 0, errmsg);
2094 if (!reply) {
2095 memprintf(errmsg, "%s : %s", args[0], *errmsg);
2096 goto error;
2097 }
2098 else if (!reply->status) {
2099 memprintf(errmsg, "%s : expects at least a <status> as arguments.\n", args[0]);
2100 goto error;
2101 }
2102
2103 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
2104 if (http_err_codes[rc] == reply->status)
2105 break;
2106 }
2107
2108 if (rc >= HTTP_ERR_SIZE) {
2109 memprintf(errmsg, "%s: status code '%d' not handled.", args[0], reply->status);
2110 goto error;
2111 }
2112 if (*args[cur_arg]) {
2113 memprintf(errmsg, "%s : unknown keyword '%s'.", args[0], args[cur_arg]);
2114 goto error;
2115 }
2116
2117 conf_err = calloc(1, sizeof(*conf_err));
2118 if (!conf_err) {
2119 memprintf(errmsg, "%s : out of memory.", args[0]);
2120 goto error;
2121 }
2122 if (reply->type == HTTP_REPLY_ERRFILES) {
2123 int rc = http_get_status_idx(reply->status);
2124
2125 conf_err->type = 2;
2126 conf_err->info.errorfiles.name = reply->body.http_errors;
2127 conf_err->info.errorfiles.status[rc] = 2;
2128 reply->body.http_errors = NULL;
2129 release_http_reply(reply);
2130 }
2131 else {
2132 conf_err->type = 1;
2133 conf_err->info.errorfile.status = reply->status;
2134 conf_err->info.errorfile.reply = reply;
Willy Tarreau2b718102021-04-21 07:32:39 +02002135 LIST_APPEND(&http_replies_list, &reply->list);
Christopher Faulet3b967c12020-05-15 15:47:44 +02002136 }
2137 conf_err->file = strdup(file);
2138 conf_err->line = line;
Willy Tarreau2b718102021-04-21 07:32:39 +02002139 LIST_APPEND(&curpx->conf.errors, &conf_err->list);
Christopher Faulet3b967c12020-05-15 15:47:44 +02002140
Christopher Faulet3005d282020-11-13 10:58:01 +01002141 /* handle warning message */
2142 if (*errmsg)
2143 ret = 1;
Christopher Faulet3b967c12020-05-15 15:47:44 +02002144 out:
2145 return ret;
2146
2147 error:
2148 release_http_reply(reply);
2149 ret = -1;
2150 goto out;
2151
2152}
2153
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002154/* Check "errorfiles" proxy keyword */
2155static int proxy_check_errors(struct proxy *px)
2156{
2157 struct conf_errors *conf_err, *conf_err_back;
2158 struct http_errors *http_errs;
Christopher Fauletfc633b62020-11-06 15:24:23 +01002159 int rc, err = ERR_NONE;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002160
2161 list_for_each_entry_safe(conf_err, conf_err_back, &px->conf.errors, list) {
2162 if (conf_err->type == 1) {
2163 /* errorfile */
2164 rc = http_get_status_idx(conf_err->info.errorfile.status);
Christopher Faulet40e85692020-05-14 17:34:31 +02002165 px->replies[rc] = conf_err->info.errorfile.reply;
Christopher Faulet3b967c12020-05-15 15:47:44 +02002166
2167 /* For proxy, to rely on default replies, just don't reference a reply */
2168 if (px->replies[rc]->type == HTTP_REPLY_ERRMSG && !px->replies[rc]->body.errmsg)
2169 px->replies[rc] = NULL;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002170 }
2171 else {
2172 /* errorfiles */
2173 list_for_each_entry(http_errs, &http_errors_list, list) {
2174 if (strcmp(http_errs->id, conf_err->info.errorfiles.name) == 0)
2175 break;
2176 }
Christopher Faulet07f41f72020-01-16 16:16:06 +01002177
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002178 /* unknown http-errors section */
2179 if (&http_errs->list == &http_errors_list) {
Amaury Denoyelle11124302021-06-04 18:22:08 +02002180 ha_alert("proxy '%s': unknown http-errors section '%s' (at %s:%d).\n",
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002181 px->id, conf_err->info.errorfiles.name, conf_err->file, conf_err->line);
2182 err |= ERR_ALERT | ERR_FATAL;
2183 free(conf_err->info.errorfiles.name);
2184 goto next;
2185 }
2186
2187 free(conf_err->info.errorfiles.name);
2188 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
2189 if (conf_err->info.errorfiles.status[rc] > 0) {
Christopher Fauletf1fedc32020-05-15 14:30:32 +02002190 if (http_errs->replies[rc])
Christopher Faulet40e85692020-05-14 17:34:31 +02002191 px->replies[rc] = http_errs->replies[rc];
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002192 else if (conf_err->info.errorfiles.status[rc] == 2)
2193 ha_warning("config: proxy '%s' : status '%d' not declared in"
2194 " http-errors section '%s' (at %s:%d).\n",
2195 px->id, http_err_codes[rc], http_errs->id,
2196 conf_err->file, conf_err->line);
2197 }
2198 }
2199 }
2200 next:
Willy Tarreau2b718102021-04-21 07:32:39 +02002201 LIST_DELETE(&conf_err->list);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002202 free(conf_err->file);
2203 free(conf_err);
2204 }
Christopher Faulet07f41f72020-01-16 16:16:06 +01002205
2206 out:
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002207 return err;
2208}
2209
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002210static int post_check_errors()
2211{
2212 struct ebpt_node *node;
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02002213 struct http_error_msg *http_errmsg;
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002214 struct htx *htx;
Christopher Fauletfc633b62020-11-06 15:24:23 +01002215 int err_code = ERR_NONE;
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002216
2217 node = ebpt_first(&http_error_messages);
2218 while (node) {
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02002219 http_errmsg = container_of(node, typeof(*http_errmsg), node);
2220 if (b_is_null(&http_errmsg->msg))
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002221 goto next;
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02002222 htx = htxbuf(&http_errmsg->msg);
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002223 if (htx_free_data_space(htx) < global.tune.maxrewrite) {
2224 ha_warning("config: errorfile '%s' runs over the buffer space"
Ilya Shipitsin47d17182020-06-21 21:42:57 +05002225 " reserved to headers rewriting. It may lead to internal errors if "
Christopher Faulet6d0c3df2020-01-22 09:26:35 +01002226 " http-after-response rules are evaluated on this message.\n",
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002227 (char *)node->key);
2228 err_code |= ERR_WARN;
2229 }
2230 next:
2231 node = ebpt_next(node);
2232 }
2233
2234 return err_code;
2235}
2236
Willy Tarreau016255a2021-02-12 08:40:29 +01002237int proxy_dup_default_conf_errors(struct proxy *curpx, const struct proxy *defpx, char **errmsg)
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002238{
2239 struct conf_errors *conf_err, *new_conf_err = NULL;
2240 int ret = 0;
2241
2242 list_for_each_entry(conf_err, &defpx->conf.errors, list) {
2243 new_conf_err = calloc(1, sizeof(*new_conf_err));
2244 if (!new_conf_err) {
2245 memprintf(errmsg, "unable to duplicate default errors (out of memory).");
2246 goto out;
2247 }
2248 new_conf_err->type = conf_err->type;
2249 if (conf_err->type == 1) {
2250 new_conf_err->info.errorfile.status = conf_err->info.errorfile.status;
Christopher Faulet40e85692020-05-14 17:34:31 +02002251 new_conf_err->info.errorfile.reply = conf_err->info.errorfile.reply;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002252 }
2253 else {
2254 new_conf_err->info.errorfiles.name = strdup(conf_err->info.errorfiles.name);
2255 if (!new_conf_err->info.errorfiles.name) {
2256 memprintf(errmsg, "unable to duplicate default errors (out of memory).");
2257 goto out;
2258 }
2259 memcpy(&new_conf_err->info.errorfiles.status, &conf_err->info.errorfiles.status,
2260 sizeof(conf_err->info.errorfiles.status));
2261 }
2262 new_conf_err->file = strdup(conf_err->file);
2263 new_conf_err->line = conf_err->line;
Willy Tarreau2b718102021-04-21 07:32:39 +02002264 LIST_APPEND(&curpx->conf.errors, &new_conf_err->list);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002265 new_conf_err = NULL;
2266 }
2267 ret = 1;
2268
2269 out:
2270 free(new_conf_err);
Christopher Faulet07f41f72020-01-16 16:16:06 +01002271 return ret;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002272}
2273
2274void proxy_release_conf_errors(struct proxy *px)
2275{
2276 struct conf_errors *conf_err, *conf_err_back;
Christopher Faulet07f41f72020-01-16 16:16:06 +01002277
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002278 list_for_each_entry_safe(conf_err, conf_err_back, &px->conf.errors, list) {
2279 if (conf_err->type == 0)
2280 free(conf_err->info.errorfiles.name);
Willy Tarreau2b718102021-04-21 07:32:39 +02002281 LIST_DELETE(&conf_err->list);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002282 free(conf_err->file);
2283 free(conf_err);
2284 }
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002285}
2286
2287/*
2288 * Parse an <http-errors> section.
2289 * Returns the error code, 0 if OK, or any combination of :
2290 * - ERR_ABORT: must abort ASAP
2291 * - ERR_FATAL: we can continue parsing but not start the service
2292 * - ERR_WARN: a warning has been emitted
2293 * - ERR_ALERT: an alert has been emitted
2294 * Only the two first ones can stop processing, the two others are just
2295 * indicators.
2296 */
2297static int cfg_parse_http_errors(const char *file, int linenum, char **args, int kwm)
2298{
2299 static struct http_errors *curr_errs = NULL;
2300 int err_code = 0;
2301 const char *err;
2302 char *errmsg = NULL;
2303
2304 if (strcmp(args[0], "http-errors") == 0) { /* new errors section */
2305 if (!*args[1]) {
2306 ha_alert("parsing [%s:%d] : missing name for http-errors section.\n", file, linenum);
2307 err_code |= ERR_ALERT | ERR_ABORT;
2308 goto out;
2309 }
2310
2311 err = invalid_char(args[1]);
2312 if (err) {
2313 ha_alert("parsing [%s:%d] : character '%c' is not permitted in '%s' name '%s'.\n",
2314 file, linenum, *err, args[0], args[1]);
2315 err_code |= ERR_ALERT | ERR_FATAL;
2316 }
2317
2318 list_for_each_entry(curr_errs, &http_errors_list, list) {
2319 /* Error if two errors section owns the same name */
2320 if (strcmp(curr_errs->id, args[1]) == 0) {
2321 ha_alert("parsing [%s:%d]: http-errors section '%s' already exists (declared at %s:%d).\n",
2322 file, linenum, args[1], curr_errs->conf.file, curr_errs->conf.line);
2323 err_code |= ERR_ALERT | ERR_FATAL;
2324 }
2325 }
2326
2327 if ((curr_errs = calloc(1, sizeof(*curr_errs))) == NULL) {
2328 ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum);
2329 err_code |= ERR_ALERT | ERR_ABORT;
2330 goto out;
2331 }
2332
Willy Tarreau2b718102021-04-21 07:32:39 +02002333 LIST_APPEND(&http_errors_list, &curr_errs->list);
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002334 curr_errs->id = strdup(args[1]);
2335 curr_errs->conf.file = strdup(file);
2336 curr_errs->conf.line = linenum;
2337 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002338 else if (strcmp(args[0], "errorfile") == 0) { /* error message from a file */
Christopher Fauletde30bb72020-05-14 10:03:55 +02002339 struct http_reply *reply;
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002340 struct buffer *msg;
2341 int status, rc;
2342
2343 if (*(args[1]) == 0 || *(args[2]) == 0) {
2344 ha_alert("parsing [%s:%d] : %s: expects <status_code> and <file> as arguments.\n",
2345 file, linenum, args[0]);
2346 err_code |= ERR_ALERT | ERR_FATAL;
2347 goto out;
2348 }
2349
2350 status = atol(args[1]);
2351 msg = http_parse_errorfile(status, args[2], &errmsg);
2352 if (!msg) {
2353 ha_alert("parsing [%s:%d] : %s : %s\n", file, linenum, args[0], errmsg);
2354 err_code |= ERR_ALERT | ERR_FATAL;
2355 goto out;
2356 }
Christopher Faulet3005d282020-11-13 10:58:01 +01002357 if (errmsg) {
2358 ha_warning("parsing [%s:%d] : %s: %s\n", file, linenum, args[0], errmsg);
2359 err_code |= ERR_WARN;
2360 }
Christopher Fauletde30bb72020-05-14 10:03:55 +02002361
2362 reply = calloc(1, sizeof(*reply));
2363 if (!reply) {
2364 ha_alert("parsing [%s:%d] : %s : out of memory.\n", file, linenum, args[0]);
2365 err_code |= ERR_ALERT | ERR_FATAL;
2366 goto out;
2367 }
2368 reply->type = HTTP_REPLY_ERRMSG;
2369 reply->status = status;
2370 reply->ctype = NULL;
2371 LIST_INIT(&reply->hdrs);
2372 reply->body.errmsg = msg;
2373
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002374 rc = http_get_status_idx(status);
Christopher Fauletde30bb72020-05-14 10:03:55 +02002375 curr_errs->replies[rc] = reply;
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002376 }
2377 else if (*args[0] != 0) {
2378 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section\n", file, linenum, args[0], cursection);
2379 err_code |= ERR_ALERT | ERR_FATAL;
2380 goto out;
2381 }
2382
2383out:
2384 free(errmsg);
2385 return err_code;
Christopher Faulet07f41f72020-01-16 16:16:06 +01002386}
2387
2388static struct cfg_kw_list cfg_kws = {ILH, {
2389 { CFG_LISTEN, "errorloc", proxy_parse_errorloc },
2390 { CFG_LISTEN, "errorloc302", proxy_parse_errorloc },
2391 { CFG_LISTEN, "errorloc303", proxy_parse_errorloc },
2392 { CFG_LISTEN, "errorfile", proxy_parse_errorfile },
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002393 { CFG_LISTEN, "errorfiles", proxy_parse_errorfiles },
Christopher Faulet3b967c12020-05-15 15:47:44 +02002394 { CFG_LISTEN, "http-error", proxy_parse_http_error },
Christopher Faulet07f41f72020-01-16 16:16:06 +01002395 { 0, NULL, NULL },
2396}};
2397
2398INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002399REGISTER_POST_PROXY_CHECK(proxy_check_errors);
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002400REGISTER_POST_CHECK(post_check_errors);
Christopher Faulet07f41f72020-01-16 16:16:06 +01002401
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002402REGISTER_CONFIG_SECTION("http-errors", cfg_parse_http_errors, NULL);
2403
Christopher Faulet29f72842019-12-11 15:52:32 +01002404/************************************************************************/
2405/* HTX sample fetches */
2406/************************************************************************/
2407
2408/* Returns 1 if a stream is an HTX stream. Otherwise, it returns 0. */
2409static int
2410smp_fetch_is_htx(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2411{
2412 if (!smp->strm)
2413 return 0;
2414
2415 smp->data.u.sint = !!IS_HTX_STRM(smp->strm);
2416 smp->data.type = SMP_T_BOOL;
2417 return 1;
2418}
2419
2420/* Returns the number of blocks in an HTX message. The channel is chosen
2421 * depending on the sample direction. */
2422static int
2423smp_fetch_htx_nbblks(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2424{
2425 struct channel *chn;
2426 struct htx *htx;
2427
2428 if (!smp->strm)
2429 return 0;
2430
2431 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002432 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002433 if (!htx)
2434 return 0;
2435
2436 smp->data.u.sint = htx_nbblks(htx);
2437 smp->data.type = SMP_T_SINT;
2438 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2439 return 1;
2440}
2441
2442/* Returns the size of an HTX message. The channel is chosen depending on the
2443 * sample direction. */
2444static int
2445smp_fetch_htx_size(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2446{
2447 struct channel *chn;
2448 struct htx *htx;
2449
2450 if (!smp->strm)
2451 return 0;
2452
2453 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002454 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002455 if (!htx)
2456 return 0;
2457
2458 smp->data.u.sint = htx->size;
2459 smp->data.type = SMP_T_SINT;
2460 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2461 return 1;
2462}
2463
2464/* Returns the data size of an HTX message. The channel is chosen depending on the
2465 * sample direction. */
2466static int
2467smp_fetch_htx_data(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2468{
2469 struct channel *chn;
2470 struct htx *htx;
2471
2472 if (!smp->strm)
2473 return 0;
2474
2475 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002476 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002477 if (!htx)
2478 return 0;
2479
2480 smp->data.u.sint = htx->data;
2481 smp->data.type = SMP_T_SINT;
2482 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2483 return 1;
2484}
2485
2486/* Returns the used space (data+meta) of an HTX message. The channel is chosen
2487 * depending on the sample direction. */
2488static int
2489smp_fetch_htx_used(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2490{
2491 struct channel *chn;
2492 struct htx *htx;
2493
2494 if (!smp->strm)
2495 return 0;
2496
2497 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002498 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002499 if (!htx)
2500 return 0;
2501
2502 smp->data.u.sint = htx_used_space(htx);
2503 smp->data.type = SMP_T_SINT;
2504 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2505 return 1;
2506}
2507
2508/* Returns the free space (size-used) of an HTX message. The channel is chosen
2509 * depending on the sample direction. */
2510static int
2511smp_fetch_htx_free(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2512{
2513 struct channel *chn;
2514 struct htx *htx;
2515
2516 if (!smp->strm)
2517 return 0;
2518
2519 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002520 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002521 if (!htx)
2522 return 0;
2523
2524 smp->data.u.sint = htx_free_space(htx);
2525 smp->data.type = SMP_T_SINT;
2526 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2527 return 1;
2528}
2529
2530/* Returns the free space for data (free-sizeof(blk)) of an HTX message. The
2531 * channel is chosen depending on the sample direction. */
2532static int
2533smp_fetch_htx_free_data(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2534{
2535 struct channel *chn;
2536 struct htx *htx;
2537
2538 if (!smp->strm)
2539 return 0;
2540
2541 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002542 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002543 if (!htx)
2544 return 0;
2545
2546 smp->data.u.sint = htx_free_data_space(htx);
2547 smp->data.type = SMP_T_SINT;
2548 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2549 return 1;
2550}
2551
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002552/* Returns 1 if the HTX message contains EOM flag. Otherwise it returns 0. The
2553 * channel is chosen depending on the sample direction.
2554 */
Christopher Faulet29f72842019-12-11 15:52:32 +01002555static int
2556smp_fetch_htx_has_eom(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2557{
2558 struct channel *chn;
2559 struct htx *htx;
2560
2561 if (!smp->strm)
2562 return 0;
2563
2564 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002565 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002566 if (!htx)
2567 return 0;
2568
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002569 smp->data.u.sint = !!(htx->flags & HTX_FL_EOM);
Christopher Faulet29f72842019-12-11 15:52:32 +01002570 smp->data.type = SMP_T_BOOL;
2571 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2572 return 1;
2573}
2574
2575/* Returns the type of a specific HTX block, if found in the message. Otherwise
2576 * HTX_BLK_UNUSED is returned. Any positive integer (>= 0) is supported or
2577 * "head", "tail" or "first". The channel is chosen depending on the sample
2578 * direction. */
2579static int
2580smp_fetch_htx_blk_type(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2581{
2582 struct channel *chn;
2583 struct htx *htx;
2584 enum htx_blk_type type;
2585 int32_t pos;
2586
2587 if (!smp->strm || !arg_p)
2588 return 0;
2589
2590 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002591 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002592 if (!htx)
2593 return 0;
2594
2595 pos = arg_p[0].data.sint;
2596 if (pos == -1)
2597 type = htx_get_head_type(htx);
2598 else if (pos == -2)
2599 type = htx_get_tail_type(htx);
2600 else if (pos == -3)
2601 type = htx_get_first_type(htx);
2602 else
2603 type = ((pos >= htx->head && pos <= htx->tail)
2604 ? htx_get_blk_type(htx_get_blk(htx, pos))
2605 : HTX_BLK_UNUSED);
2606
2607 chunk_initstr(&smp->data.u.str, htx_blk_type_str(type));
2608 smp->data.type = SMP_T_STR;
2609 smp->flags = SMP_F_CONST | SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2610 return 1;
2611}
2612
2613/* Returns the size of a specific HTX block, if found in the message. Otherwise
2614 * 0 is returned. Any positive integer (>= 0) is supported or "head", "tail" or
2615 * "first". The channel is chosen depending on the sample direction. */
2616static int
2617smp_fetch_htx_blk_size(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2618{
2619 struct channel *chn;
2620 struct htx *htx;
2621 struct htx_blk *blk;
2622 int32_t pos;
2623
2624 if (!smp->strm || !arg_p)
2625 return 0;
2626
2627 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002628 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002629 if (!htx)
2630 return 0;
2631
2632 pos = arg_p[0].data.sint;
2633 if (pos == -1)
2634 blk = htx_get_head_blk(htx);
2635 else if (pos == -2)
2636 blk = htx_get_tail_blk(htx);
2637 else if (pos == -3)
2638 blk = htx_get_first_blk(htx);
2639 else
2640 blk = ((pos >= htx->head && pos <= htx->tail) ? htx_get_blk(htx, pos) : NULL);
2641
2642 smp->data.u.sint = (blk ? htx_get_blksz(blk) : 0);
2643 smp->data.type = SMP_T_SINT;
2644 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2645 return 1;
2646}
2647
2648/* Returns the start-line if the selected HTX block exists and is a
2649 * start-line. Otherwise 0 an empty string. Any positive integer (>= 0) is
2650 * supported or "head", "tail" or "first". The channel is chosen depending on
2651 * the sample direction. */
2652static int
2653smp_fetch_htx_blk_stline(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2654{
2655 struct buffer *temp;
2656 struct channel *chn;
2657 struct htx *htx;
2658 struct htx_blk *blk;
2659 struct htx_sl *sl;
2660 int32_t pos;
2661
2662 if (!smp->strm || !arg_p)
2663 return 0;
2664
2665 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002666 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002667 if (!htx)
2668 return 0;
2669
2670 pos = arg_p[0].data.sint;
2671 if (pos == -1)
2672 blk = htx_get_head_blk(htx);
2673 else if (pos == -2)
2674 blk = htx_get_tail_blk(htx);
2675 else if (pos == -3)
2676 blk = htx_get_first_blk(htx);
2677 else
2678 blk = ((pos >= htx->head && pos <= htx->tail) ? htx_get_blk(htx, pos) : NULL);
2679
2680 if (!blk || (htx_get_blk_type(blk) != HTX_BLK_REQ_SL && htx_get_blk_type(blk) != HTX_BLK_RES_SL)) {
2681 smp->data.u.str.size = 0;
2682 smp->data.u.str.area = "";
2683 smp->data.u.str.data = 0;
2684 }
2685 else {
2686 sl = htx_get_blk_ptr(htx, blk);
2687
2688 temp = get_trash_chunk();
2689 chunk_istcat(temp, htx_sl_p1(sl));
2690 temp->area[temp->data++] = ' ';
2691 chunk_istcat(temp, htx_sl_p2(sl));
2692 temp->area[temp->data++] = ' ';
2693 chunk_istcat(temp, htx_sl_p3(sl));
2694
2695 smp->data.u.str = *temp;
2696 }
2697
2698 smp->data.type = SMP_T_STR;
2699 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2700 return 1;
2701}
2702
2703/* Returns the header name if the selected HTX block exists and is a header or a
2704 * trailer. Otherwise 0 an empty string. Any positive integer (>= 0) is
2705 * supported or "head", "tail" or "first". The channel is chosen depending on
2706 * the sample direction. */
2707static int
2708smp_fetch_htx_blk_hdrname(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2709{
2710 struct channel *chn;
2711 struct htx *htx;
2712 struct htx_blk *blk;
2713 int32_t pos;
2714
2715 if (!smp->strm || !arg_p)
2716 return 0;
2717
2718 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002719 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002720 if (!htx)
2721 return 0;
2722
2723 pos = arg_p[0].data.sint;
2724 if (pos == -1)
2725 blk = htx_get_head_blk(htx);
2726 else if (pos == -2)
2727 blk = htx_get_tail_blk(htx);
2728 else if (pos == -3)
2729 blk = htx_get_first_blk(htx);
2730 else
2731 blk = ((pos >= htx->head && pos <= htx->tail) ? htx_get_blk(htx, pos) : NULL);
2732
2733 if (!blk || (htx_get_blk_type(blk) != HTX_BLK_HDR && htx_get_blk_type(blk) != HTX_BLK_TLR)) {
2734 smp->data.u.str.size = 0;
2735 smp->data.u.str.area = "";
2736 smp->data.u.str.data = 0;
2737 }
2738 else {
2739 struct ist name = htx_get_blk_name(htx, blk);
2740
2741 chunk_initlen(&smp->data.u.str, name.ptr, name.len, name.len);
2742 }
2743 smp->data.type = SMP_T_STR;
2744 smp->flags = SMP_F_CONST | SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2745 return 1;
2746}
2747
2748/* Returns the header value if the selected HTX block exists and is a header or
2749 * a trailer. Otherwise 0 an empty string. Any positive integer (>= 0) is
2750 * supported or "head", "tail" or "first". The channel is chosen depending on
2751 * the sample direction. */
2752static int
2753smp_fetch_htx_blk_hdrval(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2754{
2755 struct channel *chn;
2756 struct htx *htx;
2757 struct htx_blk *blk;
2758 int32_t pos;
2759
2760 if (!smp->strm || !arg_p)
2761 return 0;
2762
2763 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002764 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002765 if (!htx)
2766 return 0;
2767
2768 pos = arg_p[0].data.sint;
2769 if (pos == -1)
2770 blk = htx_get_head_blk(htx);
2771 else if (pos == -2)
2772 blk = htx_get_tail_blk(htx);
2773 else if (pos == -3)
2774 blk = htx_get_first_blk(htx);
2775 else
2776 blk = ((pos >= htx->head && pos <= htx->tail) ? htx_get_blk(htx, pos) : NULL);
2777
2778 if (!blk || (htx_get_blk_type(blk) != HTX_BLK_HDR && htx_get_blk_type(blk) != HTX_BLK_TLR)) {
2779 smp->data.u.str.size = 0;
2780 smp->data.u.str.area = "";
2781 smp->data.u.str.data = 0;
2782 }
2783 else {
2784 struct ist val = htx_get_blk_value(htx, blk);
2785
2786 chunk_initlen(&smp->data.u.str, val.ptr, val.len, val.len);
2787 }
2788 smp->data.type = SMP_T_STR;
2789 smp->flags = SMP_F_CONST | SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2790 return 1;
2791}
2792
2793/* Returns the value if the selected HTX block exists and is a data
2794 * block. Otherwise 0 an empty string. Any positive integer (>= 0) is supported
2795 * or "head", "tail" or "first". The channel is chosen depending on the sample
2796 * direction. */
2797static int
Christopher Fauletc5db14c2020-01-08 14:51:03 +01002798smp_fetch_htx_blk_data(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
Christopher Faulet29f72842019-12-11 15:52:32 +01002799{
2800 struct channel *chn;
2801 struct htx *htx;
2802 struct htx_blk *blk;
2803 int32_t pos;
2804
2805 if (!smp->strm || !arg_p)
2806 return 0;
2807
2808 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002809 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002810 if (!htx)
2811 return 0;
2812
2813 pos = arg_p[0].data.sint;
2814 if (pos == -1)
2815 blk = htx_get_head_blk(htx);
2816 else if (pos == -2)
2817 blk = htx_get_tail_blk(htx);
2818 else if (pos == -3)
2819 blk = htx_get_first_blk(htx);
2820 else
2821 blk = ((pos >= htx->head && pos <= htx->tail) ? htx_get_blk(htx, pos) : NULL);
2822
2823 if (!blk || htx_get_blk_type(blk) != HTX_BLK_DATA) {
2824 smp->data.u.str.size = 0;
2825 smp->data.u.str.area = "";
2826 smp->data.u.str.data = 0;
2827 }
2828 else {
2829 struct ist val = htx_get_blk_value(htx, blk);
2830
2831 chunk_initlen(&smp->data.u.str, val.ptr, val.len, val.len);
2832 }
Christopher Faulet8178e402020-01-08 14:38:58 +01002833 smp->data.type = SMP_T_BIN;
Christopher Faulet29f72842019-12-11 15:52:32 +01002834 smp->flags = SMP_F_CONST | SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2835 return 1;
2836}
2837
2838/* This function is used to validate the arguments passed to any "htx_blk" fetch
2839 * keywords. An argument is expected by these keywords. It must be a positive
2840 * integer or on of the following strings: "head", "tail" or "first". It returns
2841 * 0 on error, and a non-zero value if OK.
2842 */
2843int val_blk_arg(struct arg *arg, char **err_msg)
2844{
2845 if (arg[0].type != ARGT_STR || !arg[0].data.str.data) {
2846 memprintf(err_msg, "a block position is expected (> 0) or a special block name (head, tail, first)");
2847 return 0;
2848 }
2849 if (arg[0].data.str.data == 4 && !strncmp(arg[0].data.str.area, "head", 4)) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002850 chunk_destroy(&arg[0].data.str);
Christopher Faulet29f72842019-12-11 15:52:32 +01002851 arg[0].type = ARGT_SINT;
2852 arg[0].data.sint = -1;
2853 }
2854 else if (arg[0].data.str.data == 4 && !strncmp(arg[0].data.str.area, "tail", 4)) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002855 chunk_destroy(&arg[0].data.str);
Christopher Faulet29f72842019-12-11 15:52:32 +01002856 arg[0].type = ARGT_SINT;
2857 arg[0].data.sint = -2;
2858 }
2859 else if (arg[0].data.str.data == 5 && !strncmp(arg[0].data.str.area, "first", 5)) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002860 chunk_destroy(&arg[0].data.str);
Christopher Faulet29f72842019-12-11 15:52:32 +01002861 arg[0].type = ARGT_SINT;
2862 arg[0].data.sint = -3;
2863 }
2864 else {
2865 int pos;
2866
2867 for (pos = 0; pos < arg[0].data.str.data; pos++) {
Willy Tarreau90807112020-02-25 08:16:33 +01002868 if (!isdigit((unsigned char)arg[0].data.str.area[pos])) {
Christopher Faulet29f72842019-12-11 15:52:32 +01002869 memprintf(err_msg, "invalid block position");
2870 return 0;
2871 }
2872 }
2873
2874 pos = strl2uic(arg[0].data.str.area, arg[0].data.str.data);
2875 if (pos < 0) {
2876 memprintf(err_msg, "block position must not be negative");
2877 return 0;
2878 }
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002879 chunk_destroy(&arg[0].data.str);
Christopher Faulet29f72842019-12-11 15:52:32 +01002880 arg[0].type = ARGT_SINT;
2881 arg[0].data.sint = pos;
2882 }
2883
2884 return 1;
2885}
2886
2887
2888/* Note: must not be declared <const> as its list will be overwritten.
Ilya Shipitsind4259502020-04-08 01:07:56 +05002889 * Note: htx sample fetches should only used for development purpose.
Christopher Faulet29f72842019-12-11 15:52:32 +01002890 */
2891static struct sample_fetch_kw_list sample_fetch_keywords = {ILH, {
Christopher Faulet2e961942021-03-25 17:29:38 +01002892 { "internal.strm.is_htx", smp_fetch_is_htx, 0, NULL, SMP_T_BOOL, SMP_USE_INTRN },
Christopher Faulet29f72842019-12-11 15:52:32 +01002893
Christopher Faulet01f44452020-01-08 14:23:40 +01002894 { "internal.htx.nbblks", smp_fetch_htx_nbblks, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2895 { "internal.htx.size", smp_fetch_htx_size, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2896 { "internal.htx.data", smp_fetch_htx_data, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2897 { "internal.htx.used", smp_fetch_htx_used, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2898 { "internal.htx.free", smp_fetch_htx_free, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2899 { "internal.htx.free_data", smp_fetch_htx_free_data, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2900 { "internal.htx.has_eom", smp_fetch_htx_has_eom, 0, NULL, SMP_T_BOOL, SMP_USE_HRQHV|SMP_USE_HRSHV},
Christopher Faulet29f72842019-12-11 15:52:32 +01002901
Christopher Faulet01f44452020-01-08 14:23:40 +01002902 { "internal.htx_blk.type", smp_fetch_htx_blk_type, ARG1(1,STR), val_blk_arg, SMP_T_STR, SMP_USE_HRQHV|SMP_USE_HRSHV},
2903 { "internal.htx_blk.size", smp_fetch_htx_blk_size, ARG1(1,STR), val_blk_arg, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2904 { "internal.htx_blk.start_line", smp_fetch_htx_blk_stline, ARG1(1,STR), val_blk_arg, SMP_T_STR, SMP_USE_HRQHV|SMP_USE_HRSHV},
2905 { "internal.htx_blk.hdrname", smp_fetch_htx_blk_hdrname, ARG1(1,STR), val_blk_arg, SMP_T_STR, SMP_USE_HRQHV|SMP_USE_HRSHV},
2906 { "internal.htx_blk.hdrval", smp_fetch_htx_blk_hdrval, ARG1(1,STR), val_blk_arg, SMP_T_STR, SMP_USE_HRQHV|SMP_USE_HRSHV},
Christopher Fauletc5db14c2020-01-08 14:51:03 +01002907 { "internal.htx_blk.data", smp_fetch_htx_blk_data, ARG1(1,STR), val_blk_arg, SMP_T_BIN, SMP_USE_HRQHV|SMP_USE_HRSHV},
Christopher Faulet29f72842019-12-11 15:52:32 +01002908
2909 { /* END */ },
2910}};
2911
2912INITCALL1(STG_REGISTER, sample_register_fetches, &sample_fetch_keywords);