blob: 6b06336e6e3cdf601f63bca8bbe5e21f90e6f4e7 [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>
Willy Tarreaub2551052020-06-09 09:07:15 +020024#include <haproxy/http_fetch.h>
Willy Tarreau87735332020-06-04 09:08:41 +020025#include <haproxy/http_htx.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020026#include <haproxy/htx.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020027#include <haproxy/log.h>
28#include <haproxy/regex.h>
29#include <haproxy/sample.h>
Willy Tarreau4cbf62d2021-05-08 13:01:23 +020030#include <haproxy/tools.h>
Christopher Faulet47596d32018-10-22 09:17:28 +020031
Christopher Faulet47596d32018-10-22 09:17:28 +020032
Christopher Fauletf7346382019-07-17 22:02:08 +020033struct buffer http_err_chunks[HTTP_ERR_SIZE];
Christopher Faulet1b13eca2020-05-14 09:54:26 +020034struct http_reply http_err_replies[HTTP_ERR_SIZE];
35
Christopher Faulet58857752020-01-15 15:19:50 +010036struct eb_root http_error_messages = EB_ROOT;
Christopher Faulet35cd81d2020-01-15 11:22:56 +010037struct list http_errors_list = LIST_HEAD_INIT(http_errors_list);
Christopher Faulet5809e102020-05-14 17:31:52 +020038struct list http_replies_list = LIST_HEAD_INIT(http_replies_list);
Christopher Fauleta7b677c2018-11-29 16:48:49 +010039
Christopher Faulet76edc0f2020-01-13 15:52:01 +010040/* The declaration of an errorfiles/errorfile directives. Used during config
41 * parsing only. */
42struct conf_errors {
43 char type; /* directive type (0: errorfiles, 1: errorfile) */
44 union {
45 struct {
46 int status; /* the status code associated to this error */
Christopher Faulet5809e102020-05-14 17:31:52 +020047 struct http_reply *reply; /* the http reply for the errorfile */
Christopher Faulet76edc0f2020-01-13 15:52:01 +010048 } errorfile; /* describe an "errorfile" directive */
49 struct {
50 char *name; /* the http-errors section name */
51 char status[HTTP_ERR_SIZE]; /* list of status to import (0: ignore, 1: implicit import, 2: explicit import) */
52 } errorfiles; /* describe an "errorfiles" directive */
53 } info;
54
55 char *file; /* file where the directive appears */
56 int line; /* line where the directive appears */
57
58 struct list list; /* next conf_errors */
59};
60
Christopher Faulet297fbb42019-05-13 14:41:27 +020061/* Returns the next unporocessed start line in the HTX message. It returns NULL
Christopher Faulet29f17582019-05-23 11:03:26 +020062 * if the start-line is undefined (first == -1). Otherwise, it returns the
Christopher Faulet297fbb42019-05-13 14:41:27 +020063 * pointer on the htx_sl structure.
Christopher Faulet47596d32018-10-22 09:17:28 +020064 */
Tim Duesterhusb8ee8942021-04-03 20:39:20 +020065struct htx_sl *http_get_stline(const struct htx *htx)
Christopher Faulet47596d32018-10-22 09:17:28 +020066{
Christopher Faulet297fbb42019-05-13 14:41:27 +020067 struct htx_blk *blk;
Christopher Faulet573fe732018-11-28 16:55:12 +010068
Christopher Faulet29f17582019-05-23 11:03:26 +020069 blk = htx_get_first_blk(htx);
Christopher Fauleta7d6cf22021-04-15 10:25:35 +020070 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 +020071 return NULL;
72 return htx_get_blk_ptr(htx, blk);
Christopher Faulet47596d32018-10-22 09:17:28 +020073}
74
Christopher Faulet727a3f12020-02-07 16:39:41 +010075/* Returns the headers size in the HTX message */
76size_t http_get_hdrs_size(struct htx *htx)
77{
78 struct htx_blk *blk;
79 size_t sz = 0;
80
81 blk = htx_get_first_blk(htx);
82 if (!blk || htx_get_blk_type(blk) > HTX_BLK_EOH)
83 return sz;
84
85 for (; blk; blk = htx_get_next_blk(htx, blk)) {
86 sz += htx_get_blksz(blk);
87 if (htx_get_blk_type(blk) == HTX_BLK_EOH)
88 break;
89 }
90 return sz;
91}
92
Christopher Faulet8dd33e12020-05-05 07:42:42 +020093/* Finds the first or next occurrence of header matching <pattern> in the HTX
94 * message <htx> using the context <ctx>. This structure holds everything
95 * necessary to use the header and find next occurrence. If its <blk> member is
96 * NULL, the header is searched from the beginning. Otherwise, the next
97 * occurrence is returned. The function returns 1 when it finds a value, and 0
98 * when there is no more. It is designed to work with headers defined as
99 * comma-separated lists. If HTTP_FIND_FL_FULL flag is set, it works on
100 * full-line headers in whose comma is not a delimiter but is part of the
101 * syntax. A special case, if ctx->value is NULL when searching for a new values
102 * of a header, the current header is rescanned. This allows rescanning after a
103 * header deletion.
104 *
105 * The matching method is chosen by checking the flags :
106 *
107 * * HTTP_FIND_FL_MATCH_REG : <pattern> is a regex. header names matching
108 * the regex are evaluated.
109 * * HTTP_FIND_FL_MATCH_STR : <pattern> is a string. The header names equal
110 * to the string are evaluated.
111 * * HTTP_FIND_FL_MATCH_PFX : <pattern> is a string. The header names
112 * starting by the string are evaluated.
113 * * HTTP_FIND_FL_MATCH_SFX : <pattern> is a string. The header names
114 * ending by the string are evaluated.
115 * * HTTP_FIND_FL_MATCH_SUB : <pattern> is a string. The header names
116 * containing the string are evaluated.
Christopher Faulet47596d32018-10-22 09:17:28 +0200117 */
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200118
119#define HTTP_FIND_FL_MATCH_STR 0x0001
120#define HTTP_FIND_FL_MATCH_PFX 0x0002
121#define HTTP_FIND_FL_MATCH_SFX 0x0003
122#define HTTP_FIND_FL_MATCH_SUB 0x0004
123#define HTTP_FIND_FL_MATCH_REG 0x0005
124/* 0x0006..0x000f: for other matching methods */
125#define HTTP_FIND_FL_MATCH_TYPE 0x000F
126#define HTTP_FIND_FL_FULL 0x0010
127
128static 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 +0200129{
130 struct htx_blk *blk = ctx->blk;
131 struct ist n, v;
132 enum htx_blk_type type;
Christopher Faulet47596d32018-10-22 09:17:28 +0200133
134 if (blk) {
135 char *p;
136
Tim Duesterhused526372020-03-05 17:56:33 +0100137 if (!isttest(ctx->value))
Christopher Faulet47596d32018-10-22 09:17:28 +0200138 goto rescan_hdr;
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200139 if (flags & HTTP_FIND_FL_FULL)
Christopher Faulet47596d32018-10-22 09:17:28 +0200140 goto next_blk;
141 v = htx_get_blk_value(htx, blk);
142 p = ctx->value.ptr + ctx->value.len + ctx->lws_after;
143 v.len -= (p - v.ptr);
144 v.ptr = p;
145 if (!v.len)
146 goto next_blk;
147 /* Skip comma */
148 if (*(v.ptr) == ',') {
Tim Duesterhus284fbe12021-11-04 22:35:44 +0100149 v = istnext(v);
Christopher Faulet47596d32018-10-22 09:17:28 +0200150 }
151
152 goto return_hdr;
153 }
154
Christopher Faulet192c6a22019-06-11 16:32:24 +0200155 if (htx_is_empty(htx))
Christopher Faulet47596d32018-10-22 09:17:28 +0200156 return 0;
157
Christopher Fauleta3f15502019-05-13 15:27:23 +0200158 for (blk = htx_get_first_blk(htx); blk; blk = htx_get_next_blk(htx, blk)) {
Christopher Faulet47596d32018-10-22 09:17:28 +0200159 rescan_hdr:
Christopher Faulet47596d32018-10-22 09:17:28 +0200160 type = htx_get_blk_type(blk);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +0100161 if (type == HTX_BLK_EOH)
Christopher Faulet573fe732018-11-28 16:55:12 +0100162 break;
Christopher Faulet47596d32018-10-22 09:17:28 +0200163 if (type != HTX_BLK_HDR)
Christopher Faulet28f29c72019-04-30 17:55:45 +0200164 continue;
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200165
166 if ((flags & HTTP_FIND_FL_MATCH_TYPE) == HTTP_FIND_FL_MATCH_REG) {
167 const struct my_regex *re = pattern;
168
169 n = htx_get_blk_name(htx, blk);
170 if (!regex_exec2(re, n.ptr, n.len))
171 goto next_blk;
172 }
173 else {
174 const struct ist name = *(const struct ist *)(pattern);
175
Christopher Faulet47596d32018-10-22 09:17:28 +0200176 /* If no name was passed, we want any header. So skip the comparison */
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200177 if (!istlen(name))
178 goto match;
179
Christopher Faulet47596d32018-10-22 09:17:28 +0200180 n = htx_get_blk_name(htx, blk);
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200181 switch (flags & HTTP_FIND_FL_MATCH_TYPE) {
182 case HTTP_FIND_FL_MATCH_STR:
183 if (!isteqi(n, name))
184 goto next_blk;
185 break;
186 case HTTP_FIND_FL_MATCH_PFX:
187 if (istlen(n) < istlen(name))
188 goto next_blk;
189
190 n = ist2(istptr(n), istlen(name));
191 if (!isteqi(n, name))
192 goto next_blk;
193 break;
194 case HTTP_FIND_FL_MATCH_SFX:
195 if (istlen(n) < istlen(name))
196 goto next_blk;
197
Tim Duesterhus4c8f75f2021-11-06 15:14:44 +0100198 n = ist2(istend(n) - istlen(name),
199 istlen(name));
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200200 if (!isteqi(n, name))
201 goto next_blk;
202 break;
203 case HTTP_FIND_FL_MATCH_SUB:
Maciej Zdeb302b9f82020-11-20 12:12:24 +0000204 if (!strnistr(n.ptr, n.len, name.ptr, name.len))
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200205 goto next_blk;
206 break;
207 default:
Christopher Faulet47596d32018-10-22 09:17:28 +0200208 goto next_blk;
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200209 break;
210 }
Christopher Faulet47596d32018-10-22 09:17:28 +0200211 }
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200212 match:
Christopher Faulet47596d32018-10-22 09:17:28 +0200213 v = htx_get_blk_value(htx, blk);
214
215 return_hdr:
216 ctx->lws_before = 0;
217 ctx->lws_after = 0;
218 while (v.len && HTTP_IS_LWS(*v.ptr)) {
Tim Duesterhus284fbe12021-11-04 22:35:44 +0100219 v = istnext(v);
Christopher Faulet47596d32018-10-22 09:17:28 +0200220 ctx->lws_before++;
221 }
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200222 if (!(flags & HTTP_FIND_FL_FULL))
Tim Duesterhus4c8f75f2021-11-06 15:14:44 +0100223 v.len = http_find_hdr_value_end(v.ptr, istend(v)) - v.ptr;
224
225 while (v.len && HTTP_IS_LWS(*(istend(v) - 1))) {
Christopher Faulet47596d32018-10-22 09:17:28 +0200226 v.len--;
227 ctx->lws_after++;
228 }
Christopher Faulet47596d32018-10-22 09:17:28 +0200229 ctx->blk = blk;
230 ctx->value = v;
231 return 1;
232
233 next_blk:
Christopher Faulet28f29c72019-04-30 17:55:45 +0200234 ;
Christopher Faulet47596d32018-10-22 09:17:28 +0200235 }
236
237 ctx->blk = NULL;
238 ctx->value = ist("");
239 ctx->lws_before = ctx->lws_after = 0;
240 return 0;
241}
242
Christopher Faulet8dd33e12020-05-05 07:42:42 +0200243
244/* Header names must match <name> */
245int http_find_header(const struct htx *htx, const struct ist name, struct http_hdr_ctx *ctx, int full)
246{
247 return __http_find_header(htx, &name, ctx, HTTP_FIND_FL_MATCH_STR | (full ? HTTP_FIND_FL_FULL : 0));
248}
249
250/* Header names must match <name>. Same than http_find_header */
251int http_find_str_header(const struct htx *htx, const struct ist name, struct http_hdr_ctx *ctx, int full)
252{
253 return __http_find_header(htx, &name, ctx, HTTP_FIND_FL_MATCH_STR | (full ? HTTP_FIND_FL_FULL : 0));
254}
255
256
257/* Header names must start with <prefix> */
258int http_find_pfx_header(const struct htx *htx, const struct ist prefix, struct http_hdr_ctx *ctx, int full)
259{
260 return __http_find_header(htx, &prefix, ctx, HTTP_FIND_FL_MATCH_PFX | (full ? HTTP_FIND_FL_FULL : 0));
261}
262
263/* Header names must end with <suffix> */
264int http_find_sfx_header(const struct htx *htx, const struct ist suffix, struct http_hdr_ctx *ctx, int full)
265{
266 return __http_find_header(htx, &suffix, ctx, HTTP_FIND_FL_MATCH_SFX | (full ? HTTP_FIND_FL_FULL : 0));
267}
268/* Header names must contain <sub> */
269int http_find_sub_header(const struct htx *htx, const struct ist sub, struct http_hdr_ctx *ctx, int full)
270{
271 return __http_find_header(htx, &sub, ctx, HTTP_FIND_FL_MATCH_SUB | (full ? HTTP_FIND_FL_FULL : 0));
272}
273
274/* Header names must match <re> regex*/
275int http_match_header(const struct htx *htx, const struct my_regex *re, struct http_hdr_ctx *ctx, int full)
276{
277 return __http_find_header(htx, re, ctx, HTTP_FIND_FL_MATCH_REG | (full ? HTTP_FIND_FL_FULL : 0));
278}
279
280
Christopher Faulet47596d32018-10-22 09:17:28 +0200281/* Adds a header block int the HTX message <htx>, just before the EOH block. It
282 * returns 1 on success, otherwise it returns 0.
283 */
284int http_add_header(struct htx *htx, const struct ist n, const struct ist v)
285{
286 struct htx_blk *blk;
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200287 struct htx_sl *sl;
Christopher Faulet47596d32018-10-22 09:17:28 +0200288 enum htx_blk_type type = htx_get_tail_type(htx);
289 int32_t prev;
290
291 blk = htx_add_header(htx, n, v);
292 if (!blk)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200293 goto fail;
Christopher Faulet47596d32018-10-22 09:17:28 +0200294
295 if (unlikely(type < HTX_BLK_EOH))
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200296 goto end;
Christopher Faulet47596d32018-10-22 09:17:28 +0200297
298 /* <blk> is the head, swap it iteratively with its predecessor to place
299 * it just before the end-of-header block. So blocks remains ordered. */
Christopher Faulet29f17582019-05-23 11:03:26 +0200300 for (prev = htx_get_prev(htx, htx->tail); prev != htx->first; prev = htx_get_prev(htx, prev)) {
Christopher Faulet47596d32018-10-22 09:17:28 +0200301 struct htx_blk *pblk = htx_get_blk(htx, prev);
302 enum htx_blk_type type = htx_get_blk_type(pblk);
303
304 /* Swap .addr and .info fields */
305 blk->addr ^= pblk->addr; pblk->addr ^= blk->addr; blk->addr ^= pblk->addr;
306 blk->info ^= pblk->info; pblk->info ^= blk->info; blk->info ^= pblk->info;
307
308 if (blk->addr == pblk->addr)
309 blk->addr += htx_get_blksz(pblk);
Christopher Faulet47596d32018-10-22 09:17:28 +0200310
311 /* Stop when end-of-header is reached */
312 if (type == HTX_BLK_EOH)
313 break;
314
315 blk = pblk;
316 }
Christopher Faulet05aab642019-04-11 13:43:57 +0200317
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200318 end:
319 sl = http_get_stline(htx);
Christopher Faulet3e1f7f42020-02-28 09:47:07 +0100320 if (sl && (sl->flags & HTX_SL_F_HAS_AUTHORITY) && isteqi(n, ist("host"))) {
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200321 if (!http_update_authority(htx, sl, v))
322 goto fail;
323 }
Christopher Faulet47596d32018-10-22 09:17:28 +0200324 return 1;
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200325
326 fail:
327 return 0;
Christopher Faulet47596d32018-10-22 09:17:28 +0200328}
329
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100330/* Replaces parts of the start-line of the HTX message <htx>. It returns 1 on
Christopher Faulet29f17582019-05-23 11:03:26 +0200331 * success, otherwise it returns 0.
Christopher Faulet47596d32018-10-22 09:17:28 +0200332 */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100333int 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 +0200334{
Christopher Faulet7b7d5072019-05-13 15:22:59 +0200335 struct htx_blk *blk;
Christopher Faulet47596d32018-10-22 09:17:28 +0200336
Christopher Faulet29f17582019-05-23 11:03:26 +0200337 blk = htx_get_first_blk(htx);
338 if (!blk || !htx_replace_stline(htx, blk, p1, p2, p3))
Christopher Faulet7b7d5072019-05-13 15:22:59 +0200339 return 0;
340 return 1;
Christopher Faulet47596d32018-10-22 09:17:28 +0200341}
342
Christopher Faulete010c802018-10-24 10:36:45 +0200343/* Replace the request method in the HTX message <htx> by <meth>. It returns 1
344 * on success, otherwise 0.
345 */
346int http_replace_req_meth(struct htx *htx, const struct ist meth)
347{
348 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200349 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100350 struct ist uri, vsn;
Christopher Faulete010c802018-10-24 10:36:45 +0200351
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100352 if (!sl)
353 return 0;
354
Christopher Faulete010c802018-10-24 10:36:45 +0200355 /* Start by copying old uri and version */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100356 chunk_memcat(temp, HTX_SL_REQ_UPTR(sl), HTX_SL_REQ_ULEN(sl)); /* uri */
357 uri = ist2(temp->area, HTX_SL_REQ_ULEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200358
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100359 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl)); /* vsn */
360 vsn = ist2(temp->area + uri.len, HTX_SL_REQ_VLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200361
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100362 /* create the new start line */
363 sl->info.req.meth = find_http_meth(meth.ptr, meth.len);
364 return http_replace_stline(htx, meth, uri, vsn);
Christopher Faulete010c802018-10-24 10:36:45 +0200365}
366
367/* Replace the request uri in the HTX message <htx> by <uri>. It returns 1 on
368 * success, otherwise 0.
369 */
370int http_replace_req_uri(struct htx *htx, const struct ist uri)
371{
372 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200373 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100374 struct ist meth, vsn;
Christopher Faulete010c802018-10-24 10:36:45 +0200375
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100376 if (!sl)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200377 goto fail;
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100378
Christopher Faulete010c802018-10-24 10:36:45 +0200379 /* Start by copying old method and version */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100380 chunk_memcat(temp, HTX_SL_REQ_MPTR(sl), HTX_SL_REQ_MLEN(sl)); /* meth */
381 meth = ist2(temp->area, HTX_SL_REQ_MLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200382
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100383 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl)); /* vsn */
384 vsn = ist2(temp->area + meth.len, HTX_SL_REQ_VLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200385
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100386 /* create the new start line */
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200387 if (!http_replace_stline(htx, meth, uri, vsn))
388 goto fail;
389
390 sl = http_get_stline(htx);
391 if (!http_update_host(htx, sl, uri))
392 goto fail;
393
394 return 1;
395 fail:
396 return 0;
Christopher Faulete010c802018-10-24 10:36:45 +0200397}
398
Christopher Fauletb8ce5052020-08-31 16:11:57 +0200399/* Replace the request path in the HTX message <htx> by <path>. The host part is
400 * preserverd. if <with_qs> is set, the query string is evaluated as part of the
401 * path and replaced. Otherwise, it is preserved too. It returns 1 on success,
402 * otherwise 0.
Christopher Faulete010c802018-10-24 10:36:45 +0200403 */
Christopher Fauletb8ce5052020-08-31 16:11:57 +0200404int http_replace_req_path(struct htx *htx, const struct ist path, int with_qs)
Christopher Faulete010c802018-10-24 10:36:45 +0200405{
406 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200407 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100408 struct ist meth, uri, vsn, p;
Christopher Faulete010c802018-10-24 10:36:45 +0200409 size_t plen = 0;
Amaury Denoyellec453f952021-07-06 11:40:12 +0200410 struct http_uri_parser parser;
Christopher Faulete010c802018-10-24 10:36:45 +0200411
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100412 if (!sl)
413 return 0;
414
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100415 uri = htx_sl_req_uri(sl);
Amaury Denoyellec453f952021-07-06 11:40:12 +0200416 parser = http_uri_parser_init(uri);
417 p = http_parse_path(&parser);
Tim Duesterhused526372020-03-05 17:56:33 +0100418 if (!isttest(p))
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100419 p = uri;
Christopher Fauletb8ce5052020-08-31 16:11:57 +0200420 if (with_qs)
421 plen = p.len;
422 else {
423 while (plen < p.len && *(p.ptr + plen) != '?')
424 plen++;
425 }
Christopher Faulete010c802018-10-24 10:36:45 +0200426
427 /* Start by copying old method and version and create the new uri */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100428 chunk_memcat(temp, HTX_SL_REQ_MPTR(sl), HTX_SL_REQ_MLEN(sl)); /* meth */
429 meth = ist2(temp->area, HTX_SL_REQ_MLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200430
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100431 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl)); /* vsn */
432 vsn = ist2(temp->area + meth.len, HTX_SL_REQ_VLEN(sl));
433
434 chunk_memcat(temp, uri.ptr, p.ptr - uri.ptr); /* uri: host part */
Christopher Faulete010c802018-10-24 10:36:45 +0200435 chunk_memcat(temp, path.ptr, path.len); /* uri: new path */
436 chunk_memcat(temp, p.ptr + plen, p.len - plen); /* uri: QS part */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100437 uri = ist2(temp->area + meth.len + vsn.len, uri.len - plen + path.len);
Christopher Faulete010c802018-10-24 10:36:45 +0200438
439 /* create the new start line */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100440 return http_replace_stline(htx, meth, uri, vsn);
Christopher Faulete010c802018-10-24 10:36:45 +0200441}
442
443/* Replace the request query-string in the HTX message <htx> by <query>. The
444 * host part and the path are preserved. It returns 1 on success, otherwise
445 * 0.
446 */
447int http_replace_req_query(struct htx *htx, const struct ist query)
448{
449 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200450 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100451 struct ist meth, uri, vsn, q;
Christopher Faulete010c802018-10-24 10:36:45 +0200452 int offset = 1;
453
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100454 if (!sl)
455 return 0;
456
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100457 uri = htx_sl_req_uri(sl);
458 q = uri;
Christopher Faulete010c802018-10-24 10:36:45 +0200459 while (q.len > 0 && *(q.ptr) != '?') {
Tim Duesterhus284fbe12021-11-04 22:35:44 +0100460 q = istnext(q);
Christopher Faulete010c802018-10-24 10:36:45 +0200461 }
462
463 /* skip the question mark or indicate that we must insert it
464 * (but only if the format string is not empty then).
465 */
466 if (q.len) {
Tim Duesterhus284fbe12021-11-04 22:35:44 +0100467 q = istnext(q);
Christopher Faulete010c802018-10-24 10:36:45 +0200468 }
469 else if (query.len > 1)
470 offset = 0;
471
472 /* Start by copying old method and version and create the new uri */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100473 chunk_memcat(temp, HTX_SL_REQ_MPTR(sl), HTX_SL_REQ_MLEN(sl)); /* meth */
474 meth = ist2(temp->area, HTX_SL_REQ_MLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200475
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100476 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl)); /* vsn */
477 vsn = ist2(temp->area + meth.len, HTX_SL_REQ_VLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200478
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100479 chunk_memcat(temp, uri.ptr, q.ptr - uri.ptr); /* uri: host + path part */
480 chunk_memcat(temp, query.ptr + offset, query.len - offset); /* uri: new QS */
481 uri = ist2(temp->area + meth.len + vsn.len, uri.len - q.len + query.len - offset);
Christopher Faulete010c802018-10-24 10:36:45 +0200482
483 /* create the new start line */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100484 return http_replace_stline(htx, meth, uri, vsn);
Christopher Faulete010c802018-10-24 10:36:45 +0200485}
486
487/* Replace the response status in the HTX message <htx> by <status>. It returns
488 * 1 on success, otherwise 0.
489*/
Christopher Fauletbde2c4c2020-08-31 16:43:34 +0200490int http_replace_res_status(struct htx *htx, const struct ist status, const struct ist reason)
Christopher Faulete010c802018-10-24 10:36:45 +0200491{
492 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200493 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletbde2c4c2020-08-31 16:43:34 +0200494 struct ist vsn, r;
Christopher Faulete010c802018-10-24 10:36:45 +0200495
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100496 if (!sl)
497 return 0;
498
Christopher Faulete010c802018-10-24 10:36:45 +0200499 /* Start by copying old uri and version */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100500 chunk_memcat(temp, HTX_SL_RES_VPTR(sl), HTX_SL_RES_VLEN(sl)); /* vsn */
501 vsn = ist2(temp->area, HTX_SL_RES_VLEN(sl));
Christopher Fauletbde2c4c2020-08-31 16:43:34 +0200502 r = reason;
503 if (!isttest(r)) {
504 chunk_memcat(temp, HTX_SL_RES_RPTR(sl), HTX_SL_RES_RLEN(sl)); /* reason */
505 r = ist2(temp->area + vsn.len, HTX_SL_RES_RLEN(sl));
506 }
Christopher Faulete010c802018-10-24 10:36:45 +0200507
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100508 /* create the new start line */
509 sl->info.res.status = strl2ui(status.ptr, status.len);
Christopher Fauletbde2c4c2020-08-31 16:43:34 +0200510 return http_replace_stline(htx, vsn, status, r);
Christopher Faulete010c802018-10-24 10:36:45 +0200511}
512
513/* Replace the response reason in the HTX message <htx> by <reason>. It returns
514 * 1 on success, otherwise 0.
515*/
516int http_replace_res_reason(struct htx *htx, const struct ist reason)
517{
518 struct buffer *temp = get_trash_chunk();
Christopher Faulet297fbb42019-05-13 14:41:27 +0200519 struct htx_sl *sl = http_get_stline(htx);
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100520 struct ist vsn, status;
Christopher Faulete010c802018-10-24 10:36:45 +0200521
Willy Tarreaucdce54c2019-02-12 12:02:27 +0100522 if (!sl)
523 return 0;
524
Christopher Faulete010c802018-10-24 10:36:45 +0200525 /* Start by copying old uri and version */
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100526 chunk_memcat(temp, HTX_SL_RES_VPTR(sl), HTX_SL_RES_VLEN(sl)); /* vsn */
527 vsn = ist2(temp->area, HTX_SL_RES_VLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200528
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100529 chunk_memcat(temp, HTX_SL_RES_CPTR(sl), HTX_SL_RES_CLEN(sl)); /* code */
530 status = ist2(temp->area + vsn.len, HTX_SL_RES_CLEN(sl));
Christopher Faulete010c802018-10-24 10:36:45 +0200531
Christopher Fauletf1ba18d2018-11-26 21:37:08 +0100532 /* create the new start line */
533 return http_replace_stline(htx, vsn, status, reason);
Christopher Faulete010c802018-10-24 10:36:45 +0200534}
535
Christopher Faulet47596d32018-10-22 09:17:28 +0200536/* Replaces a part of a header value referenced in the context <ctx> by
537 * <data>. It returns 1 on success, otherwise it returns 0. The context is
538 * updated if necessary.
539 */
540int http_replace_header_value(struct htx *htx, struct http_hdr_ctx *ctx, const struct ist data)
541{
542 struct htx_blk *blk = ctx->blk;
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200543 struct htx_sl *sl;
Christopher Faulet47596d32018-10-22 09:17:28 +0200544 char *start;
545 struct ist v;
546 uint32_t len, off;
547
548 if (!blk)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200549 goto fail;
Christopher Faulet47596d32018-10-22 09:17:28 +0200550
551 v = htx_get_blk_value(htx, blk);
552 start = ctx->value.ptr - ctx->lws_before;
553 len = ctx->lws_before + ctx->value.len + ctx->lws_after;
554 off = start - v.ptr;
555
556 blk = htx_replace_blk_value(htx, blk, ist2(start, len), data);
557 if (!blk)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200558 goto fail;
Christopher Faulet47596d32018-10-22 09:17:28 +0200559
560 v = htx_get_blk_value(htx, blk);
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200561
562 sl = http_get_stline(htx);
563 if (sl && (sl->flags & HTX_SL_F_HAS_AUTHORITY)) {
564 struct ist n = htx_get_blk_name(htx, blk);
565
566 if (isteq(n, ist("host"))) {
567 if (!http_update_authority(htx, sl, v))
568 goto fail;
569 ctx->blk = NULL;
570 http_find_header(htx, ist("host"), ctx, 1);
571 blk = ctx->blk;
572 v = htx_get_blk_value(htx, blk);
573 }
574 }
575
Christopher Faulet47596d32018-10-22 09:17:28 +0200576 ctx->blk = blk;
577 ctx->value.ptr = v.ptr + off;
578 ctx->value.len = data.len;
579 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 */
677 ctx->value.ptr = start;
678 ctx->value.len = 0;
679 ctx->lws_before = ctx->lws_after = 0;
680
681 return 1;
682}
Christopher Faulet7ff1cea2018-10-24 10:39:35 +0200683
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200684/* Updates the authority part of the uri with the value <host>. It happens when
685 * the header host is modified. It returns 0 on failure and 1 on success. It is
686 * the caller responsibility to provide the start-line and to be sure the uri
687 * contains an authority. Thus, if no authority is found in the uri, an error is
688 * returned.
689 */
Christopher Faulet1543d442020-04-28 19:57:29 +0200690int http_update_authority(struct htx *htx, struct htx_sl *sl, const struct ist host)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200691{
692 struct buffer *temp = get_trash_chunk();
693 struct ist meth, vsn, uri, authority;
Amaury Denoyelle69294b22021-07-06 11:02:22 +0200694 struct http_uri_parser parser;
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200695
696 uri = htx_sl_req_uri(sl);
Amaury Denoyelle69294b22021-07-06 11:02:22 +0200697 parser = http_uri_parser_init(uri);
698 authority = http_parse_authority(&parser, 1);
Christopher Faulet34b18e42020-02-18 11:02:21 +0100699 if (!authority.len)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200700 return 0;
701
Christopher Faulet34b18e42020-02-18 11:02:21 +0100702 /* Don't update the uri if there is no change */
703 if (isteq(host, authority))
704 return 1;
705
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200706 /* Start by copying old method and version */
707 chunk_memcat(temp, HTX_SL_REQ_MPTR(sl), HTX_SL_REQ_MLEN(sl)); /* meth */
708 meth = ist2(temp->area, HTX_SL_REQ_MLEN(sl));
709
710 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl)); /* vsn */
711 vsn = ist2(temp->area + meth.len, HTX_SL_REQ_VLEN(sl));
712
713 chunk_memcat(temp, uri.ptr, authority.ptr - uri.ptr);
714 chunk_memcat(temp, host.ptr, host.len);
Tim Duesterhus4c8f75f2021-11-06 15:14:44 +0100715 chunk_memcat(temp, istend(authority), istend(uri) - istend(authority));
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200716 uri = ist2(temp->area + meth.len + vsn.len, host.len + uri.len - authority.len); /* uri */
717
718 return http_replace_stline(htx, meth, uri, vsn);
719
720}
721
722/* Update the header host by extracting the authority of the uri <uri>. flags of
723 * the start-line are also updated accordingly. For orgin-form and asterisk-form
724 * uri, the header host is not changed and the flag HTX_SL_F_HAS_AUTHORITY is
725 * removed from the flags of the start-line. Otherwise, this flag is set and the
726 * authority is used to set the value of the header host. This function returns
727 * 0 on failure and 1 on success.
728*/
Christopher Faulet1543d442020-04-28 19:57:29 +0200729int http_update_host(struct htx *htx, struct htx_sl *sl, const struct ist uri)
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200730{
731 struct ist authority;
732 struct http_hdr_ctx ctx;
Amaury Denoyelle69294b22021-07-06 11:02:22 +0200733 struct http_uri_parser parser = http_uri_parser_init(uri);
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200734
Amaury Denoyelle69294b22021-07-06 11:02:22 +0200735 if (parser.format == URI_PARSER_FORMAT_EMPTY ||
736 parser.format == URI_PARSER_FORMAT_ASTERISK ||
737 parser.format == URI_PARSER_FORMAT_ABSPATH) {
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200738 sl->flags &= ~HTX_SL_F_HAS_AUTHORITY;
739 }
740 else {
741 sl->flags |= HTX_SL_F_HAS_AUTHORITY;
742 if (sl->info.req.meth != HTTP_METH_CONNECT) {
743 // absolute-form (RFC7320 #5.3.2)
744 sl->flags |= HTX_SL_F_HAS_SCHM;
745 if (uri.len > 4 && (uri.ptr[0] | 0x20) == 'h')
746 sl->flags |= ((uri.ptr[4] == ':') ? HTX_SL_F_SCHM_HTTP : HTX_SL_F_SCHM_HTTPS);
747
Amaury Denoyelle69294b22021-07-06 11:02:22 +0200748 authority = http_parse_authority(&parser, 1);
Christopher Fauletd7b7a1c2019-10-08 15:24:52 +0200749 if (!authority.len)
750 goto fail;
751 }
752 else {
753 // authority-form (RFC7320 #5.3.3)
754 authority = uri;
755 }
756
757 /* Replace header host value */
758 ctx.blk = NULL;
759 while (http_find_header(htx, ist("host"), &ctx, 1)) {
760 if (!http_replace_header_value(htx, &ctx, authority))
761 goto fail;
762 }
763
764 }
765 return 1;
766 fail:
767 return 0;
768}
Christopher Faulet7ff1cea2018-10-24 10:39:35 +0200769
770/* Return in <vptr> and <vlen> the pointer and length of occurrence <occ> of
771 * header whose name is <hname> of length <hlen>. If <ctx> is null, lookup is
772 * performed over the whole headers. Otherwise it must contain a valid header
773 * context, initialised with ctx->blk=NULL for the first lookup in a series. If
774 * <occ> is positive or null, occurrence #occ from the beginning (or last ctx)
775 * is returned. Occ #0 and #1 are equivalent. If <occ> is negative (and no less
776 * than -MAX_HDR_HISTORY), the occurrence is counted from the last one which is
777 * -1. The value fetch stops at commas, so this function is suited for use with
778 * list headers.
779 * The return value is 0 if nothing was found, or non-zero otherwise.
780 */
781unsigned int http_get_htx_hdr(const struct htx *htx, const struct ist hdr,
782 int occ, struct http_hdr_ctx *ctx, char **vptr, size_t *vlen)
783{
784 struct http_hdr_ctx local_ctx;
785 struct ist val_hist[MAX_HDR_HISTORY];
786 unsigned int hist_idx;
787 int found;
788
789 if (!ctx) {
790 local_ctx.blk = NULL;
791 ctx = &local_ctx;
792 }
793
794 if (occ >= 0) {
795 /* search from the beginning */
796 while (http_find_header(htx, hdr, ctx, 0)) {
797 occ--;
798 if (occ <= 0) {
799 *vptr = ctx->value.ptr;
800 *vlen = ctx->value.len;
801 return 1;
802 }
803 }
804 return 0;
805 }
806
807 /* negative occurrence, we scan all the list then walk back */
808 if (-occ > MAX_HDR_HISTORY)
809 return 0;
810
811 found = hist_idx = 0;
812 while (http_find_header(htx, hdr, ctx, 0)) {
813 val_hist[hist_idx] = ctx->value;
814 if (++hist_idx >= MAX_HDR_HISTORY)
815 hist_idx = 0;
816 found++;
817 }
818 if (-occ > found)
819 return 0;
820
821 /* OK now we have the last occurrence in [hist_idx-1], and we need to
822 * find occurrence -occ. 0 <= hist_idx < MAX_HDR_HISTORY, and we have
823 * -10 <= occ <= -1. So we have to check [hist_idx%MAX_HDR_HISTORY+occ]
824 * to remain in the 0..9 range.
825 */
826 hist_idx += occ + MAX_HDR_HISTORY;
827 if (hist_idx >= MAX_HDR_HISTORY)
828 hist_idx -= MAX_HDR_HISTORY;
829 *vptr = val_hist[hist_idx].ptr;
830 *vlen = val_hist[hist_idx].len;
831 return 1;
832}
833
834/* Return in <vptr> and <vlen> the pointer and length of occurrence <occ> of
835 * header whose name is <hname> of length <hlen>. If <ctx> is null, lookup is
836 * performed over the whole headers. Otherwise it must contain a valid header
837 * context, initialised with ctx->blk=NULL for the first lookup in a series. If
838 * <occ> is positive or null, occurrence #occ from the beginning (or last ctx)
839 * is returned. Occ #0 and #1 are equivalent. If <occ> is negative (and no less
840 * than -MAX_HDR_HISTORY), the occurrence is counted from the last one which is
841 * -1. This function differs from http_get_hdr() in that it only returns full
842 * line header values and does not stop at commas.
843 * The return value is 0 if nothing was found, or non-zero otherwise.
844 */
845unsigned int http_get_htx_fhdr(const struct htx *htx, const struct ist hdr,
846 int occ, struct http_hdr_ctx *ctx, char **vptr, size_t *vlen)
847{
848 struct http_hdr_ctx local_ctx;
849 struct ist val_hist[MAX_HDR_HISTORY];
850 unsigned int hist_idx;
851 int found;
852
853 if (!ctx) {
854 local_ctx.blk = NULL;
855 ctx = &local_ctx;
856 }
857
858 if (occ >= 0) {
859 /* search from the beginning */
860 while (http_find_header(htx, hdr, ctx, 1)) {
861 occ--;
862 if (occ <= 0) {
863 *vptr = ctx->value.ptr;
864 *vlen = ctx->value.len;
865 return 1;
866 }
867 }
868 return 0;
869 }
870
871 /* negative occurrence, we scan all the list then walk back */
872 if (-occ > MAX_HDR_HISTORY)
873 return 0;
874
875 found = hist_idx = 0;
876 while (http_find_header(htx, hdr, ctx, 1)) {
877 val_hist[hist_idx] = ctx->value;
878 if (++hist_idx >= MAX_HDR_HISTORY)
879 hist_idx = 0;
880 found++;
881 }
882 if (-occ > found)
883 return 0;
884
885 /* OK now we have the last occurrence in [hist_idx-1], and we need to
886 * find occurrence -occ. 0 <= hist_idx < MAX_HDR_HISTORY, and we have
887 * -10 <= occ <= -1. So we have to check [hist_idx%MAX_HDR_HISTORY+occ]
888 * to remain in the 0..9 range.
889 */
890 hist_idx += occ + MAX_HDR_HISTORY;
891 if (hist_idx >= MAX_HDR_HISTORY)
892 hist_idx -= MAX_HDR_HISTORY;
893 *vptr = val_hist[hist_idx].ptr;
894 *vlen = val_hist[hist_idx].len;
895 return 1;
896}
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100897
Christopher Fauleta66adf42020-11-05 22:43:41 +0100898int http_str_to_htx(struct buffer *buf, struct ist raw, char **errmsg)
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100899{
900 struct htx *htx;
901 struct htx_sl *sl;
902 struct h1m h1m;
Christopher Faulete4ab11b2019-06-11 15:05:37 +0200903 struct http_hdr hdrs[global.tune.max_http_hdr];
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100904 union h1_sl h1sl;
905 unsigned int flags = HTX_SL_F_IS_RESP;
906 int ret = 0;
907
Christopher Faulet90cc4812019-07-22 16:49:30 +0200908 b_reset(buf);
909 if (!raw.len) {
910 buf->size = 0;
Christopher Faulet1cdc0282021-02-05 10:29:29 +0100911 buf->area = NULL;
Christopher Faulet90cc4812019-07-22 16:49:30 +0200912 return 1;
913 }
914
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100915 buf->size = global.tune.bufsize;
Tim Duesterhus403fd722021-04-08 20:05:23 +0200916 buf->area = malloc(buf->size);
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100917 if (!buf->area)
918 goto error;
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100919
920 h1m_init_res(&h1m);
921 h1m.flags |= H1_MF_NO_PHDR;
Tim Duesterhus4c8f75f2021-11-06 15:14:44 +0100922 ret = h1_headers_to_hdr_list(raw.ptr, istend(raw),
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100923 hdrs, sizeof(hdrs)/sizeof(hdrs[0]), &h1m, &h1sl);
Christopher Fauleta66adf42020-11-05 22:43:41 +0100924 if (ret <= 0) {
925 memprintf(errmsg, "unabled to parse headers (error offset: %d)", h1m.err_pos);
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100926 goto error;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100927 }
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100928
Christopher Fauleta66adf42020-11-05 22:43:41 +0100929 if (unlikely(h1sl.st.v.len != 8)) {
930 memprintf(errmsg, "invalid http version (%.*s)", (int)h1sl.st.v.len, h1sl.st.v.ptr);
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100931 goto error;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100932 }
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100933 if ((*(h1sl.st.v.ptr + 5) > '1') ||
934 ((*(h1sl.st.v.ptr + 5) == '1') && (*(h1sl.st.v.ptr + 7) >= '1')))
935 h1m.flags |= H1_MF_VER_11;
936
Christopher Fauleta66adf42020-11-05 22:43:41 +0100937 if (h1sl.st.status < 200 && (h1sl.st.status == 100 || h1sl.st.status >= 102)) {
938 memprintf(errmsg, "invalid http status code for an error message (%u)",
939 h1sl.st.status);
Christopher Faulet1d5ec092019-06-26 14:23:54 +0200940 goto error;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100941 }
Christopher Faulet1d5ec092019-06-26 14:23:54 +0200942
Christopher Fauletb8d148a2020-10-09 08:50:26 +0200943 if (h1sl.st.status == 204 || h1sl.st.status == 304) {
944 /* Responses known to have no body. */
945 h1m.flags &= ~(H1_MF_CLEN|H1_MF_CHNK);
946 h1m.flags |= H1_MF_XFER_LEN;
947 h1m.curr_len = h1m.body_len = 0;
948 }
949 else if (h1m.flags & (H1_MF_CLEN|H1_MF_CHNK))
950 h1m.flags |= H1_MF_XFER_LEN;
951
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100952 if (h1m.flags & H1_MF_VER_11)
953 flags |= HTX_SL_F_VER_11;
954 if (h1m.flags & H1_MF_XFER_ENC)
955 flags |= HTX_SL_F_XFER_ENC;
Christopher Fauletb8d148a2020-10-09 08:50:26 +0200956 if (h1m.flags & H1_MF_XFER_LEN) {
957 flags |= HTX_SL_F_XFER_LEN;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100958 if (h1m.flags & H1_MF_CHNK) {
959 memprintf(errmsg, "chunk-encoded payload not supported");
960 goto error;
961 }
Christopher Fauletb8d148a2020-10-09 08:50:26 +0200962 else if (h1m.flags & H1_MF_CLEN) {
963 flags |= HTX_SL_F_CLEN;
964 if (h1m.body_len == 0)
965 flags |= HTX_SL_F_BODYLESS;
966 }
967 else
Christopher Faulet0d4ce932019-10-16 09:09:04 +0200968 flags |= HTX_SL_F_BODYLESS;
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100969 }
Christopher Fauletb8d148a2020-10-09 08:50:26 +0200970
Christopher Fauleta66adf42020-11-05 22:43:41 +0100971 if ((flags & HTX_SL_F_BODYLESS) && raw.len > ret) {
972 memprintf(errmsg, "message payload not expected");
973 goto error;
974 }
975 if ((flags & HTX_SL_F_CLEN) && h1m.body_len != (raw.len - ret)) {
976 memprintf(errmsg, "payload size does not match the announced content-length (%lu != %lu)",
Willy Tarreau431a12c2020-11-06 14:24:02 +0100977 (unsigned long)(raw.len - ret), (unsigned long)h1m.body_len);
Christopher Fauleta66adf42020-11-05 22:43:41 +0100978 goto error;
979 }
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100980
981 htx = htx_from_buf(buf);
982 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 +0100983 if (!sl || !htx_add_all_headers(htx, hdrs)) {
984 memprintf(errmsg, "unable to add headers into the HTX message");
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100985 goto error;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100986 }
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100987 sl->info.res.status = h1sl.st.status;
988
Willy Tarreau0a7ef022019-05-28 10:30:11 +0200989 while (raw.len > ret) {
990 int sent = htx_add_data(htx, ist2(raw.ptr + ret, raw.len - ret));
Christopher Fauleta66adf42020-11-05 22:43:41 +0100991 if (!sent) {
992 memprintf(errmsg, "unable to add payload into the HTX message");
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100993 goto error;
Christopher Fauleta66adf42020-11-05 22:43:41 +0100994 }
Willy Tarreau0a7ef022019-05-28 10:30:11 +0200995 ret += sent;
Christopher Fauleta7b677c2018-11-29 16:48:49 +0100996 }
Christopher Faulet1d5ec092019-06-26 14:23:54 +0200997
Christopher Fauletd1ac2b92020-12-02 19:12:22 +0100998 htx->flags |= HTX_FL_EOM;
Christopher Faulet1d5ec092019-06-26 14:23:54 +0200999
Christopher Faulet90cc4812019-07-22 16:49:30 +02001000 return 1;
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001001
1002error:
1003 if (buf->size)
1004 free(buf->area);
Christopher Faulet90cc4812019-07-22 16:49:30 +02001005 return 0;
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001006}
1007
Christopher Faulet18630642020-05-12 18:57:28 +02001008void release_http_reply(struct http_reply *http_reply)
1009{
1010 struct logformat_node *lf, *lfb;
1011 struct http_reply_hdr *hdr, *hdrb;
1012
1013 if (!http_reply)
1014 return;
1015
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001016 ha_free(&http_reply->ctype);
Christopher Faulet18630642020-05-12 18:57:28 +02001017 list_for_each_entry_safe(hdr, hdrb, &http_reply->hdrs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001018 LIST_DELETE(&hdr->list);
Christopher Faulet18630642020-05-12 18:57:28 +02001019 list_for_each_entry_safe(lf, lfb, &hdr->value, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001020 LIST_DELETE(&lf->list);
Christopher Faulet18630642020-05-12 18:57:28 +02001021 release_sample_expr(lf->expr);
1022 free(lf->arg);
1023 free(lf);
1024 }
1025 istfree(&hdr->name);
1026 free(hdr);
1027 }
1028
1029 if (http_reply->type == HTTP_REPLY_ERRFILES) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001030 ha_free(&http_reply->body.http_errors);
Christopher Faulet18630642020-05-12 18:57:28 +02001031 }
1032 else if (http_reply->type == HTTP_REPLY_RAW)
1033 chunk_destroy(&http_reply->body.obj);
1034 else if (http_reply->type == HTTP_REPLY_LOGFMT) {
1035 list_for_each_entry_safe(lf, lfb, &http_reply->body.fmt, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001036 LIST_DELETE(&lf->list);
Christopher Faulet18630642020-05-12 18:57:28 +02001037 release_sample_expr(lf->expr);
1038 free(lf->arg);
1039 free(lf);
1040 }
1041 }
Christopher Faulet63d48242020-05-21 09:59:22 +02001042 free(http_reply);
Christopher Faulet18630642020-05-12 18:57:28 +02001043}
1044
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001045static int http_htx_init(void)
1046{
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001047 struct buffer chk;
1048 struct ist raw;
Christopher Fauleta66adf42020-11-05 22:43:41 +01001049 char *errmsg = NULL;
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001050 int rc;
1051 int err_code = 0;
1052
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001053 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
1054 if (!http_err_msgs[rc]) {
Christopher Fauleta66adf42020-11-05 22:43:41 +01001055 ha_alert("Internal error: no default message defined for HTTP return code %d", rc);
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001056 err_code |= ERR_ALERT | ERR_FATAL;
1057 continue;
1058 }
1059
1060 raw = ist2(http_err_msgs[rc], strlen(http_err_msgs[rc]));
Christopher Fauleta66adf42020-11-05 22:43:41 +01001061 if (!http_str_to_htx(&chk, raw, &errmsg)) {
1062 ha_alert("Internal error: invalid default message for HTTP return code %d: %s.\n",
1063 http_err_codes[rc], errmsg);
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001064 err_code |= ERR_ALERT | ERR_FATAL;
1065 }
Christopher Fauleta66adf42020-11-05 22:43:41 +01001066 else if (errmsg) {
1067 ha_warning("invalid default message for HTTP return code %d: %s.\n", http_err_codes[rc], errmsg);
1068 err_code |= ERR_WARN;
1069 }
1070
1071 /* Reset errmsg */
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001072 ha_free(&errmsg);
Christopher Fauleta66adf42020-11-05 22:43:41 +01001073
Christopher Fauletf7346382019-07-17 22:02:08 +02001074 http_err_chunks[rc] = chk;
Christopher Faulet1b13eca2020-05-14 09:54:26 +02001075 http_err_replies[rc].type = HTTP_REPLY_ERRMSG;
1076 http_err_replies[rc].status = http_err_codes[rc];
1077 http_err_replies[rc].ctype = NULL;
1078 LIST_INIT(&http_err_replies[rc].hdrs);
1079 http_err_replies[rc].body.errmsg = &http_err_chunks[rc];
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001080 }
1081end:
1082 return err_code;
1083}
1084
Christopher Faulet58857752020-01-15 15:19:50 +01001085static void http_htx_deinit(void)
1086{
Christopher Faulet35cd81d2020-01-15 11:22:56 +01001087 struct http_errors *http_errs, *http_errsb;
Christopher Faulet5809e102020-05-14 17:31:52 +02001088 struct http_reply *http_rep, *http_repb;
Christopher Faulet58857752020-01-15 15:19:50 +01001089 struct ebpt_node *node, *next;
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001090 struct http_error_msg *http_errmsg;
Christopher Fauletde30bb72020-05-14 10:03:55 +02001091 int rc;
Christopher Faulet58857752020-01-15 15:19:50 +01001092
1093 node = ebpt_first(&http_error_messages);
1094 while (node) {
1095 next = ebpt_next(node);
1096 ebpt_delete(node);
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001097 http_errmsg = container_of(node, typeof(*http_errmsg), node);
1098 chunk_destroy(&http_errmsg->msg);
Christopher Faulet58857752020-01-15 15:19:50 +01001099 free(node->key);
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001100 free(http_errmsg);
Christopher Faulet58857752020-01-15 15:19:50 +01001101 node = next;
1102 }
Christopher Faulet35cd81d2020-01-15 11:22:56 +01001103
1104 list_for_each_entry_safe(http_errs, http_errsb, &http_errors_list, list) {
1105 free(http_errs->conf.file);
1106 free(http_errs->id);
Christopher Fauletde30bb72020-05-14 10:03:55 +02001107 for (rc = 0; rc < HTTP_ERR_SIZE; rc++)
1108 release_http_reply(http_errs->replies[rc]);
Willy Tarreau2b718102021-04-21 07:32:39 +02001109 LIST_DELETE(&http_errs->list);
Christopher Faulet35cd81d2020-01-15 11:22:56 +01001110 free(http_errs);
1111 }
Christopher Faulet5809e102020-05-14 17:31:52 +02001112
1113 list_for_each_entry_safe(http_rep, http_repb, &http_replies_list, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001114 LIST_DELETE(&http_rep->list);
Christopher Faulet5809e102020-05-14 17:31:52 +02001115 release_http_reply(http_rep);
1116 }
Christopher Faulet58857752020-01-15 15:19:50 +01001117}
1118
Christopher Fauleta7b677c2018-11-29 16:48:49 +01001119REGISTER_CONFIG_POSTPARSER("http_htx", http_htx_init);
Christopher Faulet58857752020-01-15 15:19:50 +01001120REGISTER_POST_DEINIT(http_htx_deinit);
Christopher Faulet29f72842019-12-11 15:52:32 +01001121
Christopher Faulet58857752020-01-15 15:19:50 +01001122/* Reads content of the error file <file> and convert it into an HTX message. On
1123 * success, the HTX message is returned. On error, NULL is returned and an error
1124 * message is written into the <errmsg> buffer.
Christopher Faulet5031ef52020-01-15 11:22:07 +01001125 */
Christopher Faulet58857752020-01-15 15:19:50 +01001126struct buffer *http_load_errorfile(const char *file, char **errmsg)
Christopher Faulet5031ef52020-01-15 11:22:07 +01001127{
Christopher Faulet58857752020-01-15 15:19:50 +01001128 struct buffer *buf = NULL;
1129 struct buffer chk;
1130 struct ebpt_node *node;
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001131 struct http_error_msg *http_errmsg;
Christopher Faulet5031ef52020-01-15 11:22:07 +01001132 struct stat stat;
1133 char *err = NULL;
1134 int errnum, errlen;
1135 int fd = -1;
Christopher Faulet58857752020-01-15 15:19:50 +01001136
1137 /* already loaded */
1138 node = ebis_lookup_len(&http_error_messages, file, strlen(file));
1139 if (node) {
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001140 http_errmsg = container_of(node, typeof(*http_errmsg), node);
1141 buf = &http_errmsg->msg;
Christopher Faulet58857752020-01-15 15:19:50 +01001142 goto out;
1143 }
Christopher Faulet5031ef52020-01-15 11:22:07 +01001144
Christopher Faulet58857752020-01-15 15:19:50 +01001145 /* Read the error file content */
Christopher Faulet5031ef52020-01-15 11:22:07 +01001146 fd = open(file, O_RDONLY);
1147 if ((fd < 0) || (fstat(fd, &stat) < 0)) {
1148 memprintf(errmsg, "error opening file '%s'.", file);
1149 goto out;
1150 }
1151
1152 if (stat.st_size <= global.tune.bufsize)
1153 errlen = stat.st_size;
1154 else {
1155 ha_warning("custom error message file '%s' larger than %d bytes. Truncating.\n",
1156 file, global.tune.bufsize);
1157 errlen = global.tune.bufsize;
1158 }
1159
1160 err = malloc(errlen);
1161 if (!err) {
1162 memprintf(errmsg, "out of memory.");
1163 goto out;
1164 }
1165
1166 errnum = read(fd, err, errlen);
1167 if (errnum != errlen) {
1168 memprintf(errmsg, "error reading file '%s'.", file);
1169 goto out;
1170 }
1171
Christopher Faulet58857752020-01-15 15:19:50 +01001172 /* Create the node corresponding to the error file */
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001173 http_errmsg = calloc(1, sizeof(*http_errmsg));
1174 if (!http_errmsg) {
Christopher Faulet58857752020-01-15 15:19:50 +01001175 memprintf(errmsg, "out of memory.");
1176 goto out;
1177 }
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001178 http_errmsg->node.key = strdup(file);
1179 if (!http_errmsg->node.key) {
Christopher Faulet58857752020-01-15 15:19:50 +01001180 memprintf(errmsg, "out of memory.");
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001181 free(http_errmsg);
Christopher Faulet58857752020-01-15 15:19:50 +01001182 goto out;
1183 }
1184
1185 /* Convert the error file into an HTX message */
Christopher Fauleta66adf42020-11-05 22:43:41 +01001186 if (!http_str_to_htx(&chk, ist2(err, errlen), errmsg)) {
1187 memprintf(errmsg, "'%s': %s", file, *errmsg);
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001188 free(http_errmsg->node.key);
1189 free(http_errmsg);
Christopher Faulet5031ef52020-01-15 11:22:07 +01001190 goto out;
1191 }
1192
Christopher Faulet58857752020-01-15 15:19:50 +01001193 /* Insert the node in the tree and return the HTX message */
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001194 http_errmsg->msg = chk;
1195 ebis_insert(&http_error_messages, &http_errmsg->node);
1196 buf = &http_errmsg->msg;
Christopher Faulet58857752020-01-15 15:19:50 +01001197
Christopher Faulet5031ef52020-01-15 11:22:07 +01001198 out:
1199 if (fd >= 0)
1200 close(fd);
1201 free(err);
Christopher Faulet58857752020-01-15 15:19:50 +01001202 return buf;
Christopher Faulet5031ef52020-01-15 11:22:07 +01001203}
1204
Ilya Shipitsind4259502020-04-08 01:07:56 +05001205/* Convert the raw http message <msg> into an HTX message. On success, the HTX
Christopher Faulet58857752020-01-15 15:19:50 +01001206 * message is returned. On error, NULL is returned and an error message is
1207 * written into the <errmsg> buffer.
Christopher Fauletbdf65262020-01-16 15:51:59 +01001208 */
Christopher Faulet58857752020-01-15 15:19:50 +01001209struct buffer *http_load_errormsg(const char *key, const struct ist msg, char **errmsg)
Christopher Fauletbdf65262020-01-16 15:51:59 +01001210{
Christopher Faulet58857752020-01-15 15:19:50 +01001211 struct buffer *buf = NULL;
1212 struct buffer chk;
1213 struct ebpt_node *node;
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001214 struct http_error_msg *http_errmsg;
Christopher Faulet58857752020-01-15 15:19:50 +01001215
1216 /* already loaded */
1217 node = ebis_lookup_len(&http_error_messages, key, strlen(key));
1218 if (node) {
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001219 http_errmsg = container_of(node, typeof(*http_errmsg), node);
1220 buf = &http_errmsg->msg;
Christopher Faulet58857752020-01-15 15:19:50 +01001221 goto out;
1222 }
1223 /* Create the node corresponding to the error file */
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001224 http_errmsg = calloc(1, sizeof(*http_errmsg));
1225 if (!http_errmsg) {
Christopher Faulet58857752020-01-15 15:19:50 +01001226 memprintf(errmsg, "out of memory.");
1227 goto out;
1228 }
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001229 http_errmsg->node.key = strdup(key);
1230 if (!http_errmsg->node.key) {
Christopher Faulet58857752020-01-15 15:19:50 +01001231 memprintf(errmsg, "out of memory.");
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001232 free(http_errmsg);
Christopher Faulet58857752020-01-15 15:19:50 +01001233 goto out;
1234 }
Christopher Fauletbdf65262020-01-16 15:51:59 +01001235
1236 /* Convert the error file into an HTX message */
Christopher Fauleta66adf42020-11-05 22:43:41 +01001237 if (!http_str_to_htx(&chk, msg, errmsg)) {
1238 memprintf(errmsg, "invalid error message: %s", *errmsg);
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001239 free(http_errmsg->node.key);
1240 free(http_errmsg);
Christopher Fauletbdf65262020-01-16 15:51:59 +01001241 goto out;
1242 }
Christopher Fauletbdf65262020-01-16 15:51:59 +01001243
Christopher Faulet58857752020-01-15 15:19:50 +01001244 /* Insert the node in the tree and return the HTX message */
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02001245 http_errmsg->msg = chk;
1246 ebis_insert(&http_error_messages, &http_errmsg->node);
1247 buf = &http_errmsg->msg;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001248 out:
Christopher Faulet58857752020-01-15 15:19:50 +01001249 return buf;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001250}
1251
Christopher Faulet5031ef52020-01-15 11:22:07 +01001252/* This function parses the raw HTTP error file <file> for the status code
Christopher Faulet58857752020-01-15 15:19:50 +01001253 * <status>. It returns NULL if there is any error, otherwise it return the
1254 * corresponding HTX message.
Christopher Faulet5031ef52020-01-15 11:22:07 +01001255 */
Christopher Faulet58857752020-01-15 15:19:50 +01001256struct buffer *http_parse_errorfile(int status, const char *file, char **errmsg)
Christopher Faulet5031ef52020-01-15 11:22:07 +01001257{
Christopher Faulet58857752020-01-15 15:19:50 +01001258 struct buffer *buf = NULL;
1259 int rc;
Christopher Faulet5031ef52020-01-15 11:22:07 +01001260
1261 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
1262 if (http_err_codes[rc] == status) {
Christopher Faulet58857752020-01-15 15:19:50 +01001263 buf = http_load_errorfile(file, errmsg);
Christopher Faulet5031ef52020-01-15 11:22:07 +01001264 break;
1265 }
1266 }
1267
1268 if (rc >= HTTP_ERR_SIZE)
1269 memprintf(errmsg, "status code '%d' not handled.", status);
Christopher Faulet58857752020-01-15 15:19:50 +01001270 return buf;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001271}
1272
1273/* This function creates HTX error message corresponding to a redirect message
1274 * for the status code <status>. <url> is used as location url for the
Christopher Faulet58857752020-01-15 15:19:50 +01001275 * redirect. <errloc> is used to know if it is a 302 or a 303 redirect. It
1276 * returns NULL if there is any error, otherwise it return the corresponding HTX
1277 * message.
Christopher Fauletbdf65262020-01-16 15:51:59 +01001278 */
Christopher Faulet58857752020-01-15 15:19:50 +01001279struct buffer *http_parse_errorloc(int errloc, int status, const char *url, char **errmsg)
Christopher Fauletbdf65262020-01-16 15:51:59 +01001280{
Christopher Faulet0bac4cd2020-05-27 10:11:59 +02001281 static const char *HTTP_302 =
1282 "HTTP/1.1 302 Found\r\n"
1283 "Cache-Control: no-cache\r\n"
1284 "Content-length: 0\r\n"
1285 "Location: "; /* not terminated since it will be concatenated with the URL */
1286 static const char *HTTP_303 =
1287 "HTTP/1.1 303 See Other\r\n"
1288 "Cache-Control: no-cache\r\n"
1289 "Content-length: 0\r\n"
1290 "Location: "; /* not terminated since it will be concatenated with the URL */
1291
Christopher Faulet58857752020-01-15 15:19:50 +01001292 struct buffer *buf = NULL;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001293 const char *msg;
Christopher Faulet58857752020-01-15 15:19:50 +01001294 char *key = NULL, *err = NULL;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001295 int rc, errlen;
Christopher Fauletbdf65262020-01-16 15:51:59 +01001296
1297 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
1298 if (http_err_codes[rc] == status) {
Christopher Faulet58857752020-01-15 15:19:50 +01001299 /* Create the error key */
1300 if (!memprintf(&key, "errorloc%d %s", errloc, url)) {
1301 memprintf(errmsg, "out of memory.");
1302 goto out;
1303 }
Christopher Fauletbdf65262020-01-16 15:51:59 +01001304 /* Create the error message */
1305 msg = (errloc == 302 ? HTTP_302 : HTTP_303);
1306 errlen = strlen(msg) + strlen(url) + 5;
1307 err = malloc(errlen);
1308 if (!err) {
1309 memprintf(errmsg, "out of memory.");
1310 goto out;
1311 }
1312 errlen = snprintf(err, errlen, "%s%s\r\n\r\n", msg, url);
1313
1314 /* Load it */
Christopher Faulet58857752020-01-15 15:19:50 +01001315 buf = http_load_errormsg(key, ist2(err, errlen), errmsg);
Christopher Fauletbdf65262020-01-16 15:51:59 +01001316 break;
1317 }
1318 }
1319
1320 if (rc >= HTTP_ERR_SIZE)
1321 memprintf(errmsg, "status code '%d' not handled.", status);
1322out:
Christopher Faulet58857752020-01-15 15:19:50 +01001323 free(key);
Christopher Fauletbdf65262020-01-16 15:51:59 +01001324 free(err);
Christopher Faulet58857752020-01-15 15:19:50 +01001325 return buf;
Christopher Faulet5031ef52020-01-15 11:22:07 +01001326}
1327
Christopher Faulet7eea2412020-05-13 15:02:59 +02001328/* Check an "http reply" and, for replies referencing an http-errors section,
1329 * try to find the right section and the right error message in this section. If
1330 * found, the reply is updated. If the http-errors section exists but the error
1331 * message is not found, no error message is set to fallback on the default
1332 * ones. Otherwise (unknown section) an error is returned.
1333 *
1334 * The function returns 1 in success case, otherwise, it returns 0 and errmsg is
1335 * filled.
1336 */
1337int http_check_http_reply(struct http_reply *reply, struct proxy *px, char **errmsg)
1338{
1339 struct http_errors *http_errs;
1340 int ret = 1;
1341
1342 if (reply->type != HTTP_REPLY_ERRFILES)
1343 goto end;
1344
1345 list_for_each_entry(http_errs, &http_errors_list, list) {
1346 if (strcmp(http_errs->id, reply->body.http_errors) == 0) {
Christopher Faulete29a97e2020-05-14 14:49:25 +02001347 reply->type = HTTP_REPLY_INDIRECT;
Christopher Faulet7eea2412020-05-13 15:02:59 +02001348 free(reply->body.http_errors);
Christopher Faulete29a97e2020-05-14 14:49:25 +02001349 reply->body.reply = http_errs->replies[http_get_status_idx(reply->status)];
1350 if (!reply->body.reply)
Christopher Faulet7eea2412020-05-13 15:02:59 +02001351 ha_warning("Proxy '%s': status '%d' referenced by an http reply "
1352 "not declared in http-errors section '%s'.\n",
1353 px->id, reply->status, http_errs->id);
1354 break;
1355 }
1356 }
1357
1358 if (&http_errs->list == &http_errors_list) {
1359 memprintf(errmsg, "unknown http-errors section '%s' referenced by an http reply ",
1360 reply->body.http_errors);
1361 ret = 0;
1362 }
1363
1364 end:
1365 return ret;
1366}
1367
Christopher Faulet47e791e2020-05-13 14:36:55 +02001368/* Parse an "http reply". It returns the reply on success or NULL on error. This
1369 * function creates one of the following http replies :
1370 *
1371 * - HTTP_REPLY_EMPTY : dummy response, no payload
1372 * - HTTP_REPLY_ERRMSG : implicit error message depending on the status code or explicit one
1373 * - HTTP_REPLY_ERRFILES : points on an http-errors section (resolved during post-parsing)
1374 * - HTTP_REPLY_RAW : explicit file object ('file' argument)
1375 * - HTTP_REPLY_LOGFMT : explicit log-format string ('content' argument)
1376 *
1377 * The content-type must be defined for non-empty payload. It is ignored for
1378 * error messages (implicit or explicit). When an http-errors section is
1379 * referenced (HTTP_REPLY_ERRFILES), the real error message should be resolved
1380 * during the configuration validity check or dynamically. It is the caller
1381 * responsibility to choose. If no status code is configured, <default_status>
1382 * is set.
1383 */
1384struct http_reply *http_parse_http_reply(const char **args, int *orig_arg, struct proxy *px,
1385 int default_status, char **errmsg)
1386{
1387 struct logformat_node *lf, *lfb;
1388 struct http_reply *reply = NULL;
1389 struct http_reply_hdr *hdr, *hdrb;
1390 struct stat stat;
1391 const char *act_arg = NULL;
1392 char *obj = NULL;
Christopher Faulet7a06ffb2021-10-13 17:22:17 +02001393 int cur_arg, cap = 0, objlen = 0, fd = -1;
Christopher Faulet47e791e2020-05-13 14:36:55 +02001394
1395
1396 reply = calloc(1, sizeof(*reply));
1397 if (!reply) {
1398 memprintf(errmsg, "out of memory");
1399 goto error;
1400 }
1401 LIST_INIT(&reply->hdrs);
1402 reply->type = HTTP_REPLY_EMPTY;
1403 reply->status = default_status;
1404
Christopher Faulet3b967c12020-05-15 15:47:44 +02001405 if (px->conf.args.ctx == ARGC_HERR)
1406 cap = (SMP_VAL_REQUEST | SMP_VAL_RESPONSE);
Christopher Faulet7a06ffb2021-10-13 17:22:17 +02001407 else {
1408 if (px->cap & PR_CAP_FE)
1409 cap |= ((px->conf.args.ctx == ARGC_HRQ) ? SMP_VAL_FE_HRQ_HDR : SMP_VAL_FE_HRS_HDR);
1410 if (px->cap & PR_CAP_BE)
Willy Tarreaub39e47a2021-10-16 14:41:09 +02001411 cap |= ((px->conf.args.ctx == ARGC_HRQ) ? SMP_VAL_BE_HRQ_HDR : SMP_VAL_BE_HRS_HDR);
Christopher Faulet7a06ffb2021-10-13 17:22:17 +02001412 }
Christopher Faulet47e791e2020-05-13 14:36:55 +02001413
1414 cur_arg = *orig_arg;
1415 while (*args[cur_arg]) {
1416 if (strcmp(args[cur_arg], "status") == 0) {
1417 cur_arg++;
1418 if (!*args[cur_arg]) {
1419 memprintf(errmsg, "'%s' expects <status_code> as argument", args[cur_arg-1]);
1420 goto error;
1421 }
1422 reply->status = atol(args[cur_arg]);
1423 if (reply->status < 200 || reply->status > 599) {
1424 memprintf(errmsg, "Unexpected status code '%d'", reply->status);
1425 goto error;
1426 }
1427 cur_arg++;
1428 }
1429 else if (strcmp(args[cur_arg], "content-type") == 0) {
1430 cur_arg++;
1431 if (!*args[cur_arg]) {
1432 memprintf(errmsg, "'%s' expects <ctype> as argument", args[cur_arg-1]);
1433 goto error;
1434 }
1435 free(reply->ctype);
1436 reply->ctype = strdup(args[cur_arg]);
1437 cur_arg++;
1438 }
1439 else if (strcmp(args[cur_arg], "errorfiles") == 0) {
1440 if (reply->type != HTTP_REPLY_EMPTY) {
1441 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1442 goto error;
1443 }
1444 act_arg = args[cur_arg];
1445 cur_arg++;
1446 if (!*args[cur_arg]) {
1447 memprintf(errmsg, "'%s' expects <name> as argument", args[cur_arg-1]);
1448 goto error;
1449 }
1450 reply->body.http_errors = strdup(args[cur_arg]);
1451 if (!reply->body.http_errors) {
1452 memprintf(errmsg, "out of memory");
1453 goto error;
1454 }
1455 reply->type = HTTP_REPLY_ERRFILES;
1456 cur_arg++;
1457 }
1458 else if (strcmp(args[cur_arg], "default-errorfiles") == 0) {
1459 if (reply->type != HTTP_REPLY_EMPTY) {
1460 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1461 goto error;
1462 }
1463 act_arg = args[cur_arg];
1464 reply->type = HTTP_REPLY_ERRMSG;
1465 cur_arg++;
1466 }
1467 else if (strcmp(args[cur_arg], "errorfile") == 0) {
1468 if (reply->type != HTTP_REPLY_EMPTY) {
1469 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1470 goto error;
1471 }
1472 act_arg = args[cur_arg];
1473 cur_arg++;
1474 if (!*args[cur_arg]) {
1475 memprintf(errmsg, "'%s' expects <fmt> as argument", args[cur_arg-1]);
1476 goto error;
1477 }
1478 reply->body.errmsg = http_load_errorfile(args[cur_arg], errmsg);
1479 if (!reply->body.errmsg) {
1480 goto error;
1481 }
1482 reply->type = HTTP_REPLY_ERRMSG;
1483 cur_arg++;
1484 }
1485 else if (strcmp(args[cur_arg], "file") == 0) {
1486 if (reply->type != HTTP_REPLY_EMPTY) {
1487 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1488 goto error;
1489 }
1490 act_arg = args[cur_arg];
1491 cur_arg++;
1492 if (!*args[cur_arg]) {
1493 memprintf(errmsg, "'%s' expects <file> as argument", args[cur_arg-1]);
1494 goto error;
1495 }
1496 fd = open(args[cur_arg], O_RDONLY);
1497 if ((fd < 0) || (fstat(fd, &stat) < 0)) {
1498 memprintf(errmsg, "error opening file '%s'", args[cur_arg]);
1499 goto error;
1500 }
1501 if (stat.st_size > global.tune.bufsize) {
1502 memprintf(errmsg, "file '%s' exceeds the buffer size (%lld > %d)",
1503 args[cur_arg], (long long)stat.st_size, global.tune.bufsize);
1504 goto error;
1505 }
1506 objlen = stat.st_size;
1507 obj = malloc(objlen);
1508 if (!obj || read(fd, obj, objlen) != objlen) {
1509 memprintf(errmsg, "error reading file '%s'", args[cur_arg]);
1510 goto error;
1511 }
1512 close(fd);
1513 fd = -1;
1514 reply->type = HTTP_REPLY_RAW;
1515 chunk_initlen(&reply->body.obj, obj, global.tune.bufsize, objlen);
1516 obj = NULL;
1517 cur_arg++;
1518 }
1519 else if (strcmp(args[cur_arg], "string") == 0) {
1520 if (reply->type != HTTP_REPLY_EMPTY) {
1521 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1522 goto error;
1523 }
1524 act_arg = args[cur_arg];
1525 cur_arg++;
1526 if (!*args[cur_arg]) {
1527 memprintf(errmsg, "'%s' expects <str> as argument", args[cur_arg-1]);
1528 goto error;
1529 }
1530 obj = strdup(args[cur_arg]);
1531 objlen = strlen(args[cur_arg]);
1532 if (!obj) {
1533 memprintf(errmsg, "out of memory");
1534 goto error;
1535 }
1536 reply->type = HTTP_REPLY_RAW;
1537 chunk_initlen(&reply->body.obj, obj, global.tune.bufsize, objlen);
1538 obj = NULL;
1539 cur_arg++;
1540 }
1541 else if (strcmp(args[cur_arg], "lf-file") == 0) {
1542 if (reply->type != HTTP_REPLY_EMPTY) {
1543 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1544 goto error;
1545 }
1546 act_arg = args[cur_arg];
1547 cur_arg++;
1548 if (!*args[cur_arg]) {
1549 memprintf(errmsg, "'%s' expects <file> as argument", args[cur_arg-1]);
1550 goto error;
1551 }
1552 fd = open(args[cur_arg], O_RDONLY);
1553 if ((fd < 0) || (fstat(fd, &stat) < 0)) {
1554 memprintf(errmsg, "error opening file '%s'", args[cur_arg]);
1555 goto error;
1556 }
1557 if (stat.st_size > global.tune.bufsize) {
1558 memprintf(errmsg, "file '%s' exceeds the buffer size (%lld > %d)",
1559 args[cur_arg], (long long)stat.st_size, global.tune.bufsize);
1560 goto error;
1561 }
1562 objlen = stat.st_size;
1563 obj = malloc(objlen + 1);
1564 if (!obj || read(fd, obj, objlen) != objlen) {
1565 memprintf(errmsg, "error reading file '%s'", args[cur_arg]);
1566 goto error;
1567 }
1568 close(fd);
1569 fd = -1;
1570 obj[objlen] = '\0';
1571 reply->type = HTTP_REPLY_LOGFMT;
1572 cur_arg++;
1573 }
1574 else if (strcmp(args[cur_arg], "lf-string") == 0) {
1575 if (reply->type != HTTP_REPLY_EMPTY) {
1576 memprintf(errmsg, "unexpected '%s' argument, '%s' already defined", args[cur_arg], act_arg);
1577 goto error;
1578 }
1579 act_arg = args[cur_arg];
1580 cur_arg++;
1581 if (!*args[cur_arg]) {
1582 memprintf(errmsg, "'%s' expects <fmt> as argument", args[cur_arg-1]);
1583 goto error;
1584 }
1585 obj = strdup(args[cur_arg]);
1586 objlen = strlen(args[cur_arg]);
1587 reply->type = HTTP_REPLY_LOGFMT;
1588 cur_arg++;
1589 }
1590 else if (strcmp(args[cur_arg], "hdr") == 0) {
1591 cur_arg++;
1592 if (!*args[cur_arg] || !*args[cur_arg+1]) {
1593 memprintf(errmsg, "'%s' expects <name> and <value> as arguments", args[cur_arg-1]);
1594 goto error;
1595 }
1596 if (strcasecmp(args[cur_arg], "content-length") == 0 ||
1597 strcasecmp(args[cur_arg], "transfer-encoding") == 0 ||
1598 strcasecmp(args[cur_arg], "content-type") == 0) {
1599 ha_warning("parsing [%s:%d] : header '%s' always ignored by the http reply.\n",
1600 px->conf.args.file, px->conf.args.line, args[cur_arg]);
1601 cur_arg += 2;
1602 continue;
1603 }
1604 hdr = calloc(1, sizeof(*hdr));
1605 if (!hdr) {
1606 memprintf(errmsg, "'%s' : out of memory", args[cur_arg-1]);
1607 goto error;
1608 }
Willy Tarreau2b718102021-04-21 07:32:39 +02001609 LIST_APPEND(&reply->hdrs, &hdr->list);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001610 LIST_INIT(&hdr->value);
1611 hdr->name = ist(strdup(args[cur_arg]));
1612 if (!isttest(hdr->name)) {
1613 memprintf(errmsg, "out of memory");
1614 goto error;
1615 }
Christopher Faulet47e791e2020-05-13 14:36:55 +02001616 if (!parse_logformat_string(args[cur_arg+1], px, &hdr->value, LOG_OPT_HTTP, cap, errmsg))
1617 goto error;
1618
1619 free(px->conf.lfs_file);
1620 px->conf.lfs_file = strdup(px->conf.args.file);
1621 px->conf.lfs_line = px->conf.args.line;
1622 cur_arg += 2;
1623 }
1624 else
1625 break;
1626 }
1627
1628 if (reply->type == HTTP_REPLY_EMPTY) { /* no payload */
1629 if (reply->ctype) {
1630 ha_warning("parsing [%s:%d] : content-type '%s' ignored by the http reply because"
1631 " neither errorfile nor payload defined.\n",
1632 px->conf.args.file, px->conf.args.line, reply->ctype);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001633 ha_free(&reply->ctype);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001634 }
1635 }
1636 else if (reply->type == HTTP_REPLY_ERRFILES || reply->type == HTTP_REPLY_ERRMSG) { /* errorfiles or errorfile */
1637
1638 if (reply->type != HTTP_REPLY_ERRMSG || !reply->body.errmsg) {
1639 /* default errorfile or errorfiles: check the status */
1640 int rc;
1641
1642 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
1643 if (http_err_codes[rc] == reply->status)
1644 break;
1645 }
1646
1647 if (rc >= HTTP_ERR_SIZE) {
1648 memprintf(errmsg, "status code '%d' not handled by default with '%s' argument.",
1649 reply->status, act_arg);
1650 goto error;
1651 }
1652 }
1653
1654 if (reply->ctype) {
1655 ha_warning("parsing [%s:%d] : content-type '%s' ignored by the http reply when used "
1656 "with an erorrfile.\n",
1657 px->conf.args.file, px->conf.args.line, reply->ctype);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001658 ha_free(&reply->ctype);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001659 }
1660 if (!LIST_ISEMPTY(&reply->hdrs)) {
1661 ha_warning("parsing [%s:%d] : hdr parameters ignored by the http reply when used "
1662 "with an erorrfile.\n",
1663 px->conf.args.file, px->conf.args.line);
1664 list_for_each_entry_safe(hdr, hdrb, &reply->hdrs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001665 LIST_DELETE(&hdr->list);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001666 list_for_each_entry_safe(lf, lfb, &hdr->value, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001667 LIST_DELETE(&lf->list);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001668 release_sample_expr(lf->expr);
1669 free(lf->arg);
1670 free(lf);
1671 }
1672 istfree(&hdr->name);
1673 free(hdr);
1674 }
1675 }
1676 }
1677 else if (reply->type == HTTP_REPLY_RAW) { /* explicit parameter using 'file' parameter*/
Christopher Fauletb8d148a2020-10-09 08:50:26 +02001678 if ((reply->status == 204 || reply->status == 304) && objlen) {
1679 memprintf(errmsg, "No body expected for %d responses", reply->status);
1680 goto error;
1681 }
Christopher Faulet47e791e2020-05-13 14:36:55 +02001682 if (!reply->ctype && objlen) {
1683 memprintf(errmsg, "a content type must be defined when non-empty payload is configured");
1684 goto error;
1685 }
1686 if (reply->ctype && !b_data(&reply->body.obj)) {
1687 ha_warning("parsing [%s:%d] : content-type '%s' ignored by the http reply when used "
Ilya Shipitsin47d17182020-06-21 21:42:57 +05001688 "with an empty payload.\n",
Christopher Faulet47e791e2020-05-13 14:36:55 +02001689 px->conf.args.file, px->conf.args.line, reply->ctype);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001690 ha_free(&reply->ctype);
Christopher Faulet47e791e2020-05-13 14:36:55 +02001691 }
1692 if (b_room(&reply->body.obj) < global.tune.maxrewrite) {
1693 ha_warning("parsing [%s:%d] : http reply payload runs over the buffer space reserved to headers rewriting."
1694 " It may lead to internal errors if strict rewriting mode is enabled.\n",
1695 px->conf.args.file, px->conf.args.line);
1696 }
1697 }
1698 else if (reply->type == HTTP_REPLY_LOGFMT) { /* log-format payload using 'lf-file' of 'lf-string' parameter */
1699 LIST_INIT(&reply->body.fmt);
Christopher Fauletb8d148a2020-10-09 08:50:26 +02001700 if ((reply->status == 204 || reply->status == 304)) {
1701 memprintf(errmsg, "No body expected for %d responses", reply->status);
1702 goto error;
1703 }
Christopher Faulet47e791e2020-05-13 14:36:55 +02001704 if (!reply->ctype) {
1705 memprintf(errmsg, "a content type must be defined with a log-format payload");
1706 goto error;
1707 }
1708 if (!parse_logformat_string(obj, px, &reply->body.fmt, LOG_OPT_HTTP, cap, errmsg))
1709 goto error;
1710
1711 free(px->conf.lfs_file);
1712 px->conf.lfs_file = strdup(px->conf.args.file);
1713 px->conf.lfs_line = px->conf.args.line;
1714 }
1715
1716 free(obj);
1717 *orig_arg = cur_arg;
1718 return reply;
1719
1720 error:
1721 free(obj);
1722 if (fd >= 0)
1723 close(fd);
1724 release_http_reply(reply);
1725 return NULL;
1726}
1727
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001728static int uri_is_default_port(const struct ist scheme, const struct ist port)
1729{
1730 return (isteq(port, ist("443")) && isteqi(scheme, ist("https://"))) ||
1731 (isteq(port, ist("80")) && isteqi(scheme, ist("http://")));
1732}
1733
1734/* Apply schemed-based normalization as described on rfc3986 on section 6.3.2.
1735 * Returns 0 if no error has been found else non-zero.
1736 *
1737 * The normalization is processed on the target-uri at the condition that it is
1738 * in absolute-form. In the case where the target-uri was normalized, every
1739 * host headers values found are also replaced by the normalized hostname. This
1740 * assumes that the target-uri and host headers were properly identify as
1741 * similar before calling this function.
1742 */
1743int http_scheme_based_normalize(struct htx *htx)
1744{
1745 struct http_hdr_ctx ctx;
1746 struct htx_sl *sl;
1747 struct ist uri, scheme, authority, host, port;
1748 char *start, *end, *ptr;
Amaury Denoyelle8ac8cbf2021-07-06 10:52:58 +02001749 struct http_uri_parser parser;
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001750
1751 sl = http_get_stline(htx);
1752
1753 if (!sl || !(sl->flags & (HTX_SL_F_HAS_SCHM|HTX_SL_F_HAS_AUTHORITY)))
1754 return 0;
1755
1756 uri = htx_sl_req_uri(sl);
1757
Amaury Denoyelle8ac8cbf2021-07-06 10:52:58 +02001758 parser = http_uri_parser_init(uri);
1759 scheme = http_parse_scheme(&parser);
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001760 /* if no scheme found, no normalization to proceed */
1761 if (!isttest(scheme))
1762 return 0;
1763
1764 /* Extract the port if present in authority. To properly support ipv6
1765 * hostnames, do a reverse search on the last ':' separator as long as
1766 * digits are found.
1767 */
Amaury Denoyelle69294b22021-07-06 11:02:22 +02001768 authority = http_parse_authority(&parser, 0);
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001769 start = istptr(authority);
1770 end = istend(authority);
Amaury Denoyelle164ae4a2021-07-07 17:17:39 +02001771 for (ptr = end; ptr > start && isdigit((unsigned char)*--ptr); )
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001772 ;
1773
1774 /* if no port found, no normalization to proceed */
1775 if (likely(*ptr != ':'))
1776 return 0;
1777
1778 /* split host/port on the ':' separator found */
1779 host = ist2(start, ptr - start);
1780 port = istnext(ist2(ptr, end - ptr));
1781
1782 if (istlen(port) && uri_is_default_port(scheme, port)) {
1783 /* reconstruct the uri with removal of the port */
1784 struct buffer *temp = get_trash_chunk();
1785 struct ist meth, vsn, path;
1786
1787 /* meth */
1788 chunk_memcat(temp, HTX_SL_REQ_MPTR(sl), HTX_SL_REQ_MLEN(sl));
1789 meth = ist2(temp->area, HTX_SL_REQ_MLEN(sl));
1790
1791 /* vsn */
1792 chunk_memcat(temp, HTX_SL_REQ_VPTR(sl), HTX_SL_REQ_VLEN(sl));
1793 vsn = ist2(temp->area + meth.len, HTX_SL_REQ_VLEN(sl));
1794
1795 /* reconstruct uri without port */
Amaury Denoyellec453f952021-07-06 11:40:12 +02001796 path = http_parse_path(&parser);
Amaury Denoyelle4c0882b2021-07-07 10:49:26 +02001797 chunk_istcat(temp, scheme);
1798 chunk_istcat(temp, host);
1799 chunk_istcat(temp, path);
1800 uri = ist2(temp->area + meth.len + vsn.len,
1801 scheme.len + host.len + path.len);
1802
1803 http_replace_stline(htx, meth, uri, vsn);
1804
1805 /* replace every host headers values by the normalized host */
1806 ctx.blk = NULL;
1807 while (http_find_header(htx, ist("host"), &ctx, 0)) {
1808 if (!http_replace_header_value(htx, &ctx, host))
1809 goto fail;
1810 }
1811 }
1812
1813 return 0;
1814
1815 fail:
1816 return 1;
1817}
1818
Christopher Faulet07f41f72020-01-16 16:16:06 +01001819/* Parses the "errorloc[302|303]" proxy keyword */
1820static int proxy_parse_errorloc(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +01001821 const struct proxy *defpx, const char *file, int line,
Christopher Faulet07f41f72020-01-16 16:16:06 +01001822 char **errmsg)
1823{
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001824 struct conf_errors *conf_err;
Christopher Faulet5809e102020-05-14 17:31:52 +02001825 struct http_reply *reply;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001826 struct buffer *msg;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001827 int errloc, status;
1828 int ret = 0;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001829
1830 if (warnifnotcap(curpx, PR_CAP_FE | PR_CAP_BE, file, line, args[0], NULL)) {
1831 ret = 1;
1832 goto out;
1833 }
1834
1835 if (*(args[1]) == 0 || *(args[2]) == 0) {
1836 memprintf(errmsg, "%s : expects <status_code> and <url> as arguments.\n", args[0]);
1837 ret = -1;
1838 goto out;
1839 }
1840
1841 status = atol(args[1]);
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001842 errloc = (strcmp(args[0], "errorloc303") == 0 ? 303 : 302);
Christopher Faulet07f41f72020-01-16 16:16:06 +01001843 msg = http_parse_errorloc(errloc, status, args[2], errmsg);
1844 if (!msg) {
1845 memprintf(errmsg, "%s : %s", args[0], *errmsg);
1846 ret = -1;
1847 goto out;
1848 }
Christopher Faulet5809e102020-05-14 17:31:52 +02001849
1850 reply = calloc(1, sizeof(*reply));
1851 if (!reply) {
1852 memprintf(errmsg, "%s : out of memory.", args[0]);
1853 ret = -1;
1854 goto out;
1855 }
1856 reply->type = HTTP_REPLY_ERRMSG;
1857 reply->status = status;
1858 reply->ctype = NULL;
1859 LIST_INIT(&reply->hdrs);
1860 reply->body.errmsg = msg;
Willy Tarreau2b718102021-04-21 07:32:39 +02001861 LIST_APPEND(&http_replies_list, &reply->list);
Christopher Faulet07f41f72020-01-16 16:16:06 +01001862
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001863 conf_err = calloc(1, sizeof(*conf_err));
1864 if (!conf_err) {
1865 memprintf(errmsg, "%s : out of memory.", args[0]);
Christopher Faulet5809e102020-05-14 17:31:52 +02001866 free(reply);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001867 ret = -1;
1868 goto out;
1869 }
1870 conf_err->type = 1;
1871 conf_err->info.errorfile.status = status;
Christopher Faulet5809e102020-05-14 17:31:52 +02001872 conf_err->info.errorfile.reply = reply;
1873
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001874 conf_err->file = strdup(file);
1875 conf_err->line = line;
Willy Tarreau2b718102021-04-21 07:32:39 +02001876 LIST_APPEND(&curpx->conf.errors, &conf_err->list);
Christopher Faulet07f41f72020-01-16 16:16:06 +01001877
Christopher Fauleta66adf42020-11-05 22:43:41 +01001878 /* handle warning message */
1879 if (*errmsg)
1880 ret = 1;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001881 out:
1882 return ret;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001883
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001884}
Christopher Faulet07f41f72020-01-16 16:16:06 +01001885
1886/* Parses the "errorfile" proxy keyword */
1887static int proxy_parse_errorfile(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +01001888 const struct proxy *defpx, const char *file, int line,
Christopher Faulet07f41f72020-01-16 16:16:06 +01001889 char **errmsg)
1890{
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001891 struct conf_errors *conf_err;
Christopher Faulet5809e102020-05-14 17:31:52 +02001892 struct http_reply *reply;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001893 struct buffer *msg;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001894 int status;
1895 int ret = 0;
Christopher Faulet07f41f72020-01-16 16:16:06 +01001896
1897 if (warnifnotcap(curpx, PR_CAP_FE | PR_CAP_BE, file, line, args[0], NULL)) {
1898 ret = 1;
1899 goto out;
1900 }
1901
1902 if (*(args[1]) == 0 || *(args[2]) == 0) {
1903 memprintf(errmsg, "%s : expects <status_code> and <file> as arguments.\n", args[0]);
1904 ret = -1;
1905 goto out;
1906 }
1907
1908 status = atol(args[1]);
1909 msg = http_parse_errorfile(status, args[2], errmsg);
1910 if (!msg) {
1911 memprintf(errmsg, "%s : %s", args[0], *errmsg);
1912 ret = -1;
1913 goto out;
1914 }
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001915
Christopher Faulet5809e102020-05-14 17:31:52 +02001916 reply = calloc(1, sizeof(*reply));
1917 if (!reply) {
1918 memprintf(errmsg, "%s : out of memory.", args[0]);
1919 ret = -1;
1920 goto out;
1921 }
1922 reply->type = HTTP_REPLY_ERRMSG;
1923 reply->status = status;
1924 reply->ctype = NULL;
1925 LIST_INIT(&reply->hdrs);
1926 reply->body.errmsg = msg;
Willy Tarreau2b718102021-04-21 07:32:39 +02001927 LIST_APPEND(&http_replies_list, &reply->list);
Christopher Faulet5809e102020-05-14 17:31:52 +02001928
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001929 conf_err = calloc(1, sizeof(*conf_err));
1930 if (!conf_err) {
1931 memprintf(errmsg, "%s : out of memory.", args[0]);
Christopher Faulet5809e102020-05-14 17:31:52 +02001932 free(reply);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001933 ret = -1;
1934 goto out;
1935 }
1936 conf_err->type = 1;
1937 conf_err->info.errorfile.status = status;
Christopher Faulet5809e102020-05-14 17:31:52 +02001938 conf_err->info.errorfile.reply = reply;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001939 conf_err->file = strdup(file);
1940 conf_err->line = line;
Willy Tarreau2b718102021-04-21 07:32:39 +02001941 LIST_APPEND(&curpx->conf.errors, &conf_err->list);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001942
Christopher Fauleta66adf42020-11-05 22:43:41 +01001943 /* handle warning message */
1944 if (*errmsg)
1945 ret = 1;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001946 out:
1947 return ret;
1948
1949}
1950
1951/* Parses the "errorfiles" proxy keyword */
1952static int proxy_parse_errorfiles(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +01001953 const struct proxy *defpx, const char *file, int line,
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001954 char **err)
1955{
1956 struct conf_errors *conf_err = NULL;
1957 char *name = NULL;
1958 int rc, ret = 0;
1959
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])) {
1966 memprintf(err, "%s : expects <name> as argument.", args[0]);
1967 ret = -1;
1968 goto out;
1969 }
1970
1971 name = strdup(args[1]);
1972 conf_err = calloc(1, sizeof(*conf_err));
1973 if (!name || !conf_err) {
1974 memprintf(err, "%s : out of memory.", args[0]);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001975 goto error;
1976 }
1977 conf_err->type = 0;
1978
1979 conf_err->info.errorfiles.name = name;
1980 if (!*(args[2])) {
1981 for (rc = 0; rc < HTTP_ERR_SIZE; rc++)
1982 conf_err->info.errorfiles.status[rc] = 1;
1983 }
1984 else {
1985 int cur_arg, status;
1986 for (cur_arg = 2; *(args[cur_arg]); cur_arg++) {
1987 status = atol(args[cur_arg]);
1988
1989 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
1990 if (http_err_codes[rc] == status) {
1991 conf_err->info.errorfiles.status[rc] = 2;
1992 break;
1993 }
1994 }
1995 if (rc >= HTTP_ERR_SIZE) {
1996 memprintf(err, "%s : status code '%d' not handled.", args[0], status);
Christopher Faulet7cde96c2020-01-21 10:10:11 +01001997 goto error;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001998 }
1999 }
2000 }
2001 conf_err->file = strdup(file);
2002 conf_err->line = line;
Willy Tarreau2b718102021-04-21 07:32:39 +02002003 LIST_APPEND(&curpx->conf.errors, &conf_err->list);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002004 out:
2005 return ret;
2006
2007 error:
2008 free(name);
2009 free(conf_err);
Christopher Faulet7cde96c2020-01-21 10:10:11 +01002010 ret = -1;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002011 goto out;
2012}
2013
Christopher Faulet3b967c12020-05-15 15:47:44 +02002014/* Parses the "http-error" proxy keyword */
2015static int proxy_parse_http_error(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 Faulet3b967c12020-05-15 15:47:44 +02002017 char **errmsg)
2018{
2019 struct conf_errors *conf_err;
2020 struct http_reply *reply = NULL;
2021 int rc, cur_arg, 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 cur_arg = 1;
2029 curpx->conf.args.ctx = ARGC_HERR;
2030 reply = http_parse_http_reply((const char **)args, &cur_arg, curpx, 0, errmsg);
2031 if (!reply) {
2032 memprintf(errmsg, "%s : %s", args[0], *errmsg);
2033 goto error;
2034 }
2035 else if (!reply->status) {
2036 memprintf(errmsg, "%s : expects at least a <status> as arguments.\n", args[0]);
2037 goto error;
2038 }
2039
2040 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
2041 if (http_err_codes[rc] == reply->status)
2042 break;
2043 }
2044
2045 if (rc >= HTTP_ERR_SIZE) {
2046 memprintf(errmsg, "%s: status code '%d' not handled.", args[0], reply->status);
2047 goto error;
2048 }
2049 if (*args[cur_arg]) {
2050 memprintf(errmsg, "%s : unknown keyword '%s'.", args[0], args[cur_arg]);
2051 goto error;
2052 }
2053
2054 conf_err = calloc(1, sizeof(*conf_err));
2055 if (!conf_err) {
2056 memprintf(errmsg, "%s : out of memory.", args[0]);
2057 goto error;
2058 }
2059 if (reply->type == HTTP_REPLY_ERRFILES) {
2060 int rc = http_get_status_idx(reply->status);
2061
2062 conf_err->type = 2;
2063 conf_err->info.errorfiles.name = reply->body.http_errors;
2064 conf_err->info.errorfiles.status[rc] = 2;
2065 reply->body.http_errors = NULL;
2066 release_http_reply(reply);
2067 }
2068 else {
2069 conf_err->type = 1;
2070 conf_err->info.errorfile.status = reply->status;
2071 conf_err->info.errorfile.reply = reply;
Willy Tarreau2b718102021-04-21 07:32:39 +02002072 LIST_APPEND(&http_replies_list, &reply->list);
Christopher Faulet3b967c12020-05-15 15:47:44 +02002073 }
2074 conf_err->file = strdup(file);
2075 conf_err->line = line;
Willy Tarreau2b718102021-04-21 07:32:39 +02002076 LIST_APPEND(&curpx->conf.errors, &conf_err->list);
Christopher Faulet3b967c12020-05-15 15:47:44 +02002077
Christopher Faulet3005d282020-11-13 10:58:01 +01002078 /* handle warning message */
2079 if (*errmsg)
2080 ret = 1;
Christopher Faulet3b967c12020-05-15 15:47:44 +02002081 out:
2082 return ret;
2083
2084 error:
2085 release_http_reply(reply);
2086 ret = -1;
2087 goto out;
2088
2089}
2090
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002091/* Check "errorfiles" proxy keyword */
2092static int proxy_check_errors(struct proxy *px)
2093{
2094 struct conf_errors *conf_err, *conf_err_back;
2095 struct http_errors *http_errs;
Christopher Fauletfc633b62020-11-06 15:24:23 +01002096 int rc, err = ERR_NONE;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002097
2098 list_for_each_entry_safe(conf_err, conf_err_back, &px->conf.errors, list) {
2099 if (conf_err->type == 1) {
2100 /* errorfile */
2101 rc = http_get_status_idx(conf_err->info.errorfile.status);
Christopher Faulet40e85692020-05-14 17:34:31 +02002102 px->replies[rc] = conf_err->info.errorfile.reply;
Christopher Faulet3b967c12020-05-15 15:47:44 +02002103
2104 /* For proxy, to rely on default replies, just don't reference a reply */
2105 if (px->replies[rc]->type == HTTP_REPLY_ERRMSG && !px->replies[rc]->body.errmsg)
2106 px->replies[rc] = NULL;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002107 }
2108 else {
2109 /* errorfiles */
2110 list_for_each_entry(http_errs, &http_errors_list, list) {
2111 if (strcmp(http_errs->id, conf_err->info.errorfiles.name) == 0)
2112 break;
2113 }
Christopher Faulet07f41f72020-01-16 16:16:06 +01002114
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002115 /* unknown http-errors section */
2116 if (&http_errs->list == &http_errors_list) {
Amaury Denoyelle11124302021-06-04 18:22:08 +02002117 ha_alert("proxy '%s': unknown http-errors section '%s' (at %s:%d).\n",
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002118 px->id, conf_err->info.errorfiles.name, conf_err->file, conf_err->line);
2119 err |= ERR_ALERT | ERR_FATAL;
2120 free(conf_err->info.errorfiles.name);
2121 goto next;
2122 }
2123
2124 free(conf_err->info.errorfiles.name);
2125 for (rc = 0; rc < HTTP_ERR_SIZE; rc++) {
2126 if (conf_err->info.errorfiles.status[rc] > 0) {
Christopher Fauletf1fedc32020-05-15 14:30:32 +02002127 if (http_errs->replies[rc])
Christopher Faulet40e85692020-05-14 17:34:31 +02002128 px->replies[rc] = http_errs->replies[rc];
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002129 else if (conf_err->info.errorfiles.status[rc] == 2)
2130 ha_warning("config: proxy '%s' : status '%d' not declared in"
2131 " http-errors section '%s' (at %s:%d).\n",
2132 px->id, http_err_codes[rc], http_errs->id,
2133 conf_err->file, conf_err->line);
2134 }
2135 }
2136 }
2137 next:
Willy Tarreau2b718102021-04-21 07:32:39 +02002138 LIST_DELETE(&conf_err->list);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002139 free(conf_err->file);
2140 free(conf_err);
2141 }
Christopher Faulet07f41f72020-01-16 16:16:06 +01002142
2143 out:
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002144 return err;
2145}
2146
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002147static int post_check_errors()
2148{
2149 struct ebpt_node *node;
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02002150 struct http_error_msg *http_errmsg;
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002151 struct htx *htx;
Christopher Fauletfc633b62020-11-06 15:24:23 +01002152 int err_code = ERR_NONE;
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002153
2154 node = ebpt_first(&http_error_messages);
2155 while (node) {
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02002156 http_errmsg = container_of(node, typeof(*http_errmsg), node);
2157 if (b_is_null(&http_errmsg->msg))
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002158 goto next;
Christopher Fauletb6ea17c2020-05-13 21:45:22 +02002159 htx = htxbuf(&http_errmsg->msg);
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002160 if (htx_free_data_space(htx) < global.tune.maxrewrite) {
2161 ha_warning("config: errorfile '%s' runs over the buffer space"
Ilya Shipitsin47d17182020-06-21 21:42:57 +05002162 " reserved to headers rewriting. It may lead to internal errors if "
Christopher Faulet6d0c3df2020-01-22 09:26:35 +01002163 " http-after-response rules are evaluated on this message.\n",
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002164 (char *)node->key);
2165 err_code |= ERR_WARN;
2166 }
2167 next:
2168 node = ebpt_next(node);
2169 }
2170
2171 return err_code;
2172}
2173
Willy Tarreau016255a2021-02-12 08:40:29 +01002174int proxy_dup_default_conf_errors(struct proxy *curpx, const struct proxy *defpx, char **errmsg)
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002175{
2176 struct conf_errors *conf_err, *new_conf_err = NULL;
2177 int ret = 0;
2178
2179 list_for_each_entry(conf_err, &defpx->conf.errors, list) {
2180 new_conf_err = calloc(1, sizeof(*new_conf_err));
2181 if (!new_conf_err) {
2182 memprintf(errmsg, "unable to duplicate default errors (out of memory).");
2183 goto out;
2184 }
2185 new_conf_err->type = conf_err->type;
2186 if (conf_err->type == 1) {
2187 new_conf_err->info.errorfile.status = conf_err->info.errorfile.status;
Christopher Faulet40e85692020-05-14 17:34:31 +02002188 new_conf_err->info.errorfile.reply = conf_err->info.errorfile.reply;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002189 }
2190 else {
2191 new_conf_err->info.errorfiles.name = strdup(conf_err->info.errorfiles.name);
2192 if (!new_conf_err->info.errorfiles.name) {
2193 memprintf(errmsg, "unable to duplicate default errors (out of memory).");
2194 goto out;
2195 }
2196 memcpy(&new_conf_err->info.errorfiles.status, &conf_err->info.errorfiles.status,
2197 sizeof(conf_err->info.errorfiles.status));
2198 }
2199 new_conf_err->file = strdup(conf_err->file);
2200 new_conf_err->line = conf_err->line;
Willy Tarreau2b718102021-04-21 07:32:39 +02002201 LIST_APPEND(&curpx->conf.errors, &new_conf_err->list);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002202 new_conf_err = NULL;
2203 }
2204 ret = 1;
2205
2206 out:
2207 free(new_conf_err);
Christopher Faulet07f41f72020-01-16 16:16:06 +01002208 return ret;
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002209}
2210
2211void proxy_release_conf_errors(struct proxy *px)
2212{
2213 struct conf_errors *conf_err, *conf_err_back;
Christopher Faulet07f41f72020-01-16 16:16:06 +01002214
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002215 list_for_each_entry_safe(conf_err, conf_err_back, &px->conf.errors, list) {
2216 if (conf_err->type == 0)
2217 free(conf_err->info.errorfiles.name);
Willy Tarreau2b718102021-04-21 07:32:39 +02002218 LIST_DELETE(&conf_err->list);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002219 free(conf_err->file);
2220 free(conf_err);
2221 }
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002222}
2223
2224/*
2225 * Parse an <http-errors> section.
2226 * Returns the error code, 0 if OK, or any combination of :
2227 * - ERR_ABORT: must abort ASAP
2228 * - ERR_FATAL: we can continue parsing but not start the service
2229 * - ERR_WARN: a warning has been emitted
2230 * - ERR_ALERT: an alert has been emitted
2231 * Only the two first ones can stop processing, the two others are just
2232 * indicators.
2233 */
2234static int cfg_parse_http_errors(const char *file, int linenum, char **args, int kwm)
2235{
2236 static struct http_errors *curr_errs = NULL;
2237 int err_code = 0;
2238 const char *err;
2239 char *errmsg = NULL;
2240
2241 if (strcmp(args[0], "http-errors") == 0) { /* new errors section */
2242 if (!*args[1]) {
2243 ha_alert("parsing [%s:%d] : missing name for http-errors section.\n", file, linenum);
2244 err_code |= ERR_ALERT | ERR_ABORT;
2245 goto out;
2246 }
2247
2248 err = invalid_char(args[1]);
2249 if (err) {
2250 ha_alert("parsing [%s:%d] : character '%c' is not permitted in '%s' name '%s'.\n",
2251 file, linenum, *err, args[0], args[1]);
2252 err_code |= ERR_ALERT | ERR_FATAL;
2253 }
2254
2255 list_for_each_entry(curr_errs, &http_errors_list, list) {
2256 /* Error if two errors section owns the same name */
2257 if (strcmp(curr_errs->id, args[1]) == 0) {
2258 ha_alert("parsing [%s:%d]: http-errors section '%s' already exists (declared at %s:%d).\n",
2259 file, linenum, args[1], curr_errs->conf.file, curr_errs->conf.line);
2260 err_code |= ERR_ALERT | ERR_FATAL;
2261 }
2262 }
2263
2264 if ((curr_errs = calloc(1, sizeof(*curr_errs))) == NULL) {
2265 ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum);
2266 err_code |= ERR_ALERT | ERR_ABORT;
2267 goto out;
2268 }
2269
Willy Tarreau2b718102021-04-21 07:32:39 +02002270 LIST_APPEND(&http_errors_list, &curr_errs->list);
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002271 curr_errs->id = strdup(args[1]);
2272 curr_errs->conf.file = strdup(file);
2273 curr_errs->conf.line = linenum;
2274 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002275 else if (strcmp(args[0], "errorfile") == 0) { /* error message from a file */
Christopher Fauletde30bb72020-05-14 10:03:55 +02002276 struct http_reply *reply;
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002277 struct buffer *msg;
2278 int status, rc;
2279
2280 if (*(args[1]) == 0 || *(args[2]) == 0) {
2281 ha_alert("parsing [%s:%d] : %s: expects <status_code> and <file> as arguments.\n",
2282 file, linenum, args[0]);
2283 err_code |= ERR_ALERT | ERR_FATAL;
2284 goto out;
2285 }
2286
2287 status = atol(args[1]);
2288 msg = http_parse_errorfile(status, args[2], &errmsg);
2289 if (!msg) {
2290 ha_alert("parsing [%s:%d] : %s : %s\n", file, linenum, args[0], errmsg);
2291 err_code |= ERR_ALERT | ERR_FATAL;
2292 goto out;
2293 }
Christopher Faulet3005d282020-11-13 10:58:01 +01002294 if (errmsg) {
2295 ha_warning("parsing [%s:%d] : %s: %s\n", file, linenum, args[0], errmsg);
2296 err_code |= ERR_WARN;
2297 }
Christopher Fauletde30bb72020-05-14 10:03:55 +02002298
2299 reply = calloc(1, sizeof(*reply));
2300 if (!reply) {
2301 ha_alert("parsing [%s:%d] : %s : out of memory.\n", file, linenum, args[0]);
2302 err_code |= ERR_ALERT | ERR_FATAL;
2303 goto out;
2304 }
2305 reply->type = HTTP_REPLY_ERRMSG;
2306 reply->status = status;
2307 reply->ctype = NULL;
2308 LIST_INIT(&reply->hdrs);
2309 reply->body.errmsg = msg;
2310
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002311 rc = http_get_status_idx(status);
Christopher Fauletde30bb72020-05-14 10:03:55 +02002312 curr_errs->replies[rc] = reply;
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002313 }
2314 else if (*args[0] != 0) {
2315 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section\n", file, linenum, args[0], cursection);
2316 err_code |= ERR_ALERT | ERR_FATAL;
2317 goto out;
2318 }
2319
2320out:
2321 free(errmsg);
2322 return err_code;
Christopher Faulet07f41f72020-01-16 16:16:06 +01002323}
2324
2325static struct cfg_kw_list cfg_kws = {ILH, {
2326 { CFG_LISTEN, "errorloc", proxy_parse_errorloc },
2327 { CFG_LISTEN, "errorloc302", proxy_parse_errorloc },
2328 { CFG_LISTEN, "errorloc303", proxy_parse_errorloc },
2329 { CFG_LISTEN, "errorfile", proxy_parse_errorfile },
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002330 { CFG_LISTEN, "errorfiles", proxy_parse_errorfiles },
Christopher Faulet3b967c12020-05-15 15:47:44 +02002331 { CFG_LISTEN, "http-error", proxy_parse_http_error },
Christopher Faulet07f41f72020-01-16 16:16:06 +01002332 { 0, NULL, NULL },
2333}};
2334
2335INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01002336REGISTER_POST_PROXY_CHECK(proxy_check_errors);
Christopher Faulet0a589fd2020-01-22 14:47:04 +01002337REGISTER_POST_CHECK(post_check_errors);
Christopher Faulet07f41f72020-01-16 16:16:06 +01002338
Christopher Faulet35cd81d2020-01-15 11:22:56 +01002339REGISTER_CONFIG_SECTION("http-errors", cfg_parse_http_errors, NULL);
2340
Christopher Faulet29f72842019-12-11 15:52:32 +01002341/************************************************************************/
2342/* HTX sample fetches */
2343/************************************************************************/
2344
2345/* Returns 1 if a stream is an HTX stream. Otherwise, it returns 0. */
2346static int
2347smp_fetch_is_htx(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2348{
2349 if (!smp->strm)
2350 return 0;
2351
2352 smp->data.u.sint = !!IS_HTX_STRM(smp->strm);
2353 smp->data.type = SMP_T_BOOL;
2354 return 1;
2355}
2356
2357/* Returns the number of blocks in an HTX message. The channel is chosen
2358 * depending on the sample direction. */
2359static int
2360smp_fetch_htx_nbblks(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2361{
2362 struct channel *chn;
2363 struct htx *htx;
2364
2365 if (!smp->strm)
2366 return 0;
2367
2368 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002369 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002370 if (!htx)
2371 return 0;
2372
2373 smp->data.u.sint = htx_nbblks(htx);
2374 smp->data.type = SMP_T_SINT;
2375 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2376 return 1;
2377}
2378
2379/* Returns the size of an HTX message. The channel is chosen depending on the
2380 * sample direction. */
2381static int
2382smp_fetch_htx_size(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2383{
2384 struct channel *chn;
2385 struct htx *htx;
2386
2387 if (!smp->strm)
2388 return 0;
2389
2390 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002391 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002392 if (!htx)
2393 return 0;
2394
2395 smp->data.u.sint = htx->size;
2396 smp->data.type = SMP_T_SINT;
2397 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2398 return 1;
2399}
2400
2401/* Returns the data size of an HTX message. The channel is chosen depending on the
2402 * sample direction. */
2403static int
2404smp_fetch_htx_data(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2405{
2406 struct channel *chn;
2407 struct htx *htx;
2408
2409 if (!smp->strm)
2410 return 0;
2411
2412 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002413 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002414 if (!htx)
2415 return 0;
2416
2417 smp->data.u.sint = htx->data;
2418 smp->data.type = SMP_T_SINT;
2419 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2420 return 1;
2421}
2422
2423/* Returns the used space (data+meta) of an HTX message. The channel is chosen
2424 * depending on the sample direction. */
2425static int
2426smp_fetch_htx_used(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2427{
2428 struct channel *chn;
2429 struct htx *htx;
2430
2431 if (!smp->strm)
2432 return 0;
2433
2434 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002435 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002436 if (!htx)
2437 return 0;
2438
2439 smp->data.u.sint = htx_used_space(htx);
2440 smp->data.type = SMP_T_SINT;
2441 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2442 return 1;
2443}
2444
2445/* Returns the free space (size-used) of an HTX message. The channel is chosen
2446 * depending on the sample direction. */
2447static int
2448smp_fetch_htx_free(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2449{
2450 struct channel *chn;
2451 struct htx *htx;
2452
2453 if (!smp->strm)
2454 return 0;
2455
2456 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002457 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002458 if (!htx)
2459 return 0;
2460
2461 smp->data.u.sint = htx_free_space(htx);
2462 smp->data.type = SMP_T_SINT;
2463 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2464 return 1;
2465}
2466
2467/* Returns the free space for data (free-sizeof(blk)) of an HTX message. The
2468 * channel is chosen depending on the sample direction. */
2469static int
2470smp_fetch_htx_free_data(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2471{
2472 struct channel *chn;
2473 struct htx *htx;
2474
2475 if (!smp->strm)
2476 return 0;
2477
2478 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002479 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002480 if (!htx)
2481 return 0;
2482
2483 smp->data.u.sint = htx_free_data_space(htx);
2484 smp->data.type = SMP_T_SINT;
2485 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2486 return 1;
2487}
2488
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002489/* Returns 1 if the HTX message contains EOM flag. Otherwise it returns 0. The
2490 * channel is chosen depending on the sample direction.
2491 */
Christopher Faulet29f72842019-12-11 15:52:32 +01002492static int
2493smp_fetch_htx_has_eom(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2494{
2495 struct channel *chn;
2496 struct htx *htx;
2497
2498 if (!smp->strm)
2499 return 0;
2500
2501 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002502 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002503 if (!htx)
2504 return 0;
2505
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002506 smp->data.u.sint = !!(htx->flags & HTX_FL_EOM);
Christopher Faulet29f72842019-12-11 15:52:32 +01002507 smp->data.type = SMP_T_BOOL;
2508 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2509 return 1;
2510}
2511
2512/* Returns the type of a specific HTX block, if found in the message. Otherwise
2513 * HTX_BLK_UNUSED is returned. Any positive integer (>= 0) is supported or
2514 * "head", "tail" or "first". The channel is chosen depending on the sample
2515 * direction. */
2516static int
2517smp_fetch_htx_blk_type(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2518{
2519 struct channel *chn;
2520 struct htx *htx;
2521 enum htx_blk_type type;
2522 int32_t pos;
2523
2524 if (!smp->strm || !arg_p)
2525 return 0;
2526
2527 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002528 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002529 if (!htx)
2530 return 0;
2531
2532 pos = arg_p[0].data.sint;
2533 if (pos == -1)
2534 type = htx_get_head_type(htx);
2535 else if (pos == -2)
2536 type = htx_get_tail_type(htx);
2537 else if (pos == -3)
2538 type = htx_get_first_type(htx);
2539 else
2540 type = ((pos >= htx->head && pos <= htx->tail)
2541 ? htx_get_blk_type(htx_get_blk(htx, pos))
2542 : HTX_BLK_UNUSED);
2543
2544 chunk_initstr(&smp->data.u.str, htx_blk_type_str(type));
2545 smp->data.type = SMP_T_STR;
2546 smp->flags = SMP_F_CONST | SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2547 return 1;
2548}
2549
2550/* Returns the size of a specific HTX block, if found in the message. Otherwise
2551 * 0 is returned. Any positive integer (>= 0) is supported or "head", "tail" or
2552 * "first". The channel is chosen depending on the sample direction. */
2553static int
2554smp_fetch_htx_blk_size(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2555{
2556 struct channel *chn;
2557 struct htx *htx;
2558 struct htx_blk *blk;
2559 int32_t pos;
2560
2561 if (!smp->strm || !arg_p)
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
2569 pos = arg_p[0].data.sint;
2570 if (pos == -1)
2571 blk = htx_get_head_blk(htx);
2572 else if (pos == -2)
2573 blk = htx_get_tail_blk(htx);
2574 else if (pos == -3)
2575 blk = htx_get_first_blk(htx);
2576 else
2577 blk = ((pos >= htx->head && pos <= htx->tail) ? htx_get_blk(htx, pos) : NULL);
2578
2579 smp->data.u.sint = (blk ? htx_get_blksz(blk) : 0);
2580 smp->data.type = SMP_T_SINT;
2581 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2582 return 1;
2583}
2584
2585/* Returns the start-line if the selected HTX block exists and is a
2586 * start-line. Otherwise 0 an empty string. Any positive integer (>= 0) is
2587 * supported or "head", "tail" or "first". The channel is chosen depending on
2588 * the sample direction. */
2589static int
2590smp_fetch_htx_blk_stline(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2591{
2592 struct buffer *temp;
2593 struct channel *chn;
2594 struct htx *htx;
2595 struct htx_blk *blk;
2596 struct htx_sl *sl;
2597 int32_t pos;
2598
2599 if (!smp->strm || !arg_p)
2600 return 0;
2601
2602 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002603 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002604 if (!htx)
2605 return 0;
2606
2607 pos = arg_p[0].data.sint;
2608 if (pos == -1)
2609 blk = htx_get_head_blk(htx);
2610 else if (pos == -2)
2611 blk = htx_get_tail_blk(htx);
2612 else if (pos == -3)
2613 blk = htx_get_first_blk(htx);
2614 else
2615 blk = ((pos >= htx->head && pos <= htx->tail) ? htx_get_blk(htx, pos) : NULL);
2616
2617 if (!blk || (htx_get_blk_type(blk) != HTX_BLK_REQ_SL && htx_get_blk_type(blk) != HTX_BLK_RES_SL)) {
2618 smp->data.u.str.size = 0;
2619 smp->data.u.str.area = "";
2620 smp->data.u.str.data = 0;
2621 }
2622 else {
2623 sl = htx_get_blk_ptr(htx, blk);
2624
2625 temp = get_trash_chunk();
2626 chunk_istcat(temp, htx_sl_p1(sl));
2627 temp->area[temp->data++] = ' ';
2628 chunk_istcat(temp, htx_sl_p2(sl));
2629 temp->area[temp->data++] = ' ';
2630 chunk_istcat(temp, htx_sl_p3(sl));
2631
2632 smp->data.u.str = *temp;
2633 }
2634
2635 smp->data.type = SMP_T_STR;
2636 smp->flags = SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2637 return 1;
2638}
2639
2640/* Returns the header name if the selected HTX block exists and is a header or a
2641 * trailer. Otherwise 0 an empty string. Any positive integer (>= 0) is
2642 * supported or "head", "tail" or "first". The channel is chosen depending on
2643 * the sample direction. */
2644static int
2645smp_fetch_htx_blk_hdrname(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2646{
2647 struct channel *chn;
2648 struct htx *htx;
2649 struct htx_blk *blk;
2650 int32_t pos;
2651
2652 if (!smp->strm || !arg_p)
2653 return 0;
2654
2655 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002656 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002657 if (!htx)
2658 return 0;
2659
2660 pos = arg_p[0].data.sint;
2661 if (pos == -1)
2662 blk = htx_get_head_blk(htx);
2663 else if (pos == -2)
2664 blk = htx_get_tail_blk(htx);
2665 else if (pos == -3)
2666 blk = htx_get_first_blk(htx);
2667 else
2668 blk = ((pos >= htx->head && pos <= htx->tail) ? htx_get_blk(htx, pos) : NULL);
2669
2670 if (!blk || (htx_get_blk_type(blk) != HTX_BLK_HDR && htx_get_blk_type(blk) != HTX_BLK_TLR)) {
2671 smp->data.u.str.size = 0;
2672 smp->data.u.str.area = "";
2673 smp->data.u.str.data = 0;
2674 }
2675 else {
2676 struct ist name = htx_get_blk_name(htx, blk);
2677
2678 chunk_initlen(&smp->data.u.str, name.ptr, name.len, name.len);
2679 }
2680 smp->data.type = SMP_T_STR;
2681 smp->flags = SMP_F_CONST | SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2682 return 1;
2683}
2684
2685/* Returns the header value if the selected HTX block exists and is a header or
2686 * a trailer. Otherwise 0 an empty string. Any positive integer (>= 0) is
2687 * supported or "head", "tail" or "first". The channel is chosen depending on
2688 * the sample direction. */
2689static int
2690smp_fetch_htx_blk_hdrval(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
2691{
2692 struct channel *chn;
2693 struct htx *htx;
2694 struct htx_blk *blk;
2695 int32_t pos;
2696
2697 if (!smp->strm || !arg_p)
2698 return 0;
2699
2700 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002701 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002702 if (!htx)
2703 return 0;
2704
2705 pos = arg_p[0].data.sint;
2706 if (pos == -1)
2707 blk = htx_get_head_blk(htx);
2708 else if (pos == -2)
2709 blk = htx_get_tail_blk(htx);
2710 else if (pos == -3)
2711 blk = htx_get_first_blk(htx);
2712 else
2713 blk = ((pos >= htx->head && pos <= htx->tail) ? htx_get_blk(htx, pos) : NULL);
2714
2715 if (!blk || (htx_get_blk_type(blk) != HTX_BLK_HDR && htx_get_blk_type(blk) != HTX_BLK_TLR)) {
2716 smp->data.u.str.size = 0;
2717 smp->data.u.str.area = "";
2718 smp->data.u.str.data = 0;
2719 }
2720 else {
2721 struct ist val = htx_get_blk_value(htx, blk);
2722
2723 chunk_initlen(&smp->data.u.str, val.ptr, val.len, val.len);
2724 }
2725 smp->data.type = SMP_T_STR;
2726 smp->flags = SMP_F_CONST | SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2727 return 1;
2728}
2729
2730/* Returns the value if the selected HTX block exists and is a data
2731 * block. Otherwise 0 an empty string. Any positive integer (>= 0) is supported
2732 * or "head", "tail" or "first". The channel is chosen depending on the sample
2733 * direction. */
2734static int
Christopher Fauletc5db14c2020-01-08 14:51:03 +01002735smp_fetch_htx_blk_data(const struct arg *arg_p, struct sample *smp, const char *kw, void *private)
Christopher Faulet29f72842019-12-11 15:52:32 +01002736{
2737 struct channel *chn;
2738 struct htx *htx;
2739 struct htx_blk *blk;
2740 int32_t pos;
2741
2742 if (!smp->strm || !arg_p)
2743 return 0;
2744
2745 chn = ((smp->opt & SMP_OPT_DIR) == SMP_OPT_DIR_RES) ? &smp->strm->res : &smp->strm->req;
Christopher Faulet778f5ed2020-04-29 15:51:55 +02002746 htx = smp_prefetch_htx(smp, chn, NULL, 0);
Christopher Faulet29f72842019-12-11 15:52:32 +01002747 if (!htx)
2748 return 0;
2749
2750 pos = arg_p[0].data.sint;
2751 if (pos == -1)
2752 blk = htx_get_head_blk(htx);
2753 else if (pos == -2)
2754 blk = htx_get_tail_blk(htx);
2755 else if (pos == -3)
2756 blk = htx_get_first_blk(htx);
2757 else
2758 blk = ((pos >= htx->head && pos <= htx->tail) ? htx_get_blk(htx, pos) : NULL);
2759
2760 if (!blk || htx_get_blk_type(blk) != HTX_BLK_DATA) {
2761 smp->data.u.str.size = 0;
2762 smp->data.u.str.area = "";
2763 smp->data.u.str.data = 0;
2764 }
2765 else {
2766 struct ist val = htx_get_blk_value(htx, blk);
2767
2768 chunk_initlen(&smp->data.u.str, val.ptr, val.len, val.len);
2769 }
Christopher Faulet8178e402020-01-08 14:38:58 +01002770 smp->data.type = SMP_T_BIN;
Christopher Faulet29f72842019-12-11 15:52:32 +01002771 smp->flags = SMP_F_CONST | SMP_F_VOLATILE | SMP_F_MAY_CHANGE;
2772 return 1;
2773}
2774
2775/* This function is used to validate the arguments passed to any "htx_blk" fetch
2776 * keywords. An argument is expected by these keywords. It must be a positive
2777 * integer or on of the following strings: "head", "tail" or "first". It returns
2778 * 0 on error, and a non-zero value if OK.
2779 */
2780int val_blk_arg(struct arg *arg, char **err_msg)
2781{
2782 if (arg[0].type != ARGT_STR || !arg[0].data.str.data) {
2783 memprintf(err_msg, "a block position is expected (> 0) or a special block name (head, tail, first)");
2784 return 0;
2785 }
2786 if (arg[0].data.str.data == 4 && !strncmp(arg[0].data.str.area, "head", 4)) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002787 chunk_destroy(&arg[0].data.str);
Christopher Faulet29f72842019-12-11 15:52:32 +01002788 arg[0].type = ARGT_SINT;
2789 arg[0].data.sint = -1;
2790 }
2791 else if (arg[0].data.str.data == 4 && !strncmp(arg[0].data.str.area, "tail", 4)) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002792 chunk_destroy(&arg[0].data.str);
Christopher Faulet29f72842019-12-11 15:52:32 +01002793 arg[0].type = ARGT_SINT;
2794 arg[0].data.sint = -2;
2795 }
2796 else if (arg[0].data.str.data == 5 && !strncmp(arg[0].data.str.area, "first", 5)) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002797 chunk_destroy(&arg[0].data.str);
Christopher Faulet29f72842019-12-11 15:52:32 +01002798 arg[0].type = ARGT_SINT;
2799 arg[0].data.sint = -3;
2800 }
2801 else {
2802 int pos;
2803
2804 for (pos = 0; pos < arg[0].data.str.data; pos++) {
Willy Tarreau90807112020-02-25 08:16:33 +01002805 if (!isdigit((unsigned char)arg[0].data.str.area[pos])) {
Christopher Faulet29f72842019-12-11 15:52:32 +01002806 memprintf(err_msg, "invalid block position");
2807 return 0;
2808 }
2809 }
2810
2811 pos = strl2uic(arg[0].data.str.area, arg[0].data.str.data);
2812 if (pos < 0) {
2813 memprintf(err_msg, "block position must not be negative");
2814 return 0;
2815 }
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002816 chunk_destroy(&arg[0].data.str);
Christopher Faulet29f72842019-12-11 15:52:32 +01002817 arg[0].type = ARGT_SINT;
2818 arg[0].data.sint = pos;
2819 }
2820
2821 return 1;
2822}
2823
2824
2825/* Note: must not be declared <const> as its list will be overwritten.
Ilya Shipitsind4259502020-04-08 01:07:56 +05002826 * Note: htx sample fetches should only used for development purpose.
Christopher Faulet29f72842019-12-11 15:52:32 +01002827 */
2828static struct sample_fetch_kw_list sample_fetch_keywords = {ILH, {
Christopher Faulet2e961942021-03-25 17:29:38 +01002829 { "internal.strm.is_htx", smp_fetch_is_htx, 0, NULL, SMP_T_BOOL, SMP_USE_INTRN },
Christopher Faulet29f72842019-12-11 15:52:32 +01002830
Christopher Faulet01f44452020-01-08 14:23:40 +01002831 { "internal.htx.nbblks", smp_fetch_htx_nbblks, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2832 { "internal.htx.size", smp_fetch_htx_size, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2833 { "internal.htx.data", smp_fetch_htx_data, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2834 { "internal.htx.used", smp_fetch_htx_used, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2835 { "internal.htx.free", smp_fetch_htx_free, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2836 { "internal.htx.free_data", smp_fetch_htx_free_data, 0, NULL, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2837 { "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 +01002838
Christopher Faulet01f44452020-01-08 14:23:40 +01002839 { "internal.htx_blk.type", smp_fetch_htx_blk_type, ARG1(1,STR), val_blk_arg, SMP_T_STR, SMP_USE_HRQHV|SMP_USE_HRSHV},
2840 { "internal.htx_blk.size", smp_fetch_htx_blk_size, ARG1(1,STR), val_blk_arg, SMP_T_SINT, SMP_USE_HRQHV|SMP_USE_HRSHV},
2841 { "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},
2842 { "internal.htx_blk.hdrname", smp_fetch_htx_blk_hdrname, ARG1(1,STR), val_blk_arg, SMP_T_STR, SMP_USE_HRQHV|SMP_USE_HRSHV},
2843 { "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 +01002844 { "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 +01002845
2846 { /* END */ },
2847}};
2848
2849INITCALL1(STG_REGISTER, sample_register_fetches, &sample_fetch_keywords);