blob: ed95545c8e840582be5f272966d0dbd0f279b2b6 [file] [log] [blame]
Emeric Brun107ca302010-01-04 16:16:05 +01001/*
Willy Tarreaucd3b0942012-04-27 21:52:18 +02002 * Sample management functions.
Emeric Brun107ca302010-01-04 16:16:05 +01003 *
4 * Copyright 2009-2010 EXCELIANCE, Emeric Brun <ebrun@exceliance.fr>
Willy Tarreaucd3b0942012-04-27 21:52:18 +02005 * Copyright (C) 2012 Willy Tarreau <w@1wt.eu>
Emeric Brun107ca302010-01-04 16:16:05 +01006 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
Thierry FOURNIER317e1c42014-08-12 10:20:47 +020014#include <ctype.h>
Emeric Brun107ca302010-01-04 16:16:05 +010015#include <string.h>
16#include <arpa/inet.h>
Willy Tarreaudd2f85e2012-09-02 22:34:23 +020017#include <stdio.h>
Emeric Brun107ca302010-01-04 16:16:05 +010018
Alex51c8ad42021-04-15 16:45:15 +020019#include <import/mjson.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020020#include <import/sha1.h>
Willy Tarreau7e2c6472012-10-29 20:44:36 +010021
Willy Tarreaub2551052020-06-09 09:07:15 +020022#include <haproxy/api.h>
23#include <haproxy/arg.h>
Willy Tarreauac13aea2020-06-04 10:36:03 +020024#include <haproxy/auth.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020025#include <haproxy/base64.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020026#include <haproxy/buf.h>
Willy Tarreauc13ed532020-06-02 10:22:45 +020027#include <haproxy/chunk.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020028#include <haproxy/errors.h>
Baptiste Assmanne138dda2020-10-22 15:39:03 +020029#include <haproxy/fix.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020030#include <haproxy/global.h>
Willy Tarreau8d366972020-05-27 16:10:29 +020031#include <haproxy/hash.h>
Willy Tarreaucd72d8c2020-06-02 19:11:26 +020032#include <haproxy/http.h>
Baptiste Assmanne138dda2020-10-22 15:39:03 +020033#include <haproxy/istbuf.h>
Baptiste Assmanne279ca62020-10-27 18:10:06 +010034#include <haproxy/mqtt.h>
Willy Tarreau6131d6a2020-06-02 16:48:09 +020035#include <haproxy/net_helper.h>
Willy Tarreaub23e5952020-06-04 16:06:59 +020036#include <haproxy/protobuf.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020037#include <haproxy/proxy.h>
Willy Tarreau7cd8b6e2020-06-02 17:32:26 +020038#include <haproxy/regex.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020039#include <haproxy/sample.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/sink.h>
41#include <haproxy/stick_table.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020042#include <haproxy/tools.h>
Willy Tarreau8c42b8a2020-06-04 19:27:34 +020043#include <haproxy/uri_auth-t.h>
Willy Tarreaua1718922020-06-04 16:25:31 +020044#include <haproxy/vars.h>
Tim Duesterhusd5fc8fc2021-09-11 17:51:13 +020045#include <haproxy/xxhash.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.
Christopher Faulet35926a12021-09-30 08:48:56 +0200864 * <al> is an arg_list serving as a list head to report missing dependencies.
865 * It may be NULL if such dependencies are not allowed. Otherwise, the caller
866 * must have set al->ctx if al is set.
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100867 * If <endptr> is non-nul, it will be set to the first unparsed character
868 * (which may be the final '\0') on success. If it is nul, the expression
869 * must be properly terminated by a '\0' otherwise an error is reported.
Emeric Brun107ca302010-01-04 16:16:05 +0100870 */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100871struct 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 +0100872{
Willy Tarreau833cc792013-07-24 15:34:19 +0200873 const char *begw; /* beginning of word */
874 const char *endw; /* end of word */
875 const char *endt; /* end of term */
Remi Tricot-Le Breton22e0d9b2021-01-12 14:55:12 +0100876 struct sample_expr *expr = NULL;
Willy Tarreau12785782012-04-27 21:37:17 +0200877 struct sample_fetch *fetch;
878 struct sample_conv *conv;
Emeric Brun107ca302010-01-04 16:16:05 +0100879 unsigned long prev_type;
Willy Tarreau833cc792013-07-24 15:34:19 +0200880 char *fkw = NULL;
881 char *ckw = NULL;
Willy Tarreau689a1df2013-12-13 00:40:11 +0100882 int err_arg;
Emeric Brun107ca302010-01-04 16:16:05 +0100883
Willy Tarreau833cc792013-07-24 15:34:19 +0200884 begw = str[*idx];
Willy Tarreaued2c6622020-02-14 18:27:10 +0100885 for (endw = begw; is_idchar(*endw); endw++)
886 ;
Willy Tarreau833cc792013-07-24 15:34:19 +0200887
888 if (endw == begw) {
Willy Tarreau975c1782013-12-12 23:16:54 +0100889 memprintf(err_msg, "missing fetch method");
Emeric Brun107ca302010-01-04 16:16:05 +0100890 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +0200891 }
Emeric Brun107ca302010-01-04 16:16:05 +0100892
Willy Tarreau833cc792013-07-24 15:34:19 +0200893 /* keep a copy of the current fetch keyword for error reporting */
894 fkw = my_strndup(begw, endw - begw);
Emeric Brun107ca302010-01-04 16:16:05 +0100895
Willy Tarreau833cc792013-07-24 15:34:19 +0200896 fetch = find_sample_fetch(begw, endw - begw);
897 if (!fetch) {
Willy Tarreau975c1782013-12-12 23:16:54 +0100898 memprintf(err_msg, "unknown fetch method '%s'", fkw);
Emeric Brun107ca302010-01-04 16:16:05 +0100899 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +0200900 }
Emeric Brun107ca302010-01-04 16:16:05 +0100901
Willy Tarreau833cc792013-07-24 15:34:19 +0200902 /* At this point, we have :
903 * - begw : beginning of the keyword
Willy Tarreau689a1df2013-12-13 00:40:11 +0100904 * - endw : end of the keyword, first character not part of keyword
Willy Tarreau833cc792013-07-24 15:34:19 +0200905 */
906
907 if (fetch->out_type >= SMP_TYPES) {
Willy Tarreau975c1782013-12-12 23:16:54 +0100908 memprintf(err_msg, "returns type of fetch method '%s' is unknown", fkw);
Emeric Brun107ca302010-01-04 16:16:05 +0100909 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +0200910 }
Emeric Brun107ca302010-01-04 16:16:05 +0100911 prev_type = fetch->out_type;
Willy Tarreau833cc792013-07-24 15:34:19 +0200912
Vincent Bernat02779b62016-04-03 13:48:43 +0200913 expr = calloc(1, sizeof(*expr));
Emeric Brun485479d2010-09-23 18:02:19 +0200914 if (!expr)
915 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +0100916
917 LIST_INIT(&(expr->conv_exprs));
918 expr->fetch = fetch;
Willy Tarreau2e845be2012-10-19 19:49:09 +0200919 expr->arg_p = empty_arg_list;
Emeric Brun107ca302010-01-04 16:16:05 +0100920
Willy Tarreau689a1df2013-12-13 00:40:11 +0100921 /* Note that we call the argument parser even with an empty string,
922 * this allows it to automatically create entries for mandatory
923 * implicit arguments (eg: local proxy name).
924 */
Christopher Faulet35926a12021-09-30 08:48:56 +0200925 if (al) {
926 al->kw = expr->fetch->kw;
927 al->conv = NULL;
928 }
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100929 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 +0100930 memprintf(err_msg, "fetch method '%s' : %s", fkw, *err_msg);
931 goto out_error;
932 }
Willy Tarreau2e845be2012-10-19 19:49:09 +0200933
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100934 /* now endt is our first char not part of the arg list, typically the
935 * comma after the sample fetch name or after the closing parenthesis,
936 * or the NUL char.
937 */
938
Willy Tarreau689a1df2013-12-13 00:40:11 +0100939 if (!expr->arg_p) {
940 expr->arg_p = empty_arg_list;
Emeric Brun485479d2010-09-23 18:02:19 +0200941 }
Willy Tarreau689a1df2013-12-13 00:40:11 +0100942 else if (fetch->val_args && !fetch->val_args(expr->arg_p, err_msg)) {
943 memprintf(err_msg, "invalid args in fetch method '%s' : %s", fkw, *err_msg);
Emeric Brun485479d2010-09-23 18:02:19 +0200944 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +0100945 }
946
Willy Tarreau833cc792013-07-24 15:34:19 +0200947 /* Now process the converters if any. We have two supported syntaxes
948 * for the converters, which can be combined :
949 * - comma-delimited list of converters just after the keyword and args ;
950 * - one converter per keyword
951 * The combination allows to have each keyword being a comma-delimited
952 * series of converters.
953 *
954 * We want to process the former first, then the latter. For this we start
955 * from the beginning of the supposed place in the exiting conv chain, which
956 * starts at the last comma (endt).
957 */
958
959 while (1) {
Willy Tarreau12785782012-04-27 21:37:17 +0200960 struct sample_conv_expr *conv_expr;
Willy Tarreau46dfd782019-12-17 10:25:29 +0100961 int err_arg;
962 int argcnt;
Emeric Brun107ca302010-01-04 16:16:05 +0100963
Willy Tarreau833cc792013-07-24 15:34:19 +0200964 if (*endt && *endt != ',') {
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100965 if (endptr) {
966 /* end found, let's stop here */
967 break;
968 }
Willy Tarreau833cc792013-07-24 15:34:19 +0200969 if (ckw)
Willy Tarreau97108e02016-11-25 07:33:24 +0100970 memprintf(err_msg, "missing comma after converter '%s'", ckw);
Willy Tarreau833cc792013-07-24 15:34:19 +0200971 else
Willy Tarreau975c1782013-12-12 23:16:54 +0100972 memprintf(err_msg, "missing comma after fetch keyword '%s'", fkw);
Emeric Brun107ca302010-01-04 16:16:05 +0100973 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +0200974 }
Emeric Brun107ca302010-01-04 16:16:05 +0100975
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100976 /* FIXME: how long should we support such idiocies ? Maybe we
977 * should already warn ?
978 */
Willy Tarreau833cc792013-07-24 15:34:19 +0200979 while (*endt == ',') /* then trailing commas */
980 endt++;
981
Willy Tarreau97108e02016-11-25 07:33:24 +0100982 begw = endt; /* start of converter */
Willy Tarreau833cc792013-07-24 15:34:19 +0200983
984 if (!*begw) {
985 /* none ? skip to next string */
986 (*idx)++;
987 begw = str[*idx];
988 if (!begw || !*begw)
989 break;
990 }
991
Willy Tarreaued2c6622020-02-14 18:27:10 +0100992 for (endw = begw; is_idchar(*endw); endw++)
993 ;
Willy Tarreau833cc792013-07-24 15:34:19 +0200994
995 free(ckw);
996 ckw = my_strndup(begw, endw - begw);
997
998 conv = find_sample_conv(begw, endw - begw);
999 if (!conv) {
1000 /* we found an isolated keyword that we don't know, it's not ours */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +01001001 if (begw == str[*idx]) {
1002 endt = begw;
Willy Tarreau833cc792013-07-24 15:34:19 +02001003 break;
Willy Tarreaue3b57bf2020-02-14 16:50:14 +01001004 }
Willy Tarreau97108e02016-11-25 07:33:24 +01001005 memprintf(err_msg, "unknown converter '%s'", ckw);
Willy Tarreau833cc792013-07-24 15:34:19 +02001006 goto out_error;
1007 }
Emeric Brun107ca302010-01-04 16:16:05 +01001008
Willy Tarreau833cc792013-07-24 15:34:19 +02001009 if (conv->in_type >= SMP_TYPES || conv->out_type >= SMP_TYPES) {
Willy Tarreau97108e02016-11-25 07:33:24 +01001010 memprintf(err_msg, "returns type of converter '%s' is unknown", ckw);
Emeric Brun107ca302010-01-04 16:16:05 +01001011 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +02001012 }
Emeric Brun107ca302010-01-04 16:16:05 +01001013
1014 /* If impossible type conversion */
Willy Tarreau12785782012-04-27 21:37:17 +02001015 if (!sample_casts[prev_type][conv->in_type]) {
Willy Tarreau97108e02016-11-25 07:33:24 +01001016 memprintf(err_msg, "converter '%s' cannot be applied", ckw);
Emeric Brun107ca302010-01-04 16:16:05 +01001017 goto out_error;
Emeric Brun485479d2010-09-23 18:02:19 +02001018 }
Emeric Brun107ca302010-01-04 16:16:05 +01001019
1020 prev_type = conv->out_type;
Vincent Bernat02779b62016-04-03 13:48:43 +02001021 conv_expr = calloc(1, sizeof(*conv_expr));
Emeric Brun485479d2010-09-23 18:02:19 +02001022 if (!conv_expr)
1023 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +01001024
Willy Tarreau2b718102021-04-21 07:32:39 +02001025 LIST_APPEND(&(expr->conv_exprs), &(conv_expr->list));
Emeric Brun107ca302010-01-04 16:16:05 +01001026 conv_expr->conv = conv;
1027
Christopher Faulet35926a12021-09-30 08:48:56 +02001028 if (al) {
1029 al->kw = expr->fetch->kw;
1030 al->conv = conv_expr->conv->kw;
1031 }
Willy Tarreau80b53ff2020-02-14 08:40:37 +01001032 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 +01001033 if (argcnt < 0) {
1034 memprintf(err_msg, "invalid arg %d in converter '%s' : %s", err_arg+1, ckw, *err_msg);
1035 goto out_error;
1036 }
Willy Tarreau9e92d322010-01-26 17:58:06 +01001037
Willy Tarreau46dfd782019-12-17 10:25:29 +01001038 if (argcnt && !conv->arg_mask) {
1039 memprintf(err_msg, "converter '%s' does not support any args", ckw);
1040 goto out_error;
1041 }
Willy Tarreau21d68a62012-04-20 15:52:36 +02001042
Willy Tarreau46dfd782019-12-17 10:25:29 +01001043 if (!conv_expr->arg_p)
1044 conv_expr->arg_p = empty_arg_list;
Willy Tarreau2e845be2012-10-19 19:49:09 +02001045
Willy Tarreau46dfd782019-12-17 10:25:29 +01001046 if (conv->val_args && !conv->val_args(conv_expr->arg_p, conv, file, line, err_msg)) {
1047 memprintf(err_msg, "invalid args in converter '%s' : %s", ckw, *err_msg);
Emeric Brun485479d2010-09-23 18:02:19 +02001048 goto out_error;
Emeric Brun107ca302010-01-04 16:16:05 +01001049 }
1050 }
Emeric Brun485479d2010-09-23 18:02:19 +02001051
Willy Tarreaue3b57bf2020-02-14 16:50:14 +01001052 if (endptr) {
1053 /* end found, let's stop here */
1054 *endptr = (char *)endt;
1055 }
1056
Willy Tarreau833cc792013-07-24 15:34:19 +02001057 out:
1058 free(fkw);
1059 free(ckw);
Emeric Brun107ca302010-01-04 16:16:05 +01001060 return expr;
1061
1062out_error:
Remi Tricot-Le Breton22e0d9b2021-01-12 14:55:12 +01001063 release_sample_expr(expr);
Willy Tarreau833cc792013-07-24 15:34:19 +02001064 expr = NULL;
1065 goto out;
Emeric Brun107ca302010-01-04 16:16:05 +01001066}
1067
1068/*
Willy Tarreau12785782012-04-27 21:37:17 +02001069 * Process a fetch + format conversion of defined by the sample expression <expr>
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001070 * on request or response considering the <opt> parameter.
Willy Tarreau12785782012-04-27 21:37:17 +02001071 * Returns a pointer on a typed sample structure containing the result or NULL if
1072 * sample is not found or when format conversion failed.
Emeric Brun107ca302010-01-04 16:16:05 +01001073 * If <p> is not null, function returns results in structure pointed by <p>.
Willy Tarreau12785782012-04-27 21:37:17 +02001074 * If <p> is null, functions returns a pointer on a static sample structure.
Willy Tarreaub8c8f1f2012-04-23 22:38:26 +02001075 *
1076 * Note: the fetch functions are required to properly set the return type. The
1077 * conversion functions must do so too. However the cast functions do not need
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05001078 * to since they're made to cast multiple types according to what is required.
Willy Tarreau6bcb0a82014-07-30 08:56:35 +02001079 *
1080 * The caller may indicate in <opt> if it considers the result final or not.
1081 * The caller needs to check the SMP_F_MAY_CHANGE flag in p->flags to verify
1082 * if the result is stable or not, according to the following table :
1083 *
1084 * return MAY_CHANGE FINAL Meaning for the sample
1085 * NULL 0 * Not present and will never be (eg: header)
1086 * NULL 1 0 Not present yet, could change (eg: POST param)
1087 * NULL 1 1 Not present yet, will not change anymore
1088 * smp 0 * Present and will not change (eg: header)
1089 * smp 1 0 Present, may change (eg: request length)
1090 * smp 1 1 Present, last known value (eg: request length)
Emeric Brun107ca302010-01-04 16:16:05 +01001091 */
Willy Tarreau192252e2015-04-04 01:47:55 +02001092struct sample *sample_process(struct proxy *px, struct session *sess,
1093 struct stream *strm, unsigned int opt,
Willy Tarreau12785782012-04-27 21:37:17 +02001094 struct sample_expr *expr, struct sample *p)
Emeric Brun107ca302010-01-04 16:16:05 +01001095{
Willy Tarreau12785782012-04-27 21:37:17 +02001096 struct sample_conv_expr *conv_expr;
Emeric Brun107ca302010-01-04 16:16:05 +01001097
Willy Tarreau18387e22013-07-25 12:02:38 +02001098 if (p == NULL) {
Willy Tarreaub4a88f02012-04-23 21:35:11 +02001099 p = &temp_smp;
Willy Tarreau6c616e02014-06-25 16:56:41 +02001100 memset(p, 0, sizeof(*p));
Willy Tarreau18387e22013-07-25 12:02:38 +02001101 }
Emeric Brun107ca302010-01-04 16:16:05 +01001102
Willy Tarreau1777ea62016-03-10 16:15:46 +01001103 smp_set_owner(p, px, sess, strm, opt);
Thierry FOURNIER0786d052015-05-11 15:42:45 +02001104 if (!expr->fetch->process(expr->arg_p, p, expr->fetch->kw, expr->fetch->private))
Emeric Brun107ca302010-01-04 16:16:05 +01001105 return NULL;
1106
Emeric Brun107ca302010-01-04 16:16:05 +01001107 list_for_each_entry(conv_expr, &expr->conv_exprs, list) {
Willy Tarreau12e50112012-04-25 17:21:49 +02001108 /* we want to ensure that p->type can be casted into
1109 * conv_expr->conv->in_type. We have 3 possibilities :
1110 * - NULL => not castable.
1111 * - c_none => nothing to do (let's optimize it)
1112 * - other => apply cast and prepare to fail
1113 */
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001114 if (!sample_casts[p->data.type][conv_expr->conv->in_type])
Willy Tarreau12e50112012-04-25 17:21:49 +02001115 return NULL;
1116
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001117 if (sample_casts[p->data.type][conv_expr->conv->in_type] != c_none &&
1118 !sample_casts[p->data.type][conv_expr->conv->in_type](p))
Emeric Brun107ca302010-01-04 16:16:05 +01001119 return NULL;
1120
Willy Tarreau12e50112012-04-25 17:21:49 +02001121 /* OK cast succeeded */
1122
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02001123 if (!conv_expr->conv->process(conv_expr->arg_p, p, conv_expr->conv->private))
Emeric Brun107ca302010-01-04 16:16:05 +01001124 return NULL;
Emeric Brun107ca302010-01-04 16:16:05 +01001125 }
1126 return p;
1127}
1128
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001129/*
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001130 * Resolve all remaining arguments in proxy <p>. Returns the number of
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001131 * errors or 0 if everything is fine. If at least one error is met, it will
1132 * be appended to *err. If *err==NULL it will be allocated first.
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001133 */
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001134int smp_resolve_args(struct proxy *p, char **err)
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001135{
1136 struct arg_list *cur, *bak;
1137 const char *ctx, *where;
1138 const char *conv_ctx, *conv_pre, *conv_pos;
1139 struct userlist *ul;
Willy Tarreau46947782015-01-19 19:00:58 +01001140 struct my_regex *reg;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001141 struct arg *arg;
1142 int cfgerr = 0;
Willy Tarreau46947782015-01-19 19:00:58 +01001143 int rflags;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001144
1145 list_for_each_entry_safe(cur, bak, &p->conf.args.list, list) {
1146 struct proxy *px;
1147 struct server *srv;
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001148 struct stktable *t;
1149 char *pname, *sname, *stktname;
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001150 char *err2;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001151
1152 arg = cur->arg;
1153
1154 /* prepare output messages */
1155 conv_pre = conv_pos = conv_ctx = "";
1156 if (cur->conv) {
1157 conv_ctx = cur->conv;
1158 conv_pre = "conversion keyword '";
1159 conv_pos = "' for ";
1160 }
1161
1162 where = "in";
1163 ctx = "sample fetch keyword";
1164 switch (cur->ctx) {
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001165 case ARGC_STK: where = "in stick rule in"; break;
1166 case ARGC_TRK: where = "in tracking rule in"; break;
1167 case ARGC_LOG: where = "in log-format string in"; break;
1168 case ARGC_LOGSD: where = "in log-format-sd string in"; break;
Willy Tarreau57467b82021-09-02 19:43:20 +02001169 case ARGC_HRQ: where = "in http-request expression in"; break;
1170 case ARGC_HRS: where = "in http-response response in"; break;
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001171 case ARGC_UIF: where = "in unique-id-format string in"; break;
1172 case ARGC_RDR: where = "in redirect format string in"; break;
1173 case ARGC_CAP: where = "in capture rule in"; break;
1174 case ARGC_ACL: ctx = "ACL keyword"; break;
1175 case ARGC_SRV: where = "in server directive in"; break;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001176 case ARGC_SPOE: where = "in spoe-message directive in"; break;
Christopher Faulet3b967c12020-05-15 15:47:44 +02001177 case ARGC_HERR: where = "in http-error directive in"; break;
Miroslav Zagorac7f8314c2020-12-09 16:31:48 +01001178 case ARGC_OT: where = "in ot-scope directive in"; break;
Willy Tarreau57467b82021-09-02 19:43:20 +02001179 case ARGC_TCO: where = "in tcp-request connection expression in"; break;
1180 case ARGC_TSE: where = "in tcp-request session expression in"; break;
1181 case ARGC_TRQ: where = "in tcp-request content expression in"; break;
1182 case ARGC_TRS: where = "in tcp-response content expression in"; break;
1183 case ARGC_TCK: where = "in tcp-check expression in"; break;
1184 case ARGC_CFG: where = "in configuration expression in"; break;
1185 case ARGC_CLI: where = "in CLI expression in"; break;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001186 }
1187
1188 /* set a few default settings */
1189 px = p;
1190 pname = p->id;
1191
1192 switch (arg->type) {
1193 case ARGT_SRV:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001194 if (!arg->data.str.data) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001195 memprintf(err, "%sparsing [%s:%d]: missing server name in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1196 *err ? *err : "", cur->file, cur->line,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001197 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001198 cfgerr++;
1199 continue;
1200 }
1201
1202 /* we support two formats : "bck/srv" and "srv" */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001203 sname = strrchr(arg->data.str.area, '/');
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001204
1205 if (sname) {
1206 *sname++ = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001207 pname = arg->data.str.area;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001208
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001209 px = proxy_be_by_name(pname);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001210 if (!px) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001211 memprintf(err, "%sparsing [%s:%d]: unable to find proxy '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1212 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001213 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001214 cfgerr++;
1215 break;
1216 }
1217 }
1218 else
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001219 sname = arg->data.str.area;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001220
1221 srv = findserver(px, sname);
1222 if (!srv) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001223 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",
1224 *err ? *err : "", cur->file, cur->line, sname, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001225 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001226 cfgerr++;
1227 break;
1228 }
1229
Amaury Denoyelle06269612021-08-23 14:05:07 +02001230 srv->flags |= SRV_F_NON_PURGEABLE;
1231
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001232 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001233 arg->unresolved = 0;
1234 arg->data.srv = srv;
1235 break;
1236
1237 case ARGT_FE:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001238 if (arg->data.str.data) {
1239 pname = arg->data.str.area;
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001240 px = proxy_fe_by_name(pname);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001241 }
1242
1243 if (!px) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001244 memprintf(err, "%sparsing [%s:%d]: unable to find frontend '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1245 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001246 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001247 cfgerr++;
1248 break;
1249 }
1250
1251 if (!(px->cap & PR_CAP_FE)) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001252 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",
1253 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001254 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001255 cfgerr++;
1256 break;
1257 }
1258
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001259 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001260 arg->unresolved = 0;
1261 arg->data.prx = px;
1262 break;
1263
1264 case ARGT_BE:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001265 if (arg->data.str.data) {
1266 pname = arg->data.str.area;
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001267 px = proxy_be_by_name(pname);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001268 }
1269
1270 if (!px) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001271 memprintf(err, "%sparsing [%s:%d]: unable to find backend '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1272 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001273 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001274 cfgerr++;
1275 break;
1276 }
1277
1278 if (!(px->cap & PR_CAP_BE)) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001279 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",
1280 *err ? *err : "", cur->file, cur->line, pname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001281 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001282 cfgerr++;
1283 break;
1284 }
1285
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001286 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001287 arg->unresolved = 0;
1288 arg->data.prx = px;
1289 break;
1290
1291 case ARGT_TAB:
Frédéric Lécaille9417f452019-06-20 09:31:04 +02001292 if (arg->data.str.data)
1293 stktname = arg->data.str.area;
1294 else
1295 stktname = px->id;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001296
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001297 t = stktable_find_by_name(stktname);
1298 if (!t) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001299 memprintf(err, "%sparsing [%s:%d]: unable to find table '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1300 *err ? *err : "", cur->file, cur->line, stktname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001301 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001302 cfgerr++;
1303 break;
1304 }
1305
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001306 if (!t->size) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001307 memprintf(err, "%sparsing [%s:%d]: no table in proxy '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1308 *err ? *err : "", cur->file, cur->line, stktname,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001309 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001310 cfgerr++;
1311 break;
1312 }
1313
Frédéric Lécaillebe367932019-08-07 09:28:39 +02001314 if (!in_proxies_list(t->proxies_list, p)) {
Frédéric Lécaille015e4d72019-03-19 14:55:01 +01001315 p->next_stkt_ref = t->proxies_list;
1316 t->proxies_list = p;
1317 }
1318
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001319 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001320 arg->unresolved = 0;
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001321 arg->data.t = t;
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001322 break;
1323
1324 case ARGT_USR:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001325 if (!arg->data.str.data) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001326 memprintf(err, "%sparsing [%s:%d]: missing userlist name in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1327 *err ? *err : "", cur->file, cur->line,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001328 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001329 cfgerr++;
1330 break;
1331 }
1332
1333 if (p->uri_auth && p->uri_auth->userlist &&
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001334 strcmp(p->uri_auth->userlist->name, arg->data.str.area) == 0)
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001335 ul = p->uri_auth->userlist;
1336 else
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001337 ul = auth_find_userlist(arg->data.str.area);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001338
1339 if (!ul) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001340 memprintf(err, "%sparsing [%s:%d]: unable to find userlist '%s' referenced in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1341 *err ? *err : "", cur->file, cur->line,
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001342 arg->data.str.area,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001343 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001344 cfgerr++;
1345 break;
1346 }
1347
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001348 chunk_destroy(&arg->data.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001349 arg->unresolved = 0;
1350 arg->data.usr = ul;
1351 break;
Willy Tarreau46947782015-01-19 19:00:58 +01001352
1353 case ARGT_REG:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001354 if (!arg->data.str.data) {
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001355 memprintf(err, "%sparsing [%s:%d]: missing regex in arg %d of %s%s%s%s '%s' %s proxy '%s'.\n",
1356 *err ? *err : "", cur->file, cur->line,
Christopher Faulet767a84b2017-11-24 16:50:31 +01001357 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id);
Willy Tarreau46947782015-01-19 19:00:58 +01001358 cfgerr++;
1359 continue;
1360 }
1361
Willy Tarreau46947782015-01-19 19:00:58 +01001362 rflags = 0;
1363 rflags |= (arg->type_flags & ARGF_REG_ICASE) ? REG_ICASE : 0;
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001364 err2 = NULL;
Willy Tarreau46947782015-01-19 19:00:58 +01001365
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001366 if (!(reg = regex_comp(arg->data.str.area, !(rflags & REG_ICASE), 1 /* capture substr */, &err2))) {
1367 memprintf(err, "%sparsing [%s:%d]: error in regex '%s' in arg %d of %s%s%s%s '%s' %s proxy '%s' : %s.\n",
1368 *err ? *err : "", cur->file, cur->line,
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001369 arg->data.str.area,
Willy Tarreau77e6a4e2021-03-26 16:11:55 +01001370 cur->arg_pos + 1, conv_pre, conv_ctx, conv_pos, ctx, cur->kw, where, p->id, err2);
Willy Tarreau46947782015-01-19 19:00:58 +01001371 cfgerr++;
1372 continue;
1373 }
1374
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001375 chunk_destroy(&arg->data.str);
Willy Tarreau46947782015-01-19 19:00:58 +01001376 arg->unresolved = 0;
1377 arg->data.reg = reg;
1378 break;
1379
1380
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001381 }
1382
Willy Tarreau2b718102021-04-21 07:32:39 +02001383 LIST_DELETE(&cur->list);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001384 free(cur);
1385 } /* end of args processing */
1386
1387 return cfgerr;
1388}
1389
1390/*
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001391 * Process a fetch + format conversion as defined by the sample expression
1392 * <expr> on request or response considering the <opt> parameter. The output is
Adis Nezirovic79beb242015-07-06 15:41:02 +02001393 * not explicitly set to <smp_type>, but shall be compatible with it as
1394 * specified by 'sample_casts' table. If a stable sample can be fetched, or an
1395 * unstable one when <opt> contains SMP_OPT_FINAL, the sample is converted and
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001396 * returned without the SMP_F_MAY_CHANGE flag. If an unstable sample is found
1397 * and <opt> does not contain SMP_OPT_FINAL, then the sample is returned as-is
1398 * with its SMP_F_MAY_CHANGE flag so that the caller can check it and decide to
1399 * take actions (eg: wait longer). If a sample could not be found or could not
Willy Tarreau6bcb0a82014-07-30 08:56:35 +02001400 * be converted, NULL is returned. The caller MUST NOT use the sample if the
1401 * SMP_F_MAY_CHANGE flag is present, as it is used only as a hint that there is
1402 * still hope to get it after waiting longer, and is not converted to string.
1403 * The possible output combinations are the following :
1404 *
1405 * return MAY_CHANGE FINAL Meaning for the sample
1406 * NULL * * Not present and will never be (eg: header)
1407 * smp 0 * Final value converted (eg: header)
1408 * smp 1 0 Not present yet, may appear later (eg: header)
1409 * smp 1 1 never happens (either flag is cleared on output)
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001410 */
Adis Nezirovic79beb242015-07-06 15:41:02 +02001411struct sample *sample_fetch_as_type(struct proxy *px, struct session *sess,
Willy Tarreau192252e2015-04-04 01:47:55 +02001412 struct stream *strm, unsigned int opt,
Adis Nezirovic79beb242015-07-06 15:41:02 +02001413 struct sample_expr *expr, int smp_type)
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001414{
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001415 struct sample *smp = &temp_smp;
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001416
Willy Tarreau6c616e02014-06-25 16:56:41 +02001417 memset(smp, 0, sizeof(*smp));
1418
Willy Tarreau192252e2015-04-04 01:47:55 +02001419 if (!sample_process(px, sess, strm, opt, expr, smp)) {
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001420 if ((smp->flags & SMP_F_MAY_CHANGE) && !(opt & SMP_OPT_FINAL))
1421 return smp;
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001422 return NULL;
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001423 }
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001424
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001425 if (!sample_casts[smp->data.type][smp_type])
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001426 return NULL;
1427
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001428 if (!sample_casts[smp->data.type][smp_type](smp))
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001429 return NULL;
1430
Willy Tarreau5b4bf702014-06-13 16:04:35 +02001431 smp->flags &= ~SMP_F_MAY_CHANGE;
Willy Tarreaue7ad4bb2012-12-21 00:02:32 +01001432 return smp;
1433}
1434
Christopher Faulet476e5d02016-10-26 11:34:47 +02001435static void release_sample_arg(struct arg *p)
1436{
1437 struct arg *p_back = p;
1438
1439 if (!p)
1440 return;
1441
1442 while (p->type != ARGT_STOP) {
1443 if (p->type == ARGT_STR || p->unresolved) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001444 chunk_destroy(&p->data.str);
Christopher Faulet476e5d02016-10-26 11:34:47 +02001445 p->unresolved = 0;
1446 }
1447 else if (p->type == ARGT_REG) {
Dragan Dosen26743032019-04-30 15:54:36 +02001448 regex_free(p->data.reg);
1449 p->data.reg = NULL;
Christopher Faulet476e5d02016-10-26 11:34:47 +02001450 }
1451 p++;
1452 }
1453
1454 if (p_back != empty_arg_list)
1455 free(p_back);
1456}
1457
1458void release_sample_expr(struct sample_expr *expr)
1459{
1460 struct sample_conv_expr *conv_expr, *conv_exprb;
1461
1462 if (!expr)
1463 return;
1464
Tim Duesterhus867cd982020-07-04 11:49:39 +02001465 list_for_each_entry_safe(conv_expr, conv_exprb, &expr->conv_exprs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001466 LIST_DELETE(&conv_expr->list);
Christopher Faulet476e5d02016-10-26 11:34:47 +02001467 release_sample_arg(conv_expr->arg_p);
Tim Duesterhus867cd982020-07-04 11:49:39 +02001468 free(conv_expr);
1469 }
1470
Christopher Faulet476e5d02016-10-26 11:34:47 +02001471 release_sample_arg(expr->arg_p);
1472 free(expr);
1473}
1474
Emeric Brun107ca302010-01-04 16:16:05 +01001475/*****************************************************************/
Willy Tarreau12785782012-04-27 21:37:17 +02001476/* Sample format convert functions */
Willy Tarreaub8c8f1f2012-04-23 22:38:26 +02001477/* These functions set the data type on return. */
Emeric Brun107ca302010-01-04 16:16:05 +01001478/*****************************************************************/
1479
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001480static int sample_conv_debug(const struct arg *arg_p, struct sample *smp, void *private)
1481{
1482 int i;
1483 struct sample tmp;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001484 struct buffer *buf;
1485 struct sink *sink;
1486 struct ist line;
1487 char *pfx;
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001488
Willy Tarreau0851fd52019-12-17 10:07:25 +01001489 buf = alloc_trash_chunk();
1490 if (!buf)
1491 goto end;
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001492
Christopher Fauletb45bf8e2020-08-07 14:00:23 +02001493 sink = (struct sink *)arg_p[1].data.ptr;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001494 BUG_ON(!sink);
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001495
Willy Tarreau0851fd52019-12-17 10:07:25 +01001496 pfx = arg_p[0].data.str.area;
1497 BUG_ON(!pfx);
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001498
Willy Tarreau0851fd52019-12-17 10:07:25 +01001499 chunk_printf(buf, "[debug] %s: type=%s ", pfx, smp_to_type[smp->data.type]);
1500 if (!sample_casts[smp->data.type][SMP_T_STR])
1501 goto nocast;
1502
1503 /* Copy sample fetch. This puts the sample as const, the
1504 * cast will copy data if a transformation is required.
1505 */
1506 memcpy(&tmp, smp, sizeof(struct sample));
1507 tmp.flags = SMP_F_CONST;
1508
1509 if (!sample_casts[smp->data.type][SMP_T_STR](&tmp))
1510 goto nocast;
1511
1512 /* Display the displayable chars*. */
1513 b_putchr(buf, '<');
1514 for (i = 0; i < tmp.data.u.str.data; i++) {
Willy Tarreau90807112020-02-25 08:16:33 +01001515 if (isprint((unsigned char)tmp.data.u.str.area[i]))
Willy Tarreau0851fd52019-12-17 10:07:25 +01001516 b_putchr(buf, tmp.data.u.str.area[i]);
1517 else
1518 b_putchr(buf, '.');
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001519 }
Willy Tarreau0851fd52019-12-17 10:07:25 +01001520 b_putchr(buf, '>');
1521
1522 done:
1523 line = ist2(buf->area, buf->data);
Emeric Brun54648852020-07-06 15:54:06 +02001524 sink_write(sink, &line, 1, 0, 0, NULL);
Willy Tarreau0851fd52019-12-17 10:07:25 +01001525 end:
1526 free_trash_chunk(buf);
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001527 return 1;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001528 nocast:
1529 chunk_appendf(buf, "(undisplayable)");
1530 goto done;
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001531}
Willy Tarreau0851fd52019-12-17 10:07:25 +01001532
1533// This function checks the "debug" converter's arguments.
1534static int smp_check_debug(struct arg *args, struct sample_conv *conv,
1535 const char *file, int line, char **err)
1536{
1537 const char *name = "buf0";
1538 struct sink *sink = NULL;
1539
1540 if (args[0].type != ARGT_STR) {
1541 /* optional prefix */
1542 args[0].data.str.area = "";
1543 args[0].data.str.data = 0;
1544 }
1545
1546 if (args[1].type == ARGT_STR)
1547 name = args[1].data.str.area;
1548
1549 sink = sink_find(name);
1550 if (!sink) {
1551 memprintf(err, "No such sink '%s'", name);
1552 return 0;
1553 }
1554
Christopher Faulet6ad7df42020-08-07 11:45:18 +02001555 chunk_destroy(&args[1].data.str);
Christopher Fauletb45bf8e2020-08-07 14:00:23 +02001556 args[1].type = ARGT_PTR;
1557 args[1].data.ptr = sink;
Willy Tarreau0851fd52019-12-17 10:07:25 +01001558 return 1;
1559}
Thierry FOURNIER9687c772015-05-07 15:46:29 +02001560
Holger Just1bfc24b2017-05-06 00:56:53 +02001561static int sample_conv_base642bin(const struct arg *arg_p, struct sample *smp, void *private)
1562{
Willy Tarreau83061a82018-07-13 11:56:34 +02001563 struct buffer *trash = get_trash_chunk();
Holger Just1bfc24b2017-05-06 00:56:53 +02001564 int bin_len;
1565
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001566 trash->data = 0;
1567 bin_len = base64dec(smp->data.u.str.area, smp->data.u.str.data,
1568 trash->area, trash->size);
Holger Just1bfc24b2017-05-06 00:56:53 +02001569 if (bin_len < 0)
1570 return 0;
1571
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001572 trash->data = bin_len;
Holger Just1bfc24b2017-05-06 00:56:53 +02001573 smp->data.u.str = *trash;
1574 smp->data.type = SMP_T_BIN;
1575 smp->flags &= ~SMP_F_CONST;
1576 return 1;
1577}
1578
Moemen MHEDHBI92f7d432021-04-01 20:53:59 +02001579static int sample_conv_base64url2bin(const struct arg *arg_p, struct sample *smp, void *private)
1580{
1581 struct buffer *trash = get_trash_chunk();
1582 int bin_len;
1583
1584 trash->data = 0;
1585 bin_len = base64urldec(smp->data.u.str.area, smp->data.u.str.data,
1586 trash->area, trash->size);
1587 if (bin_len < 0)
1588 return 0;
1589
1590 trash->data = bin_len;
1591 smp->data.u.str = *trash;
1592 smp->data.type = SMP_T_BIN;
1593 smp->flags &= ~SMP_F_CONST;
1594 return 1;
1595}
1596
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02001597static int sample_conv_bin2base64(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun53d1a982014-04-30 18:21:37 +02001598{
Willy Tarreau83061a82018-07-13 11:56:34 +02001599 struct buffer *trash = get_trash_chunk();
Emeric Brun53d1a982014-04-30 18:21:37 +02001600 int b64_len;
1601
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001602 trash->data = 0;
1603 b64_len = a2base64(smp->data.u.str.area, smp->data.u.str.data,
1604 trash->area, trash->size);
Emeric Brun53d1a982014-04-30 18:21:37 +02001605 if (b64_len < 0)
1606 return 0;
1607
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001608 trash->data = b64_len;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02001609 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001610 smp->data.type = SMP_T_STR;
Emeric Brun53d1a982014-04-30 18:21:37 +02001611 smp->flags &= ~SMP_F_CONST;
1612 return 1;
1613}
1614
Moemen MHEDHBI92f7d432021-04-01 20:53:59 +02001615static int sample_conv_bin2base64url(const struct arg *arg_p, struct sample *smp, void *private)
1616{
1617 struct buffer *trash = get_trash_chunk();
1618 int b64_len;
1619
1620 trash->data = 0;
1621 b64_len = a2base64url(smp->data.u.str.area, smp->data.u.str.data,
1622 trash->area, trash->size);
1623 if (b64_len < 0)
1624 return 0;
1625
1626 trash->data = b64_len;
1627 smp->data.u.str = *trash;
1628 smp->data.type = SMP_T_STR;
1629 smp->flags &= ~SMP_F_CONST;
1630 return 1;
1631}
1632
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001633static int sample_conv_sha1(const struct arg *arg_p, struct sample *smp, void *private)
1634{
1635 blk_SHA_CTX ctx;
Willy Tarreau83061a82018-07-13 11:56:34 +02001636 struct buffer *trash = get_trash_chunk();
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001637
1638 memset(&ctx, 0, sizeof(ctx));
1639
1640 blk_SHA1_Init(&ctx);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001641 blk_SHA1_Update(&ctx, smp->data.u.str.area, smp->data.u.str.data);
1642 blk_SHA1_Final((unsigned char *) trash->area, &ctx);
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001643
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001644 trash->data = 20;
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +02001645 smp->data.u.str = *trash;
1646 smp->data.type = SMP_T_BIN;
1647 smp->flags &= ~SMP_F_CONST;
1648 return 1;
1649}
1650
Tim Duesterhusd4376302019-06-17 12:41:44 +02001651#ifdef USE_OPENSSL
Tim Duesterhuscd373242019-12-17 12:31:20 +01001652static int smp_check_sha2(struct arg *args, struct sample_conv *conv,
1653 const char *file, int line, char **err)
1654{
1655 if (args[0].type == ARGT_STOP)
1656 return 1;
1657 if (args[0].type != ARGT_SINT) {
1658 memprintf(err, "Invalid type '%s'", arg_type_names[args[0].type]);
1659 return 0;
1660 }
1661
1662 switch (args[0].data.sint) {
1663 case 224:
1664 case 256:
1665 case 384:
1666 case 512:
1667 /* this is okay */
1668 return 1;
1669 default:
1670 memprintf(err, "Unsupported number of bits: '%lld'", args[0].data.sint);
1671 return 0;
1672 }
1673}
1674
Tim Duesterhusd4376302019-06-17 12:41:44 +02001675static int sample_conv_sha2(const struct arg *arg_p, struct sample *smp, void *private)
1676{
1677 struct buffer *trash = get_trash_chunk();
1678 int bits = 256;
Christopher Faulete6e7a582021-01-29 11:29:28 +01001679 if (arg_p->data.sint)
Tim Duesterhusd4376302019-06-17 12:41:44 +02001680 bits = arg_p->data.sint;
1681
1682 switch (bits) {
1683 case 224: {
1684 SHA256_CTX ctx;
1685
1686 memset(&ctx, 0, sizeof(ctx));
1687
1688 SHA224_Init(&ctx);
1689 SHA224_Update(&ctx, smp->data.u.str.area, smp->data.u.str.data);
1690 SHA224_Final((unsigned char *) trash->area, &ctx);
1691 trash->data = SHA224_DIGEST_LENGTH;
1692 break;
1693 }
1694 case 256: {
1695 SHA256_CTX ctx;
1696
1697 memset(&ctx, 0, sizeof(ctx));
1698
1699 SHA256_Init(&ctx);
1700 SHA256_Update(&ctx, smp->data.u.str.area, smp->data.u.str.data);
1701 SHA256_Final((unsigned char *) trash->area, &ctx);
1702 trash->data = SHA256_DIGEST_LENGTH;
1703 break;
1704 }
1705 case 384: {
1706 SHA512_CTX ctx;
1707
1708 memset(&ctx, 0, sizeof(ctx));
1709
1710 SHA384_Init(&ctx);
1711 SHA384_Update(&ctx, smp->data.u.str.area, smp->data.u.str.data);
1712 SHA384_Final((unsigned char *) trash->area, &ctx);
1713 trash->data = SHA384_DIGEST_LENGTH;
1714 break;
1715 }
1716 case 512: {
1717 SHA512_CTX ctx;
1718
1719 memset(&ctx, 0, sizeof(ctx));
1720
1721 SHA512_Init(&ctx);
1722 SHA512_Update(&ctx, smp->data.u.str.area, smp->data.u.str.data);
1723 SHA512_Final((unsigned char *) trash->area, &ctx);
1724 trash->data = SHA512_DIGEST_LENGTH;
1725 break;
1726 }
1727 default:
1728 return 0;
1729 }
1730
1731 smp->data.u.str = *trash;
1732 smp->data.type = SMP_T_BIN;
1733 smp->flags &= ~SMP_F_CONST;
1734 return 1;
1735}
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001736
Dragan Dosen9e8db132021-02-22 10:03:53 +01001737/* This function returns a sample struct filled with an <arg> content.
1738 * If the <arg> contains a string, it is returned in the sample flagged as
1739 * SMP_F_CONST. If the <arg> contains a variable descriptor, the sample is
1740 * filled with the content of the variable by using vars_get_by_desc().
1741 *
1742 * Keep in mind that the sample content may be written to a pre-allocated
1743 * trash chunk as returned by get_trash_chunk().
1744 *
1745 * This function returns 0 if an error occurs, otherwise it returns 1.
1746 */
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001747static inline int sample_conv_var2smp_str(const struct arg *arg, struct sample *smp)
1748{
1749 switch (arg->type) {
1750 case ARGT_STR:
1751 smp->data.type = SMP_T_STR;
1752 smp->data.u.str = arg->data.str;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001753 smp->flags = SMP_F_CONST;
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001754 return 1;
1755 case ARGT_VAR:
Willy Tarreaue352b9d2021-09-03 11:52:38 +02001756 if (!vars_get_by_desc(&arg->data.var, smp, NULL))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001757 return 0;
1758 if (!sample_casts[smp->data.type][SMP_T_STR])
1759 return 0;
1760 if (!sample_casts[smp->data.type][SMP_T_STR](smp))
1761 return 0;
1762 return 1;
1763 default:
1764 return 0;
1765 }
1766}
1767
Dragan Dosen9e8db132021-02-22 10:03:53 +01001768/* This function checks an <arg> and fills it with a variable type if the
1769 * <arg> string contains a valid variable name. If failed, the function
1770 * tries to perform a base64 decode operation on the same string, and
1771 * fills the <arg> with the decoded content.
1772 *
1773 * Validation is skipped if the <arg> string is empty.
1774 *
1775 * This function returns 0 if the variable lookup fails and the specified
1776 * <arg> string is not a valid base64 encoded string, as well if
1777 * unexpected argument type is specified or memory allocation error
1778 * occurs. Otherwise it returns 1.
1779 */
1780static inline int sample_check_arg_base64(struct arg *arg, char **err)
1781{
1782 char *dec = NULL;
1783 int dec_size;
1784
1785 if (arg->type != ARGT_STR) {
1786 memprintf(err, "unexpected argument type");
1787 return 0;
1788 }
1789
1790 if (arg->data.str.data == 0) /* empty */
1791 return 1;
1792
1793 if (vars_check_arg(arg, NULL))
1794 return 1;
1795
1796 if (arg->data.str.data % 4) {
1797 memprintf(err, "argument needs to be base64 encoded, and "
1798 "can either be a string or a variable");
1799 return 0;
1800 }
1801
1802 dec_size = (arg->data.str.data / 4 * 3)
1803 - (arg->data.str.area[arg->data.str.data-1] == '=' ? 1 : 0)
1804 - (arg->data.str.area[arg->data.str.data-2] == '=' ? 1 : 0);
1805
1806 if ((dec = malloc(dec_size)) == NULL) {
1807 memprintf(err, "memory allocation error");
1808 return 0;
1809 }
1810
1811 dec_size = base64dec(arg->data.str.area, arg->data.str.data, dec, dec_size);
1812 if (dec_size < 0) {
1813 memprintf(err, "argument needs to be base64 encoded, and "
1814 "can either be a string or a variable");
1815 free(dec);
1816 return 0;
1817 }
1818
1819 /* base64 decoded */
1820 chunk_destroy(&arg->data.str);
1821 arg->data.str.area = dec;
1822 arg->data.str.data = dec_size;
1823 return 1;
1824}
1825
Ilya Shipitsin2c481d02021-03-26 23:35:31 +05001826#ifdef EVP_CIPH_GCM_MODE
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001827static int check_aes_gcm(struct arg *args, struct sample_conv *conv,
1828 const char *file, int line, char **err)
1829{
1830 switch(args[0].data.sint) {
1831 case 128:
1832 case 192:
1833 case 256:
1834 break;
1835 default:
1836 memprintf(err, "key size must be 128, 192 or 256 (bits).");
1837 return 0;
1838 }
Dragan Dosen9e8db132021-02-22 10:03:53 +01001839
1840 /* Try to decode variables. */
1841 if (!sample_check_arg_base64(&args[1], err)) {
1842 memprintf(err, "failed to parse nonce : %s", *err);
1843 return 0;
1844 }
1845 if (!sample_check_arg_base64(&args[2], err)) {
1846 memprintf(err, "failed to parse key : %s", *err);
1847 return 0;
1848 }
1849 if (!sample_check_arg_base64(&args[3], err)) {
1850 memprintf(err, "failed to parse aead_tag : %s", *err);
1851 return 0;
1852 }
1853
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001854 return 1;
1855}
1856
1857/* Arguments: AES size in bits, nonce, key, tag. The last three arguments are base64 encoded */
1858static int sample_conv_aes_gcm_dec(const struct arg *arg_p, struct sample *smp, void *private)
1859{
1860 struct sample nonce, key, aead_tag;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001861 struct buffer *smp_trash = NULL, *smp_trash_alloc = NULL;
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001862 EVP_CIPHER_CTX *ctx;
1863 int dec_size, ret;
1864
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001865 smp_trash_alloc = alloc_trash_chunk();
1866 if (!smp_trash_alloc)
1867 return 0;
1868
Dragan Dosen9e8db132021-02-22 10:03:53 +01001869 /* smp copy */
1870 smp_trash_alloc->data = smp->data.u.str.data;
1871 if (unlikely(smp_trash_alloc->data > smp_trash_alloc->size))
1872 smp_trash_alloc->data = smp_trash_alloc->size;
1873 memcpy(smp_trash_alloc->area, smp->data.u.str.area, smp_trash_alloc->data);
1874
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001875 ctx = EVP_CIPHER_CTX_new();
1876
1877 if (!ctx)
1878 goto err;
1879
Dragan Dosen9e8db132021-02-22 10:03:53 +01001880 smp_trash = alloc_trash_chunk();
1881 if (!smp_trash)
1882 goto err;
1883
1884 smp_set_owner(&nonce, smp->px, smp->sess, smp->strm, smp->opt);
1885 if (!sample_conv_var2smp_str(&arg_p[1], &nonce))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001886 goto err;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001887
1888 if (arg_p[1].type == ARGT_VAR) {
1889 dec_size = base64dec(nonce.data.u.str.area, nonce.data.u.str.data, smp_trash->area, smp_trash->size);
1890 if (dec_size < 0)
1891 goto err;
1892 smp_trash->data = dec_size;
1893 nonce.data.u.str = *smp_trash;
1894 }
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001895
1896 /* Set cipher type and mode */
1897 switch(arg_p[0].data.sint) {
1898 case 128:
1899 EVP_DecryptInit_ex(ctx, EVP_aes_128_gcm(), NULL, NULL, NULL);
1900 break;
1901 case 192:
1902 EVP_DecryptInit_ex(ctx, EVP_aes_192_gcm(), NULL, NULL, NULL);
1903 break;
1904 case 256:
1905 EVP_DecryptInit_ex(ctx, EVP_aes_256_gcm(), NULL, NULL, NULL);
1906 break;
1907 }
1908
Dragan Dosen9e8db132021-02-22 10:03:53 +01001909 EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, nonce.data.u.str.data, NULL);
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001910
1911 /* Initialise IV */
Dragan Dosen9e8db132021-02-22 10:03:53 +01001912 if(!EVP_DecryptInit_ex(ctx, NULL, NULL, NULL, (unsigned char *) nonce.data.u.str.area))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001913 goto err;
1914
Dragan Dosen9e8db132021-02-22 10:03:53 +01001915 smp_set_owner(&key, smp->px, smp->sess, smp->strm, smp->opt);
1916 if (!sample_conv_var2smp_str(&arg_p[2], &key))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001917 goto err;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001918
1919 if (arg_p[2].type == ARGT_VAR) {
1920 dec_size = base64dec(key.data.u.str.area, key.data.u.str.data, smp_trash->area, smp_trash->size);
1921 if (dec_size < 0)
1922 goto err;
1923 smp_trash->data = dec_size;
1924 key.data.u.str = *smp_trash;
1925 }
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001926
1927 /* Initialise key */
Dragan Dosen9e8db132021-02-22 10:03:53 +01001928 if (!EVP_DecryptInit_ex(ctx, NULL, NULL, (unsigned char *) key.data.u.str.area, NULL))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001929 goto err;
1930
1931 if (!EVP_DecryptUpdate(ctx, (unsigned char *) smp_trash->area, (int *) &smp_trash->data,
Dragan Dosen9e8db132021-02-22 10:03:53 +01001932 (unsigned char *) smp_trash_alloc->area, (int) smp_trash_alloc->data))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001933 goto err;
1934
Dragan Dosen9e8db132021-02-22 10:03:53 +01001935 smp_set_owner(&aead_tag, smp->px, smp->sess, smp->strm, smp->opt);
1936 if (!sample_conv_var2smp_str(&arg_p[3], &aead_tag))
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001937 goto err;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001938
1939 if (arg_p[3].type == ARGT_VAR) {
1940 dec_size = base64dec(aead_tag.data.u.str.area, aead_tag.data.u.str.data, smp_trash_alloc->area, smp_trash_alloc->size);
1941 if (dec_size < 0)
1942 goto err;
1943 smp_trash_alloc->data = dec_size;
1944 aead_tag.data.u.str = *smp_trash_alloc;
1945 }
1946
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001947 dec_size = smp_trash->data;
1948
Dragan Dosen9e8db132021-02-22 10:03:53 +01001949 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 +02001950 ret = EVP_DecryptFinal_ex(ctx, (unsigned char *) smp_trash->area + smp_trash->data, (int *) &smp_trash->data);
1951
1952 if (ret <= 0)
1953 goto err;
1954
1955 smp->data.u.str.data = dec_size + smp_trash->data;
1956 smp->data.u.str.area = smp_trash->area;
1957 smp->data.type = SMP_T_BIN;
Dragan Dosen9e8db132021-02-22 10:03:53 +01001958 smp_dup(smp);
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001959 free_trash_chunk(smp_trash_alloc);
Dragan Dosen9e8db132021-02-22 10:03:53 +01001960 free_trash_chunk(smp_trash);
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001961 return 1;
1962
1963err:
1964 free_trash_chunk(smp_trash_alloc);
Dragan Dosen9e8db132021-02-22 10:03:53 +01001965 free_trash_chunk(smp_trash);
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001966 return 0;
1967}
Ilya Shipitsin2c481d02021-03-26 23:35:31 +05001968#endif
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02001969
Patrick Gansterer8e366512020-04-22 16:47:57 +02001970static int check_crypto_digest(struct arg *args, struct sample_conv *conv,
1971 const char *file, int line, char **err)
1972{
1973 const EVP_MD *evp = EVP_get_digestbyname(args[0].data.str.area);
1974
1975 if (evp)
1976 return 1;
1977
1978 memprintf(err, "algorithm must be a valid OpenSSL message digest name.");
1979 return 0;
1980}
1981
1982static int sample_conv_crypto_digest(const struct arg *args, struct sample *smp, void *private)
1983{
1984 struct buffer *trash = get_trash_chunk();
1985 unsigned char *md = (unsigned char*) trash->area;
1986 unsigned int md_len = trash->size;
1987 EVP_MD_CTX *ctx = EVP_MD_CTX_new();
1988 const EVP_MD *evp = EVP_get_digestbyname(args[0].data.str.area);
1989
1990 if (!ctx)
1991 return 0;
1992
1993 if (!EVP_DigestInit_ex(ctx, evp, NULL) ||
1994 !EVP_DigestUpdate(ctx, smp->data.u.str.area, smp->data.u.str.data) ||
1995 !EVP_DigestFinal_ex(ctx, md, &md_len)) {
1996 EVP_MD_CTX_free(ctx);
1997 return 0;
1998 }
1999
2000 EVP_MD_CTX_free(ctx);
2001
2002 trash->data = md_len;
2003 smp->data.u.str = *trash;
2004 smp->data.type = SMP_T_BIN;
2005 smp->flags &= ~SMP_F_CONST;
2006 return 1;
2007}
2008
2009static int check_crypto_hmac(struct arg *args, struct sample_conv *conv,
2010 const char *file, int line, char **err)
2011{
2012 if (!check_crypto_digest(args, conv, file, line, err))
2013 return 0;
Dragan Dosen9e8db132021-02-22 10:03:53 +01002014
2015 if (!sample_check_arg_base64(&args[1], err)) {
2016 memprintf(err, "failed to parse key : %s", *err);
2017 return 0;
2018 }
Patrick Gansterer8e366512020-04-22 16:47:57 +02002019
Patrick Gansterer8e366512020-04-22 16:47:57 +02002020 return 1;
2021}
2022
2023static int sample_conv_crypto_hmac(const struct arg *args, struct sample *smp, void *private)
2024{
2025 struct sample key;
Dragan Dosen9e8db132021-02-22 10:03:53 +01002026 struct buffer *trash = NULL, *key_trash = NULL;
Patrick Gansterer8e366512020-04-22 16:47:57 +02002027 unsigned char *md;
2028 unsigned int md_len;
2029 const EVP_MD *evp = EVP_get_digestbyname(args[0].data.str.area);
2030 int dec_size;
2031
2032 smp_set_owner(&key, smp->px, smp->sess, smp->strm, smp->opt);
2033 if (!sample_conv_var2smp_str(&args[1], &key))
2034 return 0;
2035
Dragan Dosen9e8db132021-02-22 10:03:53 +01002036 if (args[1].type == ARGT_VAR) {
2037 key_trash = alloc_trash_chunk();
2038 if (!key_trash)
2039 goto err;
2040
2041 dec_size = base64dec(key.data.u.str.area, key.data.u.str.data, key_trash->area, key_trash->size);
2042 if (dec_size < 0)
2043 goto err;
2044 key_trash->data = dec_size;
2045 key.data.u.str = *key_trash;
2046 }
Patrick Gansterer8e366512020-04-22 16:47:57 +02002047
Dragan Dosen9e8db132021-02-22 10:03:53 +01002048 trash = alloc_trash_chunk();
2049 if (!trash)
Patrick Gansterer8e366512020-04-22 16:47:57 +02002050 goto err;
2051
2052 md = (unsigned char*) trash->area;
2053 md_len = trash->size;
Dragan Dosen9e8db132021-02-22 10:03:53 +01002054 if (!HMAC(evp, key.data.u.str.area, key.data.u.str.data, (const unsigned char*) smp->data.u.str.area,
2055 smp->data.u.str.data, md, &md_len))
Patrick Gansterer8e366512020-04-22 16:47:57 +02002056 goto err;
2057
2058 free_trash_chunk(key_trash);
2059
2060 trash->data = md_len;
2061 smp->data.u.str = *trash;
2062 smp->data.type = SMP_T_BIN;
Dragan Dosen9e8db132021-02-22 10:03:53 +01002063 smp_dup(smp);
2064 free_trash_chunk(trash);
Patrick Gansterer8e366512020-04-22 16:47:57 +02002065 return 1;
2066
2067err:
2068 free_trash_chunk(key_trash);
Dragan Dosen9e8db132021-02-22 10:03:53 +01002069 free_trash_chunk(trash);
Patrick Gansterer8e366512020-04-22 16:47:57 +02002070 return 0;
2071}
2072
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02002073#endif /* USE_OPENSSL */
Tim Duesterhusd4376302019-06-17 12:41:44 +02002074
Marcin Deranek40ca09c2021-07-13 14:05:24 +02002075static int sample_conv_be2dec_check(struct arg *args, struct sample_conv *conv,
2076 const char *file, int line, char **err)
2077{
2078 if (args[1].data.sint <= 0 || args[1].data.sint > sizeof(unsigned long long)) {
Willy Tarreauc5d0fc92021-09-15 10:30:40 +02002079 memprintf(err, "chunk_size out of [1..%u] range (%lld)", (uint)sizeof(unsigned long long), args[1].data.sint);
Marcin Deranek40ca09c2021-07-13 14:05:24 +02002080 return 0;
2081 }
2082
2083 if (args[2].data.sint != 0 && args[2].data.sint != 1) {
2084 memprintf(err, "Unsupported truncate value (%lld)", args[2].data.sint);
2085 return 0;
2086 }
2087
2088 return 1;
2089}
2090
2091/* Converts big-endian binary input sample to a string containing an unsigned
2092 * integer number per <chunk_size> input bytes separated with <separator>.
2093 * Optional <truncate> flag indicates if input is truncated at <chunk_size>
2094 * boundaries.
2095 * Arguments: separator (string), chunk_size (integer), truncate (0,1)
2096 */
2097static int sample_conv_be2dec(const struct arg *args, struct sample *smp, void *private)
2098{
2099 struct buffer *trash = get_trash_chunk();
2100 const int last = args[2].data.sint ? smp->data.u.str.data - args[1].data.sint + 1 : smp->data.u.str.data;
2101 int max_size = trash->size - 2;
2102 int i;
2103 int start;
2104 int ptr = 0;
2105 unsigned long long number;
2106 char *pos;
2107
2108 trash->data = 0;
2109
2110 while (ptr < last && trash->data <= max_size) {
2111 start = trash->data;
2112 if (ptr) {
2113 /* Add separator */
2114 memcpy(trash->area + trash->data, args[0].data.str.area, args[0].data.str.data);
2115 trash->data += args[0].data.str.data;
2116 }
2117 else
2118 max_size -= args[0].data.str.data;
2119
2120 /* Add integer */
2121 for (number = 0, i = 0; i < args[1].data.sint && ptr < smp->data.u.str.data; i++)
2122 number = (number << 8) + (unsigned char)smp->data.u.str.area[ptr++];
2123
2124 pos = ulltoa(number, trash->area + trash->data, trash->size - trash->data);
2125 if (pos)
2126 trash->data = pos - trash->area;
2127 else {
2128 trash->data = start;
2129 break;
2130 }
2131 }
2132
2133 smp->data.u.str = *trash;
2134 smp->data.type = SMP_T_STR;
2135 smp->flags &= ~SMP_F_CONST;
2136 return 1;
2137}
2138
Marcin Deranekda0264a2021-07-13 14:08:56 +02002139static int sample_conv_be2hex_check(struct arg *args, struct sample_conv *conv,
2140 const char *file, int line, char **err)
2141{
2142 if (args[1].data.sint <= 0 && (args[0].data.str.data > 0 || args[2].data.sint != 0)) {
2143 memprintf(err, "chunk_size needs to be positive (%lld)", args[1].data.sint);
2144 return 0;
2145 }
2146
2147 if (args[2].data.sint != 0 && args[2].data.sint != 1) {
2148 memprintf(err, "Unsupported truncate value (%lld)", args[2].data.sint);
2149 return 0;
2150 }
2151
2152 return 1;
2153}
2154
2155/* Converts big-endian binary input sample to a hex string containing two hex
2156 * digits per input byte. <separator> is put every <chunk_size> binary input
2157 * bytes if specified. Optional <truncate> flag indicates if input is truncated
2158 * at <chunk_size> boundaries.
2159 * Arguments: separator (string), chunk_size (integer), truncate (0,1)
2160 */
2161static int sample_conv_be2hex(const struct arg *args, struct sample *smp, void *private)
2162{
2163 struct buffer *trash = get_trash_chunk();
2164 int chunk_size = args[1].data.sint;
2165 const int last = args[2].data.sint ? smp->data.u.str.data - chunk_size + 1 : smp->data.u.str.data;
2166 int i;
2167 int max_size;
2168 int ptr = 0;
2169 unsigned char c;
2170
2171 trash->data = 0;
2172 if (args[0].data.str.data == 0 && args[2].data.sint == 0)
2173 chunk_size = smp->data.u.str.data;
2174 max_size = trash->size - 2 * chunk_size;
2175
2176 while (ptr < last && trash->data <= max_size) {
2177 if (ptr) {
2178 /* Add separator */
2179 memcpy(trash->area + trash->data, args[0].data.str.area, args[0].data.str.data);
2180 trash->data += args[0].data.str.data;
2181 }
2182 else
2183 max_size -= args[0].data.str.data;
2184
2185 /* Add hex */
2186 for (i = 0; i < chunk_size && ptr < smp->data.u.str.data; i++) {
2187 c = smp->data.u.str.area[ptr++];
2188 trash->area[trash->data++] = hextab[(c >> 4) & 0xF];
2189 trash->area[trash->data++] = hextab[c & 0xF];
2190 }
2191 }
2192
2193 smp->data.u.str = *trash;
2194 smp->data.type = SMP_T_STR;
2195 smp->flags &= ~SMP_F_CONST;
2196 return 1;
2197}
2198
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002199static int sample_conv_bin2hex(const struct arg *arg_p, struct sample *smp, void *private)
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01002200{
Willy Tarreau83061a82018-07-13 11:56:34 +02002201 struct buffer *trash = get_trash_chunk();
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01002202 unsigned char c;
2203 int ptr = 0;
2204
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002205 trash->data = 0;
2206 while (ptr < smp->data.u.str.data && trash->data <= trash->size - 2) {
2207 c = smp->data.u.str.area[ptr++];
2208 trash->area[trash->data++] = hextab[(c >> 4) & 0xF];
2209 trash->area[trash->data++] = hextab[c & 0xF];
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01002210 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002211 smp->data.u.str = *trash;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002212 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +01002213 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +01002214 return 1;
2215}
2216
Dragan Dosen3f957b22017-10-24 09:27:34 +02002217static int sample_conv_hex2int(const struct arg *arg_p, struct sample *smp, void *private)
2218{
2219 long long int n = 0;
2220 int i, c;
2221
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002222 for (i = 0; i < smp->data.u.str.data; i++) {
2223 if ((c = hex2i(smp->data.u.str.area[i])) < 0)
Dragan Dosen3f957b22017-10-24 09:27:34 +02002224 return 0;
2225 n = (n << 4) + c;
2226 }
2227
2228 smp->data.u.sint = n;
2229 smp->data.type = SMP_T_SINT;
2230 smp->flags &= ~SMP_F_CONST;
2231 return 1;
2232}
2233
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002234/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002235static int sample_conv_djb2(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002236{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002237 smp->data.u.sint = hash_djb2(smp->data.u.str.area,
2238 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002239 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002240 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002241 smp->data.type = SMP_T_SINT;
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002242 return 1;
2243}
2244
Willy Tarreau60a2ee72017-12-15 07:13:48 +01002245static int sample_conv_length(const struct arg *arg_p, struct sample *smp, void *private)
Etienne Carriereed0d24e2017-12-13 13:41:34 +01002246{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002247 int i = smp->data.u.str.data;
Etienne Carriereed0d24e2017-12-13 13:41:34 +01002248 smp->data.u.sint = i;
2249 smp->data.type = SMP_T_SINT;
2250 return 1;
2251}
2252
2253
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002254static int sample_conv_str2lower(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun107ca302010-01-04 16:16:05 +01002255{
2256 int i;
2257
Willy Tarreauf0645dc2016-08-09 14:29:38 +02002258 if (!smp_make_rw(smp))
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +01002259 return 0;
2260
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002261 for (i = 0; i < smp->data.u.str.data; i++) {
2262 if ((smp->data.u.str.area[i] >= 'A') && (smp->data.u.str.area[i] <= 'Z'))
2263 smp->data.u.str.area[i] += 'a' - 'A';
Emeric Brun107ca302010-01-04 16:16:05 +01002264 }
2265 return 1;
2266}
2267
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002268static int sample_conv_str2upper(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun107ca302010-01-04 16:16:05 +01002269{
2270 int i;
2271
Willy Tarreauf0645dc2016-08-09 14:29:38 +02002272 if (!smp_make_rw(smp))
Emeric Brun485479d2010-09-23 18:02:19 +02002273 return 0;
2274
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002275 for (i = 0; i < smp->data.u.str.data; i++) {
2276 if ((smp->data.u.str.area[i] >= 'a') && (smp->data.u.str.area[i] <= 'z'))
2277 smp->data.u.str.area[i] += 'A' - 'a';
Emeric Brun107ca302010-01-04 16:16:05 +01002278 }
2279 return 1;
2280}
2281
Tim Duesterhus1478aa72018-01-25 16:24:51 +01002282/* takes the IPv4 mask in args[0] and an optional IPv6 mask in args[1] */
2283static int sample_conv_ipmask(const struct arg *args, struct sample *smp, void *private)
Willy Tarreaud31d6eb2010-01-26 18:01:41 +01002284{
Tim Duesterhus1478aa72018-01-25 16:24:51 +01002285 /* Attempt to convert to IPv4 to apply the correct mask. */
2286 c_ipv62ip(smp);
2287
2288 if (smp->data.type == SMP_T_IPV4) {
2289 smp->data.u.ipv4.s_addr &= args[0].data.ipv4.s_addr;
2290 smp->data.type = SMP_T_IPV4;
2291 }
2292 else if (smp->data.type == SMP_T_IPV6) {
2293 /* IPv6 cannot be converted without an IPv6 mask. */
2294 if (args[1].type != ARGT_IPV6)
2295 return 0;
2296
Willy Tarreaua8b7ecd2020-02-25 09:43:22 +01002297 write_u64(&smp->data.u.ipv6.s6_addr[0],
2298 read_u64(&smp->data.u.ipv6.s6_addr[0]) & read_u64(&args[1].data.ipv6.s6_addr[0]));
2299 write_u64(&smp->data.u.ipv6.s6_addr[8],
2300 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 +01002301 smp->data.type = SMP_T_IPV6;
2302 }
2303
Willy Tarreaud31d6eb2010-01-26 18:01:41 +01002304 return 1;
2305}
2306
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002307/* takes an UINT value on input supposed to represent the time since EPOCH,
2308 * adds an optional offset found in args[1] and emits a string representing
2309 * the local time in the format specified in args[1] using strftime().
2310 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002311static int sample_conv_ltime(const struct arg *args, struct sample *smp, void *private)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002312{
Willy Tarreau83061a82018-07-13 11:56:34 +02002313 struct buffer *temp;
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002314 /* With high numbers, the date returned can be negative, the 55 bits mask prevent this. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002315 time_t curr_date = smp->data.u.sint & 0x007fffffffffffffLL;
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002316 struct tm tm;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002317
2318 /* add offset */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002319 if (args[1].type == ARGT_SINT)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002320 curr_date += args[1].data.sint;
2321
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002322 get_localtime(curr_date, &tm);
2323
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002324 temp = get_trash_chunk();
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002325 temp->data = strftime(temp->area, temp->size, args[0].data.str.area, &tm);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002326 smp->data.u.str = *temp;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002327 smp->data.type = SMP_T_STR;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002328 return 1;
2329}
2330
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002331/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002332static int sample_conv_sdbm(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002333{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002334 smp->data.u.sint = hash_sdbm(smp->data.u.str.area,
2335 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002336 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002337 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002338 smp->data.type = SMP_T_SINT;
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002339 return 1;
2340}
2341
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002342/* takes an UINT value on input supposed to represent the time since EPOCH,
2343 * adds an optional offset found in args[1] and emits a string representing
2344 * the UTC date in the format specified in args[1] using strftime().
2345 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002346static int sample_conv_utime(const struct arg *args, struct sample *smp, void *private)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002347{
Willy Tarreau83061a82018-07-13 11:56:34 +02002348 struct buffer *temp;
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002349 /* With high numbers, the date returned can be negative, the 55 bits mask prevent this. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002350 time_t curr_date = smp->data.u.sint & 0x007fffffffffffffLL;
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002351 struct tm tm;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002352
2353 /* add offset */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002354 if (args[1].type == ARGT_SINT)
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002355 curr_date += args[1].data.sint;
2356
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002357 get_gmtime(curr_date, &tm);
2358
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002359 temp = get_trash_chunk();
Tim Duesterhus1f269c12021-08-28 23:57:01 +02002360 temp->data = strftime(temp->area, temp->size, args[0].data.str.area, &tm);
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002361 smp->data.u.str = *temp;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002362 smp->data.type = SMP_T_STR;
Willy Tarreau0dbfdba2014-07-10 16:37:47 +02002363 return 1;
2364}
2365
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002366/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002367static int sample_conv_wt6(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002368{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002369 smp->data.u.sint = hash_wt6(smp->data.u.str.area,
2370 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002371 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002372 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002373 smp->data.type = SMP_T_SINT;
Willy Tarreau23ec4ca2014-07-15 20:15:37 +02002374 return 1;
2375}
2376
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002377/* hashes the binary input into a 32-bit unsigned int using xxh.
2378 * The seed of the hash defaults to 0 but can be changd in argument 1.
2379 */
2380static int sample_conv_xxh32(const struct arg *arg_p, struct sample *smp, void *private)
2381{
2382 unsigned int seed;
2383
Christopher Faulete6e7a582021-01-29 11:29:28 +01002384 if (arg_p->data.sint)
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002385 seed = arg_p->data.sint;
2386 else
2387 seed = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002388 smp->data.u.sint = XXH32(smp->data.u.str.area, smp->data.u.str.data,
2389 seed);
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002390 smp->data.type = SMP_T_SINT;
2391 return 1;
2392}
2393
2394/* hashes the binary input into a 64-bit unsigned int using xxh.
2395 * In fact, the function returns a 64 bit unsigned, but the sample
2396 * storage of haproxy only proposes 64-bits signed, so the value is
2397 * cast as signed. This cast doesn't impact the hash repartition.
2398 * The seed of the hash defaults to 0 but can be changd in argument 1.
2399 */
2400static int sample_conv_xxh64(const struct arg *arg_p, struct sample *smp, void *private)
2401{
2402 unsigned long long int seed;
2403
Christopher Faulete6e7a582021-01-29 11:29:28 +01002404 if (arg_p->data.sint)
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002405 seed = (unsigned long long int)arg_p->data.sint;
2406 else
2407 seed = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002408 smp->data.u.sint = (long long int)XXH64(smp->data.u.str.area,
2409 smp->data.u.str.data, seed);
Thierry FOURNIER01e09742016-12-26 11:46:11 +01002410 smp->data.type = SMP_T_SINT;
2411 return 1;
2412}
2413
Dragan Dosen04bf0cc2020-12-22 21:44:33 +01002414static int sample_conv_xxh3(const struct arg *arg_p, struct sample *smp, void *private)
2415{
2416 unsigned long long int seed;
2417
Christopher Faulete6e7a582021-01-29 11:29:28 +01002418 if (arg_p->data.sint)
Dragan Dosen04bf0cc2020-12-22 21:44:33 +01002419 seed = (unsigned long long int)arg_p->data.sint;
2420 else
2421 seed = 0;
2422 smp->data.u.sint = (long long int)XXH3(smp->data.u.str.area,
2423 smp->data.u.str.data, seed);
2424 smp->data.type = SMP_T_SINT;
2425 return 1;
2426}
2427
Willy Tarreau80599772015-01-20 19:35:24 +01002428/* hashes the binary input into a 32-bit unsigned int */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002429static int sample_conv_crc32(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau80599772015-01-20 19:35:24 +01002430{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002431 smp->data.u.sint = hash_crc32(smp->data.u.str.area,
2432 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002433 if (arg_p->data.sint)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002434 smp->data.u.sint = full_hash(smp->data.u.sint);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002435 smp->data.type = SMP_T_SINT;
Willy Tarreau80599772015-01-20 19:35:24 +01002436 return 1;
2437}
2438
Emmanuel Hocdet50791a72018-03-21 11:19:01 +01002439/* hashes the binary input into crc32c (RFC4960, Appendix B [8].) */
2440static int sample_conv_crc32c(const struct arg *arg_p, struct sample *smp, void *private)
2441{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002442 smp->data.u.sint = hash_crc32c(smp->data.u.str.area,
2443 smp->data.u.str.data);
Christopher Faulete6e7a582021-01-29 11:29:28 +01002444 if (arg_p->data.sint)
Emmanuel Hocdet50791a72018-03-21 11:19:01 +01002445 smp->data.u.sint = full_hash(smp->data.u.sint);
2446 smp->data.type = SMP_T_SINT;
2447 return 1;
2448}
2449
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002450/* This function escape special json characters. The returned string can be
2451 * safely set between two '"' and used as json string. The json string is
2452 * defined like this:
2453 *
2454 * any Unicode character except '"' or '\' or control character
2455 * \", \\, \/, \b, \f, \n, \r, \t, \u + four-hex-digits
2456 *
2457 * The enum input_type contain all the allowed mode for decoding the input
2458 * string.
2459 */
2460enum input_type {
2461 IT_ASCII = 0,
2462 IT_UTF8,
2463 IT_UTF8S,
2464 IT_UTF8P,
2465 IT_UTF8PS,
2466};
William Dauchy5417e892021-01-08 21:57:41 +01002467
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002468static int sample_conv_json_check(struct arg *arg, struct sample_conv *conv,
2469 const char *file, int line, char **err)
2470{
Christopher Faulet95917132020-08-05 23:07:07 +02002471 enum input_type type;
2472
Christopher Faulet95917132020-08-05 23:07:07 +02002473 if (strcmp(arg->data.str.area, "") == 0)
2474 type = IT_ASCII;
2475 else if (strcmp(arg->data.str.area, "ascii") == 0)
2476 type = IT_ASCII;
2477 else if (strcmp(arg->data.str.area, "utf8") == 0)
2478 type = IT_UTF8;
2479 else if (strcmp(arg->data.str.area, "utf8s") == 0)
2480 type = IT_UTF8S;
2481 else if (strcmp(arg->data.str.area, "utf8p") == 0)
2482 type = IT_UTF8P;
2483 else if (strcmp(arg->data.str.area, "utf8ps") == 0)
2484 type = IT_UTF8PS;
2485 else {
2486 memprintf(err, "Unexpected input code type. "
2487 "Allowed value are 'ascii', 'utf8', 'utf8s', 'utf8p' and 'utf8ps'");
2488 return 0;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002489 }
2490
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002491 chunk_destroy(&arg->data.str);
Christopher Faulet95917132020-08-05 23:07:07 +02002492 arg->type = ARGT_SINT;
2493 arg->data.sint = type;
2494 return 1;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002495}
2496
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002497static int sample_conv_json(const struct arg *arg_p, struct sample *smp, void *private)
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002498{
Willy Tarreau83061a82018-07-13 11:56:34 +02002499 struct buffer *temp;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002500 char _str[7]; /* \u + 4 hex digit + null char for sprintf. */
2501 const char *str;
2502 int len;
2503 enum input_type input_type = IT_ASCII;
2504 unsigned int c;
2505 unsigned int ret;
2506 char *p;
2507
Christopher Faulete6e7a582021-01-29 11:29:28 +01002508 input_type = arg_p->data.sint;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002509
2510 temp = get_trash_chunk();
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002511 temp->data = 0;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002512
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002513 p = smp->data.u.str.area;
2514 while (p < smp->data.u.str.area + smp->data.u.str.data) {
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002515
2516 if (input_type == IT_ASCII) {
2517 /* Read input as ASCII. */
2518 c = *(unsigned char *)p;
2519 p++;
2520 }
2521 else {
2522 /* Read input as UTF8. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002523 ret = utf8_next(p,
2524 smp->data.u.str.data - ( p - smp->data.u.str.area),
2525 &c);
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002526 p += utf8_return_length(ret);
2527
2528 if (input_type == IT_UTF8 && utf8_return_code(ret) != UTF8_CODE_OK)
2529 return 0;
2530 if (input_type == IT_UTF8S && utf8_return_code(ret) != UTF8_CODE_OK)
2531 continue;
2532 if (input_type == IT_UTF8P && utf8_return_code(ret) & (UTF8_CODE_INVRANGE|UTF8_CODE_BADSEQ))
2533 return 0;
2534 if (input_type == IT_UTF8PS && utf8_return_code(ret) & (UTF8_CODE_INVRANGE|UTF8_CODE_BADSEQ))
2535 continue;
2536
2537 /* Check too big values. */
2538 if ((unsigned int)c > 0xffff) {
2539 if (input_type == IT_UTF8 || input_type == IT_UTF8P)
2540 return 0;
2541 continue;
2542 }
2543 }
2544
2545 /* Convert character. */
2546 if (c == '"') {
2547 len = 2;
2548 str = "\\\"";
2549 }
2550 else if (c == '\\') {
2551 len = 2;
2552 str = "\\\\";
2553 }
2554 else if (c == '/') {
2555 len = 2;
2556 str = "\\/";
2557 }
2558 else if (c == '\b') {
2559 len = 2;
2560 str = "\\b";
2561 }
2562 else if (c == '\f') {
2563 len = 2;
2564 str = "\\f";
2565 }
2566 else if (c == '\r') {
2567 len = 2;
2568 str = "\\r";
2569 }
2570 else if (c == '\n') {
2571 len = 2;
2572 str = "\\n";
2573 }
2574 else if (c == '\t') {
2575 len = 2;
2576 str = "\\t";
2577 }
Willy Tarreau90807112020-02-25 08:16:33 +01002578 else if (c > 0xff || !isprint((unsigned char)c)) {
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002579 /* isprint generate a segfault if c is too big. The man says that
2580 * c must have the value of an unsigned char or EOF.
2581 */
2582 len = 6;
2583 _str[0] = '\\';
2584 _str[1] = 'u';
2585 snprintf(&_str[2], 5, "%04x", (unsigned short)c);
2586 str = _str;
2587 }
2588 else {
2589 len = 1;
Willy Tarreau5715da22020-02-25 08:37:37 +01002590 _str[0] = c;
2591 str = _str;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002592 }
2593
2594 /* Check length */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002595 if (temp->data + len > temp->size)
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002596 return 0;
2597
2598 /* Copy string. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002599 memcpy(temp->area + temp->data, str, len);
2600 temp->data += len;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002601 }
2602
2603 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002604 smp->data.u.str = *temp;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002605 smp->data.type = SMP_T_STR;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02002606
2607 return 1;
2608}
2609
Emeric Brun54c4ac82014-11-03 15:32:43 +01002610/* This sample function is designed to extract some bytes from an input buffer.
2611 * First arg is the offset.
2612 * Optional second arg is the length to truncate */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002613static int sample_conv_bytes(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brun54c4ac82014-11-03 15:32:43 +01002614{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002615 if (smp->data.u.str.data <= arg_p[0].data.sint) {
2616 smp->data.u.str.data = 0;
Emeric Brun54c4ac82014-11-03 15:32:43 +01002617 return 1;
2618 }
2619
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002620 if (smp->data.u.str.size)
2621 smp->data.u.str.size -= arg_p[0].data.sint;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002622 smp->data.u.str.data -= arg_p[0].data.sint;
2623 smp->data.u.str.area += arg_p[0].data.sint;
Emeric Brun54c4ac82014-11-03 15:32:43 +01002624
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002625 if ((arg_p[1].type == ARGT_SINT) && (arg_p[1].data.sint < smp->data.u.str.data))
2626 smp->data.u.str.data = arg_p[1].data.sint;
Emeric Brun54c4ac82014-11-03 15:32:43 +01002627
2628 return 1;
2629}
2630
Emeric Brunf399b0d2014-11-03 17:07:03 +01002631static int sample_conv_field_check(struct arg *args, struct sample_conv *conv,
2632 const char *file, int line, char **err)
2633{
2634 struct arg *arg = args;
2635
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002636 if (arg->type != ARGT_SINT) {
Emeric Brunf399b0d2014-11-03 17:07:03 +01002637 memprintf(err, "Unexpected arg type");
2638 return 0;
2639 }
2640
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002641 if (!arg->data.sint) {
Emeric Brunf399b0d2014-11-03 17:07:03 +01002642 memprintf(err, "Unexpected value 0 for index");
2643 return 0;
2644 }
2645
2646 arg++;
2647
2648 if (arg->type != ARGT_STR) {
2649 memprintf(err, "Unexpected arg type");
2650 return 0;
2651 }
2652
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002653 if (!arg->data.str.data) {
Emeric Brunf399b0d2014-11-03 17:07:03 +01002654 memprintf(err, "Empty separators list");
2655 return 0;
2656 }
2657
2658 return 1;
2659}
2660
2661/* This sample function is designed to a return selected part of a string (field).
2662 * First arg is the index of the field (start at 1)
2663 * Second arg is a char list of separators (type string)
2664 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002665static int sample_conv_field(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brunf399b0d2014-11-03 17:07:03 +01002666{
Marcin Deranek9631a282018-04-16 14:30:46 +02002667 int field;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002668 char *start, *end;
2669 int i;
Marcin Deranek9631a282018-04-16 14:30:46 +02002670 int count = (arg_p[2].type == ARGT_SINT) ? arg_p[2].data.sint : 1;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002671
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002672 if (!arg_p[0].data.sint)
Emeric Brunf399b0d2014-11-03 17:07:03 +01002673 return 0;
2674
Marcin Deranek9631a282018-04-16 14:30:46 +02002675 if (arg_p[0].data.sint < 0) {
2676 field = -1;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002677 end = start = smp->data.u.str.area + smp->data.u.str.data;
2678 while (start > smp->data.u.str.area) {
2679 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2680 if (*(start-1) == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002681 if (field == arg_p[0].data.sint) {
2682 if (count == 1)
2683 goto found;
2684 else if (count > 1)
2685 count--;
2686 } else {
2687 end = start-1;
2688 field--;
2689 }
2690 break;
2691 }
Emeric Brunf399b0d2014-11-03 17:07:03 +01002692 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002693 start--;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002694 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002695 } else {
2696 field = 1;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002697 end = start = smp->data.u.str.area;
2698 while (end - smp->data.u.str.area < smp->data.u.str.data) {
2699 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2700 if (*end == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002701 if (field == arg_p[0].data.sint) {
2702 if (count == 1)
2703 goto found;
2704 else if (count > 1)
2705 count--;
2706 } else {
2707 start = end+1;
2708 field++;
2709 }
2710 break;
2711 }
2712 }
2713 end++;
2714 }
Emeric Brunf399b0d2014-11-03 17:07:03 +01002715 }
2716
2717 /* Field not found */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002718 if (field != arg_p[0].data.sint) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002719 smp->data.u.str.data = 0;
Tim Duesterhus4381d262019-10-16 15:11:15 +02002720 return 0;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002721 }
2722found:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002723 smp->data.u.str.data = end - start;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002724 /* If ret string is len 0, no need to
2725 change pointers or to update size */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002726 if (!smp->data.u.str.data)
Emeric Brunf399b0d2014-11-03 17:07:03 +01002727 return 1;
2728
Emeric Brunf399b0d2014-11-03 17:07:03 +01002729 /* Compute remaining size if needed
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002730 Note: smp->data.u.str.size cannot be set to 0 */
2731 if (smp->data.u.str.size)
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002732 smp->data.u.str.size -= start - smp->data.u.str.area;
Emeric Brunf399b0d2014-11-03 17:07:03 +01002733
Thayne McCombsb2843052021-04-11 23:26:59 -06002734 smp->data.u.str.area = start;
2735
Emeric Brunf399b0d2014-11-03 17:07:03 +01002736 return 1;
2737}
2738
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002739/* This sample function is designed to return a word from a string.
2740 * First arg is the index of the word (start at 1)
2741 * Second arg is a char list of words separators (type string)
2742 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002743static int sample_conv_word(const struct arg *arg_p, struct sample *smp, void *private)
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002744{
Marcin Deranek9631a282018-04-16 14:30:46 +02002745 int word;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002746 char *start, *end;
2747 int i, issep, inword;
Marcin Deranek9631a282018-04-16 14:30:46 +02002748 int count = (arg_p[2].type == ARGT_SINT) ? arg_p[2].data.sint : 1;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002749
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002750 if (!arg_p[0].data.sint)
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002751 return 0;
2752
2753 word = 0;
2754 inword = 0;
Marcin Deranek9631a282018-04-16 14:30:46 +02002755 if (arg_p[0].data.sint < 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002756 end = start = smp->data.u.str.area + smp->data.u.str.data;
2757 while (start > smp->data.u.str.area) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002758 issep = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002759 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2760 if (*(start-1) == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002761 issep = 1;
2762 break;
2763 }
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002764 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002765 if (!inword) {
2766 if (!issep) {
2767 if (word != arg_p[0].data.sint) {
2768 word--;
2769 end = start;
2770 }
2771 inword = 1;
2772 }
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002773 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002774 else if (issep) {
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002775 if (word == arg_p[0].data.sint) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002776 if (count == 1)
2777 goto found;
2778 else if (count > 1)
2779 count--;
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002780 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002781 inword = 0;
2782 }
2783 start--;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002784 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002785 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002786 end = start = smp->data.u.str.area;
2787 while (end - smp->data.u.str.area < smp->data.u.str.data) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002788 issep = 0;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002789 for (i = 0 ; i < arg_p[1].data.str.data; i++) {
2790 if (*end == arg_p[1].data.str.area[i]) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002791 issep = 1;
2792 break;
2793 }
2794 }
2795 if (!inword) {
2796 if (!issep) {
2797 if (word != arg_p[0].data.sint) {
2798 word++;
2799 start = end;
2800 }
2801 inword = 1;
2802 }
2803 }
2804 else if (issep) {
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002805 if (word == arg_p[0].data.sint) {
Marcin Deranek9631a282018-04-16 14:30:46 +02002806 if (count == 1)
2807 goto found;
2808 else if (count > 1)
2809 count--;
Willy Tarreau9eb2a4a2018-04-19 10:33:28 +02002810 }
Marcin Deranek9631a282018-04-16 14:30:46 +02002811 inword = 0;
2812 }
2813 end++;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002814 }
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002815 }
2816
2817 /* Field not found */
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02002818 if (word != arg_p[0].data.sint) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002819 smp->data.u.str.data = 0;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002820 return 1;
2821 }
2822found:
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002823 smp->data.u.str.data = end - start;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002824 /* If ret string is len 0, no need to
2825 change pointers or to update size */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002826 if (!smp->data.u.str.data)
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002827 return 1;
2828
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002829 smp->data.u.str.area = start;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002830
2831 /* Compute remaining size if needed
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002832 Note: smp->data.u.str.size cannot be set to 0 */
2833 if (smp->data.u.str.size)
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002834 smp->data.u.str.size -= start - smp->data.u.str.area;
Emeric Brunc9a0f6d2014-11-25 14:09:01 +01002835
2836 return 1;
2837}
2838
Willy Tarreau7eda8492015-01-20 19:47:06 +01002839static int sample_conv_regsub_check(struct arg *args, struct sample_conv *conv,
2840 const char *file, int line, char **err)
2841{
2842 struct arg *arg = args;
2843 char *p;
2844 int len;
2845
2846 /* arg0 is a regex, it uses type_flag for ICASE and global match */
2847 arg[0].type_flags = 0;
2848
2849 if (arg[2].type != ARGT_STR)
2850 return 1;
2851
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002852 p = arg[2].data.str.area;
2853 len = arg[2].data.str.data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002854 while (len) {
2855 if (*p == 'i') {
2856 arg[0].type_flags |= ARGF_REG_ICASE;
2857 }
2858 else if (*p == 'g') {
2859 arg[0].type_flags |= ARGF_REG_GLOB;
2860 }
2861 else {
2862 memprintf(err, "invalid regex flag '%c', only 'i' and 'g' are supported", *p);
2863 return 0;
2864 }
2865 p++;
2866 len--;
2867 }
2868 return 1;
2869}
2870
2871/* This sample function is designed to do the equivalent of s/match/replace/ on
2872 * the input string. It applies a regex and restarts from the last matched
2873 * location until nothing matches anymore. First arg is the regex to apply to
2874 * the input string, second arg is the replacement expression.
2875 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02002876static int sample_conv_regsub(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau7eda8492015-01-20 19:47:06 +01002877{
2878 char *start, *end;
2879 struct my_regex *reg = arg_p[0].data.reg;
2880 regmatch_t pmatch[MAX_MATCH];
Willy Tarreau83061a82018-07-13 11:56:34 +02002881 struct buffer *trash = get_trash_chunk();
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002882 struct buffer *output;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002883 int flag, max;
2884 int found;
2885
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002886 start = smp->data.u.str.area;
2887 end = start + smp->data.u.str.data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002888
2889 flag = 0;
2890 while (1) {
2891 /* check for last round which is used to copy remaining parts
2892 * when not running in global replacement mode.
2893 */
2894 found = 0;
2895 if ((arg_p[0].type_flags & ARGF_REG_GLOB) || !(flag & REG_NOTBOL)) {
2896 /* Note: we can have start == end on empty strings or at the end */
2897 found = regex_exec_match2(reg, start, end - start, MAX_MATCH, pmatch, flag);
2898 }
2899
2900 if (!found)
2901 pmatch[0].rm_so = end - start;
2902
2903 /* copy the heading non-matching part (which may also be the tail if nothing matches) */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002904 max = trash->size - trash->data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002905 if (max && pmatch[0].rm_so > 0) {
2906 if (max > pmatch[0].rm_so)
2907 max = pmatch[0].rm_so;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002908 memcpy(trash->area + trash->data, start, max);
2909 trash->data += max;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002910 }
2911
2912 if (!found)
2913 break;
2914
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002915 output = alloc_trash_chunk();
Willy Tarreau23997da2020-02-18 14:27:44 +01002916 if (!output)
2917 break;
2918
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002919 output->data = exp_replace(output->area, output->size, start, arg_p[1].data.str.area, pmatch);
2920
Willy Tarreau7eda8492015-01-20 19:47:06 +01002921 /* replace the matching part */
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002922 max = output->size - output->data;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002923 if (max) {
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002924 if (max > output->data)
2925 max = output->data;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002926 memcpy(trash->area + trash->data,
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002927 output->area, max);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002928 trash->data += max;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002929 }
2930
Jerome Magnin07e1e3c2020-02-16 19:20:19 +01002931 free_trash_chunk(output);
2932
Willy Tarreau7eda8492015-01-20 19:47:06 +01002933 /* stop here if we're done with this string */
2934 if (start >= end)
2935 break;
2936
2937 /* We have a special case for matches of length 0 (eg: "x*y*").
2938 * These ones are considered to match in front of a character,
2939 * so we have to copy that character and skip to the next one.
2940 */
2941 if (!pmatch[0].rm_eo) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002942 if (trash->data < trash->size)
2943 trash->area[trash->data++] = start[pmatch[0].rm_eo];
Willy Tarreau7eda8492015-01-20 19:47:06 +01002944 pmatch[0].rm_eo++;
2945 }
2946
2947 start += pmatch[0].rm_eo;
2948 flag |= REG_NOTBOL;
2949 }
2950
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002951 smp->data.u.str = *trash;
Willy Tarreau7eda8492015-01-20 19:47:06 +01002952 return 1;
2953}
2954
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002955/* This function check an operator entry. It expects a string.
2956 * The string can be an integer or a variable name.
2957 */
2958static int check_operator(struct arg *args, struct sample_conv *conv,
2959 const char *file, int line, char **err)
2960{
2961 const char *str;
2962 const char *end;
Christopher Faulet95917132020-08-05 23:07:07 +02002963 long long int i;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002964
2965 /* Try to decode a variable. */
2966 if (vars_check_arg(&args[0], NULL))
2967 return 1;
2968
2969 /* Try to convert an integer */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002970 str = args[0].data.str.area;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002971 end = str + strlen(str);
Christopher Faulet95917132020-08-05 23:07:07 +02002972 i = read_int64(&str, end);
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002973 if (*str != '\0') {
2974 memprintf(err, "expects an integer or a variable name");
2975 return 0;
2976 }
Christopher Faulet95917132020-08-05 23:07:07 +02002977
Christopher Faulet6ad7df42020-08-07 11:45:18 +02002978 chunk_destroy(&args[0].data.str);
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002979 args[0].type = ARGT_SINT;
Christopher Faulet95917132020-08-05 23:07:07 +02002980 args[0].data.sint = i;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002981 return 1;
2982}
2983
Willy Tarreau6204cd92016-03-10 16:33:04 +01002984/* This function returns a sample struct filled with an arg content.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002985 * If the arg contain an integer, the integer is returned in the
2986 * sample. If the arg contains a variable descriptor, it returns the
2987 * variable value.
2988 *
2989 * This function returns 0 if an error occurs, otherwise it returns 1.
2990 */
Willy Tarreau6204cd92016-03-10 16:33:04 +01002991static inline int sample_conv_var2smp(const struct arg *arg, struct sample *smp)
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002992{
2993 switch (arg->type) {
2994 case ARGT_SINT:
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002995 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002996 smp->data.u.sint = arg->data.sint;
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02002997 return 1;
2998 case ARGT_VAR:
Willy Tarreaue352b9d2021-09-03 11:52:38 +02002999 if (!vars_get_by_desc(&arg->data.var, smp, NULL))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003000 return 0;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003001 if (!sample_casts[smp->data.type][SMP_T_SINT])
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003002 return 0;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003003 if (!sample_casts[smp->data.type][SMP_T_SINT](smp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003004 return 0;
3005 return 1;
3006 default:
3007 return 0;
3008 }
3009}
3010
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003011/* Takes a SINT on input, applies a binary twos complement and returns the SINT
Willy Tarreau97707872015-01-27 15:12:13 +01003012 * result.
3013 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003014static int sample_conv_binary_cpl(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003015{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003016 smp->data.u.sint = ~smp->data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01003017 return 1;
3018}
3019
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003020/* Takes a SINT on input, applies a binary "and" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003021 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01003022 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003023static int sample_conv_binary_and(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003024{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003025 struct sample tmp;
3026
Willy Tarreau7560dd42016-03-10 16:28:58 +01003027 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003028 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003029 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003030 smp->data.u.sint &= tmp.data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01003031 return 1;
3032}
3033
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003034/* Takes a SINT on input, applies a binary "or" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003035 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01003036 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003037static int sample_conv_binary_or(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003038{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003039 struct sample tmp;
3040
Willy Tarreau7560dd42016-03-10 16:28:58 +01003041 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003042 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003043 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003044 smp->data.u.sint |= tmp.data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01003045 return 1;
3046}
3047
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003048/* Takes a SINT on input, applies a binary "xor" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003049 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01003050 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003051static int sample_conv_binary_xor(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003052{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003053 struct sample tmp;
3054
Willy Tarreau7560dd42016-03-10 16:28:58 +01003055 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003056 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003057 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003058 smp->data.u.sint ^= tmp.data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01003059 return 1;
3060}
3061
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003062static inline long long int arith_add(long long int a, long long int b)
3063{
3064 /* Prevent overflow and makes capped calculus.
3065 * We must ensure that the check calculus doesn't
3066 * exceed the signed 64 bits limits.
3067 *
3068 * +----------+----------+
3069 * | a<0 | a>=0 |
3070 * +------+----------+----------+
3071 * | b<0 | MIN-a>b | no check |
3072 * +------+----------+----------+
3073 * | b>=0 | no check | MAX-a<b |
3074 * +------+----------+----------+
3075 */
3076 if ((a ^ b) >= 0) {
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05003077 /* signs are different. */
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003078 if (a < 0) {
3079 if (LLONG_MIN - a > b)
3080 return LLONG_MIN;
3081 }
3082 if (LLONG_MAX - a < b)
3083 return LLONG_MAX;
3084 }
3085 return a + b;
3086}
3087
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003088/* Takes a SINT on input, applies an arithmetic "add" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003089 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01003090 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003091static int sample_conv_arith_add(const struct arg *arg_p, struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003092{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003093 struct sample tmp;
3094
Willy Tarreau7560dd42016-03-10 16:28:58 +01003095 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003096 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003097 return 0;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003098 smp->data.u.sint = arith_add(smp->data.u.sint, tmp.data.u.sint);
Willy Tarreau97707872015-01-27 15:12:13 +01003099 return 1;
3100}
3101
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003102/* Takes a SINT on input, applies an arithmetic "sub" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003103 * arg_p or in the variable described in arg_p, and returns the SINT result.
Willy Tarreau97707872015-01-27 15:12:13 +01003104 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003105static int sample_conv_arith_sub(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003106 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003107{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003108 struct sample tmp;
3109
Willy Tarreau7560dd42016-03-10 16:28:58 +01003110 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003111 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003112 return 0;
3113
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003114 /* We cannot represent -LLONG_MIN because abs(LLONG_MIN) is greater
3115 * than abs(LLONG_MAX). So, the following code use LLONG_MAX in place
3116 * of -LLONG_MIN and correct the result.
3117 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003118 if (tmp.data.u.sint == LLONG_MIN) {
3119 smp->data.u.sint = arith_add(smp->data.u.sint, LLONG_MAX);
3120 if (smp->data.u.sint < LLONG_MAX)
3121 smp->data.u.sint++;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003122 return 1;
3123 }
3124
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003125 /* standard subtraction: we use the "add" function and negate
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003126 * the second operand.
3127 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003128 smp->data.u.sint = arith_add(smp->data.u.sint, -tmp.data.u.sint);
Willy Tarreau97707872015-01-27 15:12:13 +01003129 return 1;
3130}
3131
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003132/* Takes a SINT on input, applies an arithmetic "mul" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003133 * arg_p or in the variable described in arg_p, and returns the SINT result.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003134 * If the result makes an overflow, then the largest possible quantity is
3135 * returned.
Willy Tarreau97707872015-01-27 15:12:13 +01003136 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003137static int sample_conv_arith_mul(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003138 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003139{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003140 struct sample tmp;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003141 long long int c;
3142
Willy Tarreau7560dd42016-03-10 16:28:58 +01003143 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003144 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003145 return 0;
3146
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003147 /* prevent divide by 0 during the check */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003148 if (!smp->data.u.sint || !tmp.data.u.sint) {
3149 smp->data.u.sint = 0;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003150 return 1;
3151 }
3152
3153 /* The multiply between LLONG_MIN and -1 returns a
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05003154 * "floating point exception".
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003155 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003156 if (smp->data.u.sint == LLONG_MIN && tmp.data.u.sint == -1) {
3157 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003158 return 1;
3159 }
3160
3161 /* execute standard multiplication. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003162 c = smp->data.u.sint * tmp.data.u.sint;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003163
3164 /* check for overflow and makes capped multiply. */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003165 if (smp->data.u.sint != c / tmp.data.u.sint) {
3166 if ((smp->data.u.sint < 0) == (tmp.data.u.sint < 0)) {
3167 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003168 return 1;
3169 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003170 smp->data.u.sint = LLONG_MIN;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003171 return 1;
3172 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003173 smp->data.u.sint = c;
Willy Tarreau97707872015-01-27 15:12:13 +01003174 return 1;
3175}
3176
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003177/* Takes a SINT on input, applies an arithmetic "div" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003178 * arg_p or in the variable described in arg_p, and returns the SINT result.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003179 * If arg_p makes the result overflow, then the largest possible quantity is
3180 * returned.
Willy Tarreau97707872015-01-27 15:12:13 +01003181 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003182static int sample_conv_arith_div(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003183 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003184{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003185 struct sample tmp;
3186
Willy Tarreau7560dd42016-03-10 16:28:58 +01003187 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003188 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003189 return 0;
3190
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003191 if (tmp.data.u.sint) {
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003192 /* The divide between LLONG_MIN and -1 returns a
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05003193 * "floating point exception".
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003194 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003195 if (smp->data.u.sint == LLONG_MIN && tmp.data.u.sint == -1) {
3196 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003197 return 1;
3198 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003199 smp->data.u.sint /= tmp.data.u.sint;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003200 return 1;
3201 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003202 smp->data.u.sint = LLONG_MAX;
Willy Tarreau97707872015-01-27 15:12:13 +01003203 return 1;
3204}
3205
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003206/* Takes a SINT on input, applies an arithmetic "mod" with the SINT directly in
Joseph Herlant757f5ad2018-11-15 12:14:56 -08003207 * arg_p or in the variable described in arg_p, and returns the SINT result.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003208 * If arg_p makes the result overflow, then 0 is returned.
Willy Tarreau97707872015-01-27 15:12:13 +01003209 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003210static int sample_conv_arith_mod(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003211 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003212{
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003213 struct sample tmp;
3214
Willy Tarreau7560dd42016-03-10 16:28:58 +01003215 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreau6204cd92016-03-10 16:33:04 +01003216 if (!sample_conv_var2smp(arg_p, &tmp))
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02003217 return 0;
3218
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003219 if (tmp.data.u.sint) {
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003220 /* The divide between LLONG_MIN and -1 returns a
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05003221 * "floating point exception".
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003222 */
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003223 if (smp->data.u.sint == LLONG_MIN && tmp.data.u.sint == -1) {
3224 smp->data.u.sint = 0;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003225 return 1;
3226 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003227 smp->data.u.sint %= tmp.data.u.sint;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003228 return 1;
3229 }
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003230 smp->data.u.sint = 0;
Willy Tarreau97707872015-01-27 15:12:13 +01003231 return 1;
3232}
3233
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003234/* Takes an SINT on input, applies an arithmetic "neg" and returns the SINT
Willy Tarreau97707872015-01-27 15:12:13 +01003235 * result.
3236 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003237static int sample_conv_arith_neg(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 if (smp->data.u.sint == LLONG_MIN)
3241 smp->data.u.sint = LLONG_MAX;
Thierry FOURNIER00c005c2015-07-08 01:10:21 +02003242 else
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003243 smp->data.u.sint = -smp->data.u.sint;
Willy Tarreau97707872015-01-27 15:12:13 +01003244 return 1;
3245}
3246
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003247/* Takes a SINT on input, returns true is the value is non-null, otherwise
Willy Tarreau97707872015-01-27 15:12:13 +01003248 * false. The output is a BOOL.
3249 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003250static int sample_conv_arith_bool(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003251 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003252{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003253 smp->data.u.sint = !!smp->data.u.sint;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003254 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003255 return 1;
3256}
3257
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003258/* Takes a SINT on input, returns false is the value is non-null, otherwise
Willy Tarreau97707872015-01-27 15:12:13 +01003259 * truee. The output is a BOOL.
3260 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003261static int sample_conv_arith_not(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003262 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003263{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003264 smp->data.u.sint = !smp->data.u.sint;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003265 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003266 return 1;
3267}
3268
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003269/* Takes a SINT on input, returns true is the value is odd, otherwise false.
Willy Tarreau97707872015-01-27 15:12:13 +01003270 * The output is a BOOL.
3271 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003272static int sample_conv_arith_odd(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003273 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003274{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003275 smp->data.u.sint = smp->data.u.sint & 1;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003276 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003277 return 1;
3278}
3279
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02003280/* Takes a SINT on input, returns true is the value is even, otherwise false.
Willy Tarreau97707872015-01-27 15:12:13 +01003281 * The output is a BOOL.
3282 */
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +02003283static int sample_conv_arith_even(const struct arg *arg_p,
Thierry FOURNIER68a556e2015-02-23 15:11:11 +01003284 struct sample *smp, void *private)
Willy Tarreau97707872015-01-27 15:12:13 +01003285{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003286 smp->data.u.sint = !(smp->data.u.sint & 1);
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003287 smp->data.type = SMP_T_BOOL;
Willy Tarreau97707872015-01-27 15:12:13 +01003288 return 1;
3289}
3290
Willy Tarreau280f42b2018-02-19 15:34:12 +01003291/* appends an optional const string, an optional variable contents and another
3292 * optional const string to an existing string.
3293 */
3294static int sample_conv_concat(const struct arg *arg_p, struct sample *smp, void *private)
3295{
Willy Tarreau83061a82018-07-13 11:56:34 +02003296 struct buffer *trash;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003297 struct sample tmp;
3298 int max;
3299
Willy Tarreau591fc3a2021-01-08 16:08:43 +01003300 trash = alloc_trash_chunk();
William Dauchye9970102021-01-11 11:05:58 +01003301 if (!trash)
3302 return 0;
3303
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003304 trash->data = smp->data.u.str.data;
3305 if (trash->data > trash->size - 1)
3306 trash->data = trash->size - 1;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003307
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003308 memcpy(trash->area, smp->data.u.str.area, trash->data);
3309 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003310
3311 /* append first string */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003312 max = arg_p[0].data.str.data;
3313 if (max > trash->size - 1 - trash->data)
3314 max = trash->size - 1 - trash->data;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003315
3316 if (max) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003317 memcpy(trash->area + trash->data, arg_p[0].data.str.area, max);
3318 trash->data += max;
3319 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003320 }
3321
3322 /* append second string (variable) if it's found and we can turn it
3323 * into a string.
3324 */
3325 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
Willy Tarreaue352b9d2021-09-03 11:52:38 +02003326 if (arg_p[1].type == ARGT_VAR && vars_get_by_desc(&arg_p[1].data.var, &tmp, NULL) &&
Willy Tarreau280f42b2018-02-19 15:34:12 +01003327 (sample_casts[tmp.data.type][SMP_T_STR] == c_none ||
3328 sample_casts[tmp.data.type][SMP_T_STR](&tmp))) {
3329
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003330 max = tmp.data.u.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, tmp.data.u.str.area,
3336 max);
3337 trash->data += max;
3338 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003339 }
3340 }
3341
3342 /* append third string */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003343 max = arg_p[2].data.str.data;
3344 if (max > trash->size - 1 - trash->data)
3345 max = trash->size - 1 - trash->data;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003346
3347 if (max) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003348 memcpy(trash->area + trash->data, arg_p[2].data.str.area, max);
3349 trash->data += max;
3350 trash->area[trash->data] = 0;
Willy Tarreau280f42b2018-02-19 15:34:12 +01003351 }
3352
3353 smp->data.u.str = *trash;
3354 smp->data.type = SMP_T_STR;
Willy Tarreau591fc3a2021-01-08 16:08:43 +01003355 smp_dup(smp);
3356 free_trash_chunk(trash);
Willy Tarreau280f42b2018-02-19 15:34:12 +01003357 return 1;
3358}
3359
3360/* This function checks the "concat" converter's arguments and extracts the
3361 * variable name and its scope.
3362 */
3363static int smp_check_concat(struct arg *args, struct sample_conv *conv,
3364 const char *file, int line, char **err)
3365{
3366 /* Try to decode a variable. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003367 if (args[1].data.str.data > 0 && !vars_check_arg(&args[1], NULL)) {
3368 memprintf(err, "failed to register variable name '%s'",
3369 args[1].data.str.area);
Willy Tarreau280f42b2018-02-19 15:34:12 +01003370 return 0;
3371 }
3372 return 1;
3373}
3374
Tim Duesterhusf38175c2020-06-09 11:48:42 +02003375/* Compares string with a variable containing a string. Return value
Tim Duesterhusca097c12018-04-27 21:18:45 +02003376 * is compatible with strcmp(3)'s return value.
3377 */
3378static int sample_conv_strcmp(const struct arg *arg_p, struct sample *smp, void *private)
3379{
3380 struct sample tmp;
3381 int max, result;
3382
3383 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
3384 if (arg_p[0].type != ARGT_VAR)
3385 return 0;
Willy Tarreaue352b9d2021-09-03 11:52:38 +02003386 if (!vars_get_by_desc(&arg_p[0].data.var, &tmp, NULL))
Tim Duesterhusca097c12018-04-27 21:18:45 +02003387 return 0;
3388 if (!sample_casts[tmp.data.type][SMP_T_STR](&tmp))
3389 return 0;
3390
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003391 max = MIN(smp->data.u.str.data, tmp.data.u.str.data);
3392 result = strncmp(smp->data.u.str.area, tmp.data.u.str.area, max);
Tim Duesterhusca097c12018-04-27 21:18:45 +02003393 if (result == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003394 if (smp->data.u.str.data != tmp.data.u.str.data) {
3395 if (smp->data.u.str.data < tmp.data.u.str.data) {
Tim Duesterhusca097c12018-04-27 21:18:45 +02003396 result = -1;
3397 }
3398 else {
3399 result = 1;
3400 }
3401 }
3402 }
3403
3404 smp->data.u.sint = result;
3405 smp->data.type = SMP_T_SINT;
3406 return 1;
3407}
3408
Willy Tarreau2a8a2f02021-05-09 11:59:49 +02003409#if defined(HAVE_CRYPTO_memcmp)
Tim Duesterhusf38175c2020-06-09 11:48:42 +02003410/* Compares bytestring with a variable containing a bytestring. Return value
3411 * is `true` if both bytestrings are bytewise identical and `false` otherwise.
3412 *
3413 * Comparison will be performed in constant time if both bytestrings are of
3414 * the same length. If the lengths differ execution time will not be constant.
3415 */
3416static int sample_conv_secure_memcmp(const struct arg *arg_p, struct sample *smp, void *private)
3417{
3418 struct sample tmp;
3419 int result;
3420
3421 smp_set_owner(&tmp, smp->px, smp->sess, smp->strm, smp->opt);
3422 if (arg_p[0].type != ARGT_VAR)
3423 return 0;
Willy Tarreaue352b9d2021-09-03 11:52:38 +02003424 if (!vars_get_by_desc(&arg_p[0].data.var, &tmp, NULL))
Tim Duesterhusf38175c2020-06-09 11:48:42 +02003425 return 0;
3426 if (!sample_casts[tmp.data.type][SMP_T_BIN](&tmp))
3427 return 0;
3428
3429 if (smp->data.u.str.data != tmp.data.u.str.data) {
3430 smp->data.u.sint = 0;
3431 smp->data.type = SMP_T_BOOL;
3432 return 1;
3433 }
3434
3435 /* The following comparison is performed in constant time. */
3436 result = CRYPTO_memcmp(smp->data.u.str.area, tmp.data.u.str.area, smp->data.u.str.data);
3437
3438 smp->data.u.sint = result == 0;
3439 smp->data.type = SMP_T_BOOL;
3440 return 1;
3441}
3442#endif
3443
Tim Duesterhus3943e4f2020-09-11 14:25:23 +02003444/* Takes a boolean as input. Returns the first argument if that boolean is true and
3445 * the second argument otherwise.
3446 */
3447static int sample_conv_iif(const struct arg *arg_p, struct sample *smp, void *private)
3448{
3449 smp->data.type = SMP_T_STR;
3450 smp->flags |= SMP_F_CONST;
3451
3452 if (smp->data.u.sint) {
3453 smp->data.u.str.data = arg_p[0].data.str.data;
3454 smp->data.u.str.area = arg_p[0].data.str.area;
3455 }
3456 else {
3457 smp->data.u.str.data = arg_p[1].data.str.data;
3458 smp->data.u.str.area = arg_p[1].data.str.area;
3459 }
3460
3461 return 1;
3462}
3463
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003464#define GRPC_MSG_COMPRESS_FLAG_SZ 1 /* 1 byte */
3465#define GRPC_MSG_LENGTH_SZ 4 /* 4 bytes */
3466#define GRPC_MSG_HEADER_SZ (GRPC_MSG_COMPRESS_FLAG_SZ + GRPC_MSG_LENGTH_SZ)
3467
3468/*
3469 * Extract the field value of an input binary sample. Takes a mandatory argument:
3470 * the protocol buffers field identifier (dotted notation) internally represented
3471 * as an array of unsigned integers and its size.
3472 * Return 1 if the field was found, 0 if not.
3473 */
3474static int sample_conv_ungrpc(const struct arg *arg_p, struct sample *smp, void *private)
3475{
3476 unsigned char *pos;
3477 size_t grpc_left;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003478
3479 pos = (unsigned char *)smp->data.u.str.area;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003480 grpc_left = smp->data.u.str.data;
3481
Frédéric Lécaille7c93e882019-03-04 07:33:41 +01003482 while (grpc_left > GRPC_MSG_HEADER_SZ) {
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003483 size_t grpc_msg_len, left;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003484
3485 grpc_msg_len = left = ntohl(*(uint32_t *)(pos + GRPC_MSG_COMPRESS_FLAG_SZ));
3486
3487 pos += GRPC_MSG_HEADER_SZ;
3488 grpc_left -= GRPC_MSG_HEADER_SZ;
3489
3490 if (grpc_left < left)
3491 return 0;
3492
Frédéric Lécaille5f33f852019-03-06 08:03:44 +01003493 if (protobuf_field_lookup(arg_p, smp, &pos, &left))
3494 return 1;
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003495
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01003496 grpc_left -= grpc_msg_len;
3497 }
3498
3499 return 0;
3500}
3501
Frédéric Lécaillebfe61382019-03-06 14:34:36 +01003502static int sample_conv_protobuf(const struct arg *arg_p, struct sample *smp, void *private)
3503{
3504 unsigned char *pos;
3505 size_t left;
3506
3507 pos = (unsigned char *)smp->data.u.str.area;
3508 left = smp->data.u.str.data;
3509
3510 return protobuf_field_lookup(arg_p, smp, &pos, &left);
3511}
3512
3513static int sample_conv_protobuf_check(struct arg *args, struct sample_conv *conv,
3514 const char *file, int line, char **err)
Frédéric Lécaille756d97f2019-03-04 19:03:48 +01003515{
3516 if (!args[1].type) {
3517 args[1].type = ARGT_SINT;
3518 args[1].data.sint = PBUF_T_BINARY;
3519 }
3520 else {
3521 int pbuf_type;
3522
3523 pbuf_type = protobuf_type(args[1].data.str.area);
3524 if (pbuf_type == -1) {
3525 memprintf(err, "Wrong protocol buffer type '%s'", args[1].data.str.area);
3526 return 0;
3527 }
3528
Christopher Faulet6ad7df42020-08-07 11:45:18 +02003529 chunk_destroy(&args[1].data.str);
Frédéric Lécaille756d97f2019-03-04 19:03:48 +01003530 args[1].type = ARGT_SINT;
3531 args[1].data.sint = pbuf_type;
3532 }
3533
3534 return 1;
3535}
3536
Baptiste Assmanne138dda2020-10-22 15:39:03 +02003537/*
3538 * Extract the tag value of an input binary sample. Takes a mandatory argument:
3539 * the FIX protocol tag identifier.
3540 * Return 1 if the tag was found, 0 if not.
3541 */
3542static int sample_conv_fix_tag_value(const struct arg *arg_p, struct sample *smp, void *private)
3543{
3544 struct ist value;
3545
3546 smp->flags &= ~SMP_F_MAY_CHANGE;
3547 value = fix_tag_value(ist2(smp->data.u.str.area, smp->data.u.str.data),
3548 arg_p[0].data.sint);
3549 if (!istlen(value)) {
3550 if (!isttest(value)) {
3551 /* value != IST_NULL, need more data */
3552 smp->flags |= SMP_F_MAY_CHANGE;
3553 }
3554 return 0;
3555 }
3556
3557 smp->data.u.str = ist2buf(value);
3558 smp->flags |= SMP_F_CONST;
3559
3560 return 1;
3561}
3562
3563/* This function checks the "fix_tag_value" converter configuration.
3564 * It expects a "known" (by HAProxy) tag name or ID.
3565 * Tag string names are converted to their ID counterpart because this is the
3566 * format they are sent over the wire.
3567 */
3568static int sample_conv_fix_value_check(struct arg *args, struct sample_conv *conv,
3569 const char *file, int line, char **err)
3570{
3571 struct ist str;
3572 unsigned int tag;
3573
3574 str = ist2(args[0].data.str.area, args[0].data.str.data);
3575 tag = fix_tagid(str);
3576 if (!tag) {
3577 memprintf(err, "Unknown FIX tag name '%s'", args[0].data.str.area);
3578 return 0;
3579 }
3580
3581 chunk_destroy(&args[0].data.str);
3582 args[0].type = ARGT_SINT;
3583 args[0].data.sint = tag;
3584
3585 return 1;
3586}
3587
3588/*
3589 * Checks that a buffer contains a valid FIX message
3590 *
3591 * Return 1 if the check could be run, 0 if not.
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05003592 * The result of the analyse itself is stored in <smp> as a boolean
Baptiste Assmanne138dda2020-10-22 15:39:03 +02003593 */
3594static int sample_conv_fix_is_valid(const struct arg *arg_p, struct sample *smp, void *private)
3595{
3596 struct ist msg;
3597
3598 msg = ist2(smp->data.u.str.area, smp->data.u.str.data);
3599
3600 smp->flags &= ~SMP_F_MAY_CHANGE;
3601 switch (fix_validate_message(msg)) {
3602 case FIX_VALID_MESSAGE:
3603 smp->data.type = SMP_T_BOOL;
3604 smp->data.u.sint = 1;
3605 return 1;
3606 case FIX_NEED_MORE_DATA:
3607 smp->flags |= SMP_F_MAY_CHANGE;
3608 return 0;
3609 case FIX_INVALID_MESSAGE:
3610 smp->data.type = SMP_T_BOOL;
3611 smp->data.u.sint = 0;
3612 return 1;
3613 }
3614 return 0;
3615}
3616
Baptiste Assmanne279ca62020-10-27 18:10:06 +01003617/*
3618 * Extract the field value of an input binary sample containing an MQTT packet.
3619 * Takes 2 mandatory arguments:
3620 * - packet type
3621 * - field name
3622 *
3623 * return 1 if the field was found, 0 if not.
3624 */
3625static int sample_conv_mqtt_field_value(const struct arg *arg_p, struct sample *smp, void *private)
3626{
3627 struct ist pkt, value;
3628 int type, fieldname_id;
3629
3630 pkt = ist2(smp->data.u.str.area, smp->data.u.str.data);
3631 type = arg_p[0].data.sint;
3632 fieldname_id = arg_p[1].data.sint;
3633
3634 smp->flags &= ~SMP_F_MAY_CHANGE;
3635 value = mqtt_field_value(pkt, type, fieldname_id);
3636 if (!istlen(value)) {
3637 if (isttest(value)) {
3638 /* value != IST_NULL, need more data */
3639 smp->flags |= SMP_F_MAY_CHANGE;
3640 }
3641 return 0;
3642 }
3643
3644 smp->data.u.str = ist2buf(value);
3645 smp->flags |= SMP_F_CONST;
3646 return 1;
3647}
3648
3649/*
3650 * this function checks the "mqtt_field_value" converter configuration.
3651 * It expects a known packet type name or ID and a field name, in this order
3652 *
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05003653 * Args[0] will be turned into a MQTT_CPT_* value for direct matching when parsing
Baptiste Assmanne279ca62020-10-27 18:10:06 +01003654 * a packet.
3655 */
3656static int sample_conv_mqtt_field_value_check(struct arg *args, struct sample_conv *conv,
3657 const char *file, int line, char **err)
3658{
3659 int type, fieldname_id;
3660
3661 /* check the MQTT packet type is valid */
3662 type = mqtt_typeid(ist2(args[0].data.str.area, args[0].data.str.data));
3663 if (type == MQTT_CPT_INVALID) {
3664 memprintf(err, "Unknown MQTT type '%s'", args[0].data.str.area);
3665 return 0;
3666 }
3667
3668 /* check the field name belongs to the MQTT packet type */
3669 fieldname_id = mqtt_check_type_fieldname(type, ist2(args[1].data.str.area, args[1].data.str.data));
3670 if (fieldname_id == MQTT_FN_INVALID) {
3671 memprintf(err, "Unknown MQTT field name '%s' for packet type '%s'", args[1].data.str.area,
3672 args[0].data.str.area);
3673 return 0;
3674 }
3675
3676 /* save numeric counterparts of type and field name */
3677 chunk_destroy(&args[0].data.str);
3678 chunk_destroy(&args[1].data.str);
3679 args[0].type = ARGT_SINT;
3680 args[0].data.sint = type;
3681 args[1].type = ARGT_SINT;
3682 args[1].data.sint = fieldname_id;
3683
3684 return 1;
3685}
3686
3687/*
3688 * Checks that <smp> contains a valid MQTT message
3689 *
3690 * The function returns 1 if the check was run to its end, 0 otherwise.
3691 * The result of the analyse itself is stored in <smp> as a boolean.
3692 */
3693static int sample_conv_mqtt_is_valid(const struct arg *arg_p, struct sample *smp, void *private)
3694{
3695 struct ist msg;
3696
3697 msg = ist2(smp->data.u.str.area, smp->data.u.str.data);
3698
3699 smp->flags &= ~SMP_F_MAY_CHANGE;
3700 switch (mqtt_validate_message(msg, NULL)) {
3701 case FIX_VALID_MESSAGE:
3702 smp->data.type = SMP_T_BOOL;
3703 smp->data.u.sint = 1;
3704 return 1;
3705 case FIX_NEED_MORE_DATA:
3706 smp->flags |= SMP_F_MAY_CHANGE;
3707 return 0;
3708 case FIX_INVALID_MESSAGE:
3709 smp->data.type = SMP_T_BOOL;
3710 smp->data.u.sint = 0;
3711 return 1;
3712 }
3713 return 0;
3714}
3715
Tim Duesterhusca097c12018-04-27 21:18:45 +02003716/* This function checks the "strcmp" converter's arguments and extracts the
3717 * variable name and its scope.
3718 */
3719static int smp_check_strcmp(struct arg *args, struct sample_conv *conv,
3720 const char *file, int line, char **err)
3721{
Willy Tarreaua1169b62021-05-08 06:50:28 +02003722 if (!args[0].data.str.data) {
3723 memprintf(err, "missing variable name");
3724 return 0;
3725 }
3726
Tim Duesterhusca097c12018-04-27 21:18:45 +02003727 /* Try to decode a variable. */
3728 if (vars_check_arg(&args[0], NULL))
3729 return 1;
3730
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003731 memprintf(err, "failed to register variable name '%s'",
3732 args[0].data.str.area);
Tim Duesterhusca097c12018-04-27 21:18:45 +02003733 return 0;
3734}
3735
Willy Tarreau2a8a2f02021-05-09 11:59:49 +02003736#if defined(HAVE_CRYPTO_memcmp)
Tim Duesterhusf38175c2020-06-09 11:48:42 +02003737/* This function checks the "secure_memcmp" converter's arguments and extracts the
3738 * variable name and its scope.
3739 */
3740static int smp_check_secure_memcmp(struct arg *args, struct sample_conv *conv,
3741 const char *file, int line, char **err)
3742{
Willy Tarreaua1169b62021-05-08 06:50:28 +02003743 if (!args[0].data.str.data) {
3744 memprintf(err, "missing variable name");
3745 return 0;
3746 }
3747
Tim Duesterhusf38175c2020-06-09 11:48:42 +02003748 /* Try to decode a variable. */
3749 if (vars_check_arg(&args[0], NULL))
3750 return 1;
3751
3752 memprintf(err, "failed to register variable name '%s'",
3753 args[0].data.str.area);
3754 return 0;
3755}
3756#endif
3757
Christopher Faulet4ccc12f2020-04-01 09:08:32 +02003758/**/
3759static int sample_conv_htonl(const struct arg *arg_p, struct sample *smp, void *private)
3760{
3761 struct buffer *tmp;
3762 uint32_t n;
3763
3764 n = htonl((uint32_t)smp->data.u.sint);
3765 tmp = get_trash_chunk();
3766
3767 memcpy(b_head(tmp), &n, 4);
3768 b_add(tmp, 4);
3769
3770 smp->data.u.str = *tmp;
3771 smp->data.type = SMP_T_BIN;
3772 return 1;
3773}
3774
Christopher Fauletea159d62020-04-01 16:21:44 +02003775/**/
3776static int sample_conv_cut_crlf(const struct arg *arg_p, struct sample *smp, void *private)
3777{
3778 char *p;
3779 size_t l;
3780
3781 p = smp->data.u.str.area;
3782 for (l = 0; l < smp->data.u.str.data; l++) {
3783 if (*(p+l) == '\r' || *(p+l) == '\n')
3784 break;
3785 }
3786 smp->data.u.str.data = l;
3787 return 1;
3788}
3789
Christopher Faulet51fc9d12020-04-01 17:24:41 +02003790/**/
3791static int sample_conv_ltrim(const struct arg *arg_p, struct sample *smp, void *private)
3792{
3793 char *delimiters, *p;
3794 size_t dlen, l;
3795
3796 delimiters = arg_p[0].data.str.area;
3797 dlen = arg_p[0].data.str.data;
3798
3799 l = smp->data.u.str.data;
3800 p = smp->data.u.str.area;
3801 while (l && memchr(delimiters, *p, dlen) != NULL) {
3802 p++;
3803 l--;
3804 }
3805
3806 smp->data.u.str.area = p;
3807 smp->data.u.str.data = l;
3808 return 1;
3809}
3810
Christopher Faulet568415a2020-04-01 17:24:47 +02003811/**/
3812static int sample_conv_rtrim(const struct arg *arg_p, struct sample *smp, void *private)
3813{
3814 char *delimiters, *p;
3815 size_t dlen, l;
3816
3817 delimiters = arg_p[0].data.str.area;
3818 dlen = arg_p[0].data.str.data;
3819
3820 l = smp->data.u.str.data;
3821 p = smp->data.u.str.area + l - 1;
3822 while (l && memchr(delimiters, *p, dlen) != NULL) {
3823 p--;
3824 l--;
3825 }
3826
3827 smp->data.u.str.data = l;
3828 return 1;
3829}
3830
Alex51c8ad42021-04-15 16:45:15 +02003831/* This function checks the "json_query" converter's arguments. */
3832static int sample_check_json_query(struct arg *arg, struct sample_conv *conv,
3833 const char *file, int line, char **err)
3834{
3835 if (arg[0].data.str.data == 0) {
3836 memprintf(err, "json_path must not be empty");
3837 return 0;
3838 }
3839
3840 if (arg[1].data.str.data != 0) {
3841 if (strcmp(arg[1].data.str.area, "int") != 0) {
3842 memprintf(err, "output_type only supports \"int\" as argument");
3843 return 0;
3844 } else {
3845 arg[1].type = ARGT_SINT;
3846 arg[1].data.sint = 0;
3847 }
3848 }
3849 return 1;
3850}
3851
3852/* Limit JSON integer values to the range [-(2**53)+1, (2**53)-1] as per
3853 * the recommendation for interoperable integers in section 6 of RFC 7159.
3854 */
3855#define JSON_INT_MAX ((1LL << 53) - 1)
3856#define JSON_INT_MIN (-JSON_INT_MAX)
3857
3858/* This sample function get the value from a given json string.
3859 * The mjson library is used to parse the JSON struct
3860 */
3861static int sample_conv_json_query(const struct arg *args, struct sample *smp, void *private)
3862{
3863 struct buffer *trash = get_trash_chunk();
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003864 const char *token; /* holds the temporary string from mjson_find */
3865 int token_size; /* holds the length of <token> */
Alex51c8ad42021-04-15 16:45:15 +02003866
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003867 enum mjson_tok token_type;
Alex51c8ad42021-04-15 16:45:15 +02003868
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003869 token_type = mjson_find(smp->data.u.str.area, smp->data.u.str.data, args[0].data.str.area, &token, &token_size);
3870
3871 switch (token_type) {
Alex51c8ad42021-04-15 16:45:15 +02003872 case MJSON_TOK_NUMBER:
3873 if (args[1].type == ARGT_SINT) {
Willy Tarreaufb601952021-05-14 08:51:53 +02003874 smp->data.u.sint = strtoll(token, NULL, 0);
Alex51c8ad42021-04-15 16:45:15 +02003875
3876 if (smp->data.u.sint < JSON_INT_MIN || smp->data.u.sint > JSON_INT_MAX)
3877 return 0;
3878
3879 smp->data.type = SMP_T_SINT;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003880
3881 return 1;
Alex51c8ad42021-04-15 16:45:15 +02003882 } else {
3883 double double_val;
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003884
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003885 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 +02003886 return 0;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003887
3888 trash->data = snprintf(trash->area,trash->size,"%g",double_val);
3889 smp->data.u.str = *trash;
3890 smp->data.type = SMP_T_STR;
3891
3892 return 1;
Alex51c8ad42021-04-15 16:45:15 +02003893 }
Alex51c8ad42021-04-15 16:45:15 +02003894 case MJSON_TOK_TRUE:
3895 smp->data.type = SMP_T_BOOL;
3896 smp->data.u.sint = 1;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003897
3898 return 1;
Alex51c8ad42021-04-15 16:45:15 +02003899 case MJSON_TOK_FALSE:
3900 smp->data.type = SMP_T_BOOL;
3901 smp->data.u.sint = 0;
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003902
3903 return 1;
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003904 case MJSON_TOK_STRING: {
3905 int len;
3906
3907 len = mjson_get_string(smp->data.u.str.area, smp->data.u.str.data, args[0].data.str.area, trash->area, trash->size);
3908
3909 if (len == -1) {
Alex51c8ad42021-04-15 16:45:15 +02003910 /* invalid string */
3911 return 0;
Alex51c8ad42021-04-15 16:45:15 +02003912 }
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003913
3914 trash->data = len;
3915 smp->data.u.str = *trash;
3916 smp->data.type = SMP_T_STR;
3917
3918 return 1;
Tim Duesterhus4809c8c2021-04-15 18:08:48 +02003919 }
Tim Duesterhus8f3bc8f2021-04-15 18:14:32 +02003920 case MJSON_TOK_NULL:
3921 case MJSON_TOK_ARRAY:
3922 case MJSON_TOK_OBJECT:
3923 /* We cannot handle these. */
3924 return 0;
3925 case MJSON_TOK_INVALID:
3926 /* Nothing matches the query. */
3927 return 0;
3928 case MJSON_TOK_KEY:
3929 /* This is not a valid return value according to the
3930 * mjson documentation, but we handle it to benefit
3931 * from '-Wswitch'.
3932 */
Alex51c8ad42021-04-15 16:45:15 +02003933 return 0;
3934 }
Tim Duesterhus3b9cdf12021-04-15 18:40:06 +02003935
3936 my_unreachable();
3937 return 0;
Alex51c8ad42021-04-15 16:45:15 +02003938}
3939
3940
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003941/************************************************************************/
3942/* All supported sample fetch functions must be declared here */
3943/************************************************************************/
3944
3945/* force TRUE to be returned at the fetch level */
3946static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02003947smp_fetch_true(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003948{
Willy Tarreau280f42b2018-02-19 15:34:12 +01003949 if (!smp_make_rw(smp))
3950 return 0;
3951
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003952 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003953 smp->data.u.sint = 1;
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003954 return 1;
3955}
3956
3957/* force FALSE to be returned at the fetch level */
3958static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02003959smp_fetch_false(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003960{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003961 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02003962 smp->data.u.sint = 0;
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003963 return 1;
3964}
3965
3966/* retrieve environment variable $1 as a string */
3967static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02003968smp_fetch_env(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003969{
3970 char *env;
3971
Christopher Faulete6e7a582021-01-29 11:29:28 +01003972 if (args[0].type != ARGT_STR)
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003973 return 0;
3974
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003975 env = getenv(args[0].data.str.area);
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003976 if (!env)
3977 return 0;
3978
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02003979 smp->data.type = SMP_T_STR;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +01003980 smp->flags = SMP_F_CONST;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003981 smp->data.u.str.area = env;
3982 smp->data.u.str.data = strlen(env);
Willy Tarreau5b8ad222013-07-25 12:17:57 +02003983 return 1;
3984}
3985
Damien Claisseae6f1252019-10-30 15:57:28 +00003986/* Validates the data unit argument passed to "date" fetch. Argument 1 support an
3987 * optional string representing the unit of the result: "s" for seconds, "ms" for
3988 * milliseconds and "us" for microseconds.
3989 * Returns 0 on error and non-zero if OK.
3990 */
3991int smp_check_date_unit(struct arg *args, char **err)
3992{
3993 if (args[1].type == ARGT_STR) {
Christopher Faulet95917132020-08-05 23:07:07 +02003994 long long int unit;
3995
Damien Claisseae6f1252019-10-30 15:57:28 +00003996 if (strcmp(args[1].data.str.area, "s") == 0) {
Christopher Faulet95917132020-08-05 23:07:07 +02003997 unit = TIME_UNIT_S;
Damien Claisseae6f1252019-10-30 15:57:28 +00003998 }
3999 else if (strcmp(args[1].data.str.area, "ms") == 0) {
Christopher Faulet95917132020-08-05 23:07:07 +02004000 unit = TIME_UNIT_MS;
Damien Claisseae6f1252019-10-30 15:57:28 +00004001 }
4002 else if (strcmp(args[1].data.str.area, "us") == 0) {
Christopher Faulet95917132020-08-05 23:07:07 +02004003 unit = TIME_UNIT_US;
Damien Claisseae6f1252019-10-30 15:57:28 +00004004 }
4005 else {
4006 memprintf(err, "expects 's', 'ms' or 'us', got '%s'",
4007 args[1].data.str.area);
4008 return 0;
4009 }
Christopher Faulet95917132020-08-05 23:07:07 +02004010
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004011 chunk_destroy(&args[1].data.str);
Damien Claisseae6f1252019-10-30 15:57:28 +00004012 args[1].type = ARGT_SINT;
Christopher Faulet95917132020-08-05 23:07:07 +02004013 args[1].data.sint = unit;
Damien Claisseae6f1252019-10-30 15:57:28 +00004014 }
4015 else if (args[1].type != ARGT_STOP) {
4016 memprintf(err, "Unexpected arg type");
4017 return 0;
4018 }
4019
4020 return 1;
4021}
4022
4023/* retrieve the current local date in epoch time, converts it to milliseconds
4024 * or microseconds if asked to in optional args[1] unit param, and applies an
4025 * optional args[0] offset.
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004026 */
4027static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004028smp_fetch_date(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004029{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004030 smp->data.u.sint = date.tv_sec;
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004031
Damien Claisseae6f1252019-10-30 15:57:28 +00004032 /* report in milliseconds */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004033 if (args[1].type == ARGT_SINT && args[1].data.sint == TIME_UNIT_MS) {
Damien Claisseae6f1252019-10-30 15:57:28 +00004034 smp->data.u.sint *= 1000;
4035 smp->data.u.sint += date.tv_usec / 1000;
4036 }
4037 /* report in microseconds */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004038 else if (args[1].type == ARGT_SINT && args[1].data.sint == TIME_UNIT_US) {
Damien Claisseae6f1252019-10-30 15:57:28 +00004039 smp->data.u.sint *= 1000000;
4040 smp->data.u.sint += date.tv_usec;
4041 }
4042
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004043 /* add offset */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004044 if (args[0].type == ARGT_SINT)
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004045 smp->data.u.sint += args[0].data.sint;
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004046
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004047 smp->data.type = SMP_T_SINT;
Willy Tarreau6236d3a2013-07-25 14:28:25 +02004048 smp->flags |= SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4049 return 1;
4050}
4051
Etienne Carrierea792a0a2018-01-17 13:43:24 +01004052/* retrieve the current microsecond part of the date */
4053static int
4054smp_fetch_date_us(const struct arg *args, struct sample *smp, const char *kw, void *private)
4055{
4056 smp->data.u.sint = date.tv_usec;
4057 smp->data.type = SMP_T_SINT;
4058 smp->flags |= SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4059 return 1;
4060}
4061
4062
Nenad Merdanovic807a6e72017-03-12 22:00:00 +01004063/* returns the hostname */
4064static int
4065smp_fetch_hostname(const struct arg *args, struct sample *smp, const char *kw, void *private)
4066{
4067 smp->data.type = SMP_T_STR;
4068 smp->flags = SMP_F_CONST;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004069 smp->data.u.str.area = hostname;
4070 smp->data.u.str.data = strlen(hostname);
Nenad Merdanovic807a6e72017-03-12 22:00:00 +01004071 return 1;
4072}
4073
Willy Tarreau0f30d262014-11-24 16:02:05 +01004074/* returns the number of processes */
4075static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004076smp_fetch_nbproc(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau0f30d262014-11-24 16:02:05 +01004077{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004078 smp->data.type = SMP_T_SINT;
Willy Tarreau91358592021-06-15 08:08:04 +02004079 smp->data.u.sint = 1;
Willy Tarreau0f30d262014-11-24 16:02:05 +01004080 return 1;
4081}
4082
4083/* returns the number of the current process (between 1 and nbproc */
4084static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004085smp_fetch_proc(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau0f30d262014-11-24 16:02:05 +01004086{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004087 smp->data.type = SMP_T_SINT;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02004088 smp->data.u.sint = 1;
Willy Tarreau0f30d262014-11-24 16:02:05 +01004089 return 1;
4090}
4091
Christopher Faulet34adb2a2017-11-21 21:45:38 +01004092/* returns the number of the current thread (between 1 and nbthread */
4093static int
4094smp_fetch_thread(const struct arg *args, struct sample *smp, const char *kw, void *private)
4095{
4096 smp->data.type = SMP_T_SINT;
4097 smp->data.u.sint = tid;
4098 return 1;
4099}
4100
Willy Tarreau84310e22014-02-14 11:59:04 +01004101/* generate a random 32-bit integer for whatever purpose, with an optional
4102 * range specified in argument.
4103 */
4104static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004105smp_fetch_rand(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau84310e22014-02-14 11:59:04 +01004106{
Willy Tarreauaa8bbc12020-03-08 18:01:10 +01004107 smp->data.u.sint = ha_random32();
Willy Tarreau84310e22014-02-14 11:59:04 +01004108
4109 /* reduce if needed. Don't do a modulo, use all bits! */
Christopher Faulete6e7a582021-01-29 11:29:28 +01004110 if (args[0].type == ARGT_SINT)
Willy Tarreauaa8bbc12020-03-08 18:01:10 +01004111 smp->data.u.sint = ((u64)smp->data.u.sint * (u64)args[0].data.sint) >> 32;
Willy Tarreau84310e22014-02-14 11:59:04 +01004112
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004113 smp->data.type = SMP_T_SINT;
Willy Tarreau84310e22014-02-14 11:59:04 +01004114 smp->flags |= SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4115 return 1;
4116}
4117
Willy Tarreau0f30d262014-11-24 16:02:05 +01004118/* returns true if the current process is stopping */
4119static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02004120smp_fetch_stopping(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau0f30d262014-11-24 16:02:05 +01004121{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004122 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004123 smp->data.u.sint = stopping;
Willy Tarreau0f30d262014-11-24 16:02:05 +01004124 return 1;
4125}
4126
Willy Tarreau70fe9442018-11-22 16:07:39 +01004127/* returns the number of calls of the current stream's process_stream() */
4128static int
4129smp_fetch_cpu_calls(const struct arg *args, struct sample *smp, const char *kw, void *private)
4130{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004131 if (!smp->strm)
4132 return 0;
4133
Willy Tarreau70fe9442018-11-22 16:07:39 +01004134 smp->data.type = SMP_T_SINT;
4135 smp->data.u.sint = smp->strm->task->calls;
4136 return 1;
4137}
4138
4139/* returns the average number of nanoseconds spent processing the stream per call */
4140static int
4141smp_fetch_cpu_ns_avg(const struct arg *args, struct sample *smp, const char *kw, void *private)
4142{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004143 if (!smp->strm)
4144 return 0;
4145
Willy Tarreau70fe9442018-11-22 16:07:39 +01004146 smp->data.type = SMP_T_SINT;
4147 smp->data.u.sint = smp->strm->task->calls ? smp->strm->task->cpu_time / smp->strm->task->calls : 0;
4148 return 1;
4149}
4150
4151/* returns the total number of nanoseconds spent processing the stream */
4152static int
4153smp_fetch_cpu_ns_tot(const struct arg *args, struct sample *smp, const char *kw, void *private)
4154{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004155 if (!smp->strm)
4156 return 0;
4157
Willy Tarreau70fe9442018-11-22 16:07:39 +01004158 smp->data.type = SMP_T_SINT;
4159 smp->data.u.sint = smp->strm->task->cpu_time;
4160 return 1;
4161}
4162
4163/* returns the average number of nanoseconds per call spent waiting for other tasks to be processed */
4164static int
4165smp_fetch_lat_ns_avg(const struct arg *args, struct sample *smp, const char *kw, void *private)
4166{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004167 if (!smp->strm)
4168 return 0;
4169
Willy Tarreau70fe9442018-11-22 16:07:39 +01004170 smp->data.type = SMP_T_SINT;
4171 smp->data.u.sint = smp->strm->task->calls ? smp->strm->task->lat_time / smp->strm->task->calls : 0;
4172 return 1;
4173}
4174
4175/* returns the total number of nanoseconds per call spent waiting for other tasks to be processed */
4176static int
4177smp_fetch_lat_ns_tot(const struct arg *args, struct sample *smp, const char *kw, void *private)
4178{
Willy Tarreaue0dd2102020-04-29 11:59:02 +02004179 if (!smp->strm)
4180 return 0;
4181
Willy Tarreau70fe9442018-11-22 16:07:39 +01004182 smp->data.type = SMP_T_SINT;
4183 smp->data.u.sint = smp->strm->task->lat_time;
4184 return 1;
4185}
4186
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004187static int smp_fetch_const_str(const struct arg *args, struct sample *smp, const char *kw, void *private)
4188{
4189 smp->flags |= SMP_F_CONST;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004190 smp->data.type = SMP_T_STR;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004191 smp->data.u.str.area = args[0].data.str.area;
4192 smp->data.u.str.data = args[0].data.str.data;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004193 return 1;
4194}
4195
4196static int smp_check_const_bool(struct arg *args, char **err)
4197{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004198 if (strcasecmp(args[0].data.str.area, "true") == 0 ||
4199 strcasecmp(args[0].data.str.area, "1") == 0) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004200 chunk_destroy(&args[0].data.str);
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004201 args[0].type = ARGT_SINT;
4202 args[0].data.sint = 1;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004203 return 1;
4204 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004205 if (strcasecmp(args[0].data.str.area, "false") == 0 ||
4206 strcasecmp(args[0].data.str.area, "0") == 0) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004207 chunk_destroy(&args[0].data.str);
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004208 args[0].type = ARGT_SINT;
4209 args[0].data.sint = 0;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004210 return 1;
4211 }
4212 memprintf(err, "Expects 'true', 'false', '0' or '1'");
4213 return 0;
4214}
4215
4216static int smp_fetch_const_bool(const struct arg *args, struct sample *smp, const char *kw, void *private)
4217{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004218 smp->data.type = SMP_T_BOOL;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004219 smp->data.u.sint = args[0].data.sint;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004220 return 1;
4221}
4222
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02004223static int smp_fetch_const_int(const struct arg *args, struct sample *smp, const char *kw, void *private)
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004224{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004225 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004226 smp->data.u.sint = args[0].data.sint;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004227 return 1;
4228}
4229
4230static int smp_fetch_const_ipv4(const struct arg *args, struct sample *smp, const char *kw, void *private)
4231{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004232 smp->data.type = SMP_T_IPV4;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004233 smp->data.u.ipv4 = args[0].data.ipv4;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004234 return 1;
4235}
4236
4237static int smp_fetch_const_ipv6(const struct arg *args, struct sample *smp, const char *kw, void *private)
4238{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004239 smp->data.type = SMP_T_IPV6;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004240 smp->data.u.ipv6 = args[0].data.ipv6;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004241 return 1;
4242}
4243
4244static int smp_check_const_bin(struct arg *args, char **err)
4245{
David Carlier64a16ab2016-04-08 10:37:02 +01004246 char *binstr = NULL;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004247 int binstrlen;
4248
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004249 if (!parse_binary(args[0].data.str.area, &binstr, &binstrlen, err))
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004250 return 0;
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004251 chunk_destroy(&args[0].data.str);
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004252 args[0].type = ARGT_STR;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004253 args[0].data.str.area = binstr;
4254 args[0].data.str.data = binstrlen;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004255 return 1;
4256}
4257
4258static int smp_fetch_const_bin(const struct arg *args, struct sample *smp, const char *kw, void *private)
4259{
4260 smp->flags |= SMP_F_CONST;
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004261 smp->data.type = SMP_T_BIN;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004262 smp->data.u.str.area = args[0].data.str.area;
4263 smp->data.u.str.data = args[0].data.str.data;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004264 return 1;
4265}
4266
4267static int smp_check_const_meth(struct arg *args, char **err)
4268{
4269 enum http_meth_t meth;
4270 int i;
4271
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004272 meth = find_http_meth(args[0].data.str.area, args[0].data.str.data);
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004273 if (meth != HTTP_METH_OTHER) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +02004274 chunk_destroy(&args[0].data.str);
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004275 args[0].type = ARGT_SINT;
4276 args[0].data.sint = meth;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004277 } else {
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05004278 /* Check method avalaibility. A method is a token defined as :
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004279 * tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "." /
4280 * "^" / "_" / "`" / "|" / "~" / DIGIT / ALPHA
4281 * token = 1*tchar
4282 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004283 for (i = 0; i < args[0].data.str.data; i++) {
4284 if (!HTTP_IS_TOKEN(args[0].data.str.area[i])) {
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004285 memprintf(err, "expects valid method.");
4286 return 0;
4287 }
4288 }
4289 }
4290 return 1;
4291}
4292
4293static int smp_fetch_const_meth(const struct arg *args, struct sample *smp, const char *kw, void *private)
4294{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02004295 smp->data.type = SMP_T_METH;
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +02004296 if (args[0].type == ARGT_SINT) {
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004297 smp->flags &= ~SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004298 smp->data.u.meth.meth = args[0].data.sint;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004299 smp->data.u.meth.str.area = "";
4300 smp->data.u.meth.str.data = 0;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004301 } else {
4302 smp->flags |= SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02004303 smp->data.u.meth.meth = HTTP_METH_OTHER;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004304 smp->data.u.meth.str.area = args[0].data.str.area;
4305 smp->data.u.meth.str.data = args[0].data.str.data;
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004306 }
4307 return 1;
4308}
4309
Luca Schimweg8a694b82019-09-10 15:42:52 +02004310// This function checks the "uuid" sample's arguments.
4311// Function won't get called when no parameter is specified (maybe a bug?)
4312static int smp_check_uuid(struct arg *args, char **err)
4313{
4314 if (!args[0].type) {
4315 args[0].type = ARGT_SINT;
4316 args[0].data.sint = 4;
4317 }
4318 else if (args[0].data.sint != 4) {
4319 memprintf(err, "Unsupported UUID version: '%lld'", args[0].data.sint);
4320 return 0;
4321 }
4322
4323 return 1;
4324}
4325
4326// Generate a RFC4122 UUID (default is v4 = fully random)
4327static int smp_fetch_uuid(const struct arg *args, struct sample *smp, const char *kw, void *private)
4328{
4329 if (args[0].data.sint == 4 || !args[0].type) {
Willy Tarreauee3bcdd2020-03-08 17:48:17 +01004330 ha_generate_uuid(&trash);
Luca Schimweg8a694b82019-09-10 15:42:52 +02004331 smp->data.type = SMP_T_STR;
4332 smp->flags = SMP_F_VOL_TEST | SMP_F_MAY_CHANGE;
4333 smp->data.u.str = trash;
4334 return 1;
4335 }
4336
4337 // more implementations of other uuid formats possible here
4338 return 0;
4339}
4340
Willy Tarreau5b8ad222013-07-25 12:17:57 +02004341/* Note: must not be declared <const> as its list will be overwritten.
4342 * Note: fetches that may return multiple types must be declared as the lowest
4343 * common denominator, the type that can be casted into all other ones. For
4344 * instance IPv4/IPv6 must be declared IPv4.
4345 */
4346static struct sample_fetch_kw_list smp_kws = {ILH, {
Willy Tarreau0209c972021-03-26 12:03:11 +01004347 { "always_false", smp_fetch_false, 0, NULL, SMP_T_BOOL, SMP_USE_CONST },
4348 { "always_true", smp_fetch_true, 0, NULL, SMP_T_BOOL, SMP_USE_CONST },
4349 { "env", smp_fetch_env, ARG1(1,STR), NULL, SMP_T_STR, SMP_USE_CONST },
4350 { "date", smp_fetch_date, ARG2(0,SINT,STR), smp_check_date_unit, SMP_T_SINT, SMP_USE_CONST },
4351 { "date_us", smp_fetch_date_us, 0, NULL, SMP_T_SINT, SMP_USE_CONST },
4352 { "hostname", smp_fetch_hostname, 0, NULL, SMP_T_STR, SMP_USE_CONST },
4353 { "nbproc", smp_fetch_nbproc,0, NULL, SMP_T_SINT, SMP_USE_CONST },
4354 { "proc", smp_fetch_proc, 0, NULL, SMP_T_SINT, SMP_USE_CONST },
4355 { "thread", smp_fetch_thread, 0, NULL, SMP_T_SINT, SMP_USE_CONST },
4356 { "rand", smp_fetch_rand, ARG1(0,SINT), NULL, SMP_T_SINT, SMP_USE_CONST },
Willy Tarreau0f30d262014-11-24 16:02:05 +01004357 { "stopping", smp_fetch_stopping, 0, NULL, SMP_T_BOOL, SMP_USE_INTRN },
Willy Tarreau0209c972021-03-26 12:03:11 +01004358 { "uuid", smp_fetch_uuid, ARG1(0, SINT), smp_check_uuid, SMP_T_STR, SMP_USE_CONST },
Willy Tarreau70fe9442018-11-22 16:07:39 +01004359
4360 { "cpu_calls", smp_fetch_cpu_calls, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4361 { "cpu_ns_avg", smp_fetch_cpu_ns_avg, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4362 { "cpu_ns_tot", smp_fetch_cpu_ns_tot, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4363 { "lat_ns_avg", smp_fetch_lat_ns_avg, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
4364 { "lat_ns_tot", smp_fetch_lat_ns_tot, 0, NULL, SMP_T_SINT, SMP_USE_INTRN },
Thierry FOURNIERcc103292015-06-06 19:30:17 +02004365
Willy Tarreau0209c972021-03-26 12:03:11 +01004366 { "str", smp_fetch_const_str, ARG1(1,STR), NULL , SMP_T_STR, SMP_USE_CONST },
4367 { "bool", smp_fetch_const_bool, ARG1(1,STR), smp_check_const_bool, SMP_T_BOOL, SMP_USE_CONST },
4368 { "int", smp_fetch_const_int, ARG1(1,SINT), NULL , SMP_T_SINT, SMP_USE_CONST },
4369 { "ipv4", smp_fetch_const_ipv4, ARG1(1,IPV4), NULL , SMP_T_IPV4, SMP_USE_CONST },
4370 { "ipv6", smp_fetch_const_ipv6, ARG1(1,IPV6), NULL , SMP_T_IPV6, SMP_USE_CONST },
4371 { "bin", smp_fetch_const_bin, ARG1(1,STR), smp_check_const_bin , SMP_T_BIN, SMP_USE_CONST },
4372 { "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 +02004373
Willy Tarreau5b8ad222013-07-25 12:17:57 +02004374 { /* END */ },
4375}};
4376
Willy Tarreau0108d902018-11-25 19:14:37 +01004377INITCALL1(STG_REGISTER, sample_register_fetches, &smp_kws);
4378
Emeric Brun107ca302010-01-04 16:16:05 +01004379/* Note: must not be declared <const> as its list will be overwritten */
Willy Tarreaudc13c112013-06-21 23:16:39 +02004380static struct sample_conv_kw_list sample_conv_kws = {ILH, {
Moemen MHEDHBI848216f2021-04-02 01:05:07 +02004381 { "debug", sample_conv_debug, ARG2(0,STR,STR), smp_check_debug, SMP_T_ANY, SMP_T_ANY },
4382 { "b64dec", sample_conv_base642bin, 0, NULL, SMP_T_STR, SMP_T_BIN },
4383 { "base64", sample_conv_bin2base64, 0, NULL, SMP_T_BIN, SMP_T_STR },
4384 { "ub64enc", sample_conv_bin2base64url,0, NULL, SMP_T_BIN, SMP_T_STR },
4385 { "ub64dec", sample_conv_base64url2bin,0, NULL, SMP_T_STR, SMP_T_BIN },
4386 { "upper", sample_conv_str2upper, 0, NULL, SMP_T_STR, SMP_T_STR },
4387 { "lower", sample_conv_str2lower, 0, NULL, SMP_T_STR, SMP_T_STR },
4388 { "length", sample_conv_length, 0, NULL, SMP_T_STR, SMP_T_SINT },
Marcin Deranek40ca09c2021-07-13 14:05:24 +02004389 { "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 +02004390 { "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 +02004391 { "hex", sample_conv_bin2hex, 0, NULL, SMP_T_BIN, SMP_T_STR },
4392 { "hex2i", sample_conv_hex2int, 0, NULL, SMP_T_STR, SMP_T_SINT },
4393 { "ipmask", sample_conv_ipmask, ARG2(1,MSK4,MSK6), NULL, SMP_T_ADDR, SMP_T_IPV4 },
4394 { "ltime", sample_conv_ltime, ARG2(1,STR,SINT), NULL, SMP_T_SINT, SMP_T_STR },
4395 { "utime", sample_conv_utime, ARG2(1,STR,SINT), NULL, SMP_T_SINT, SMP_T_STR },
4396 { "crc32", sample_conv_crc32, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4397 { "crc32c", sample_conv_crc32c, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4398 { "djb2", sample_conv_djb2, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4399 { "sdbm", sample_conv_sdbm, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4400 { "wt6", sample_conv_wt6, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4401 { "xxh3", sample_conv_xxh3, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4402 { "xxh32", sample_conv_xxh32, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4403 { "xxh64", sample_conv_xxh64, ARG1(0,SINT), NULL, SMP_T_BIN, SMP_T_SINT },
4404 { "json", sample_conv_json, ARG1(1,STR), sample_conv_json_check, SMP_T_STR, SMP_T_STR },
4405 { "bytes", sample_conv_bytes, ARG2(1,SINT,SINT), NULL, SMP_T_BIN, SMP_T_BIN },
4406 { "field", sample_conv_field, ARG3(2,SINT,STR,SINT), sample_conv_field_check, SMP_T_STR, SMP_T_STR },
4407 { "word", sample_conv_word, ARG3(2,SINT,STR,SINT), sample_conv_field_check, SMP_T_STR, SMP_T_STR },
4408 { "regsub", sample_conv_regsub, ARG3(2,REG,STR,STR), sample_conv_regsub_check, SMP_T_STR, SMP_T_STR },
4409 { "sha1", sample_conv_sha1, 0, NULL, SMP_T_BIN, SMP_T_BIN },
Tim Duesterhusd4376302019-06-17 12:41:44 +02004410#ifdef USE_OPENSSL
Tim Duesterhuscd373242019-12-17 12:31:20 +01004411 { "sha2", sample_conv_sha2, ARG1(0, SINT), smp_check_sha2, SMP_T_BIN, SMP_T_BIN },
Ilya Shipitsin2c481d02021-03-26 23:35:31 +05004412#ifdef EVP_CIPH_GCM_MODE
Patrick Ganstererb399bfb2018-06-17 11:21:11 +02004413 { "aes_gcm_dec", sample_conv_aes_gcm_dec, ARG4(4,SINT,STR,STR,STR), check_aes_gcm, SMP_T_BIN, SMP_T_BIN },
4414#endif
Patrick Gansterer8e366512020-04-22 16:47:57 +02004415 { "digest", sample_conv_crypto_digest, ARG1(1,STR), check_crypto_digest, SMP_T_BIN, SMP_T_BIN },
4416 { "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 +02004417#endif
Willy Tarreau280f42b2018-02-19 15:34:12 +01004418 { "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 +02004419 { "strcmp", sample_conv_strcmp, ARG1(1,STR), smp_check_strcmp, SMP_T_STR, SMP_T_SINT },
Willy Tarreau2a8a2f02021-05-09 11:59:49 +02004420#if defined(HAVE_CRYPTO_memcmp)
Tim Duesterhusf38175c2020-06-09 11:48:42 +02004421 { "secure_memcmp", sample_conv_secure_memcmp, ARG1(1,STR), smp_check_secure_memcmp, SMP_T_BIN, SMP_T_BOOL },
4422#endif
Frédéric Lécaille50290fb2019-02-27 14:34:51 +01004423
4424 /* gRPC converters. */
Frédéric Lécaillebfe61382019-03-06 14:34:36 +01004425 { "ungrpc", sample_conv_ungrpc, ARG2(1,PBUF_FNUM,STR), sample_conv_protobuf_check, SMP_T_BIN, SMP_T_BIN },
4426 { "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 +01004427
Baptiste Assmanne138dda2020-10-22 15:39:03 +02004428 /* FIX converters */
4429 { "fix_is_valid", sample_conv_fix_is_valid, 0, NULL, SMP_T_BIN, SMP_T_BOOL },
4430 { "fix_tag_value", sample_conv_fix_tag_value, ARG1(1,STR), sample_conv_fix_value_check, SMP_T_BIN, SMP_T_BIN },
4431
Baptiste Assmanne279ca62020-10-27 18:10:06 +01004432 /* MQTT converters */
4433 { "mqtt_is_valid", sample_conv_mqtt_is_valid, 0, NULL, SMP_T_BIN, SMP_T_BOOL },
4434 { "mqtt_field_value", sample_conv_mqtt_field_value, ARG2(2,STR,STR), sample_conv_mqtt_field_value_check, SMP_T_BIN, SMP_T_STR },
4435
Tim Duesterhus3943e4f2020-09-11 14:25:23 +02004436 { "iif", sample_conv_iif, ARG2(2, STR, STR), NULL, SMP_T_BOOL, SMP_T_STR },
4437
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +02004438 { "and", sample_conv_binary_and, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4439 { "or", sample_conv_binary_or, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4440 { "xor", sample_conv_binary_xor, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4441 { "cpl", sample_conv_binary_cpl, 0, NULL, SMP_T_SINT, SMP_T_SINT },
4442 { "bool", sample_conv_arith_bool, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4443 { "not", sample_conv_arith_not, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4444 { "odd", sample_conv_arith_odd, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4445 { "even", sample_conv_arith_even, 0, NULL, SMP_T_SINT, SMP_T_BOOL },
4446 { "add", sample_conv_arith_add, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4447 { "sub", sample_conv_arith_sub, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4448 { "mul", sample_conv_arith_mul, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4449 { "div", sample_conv_arith_div, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4450 { "mod", sample_conv_arith_mod, ARG1(1,STR), check_operator, SMP_T_SINT, SMP_T_SINT },
4451 { "neg", sample_conv_arith_neg, 0, NULL, SMP_T_SINT, SMP_T_SINT },
Willy Tarreau97707872015-01-27 15:12:13 +01004452
Christopher Fauletea159d62020-04-01 16:21:44 +02004453 { "htonl", sample_conv_htonl, 0, NULL, SMP_T_SINT, SMP_T_BIN },
4454 { "cut_crlf", sample_conv_cut_crlf, 0, NULL, SMP_T_STR, SMP_T_STR },
Christopher Faulet51fc9d12020-04-01 17:24:41 +02004455 { "ltrim", sample_conv_ltrim, ARG1(1,STR), NULL, SMP_T_STR, SMP_T_STR },
Christopher Faulet568415a2020-04-01 17:24:47 +02004456 { "rtrim", sample_conv_rtrim, ARG1(1,STR), NULL, SMP_T_STR, SMP_T_STR },
Alex51c8ad42021-04-15 16:45:15 +02004457 { "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 +02004458 { NULL, NULL, 0, 0, 0 },
Emeric Brun107ca302010-01-04 16:16:05 +01004459}};
4460
Willy Tarreau0108d902018-11-25 19:14:37 +01004461INITCALL1(STG_REGISTER, sample_register_convs, &sample_conv_kws);