blob: b9d90ea0ec7665ddfaa7298571c3c2e0d4c04223 [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>
21#include <import/xxhash.h>
Willy Tarreau7e2c6472012-10-29 20:44:36 +010022
Willy Tarreaub2551052020-06-09 09:07:15 +020023#include <haproxy/api.h>
24#include <haproxy/arg.h>
Willy Tarreauac13aea2020-06-04 10:36:03 +020025#include <haproxy/auth.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020026#include <haproxy/base64.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020027#include <haproxy/buf.h>
Willy Tarreauc13ed532020-06-02 10:22:45 +020028#include <haproxy/chunk.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>
Thierry FOURNIER01e09742016-12-26 11:46:11 +010046
Willy Tarreau1cf8f082014-02-07 12:14:54 +010047/* sample type names */
48const char *smp_to_type[SMP_TYPES] = {
Thierry FOURNIER9c627e82015-06-03 20:12:35 +020049 [SMP_T_ANY] = "any",
Willy Tarreau1cf8f082014-02-07 12:14:54 +010050 [SMP_T_BOOL] = "bool",
Willy Tarreau1cf8f082014-02-07 12:14:54 +010051 [SMP_T_SINT] = "sint",
52 [SMP_T_ADDR] = "addr",
53 [SMP_T_IPV4] = "ipv4",
54 [SMP_T_IPV6] = "ipv6",
55 [SMP_T_STR] = "str",
56 [SMP_T_BIN] = "bin",
Thierry FOURNIER4c2479e2015-06-03 20:12:04 +020057 [SMP_T_METH] = "meth",
Willy Tarreau1cf8f082014-02-07 12:14:54 +010058};
59
Willy Tarreau12785782012-04-27 21:37:17 +020060/* static sample used in sample_process() when <p> is NULL */
Emeric Brune5c918b2017-06-14 14:15:36 +020061static THREAD_LOCAL struct sample temp_smp;
Emeric Brun107ca302010-01-04 16:16:05 +010062
Willy Tarreau12785782012-04-27 21:37:17 +020063/* list head of all known sample fetch keywords */
64static struct sample_fetch_kw_list sample_fetches = {
65 .list = LIST_HEAD_INIT(sample_fetches.list)
Emeric Brun107ca302010-01-04 16:16:05 +010066};
67
Willy Tarreau12785782012-04-27 21:37:17 +020068/* list head of all known sample format conversion keywords */
69static struct sample_conv_kw_list sample_convs = {
70 .list = LIST_HEAD_INIT(sample_convs.list)
Emeric Brun107ca302010-01-04 16:16:05 +010071};
72
Willy Tarreau80aca902013-01-07 15:42:20 +010073const unsigned int fetch_cap[SMP_SRC_ENTRIES] = {
Willy Tarreaube2159b2021-03-26 11:56:11 +010074 [SMP_SRC_CONST] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
75 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
76 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
77 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
78 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
79 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +010080 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL_CFG_PARSER |
81 SMP_VAL_CLI_PARSER ),
Willy Tarreaube2159b2021-03-26 11:56:11 +010082
Willy Tarreau80aca902013-01-07 15:42:20 +010083 [SMP_SRC_INTRN] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
84 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
85 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
86 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
87 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
88 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +010089 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
90 SMP_VAL_CLI_PARSER ),
Willy Tarreau80aca902013-01-07 15:42:20 +010091
92 [SMP_SRC_LISTN] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
93 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
94 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
95 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
96 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
97 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +010098 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
99 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100100
101 [SMP_SRC_FTEND] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
102 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
103 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
104 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
105 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
106 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100107 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
108 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100109
110 [SMP_SRC_L4CLI] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
111 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
112 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
113 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
114 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
115 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100116 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
117 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100118
119 [SMP_SRC_L5CLI] = (SMP_VAL___________ | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
120 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
121 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
122 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
123 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
124 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100125 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
126 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100127
128 [SMP_SRC_TRACK] = (SMP_VAL_FE_CON_ACC | SMP_VAL_FE_SES_ACC | SMP_VAL_FE_REQ_CNT |
129 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
130 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
131 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
132 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
133 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100134 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
135 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100136
137 [SMP_SRC_L6REQ] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_FE_REQ_CNT |
138 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
139 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
140 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL___________ |
141 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
142 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100143 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
144 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100145
146 [SMP_SRC_HRQHV] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_FE_REQ_CNT |
147 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
148 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
149 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL___________ |
150 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
151 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100152 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
153 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100154
155 [SMP_SRC_HRQHP] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_FE_REQ_CNT |
156 SMP_VAL_FE_HRQ_HDR | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
157 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
158 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
159 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
160 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100161 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
162 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100163
164 [SMP_SRC_HRQBO] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
165 SMP_VAL___________ | SMP_VAL_FE_HRQ_BDY | SMP_VAL_FE_SET_BCK |
166 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
167 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL___________ |
168 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
169 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100170 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
171 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100172
173 [SMP_SRC_BKEND] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
174 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
175 SMP_VAL_BE_REQ_CNT | SMP_VAL_BE_HRQ_HDR | SMP_VAL_BE_HRQ_BDY |
176 SMP_VAL_BE_SET_SRV | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
177 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
178 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100179 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
180 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100181
182 [SMP_SRC_SERVR] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
183 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
184 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
185 SMP_VAL___________ | SMP_VAL_BE_SRV_CON | SMP_VAL_BE_RES_CNT |
186 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
187 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100188 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
189 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100190
191 [SMP_SRC_L4SRV] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
192 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
193 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
194 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_BE_RES_CNT |
195 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
196 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100197 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
198 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100199
200 [SMP_SRC_L5SRV] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
201 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
202 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
203 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_BE_RES_CNT |
204 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
205 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100206 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
207 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100208
209 [SMP_SRC_L6RES] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
210 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
211 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
212 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_BE_RES_CNT |
213 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
214 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100215 SMP_VAL___________ | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
216 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100217
218 [SMP_SRC_HRSHV] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
219 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
220 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
221 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_BE_RES_CNT |
222 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
223 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100224 SMP_VAL___________ | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
225 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100226
227 [SMP_SRC_HRSHP] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
228 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
229 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
230 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL_BE_RES_CNT |
231 SMP_VAL_BE_HRS_HDR | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
232 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100233 SMP_VAL_FE_LOG_END | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
234 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100235
236 [SMP_SRC_HRSBO] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
237 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
238 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
239 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
240 SMP_VAL___________ | SMP_VAL_BE_HRS_BDY | SMP_VAL_BE_STO_RUL |
241 SMP_VAL_FE_RES_CNT | SMP_VAL_FE_HRS_HDR | SMP_VAL_FE_HRS_BDY |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100242 SMP_VAL___________ | SMP_VAL_BE_CHK_RUL | SMP_VAL___________ |
243 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100244
245 [SMP_SRC_RQFIN] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
246 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
247 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___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100251 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
252 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100253
254 [SMP_SRC_RSFIN] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
255 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
256 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___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100260 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
261 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100262
263 [SMP_SRC_TXFIN] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
264 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
265 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___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100269 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
270 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100271
272 [SMP_SRC_SSFIN] = (SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
273 SMP_VAL___________ | SMP_VAL___________ | SMP_VAL___________ |
274 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___________ |
Willy Tarreaudb5e0db2021-03-26 15:29:35 +0100278 SMP_VAL_FE_LOG_END | SMP_VAL___________ | SMP_VAL___________ |
279 SMP_VAL___________ ),
Willy Tarreau80aca902013-01-07 15:42:20 +0100280};
281
282static const char *fetch_src_names[SMP_SRC_ENTRIES] = {
283 [SMP_SRC_INTRN] = "internal state",
284 [SMP_SRC_LISTN] = "listener",
285 [SMP_SRC_FTEND] = "frontend",
286 [SMP_SRC_L4CLI] = "client address",
287 [SMP_SRC_L5CLI] = "client-side connection",
288 [SMP_SRC_TRACK] = "track counters",
289 [SMP_SRC_L6REQ] = "request buffer",
290 [SMP_SRC_HRQHV] = "HTTP request headers",
291 [SMP_SRC_HRQHP] = "HTTP request",
292 [SMP_SRC_HRQBO] = "HTTP request body",
293 [SMP_SRC_BKEND] = "backend",
294 [SMP_SRC_SERVR] = "server",
295 [SMP_SRC_L4SRV] = "server address",
296 [SMP_SRC_L5SRV] = "server-side connection",
297 [SMP_SRC_L6RES] = "response buffer",
298 [SMP_SRC_HRSHV] = "HTTP response headers",
299 [SMP_SRC_HRSHP] = "HTTP response",
300 [SMP_SRC_HRSBO] = "HTTP response body",
301 [SMP_SRC_RQFIN] = "request buffer statistics",
302 [SMP_SRC_RSFIN] = "response buffer statistics",
303 [SMP_SRC_TXFIN] = "transaction statistics",
304 [SMP_SRC_SSFIN] = "session statistics",
305};
306
Willy Tarreaubf8e2512013-03-25 14:52:41 +0100307static const char *fetch_ckp_names[SMP_CKP_ENTRIES] = {
308 [SMP_CKP_FE_CON_ACC] = "frontend tcp-request connection rule",
309 [SMP_CKP_FE_SES_ACC] = "frontend tcp-request session rule",
310 [SMP_CKP_FE_REQ_CNT] = "frontend tcp-request content rule",
311 [SMP_CKP_FE_HRQ_HDR] = "frontend http-request header rule",
312 [SMP_CKP_FE_HRQ_BDY] = "frontend http-request body rule",
313 [SMP_CKP_FE_SET_BCK] = "frontend use-backend rule",
314 [SMP_CKP_BE_REQ_CNT] = "backend tcp-request content rule",
315 [SMP_CKP_BE_HRQ_HDR] = "backend http-request header rule",
316 [SMP_CKP_BE_HRQ_BDY] = "backend http-request body rule",
317 [SMP_CKP_BE_SET_SRV] = "backend use-server, balance or stick-match rule",
318 [SMP_CKP_BE_SRV_CON] = "server source selection",
319 [SMP_CKP_BE_RES_CNT] = "backend tcp-response content rule",
320 [SMP_CKP_BE_HRS_HDR] = "backend http-response header rule",
321 [SMP_CKP_BE_HRS_BDY] = "backend http-response body rule",
322 [SMP_CKP_BE_STO_RUL] = "backend stick-store rule",
323 [SMP_CKP_FE_RES_CNT] = "frontend tcp-response content rule",
324 [SMP_CKP_FE_HRS_HDR] = "frontend http-response header rule",
325 [SMP_CKP_FE_HRS_BDY] = "frontend http-response body rule",
326 [SMP_CKP_FE_LOG_END] = "logs",
Gaetan Rivet707b52f2020-02-21 18:14:59 +0100327 [SMP_CKP_BE_CHK_RUL] = "backend tcp-check rule",
Willy Tarreaubf8e2512013-03-25 14:52:41 +0100328};
329
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100330/* This function returns the type of the data returned by the sample_expr.
331 * It assumes that the <expr> and all of its converters are properly
332 * initialized.
333 */
334inline
335int smp_expr_output_type(struct sample_expr *expr)
336{
337 struct sample_conv_expr *smp_expr;
338
339 if (!LIST_ISEMPTY(&expr->conv_exprs)) {
340 smp_expr = LIST_PREV(&expr->conv_exprs, struct sample_conv_expr *, list);
341 return smp_expr->conv->out_type;
342 }
343 return expr->fetch->out_type;
344}
345
346
Willy Tarreau80aca902013-01-07 15:42:20 +0100347/* fill the trash with a comma-delimited list of source names for the <use> bit
348 * field which must be composed of a non-null set of SMP_USE_* flags. The return
349 * value is the pointer to the string in the trash buffer.
350 */
351const char *sample_src_names(unsigned int use)
352{
353 int bit;
354
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200355 trash.data = 0;
356 trash.area[0] = '\0';
Willy Tarreau80aca902013-01-07 15:42:20 +0100357 for (bit = 0; bit < SMP_SRC_ENTRIES; bit++) {
358 if (!(use & ~((1 << bit) - 1)))
359 break; /* no more bits */
360
361 if (!(use & (1 << bit)))
362 continue; /* bit not set */
363
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200364 trash.data += snprintf(trash.area + trash.data,
365 trash.size - trash.data, "%s%s",
366 (use & ((1 << bit) - 1)) ? "," : "",
367 fetch_src_names[bit]);
Willy Tarreau80aca902013-01-07 15:42:20 +0100368 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200369 return trash.area;
Willy Tarreau80aca902013-01-07 15:42:20 +0100370}
371
Willy Tarreaubf8e2512013-03-25 14:52:41 +0100372/* return a pointer to the correct sample checkpoint name, or "unknown" when
373 * the flags are invalid. Only the lowest bit is used, higher bits are ignored
374 * if set.
375 */
376const char *sample_ckp_names(unsigned int use)
377{
378 int bit;
379
380 for (bit = 0; bit < SMP_CKP_ENTRIES; bit++)
381 if (use & (1 << bit))
382 return fetch_ckp_names[bit];
383 return "unknown sample check place, please report this bug";
384}
385
Emeric Brun107ca302010-01-04 16:16:05 +0100386/*
Willy Tarreau80aca902013-01-07 15:42:20 +0100387 * Registers the sample fetch keyword list <kwl> as a list of valid keywords
388 * for next parsing sessions. The fetch keywords capabilities are also computed
389 * from their ->use field.
Emeric Brun107ca302010-01-04 16:16:05 +0100390 */
Willy Tarreau80aca902013-01-07 15:42:20 +0100391void sample_register_fetches(struct sample_fetch_kw_list *kwl)
Emeric Brun107ca302010-01-04 16:16:05 +0100392{
Willy Tarreau80aca902013-01-07 15:42:20 +0100393 struct sample_fetch *sf;
394 int bit;
395
396 for (sf = kwl->kw; sf->kw != NULL; sf++) {
397 for (bit = 0; bit < SMP_SRC_ENTRIES; bit++)
398 if (sf->use & (1 << bit))
399 sf->val |= fetch_cap[bit];
400 }
Willy Tarreau2b718102021-04-21 07:32:39 +0200401 LIST_APPEND(&sample_fetches.list, &kwl->list);
Emeric Brun107ca302010-01-04 16:16:05 +0100402}
403
404/*
Willy Tarreau12785782012-04-27 21:37:17 +0200405 * Registers the sample format coverstion keyword list <pckl> as a list of valid keywords for next
Emeric Brun107ca302010-01-04 16:16:05 +0100406 * parsing sessions.
407 */
Willy Tarreau12785782012-04-27 21:37:17 +0200408void sample_register_convs(struct sample_conv_kw_list *pckl)
Emeric Brun107ca302010-01-04 16:16:05 +0100409{
Willy Tarreau2b718102021-04-21 07:32:39 +0200410 LIST_APPEND(&sample_convs.list, &pckl->list);
Emeric Brun107ca302010-01-04 16:16:05 +0100411}
412
413/*
Willy Tarreau12785782012-04-27 21:37:17 +0200414 * Returns the pointer on sample fetch keyword structure identified by
Emeric Brun107ca302010-01-04 16:16:05 +0100415 * string of <len> in buffer <kw>.
416 *
417 */
Willy Tarreau12785782012-04-27 21:37:17 +0200418struct sample_fetch *find_sample_fetch(const char *kw, int len)
Emeric Brun107ca302010-01-04 16:16:05 +0100419{
420 int index;
Willy Tarreau12785782012-04-27 21:37:17 +0200421 struct sample_fetch_kw_list *kwl;
Emeric Brun107ca302010-01-04 16:16:05 +0100422
Willy Tarreau12785782012-04-27 21:37:17 +0200423 list_for_each_entry(kwl, &sample_fetches.list, list) {
Emeric Brun107ca302010-01-04 16:16:05 +0100424 for (index = 0; kwl->kw[index].kw != NULL; index++) {
425 if (strncmp(kwl->kw[index].kw, kw, len) == 0 &&
426 kwl->kw[index].kw[len] == '\0')
427 return &kwl->kw[index];
428 }
429 }
430 return NULL;
431}
432
Tim Duesterhusc555ee02018-01-25 16:24:44 +0100433/* This function browses the list of available sample fetches. <current> is
Thierry FOURNIER4d9a1d12014-12-08 14:49:19 +0100434 * the last used sample fetch. If it is the first call, it must set to NULL.
Tim Duesterhusc555ee02018-01-25 16:24:44 +0100435 * <idx> is the index of the next sample fetch entry. It is used as private
436 * value. It is useless to initiate it.
Thierry FOURNIER4d9a1d12014-12-08 14:49:19 +0100437 *
Tim Duesterhusc555ee02018-01-25 16:24:44 +0100438 * It returns always the new fetch_sample entry, and NULL when the end of
Thierry FOURNIER4d9a1d12014-12-08 14:49:19 +0100439 * the list is reached.
440 */
441struct sample_fetch *sample_fetch_getnext(struct sample_fetch *current, int *idx)
442{
443 struct sample_fetch_kw_list *kwl;
444 struct sample_fetch *base;
445
446 if (!current) {
447 /* Get first kwl entry. */
448 kwl = LIST_NEXT(&sample_fetches.list, struct sample_fetch_kw_list *, list);
449 (*idx) = 0;
450 } else {
451 /* Get kwl corresponding to the curret entry. */
452 base = current + 1 - (*idx);
453 kwl = container_of(base, struct sample_fetch_kw_list, kw);
454 }
455
456 while (1) {
457
458 /* Check if kwl is the last entry. */
459 if (&kwl->list == &sample_fetches.list)
460 return NULL;
461
462 /* idx contain the next keyword. If it is available, return it. */
463 if (kwl->kw[*idx].kw) {
464 (*idx)++;
465 return &kwl->kw[(*idx)-1];
466 }
467
468 /* get next entry in the main list, and return NULL if the end is reached. */
469 kwl = LIST_NEXT(&kwl->list, struct sample_fetch_kw_list *, list);
470
471 /* Set index to 0, ans do one other loop. */
472 (*idx) = 0;
473 }
474}
475
Thierry FOURNIER8fd13762015-03-10 23:56:48 +0100476/* This function browses the list of available converters. <current> is
477 * the last used converter. If it is the first call, it must set to NULL.
478 * <idx> is the index of the next converter entry. It is used as private
479 * value. It is useless to initiate it.
480 *
481 * It returns always the next sample_conv entry, and NULL when the end of
482 * the list is reached.
483 */
484struct sample_conv *sample_conv_getnext(struct sample_conv *current, int *idx)
485{
486 struct sample_conv_kw_list *kwl;
487 struct sample_conv *base;
488
489 if (!current) {
490 /* Get first kwl entry. */
491 kwl = LIST_NEXT(&sample_convs.list, struct sample_conv_kw_list *, list);
492 (*idx) = 0;
493 } else {
494 /* Get kwl corresponding to the curret entry. */
495 base = current + 1 - (*idx);
496 kwl = container_of(base, struct sample_conv_kw_list, kw);
497 }
498
499 while (1) {
500 /* Check if kwl is the last entry. */
501 if (&kwl->list == &sample_convs.list)
502 return NULL;
503
504 /* idx contain the next keyword. If it is available, return it. */
505 if (kwl->kw[*idx].kw) {
506 (*idx)++;
507 return &kwl->kw[(*idx)-1];
508 }
509
510 /* get next entry in the main list, and return NULL if the end is reached. */
511 kwl = LIST_NEXT(&kwl->list, struct sample_conv_kw_list *, list);
512
513 /* Set index to 0, ans do one other loop. */
514 (*idx) = 0;
515 }
516}
517
Emeric Brun107ca302010-01-04 16:16:05 +0100518/*
Willy Tarreau12785782012-04-27 21:37:17 +0200519 * Returns the pointer on sample format conversion keyword structure identified by
Emeric Brun107ca302010-01-04 16:16:05 +0100520 * string of <len> in buffer <kw>.
521 *
522 */
Willy Tarreau12785782012-04-27 21:37:17 +0200523struct sample_conv *find_sample_conv(const char *kw, int len)
Emeric Brun107ca302010-01-04 16:16:05 +0100524{
525 int index;
Willy Tarreau12785782012-04-27 21:37:17 +0200526 struct sample_conv_kw_list *kwl;
Emeric Brun107ca302010-01-04 16:16:05 +0100527
Willy Tarreau12785782012-04-27 21:37:17 +0200528 list_for_each_entry(kwl, &sample_convs.list, list) {
Emeric Brun107ca302010-01-04 16:16:05 +0100529 for (index = 0; kwl->kw[index].kw != NULL; index++) {
530 if (strncmp(kwl->kw[index].kw, kw, len) == 0 &&
531 kwl->kw[index].kw[len] == '\0')
532 return &kwl->kw[index];
533 }
534 }
535 return NULL;
536}
537
Emeric Brun107ca302010-01-04 16:16:05 +0100538/******************************************************************/
Willy Tarreau12785782012-04-27 21:37:17 +0200539/* Sample casts functions */
Emeric Brun107ca302010-01-04 16:16:05 +0100540/******************************************************************/
541
Willy Tarreau342acb42012-04-23 22:03:39 +0200542static int c_ip2int(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100543{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200544 smp->data.u.sint = ntohl(smp->data.u.ipv4.s_addr);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200545 smp->data.type = SMP_T_SINT;
Emeric Brun107ca302010-01-04 16:16:05 +0100546 return 1;
547}
548
Willy Tarreau342acb42012-04-23 22:03:39 +0200549static int c_ip2str(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100550{
Willy Tarreau83061a82018-07-13 11:56:34 +0200551 struct buffer *trash = get_trash_chunk();
Emeric Brun107ca302010-01-04 16:16:05 +0100552
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200553 if (!inet_ntop(AF_INET, (void *)&smp->data.u.ipv4, trash->area, trash->size))
Emeric Brun107ca302010-01-04 16:16:05 +0100554 return 0;
555
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200556 trash->data = strlen(trash->area);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200557 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200558 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100559 smp->flags &= ~SMP_F_CONST;
Emeric Brun107ca302010-01-04 16:16:05 +0100560
561 return 1;
562}
563
Willy Tarreau342acb42012-04-23 22:03:39 +0200564static int c_ip2ipv6(struct sample *smp)
David du Colombier4f92d322011-03-24 11:09:31 +0100565{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200566 v4tov6(&smp->data.u.ipv6, &smp->data.u.ipv4);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200567 smp->data.type = SMP_T_IPV6;
David du Colombier4f92d322011-03-24 11:09:31 +0100568 return 1;
569}
570
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200571static int c_ipv62ip(struct sample *smp)
572{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200573 if (!v6tov4(&smp->data.u.ipv4, &smp->data.u.ipv6))
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200574 return 0;
Tim Duesterhusbf5ce022018-01-25 16:24:46 +0100575 smp->data.type = SMP_T_IPV4;
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200576 return 1;
577}
578
Willy Tarreau342acb42012-04-23 22:03:39 +0200579static int c_ipv62str(struct sample *smp)
David du Colombier4f92d322011-03-24 11:09:31 +0100580{
Willy Tarreau83061a82018-07-13 11:56:34 +0200581 struct buffer *trash = get_trash_chunk();
David du Colombier4f92d322011-03-24 11:09:31 +0100582
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200583 if (!inet_ntop(AF_INET6, (void *)&smp->data.u.ipv6, trash->area, trash->size))
David du Colombier4f92d322011-03-24 11:09:31 +0100584 return 0;
585
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200586 trash->data = strlen(trash->area);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200587 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200588 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100589 smp->flags &= ~SMP_F_CONST;
David du Colombier4f92d322011-03-24 11:09:31 +0100590 return 1;
591}
592
593/*
Willy Tarreau342acb42012-04-23 22:03:39 +0200594static int c_ipv62ip(struct sample *smp)
David du Colombier4f92d322011-03-24 11:09:31 +0100595{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200596 return v6tov4(&smp->data.u.ipv4, &smp->data.u.ipv6);
David du Colombier4f92d322011-03-24 11:09:31 +0100597}
598*/
599
Willy Tarreau342acb42012-04-23 22:03:39 +0200600static int c_int2ip(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100601{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200602 smp->data.u.ipv4.s_addr = htonl((unsigned int)smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200603 smp->data.type = SMP_T_IPV4;
Emeric Brun107ca302010-01-04 16:16:05 +0100604 return 1;
605}
606
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200607static int c_int2ipv6(struct sample *smp)
608{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200609 smp->data.u.ipv4.s_addr = htonl((unsigned int)smp->data.u.sint);
610 v4tov6(&smp->data.u.ipv6, &smp->data.u.ipv4);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200611 smp->data.type = SMP_T_IPV6;
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200612 return 1;
613}
614
Thierry FOURNIERb805f712013-11-26 20:47:54 +0100615static int c_str2addr(struct sample *smp)
616{
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200617 if (!buf2ip(smp->data.u.str.area, smp->data.u.str.data, &smp->data.u.ipv4)) {
618 if (!buf2ip6(smp->data.u.str.area, smp->data.u.str.data, &smp->data.u.ipv6))
Thierry FOURNIERfd139902013-12-11 12:38:57 +0100619 return 0;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200620 smp->data.type = SMP_T_IPV6;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100621 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIERfd139902013-12-11 12:38:57 +0100622 return 1;
Thierry FOURNIERb805f712013-11-26 20:47:54 +0100623 }
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200624 smp->data.type = SMP_T_IPV4;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100625 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIERb805f712013-11-26 20:47:54 +0100626 return 1;
627}
628
Willy Tarreau342acb42012-04-23 22:03:39 +0200629static int c_str2ip(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100630{
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200631 if (!buf2ip(smp->data.u.str.area, smp->data.u.str.data, &smp->data.u.ipv4))
Emeric Brun107ca302010-01-04 16:16:05 +0100632 return 0;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200633 smp->data.type = SMP_T_IPV4;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100634 smp->flags &= ~SMP_F_CONST;
Emeric Brun107ca302010-01-04 16:16:05 +0100635 return 1;
636}
637
Willy Tarreau342acb42012-04-23 22:03:39 +0200638static int c_str2ipv6(struct sample *smp)
David du Colombier4f92d322011-03-24 11:09:31 +0100639{
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200640 if (!buf2ip6(smp->data.u.str.area, smp->data.u.str.data, &smp->data.u.ipv6))
Thierry FOURNIERfd139902013-12-11 12:38:57 +0100641 return 0;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200642 smp->data.type = SMP_T_IPV6;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100643 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIERfd139902013-12-11 12:38:57 +0100644 return 1;
David du Colombier4f92d322011-03-24 11:09:31 +0100645}
646
Emeric Brun4b9e8022014-11-03 18:17:10 +0100647/*
648 * The NULL char always enforces the end of string if it is met.
649 * Data is never changed, so we can ignore the CONST case
Thierry FOURNIERe87cac12014-03-12 15:07:59 +0100650 */
Emeric Brun8ac33d92012-10-17 13:36:06 +0200651static int c_bin2str(struct sample *smp)
652{
Emeric Brun4b9e8022014-11-03 18:17:10 +0100653 int i;
Emeric Brun8ac33d92012-10-17 13:36:06 +0200654
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200655 for (i = 0; i < smp->data.u.str.data; i++) {
656 if (!smp->data.u.str.area[i]) {
657 smp->data.u.str.data = i;
Thierry FOURNIERe87cac12014-03-12 15:07:59 +0100658 break;
Emeric Brun4b9e8022014-11-03 18:17:10 +0100659 }
Emeric Brun8ac33d92012-10-17 13:36:06 +0200660 }
Christopher Faulet472ad512020-04-30 09:57:40 +0200661 smp->data.type = SMP_T_STR;
Emeric Brun8ac33d92012-10-17 13:36:06 +0200662 return 1;
663}
664
Willy Tarreau342acb42012-04-23 22:03:39 +0200665static int c_int2str(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100666{
Willy Tarreau83061a82018-07-13 11:56:34 +0200667 struct buffer *trash = get_trash_chunk();
Emeric Brun107ca302010-01-04 16:16:05 +0100668 char *pos;
669
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200670 pos = lltoa_r(smp->data.u.sint, trash->area, trash->size);
Emeric Brun107ca302010-01-04 16:16:05 +0100671 if (!pos)
672 return 0;
673
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200674 trash->size = trash->size - (pos - trash->area);
675 trash->area = pos;
676 trash->data = strlen(pos);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200677 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200678 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100679 smp->flags &= ~SMP_F_CONST;
Emeric Brun107ca302010-01-04 16:16:05 +0100680 return 1;
681}
682
Joseph Herlant757f5ad2018-11-15 12:14:56 -0800683/* This function unconditionally duplicates data and removes the "const" flag.
Willy Tarreauad635822016-08-08 19:21:09 +0200684 * For strings and binary blocks, it also provides a known allocated size with
685 * a length that is capped to the size, and ensures a trailing zero is always
686 * appended for strings. This is necessary for some operations which may
687 * require to extend the length. It returns 0 if it fails, 1 on success.
688 */
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100689int smp_dup(struct sample *smp)
Emeric Brun485479d2010-09-23 18:02:19 +0200690{
Willy Tarreau83061a82018-07-13 11:56:34 +0200691 struct buffer *trash;
Emeric Brun485479d2010-09-23 18:02:19 +0200692
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200693 switch (smp->data.type) {
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100694 case SMP_T_BOOL:
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100695 case SMP_T_SINT:
696 case SMP_T_ADDR:
697 case SMP_T_IPV4:
698 case SMP_T_IPV6:
699 /* These type are not const. */
700 break;
Willy Tarreauad635822016-08-08 19:21:09 +0200701
Christopher Fauletec100512017-07-24 15:38:41 +0200702 case SMP_T_METH:
703 if (smp->data.u.meth.meth != HTTP_METH_OTHER)
704 break;
705 /* Fall through */
706
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100707 case SMP_T_STR:
Willy Tarreauad635822016-08-08 19:21:09 +0200708 trash = get_trash_chunk();
Olivier Houchard4468f1c2018-12-07 15:23:41 +0100709 trash->data = smp->data.type == SMP_T_STR ?
710 smp->data.u.str.data : smp->data.u.meth.str.data;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200711 if (trash->data > trash->size - 1)
712 trash->data = trash->size - 1;
Willy Tarreauad635822016-08-08 19:21:09 +0200713
Olivier Houchard4468f1c2018-12-07 15:23:41 +0100714 memcpy(trash->area, smp->data.type == SMP_T_STR ?
715 smp->data.u.str.area : smp->data.u.meth.str.area,
716 trash->data);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200717 trash->area[trash->data] = 0;
Willy Tarreauad635822016-08-08 19:21:09 +0200718 smp->data.u.str = *trash;
719 break;
720
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100721 case SMP_T_BIN:
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100722 trash = get_trash_chunk();
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200723 trash->data = smp->data.u.str.data;
724 if (trash->data > trash->size)
725 trash->data = trash->size;
Willy Tarreauad635822016-08-08 19:21:09 +0200726
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200727 memcpy(trash->area, smp->data.u.str.area, trash->data);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200728 smp->data.u.str = *trash;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100729 break;
Christopher Fauletec100512017-07-24 15:38:41 +0200730
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100731 default:
732 /* Other cases are unexpected. */
733 return 0;
734 }
Thierry FOURNIERb805f712013-11-26 20:47:54 +0100735
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100736 /* remove const flag */
737 smp->flags &= ~SMP_F_CONST;
Emeric Brun485479d2010-09-23 18:02:19 +0200738 return 1;
739}
740
Thierry FOURNIER0e9af552013-12-14 14:55:04 +0100741int c_none(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100742{
743 return 1;
744}
745
Willy Tarreau342acb42012-04-23 22:03:39 +0200746static int c_str2int(struct sample *smp)
Emeric Brun107ca302010-01-04 16:16:05 +0100747{
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200748 const char *str;
749 const char *end;
Emeric Brun107ca302010-01-04 16:16:05 +0100750
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200751 if (smp->data.u.str.data == 0)
Thierry FOURNIER60bb0202014-01-27 18:20:48 +0100752 return 0;
753
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200754 str = smp->data.u.str.area;
755 end = smp->data.u.str.area + smp->data.u.str.data;
Emeric Brun107ca302010-01-04 16:16:05 +0100756
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200757 smp->data.u.sint = read_int64(&str, end);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200758 smp->data.type = SMP_T_SINT;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +0100759 smp->flags &= ~SMP_F_CONST;
Emeric Brun107ca302010-01-04 16:16:05 +0100760 return 1;
761}
762
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100763static int c_str2meth(struct sample *smp)
764{
765 enum http_meth_t meth;
766 int len;
767
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200768 meth = find_http_meth(smp->data.u.str.area, smp->data.u.str.data);
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100769 if (meth == HTTP_METH_OTHER) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200770 len = smp->data.u.str.data;
771 smp->data.u.meth.str.area = smp->data.u.str.area;
772 smp->data.u.meth.str.data = len;
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100773 }
774 else
775 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200776 smp->data.u.meth.meth = meth;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200777 smp->data.type = SMP_T_METH;
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100778 return 1;
779}
780
781static int c_meth2str(struct sample *smp)
782{
783 int len;
784 enum http_meth_t meth;
785
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200786 if (smp->data.u.meth.meth == HTTP_METH_OTHER) {
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100787 /* The method is unknown. Copy the original pointer. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200788 len = smp->data.u.meth.str.data;
789 smp->data.u.str.area = smp->data.u.meth.str.area;
790 smp->data.u.str.data = len;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200791 smp->data.type = SMP_T_STR;
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100792 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200793 else if (smp->data.u.meth.meth < HTTP_METH_OTHER) {
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100794 /* The method is known, copy the pointer containing the string. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200795 meth = smp->data.u.meth.meth;
Willy Tarreau35b51c62018-09-10 15:38:55 +0200796 smp->data.u.str.area = http_known_methods[meth].ptr;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200797 smp->data.u.str.data = http_known_methods[meth].len;
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100798 smp->flags |= SMP_F_CONST;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200799 smp->data.type = SMP_T_STR;
Thierry FOURNIERd4373142013-12-17 01:10:10 +0100800 }
801 else {
802 /* Unknown method */
803 return 0;
804 }
805 return 1;
806}
807
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200808static int c_addr2bin(struct sample *smp)
809{
Willy Tarreau83061a82018-07-13 11:56:34 +0200810 struct buffer *chk = get_trash_chunk();
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200811
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200812 if (smp->data.type == SMP_T_IPV4) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200813 chk->data = 4;
814 memcpy(chk->area, &smp->data.u.ipv4, chk->data);
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200815 }
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200816 else if (smp->data.type == SMP_T_IPV6) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200817 chk->data = 16;
818 memcpy(chk->area, &smp->data.u.ipv6, chk->data);
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200819 }
820 else
821 return 0;
822
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200823 smp->data.u.str = *chk;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200824 smp->data.type = SMP_T_BIN;
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200825 return 1;
826}
827
Willy Tarreaubbfd1a22014-07-15 21:19:08 +0200828static int c_int2bin(struct sample *smp)
829{
Willy Tarreau83061a82018-07-13 11:56:34 +0200830 struct buffer *chk = get_trash_chunk();
Willy Tarreaubbfd1a22014-07-15 21:19:08 +0200831
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200832 *(unsigned long long int *) chk->area = my_htonll(smp->data.u.sint);
833 chk->data = 8;
Willy Tarreaubbfd1a22014-07-15 21:19:08 +0200834
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200835 smp->data.u.str = *chk;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200836 smp->data.type = SMP_T_BIN;
Willy Tarreaubbfd1a22014-07-15 21:19:08 +0200837 return 1;
838}
839
Willy Tarreau9700e5c2014-07-15 21:03:26 +0200840
Emeric Brun107ca302010-01-04 16:16:05 +0100841/*****************************************************************/
Willy Tarreau12785782012-04-27 21:37:17 +0200842/* Sample casts matrix: */
843/* sample_casts[from type][to type] */
844/* NULL pointer used for impossible sample casts */
Emeric Brun107ca302010-01-04 16:16:05 +0100845/*****************************************************************/
Emeric Brun107ca302010-01-04 16:16:05 +0100846
Thierry FOURNIER8af6ff12013-11-21 10:53:12 +0100847sample_cast_fct sample_casts[SMP_TYPES][SMP_TYPES] = {
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200848/* to: ANY BOOL SINT ADDR IPV4 IPV6 STR BIN METH */
849/* from: ANY */ { c_none, c_none, c_none, c_none, c_none, c_none, c_none, c_none, c_none, },
850/* BOOL */ { c_none, c_none, c_none, NULL, NULL, NULL, c_int2str, NULL, NULL, },
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200851/* 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 +0200852/* ADDR */ { c_none, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, },
853/* IPV4 */ { c_none, NULL, c_ip2int, c_none, c_none, c_ip2ipv6, c_ip2str, c_addr2bin, NULL, },
Thierry FOURNIERcc4d1712015-07-24 09:04:56 +0200854/* IPV6 */ { c_none, NULL, NULL, c_none, c_ipv62ip,c_none, c_ipv62str, c_addr2bin, NULL, },
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200855/* STR */ { c_none, c_str2int, c_str2int, c_str2addr, c_str2ip, c_str2ipv6, c_none, c_none, c_str2meth, },
856/* BIN */ { c_none, NULL, NULL, NULL, NULL, NULL, c_bin2str, c_none, c_str2meth, },
857/* METH */ { c_none, NULL, NULL, NULL, NULL, NULL, c_meth2str, c_meth2str, c_none, }
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200858};
Emeric Brun107ca302010-01-04 16:16:05 +0100859
Emeric Brun107ca302010-01-04 16:16:05 +0100860/*
Willy Tarreau12785782012-04-27 21:37:17 +0200861 * Parse a sample expression configuration:
Emeric Brun107ca302010-01-04 16:16:05 +0100862 * fetch keyword followed by format conversion keywords.
Willy Tarreau12785782012-04-27 21:37:17 +0200863 * Returns a pointer on allocated sample expression structure.
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200864 * The caller must have set al->ctx.
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100865 * If <endptr> is non-nul, it will be set to the first unparsed character
866 * (which may be the final '\0') on success. If it is nul, the expression
867 * must be properly terminated by a '\0' otherwise an error is reported.
Emeric Brun107ca302010-01-04 16:16:05 +0100868 */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100869struct 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 +0100870{
Willy Tarreau833cc792013-07-24 15:34:19 +0200871 const char *begw; /* beginning of word */
872 const char *endw; /* end of word */
873 const char *endt; /* end of term */
Remi Tricot-Le Breton22e0d9b2021-01-12 14:55:12 +0100874 struct sample_expr *expr = NULL;
Willy Tarreau12785782012-04-27 21:37:17 +0200875 struct sample_fetch *fetch;
876 struct sample_conv *conv;
Emeric Brun107ca302010-01-04 16:16:05 +0100877 unsigned long prev_type;
Willy Tarreau833cc792013-07-24 15:34:19 +0200878 char *fkw = NULL;
879 char *ckw = NULL;
Willy Tarreau689a1df2013-12-13 00:40:11 +0100880 int err_arg;
Emeric Brun107ca302010-01-04 16:16:05 +0100881
Willy Tarreau833cc792013-07-24 15:34:19 +0200882 begw = str[*idx];
Willy Tarreaued2c6622020-02-14 18:27:10 +0100883 for (endw = begw; is_idchar(*endw); endw++)
884 ;
Willy Tarreau833cc792013-07-24 15:34:19 +0200885
886 if (endw == begw) {
Willy Tarreau975c1782013-12-12 23:16:54 +0100887 memprintf(err_msg, "missing fetch method");
Emeric Brun107ca302010-01-04 16:16:05 +0100888 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +0200889 }
Emeric Brun107ca302010-01-04 16:16:05 +0100890
Willy Tarreau833cc792013-07-24 15:34:19 +0200891 /* keep a copy of the current fetch keyword for error reporting */
892 fkw = my_strndup(begw, endw - begw);
Emeric Brun107ca302010-01-04 16:16:05 +0100893
Willy Tarreau833cc792013-07-24 15:34:19 +0200894 fetch = find_sample_fetch(begw, endw - begw);
895 if (!fetch) {
Willy Tarreau975c1782013-12-12 23:16:54 +0100896 memprintf(err_msg, "unknown fetch method '%s'", fkw);
Emeric Brun107ca302010-01-04 16:16:05 +0100897 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +0200898 }
Emeric Brun107ca302010-01-04 16:16:05 +0100899
Willy Tarreau833cc792013-07-24 15:34:19 +0200900 /* At this point, we have :
901 * - begw : beginning of the keyword
Willy Tarreau689a1df2013-12-13 00:40:11 +0100902 * - endw : end of the keyword, first character not part of keyword
Willy Tarreau833cc792013-07-24 15:34:19 +0200903 */
904
905 if (fetch->out_type >= SMP_TYPES) {
Willy Tarreau975c1782013-12-12 23:16:54 +0100906 memprintf(err_msg, "returns type of fetch method '%s' is unknown", fkw);
Emeric Brun107ca302010-01-04 16:16:05 +0100907 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +0200908 }
Emeric Brun107ca302010-01-04 16:16:05 +0100909 prev_type = fetch->out_type;
Willy Tarreau833cc792013-07-24 15:34:19 +0200910
Vincent Bernat02779b62016-04-03 13:48:43 +0200911 expr = calloc(1, sizeof(*expr));
Emeric Brun485479d2010-09-23 18:02:19 +0200912 if (!expr)
913 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +0100914
915 LIST_INIT(&(expr->conv_exprs));
916 expr->fetch = fetch;
Willy Tarreau2e845be2012-10-19 19:49:09 +0200917 expr->arg_p = empty_arg_list;
Emeric Brun107ca302010-01-04 16:16:05 +0100918
Willy Tarreau689a1df2013-12-13 00:40:11 +0100919 /* Note that we call the argument parser even with an empty string,
920 * this allows it to automatically create entries for mandatory
921 * implicit arguments (eg: local proxy name).
922 */
923 al->kw = expr->fetch->kw;
924 al->conv = NULL;
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100925 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 +0100926 memprintf(err_msg, "fetch method '%s' : %s", fkw, *err_msg);
927 goto out_error;
928 }
Willy Tarreau2e845be2012-10-19 19:49:09 +0200929
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100930 /* now endt is our first char not part of the arg list, typically the
931 * comma after the sample fetch name or after the closing parenthesis,
932 * or the NUL char.
933 */
934
Willy Tarreau689a1df2013-12-13 00:40:11 +0100935 if (!expr->arg_p) {
936 expr->arg_p = empty_arg_list;
Emeric Brun485479d2010-09-23 18:02:19 +0200937 }
Willy Tarreau689a1df2013-12-13 00:40:11 +0100938 else if (fetch->val_args && !fetch->val_args(expr->arg_p, err_msg)) {
939 memprintf(err_msg, "invalid args in fetch method '%s' : %s", fkw, *err_msg);
Emeric Brun485479d2010-09-23 18:02:19 +0200940 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +0100941 }
942
Willy Tarreau833cc792013-07-24 15:34:19 +0200943 /* Now process the converters if any. We have two supported syntaxes
944 * for the converters, which can be combined :
945 * - comma-delimited list of converters just after the keyword and args ;
946 * - one converter per keyword
947 * The combination allows to have each keyword being a comma-delimited
948 * series of converters.
949 *
950 * We want to process the former first, then the latter. For this we start
951 * from the beginning of the supposed place in the exiting conv chain, which
952 * starts at the last comma (endt).
953 */
954
955 while (1) {
Willy Tarreau12785782012-04-27 21:37:17 +0200956 struct sample_conv_expr *conv_expr;
Willy Tarreau46dfd782019-12-17 10:25:29 +0100957 int err_arg;
958 int argcnt;
Emeric Brun107ca302010-01-04 16:16:05 +0100959
Willy Tarreau833cc792013-07-24 15:34:19 +0200960 if (*endt && *endt != ',') {
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100961 if (endptr) {
962 /* end found, let's stop here */
963 break;
964 }
Willy Tarreau833cc792013-07-24 15:34:19 +0200965 if (ckw)
Willy Tarreau97108e02016-11-25 07:33:24 +0100966 memprintf(err_msg, "missing comma after converter '%s'", ckw);
Willy Tarreau833cc792013-07-24 15:34:19 +0200967 else
Willy Tarreau975c1782013-12-12 23:16:54 +0100968 memprintf(err_msg, "missing comma after fetch keyword '%s'", fkw);
Emeric Brun107ca302010-01-04 16:16:05 +0100969 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +0200970 }
Emeric Brun107ca302010-01-04 16:16:05 +0100971
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100972 /* FIXME: how long should we support such idiocies ? Maybe we
973 * should already warn ?
974 */
Willy Tarreau833cc792013-07-24 15:34:19 +0200975 while (*endt == ',') /* then trailing commas */
976 endt++;
977
Willy Tarreau97108e02016-11-25 07:33:24 +0100978 begw = endt; /* start of converter */
Willy Tarreau833cc792013-07-24 15:34:19 +0200979
980 if (!*begw) {
981 /* none ? skip to next string */
982 (*idx)++;
983 begw = str[*idx];
984 if (!begw || !*begw)
985 break;
986 }
987
Willy Tarreaued2c6622020-02-14 18:27:10 +0100988 for (endw = begw; is_idchar(*endw); endw++)
989 ;
Willy Tarreau833cc792013-07-24 15:34:19 +0200990
991 free(ckw);
992 ckw = my_strndup(begw, endw - begw);
993
994 conv = find_sample_conv(begw, endw - begw);
995 if (!conv) {
996 /* we found an isolated keyword that we don't know, it's not ours */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100997 if (begw == str[*idx]) {
998 endt = begw;
Willy Tarreau833cc792013-07-24 15:34:19 +0200999 break;
Willy Tarreaue3b57bf2020-02-14 16:50:14 +01001000 }
Willy Tarreau97108e02016-11-25 07:33:24 +01001001 memprintf(err_msg, "unknown converter '%s'", ckw);
Willy Tarreau833cc792013-07-24 15:34:19 +02001002 goto out_error;
1003 }
Emeric Brun107ca302010-01-04 16:16:05 +01001004
Willy Tarreau833cc792013-07-24 15:34:19 +02001005 if (conv->in_type >= SMP_TYPES || conv->out_type >= SMP_TYPES) {
Willy Tarreau97108e02016-11-25 07:33:24 +01001006 memprintf(err_msg, "returns type of converter '%s' is unknown", ckw);
Emeric Brun107ca302010-01-04 16:16:05 +01001007 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +02001008 }
Emeric Brun107ca302010-01-04 16:16:05 +01001009
1010 /* If impossible type conversion */
Willy Tarreau12785782012-04-27 21:37:17 +02001011 if (!sample_casts[prev_type][conv->in_type]) {
Willy Tarreau97108e02016-11-25 07:33:24 +01001012 memprintf(err_msg, "converter '%s' cannot be applied", ckw);
Emeric Brun107ca302010-01-04 16:16:05 +01001013 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +02001014 }
Emeric Brun107ca302010-01-04 16:16:05 +01001015
1016 prev_type = conv->out_type;
Vincent Bernat02779b62016-04-03 13:48:43 +02001017 conv_expr = calloc(1, sizeof(*conv_expr));
Emeric Brun485479d2010-09-23 18:02:19 +02001018 if (!conv_expr)
1019 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +01001020
Willy Tarreau2b718102021-04-21 07:32:39 +02001021 LIST_APPEND(&(expr->conv_exprs), &(conv_expr->list));
Emeric Brun107ca302010-01-04 16:16:05 +01001022 conv_expr->conv = conv;
1023
Willy Tarreau46dfd782019-12-17 10:25:29 +01001024 al->kw = expr->fetch->kw;
1025 al->conv = conv_expr->conv->kw;
Willy Tarreau80b53ff2020-02-14 08:40:37 +01001026 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 +01001027 if (argcnt < 0) {
1028 memprintf(err_msg, "invalid arg %d in converter '%s' : %s", err_arg+1, ckw, *err_msg);
1029 goto out_error;
1030 }
Willy Tarreau9e92d322010-01-26 17:58:06 +01001031
Willy Tarreau46dfd782019-12-17 10:25:29 +01001032 if (argcnt && !conv->arg_mask) {
1033 memprintf(err_msg, "converter '%s' does not support any args", ckw);
1034 goto out_error;
1035 }
Willy Tarreau21d68a62012-04-20 15:52:36 +02001036
Willy Tarreau46dfd782019-12-17 10:25:29 +01001037 if (!conv_expr->arg_p)
1038 conv_expr->arg_p = empty_arg_list;
Willy Tarreau2e845be2012-10-19 19:49:09 +02001039
Willy Tarreau46dfd782019-12-17 10:25:29 +01001040 if (conv->val_args && !conv->val_args(conv_expr->arg_p, conv, file, line, err_msg)) {
1041 memprintf(err_msg, "invalid args in converter '%s' : %s", ckw, *err_msg);
Emeric Brun485479d2010-09-23 18:02:19 +02001042 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +01001043 }
1044 }
Emeric Brun485479d2010-09-23 18:02:19 +02001045
Willy Tarreaue3b57bf2020-02-14 16:50:14 +01001046 if (endptr) {
1047 /* end found, let's stop here */
1048 *endptr = (char *)endt;
1049 }
1050
Willy Tarreau833cc792013-07-24 15:34:19 +02001051 out:
1052 free(fkw);
1053 free(ckw);
Emeric Brun107ca302010-01-04 16:16:05 +01001054 return expr;
1055
1056out_error:
Remi Tricot-Le Breton22e0d9b2021-01-12 14:55:12 +01001057 release_sample_expr(expr);
Willy Tarreau833cc792013-07-24 15:34:19 +02001058 expr = NULL;
1059 goto out;
Emeric Brun107ca302010-01-04 16:16:05 +01001060}
1061
1062/*
Willy Tarreau12785782012-04-27 21:37:17 +02001063 * Process a fetch + format conversion of defined by the sample expression <expr>
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001064 * on request or response considering the <opt> parameter.
Willy Tarreau12785782012-04-27 21:37:17 +02001065 * Returns a pointer on a typed sample structure containing the result or NULL if
1066 * sample is not found or when format conversion failed.
Emeric Brun107ca302010-01-04 16:16:05 +01001067 * If <p> is not null, function returns results in structure pointed by <p>.
Willy Tarreau12785782012-04-27 21:37:17 +02001068 * If <p> is null, functions returns a pointer on a static sample structure.
Willy Tarreaub8c8f1f2012-04-23 22:38:26 +02001069 *
1070 * Note: the fetch functions are required to properly set the return type. The
1071 * conversion functions must do so too. However the cast functions do not need
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05001072 * to since they're made to cast multiple types according to what is required.
Willy Tarreau6bcb0a82014-07-30 08:56:35 +02001073 *
1074 * The caller may indicate in <opt> if it considers the result final or not.
1075 * The caller needs to check the SMP_F_MAY_CHANGE flag in p->flags to verify
1076 * if the result is stable or not, according to the following table :
1077 *
1078 * return MAY_CHANGE FINAL Meaning for the sample
1079 * NULL 0 * Not present and will never be (eg: header)
1080 * NULL 1 0 Not present yet, could change (eg: POST param)
1081 * NULL 1 1 Not present yet, will not change anymore
1082 * smp 0 * Present and will not change (eg: header)
1083 * smp 1 0 Present, may change (eg: request length)
1084 * smp 1 1 Present, last known value (eg: request length)
Emeric Brun107ca302010-01-04 16:16:05 +01001085 */
Willy Tarreau192252e2015-04-04 01:47:55 +02001086struct sample *sample_process(struct proxy *px, struct session *sess,
1087 struct stream *strm, unsigned int opt,
Willy Tarreau12785782012-04-27 21:37:17 +02001088 struct sample_expr *expr, struct sample *p)
Emeric Brun107ca302010-01-04 16:16:05 +01001089{
Willy Tarreau12785782012-04-27 21:37:17 +02001090 struct sample_conv_expr *conv_expr;
Emeric Brun107ca302010-01-04 16:16:05 +01001091
Willy Tarreau18387e22013-07-25 12:02:38 +02001092 if (p == NULL) {
Willy Tarreaub4a88f02012-04-23 21:35:11 +02001093 p = &temp_smp;
Willy Tarreau6c616e02014-06-25 16:56:41 +02001094 memset(p, 0, sizeof(*p));
Willy Tarreau18387e22013-07-25 12:02:38 +02001095 }
Emeric Brun107ca302010-01-04 16:16:05 +01001096
Willy Tarreau1777ea62016-03-10 16:15:46 +01001097 smp_set_owner(p, px, sess, strm, opt);
Thierry FOURNIER0786d052015-05-11 15:42:45 +02001098 if (!expr->fetch->process(expr->arg_p, p, expr->fetch->kw, expr->fetch->private))
Emeric Brun107ca302010-01-04 16:16:05 +01001099 return NULL;
1100
Emeric Brun107ca302010-01-04 16:16:05 +01001101 list_for_each_entry(conv_expr, &expr->conv_exprs, list) {
Willy Tarreau12e50112012-04-25 17:21:49 +02001102 /* we want to ensure that p->type can be casted into
1103 * conv_expr->conv->in_type. We have 3 possibilities :
1104 * - NULL => not castable.
1105 * - c_none => nothing to do (let's optimize it)
1106 * - other => apply cast and prepare to fail
1107 */
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001108 if (!sample_casts[p->data.type][conv_expr->conv->in_type])
Willy Tarreau12e50112012-04-25 17:21:49 +02001109 return NULL;
1110
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001111 if (sample_casts[p->data.type][conv_expr->conv->in_type] != c_none &&
1112 !sample_casts[p->data.type][conv_expr->conv->in_type](p))
Emeric Brun107ca302010-01-04 16:16:05 +01001113 return NULL;
1114
Willy Tarreau12e50112012-04-25 17:21:49 +02001115 /* OK cast succeeded */
1116
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02001117 if (!conv_expr->conv->process(conv_expr->arg_p, p, conv_expr->conv->private))
Emeric Brun107ca302010-01-04 16:16:05 +01001118 return NULL;
Emeric Brun107ca302010-01-04 16:16:05 +01001119 }
1120 return p;
1121}
1122
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001123/*
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001124 * Resolve all remaining arguments in proxy <p>. Returns the number of
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001125 * errors or 0 if everything is fine. If at least one error is met, it will
1126 * be appended to *err. If *err==NULL it will be allocated first.
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001127 */
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001128int smp_resolve_args(struct proxy *p, char **err)
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001129{
1130 struct arg_list *cur, *bak;
1131 const char *ctx, *where;
1132 const char *conv_ctx, *conv_pre, *conv_pos;
1133 struct userlist *ul;
Willy Tarreau46947782015-01-19 19:00:58 +01001134 struct my_regex *reg;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001135 struct arg *arg;
1136 int cfgerr = 0;
Willy Tarreau46947782015-01-19 19:00:58 +01001137 int rflags;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001138
1139 list_for_each_entry_safe(cur, bak, &p->conf.args.list, list) {
1140 struct proxy *px;
1141 struct server *srv;
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001142 struct stktable *t;
1143 char *pname, *sname, *stktname;
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001144 char *err2;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001145
1146 arg = cur->arg;
1147
1148 /* prepare output messages */
1149 conv_pre = conv_pos = conv_ctx = "";
1150 if (cur->conv) {
1151 conv_ctx = cur->conv;
1152 conv_pre = "conversion keyword '";
1153 conv_pos = "' for ";
1154 }
1155
1156 where = "in";
1157 ctx = "sample fetch keyword";
1158 switch (cur->ctx) {
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001159 case ARGC_STK: where = "in stick rule in"; break;
1160 case ARGC_TRK: where = "in tracking rule in"; break;
1161 case ARGC_LOG: where = "in log-format string in"; break;
1162 case ARGC_LOGSD: where = "in log-format-sd string in"; break;
1163 case ARGC_HRQ: where = "in http-request header format string in"; break;
1164 case ARGC_HRS: where = "in http-response header format string in"; break;
1165 case ARGC_UIF: where = "in unique-id-format string in"; break;
1166 case ARGC_RDR: where = "in redirect format string in"; break;
1167 case ARGC_CAP: where = "in capture rule in"; break;
1168 case ARGC_ACL: ctx = "ACL keyword"; break;
1169 case ARGC_SRV: where = "in server directive in"; break;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001170 case ARGC_SPOE: where = "in spoe-message directive in"; break;
Christopher Faulet3b967c12020-05-15 15:47:44 +02001171 case ARGC_HERR: where = "in http-error directive in"; break;
Miroslav Zagorac7f8314c2020-12-09 16:31:48 +01001172 case ARGC_OT: where = "in ot-scope directive in"; break;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001173 }
1174
1175 /* set a few default settings */
1176 px = p;
1177 pname = p->id;
1178
1179 switch (arg->type) {
1180 case ARGT_SRV:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001181 if (!arg->data.str.data) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001182 memprintf(err, "%sparsing [%s:%d]: missing server name in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1183 *err ? *err : "", cur->file, cur->line,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001184 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001185 cfgerr++;
1186 continue;
1187 }
1188
1189 /* we support two formats : "bck/srv" and "srv" */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001190 sname = strrchr(arg->data.str.area, '/');
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001191
1192 if (sname) {
1193 *sname++ = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001194 pname = arg->data.str.area;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001195
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001196 px = proxy_be_by_name(pname);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001197 if (!px) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001198 memprintf(err, "%sparsing [%s:%d]: unable to find proxy '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1199 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001200 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001201 cfgerr++;
1202 break;
1203 }
1204 }
1205 else
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001206 sname = arg->data.str.area;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001207
1208 srv = findserver(px, sname);
1209 if (!srv) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001210 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",
1211 *err ? *err : "", cur->file, cur->line, sname, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001212 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001213 cfgerr++;
1214 break;
1215 }
1216
Amaury Denoyelle06269612021-08-23 14:05:07 +02001217 srv->flags |= SRV_F_NON_PURGEABLE;
1218
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001219 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001220 arg->unresolved = 0;
1221 arg->data.srv = srv;
1222 break;
1223
1224 case ARGT_FE:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001225 if (arg->data.str.data) {
1226 pname = arg->data.str.area;
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001227 px = proxy_fe_by_name(pname);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001228 }
1229
1230 if (!px) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001231 memprintf(err, "%sparsing [%s:%d]: unable to find frontend '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1232 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001233 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001234 cfgerr++;
1235 break;
1236 }
1237
1238 if (!(px->cap & PR_CAP_FE)) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001239 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",
1240 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001241 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001242 cfgerr++;
1243 break;
1244 }
1245
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001246 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001247 arg->unresolved = 0;
1248 arg->data.prx = px;
1249 break;
1250
1251 case ARGT_BE:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001252 if (arg->data.str.data) {
1253 pname = arg->data.str.area;
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001254 px = proxy_be_by_name(pname);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001255 }
1256
1257 if (!px) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001258 memprintf(err, "%sparsing [%s:%d]: unable to find backend '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1259 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001260 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001261 cfgerr++;
1262 break;
1263 }
1264
1265 if (!(px->cap & PR_CAP_BE)) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001266 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",
1267 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001268 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001269 cfgerr++;
1270 break;
1271 }
1272
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001273 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001274 arg->unresolved = 0;
1275 arg->data.prx = px;
1276 break;
1277
1278 case ARGT_TAB:
Frédéric Lécaille9417f452019-06-20 09:31:04 +02001279 if (arg->data.str.data)
1280 stktname = arg->data.str.area;
1281 else
1282 stktname = px->id;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001283
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001284 t = stktable_find_by_name(stktname);
1285 if (!t) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001286 memprintf(err, "%sparsing [%s:%d]: unable to find table '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1287 *err ? *err : "", cur->file, cur->line, stktname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001288 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001289 cfgerr++;
1290 break;
1291 }
1292
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001293 if (!t->size) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001294 memprintf(err, "%sparsing [%s:%d]: no table in proxy '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1295 *err ? *err : "", cur->file, cur->line, stktname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001296 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001297 cfgerr++;
1298 break;
1299 }
1300
Frédéric Lécaillebe367932019-08-07 09:28:39 +02001301 if (!in_proxies_list(t->proxies_list, p)) {
Frédéric Lécaille015e4d72019-03-19 14:55:01 +01001302 p->next_stkt_ref = t->proxies_list;
1303 t->proxies_list = p;
1304 }
1305
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001306 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001307 arg->unresolved = 0;
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001308 arg->data.t = t;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001309 break;
1310
1311 case ARGT_USR:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001312 if (!arg->data.str.data) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001313 memprintf(err, "%sparsing [%s:%d]: missing userlist name in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1314 *err ? *err : "", cur->file, cur->line,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001315 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001316 cfgerr++;
1317 break;
1318 }
1319
1320 if (p->uri_auth && p->uri_auth->userlist &&
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001321 strcmp(p->uri_auth->userlist->name, arg->data.str.area) == 0)
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001322 ul = p->uri_auth->userlist;
1323 else
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001324 ul = auth_find_userlist(arg->data.str.area);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001325
1326 if (!ul) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001327 memprintf(err, "%sparsing [%s:%d]: unable to find userlist '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1328 *err ? *err : "", cur->file, cur->line,
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001329 arg->data.str.area,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001330 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001331 cfgerr++;
1332 break;
1333 }
1334
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001335 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001336 arg->unresolved = 0;
1337 arg->data.usr = ul;
1338 break;
Willy Tarreau46947782015-01-19 19:00:58 +01001339
1340 case ARGT_REG:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001341 if (!arg->data.str.data) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001342 memprintf(err, "%sparsing [%s:%d]: missing regex in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1343 *err ? *err : "", cur->file, cur->line,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001344 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreau46947782015-01-19 19:00:58 +01001345 cfgerr++;
1346 continue;
1347 }
1348
Willy Tarreau46947782015-01-19 19:00:58 +01001349 rflags = 0;
1350 rflags |= (arg->type_flags & ARGF_REG_ICASE) ? REG_ICASE : 0;
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001351 err2 = NULL;
Willy Tarreau46947782015-01-19 19:00:58 +01001352
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001353 if (!(reg = regex_comp(arg->data.str.area, !(rflags & REG_ICASE), 1 /* capture substr */, &err2))) {
1354 memprintf(err, "%sparsing [%s:%d]: error in regex '%s' in arg %d of %s%s%s%s '%s' %s proxy '%s' : %s.\n",
1355 *err ? *err : "", cur->file, cur->line,
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001356 arg->data.str.area,
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001357 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id, err2);
Willy Tarreau46947782015-01-19 19:00:58 +01001358 cfgerr++;
1359 continue;
1360 }
1361
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001362 chunk_destroy(&arg->data.str);
Willy Tarreau46947782015-01-19 19:00:58 +01001363 arg->unresolved = 0;
1364 arg->data.reg = reg;
1365 break;
1366
1367
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001368 }
1369
Willy Tarreau2b718102021-04-21 07:32:39 +02001370 LIST_DELETE(&cur->list);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001371 free(cur);
1372 } /* end of args processing */
1373
1374 return cfgerr;
1375}
1376
1377/*
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001378 * Process a fetch + format conversion as defined by the sample expression
1379 * <expr> on request or response considering the <opt> parameter. The output is
Adis Nezirovic79beb242015-07-06 15:41:02 +02001380 * not explicitly set to <smp_type>, but shall be compatible with it as
1381 * specified by 'sample_casts' table. If a stable sample can be fetched, or an
1382 * unstable one when <opt> contains SMP_OPT_FINAL, the sample is converted and
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001383 * returned without the SMP_F_MAY_CHANGE flag. If an unstable sample is found
1384 * and <opt> does not contain SMP_OPT_FINAL, then the sample is returned as-is
1385 * with its SMP_F_MAY_CHANGE flag so that the caller can check it and decide to
1386 * take actions (eg: wait longer). If a sample could not be found or could not
Willy Tarreau6bcb0a82014-07-30 08:56:35 +02001387 * be converted, NULL is returned. The caller MUST NOT use the sample if the
1388 * SMP_F_MAY_CHANGE flag is present, as it is used only as a hint that there is
1389 * still hope to get it after waiting longer, and is not converted to string.
1390 * The possible output combinations are the following :
1391 *
1392 * return MAY_CHANGE FINAL Meaning for the sample
1393 * NULL * * Not present and will never be (eg: header)
1394 * smp 0 * Final value converted (eg: header)
1395 * smp 1 0 Not present yet, may appear later (eg: header)
1396 * smp 1 1 never happens (either flag is cleared on output)
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001397 */
Adis Nezirovic79beb242015-07-06 15:41:02 +02001398struct sample *sample_fetch_as_type(struct proxy *px, struct session *sess,
Willy Tarreau192252e2015-04-04 01:47:55 +02001399 struct stream *strm, unsigned int opt,
Adis Nezirovic79beb242015-07-06 15:41:02 +02001400 struct sample_expr *expr, int smp_type)
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001401{
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001402 struct sample *smp = &temp_smp;
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001403
Willy Tarreau6c616e02014-06-25 16:56:41 +02001404 memset(smp, 0, sizeof(*smp));
1405
Willy Tarreau192252e2015-04-04 01:47:55 +02001406 if (!sample_process(px, sess, strm, opt, expr, smp)) {
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001407 if ((smp->flags & SMP_F_MAY_CHANGE) && !(opt & SMP_OPT_FINAL))
1408 return smp;
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001409 return NULL;
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001410 }
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001411
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001412 if (!sample_casts[smp->data.type][smp_type])
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001413 return NULL;
1414
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001415 if (!sample_casts[smp->data.type][smp_type](smp))
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001416 return NULL;
1417
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001418 smp->flags &= ~SMP_F_MAY_CHANGE;
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001419 return smp;
1420}
1421
Christopher Faulet476e5d02016-10-26 11:34:47 +02001422static void release_sample_arg(struct arg *p)
1423{
1424 struct arg *p_back = p;
1425
1426 if (!p)
1427 return;
1428
1429 while (p->type != ARGT_STOP) {
1430 if (p->type == ARGT_STR || p->unresolved) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001431 chunk_destroy(&p->data.str);
Christopher Faulet476e5d02016-10-26 11:34:47 +02001432 p->unresolved = 0;
1433 }
1434 else if (p->type == ARGT_REG) {
Dragan Dosen26743032019-04-30 15:54:36 +02001435 regex_free(p->data.reg);
1436 p->data.reg = NULL;
Christopher Faulet476e5d02016-10-26 11:34:47 +02001437 }
1438 p++;
1439 }
1440
1441 if (p_back != empty_arg_list)
1442 free(p_back);
1443}
1444
1445void release_sample_expr(struct sample_expr *expr)
1446{
1447 struct sample_conv_expr *conv_expr, *conv_exprb;
1448
1449 if (!expr)
1450 return;
1451
Tim Duesterhus867cd982020-07-04 11:49:39 +02001452 list_for_each_entry_safe(conv_expr, conv_exprb, &expr->conv_exprs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001453 LIST_DELETE(&conv_expr->list);
Christopher Faulet476e5d02016-10-26 11:34:47 +02001454 release_sample_arg(conv_expr->arg_p);
Tim Duesterhus867cd982020-07-04 11:49:39 +02001455 free(conv_expr);
1456 }
1457
Christopher Faulet476e5d02016-10-26 11:34:47 +02001458 release_sample_arg(expr->arg_p);
1459 free(expr);
1460}
1461
Emeric Brun107ca302010-01-04 16:16:05 +01001462/*****************************************************************/
Willy Tarreau12785782012-04-27 21:37:17 +02001463/* Sample format convert functions */
Willy Tarreaub8c8f1f2012-04-23 22:38:26 +02001464/* These functions set the data type on return. */
Emeric Brun107ca302010-01-04 16:16:05 +01001465/*****************************************************************/
1466
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001467static int sample_conv_debug(const struct arg *arg_p, struct sample *smp, void *private)
1468{
1469 int i;
1470 struct sample tmp;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001471 struct buffer *buf;
1472 struct sink *sink;
1473 struct ist line;
1474 char *pfx;
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001475
Willy Tarreau0851fd52019-12-17 10:07:25 +01001476 buf = alloc_trash_chunk();
1477 if (!buf)
1478 goto end;
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001479
Christopher Fauletb45bf8e2020-08-07 14:00:23 +02001480 sink = (struct sink *)arg_p[1].data.ptr;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001481 BUG_ON(!sink);
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001482
Willy Tarreau0851fd52019-12-17 10:07:25 +01001483 pfx = arg_p[0].data.str.area;
1484 BUG_ON(!pfx);
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001485
Willy Tarreau0851fd52019-12-17 10:07:25 +01001486 chunk_printf(buf, "[debug] %s: type=%s ", pfx, smp_to_type[smp->data.type]);
1487 if (!sample_casts[smp->data.type][SMP_T_STR])
1488 goto nocast;
1489
1490 /* Copy sample fetch. This puts the sample as const, the
1491 * cast will copy data if a transformation is required.
1492 */
1493 memcpy(&tmp, smp, sizeof(struct sample));
1494 tmp.flags = SMP_F_CONST;
1495
1496 if (!sample_casts[smp->data.type][SMP_T_STR](&tmp))
1497 goto nocast;
1498
1499 /* Display the displayable chars*. */
1500 b_putchr(buf, '<');
1501 for (i = 0; i < tmp.data.u.str.data; i++) {
Willy Tarreau90807112020-02-25 08:16:33 +01001502 if (isprint((unsigned char)tmp.data.u.str.area[i]))
Willy Tarreau0851fd52019-12-17 10:07:25 +01001503 b_putchr(buf, tmp.data.u.str.area[i]);
1504 else
1505 b_putchr(buf, '.');
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001506 }
Willy Tarreau0851fd52019-12-17 10:07:25 +01001507 b_putchr(buf, '>');
1508
1509 done:
1510 line = ist2(buf->area, buf->data);
Emeric Brun54648852020-07-06 15:54:06 +02001511 sink_write(sink, &line, 1, 0, 0, NULL);
Willy Tarreau0851fd52019-12-17 10:07:25 +01001512 end:
1513 free_trash_chunk(buf);
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001514 return 1;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001515 nocast:
1516 chunk_appendf(buf, "(undisplayable)");
1517 goto done;
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001518}
Willy Tarreau0851fd52019-12-17 10:07:25 +01001519
1520// This function checks the "debug" converter's arguments.
1521static int smp_check_debug(struct arg *args, struct sample_conv *conv,
1522 const char *file, int line, char **err)
1523{
1524 const char *name = "buf0";
1525 struct sink *sink = NULL;
1526
1527 if (args[0].type != ARGT_STR) {
1528 /* optional prefix */
1529 args[0].data.str.area = "";
1530 args[0].data.str.data = 0;
1531 }
1532
1533 if (args[1].type == ARGT_STR)
1534 name = args[1].data.str.area;
1535
1536 sink = sink_find(name);
1537 if (!sink) {
1538 memprintf(err, "No such sink '%s'", name);
1539 return 0;
1540 }
1541
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001542 chunk_destroy(&args[1].data.str);
Christopher Fauletb45bf8e2020-08-07 14:00:23 +02001543 args[1].type = ARGT_PTR;
1544 args[1].data.ptr = sink;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001545 return 1;
1546}
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001547
Holger Just1bfc24b2017-05-06 00:56:53 +02001548static int sample_conv_base642bin(const struct arg *arg_p, struct sample *smp, void *private)
1549{
Willy Tarreau83061a82018-07-13 11:56:34 +02001550 struct buffer *trash = get_trash_chunk();
Holger Just1bfc24b2017-05-06 00:56:53 +02001551 int bin_len;
1552
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001553 trash->data = 0;
1554 bin_len = base64dec(smp->data.u.str.area, smp->data.u.str.data,
1555 trash->area, trash->size);
Holger Just1bfc24b2017-05-06 00:56:53 +02001556 if (bin_len < 0)
1557 return 0;
1558
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001559 trash->data = bin_len;
Holger Just1bfc24b2017-05-06 00:56:53 +02001560 smp->data.u.str = *trash;
1561 smp->data.type = SMP_T_BIN;
1562 smp->flags &= ~SMP_F_CONST;
1563 return 1;
1564}
1565
Moemen MHEDHBI92f7d432021-04-01 20:53:59 +02001566static int sample_conv_base64url2bin(const struct arg *arg_p, struct sample *smp, void *private)
1567{
1568 struct buffer *trash = get_trash_chunk();
1569 int bin_len;
1570
1571 trash->data = 0;
1572 bin_len = base64urldec(smp->data.u.str.area, smp->data.u.str.data,
1573 trash->area, trash->size);
1574 if (bin_len < 0)
1575 return 0;
1576
1577 trash->data = bin_len;
1578 smp->data.u.str = *trash;
1579 smp->data.type = SMP_T_BIN;
1580 smp->flags &= ~SMP_F_CONST;
1581 return 1;
1582}
1583
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02001584static int sample_conv_bin2base64(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun53d1a982014-04-30 18:21:37 +02001585{
Willy Tarreau83061a82018-07-13 11:56:34 +02001586 struct buffer *trash = get_trash_chunk();
Emeric Brun53d1a982014-04-30 18:21:37 +02001587 int b64_len;
1588
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001589 trash->data = 0;
1590 b64_len = a2base64(smp->data.u.str.area, smp->data.u.str.data,
1591 trash->area, trash->size);
Emeric Brun53d1a982014-04-30 18:21:37 +02001592 if (b64_len < 0)
1593 return 0;
1594
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001595 trash->data = b64_len;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02001596 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001597 smp->data.type = SMP_T_STR;
Emeric Brun53d1a982014-04-30 18:21:37 +02001598 smp->flags &= ~SMP_F_CONST;
1599 return 1;
1600}
1601
Moemen MHEDHBI92f7d432021-04-01 20:53:59 +02001602static int sample_conv_bin2base64url(const struct arg *arg_p, struct sample *smp, void *private)
1603{
1604 struct buffer *trash = get_trash_chunk();
1605 int b64_len;
1606
1607 trash->data = 0;
1608 b64_len = a2base64url(smp->data.u.str.area, smp->data.u.str.data,
1609 trash->area, trash->size);
1610 if (b64_len < 0)
1611 return 0;
1612
1613 trash->data = b64_len;
1614 smp->data.u.str = *trash;
1615 smp->data.type = SMP_T_STR;
1616 smp->flags &= ~SMP_F_CONST;
1617 return 1;
1618}
1619
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001620static int sample_conv_sha1(const struct arg *arg_p, struct sample *smp, void *private)
1621{
1622 blk_SHA_CTX ctx;
Willy Tarreau83061a82018-07-13 11:56:34 +02001623 struct buffer *trash = get_trash_chunk();
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001624
1625 memset(&ctx, 0, sizeof(ctx));
1626
1627 blk_SHA1_Init(&ctx);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001628 blk_SHA1_Update(&ctx, smp->data.u.str.area, smp->data.u.str.data);
1629 blk_SHA1_Final((unsigned char *) trash->area, &ctx);
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001630
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001631 trash->data = 20;
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001632 smp->data.u.str = *trash;
1633 smp->data.type = SMP_T_BIN;
1634 smp->flags &= ~SMP_F_CONST;
1635 return 1;
1636}
1637
Tim Duesterhusd4376302019-06-17 12:41:44 +02001638#ifdef USE_OPENSSL
Tim Duesterhuscd373242019-12-17 12:31:20 +01001639static int smp_check_sha2(struct arg *args, struct sample_conv *conv,
1640 const char *file, int line, char **err)
1641{
1642 if (args[0].type == ARGT_STOP)
1643 return 1;
1644 if (args[0].type != ARGT_SINT) {
1645 memprintf(err, "Invalid type '%s'", arg_type_names[args[0].type]);
1646 return 0;
1647 }
1648
1649 switch (args[0].data.sint) {
1650 case 224:
1651 case 256:
1652 case 384:
1653 case 512:
1654 /* this is okay */
1655 return 1;
1656 default:
1657 memprintf(err, "Unsupported number of bits: '%lld'", args[0].data.sint);
1658 return 0;
1659 }
1660}
1661
Tim Duesterhusd4376302019-06-17 12:41:44 +02001662static int sample_conv_sha2(const struct arg *arg_p, struct sample *smp, void *private)
1663{
1664 struct buffer *trash = get_trash_chunk();
1665 int bits = 256;
Christopher Faulete6e7a582021-01-29 11:29:28 +01001666 if (arg_p->data.sint)
Tim Duesterhusd4376302019-06-17 12:41:44 +02001667 bits = arg_p->data.sint;
1668
1669 switch (bits) {
1670 case 224: {
1671 SHA256_CTX ctx;
1672
1673 memset(&ctx, 0, sizeof(ctx));
1674
1675 SHA224_Init(&ctx);
1676 SHA224_Update(&ctx, smp->data.u.str.area, smp->data.u.str.data);
1677 SHA224_Final((unsigned char *) trash->area, &ctx);
1678 trash->data = SHA224_DIGEST_LENGTH;
1679 break;
1680 }
1681 case 256: {
1682 SHA256_CTX ctx;
1683
1684 memset(&ctx, 0, sizeof(ctx));
1685
1686 SHA256_Init(&ctx);
1687 SHA256_Update(&ctx, smp->data.u.str.area, smp->data.u.str.data);
1688 SHA256_Final((unsigned char *) trash->area, &ctx);
1689 trash->data = SHA256_DIGEST_LENGTH;
1690 break;
1691 }
1692 case 384: {
1693 SHA512_CTX ctx;
1694
1695 memset(&ctx, 0, sizeof(ctx));
1696
1697 SHA384_Init(&ctx);
1698 SHA384_Update(&ctx, smp->data.u.str.area, smp->data.u.str.data);
1699 SHA384_Final((unsigned char *) trash->area, &ctx);
1700 trash->data = SHA384_DIGEST_LENGTH;
1701 break;
1702 }
1703 case 512: {
1704 SHA512_CTX ctx;
1705
1706 memset(&ctx, 0, sizeof(ctx));
1707
1708 SHA512_Init(&ctx);
1709 SHA512_Update(&ctx, smp->data.u.str.area, smp->data.u.str.data);
1710 SHA512_Final((unsigned char *) trash->area, &ctx);
1711 trash->data = SHA512_DIGEST_LENGTH;
1712 break;
1713 }
1714 default:
1715 return 0;
1716 }
1717
1718 smp->data.u.str = *trash;
1719 smp->data.type = SMP_T_BIN;
1720 smp->flags &= ~SMP_F_CONST;
1721 return 1;
1722}
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001723
Dragan Dosen9e8db132021-02-22 10:03:53 +01001724/* This function returns a sample struct filled with an <arg> content.
1725 * If the <arg> contains a string, it is returned in the sample flagged as
1726 * SMP_F_CONST. If the <arg> contains a variable descriptor, the sample is
1727 * filled with the content of the variable by using vars_get_by_desc().
1728 *
1729 * Keep in mind that the sample content may be written to a pre-allocated
1730 * trash chunk as returned by get_trash_chunk().
1731 *
1732 * This function returns 0 if an error occurs, otherwise it returns 1.
1733 */
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001734static inline int sample_conv_var2smp_str(const struct arg *arg, struct sample *smp)
1735{
1736 switch (arg->type) {
1737 case ARGT_STR:
1738 smp->data.type = SMP_T_STR;
1739 smp->data.u.str = arg->data.str;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001740 smp->flags = SMP_F_CONST;
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001741 return 1;
1742 case ARGT_VAR:
1743 if (!vars_get_by_desc(&arg->data.var, smp))
1744 return 0;
1745 if (!sample_casts[smp->data.type][SMP_T_STR])
1746 return 0;
1747 if (!sample_casts[smp->data.type][SMP_T_STR](smp))
1748 return 0;
1749 return 1;
1750 default:
1751 return 0;
1752 }
1753}
1754
Dragan Dosen9e8db132021-02-22 10:03:53 +01001755/* This function checks an <arg> and fills it with a variable type if the
1756 * <arg> string contains a valid variable name. If failed, the function
1757 * tries to perform a base64 decode operation on the same string, and
1758 * fills the <arg> with the decoded content.
1759 *
1760 * Validation is skipped if the <arg> string is empty.
1761 *
1762 * This function returns 0 if the variable lookup fails and the specified
1763 * <arg> string is not a valid base64 encoded string, as well if
1764 * unexpected argument type is specified or memory allocation error
1765 * occurs. Otherwise it returns 1.
1766 */
1767static inline int sample_check_arg_base64(struct arg *arg, char **err)
1768{
1769 char *dec = NULL;
1770 int dec_size;
1771
1772 if (arg->type != ARGT_STR) {
1773 memprintf(err, "unexpected argument type");
1774 return 0;
1775 }
1776
1777 if (arg->data.str.data == 0) /* empty */
1778 return 1;
1779
1780 if (vars_check_arg(arg, NULL))
1781 return 1;
1782
1783 if (arg->data.str.data % 4) {
1784 memprintf(err, "argument needs to be base64 encoded, and "
1785 "can either be a string or a variable");
1786 return 0;
1787 }
1788
1789 dec_size = (arg->data.str.data / 4 * 3)
1790 - (arg->data.str.area[arg->data.str.data-1] == '=' ? 1 : 0)
1791 - (arg->data.str.area[arg->data.str.data-2] == '=' ? 1 : 0);
1792
1793 if ((dec = malloc(dec_size)) == NULL) {
1794 memprintf(err, "memory allocation error");
1795 return 0;
1796 }
1797
1798 dec_size = base64dec(arg->data.str.area, arg->data.str.data, dec, dec_size);
1799 if (dec_size < 0) {
1800 memprintf(err, "argument needs to be base64 encoded, and "
1801 "can either be a string or a variable");
1802 free(dec);
1803 return 0;
1804 }
1805
1806 /* base64 decoded */
1807 chunk_destroy(&arg->data.str);
1808 arg->data.str.area = dec;
1809 arg->data.str.data = dec_size;
1810 return 1;
1811}
1812
Ilya Shipitsin2c481d02021-03-26 23:35:31 +05001813#ifdef EVP_CIPH_GCM_MODE
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001814static int check_aes_gcm(struct arg *args, struct sample_conv *conv,
1815 const char *file, int line, char **err)
1816{
1817 switch(args[0].data.sint) {
1818 case 128:
1819 case 192:
1820 case 256:
1821 break;
1822 default:
1823 memprintf(err, "key size must be 128, 192 or 256 (bits).");
1824 return 0;
1825 }
Dragan Dosen9e8db132021-02-22 10:03:53 +01001826
1827 /* Try to decode variables. */
1828 if (!sample_check_arg_base64(&args[1], err)) {
1829 memprintf(err, "failed to parse nonce : %s", *err);
1830 return 0;
1831 }
1832 if (!sample_check_arg_base64(&args[2], err)) {
1833 memprintf(err, "failed to parse key : %s", *err);
1834 return 0;
1835 }
1836 if (!sample_check_arg_base64(&args[3], err)) {
1837 memprintf(err, "failed to parse aead_tag : %s", *err);
1838 return 0;
1839 }
1840
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001841 return 1;
1842}
1843
1844/* Arguments: AES size in bits, nonce, key, tag. The last three arguments are base64 encoded */
1845static int sample_conv_aes_gcm_dec(const struct arg *arg_p, struct sample *smp, void *private)
1846{
1847 struct sample nonce, key, aead_tag;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001848 struct buffer *smp_trash = NULL, *smp_trash_alloc = NULL;
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001849 EVP_CIPHER_CTX *ctx;
1850 int dec_size, ret;
1851
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001852 smp_trash_alloc = alloc_trash_chunk();
1853 if (!smp_trash_alloc)
1854 return 0;
1855
Dragan Dosen9e8db132021-02-22 10:03:53 +01001856 /* smp copy */
1857 smp_trash_alloc->data = smp->data.u.str.data;
1858 if (unlikely(smp_trash_alloc->data > smp_trash_alloc->size))
1859 smp_trash_alloc->data = smp_trash_alloc->size;
1860 memcpy(smp_trash_alloc->area, smp->data.u.str.area, smp_trash_alloc->data);
1861
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001862 ctx = EVP_CIPHER_CTX_new();
1863
1864 if (!ctx)
1865 goto err;
1866
Dragan Dosen9e8db132021-02-22 10:03:53 +01001867 smp_trash = alloc_trash_chunk();
1868 if (!smp_trash)
1869 goto err;
1870
1871 smp_set_owner(&nonce, smp->px, smp->sess, smp->strm, smp->opt);
1872 if (!sample_conv_var2smp_str(&arg_p[1], &nonce))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001873 goto err;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001874
1875 if (arg_p[1].type == ARGT_VAR) {
1876 dec_size = base64dec(nonce.data.u.str.area, nonce.data.u.str.data, smp_trash->area, smp_trash->size);
1877 if (dec_size < 0)
1878 goto err;
1879 smp_trash->data = dec_size;
1880 nonce.data.u.str = *smp_trash;
1881 }
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001882
1883 /* Set cipher type and mode */
1884 switch(arg_p[0].data.sint) {
1885 case 128:
1886 EVP_DecryptInit_ex(ctx, EVP_aes_128_gcm(), NULL, NULL, NULL);
1887 break;
1888 case 192:
1889 EVP_DecryptInit_ex(ctx, EVP_aes_192_gcm(), NULL, NULL, NULL);
1890 break;
1891 case 256:
1892 EVP_DecryptInit_ex(ctx, EVP_aes_256_gcm(), NULL, NULL, NULL);
1893 break;
1894 }
1895
Dragan Dosen9e8db132021-02-22 10:03:53 +01001896 EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, nonce.data.u.str.data, NULL);
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001897
1898 /* Initialise IV */
Dragan Dosen9e8db132021-02-22 10:03:53 +01001899 if(!EVP_DecryptInit_ex(ctx, NULL, NULL, NULL, (unsigned char *) nonce.data.u.str.area))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001900 goto err;
1901
Dragan Dosen9e8db132021-02-22 10:03:53 +01001902 smp_set_owner(&key, smp->px, smp->sess, smp->strm, smp->opt);
1903 if (!sample_conv_var2smp_str(&arg_p[2], &key))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001904 goto err;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001905
1906 if (arg_p[2].type == ARGT_VAR) {
1907 dec_size = base64dec(key.data.u.str.area, key.data.u.str.data, smp_trash->area, smp_trash->size);
1908 if (dec_size < 0)
1909 goto err;
1910 smp_trash->data = dec_size;
1911 key.data.u.str = *smp_trash;
1912 }
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001913
1914 /* Initialise key */
Dragan Dosen9e8db132021-02-22 10:03:53 +01001915 if (!EVP_DecryptInit_ex(ctx, NULL, NULL, (unsigned char *) key.data.u.str.area, NULL))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001916 goto err;
1917
1918 if (!EVP_DecryptUpdate(ctx, (unsigned char *) smp_trash->area, (int *) &smp_trash->data,
Dragan Dosen9e8db132021-02-22 10:03:53 +01001919 (unsigned char *) smp_trash_alloc->area, (int) smp_trash_alloc->data))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001920 goto err;
1921
Dragan Dosen9e8db132021-02-22 10:03:53 +01001922 smp_set_owner(&aead_tag, smp->px, smp->sess, smp->strm, smp->opt);
1923 if (!sample_conv_var2smp_str(&arg_p[3], &aead_tag))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001924 goto err;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001925
1926 if (arg_p[3].type == ARGT_VAR) {
1927 dec_size = base64dec(aead_tag.data.u.str.area, aead_tag.data.u.str.data, smp_trash_alloc->area, smp_trash_alloc->size);
1928 if (dec_size < 0)
1929 goto err;
1930 smp_trash_alloc->data = dec_size;
1931 aead_tag.data.u.str = *smp_trash_alloc;
1932 }
1933
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001934 dec_size = smp_trash->data;
1935
Dragan Dosen9e8db132021-02-22 10:03:53 +01001936 EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, aead_tag.data.u.str.data, (void *) aead_tag.data.u.str.area);
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001937 ret = EVP_DecryptFinal_ex(ctx, (unsigned char *) smp_trash->area + smp_trash->data, (int *) &smp_trash->data);
1938
1939 if (ret <= 0)
1940 goto err;
1941
1942 smp->data.u.str.data = dec_size + smp_trash->data;
1943 smp->data.u.str.area = smp_trash->area;
1944 smp->data.type = SMP_T_BIN;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001945 smp_dup(smp);
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001946 free_trash_chunk(smp_trash_alloc);
Dragan Dosen9e8db132021-02-22 10:03:53 +01001947 free_trash_chunk(smp_trash);
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001948 return 1;
1949
1950err:
1951 free_trash_chunk(smp_trash_alloc);
Dragan Dosen9e8db132021-02-22 10:03:53 +01001952 free_trash_chunk(smp_trash);
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001953 return 0;
1954}
Ilya Shipitsin2c481d02021-03-26 23:35:31 +05001955#endif
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001956
Patrick Gansterer8e366512020-04-22 16:47:57 +02001957static int check_crypto_digest(struct arg *args, struct sample_conv *conv,
1958 const char *file, int line, char **err)
1959{
1960 const EVP_MD *evp = EVP_get_digestbyname(args[0].data.str.area);
1961
1962 if (evp)
1963 return 1;
1964
1965 memprintf(err, "algorithm must be a valid OpenSSL message digest name.");
1966 return 0;
1967}
1968
1969static int sample_conv_crypto_digest(const struct arg *args, struct sample *smp, void *private)
1970{
1971 struct buffer *trash = get_trash_chunk();
1972 unsigned char *md = (unsigned char*) trash->area;
1973 unsigned int md_len = trash->size;
1974 EVP_MD_CTX *ctx = EVP_MD_CTX_new();
1975 const EVP_MD *evp = EVP_get_digestbyname(args[0].data.str.area);
1976
1977 if (!ctx)
1978 return 0;
1979
1980 if (!EVP_DigestInit_ex(ctx, evp, NULL) ||
1981 !EVP_DigestUpdate(ctx, smp->data.u.str.area, smp->data.u.str.data) ||
1982 !EVP_DigestFinal_ex(ctx, md, &md_len)) {
1983 EVP_MD_CTX_free(ctx);
1984 return 0;
1985 }
1986
1987 EVP_MD_CTX_free(ctx);
1988
1989 trash->data = md_len;
1990 smp->data.u.str = *trash;
1991 smp->data.type = SMP_T_BIN;
1992 smp->flags &= ~SMP_F_CONST;
1993 return 1;
1994}
1995
1996static int check_crypto_hmac(struct arg *args, struct sample_conv *conv,
1997 const char *file, int line, char **err)
1998{
1999 if (!check_crypto_digest(args, conv, file, line, err))
2000 return 0;
Dragan Dosen9e8db132021-02-22 10:03:53 +01002001
2002 if (!sample_check_arg_base64(&args[1], err)) {
2003 memprintf(err, "failed to parse key : %s", *err);
2004 return 0;
2005 }
Patrick Gansterer8e366512020-04-22 16:47:57 +02002006
Patrick Gansterer8e366512020-04-22 16:47:57 +02002007 return 1;
2008}
2009
2010static int sample_conv_crypto_hmac(const struct arg *args, struct sample *smp, void *private)
2011{
2012 struct sample key;
Dragan Dosen9e8db132021-02-22 10:03:53 +01002013 struct buffer *trash = NULL, *key_trash = NULL;
Patrick Gansterer8e366512020-04-22 16:47:57 +02002014 unsigned char *md;
2015 unsigned int md_len;
2016 const EVP_MD *evp = EVP_get_digestbyname(args[0].data.str.area);
2017 int dec_size;
2018
2019 smp_set_owner(&key, smp->px, smp->sess, smp->strm, smp->opt);
2020 if (!sample_conv_var2smp_str(&args[1], &key))
2021 return 0;
2022
Dragan Dosen9e8db132021-02-22 10:03:53 +01002023 if (args[1].type == ARGT_VAR) {
2024 key_trash = alloc_trash_chunk();
2025 if (!key_trash)
2026 goto err;
2027
2028 dec_size = base64dec(key.data.u.str.area, key.data.u.str.data, key_trash->area, key_trash->size);
2029 if (dec_size < 0)
2030 goto err;
2031 key_trash->data = dec_size;
2032 key.data.u.str = *key_trash;
2033 }
Patrick Gansterer8e366512020-04-22 16:47:57 +02002034
Dragan Dosen9e8db132021-02-22 10:03:53 +01002035 trash = alloc_trash_chunk();
2036 if (!trash)
Patrick Gansterer8e366512020-04-22 16:47:57 +02002037 goto err;
2038
2039 md = (unsigned char*) trash->area;
2040 md_len = trash->size;
Dragan Dosen9e8db132021-02-22 10:03:53 +01002041 if (!HMAC(evp, key.data.u.str.area, key.data.u.str.data, (const unsigned char*) smp->data.u.str.area,
2042 smp->data.u.str.data, md, &md_len))
Patrick Gansterer8e366512020-04-22 16:47:57 +02002043 goto err;
2044
2045 free_trash_chunk(key_trash);
2046
2047 trash->data = md_len;
2048 smp->data.u.str = *trash;
2049 smp->data.type = SMP_T_BIN;
Dragan Dosen9e8db132021-02-22 10:03:53 +01002050 smp_dup(smp);
2051 free_trash_chunk(trash);
Patrick Gansterer8e366512020-04-22 16:47:57 +02002052 return 1;
2053
2054err:
2055 free_trash_chunk(key_trash);
Dragan Dosen9e8db132021-02-22 10:03:53 +01002056 free_trash_chunk(trash);
Patrick Gansterer8e366512020-04-22 16:47:57 +02002057 return 0;
2058}
2059
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02002060#endif /* USE_OPENSSL */
Tim Duesterhusd4376302019-06-17 12:41:44 +02002061
Marcin Deranek40ca09c2021-07-13 14:05:24 +02002062static int sample_conv_be2dec_check(struct arg *args, struct sample_conv *conv,
2063 const char *file, int line, char **err)
2064{
2065 if (args[1].data.sint <= 0 || args[1].data.sint > sizeof(unsigned long long)) {
2066 memprintf(err, "chunk_size out of [1..%ld] range (%lld)", sizeof(unsigned long long), args[1].data.sint);
2067 return 0;
2068 }
2069
2070 if (args[2].data.sint != 0 && args[2].data.sint != 1) {
2071 memprintf(err, "Unsupported truncate value (%lld)", args[2].data.sint);
2072 return 0;
2073 }
2074
2075 return 1;
2076}
2077
2078/* Converts big-endian binary input sample to a string containing an unsigned
2079 * integer number per <chunk_size> input bytes separated with <separator>.
2080 * Optional <truncate> flag indicates if input is truncated at <chunk_size>
2081 * boundaries.
2082 * Arguments: separator (string), chunk_size (integer), truncate (0,1)
2083 */
2084static int sample_conv_be2dec(const struct arg *args, struct sample *smp, void *private)
2085{
2086 struct buffer *trash = get_trash_chunk();
2087 const int last = args[2].data.sint ? smp->data.u.str.data - args[1].data.sint + 1 : smp->data.u.str.data;
2088 int max_size = trash->size - 2;
2089 int i;
2090 int start;
2091 int ptr = 0;
2092 unsigned long long number;
2093 char *pos;
2094
2095 trash->data = 0;
2096
2097 while (ptr < last && trash->data <= max_size) {
2098 start = trash->data;
2099 if (ptr) {
2100 /* Add separator */
2101 memcpy(trash->area + trash->data, args[0].data.str.area, args[0].data.str.data);
2102 trash->data += args[0].data.str.data;
2103 }
2104 else
2105 max_size -= args[0].data.str.data;
2106
2107 /* Add integer */
2108 for (number = 0, i = 0; i < args[1].data.sint && ptr < smp->data.u.str.data; i++)
2109 number = (number << 8) + (unsigned char)smp->data.u.str.area[ptr++];
2110
2111 pos = ulltoa(number, trash->area + trash->data, trash->size - trash->data);
2112 if (pos)
2113 trash->data = pos - trash->area;
2114 else {
2115 trash->data = start;
2116 break;
2117 }
2118 }
2119
2120 smp->data.u.str = *trash;
2121 smp->data.type = SMP_T_STR;
2122 smp->flags &= ~SMP_F_CONST;
2123 return 1;
2124}
2125
Marcin Deranekda0264a2021-07-13 14:08:56 +02002126static int sample_conv_be2hex_check(struct arg *args, struct sample_conv *conv,
2127 const char *file, int line, char **err)
2128{
2129 if (args[1].data.sint <= 0 && (args[0].data.str.data > 0 || args[2].data.sint != 0)) {
2130 memprintf(err, "chunk_size needs to be positive (%lld)", args[1].data.sint);
2131 return 0;
2132 }
2133
2134 if (args[2].data.sint != 0 && args[2].data.sint != 1) {
2135 memprintf(err, "Unsupported truncate value (%lld)", args[2].data.sint);
2136 return 0;
2137 }
2138
2139 return 1;
2140}
2141
2142/* Converts big-endian binary input sample to a hex string containing two hex
2143 * digits per input byte. <separator> is put every <chunk_size> binary input
2144 * bytes if specified. Optional <truncate> flag indicates if input is truncated
2145 * at <chunk_size> boundaries.
2146 * Arguments: separator (string), chunk_size (integer), truncate (0,1)
2147 */
2148static int sample_conv_be2hex(const struct arg *args, struct sample *smp, void *private)
2149{
2150 struct buffer *trash = get_trash_chunk();
2151 int chunk_size = args[1].data.sint;
2152 const int last = args[2].data.sint ? smp->data.u.str.data - chunk_size + 1 : smp->data.u.str.data;
2153 int i;
2154 int max_size;
2155 int ptr = 0;
2156 unsigned char c;
2157
2158 trash->data = 0;
2159 if (args[0].data.str.data == 0 && args[2].data.sint == 0)
2160 chunk_size = smp->data.u.str.data;
2161 max_size = trash->size - 2 * chunk_size;
2162
2163 while (ptr < last && trash->data <= max_size) {
2164 if (ptr) {
2165 /* Add separator */
2166 memcpy(trash->area + trash->data, args[0].data.str.area, args[0].data.str.data);
2167 trash->data += args[0].data.str.data;
2168 }
2169 else
2170 max_size -= args[0].data.str.data;
2171
2172 /* Add hex */
2173 for (i = 0; i < chunk_size && ptr < smp->data.u.str.data; i++) {
2174 c = smp->data.u.str.area[ptr++];
2175 trash->area[trash->data++] = hextab[(c >> 4) & 0xF];
2176 trash->area[trash->data++] = hextab[c & 0xF];
2177 }
2178 }
2179
2180 smp->data.u.str = *trash;
2181 smp->data.type = SMP_T_STR;
2182 smp->flags &= ~SMP_F_CONST;
2183 return 1;
2184}
2185
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002186static int sample_conv_bin2hex(const struct arg *arg_p, struct sample *smp, void *private)
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01002187{
Willy Tarreau83061a82018-07-13 11:56:34 +02002188 struct buffer *trash = get_trash_chunk();
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01002189 unsigned char c;
2190 int ptr = 0;
2191
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002192 trash->data = 0;
2193 while (ptr < smp->data.u.str.data && trash->data <= trash->size - 2) {
2194 c = smp->data.u.str.area[ptr++];
2195 trash->area[trash->data++] = hextab[(c >> 4) & 0xF];
2196 trash->area[trash->data++] = hextab[c & 0xF];
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01002197 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002198 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002199 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +01002200 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01002201 return 1;
2202}
2203
Dragan Dosen3f957b22017-10-24 09:27:34 +02002204static int sample_conv_hex2int(const struct arg *arg_p, struct sample *smp, void *private)
2205{
2206 long long int n = 0;
2207 int i, c;
2208
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002209 for (i = 0; i < smp->data.u.str.data; i++) {
2210 if ((c = hex2i(smp->data.u.str.area[i])) < 0)
Dragan Dosen3f957b22017-10-24 09:27:34 +02002211 return 0;
2212 n = (n << 4) + c;
2213 }
2214
2215 smp->data.u.sint = n;
2216 smp->data.type = SMP_T_SINT;
2217 smp->flags &= ~SMP_F_CONST;
2218 return 1;
2219}
2220
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002221/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002222static int sample_conv_djb2(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002223{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002224 smp->data.u.sint = hash_djb2(smp->data.u.str.area,
2225 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002226 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002227 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002228 smp->data.type = SMP_T_SINT;
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002229 return 1;
2230}
2231
Willy Tarreau60a2ee72017-12-15 07:13:48 +01002232static int sample_conv_length(const struct arg *arg_p, struct sample *smp, void *private)
Etienne Carriereed0d24e2017-12-13 13:41:34 +01002233{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002234 int i = smp->data.u.str.data;
Etienne Carriereed0d24e2017-12-13 13:41:34 +01002235 smp->data.u.sint = i;
2236 smp->data.type = SMP_T_SINT;
2237 return 1;
2238}
2239
2240
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002241static int sample_conv_str2lower(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun107ca302010-01-04 16:16:05 +01002242{
2243 int i;
2244
Willy Tarreauf0645dc2016-08-09 14:29:38 +02002245 if (!smp_make_rw(smp))
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +01002246 return 0;
2247
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002248 for (i = 0; i < smp->data.u.str.data; i++) {
2249 if ((smp->data.u.str.area[i] >= 'A') && (smp->data.u.str.area[i] <= 'Z'))
2250 smp->data.u.str.area[i] += 'a' - 'A';
Emeric Brun107ca302010-01-04 16:16:05 +01002251 }
2252 return 1;
2253}
2254
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002255static int sample_conv_str2upper(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun107ca302010-01-04 16:16:05 +01002256{
2257 int i;
2258
Willy Tarreauf0645dc2016-08-09 14:29:38 +02002259 if (!smp_make_rw(smp))
Emeric Brun485479d2010-09-23 18:02:19 +02002260 return 0;
2261
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002262 for (i = 0; i < smp->data.u.str.data; i++) {
2263 if ((smp->data.u.str.area[i] >= 'a') && (smp->data.u.str.area[i] <= 'z'))
2264 smp->data.u.str.area[i] += 'A' - 'a';
Emeric Brun107ca302010-01-04 16:16:05 +01002265 }
2266 return 1;
2267}
2268
Tim Duesterhus1478aa72018-01-25 16:24:51 +01002269/* takes the IPv4 mask in args[0] and an optional IPv6 mask in args[1] */
2270static int sample_conv_ipmask(const struct arg *args, struct sample *smp, void *private)
Willy Tarreaud31d6eb2010-01-26 18:01:41 +01002271{
Tim Duesterhus1478aa72018-01-25 16:24:51 +01002272 /* Attempt to convert to IPv4 to apply the correct mask. */
2273 c_ipv62ip(smp);
2274
2275 if (smp->data.type == SMP_T_IPV4) {
2276 smp->data.u.ipv4.s_addr &= args[0].data.ipv4.s_addr;
2277 smp->data.type = SMP_T_IPV4;
2278 }
2279 else if (smp->data.type == SMP_T_IPV6) {
2280 /* IPv6 cannot be converted without an IPv6 mask. */
2281 if (args[1].type != ARGT_IPV6)
2282 return 0;
2283
Willy Tarreaua8b7ecd2020-02-25 09:43:22 +01002284 write_u64(&smp->data.u.ipv6.s6_addr[0],
2285 read_u64(&smp->data.u.ipv6.s6_addr[0]) & read_u64(&args[1].data.ipv6.s6_addr[0]));
2286 write_u64(&smp->data.u.ipv6.s6_addr[8],
2287 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 +01002288 smp->data.type = SMP_T_IPV6;
2289 }
2290
Willy Tarreaud31d6eb2010-01-26 18:01:41 +01002291 return 1;
2292}
2293
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002294/* takes an UINT value on input supposed to represent the time since EPOCH,
2295 * adds an optional offset found in args[1] and emits a string representing
2296 * the local time in the format specified in args[1] using strftime().
2297 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002298static int sample_conv_ltime(const struct arg *args, struct sample *smp, void *private)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002299{
Willy Tarreau83061a82018-07-13 11:56:34 +02002300 struct buffer *temp;
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002301 /* With high numbers, the date returned can be negative, the 55 bits mask prevent this. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002302 time_t curr_date = smp->data.u.sint & 0x007fffffffffffffLL;
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002303 struct tm tm;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002304
2305 /* add offset */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002306 if (args[1].type == ARGT_SINT)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002307 curr_date += args[1].data.sint;
2308
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002309 get_localtime(curr_date, &tm);
2310
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002311 temp = get_trash_chunk();
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002312 temp->data = strftime(temp->area, temp->size, args[0].data.str.area, &tm);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002313 smp->data.u.str = *temp;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002314 smp->data.type = SMP_T_STR;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002315 return 1;
2316}
2317
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002318/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002319static int sample_conv_sdbm(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002320{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002321 smp->data.u.sint = hash_sdbm(smp->data.u.str.area,
2322 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002323 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002324 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002325 smp->data.type = SMP_T_SINT;
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002326 return 1;
2327}
2328
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002329/* takes an UINT value on input supposed to represent the time since EPOCH,
2330 * adds an optional offset found in args[1] and emits a string representing
2331 * the UTC date in the format specified in args[1] using strftime().
2332 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002333static int sample_conv_utime(const struct arg *args, struct sample *smp, void *private)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002334{
Willy Tarreau83061a82018-07-13 11:56:34 +02002335 struct buffer *temp;
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002336 /* With high numbers, the date returned can be negative, the 55 bits mask prevent this. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002337 time_t curr_date = smp->data.u.sint & 0x007fffffffffffffLL;
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002338 struct tm tm;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002339
2340 /* add offset */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002341 if (args[1].type == ARGT_SINT)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002342 curr_date += args[1].data.sint;
2343
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002344 get_gmtime(curr_date, &tm);
2345
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002346 temp = get_trash_chunk();
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002347 temp->data = strftime(temp->area, temp->size, args[0].data.str.area, &tm);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002348 smp->data.u.str = *temp;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002349 smp->data.type = SMP_T_STR;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002350 return 1;
2351}
2352
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002353/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002354static int sample_conv_wt6(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002355{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002356 smp->data.u.sint = hash_wt6(smp->data.u.str.area,
2357 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002358 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002359 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002360 smp->data.type = SMP_T_SINT;
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002361 return 1;
2362}
2363
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002364/* hashes the binary input into a 32-bit unsigned int using xxh.
2365 * The seed of the hash defaults to 0 but can be changd in argument 1.
2366 */
2367static int sample_conv_xxh32(const struct arg *arg_p, struct sample *smp, void *private)
2368{
2369 unsigned int seed;
2370
Christopher Faulete6e7a582021-01-29 11:29:28 +01002371 if (arg_p->data.sint)
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002372 seed = arg_p->data.sint;
2373 else
2374 seed = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002375 smp->data.u.sint = XXH32(smp->data.u.str.area, smp->data.u.str.data,
2376 seed);
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002377 smp->data.type = SMP_T_SINT;
2378 return 1;
2379}
2380
2381/* hashes the binary input into a 64-bit unsigned int using xxh.
2382 * In fact, the function returns a 64 bit unsigned, but the sample
2383 * storage of haproxy only proposes 64-bits signed, so the value is
2384 * cast as signed. This cast doesn't impact the hash repartition.
2385 * The seed of the hash defaults to 0 but can be changd in argument 1.
2386 */
2387static int sample_conv_xxh64(const struct arg *arg_p, struct sample *smp, void *private)
2388{
2389 unsigned long long int seed;
2390
Christopher Faulete6e7a582021-01-29 11:29:28 +01002391 if (arg_p->data.sint)
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002392 seed = (unsigned long long int)arg_p->data.sint;
2393 else
2394 seed = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002395 smp->data.u.sint = (long long int)XXH64(smp->data.u.str.area,
2396 smp->data.u.str.data, seed);
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002397 smp->data.type = SMP_T_SINT;
2398 return 1;
2399}
2400
Dragan Dosen04bf0cc2020-12-22 21:44:33 +01002401static int sample_conv_xxh3(const struct arg *arg_p, struct sample *smp, void *private)
2402{
2403 unsigned long long int seed;
2404
Christopher Faulete6e7a582021-01-29 11:29:28 +01002405 if (arg_p->data.sint)
Dragan Dosen04bf0cc2020-12-22 21:44:33 +01002406 seed = (unsigned long long int)arg_p->data.sint;
2407 else
2408 seed = 0;
2409 smp->data.u.sint = (long long int)XXH3(smp->data.u.str.area,
2410 smp->data.u.str.data, seed);
2411 smp->data.type = SMP_T_SINT;
2412 return 1;
2413}
2414
Willy Tarreau80599772015-01-20 19:35:24 +01002415/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002416static int sample_conv_crc32(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau80599772015-01-20 19:35:24 +01002417{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002418 smp->data.u.sint = hash_crc32(smp->data.u.str.area,
2419 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002420 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002421 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002422 smp->data.type = SMP_T_SINT;
Willy Tarreau80599772015-01-20 19:35:24 +01002423 return 1;
2424}
2425
Emmanuel Hocdet50791a72018-03-21 11:19:01 +01002426/* hashes the binary input into crc32c (RFC4960, Appendix B [8].) */
2427static int sample_conv_crc32c(const struct arg *arg_p, struct sample *smp, void *private)
2428{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002429 smp->data.u.sint = hash_crc32c(smp->data.u.str.area,
2430 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002431 if (arg_p->data.sint)
Emmanuel Hocdet50791a72018-03-21 11:19:01 +01002432 smp->data.u.sint = full_hash(smp->data.u.sint);
2433 smp->data.type = SMP_T_SINT;
2434 return 1;
2435}
2436
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002437/* This function escape special json characters. The returned string can be
2438 * safely set between two '"' and used as json string. The json string is
2439 * defined like this:
2440 *
2441 * any Unicode character except '"' or '\' or control character
2442 * \", \\, \/, \b, \f, \n, \r, \t, \u + four-hex-digits
2443 *
2444 * The enum input_type contain all the allowed mode for decoding the input
2445 * string.
2446 */
2447enum input_type {
2448 IT_ASCII = 0,
2449 IT_UTF8,
2450 IT_UTF8S,
2451 IT_UTF8P,
2452 IT_UTF8PS,
2453};
William Dauchy5417e892021-01-08 21:57:41 +01002454
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002455static int sample_conv_json_check(struct arg *arg, struct sample_conv *conv,
2456 const char *file, int line, char **err)
2457{
Christopher Faulet95917132020-08-05 23:07:07 +02002458 enum input_type type;
2459
Christopher Faulet95917132020-08-05 23:07:07 +02002460 if (strcmp(arg->data.str.area, "") == 0)
2461 type = IT_ASCII;
2462 else if (strcmp(arg->data.str.area, "ascii") == 0)
2463 type = IT_ASCII;
2464 else if (strcmp(arg->data.str.area, "utf8") == 0)
2465 type = IT_UTF8;
2466 else if (strcmp(arg->data.str.area, "utf8s") == 0)
2467 type = IT_UTF8S;
2468 else if (strcmp(arg->data.str.area, "utf8p") == 0)
2469 type = IT_UTF8P;
2470 else if (strcmp(arg->data.str.area, "utf8ps") == 0)
2471 type = IT_UTF8PS;
2472 else {
2473 memprintf(err, "Unexpected input code type. "
2474 "Allowed value are 'ascii', 'utf8', 'utf8s', 'utf8p' and 'utf8ps'");
2475 return 0;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002476 }
2477
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002478 chunk_destroy(&arg->data.str);
Christopher Faulet95917132020-08-05 23:07:07 +02002479 arg->type = ARGT_SINT;
2480 arg->data.sint = type;
2481 return 1;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002482}
2483
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002484static int sample_conv_json(const struct arg *arg_p, struct sample *smp, void *private)
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002485{
Willy Tarreau83061a82018-07-13 11:56:34 +02002486 struct buffer *temp;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002487 char _str[7]; /* \u + 4 hex digit + null char for sprintf. */
2488 const char *str;
2489 int len;
2490 enum input_type input_type = IT_ASCII;
2491 unsigned int c;
2492 unsigned int ret;
2493 char *p;
2494
Christopher Faulete6e7a582021-01-29 11:29:28 +01002495 input_type = arg_p->data.sint;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002496
2497 temp = get_trash_chunk();
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002498 temp->data = 0;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002499
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002500 p = smp->data.u.str.area;
2501 while (p < smp->data.u.str.area + smp->data.u.str.data) {
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002502
2503 if (input_type == IT_ASCII) {
2504 /* Read input as ASCII. */
2505 c = *(unsigned char *)p;
2506 p++;
2507 }
2508 else {
2509 /* Read input as UTF8. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002510 ret = utf8_next(p,
2511 smp->data.u.str.data - ( p - smp->data.u.str.area),
2512 &c);
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002513 p += utf8_return_length(ret);
2514
2515 if (input_type == IT_UTF8 && utf8_return_code(ret) != UTF8_CODE_OK)
2516 return 0;
2517 if (input_type == IT_UTF8S && utf8_return_code(ret) != UTF8_CODE_OK)
2518 continue;
2519 if (input_type == IT_UTF8P && utf8_return_code(ret) & (UTF8_CODE_INVRANGE|UTF8_CODE_BADSEQ))
2520 return 0;
2521 if (input_type == IT_UTF8PS && utf8_return_code(ret) & (UTF8_CODE_INVRANGE|UTF8_CODE_BADSEQ))
2522 continue;
2523
2524 /* Check too big values. */
2525 if ((unsigned int)c > 0xffff) {
2526 if (input_type == IT_UTF8 || input_type == IT_UTF8P)
2527 return 0;
2528 continue;
2529 }
2530 }
2531
2532 /* Convert character. */
2533 if (c == '"') {
2534 len = 2;
2535 str = "\\\"";
2536 }
2537 else if (c == '\\') {
2538 len = 2;
2539 str = "\\\\";
2540 }
2541 else if (c == '/') {
2542 len = 2;
2543 str = "\\/";
2544 }
2545 else if (c == '\b') {
2546 len = 2;
2547 str = "\\b";
2548 }
2549 else if (c == '\f') {
2550 len = 2;
2551 str = "\\f";
2552 }
2553 else if (c == '\r') {
2554 len = 2;
2555 str = "\\r";
2556 }
2557 else if (c == '\n') {
2558 len = 2;
2559 str = "\\n";
2560 }
2561 else if (c == '\t') {
2562 len = 2;
2563 str = "\\t";
2564 }
Willy Tarreau90807112020-02-25 08:16:33 +01002565 else if (c > 0xff || !isprint((unsigned char)c)) {
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002566 /* isprint generate a segfault if c is too big. The man says that
2567 * c must have the value of an unsigned char or EOF.
2568 */
2569 len = 6;
2570 _str[0] = '\\';
2571 _str[1] = 'u';
2572 snprintf(&_str[2], 5, "%04x", (unsigned short)c);
2573 str = _str;
2574 }
2575 else {
2576 len = 1;
Willy Tarreau5715da22020-02-25 08:37:37 +01002577 _str[0] = c;
2578 str = _str;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002579 }
2580
2581 /* Check length */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002582 if (temp->data + len > temp->size)
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002583 return 0;
2584
2585 /* Copy string. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002586 memcpy(temp->area + temp->data, str, len);
2587 temp->data += len;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002588 }
2589
2590 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002591 smp->data.u.str = *temp;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002592 smp->data.type = SMP_T_STR;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002593
2594 return 1;
2595}
2596
Emeric Brun54c4ac82014-11-03 15:32:43 +01002597/* This sample function is designed to extract some bytes from an input buffer.
2598 * First arg is the offset.
2599 * Optional second arg is the length to truncate */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002600static int sample_conv_bytes(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun54c4ac82014-11-03 15:32:43 +01002601{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002602 if (smp->data.u.str.data <= arg_p[0].data.sint) {
2603 smp->data.u.str.data = 0;
Emeric Brun54c4ac82014-11-03 15:32:43 +01002604 return 1;
2605 }
2606
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002607 if (smp->data.u.str.size)
2608 smp->data.u.str.size -= arg_p[0].data.sint;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002609 smp->data.u.str.data -= arg_p[0].data.sint;
2610 smp->data.u.str.area += arg_p[0].data.sint;
Emeric Brun54c4ac82014-11-03 15:32:43 +01002611
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002612 if ((arg_p[1].type == ARGT_SINT) && (arg_p[1].data.sint < smp->data.u.str.data))
2613 smp->data.u.str.data = arg_p[1].data.sint;
Emeric Brun54c4ac82014-11-03 15:32:43 +01002614
2615 return 1;
2616}
2617
Emeric Brunf399b0d2014-11-03 17:07:03 +01002618static int sample_conv_field_check(struct arg *args, struct sample_conv *conv,
2619 const char *file, int line, char **err)
2620{
2621 struct arg *arg = args;
2622
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002623 if (arg->type != ARGT_SINT) {
Emeric Brunf399b0d2014-11-03 17:07:03 +01002624 memprintf(err, "Unexpected arg type");
2625 return 0;
2626 }
2627
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002628 if (!arg->data.sint) {
Emeric Brunf399b0d2014-11-03 17:07:03 +01002629 memprintf(err, "Unexpected value 0 for index");
2630 return 0;
2631 }
2632
2633 arg++;
2634
2635 if (arg->type != ARGT_STR) {
2636 memprintf(err, "Unexpected arg type");
2637 return 0;
2638 }
2639
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002640 if (!arg->data.str.data) {
Emeric Brunf399b0d2014-11-03 17:07:03 +01002641 memprintf(err, "Empty separators list");
2642 return 0;
2643 }
2644
2645 return 1;
2646}
2647
2648/* This sample function is designed to a return selected part of a string (field).
2649 * First arg is the index of the field (start at 1)
2650 * Second arg is a char list of separators (type string)
2651 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002652static int sample_conv_field(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brunf399b0d2014-11-03 17:07:03 +01002653{
Marcin Deranek9631a282018-04-16 14:30:46 +02002654 int field;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002655 char *start, *end;
2656 int i;
Marcin Deranek9631a282018-04-16 14:30:46 +02002657 int count = (arg_p[2].type == ARGT_SINT) ? arg_p[2].data.sint : 1;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002658
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002659 if (!arg_p[0].data.sint)
Emeric Brunf399b0d2014-11-03 17:07:03 +01002660 return 0;
2661
Marcin Deranek9631a282018-04-16 14:30:46 +02002662 if (arg_p[0].data.sint < 0) {
2663 field = -1;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002664 end = start = smp->data.u.str.area + smp->data.u.str.data;
2665 while (start > smp->data.u.str.area) {
2666 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2667 if (*(start-1) == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002668 if (field == arg_p[0].data.sint) {
2669 if (count == 1)
2670 goto found;
2671 else if (count > 1)
2672 count--;
2673 } else {
2674 end = start-1;
2675 field--;
2676 }
2677 break;
2678 }
Emeric Brunf399b0d2014-11-03 17:07:03 +01002679 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002680 start--;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002681 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002682 } else {
2683 field = 1;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002684 end = start = smp->data.u.str.area;
2685 while (end - smp->data.u.str.area < smp->data.u.str.data) {
2686 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2687 if (*end == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002688 if (field == arg_p[0].data.sint) {
2689 if (count == 1)
2690 goto found;
2691 else if (count > 1)
2692 count--;
2693 } else {
2694 start = end+1;
2695 field++;
2696 }
2697 break;
2698 }
2699 }
2700 end++;
2701 }
Emeric Brunf399b0d2014-11-03 17:07:03 +01002702 }
2703
2704 /* Field not found */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002705 if (field != arg_p[0].data.sint) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002706 smp->data.u.str.data = 0;
Tim Duesterhus4381d262019-10-16 15:11:15 +02002707 return 0;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002708 }
2709found:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002710 smp->data.u.str.data = end - start;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002711 /* If ret string is len 0, no need to
2712 change pointers or to update size */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002713 if (!smp->data.u.str.data)
Emeric Brunf399b0d2014-11-03 17:07:03 +01002714 return 1;
2715
Emeric Brunf399b0d2014-11-03 17:07:03 +01002716 /* Compute remaining size if needed
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002717 Note: smp->data.u.str.size cannot be set to 0 */
2718 if (smp->data.u.str.size)
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002719 smp->data.u.str.size -= start - smp->data.u.str.area;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002720
Thayne McCombsb2843052021-04-11 23:26:59 -06002721 smp->data.u.str.area = start;
2722
Emeric Brunf399b0d2014-11-03 17:07:03 +01002723 return 1;
2724}
2725
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002726/* This sample function is designed to return a word from a string.
2727 * First arg is the index of the word (start at 1)
2728 * Second arg is a char list of words separators (type string)
2729 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002730static int sample_conv_word(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002731{
Marcin Deranek9631a282018-04-16 14:30:46 +02002732 int word;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002733 char *start, *end;
2734 int i, issep, inword;
Marcin Deranek9631a282018-04-16 14:30:46 +02002735 int count = (arg_p[2].type == ARGT_SINT) ? arg_p[2].data.sint : 1;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002736
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002737 if (!arg_p[0].data.sint)
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002738 return 0;
2739
2740 word = 0;
2741 inword = 0;
Marcin Deranek9631a282018-04-16 14:30:46 +02002742 if (arg_p[0].data.sint < 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002743 end = start = smp->data.u.str.area + smp->data.u.str.data;
2744 while (start > smp->data.u.str.area) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002745 issep = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002746 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2747 if (*(start-1) == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002748 issep = 1;
2749 break;
2750 }
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002751 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002752 if (!inword) {
2753 if (!issep) {
2754 if (word != arg_p[0].data.sint) {
2755 word--;
2756 end = start;
2757 }
2758 inword = 1;
2759 }
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002760 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002761 else if (issep) {
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002762 if (word == arg_p[0].data.sint) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002763 if (count == 1)
2764 goto found;
2765 else if (count > 1)
2766 count--;
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002767 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002768 inword = 0;
2769 }
2770 start--;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002771 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002772 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002773 end = start = smp->data.u.str.area;
2774 while (end - smp->data.u.str.area < smp->data.u.str.data) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002775 issep = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002776 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2777 if (*end == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002778 issep = 1;
2779 break;
2780 }
2781 }
2782 if (!inword) {
2783 if (!issep) {
2784 if (word != arg_p[0].data.sint) {
2785 word++;
2786 start = end;
2787 }
2788 inword = 1;
2789 }
2790 }
2791 else if (issep) {
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002792 if (word == arg_p[0].data.sint) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002793 if (count == 1)
2794 goto found;
2795 else if (count > 1)
2796 count--;
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002797 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002798 inword = 0;
2799 }
2800 end++;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002801 }
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002802 }
2803
2804 /* Field not found */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002805 if (word != arg_p[0].data.sint) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002806 smp->data.u.str.data = 0;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002807 return 1;
2808 }
2809found:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002810 smp->data.u.str.data = end - start;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002811 /* If ret string is len 0, no need to
2812 change pointers or to update size */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002813 if (!smp->data.u.str.data)
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002814 return 1;
2815
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002816 smp->data.u.str.area = start;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002817
2818 /* Compute remaining size if needed
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002819 Note: smp->data.u.str.size cannot be set to 0 */
2820 if (smp->data.u.str.size)
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002821 smp->data.u.str.size -= start - smp->data.u.str.area;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002822
2823 return 1;
2824}
2825
Willy Tarreau7eda8492015-01-20 19:47:06 +01002826static int sample_conv_regsub_check(struct arg *args, struct sample_conv *conv,
2827 const char *file, int line, char **err)
2828{
2829 struct arg *arg = args;
2830 char *p;
2831 int len;
2832
2833 /* arg0 is a regex, it uses type_flag for ICASE and global match */
2834 arg[0].type_flags = 0;
2835
2836 if (arg[2].type != ARGT_STR)
2837 return 1;
2838
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002839 p = arg[2].data.str.area;
2840 len = arg[2].data.str.data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002841 while (len) {
2842 if (*p == 'i') {
2843 arg[0].type_flags |= ARGF_REG_ICASE;
2844 }
2845 else if (*p == 'g') {
2846 arg[0].type_flags |= ARGF_REG_GLOB;
2847 }
2848 else {
2849 memprintf(err, "invalid regex flag '%c', only 'i' and 'g' are supported", *p);
2850 return 0;
2851 }
2852 p++;
2853 len--;
2854 }
2855 return 1;
2856}
2857
2858/* This sample function is designed to do the equivalent of s/match/replace/ on
2859 * the input string. It applies a regex and restarts from the last matched
2860 * location until nothing matches anymore. First arg is the regex to apply to
2861 * the input string, second arg is the replacement expression.
2862 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002863static int sample_conv_regsub(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau7eda8492015-01-20 19:47:06 +01002864{
2865 char *start, *end;
2866 struct my_regex *reg = arg_p[0].data.reg;
2867 regmatch_t pmatch[MAX_MATCH];
Willy Tarreau83061a82018-07-13 11:56:34 +02002868 struct buffer *trash = get_trash_chunk();
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002869 struct buffer *output;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002870 int flag, max;
2871 int found;
2872
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002873 start = smp->data.u.str.area;
2874 end = start + smp->data.u.str.data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002875
2876 flag = 0;
2877 while (1) {
2878 /* check for last round which is used to copy remaining parts
2879 * when not running in global replacement mode.
2880 */
2881 found = 0;
2882 if ((arg_p[0].type_flags & ARGF_REG_GLOB) || !(flag & REG_NOTBOL)) {
2883 /* Note: we can have start == end on empty strings or at the end */
2884 found = regex_exec_match2(reg, start, end - start, MAX_MATCH, pmatch, flag);
2885 }
2886
2887 if (!found)
2888 pmatch[0].rm_so = end - start;
2889
2890 /* copy the heading non-matching part (which may also be the tail if nothing matches) */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002891 max = trash->size - trash->data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002892 if (max && pmatch[0].rm_so > 0) {
2893 if (max > pmatch[0].rm_so)
2894 max = pmatch[0].rm_so;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002895 memcpy(trash->area + trash->data, start, max);
2896 trash->data += max;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002897 }
2898
2899 if (!found)
2900 break;
2901
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002902 output = alloc_trash_chunk();
Willy Tarreau23997da2020-02-18 14:27:44 +01002903 if (!output)
2904 break;
2905
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002906 output->data = exp_replace(output->area, output->size, start, arg_p[1].data.str.area, pmatch);
2907
Willy Tarreau7eda8492015-01-20 19:47:06 +01002908 /* replace the matching part */
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002909 max = output->size - output->data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002910 if (max) {
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002911 if (max > output->data)
2912 max = output->data;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002913 memcpy(trash->area + trash->data,
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002914 output->area, max);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002915 trash->data += max;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002916 }
2917
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002918 free_trash_chunk(output);
2919
Willy Tarreau7eda8492015-01-20 19:47:06 +01002920 /* stop here if we're done with this string */
2921 if (start >= end)
2922 break;
2923
2924 /* We have a special case for matches of length 0 (eg: "x*y*").
2925 * These ones are considered to match in front of a character,
2926 * so we have to copy that character and skip to the next one.
2927 */
2928 if (!pmatch[0].rm_eo) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002929 if (trash->data < trash->size)
2930 trash->area[trash->data++] = start[pmatch[0].rm_eo];
Willy Tarreau7eda8492015-01-20 19:47:06 +01002931 pmatch[0].rm_eo++;
2932 }
2933
2934 start += pmatch[0].rm_eo;
2935 flag |= REG_NOTBOL;
2936 }
2937
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002938 smp->data.u.str = *trash;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002939 return 1;
2940}
2941
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002942/* This function check an operator entry. It expects a string.
2943 * The string can be an integer or a variable name.
2944 */
2945static int check_operator(struct arg *args, struct sample_conv *conv,
2946 const char *file, int line, char **err)
2947{
2948 const char *str;
2949 const char *end;
Christopher Faulet95917132020-08-05 23:07:07 +02002950 long long int i;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002951
2952 /* Try to decode a variable. */
2953 if (vars_check_arg(&args[0], NULL))
2954 return 1;
2955
2956 /* Try to convert an integer */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002957 str = args[0].data.str.area;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002958 end = str + strlen(str);
Christopher Faulet95917132020-08-05 23:07:07 +02002959 i = read_int64(&str, end);
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002960 if (*str != '\0') {
2961 memprintf(err, "expects an integer or a variable name");
2962 return 0;
2963 }
Christopher Faulet95917132020-08-05 23:07:07 +02002964
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002965 chunk_destroy(&args[0].data.str);
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002966 args[0].type = ARGT_SINT;
Christopher Faulet95917132020-08-05 23:07:07 +02002967 args[0].data.sint = i;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002968 return 1;
2969}
2970
Willy Tarreau6204cd92016-03-10 16:33:04 +01002971/* This function returns a sample struct filled with an arg content.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002972 * If the arg contain an integer, the integer is returned in the
2973 * sample. If the arg contains a variable descriptor, it returns the
2974 * variable value.
2975 *
2976 * This function returns 0 if an error occurs, otherwise it returns 1.
2977 */
Willy Tarreau6204cd92016-03-10 16:33:04 +01002978static inline int sample_conv_var2smp(const struct arg *arg, struct sample *smp)
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002979{
2980 switch (arg->type) {
2981 case ARGT_SINT:
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002982 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002983 smp->data.u.sint = arg->data.sint;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002984 return 1;
2985 case ARGT_VAR:
Willy Tarreau6204cd92016-03-10 16:33:04 +01002986 if (!vars_get_by_desc(&arg->data.var, smp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002987 return 0;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002988 if (!sample_casts[smp->data.type][SMP_T_SINT])
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002989 return 0;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002990 if (!sample_casts[smp->data.type][SMP_T_SINT](smp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002991 return 0;
2992 return 1;
2993 default:
2994 return 0;
2995 }
2996}
2997
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02002998/* Takes a SINT on input, applies a binary twos complement and returns the SINT
Willy Tarreau97707872015-01-27 15:12:13 +01002999 * result.
3000 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003001static int sample_conv_binary_cpl(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003002{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003003 smp->data.u.sint = ~smp->data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01003004 return 1;
3005}
3006
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003007/* Takes a SINT on input, applies a binary "and" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003008 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01003009 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003010static int sample_conv_binary_and(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003011{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003012 struct sample tmp;
3013
Willy Tarreau7560dd42016-03-10 16:28:58 +01003014 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003015 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003016 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003017 smp->data.u.sint &= tmp.data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01003018 return 1;
3019}
3020
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003021/* Takes a SINT on input, applies a binary "or" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003022 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01003023 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003024static int sample_conv_binary_or(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003025{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003026 struct sample tmp;
3027
Willy Tarreau7560dd42016-03-10 16:28:58 +01003028 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003029 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003030 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003031 smp->data.u.sint |= tmp.data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01003032 return 1;
3033}
3034
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003035/* Takes a SINT on input, applies a binary "xor" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003036 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01003037 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003038static int sample_conv_binary_xor(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003039{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003040 struct sample tmp;
3041
Willy Tarreau7560dd42016-03-10 16:28:58 +01003042 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003043 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003044 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003045 smp->data.u.sint ^= tmp.data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01003046 return 1;
3047}
3048
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003049static inline long long int arith_add(long long int a, long long int b)
3050{
3051 /* Prevent overflow and makes capped calculus.
3052 * We must ensure that the check calculus doesn't
3053 * exceed the signed 64 bits limits.
3054 *
3055 * +----------+----------+
3056 * | a<0 | a>=0 |
3057 * +------+----------+----------+
3058 * | b<0 | MIN-a>b | no check |
3059 * +------+----------+----------+
3060 * | b>=0 | no check | MAX-a<b |
3061 * +------+----------+----------+
3062 */
3063 if ((a ^ b) >= 0) {
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05003064 /* signs are different. */
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003065 if (a < 0) {
3066 if (LLONG_MIN - a > b)
3067 return LLONG_MIN;
3068 }
3069 if (LLONG_MAX - a < b)
3070 return LLONG_MAX;
3071 }
3072 return a + b;
3073}
3074
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003075/* Takes a SINT on input, applies an arithmetic "add" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003076 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01003077 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003078static int sample_conv_arith_add(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003079{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003080 struct sample tmp;
3081
Willy Tarreau7560dd42016-03-10 16:28:58 +01003082 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003083 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003084 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003085 smp->data.u.sint = arith_add(smp->data.u.sint, tmp.data.u.sint);
Willy Tarreau97707872015-01-27 15:12:13 +01003086 return 1;
3087}
3088
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003089/* Takes a SINT on input, applies an arithmetic "sub" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003090 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01003091 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003092static int sample_conv_arith_sub(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003093 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003094{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003095 struct sample tmp;
3096
Willy Tarreau7560dd42016-03-10 16:28:58 +01003097 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003098 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003099 return 0;
3100
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003101 /* We cannot represent -LLONG_MIN because abs(LLONG_MIN) is greater
3102 * than abs(LLONG_MAX). So, the following code use LLONG_MAX in place
3103 * of -LLONG_MIN and correct the result.
3104 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003105 if (tmp.data.u.sint == LLONG_MIN) {
3106 smp->data.u.sint = arith_add(smp->data.u.sint, LLONG_MAX);
3107 if (smp->data.u.sint < LLONG_MAX)
3108 smp->data.u.sint++;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003109 return 1;
3110 }
3111
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003112 /* standard subtraction: we use the "add" function and negate
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003113 * the second operand.
3114 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003115 smp->data.u.sint = arith_add(smp->data.u.sint, -tmp.data.u.sint);
Willy Tarreau97707872015-01-27 15:12:13 +01003116 return 1;
3117}
3118
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003119/* Takes a SINT on input, applies an arithmetic "mul" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003120 * arg_p or in the variable described in arg_p, and returns the SINT result.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003121 * If the result makes an overflow, then the largest possible quantity is
3122 * returned.
Willy Tarreau97707872015-01-27 15:12:13 +01003123 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003124static int sample_conv_arith_mul(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003125 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003126{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003127 struct sample tmp;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003128 long long int c;
3129
Willy Tarreau7560dd42016-03-10 16:28:58 +01003130 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003131 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003132 return 0;
3133
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003134 /* prevent divide by 0 during the check */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003135 if (!smp->data.u.sint || !tmp.data.u.sint) {
3136 smp->data.u.sint = 0;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003137 return 1;
3138 }
3139
3140 /* The multiply between LLONG_MIN and -1 returns a
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05003141 * "floating point exception".
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003142 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003143 if (smp->data.u.sint == LLONG_MIN && tmp.data.u.sint == -1) {
3144 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003145 return 1;
3146 }
3147
3148 /* execute standard multiplication. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003149 c = smp->data.u.sint * tmp.data.u.sint;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003150
3151 /* check for overflow and makes capped multiply. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003152 if (smp->data.u.sint != c / tmp.data.u.sint) {
3153 if ((smp->data.u.sint < 0) == (tmp.data.u.sint < 0)) {
3154 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003155 return 1;
3156 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003157 smp->data.u.sint = LLONG_MIN;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003158 return 1;
3159 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003160 smp->data.u.sint = c;
Willy Tarreau97707872015-01-27 15:12:13 +01003161 return 1;
3162}
3163
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003164/* Takes a SINT on input, applies an arithmetic "div" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003165 * arg_p or in the variable described in arg_p, and returns the SINT result.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003166 * If arg_p makes the result overflow, then the largest possible quantity is
3167 * returned.
Willy Tarreau97707872015-01-27 15:12:13 +01003168 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003169static int sample_conv_arith_div(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003170 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003171{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003172 struct sample tmp;
3173
Willy Tarreau7560dd42016-03-10 16:28:58 +01003174 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003175 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003176 return 0;
3177
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003178 if (tmp.data.u.sint) {
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003179 /* The divide between LLONG_MIN and -1 returns a
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05003180 * "floating point exception".
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003181 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003182 if (smp->data.u.sint == LLONG_MIN && tmp.data.u.sint == -1) {
3183 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003184 return 1;
3185 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003186 smp->data.u.sint /= tmp.data.u.sint;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003187 return 1;
3188 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003189 smp->data.u.sint = LLONG_MAX;
Willy Tarreau97707872015-01-27 15:12:13 +01003190 return 1;
3191}
3192
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003193/* Takes a SINT on input, applies an arithmetic "mod" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003194 * arg_p or in the variable described in arg_p, and returns the SINT result.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003195 * If arg_p makes the result overflow, then 0 is returned.
Willy Tarreau97707872015-01-27 15:12:13 +01003196 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003197static int sample_conv_arith_mod(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003198 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003199{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003200 struct sample tmp;
3201
Willy Tarreau7560dd42016-03-10 16:28:58 +01003202 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003203 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003204 return 0;
3205
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003206 if (tmp.data.u.sint) {
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003207 /* The divide between LLONG_MIN and -1 returns a
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05003208 * "floating point exception".
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003209 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003210 if (smp->data.u.sint == LLONG_MIN && tmp.data.u.sint == -1) {
3211 smp->data.u.sint = 0;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003212 return 1;
3213 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003214 smp->data.u.sint %= tmp.data.u.sint;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003215 return 1;
3216 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003217 smp->data.u.sint = 0;
Willy Tarreau97707872015-01-27 15:12:13 +01003218 return 1;
3219}
3220
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003221/* Takes an SINT on input, applies an arithmetic "neg" and returns the SINT
Willy Tarreau97707872015-01-27 15:12:13 +01003222 * result.
3223 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003224static int sample_conv_arith_neg(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003225 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003226{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003227 if (smp->data.u.sint == LLONG_MIN)
3228 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003229 else
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003230 smp->data.u.sint = -smp->data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01003231 return 1;
3232}
3233
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003234/* Takes a SINT on input, returns true is the value is non-null, otherwise
Willy Tarreau97707872015-01-27 15:12:13 +01003235 * false. The output is a BOOL.
3236 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003237static int sample_conv_arith_bool(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003238 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003239{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003240 smp->data.u.sint = !!smp->data.u.sint;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003241 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003242 return 1;
3243}
3244
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003245/* Takes a SINT on input, returns false is the value is non-null, otherwise
Willy Tarreau97707872015-01-27 15:12:13 +01003246 * truee. The output is a BOOL.
3247 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003248static int sample_conv_arith_not(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003249 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003250{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003251 smp->data.u.sint = !smp->data.u.sint;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003252 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003253 return 1;
3254}
3255
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003256/* Takes a SINT on input, returns true is the value is odd, otherwise false.
Willy Tarreau97707872015-01-27 15:12:13 +01003257 * The output is a BOOL.
3258 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003259static int sample_conv_arith_odd(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003260 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003261{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003262 smp->data.u.sint = smp->data.u.sint & 1;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003263 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003264 return 1;
3265}
3266
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003267/* Takes a SINT on input, returns true is the value is even, otherwise false.
Willy Tarreau97707872015-01-27 15:12:13 +01003268 * The output is a BOOL.
3269 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003270static int sample_conv_arith_even(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003271 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003272{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003273 smp->data.u.sint = !(smp->data.u.sint & 1);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003274 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003275 return 1;
3276}
3277
Willy Tarreau280f42b2018-02-19 15:34:12 +01003278/* appends an optional const string, an optional variable contents and another
3279 * optional const string to an existing string.
3280 */
3281static int sample_conv_concat(const struct arg *arg_p, struct sample *smp, void *private)
3282{
Willy Tarreau83061a82018-07-13 11:56:34 +02003283 struct buffer *trash;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003284 struct sample tmp;
3285 int max;
3286
Willy Tarreau591fc3a2021-01-08 16:08:43 +01003287 trash = alloc_trash_chunk();
William Dauchye9970102021-01-11 11:05:58 +01003288 if (!trash)
3289 return 0;
3290
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003291 trash->data = smp->data.u.str.data;
3292 if (trash->data > trash->size - 1)
3293 trash->data = trash->size - 1;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003294
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003295 memcpy(trash->area, smp->data.u.str.area, trash->data);
3296 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003297
3298 /* append first string */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003299 max = arg_p[0].data.str.data;
3300 if (max > trash->size - 1 - trash->data)
3301 max = trash->size - 1 - trash->data;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003302
3303 if (max) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003304 memcpy(trash->area + trash->data, arg_p[0].data.str.area, max);
3305 trash->data += max;
3306 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003307 }
3308
3309 /* append second string (variable) if it's found and we can turn it
3310 * into a string.
3311 */
3312 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
3313 if (arg_p[1].type == ARGT_VAR && vars_get_by_desc(&arg_p[1].data.var, &tmp) &&
3314 (sample_casts[tmp.data.type][SMP_T_STR] == c_none ||
3315 sample_casts[tmp.data.type][SMP_T_STR](&tmp))) {
3316
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003317 max = tmp.data.u.str.data;
3318 if (max > trash->size - 1 - trash->data)
3319 max = trash->size - 1 - trash->data;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003320
3321 if (max) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003322 memcpy(trash->area + trash->data, tmp.data.u.str.area,
3323 max);
3324 trash->data += max;
3325 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003326 }
3327 }
3328
3329 /* append third string */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003330 max = arg_p[2].data.str.data;
3331 if (max > trash->size - 1 - trash->data)
3332 max = trash->size - 1 - trash->data;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003333
3334 if (max) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003335 memcpy(trash->area + trash->data, arg_p[2].data.str.area, max);
3336 trash->data += max;
3337 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003338 }
3339
3340 smp->data.u.str = *trash;
3341 smp->data.type = SMP_T_STR;
Willy Tarreau591fc3a2021-01-08 16:08:43 +01003342 smp_dup(smp);
3343 free_trash_chunk(trash);
Willy Tarreau280f42b2018-02-19 15:34:12 +01003344 return 1;
3345}
3346
3347/* This function checks the "concat" converter's arguments and extracts the
3348 * variable name and its scope.
3349 */
3350static int smp_check_concat(struct arg *args, struct sample_conv *conv,
3351 const char *file, int line, char **err)
3352{
3353 /* Try to decode a variable. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003354 if (args[1].data.str.data > 0 && !vars_check_arg(&args[1], NULL)) {
3355 memprintf(err, "failed to register variable name '%s'",
3356 args[1].data.str.area);
Willy Tarreau280f42b2018-02-19 15:34:12 +01003357 return 0;
3358 }
3359 return 1;
3360}
3361
Tim Duesterhusf38175c2020-06-09 11:48:42 +02003362/* Compares string with a variable containing a string. Return value
Tim Duesterhusca097c12018-04-27 21:18:45 +02003363 * is compatible with strcmp(3)'s return value.
3364 */
3365static int sample_conv_strcmp(const struct arg *arg_p, struct sample *smp, void *private)
3366{
3367 struct sample tmp;
3368 int max, result;
3369
3370 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
3371 if (arg_p[0].type != ARGT_VAR)
3372 return 0;
3373 if (!vars_get_by_desc(&arg_p[0].data.var, &tmp))
3374 return 0;
3375 if (!sample_casts[tmp.data.type][SMP_T_STR](&tmp))
3376 return 0;
3377
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003378 max = MIN(smp->data.u.str.data, tmp.data.u.str.data);
3379 result = strncmp(smp->data.u.str.area, tmp.data.u.str.area, max);
Tim Duesterhusca097c12018-04-27 21:18:45 +02003380 if (result == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003381 if (smp->data.u.str.data != tmp.data.u.str.data) {
3382 if (smp->data.u.str.data < tmp.data.u.str.data) {
Tim Duesterhusca097c12018-04-27 21:18:45 +02003383 result = -1;
3384 }
3385 else {
3386 result = 1;
3387 }
3388 }
3389 }
3390
3391 smp->data.u.sint = result;
3392 smp->data.type = SMP_T_SINT;
3393 return 1;
3394}
3395
Willy Tarreau2a8a2f02021-05-09 11:59:49 +02003396#if defined(HAVE_CRYPTO_memcmp)
Tim Duesterhusf38175c2020-06-09 11:48:42 +02003397/* Compares bytestring with a variable containing a bytestring. Return value
3398 * is `true` if both bytestrings are bytewise identical and `false` otherwise.
3399 *
3400 * Comparison will be performed in constant time if both bytestrings are of
3401 * the same length. If the lengths differ execution time will not be constant.
3402 */
3403static int sample_conv_secure_memcmp(const struct arg *arg_p, struct sample *smp, void *private)
3404{
3405 struct sample tmp;
3406 int result;
3407
3408 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
3409 if (arg_p[0].type != ARGT_VAR)
3410 return 0;
3411 if (!vars_get_by_desc(&arg_p[0].data.var, &tmp))
3412 return 0;
3413 if (!sample_casts[tmp.data.type][SMP_T_BIN](&tmp))
3414 return 0;
3415
3416 if (smp->data.u.str.data != tmp.data.u.str.data) {
3417 smp->data.u.sint = 0;
3418 smp->data.type = SMP_T_BOOL;
3419 return 1;
3420 }
3421
3422 /* The following comparison is performed in constant time. */
3423 result = CRYPTO_memcmp(smp->data.u.str.area, tmp.data.u.str.area, smp->data.u.str.data);
3424
3425 smp->data.u.sint = result == 0;
3426 smp->data.type = SMP_T_BOOL;
3427 return 1;
3428}
3429#endif
3430
Tim Duesterhus3943e4f2020-09-11 14:25:23 +02003431/* Takes a boolean as input. Returns the first argument if that boolean is true and
3432 * the second argument otherwise.
3433 */
3434static int sample_conv_iif(const struct arg *arg_p, struct sample *smp, void *private)
3435{
3436 smp->data.type = SMP_T_STR;
3437 smp->flags |= SMP_F_CONST;
3438
3439 if (smp->data.u.sint) {
3440 smp->data.u.str.data = arg_p[0].data.str.data;
3441 smp->data.u.str.area = arg_p[0].data.str.area;
3442 }
3443 else {
3444 smp->data.u.str.data = arg_p[1].data.str.data;
3445 smp->data.u.str.area = arg_p[1].data.str.area;
3446 }
3447
3448 return 1;
3449}
3450
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003451#define GRPC_MSG_COMPRESS_FLAG_SZ 1 /* 1 byte */
3452#define GRPC_MSG_LENGTH_SZ 4 /* 4 bytes */
3453#define GRPC_MSG_HEADER_SZ (GRPC_MSG_COMPRESS_FLAG_SZ + GRPC_MSG_LENGTH_SZ)
3454
3455/*
3456 * Extract the field value of an input binary sample. Takes a mandatory argument:
3457 * the protocol buffers field identifier (dotted notation) internally represented
3458 * as an array of unsigned integers and its size.
3459 * Return 1 if the field was found, 0 if not.
3460 */
3461static int sample_conv_ungrpc(const struct arg *arg_p, struct sample *smp, void *private)
3462{
3463 unsigned char *pos;
3464 size_t grpc_left;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003465
3466 pos = (unsigned char *)smp->data.u.str.area;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003467 grpc_left = smp->data.u.str.data;
3468
Frédéric Lécaille7c93e882019-03-04 07:33:41 +01003469 while (grpc_left > GRPC_MSG_HEADER_SZ) {
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003470 size_t grpc_msg_len, left;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003471
3472 grpc_msg_len = left = ntohl(*(uint32_t *)(pos + GRPC_MSG_COMPRESS_FLAG_SZ));
3473
3474 pos += GRPC_MSG_HEADER_SZ;
3475 grpc_left -= GRPC_MSG_HEADER_SZ;
3476
3477 if (grpc_left < left)
3478 return 0;
3479
Frédéric Lécaille5f33f852019-03-06 08:03:44 +01003480 if (protobuf_field_lookup(arg_p, smp, &pos, &left))
3481 return 1;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003482
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003483 grpc_left -= grpc_msg_len;
3484 }
3485
3486 return 0;
3487}
3488
Frédéric Lécaillebfe61382019-03-06 14:34:36 +01003489static int sample_conv_protobuf(const struct arg *arg_p, struct sample *smp, void *private)
3490{
3491 unsigned char *pos;
3492 size_t left;
3493
3494 pos = (unsigned char *)smp->data.u.str.area;
3495 left = smp->data.u.str.data;
3496
3497 return protobuf_field_lookup(arg_p, smp, &pos, &left);
3498}
3499
3500static int sample_conv_protobuf_check(struct arg *args, struct sample_conv *conv,
3501 const char *file, int line, char **err)
Frédéric Lécaille756d97f2019-03-04 19:03:48 +01003502{
3503 if (!args[1].type) {
3504 args[1].type = ARGT_SINT;
3505 args[1].data.sint = PBUF_T_BINARY;
3506 }
3507 else {
3508 int pbuf_type;
3509
3510 pbuf_type = protobuf_type(args[1].data.str.area);
3511 if (pbuf_type == -1) {
3512 memprintf(err, "Wrong protocol buffer type '%s'", args[1].data.str.area);
3513 return 0;
3514 }
3515
Christopher Faulet6ad7df42020-08-07 11:45:18 +02003516 chunk_destroy(&args[1].data.str);
Frédéric Lécaille756d97f2019-03-04 19:03:48 +01003517 args[1].type = ARGT_SINT;
3518 args[1].data.sint = pbuf_type;
3519 }
3520
3521 return 1;
3522}
3523
Baptiste Assmanne138dda2020-10-22 15:39:03 +02003524/*
3525 * Extract the tag value of an input binary sample. Takes a mandatory argument:
3526 * the FIX protocol tag identifier.
3527 * Return 1 if the tag was found, 0 if not.
3528 */
3529static int sample_conv_fix_tag_value(const struct arg *arg_p, struct sample *smp, void *private)
3530{
3531 struct ist value;
3532
3533 smp->flags &= ~SMP_F_MAY_CHANGE;
3534 value = fix_tag_value(ist2(smp->data.u.str.area, smp->data.u.str.data),
3535 arg_p[0].data.sint);
3536 if (!istlen(value)) {
3537 if (!isttest(value)) {
3538 /* value != IST_NULL, need more data */
3539 smp->flags |= SMP_F_MAY_CHANGE;
3540 }
3541 return 0;
3542 }
3543
3544 smp->data.u.str = ist2buf(value);
3545 smp->flags |= SMP_F_CONST;
3546
3547 return 1;
3548}
3549
3550/* This function checks the "fix_tag_value" converter configuration.
3551 * It expects a "known" (by HAProxy) tag name or ID.
3552 * Tag string names are converted to their ID counterpart because this is the
3553 * format they are sent over the wire.
3554 */
3555static int sample_conv_fix_value_check(struct arg *args, struct sample_conv *conv,
3556 const char *file, int line, char **err)
3557{
3558 struct ist str;
3559 unsigned int tag;
3560
3561 str = ist2(args[0].data.str.area, args[0].data.str.data);
3562 tag = fix_tagid(str);
3563 if (!tag) {
3564 memprintf(err, "Unknown FIX tag name '%s'", args[0].data.str.area);
3565 return 0;
3566 }
3567
3568 chunk_destroy(&args[0].data.str);
3569 args[0].type = ARGT_SINT;
3570 args[0].data.sint = tag;
3571
3572 return 1;
3573}
3574
3575/*
3576 * Checks that a buffer contains a valid FIX message
3577 *
3578 * Return 1 if the check could be run, 0 if not.
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05003579 * The result of the analyse itself is stored in <smp> as a boolean
Baptiste Assmanne138dda2020-10-22 15:39:03 +02003580 */
3581static int sample_conv_fix_is_valid(const struct arg *arg_p, struct sample *smp, void *private)
3582{
3583 struct ist msg;
3584
3585 msg = ist2(smp->data.u.str.area, smp->data.u.str.data);
3586
3587 smp->flags &= ~SMP_F_MAY_CHANGE;
3588 switch (fix_validate_message(msg)) {
3589 case FIX_VALID_MESSAGE:
3590 smp->data.type = SMP_T_BOOL;
3591 smp->data.u.sint = 1;
3592 return 1;
3593 case FIX_NEED_MORE_DATA:
3594 smp->flags |= SMP_F_MAY_CHANGE;
3595 return 0;
3596 case FIX_INVALID_MESSAGE:
3597 smp->data.type = SMP_T_BOOL;
3598 smp->data.u.sint = 0;
3599 return 1;
3600 }
3601 return 0;
3602}
3603
Baptiste Assmanne279ca62020-10-27 18:10:06 +01003604/*
3605 * Extract the field value of an input binary sample containing an MQTT packet.
3606 * Takes 2 mandatory arguments:
3607 * - packet type
3608 * - field name
3609 *
3610 * return 1 if the field was found, 0 if not.
3611 */
3612static int sample_conv_mqtt_field_value(const struct arg *arg_p, struct sample *smp, void *private)
3613{
3614 struct ist pkt, value;
3615 int type, fieldname_id;
3616
3617 pkt = ist2(smp->data.u.str.area, smp->data.u.str.data);
3618 type = arg_p[0].data.sint;
3619 fieldname_id = arg_p[1].data.sint;
3620
3621 smp->flags &= ~SMP_F_MAY_CHANGE;
3622 value = mqtt_field_value(pkt, type, fieldname_id);
3623 if (!istlen(value)) {
3624 if (isttest(value)) {
3625 /* value != IST_NULL, need more data */
3626 smp->flags |= SMP_F_MAY_CHANGE;
3627 }
3628 return 0;
3629 }
3630
3631 smp->data.u.str = ist2buf(value);
3632 smp->flags |= SMP_F_CONST;
3633 return 1;
3634}
3635
3636/*
3637 * this function checks the "mqtt_field_value" converter configuration.
3638 * It expects a known packet type name or ID and a field name, in this order
3639 *
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05003640 * Args[0] will be turned into a MQTT_CPT_* value for direct matching when parsing
Baptiste Assmanne279ca62020-10-27 18:10:06 +01003641 * a packet.
3642 */
3643static int sample_conv_mqtt_field_value_check(struct arg *args, struct sample_conv *conv,
3644 const char *file, int line, char **err)
3645{
3646 int type, fieldname_id;
3647
3648 /* check the MQTT packet type is valid */
3649 type = mqtt_typeid(ist2(args[0].data.str.area, args[0].data.str.data));
3650 if (type == MQTT_CPT_INVALID) {
3651 memprintf(err, "Unknown MQTT type '%s'", args[0].data.str.area);
3652 return 0;
3653 }
3654
3655 /* check the field name belongs to the MQTT packet type */
3656 fieldname_id = mqtt_check_type_fieldname(type, ist2(args[1].data.str.area, args[1].data.str.data));
3657 if (fieldname_id == MQTT_FN_INVALID) {
3658 memprintf(err, "Unknown MQTT field name '%s' for packet type '%s'", args[1].data.str.area,
3659 args[0].data.str.area);
3660 return 0;
3661 }
3662
3663 /* save numeric counterparts of type and field name */
3664 chunk_destroy(&args[0].data.str);
3665 chunk_destroy(&args[1].data.str);
3666 args[0].type = ARGT_SINT;
3667 args[0].data.sint = type;
3668 args[1].type = ARGT_SINT;
3669 args[1].data.sint = fieldname_id;
3670
3671 return 1;
3672}
3673
3674/*
3675 * Checks that <smp> contains a valid MQTT message
3676 *
3677 * The function returns 1 if the check was run to its end, 0 otherwise.
3678 * The result of the analyse itself is stored in <smp> as a boolean.
3679 */
3680static int sample_conv_mqtt_is_valid(const struct arg *arg_p, struct sample *smp, void *private)
3681{
3682 struct ist msg;
3683
3684 msg = ist2(smp->data.u.str.area, smp->data.u.str.data);
3685
3686 smp->flags &= ~SMP_F_MAY_CHANGE;
3687 switch (mqtt_validate_message(msg, NULL)) {
3688 case FIX_VALID_MESSAGE:
3689 smp->data.type = SMP_T_BOOL;
3690 smp->data.u.sint = 1;
3691 return 1;
3692 case FIX_NEED_MORE_DATA:
3693 smp->flags |= SMP_F_MAY_CHANGE;
3694 return 0;
3695 case FIX_INVALID_MESSAGE:
3696 smp->data.type = SMP_T_BOOL;
3697 smp->data.u.sint = 0;
3698 return 1;
3699 }
3700 return 0;
3701}
3702
Tim Duesterhusca097c12018-04-27 21:18:45 +02003703/* This function checks the "strcmp" converter's arguments and extracts the
3704 * variable name and its scope.
3705 */
3706static int smp_check_strcmp(struct arg *args, struct sample_conv *conv,
3707 const char *file, int line, char **err)
3708{
Willy Tarreaua1169b62021-05-08 06:50:28 +02003709 if (!args[0].data.str.data) {
3710 memprintf(err, "missing variable name");
3711 return 0;
3712 }
3713
Tim Duesterhusca097c12018-04-27 21:18:45 +02003714 /* Try to decode a variable. */
3715 if (vars_check_arg(&args[0], NULL))
3716 return 1;
3717
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003718 memprintf(err, "failed to register variable name '%s'",
3719 args[0].data.str.area);
Tim Duesterhusca097c12018-04-27 21:18:45 +02003720 return 0;
3721}
3722
Willy Tarreau2a8a2f02021-05-09 11:59:49 +02003723#if defined(HAVE_CRYPTO_memcmp)
Tim Duesterhusf38175c2020-06-09 11:48:42 +02003724/* This function checks the "secure_memcmp" converter's arguments and extracts the
3725 * variable name and its scope.
3726 */
3727static int smp_check_secure_memcmp(struct arg *args, struct sample_conv *conv,
3728 const char *file, int line, char **err)
3729{
Willy Tarreaua1169b62021-05-08 06:50:28 +02003730 if (!args[0].data.str.data) {
3731 memprintf(err, "missing variable name");
3732 return 0;
3733 }
3734
Tim Duesterhusf38175c2020-06-09 11:48:42 +02003735 /* Try to decode a variable. */
3736 if (vars_check_arg(&args[0], NULL))
3737 return 1;
3738
3739 memprintf(err, "failed to register variable name '%s'",
3740 args[0].data.str.area);
3741 return 0;
3742}
3743#endif
3744
Christopher Faulet4ccc12f2020-04-01 09:08:32 +02003745/**/
3746static int sample_conv_htonl(const struct arg *arg_p, struct sample *smp, void *private)
3747{
3748 struct buffer *tmp;
3749 uint32_t n;
3750
3751 n = htonl((uint32_t)smp->data.u.sint);
3752 tmp = get_trash_chunk();
3753
3754 memcpy(b_head(tmp), &n, 4);
3755 b_add(tmp, 4);
3756
3757 smp->data.u.str = *tmp;
3758 smp->data.type = SMP_T_BIN;
3759 return 1;
3760}
3761
Christopher Fauletea159d62020-04-01 16:21:44 +02003762/**/
3763static int sample_conv_cut_crlf(const struct arg *arg_p, struct sample *smp, void *private)
3764{
3765 char *p;
3766 size_t l;
3767
3768 p = smp->data.u.str.area;
3769 for (l = 0; l < smp->data.u.str.data; l++) {
3770 if (*(p+l) == '\r' || *(p+l) == '\n')
3771 break;
3772 }
3773 smp->data.u.str.data = l;
3774 return 1;
3775}
3776
Christopher Faulet51fc9d12020-04-01 17:24:41 +02003777/**/
3778static int sample_conv_ltrim(const struct arg *arg_p, struct sample *smp, void *private)
3779{
3780 char *delimiters, *p;
3781 size_t dlen, l;
3782
3783 delimiters = arg_p[0].data.str.area;
3784 dlen = arg_p[0].data.str.data;
3785
3786 l = smp->data.u.str.data;
3787 p = smp->data.u.str.area;
3788 while (l && memchr(delimiters, *p, dlen) != NULL) {
3789 p++;
3790 l--;
3791 }
3792
3793 smp->data.u.str.area = p;
3794 smp->data.u.str.data = l;
3795 return 1;
3796}
3797
Christopher Faulet568415a2020-04-01 17:24:47 +02003798/**/
3799static int sample_conv_rtrim(const struct arg *arg_p, struct sample *smp, void *private)
3800{
3801 char *delimiters, *p;
3802 size_t dlen, l;
3803
3804 delimiters = arg_p[0].data.str.area;
3805 dlen = arg_p[0].data.str.data;
3806
3807 l = smp->data.u.str.data;
3808 p = smp->data.u.str.area + l - 1;
3809 while (l && memchr(delimiters, *p, dlen) != NULL) {
3810 p--;
3811 l--;
3812 }
3813
3814 smp->data.u.str.data = l;
3815 return 1;
3816}
3817
Alex51c8ad42021-04-15 16:45:15 +02003818/* This function checks the "json_query" converter's arguments. */
3819static int sample_check_json_query(struct arg *arg, struct sample_conv *conv,
3820 const char *file, int line, char **err)
3821{
3822 if (arg[0].data.str.data == 0) {
3823 memprintf(err, "json_path must not be empty");
3824 return 0;
3825 }
3826
3827 if (arg[1].data.str.data != 0) {
3828 if (strcmp(arg[1].data.str.area, "int") != 0) {
3829 memprintf(err, "output_type only supports \"int\" as argument");
3830 return 0;
3831 } else {
3832 arg[1].type = ARGT_SINT;
3833 arg[1].data.sint = 0;
3834 }
3835 }
3836 return 1;
3837}
3838
3839/* Limit JSON integer values to the range [-(2**53)+1, (2**53)-1] as per
3840 * the recommendation for interoperable integers in section 6 of RFC 7159.
3841 */
3842#define JSON_INT_MAX ((1LL << 53) - 1)
3843#define JSON_INT_MIN (-JSON_INT_MAX)
3844
3845/* This sample function get the value from a given json string.
3846 * The mjson library is used to parse the JSON struct
3847 */
3848static int sample_conv_json_query(const struct arg *args, struct sample *smp, void *private)
3849{
3850 struct buffer *trash = get_trash_chunk();
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003851 const char *token; /* holds the temporary string from mjson_find */
3852 int token_size; /* holds the length of <token> */
Alex51c8ad42021-04-15 16:45:15 +02003853
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003854 enum mjson_tok token_type;
Alex51c8ad42021-04-15 16:45:15 +02003855
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003856 token_type = mjson_find(smp->data.u.str.area, smp->data.u.str.data, args[0].data.str.area, &token, &token_size);
3857
3858 switch (token_type) {
Alex51c8ad42021-04-15 16:45:15 +02003859 case MJSON_TOK_NUMBER:
3860 if (args[1].type == ARGT_SINT) {
Willy Tarreaufb601952021-05-14 08:51:53 +02003861 smp->data.u.sint = strtoll(token, NULL, 0);
Alex51c8ad42021-04-15 16:45:15 +02003862
3863 if (smp->data.u.sint < JSON_INT_MIN || smp->data.u.sint > JSON_INT_MAX)
3864 return 0;
3865
3866 smp->data.type = SMP_T_SINT;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003867
3868 return 1;
Alex51c8ad42021-04-15 16:45:15 +02003869 } else {
3870 double double_val;
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003871
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003872 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 +02003873 return 0;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003874
3875 trash->data = snprintf(trash->area,trash->size,"%g",double_val);
3876 smp->data.u.str = *trash;
3877 smp->data.type = SMP_T_STR;
3878
3879 return 1;
Alex51c8ad42021-04-15 16:45:15 +02003880 }
Alex51c8ad42021-04-15 16:45:15 +02003881 case MJSON_TOK_TRUE:
3882 smp->data.type = SMP_T_BOOL;
3883 smp->data.u.sint = 1;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003884
3885 return 1;
Alex51c8ad42021-04-15 16:45:15 +02003886 case MJSON_TOK_FALSE:
3887 smp->data.type = SMP_T_BOOL;
3888 smp->data.u.sint = 0;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003889
3890 return 1;
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003891 case MJSON_TOK_STRING: {
3892 int len;
3893
3894 len = mjson_get_string(smp->data.u.str.area, smp->data.u.str.data, args[0].data.str.area, trash->area, trash->size);
3895
3896 if (len == -1) {
Alex51c8ad42021-04-15 16:45:15 +02003897 /* invalid string */
3898 return 0;
Alex51c8ad42021-04-15 16:45:15 +02003899 }
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003900
3901 trash->data = len;
3902 smp->data.u.str = *trash;
3903 smp->data.type = SMP_T_STR;
3904
3905 return 1;
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003906 }
Tim Duesterhus8f3bc8f2021-04-15 18:14:32 +02003907 case MJSON_TOK_NULL:
3908 case MJSON_TOK_ARRAY:
3909 case MJSON_TOK_OBJECT:
3910 /* We cannot handle these. */
3911 return 0;
3912 case MJSON_TOK_INVALID:
3913 /* Nothing matches the query. */
3914 return 0;
3915 case MJSON_TOK_KEY:
3916 /* This is not a valid return value according to the
3917 * mjson documentation, but we handle it to benefit
3918 * from '-Wswitch'.
3919 */
Alex51c8ad42021-04-15 16:45:15 +02003920 return 0;
3921 }
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003922
3923 my_unreachable();
3924 return 0;
Alex51c8ad42021-04-15 16:45:15 +02003925}
3926
3927
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003928/************************************************************************/
3929/* All supported sample fetch functions must be declared here */
3930/************************************************************************/
3931
3932/* force TRUE to be returned at the fetch level */
3933static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02003934smp_fetch_true(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003935{
Willy Tarreau280f42b2018-02-19 15:34:12 +01003936 if (!smp_make_rw(smp))
3937 return 0;
3938
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003939 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003940 smp->data.u.sint = 1;
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003941 return 1;
3942}
3943
3944/* force FALSE to be returned at the fetch level */
3945static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02003946smp_fetch_false(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003947{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003948 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003949 smp->data.u.sint = 0;
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003950 return 1;
3951}
3952
3953/* retrieve environment variable $1 as a string */
3954static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02003955smp_fetch_env(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003956{
3957 char *env;
3958
Christopher Faulete6e7a582021-01-29 11:29:28 +01003959 if (args[0].type != ARGT_STR)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003960 return 0;
3961
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003962 env = getenv(args[0].data.str.area);
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003963 if (!env)
3964 return 0;
3965
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003966 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +01003967 smp->flags = SMP_F_CONST;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003968 smp->data.u.str.area = env;
3969 smp->data.u.str.data = strlen(env);
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003970 return 1;
3971}
3972
Damien Claisseae6f1252019-10-30 15:57:28 +00003973/* Validates the data unit argument passed to "date" fetch. Argument 1 support an
3974 * optional string representing the unit of the result: "s" for seconds, "ms" for
3975 * milliseconds and "us" for microseconds.
3976 * Returns 0 on error and non-zero if OK.
3977 */
3978int smp_check_date_unit(struct arg *args, char **err)
3979{
3980 if (args[1].type == ARGT_STR) {
Christopher Faulet95917132020-08-05 23:07:07 +02003981 long long int unit;
3982
Damien Claisseae6f1252019-10-30 15:57:28 +00003983 if (strcmp(args[1].data.str.area, "s") == 0) {
Christopher Faulet95917132020-08-05 23:07:07 +02003984 unit = TIME_UNIT_S;
Damien Claisseae6f1252019-10-30 15:57:28 +00003985 }
3986 else if (strcmp(args[1].data.str.area, "ms") == 0) {
Christopher Faulet95917132020-08-05 23:07:07 +02003987 unit = TIME_UNIT_MS;
Damien Claisseae6f1252019-10-30 15:57:28 +00003988 }
3989 else if (strcmp(args[1].data.str.area, "us") == 0) {
Christopher Faulet95917132020-08-05 23:07:07 +02003990 unit = TIME_UNIT_US;
Damien Claisseae6f1252019-10-30 15:57:28 +00003991 }
3992 else {
3993 memprintf(err, "expects 's', 'ms' or 'us', got '%s'",
3994 args[1].data.str.area);
3995 return 0;
3996 }
Christopher Faulet95917132020-08-05 23:07:07 +02003997
Christopher Faulet6ad7df42020-08-07 11:45:18 +02003998 chunk_destroy(&args[1].data.str);
Damien Claisseae6f1252019-10-30 15:57:28 +00003999 args[1].type = ARGT_SINT;
Christopher Faulet95917132020-08-05 23:07:07 +02004000 args[1].data.sint = unit;
Damien Claisseae6f1252019-10-30 15:57:28 +00004001 }
4002 else if (args[1].type != ARGT_STOP) {
4003 memprintf(err, "Unexpected arg type");
4004 return 0;
4005 }
4006
4007 return 1;
4008}
4009
4010/* retrieve the current local date in epoch time, converts it to milliseconds
4011 * or microseconds if asked to in optional args[1] unit param, and applies an
4012 * optional args[0] offset.
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004013 */
4014static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004015smp_fetch_date(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004016{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004017 smp->data.u.sint = date.tv_sec;
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004018
Damien Claisseae6f1252019-10-30 15:57:28 +00004019 /* report in milliseconds */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004020 if (args[1].type == ARGT_SINT && args[1].data.sint == TIME_UNIT_MS) {
Damien Claisseae6f1252019-10-30 15:57:28 +00004021 smp->data.u.sint *= 1000;
4022 smp->data.u.sint += date.tv_usec / 1000;
4023 }
4024 /* report in microseconds */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004025 else if (args[1].type == ARGT_SINT && args[1].data.sint == TIME_UNIT_US) {
Damien Claisseae6f1252019-10-30 15:57:28 +00004026 smp->data.u.sint *= 1000000;
4027 smp->data.u.sint += date.tv_usec;
4028 }
4029
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004030 /* add offset */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004031 if (args[0].type == ARGT_SINT)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004032 smp->data.u.sint += args[0].data.sint;
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004033
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004034 smp->data.type = SMP_T_SINT;
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004035 smp->flags |= SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4036 return 1;
4037}
4038
Etienne Carrierea792a0a2018-01-17 13:43:24 +01004039/* retrieve the current microsecond part of the date */
4040static int
4041smp_fetch_date_us(const struct arg *args, struct sample *smp, const char *kw, void *private)
4042{
4043 smp->data.u.sint = date.tv_usec;
4044 smp->data.type = SMP_T_SINT;
4045 smp->flags |= SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4046 return 1;
4047}
4048
4049
Nenad Merdanovic807a6e72017-03-12 22:00:00 +01004050/* returns the hostname */
4051static int
4052smp_fetch_hostname(const struct arg *args, struct sample *smp, const char *kw, void *private)
4053{
4054 smp->data.type = SMP_T_STR;
4055 smp->flags = SMP_F_CONST;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004056 smp->data.u.str.area = hostname;
4057 smp->data.u.str.data = strlen(hostname);
Nenad Merdanovic807a6e72017-03-12 22:00:00 +01004058 return 1;
4059}
4060
Willy Tarreau0f30d262014-11-24 16:02:05 +01004061/* returns the number of processes */
4062static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004063smp_fetch_nbproc(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau0f30d262014-11-24 16:02:05 +01004064{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004065 smp->data.type = SMP_T_SINT;
Willy Tarreau91358592021-06-15 08:08:04 +02004066 smp->data.u.sint = 1;
Willy Tarreau0f30d262014-11-24 16:02:05 +01004067 return 1;
4068}
4069
4070/* returns the number of the current process (between 1 and nbproc */
4071static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004072smp_fetch_proc(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau0f30d262014-11-24 16:02:05 +01004073{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004074 smp->data.type = SMP_T_SINT;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02004075 smp->data.u.sint = 1;
Willy Tarreau0f30d262014-11-24 16:02:05 +01004076 return 1;
4077}
4078
Christopher Faulet34adb2a2017-11-21 21:45:38 +01004079/* returns the number of the current thread (between 1 and nbthread */
4080static int
4081smp_fetch_thread(const struct arg *args, struct sample *smp, const char *kw, void *private)
4082{
4083 smp->data.type = SMP_T_SINT;
4084 smp->data.u.sint = tid;
4085 return 1;
4086}
4087
Willy Tarreau84310e22014-02-14 11:59:04 +01004088/* generate a random 32-bit integer for whatever purpose, with an optional
4089 * range specified in argument.
4090 */
4091static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004092smp_fetch_rand(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau84310e22014-02-14 11:59:04 +01004093{
Willy Tarreauaa8bbc12020-03-08 18:01:10 +01004094 smp->data.u.sint = ha_random32();
Willy Tarreau84310e22014-02-14 11:59:04 +01004095
4096 /* reduce if needed. Don't do a modulo, use all bits! */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004097 if (args[0].type == ARGT_SINT)
Willy Tarreauaa8bbc12020-03-08 18:01:10 +01004098 smp->data.u.sint = ((u64)smp->data.u.sint * (u64)args[0].data.sint) >> 32;
Willy Tarreau84310e22014-02-14 11:59:04 +01004099
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004100 smp->data.type = SMP_T_SINT;
Willy Tarreau84310e22014-02-14 11:59:04 +01004101 smp->flags |= SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4102 return 1;
4103}
4104
Willy Tarreau0f30d262014-11-24 16:02:05 +01004105/* returns true if the current process is stopping */
4106static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004107smp_fetch_stopping(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau0f30d262014-11-24 16:02:05 +01004108{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004109 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004110 smp->data.u.sint = stopping;
Willy Tarreau0f30d262014-11-24 16:02:05 +01004111 return 1;
4112}
4113
Willy Tarreau70fe9442018-11-22 16:07:39 +01004114/* returns the number of calls of the current stream's process_stream() */
4115static int
4116smp_fetch_cpu_calls(const struct arg *args, struct sample *smp, const char *kw, void *private)
4117{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004118 if (!smp->strm)
4119 return 0;
4120
Willy Tarreau70fe9442018-11-22 16:07:39 +01004121 smp->data.type = SMP_T_SINT;
4122 smp->data.u.sint = smp->strm->task->calls;
4123 return 1;
4124}
4125
4126/* returns the average number of nanoseconds spent processing the stream per call */
4127static int
4128smp_fetch_cpu_ns_avg(const struct arg *args, struct sample *smp, const char *kw, void *private)
4129{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004130 if (!smp->strm)
4131 return 0;
4132
Willy Tarreau70fe9442018-11-22 16:07:39 +01004133 smp->data.type = SMP_T_SINT;
4134 smp->data.u.sint = smp->strm->task->calls ? smp->strm->task->cpu_time / smp->strm->task->calls : 0;
4135 return 1;
4136}
4137
4138/* returns the total number of nanoseconds spent processing the stream */
4139static int
4140smp_fetch_cpu_ns_tot(const struct arg *args, struct sample *smp, const char *kw, void *private)
4141{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004142 if (!smp->strm)
4143 return 0;
4144
Willy Tarreau70fe9442018-11-22 16:07:39 +01004145 smp->data.type = SMP_T_SINT;
4146 smp->data.u.sint = smp->strm->task->cpu_time;
4147 return 1;
4148}
4149
4150/* returns the average number of nanoseconds per call spent waiting for other tasks to be processed */
4151static int
4152smp_fetch_lat_ns_avg(const struct arg *args, struct sample *smp, const char *kw, void *private)
4153{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004154 if (!smp->strm)
4155 return 0;
4156
Willy Tarreau70fe9442018-11-22 16:07:39 +01004157 smp->data.type = SMP_T_SINT;
4158 smp->data.u.sint = smp->strm->task->calls ? smp->strm->task->lat_time / smp->strm->task->calls : 0;
4159 return 1;
4160}
4161
4162/* returns the total number of nanoseconds per call spent waiting for other tasks to be processed */
4163static int
4164smp_fetch_lat_ns_tot(const struct arg *args, struct sample *smp, const char *kw, void *private)
4165{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004166 if (!smp->strm)
4167 return 0;
4168
Willy Tarreau70fe9442018-11-22 16:07:39 +01004169 smp->data.type = SMP_T_SINT;
4170 smp->data.u.sint = smp->strm->task->lat_time;
4171 return 1;
4172}
4173
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004174static int smp_fetch_const_str(const struct arg *args, struct sample *smp, const char *kw, void *private)
4175{
4176 smp->flags |= SMP_F_CONST;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004177 smp->data.type = SMP_T_STR;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004178 smp->data.u.str.area = args[0].data.str.area;
4179 smp->data.u.str.data = args[0].data.str.data;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004180 return 1;
4181}
4182
4183static int smp_check_const_bool(struct arg *args, char **err)
4184{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004185 if (strcasecmp(args[0].data.str.area, "true") == 0 ||
4186 strcasecmp(args[0].data.str.area, "1") == 0) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004187 chunk_destroy(&args[0].data.str);
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004188 args[0].type = ARGT_SINT;
4189 args[0].data.sint = 1;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004190 return 1;
4191 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004192 if (strcasecmp(args[0].data.str.area, "false") == 0 ||
4193 strcasecmp(args[0].data.str.area, "0") == 0) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004194 chunk_destroy(&args[0].data.str);
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004195 args[0].type = ARGT_SINT;
4196 args[0].data.sint = 0;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004197 return 1;
4198 }
4199 memprintf(err, "Expects 'true', 'false', '0' or '1'");
4200 return 0;
4201}
4202
4203static int smp_fetch_const_bool(const struct arg *args, struct sample *smp, const char *kw, void *private)
4204{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004205 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004206 smp->data.u.sint = args[0].data.sint;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004207 return 1;
4208}
4209
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02004210static int smp_fetch_const_int(const struct arg *args, struct sample *smp, const char *kw, void *private)
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004211{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004212 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004213 smp->data.u.sint = args[0].data.sint;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004214 return 1;
4215}
4216
4217static int smp_fetch_const_ipv4(const struct arg *args, struct sample *smp, const char *kw, void *private)
4218{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004219 smp->data.type = SMP_T_IPV4;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004220 smp->data.u.ipv4 = args[0].data.ipv4;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004221 return 1;
4222}
4223
4224static int smp_fetch_const_ipv6(const struct arg *args, struct sample *smp, const char *kw, void *private)
4225{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004226 smp->data.type = SMP_T_IPV6;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004227 smp->data.u.ipv6 = args[0].data.ipv6;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004228 return 1;
4229}
4230
4231static int smp_check_const_bin(struct arg *args, char **err)
4232{
David Carlier64a16ab2016-04-08 10:37:02 +01004233 char *binstr = NULL;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004234 int binstrlen;
4235
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004236 if (!parse_binary(args[0].data.str.area, &binstr, &binstrlen, err))
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004237 return 0;
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004238 chunk_destroy(&args[0].data.str);
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004239 args[0].type = ARGT_STR;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004240 args[0].data.str.area = binstr;
4241 args[0].data.str.data = binstrlen;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004242 return 1;
4243}
4244
4245static int smp_fetch_const_bin(const struct arg *args, struct sample *smp, const char *kw, void *private)
4246{
4247 smp->flags |= SMP_F_CONST;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004248 smp->data.type = SMP_T_BIN;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004249 smp->data.u.str.area = args[0].data.str.area;
4250 smp->data.u.str.data = args[0].data.str.data;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004251 return 1;
4252}
4253
4254static int smp_check_const_meth(struct arg *args, char **err)
4255{
4256 enum http_meth_t meth;
4257 int i;
4258
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004259 meth = find_http_meth(args[0].data.str.area, args[0].data.str.data);
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004260 if (meth != HTTP_METH_OTHER) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004261 chunk_destroy(&args[0].data.str);
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004262 args[0].type = ARGT_SINT;
4263 args[0].data.sint = meth;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004264 } else {
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05004265 /* Check method avalaibility. A method is a token defined as :
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004266 * tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "." /
4267 * "^" / "_" / "`" / "|" / "~" / DIGIT / ALPHA
4268 * token = 1*tchar
4269 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004270 for (i = 0; i < args[0].data.str.data; i++) {
4271 if (!HTTP_IS_TOKEN(args[0].data.str.area[i])) {
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004272 memprintf(err, "expects valid method.");
4273 return 0;
4274 }
4275 }
4276 }
4277 return 1;
4278}
4279
4280static int smp_fetch_const_meth(const struct arg *args, struct sample *smp, const char *kw, void *private)
4281{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004282 smp->data.type = SMP_T_METH;
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004283 if (args[0].type == ARGT_SINT) {
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004284 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004285 smp->data.u.meth.meth = args[0].data.sint;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004286 smp->data.u.meth.str.area = "";
4287 smp->data.u.meth.str.data = 0;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004288 } else {
4289 smp->flags |= SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004290 smp->data.u.meth.meth = HTTP_METH_OTHER;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004291 smp->data.u.meth.str.area = args[0].data.str.area;
4292 smp->data.u.meth.str.data = args[0].data.str.data;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004293 }
4294 return 1;
4295}
4296
Luca Schimweg8a694b82019-09-10 15:42:52 +02004297// This function checks the "uuid" sample's arguments.
4298// Function won't get called when no parameter is specified (maybe a bug?)
4299static int smp_check_uuid(struct arg *args, char **err)
4300{
4301 if (!args[0].type) {
4302 args[0].type = ARGT_SINT;
4303 args[0].data.sint = 4;
4304 }
4305 else if (args[0].data.sint != 4) {
4306 memprintf(err, "Unsupported UUID version: '%lld'", args[0].data.sint);
4307 return 0;
4308 }
4309
4310 return 1;
4311}
4312
4313// Generate a RFC4122 UUID (default is v4 = fully random)
4314static int smp_fetch_uuid(const struct arg *args, struct sample *smp, const char *kw, void *private)
4315{
4316 if (args[0].data.sint == 4 || !args[0].type) {
Willy Tarreauee3bcdd2020-03-08 17:48:17 +01004317 ha_generate_uuid(&trash);
Luca Schimweg8a694b82019-09-10 15:42:52 +02004318 smp->data.type = SMP_T_STR;
4319 smp->flags = SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4320 smp->data.u.str = trash;
4321 return 1;
4322 }
4323
4324 // more implementations of other uuid formats possible here
4325 return 0;
4326}
4327
Willy Tarreau5b8ad222013-07-25 12:17:57 +02004328/* Note: must not be declared <const> as its list will be overwritten.
4329 * Note: fetches that may return multiple types must be declared as the lowest
4330 * common denominator, the type that can be casted into all other ones. For
4331 * instance IPv4/IPv6 must be declared IPv4.
4332 */
4333static struct sample_fetch_kw_list smp_kws = {ILH, {
Willy Tarreau0209c972021-03-26 12:03:11 +01004334 { "always_false", smp_fetch_false, 0, NULL, SMP_T_BOOL, SMP_USE_CONST },
4335 { "always_true", smp_fetch_true, 0, NULL, SMP_T_BOOL, SMP_USE_CONST },
4336 { "env", smp_fetch_env, ARG1(1,STR), NULL, SMP_T_STR, SMP_USE_CONST },
4337 { "date", smp_fetch_date, ARG2(0,SINT,STR), smp_check_date_unit, SMP_T_SINT, SMP_USE_CONST },
4338 { "date_us", smp_fetch_date_us, 0, NULL, SMP_T_SINT, SMP_USE_CONST },
4339 { "hostname", smp_fetch_hostname, 0, NULL, SMP_T_STR, SMP_USE_CONST },
4340 { "nbproc", smp_fetch_nbproc,0, NULL, SMP_T_SINT, SMP_USE_CONST },
4341 { "proc", smp_fetch_proc, 0, NULL, SMP_T_SINT, SMP_USE_CONST },
4342 { "thread", smp_fetch_thread, 0, NULL, SMP_T_SINT, SMP_USE_CONST },
4343 { "rand", smp_fetch_rand, ARG1(0,SINT), NULL, SMP_T_SINT, SMP_USE_CONST },
Willy Tarreau0f30d262014-11-24 16:02:05 +01004344 { "stopping", smp_fetch_stopping, 0, NULL, SMP_T_BOOL, SMP_USE_INTRN },
Willy Tarreau0209c972021-03-26 12:03:11 +01004345 { "uuid", smp_fetch_uuid, ARG1(0, SINT), smp_check_uuid, SMP_T_STR, SMP_USE_CONST },
Willy Tarreau70fe9442018-11-22 16:07:39 +01004346
4347 { "cpu_calls", smp_fetch_cpu_calls, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4348 { "cpu_ns_avg", smp_fetch_cpu_ns_avg, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4349 { "cpu_ns_tot", smp_fetch_cpu_ns_tot, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4350 { "lat_ns_avg", smp_fetch_lat_ns_avg, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4351 { "lat_ns_tot", smp_fetch_lat_ns_tot, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004352
Willy Tarreau0209c972021-03-26 12:03:11 +01004353 { "str", smp_fetch_const_str, ARG1(1,STR), NULL , SMP_T_STR, SMP_USE_CONST },
4354 { "bool", smp_fetch_const_bool, ARG1(1,STR), smp_check_const_bool, SMP_T_BOOL, SMP_USE_CONST },
4355 { "int", smp_fetch_const_int, ARG1(1,SINT), NULL , SMP_T_SINT, SMP_USE_CONST },
4356 { "ipv4", smp_fetch_const_ipv4, ARG1(1,IPV4), NULL , SMP_T_IPV4, SMP_USE_CONST },
4357 { "ipv6", smp_fetch_const_ipv6, ARG1(1,IPV6), NULL , SMP_T_IPV6, SMP_USE_CONST },
4358 { "bin", smp_fetch_const_bin, ARG1(1,STR), smp_check_const_bin , SMP_T_BIN, SMP_USE_CONST },
4359 { "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 +02004360
Willy Tarreau5b8ad222013-07-25 12:17:57 +02004361 { /* END */ },
4362}};
4363
Willy Tarreau0108d902018-11-25 19:14:37 +01004364INITCALL1(STG_REGISTER, sample_register_fetches, &smp_kws);
4365
Emeric Brun107ca302010-01-04 16:16:05 +01004366/* Note: must not be declared <const> as its list will be overwritten */
Willy Tarreaudc13c112013-06-21 23:16:39 +02004367static struct sample_conv_kw_list sample_conv_kws = {ILH, {
Moemen MHEDHBI848216f2021-04-02 01:05:07 +02004368 { "debug", sample_conv_debug, ARG2(0,STR,STR), smp_check_debug, SMP_T_ANY, SMP_T_ANY },
4369 { "b64dec", sample_conv_base642bin, 0, NULL, SMP_T_STR, SMP_T_BIN },
4370 { "base64", sample_conv_bin2base64, 0, NULL, SMP_T_BIN, SMP_T_STR },
4371 { "ub64enc", sample_conv_bin2base64url,0, NULL, SMP_T_BIN, SMP_T_STR },
4372 { "ub64dec", sample_conv_base64url2bin,0, NULL, SMP_T_STR, SMP_T_BIN },
4373 { "upper", sample_conv_str2upper, 0, NULL, SMP_T_STR, SMP_T_STR },
4374 { "lower", sample_conv_str2lower, 0, NULL, SMP_T_STR, SMP_T_STR },
4375 { "length", sample_conv_length, 0, NULL, SMP_T_STR, SMP_T_SINT },
Marcin Deranek40ca09c2021-07-13 14:05:24 +02004376 { "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 +02004377 { "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 +02004378 { "hex", sample_conv_bin2hex, 0, NULL, SMP_T_BIN, SMP_T_STR },
4379 { "hex2i", sample_conv_hex2int, 0, NULL, SMP_T_STR, SMP_T_SINT },
4380 { "ipmask", sample_conv_ipmask, ARG2(1,MSK4,MSK6), NULL, SMP_T_ADDR, SMP_T_IPV4 },
4381 { "ltime", sample_conv_ltime, ARG2(1,STR,SINT), NULL, SMP_T_SINT, SMP_T_STR },
4382 { "utime", sample_conv_utime, ARG2(1,STR,SINT), NULL, SMP_T_SINT, SMP_T_STR },
4383 { "crc32", sample_conv_crc32, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4384 { "crc32c", sample_conv_crc32c, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4385 { "djb2", sample_conv_djb2, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4386 { "sdbm", sample_conv_sdbm, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4387 { "wt6", sample_conv_wt6, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4388 { "xxh3", sample_conv_xxh3, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4389 { "xxh32", sample_conv_xxh32, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4390 { "xxh64", sample_conv_xxh64, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4391 { "json", sample_conv_json, ARG1(1,STR), sample_conv_json_check, SMP_T_STR, SMP_T_STR },
4392 { "bytes", sample_conv_bytes, ARG2(1,SINT,SINT), NULL, SMP_T_BIN, SMP_T_BIN },
4393 { "field", sample_conv_field, ARG3(2,SINT,STR,SINT), sample_conv_field_check, SMP_T_STR, SMP_T_STR },
4394 { "word", sample_conv_word, ARG3(2,SINT,STR,SINT), sample_conv_field_check, SMP_T_STR, SMP_T_STR },
4395 { "regsub", sample_conv_regsub, ARG3(2,REG,STR,STR), sample_conv_regsub_check, SMP_T_STR, SMP_T_STR },
4396 { "sha1", sample_conv_sha1, 0, NULL, SMP_T_BIN, SMP_T_BIN },
Tim Duesterhusd4376302019-06-17 12:41:44 +02004397#ifdef USE_OPENSSL
Tim Duesterhuscd373242019-12-17 12:31:20 +01004398 { "sha2", sample_conv_sha2, ARG1(0, SINT), smp_check_sha2, SMP_T_BIN, SMP_T_BIN },
Ilya Shipitsin2c481d02021-03-26 23:35:31 +05004399#ifdef EVP_CIPH_GCM_MODE
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02004400 { "aes_gcm_dec", sample_conv_aes_gcm_dec, ARG4(4,SINT,STR,STR,STR), check_aes_gcm, SMP_T_BIN, SMP_T_BIN },
4401#endif
Patrick Gansterer8e366512020-04-22 16:47:57 +02004402 { "digest", sample_conv_crypto_digest, ARG1(1,STR), check_crypto_digest, SMP_T_BIN, SMP_T_BIN },
4403 { "hmac", sample_conv_crypto_hmac, ARG2(2,STR,STR), check_crypto_hmac, SMP_T_BIN, SMP_T_BIN },
Tim Duesterhusd4376302019-06-17 12:41:44 +02004404#endif
Willy Tarreau280f42b2018-02-19 15:34:12 +01004405 { "concat", sample_conv_concat, ARG3(1,STR,STR,STR), smp_check_concat, SMP_T_STR, SMP_T_STR },
Tim Duesterhusca097c12018-04-27 21:18:45 +02004406 { "strcmp", sample_conv_strcmp, ARG1(1,STR), smp_check_strcmp, SMP_T_STR, SMP_T_SINT },
Willy Tarreau2a8a2f02021-05-09 11:59:49 +02004407#if defined(HAVE_CRYPTO_memcmp)
Tim Duesterhusf38175c2020-06-09 11:48:42 +02004408 { "secure_memcmp", sample_conv_secure_memcmp, ARG1(1,STR), smp_check_secure_memcmp, SMP_T_BIN, SMP_T_BOOL },
4409#endif
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01004410
4411 /* gRPC converters. */
Frédéric Lécaillebfe61382019-03-06 14:34:36 +01004412 { "ungrpc", sample_conv_ungrpc, ARG2(1,PBUF_FNUM,STR), sample_conv_protobuf_check, SMP_T_BIN, SMP_T_BIN },
4413 { "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 +01004414
Baptiste Assmanne138dda2020-10-22 15:39:03 +02004415 /* FIX converters */
4416 { "fix_is_valid", sample_conv_fix_is_valid, 0, NULL, SMP_T_BIN, SMP_T_BOOL },
4417 { "fix_tag_value", sample_conv_fix_tag_value, ARG1(1,STR), sample_conv_fix_value_check, SMP_T_BIN, SMP_T_BIN },
4418
Baptiste Assmanne279ca62020-10-27 18:10:06 +01004419 /* MQTT converters */
4420 { "mqtt_is_valid", sample_conv_mqtt_is_valid, 0, NULL, SMP_T_BIN, SMP_T_BOOL },
4421 { "mqtt_field_value", sample_conv_mqtt_field_value, ARG2(2,STR,STR), sample_conv_mqtt_field_value_check, SMP_T_BIN, SMP_T_STR },
4422
Tim Duesterhus3943e4f2020-09-11 14:25:23 +02004423 { "iif", sample_conv_iif, ARG2(2, STR, STR), NULL, SMP_T_BOOL, SMP_T_STR },
4424
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02004425 { "and", sample_conv_binary_and, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4426 { "or", sample_conv_binary_or, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4427 { "xor", sample_conv_binary_xor, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4428 { "cpl", sample_conv_binary_cpl, 0, NULL, SMP_T_SINT, SMP_T_SINT },
4429 { "bool", sample_conv_arith_bool, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4430 { "not", sample_conv_arith_not, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4431 { "odd", sample_conv_arith_odd, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4432 { "even", sample_conv_arith_even, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4433 { "add", sample_conv_arith_add, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4434 { "sub", sample_conv_arith_sub, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4435 { "mul", sample_conv_arith_mul, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4436 { "div", sample_conv_arith_div, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4437 { "mod", sample_conv_arith_mod, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4438 { "neg", sample_conv_arith_neg, 0, NULL, SMP_T_SINT, SMP_T_SINT },
Willy Tarreau97707872015-01-27 15:12:13 +01004439
Christopher Fauletea159d62020-04-01 16:21:44 +02004440 { "htonl", sample_conv_htonl, 0, NULL, SMP_T_SINT, SMP_T_BIN },
4441 { "cut_crlf", sample_conv_cut_crlf, 0, NULL, SMP_T_STR, SMP_T_STR },
Christopher Faulet51fc9d12020-04-01 17:24:41 +02004442 { "ltrim", sample_conv_ltrim, ARG1(1,STR), NULL, SMP_T_STR, SMP_T_STR },
Christopher Faulet568415a2020-04-01 17:24:47 +02004443 { "rtrim", sample_conv_rtrim, ARG1(1,STR), NULL, SMP_T_STR, SMP_T_STR },
Alex51c8ad42021-04-15 16:45:15 +02004444 { "json_query", sample_conv_json_query, ARG2(1,STR,STR), sample_check_json_query , SMP_T_STR, SMP_T_ANY },
Willy Tarreau9fcb9842012-04-20 14:45:49 +02004445 { NULL, NULL, 0, 0, 0 },
Emeric Brun107ca302010-01-04 16:16:05 +01004446}};
4447
Willy Tarreau0108d902018-11-25 19:14:37 +01004448INITCALL1(STG_REGISTER, sample_register_convs, &sample_conv_kws);