blob: cd9fccf85e3a786ba706ef47859923102f926af8 [file] [log] [blame]
Emeric Brun107ca302010-01-04 16:16:05 +01001/*
Willy Tarreaucd3b0942012-04-27 21:52:18 +02002 * Sample management functions.
Emeric Brun107ca302010-01-04 16:16:05 +01003 *
4 * Copyright 2009-2010 EXCELIANCE, Emeric Brun <ebrun@exceliance.fr>
Willy Tarreaucd3b0942012-04-27 21:52:18 +02005 * Copyright (C) 2012 Willy Tarreau <w@1wt.eu>
Emeric Brun107ca302010-01-04 16:16:05 +01006 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
Thierry FOURNIER317e1c42014-08-12 10:20:47 +020014#include <ctype.h>
Emeric Brun107ca302010-01-04 16:16:05 +010015#include <string.h>
16#include <arpa/inet.h>
Willy Tarreaudd2f85e2012-09-02 22:34:23 +020017#include <stdio.h>
Emeric Brun107ca302010-01-04 16:16:05 +010018
Alex51c8ad42021-04-15 16:45:15 +020019#include <import/mjson.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020020#include <import/sha1.h>
Willy Tarreau7e2c6472012-10-29 20:44:36 +010021
Willy Tarreaub2551052020-06-09 09:07:15 +020022#include <haproxy/api.h>
23#include <haproxy/arg.h>
Willy Tarreauac13aea2020-06-04 10:36:03 +020024#include <haproxy/auth.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020025#include <haproxy/base64.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020026#include <haproxy/buf.h>
Willy Tarreauc13ed532020-06-02 10:22:45 +020027#include <haproxy/chunk.h>
Willy Tarreau55542642021-10-08 09:33:24 +020028#include <haproxy/clock.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020029#include <haproxy/errors.h>
Baptiste Assmanne138dda2020-10-22 15:39:03 +020030#include <haproxy/fix.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020031#include <haproxy/global.h>
Willy Tarreau8d366972020-05-27 16:10:29 +020032#include <haproxy/hash.h>
Willy Tarreaucd72d8c2020-06-02 19:11:26 +020033#include <haproxy/http.h>
Baptiste Assmanne138dda2020-10-22 15:39:03 +020034#include <haproxy/istbuf.h>
Baptiste Assmanne279ca62020-10-27 18:10:06 +010035#include <haproxy/mqtt.h>
Willy Tarreau6131d6a2020-06-02 16:48:09 +020036#include <haproxy/net_helper.h>
Willy Tarreaub23e5952020-06-04 16:06:59 +020037#include <haproxy/protobuf.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020038#include <haproxy/proxy.h>
Willy Tarreau7cd8b6e2020-06-02 17:32:26 +020039#include <haproxy/regex.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020040#include <haproxy/sample.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020041#include <haproxy/sink.h>
42#include <haproxy/stick_table.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020043#include <haproxy/tools.h>
Willy Tarreau8c42b8a2020-06-04 19:27:34 +020044#include <haproxy/uri_auth-t.h>
Willy Tarreaua1718922020-06-04 16:25:31 +020045#include <haproxy/vars.h>
Tim Duesterhusd5fc8fc2021-09-11 17:51:13 +020046#include <haproxy/xxhash.h>
Remi Tricot-Le Breton0a72f5e2021-10-01 15:36:57 +020047#include <haproxy/jwt.h>
Thierry FOURNIER01e09742016-12-26 11:46:11 +010048
Willy Tarreau1cf8f082014-02-07 12:14:54 +010049/* sample type names */
50const char *smp_to_type[SMP_TYPES] = {
Thierry FOURNIER9c627e82015-06-03 20:12:35 +020051 [SMP_T_ANY] = "any",
Willy Tarreau1cf8f082014-02-07 12:14:54 +010052 [SMP_T_BOOL] = "bool",
Willy Tarreau1cf8f082014-02-07 12:14:54 +010053 [SMP_T_SINT] = "sint",
54 [SMP_T_ADDR] = "addr",
55 [SMP_T_IPV4] = "ipv4",
56 [SMP_T_IPV6] = "ipv6",
57 [SMP_T_STR] = "str",
58 [SMP_T_BIN] = "bin",
Thierry FOURNIER4c2479e2015-06-03 20:12:04 +020059 [SMP_T_METH] = "meth",
Willy Tarreau1cf8f082014-02-07 12:14:54 +010060};
61
Willy Tarreau12785782012-04-27 21:37:17 +020062/* static sample used in sample_process() when <p> is NULL */
Emeric Brune5c918b2017-06-14 14:15:36 +020063static THREAD_LOCAL struct sample temp_smp;
Emeric Brun107ca302010-01-04 16:16:05 +010064
Willy Tarreau12785782012-04-27 21:37:17 +020065/* list head of all known sample fetch keywords */
66static struct sample_fetch_kw_list sample_fetches = {
67 .list = LIST_HEAD_INIT(sample_fetches.list)
Emeric Brun107ca302010-01-04 16:16:05 +010068};
69
Willy Tarreau12785782012-04-27 21:37:17 +020070/* list head of all known sample format conversion keywords */
71static struct sample_conv_kw_list sample_convs = {
72 .list = LIST_HEAD_INIT(sample_convs.list)
Emeric Brun107ca302010-01-04 16:16:05 +010073};
74
Willy Tarreau80aca902013-01-07 15:42:20 +010075const unsigned int fetch_cap[SMP_SRC_ENTRIES] = {
Willy Tarreaube2159b2021-03-26 11:56:11 +010076 [SMP_SRC_CONST] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
77 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
78 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
79 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
80 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
81 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +010082 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL_CFG_PARSER |
83 SMP_VAL_CLI_PARSER ),
Willy Tarreaube2159b2021-03-26 11:56:11 +010084
Willy Tarreau80aca902013-01-07 15:42:20 +010085 [SMP_SRC_INTRN] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
86 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
87 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
88 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
89 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
90 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +010091 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
92 SMP_VAL_CLI_PARSER ),
Willy Tarreau80aca902013-01-07 15:42:20 +010093
94 [SMP_SRC_LISTN] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
95 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
96 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
97 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
98 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
99 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100100 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
101 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100102
103 [SMP_SRC_FTEND] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
104 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
105 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
106 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
107 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
108 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100109 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
110 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100111
112 [SMP_SRC_L4CLI] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
113 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
114 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
115 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
116 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
117 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100118 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
119 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100120
121 [SMP_SRC_L5CLI] = (SMP_VAL___________ | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
122 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
123 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
124 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
125 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
126 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100127 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
128 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100129
130 [SMP_SRC_TRACK] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
131 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
132 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
133 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
134 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
135 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100136 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
137 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100138
139 [SMP_SRC_L6REQ] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_FE_REQ_CNT |
140 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
141 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
142 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL___________ |
143 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
144 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100145 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
146 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100147
148 [SMP_SRC_HRQHV] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_FE_REQ_CNT |
149 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
150 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
151 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL___________ |
152 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
153 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100154 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
155 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100156
157 [SMP_SRC_HRQHP] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_FE_REQ_CNT |
158 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
159 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
160 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
161 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
162 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100163 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
164 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100165
166 [SMP_SRC_HRQBO] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
167 SMP_VAL___________ | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
168 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
169 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL___________ |
170 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
171 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100172 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
173 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100174
175 [SMP_SRC_BKEND] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
176 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
177 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
178 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
179 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
180 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100181 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
182 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100183
184 [SMP_SRC_SERVR] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
185 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
186 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
187 SMP_VAL___________ | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
188 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
189 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100190 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
191 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100192
193 [SMP_SRC_L4SRV] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
194 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
195 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
196 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_BE_RES_CNT |
197 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
198 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100199 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
200 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100201
202 [SMP_SRC_L5SRV] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
203 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
204 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
205 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_BE_RES_CNT |
206 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
207 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100208 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
209 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100210
211 [SMP_SRC_L6RES] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
212 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
213 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
214 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_BE_RES_CNT |
215 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
216 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100217 SMP_VAL___________ | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
218 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100219
220 [SMP_SRC_HRSHV] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
221 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
222 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
223 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_BE_RES_CNT |
224 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
225 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100226 SMP_VAL___________ | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
227 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100228
229 [SMP_SRC_HRSHP] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
230 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
231 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
232 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_BE_RES_CNT |
233 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
234 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100235 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
236 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100237
238 [SMP_SRC_HRSBO] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
239 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
240 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
241 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
242 SMP_VAL___________ | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
243 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100244 SMP_VAL___________ | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
245 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100246
247 [SMP_SRC_RQFIN] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
248 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
249 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
250 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
251 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
252 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100253 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
254 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100255
256 [SMP_SRC_RSFIN] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
257 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
258 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
259 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
260 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
261 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100262 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
263 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100264
265 [SMP_SRC_TXFIN] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
266 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
267 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
268 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
269 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
270 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100271 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
272 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100273
274 [SMP_SRC_SSFIN] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
275 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
276 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
277 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
278 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
279 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100280 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
281 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100282};
283
284static const char *fetch_src_names[SMP_SRC_ENTRIES] = {
285 [SMP_SRC_INTRN] = "internal state",
286 [SMP_SRC_LISTN] = "listener",
287 [SMP_SRC_FTEND] = "frontend",
288 [SMP_SRC_L4CLI] = "client address",
289 [SMP_SRC_L5CLI] = "client-side connection",
290 [SMP_SRC_TRACK] = "track counters",
291 [SMP_SRC_L6REQ] = "request buffer",
292 [SMP_SRC_HRQHV] = "HTTP request headers",
293 [SMP_SRC_HRQHP] = "HTTP request",
294 [SMP_SRC_HRQBO] = "HTTP request body",
295 [SMP_SRC_BKEND] = "backend",
296 [SMP_SRC_SERVR] = "server",
297 [SMP_SRC_L4SRV] = "server address",
298 [SMP_SRC_L5SRV] = "server-side connection",
299 [SMP_SRC_L6RES] = "response buffer",
300 [SMP_SRC_HRSHV] = "HTTP response headers",
301 [SMP_SRC_HRSHP] = "HTTP response",
302 [SMP_SRC_HRSBO] = "HTTP response body",
303 [SMP_SRC_RQFIN] = "request buffer statistics",
304 [SMP_SRC_RSFIN] = "response buffer statistics",
305 [SMP_SRC_TXFIN] = "transaction statistics",
306 [SMP_SRC_SSFIN] = "session statistics",
307};
308
Willy Tarreaubf8e2512013-03-25 14:52:41 +0100309static const char *fetch_ckp_names[SMP_CKP_ENTRIES] = {
310 [SMP_CKP_FE_CON_ACC] = "frontend tcp-request connection rule",
311 [SMP_CKP_FE_SES_ACC] = "frontend tcp-request session rule",
312 [SMP_CKP_FE_REQ_CNT] = "frontend tcp-request content rule",
313 [SMP_CKP_FE_HRQ_HDR] = "frontend http-request header rule",
314 [SMP_CKP_FE_HRQ_BDY] = "frontend http-request body rule",
315 [SMP_CKP_FE_SET_BCK] = "frontend use-backend rule",
316 [SMP_CKP_BE_REQ_CNT] = "backend tcp-request content rule",
317 [SMP_CKP_BE_HRQ_HDR] = "backend http-request header rule",
318 [SMP_CKP_BE_HRQ_BDY] = "backend http-request body rule",
319 [SMP_CKP_BE_SET_SRV] = "backend use-server, balance or stick-match rule",
320 [SMP_CKP_BE_SRV_CON] = "server source selection",
321 [SMP_CKP_BE_RES_CNT] = "backend tcp-response content rule",
322 [SMP_CKP_BE_HRS_HDR] = "backend http-response header rule",
323 [SMP_CKP_BE_HRS_BDY] = "backend http-response body rule",
324 [SMP_CKP_BE_STO_RUL] = "backend stick-store rule",
325 [SMP_CKP_FE_RES_CNT] = "frontend tcp-response content rule",
326 [SMP_CKP_FE_HRS_HDR] = "frontend http-response header rule",
327 [SMP_CKP_FE_HRS_BDY] = "frontend http-response body rule",
328 [SMP_CKP_FE_LOG_END] = "logs",
Gaetan Rivet707b52f2020-02-21 18:14:59 +0100329 [SMP_CKP_BE_CHK_RUL] = "backend tcp-check rule",
Willy Tarreau0d71d2f2022-03-29 16:39:24 +0200330 [SMP_CKP_CFG_PARSER] = "configuration parser",
331 [SMP_CKP_CLI_PARSER] = "CLI parser",
Willy Tarreaubf8e2512013-03-25 14:52:41 +0100332};
333
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100334/* This function returns the type of the data returned by the sample_expr.
335 * It assumes that the <expr> and all of its converters are properly
336 * initialized.
337 */
338inline
339int smp_expr_output_type(struct sample_expr *expr)
340{
341 struct sample_conv_expr *smp_expr;
342
343 if (!LIST_ISEMPTY(&expr->conv_exprs)) {
344 smp_expr = LIST_PREV(&expr->conv_exprs, struct sample_conv_expr *, list);
345 return smp_expr->conv->out_type;
346 }
347 return expr->fetch->out_type;
348}
349
350
Willy Tarreau80aca902013-01-07 15:42:20 +0100351/* fill the trash with a comma-delimited list of source names for the <use> bit
352 * field which must be composed of a non-null set of SMP_USE_* flags. The return
353 * value is the pointer to the string in the trash buffer.
354 */
355const char *sample_src_names(unsigned int use)
356{
357 int bit;
358
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200359 trash.data = 0;
360 trash.area[0] = '\0';
Willy Tarreau80aca902013-01-07 15:42:20 +0100361 for (bit = 0; bit < SMP_SRC_ENTRIES; bit++) {
362 if (!(use & ~((1 << bit) - 1)))
363 break; /* no more bits */
364
365 if (!(use & (1 << bit)))
366 continue; /* bit not set */
367
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200368 trash.data += snprintf(trash.area + trash.data,
369 trash.size - trash.data, "%s%s",
370 (use & ((1 << bit) - 1)) ? "," : "",
371 fetch_src_names[bit]);
Willy Tarreau80aca902013-01-07 15:42:20 +0100372 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200373 return trash.area;
Willy Tarreau80aca902013-01-07 15:42:20 +0100374}
375
Willy Tarreaubf8e2512013-03-25 14:52:41 +0100376/* return a pointer to the correct sample checkpoint name, or "unknown" when
377 * the flags are invalid. Only the lowest bit is used, higher bits are ignored
378 * if set.
379 */
380const char *sample_ckp_names(unsigned int use)
381{
382 int bit;
383
384 for (bit = 0; bit < SMP_CKP_ENTRIES; bit++)
385 if (use & (1 << bit))
386 return fetch_ckp_names[bit];
387 return "unknown sample check place, please report this bug";
388}
389
Emeric Brun107ca302010-01-04 16:16:05 +0100390/*
Willy Tarreau80aca902013-01-07 15:42:20 +0100391 * Registers the sample fetch keyword list <kwl> as a list of valid keywords
392 * for next parsing sessions. The fetch keywords capabilities are also computed
393 * from their ->use field.
Emeric Brun107ca302010-01-04 16:16:05 +0100394 */
Willy Tarreau80aca902013-01-07 15:42:20 +0100395void sample_register_fetches(struct sample_fetch_kw_list *kwl)
Emeric Brun107ca302010-01-04 16:16:05 +0100396{
Willy Tarreau80aca902013-01-07 15:42:20 +0100397 struct sample_fetch *sf;
398 int bit;
399
400 for (sf = kwl->kw; sf->kw != NULL; sf++) {
401 for (bit = 0; bit < SMP_SRC_ENTRIES; bit++)
402 if (sf->use & (1 << bit))
403 sf->val |= fetch_cap[bit];
404 }
Willy Tarreau2b718102021-04-21 07:32:39 +0200405 LIST_APPEND(&sample_fetches.list, &kwl->list);
Emeric Brun107ca302010-01-04 16:16:05 +0100406}
407
408/*
Willy Tarreau12785782012-04-27 21:37:17 +0200409 * Registers the sample format coverstion keyword list <pckl> as a list of valid keywords for next
Emeric Brun107ca302010-01-04 16:16:05 +0100410 * parsing sessions.
411 */
Willy Tarreau12785782012-04-27 21:37:17 +0200412void sample_register_convs(struct sample_conv_kw_list *pckl)
Emeric Brun107ca302010-01-04 16:16:05 +0100413{
Willy Tarreau2b718102021-04-21 07:32:39 +0200414 LIST_APPEND(&sample_convs.list, &pckl->list);
Emeric Brun107ca302010-01-04 16:16:05 +0100415}
416
417/*
Willy Tarreau12785782012-04-27 21:37:17 +0200418 * Returns the pointer on sample fetch keyword structure identified by
Emeric Brun107ca302010-01-04 16:16:05 +0100419 * string of <len> in buffer <kw>.
420 *
421 */
Willy Tarreau12785782012-04-27 21:37:17 +0200422struct sample_fetch *find_sample_fetch(const char *kw, int len)
Emeric Brun107ca302010-01-04 16:16:05 +0100423{
424 int index;
Willy Tarreau12785782012-04-27 21:37:17 +0200425 struct sample_fetch_kw_list *kwl;
Emeric Brun107ca302010-01-04 16:16:05 +0100426
Willy Tarreau12785782012-04-27 21:37:17 +0200427 list_for_each_entry(kwl, &sample_fetches.list, list) {
Emeric Brun107ca302010-01-04 16:16:05 +0100428 for (index = 0; kwl->kw[index].kw != NULL; index++) {
429 if (strncmp(kwl->kw[index].kw, kw, len) == 0 &&
430 kwl->kw[index].kw[len] == '\0')
431 return &kwl->kw[index];
432 }
433 }
434 return NULL;
435}
436
Willy Tarreauf78813f2022-03-29 16:51:29 +0200437/* dump list of registered sample fetch keywords on stdout */
438void smp_dump_fetch_kw(void)
439{
440 struct sample_fetch_kw_list *kwl;
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200441 struct sample_fetch *kwp, *kw;
Willy Tarreauf78813f2022-03-29 16:51:29 +0200442 uint64_t mask;
443 int index;
444 int arg;
445 int bit;
446
447 for (bit = 0; bit <= SMP_CKP_ENTRIES + 1; bit++) {
448 putchar('#');
449 for (index = 0; bit + index <= SMP_CKP_ENTRIES; index++)
450 putchar(' ');
451 for (index = 0; index < bit && index < SMP_CKP_ENTRIES; index++)
452 printf((bit <= SMP_CKP_ENTRIES) ? "/ " : " |");
453 for (index = bit; bit < SMP_CKP_ENTRIES && index < SMP_CKP_ENTRIES + 2; index++)
454 if (index == bit)
455 putchar('_');
456 else if (index == bit + 1)
457 putchar('.');
458 else
459 putchar('-');
460 printf(" %s\n", (bit < SMP_CKP_ENTRIES) ? fetch_ckp_names[bit] : "");
461 }
462
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200463 for (kw = kwp = NULL;; kwp = kw) {
464 list_for_each_entry(kwl, &sample_fetches.list, list) {
465 for (index = 0; kwl->kw[index].kw != NULL; index++) {
466 if (strordered(kwp ? kwp->kw : NULL,
467 kwl->kw[index].kw,
468 kw != kwp ? kw->kw : NULL))
469 kw = &kwl->kw[index];
470 }
471 }
Willy Tarreauf78813f2022-03-29 16:51:29 +0200472
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200473 if (kw == kwp)
474 break;
Willy Tarreauf78813f2022-03-29 16:51:29 +0200475
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200476 printf("[ ");
477 for (bit = 0; bit < SMP_CKP_ENTRIES; bit++)
478 printf("%s", (kw->val & (1 << bit)) ? "Y " : ". ");
479
480 printf("] %s", kw->kw);
481 if (kw->arg_mask) {
482 mask = kw->arg_mask >> ARGM_BITS;
483 printf("(");
484 for (arg = 0;
485 arg < ARGM_NBARGS && ((mask >> (arg * ARGT_BITS)) & ARGT_MASK);
486 arg++) {
487 if (arg == (kw->arg_mask & ARGM_MASK)) {
488 /* now dumping extra args */
489 printf("[");
Willy Tarreauf78813f2022-03-29 16:51:29 +0200490 }
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200491 if (arg)
492 printf(",");
493 printf("%s", arg_type_names[(mask >> (arg * ARGT_BITS)) & ARGT_MASK]);
Willy Tarreauf78813f2022-03-29 16:51:29 +0200494 }
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200495 if (arg > (kw->arg_mask & ARGM_MASK)) {
496 /* extra args were dumped */
497 printf("]");
498 }
499 printf(")");
Willy Tarreauf78813f2022-03-29 16:51:29 +0200500 }
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200501 printf(": %s", smp_to_type[kw->out_type]);
502 printf("\n");
Willy Tarreauf78813f2022-03-29 16:51:29 +0200503 }
504}
505
Willy Tarreau29d799d2022-03-29 16:59:49 +0200506/* dump list of registered sample converter keywords on stdout */
507void smp_dump_conv_kw(void)
508{
509 struct sample_conv_kw_list *kwl;
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200510 struct sample_conv *kwp, *kw;
Willy Tarreau29d799d2022-03-29 16:59:49 +0200511 uint64_t mask;
512 int index;
513 int arg;
514
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200515 for (kw = kwp = NULL;; kwp = kw) {
516 list_for_each_entry(kwl, &sample_convs.list, list) {
517 for (index = 0; kwl->kw[index].kw != NULL; index++) {
518 if (strordered(kwp ? kwp->kw : NULL,
519 kwl->kw[index].kw,
520 kw != kwp ? kw->kw : NULL))
521 kw = &kwl->kw[index];
522 }
523 }
524
525 if (kw == kwp)
526 break;
527
528 printf("%s", kw->kw);
529 if (kw->arg_mask) {
530 mask = kw->arg_mask >> ARGM_BITS;
531 printf("(");
532 for (arg = 0;
533 arg < ARGM_NBARGS && ((mask >> (arg * ARGT_BITS)) & ARGT_MASK);
534 arg++) {
535 if (arg == (kw->arg_mask & ARGM_MASK)) {
536 /* now dumping extra args */
537 printf("[");
Willy Tarreau29d799d2022-03-29 16:59:49 +0200538 }
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200539 if (arg)
540 printf(",");
541 printf("%s", arg_type_names[(mask >> (arg * ARGT_BITS)) & ARGT_MASK]);
Willy Tarreau29d799d2022-03-29 16:59:49 +0200542 }
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200543 if (arg > (kw->arg_mask & ARGM_MASK)) {
544 /* extra args were dumped */
545 printf("]");
546 }
547 printf(")");
Willy Tarreau29d799d2022-03-29 16:59:49 +0200548 }
Willy Tarreau5e0f90a2022-03-30 11:30:36 +0200549 printf(": %s => %s", smp_to_type[kw->out_type], smp_to_type[kw->in_type]);
550 printf("\n");
Willy Tarreau29d799d2022-03-29 16:59:49 +0200551 }
552}
553
Tim Duesterhusc555ee02018-01-25 16:24:44 +0100554/* This function browses the list of available sample fetches. <current> is
Thierry FOURNIER4d9a1d12014-12-08 14:49:19 +0100555 * the last used sample fetch. If it is the first call, it must set to NULL.
Tim Duesterhusc555ee02018-01-25 16:24:44 +0100556 * <idx> is the index of the next sample fetch entry. It is used as private
557 * value. It is useless to initiate it.
Thierry FOURNIER4d9a1d12014-12-08 14:49:19 +0100558 *
Tim Duesterhusc555ee02018-01-25 16:24:44 +0100559 * It returns always the new fetch_sample entry, and NULL when the end of
Thierry FOURNIER4d9a1d12014-12-08 14:49:19 +0100560 * the list is reached.
561 */
562struct sample_fetch *sample_fetch_getnext(struct sample_fetch *current, int *idx)
563{
564 struct sample_fetch_kw_list *kwl;
565 struct sample_fetch *base;
566
567 if (!current) {
568 /* Get first kwl entry. */
569 kwl = LIST_NEXT(&sample_fetches.list, struct sample_fetch_kw_list *, list);
570 (*idx) = 0;
571 } else {
572 /* Get kwl corresponding to the curret entry. */
573 base = current + 1 - (*idx);
574 kwl = container_of(base, struct sample_fetch_kw_list, kw);
575 }
576
577 while (1) {
578
579 /* Check if kwl is the last entry. */
580 if (&kwl->list == &sample_fetches.list)
581 return NULL;
582
583 /* idx contain the next keyword. If it is available, return it. */
584 if (kwl->kw[*idx].kw) {
585 (*idx)++;
586 return &kwl->kw[(*idx)-1];
587 }
588
589 /* get next entry in the main list, and return NULL if the end is reached. */
590 kwl = LIST_NEXT(&kwl->list, struct sample_fetch_kw_list *, list);
591
592 /* Set index to 0, ans do one other loop. */
593 (*idx) = 0;
594 }
595}
596
Thierry FOURNIER8fd13762015-03-10 23:56:48 +0100597/* This function browses the list of available converters. <current> is
598 * the last used converter. If it is the first call, it must set to NULL.
599 * <idx> is the index of the next converter entry. It is used as private
600 * value. It is useless to initiate it.
601 *
602 * It returns always the next sample_conv entry, and NULL when the end of
603 * the list is reached.
604 */
605struct sample_conv *sample_conv_getnext(struct sample_conv *current, int *idx)
606{
607 struct sample_conv_kw_list *kwl;
608 struct sample_conv *base;
609
610 if (!current) {
611 /* Get first kwl entry. */
612 kwl = LIST_NEXT(&sample_convs.list, struct sample_conv_kw_list *, list);
613 (*idx) = 0;
614 } else {
615 /* Get kwl corresponding to the curret entry. */
616 base = current + 1 - (*idx);
617 kwl = container_of(base, struct sample_conv_kw_list, kw);
618 }
619
620 while (1) {
621 /* Check if kwl is the last entry. */
622 if (&kwl->list == &sample_convs.list)
623 return NULL;
624
625 /* idx contain the next keyword. If it is available, return it. */
626 if (kwl->kw[*idx].kw) {
627 (*idx)++;
628 return &kwl->kw[(*idx)-1];
629 }
630
631 /* get next entry in the main list, and return NULL if the end is reached. */
632 kwl = LIST_NEXT(&kwl->list, struct sample_conv_kw_list *, list);
633
634 /* Set index to 0, ans do one other loop. */
635 (*idx) = 0;
636 }
637}
638
Emeric Brun107ca302010-01-04 16:16:05 +0100639/*
Willy Tarreau12785782012-04-27 21:37:17 +0200640 * Returns the pointer on sample format conversion keyword structure identified by
Emeric Brun107ca302010-01-04 16:16:05 +0100641 * string of <len> in buffer <kw>.
642 *
643 */
Willy Tarreau12785782012-04-27 21:37:17 +0200644struct sample_conv *find_sample_conv(const char *kw, int len)
Emeric Brun107ca302010-01-04 16:16:05 +0100645{
646 int index;
Willy Tarreau12785782012-04-27 21:37:17 +0200647 struct sample_conv_kw_list *kwl;
Emeric Brun107ca302010-01-04 16:16:05 +0100648
Willy Tarreau12785782012-04-27 21:37:17 +0200649 list_for_each_entry(kwl, &sample_convs.list, list) {
Emeric Brun107ca302010-01-04 16:16:05 +0100650 for (index = 0; kwl->kw[index].kw != NULL; index++) {
651 if (strncmp(kwl->kw[index].kw, kw, len) == 0 &&
652 kwl->kw[index].kw[len] == '\0')
653 return &kwl->kw[index];
654 }
655 }
656 return NULL;
657}
658
Emeric Brun107ca302010-01-04 16:16:05 +0100659/******************************************************************/
Willy Tarreau12785782012-04-27 21:37:17 +0200660/* Sample casts functions */
Emeric Brun107ca302010-01-04 16:16:05 +0100661/******************************************************************/
662
Willy Tarreau342acb42012-04-23 22:03:39 +0200663static int c_ip2int(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100664{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200665 smp->data.u.sint = ntohl(smp->data.u.ipv4.s_addr);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200666 smp->data.type = SMP_T_SINT;
Emeric Brun107ca302010-01-04 16:16:05 +0100667 return 1;
668}
669
Willy Tarreau342acb42012-04-23 22:03:39 +0200670static int c_ip2str(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100671{
Willy Tarreau83061a82018-07-13 11:56:34 +0200672 struct buffer *trash = get_trash_chunk();
Emeric Brun107ca302010-01-04 16:16:05 +0100673
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200674 if (!inet_ntop(AF_INET, (void *)&smp->data.u.ipv4, trash->area, trash->size))
Emeric Brun107ca302010-01-04 16:16:05 +0100675 return 0;
676
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200677 trash->data = strlen(trash->area);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200678 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200679 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100680 smp->flags &= ~SMP_F_CONST;
Emeric Brun107ca302010-01-04 16:16:05 +0100681
682 return 1;
683}
684
Willy Tarreau342acb42012-04-23 22:03:39 +0200685static int c_ip2ipv6(struct sample *smp)
David du Colombier4f92d322011-03-24 11:09:31 +0100686{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200687 v4tov6(&smp->data.u.ipv6, &smp->data.u.ipv4);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200688 smp->data.type = SMP_T_IPV6;
David du Colombier4f92d322011-03-24 11:09:31 +0100689 return 1;
690}
691
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200692static int c_ipv62ip(struct sample *smp)
693{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200694 if (!v6tov4(&smp->data.u.ipv4, &smp->data.u.ipv6))
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200695 return 0;
Tim Duesterhusbf5ce022018-01-25 16:24:46 +0100696 smp->data.type = SMP_T_IPV4;
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200697 return 1;
698}
699
Willy Tarreau342acb42012-04-23 22:03:39 +0200700static int c_ipv62str(struct sample *smp)
David du Colombier4f92d322011-03-24 11:09:31 +0100701{
Willy Tarreau83061a82018-07-13 11:56:34 +0200702 struct buffer *trash = get_trash_chunk();
David du Colombier4f92d322011-03-24 11:09:31 +0100703
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200704 if (!inet_ntop(AF_INET6, (void *)&smp->data.u.ipv6, trash->area, trash->size))
David du Colombier4f92d322011-03-24 11:09:31 +0100705 return 0;
706
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200707 trash->data = strlen(trash->area);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200708 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200709 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100710 smp->flags &= ~SMP_F_CONST;
David du Colombier4f92d322011-03-24 11:09:31 +0100711 return 1;
712}
713
714/*
Willy Tarreau342acb42012-04-23 22:03:39 +0200715static int c_ipv62ip(struct sample *smp)
David du Colombier4f92d322011-03-24 11:09:31 +0100716{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200717 return v6tov4(&smp->data.u.ipv4, &smp->data.u.ipv6);
David du Colombier4f92d322011-03-24 11:09:31 +0100718}
719*/
720
Willy Tarreau342acb42012-04-23 22:03:39 +0200721static int c_int2ip(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100722{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200723 smp->data.u.ipv4.s_addr = htonl((unsigned int)smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200724 smp->data.type = SMP_T_IPV4;
Emeric Brun107ca302010-01-04 16:16:05 +0100725 return 1;
726}
727
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200728static int c_int2ipv6(struct sample *smp)
729{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200730 smp->data.u.ipv4.s_addr = htonl((unsigned int)smp->data.u.sint);
731 v4tov6(&smp->data.u.ipv6, &smp->data.u.ipv4);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200732 smp->data.type = SMP_T_IPV6;
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200733 return 1;
734}
735
Thierry FOURNIERb805f712013-11-26 20:47:54 +0100736static int c_str2addr(struct sample *smp)
737{
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200738 if (!buf2ip(smp->data.u.str.area, smp->data.u.str.data, &smp->data.u.ipv4)) {
739 if (!buf2ip6(smp->data.u.str.area, smp->data.u.str.data, &smp->data.u.ipv6))
Thierry FOURNIERfd139902013-12-11 12:38:57 +0100740 return 0;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200741 smp->data.type = SMP_T_IPV6;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100742 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIERfd139902013-12-11 12:38:57 +0100743 return 1;
Thierry FOURNIERb805f712013-11-26 20:47:54 +0100744 }
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200745 smp->data.type = SMP_T_IPV4;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100746 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIERb805f712013-11-26 20:47:54 +0100747 return 1;
748}
749
Willy Tarreau342acb42012-04-23 22:03:39 +0200750static int c_str2ip(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100751{
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200752 if (!buf2ip(smp->data.u.str.area, smp->data.u.str.data, &smp->data.u.ipv4))
Emeric Brun107ca302010-01-04 16:16:05 +0100753 return 0;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200754 smp->data.type = SMP_T_IPV4;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100755 smp->flags &= ~SMP_F_CONST;
Emeric Brun107ca302010-01-04 16:16:05 +0100756 return 1;
757}
758
Willy Tarreau342acb42012-04-23 22:03:39 +0200759static int c_str2ipv6(struct sample *smp)
David du Colombier4f92d322011-03-24 11:09:31 +0100760{
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200761 if (!buf2ip6(smp->data.u.str.area, smp->data.u.str.data, &smp->data.u.ipv6))
Thierry FOURNIERfd139902013-12-11 12:38:57 +0100762 return 0;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200763 smp->data.type = SMP_T_IPV6;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100764 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIERfd139902013-12-11 12:38:57 +0100765 return 1;
David du Colombier4f92d322011-03-24 11:09:31 +0100766}
767
Emeric Brun4b9e8022014-11-03 18:17:10 +0100768/*
769 * The NULL char always enforces the end of string if it is met.
770 * Data is never changed, so we can ignore the CONST case
Thierry FOURNIERe87cac12014-03-12 15:07:59 +0100771 */
Emeric Brun8ac33d92012-10-17 13:36:06 +0200772static int c_bin2str(struct sample *smp)
773{
Emeric Brun4b9e8022014-11-03 18:17:10 +0100774 int i;
Emeric Brun8ac33d92012-10-17 13:36:06 +0200775
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200776 for (i = 0; i < smp->data.u.str.data; i++) {
777 if (!smp->data.u.str.area[i]) {
778 smp->data.u.str.data = i;
Thierry FOURNIERe87cac12014-03-12 15:07:59 +0100779 break;
Emeric Brun4b9e8022014-11-03 18:17:10 +0100780 }
Emeric Brun8ac33d92012-10-17 13:36:06 +0200781 }
Christopher Faulet472ad512020-04-30 09:57:40 +0200782 smp->data.type = SMP_T_STR;
Emeric Brun8ac33d92012-10-17 13:36:06 +0200783 return 1;
784}
785
Willy Tarreau342acb42012-04-23 22:03:39 +0200786static int c_int2str(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100787{
Willy Tarreau83061a82018-07-13 11:56:34 +0200788 struct buffer *trash = get_trash_chunk();
Emeric Brun107ca302010-01-04 16:16:05 +0100789 char *pos;
790
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200791 pos = lltoa_r(smp->data.u.sint, trash->area, trash->size);
Emeric Brun107ca302010-01-04 16:16:05 +0100792 if (!pos)
793 return 0;
794
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200795 trash->size = trash->size - (pos - trash->area);
796 trash->area = pos;
797 trash->data = strlen(pos);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200798 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200799 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100800 smp->flags &= ~SMP_F_CONST;
Emeric Brun107ca302010-01-04 16:16:05 +0100801 return 1;
802}
803
Joseph Herlant757f5ad2018-11-15 12:14:56 -0800804/* This function unconditionally duplicates data and removes the "const" flag.
Willy Tarreauad635822016-08-08 19:21:09 +0200805 * For strings and binary blocks, it also provides a known allocated size with
806 * a length that is capped to the size, and ensures a trailing zero is always
807 * appended for strings. This is necessary for some operations which may
808 * require to extend the length. It returns 0 if it fails, 1 on success.
809 */
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100810int smp_dup(struct sample *smp)
Emeric Brun485479d2010-09-23 18:02:19 +0200811{
Willy Tarreau83061a82018-07-13 11:56:34 +0200812 struct buffer *trash;
Emeric Brun485479d2010-09-23 18:02:19 +0200813
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200814 switch (smp->data.type) {
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100815 case SMP_T_BOOL:
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100816 case SMP_T_SINT:
817 case SMP_T_ADDR:
818 case SMP_T_IPV4:
819 case SMP_T_IPV6:
820 /* These type are not const. */
821 break;
Willy Tarreauad635822016-08-08 19:21:09 +0200822
Christopher Fauletec100512017-07-24 15:38:41 +0200823 case SMP_T_METH:
824 if (smp->data.u.meth.meth != HTTP_METH_OTHER)
825 break;
826 /* Fall through */
827
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100828 case SMP_T_STR:
Willy Tarreauad635822016-08-08 19:21:09 +0200829 trash = get_trash_chunk();
Olivier Houchard4468f1c2018-12-07 15:23:41 +0100830 trash->data = smp->data.type == SMP_T_STR ?
831 smp->data.u.str.data : smp->data.u.meth.str.data;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200832 if (trash->data > trash->size - 1)
833 trash->data = trash->size - 1;
Willy Tarreauad635822016-08-08 19:21:09 +0200834
Olivier Houchard4468f1c2018-12-07 15:23:41 +0100835 memcpy(trash->area, smp->data.type == SMP_T_STR ?
836 smp->data.u.str.area : smp->data.u.meth.str.area,
837 trash->data);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200838 trash->area[trash->data] = 0;
Willy Tarreauad635822016-08-08 19:21:09 +0200839 smp->data.u.str = *trash;
840 break;
841
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100842 case SMP_T_BIN:
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100843 trash = get_trash_chunk();
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200844 trash->data = smp->data.u.str.data;
845 if (trash->data > trash->size)
846 trash->data = trash->size;
Willy Tarreauad635822016-08-08 19:21:09 +0200847
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200848 memcpy(trash->area, smp->data.u.str.area, trash->data);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200849 smp->data.u.str = *trash;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100850 break;
Christopher Fauletec100512017-07-24 15:38:41 +0200851
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100852 default:
853 /* Other cases are unexpected. */
854 return 0;
855 }
Thierry FOURNIERb805f712013-11-26 20:47:54 +0100856
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100857 /* remove const flag */
858 smp->flags &= ~SMP_F_CONST;
Emeric Brun485479d2010-09-23 18:02:19 +0200859 return 1;
860}
861
Thierry FOURNIER0e9af552013-12-14 14:55:04 +0100862int c_none(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100863{
864 return 1;
865}
866
Willy Tarreau342acb42012-04-23 22:03:39 +0200867static int c_str2int(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100868{
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200869 const char *str;
870 const char *end;
Emeric Brun107ca302010-01-04 16:16:05 +0100871
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200872 if (smp->data.u.str.data == 0)
Thierry FOURNIER60bb0202014-01-27 18:20:48 +0100873 return 0;
874
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200875 str = smp->data.u.str.area;
876 end = smp->data.u.str.area + smp->data.u.str.data;
Emeric Brun107ca302010-01-04 16:16:05 +0100877
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200878 smp->data.u.sint = read_int64(&str, end);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200879 smp->data.type = SMP_T_SINT;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100880 smp->flags &= ~SMP_F_CONST;
Emeric Brun107ca302010-01-04 16:16:05 +0100881 return 1;
882}
883
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100884static int c_str2meth(struct sample *smp)
885{
886 enum http_meth_t meth;
887 int len;
888
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200889 meth = find_http_meth(smp->data.u.str.area, smp->data.u.str.data);
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100890 if (meth == HTTP_METH_OTHER) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200891 len = smp->data.u.str.data;
892 smp->data.u.meth.str.area = smp->data.u.str.area;
893 smp->data.u.meth.str.data = len;
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100894 }
895 else
896 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200897 smp->data.u.meth.meth = meth;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200898 smp->data.type = SMP_T_METH;
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100899 return 1;
900}
901
902static int c_meth2str(struct sample *smp)
903{
904 int len;
905 enum http_meth_t meth;
906
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200907 if (smp->data.u.meth.meth == HTTP_METH_OTHER) {
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100908 /* The method is unknown. Copy the original pointer. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200909 len = smp->data.u.meth.str.data;
910 smp->data.u.str.area = smp->data.u.meth.str.area;
911 smp->data.u.str.data = len;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200912 smp->data.type = SMP_T_STR;
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100913 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200914 else if (smp->data.u.meth.meth < HTTP_METH_OTHER) {
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100915 /* The method is known, copy the pointer containing the string. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200916 meth = smp->data.u.meth.meth;
Willy Tarreau35b51c62018-09-10 15:38:55 +0200917 smp->data.u.str.area = http_known_methods[meth].ptr;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200918 smp->data.u.str.data = http_known_methods[meth].len;
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100919 smp->flags |= SMP_F_CONST;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200920 smp->data.type = SMP_T_STR;
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100921 }
922 else {
923 /* Unknown method */
924 return 0;
925 }
926 return 1;
927}
928
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200929static int c_addr2bin(struct sample *smp)
930{
Willy Tarreau83061a82018-07-13 11:56:34 +0200931 struct buffer *chk = get_trash_chunk();
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200932
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200933 if (smp->data.type == SMP_T_IPV4) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200934 chk->data = 4;
935 memcpy(chk->area, &smp->data.u.ipv4, chk->data);
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200936 }
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200937 else if (smp->data.type == SMP_T_IPV6) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200938 chk->data = 16;
939 memcpy(chk->area, &smp->data.u.ipv6, chk->data);
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200940 }
941 else
942 return 0;
943
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200944 smp->data.u.str = *chk;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200945 smp->data.type = SMP_T_BIN;
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200946 return 1;
947}
948
Willy Tarreaubbfd1a22014-07-15 21:19:08 +0200949static int c_int2bin(struct sample *smp)
950{
Willy Tarreau83061a82018-07-13 11:56:34 +0200951 struct buffer *chk = get_trash_chunk();
Willy Tarreaubbfd1a22014-07-15 21:19:08 +0200952
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200953 *(unsigned long long int *) chk->area = my_htonll(smp->data.u.sint);
954 chk->data = 8;
Willy Tarreaubbfd1a22014-07-15 21:19:08 +0200955
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200956 smp->data.u.str = *chk;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200957 smp->data.type = SMP_T_BIN;
Willy Tarreaubbfd1a22014-07-15 21:19:08 +0200958 return 1;
959}
960
Willy Tarreaub9f30f32022-04-25 10:46:16 +0200961static int c_bool2bin(struct sample *smp)
962{
963 struct buffer *chk = get_trash_chunk();
964
965 *(unsigned long long int *)chk->area = my_htonll(!!smp->data.u.sint);
966 chk->data = 8;
967 smp->data.u.str = *chk;
968 smp->data.type = SMP_T_BIN;
969 return 1;
970}
971
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200972
Emeric Brun107ca302010-01-04 16:16:05 +0100973/*****************************************************************/
Willy Tarreau12785782012-04-27 21:37:17 +0200974/* Sample casts matrix: */
975/* sample_casts[from type][to type] */
976/* NULL pointer used for impossible sample casts */
Emeric Brun107ca302010-01-04 16:16:05 +0100977/*****************************************************************/
Emeric Brun107ca302010-01-04 16:16:05 +0100978
Thierry FOURNIER8af6ff12013-11-21 10:53:12 +0100979sample_cast_fct sample_casts[SMP_TYPES][SMP_TYPES] = {
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200980/* to: ANY BOOL SINT ADDR IPV4 IPV6 STR BIN METH */
981/* from: ANY */ { c_none, c_none, c_none, c_none, c_none, c_none, c_none, c_none, c_none, },
Willy Tarreaub9f30f32022-04-25 10:46:16 +0200982/* BOOL */ { c_none, c_none, c_none, NULL, NULL, NULL, c_int2str, c_bool2bin, NULL, },
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200983/* SINT */ { c_none, c_none, c_none, c_int2ip, c_int2ip, c_int2ipv6, c_int2str, c_int2bin, NULL, },
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200984/* ADDR */ { c_none, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, },
985/* IPV4 */ { c_none, NULL, c_ip2int, c_none, c_none, c_ip2ipv6, c_ip2str, c_addr2bin, NULL, },
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200986/* IPV6 */ { c_none, NULL, NULL, c_none, c_ipv62ip,c_none, c_ipv62str, c_addr2bin, NULL, },
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200987/* STR */ { c_none, c_str2int, c_str2int, c_str2addr, c_str2ip, c_str2ipv6, c_none, c_none, c_str2meth, },
988/* BIN */ { c_none, NULL, NULL, NULL, NULL, NULL, c_bin2str, c_none, c_str2meth, },
989/* METH */ { c_none, NULL, NULL, NULL, NULL, NULL, c_meth2str, c_meth2str, c_none, }
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200990};
Emeric Brun107ca302010-01-04 16:16:05 +0100991
Emeric Brun107ca302010-01-04 16:16:05 +0100992/*
Willy Tarreau12785782012-04-27 21:37:17 +0200993 * Parse a sample expression configuration:
Emeric Brun107ca302010-01-04 16:16:05 +0100994 * fetch keyword followed by format conversion keywords.
Willy Tarreau12785782012-04-27 21:37:17 +0200995 * Returns a pointer on allocated sample expression structure.
Christopher Faulet35926a12021-09-30 08:48:56 +0200996 * <al> is an arg_list serving as a list head to report missing dependencies.
997 * It may be NULL if such dependencies are not allowed. Otherwise, the caller
998 * must have set al->ctx if al is set.
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100999 * If <endptr> is non-nul, it will be set to the first unparsed character
1000 * (which may be the final '\0') on success. If it is nul, the expression
1001 * must be properly terminated by a '\0' otherwise an error is reported.
Emeric Brun107ca302010-01-04 16:16:05 +01001002 */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +01001003struct sample_expr *sample_parse_expr(char **str, int *idx, const char *file, int line, char **err_msg, struct arg_list *al, char **endptr)
Emeric Brun107ca302010-01-04 16:16:05 +01001004{
Willy Tarreau833cc792013-07-24 15:34:19 +02001005 const char *begw; /* beginning of word */
1006 const char *endw; /* end of word */
1007 const char *endt; /* end of term */
Remi Tricot-Le Breton22e0d9b2021-01-12 14:55:12 +01001008 struct sample_expr *expr = NULL;
Willy Tarreau12785782012-04-27 21:37:17 +02001009 struct sample_fetch *fetch;
1010 struct sample_conv *conv;
Emeric Brun107ca302010-01-04 16:16:05 +01001011 unsigned long prev_type;
Willy Tarreau833cc792013-07-24 15:34:19 +02001012 char *fkw = NULL;
1013 char *ckw = NULL;
Willy Tarreau689a1df2013-12-13 00:40:11 +01001014 int err_arg;
Emeric Brun107ca302010-01-04 16:16:05 +01001015
Willy Tarreau833cc792013-07-24 15:34:19 +02001016 begw = str[*idx];
Willy Tarreaued2c6622020-02-14 18:27:10 +01001017 for (endw = begw; is_idchar(*endw); endw++)
1018 ;
Willy Tarreau833cc792013-07-24 15:34:19 +02001019
1020 if (endw == begw) {
Willy Tarreau975c1782013-12-12 23:16:54 +01001021 memprintf(err_msg, "missing fetch method");
Emeric Brun107ca302010-01-04 16:16:05 +01001022 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +02001023 }
Emeric Brun107ca302010-01-04 16:16:05 +01001024
Willy Tarreau833cc792013-07-24 15:34:19 +02001025 /* keep a copy of the current fetch keyword for error reporting */
1026 fkw = my_strndup(begw, endw - begw);
Emeric Brun107ca302010-01-04 16:16:05 +01001027
Willy Tarreau833cc792013-07-24 15:34:19 +02001028 fetch = find_sample_fetch(begw, endw - begw);
1029 if (!fetch) {
Willy Tarreau975c1782013-12-12 23:16:54 +01001030 memprintf(err_msg, "unknown fetch method '%s'", fkw);
Emeric Brun107ca302010-01-04 16:16:05 +01001031 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +02001032 }
Emeric Brun107ca302010-01-04 16:16:05 +01001033
Willy Tarreau833cc792013-07-24 15:34:19 +02001034 /* At this point, we have :
1035 * - begw : beginning of the keyword
Willy Tarreau689a1df2013-12-13 00:40:11 +01001036 * - endw : end of the keyword, first character not part of keyword
Willy Tarreau833cc792013-07-24 15:34:19 +02001037 */
1038
1039 if (fetch->out_type >= SMP_TYPES) {
Willy Tarreau975c1782013-12-12 23:16:54 +01001040 memprintf(err_msg, "returns type of fetch method '%s' is unknown", fkw);
Emeric Brun107ca302010-01-04 16:16:05 +01001041 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +02001042 }
Emeric Brun107ca302010-01-04 16:16:05 +01001043 prev_type = fetch->out_type;
Willy Tarreau833cc792013-07-24 15:34:19 +02001044
Vincent Bernat02779b62016-04-03 13:48:43 +02001045 expr = calloc(1, sizeof(*expr));
Emeric Brun485479d2010-09-23 18:02:19 +02001046 if (!expr)
1047 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +01001048
1049 LIST_INIT(&(expr->conv_exprs));
1050 expr->fetch = fetch;
Willy Tarreau2e845be2012-10-19 19:49:09 +02001051 expr->arg_p = empty_arg_list;
Emeric Brun107ca302010-01-04 16:16:05 +01001052
Willy Tarreau689a1df2013-12-13 00:40:11 +01001053 /* Note that we call the argument parser even with an empty string,
1054 * this allows it to automatically create entries for mandatory
1055 * implicit arguments (eg: local proxy name).
1056 */
Christopher Faulet35926a12021-09-30 08:48:56 +02001057 if (al) {
1058 al->kw = expr->fetch->kw;
1059 al->conv = NULL;
1060 }
Willy Tarreau80b53ff2020-02-14 08:40:37 +01001061 if (make_arg_list(endw, -1, fetch->arg_mask, &expr->arg_p, err_msg, &endt, &err_arg, al) < 0) {
Willy Tarreau689a1df2013-12-13 00:40:11 +01001062 memprintf(err_msg, "fetch method '%s' : %s", fkw, *err_msg);
1063 goto out_error;
1064 }
Willy Tarreau2e845be2012-10-19 19:49:09 +02001065
Willy Tarreau80b53ff2020-02-14 08:40:37 +01001066 /* now endt is our first char not part of the arg list, typically the
1067 * comma after the sample fetch name or after the closing parenthesis,
1068 * or the NUL char.
1069 */
1070
Willy Tarreau689a1df2013-12-13 00:40:11 +01001071 if (!expr->arg_p) {
1072 expr->arg_p = empty_arg_list;
Emeric Brun485479d2010-09-23 18:02:19 +02001073 }
Willy Tarreau689a1df2013-12-13 00:40:11 +01001074 else if (fetch->val_args && !fetch->val_args(expr->arg_p, err_msg)) {
1075 memprintf(err_msg, "invalid args in fetch method '%s' : %s", fkw, *err_msg);
Emeric Brun485479d2010-09-23 18:02:19 +02001076 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +01001077 }
1078
Willy Tarreau833cc792013-07-24 15:34:19 +02001079 /* Now process the converters if any. We have two supported syntaxes
1080 * for the converters, which can be combined :
1081 * - comma-delimited list of converters just after the keyword and args ;
1082 * - one converter per keyword
1083 * The combination allows to have each keyword being a comma-delimited
1084 * series of converters.
1085 *
1086 * We want to process the former first, then the latter. For this we start
1087 * from the beginning of the supposed place in the exiting conv chain, which
1088 * starts at the last comma (endt).
1089 */
1090
1091 while (1) {
Willy Tarreau12785782012-04-27 21:37:17 +02001092 struct sample_conv_expr *conv_expr;
Willy Tarreau46dfd782019-12-17 10:25:29 +01001093 int err_arg;
1094 int argcnt;
Emeric Brun107ca302010-01-04 16:16:05 +01001095
Willy Tarreau833cc792013-07-24 15:34:19 +02001096 if (*endt && *endt != ',') {
Willy Tarreaue3b57bf2020-02-14 16:50:14 +01001097 if (endptr) {
1098 /* end found, let's stop here */
1099 break;
1100 }
Willy Tarreau833cc792013-07-24 15:34:19 +02001101 if (ckw)
Willy Tarreau97108e02016-11-25 07:33:24 +01001102 memprintf(err_msg, "missing comma after converter '%s'", ckw);
Willy Tarreau833cc792013-07-24 15:34:19 +02001103 else
Willy Tarreau975c1782013-12-12 23:16:54 +01001104 memprintf(err_msg, "missing comma after fetch keyword '%s'", fkw);
Emeric Brun107ca302010-01-04 16:16:05 +01001105 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +02001106 }
Emeric Brun107ca302010-01-04 16:16:05 +01001107
Willy Tarreau80b53ff2020-02-14 08:40:37 +01001108 /* FIXME: how long should we support such idiocies ? Maybe we
1109 * should already warn ?
1110 */
Willy Tarreau833cc792013-07-24 15:34:19 +02001111 while (*endt == ',') /* then trailing commas */
1112 endt++;
1113
Willy Tarreau97108e02016-11-25 07:33:24 +01001114 begw = endt; /* start of converter */
Willy Tarreau833cc792013-07-24 15:34:19 +02001115
1116 if (!*begw) {
1117 /* none ? skip to next string */
1118 (*idx)++;
1119 begw = str[*idx];
1120 if (!begw || !*begw)
1121 break;
1122 }
1123
Willy Tarreaued2c6622020-02-14 18:27:10 +01001124 for (endw = begw; is_idchar(*endw); endw++)
1125 ;
Willy Tarreau833cc792013-07-24 15:34:19 +02001126
1127 free(ckw);
1128 ckw = my_strndup(begw, endw - begw);
1129
1130 conv = find_sample_conv(begw, endw - begw);
1131 if (!conv) {
1132 /* we found an isolated keyword that we don't know, it's not ours */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +01001133 if (begw == str[*idx]) {
1134 endt = begw;
Willy Tarreau833cc792013-07-24 15:34:19 +02001135 break;
Willy Tarreaue3b57bf2020-02-14 16:50:14 +01001136 }
Willy Tarreau97108e02016-11-25 07:33:24 +01001137 memprintf(err_msg, "unknown converter '%s'", ckw);
Willy Tarreau833cc792013-07-24 15:34:19 +02001138 goto out_error;
1139 }
Emeric Brun107ca302010-01-04 16:16:05 +01001140
Willy Tarreau833cc792013-07-24 15:34:19 +02001141 if (conv->in_type >= SMP_TYPES || conv->out_type >= SMP_TYPES) {
Willy Tarreau97108e02016-11-25 07:33:24 +01001142 memprintf(err_msg, "returns type of converter '%s' is unknown", ckw);
Emeric Brun107ca302010-01-04 16:16:05 +01001143 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +02001144 }
Emeric Brun107ca302010-01-04 16:16:05 +01001145
1146 /* If impossible type conversion */
Willy Tarreau12785782012-04-27 21:37:17 +02001147 if (!sample_casts[prev_type][conv->in_type]) {
Willy Tarreau97108e02016-11-25 07:33:24 +01001148 memprintf(err_msg, "converter '%s' cannot be applied", ckw);
Emeric Brun107ca302010-01-04 16:16:05 +01001149 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +02001150 }
Emeric Brun107ca302010-01-04 16:16:05 +01001151
1152 prev_type = conv->out_type;
Vincent Bernat02779b62016-04-03 13:48:43 +02001153 conv_expr = calloc(1, sizeof(*conv_expr));
Emeric Brun485479d2010-09-23 18:02:19 +02001154 if (!conv_expr)
1155 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +01001156
Willy Tarreau2b718102021-04-21 07:32:39 +02001157 LIST_APPEND(&(expr->conv_exprs), &(conv_expr->list));
Emeric Brun107ca302010-01-04 16:16:05 +01001158 conv_expr->conv = conv;
1159
Christopher Faulet35926a12021-09-30 08:48:56 +02001160 if (al) {
1161 al->kw = expr->fetch->kw;
1162 al->conv = conv_expr->conv->kw;
1163 }
Willy Tarreau80b53ff2020-02-14 08:40:37 +01001164 argcnt = make_arg_list(endw, -1, conv->arg_mask, &conv_expr->arg_p, err_msg, &endt, &err_arg, al);
Willy Tarreau46dfd782019-12-17 10:25:29 +01001165 if (argcnt < 0) {
1166 memprintf(err_msg, "invalid arg %d in converter '%s' : %s", err_arg+1, ckw, *err_msg);
1167 goto out_error;
1168 }
Willy Tarreau9e92d322010-01-26 17:58:06 +01001169
Willy Tarreau46dfd782019-12-17 10:25:29 +01001170 if (argcnt && !conv->arg_mask) {
1171 memprintf(err_msg, "converter '%s' does not support any args", ckw);
1172 goto out_error;
1173 }
Willy Tarreau21d68a62012-04-20 15:52:36 +02001174
Willy Tarreau46dfd782019-12-17 10:25:29 +01001175 if (!conv_expr->arg_p)
1176 conv_expr->arg_p = empty_arg_list;
Willy Tarreau2e845be2012-10-19 19:49:09 +02001177
Willy Tarreau46dfd782019-12-17 10:25:29 +01001178 if (conv->val_args && !conv->val_args(conv_expr->arg_p, conv, file, line, err_msg)) {
1179 memprintf(err_msg, "invalid args in converter '%s' : %s", ckw, *err_msg);
Emeric Brun485479d2010-09-23 18:02:19 +02001180 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +01001181 }
1182 }
Emeric Brun485479d2010-09-23 18:02:19 +02001183
Willy Tarreaue3b57bf2020-02-14 16:50:14 +01001184 if (endptr) {
1185 /* end found, let's stop here */
1186 *endptr = (char *)endt;
1187 }
1188
Willy Tarreau833cc792013-07-24 15:34:19 +02001189 out:
1190 free(fkw);
1191 free(ckw);
Emeric Brun107ca302010-01-04 16:16:05 +01001192 return expr;
1193
1194out_error:
Remi Tricot-Le Breton22e0d9b2021-01-12 14:55:12 +01001195 release_sample_expr(expr);
Willy Tarreau833cc792013-07-24 15:34:19 +02001196 expr = NULL;
1197 goto out;
Emeric Brun107ca302010-01-04 16:16:05 +01001198}
1199
1200/*
Willy Tarreau12785782012-04-27 21:37:17 +02001201 * Process a fetch + format conversion of defined by the sample expression <expr>
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001202 * on request or response considering the <opt> parameter.
Willy Tarreau12785782012-04-27 21:37:17 +02001203 * Returns a pointer on a typed sample structure containing the result or NULL if
1204 * sample is not found or when format conversion failed.
Emeric Brun107ca302010-01-04 16:16:05 +01001205 * If <p> is not null, function returns results in structure pointed by <p>.
Willy Tarreau12785782012-04-27 21:37:17 +02001206 * If <p> is null, functions returns a pointer on a static sample structure.
Willy Tarreaub8c8f1f2012-04-23 22:38:26 +02001207 *
1208 * Note: the fetch functions are required to properly set the return type. The
1209 * conversion functions must do so too. However the cast functions do not need
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05001210 * to since they're made to cast multiple types according to what is required.
Willy Tarreau6bcb0a82014-07-30 08:56:35 +02001211 *
1212 * The caller may indicate in <opt> if it considers the result final or not.
1213 * The caller needs to check the SMP_F_MAY_CHANGE flag in p->flags to verify
1214 * if the result is stable or not, according to the following table :
1215 *
1216 * return MAY_CHANGE FINAL Meaning for the sample
1217 * NULL 0 * Not present and will never be (eg: header)
1218 * NULL 1 0 Not present yet, could change (eg: POST param)
1219 * NULL 1 1 Not present yet, will not change anymore
1220 * smp 0 * Present and will not change (eg: header)
1221 * smp 1 0 Present, may change (eg: request length)
1222 * smp 1 1 Present, last known value (eg: request length)
Emeric Brun107ca302010-01-04 16:16:05 +01001223 */
Willy Tarreau192252e2015-04-04 01:47:55 +02001224struct sample *sample_process(struct proxy *px, struct session *sess,
1225 struct stream *strm, unsigned int opt,
Willy Tarreau12785782012-04-27 21:37:17 +02001226 struct sample_expr *expr, struct sample *p)
Emeric Brun107ca302010-01-04 16:16:05 +01001227{
Willy Tarreau12785782012-04-27 21:37:17 +02001228 struct sample_conv_expr *conv_expr;
Emeric Brun107ca302010-01-04 16:16:05 +01001229
Willy Tarreau18387e22013-07-25 12:02:38 +02001230 if (p == NULL) {
Willy Tarreaub4a88f02012-04-23 21:35:11 +02001231 p = &temp_smp;
Willy Tarreau6c616e02014-06-25 16:56:41 +02001232 memset(p, 0, sizeof(*p));
Willy Tarreau18387e22013-07-25 12:02:38 +02001233 }
Emeric Brun107ca302010-01-04 16:16:05 +01001234
Willy Tarreau1777ea62016-03-10 16:15:46 +01001235 smp_set_owner(p, px, sess, strm, opt);
Thierry FOURNIER0786d052015-05-11 15:42:45 +02001236 if (!expr->fetch->process(expr->arg_p, p, expr->fetch->kw, expr->fetch->private))
Emeric Brun107ca302010-01-04 16:16:05 +01001237 return NULL;
1238
Emeric Brun107ca302010-01-04 16:16:05 +01001239 list_for_each_entry(conv_expr, &expr->conv_exprs, list) {
Willy Tarreau12e50112012-04-25 17:21:49 +02001240 /* we want to ensure that p->type can be casted into
1241 * conv_expr->conv->in_type. We have 3 possibilities :
1242 * - NULL => not castable.
1243 * - c_none => nothing to do (let's optimize it)
1244 * - other => apply cast and prepare to fail
1245 */
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001246 if (!sample_casts[p->data.type][conv_expr->conv->in_type])
Willy Tarreau12e50112012-04-25 17:21:49 +02001247 return NULL;
1248
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001249 if (sample_casts[p->data.type][conv_expr->conv->in_type] != c_none &&
1250 !sample_casts[p->data.type][conv_expr->conv->in_type](p))
Emeric Brun107ca302010-01-04 16:16:05 +01001251 return NULL;
1252
Willy Tarreau12e50112012-04-25 17:21:49 +02001253 /* OK cast succeeded */
1254
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02001255 if (!conv_expr->conv->process(conv_expr->arg_p, p, conv_expr->conv->private))
Emeric Brun107ca302010-01-04 16:16:05 +01001256 return NULL;
Emeric Brun107ca302010-01-04 16:16:05 +01001257 }
1258 return p;
1259}
1260
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001261/*
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001262 * Resolve all remaining arguments in proxy <p>. Returns the number of
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001263 * errors or 0 if everything is fine. If at least one error is met, it will
1264 * be appended to *err. If *err==NULL it will be allocated first.
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001265 */
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001266int smp_resolve_args(struct proxy *p, char **err)
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001267{
1268 struct arg_list *cur, *bak;
1269 const char *ctx, *where;
1270 const char *conv_ctx, *conv_pre, *conv_pos;
1271 struct userlist *ul;
Willy Tarreau46947782015-01-19 19:00:58 +01001272 struct my_regex *reg;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001273 struct arg *arg;
1274 int cfgerr = 0;
Willy Tarreau46947782015-01-19 19:00:58 +01001275 int rflags;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001276
1277 list_for_each_entry_safe(cur, bak, &p->conf.args.list, list) {
1278 struct proxy *px;
1279 struct server *srv;
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001280 struct stktable *t;
1281 char *pname, *sname, *stktname;
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001282 char *err2;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001283
1284 arg = cur->arg;
1285
1286 /* prepare output messages */
1287 conv_pre = conv_pos = conv_ctx = "";
1288 if (cur->conv) {
1289 conv_ctx = cur->conv;
1290 conv_pre = "conversion keyword '";
1291 conv_pos = "' for ";
1292 }
1293
1294 where = "in";
1295 ctx = "sample fetch keyword";
1296 switch (cur->ctx) {
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001297 case ARGC_STK: where = "in stick rule in"; break;
1298 case ARGC_TRK: where = "in tracking rule in"; break;
1299 case ARGC_LOG: where = "in log-format string in"; break;
1300 case ARGC_LOGSD: where = "in log-format-sd string in"; break;
Willy Tarreau57467b82021-09-02 19:43:20 +02001301 case ARGC_HRQ: where = "in http-request expression in"; break;
1302 case ARGC_HRS: where = "in http-response response in"; break;
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001303 case ARGC_UIF: where = "in unique-id-format string in"; break;
1304 case ARGC_RDR: where = "in redirect format string in"; break;
1305 case ARGC_CAP: where = "in capture rule in"; break;
1306 case ARGC_ACL: ctx = "ACL keyword"; break;
1307 case ARGC_SRV: where = "in server directive in"; break;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001308 case ARGC_SPOE: where = "in spoe-message directive in"; break;
Willy Tarreau1a8636d2022-04-25 08:15:46 +02001309 case ARGC_UBK: where = "in use_backend expression in"; break;
Willy Tarreau7c9a0fe2022-04-25 10:25:34 +02001310 case ARGC_USRV: where = "in use-server or balance expression in"; break;
Christopher Faulet3b967c12020-05-15 15:47:44 +02001311 case ARGC_HERR: where = "in http-error directive in"; break;
Miroslav Zagorac7f8314c2020-12-09 16:31:48 +01001312 case ARGC_OT: where = "in ot-scope directive in"; break;
Willy Tarreau57467b82021-09-02 19:43:20 +02001313 case ARGC_TCO: where = "in tcp-request connection expression in"; break;
1314 case ARGC_TSE: where = "in tcp-request session expression in"; break;
1315 case ARGC_TRQ: where = "in tcp-request content expression in"; break;
1316 case ARGC_TRS: where = "in tcp-response content expression in"; break;
1317 case ARGC_TCK: where = "in tcp-check expression in"; break;
1318 case ARGC_CFG: where = "in configuration expression in"; break;
1319 case ARGC_CLI: where = "in CLI expression in"; break;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001320 }
1321
1322 /* set a few default settings */
1323 px = p;
1324 pname = p->id;
1325
1326 switch (arg->type) {
1327 case ARGT_SRV:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001328 if (!arg->data.str.data) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001329 memprintf(err, "%sparsing [%s:%d]: missing server name in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1330 *err ? *err : "", cur->file, cur->line,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001331 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001332 cfgerr++;
1333 continue;
1334 }
1335
1336 /* we support two formats : "bck/srv" and "srv" */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001337 sname = strrchr(arg->data.str.area, '/');
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001338
1339 if (sname) {
1340 *sname++ = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001341 pname = arg->data.str.area;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001342
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001343 px = proxy_be_by_name(pname);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001344 if (!px) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001345 memprintf(err, "%sparsing [%s:%d]: unable to find proxy '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1346 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001347 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001348 cfgerr++;
1349 break;
1350 }
1351 }
Christopher Faulet37a9e212021-10-12 18:48:05 +02001352 else {
1353 if (px->cap & PR_CAP_DEF) {
1354 memprintf(err, "%sparsing [%s:%d]: backend name must be set in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1355 *err ? *err : "", cur->file, cur->line,
1356 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
1357 cfgerr++;
1358 break;
1359 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001360 sname = arg->data.str.area;
Christopher Faulet37a9e212021-10-12 18:48:05 +02001361 }
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001362
1363 srv = findserver(px, sname);
1364 if (!srv) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001365 memprintf(err, "%sparsing [%s:%d]: unable to find server '%s' in proxy '%s', referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1366 *err ? *err : "", cur->file, cur->line, sname, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001367 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001368 cfgerr++;
1369 break;
1370 }
1371
Amaury Denoyelle06269612021-08-23 14:05:07 +02001372 srv->flags |= SRV_F_NON_PURGEABLE;
1373
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001374 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001375 arg->unresolved = 0;
1376 arg->data.srv = srv;
1377 break;
1378
1379 case ARGT_FE:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001380 if (arg->data.str.data) {
1381 pname = arg->data.str.area;
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001382 px = proxy_fe_by_name(pname);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001383 }
1384
1385 if (!px) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001386 memprintf(err, "%sparsing [%s:%d]: unable to find frontend '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1387 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001388 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001389 cfgerr++;
1390 break;
1391 }
1392
1393 if (!(px->cap & PR_CAP_FE)) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001394 memprintf(err, "%sparsing [%s:%d]: proxy '%s', referenced in arg %d of %s%s%s%s '%s' %s proxy '%s', has not frontend capability.\n",
1395 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001396 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001397 cfgerr++;
1398 break;
1399 }
1400
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001401 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001402 arg->unresolved = 0;
1403 arg->data.prx = px;
1404 break;
1405
1406 case ARGT_BE:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001407 if (arg->data.str.data) {
1408 pname = arg->data.str.area;
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001409 px = proxy_be_by_name(pname);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001410 }
1411
1412 if (!px) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001413 memprintf(err, "%sparsing [%s:%d]: unable to find backend '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1414 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001415 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001416 cfgerr++;
1417 break;
1418 }
1419
1420 if (!(px->cap & PR_CAP_BE)) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001421 memprintf(err, "%sparsing [%s:%d]: proxy '%s', referenced in arg %d of %s%s%s%s '%s' %s proxy '%s', has not backend capability.\n",
1422 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001423 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001424 cfgerr++;
1425 break;
1426 }
1427
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001428 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001429 arg->unresolved = 0;
1430 arg->data.prx = px;
1431 break;
1432
1433 case ARGT_TAB:
Frédéric Lécaille9417f452019-06-20 09:31:04 +02001434 if (arg->data.str.data)
1435 stktname = arg->data.str.area;
Christopher Faulet37a9e212021-10-12 18:48:05 +02001436 else {
1437 if (px->cap & PR_CAP_DEF) {
1438 memprintf(err, "%sparsing [%s:%d]: table name must be set in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1439 *err ? *err : "", cur->file, cur->line,
1440 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
1441 cfgerr++;
1442 break;
1443 }
Frédéric Lécaille9417f452019-06-20 09:31:04 +02001444 stktname = px->id;
Christopher Faulet37a9e212021-10-12 18:48:05 +02001445 }
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001446
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001447 t = stktable_find_by_name(stktname);
1448 if (!t) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001449 memprintf(err, "%sparsing [%s:%d]: unable to find table '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1450 *err ? *err : "", cur->file, cur->line, stktname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001451 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001452 cfgerr++;
1453 break;
1454 }
1455
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001456 if (!t->size) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001457 memprintf(err, "%sparsing [%s:%d]: no table in proxy '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1458 *err ? *err : "", cur->file, cur->line, stktname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001459 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001460 cfgerr++;
1461 break;
1462 }
1463
Frédéric Lécaillebe367932019-08-07 09:28:39 +02001464 if (!in_proxies_list(t->proxies_list, p)) {
Frédéric Lécaille015e4d72019-03-19 14:55:01 +01001465 p->next_stkt_ref = t->proxies_list;
1466 t->proxies_list = p;
1467 }
1468
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001469 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001470 arg->unresolved = 0;
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001471 arg->data.t = t;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001472 break;
1473
1474 case ARGT_USR:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001475 if (!arg->data.str.data) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001476 memprintf(err, "%sparsing [%s:%d]: missing userlist name in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1477 *err ? *err : "", cur->file, cur->line,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001478 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001479 cfgerr++;
1480 break;
1481 }
1482
1483 if (p->uri_auth && p->uri_auth->userlist &&
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001484 strcmp(p->uri_auth->userlist->name, arg->data.str.area) == 0)
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001485 ul = p->uri_auth->userlist;
1486 else
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001487 ul = auth_find_userlist(arg->data.str.area);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001488
1489 if (!ul) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001490 memprintf(err, "%sparsing [%s:%d]: unable to find userlist '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1491 *err ? *err : "", cur->file, cur->line,
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001492 arg->data.str.area,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001493 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001494 cfgerr++;
1495 break;
1496 }
1497
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001498 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001499 arg->unresolved = 0;
1500 arg->data.usr = ul;
1501 break;
Willy Tarreau46947782015-01-19 19:00:58 +01001502
1503 case ARGT_REG:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001504 if (!arg->data.str.data) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001505 memprintf(err, "%sparsing [%s:%d]: missing regex in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1506 *err ? *err : "", cur->file, cur->line,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001507 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreau46947782015-01-19 19:00:58 +01001508 cfgerr++;
1509 continue;
1510 }
1511
Willy Tarreau46947782015-01-19 19:00:58 +01001512 rflags = 0;
1513 rflags |= (arg->type_flags & ARGF_REG_ICASE) ? REG_ICASE : 0;
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001514 err2 = NULL;
Willy Tarreau46947782015-01-19 19:00:58 +01001515
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001516 if (!(reg = regex_comp(arg->data.str.area, !(rflags & REG_ICASE), 1 /* capture substr */, &err2))) {
1517 memprintf(err, "%sparsing [%s:%d]: error in regex '%s' in arg %d of %s%s%s%s '%s' %s proxy '%s' : %s.\n",
1518 *err ? *err : "", cur->file, cur->line,
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001519 arg->data.str.area,
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001520 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id, err2);
Willy Tarreau46947782015-01-19 19:00:58 +01001521 cfgerr++;
1522 continue;
1523 }
1524
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001525 chunk_destroy(&arg->data.str);
Willy Tarreau46947782015-01-19 19:00:58 +01001526 arg->unresolved = 0;
1527 arg->data.reg = reg;
1528 break;
1529
1530
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001531 }
1532
Willy Tarreau2b718102021-04-21 07:32:39 +02001533 LIST_DELETE(&cur->list);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001534 free(cur);
1535 } /* end of args processing */
1536
1537 return cfgerr;
1538}
1539
1540/*
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001541 * Process a fetch + format conversion as defined by the sample expression
1542 * <expr> on request or response considering the <opt> parameter. The output is
Adis Nezirovic79beb242015-07-06 15:41:02 +02001543 * not explicitly set to <smp_type>, but shall be compatible with it as
1544 * specified by 'sample_casts' table. If a stable sample can be fetched, or an
1545 * unstable one when <opt> contains SMP_OPT_FINAL, the sample is converted and
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001546 * returned without the SMP_F_MAY_CHANGE flag. If an unstable sample is found
1547 * and <opt> does not contain SMP_OPT_FINAL, then the sample is returned as-is
1548 * with its SMP_F_MAY_CHANGE flag so that the caller can check it and decide to
1549 * take actions (eg: wait longer). If a sample could not be found or could not
Willy Tarreau6bcb0a82014-07-30 08:56:35 +02001550 * be converted, NULL is returned. The caller MUST NOT use the sample if the
1551 * SMP_F_MAY_CHANGE flag is present, as it is used only as a hint that there is
1552 * still hope to get it after waiting longer, and is not converted to string.
1553 * The possible output combinations are the following :
1554 *
1555 * return MAY_CHANGE FINAL Meaning for the sample
1556 * NULL * * Not present and will never be (eg: header)
1557 * smp 0 * Final value converted (eg: header)
1558 * smp 1 0 Not present yet, may appear later (eg: header)
1559 * smp 1 1 never happens (either flag is cleared on output)
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001560 */
Adis Nezirovic79beb242015-07-06 15:41:02 +02001561struct sample *sample_fetch_as_type(struct proxy *px, struct session *sess,
Willy Tarreau192252e2015-04-04 01:47:55 +02001562 struct stream *strm, unsigned int opt,
Adis Nezirovic79beb242015-07-06 15:41:02 +02001563 struct sample_expr *expr, int smp_type)
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001564{
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001565 struct sample *smp = &temp_smp;
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001566
Willy Tarreau6c616e02014-06-25 16:56:41 +02001567 memset(smp, 0, sizeof(*smp));
1568
Willy Tarreau192252e2015-04-04 01:47:55 +02001569 if (!sample_process(px, sess, strm, opt, expr, smp)) {
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001570 if ((smp->flags & SMP_F_MAY_CHANGE) && !(opt & SMP_OPT_FINAL))
1571 return smp;
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001572 return NULL;
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001573 }
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001574
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001575 if (!sample_casts[smp->data.type][smp_type])
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001576 return NULL;
1577
Willy Tarreau3705dee2022-04-25 10:02:11 +02001578 if (sample_casts[smp->data.type][smp_type] != c_none &&
1579 !sample_casts[smp->data.type][smp_type](smp))
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001580 return NULL;
1581
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001582 smp->flags &= ~SMP_F_MAY_CHANGE;
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001583 return smp;
1584}
1585
Christopher Faulet476e5d02016-10-26 11:34:47 +02001586static void release_sample_arg(struct arg *p)
1587{
1588 struct arg *p_back = p;
1589
1590 if (!p)
1591 return;
1592
1593 while (p->type != ARGT_STOP) {
1594 if (p->type == ARGT_STR || p->unresolved) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001595 chunk_destroy(&p->data.str);
Christopher Faulet476e5d02016-10-26 11:34:47 +02001596 p->unresolved = 0;
1597 }
1598 else if (p->type == ARGT_REG) {
Dragan Dosen26743032019-04-30 15:54:36 +02001599 regex_free(p->data.reg);
1600 p->data.reg = NULL;
Christopher Faulet476e5d02016-10-26 11:34:47 +02001601 }
1602 p++;
1603 }
1604
1605 if (p_back != empty_arg_list)
1606 free(p_back);
1607}
1608
1609void release_sample_expr(struct sample_expr *expr)
1610{
1611 struct sample_conv_expr *conv_expr, *conv_exprb;
1612
1613 if (!expr)
1614 return;
1615
Tim Duesterhus867cd982020-07-04 11:49:39 +02001616 list_for_each_entry_safe(conv_expr, conv_exprb, &expr->conv_exprs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001617 LIST_DELETE(&conv_expr->list);
Christopher Faulet476e5d02016-10-26 11:34:47 +02001618 release_sample_arg(conv_expr->arg_p);
Tim Duesterhus867cd982020-07-04 11:49:39 +02001619 free(conv_expr);
1620 }
1621
Christopher Faulet476e5d02016-10-26 11:34:47 +02001622 release_sample_arg(expr->arg_p);
1623 free(expr);
1624}
1625
Emeric Brun107ca302010-01-04 16:16:05 +01001626/*****************************************************************/
Willy Tarreau12785782012-04-27 21:37:17 +02001627/* Sample format convert functions */
Willy Tarreaub8c8f1f2012-04-23 22:38:26 +02001628/* These functions set the data type on return. */
Emeric Brun107ca302010-01-04 16:16:05 +01001629/*****************************************************************/
1630
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001631static int sample_conv_debug(const struct arg *arg_p, struct sample *smp, void *private)
1632{
1633 int i;
1634 struct sample tmp;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001635 struct buffer *buf;
1636 struct sink *sink;
1637 struct ist line;
1638 char *pfx;
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001639
Willy Tarreau0851fd52019-12-17 10:07:25 +01001640 buf = alloc_trash_chunk();
1641 if (!buf)
1642 goto end;
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001643
Christopher Fauletb45bf8e2020-08-07 14:00:23 +02001644 sink = (struct sink *)arg_p[1].data.ptr;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001645 BUG_ON(!sink);
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001646
Willy Tarreau0851fd52019-12-17 10:07:25 +01001647 pfx = arg_p[0].data.str.area;
1648 BUG_ON(!pfx);
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001649
Willy Tarreau0851fd52019-12-17 10:07:25 +01001650 chunk_printf(buf, "[debug] %s: type=%s ", pfx, smp_to_type[smp->data.type]);
1651 if (!sample_casts[smp->data.type][SMP_T_STR])
1652 goto nocast;
1653
1654 /* Copy sample fetch. This puts the sample as const, the
1655 * cast will copy data if a transformation is required.
1656 */
1657 memcpy(&tmp, smp, sizeof(struct sample));
1658 tmp.flags = SMP_F_CONST;
1659
1660 if (!sample_casts[smp->data.type][SMP_T_STR](&tmp))
1661 goto nocast;
1662
1663 /* Display the displayable chars*. */
1664 b_putchr(buf, '<');
1665 for (i = 0; i < tmp.data.u.str.data; i++) {
Willy Tarreau90807112020-02-25 08:16:33 +01001666 if (isprint((unsigned char)tmp.data.u.str.area[i]))
Willy Tarreau0851fd52019-12-17 10:07:25 +01001667 b_putchr(buf, tmp.data.u.str.area[i]);
1668 else
1669 b_putchr(buf, '.');
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001670 }
Willy Tarreau0851fd52019-12-17 10:07:25 +01001671 b_putchr(buf, '>');
1672
1673 done:
1674 line = ist2(buf->area, buf->data);
Emeric Brun54648852020-07-06 15:54:06 +02001675 sink_write(sink, &line, 1, 0, 0, NULL);
Willy Tarreau0851fd52019-12-17 10:07:25 +01001676 end:
1677 free_trash_chunk(buf);
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001678 return 1;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001679 nocast:
1680 chunk_appendf(buf, "(undisplayable)");
1681 goto done;
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001682}
Willy Tarreau0851fd52019-12-17 10:07:25 +01001683
1684// This function checks the "debug" converter's arguments.
1685static int smp_check_debug(struct arg *args, struct sample_conv *conv,
1686 const char *file, int line, char **err)
1687{
1688 const char *name = "buf0";
1689 struct sink *sink = NULL;
1690
1691 if (args[0].type != ARGT_STR) {
1692 /* optional prefix */
1693 args[0].data.str.area = "";
1694 args[0].data.str.data = 0;
1695 }
1696
1697 if (args[1].type == ARGT_STR)
1698 name = args[1].data.str.area;
1699
1700 sink = sink_find(name);
1701 if (!sink) {
1702 memprintf(err, "No such sink '%s'", name);
1703 return 0;
1704 }
1705
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001706 chunk_destroy(&args[1].data.str);
Christopher Fauletb45bf8e2020-08-07 14:00:23 +02001707 args[1].type = ARGT_PTR;
1708 args[1].data.ptr = sink;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001709 return 1;
1710}
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001711
Holger Just1bfc24b2017-05-06 00:56:53 +02001712static int sample_conv_base642bin(const struct arg *arg_p, struct sample *smp, void *private)
1713{
Willy Tarreau83061a82018-07-13 11:56:34 +02001714 struct buffer *trash = get_trash_chunk();
Holger Just1bfc24b2017-05-06 00:56:53 +02001715 int bin_len;
1716
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001717 trash->data = 0;
1718 bin_len = base64dec(smp->data.u.str.area, smp->data.u.str.data,
1719 trash->area, trash->size);
Holger Just1bfc24b2017-05-06 00:56:53 +02001720 if (bin_len < 0)
1721 return 0;
1722
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001723 trash->data = bin_len;
Holger Just1bfc24b2017-05-06 00:56:53 +02001724 smp->data.u.str = *trash;
1725 smp->data.type = SMP_T_BIN;
1726 smp->flags &= ~SMP_F_CONST;
1727 return 1;
1728}
1729
Moemen MHEDHBI92f7d432021-04-01 20:53:59 +02001730static int sample_conv_base64url2bin(const struct arg *arg_p, struct sample *smp, void *private)
1731{
1732 struct buffer *trash = get_trash_chunk();
1733 int bin_len;
1734
1735 trash->data = 0;
1736 bin_len = base64urldec(smp->data.u.str.area, smp->data.u.str.data,
1737 trash->area, trash->size);
1738 if (bin_len < 0)
1739 return 0;
1740
1741 trash->data = bin_len;
1742 smp->data.u.str = *trash;
1743 smp->data.type = SMP_T_BIN;
1744 smp->flags &= ~SMP_F_CONST;
1745 return 1;
1746}
1747
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02001748static int sample_conv_bin2base64(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun53d1a982014-04-30 18:21:37 +02001749{
Willy Tarreau83061a82018-07-13 11:56:34 +02001750 struct buffer *trash = get_trash_chunk();
Emeric Brun53d1a982014-04-30 18:21:37 +02001751 int b64_len;
1752
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001753 trash->data = 0;
1754 b64_len = a2base64(smp->data.u.str.area, smp->data.u.str.data,
1755 trash->area, trash->size);
Emeric Brun53d1a982014-04-30 18:21:37 +02001756 if (b64_len < 0)
1757 return 0;
1758
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001759 trash->data = b64_len;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02001760 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001761 smp->data.type = SMP_T_STR;
Emeric Brun53d1a982014-04-30 18:21:37 +02001762 smp->flags &= ~SMP_F_CONST;
1763 return 1;
1764}
1765
Moemen MHEDHBI92f7d432021-04-01 20:53:59 +02001766static int sample_conv_bin2base64url(const struct arg *arg_p, struct sample *smp, void *private)
1767{
1768 struct buffer *trash = get_trash_chunk();
1769 int b64_len;
1770
1771 trash->data = 0;
1772 b64_len = a2base64url(smp->data.u.str.area, smp->data.u.str.data,
1773 trash->area, trash->size);
1774 if (b64_len < 0)
1775 return 0;
1776
1777 trash->data = b64_len;
1778 smp->data.u.str = *trash;
1779 smp->data.type = SMP_T_STR;
1780 smp->flags &= ~SMP_F_CONST;
1781 return 1;
1782}
1783
Willy Tarreau168e8de2021-10-06 15:29:00 +02001784/* This function returns a sample struct filled with the conversion of variable
1785 * <var> to sample type <type> (SMP_T_*), via a cast to the target type. If the
1786 * variable cannot be retrieved or casted, 0 is returned, otherwise 1.
1787 *
1788 * Keep in mind that the sample content may be written to a pre-allocated
1789 * trash chunk as returned by get_trash_chunk().
1790 */
1791int sample_conv_var2smp(const struct var_desc *var, struct sample *smp, int type)
1792{
1793 if (!vars_get_by_desc(var, smp, NULL))
1794 return 0;
1795 if (!sample_casts[smp->data.type][type])
1796 return 0;
1797 if (!sample_casts[smp->data.type][type](smp))
1798 return 0;
1799 return 1;
1800}
1801
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001802static int sample_conv_sha1(const struct arg *arg_p, struct sample *smp, void *private)
1803{
1804 blk_SHA_CTX ctx;
Willy Tarreau83061a82018-07-13 11:56:34 +02001805 struct buffer *trash = get_trash_chunk();
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001806
1807 memset(&ctx, 0, sizeof(ctx));
1808
1809 blk_SHA1_Init(&ctx);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001810 blk_SHA1_Update(&ctx, smp->data.u.str.area, smp->data.u.str.data);
1811 blk_SHA1_Final((unsigned char *) trash->area, &ctx);
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001812
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001813 trash->data = 20;
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001814 smp->data.u.str = *trash;
1815 smp->data.type = SMP_T_BIN;
1816 smp->flags &= ~SMP_F_CONST;
1817 return 1;
1818}
1819
Dragan Dosen9e8db132021-02-22 10:03:53 +01001820/* This function returns a sample struct filled with an <arg> content.
1821 * If the <arg> contains a string, it is returned in the sample flagged as
1822 * SMP_F_CONST. If the <arg> contains a variable descriptor, the sample is
1823 * filled with the content of the variable by using vars_get_by_desc().
1824 *
1825 * Keep in mind that the sample content may be written to a pre-allocated
1826 * trash chunk as returned by get_trash_chunk().
1827 *
1828 * This function returns 0 if an error occurs, otherwise it returns 1.
1829 */
Willy Tarreau4034e2c2021-10-06 15:20:18 +02001830int sample_conv_var2smp_str(const struct arg *arg, struct sample *smp)
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001831{
1832 switch (arg->type) {
1833 case ARGT_STR:
1834 smp->data.type = SMP_T_STR;
1835 smp->data.u.str = arg->data.str;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001836 smp->flags = SMP_F_CONST;
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001837 return 1;
1838 case ARGT_VAR:
Willy Tarreau2476ff12021-10-06 15:30:52 +02001839 return sample_conv_var2smp(&arg->data.var, smp, SMP_T_STR);
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001840 default:
1841 return 0;
1842 }
1843}
1844
Marcin Deranek40ca09c2021-07-13 14:05:24 +02001845static int sample_conv_be2dec_check(struct arg *args, struct sample_conv *conv,
1846 const char *file, int line, char **err)
1847{
1848 if (args[1].data.sint <= 0 || args[1].data.sint > sizeof(unsigned long long)) {
Willy Tarreauc5d0fc92021-09-15 10:30:40 +02001849 memprintf(err, "chunk_size out of [1..%u] range (%lld)", (uint)sizeof(unsigned long long), args[1].data.sint);
Marcin Deranek40ca09c2021-07-13 14:05:24 +02001850 return 0;
1851 }
1852
1853 if (args[2].data.sint != 0 && args[2].data.sint != 1) {
1854 memprintf(err, "Unsupported truncate value (%lld)", args[2].data.sint);
1855 return 0;
1856 }
1857
1858 return 1;
1859}
1860
1861/* Converts big-endian binary input sample to a string containing an unsigned
1862 * integer number per <chunk_size> input bytes separated with <separator>.
1863 * Optional <truncate> flag indicates if input is truncated at <chunk_size>
1864 * boundaries.
1865 * Arguments: separator (string), chunk_size (integer), truncate (0,1)
1866 */
1867static int sample_conv_be2dec(const struct arg *args, struct sample *smp, void *private)
1868{
1869 struct buffer *trash = get_trash_chunk();
1870 const int last = args[2].data.sint ? smp->data.u.str.data - args[1].data.sint + 1 : smp->data.u.str.data;
1871 int max_size = trash->size - 2;
1872 int i;
1873 int start;
1874 int ptr = 0;
1875 unsigned long long number;
1876 char *pos;
1877
1878 trash->data = 0;
1879
1880 while (ptr < last && trash->data <= max_size) {
1881 start = trash->data;
1882 if (ptr) {
1883 /* Add separator */
1884 memcpy(trash->area + trash->data, args[0].data.str.area, args[0].data.str.data);
1885 trash->data += args[0].data.str.data;
1886 }
1887 else
1888 max_size -= args[0].data.str.data;
1889
1890 /* Add integer */
1891 for (number = 0, i = 0; i < args[1].data.sint && ptr < smp->data.u.str.data; i++)
1892 number = (number << 8) + (unsigned char)smp->data.u.str.area[ptr++];
1893
1894 pos = ulltoa(number, trash->area + trash->data, trash->size - trash->data);
1895 if (pos)
1896 trash->data = pos - trash->area;
1897 else {
1898 trash->data = start;
1899 break;
1900 }
1901 }
1902
1903 smp->data.u.str = *trash;
1904 smp->data.type = SMP_T_STR;
1905 smp->flags &= ~SMP_F_CONST;
1906 return 1;
1907}
1908
Marcin Deranekda0264a2021-07-13 14:08:56 +02001909static int sample_conv_be2hex_check(struct arg *args, struct sample_conv *conv,
1910 const char *file, int line, char **err)
1911{
1912 if (args[1].data.sint <= 0 && (args[0].data.str.data > 0 || args[2].data.sint != 0)) {
1913 memprintf(err, "chunk_size needs to be positive (%lld)", args[1].data.sint);
1914 return 0;
1915 }
1916
1917 if (args[2].data.sint != 0 && args[2].data.sint != 1) {
1918 memprintf(err, "Unsupported truncate value (%lld)", args[2].data.sint);
1919 return 0;
1920 }
1921
1922 return 1;
1923}
1924
1925/* Converts big-endian binary input sample to a hex string containing two hex
1926 * digits per input byte. <separator> is put every <chunk_size> binary input
1927 * bytes if specified. Optional <truncate> flag indicates if input is truncated
1928 * at <chunk_size> boundaries.
1929 * Arguments: separator (string), chunk_size (integer), truncate (0,1)
1930 */
1931static int sample_conv_be2hex(const struct arg *args, struct sample *smp, void *private)
1932{
1933 struct buffer *trash = get_trash_chunk();
1934 int chunk_size = args[1].data.sint;
1935 const int last = args[2].data.sint ? smp->data.u.str.data - chunk_size + 1 : smp->data.u.str.data;
1936 int i;
1937 int max_size;
1938 int ptr = 0;
1939 unsigned char c;
1940
1941 trash->data = 0;
1942 if (args[0].data.str.data == 0 && args[2].data.sint == 0)
1943 chunk_size = smp->data.u.str.data;
1944 max_size = trash->size - 2 * chunk_size;
1945
1946 while (ptr < last && trash->data <= max_size) {
1947 if (ptr) {
1948 /* Add separator */
1949 memcpy(trash->area + trash->data, args[0].data.str.area, args[0].data.str.data);
1950 trash->data += args[0].data.str.data;
1951 }
1952 else
1953 max_size -= args[0].data.str.data;
1954
1955 /* Add hex */
1956 for (i = 0; i < chunk_size && ptr < smp->data.u.str.data; i++) {
1957 c = smp->data.u.str.area[ptr++];
1958 trash->area[trash->data++] = hextab[(c >> 4) & 0xF];
1959 trash->area[trash->data++] = hextab[c & 0xF];
1960 }
1961 }
1962
1963 smp->data.u.str = *trash;
1964 smp->data.type = SMP_T_STR;
1965 smp->flags &= ~SMP_F_CONST;
1966 return 1;
1967}
1968
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02001969static int sample_conv_bin2hex(const struct arg *arg_p, struct sample *smp, void *private)
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01001970{
Willy Tarreau83061a82018-07-13 11:56:34 +02001971 struct buffer *trash = get_trash_chunk();
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01001972 unsigned char c;
1973 int ptr = 0;
1974
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001975 trash->data = 0;
1976 while (ptr < smp->data.u.str.data && trash->data <= trash->size - 2) {
1977 c = smp->data.u.str.area[ptr++];
1978 trash->area[trash->data++] = hextab[(c >> 4) & 0xF];
1979 trash->area[trash->data++] = hextab[c & 0xF];
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01001980 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02001981 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001982 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +01001983 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01001984 return 1;
1985}
1986
Dragan Dosen3f957b22017-10-24 09:27:34 +02001987static int sample_conv_hex2int(const struct arg *arg_p, struct sample *smp, void *private)
1988{
1989 long long int n = 0;
1990 int i, c;
1991
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001992 for (i = 0; i < smp->data.u.str.data; i++) {
1993 if ((c = hex2i(smp->data.u.str.area[i])) < 0)
Dragan Dosen3f957b22017-10-24 09:27:34 +02001994 return 0;
1995 n = (n << 4) + c;
1996 }
1997
1998 smp->data.u.sint = n;
1999 smp->data.type = SMP_T_SINT;
2000 smp->flags &= ~SMP_F_CONST;
2001 return 1;
2002}
2003
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002004/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002005static int sample_conv_djb2(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002006{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002007 smp->data.u.sint = hash_djb2(smp->data.u.str.area,
2008 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002009 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002010 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002011 smp->data.type = SMP_T_SINT;
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002012 return 1;
2013}
2014
Willy Tarreau60a2ee72017-12-15 07:13:48 +01002015static int sample_conv_length(const struct arg *arg_p, struct sample *smp, void *private)
Etienne Carriereed0d24e2017-12-13 13:41:34 +01002016{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002017 int i = smp->data.u.str.data;
Etienne Carriereed0d24e2017-12-13 13:41:34 +01002018 smp->data.u.sint = i;
2019 smp->data.type = SMP_T_SINT;
2020 return 1;
2021}
2022
2023
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002024static int sample_conv_str2lower(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun107ca302010-01-04 16:16:05 +01002025{
2026 int i;
2027
Willy Tarreauf0645dc2016-08-09 14:29:38 +02002028 if (!smp_make_rw(smp))
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +01002029 return 0;
2030
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002031 for (i = 0; i < smp->data.u.str.data; i++) {
2032 if ((smp->data.u.str.area[i] >= 'A') && (smp->data.u.str.area[i] <= 'Z'))
2033 smp->data.u.str.area[i] += 'a' - 'A';
Emeric Brun107ca302010-01-04 16:16:05 +01002034 }
2035 return 1;
2036}
2037
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002038static int sample_conv_str2upper(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun107ca302010-01-04 16:16:05 +01002039{
2040 int i;
2041
Willy Tarreauf0645dc2016-08-09 14:29:38 +02002042 if (!smp_make_rw(smp))
Emeric Brun485479d2010-09-23 18:02:19 +02002043 return 0;
2044
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002045 for (i = 0; i < smp->data.u.str.data; i++) {
2046 if ((smp->data.u.str.area[i] >= 'a') && (smp->data.u.str.area[i] <= 'z'))
2047 smp->data.u.str.area[i] += 'A' - 'a';
Emeric Brun107ca302010-01-04 16:16:05 +01002048 }
2049 return 1;
2050}
2051
Tim Duesterhus1478aa72018-01-25 16:24:51 +01002052/* takes the IPv4 mask in args[0] and an optional IPv6 mask in args[1] */
2053static int sample_conv_ipmask(const struct arg *args, struct sample *smp, void *private)
Willy Tarreaud31d6eb2010-01-26 18:01:41 +01002054{
Tim Duesterhus1478aa72018-01-25 16:24:51 +01002055 /* Attempt to convert to IPv4 to apply the correct mask. */
2056 c_ipv62ip(smp);
2057
2058 if (smp->data.type == SMP_T_IPV4) {
2059 smp->data.u.ipv4.s_addr &= args[0].data.ipv4.s_addr;
2060 smp->data.type = SMP_T_IPV4;
2061 }
2062 else if (smp->data.type == SMP_T_IPV6) {
2063 /* IPv6 cannot be converted without an IPv6 mask. */
2064 if (args[1].type != ARGT_IPV6)
2065 return 0;
2066
Willy Tarreaua8b7ecd2020-02-25 09:43:22 +01002067 write_u64(&smp->data.u.ipv6.s6_addr[0],
2068 read_u64(&smp->data.u.ipv6.s6_addr[0]) & read_u64(&args[1].data.ipv6.s6_addr[0]));
2069 write_u64(&smp->data.u.ipv6.s6_addr[8],
2070 read_u64(&smp->data.u.ipv6.s6_addr[8]) & read_u64(&args[1].data.ipv6.s6_addr[8]));
Tim Duesterhus1478aa72018-01-25 16:24:51 +01002071 smp->data.type = SMP_T_IPV6;
2072 }
2073
Willy Tarreaud31d6eb2010-01-26 18:01:41 +01002074 return 1;
2075}
2076
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002077/* takes an UINT value on input supposed to represent the time since EPOCH,
2078 * adds an optional offset found in args[1] and emits a string representing
2079 * the local time in the format specified in args[1] using strftime().
2080 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002081static int sample_conv_ltime(const struct arg *args, struct sample *smp, void *private)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002082{
Willy Tarreau83061a82018-07-13 11:56:34 +02002083 struct buffer *temp;
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002084 /* With high numbers, the date returned can be negative, the 55 bits mask prevent this. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002085 time_t curr_date = smp->data.u.sint & 0x007fffffffffffffLL;
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002086 struct tm tm;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002087
2088 /* add offset */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002089 if (args[1].type == ARGT_SINT)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002090 curr_date += args[1].data.sint;
2091
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002092 get_localtime(curr_date, &tm);
2093
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002094 temp = get_trash_chunk();
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002095 temp->data = strftime(temp->area, temp->size, args[0].data.str.area, &tm);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002096 smp->data.u.str = *temp;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002097 smp->data.type = SMP_T_STR;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002098 return 1;
2099}
2100
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002101/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002102static int sample_conv_sdbm(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002103{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002104 smp->data.u.sint = hash_sdbm(smp->data.u.str.area,
2105 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002106 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002107 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002108 smp->data.type = SMP_T_SINT;
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002109 return 1;
2110}
2111
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002112/* takes an UINT value on input supposed to represent the time since EPOCH,
2113 * adds an optional offset found in args[1] and emits a string representing
2114 * the UTC date in the format specified in args[1] using strftime().
2115 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002116static int sample_conv_utime(const struct arg *args, struct sample *smp, void *private)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002117{
Willy Tarreau83061a82018-07-13 11:56:34 +02002118 struct buffer *temp;
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002119 /* With high numbers, the date returned can be negative, the 55 bits mask prevent this. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002120 time_t curr_date = smp->data.u.sint & 0x007fffffffffffffLL;
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002121 struct tm tm;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002122
2123 /* add offset */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002124 if (args[1].type == ARGT_SINT)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002125 curr_date += args[1].data.sint;
2126
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002127 get_gmtime(curr_date, &tm);
2128
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002129 temp = get_trash_chunk();
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002130 temp->data = strftime(temp->area, temp->size, args[0].data.str.area, &tm);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002131 smp->data.u.str = *temp;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002132 smp->data.type = SMP_T_STR;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002133 return 1;
2134}
2135
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002136/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002137static int sample_conv_wt6(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002138{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002139 smp->data.u.sint = hash_wt6(smp->data.u.str.area,
2140 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002141 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002142 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002143 smp->data.type = SMP_T_SINT;
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002144 return 1;
2145}
2146
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002147/* hashes the binary input into a 32-bit unsigned int using xxh.
2148 * The seed of the hash defaults to 0 but can be changd in argument 1.
2149 */
2150static int sample_conv_xxh32(const struct arg *arg_p, struct sample *smp, void *private)
2151{
2152 unsigned int seed;
2153
Christopher Faulete6e7a582021-01-29 11:29:28 +01002154 if (arg_p->data.sint)
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002155 seed = arg_p->data.sint;
2156 else
2157 seed = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002158 smp->data.u.sint = XXH32(smp->data.u.str.area, smp->data.u.str.data,
2159 seed);
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002160 smp->data.type = SMP_T_SINT;
2161 return 1;
2162}
2163
2164/* hashes the binary input into a 64-bit unsigned int using xxh.
2165 * In fact, the function returns a 64 bit unsigned, but the sample
2166 * storage of haproxy only proposes 64-bits signed, so the value is
2167 * cast as signed. This cast doesn't impact the hash repartition.
2168 * The seed of the hash defaults to 0 but can be changd in argument 1.
2169 */
2170static int sample_conv_xxh64(const struct arg *arg_p, struct sample *smp, void *private)
2171{
2172 unsigned long long int seed;
2173
Christopher Faulete6e7a582021-01-29 11:29:28 +01002174 if (arg_p->data.sint)
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002175 seed = (unsigned long long int)arg_p->data.sint;
2176 else
2177 seed = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002178 smp->data.u.sint = (long long int)XXH64(smp->data.u.str.area,
2179 smp->data.u.str.data, seed);
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002180 smp->data.type = SMP_T_SINT;
2181 return 1;
2182}
2183
Dragan Dosen04bf0cc2020-12-22 21:44:33 +01002184static int sample_conv_xxh3(const struct arg *arg_p, struct sample *smp, void *private)
2185{
2186 unsigned long long int seed;
2187
Christopher Faulete6e7a582021-01-29 11:29:28 +01002188 if (arg_p->data.sint)
Dragan Dosen04bf0cc2020-12-22 21:44:33 +01002189 seed = (unsigned long long int)arg_p->data.sint;
2190 else
2191 seed = 0;
2192 smp->data.u.sint = (long long int)XXH3(smp->data.u.str.area,
2193 smp->data.u.str.data, seed);
2194 smp->data.type = SMP_T_SINT;
2195 return 1;
2196}
2197
Willy Tarreau80599772015-01-20 19:35:24 +01002198/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002199static int sample_conv_crc32(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau80599772015-01-20 19:35:24 +01002200{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002201 smp->data.u.sint = hash_crc32(smp->data.u.str.area,
2202 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002203 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002204 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002205 smp->data.type = SMP_T_SINT;
Willy Tarreau80599772015-01-20 19:35:24 +01002206 return 1;
2207}
2208
Emmanuel Hocdet50791a72018-03-21 11:19:01 +01002209/* hashes the binary input into crc32c (RFC4960, Appendix B [8].) */
2210static int sample_conv_crc32c(const struct arg *arg_p, struct sample *smp, void *private)
2211{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002212 smp->data.u.sint = hash_crc32c(smp->data.u.str.area,
2213 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002214 if (arg_p->data.sint)
Emmanuel Hocdet50791a72018-03-21 11:19:01 +01002215 smp->data.u.sint = full_hash(smp->data.u.sint);
2216 smp->data.type = SMP_T_SINT;
2217 return 1;
2218}
2219
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002220/* This function escape special json characters. The returned string can be
2221 * safely set between two '"' and used as json string. The json string is
2222 * defined like this:
2223 *
2224 * any Unicode character except '"' or '\' or control character
2225 * \", \\, \/, \b, \f, \n, \r, \t, \u + four-hex-digits
2226 *
2227 * The enum input_type contain all the allowed mode for decoding the input
2228 * string.
2229 */
2230enum input_type {
2231 IT_ASCII = 0,
2232 IT_UTF8,
2233 IT_UTF8S,
2234 IT_UTF8P,
2235 IT_UTF8PS,
2236};
William Dauchy5417e892021-01-08 21:57:41 +01002237
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002238static int sample_conv_json_check(struct arg *arg, struct sample_conv *conv,
2239 const char *file, int line, char **err)
2240{
Christopher Faulet95917132020-08-05 23:07:07 +02002241 enum input_type type;
2242
Christopher Faulet95917132020-08-05 23:07:07 +02002243 if (strcmp(arg->data.str.area, "") == 0)
2244 type = IT_ASCII;
2245 else if (strcmp(arg->data.str.area, "ascii") == 0)
2246 type = IT_ASCII;
2247 else if (strcmp(arg->data.str.area, "utf8") == 0)
2248 type = IT_UTF8;
2249 else if (strcmp(arg->data.str.area, "utf8s") == 0)
2250 type = IT_UTF8S;
2251 else if (strcmp(arg->data.str.area, "utf8p") == 0)
2252 type = IT_UTF8P;
2253 else if (strcmp(arg->data.str.area, "utf8ps") == 0)
2254 type = IT_UTF8PS;
2255 else {
2256 memprintf(err, "Unexpected input code type. "
2257 "Allowed value are 'ascii', 'utf8', 'utf8s', 'utf8p' and 'utf8ps'");
2258 return 0;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002259 }
2260
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002261 chunk_destroy(&arg->data.str);
Christopher Faulet95917132020-08-05 23:07:07 +02002262 arg->type = ARGT_SINT;
2263 arg->data.sint = type;
2264 return 1;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002265}
2266
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002267static int sample_conv_json(const struct arg *arg_p, struct sample *smp, void *private)
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002268{
Willy Tarreau83061a82018-07-13 11:56:34 +02002269 struct buffer *temp;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002270 char _str[7]; /* \u + 4 hex digit + null char for sprintf. */
2271 const char *str;
2272 int len;
2273 enum input_type input_type = IT_ASCII;
2274 unsigned int c;
2275 unsigned int ret;
2276 char *p;
2277
Christopher Faulete6e7a582021-01-29 11:29:28 +01002278 input_type = arg_p->data.sint;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002279
2280 temp = get_trash_chunk();
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002281 temp->data = 0;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002282
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002283 p = smp->data.u.str.area;
2284 while (p < smp->data.u.str.area + smp->data.u.str.data) {
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002285
2286 if (input_type == IT_ASCII) {
2287 /* Read input as ASCII. */
2288 c = *(unsigned char *)p;
2289 p++;
2290 }
2291 else {
2292 /* Read input as UTF8. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002293 ret = utf8_next(p,
2294 smp->data.u.str.data - ( p - smp->data.u.str.area),
2295 &c);
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002296 p += utf8_return_length(ret);
2297
2298 if (input_type == IT_UTF8 && utf8_return_code(ret) != UTF8_CODE_OK)
2299 return 0;
2300 if (input_type == IT_UTF8S && utf8_return_code(ret) != UTF8_CODE_OK)
2301 continue;
2302 if (input_type == IT_UTF8P && utf8_return_code(ret) & (UTF8_CODE_INVRANGE|UTF8_CODE_BADSEQ))
2303 return 0;
2304 if (input_type == IT_UTF8PS && utf8_return_code(ret) & (UTF8_CODE_INVRANGE|UTF8_CODE_BADSEQ))
2305 continue;
2306
2307 /* Check too big values. */
2308 if ((unsigned int)c > 0xffff) {
2309 if (input_type == IT_UTF8 || input_type == IT_UTF8P)
2310 return 0;
2311 continue;
2312 }
2313 }
2314
2315 /* Convert character. */
2316 if (c == '"') {
2317 len = 2;
2318 str = "\\\"";
2319 }
2320 else if (c == '\\') {
2321 len = 2;
2322 str = "\\\\";
2323 }
2324 else if (c == '/') {
2325 len = 2;
2326 str = "\\/";
2327 }
2328 else if (c == '\b') {
2329 len = 2;
2330 str = "\\b";
2331 }
2332 else if (c == '\f') {
2333 len = 2;
2334 str = "\\f";
2335 }
2336 else if (c == '\r') {
2337 len = 2;
2338 str = "\\r";
2339 }
2340 else if (c == '\n') {
2341 len = 2;
2342 str = "\\n";
2343 }
2344 else if (c == '\t') {
2345 len = 2;
2346 str = "\\t";
2347 }
Willy Tarreau90807112020-02-25 08:16:33 +01002348 else if (c > 0xff || !isprint((unsigned char)c)) {
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002349 /* isprint generate a segfault if c is too big. The man says that
2350 * c must have the value of an unsigned char or EOF.
2351 */
2352 len = 6;
2353 _str[0] = '\\';
2354 _str[1] = 'u';
2355 snprintf(&_str[2], 5, "%04x", (unsigned short)c);
2356 str = _str;
2357 }
2358 else {
2359 len = 1;
Willy Tarreau5715da22020-02-25 08:37:37 +01002360 _str[0] = c;
2361 str = _str;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002362 }
2363
2364 /* Check length */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002365 if (temp->data + len > temp->size)
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002366 return 0;
2367
2368 /* Copy string. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002369 memcpy(temp->area + temp->data, str, len);
2370 temp->data += len;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002371 }
2372
2373 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002374 smp->data.u.str = *temp;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002375 smp->data.type = SMP_T_STR;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002376
2377 return 1;
2378}
2379
Emeric Brun54c4ac82014-11-03 15:32:43 +01002380/* This sample function is designed to extract some bytes from an input buffer.
2381 * First arg is the offset.
2382 * Optional second arg is the length to truncate */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002383static int sample_conv_bytes(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun54c4ac82014-11-03 15:32:43 +01002384{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002385 if (smp->data.u.str.data <= arg_p[0].data.sint) {
2386 smp->data.u.str.data = 0;
Emeric Brun54c4ac82014-11-03 15:32:43 +01002387 return 1;
2388 }
2389
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002390 if (smp->data.u.str.size)
2391 smp->data.u.str.size -= arg_p[0].data.sint;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002392 smp->data.u.str.data -= arg_p[0].data.sint;
2393 smp->data.u.str.area += arg_p[0].data.sint;
Emeric Brun54c4ac82014-11-03 15:32:43 +01002394
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002395 if ((arg_p[1].type == ARGT_SINT) && (arg_p[1].data.sint < smp->data.u.str.data))
2396 smp->data.u.str.data = arg_p[1].data.sint;
Emeric Brun54c4ac82014-11-03 15:32:43 +01002397
2398 return 1;
2399}
2400
Emeric Brunf399b0d2014-11-03 17:07:03 +01002401static int sample_conv_field_check(struct arg *args, struct sample_conv *conv,
2402 const char *file, int line, char **err)
2403{
2404 struct arg *arg = args;
2405
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002406 if (arg->type != ARGT_SINT) {
Emeric Brunf399b0d2014-11-03 17:07:03 +01002407 memprintf(err, "Unexpected arg type");
2408 return 0;
2409 }
2410
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002411 if (!arg->data.sint) {
Emeric Brunf399b0d2014-11-03 17:07:03 +01002412 memprintf(err, "Unexpected value 0 for index");
2413 return 0;
2414 }
2415
2416 arg++;
2417
2418 if (arg->type != ARGT_STR) {
2419 memprintf(err, "Unexpected arg type");
2420 return 0;
2421 }
2422
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002423 if (!arg->data.str.data) {
Emeric Brunf399b0d2014-11-03 17:07:03 +01002424 memprintf(err, "Empty separators list");
2425 return 0;
2426 }
2427
2428 return 1;
2429}
2430
2431/* This sample function is designed to a return selected part of a string (field).
2432 * First arg is the index of the field (start at 1)
2433 * Second arg is a char list of separators (type string)
2434 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002435static int sample_conv_field(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brunf399b0d2014-11-03 17:07:03 +01002436{
Marcin Deranek9631a282018-04-16 14:30:46 +02002437 int field;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002438 char *start, *end;
2439 int i;
Marcin Deranek9631a282018-04-16 14:30:46 +02002440 int count = (arg_p[2].type == ARGT_SINT) ? arg_p[2].data.sint : 1;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002441
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002442 if (!arg_p[0].data.sint)
Emeric Brunf399b0d2014-11-03 17:07:03 +01002443 return 0;
2444
Marcin Deranek9631a282018-04-16 14:30:46 +02002445 if (arg_p[0].data.sint < 0) {
2446 field = -1;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002447 end = start = smp->data.u.str.area + smp->data.u.str.data;
2448 while (start > smp->data.u.str.area) {
2449 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2450 if (*(start-1) == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002451 if (field == arg_p[0].data.sint) {
2452 if (count == 1)
2453 goto found;
2454 else if (count > 1)
2455 count--;
2456 } else {
2457 end = start-1;
2458 field--;
2459 }
2460 break;
2461 }
Emeric Brunf399b0d2014-11-03 17:07:03 +01002462 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002463 start--;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002464 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002465 } else {
2466 field = 1;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002467 end = start = smp->data.u.str.area;
2468 while (end - smp->data.u.str.area < smp->data.u.str.data) {
2469 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2470 if (*end == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002471 if (field == arg_p[0].data.sint) {
2472 if (count == 1)
2473 goto found;
2474 else if (count > 1)
2475 count--;
2476 } else {
2477 start = end+1;
2478 field++;
2479 }
2480 break;
2481 }
2482 }
2483 end++;
2484 }
Emeric Brunf399b0d2014-11-03 17:07:03 +01002485 }
2486
2487 /* Field not found */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002488 if (field != arg_p[0].data.sint) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002489 smp->data.u.str.data = 0;
Tim Duesterhus4381d262019-10-16 15:11:15 +02002490 return 0;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002491 }
2492found:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002493 smp->data.u.str.data = end - start;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002494 /* If ret string is len 0, no need to
2495 change pointers or to update size */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002496 if (!smp->data.u.str.data)
Emeric Brunf399b0d2014-11-03 17:07:03 +01002497 return 1;
2498
Emeric Brunf399b0d2014-11-03 17:07:03 +01002499 /* Compute remaining size if needed
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002500 Note: smp->data.u.str.size cannot be set to 0 */
2501 if (smp->data.u.str.size)
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002502 smp->data.u.str.size -= start - smp->data.u.str.area;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002503
Thayne McCombsb2843052021-04-11 23:26:59 -06002504 smp->data.u.str.area = start;
2505
Emeric Brunf399b0d2014-11-03 17:07:03 +01002506 return 1;
2507}
2508
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002509/* This sample function is designed to return a word from a string.
2510 * First arg is the index of the word (start at 1)
2511 * Second arg is a char list of words separators (type string)
2512 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002513static int sample_conv_word(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002514{
Marcin Deranek9631a282018-04-16 14:30:46 +02002515 int word;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002516 char *start, *end;
2517 int i, issep, inword;
Marcin Deranek9631a282018-04-16 14:30:46 +02002518 int count = (arg_p[2].type == ARGT_SINT) ? arg_p[2].data.sint : 1;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002519
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002520 if (!arg_p[0].data.sint)
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002521 return 0;
2522
2523 word = 0;
2524 inword = 0;
Marcin Deranek9631a282018-04-16 14:30:46 +02002525 if (arg_p[0].data.sint < 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002526 end = start = smp->data.u.str.area + smp->data.u.str.data;
2527 while (start > smp->data.u.str.area) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002528 issep = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002529 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2530 if (*(start-1) == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002531 issep = 1;
2532 break;
2533 }
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002534 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002535 if (!inword) {
2536 if (!issep) {
2537 if (word != arg_p[0].data.sint) {
2538 word--;
2539 end = start;
2540 }
2541 inword = 1;
2542 }
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002543 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002544 else if (issep) {
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002545 if (word == arg_p[0].data.sint) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002546 if (count == 1)
2547 goto found;
2548 else if (count > 1)
2549 count--;
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002550 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002551 inword = 0;
2552 }
2553 start--;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002554 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002555 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002556 end = start = smp->data.u.str.area;
2557 while (end - smp->data.u.str.area < smp->data.u.str.data) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002558 issep = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002559 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2560 if (*end == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002561 issep = 1;
2562 break;
2563 }
2564 }
2565 if (!inword) {
2566 if (!issep) {
2567 if (word != arg_p[0].data.sint) {
2568 word++;
2569 start = end;
2570 }
2571 inword = 1;
2572 }
2573 }
2574 else if (issep) {
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002575 if (word == arg_p[0].data.sint) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002576 if (count == 1)
2577 goto found;
2578 else if (count > 1)
2579 count--;
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002580 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002581 inword = 0;
2582 }
2583 end++;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002584 }
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002585 }
2586
2587 /* Field not found */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002588 if (word != arg_p[0].data.sint) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002589 smp->data.u.str.data = 0;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002590 return 1;
2591 }
2592found:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002593 smp->data.u.str.data = end - start;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002594 /* If ret string is len 0, no need to
2595 change pointers or to update size */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002596 if (!smp->data.u.str.data)
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002597 return 1;
2598
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002599
2600 /* Compute remaining size if needed
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002601 Note: smp->data.u.str.size cannot be set to 0 */
2602 if (smp->data.u.str.size)
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002603 smp->data.u.str.size -= start - smp->data.u.str.area;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002604
Thayne McCombs6a0d2172022-05-25 22:58:51 -06002605 smp->data.u.str.area = start;
2606
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002607 return 1;
2608}
2609
Willy Tarreau7eda8492015-01-20 19:47:06 +01002610static int sample_conv_regsub_check(struct arg *args, struct sample_conv *conv,
2611 const char *file, int line, char **err)
2612{
2613 struct arg *arg = args;
2614 char *p;
2615 int len;
2616
2617 /* arg0 is a regex, it uses type_flag for ICASE and global match */
2618 arg[0].type_flags = 0;
2619
2620 if (arg[2].type != ARGT_STR)
2621 return 1;
2622
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002623 p = arg[2].data.str.area;
2624 len = arg[2].data.str.data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002625 while (len) {
2626 if (*p == 'i') {
2627 arg[0].type_flags |= ARGF_REG_ICASE;
2628 }
2629 else if (*p == 'g') {
2630 arg[0].type_flags |= ARGF_REG_GLOB;
2631 }
2632 else {
2633 memprintf(err, "invalid regex flag '%c', only 'i' and 'g' are supported", *p);
2634 return 0;
2635 }
2636 p++;
2637 len--;
2638 }
2639 return 1;
2640}
2641
2642/* This sample function is designed to do the equivalent of s/match/replace/ on
2643 * the input string. It applies a regex and restarts from the last matched
2644 * location until nothing matches anymore. First arg is the regex to apply to
2645 * the input string, second arg is the replacement expression.
2646 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002647static int sample_conv_regsub(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau7eda8492015-01-20 19:47:06 +01002648{
2649 char *start, *end;
2650 struct my_regex *reg = arg_p[0].data.reg;
2651 regmatch_t pmatch[MAX_MATCH];
Willy Tarreau83061a82018-07-13 11:56:34 +02002652 struct buffer *trash = get_trash_chunk();
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002653 struct buffer *output;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002654 int flag, max;
2655 int found;
2656
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002657 start = smp->data.u.str.area;
2658 end = start + smp->data.u.str.data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002659
2660 flag = 0;
2661 while (1) {
2662 /* check for last round which is used to copy remaining parts
2663 * when not running in global replacement mode.
2664 */
2665 found = 0;
2666 if ((arg_p[0].type_flags & ARGF_REG_GLOB) || !(flag & REG_NOTBOL)) {
2667 /* Note: we can have start == end on empty strings or at the end */
2668 found = regex_exec_match2(reg, start, end - start, MAX_MATCH, pmatch, flag);
2669 }
2670
2671 if (!found)
2672 pmatch[0].rm_so = end - start;
2673
2674 /* copy the heading non-matching part (which may also be the tail if nothing matches) */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002675 max = trash->size - trash->data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002676 if (max && pmatch[0].rm_so > 0) {
2677 if (max > pmatch[0].rm_so)
2678 max = pmatch[0].rm_so;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002679 memcpy(trash->area + trash->data, start, max);
2680 trash->data += max;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002681 }
2682
2683 if (!found)
2684 break;
2685
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002686 output = alloc_trash_chunk();
Willy Tarreau23997da2020-02-18 14:27:44 +01002687 if (!output)
2688 break;
2689
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002690 output->data = exp_replace(output->area, output->size, start, arg_p[1].data.str.area, pmatch);
2691
Willy Tarreau7eda8492015-01-20 19:47:06 +01002692 /* replace the matching part */
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002693 max = output->size - output->data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002694 if (max) {
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002695 if (max > output->data)
2696 max = output->data;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002697 memcpy(trash->area + trash->data,
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002698 output->area, max);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002699 trash->data += max;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002700 }
2701
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002702 free_trash_chunk(output);
2703
Willy Tarreau7eda8492015-01-20 19:47:06 +01002704 /* stop here if we're done with this string */
2705 if (start >= end)
2706 break;
2707
2708 /* We have a special case for matches of length 0 (eg: "x*y*").
2709 * These ones are considered to match in front of a character,
2710 * so we have to copy that character and skip to the next one.
2711 */
2712 if (!pmatch[0].rm_eo) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002713 if (trash->data < trash->size)
2714 trash->area[trash->data++] = start[pmatch[0].rm_eo];
Willy Tarreau7eda8492015-01-20 19:47:06 +01002715 pmatch[0].rm_eo++;
2716 }
2717
2718 start += pmatch[0].rm_eo;
2719 flag |= REG_NOTBOL;
2720 }
2721
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002722 smp->data.u.str = *trash;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002723 return 1;
2724}
2725
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002726/* This function check an operator entry. It expects a string.
2727 * The string can be an integer or a variable name.
2728 */
2729static int check_operator(struct arg *args, struct sample_conv *conv,
2730 const char *file, int line, char **err)
2731{
2732 const char *str;
2733 const char *end;
Christopher Faulet95917132020-08-05 23:07:07 +02002734 long long int i;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002735
2736 /* Try to decode a variable. */
2737 if (vars_check_arg(&args[0], NULL))
2738 return 1;
2739
2740 /* Try to convert an integer */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002741 str = args[0].data.str.area;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002742 end = str + strlen(str);
Christopher Faulet95917132020-08-05 23:07:07 +02002743 i = read_int64(&str, end);
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002744 if (*str != '\0') {
2745 memprintf(err, "expects an integer or a variable name");
2746 return 0;
2747 }
Christopher Faulet95917132020-08-05 23:07:07 +02002748
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002749 chunk_destroy(&args[0].data.str);
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002750 args[0].type = ARGT_SINT;
Christopher Faulet95917132020-08-05 23:07:07 +02002751 args[0].data.sint = i;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002752 return 1;
2753}
2754
Willy Tarreau6204cd92016-03-10 16:33:04 +01002755/* This function returns a sample struct filled with an arg content.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002756 * If the arg contain an integer, the integer is returned in the
2757 * sample. If the arg contains a variable descriptor, it returns the
2758 * variable value.
2759 *
2760 * This function returns 0 if an error occurs, otherwise it returns 1.
2761 */
Willy Tarreaud9be5992021-10-06 15:19:05 +02002762int sample_conv_var2smp_sint(const struct arg *arg, struct sample *smp)
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002763{
2764 switch (arg->type) {
2765 case ARGT_SINT:
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002766 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002767 smp->data.u.sint = arg->data.sint;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002768 return 1;
2769 case ARGT_VAR:
Willy Tarreau2476ff12021-10-06 15:30:52 +02002770 return sample_conv_var2smp(&arg->data.var, smp, SMP_T_SINT);
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002771 default:
2772 return 0;
2773 }
2774}
2775
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02002776/* Takes a SINT on input, applies a binary twos complement and returns the SINT
Willy Tarreau97707872015-01-27 15:12:13 +01002777 * result.
2778 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002779static int sample_conv_binary_cpl(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01002780{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002781 smp->data.u.sint = ~smp->data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01002782 return 1;
2783}
2784
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002785/* Takes a SINT on input, applies a binary "and" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08002786 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01002787 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002788static int sample_conv_binary_and(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01002789{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002790 struct sample tmp;
2791
Willy Tarreau7560dd42016-03-10 16:28:58 +01002792 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreaud9be5992021-10-06 15:19:05 +02002793 if (!sample_conv_var2smp_sint(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002794 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002795 smp->data.u.sint &= tmp.data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01002796 return 1;
2797}
2798
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002799/* Takes a SINT on input, applies a binary "or" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08002800 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01002801 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002802static int sample_conv_binary_or(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01002803{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002804 struct sample tmp;
2805
Willy Tarreau7560dd42016-03-10 16:28:58 +01002806 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreaud9be5992021-10-06 15:19:05 +02002807 if (!sample_conv_var2smp_sint(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002808 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002809 smp->data.u.sint |= tmp.data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01002810 return 1;
2811}
2812
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002813/* Takes a SINT on input, applies a binary "xor" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08002814 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01002815 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002816static int sample_conv_binary_xor(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01002817{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002818 struct sample tmp;
2819
Willy Tarreau7560dd42016-03-10 16:28:58 +01002820 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreaud9be5992021-10-06 15:19:05 +02002821 if (!sample_conv_var2smp_sint(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002822 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002823 smp->data.u.sint ^= tmp.data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01002824 return 1;
2825}
2826
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002827static inline long long int arith_add(long long int a, long long int b)
2828{
2829 /* Prevent overflow and makes capped calculus.
2830 * We must ensure that the check calculus doesn't
2831 * exceed the signed 64 bits limits.
2832 *
2833 * +----------+----------+
2834 * | a<0 | a>=0 |
2835 * +------+----------+----------+
2836 * | b<0 | MIN-a>b | no check |
2837 * +------+----------+----------+
2838 * | b>=0 | no check | MAX-a<b |
2839 * +------+----------+----------+
2840 */
2841 if ((a ^ b) >= 0) {
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05002842 /* signs are different. */
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002843 if (a < 0) {
2844 if (LLONG_MIN - a > b)
2845 return LLONG_MIN;
2846 }
2847 if (LLONG_MAX - a < b)
2848 return LLONG_MAX;
2849 }
2850 return a + b;
2851}
2852
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002853/* Takes a SINT on input, applies an arithmetic "add" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08002854 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01002855 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002856static int sample_conv_arith_add(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01002857{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002858 struct sample tmp;
2859
Willy Tarreau7560dd42016-03-10 16:28:58 +01002860 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreaud9be5992021-10-06 15:19:05 +02002861 if (!sample_conv_var2smp_sint(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002862 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002863 smp->data.u.sint = arith_add(smp->data.u.sint, tmp.data.u.sint);
Willy Tarreau97707872015-01-27 15:12:13 +01002864 return 1;
2865}
2866
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002867/* Takes a SINT on input, applies an arithmetic "sub" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08002868 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01002869 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002870static int sample_conv_arith_sub(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01002871 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01002872{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002873 struct sample tmp;
2874
Willy Tarreau7560dd42016-03-10 16:28:58 +01002875 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreaud9be5992021-10-06 15:19:05 +02002876 if (!sample_conv_var2smp_sint(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002877 return 0;
2878
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002879 /* We cannot represent -LLONG_MIN because abs(LLONG_MIN) is greater
2880 * than abs(LLONG_MAX). So, the following code use LLONG_MAX in place
2881 * of -LLONG_MIN and correct the result.
2882 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002883 if (tmp.data.u.sint == LLONG_MIN) {
2884 smp->data.u.sint = arith_add(smp->data.u.sint, LLONG_MAX);
2885 if (smp->data.u.sint < LLONG_MAX)
2886 smp->data.u.sint++;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002887 return 1;
2888 }
2889
Joseph Herlant757f5ad2018-11-15 12:14:56 -08002890 /* standard subtraction: we use the "add" function and negate
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002891 * the second operand.
2892 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002893 smp->data.u.sint = arith_add(smp->data.u.sint, -tmp.data.u.sint);
Willy Tarreau97707872015-01-27 15:12:13 +01002894 return 1;
2895}
2896
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002897/* Takes a SINT on input, applies an arithmetic "mul" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08002898 * arg_p or in the variable described in arg_p, and returns the SINT result.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002899 * If the result makes an overflow, then the largest possible quantity is
2900 * returned.
Willy Tarreau97707872015-01-27 15:12:13 +01002901 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002902static int sample_conv_arith_mul(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01002903 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01002904{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002905 struct sample tmp;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002906 long long int c;
2907
Willy Tarreau7560dd42016-03-10 16:28:58 +01002908 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreaud9be5992021-10-06 15:19:05 +02002909 if (!sample_conv_var2smp_sint(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002910 return 0;
2911
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002912 /* prevent divide by 0 during the check */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002913 if (!smp->data.u.sint || !tmp.data.u.sint) {
2914 smp->data.u.sint = 0;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002915 return 1;
2916 }
2917
2918 /* The multiply between LLONG_MIN and -1 returns a
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05002919 * "floating point exception".
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002920 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002921 if (smp->data.u.sint == LLONG_MIN && tmp.data.u.sint == -1) {
2922 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002923 return 1;
2924 }
2925
2926 /* execute standard multiplication. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002927 c = smp->data.u.sint * tmp.data.u.sint;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002928
2929 /* check for overflow and makes capped multiply. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002930 if (smp->data.u.sint != c / tmp.data.u.sint) {
2931 if ((smp->data.u.sint < 0) == (tmp.data.u.sint < 0)) {
2932 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002933 return 1;
2934 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002935 smp->data.u.sint = LLONG_MIN;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002936 return 1;
2937 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002938 smp->data.u.sint = c;
Willy Tarreau97707872015-01-27 15:12:13 +01002939 return 1;
2940}
2941
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002942/* Takes a SINT on input, applies an arithmetic "div" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08002943 * arg_p or in the variable described in arg_p, and returns the SINT result.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002944 * If arg_p makes the result overflow, then the largest possible quantity is
2945 * returned.
Willy Tarreau97707872015-01-27 15:12:13 +01002946 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002947static int sample_conv_arith_div(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01002948 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01002949{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002950 struct sample tmp;
2951
Willy Tarreau7560dd42016-03-10 16:28:58 +01002952 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreaud9be5992021-10-06 15:19:05 +02002953 if (!sample_conv_var2smp_sint(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002954 return 0;
2955
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002956 if (tmp.data.u.sint) {
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002957 /* The divide between LLONG_MIN and -1 returns a
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05002958 * "floating point exception".
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002959 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002960 if (smp->data.u.sint == LLONG_MIN && tmp.data.u.sint == -1) {
2961 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002962 return 1;
2963 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002964 smp->data.u.sint /= tmp.data.u.sint;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002965 return 1;
2966 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002967 smp->data.u.sint = LLONG_MAX;
Willy Tarreau97707872015-01-27 15:12:13 +01002968 return 1;
2969}
2970
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002971/* Takes a SINT on input, applies an arithmetic "mod" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08002972 * arg_p or in the variable described in arg_p, and returns the SINT result.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002973 * If arg_p makes the result overflow, then 0 is returned.
Willy Tarreau97707872015-01-27 15:12:13 +01002974 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002975static int sample_conv_arith_mod(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01002976 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01002977{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002978 struct sample tmp;
2979
Willy Tarreau7560dd42016-03-10 16:28:58 +01002980 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreaud9be5992021-10-06 15:19:05 +02002981 if (!sample_conv_var2smp_sint(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002982 return 0;
2983
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002984 if (tmp.data.u.sint) {
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002985 /* The divide between LLONG_MIN and -1 returns a
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05002986 * "floating point exception".
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002987 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002988 if (smp->data.u.sint == LLONG_MIN && tmp.data.u.sint == -1) {
2989 smp->data.u.sint = 0;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002990 return 1;
2991 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002992 smp->data.u.sint %= tmp.data.u.sint;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02002993 return 1;
2994 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002995 smp->data.u.sint = 0;
Willy Tarreau97707872015-01-27 15:12:13 +01002996 return 1;
2997}
2998
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02002999/* Takes an SINT on input, applies an arithmetic "neg" and returns the SINT
Willy Tarreau97707872015-01-27 15:12:13 +01003000 * result.
3001 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003002static int sample_conv_arith_neg(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003003 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003004{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003005 if (smp->data.u.sint == LLONG_MIN)
3006 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003007 else
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003008 smp->data.u.sint = -smp->data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01003009 return 1;
3010}
3011
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003012/* Takes a SINT on input, returns true is the value is non-null, otherwise
Willy Tarreau97707872015-01-27 15:12:13 +01003013 * false. The output is a BOOL.
3014 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003015static int sample_conv_arith_bool(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003016 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003017{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003018 smp->data.u.sint = !!smp->data.u.sint;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003019 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003020 return 1;
3021}
3022
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003023/* Takes a SINT on input, returns false is the value is non-null, otherwise
Willy Tarreau97707872015-01-27 15:12:13 +01003024 * truee. The output is a BOOL.
3025 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003026static int sample_conv_arith_not(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003027 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003028{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003029 smp->data.u.sint = !smp->data.u.sint;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003030 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003031 return 1;
3032}
3033
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003034/* Takes a SINT on input, returns true is the value is odd, otherwise false.
Willy Tarreau97707872015-01-27 15:12:13 +01003035 * The output is a BOOL.
3036 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003037static int sample_conv_arith_odd(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003038 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003039{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003040 smp->data.u.sint = smp->data.u.sint & 1;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003041 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003042 return 1;
3043}
3044
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003045/* Takes a SINT on input, returns true is the value is even, otherwise false.
Willy Tarreau97707872015-01-27 15:12:13 +01003046 * The output is a BOOL.
3047 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003048static int sample_conv_arith_even(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003049 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003050{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003051 smp->data.u.sint = !(smp->data.u.sint & 1);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003052 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003053 return 1;
3054}
3055
Willy Tarreau280f42b2018-02-19 15:34:12 +01003056/* appends an optional const string, an optional variable contents and another
3057 * optional const string to an existing string.
3058 */
3059static int sample_conv_concat(const struct arg *arg_p, struct sample *smp, void *private)
3060{
Willy Tarreau83061a82018-07-13 11:56:34 +02003061 struct buffer *trash;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003062 struct sample tmp;
3063 int max;
3064
Willy Tarreau591fc3a2021-01-08 16:08:43 +01003065 trash = alloc_trash_chunk();
William Dauchye9970102021-01-11 11:05:58 +01003066 if (!trash)
3067 return 0;
3068
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003069 trash->data = smp->data.u.str.data;
3070 if (trash->data > trash->size - 1)
3071 trash->data = trash->size - 1;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003072
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003073 memcpy(trash->area, smp->data.u.str.area, trash->data);
3074 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003075
3076 /* append first string */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003077 max = arg_p[0].data.str.data;
3078 if (max > trash->size - 1 - trash->data)
3079 max = trash->size - 1 - trash->data;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003080
3081 if (max) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003082 memcpy(trash->area + trash->data, arg_p[0].data.str.area, max);
3083 trash->data += max;
3084 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003085 }
3086
3087 /* append second string (variable) if it's found and we can turn it
3088 * into a string.
3089 */
3090 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreaue352b9d2021-09-03 11:52:38 +02003091 if (arg_p[1].type == ARGT_VAR && vars_get_by_desc(&arg_p[1].data.var, &tmp, NULL) &&
Willy Tarreau280f42b2018-02-19 15:34:12 +01003092 (sample_casts[tmp.data.type][SMP_T_STR] == c_none ||
3093 sample_casts[tmp.data.type][SMP_T_STR](&tmp))) {
3094
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003095 max = tmp.data.u.str.data;
3096 if (max > trash->size - 1 - trash->data)
3097 max = trash->size - 1 - trash->data;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003098
3099 if (max) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003100 memcpy(trash->area + trash->data, tmp.data.u.str.area,
3101 max);
3102 trash->data += max;
3103 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003104 }
3105 }
3106
3107 /* append third string */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003108 max = arg_p[2].data.str.data;
3109 if (max > trash->size - 1 - trash->data)
3110 max = trash->size - 1 - trash->data;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003111
3112 if (max) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003113 memcpy(trash->area + trash->data, arg_p[2].data.str.area, max);
3114 trash->data += max;
3115 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003116 }
3117
3118 smp->data.u.str = *trash;
3119 smp->data.type = SMP_T_STR;
Willy Tarreau591fc3a2021-01-08 16:08:43 +01003120 smp_dup(smp);
3121 free_trash_chunk(trash);
Willy Tarreau280f42b2018-02-19 15:34:12 +01003122 return 1;
3123}
3124
3125/* This function checks the "concat" converter's arguments and extracts the
3126 * variable name and its scope.
3127 */
3128static int smp_check_concat(struct arg *args, struct sample_conv *conv,
3129 const char *file, int line, char **err)
3130{
3131 /* Try to decode a variable. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003132 if (args[1].data.str.data > 0 && !vars_check_arg(&args[1], NULL)) {
3133 memprintf(err, "failed to register variable name '%s'",
3134 args[1].data.str.area);
Willy Tarreau280f42b2018-02-19 15:34:12 +01003135 return 0;
3136 }
3137 return 1;
3138}
3139
Nikola Sale0dbf0382022-04-03 18:11:53 +02003140/* Append delimiter (only to a non empty input) followed by the optional
3141 * variable contents concatenated with the optional sufix.
3142 */
3143static int sample_conv_add_item(const struct arg *arg_p, struct sample *smp, void *private)
3144{
3145 struct buffer *tmpbuf;
3146 struct sample tmp;
3147 size_t max;
3148 int var_available;
3149
3150 tmpbuf = alloc_trash_chunk();
3151 if (!tmpbuf)
3152 return 0;
3153
3154 tmpbuf->data = smp->data.u.str.data;
3155 if (tmpbuf->data > tmpbuf->size - 1)
3156 tmpbuf->data = tmpbuf->size - 1;
3157
3158 memcpy(tmpbuf->area, smp->data.u.str.area, tmpbuf->data);
3159 tmpbuf->area[tmpbuf->data] = 0;
3160
3161 /* Check if variable is found and we can turn into a string. */
3162 var_available = 0;
3163 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
3164 if (arg_p[1].type == ARGT_VAR && vars_get_by_desc(&arg_p[1].data.var, &tmp, NULL) &&
3165 (sample_casts[tmp.data.type][SMP_T_STR] == c_none ||
3166 sample_casts[tmp.data.type][SMP_T_STR](&tmp)))
3167 var_available = 1;
3168
3169 /* Append delimiter only if input is not empty and either
3170 * the variable or the suffix are not empty
3171 */
3172 if (smp->data.u.str.data && ((var_available && tmp.data.u.str.data) ||
3173 arg_p[2].data.str.data)) {
3174 max = arg_p[0].data.str.data;
3175 if (max > tmpbuf->size - 1 - tmpbuf->data)
3176 max = tmpbuf->size - 1 - tmpbuf->data;
3177
3178 if (max) {
3179 memcpy(tmpbuf->area + tmpbuf->data, arg_p[0].data.str.area, max);
3180 tmpbuf->data += max;
3181 tmpbuf->area[tmpbuf->data] = 0;
3182 }
3183 }
3184
3185 /* Append variable contents if variable is found and turned into string. */
3186 if (var_available) {
3187 max = tmp.data.u.str.data;
3188 if (max > tmpbuf->size - 1 - tmpbuf->data)
3189 max = tmpbuf->size - 1 - tmpbuf->data;
3190
3191 if (max) {
3192 memcpy(tmpbuf->area + tmpbuf->data, tmp.data.u.str.area, max);
3193 tmpbuf->data += max;
3194 tmpbuf->area[tmpbuf->data] = 0;
3195 }
3196 }
3197
3198 /* Append optional suffix. */
3199 max = arg_p[2].data.str.data;
3200 if (max > tmpbuf->size - 1 - tmpbuf->data)
3201 max = tmpbuf->size - 1 - tmpbuf->data;
3202
3203 if (max) {
3204 memcpy(tmpbuf->area + tmpbuf->data, arg_p[2].data.str.area, max);
3205 tmpbuf->data += max;
3206 tmpbuf->area[tmpbuf->data] = 0;
3207 }
3208
3209 smp->data.u.str = *tmpbuf;
3210 smp->data.type = SMP_T_STR;
3211 smp_dup(smp);
3212 free_trash_chunk(tmpbuf);
3213 return 1;
3214}
3215
3216/* Check the "add_item" converter's arguments and extracts the
3217 * variable name and its scope.
3218 */
3219static int smp_check_add_item(struct arg *args, struct sample_conv *conv,
3220 const char *file, int line, char **err)
3221{
3222 /* Try to decode a variable. */
3223 if (args[1].data.str.data > 0 && !vars_check_arg(&args[1], NULL)) {
3224 memprintf(err, "failed to register variable name '%s'",
3225 args[1].data.str.area);
3226 return 0;
3227 }
3228
3229 if (args[1].data.str.data == 0 && args[2].data.str.data == 0) {
3230 memprintf(err, "one of the optional arguments has to be nonempty");
3231 return 0;
3232 }
3233
3234 return 1;
3235}
3236
Tim Duesterhusf38175c2020-06-09 11:48:42 +02003237/* Compares string with a variable containing a string. Return value
Tim Duesterhusca097c12018-04-27 21:18:45 +02003238 * is compatible with strcmp(3)'s return value.
3239 */
3240static int sample_conv_strcmp(const struct arg *arg_p, struct sample *smp, void *private)
3241{
3242 struct sample tmp;
3243 int max, result;
3244
3245 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
3246 if (arg_p[0].type != ARGT_VAR)
3247 return 0;
Willy Tarreau2476ff12021-10-06 15:30:52 +02003248
3249 if (!sample_conv_var2smp(&arg_p[0].data.var, &tmp, SMP_T_STR))
Tim Duesterhusca097c12018-04-27 21:18:45 +02003250 return 0;
3251
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003252 max = MIN(smp->data.u.str.data, tmp.data.u.str.data);
3253 result = strncmp(smp->data.u.str.area, tmp.data.u.str.area, max);
Tim Duesterhusca097c12018-04-27 21:18:45 +02003254 if (result == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003255 if (smp->data.u.str.data != tmp.data.u.str.data) {
3256 if (smp->data.u.str.data < tmp.data.u.str.data) {
Tim Duesterhusca097c12018-04-27 21:18:45 +02003257 result = -1;
3258 }
3259 else {
3260 result = 1;
3261 }
3262 }
3263 }
3264
3265 smp->data.u.sint = result;
3266 smp->data.type = SMP_T_SINT;
3267 return 1;
3268}
William Lallemanddd754cb2022-08-26 16:21:28 +02003269/*
3270 * This converter can takes a Host header value as defined by rfc9110#section-7.2
3271 * Host = uri-host [ ":" port ] ;
3272 * It returns the uri-host value in lowecase with the port stripped.
3273 */
3274static int sample_conv_host_only(const struct arg *arg_p, struct sample *smp, void *private)
3275{
3276 /* Working cases: hostname00, hostname00:80, 127.0.0.1, 127.0.0.1:80, [::1], [::1]:80 */
3277 char *beg = smp->data.u.str.area;
3278 char *end = smp->data.u.str.area + smp->data.u.str.data - 1;
3279 char *p;
3280
3281 for (p = end; p >= beg; p--) {
3282 if (*p == ':' || *p == ']')
3283 break;
3284 }
3285
3286 if (p >= beg && *p == ':')
3287 smp->data.u.str.data = p - beg;
3288 /* if no port part was found, the hostname is the whole string */
3289
3290 smp->data.type = SMP_T_STR;
3291
3292 return sample_conv_str2lower(arg_p, smp, NULL);
3293}
3294
3295/*
3296 * This converter can takes a Host header value as defined by rfc9110#section-7.2
3297 * Host = uri-host [ ":" port ] ;
3298 * It returns the port value as a int.
3299 */
3300static int sample_conv_port_only(const struct arg *arg_p, struct sample *smp, void *private)
3301{
3302 /* Working cases: hostname00, hostname00:80, 127.0.0.1, 127.0.0.1:80, [::1], [::1]:80 */
3303 char *beg = smp->data.u.str.area;
3304 char *end = smp->data.u.str.area + smp->data.u.str.data - 1;
3305 char *p;
3306
3307 for (p = end; p >= beg; p--) {
3308 if (*p == ':' || *p == ']')
3309 break;
3310 }
3311
3312 smp->data.type = SMP_T_SINT;
3313 if (p >= beg && *p == ':' && ++p <= end) {
3314 smp->data.u.sint = strl2ui(p, smp->data.u.str.data + smp->data.u.str.area - p);
3315 } else {
3316 smp->data.u.sint = 0;
3317 }
3318 return 1;
3319}
3320
Tim Duesterhusca097c12018-04-27 21:18:45 +02003321
Tim Duesterhus3943e4f2020-09-11 14:25:23 +02003322/* Takes a boolean as input. Returns the first argument if that boolean is true and
3323 * the second argument otherwise.
3324 */
3325static int sample_conv_iif(const struct arg *arg_p, struct sample *smp, void *private)
3326{
3327 smp->data.type = SMP_T_STR;
3328 smp->flags |= SMP_F_CONST;
3329
3330 if (smp->data.u.sint) {
3331 smp->data.u.str.data = arg_p[0].data.str.data;
3332 smp->data.u.str.area = arg_p[0].data.str.area;
3333 }
3334 else {
3335 smp->data.u.str.data = arg_p[1].data.str.data;
3336 smp->data.u.str.area = arg_p[1].data.str.area;
3337 }
3338
3339 return 1;
3340}
3341
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003342#define GRPC_MSG_COMPRESS_FLAG_SZ 1 /* 1 byte */
3343#define GRPC_MSG_LENGTH_SZ 4 /* 4 bytes */
3344#define GRPC_MSG_HEADER_SZ (GRPC_MSG_COMPRESS_FLAG_SZ + GRPC_MSG_LENGTH_SZ)
3345
3346/*
3347 * Extract the field value of an input binary sample. Takes a mandatory argument:
3348 * the protocol buffers field identifier (dotted notation) internally represented
3349 * as an array of unsigned integers and its size.
3350 * Return 1 if the field was found, 0 if not.
3351 */
3352static int sample_conv_ungrpc(const struct arg *arg_p, struct sample *smp, void *private)
3353{
3354 unsigned char *pos;
3355 size_t grpc_left;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003356
3357 pos = (unsigned char *)smp->data.u.str.area;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003358 grpc_left = smp->data.u.str.data;
3359
Frédéric Lécaille7c93e882019-03-04 07:33:41 +01003360 while (grpc_left > GRPC_MSG_HEADER_SZ) {
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003361 size_t grpc_msg_len, left;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003362
3363 grpc_msg_len = left = ntohl(*(uint32_t *)(pos + GRPC_MSG_COMPRESS_FLAG_SZ));
3364
3365 pos += GRPC_MSG_HEADER_SZ;
3366 grpc_left -= GRPC_MSG_HEADER_SZ;
3367
3368 if (grpc_left < left)
3369 return 0;
3370
Frédéric Lécaille5f33f852019-03-06 08:03:44 +01003371 if (protobuf_field_lookup(arg_p, smp, &pos, &left))
3372 return 1;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003373
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003374 grpc_left -= grpc_msg_len;
3375 }
3376
3377 return 0;
3378}
3379
Frédéric Lécaillebfe61382019-03-06 14:34:36 +01003380static int sample_conv_protobuf(const struct arg *arg_p, struct sample *smp, void *private)
3381{
3382 unsigned char *pos;
3383 size_t left;
3384
3385 pos = (unsigned char *)smp->data.u.str.area;
3386 left = smp->data.u.str.data;
3387
3388 return protobuf_field_lookup(arg_p, smp, &pos, &left);
3389}
3390
3391static int sample_conv_protobuf_check(struct arg *args, struct sample_conv *conv,
3392 const char *file, int line, char **err)
Frédéric Lécaille756d97f2019-03-04 19:03:48 +01003393{
3394 if (!args[1].type) {
3395 args[1].type = ARGT_SINT;
3396 args[1].data.sint = PBUF_T_BINARY;
3397 }
3398 else {
3399 int pbuf_type;
3400
3401 pbuf_type = protobuf_type(args[1].data.str.area);
3402 if (pbuf_type == -1) {
3403 memprintf(err, "Wrong protocol buffer type '%s'", args[1].data.str.area);
3404 return 0;
3405 }
3406
Christopher Faulet6ad7df42020-08-07 11:45:18 +02003407 chunk_destroy(&args[1].data.str);
Frédéric Lécaille756d97f2019-03-04 19:03:48 +01003408 args[1].type = ARGT_SINT;
3409 args[1].data.sint = pbuf_type;
3410 }
3411
3412 return 1;
3413}
3414
Baptiste Assmanne138dda2020-10-22 15:39:03 +02003415/*
3416 * Extract the tag value of an input binary sample. Takes a mandatory argument:
3417 * the FIX protocol tag identifier.
3418 * Return 1 if the tag was found, 0 if not.
3419 */
3420static int sample_conv_fix_tag_value(const struct arg *arg_p, struct sample *smp, void *private)
3421{
3422 struct ist value;
3423
3424 smp->flags &= ~SMP_F_MAY_CHANGE;
3425 value = fix_tag_value(ist2(smp->data.u.str.area, smp->data.u.str.data),
3426 arg_p[0].data.sint);
3427 if (!istlen(value)) {
Christopher Fauleta5aa0822021-10-13 17:58:53 +02003428 if (isttest(value)) {
Baptiste Assmanne138dda2020-10-22 15:39:03 +02003429 /* value != IST_NULL, need more data */
3430 smp->flags |= SMP_F_MAY_CHANGE;
3431 }
3432 return 0;
3433 }
3434
3435 smp->data.u.str = ist2buf(value);
3436 smp->flags |= SMP_F_CONST;
3437
3438 return 1;
3439}
3440
3441/* This function checks the "fix_tag_value" converter configuration.
3442 * It expects a "known" (by HAProxy) tag name or ID.
3443 * Tag string names are converted to their ID counterpart because this is the
3444 * format they are sent over the wire.
3445 */
3446static int sample_conv_fix_value_check(struct arg *args, struct sample_conv *conv,
3447 const char *file, int line, char **err)
3448{
3449 struct ist str;
3450 unsigned int tag;
3451
3452 str = ist2(args[0].data.str.area, args[0].data.str.data);
3453 tag = fix_tagid(str);
3454 if (!tag) {
3455 memprintf(err, "Unknown FIX tag name '%s'", args[0].data.str.area);
3456 return 0;
3457 }
3458
3459 chunk_destroy(&args[0].data.str);
3460 args[0].type = ARGT_SINT;
3461 args[0].data.sint = tag;
3462
3463 return 1;
3464}
3465
3466/*
3467 * Checks that a buffer contains a valid FIX message
3468 *
3469 * Return 1 if the check could be run, 0 if not.
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05003470 * The result of the analyse itself is stored in <smp> as a boolean
Baptiste Assmanne138dda2020-10-22 15:39:03 +02003471 */
3472static int sample_conv_fix_is_valid(const struct arg *arg_p, struct sample *smp, void *private)
3473{
3474 struct ist msg;
3475
3476 msg = ist2(smp->data.u.str.area, smp->data.u.str.data);
3477
3478 smp->flags &= ~SMP_F_MAY_CHANGE;
3479 switch (fix_validate_message(msg)) {
3480 case FIX_VALID_MESSAGE:
3481 smp->data.type = SMP_T_BOOL;
3482 smp->data.u.sint = 1;
3483 return 1;
3484 case FIX_NEED_MORE_DATA:
3485 smp->flags |= SMP_F_MAY_CHANGE;
3486 return 0;
3487 case FIX_INVALID_MESSAGE:
3488 smp->data.type = SMP_T_BOOL;
3489 smp->data.u.sint = 0;
3490 return 1;
3491 }
3492 return 0;
3493}
3494
Baptiste Assmanne279ca62020-10-27 18:10:06 +01003495/*
3496 * Extract the field value of an input binary sample containing an MQTT packet.
3497 * Takes 2 mandatory arguments:
3498 * - packet type
3499 * - field name
3500 *
3501 * return 1 if the field was found, 0 if not.
3502 */
3503static int sample_conv_mqtt_field_value(const struct arg *arg_p, struct sample *smp, void *private)
3504{
3505 struct ist pkt, value;
3506 int type, fieldname_id;
3507
3508 pkt = ist2(smp->data.u.str.area, smp->data.u.str.data);
3509 type = arg_p[0].data.sint;
3510 fieldname_id = arg_p[1].data.sint;
3511
3512 smp->flags &= ~SMP_F_MAY_CHANGE;
3513 value = mqtt_field_value(pkt, type, fieldname_id);
3514 if (!istlen(value)) {
3515 if (isttest(value)) {
3516 /* value != IST_NULL, need more data */
3517 smp->flags |= SMP_F_MAY_CHANGE;
3518 }
3519 return 0;
3520 }
3521
3522 smp->data.u.str = ist2buf(value);
3523 smp->flags |= SMP_F_CONST;
3524 return 1;
3525}
3526
3527/*
3528 * this function checks the "mqtt_field_value" converter configuration.
3529 * It expects a known packet type name or ID and a field name, in this order
3530 *
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05003531 * Args[0] will be turned into a MQTT_CPT_* value for direct matching when parsing
Baptiste Assmanne279ca62020-10-27 18:10:06 +01003532 * a packet.
3533 */
3534static int sample_conv_mqtt_field_value_check(struct arg *args, struct sample_conv *conv,
3535 const char *file, int line, char **err)
3536{
3537 int type, fieldname_id;
3538
3539 /* check the MQTT packet type is valid */
3540 type = mqtt_typeid(ist2(args[0].data.str.area, args[0].data.str.data));
3541 if (type == MQTT_CPT_INVALID) {
3542 memprintf(err, "Unknown MQTT type '%s'", args[0].data.str.area);
3543 return 0;
3544 }
3545
3546 /* check the field name belongs to the MQTT packet type */
3547 fieldname_id = mqtt_check_type_fieldname(type, ist2(args[1].data.str.area, args[1].data.str.data));
3548 if (fieldname_id == MQTT_FN_INVALID) {
3549 memprintf(err, "Unknown MQTT field name '%s' for packet type '%s'", args[1].data.str.area,
3550 args[0].data.str.area);
3551 return 0;
3552 }
3553
3554 /* save numeric counterparts of type and field name */
3555 chunk_destroy(&args[0].data.str);
3556 chunk_destroy(&args[1].data.str);
3557 args[0].type = ARGT_SINT;
3558 args[0].data.sint = type;
3559 args[1].type = ARGT_SINT;
3560 args[1].data.sint = fieldname_id;
3561
3562 return 1;
3563}
3564
3565/*
3566 * Checks that <smp> contains a valid MQTT message
3567 *
3568 * The function returns 1 if the check was run to its end, 0 otherwise.
3569 * The result of the analyse itself is stored in <smp> as a boolean.
3570 */
3571static int sample_conv_mqtt_is_valid(const struct arg *arg_p, struct sample *smp, void *private)
3572{
3573 struct ist msg;
3574
3575 msg = ist2(smp->data.u.str.area, smp->data.u.str.data);
3576
3577 smp->flags &= ~SMP_F_MAY_CHANGE;
3578 switch (mqtt_validate_message(msg, NULL)) {
3579 case FIX_VALID_MESSAGE:
3580 smp->data.type = SMP_T_BOOL;
3581 smp->data.u.sint = 1;
3582 return 1;
3583 case FIX_NEED_MORE_DATA:
3584 smp->flags |= SMP_F_MAY_CHANGE;
3585 return 0;
3586 case FIX_INVALID_MESSAGE:
3587 smp->data.type = SMP_T_BOOL;
3588 smp->data.u.sint = 0;
3589 return 1;
3590 }
3591 return 0;
3592}
3593
Tim Duesterhusca097c12018-04-27 21:18:45 +02003594/* This function checks the "strcmp" converter's arguments and extracts the
3595 * variable name and its scope.
3596 */
3597static int smp_check_strcmp(struct arg *args, struct sample_conv *conv,
3598 const char *file, int line, char **err)
3599{
Willy Tarreaua1169b62021-05-08 06:50:28 +02003600 if (!args[0].data.str.data) {
3601 memprintf(err, "missing variable name");
3602 return 0;
3603 }
3604
Tim Duesterhusca097c12018-04-27 21:18:45 +02003605 /* Try to decode a variable. */
3606 if (vars_check_arg(&args[0], NULL))
3607 return 1;
3608
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003609 memprintf(err, "failed to register variable name '%s'",
3610 args[0].data.str.area);
Tim Duesterhusca097c12018-04-27 21:18:45 +02003611 return 0;
3612}
Tim Duesterhusf38175c2020-06-09 11:48:42 +02003613
Christopher Faulet4ccc12f2020-04-01 09:08:32 +02003614/**/
3615static int sample_conv_htonl(const struct arg *arg_p, struct sample *smp, void *private)
3616{
3617 struct buffer *tmp;
3618 uint32_t n;
3619
3620 n = htonl((uint32_t)smp->data.u.sint);
3621 tmp = get_trash_chunk();
3622
3623 memcpy(b_head(tmp), &n, 4);
3624 b_add(tmp, 4);
3625
3626 smp->data.u.str = *tmp;
3627 smp->data.type = SMP_T_BIN;
3628 return 1;
3629}
3630
Christopher Fauletea159d62020-04-01 16:21:44 +02003631/**/
3632static int sample_conv_cut_crlf(const struct arg *arg_p, struct sample *smp, void *private)
3633{
3634 char *p;
3635 size_t l;
3636
3637 p = smp->data.u.str.area;
3638 for (l = 0; l < smp->data.u.str.data; l++) {
3639 if (*(p+l) == '\r' || *(p+l) == '\n')
3640 break;
3641 }
3642 smp->data.u.str.data = l;
3643 return 1;
3644}
3645
Christopher Faulet51fc9d12020-04-01 17:24:41 +02003646/**/
3647static int sample_conv_ltrim(const struct arg *arg_p, struct sample *smp, void *private)
3648{
3649 char *delimiters, *p;
3650 size_t dlen, l;
3651
3652 delimiters = arg_p[0].data.str.area;
3653 dlen = arg_p[0].data.str.data;
3654
3655 l = smp->data.u.str.data;
3656 p = smp->data.u.str.area;
3657 while (l && memchr(delimiters, *p, dlen) != NULL) {
3658 p++;
3659 l--;
3660 }
3661
3662 smp->data.u.str.area = p;
3663 smp->data.u.str.data = l;
3664 return 1;
3665}
3666
Christopher Faulet568415a2020-04-01 17:24:47 +02003667/**/
3668static int sample_conv_rtrim(const struct arg *arg_p, struct sample *smp, void *private)
3669{
3670 char *delimiters, *p;
3671 size_t dlen, l;
3672
3673 delimiters = arg_p[0].data.str.area;
3674 dlen = arg_p[0].data.str.data;
3675
3676 l = smp->data.u.str.data;
3677 p = smp->data.u.str.area + l - 1;
3678 while (l && memchr(delimiters, *p, dlen) != NULL) {
3679 p--;
3680 l--;
3681 }
3682
3683 smp->data.u.str.data = l;
3684 return 1;
3685}
3686
Alex51c8ad42021-04-15 16:45:15 +02003687/* This function checks the "json_query" converter's arguments. */
3688static int sample_check_json_query(struct arg *arg, struct sample_conv *conv,
3689 const char *file, int line, char **err)
3690{
3691 if (arg[0].data.str.data == 0) {
3692 memprintf(err, "json_path must not be empty");
3693 return 0;
3694 }
3695
3696 if (arg[1].data.str.data != 0) {
3697 if (strcmp(arg[1].data.str.area, "int") != 0) {
3698 memprintf(err, "output_type only supports \"int\" as argument");
3699 return 0;
3700 } else {
3701 arg[1].type = ARGT_SINT;
3702 arg[1].data.sint = 0;
3703 }
3704 }
3705 return 1;
3706}
3707
3708/* Limit JSON integer values to the range [-(2**53)+1, (2**53)-1] as per
3709 * the recommendation for interoperable integers in section 6 of RFC 7159.
3710 */
3711#define JSON_INT_MAX ((1LL << 53) - 1)
3712#define JSON_INT_MIN (-JSON_INT_MAX)
3713
3714/* This sample function get the value from a given json string.
3715 * The mjson library is used to parse the JSON struct
3716 */
3717static int sample_conv_json_query(const struct arg *args, struct sample *smp, void *private)
3718{
3719 struct buffer *trash = get_trash_chunk();
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003720 const char *token; /* holds the temporary string from mjson_find */
3721 int token_size; /* holds the length of <token> */
Alex51c8ad42021-04-15 16:45:15 +02003722
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003723 enum mjson_tok token_type;
Alex51c8ad42021-04-15 16:45:15 +02003724
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003725 token_type = mjson_find(smp->data.u.str.area, smp->data.u.str.data, args[0].data.str.area, &token, &token_size);
3726
3727 switch (token_type) {
Alex51c8ad42021-04-15 16:45:15 +02003728 case MJSON_TOK_NUMBER:
3729 if (args[1].type == ARGT_SINT) {
Willy Tarreaufb601952021-05-14 08:51:53 +02003730 smp->data.u.sint = strtoll(token, NULL, 0);
Alex51c8ad42021-04-15 16:45:15 +02003731
3732 if (smp->data.u.sint < JSON_INT_MIN || smp->data.u.sint > JSON_INT_MAX)
3733 return 0;
3734
3735 smp->data.type = SMP_T_SINT;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003736
3737 return 1;
Alex51c8ad42021-04-15 16:45:15 +02003738 } else {
3739 double double_val;
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003740
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003741 if (mjson_get_number(smp->data.u.str.area, smp->data.u.str.data, args[0].data.str.area, &double_val) == 0)
Alex51c8ad42021-04-15 16:45:15 +02003742 return 0;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003743
3744 trash->data = snprintf(trash->area,trash->size,"%g",double_val);
3745 smp->data.u.str = *trash;
3746 smp->data.type = SMP_T_STR;
3747
3748 return 1;
Alex51c8ad42021-04-15 16:45:15 +02003749 }
Alex51c8ad42021-04-15 16:45:15 +02003750 case MJSON_TOK_TRUE:
3751 smp->data.type = SMP_T_BOOL;
3752 smp->data.u.sint = 1;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003753
3754 return 1;
Alex51c8ad42021-04-15 16:45:15 +02003755 case MJSON_TOK_FALSE:
3756 smp->data.type = SMP_T_BOOL;
3757 smp->data.u.sint = 0;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003758
3759 return 1;
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003760 case MJSON_TOK_STRING: {
3761 int len;
3762
3763 len = mjson_get_string(smp->data.u.str.area, smp->data.u.str.data, args[0].data.str.area, trash->area, trash->size);
3764
3765 if (len == -1) {
Alex51c8ad42021-04-15 16:45:15 +02003766 /* invalid string */
3767 return 0;
Alex51c8ad42021-04-15 16:45:15 +02003768 }
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003769
3770 trash->data = len;
3771 smp->data.u.str = *trash;
3772 smp->data.type = SMP_T_STR;
3773
3774 return 1;
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003775 }
Tim Duesterhus8f3bc8f2021-04-15 18:14:32 +02003776 case MJSON_TOK_NULL:
3777 case MJSON_TOK_ARRAY:
3778 case MJSON_TOK_OBJECT:
3779 /* We cannot handle these. */
3780 return 0;
3781 case MJSON_TOK_INVALID:
3782 /* Nothing matches the query. */
3783 return 0;
3784 case MJSON_TOK_KEY:
3785 /* This is not a valid return value according to the
3786 * mjson documentation, but we handle it to benefit
3787 * from '-Wswitch'.
3788 */
Alex51c8ad42021-04-15 16:45:15 +02003789 return 0;
3790 }
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003791
3792 my_unreachable();
3793 return 0;
Alex51c8ad42021-04-15 16:45:15 +02003794}
3795
Remi Tricot-Le Breton0a72f5e2021-10-01 15:36:57 +02003796#ifdef USE_OPENSSL
Remi Tricot-Le Breton130e1422021-10-01 15:36:58 +02003797static int sample_conv_jwt_verify_check(struct arg *args, struct sample_conv *conv,
3798 const char *file, int line, char **err)
3799{
3800 vars_check_arg(&args[0], NULL);
3801 vars_check_arg(&args[1], NULL);
3802
3803 if (args[0].type == ARGT_STR) {
3804 enum jwt_alg alg = jwt_parse_alg(args[0].data.str.area, args[0].data.str.data);
3805
3806 switch(alg) {
3807 case JWT_ALG_DEFAULT:
Tim Duesterhusab896ee2021-10-29 18:06:55 +02003808 memprintf(err, "unknown JWT algorithm: %s", args[0].data.str.area);
3809 return 0;
Remi Tricot-Le Breton130e1422021-10-01 15:36:58 +02003810
3811 case JWS_ALG_PS256:
3812 case JWS_ALG_PS384:
3813 case JWS_ALG_PS512:
3814 memprintf(err, "RSASSA-PSS JWS signing not managed yet");
Tim Duesterhusab896ee2021-10-29 18:06:55 +02003815 return 0;
Remi Tricot-Le Breton130e1422021-10-01 15:36:58 +02003816
3817 default:
3818 break;
3819 }
3820 }
3821
3822 if (args[1].type == ARGT_STR) {
3823 jwt_tree_load_cert(args[1].data.str.area, args[1].data.str.data, err);
3824 }
3825
3826 return 1;
3827}
3828
3829/* Check that a JWT's signature is correct */
3830static int sample_conv_jwt_verify(const struct arg *args, struct sample *smp, void *private)
3831{
3832 struct sample alg_smp, key_smp;
3833
3834 smp->data.type = SMP_T_SINT;
3835 smp->data.u.sint = 0;
3836
3837 smp_set_owner(&alg_smp, smp->px, smp->sess, smp->strm, smp->opt);
3838 smp_set_owner(&key_smp, smp->px, smp->sess, smp->strm, smp->opt);
3839 if (!sample_conv_var2smp_str(&args[0], &alg_smp))
3840 return 0;
3841 if (!sample_conv_var2smp_str(&args[1], &key_smp))
3842 return 0;
3843
3844 smp->data.u.sint = jwt_verify(&smp->data.u.str, &alg_smp.data.u.str,
3845 &key_smp.data.u.str);
3846
3847 return 1;
3848}
3849
3850
Remi Tricot-Le Breton0a72f5e2021-10-01 15:36:57 +02003851/*
3852 * Returns the decoded header or payload of a JWT if no parameter is given, or
3853 * the value of the specified field of the corresponding JWT subpart if a
3854 * parameter is given.
3855 */
3856static int sample_conv_jwt_member_query(const struct arg *args, struct sample *smp,
3857 void *private, enum jwt_elt member)
3858{
3859 struct jwt_item items[JWT_ELT_MAX] = { { 0 } };
3860 unsigned int item_num = member + 1; /* We don't need to tokenize the full token */
3861 struct buffer *decoded_header = get_trash_chunk();
3862 int retval = 0;
Willy Tarreaue20e0262021-10-15 12:10:24 +02003863 int ret;
Remi Tricot-Le Breton0a72f5e2021-10-01 15:36:57 +02003864
3865 jwt_tokenize(&smp->data.u.str, items, &item_num);
3866
3867 if (item_num < member + 1)
3868 goto end;
3869
Willy Tarreaue20e0262021-10-15 12:10:24 +02003870 ret = base64urldec(items[member].start, items[member].length,
3871 decoded_header->area, decoded_header->size);
3872 if (ret == -1)
Remi Tricot-Le Breton0a72f5e2021-10-01 15:36:57 +02003873 goto end;
3874
Willy Tarreaue20e0262021-10-15 12:10:24 +02003875 decoded_header->data = ret;
Remi Tricot-Le Breton0a72f5e2021-10-01 15:36:57 +02003876 if (args[0].type != ARGT_STR) {
3877 smp->data.u.str = *decoded_header;
3878 smp->data.type = SMP_T_STR;
3879 goto end;
3880 }
3881
3882 /* We look for a specific field of the header or payload part of the JWT */
3883 smp->data.u.str = *decoded_header;
3884
3885 retval = sample_conv_json_query(args, smp, private);
3886
3887end:
3888 return retval;
3889}
3890
3891/* This function checks the "jwt_header_query" and "jwt_payload_query" converters' arguments.
3892 * It is based on the "json_query" converter's check with the only difference
3893 * being that the jwt converters can take 0 parameters as well.
3894 */
3895static int sample_conv_jwt_query_check(struct arg *arg, struct sample_conv *conv,
3896 const char *file, int line, char **err)
3897{
3898 if (arg[1].data.str.data != 0) {
3899 if (strcmp(arg[1].data.str.area, "int") != 0) {
3900 memprintf(err, "output_type only supports \"int\" as argument");
3901 return 0;
3902 } else {
3903 arg[1].type = ARGT_SINT;
3904 arg[1].data.sint = 0;
3905 }
3906 }
3907 return 1;
3908}
3909
3910/*
3911 * If no parameter is given, return the decoded header part of a JWT (the first
3912 * base64 encoded part, corresponding to the JOSE header).
3913 * If a parameter is given, this converter acts as a "json_query" on this
3914 * decoded JSON.
3915 */
3916static int sample_conv_jwt_header_query(const struct arg *args, struct sample *smp, void *private)
3917{
3918 return sample_conv_jwt_member_query(args, smp, private, JWT_ELT_JOSE);
3919}
3920
3921/*
3922 * If no parameter is given, return the decoded payload part of a JWT (the
3923 * second base64 encoded part, which contains all the claims). If a parameter
3924 * is given, this converter acts as a "json_query" on this decoded JSON.
3925 */
3926static int sample_conv_jwt_payload_query(const struct arg *args, struct sample *smp, void *private)
3927{
3928 return sample_conv_jwt_member_query(args, smp, private, JWT_ELT_CLAIMS);
3929}
3930
3931#endif /* USE_OPENSSL */
Alex51c8ad42021-04-15 16:45:15 +02003932
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003933/************************************************************************/
3934/* All supported sample fetch functions must be declared here */
3935/************************************************************************/
3936
3937/* force TRUE to be returned at the fetch level */
3938static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02003939smp_fetch_true(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003940{
Willy Tarreau280f42b2018-02-19 15:34:12 +01003941 if (!smp_make_rw(smp))
3942 return 0;
3943
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003944 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003945 smp->data.u.sint = 1;
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003946 return 1;
3947}
3948
3949/* force FALSE to be returned at the fetch level */
3950static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02003951smp_fetch_false(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003952{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003953 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003954 smp->data.u.sint = 0;
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003955 return 1;
3956}
3957
3958/* retrieve environment variable $1 as a string */
3959static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02003960smp_fetch_env(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003961{
3962 char *env;
3963
Christopher Faulete6e7a582021-01-29 11:29:28 +01003964 if (args[0].type != ARGT_STR)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003965 return 0;
3966
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003967 env = getenv(args[0].data.str.area);
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003968 if (!env)
3969 return 0;
3970
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003971 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +01003972 smp->flags = SMP_F_CONST;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003973 smp->data.u.str.area = env;
3974 smp->data.u.str.data = strlen(env);
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003975 return 1;
3976}
3977
Damien Claisseae6f1252019-10-30 15:57:28 +00003978/* Validates the data unit argument passed to "date" fetch. Argument 1 support an
3979 * optional string representing the unit of the result: "s" for seconds, "ms" for
3980 * milliseconds and "us" for microseconds.
3981 * Returns 0 on error and non-zero if OK.
3982 */
3983int smp_check_date_unit(struct arg *args, char **err)
3984{
3985 if (args[1].type == ARGT_STR) {
Christopher Faulet95917132020-08-05 23:07:07 +02003986 long long int unit;
3987
Damien Claisseae6f1252019-10-30 15:57:28 +00003988 if (strcmp(args[1].data.str.area, "s") == 0) {
Christopher Faulet95917132020-08-05 23:07:07 +02003989 unit = TIME_UNIT_S;
Damien Claisseae6f1252019-10-30 15:57:28 +00003990 }
3991 else if (strcmp(args[1].data.str.area, "ms") == 0) {
Christopher Faulet95917132020-08-05 23:07:07 +02003992 unit = TIME_UNIT_MS;
Damien Claisseae6f1252019-10-30 15:57:28 +00003993 }
3994 else if (strcmp(args[1].data.str.area, "us") == 0) {
Christopher Faulet95917132020-08-05 23:07:07 +02003995 unit = TIME_UNIT_US;
Damien Claisseae6f1252019-10-30 15:57:28 +00003996 }
3997 else {
3998 memprintf(err, "expects 's', 'ms' or 'us', got '%s'",
3999 args[1].data.str.area);
4000 return 0;
4001 }
Christopher Faulet95917132020-08-05 23:07:07 +02004002
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004003 chunk_destroy(&args[1].data.str);
Damien Claisseae6f1252019-10-30 15:57:28 +00004004 args[1].type = ARGT_SINT;
Christopher Faulet95917132020-08-05 23:07:07 +02004005 args[1].data.sint = unit;
Damien Claisseae6f1252019-10-30 15:57:28 +00004006 }
4007 else if (args[1].type != ARGT_STOP) {
4008 memprintf(err, "Unexpected arg type");
4009 return 0;
4010 }
4011
4012 return 1;
4013}
4014
4015/* retrieve the current local date in epoch time, converts it to milliseconds
4016 * or microseconds if asked to in optional args[1] unit param, and applies an
4017 * optional args[0] offset.
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004018 */
4019static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004020smp_fetch_date(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004021{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004022 smp->data.u.sint = date.tv_sec;
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004023
Damien Claisseae6f1252019-10-30 15:57:28 +00004024 /* report in milliseconds */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004025 if (args[1].type == ARGT_SINT && args[1].data.sint == TIME_UNIT_MS) {
Damien Claisseae6f1252019-10-30 15:57:28 +00004026 smp->data.u.sint *= 1000;
4027 smp->data.u.sint += date.tv_usec / 1000;
4028 }
4029 /* report in microseconds */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004030 else if (args[1].type == ARGT_SINT && args[1].data.sint == TIME_UNIT_US) {
Damien Claisseae6f1252019-10-30 15:57:28 +00004031 smp->data.u.sint *= 1000000;
4032 smp->data.u.sint += date.tv_usec;
4033 }
4034
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004035 /* add offset */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004036 if (args[0].type == ARGT_SINT)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004037 smp->data.u.sint += args[0].data.sint;
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004038
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004039 smp->data.type = SMP_T_SINT;
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004040 smp->flags |= SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4041 return 1;
4042}
4043
Etienne Carrierea792a0a2018-01-17 13:43:24 +01004044/* retrieve the current microsecond part of the date */
4045static int
4046smp_fetch_date_us(const struct arg *args, struct sample *smp, const char *kw, void *private)
4047{
4048 smp->data.u.sint = date.tv_usec;
4049 smp->data.type = SMP_T_SINT;
4050 smp->flags |= SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4051 return 1;
4052}
4053
4054
Nenad Merdanovic807a6e72017-03-12 22:00:00 +01004055/* returns the hostname */
4056static int
4057smp_fetch_hostname(const struct arg *args, struct sample *smp, const char *kw, void *private)
4058{
4059 smp->data.type = SMP_T_STR;
4060 smp->flags = SMP_F_CONST;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004061 smp->data.u.str.area = hostname;
4062 smp->data.u.str.data = strlen(hostname);
Nenad Merdanovic807a6e72017-03-12 22:00:00 +01004063 return 1;
4064}
4065
Willy Tarreau0f30d262014-11-24 16:02:05 +01004066/* returns the number of processes */
4067static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004068smp_fetch_nbproc(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau0f30d262014-11-24 16:02:05 +01004069{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004070 smp->data.type = SMP_T_SINT;
Willy Tarreau91358592021-06-15 08:08:04 +02004071 smp->data.u.sint = 1;
Willy Tarreau0f30d262014-11-24 16:02:05 +01004072 return 1;
4073}
4074
4075/* returns the number of the current process (between 1 and nbproc */
4076static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004077smp_fetch_proc(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau0f30d262014-11-24 16:02:05 +01004078{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004079 smp->data.type = SMP_T_SINT;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02004080 smp->data.u.sint = 1;
Willy Tarreau0f30d262014-11-24 16:02:05 +01004081 return 1;
4082}
4083
Christopher Faulet34adb2a2017-11-21 21:45:38 +01004084/* returns the number of the current thread (between 1 and nbthread */
4085static int
4086smp_fetch_thread(const struct arg *args, struct sample *smp, const char *kw, void *private)
4087{
4088 smp->data.type = SMP_T_SINT;
4089 smp->data.u.sint = tid;
4090 return 1;
4091}
4092
Willy Tarreau84310e22014-02-14 11:59:04 +01004093/* generate a random 32-bit integer for whatever purpose, with an optional
4094 * range specified in argument.
4095 */
4096static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004097smp_fetch_rand(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau84310e22014-02-14 11:59:04 +01004098{
Willy Tarreauaa8bbc12020-03-08 18:01:10 +01004099 smp->data.u.sint = ha_random32();
Willy Tarreau84310e22014-02-14 11:59:04 +01004100
4101 /* reduce if needed. Don't do a modulo, use all bits! */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004102 if (args[0].type == ARGT_SINT)
Willy Tarreauaa8bbc12020-03-08 18:01:10 +01004103 smp->data.u.sint = ((u64)smp->data.u.sint * (u64)args[0].data.sint) >> 32;
Willy Tarreau84310e22014-02-14 11:59:04 +01004104
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004105 smp->data.type = SMP_T_SINT;
Willy Tarreau84310e22014-02-14 11:59:04 +01004106 smp->flags |= SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4107 return 1;
4108}
4109
Willy Tarreau0f30d262014-11-24 16:02:05 +01004110/* returns true if the current process is stopping */
4111static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004112smp_fetch_stopping(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau0f30d262014-11-24 16:02:05 +01004113{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004114 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004115 smp->data.u.sint = stopping;
Willy Tarreau0f30d262014-11-24 16:02:05 +01004116 return 1;
4117}
4118
Willy Tarreau70fe9442018-11-22 16:07:39 +01004119/* returns the number of calls of the current stream's process_stream() */
4120static int
4121smp_fetch_cpu_calls(const struct arg *args, struct sample *smp, const char *kw, void *private)
4122{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004123 if (!smp->strm)
4124 return 0;
4125
Willy Tarreau70fe9442018-11-22 16:07:39 +01004126 smp->data.type = SMP_T_SINT;
4127 smp->data.u.sint = smp->strm->task->calls;
4128 return 1;
4129}
4130
4131/* returns the average number of nanoseconds spent processing the stream per call */
4132static int
4133smp_fetch_cpu_ns_avg(const struct arg *args, struct sample *smp, const char *kw, void *private)
4134{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004135 if (!smp->strm)
4136 return 0;
4137
Willy Tarreau70fe9442018-11-22 16:07:39 +01004138 smp->data.type = SMP_T_SINT;
Willy Tarreau6a28a302022-09-07 09:17:45 +02004139 smp->data.u.sint = smp->strm->task->calls ? smp->strm->cpu_time / smp->strm->task->calls : 0;
Willy Tarreau70fe9442018-11-22 16:07:39 +01004140 return 1;
4141}
4142
4143/* returns the total number of nanoseconds spent processing the stream */
4144static int
4145smp_fetch_cpu_ns_tot(const struct arg *args, struct sample *smp, const char *kw, void *private)
4146{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004147 if (!smp->strm)
4148 return 0;
4149
Willy Tarreau70fe9442018-11-22 16:07:39 +01004150 smp->data.type = SMP_T_SINT;
Willy Tarreau6a28a302022-09-07 09:17:45 +02004151 smp->data.u.sint = smp->strm->cpu_time;
Willy Tarreau70fe9442018-11-22 16:07:39 +01004152 return 1;
4153}
4154
4155/* returns the average number of nanoseconds per call spent waiting for other tasks to be processed */
4156static int
4157smp_fetch_lat_ns_avg(const struct arg *args, struct sample *smp, const char *kw, void *private)
4158{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004159 if (!smp->strm)
4160 return 0;
4161
Willy Tarreau70fe9442018-11-22 16:07:39 +01004162 smp->data.type = SMP_T_SINT;
Willy Tarreau6a28a302022-09-07 09:17:45 +02004163 smp->data.u.sint = smp->strm->task->calls ? smp->strm->lat_time / smp->strm->task->calls : 0;
Willy Tarreau70fe9442018-11-22 16:07:39 +01004164 return 1;
4165}
4166
4167/* returns the total number of nanoseconds per call spent waiting for other tasks to be processed */
4168static int
4169smp_fetch_lat_ns_tot(const struct arg *args, struct sample *smp, const char *kw, void *private)
4170{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004171 if (!smp->strm)
4172 return 0;
4173
Willy Tarreau70fe9442018-11-22 16:07:39 +01004174 smp->data.type = SMP_T_SINT;
Willy Tarreau6a28a302022-09-07 09:17:45 +02004175 smp->data.u.sint = smp->strm->lat_time;
Willy Tarreau70fe9442018-11-22 16:07:39 +01004176 return 1;
4177}
4178
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004179static int smp_fetch_const_str(const struct arg *args, struct sample *smp, const char *kw, void *private)
4180{
4181 smp->flags |= SMP_F_CONST;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004182 smp->data.type = SMP_T_STR;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004183 smp->data.u.str.area = args[0].data.str.area;
4184 smp->data.u.str.data = args[0].data.str.data;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004185 return 1;
4186}
4187
4188static int smp_check_const_bool(struct arg *args, char **err)
4189{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004190 if (strcasecmp(args[0].data.str.area, "true") == 0 ||
4191 strcasecmp(args[0].data.str.area, "1") == 0) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004192 chunk_destroy(&args[0].data.str);
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004193 args[0].type = ARGT_SINT;
4194 args[0].data.sint = 1;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004195 return 1;
4196 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004197 if (strcasecmp(args[0].data.str.area, "false") == 0 ||
4198 strcasecmp(args[0].data.str.area, "0") == 0) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004199 chunk_destroy(&args[0].data.str);
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004200 args[0].type = ARGT_SINT;
4201 args[0].data.sint = 0;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004202 return 1;
4203 }
4204 memprintf(err, "Expects 'true', 'false', '0' or '1'");
4205 return 0;
4206}
4207
4208static int smp_fetch_const_bool(const struct arg *args, struct sample *smp, const char *kw, void *private)
4209{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004210 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004211 smp->data.u.sint = args[0].data.sint;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004212 return 1;
4213}
4214
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02004215static int smp_fetch_const_int(const struct arg *args, struct sample *smp, const char *kw, void *private)
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004216{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004217 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004218 smp->data.u.sint = args[0].data.sint;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004219 return 1;
4220}
4221
4222static int smp_fetch_const_ipv4(const struct arg *args, struct sample *smp, const char *kw, void *private)
4223{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004224 smp->data.type = SMP_T_IPV4;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004225 smp->data.u.ipv4 = args[0].data.ipv4;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004226 return 1;
4227}
4228
4229static int smp_fetch_const_ipv6(const struct arg *args, struct sample *smp, const char *kw, void *private)
4230{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004231 smp->data.type = SMP_T_IPV6;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004232 smp->data.u.ipv6 = args[0].data.ipv6;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004233 return 1;
4234}
4235
4236static int smp_check_const_bin(struct arg *args, char **err)
4237{
David Carlier64a16ab2016-04-08 10:37:02 +01004238 char *binstr = NULL;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004239 int binstrlen;
4240
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004241 if (!parse_binary(args[0].data.str.area, &binstr, &binstrlen, err))
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004242 return 0;
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004243 chunk_destroy(&args[0].data.str);
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004244 args[0].type = ARGT_STR;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004245 args[0].data.str.area = binstr;
4246 args[0].data.str.data = binstrlen;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004247 return 1;
4248}
4249
4250static int smp_fetch_const_bin(const struct arg *args, struct sample *smp, const char *kw, void *private)
4251{
4252 smp->flags |= SMP_F_CONST;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004253 smp->data.type = SMP_T_BIN;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004254 smp->data.u.str.area = args[0].data.str.area;
4255 smp->data.u.str.data = args[0].data.str.data;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004256 return 1;
4257}
4258
4259static int smp_check_const_meth(struct arg *args, char **err)
4260{
4261 enum http_meth_t meth;
4262 int i;
4263
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004264 meth = find_http_meth(args[0].data.str.area, args[0].data.str.data);
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004265 if (meth != HTTP_METH_OTHER) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004266 chunk_destroy(&args[0].data.str);
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004267 args[0].type = ARGT_SINT;
4268 args[0].data.sint = meth;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004269 } else {
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05004270 /* Check method avalaibility. A method is a token defined as :
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004271 * tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "." /
4272 * "^" / "_" / "`" / "|" / "~" / DIGIT / ALPHA
4273 * token = 1*tchar
4274 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004275 for (i = 0; i < args[0].data.str.data; i++) {
4276 if (!HTTP_IS_TOKEN(args[0].data.str.area[i])) {
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004277 memprintf(err, "expects valid method.");
4278 return 0;
4279 }
4280 }
4281 }
4282 return 1;
4283}
4284
4285static int smp_fetch_const_meth(const struct arg *args, struct sample *smp, const char *kw, void *private)
4286{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004287 smp->data.type = SMP_T_METH;
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004288 if (args[0].type == ARGT_SINT) {
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004289 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004290 smp->data.u.meth.meth = args[0].data.sint;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004291 smp->data.u.meth.str.area = "";
4292 smp->data.u.meth.str.data = 0;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004293 } else {
4294 smp->flags |= SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004295 smp->data.u.meth.meth = HTTP_METH_OTHER;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004296 smp->data.u.meth.str.area = args[0].data.str.area;
4297 smp->data.u.meth.str.data = args[0].data.str.data;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004298 }
4299 return 1;
4300}
4301
Luca Schimweg8a694b82019-09-10 15:42:52 +02004302// This function checks the "uuid" sample's arguments.
4303// Function won't get called when no parameter is specified (maybe a bug?)
4304static int smp_check_uuid(struct arg *args, char **err)
4305{
4306 if (!args[0].type) {
4307 args[0].type = ARGT_SINT;
4308 args[0].data.sint = 4;
4309 }
4310 else if (args[0].data.sint != 4) {
4311 memprintf(err, "Unsupported UUID version: '%lld'", args[0].data.sint);
4312 return 0;
4313 }
4314
4315 return 1;
4316}
4317
4318// Generate a RFC4122 UUID (default is v4 = fully random)
4319static int smp_fetch_uuid(const struct arg *args, struct sample *smp, const char *kw, void *private)
4320{
4321 if (args[0].data.sint == 4 || !args[0].type) {
Willy Tarreauee3bcdd2020-03-08 17:48:17 +01004322 ha_generate_uuid(&trash);
Luca Schimweg8a694b82019-09-10 15:42:52 +02004323 smp->data.type = SMP_T_STR;
4324 smp->flags = SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4325 smp->data.u.str = trash;
4326 return 1;
4327 }
4328
4329 // more implementations of other uuid formats possible here
4330 return 0;
4331}
4332
Willy Tarreau5b8ad222013-07-25 12:17:57 +02004333/* Note: must not be declared <const> as its list will be overwritten.
4334 * Note: fetches that may return multiple types must be declared as the lowest
4335 * common denominator, the type that can be casted into all other ones. For
4336 * instance IPv4/IPv6 must be declared IPv4.
4337 */
4338static struct sample_fetch_kw_list smp_kws = {ILH, {
Willy Tarreau0209c972021-03-26 12:03:11 +01004339 { "always_false", smp_fetch_false, 0, NULL, SMP_T_BOOL, SMP_USE_CONST },
4340 { "always_true", smp_fetch_true, 0, NULL, SMP_T_BOOL, SMP_USE_CONST },
4341 { "env", smp_fetch_env, ARG1(1,STR), NULL, SMP_T_STR, SMP_USE_CONST },
4342 { "date", smp_fetch_date, ARG2(0,SINT,STR), smp_check_date_unit, SMP_T_SINT, SMP_USE_CONST },
4343 { "date_us", smp_fetch_date_us, 0, NULL, SMP_T_SINT, SMP_USE_CONST },
4344 { "hostname", smp_fetch_hostname, 0, NULL, SMP_T_STR, SMP_USE_CONST },
4345 { "nbproc", smp_fetch_nbproc,0, NULL, SMP_T_SINT, SMP_USE_CONST },
4346 { "proc", smp_fetch_proc, 0, NULL, SMP_T_SINT, SMP_USE_CONST },
4347 { "thread", smp_fetch_thread, 0, NULL, SMP_T_SINT, SMP_USE_CONST },
4348 { "rand", smp_fetch_rand, ARG1(0,SINT), NULL, SMP_T_SINT, SMP_USE_CONST },
Willy Tarreau0f30d262014-11-24 16:02:05 +01004349 { "stopping", smp_fetch_stopping, 0, NULL, SMP_T_BOOL, SMP_USE_INTRN },
Willy Tarreau0209c972021-03-26 12:03:11 +01004350 { "uuid", smp_fetch_uuid, ARG1(0, SINT), smp_check_uuid, SMP_T_STR, SMP_USE_CONST },
Willy Tarreau70fe9442018-11-22 16:07:39 +01004351
4352 { "cpu_calls", smp_fetch_cpu_calls, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4353 { "cpu_ns_avg", smp_fetch_cpu_ns_avg, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4354 { "cpu_ns_tot", smp_fetch_cpu_ns_tot, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4355 { "lat_ns_avg", smp_fetch_lat_ns_avg, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4356 { "lat_ns_tot", smp_fetch_lat_ns_tot, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004357
Willy Tarreau0209c972021-03-26 12:03:11 +01004358 { "str", smp_fetch_const_str, ARG1(1,STR), NULL , SMP_T_STR, SMP_USE_CONST },
4359 { "bool", smp_fetch_const_bool, ARG1(1,STR), smp_check_const_bool, SMP_T_BOOL, SMP_USE_CONST },
4360 { "int", smp_fetch_const_int, ARG1(1,SINT), NULL , SMP_T_SINT, SMP_USE_CONST },
4361 { "ipv4", smp_fetch_const_ipv4, ARG1(1,IPV4), NULL , SMP_T_IPV4, SMP_USE_CONST },
4362 { "ipv6", smp_fetch_const_ipv6, ARG1(1,IPV6), NULL , SMP_T_IPV6, SMP_USE_CONST },
4363 { "bin", smp_fetch_const_bin, ARG1(1,STR), smp_check_const_bin , SMP_T_BIN, SMP_USE_CONST },
4364 { "meth", smp_fetch_const_meth, ARG1(1,STR), smp_check_const_meth, SMP_T_METH, SMP_USE_CONST },
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004365
Willy Tarreau5b8ad222013-07-25 12:17:57 +02004366 { /* END */ },
4367}};
4368
Willy Tarreau0108d902018-11-25 19:14:37 +01004369INITCALL1(STG_REGISTER, sample_register_fetches, &smp_kws);
4370
Emeric Brun107ca302010-01-04 16:16:05 +01004371/* Note: must not be declared <const> as its list will be overwritten */
Willy Tarreaudc13c112013-06-21 23:16:39 +02004372static struct sample_conv_kw_list sample_conv_kws = {ILH, {
Nikola Sale0dbf0382022-04-03 18:11:53 +02004373 { "add_item",sample_conv_add_item, ARG3(2,STR,STR,STR), smp_check_add_item, SMP_T_STR, SMP_T_STR },
Moemen MHEDHBI848216f2021-04-02 01:05:07 +02004374 { "debug", sample_conv_debug, ARG2(0,STR,STR), smp_check_debug, SMP_T_ANY, SMP_T_ANY },
4375 { "b64dec", sample_conv_base642bin, 0, NULL, SMP_T_STR, SMP_T_BIN },
4376 { "base64", sample_conv_bin2base64, 0, NULL, SMP_T_BIN, SMP_T_STR },
Nikola Sale0dbf0382022-04-03 18:11:53 +02004377 { "concat", sample_conv_concat, ARG3(1,STR,STR,STR), smp_check_concat, SMP_T_STR, SMP_T_STR },
Moemen MHEDHBI848216f2021-04-02 01:05:07 +02004378 { "ub64enc", sample_conv_bin2base64url,0, NULL, SMP_T_BIN, SMP_T_STR },
4379 { "ub64dec", sample_conv_base64url2bin,0, NULL, SMP_T_STR, SMP_T_BIN },
4380 { "upper", sample_conv_str2upper, 0, NULL, SMP_T_STR, SMP_T_STR },
4381 { "lower", sample_conv_str2lower, 0, NULL, SMP_T_STR, SMP_T_STR },
4382 { "length", sample_conv_length, 0, NULL, SMP_T_STR, SMP_T_SINT },
Marcin Deranek40ca09c2021-07-13 14:05:24 +02004383 { "be2dec", sample_conv_be2dec, ARG3(1,STR,SINT,SINT), sample_conv_be2dec_check, SMP_T_BIN, SMP_T_STR },
Marcin Deranekda0264a2021-07-13 14:08:56 +02004384 { "be2hex", sample_conv_be2hex, ARG3(1,STR,SINT,SINT), sample_conv_be2hex_check, SMP_T_BIN, SMP_T_STR },
Moemen MHEDHBI848216f2021-04-02 01:05:07 +02004385 { "hex", sample_conv_bin2hex, 0, NULL, SMP_T_BIN, SMP_T_STR },
4386 { "hex2i", sample_conv_hex2int, 0, NULL, SMP_T_STR, SMP_T_SINT },
4387 { "ipmask", sample_conv_ipmask, ARG2(1,MSK4,MSK6), NULL, SMP_T_ADDR, SMP_T_IPV4 },
4388 { "ltime", sample_conv_ltime, ARG2(1,STR,SINT), NULL, SMP_T_SINT, SMP_T_STR },
4389 { "utime", sample_conv_utime, ARG2(1,STR,SINT), NULL, SMP_T_SINT, SMP_T_STR },
4390 { "crc32", sample_conv_crc32, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4391 { "crc32c", sample_conv_crc32c, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4392 { "djb2", sample_conv_djb2, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4393 { "sdbm", sample_conv_sdbm, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4394 { "wt6", sample_conv_wt6, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4395 { "xxh3", sample_conv_xxh3, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4396 { "xxh32", sample_conv_xxh32, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4397 { "xxh64", sample_conv_xxh64, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4398 { "json", sample_conv_json, ARG1(1,STR), sample_conv_json_check, SMP_T_STR, SMP_T_STR },
4399 { "bytes", sample_conv_bytes, ARG2(1,SINT,SINT), NULL, SMP_T_BIN, SMP_T_BIN },
4400 { "field", sample_conv_field, ARG3(2,SINT,STR,SINT), sample_conv_field_check, SMP_T_STR, SMP_T_STR },
4401 { "word", sample_conv_word, ARG3(2,SINT,STR,SINT), sample_conv_field_check, SMP_T_STR, SMP_T_STR },
4402 { "regsub", sample_conv_regsub, ARG3(2,REG,STR,STR), sample_conv_regsub_check, SMP_T_STR, SMP_T_STR },
4403 { "sha1", sample_conv_sha1, 0, NULL, SMP_T_BIN, SMP_T_BIN },
Willy Tarreau99ea1882021-10-06 15:37:17 +02004404 { "strcmp", sample_conv_strcmp, ARG1(1,STR), smp_check_strcmp, SMP_T_STR, SMP_T_SINT },
William Lallemanddd754cb2022-08-26 16:21:28 +02004405 { "host_only", sample_conv_host_only, 0, NULL, SMP_T_STR, SMP_T_STR },
4406 { "port_only", sample_conv_port_only, 0, NULL, SMP_T_STR, SMP_T_SINT },
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01004407
4408 /* gRPC converters. */
Frédéric Lécaillebfe61382019-03-06 14:34:36 +01004409 { "ungrpc", sample_conv_ungrpc, ARG2(1,PBUF_FNUM,STR), sample_conv_protobuf_check, SMP_T_BIN, SMP_T_BIN },
4410 { "protobuf", sample_conv_protobuf, ARG2(1,PBUF_FNUM,STR), sample_conv_protobuf_check, SMP_T_BIN, SMP_T_BIN },
Willy Tarreau97707872015-01-27 15:12:13 +01004411
Baptiste Assmanne138dda2020-10-22 15:39:03 +02004412 /* FIX converters */
4413 { "fix_is_valid", sample_conv_fix_is_valid, 0, NULL, SMP_T_BIN, SMP_T_BOOL },
4414 { "fix_tag_value", sample_conv_fix_tag_value, ARG1(1,STR), sample_conv_fix_value_check, SMP_T_BIN, SMP_T_BIN },
4415
Baptiste Assmanne279ca62020-10-27 18:10:06 +01004416 /* MQTT converters */
4417 { "mqtt_is_valid", sample_conv_mqtt_is_valid, 0, NULL, SMP_T_BIN, SMP_T_BOOL },
4418 { "mqtt_field_value", sample_conv_mqtt_field_value, ARG2(2,STR,STR), sample_conv_mqtt_field_value_check, SMP_T_BIN, SMP_T_STR },
4419
Tim Duesterhus3943e4f2020-09-11 14:25:23 +02004420 { "iif", sample_conv_iif, ARG2(2, STR, STR), NULL, SMP_T_BOOL, SMP_T_STR },
4421
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02004422 { "and", sample_conv_binary_and, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4423 { "or", sample_conv_binary_or, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4424 { "xor", sample_conv_binary_xor, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4425 { "cpl", sample_conv_binary_cpl, 0, NULL, SMP_T_SINT, SMP_T_SINT },
4426 { "bool", sample_conv_arith_bool, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4427 { "not", sample_conv_arith_not, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4428 { "odd", sample_conv_arith_odd, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4429 { "even", sample_conv_arith_even, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4430 { "add", sample_conv_arith_add, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4431 { "sub", sample_conv_arith_sub, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4432 { "mul", sample_conv_arith_mul, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4433 { "div", sample_conv_arith_div, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4434 { "mod", sample_conv_arith_mod, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4435 { "neg", sample_conv_arith_neg, 0, NULL, SMP_T_SINT, SMP_T_SINT },
Willy Tarreau97707872015-01-27 15:12:13 +01004436
Christopher Fauletea159d62020-04-01 16:21:44 +02004437 { "htonl", sample_conv_htonl, 0, NULL, SMP_T_SINT, SMP_T_BIN },
4438 { "cut_crlf", sample_conv_cut_crlf, 0, NULL, SMP_T_STR, SMP_T_STR },
Christopher Faulet51fc9d12020-04-01 17:24:41 +02004439 { "ltrim", sample_conv_ltrim, ARG1(1,STR), NULL, SMP_T_STR, SMP_T_STR },
Christopher Faulet568415a2020-04-01 17:24:47 +02004440 { "rtrim", sample_conv_rtrim, ARG1(1,STR), NULL, SMP_T_STR, SMP_T_STR },
Alex51c8ad42021-04-15 16:45:15 +02004441 { "json_query", sample_conv_json_query, ARG2(1,STR,STR), sample_check_json_query , SMP_T_STR, SMP_T_ANY },
Remi Tricot-Le Breton0a72f5e2021-10-01 15:36:57 +02004442
4443#ifdef USE_OPENSSL
4444 /* JSON Web Token converters */
4445 { "jwt_header_query", sample_conv_jwt_header_query, ARG2(0,STR,STR), sample_conv_jwt_query_check, SMP_T_BIN, SMP_T_ANY },
4446 { "jwt_payload_query", sample_conv_jwt_payload_query, ARG2(0,STR,STR), sample_conv_jwt_query_check, SMP_T_BIN, SMP_T_ANY },
Remi Tricot-Le Breton130e1422021-10-01 15:36:58 +02004447 { "jwt_verify", sample_conv_jwt_verify, ARG2(2,STR,STR), sample_conv_jwt_verify_check, SMP_T_BIN, SMP_T_SINT },
Remi Tricot-Le Breton0a72f5e2021-10-01 15:36:57 +02004448#endif
Willy Tarreau9fcb9842012-04-20 14:45:49 +02004449 { NULL, NULL, 0, 0, 0 },
Emeric Brun107ca302010-01-04 16:16:05 +01004450}};
4451
Willy Tarreau0108d902018-11-25 19:14:37 +01004452INITCALL1(STG_REGISTER, sample_register_convs, &sample_conv_kws);