blob: b2b0f0c1cf60e8869187e6f0a5c7e3fe89b20b43 [file] [log] [blame]
Willy Tarreaua84d3742007-05-07 00:36:48 +02001/*
2 * ACL management functions.
3 *
Willy Tarreaud4c33c82013-01-07 21:59:07 +01004 * Copyright 2000-2013 Willy Tarreau <w@1wt.eu>
Willy Tarreaua84d3742007-05-07 00:36:48 +02005 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
Willy Tarreauae8b7962007-06-09 23:10:04 +020013#include <ctype.h>
Willy Tarreaua84d3742007-05-07 00:36:48 +020014#include <stdio.h>
15#include <string.h>
16
Willy Tarreaub2551052020-06-09 09:07:15 +020017#include <import/ebsttree.h>
18
Willy Tarreaudcc048a2020-06-04 19:11:43 +020019#include <haproxy/acl.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020020#include <haproxy/api.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020021#include <haproxy/arg.h>
22#include <haproxy/auth.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020023#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020024#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020025#include <haproxy/list.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020026#include <haproxy/pattern.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020027#include <haproxy/proxy-t.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020028#include <haproxy/sample.h>
Willy Tarreau872f2ea2020-06-04 18:46:44 +020029#include <haproxy/stick_table.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020030#include <haproxy/tools.h>
Willy Tarreauc4262962010-05-10 23:42:40 +020031
Willy Tarreaua84d3742007-05-07 00:36:48 +020032/* List head of all known ACL keywords */
33static struct acl_kw_list acl_keywords = {
34 .list = LIST_HEAD_INIT(acl_keywords.list)
35};
36
Willy Tarreau0cba6072013-11-28 22:21:02 +010037/* input values are 0 or 3, output is the same */
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +010038static inline enum acl_test_res pat2acl(struct pattern *pat)
Willy Tarreau0cba6072013-11-28 22:21:02 +010039{
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +010040 if (pat)
41 return ACL_TEST_PASS;
42 else
43 return ACL_TEST_FAIL;
Willy Tarreau0cba6072013-11-28 22:21:02 +010044}
45
Willy Tarreaua5909832007-06-17 20:40:25 +020046/*
Willy Tarreaua84d3742007-05-07 00:36:48 +020047 * Registers the ACL keyword list <kwl> as a list of valid keywords for next
48 * parsing sessions.
49 */
50void acl_register_keywords(struct acl_kw_list *kwl)
51{
Willy Tarreau2b718102021-04-21 07:32:39 +020052 LIST_APPEND(&acl_keywords.list, &kwl->list);
Willy Tarreaua84d3742007-05-07 00:36:48 +020053}
54
55/*
56 * Unregisters the ACL keyword list <kwl> from the list of valid keywords.
57 */
58void acl_unregister_keywords(struct acl_kw_list *kwl)
59{
Willy Tarreau2b718102021-04-21 07:32:39 +020060 LIST_DELETE(&kwl->list);
Willy Tarreaua84d3742007-05-07 00:36:48 +020061 LIST_INIT(&kwl->list);
62}
63
64/* Return a pointer to the ACL <name> within the list starting at <head>, or
65 * NULL if not found.
66 */
67struct acl *find_acl_by_name(const char *name, struct list *head)
68{
69 struct acl *acl;
70 list_for_each_entry(acl, head, list) {
71 if (strcmp(acl->name, name) == 0)
72 return acl;
73 }
74 return NULL;
75}
76
77/* Return a pointer to the ACL keyword <kw>, or NULL if not found. Note that if
Willy Tarreau4bfa4222013-12-16 22:01:06 +010078 * <kw> contains an opening parenthesis or a comma, only the left part of it is
79 * checked.
Willy Tarreaua84d3742007-05-07 00:36:48 +020080 */
81struct acl_keyword *find_acl_kw(const char *kw)
82{
83 int index;
84 const char *kwend;
85 struct acl_kw_list *kwl;
86
Willy Tarreau4bfa4222013-12-16 22:01:06 +010087 kwend = kw;
Willy Tarreaued2c6622020-02-14 18:27:10 +010088 while (is_idchar(*kwend))
Willy Tarreau4bfa4222013-12-16 22:01:06 +010089 kwend++;
Willy Tarreaua84d3742007-05-07 00:36:48 +020090
91 list_for_each_entry(kwl, &acl_keywords.list, list) {
92 for (index = 0; kwl->kw[index].kw != NULL; index++) {
93 if ((strncmp(kwl->kw[index].kw, kw, kwend - kw) == 0) &&
94 kwl->kw[index].kw[kwend-kw] == 0)
95 return &kwl->kw[index];
96 }
97 }
98 return NULL;
99}
100
Willy Tarreaua84d3742007-05-07 00:36:48 +0200101static struct acl_expr *prune_acl_expr(struct acl_expr *expr)
102{
Willy Tarreau34db1082012-04-19 17:16:54 +0200103 struct arg *arg;
104
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100105 pattern_prune(&expr->pat);
Willy Tarreau34db1082012-04-19 17:16:54 +0200106
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100107 for (arg = expr->smp->arg_p; arg; arg++) {
Willy Tarreau34db1082012-04-19 17:16:54 +0200108 if (arg->type == ARGT_STOP)
109 break;
Willy Tarreau496aa012012-06-01 10:38:29 +0200110 if (arg->type == ARGT_STR || arg->unresolved) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +0200111 chunk_destroy(&arg->data.str);
Willy Tarreau496aa012012-06-01 10:38:29 +0200112 arg->unresolved = 0;
Willy Tarreau34db1082012-04-19 17:16:54 +0200113 }
Willy Tarreau34db1082012-04-19 17:16:54 +0200114 }
115
Tim Duesterhus9fa0df52020-07-04 11:49:38 +0200116 release_sample_expr(expr->smp);
117
Willy Tarreaua84d3742007-05-07 00:36:48 +0200118 return expr;
119}
120
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200121/* Parse an ACL expression starting at <args>[0], and return it. If <err> is
122 * not NULL, it will be filled with a pointer to an error message in case of
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200123 * error. This pointer must be freeable or NULL. <al> is an arg_list serving
124 * as a list head to report missing dependencies.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200125 *
Willy Tarreaua84d3742007-05-07 00:36:48 +0200126 * Right now, the only accepted syntax is :
127 * <subject> [<value>...]
128 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100129struct acl_expr *parse_acl_expr(const char **args, char **err, struct arg_list *al,
130 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200131{
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100132 __label__ out_return, out_free_expr;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200133 struct acl_expr *expr;
134 struct acl_keyword *aclkw;
Christopher Faulet54ceb042017-06-14 14:41:33 +0200135 int refflags, patflags;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200136 const char *arg;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100137 struct sample_expr *smp = NULL;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100138 int idx = 0;
139 char *ckw = NULL;
140 const char *begw;
141 const char *endw;
Willy Tarreau131b4662013-12-13 01:08:36 +0100142 const char *endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100143 int cur_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100144 int nbargs;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100145 int operator = STD_OP_EQ;
146 int op;
147 int contain_colon, have_dot;
148 const char *dot;
149 signed long long value, minor;
150 /* The following buffer contain two numbers, a ':' separator and the final \0. */
151 char buffer[NB_LLMAX_STR + 1 + NB_LLMAX_STR + 1];
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100152 int is_loaded;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100153 int unique_id;
154 char *error;
155 struct pat_ref *ref;
156 struct pattern_expr *pattern_expr;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100157 int load_as_map = 0;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200158 int acl_conv_found = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200159
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100160 /* First, we look for an ACL keyword. And if we don't find one, then
161 * we look for a sample fetch expression starting with a sample fetch
162 * keyword.
Willy Tarreaubef91e72013-03-31 23:14:46 +0200163 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100164
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100165 al->ctx = ARGC_ACL; // to report errors while resolving args late
Willy Tarreau131b4662013-12-13 01:08:36 +0100166 al->kw = *args;
167 al->conv = NULL;
168
Willy Tarreaua84d3742007-05-07 00:36:48 +0200169 aclkw = find_acl_kw(args[0]);
Willy Tarreau20490922014-03-17 18:04:27 +0100170 if (aclkw) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100171 /* OK we have a real ACL keyword */
Willy Tarreau9987ea92013-06-11 21:09:06 +0200172
Willy Tarreau131b4662013-12-13 01:08:36 +0100173 /* build new sample expression for this ACL */
Vincent Bernat02779b62016-04-03 13:48:43 +0200174 smp = calloc(1, sizeof(*smp));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100175 if (!smp) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100176 memprintf(err, "out of memory when parsing ACL expression");
177 goto out_return;
178 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100179 LIST_INIT(&(smp->conv_exprs));
180 smp->fetch = aclkw->smp;
181 smp->arg_p = empty_arg_list;
Willy Tarreau34db1082012-04-19 17:16:54 +0200182
Joseph Herlant68082792018-11-15 14:55:09 -0800183 /* look for the beginning of the subject arguments */
Willy Tarreaued2c6622020-02-14 18:27:10 +0100184 for (arg = args[0]; is_idchar(*arg); arg++)
185 ;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100186
Willy Tarreau131b4662013-12-13 01:08:36 +0100187 /* At this point, we have :
188 * - args[0] : beginning of the keyword
189 * - arg : end of the keyword, first character not part of keyword
Willy Tarreau131b4662013-12-13 01:08:36 +0100190 */
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100191 nbargs = make_arg_list(arg, -1, smp->fetch->arg_mask, &smp->arg_p,
192 err, &endt, NULL, al);
Willy Tarreau131b4662013-12-13 01:08:36 +0100193 if (nbargs < 0) {
194 /* note that make_arg_list will have set <err> here */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100195 memprintf(err, "ACL keyword '%s' : %s", aclkw->kw, *err);
196 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100197 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100198
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100199 if (!smp->arg_p) {
200 smp->arg_p = empty_arg_list;
Willy Tarreau131b4662013-12-13 01:08:36 +0100201 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100202 else if (smp->fetch->val_args && !smp->fetch->val_args(smp->arg_p, err)) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100203 /* invalid keyword argument, error must have been
204 * set by val_args().
205 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100206 memprintf(err, "in argument to '%s', %s", aclkw->kw, *err);
207 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100208 }
209 arg = endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100210
Joseph Herlant68082792018-11-15 14:55:09 -0800211 /* look for the beginning of the converters list. Those directly attached
Willy Tarreau131b4662013-12-13 01:08:36 +0100212 * to the ACL keyword are found just after <arg> which points to the comma.
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200213 * If we find any converter, then we don't use the ACL keyword's match
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200214 * anymore but the one related to the converter's output type.
Willy Tarreau131b4662013-12-13 01:08:36 +0100215 */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200216 cur_type = smp->fetch->out_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100217 while (*arg) {
218 struct sample_conv *conv;
219 struct sample_conv_expr *conv_expr;
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100220 int err_arg;
221 int argcnt;
Willy Tarreau131b4662013-12-13 01:08:36 +0100222
223 if (*arg && *arg != ',') {
224 if (ckw)
Willy Tarreau97108e02016-11-25 07:33:24 +0100225 memprintf(err, "ACL keyword '%s' : missing comma after converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100226 aclkw->kw, ckw);
Willy Tarreau131b4662013-12-13 01:08:36 +0100227 else
228 memprintf(err, "ACL keyword '%s' : missing comma after fetch keyword.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100229 aclkw->kw);
230 goto out_free_smp;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200231 }
Willy Tarreauae52f062012-04-26 12:13:35 +0200232
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100233 /* FIXME: how long should we support such idiocies ? Maybe we
234 * should already warn ?
235 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100236 while (*arg == ',') /* then trailing commas */
237 arg++;
Willy Tarreau2e845be2012-10-19 19:49:09 +0200238
Willy Tarreau97108e02016-11-25 07:33:24 +0100239 begw = arg; /* start of converter keyword */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100240
Willy Tarreau131b4662013-12-13 01:08:36 +0100241 if (!*begw)
242 /* none ? end of converters */
243 break;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100244
Willy Tarreaued2c6622020-02-14 18:27:10 +0100245 for (endw = begw; is_idchar(*endw); endw++)
246 ;
Willy Tarreau9ca69362013-10-22 19:10:06 +0200247
Willy Tarreau131b4662013-12-13 01:08:36 +0100248 free(ckw);
249 ckw = my_strndup(begw, endw - begw);
Willy Tarreauf75d0082013-04-07 21:20:44 +0200250
Willy Tarreau131b4662013-12-13 01:08:36 +0100251 conv = find_sample_conv(begw, endw - begw);
252 if (!conv) {
253 /* Unknown converter method */
Willy Tarreau97108e02016-11-25 07:33:24 +0100254 memprintf(err, "ACL keyword '%s' : unknown converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100255 aclkw->kw, ckw);
256 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100257 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100258
Willy Tarreau131b4662013-12-13 01:08:36 +0100259 arg = endw;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100260
Willy Tarreau131b4662013-12-13 01:08:36 +0100261 if (conv->in_type >= SMP_TYPES || conv->out_type >= SMP_TYPES) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100262 memprintf(err, "ACL keyword '%s' : returns type of converter '%s' is unknown.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100263 aclkw->kw, ckw);
264 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100265 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100266
Willy Tarreau131b4662013-12-13 01:08:36 +0100267 /* If impossible type conversion */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200268 if (!sample_casts[cur_type][conv->in_type]) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100269 memprintf(err, "ACL keyword '%s' : converter '%s' cannot be applied.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100270 aclkw->kw, ckw);
271 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100272 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100273
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200274 cur_type = conv->out_type;
Vincent Bernat02779b62016-04-03 13:48:43 +0200275 conv_expr = calloc(1, sizeof(*conv_expr));
Willy Tarreau131b4662013-12-13 01:08:36 +0100276 if (!conv_expr)
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100277 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100278
Willy Tarreau2b718102021-04-21 07:32:39 +0200279 LIST_APPEND(&(smp->conv_exprs), &(conv_expr->list));
Willy Tarreau131b4662013-12-13 01:08:36 +0100280 conv_expr->conv = conv;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200281 acl_conv_found = 1;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100282
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100283 al->kw = smp->fetch->kw;
284 al->conv = conv_expr->conv->kw;
285 argcnt = make_arg_list(endw, -1, conv->arg_mask, &conv_expr->arg_p, err, &arg, &err_arg, al);
286 if (argcnt < 0) {
287 memprintf(err, "ACL keyword '%s' : invalid arg %d in converter '%s' : %s.",
288 aclkw->kw, err_arg+1, ckw, *err);
289 goto out_free_smp;
290 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100291
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100292 if (argcnt && !conv->arg_mask) {
293 memprintf(err, "converter '%s' does not support any args", ckw);
294 goto out_free_smp;
295 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100296
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100297 if (!conv_expr->arg_p)
298 conv_expr->arg_p = empty_arg_list;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100299
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100300 if (conv->val_args && !conv->val_args(conv_expr->arg_p, conv, file, line, err)) {
301 memprintf(err, "ACL keyword '%s' : invalid args in converter '%s' : %s.",
302 aclkw->kw, ckw, *err);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100303 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100304 }
Willy Tarreau61612d42012-04-19 18:42:05 +0200305 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100306 ha_free(&ckw);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200307 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100308 else {
309 /* This is not an ACL keyword, so we hope this is a sample fetch
310 * keyword that we're going to transparently use as an ACL. If
311 * so, we retrieve a completely parsed expression with args and
312 * convs already done.
313 */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100314 smp = sample_parse_expr((char **)args, &idx, file, line, err, al, NULL);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100315 if (!smp) {
316 memprintf(err, "%s in ACL expression '%s'", *err, *args);
317 goto out_return;
318 }
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200319 cur_type = smp_expr_output_type(smp);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100320 }
321
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200322 expr = calloc(1, sizeof(*expr));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100323 if (!expr) {
324 memprintf(err, "out of memory when parsing ACL expression");
Christopher Faulet361935a2019-09-13 09:50:15 +0200325 goto out_free_smp;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100326 }
327
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100328 pattern_init_head(&expr->pat);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100329
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200330 expr->pat.expect_type = cur_type;
331 expr->smp = smp;
332 expr->kw = smp->fetch->kw;
333 smp = NULL; /* don't free it anymore */
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100334
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200335 if (aclkw && !acl_conv_found) {
336 expr->kw = aclkw->kw;
337 expr->pat.parse = aclkw->parse ? aclkw->parse : pat_parse_fcts[aclkw->match_type];
338 expr->pat.index = aclkw->index ? aclkw->index : pat_index_fcts[aclkw->match_type];
339 expr->pat.match = aclkw->match ? aclkw->match : pat_match_fcts[aclkw->match_type];
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200340 expr->pat.prune = aclkw->prune ? aclkw->prune : pat_prune_fcts[aclkw->match_type];
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100341 }
342
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100343 if (!expr->pat.parse) {
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200344 /* Parse/index/match functions depend on the expression type,
345 * so we have to map them now. Some types can be automatically
346 * converted.
347 */
348 switch (cur_type) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100349 case SMP_T_BOOL:
350 expr->pat.parse = pat_parse_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100351 expr->pat.index = pat_index_fcts[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100352 expr->pat.match = pat_match_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100353 expr->pat.prune = pat_prune_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100354 expr->pat.expect_type = pat_match_types[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100355 break;
356 case SMP_T_SINT:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100357 expr->pat.parse = pat_parse_fcts[PAT_MATCH_INT];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100358 expr->pat.index = pat_index_fcts[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100359 expr->pat.match = pat_match_fcts[PAT_MATCH_INT];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100360 expr->pat.prune = pat_prune_fcts[PAT_MATCH_INT];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100361 expr->pat.expect_type = pat_match_types[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100362 break;
Willy Tarreau78c5eec2019-04-19 11:45:20 +0200363 case SMP_T_ADDR:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100364 case SMP_T_IPV4:
365 case SMP_T_IPV6:
366 expr->pat.parse = pat_parse_fcts[PAT_MATCH_IP];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100367 expr->pat.index = pat_index_fcts[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100368 expr->pat.match = pat_match_fcts[PAT_MATCH_IP];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100369 expr->pat.prune = pat_prune_fcts[PAT_MATCH_IP];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100370 expr->pat.expect_type = pat_match_types[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100371 break;
Thierry FOURNIER9fefbd52014-05-11 15:15:00 +0200372 case SMP_T_STR:
373 expr->pat.parse = pat_parse_fcts[PAT_MATCH_STR];
374 expr->pat.index = pat_index_fcts[PAT_MATCH_STR];
375 expr->pat.match = pat_match_fcts[PAT_MATCH_STR];
Thierry FOURNIER9fefbd52014-05-11 15:15:00 +0200376 expr->pat.prune = pat_prune_fcts[PAT_MATCH_STR];
377 expr->pat.expect_type = pat_match_types[PAT_MATCH_STR];
378 break;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100379 }
380 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200381
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100382 /* Additional check to protect against common mistakes */
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100383 if (expr->pat.parse && cur_type != SMP_T_BOOL && !*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100384 ha_warning("parsing acl keyword '%s' :\n"
385 " no pattern to match against were provided, so this ACL will never match.\n"
386 " If this is what you intended, please add '--' to get rid of this warning.\n"
387 " If you intended to match only for existence, please use '-m found'.\n"
388 " If you wanted to force an int to match as a bool, please use '-m bool'.\n"
389 "\n",
390 args[0]);
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100391 }
392
Willy Tarreaua84d3742007-05-07 00:36:48 +0200393 args++;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200394
395 /* check for options before patterns. Supported options are :
396 * -i : ignore case for all patterns by default
397 * -f : read patterns from those files
Willy Tarreau5adeda12013-03-31 22:13:34 +0200398 * -m : force matching method (must be used before -f)
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100399 * -M : load the file as map file
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100400 * -u : force the unique id of the acl
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200401 * -- : everything after this is not an option
402 */
Christopher Faulet54ceb042017-06-14 14:41:33 +0200403 refflags = PAT_REF_ACL;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200404 patflags = 0;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100405 is_loaded = 0;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100406 unique_id = -1;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200407 while (**args == '-') {
Willy Tarreau2039bba2014-05-11 09:43:46 +0200408 if (strcmp(*args, "-i") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200409 patflags |= PAT_MF_IGNORE_CASE;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200410 else if (strcmp(*args, "-n") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200411 patflags |= PAT_MF_NO_DNS;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200412 else if (strcmp(*args, "-u") == 0) {
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100413 unique_id = strtol(args[1], &error, 10);
414 if (*error != '\0') {
415 memprintf(err, "the argument of -u must be an integer");
416 goto out_free_expr;
417 }
418
419 /* Check if this id is really unique. */
420 if (pat_ref_lookupid(unique_id)) {
421 memprintf(err, "the id is already used");
422 goto out_free_expr;
423 }
424
425 args++;
426 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200427 else if (strcmp(*args, "-f") == 0) {
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100428 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200429 memprintf(err, "matching method must be specified first (using '-m') when using a sample fetch of this type ('%s')", expr->kw);
Willy Tarreaubef91e72013-03-31 23:14:46 +0200430 goto out_free_expr;
431 }
432
Christopher Faulet54ceb042017-06-14 14:41:33 +0200433 if (!pattern_read_from_file(&expr->pat, refflags, args[1], patflags, load_as_map, err, file, line))
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200434 goto out_free_expr;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100435 is_loaded = 1;
Willy Tarreau5adeda12013-03-31 22:13:34 +0200436 args++;
437 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200438 else if (strcmp(*args, "-m") == 0) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200439 int idx;
440
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100441 if (is_loaded) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200442 memprintf(err, "'-m' must only be specified before patterns and files in parsing ACL expression");
443 goto out_free_expr;
444 }
445
Willy Tarreau6f8fe312013-11-28 22:24:25 +0100446 idx = pat_find_match_name(args[1]);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200447 if (idx < 0) {
448 memprintf(err, "unknown matching method '%s' when parsing ACL expression", args[1]);
449 goto out_free_expr;
450 }
451
452 /* Note: -m found is always valid, bool/int are compatible, str/bin/reg/len are compatible */
Willy Tarreau9bb49f62015-09-24 16:37:12 +0200453 if (idx != PAT_MATCH_FOUND && !sample_casts[cur_type][pat_match_types[idx]]) {
Willy Tarreau93fddf12013-03-31 22:59:32 +0200454 memprintf(err, "matching method '%s' cannot be used with fetch keyword '%s'", args[1], expr->kw);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200455 goto out_free_expr;
456 }
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100457 expr->pat.parse = pat_parse_fcts[idx];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100458 expr->pat.index = pat_index_fcts[idx];
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100459 expr->pat.match = pat_match_fcts[idx];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100460 expr->pat.prune = pat_prune_fcts[idx];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100461 expr->pat.expect_type = pat_match_types[idx];
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200462 args++;
463 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200464 else if (strcmp(*args, "-M") == 0) {
Christopher Faulet54ceb042017-06-14 14:41:33 +0200465 refflags |= PAT_REF_MAP;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100466 load_as_map = 1;
467 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200468 else if (strcmp(*args, "--") == 0) {
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200469 args++;
470 break;
471 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200472 else {
473 memprintf(err, "'%s' is not a valid ACL option. Please use '--' before any pattern beginning with a '-'", args[0]);
474 goto out_free_expr;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200475 break;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200476 }
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200477 args++;
478 }
479
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100480 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200481 memprintf(err, "matching method must be specified first (using '-m') when using a sample fetch of this type ('%s')", expr->kw);
Willy Tarreaubef91e72013-03-31 23:14:46 +0200482 goto out_free_expr;
483 }
484
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100485 /* Create displayed reference */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200486 snprintf(trash.area, trash.size, "acl '%s' file '%s' line %d",
487 expr->kw, file, line);
488 trash.area[trash.size - 1] = '\0';
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100489
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500490 /* Create new pattern reference. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200491 ref = pat_ref_newid(unique_id, trash.area, PAT_REF_ACL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100492 if (!ref) {
493 memprintf(err, "memory error");
494 goto out_free_expr;
495 }
496
497 /* Create new pattern expression associated to this reference. */
Emeric Brun7d27f3c2017-07-03 17:54:23 +0200498 pattern_expr = pattern_new_expr(&expr->pat, ref, patflags, err, NULL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100499 if (!pattern_expr)
500 goto out_free_expr;
501
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200502 /* now parse all patterns */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100503 while (**args) {
504 arg = *args;
505
506 /* Compatibility layer. Each pattern can parse only one string per pattern,
507 * but the pat_parser_int() and pat_parse_dotted_ver() parsers were need
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500508 * optionally two operators. The first operator is the match method: eq,
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100509 * le, lt, ge and gt. pat_parse_int() and pat_parse_dotted_ver() functions
510 * can have a compatibility syntax based on ranges:
511 *
512 * pat_parse_int():
513 *
514 * "eq x" -> "x" or "x:x"
515 * "le x" -> ":x"
516 * "lt x" -> ":y" (with y = x - 1)
517 * "ge x" -> "x:"
518 * "gt x" -> "y:" (with y = x + 1)
519 *
520 * pat_parse_dotted_ver():
521 *
522 * "eq x.y" -> "x.y" or "x.y:x.y"
523 * "le x.y" -> ":x.y"
524 * "lt x.y" -> ":w.z" (with w.z = x.y - 1)
525 * "ge x.y" -> "x.y:"
526 * "gt x.y" -> "w.z:" (with w.z = x.y + 1)
527 *
528 * If y is not present, assume that is "0".
529 *
530 * The syntax eq, le, lt, ge and gt are proper to the acl syntax. The
531 * following block of code detect the operator, and rewrite each value
532 * in parsable string.
533 */
534 if (expr->pat.parse == pat_parse_int ||
535 expr->pat.parse == pat_parse_dotted_ver) {
536 /* Check for operator. If the argument is operator, memorise it and
537 * continue to the next argument.
538 */
539 op = get_std_op(arg);
540 if (op != -1) {
541 operator = op;
542 args++;
543 continue;
544 }
545
546 /* Check if the pattern contain ':' or '-' character. */
547 contain_colon = (strchr(arg, ':') || strchr(arg, '-'));
548
549 /* If the pattern contain ':' or '-' character, give it to the parser as is.
550 * If no contain ':' and operator is STD_OP_EQ, give it to the parser as is.
551 * In other case, try to convert the value according with the operator.
552 */
553 if (!contain_colon && operator != STD_OP_EQ) {
554 /* Search '.' separator. */
555 dot = strchr(arg, '.');
556 if (!dot) {
557 have_dot = 0;
558 minor = 0;
559 dot = arg + strlen(arg);
560 }
561 else
562 have_dot = 1;
563
564 /* convert the integer minor part for the pat_parse_dotted_ver() function. */
565 if (expr->pat.parse == pat_parse_dotted_ver && have_dot) {
566 if (strl2llrc(dot+1, strlen(dot+1), &minor) != 0) {
567 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100568 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100569 }
570 if (minor >= 65536) {
571 memprintf(err, "'%s' contains too large a minor value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100572 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100573 }
574 }
575
576 /* convert the integer value for the pat_parse_int() function, and the
577 * integer major part for the pat_parse_dotted_ver() function.
578 */
579 if (strl2llrc(arg, dot - arg, &value) != 0) {
580 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100581 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100582 }
583 if (expr->pat.parse == pat_parse_dotted_ver) {
584 if (value >= 65536) {
585 memprintf(err, "'%s' contains too large a major value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100586 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100587 }
588 value = (value << 16) | (minor & 0xffff);
589 }
590
591 switch (operator) {
592
593 case STD_OP_EQ: /* this case is not possible. */
594 memprintf(err, "internal error");
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100595 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100596
597 case STD_OP_GT:
598 value++; /* gt = ge + 1 */
Tim Duesterhus588b3142020-05-29 14:35:51 +0200599 /* fall through */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100600
601 case STD_OP_GE:
602 if (expr->pat.parse == pat_parse_int)
603 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld:", value);
604 else
605 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld.%lld:",
606 value >> 16, value & 0xffff);
607 arg = buffer;
608 break;
609
610 case STD_OP_LT:
611 value--; /* lt = le - 1 */
Tim Duesterhus588b3142020-05-29 14:35:51 +0200612 /* fall through */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100613
614 case STD_OP_LE:
615 if (expr->pat.parse == pat_parse_int)
616 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld", value);
617 else
618 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld.%lld",
619 value >> 16, value & 0xffff);
620 arg = buffer;
621 break;
622 }
623 }
624 }
625
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100626 /* Add sample to the reference, and try to compile it fior each pattern
627 * using this value.
628 */
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200629 if (!pat_ref_add(ref, arg, NULL, err))
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100630 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100631 args++;
632 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200633
634 return expr;
635
Willy Tarreaua84d3742007-05-07 00:36:48 +0200636 out_free_expr:
637 prune_acl_expr(expr);
638 free(expr);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100639 out_free_smp:
Christopher Faulet361935a2019-09-13 09:50:15 +0200640 free(ckw);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100641 free(smp);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200642 out_return:
643 return NULL;
644}
645
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200646/* Purge everything in the acl <acl>, then return <acl>. */
647struct acl *prune_acl(struct acl *acl) {
648
649 struct acl_expr *expr, *exprb;
650
651 free(acl->name);
652
653 list_for_each_entry_safe(expr, exprb, &acl->expr, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200654 LIST_DELETE(&expr->list);
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200655 prune_acl_expr(expr);
656 free(expr);
657 }
658
659 return acl;
660}
661
Willy Tarreaua84d3742007-05-07 00:36:48 +0200662/* Parse an ACL with the name starting at <args>[0], and with a list of already
663 * known ACLs in <acl>. If the ACL was not in the list, it will be added.
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100664 * A pointer to that ACL is returned. If the ACL has an empty name, then it's
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200665 * an anonymous one and it won't be merged with any other one. If <err> is not
666 * NULL, it will be filled with an appropriate error. This pointer must be
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200667 * freeable or NULL. <al> is the arg_list serving as a head for unresolved
668 * dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200669 *
670 * args syntax: <aclname> <acl_expr>
671 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100672struct acl *parse_acl(const char **args, struct list *known_acl, char **err, struct arg_list *al,
673 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200674{
675 __label__ out_return, out_free_acl_expr, out_free_name;
676 struct acl *cur_acl;
677 struct acl_expr *acl_expr;
678 char *name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200679 const char *pos;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200680
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200681 if (**args && (pos = invalid_char(*args))) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200682 memprintf(err, "invalid character in ACL name : '%c'", *pos);
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100683 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200684 }
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100685
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100686 acl_expr = parse_acl_expr(args + 1, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200687 if (!acl_expr) {
688 /* parse_acl_expr will have filled <err> here */
Willy Tarreaua84d3742007-05-07 00:36:48 +0200689 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200690 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200691
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200692 /* Check for args beginning with an opening parenthesis just after the
693 * subject, as this is almost certainly a typo. Right now we can only
694 * emit a warning, so let's do so.
695 */
Krzysztof Piotr Oledzki4cdd8312009-10-05 00:23:35 +0200696 if (!strchr(args[1], '(') && *args[2] == '(')
Christopher Faulet767a84b2017-11-24 16:50:31 +0100697 ha_warning("parsing acl '%s' :\n"
698 " matching '%s' for pattern '%s' is likely a mistake and probably\n"
699 " not what you want. Maybe you need to remove the extraneous space before '('.\n"
700 " If you are really sure this is not an error, please insert '--' between the\n"
701 " match and the pattern to make this warning message disappear.\n",
702 args[0], args[1], args[2]);
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200703
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100704 if (*args[0])
705 cur_acl = find_acl_by_name(args[0], known_acl);
706 else
707 cur_acl = NULL;
708
Willy Tarreaua84d3742007-05-07 00:36:48 +0200709 if (!cur_acl) {
710 name = strdup(args[0]);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200711 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200712 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200713 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200714 }
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200715 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200716 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200717 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200718 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200719 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200720
721 LIST_INIT(&cur_acl->expr);
Willy Tarreau2b718102021-04-21 07:32:39 +0200722 LIST_APPEND(known_acl, &cur_acl->list);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200723 cur_acl->name = name;
724 }
725
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100726 /* We want to know what features the ACL needs (typically HTTP parsing),
727 * and where it may be used. If an ACL relies on multiple matches, it is
728 * OK if at least one of them may match in the context where it is used.
729 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100730 cur_acl->use |= acl_expr->smp->fetch->use;
731 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreau2b718102021-04-21 07:32:39 +0200732 LIST_APPEND(&cur_acl->expr, &acl_expr->list);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200733 return cur_acl;
734
735 out_free_name:
736 free(name);
737 out_free_acl_expr:
738 prune_acl_expr(acl_expr);
739 free(acl_expr);
740 out_return:
741 return NULL;
742}
743
Willy Tarreau16fbe822007-06-17 11:54:31 +0200744/* Some useful ACLs provided by default. Only those used are allocated. */
745
746const struct {
747 const char *name;
748 const char *expr[4]; /* put enough for longest expression */
749} default_acl_list[] = {
Willy Tarreau58393e12008-07-20 10:39:22 +0200750 { .name = "TRUE", .expr = {"always_true",""}},
751 { .name = "FALSE", .expr = {"always_false",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200752 { .name = "LOCALHOST", .expr = {"src","127.0.0.1/8",""}},
Christopher Faulet779184e2021-04-01 17:24:04 +0200753 { .name = "HTTP", .expr = {"req.proto_http",""}},
754 { .name = "HTTP_1.0", .expr = {"req.ver","1.0",""}},
755 { .name = "HTTP_1.1", .expr = {"req.ver","1.1",""}},
Christopher Faulet8043e832021-03-26 16:00:54 +0100756 { .name = "HTTP_2.0", .expr = {"req.ver","2.0",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200757 { .name = "METH_CONNECT", .expr = {"method","CONNECT",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200758 { .name = "METH_DELETE", .expr = {"method","DELETE",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200759 { .name = "METH_GET", .expr = {"method","GET","HEAD",""}},
760 { .name = "METH_HEAD", .expr = {"method","HEAD",""}},
761 { .name = "METH_OPTIONS", .expr = {"method","OPTIONS",""}},
762 { .name = "METH_POST", .expr = {"method","POST",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200763 { .name = "METH_PUT", .expr = {"method","PUT",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200764 { .name = "METH_TRACE", .expr = {"method","TRACE",""}},
765 { .name = "HTTP_URL_ABS", .expr = {"url_reg","^[^/:]*://",""}},
766 { .name = "HTTP_URL_SLASH", .expr = {"url_beg","/",""}},
767 { .name = "HTTP_URL_STAR", .expr = {"url","*",""}},
Christopher Faulet779184e2021-04-01 17:24:04 +0200768 { .name = "HTTP_CONTENT", .expr = {"req.hdr_val(content-length)","gt","0",""}},
769 { .name = "RDP_COOKIE", .expr = {"req.rdp_cookie_cnt","gt","0",""}},
770 { .name = "REQ_CONTENT", .expr = {"req.len","gt","0",""}},
Willy Tarreaub6fb4202008-07-20 11:18:28 +0200771 { .name = "WAIT_END", .expr = {"wait_end",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200772 { .name = NULL, .expr = {""}}
773};
774
775/* Find a default ACL from the default_acl list, compile it and return it.
776 * If the ACL is not found, NULL is returned. In theory, it cannot fail,
777 * except when default ACLs are broken, in which case it will return NULL.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200778 * If <known_acl> is not NULL, the ACL will be queued at its tail. If <err> is
779 * not NULL, it will be filled with an error message if an error occurs. This
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200780 * pointer must be freeable or NULL. <al> is an arg_list serving as a list head
781 * to report missing dependencies.
Willy Tarreau16fbe822007-06-17 11:54:31 +0200782 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200783static struct acl *find_acl_default(const char *acl_name, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100784 char **err, struct arg_list *al,
785 const char *file, int line)
Willy Tarreau16fbe822007-06-17 11:54:31 +0200786{
787 __label__ out_return, out_free_acl_expr, out_free_name;
788 struct acl *cur_acl;
789 struct acl_expr *acl_expr;
790 char *name;
791 int index;
792
793 for (index = 0; default_acl_list[index].name != NULL; index++) {
794 if (strcmp(acl_name, default_acl_list[index].name) == 0)
795 break;
796 }
797
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200798 if (default_acl_list[index].name == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200799 memprintf(err, "no such ACL : '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200800 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200801 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200802
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100803 acl_expr = parse_acl_expr((const char **)default_acl_list[index].expr, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200804 if (!acl_expr) {
805 /* parse_acl_expr must have filled err here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200806 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200807 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200808
809 name = strdup(acl_name);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200810 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200811 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200812 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200813 }
814
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200815 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200816 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200817 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200818 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200819 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200820
821 cur_acl->name = name;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100822 cur_acl->use |= acl_expr->smp->fetch->use;
823 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreau16fbe822007-06-17 11:54:31 +0200824 LIST_INIT(&cur_acl->expr);
Willy Tarreau2b718102021-04-21 07:32:39 +0200825 LIST_APPEND(&cur_acl->expr, &acl_expr->list);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200826 if (known_acl)
Willy Tarreau2b718102021-04-21 07:32:39 +0200827 LIST_APPEND(known_acl, &cur_acl->list);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200828
829 return cur_acl;
830
831 out_free_name:
832 free(name);
833 out_free_acl_expr:
834 prune_acl_expr(acl_expr);
835 free(acl_expr);
836 out_return:
837 return NULL;
838}
Willy Tarreaua84d3742007-05-07 00:36:48 +0200839
840/* Purge everything in the acl_cond <cond>, then return <cond>. */
841struct acl_cond *prune_acl_cond(struct acl_cond *cond)
842{
843 struct acl_term_suite *suite, *tmp_suite;
844 struct acl_term *term, *tmp_term;
845
846 /* iterate through all term suites and free all terms and all suites */
847 list_for_each_entry_safe(suite, tmp_suite, &cond->suites, list) {
848 list_for_each_entry_safe(term, tmp_term, &suite->terms, list)
849 free(term);
850 free(suite);
851 }
852 return cond;
853}
854
855/* Parse an ACL condition starting at <args>[0], relying on a list of already
856 * known ACLs passed in <known_acl>. The new condition is returned (or NULL in
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200857 * case of low memory). Supports multiple conditions separated by "or". If
858 * <err> is not NULL, it will be filled with a pointer to an error message in
859 * case of error, that the caller is responsible for freeing. The initial
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200860 * location must either be freeable or NULL. The list <al> serves as a list head
861 * for unresolved dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200862 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200863struct acl_cond *parse_acl_cond(const char **args, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100864 enum acl_cond_pol pol, char **err, struct arg_list *al,
865 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200866{
867 __label__ out_return, out_free_suite, out_free_term;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200868 int arg, neg;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200869 const char *word;
870 struct acl *cur_acl;
871 struct acl_term *cur_term;
872 struct acl_term_suite *cur_suite;
873 struct acl_cond *cond;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100874 unsigned int suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200875
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200876 cond = calloc(1, sizeof(*cond));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200877 if (cond == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200878 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200879 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200880 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200881
882 LIST_INIT(&cond->list);
883 LIST_INIT(&cond->suites);
884 cond->pol = pol;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100885 cond->val = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200886
887 cur_suite = NULL;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100888 suite_val = ~0U;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200889 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200890 for (arg = 0; *args[arg]; arg++) {
891 word = args[arg];
892
893 /* remove as many exclamation marks as we can */
894 while (*word == '!') {
895 neg = !neg;
896 word++;
897 }
898
899 /* an empty word is allowed because we cannot force the user to
900 * always think about not leaving exclamation marks alone.
901 */
902 if (!*word)
903 continue;
904
Willy Tarreau16fbe822007-06-17 11:54:31 +0200905 if (strcasecmp(word, "or") == 0 || strcmp(word, "||") == 0) {
Willy Tarreaua84d3742007-05-07 00:36:48 +0200906 /* new term suite */
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100907 cond->val |= suite_val;
908 suite_val = ~0U;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200909 cur_suite = NULL;
910 neg = 0;
911 continue;
912 }
913
Willy Tarreau95fa4692010-02-01 13:05:50 +0100914 if (strcmp(word, "{") == 0) {
915 /* we may have a complete ACL expression between two braces,
916 * find the last one.
917 */
918 int arg_end = arg + 1;
919 const char **args_new;
920
921 while (*args[arg_end] && strcmp(args[arg_end], "}") != 0)
922 arg_end++;
923
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200924 if (!*args[arg_end]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200925 memprintf(err, "missing closing '}' in condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100926 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200927 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100928
929 args_new = calloc(1, (arg_end - arg + 1) * sizeof(*args_new));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200930 if (!args_new) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200931 memprintf(err, "out of memory when parsing condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100932 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200933 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100934
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100935 args_new[0] = "";
Willy Tarreau95fa4692010-02-01 13:05:50 +0100936 memcpy(args_new + 1, args + arg + 1, (arg_end - arg) * sizeof(*args_new));
937 args_new[arg_end - arg] = "";
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100938 cur_acl = parse_acl(args_new, known_acl, err, al, file, line);
Willy Tarreau95fa4692010-02-01 13:05:50 +0100939 free(args_new);
940
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200941 if (!cur_acl) {
942 /* note that parse_acl() must have filled <err> here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200943 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200944 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100945 arg = arg_end;
946 }
947 else {
948 /* search for <word> in the known ACL names. If we do not find
949 * it, let's look for it in the default ACLs, and if found, add
950 * it to the list of ACLs of this proxy. This makes it possible
951 * to override them.
952 */
953 cur_acl = find_acl_by_name(word, known_acl);
954 if (cur_acl == NULL) {
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100955 cur_acl = find_acl_default(word, known_acl, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200956 if (cur_acl == NULL) {
957 /* note that find_acl_default() must have filled <err> here */
Willy Tarreau95fa4692010-02-01 13:05:50 +0100958 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200959 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100960 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200961 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200962
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200963 cur_term = calloc(1, sizeof(*cur_term));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200964 if (cur_term == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200965 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200966 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200967 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200968
969 cur_term->acl = cur_acl;
970 cur_term->neg = neg;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100971
972 /* Here it is a bit complex. The acl_term_suite is a conjunction
973 * of many terms. It may only be used if all of its terms are
974 * usable at the same time. So the suite's validity domain is an
975 * AND between all ACL keywords' ones. But, the global condition
976 * is valid if at least one term suite is OK. So it's an OR between
977 * all of their validity domains. We could emit a warning as soon
978 * as suite_val is null because it means that the last ACL is not
979 * compatible with the previous ones. Let's remain simple for now.
980 */
981 cond->use |= cur_acl->use;
982 suite_val &= cur_acl->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200983
984 if (!cur_suite) {
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200985 cur_suite = calloc(1, sizeof(*cur_suite));
Willy Tarreauf678b7f2013-01-24 00:25:39 +0100986 if (cur_suite == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200987 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200988 goto out_free_term;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200989 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200990 LIST_INIT(&cur_suite->terms);
Willy Tarreau2b718102021-04-21 07:32:39 +0200991 LIST_APPEND(&cond->suites, &cur_suite->list);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200992 }
Willy Tarreau2b718102021-04-21 07:32:39 +0200993 LIST_APPEND(&cur_suite->terms, &cur_term->list);
Willy Tarreau74b98a82007-06-16 19:35:18 +0200994 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200995 }
996
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100997 cond->val |= suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200998 return cond;
999
1000 out_free_term:
1001 free(cur_term);
1002 out_free_suite:
1003 prune_acl_cond(cond);
1004 free(cond);
1005 out_return:
1006 return NULL;
1007}
1008
Willy Tarreau2bbba412010-01-28 16:48:33 +01001009/* Builds an ACL condition starting at the if/unless keyword. The complete
1010 * condition is returned. NULL is returned in case of error or if the first
1011 * word is neither "if" nor "unless". It automatically sets the file name and
Willy Tarreau25320b22013-03-24 07:22:08 +01001012 * the line number in the condition for better error reporting, and sets the
1013 * HTTP intiailization requirements in the proxy. If <err> is not NULL, it will
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001014 * be filled with a pointer to an error message in case of error, that the
1015 * caller is responsible for freeing. The initial location must either be
1016 * freeable or NULL.
Willy Tarreau2bbba412010-01-28 16:48:33 +01001017 */
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001018struct acl_cond *build_acl_cond(const char *file, int line, struct list *known_acl,
1019 struct proxy *px, const char **args, char **err)
Willy Tarreau2bbba412010-01-28 16:48:33 +01001020{
Willy Tarreau0cba6072013-11-28 22:21:02 +01001021 enum acl_cond_pol pol = ACL_COND_NONE;
Willy Tarreau2bbba412010-01-28 16:48:33 +01001022 struct acl_cond *cond = NULL;
1023
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001024 if (err)
1025 *err = NULL;
1026
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001027 if (strcmp(*args, "if") == 0) {
Willy Tarreau2bbba412010-01-28 16:48:33 +01001028 pol = ACL_COND_IF;
1029 args++;
1030 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001031 else if (strcmp(*args, "unless") == 0) {
Willy Tarreau2bbba412010-01-28 16:48:33 +01001032 pol = ACL_COND_UNLESS;
1033 args++;
1034 }
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001035 else {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001036 memprintf(err, "conditions must start with either 'if' or 'unless'");
Willy Tarreau2bbba412010-01-28 16:48:33 +01001037 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001038 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001039
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001040 cond = parse_acl_cond(args, known_acl, pol, err, &px->conf.args, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001041 if (!cond) {
1042 /* note that parse_acl_cond must have filled <err> here */
Willy Tarreau2bbba412010-01-28 16:48:33 +01001043 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001044 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001045
1046 cond->file = file;
1047 cond->line = line;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001048 px->http_needed |= !!(cond->use & SMP_USE_HTTP_ANY);
Willy Tarreau2bbba412010-01-28 16:48:33 +01001049 return cond;
1050}
1051
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001052/* Execute condition <cond> and return either ACL_TEST_FAIL, ACL_TEST_MISS or
1053 * ACL_TEST_PASS depending on the test results. ACL_TEST_MISS may only be
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001054 * returned if <opt> does not contain SMP_OPT_FINAL, indicating that incomplete
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001055 * data is being examined. The function automatically sets SMP_OPT_ITERATE. This
1056 * function only computes the condition, it does not apply the polarity required
1057 * by IF/UNLESS, it's up to the caller to do this using something like this :
Willy Tarreau11382812008-07-09 16:18:21 +02001058 *
1059 * res = acl_pass(res);
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001060 * if (res == ACL_TEST_MISS)
Willy Tarreaub6866442008-07-14 23:54:42 +02001061 * return 0;
Willy Tarreau11382812008-07-09 16:18:21 +02001062 * if (cond->pol == ACL_COND_UNLESS)
1063 * res = !res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001064 */
Willy Tarreau192252e2015-04-04 01:47:55 +02001065enum acl_test_res acl_exec_cond(struct acl_cond *cond, struct proxy *px, struct session *sess, struct stream *strm, unsigned int opt)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001066{
1067 __label__ fetch_next;
1068 struct acl_term_suite *suite;
1069 struct acl_term *term;
1070 struct acl_expr *expr;
1071 struct acl *acl;
Willy Tarreau37406352012-04-23 16:16:37 +02001072 struct sample smp;
Willy Tarreau0cba6072013-11-28 22:21:02 +01001073 enum acl_test_res acl_res, suite_res, cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001074
Willy Tarreau7a777ed2012-04-26 11:44:02 +02001075 /* ACLs are iterated over all values, so let's always set the flag to
1076 * indicate this to the fetch functions.
1077 */
1078 opt |= SMP_OPT_ITERATE;
1079
Willy Tarreau11382812008-07-09 16:18:21 +02001080 /* We're doing a logical OR between conditions so we initialize to FAIL.
1081 * The MISS status is propagated down from the suites.
1082 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001083 cond_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001084 list_for_each_entry(suite, &cond->suites, list) {
Willy Tarreau11382812008-07-09 16:18:21 +02001085 /* Evaluate condition suite <suite>. We stop at the first term
Willy Tarreau0cba6072013-11-28 22:21:02 +01001086 * which returns ACL_TEST_FAIL. The MISS status is still propagated
Willy Tarreau11382812008-07-09 16:18:21 +02001087 * in case of uncertainty in the result.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001088 */
1089
1090 /* we're doing a logical AND between terms, so we must set the
1091 * initial value to PASS.
1092 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001093 suite_res = ACL_TEST_PASS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001094 list_for_each_entry(term, &suite->terms, list) {
1095 acl = term->acl;
1096
1097 /* FIXME: use cache !
1098 * check acl->cache_idx for this.
1099 */
1100
1101 /* ACL result not cached. Let's scan all the expressions
1102 * and use the first one to match.
1103 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001104 acl_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001105 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaud41f8d82007-06-10 10:06:18 +02001106 /* we need to reset context and flags */
Willy Tarreau37406352012-04-23 16:16:37 +02001107 memset(&smp, 0, sizeof(smp));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001108 fetch_next:
Willy Tarreau192252e2015-04-04 01:47:55 +02001109 if (!sample_process(px, sess, strm, opt, expr->smp, &smp)) {
Willy Tarreaub6866442008-07-14 23:54:42 +02001110 /* maybe we could not fetch because of missing data */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001111 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001112 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001113 continue;
Willy Tarreaub6866442008-07-14 23:54:42 +02001114 }
Willy Tarreauc4262962010-05-10 23:42:40 +02001115
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +01001116 acl_res |= pat2acl(pattern_exec_match(&expr->pat, &smp, 0));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001117 /*
Willy Tarreau11382812008-07-09 16:18:21 +02001118 * OK now acl_res holds the result of this expression
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001119 * as one of ACL_TEST_FAIL, ACL_TEST_MISS or ACL_TEST_PASS.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001120 *
Willy Tarreau11382812008-07-09 16:18:21 +02001121 * Then if (!MISS) we can cache the result, and put
Willy Tarreau37406352012-04-23 16:16:37 +02001122 * (smp.flags & SMP_F_VOLATILE) in the cache flags.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001123 *
1124 * FIXME: implement cache.
1125 *
1126 */
1127
Willy Tarreau11382812008-07-09 16:18:21 +02001128 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001129 if (acl_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001130 break;
1131
Willy Tarreau37406352012-04-23 16:16:37 +02001132 if (smp.flags & SMP_F_NOT_LAST)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001133 goto fetch_next;
Willy Tarreaub6866442008-07-14 23:54:42 +02001134
1135 /* sometimes we know the fetched data is subject to change
1136 * later and give another chance for a new match (eg: request
1137 * size, time, ...)
1138 */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001139 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001140 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001141 }
1142 /*
1143 * Here we have the result of an ACL (cached or not).
1144 * ACLs are combined, negated or not, to form conditions.
1145 */
1146
Willy Tarreaua84d3742007-05-07 00:36:48 +02001147 if (term->neg)
Willy Tarreau11382812008-07-09 16:18:21 +02001148 acl_res = acl_neg(acl_res);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001149
1150 suite_res &= acl_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001151
Willy Tarreau79c412b2013-10-30 19:30:32 +01001152 /* we're ANDing these terms, so a single FAIL or MISS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001153 if (suite_res != ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001154 break;
1155 }
1156 cond_res |= suite_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001157
1158 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001159 if (cond_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001160 break;
1161 }
Willy Tarreau11382812008-07-09 16:18:21 +02001162 return cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001163}
1164
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001165/* Returns a pointer to the first ACL conflicting with usage at place <where>
1166 * which is one of the SMP_VAL_* bits indicating a check place, or NULL if
1167 * no conflict is found. Only full conflicts are detected (ACL is not usable).
1168 * Use the next function to check for useless keywords.
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001169 */
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001170const struct acl *acl_cond_conflicts(const struct acl_cond *cond, unsigned int where)
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001171{
1172 struct acl_term_suite *suite;
1173 struct acl_term *term;
1174 struct acl *acl;
1175
1176 list_for_each_entry(suite, &cond->suites, list) {
1177 list_for_each_entry(term, &suite->terms, list) {
1178 acl = term->acl;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001179 if (!(acl->val & where))
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001180 return acl;
1181 }
1182 }
1183 return NULL;
1184}
1185
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001186/* Returns a pointer to the first ACL and its first keyword to conflict with
1187 * usage at place <where> which is one of the SMP_VAL_* bits indicating a check
1188 * place. Returns true if a conflict is found, with <acl> and <kw> set (if non
1189 * null), or false if not conflict is found. The first useless keyword is
1190 * returned.
1191 */
Willy Tarreau93fddf12013-03-31 22:59:32 +02001192int acl_cond_kw_conflicts(const struct acl_cond *cond, unsigned int where, struct acl const **acl, char const **kw)
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001193{
1194 struct acl_term_suite *suite;
1195 struct acl_term *term;
1196 struct acl_expr *expr;
1197
1198 list_for_each_entry(suite, &cond->suites, list) {
1199 list_for_each_entry(term, &suite->terms, list) {
1200 list_for_each_entry(expr, &term->acl->expr, list) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001201 if (!(expr->smp->fetch->val & where)) {
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001202 if (acl)
1203 *acl = term->acl;
1204 if (kw)
1205 *kw = expr->kw;
1206 return 1;
1207 }
1208 }
1209 }
1210 }
1211 return 0;
1212}
1213
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001214/*
1215 * Find targets for userlist and groups in acl. Function returns the number
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001216 * of errors or OK if everything is fine. It must be called only once sample
1217 * fetch arguments have been resolved (after smp_resolve_args()).
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001218 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001219int acl_find_targets(struct proxy *p)
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001220{
1221
1222 struct acl *acl;
1223 struct acl_expr *expr;
Thierry FOURNIER3ead5b92013-12-13 12:12:18 +01001224 struct pattern_list *pattern;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001225 int cfgerr = 0;
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001226 struct pattern_expr_list *pexp;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001227
1228 list_for_each_entry(acl, &p->acl, list) {
1229 list_for_each_entry(expr, &acl->expr, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001230 if (strcmp(expr->kw, "http_auth_group") == 0) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001231 /* Note: the ARGT_USR argument may only have been resolved earlier
1232 * by smp_resolve_args().
1233 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001234 if (expr->smp->arg_p->unresolved) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001235 ha_alert("Internal bug in proxy %s: %sacl %s %s() makes use of unresolved userlist '%s'. Please report this.\n",
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001236 p->id, *acl->name ? "" : "anonymous ", acl->name, expr->kw,
1237 expr->smp->arg_p->data.str.area);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001238 cfgerr++;
Willy Tarreau496aa012012-06-01 10:38:29 +02001239 continue;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001240 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001241
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001242 if (LIST_ISEMPTY(&expr->pat.head)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001243 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1244 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001245 cfgerr++;
1246 continue;
1247 }
1248
Thierry FOURNIER9eec0a62014-01-22 18:38:02 +01001249 /* For each pattern, check if the group exists. */
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001250 list_for_each_entry(pexp, &expr->pat.head, list) {
1251 if (LIST_ISEMPTY(&pexp->expr->patterns)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001252 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1253 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001254 cfgerr++;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001255 continue;
1256 }
1257
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001258 list_for_each_entry(pattern, &pexp->expr->patterns, list) {
1259 /* this keyword only has one argument */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001260 if (!check_group(expr->smp->arg_p->data.usr, pattern->pat.ptr.str)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001261 ha_alert("proxy %s: acl %s %s(): invalid group '%s'.\n",
1262 p->id, acl->name, expr->kw, pattern->pat.ptr.str);
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001263 cfgerr++;
1264 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001265 }
1266 }
1267 }
1268 }
1269 }
1270
1271 return cfgerr;
1272}
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001273
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001274/* initializes ACLs by resolving the sample fetch names they rely upon.
1275 * Returns 0 on success, otherwise an error.
1276 */
1277int init_acl()
1278{
1279 int err = 0;
1280 int index;
1281 const char *name;
1282 struct acl_kw_list *kwl;
1283 struct sample_fetch *smp;
1284
1285 list_for_each_entry(kwl, &acl_keywords.list, list) {
1286 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1287 name = kwl->kw[index].fetch_kw;
1288 if (!name)
1289 name = kwl->kw[index].kw;
1290
1291 smp = find_sample_fetch(name, strlen(name));
1292 if (!smp) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001293 ha_alert("Critical internal error: ACL keyword '%s' relies on sample fetch '%s' which was not registered!\n",
1294 kwl->kw[index].kw, name);
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001295 err++;
1296 continue;
1297 }
1298 kwl->kw[index].smp = smp;
1299 }
1300 }
1301 return err;
1302}
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001303
Amaury Denoyelle68fd7e42021-03-25 17:15:52 +01001304void free_acl_cond(struct acl_cond *cond)
1305{
1306 struct acl_term_suite *suite, *suiteb;
1307 struct acl_term *term, *termb;
1308
1309 if (!cond)
1310 return;
1311
1312 list_for_each_entry_safe(suite, suiteb, &cond->suites, list) {
1313 list_for_each_entry_safe(term, termb, &suite->terms, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001314 LIST_DELETE(&term->list);
Amaury Denoyelle68fd7e42021-03-25 17:15:52 +01001315 free(term);
1316 }
Willy Tarreau2b718102021-04-21 07:32:39 +02001317 LIST_DELETE(&suite->list);
Amaury Denoyelle68fd7e42021-03-25 17:15:52 +01001318 free(suite);
1319 }
1320
1321 free(cond);
1322}
1323
Willy Tarreaua84d3742007-05-07 00:36:48 +02001324/************************************************************************/
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001325/* All supported sample and ACL keywords must be declared here. */
1326/************************************************************************/
1327
1328/* Note: must not be declared <const> as its list will be overwritten.
Willy Tarreau61612d42012-04-19 18:42:05 +02001329 * Please take care of keeping this list alphabetically sorted.
1330 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001331static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001332 { /* END */ },
Willy Tarreaua84d3742007-05-07 00:36:48 +02001333}};
1334
Willy Tarreau0108d902018-11-25 19:14:37 +01001335INITCALL1(STG_REGISTER, acl_register_keywords, &acl_kws);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001336
1337/*
1338 * Local variables:
1339 * c-indent-level: 8
1340 * c-basic-offset: 8
1341 * End:
1342 */