blob: 84cb0f0d8ad06ca1d2b146d9373023328cee71b9 [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
Christopher Faulet35926a12021-09-30 08:48:56 +0200124 * as a list head to report missing dependencies. It may be NULL if such
125 * dependencies are not allowed.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200126 *
Willy Tarreaua84d3742007-05-07 00:36:48 +0200127 * Right now, the only accepted syntax is :
128 * <subject> [<value>...]
129 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100130struct acl_expr *parse_acl_expr(const char **args, char **err, struct arg_list *al,
131 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200132{
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100133 __label__ out_return, out_free_expr;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200134 struct acl_expr *expr;
135 struct acl_keyword *aclkw;
Christopher Faulet54ceb042017-06-14 14:41:33 +0200136 int refflags, patflags;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200137 const char *arg;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100138 struct sample_expr *smp = NULL;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100139 int idx = 0;
140 char *ckw = NULL;
141 const char *begw;
142 const char *endw;
Willy Tarreau131b4662013-12-13 01:08:36 +0100143 const char *endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100144 int cur_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100145 int nbargs;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100146 int operator = STD_OP_EQ;
147 int op;
148 int contain_colon, have_dot;
149 const char *dot;
150 signed long long value, minor;
151 /* The following buffer contain two numbers, a ':' separator and the final \0. */
152 char buffer[NB_LLMAX_STR + 1 + NB_LLMAX_STR + 1];
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100153 int is_loaded;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100154 int unique_id;
155 char *error;
156 struct pat_ref *ref;
157 struct pattern_expr *pattern_expr;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100158 int load_as_map = 0;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200159 int acl_conv_found = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200160
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100161 /* First, we look for an ACL keyword. And if we don't find one, then
162 * we look for a sample fetch expression starting with a sample fetch
163 * keyword.
Willy Tarreaubef91e72013-03-31 23:14:46 +0200164 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100165
Christopher Faulet35926a12021-09-30 08:48:56 +0200166 if (al) {
167 al->ctx = ARGC_ACL; // to report errors while resolving args late
168 al->kw = *args;
169 al->conv = NULL;
170 }
Willy Tarreau131b4662013-12-13 01:08:36 +0100171
Willy Tarreaua84d3742007-05-07 00:36:48 +0200172 aclkw = find_acl_kw(args[0]);
Willy Tarreau20490922014-03-17 18:04:27 +0100173 if (aclkw) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100174 /* OK we have a real ACL keyword */
Willy Tarreau9987ea92013-06-11 21:09:06 +0200175
Willy Tarreau131b4662013-12-13 01:08:36 +0100176 /* build new sample expression for this ACL */
Vincent Bernat02779b62016-04-03 13:48:43 +0200177 smp = calloc(1, sizeof(*smp));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100178 if (!smp) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100179 memprintf(err, "out of memory when parsing ACL expression");
180 goto out_return;
181 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100182 LIST_INIT(&(smp->conv_exprs));
183 smp->fetch = aclkw->smp;
184 smp->arg_p = empty_arg_list;
Willy Tarreau34db1082012-04-19 17:16:54 +0200185
Joseph Herlant68082792018-11-15 14:55:09 -0800186 /* look for the beginning of the subject arguments */
Willy Tarreaued2c6622020-02-14 18:27:10 +0100187 for (arg = args[0]; is_idchar(*arg); arg++)
188 ;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100189
Willy Tarreau131b4662013-12-13 01:08:36 +0100190 /* At this point, we have :
191 * - args[0] : beginning of the keyword
192 * - arg : end of the keyword, first character not part of keyword
Willy Tarreau131b4662013-12-13 01:08:36 +0100193 */
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100194 nbargs = make_arg_list(arg, -1, smp->fetch->arg_mask, &smp->arg_p,
195 err, &endt, NULL, al);
Willy Tarreau131b4662013-12-13 01:08:36 +0100196 if (nbargs < 0) {
197 /* note that make_arg_list will have set <err> here */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100198 memprintf(err, "ACL keyword '%s' : %s", aclkw->kw, *err);
199 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100200 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100201
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100202 if (!smp->arg_p) {
203 smp->arg_p = empty_arg_list;
Willy Tarreau131b4662013-12-13 01:08:36 +0100204 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100205 else if (smp->fetch->val_args && !smp->fetch->val_args(smp->arg_p, err)) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100206 /* invalid keyword argument, error must have been
207 * set by val_args().
208 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100209 memprintf(err, "in argument to '%s', %s", aclkw->kw, *err);
210 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100211 }
212 arg = endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100213
Joseph Herlant68082792018-11-15 14:55:09 -0800214 /* look for the beginning of the converters list. Those directly attached
Willy Tarreau131b4662013-12-13 01:08:36 +0100215 * to the ACL keyword are found just after <arg> which points to the comma.
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200216 * If we find any converter, then we don't use the ACL keyword's match
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200217 * anymore but the one related to the converter's output type.
Willy Tarreau131b4662013-12-13 01:08:36 +0100218 */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200219 cur_type = smp->fetch->out_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100220 while (*arg) {
221 struct sample_conv *conv;
222 struct sample_conv_expr *conv_expr;
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100223 int err_arg;
224 int argcnt;
Willy Tarreau131b4662013-12-13 01:08:36 +0100225
226 if (*arg && *arg != ',') {
227 if (ckw)
Willy Tarreau97108e02016-11-25 07:33:24 +0100228 memprintf(err, "ACL keyword '%s' : missing comma after converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100229 aclkw->kw, ckw);
Willy Tarreau131b4662013-12-13 01:08:36 +0100230 else
231 memprintf(err, "ACL keyword '%s' : missing comma after fetch keyword.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100232 aclkw->kw);
233 goto out_free_smp;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200234 }
Willy Tarreauae52f062012-04-26 12:13:35 +0200235
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100236 /* FIXME: how long should we support such idiocies ? Maybe we
237 * should already warn ?
238 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100239 while (*arg == ',') /* then trailing commas */
240 arg++;
Willy Tarreau2e845be2012-10-19 19:49:09 +0200241
Willy Tarreau97108e02016-11-25 07:33:24 +0100242 begw = arg; /* start of converter keyword */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100243
Willy Tarreau131b4662013-12-13 01:08:36 +0100244 if (!*begw)
245 /* none ? end of converters */
246 break;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100247
Willy Tarreaued2c6622020-02-14 18:27:10 +0100248 for (endw = begw; is_idchar(*endw); endw++)
249 ;
Willy Tarreau9ca69362013-10-22 19:10:06 +0200250
Willy Tarreau131b4662013-12-13 01:08:36 +0100251 free(ckw);
252 ckw = my_strndup(begw, endw - begw);
Willy Tarreauf75d0082013-04-07 21:20:44 +0200253
Willy Tarreau131b4662013-12-13 01:08:36 +0100254 conv = find_sample_conv(begw, endw - begw);
255 if (!conv) {
256 /* Unknown converter method */
Willy Tarreau97108e02016-11-25 07:33:24 +0100257 memprintf(err, "ACL keyword '%s' : unknown converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100258 aclkw->kw, ckw);
259 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100260 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100261
Willy Tarreau131b4662013-12-13 01:08:36 +0100262 arg = endw;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100263
Willy Tarreau131b4662013-12-13 01:08:36 +0100264 if (conv->in_type >= SMP_TYPES || conv->out_type >= SMP_TYPES) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100265 memprintf(err, "ACL keyword '%s' : returns type of converter '%s' is unknown.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100266 aclkw->kw, ckw);
267 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100268 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100269
Willy Tarreau131b4662013-12-13 01:08:36 +0100270 /* If impossible type conversion */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200271 if (!sample_casts[cur_type][conv->in_type]) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100272 memprintf(err, "ACL keyword '%s' : converter '%s' cannot be applied.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100273 aclkw->kw, ckw);
274 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100275 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100276
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200277 cur_type = conv->out_type;
Vincent Bernat02779b62016-04-03 13:48:43 +0200278 conv_expr = calloc(1, sizeof(*conv_expr));
Willy Tarreau131b4662013-12-13 01:08:36 +0100279 if (!conv_expr)
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100280 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100281
Willy Tarreau2b718102021-04-21 07:32:39 +0200282 LIST_APPEND(&(smp->conv_exprs), &(conv_expr->list));
Willy Tarreau131b4662013-12-13 01:08:36 +0100283 conv_expr->conv = conv;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200284 acl_conv_found = 1;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100285
Christopher Faulet35926a12021-09-30 08:48:56 +0200286 if (al) {
287 al->kw = smp->fetch->kw;
288 al->conv = conv_expr->conv->kw;
289 }
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100290 argcnt = make_arg_list(endw, -1, conv->arg_mask, &conv_expr->arg_p, err, &arg, &err_arg, al);
291 if (argcnt < 0) {
292 memprintf(err, "ACL keyword '%s' : invalid arg %d in converter '%s' : %s.",
293 aclkw->kw, err_arg+1, ckw, *err);
294 goto out_free_smp;
295 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100296
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100297 if (argcnt && !conv->arg_mask) {
298 memprintf(err, "converter '%s' does not support any args", ckw);
299 goto out_free_smp;
300 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100301
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100302 if (!conv_expr->arg_p)
303 conv_expr->arg_p = empty_arg_list;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100304
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100305 if (conv->val_args && !conv->val_args(conv_expr->arg_p, conv, file, line, err)) {
306 memprintf(err, "ACL keyword '%s' : invalid args in converter '%s' : %s.",
307 aclkw->kw, ckw, *err);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100308 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100309 }
Willy Tarreau61612d42012-04-19 18:42:05 +0200310 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100311 ha_free(&ckw);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200312 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100313 else {
314 /* This is not an ACL keyword, so we hope this is a sample fetch
315 * keyword that we're going to transparently use as an ACL. If
316 * so, we retrieve a completely parsed expression with args and
317 * convs already done.
318 */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100319 smp = sample_parse_expr((char **)args, &idx, file, line, err, al, NULL);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100320 if (!smp) {
321 memprintf(err, "%s in ACL expression '%s'", *err, *args);
322 goto out_return;
323 }
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200324 cur_type = smp_expr_output_type(smp);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100325 }
326
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200327 expr = calloc(1, sizeof(*expr));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100328 if (!expr) {
329 memprintf(err, "out of memory when parsing ACL expression");
Christopher Faulet361935a2019-09-13 09:50:15 +0200330 goto out_free_smp;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100331 }
332
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100333 pattern_init_head(&expr->pat);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100334
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200335 expr->pat.expect_type = cur_type;
336 expr->smp = smp;
337 expr->kw = smp->fetch->kw;
338 smp = NULL; /* don't free it anymore */
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100339
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200340 if (aclkw && !acl_conv_found) {
341 expr->kw = aclkw->kw;
342 expr->pat.parse = aclkw->parse ? aclkw->parse : pat_parse_fcts[aclkw->match_type];
343 expr->pat.index = aclkw->index ? aclkw->index : pat_index_fcts[aclkw->match_type];
344 expr->pat.match = aclkw->match ? aclkw->match : pat_match_fcts[aclkw->match_type];
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200345 expr->pat.prune = aclkw->prune ? aclkw->prune : pat_prune_fcts[aclkw->match_type];
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100346 }
347
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100348 if (!expr->pat.parse) {
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200349 /* Parse/index/match functions depend on the expression type,
350 * so we have to map them now. Some types can be automatically
351 * converted.
352 */
353 switch (cur_type) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100354 case SMP_T_BOOL:
355 expr->pat.parse = pat_parse_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100356 expr->pat.index = pat_index_fcts[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100357 expr->pat.match = pat_match_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100358 expr->pat.prune = pat_prune_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100359 expr->pat.expect_type = pat_match_types[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100360 break;
361 case SMP_T_SINT:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100362 expr->pat.parse = pat_parse_fcts[PAT_MATCH_INT];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100363 expr->pat.index = pat_index_fcts[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100364 expr->pat.match = pat_match_fcts[PAT_MATCH_INT];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100365 expr->pat.prune = pat_prune_fcts[PAT_MATCH_INT];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100366 expr->pat.expect_type = pat_match_types[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100367 break;
Willy Tarreau78c5eec2019-04-19 11:45:20 +0200368 case SMP_T_ADDR:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100369 case SMP_T_IPV4:
370 case SMP_T_IPV6:
371 expr->pat.parse = pat_parse_fcts[PAT_MATCH_IP];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100372 expr->pat.index = pat_index_fcts[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100373 expr->pat.match = pat_match_fcts[PAT_MATCH_IP];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100374 expr->pat.prune = pat_prune_fcts[PAT_MATCH_IP];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100375 expr->pat.expect_type = pat_match_types[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100376 break;
Thierry FOURNIER9fefbd52014-05-11 15:15:00 +0200377 case SMP_T_STR:
378 expr->pat.parse = pat_parse_fcts[PAT_MATCH_STR];
379 expr->pat.index = pat_index_fcts[PAT_MATCH_STR];
380 expr->pat.match = pat_match_fcts[PAT_MATCH_STR];
Thierry FOURNIER9fefbd52014-05-11 15:15:00 +0200381 expr->pat.prune = pat_prune_fcts[PAT_MATCH_STR];
382 expr->pat.expect_type = pat_match_types[PAT_MATCH_STR];
383 break;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100384 }
385 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200386
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100387 /* Additional check to protect against common mistakes */
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100388 if (expr->pat.parse && cur_type != SMP_T_BOOL && !*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100389 ha_warning("parsing acl keyword '%s' :\n"
390 " no pattern to match against were provided, so this ACL will never match.\n"
391 " If this is what you intended, please add '--' to get rid of this warning.\n"
392 " If you intended to match only for existence, please use '-m found'.\n"
393 " If you wanted to force an int to match as a bool, please use '-m bool'.\n"
394 "\n",
395 args[0]);
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100396 }
397
Willy Tarreaua84d3742007-05-07 00:36:48 +0200398 args++;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200399
400 /* check for options before patterns. Supported options are :
401 * -i : ignore case for all patterns by default
402 * -f : read patterns from those files
Willy Tarreau5adeda12013-03-31 22:13:34 +0200403 * -m : force matching method (must be used before -f)
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100404 * -M : load the file as map file
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100405 * -u : force the unique id of the acl
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200406 * -- : everything after this is not an option
407 */
Christopher Faulet54ceb042017-06-14 14:41:33 +0200408 refflags = PAT_REF_ACL;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200409 patflags = 0;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100410 is_loaded = 0;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100411 unique_id = -1;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200412 while (**args == '-') {
Willy Tarreau2039bba2014-05-11 09:43:46 +0200413 if (strcmp(*args, "-i") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200414 patflags |= PAT_MF_IGNORE_CASE;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200415 else if (strcmp(*args, "-n") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200416 patflags |= PAT_MF_NO_DNS;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200417 else if (strcmp(*args, "-u") == 0) {
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100418 unique_id = strtol(args[1], &error, 10);
419 if (*error != '\0') {
420 memprintf(err, "the argument of -u must be an integer");
421 goto out_free_expr;
422 }
423
424 /* Check if this id is really unique. */
425 if (pat_ref_lookupid(unique_id)) {
426 memprintf(err, "the id is already used");
427 goto out_free_expr;
428 }
429
430 args++;
431 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200432 else if (strcmp(*args, "-f") == 0) {
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100433 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200434 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 +0200435 goto out_free_expr;
436 }
437
Christopher Faulet54ceb042017-06-14 14:41:33 +0200438 if (!pattern_read_from_file(&expr->pat, refflags, args[1], patflags, load_as_map, err, file, line))
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200439 goto out_free_expr;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100440 is_loaded = 1;
Willy Tarreau5adeda12013-03-31 22:13:34 +0200441 args++;
442 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200443 else if (strcmp(*args, "-m") == 0) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200444 int idx;
445
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100446 if (is_loaded) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200447 memprintf(err, "'-m' must only be specified before patterns and files in parsing ACL expression");
448 goto out_free_expr;
449 }
450
Willy Tarreau6f8fe312013-11-28 22:24:25 +0100451 idx = pat_find_match_name(args[1]);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200452 if (idx < 0) {
453 memprintf(err, "unknown matching method '%s' when parsing ACL expression", args[1]);
454 goto out_free_expr;
455 }
456
457 /* Note: -m found is always valid, bool/int are compatible, str/bin/reg/len are compatible */
Willy Tarreau9bb49f62015-09-24 16:37:12 +0200458 if (idx != PAT_MATCH_FOUND && !sample_casts[cur_type][pat_match_types[idx]]) {
Willy Tarreau93fddf12013-03-31 22:59:32 +0200459 memprintf(err, "matching method '%s' cannot be used with fetch keyword '%s'", args[1], expr->kw);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200460 goto out_free_expr;
461 }
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100462 expr->pat.parse = pat_parse_fcts[idx];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100463 expr->pat.index = pat_index_fcts[idx];
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100464 expr->pat.match = pat_match_fcts[idx];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100465 expr->pat.prune = pat_prune_fcts[idx];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100466 expr->pat.expect_type = pat_match_types[idx];
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200467 args++;
468 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200469 else if (strcmp(*args, "-M") == 0) {
Christopher Faulet54ceb042017-06-14 14:41:33 +0200470 refflags |= PAT_REF_MAP;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100471 load_as_map = 1;
472 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200473 else if (strcmp(*args, "--") == 0) {
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200474 args++;
475 break;
476 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200477 else {
478 memprintf(err, "'%s' is not a valid ACL option. Please use '--' before any pattern beginning with a '-'", args[0]);
479 goto out_free_expr;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200480 break;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200481 }
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200482 args++;
483 }
484
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100485 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200486 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 +0200487 goto out_free_expr;
488 }
489
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100490 /* Create displayed reference */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200491 snprintf(trash.area, trash.size, "acl '%s' file '%s' line %d",
492 expr->kw, file, line);
493 trash.area[trash.size - 1] = '\0';
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100494
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500495 /* Create new pattern reference. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200496 ref = pat_ref_newid(unique_id, trash.area, PAT_REF_ACL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100497 if (!ref) {
498 memprintf(err, "memory error");
499 goto out_free_expr;
500 }
501
502 /* Create new pattern expression associated to this reference. */
Emeric Brun7d27f3c2017-07-03 17:54:23 +0200503 pattern_expr = pattern_new_expr(&expr->pat, ref, patflags, err, NULL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100504 if (!pattern_expr)
505 goto out_free_expr;
506
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200507 /* now parse all patterns */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100508 while (**args) {
509 arg = *args;
510
511 /* Compatibility layer. Each pattern can parse only one string per pattern,
512 * but the pat_parser_int() and pat_parse_dotted_ver() parsers were need
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500513 * optionally two operators. The first operator is the match method: eq,
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100514 * le, lt, ge and gt. pat_parse_int() and pat_parse_dotted_ver() functions
515 * can have a compatibility syntax based on ranges:
516 *
517 * pat_parse_int():
518 *
519 * "eq x" -> "x" or "x:x"
520 * "le x" -> ":x"
521 * "lt x" -> ":y" (with y = x - 1)
522 * "ge x" -> "x:"
523 * "gt x" -> "y:" (with y = x + 1)
524 *
525 * pat_parse_dotted_ver():
526 *
527 * "eq x.y" -> "x.y" or "x.y:x.y"
528 * "le x.y" -> ":x.y"
529 * "lt x.y" -> ":w.z" (with w.z = x.y - 1)
530 * "ge x.y" -> "x.y:"
531 * "gt x.y" -> "w.z:" (with w.z = x.y + 1)
532 *
533 * If y is not present, assume that is "0".
534 *
535 * The syntax eq, le, lt, ge and gt are proper to the acl syntax. The
536 * following block of code detect the operator, and rewrite each value
537 * in parsable string.
538 */
539 if (expr->pat.parse == pat_parse_int ||
540 expr->pat.parse == pat_parse_dotted_ver) {
541 /* Check for operator. If the argument is operator, memorise it and
542 * continue to the next argument.
543 */
544 op = get_std_op(arg);
545 if (op != -1) {
546 operator = op;
547 args++;
548 continue;
549 }
550
551 /* Check if the pattern contain ':' or '-' character. */
552 contain_colon = (strchr(arg, ':') || strchr(arg, '-'));
553
554 /* If the pattern contain ':' or '-' character, give it to the parser as is.
555 * If no contain ':' and operator is STD_OP_EQ, give it to the parser as is.
556 * In other case, try to convert the value according with the operator.
557 */
558 if (!contain_colon && operator != STD_OP_EQ) {
559 /* Search '.' separator. */
560 dot = strchr(arg, '.');
561 if (!dot) {
562 have_dot = 0;
563 minor = 0;
564 dot = arg + strlen(arg);
565 }
566 else
567 have_dot = 1;
568
569 /* convert the integer minor part for the pat_parse_dotted_ver() function. */
570 if (expr->pat.parse == pat_parse_dotted_ver && have_dot) {
571 if (strl2llrc(dot+1, strlen(dot+1), &minor) != 0) {
572 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100573 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100574 }
575 if (minor >= 65536) {
576 memprintf(err, "'%s' contains too large a minor value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100577 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100578 }
579 }
580
581 /* convert the integer value for the pat_parse_int() function, and the
582 * integer major part for the pat_parse_dotted_ver() function.
583 */
584 if (strl2llrc(arg, dot - arg, &value) != 0) {
585 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100586 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100587 }
588 if (expr->pat.parse == pat_parse_dotted_ver) {
589 if (value >= 65536) {
590 memprintf(err, "'%s' contains too large a major value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100591 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100592 }
593 value = (value << 16) | (minor & 0xffff);
594 }
595
596 switch (operator) {
597
598 case STD_OP_EQ: /* this case is not possible. */
599 memprintf(err, "internal error");
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100600 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100601
602 case STD_OP_GT:
603 value++; /* gt = ge + 1 */
Willy Tarreau8de35932022-11-14 07:21:22 +0100604 __fallthrough;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100605
606 case STD_OP_GE:
607 if (expr->pat.parse == pat_parse_int)
608 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld:", value);
609 else
610 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld.%lld:",
611 value >> 16, value & 0xffff);
612 arg = buffer;
613 break;
614
615 case STD_OP_LT:
616 value--; /* lt = le - 1 */
Willy Tarreau8de35932022-11-14 07:21:22 +0100617 __fallthrough;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100618
619 case STD_OP_LE:
620 if (expr->pat.parse == pat_parse_int)
621 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld", value);
622 else
623 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld.%lld",
624 value >> 16, value & 0xffff);
625 arg = buffer;
626 break;
627 }
628 }
629 }
630
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100631 /* Add sample to the reference, and try to compile it fior each pattern
632 * using this value.
633 */
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200634 if (!pat_ref_add(ref, arg, NULL, err))
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100635 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100636 args++;
637 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200638
639 return expr;
640
Willy Tarreaua84d3742007-05-07 00:36:48 +0200641 out_free_expr:
642 prune_acl_expr(expr);
643 free(expr);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100644 out_free_smp:
Christopher Faulet361935a2019-09-13 09:50:15 +0200645 free(ckw);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100646 free(smp);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200647 out_return:
648 return NULL;
649}
650
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200651/* Purge everything in the acl <acl>, then return <acl>. */
652struct acl *prune_acl(struct acl *acl) {
653
654 struct acl_expr *expr, *exprb;
655
656 free(acl->name);
657
658 list_for_each_entry_safe(expr, exprb, &acl->expr, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200659 LIST_DELETE(&expr->list);
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200660 prune_acl_expr(expr);
661 free(expr);
662 }
663
664 return acl;
665}
666
Willy Tarreaua84d3742007-05-07 00:36:48 +0200667/* Parse an ACL with the name starting at <args>[0], and with a list of already
668 * known ACLs in <acl>. If the ACL was not in the list, it will be added.
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100669 * A pointer to that ACL is returned. If the ACL has an empty name, then it's
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200670 * an anonymous one and it won't be merged with any other one. If <err> is not
671 * NULL, it will be filled with an appropriate error. This pointer must be
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200672 * freeable or NULL. <al> is the arg_list serving as a head for unresolved
Christopher Faulet35926a12021-09-30 08:48:56 +0200673 * dependencies. It may be NULL if such dependencies are not allowed.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200674 *
675 * args syntax: <aclname> <acl_expr>
676 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100677struct acl *parse_acl(const char **args, struct list *known_acl, char **err, struct arg_list *al,
678 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200679{
680 __label__ out_return, out_free_acl_expr, out_free_name;
681 struct acl *cur_acl;
682 struct acl_expr *acl_expr;
683 char *name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200684 const char *pos;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200685
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200686 if (**args && (pos = invalid_char(*args))) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200687 memprintf(err, "invalid character in ACL name : '%c'", *pos);
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100688 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200689 }
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100690
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100691 acl_expr = parse_acl_expr(args + 1, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200692 if (!acl_expr) {
693 /* parse_acl_expr will have filled <err> here */
Willy Tarreaua84d3742007-05-07 00:36:48 +0200694 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200695 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200696
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200697 /* Check for args beginning with an opening parenthesis just after the
698 * subject, as this is almost certainly a typo. Right now we can only
699 * emit a warning, so let's do so.
700 */
Krzysztof Piotr Oledzki4cdd8312009-10-05 00:23:35 +0200701 if (!strchr(args[1], '(') && *args[2] == '(')
Christopher Faulet767a84b2017-11-24 16:50:31 +0100702 ha_warning("parsing acl '%s' :\n"
703 " matching '%s' for pattern '%s' is likely a mistake and probably\n"
704 " not what you want. Maybe you need to remove the extraneous space before '('.\n"
705 " If you are really sure this is not an error, please insert '--' between the\n"
706 " match and the pattern to make this warning message disappear.\n",
707 args[0], args[1], args[2]);
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200708
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100709 if (*args[0])
710 cur_acl = find_acl_by_name(args[0], known_acl);
711 else
712 cur_acl = NULL;
713
Willy Tarreaua84d3742007-05-07 00:36:48 +0200714 if (!cur_acl) {
715 name = strdup(args[0]);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200716 if (!name) {
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_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200719 }
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200720 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200721 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200722 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200723 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200724 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200725
726 LIST_INIT(&cur_acl->expr);
Willy Tarreau2b718102021-04-21 07:32:39 +0200727 LIST_APPEND(known_acl, &cur_acl->list);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200728 cur_acl->name = name;
729 }
730
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100731 /* We want to know what features the ACL needs (typically HTTP parsing),
732 * and where it may be used. If an ACL relies on multiple matches, it is
733 * OK if at least one of them may match in the context where it is used.
734 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100735 cur_acl->use |= acl_expr->smp->fetch->use;
736 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreau2b718102021-04-21 07:32:39 +0200737 LIST_APPEND(&cur_acl->expr, &acl_expr->list);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200738 return cur_acl;
739
740 out_free_name:
741 free(name);
742 out_free_acl_expr:
743 prune_acl_expr(acl_expr);
744 free(acl_expr);
745 out_return:
746 return NULL;
747}
748
Willy Tarreau16fbe822007-06-17 11:54:31 +0200749/* Some useful ACLs provided by default. Only those used are allocated. */
750
751const struct {
752 const char *name;
753 const char *expr[4]; /* put enough for longest expression */
754} default_acl_list[] = {
Willy Tarreau58393e12008-07-20 10:39:22 +0200755 { .name = "TRUE", .expr = {"always_true",""}},
756 { .name = "FALSE", .expr = {"always_false",""}},
Björn Jacke20d0f502021-10-15 16:32:15 +0200757 { .name = "LOCALHOST", .expr = {"src","127.0.0.1/8","::1",""}},
Christopher Faulet779184e2021-04-01 17:24:04 +0200758 { .name = "HTTP", .expr = {"req.proto_http",""}},
759 { .name = "HTTP_1.0", .expr = {"req.ver","1.0",""}},
760 { .name = "HTTP_1.1", .expr = {"req.ver","1.1",""}},
Christopher Faulet8043e832021-03-26 16:00:54 +0100761 { .name = "HTTP_2.0", .expr = {"req.ver","2.0",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200762 { .name = "METH_CONNECT", .expr = {"method","CONNECT",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200763 { .name = "METH_DELETE", .expr = {"method","DELETE",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200764 { .name = "METH_GET", .expr = {"method","GET","HEAD",""}},
765 { .name = "METH_HEAD", .expr = {"method","HEAD",""}},
766 { .name = "METH_OPTIONS", .expr = {"method","OPTIONS",""}},
767 { .name = "METH_POST", .expr = {"method","POST",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200768 { .name = "METH_PUT", .expr = {"method","PUT",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200769 { .name = "METH_TRACE", .expr = {"method","TRACE",""}},
770 { .name = "HTTP_URL_ABS", .expr = {"url_reg","^[^/:]*://",""}},
771 { .name = "HTTP_URL_SLASH", .expr = {"url_beg","/",""}},
772 { .name = "HTTP_URL_STAR", .expr = {"url","*",""}},
Christopher Faulet779184e2021-04-01 17:24:04 +0200773 { .name = "HTTP_CONTENT", .expr = {"req.hdr_val(content-length)","gt","0",""}},
774 { .name = "RDP_COOKIE", .expr = {"req.rdp_cookie_cnt","gt","0",""}},
775 { .name = "REQ_CONTENT", .expr = {"req.len","gt","0",""}},
Willy Tarreaub6fb4202008-07-20 11:18:28 +0200776 { .name = "WAIT_END", .expr = {"wait_end",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200777 { .name = NULL, .expr = {""}}
778};
779
780/* Find a default ACL from the default_acl list, compile it and return it.
781 * If the ACL is not found, NULL is returned. In theory, it cannot fail,
782 * except when default ACLs are broken, in which case it will return NULL.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200783 * If <known_acl> is not NULL, the ACL will be queued at its tail. If <err> is
784 * not NULL, it will be filled with an error message if an error occurs. This
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200785 * pointer must be freeable or NULL. <al> is an arg_list serving as a list head
Christopher Faulet35926a12021-09-30 08:48:56 +0200786 * to report missing dependencies. It may be NULL if such dependencies are not
787 * allowed.
Willy Tarreau16fbe822007-06-17 11:54:31 +0200788 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200789static struct acl *find_acl_default(const char *acl_name, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100790 char **err, struct arg_list *al,
791 const char *file, int line)
Willy Tarreau16fbe822007-06-17 11:54:31 +0200792{
793 __label__ out_return, out_free_acl_expr, out_free_name;
794 struct acl *cur_acl;
795 struct acl_expr *acl_expr;
796 char *name;
797 int index;
798
799 for (index = 0; default_acl_list[index].name != NULL; index++) {
800 if (strcmp(acl_name, default_acl_list[index].name) == 0)
801 break;
802 }
803
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200804 if (default_acl_list[index].name == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200805 memprintf(err, "no such ACL : '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200806 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200807 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200808
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100809 acl_expr = parse_acl_expr((const char **)default_acl_list[index].expr, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200810 if (!acl_expr) {
811 /* parse_acl_expr must have filled err here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200812 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200813 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200814
815 name = strdup(acl_name);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200816 if (!name) {
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_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200819 }
820
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200821 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200822 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200823 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200824 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200825 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200826
827 cur_acl->name = name;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100828 cur_acl->use |= acl_expr->smp->fetch->use;
829 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreau16fbe822007-06-17 11:54:31 +0200830 LIST_INIT(&cur_acl->expr);
Willy Tarreau2b718102021-04-21 07:32:39 +0200831 LIST_APPEND(&cur_acl->expr, &acl_expr->list);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200832 if (known_acl)
Willy Tarreau2b718102021-04-21 07:32:39 +0200833 LIST_APPEND(known_acl, &cur_acl->list);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200834
835 return cur_acl;
836
837 out_free_name:
838 free(name);
839 out_free_acl_expr:
840 prune_acl_expr(acl_expr);
841 free(acl_expr);
842 out_return:
843 return NULL;
844}
Willy Tarreaua84d3742007-05-07 00:36:48 +0200845
846/* Purge everything in the acl_cond <cond>, then return <cond>. */
847struct acl_cond *prune_acl_cond(struct acl_cond *cond)
848{
849 struct acl_term_suite *suite, *tmp_suite;
850 struct acl_term *term, *tmp_term;
851
852 /* iterate through all term suites and free all terms and all suites */
853 list_for_each_entry_safe(suite, tmp_suite, &cond->suites, list) {
854 list_for_each_entry_safe(term, tmp_term, &suite->terms, list)
855 free(term);
856 free(suite);
857 }
858 return cond;
859}
860
861/* Parse an ACL condition starting at <args>[0], relying on a list of already
862 * known ACLs passed in <known_acl>. The new condition is returned (or NULL in
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200863 * case of low memory). Supports multiple conditions separated by "or". If
864 * <err> is not NULL, it will be filled with a pointer to an error message in
865 * case of error, that the caller is responsible for freeing. The initial
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200866 * location must either be freeable or NULL. The list <al> serves as a list head
Christopher Faulet35926a12021-09-30 08:48:56 +0200867 * for unresolved dependencies. It may be NULL if such dependencies are not
868 * allowed.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200869 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200870struct acl_cond *parse_acl_cond(const char **args, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100871 enum acl_cond_pol pol, char **err, struct arg_list *al,
872 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200873{
874 __label__ out_return, out_free_suite, out_free_term;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200875 int arg, neg;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200876 const char *word;
877 struct acl *cur_acl;
878 struct acl_term *cur_term;
879 struct acl_term_suite *cur_suite;
880 struct acl_cond *cond;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100881 unsigned int suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200882
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200883 cond = calloc(1, sizeof(*cond));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200884 if (cond == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200885 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200886 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200887 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200888
889 LIST_INIT(&cond->list);
890 LIST_INIT(&cond->suites);
891 cond->pol = pol;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100892 cond->val = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200893
894 cur_suite = NULL;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100895 suite_val = ~0U;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200896 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200897 for (arg = 0; *args[arg]; arg++) {
898 word = args[arg];
899
900 /* remove as many exclamation marks as we can */
901 while (*word == '!') {
902 neg = !neg;
903 word++;
904 }
905
906 /* an empty word is allowed because we cannot force the user to
907 * always think about not leaving exclamation marks alone.
908 */
909 if (!*word)
910 continue;
911
Willy Tarreau16fbe822007-06-17 11:54:31 +0200912 if (strcasecmp(word, "or") == 0 || strcmp(word, "||") == 0) {
Willy Tarreaua84d3742007-05-07 00:36:48 +0200913 /* new term suite */
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100914 cond->val |= suite_val;
915 suite_val = ~0U;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200916 cur_suite = NULL;
917 neg = 0;
918 continue;
919 }
920
Willy Tarreau95fa4692010-02-01 13:05:50 +0100921 if (strcmp(word, "{") == 0) {
922 /* we may have a complete ACL expression between two braces,
923 * find the last one.
924 */
925 int arg_end = arg + 1;
926 const char **args_new;
927
928 while (*args[arg_end] && strcmp(args[arg_end], "}") != 0)
929 arg_end++;
930
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200931 if (!*args[arg_end]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200932 memprintf(err, "missing closing '}' in condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100933 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200934 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100935
936 args_new = calloc(1, (arg_end - arg + 1) * sizeof(*args_new));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200937 if (!args_new) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200938 memprintf(err, "out of memory when parsing condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100939 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200940 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100941
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100942 args_new[0] = "";
Willy Tarreau95fa4692010-02-01 13:05:50 +0100943 memcpy(args_new + 1, args + arg + 1, (arg_end - arg) * sizeof(*args_new));
944 args_new[arg_end - arg] = "";
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100945 cur_acl = parse_acl(args_new, known_acl, err, al, file, line);
Willy Tarreau95fa4692010-02-01 13:05:50 +0100946 free(args_new);
947
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200948 if (!cur_acl) {
949 /* note that parse_acl() must have filled <err> here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200950 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200951 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100952 arg = arg_end;
953 }
954 else {
955 /* search for <word> in the known ACL names. If we do not find
956 * it, let's look for it in the default ACLs, and if found, add
957 * it to the list of ACLs of this proxy. This makes it possible
958 * to override them.
959 */
960 cur_acl = find_acl_by_name(word, known_acl);
961 if (cur_acl == NULL) {
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100962 cur_acl = find_acl_default(word, known_acl, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200963 if (cur_acl == NULL) {
964 /* note that find_acl_default() must have filled <err> here */
Willy Tarreau95fa4692010-02-01 13:05:50 +0100965 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200966 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100967 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200968 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200969
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200970 cur_term = calloc(1, sizeof(*cur_term));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200971 if (cur_term == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200972 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200973 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200974 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200975
976 cur_term->acl = cur_acl;
977 cur_term->neg = neg;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100978
979 /* Here it is a bit complex. The acl_term_suite is a conjunction
980 * of many terms. It may only be used if all of its terms are
981 * usable at the same time. So the suite's validity domain is an
982 * AND between all ACL keywords' ones. But, the global condition
983 * is valid if at least one term suite is OK. So it's an OR between
984 * all of their validity domains. We could emit a warning as soon
985 * as suite_val is null because it means that the last ACL is not
986 * compatible with the previous ones. Let's remain simple for now.
987 */
988 cond->use |= cur_acl->use;
989 suite_val &= cur_acl->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200990
991 if (!cur_suite) {
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200992 cur_suite = calloc(1, sizeof(*cur_suite));
Willy Tarreauf678b7f2013-01-24 00:25:39 +0100993 if (cur_suite == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200994 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200995 goto out_free_term;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200996 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200997 LIST_INIT(&cur_suite->terms);
Willy Tarreau2b718102021-04-21 07:32:39 +0200998 LIST_APPEND(&cond->suites, &cur_suite->list);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200999 }
Willy Tarreau2b718102021-04-21 07:32:39 +02001000 LIST_APPEND(&cur_suite->terms, &cur_term->list);
Willy Tarreau74b98a82007-06-16 19:35:18 +02001001 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001002 }
1003
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001004 cond->val |= suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001005 return cond;
1006
1007 out_free_term:
1008 free(cur_term);
1009 out_free_suite:
1010 prune_acl_cond(cond);
1011 free(cond);
1012 out_return:
1013 return NULL;
1014}
1015
Willy Tarreau2bbba412010-01-28 16:48:33 +01001016/* Builds an ACL condition starting at the if/unless keyword. The complete
1017 * condition is returned. NULL is returned in case of error or if the first
1018 * word is neither "if" nor "unless". It automatically sets the file name and
Willy Tarreau25320b22013-03-24 07:22:08 +01001019 * the line number in the condition for better error reporting, and sets the
1020 * HTTP intiailization requirements in the proxy. If <err> is not NULL, it will
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001021 * be filled with a pointer to an error message in case of error, that the
1022 * caller is responsible for freeing. The initial location must either be
1023 * freeable or NULL.
Willy Tarreau2bbba412010-01-28 16:48:33 +01001024 */
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001025struct acl_cond *build_acl_cond(const char *file, int line, struct list *known_acl,
1026 struct proxy *px, const char **args, char **err)
Willy Tarreau2bbba412010-01-28 16:48:33 +01001027{
Willy Tarreau0cba6072013-11-28 22:21:02 +01001028 enum acl_cond_pol pol = ACL_COND_NONE;
Willy Tarreau2bbba412010-01-28 16:48:33 +01001029 struct acl_cond *cond = NULL;
1030
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001031 if (err)
1032 *err = NULL;
1033
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001034 if (strcmp(*args, "if") == 0) {
Willy Tarreau2bbba412010-01-28 16:48:33 +01001035 pol = ACL_COND_IF;
1036 args++;
1037 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001038 else if (strcmp(*args, "unless") == 0) {
Willy Tarreau2bbba412010-01-28 16:48:33 +01001039 pol = ACL_COND_UNLESS;
1040 args++;
1041 }
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001042 else {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001043 memprintf(err, "conditions must start with either 'if' or 'unless'");
Willy Tarreau2bbba412010-01-28 16:48:33 +01001044 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001045 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001046
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001047 cond = parse_acl_cond(args, known_acl, pol, err, &px->conf.args, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001048 if (!cond) {
1049 /* note that parse_acl_cond must have filled <err> here */
Willy Tarreau2bbba412010-01-28 16:48:33 +01001050 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001051 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001052
1053 cond->file = file;
1054 cond->line = line;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001055 px->http_needed |= !!(cond->use & SMP_USE_HTTP_ANY);
Willy Tarreau2bbba412010-01-28 16:48:33 +01001056 return cond;
1057}
1058
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001059/* Execute condition <cond> and return either ACL_TEST_FAIL, ACL_TEST_MISS or
1060 * ACL_TEST_PASS depending on the test results. ACL_TEST_MISS may only be
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001061 * returned if <opt> does not contain SMP_OPT_FINAL, indicating that incomplete
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001062 * data is being examined. The function automatically sets SMP_OPT_ITERATE. This
1063 * function only computes the condition, it does not apply the polarity required
1064 * by IF/UNLESS, it's up to the caller to do this using something like this :
Willy Tarreau11382812008-07-09 16:18:21 +02001065 *
1066 * res = acl_pass(res);
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001067 * if (res == ACL_TEST_MISS)
Willy Tarreaub6866442008-07-14 23:54:42 +02001068 * return 0;
Willy Tarreau11382812008-07-09 16:18:21 +02001069 * if (cond->pol == ACL_COND_UNLESS)
1070 * res = !res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001071 */
Willy Tarreau192252e2015-04-04 01:47:55 +02001072enum 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 +02001073{
1074 __label__ fetch_next;
1075 struct acl_term_suite *suite;
1076 struct acl_term *term;
1077 struct acl_expr *expr;
1078 struct acl *acl;
Willy Tarreau37406352012-04-23 16:16:37 +02001079 struct sample smp;
Willy Tarreau0cba6072013-11-28 22:21:02 +01001080 enum acl_test_res acl_res, suite_res, cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001081
Willy Tarreau7a777ed2012-04-26 11:44:02 +02001082 /* ACLs are iterated over all values, so let's always set the flag to
1083 * indicate this to the fetch functions.
1084 */
1085 opt |= SMP_OPT_ITERATE;
1086
Willy Tarreau11382812008-07-09 16:18:21 +02001087 /* We're doing a logical OR between conditions so we initialize to FAIL.
1088 * The MISS status is propagated down from the suites.
1089 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001090 cond_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001091 list_for_each_entry(suite, &cond->suites, list) {
Willy Tarreau11382812008-07-09 16:18:21 +02001092 /* Evaluate condition suite <suite>. We stop at the first term
Willy Tarreau0cba6072013-11-28 22:21:02 +01001093 * which returns ACL_TEST_FAIL. The MISS status is still propagated
Willy Tarreau11382812008-07-09 16:18:21 +02001094 * in case of uncertainty in the result.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001095 */
1096
1097 /* we're doing a logical AND between terms, so we must set the
1098 * initial value to PASS.
1099 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001100 suite_res = ACL_TEST_PASS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001101 list_for_each_entry(term, &suite->terms, list) {
1102 acl = term->acl;
1103
1104 /* FIXME: use cache !
1105 * check acl->cache_idx for this.
1106 */
1107
1108 /* ACL result not cached. Let's scan all the expressions
1109 * and use the first one to match.
1110 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001111 acl_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001112 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaud41f8d82007-06-10 10:06:18 +02001113 /* we need to reset context and flags */
Willy Tarreau37406352012-04-23 16:16:37 +02001114 memset(&smp, 0, sizeof(smp));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001115 fetch_next:
Willy Tarreau192252e2015-04-04 01:47:55 +02001116 if (!sample_process(px, sess, strm, opt, expr->smp, &smp)) {
Willy Tarreaub6866442008-07-14 23:54:42 +02001117 /* maybe we could not fetch because of missing data */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001118 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001119 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001120 continue;
Willy Tarreaub6866442008-07-14 23:54:42 +02001121 }
Willy Tarreauc4262962010-05-10 23:42:40 +02001122
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +01001123 acl_res |= pat2acl(pattern_exec_match(&expr->pat, &smp, 0));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001124 /*
Willy Tarreau11382812008-07-09 16:18:21 +02001125 * OK now acl_res holds the result of this expression
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001126 * as one of ACL_TEST_FAIL, ACL_TEST_MISS or ACL_TEST_PASS.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001127 *
Willy Tarreau11382812008-07-09 16:18:21 +02001128 * Then if (!MISS) we can cache the result, and put
Willy Tarreau37406352012-04-23 16:16:37 +02001129 * (smp.flags & SMP_F_VOLATILE) in the cache flags.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001130 *
1131 * FIXME: implement cache.
1132 *
1133 */
1134
Willy Tarreau11382812008-07-09 16:18:21 +02001135 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001136 if (acl_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001137 break;
1138
Willy Tarreau37406352012-04-23 16:16:37 +02001139 if (smp.flags & SMP_F_NOT_LAST)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001140 goto fetch_next;
Willy Tarreaub6866442008-07-14 23:54:42 +02001141
1142 /* sometimes we know the fetched data is subject to change
1143 * later and give another chance for a new match (eg: request
1144 * size, time, ...)
1145 */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001146 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001147 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001148 }
1149 /*
1150 * Here we have the result of an ACL (cached or not).
1151 * ACLs are combined, negated or not, to form conditions.
1152 */
1153
Willy Tarreaua84d3742007-05-07 00:36:48 +02001154 if (term->neg)
Willy Tarreau11382812008-07-09 16:18:21 +02001155 acl_res = acl_neg(acl_res);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001156
1157 suite_res &= acl_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001158
Willy Tarreau79c412b2013-10-30 19:30:32 +01001159 /* we're ANDing these terms, so a single FAIL or MISS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001160 if (suite_res != ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001161 break;
1162 }
1163 cond_res |= suite_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001164
1165 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001166 if (cond_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001167 break;
1168 }
Willy Tarreau11382812008-07-09 16:18:21 +02001169 return cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001170}
1171
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001172/* Returns a pointer to the first ACL conflicting with usage at place <where>
1173 * which is one of the SMP_VAL_* bits indicating a check place, or NULL if
1174 * no conflict is found. Only full conflicts are detected (ACL is not usable).
1175 * Use the next function to check for useless keywords.
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001176 */
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001177const struct acl *acl_cond_conflicts(const struct acl_cond *cond, unsigned int where)
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001178{
1179 struct acl_term_suite *suite;
1180 struct acl_term *term;
1181 struct acl *acl;
1182
1183 list_for_each_entry(suite, &cond->suites, list) {
1184 list_for_each_entry(term, &suite->terms, list) {
1185 acl = term->acl;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001186 if (!(acl->val & where))
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001187 return acl;
1188 }
1189 }
1190 return NULL;
1191}
1192
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001193/* Returns a pointer to the first ACL and its first keyword to conflict with
1194 * usage at place <where> which is one of the SMP_VAL_* bits indicating a check
1195 * place. Returns true if a conflict is found, with <acl> and <kw> set (if non
1196 * null), or false if not conflict is found. The first useless keyword is
1197 * returned.
1198 */
Willy Tarreau93fddf12013-03-31 22:59:32 +02001199int 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 +01001200{
1201 struct acl_term_suite *suite;
1202 struct acl_term *term;
1203 struct acl_expr *expr;
1204
1205 list_for_each_entry(suite, &cond->suites, list) {
1206 list_for_each_entry(term, &suite->terms, list) {
1207 list_for_each_entry(expr, &term->acl->expr, list) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001208 if (!(expr->smp->fetch->val & where)) {
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001209 if (acl)
1210 *acl = term->acl;
1211 if (kw)
1212 *kw = expr->kw;
1213 return 1;
1214 }
1215 }
1216 }
1217 }
1218 return 0;
1219}
1220
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001221/*
1222 * Find targets for userlist and groups in acl. Function returns the number
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001223 * of errors or OK if everything is fine. It must be called only once sample
1224 * fetch arguments have been resolved (after smp_resolve_args()).
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001225 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001226int acl_find_targets(struct proxy *p)
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001227{
1228
1229 struct acl *acl;
1230 struct acl_expr *expr;
Thierry FOURNIER3ead5b92013-12-13 12:12:18 +01001231 struct pattern_list *pattern;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001232 int cfgerr = 0;
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001233 struct pattern_expr_list *pexp;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001234
1235 list_for_each_entry(acl, &p->acl, list) {
1236 list_for_each_entry(expr, &acl->expr, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001237 if (strcmp(expr->kw, "http_auth_group") == 0) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001238 /* Note: the ARGT_USR argument may only have been resolved earlier
1239 * by smp_resolve_args().
1240 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001241 if (expr->smp->arg_p->unresolved) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001242 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 +02001243 p->id, *acl->name ? "" : "anonymous ", acl->name, expr->kw,
1244 expr->smp->arg_p->data.str.area);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001245 cfgerr++;
Willy Tarreau496aa012012-06-01 10:38:29 +02001246 continue;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001247 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001248
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001249 if (LIST_ISEMPTY(&expr->pat.head)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001250 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1251 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001252 cfgerr++;
1253 continue;
1254 }
1255
Thierry FOURNIER9eec0a62014-01-22 18:38:02 +01001256 /* For each pattern, check if the group exists. */
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001257 list_for_each_entry(pexp, &expr->pat.head, list) {
1258 if (LIST_ISEMPTY(&pexp->expr->patterns)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001259 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1260 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001261 cfgerr++;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001262 continue;
1263 }
1264
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001265 list_for_each_entry(pattern, &pexp->expr->patterns, list) {
1266 /* this keyword only has one argument */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001267 if (!check_group(expr->smp->arg_p->data.usr, pattern->pat.ptr.str)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001268 ha_alert("proxy %s: acl %s %s(): invalid group '%s'.\n",
1269 p->id, acl->name, expr->kw, pattern->pat.ptr.str);
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001270 cfgerr++;
1271 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001272 }
1273 }
1274 }
1275 }
1276 }
1277
1278 return cfgerr;
1279}
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001280
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001281/* initializes ACLs by resolving the sample fetch names they rely upon.
1282 * Returns 0 on success, otherwise an error.
1283 */
1284int init_acl()
1285{
1286 int err = 0;
1287 int index;
1288 const char *name;
1289 struct acl_kw_list *kwl;
1290 struct sample_fetch *smp;
1291
1292 list_for_each_entry(kwl, &acl_keywords.list, list) {
1293 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1294 name = kwl->kw[index].fetch_kw;
1295 if (!name)
1296 name = kwl->kw[index].kw;
1297
1298 smp = find_sample_fetch(name, strlen(name));
1299 if (!smp) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001300 ha_alert("Critical internal error: ACL keyword '%s' relies on sample fetch '%s' which was not registered!\n",
1301 kwl->kw[index].kw, name);
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001302 err++;
1303 continue;
1304 }
1305 kwl->kw[index].smp = smp;
1306 }
1307 }
1308 return err;
1309}
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001310
Willy Tarreau6ff7d1b2022-03-29 15:36:56 +02001311/* dump known ACL keywords on stdout */
1312void acl_dump_kwd(void)
1313{
1314 struct acl_kw_list *kwl;
Willy Tarreau800bd782022-03-30 11:49:59 +02001315 const struct acl_keyword *kwp, *kw;
Willy Tarreau6ff7d1b2022-03-29 15:36:56 +02001316 const char *name;
1317 int index;
1318
Willy Tarreau800bd782022-03-30 11:49:59 +02001319 for (kw = kwp = NULL;; kwp = kw) {
1320 list_for_each_entry(kwl, &acl_keywords.list, list) {
1321 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1322 if (strordered(kwp ? kwp->kw : NULL,
1323 kwl->kw[index].kw,
1324 kw != kwp ? kw->kw : NULL))
1325 kw = &kwl->kw[index];
1326 }
Willy Tarreau6ff7d1b2022-03-29 15:36:56 +02001327 }
Willy Tarreau800bd782022-03-30 11:49:59 +02001328
1329 if (kw == kwp)
1330 break;
1331
1332 name = kw->fetch_kw;
1333 if (!name)
1334 name = kw->kw;
1335
1336 printf("%s = %s -m %s\n", kw->kw, name, pat_match_names[kw->match_type]);
Willy Tarreau6ff7d1b2022-03-29 15:36:56 +02001337 }
1338}
1339
Amaury Denoyelle68fd7e42021-03-25 17:15:52 +01001340void free_acl_cond(struct acl_cond *cond)
1341{
1342 struct acl_term_suite *suite, *suiteb;
1343 struct acl_term *term, *termb;
1344
1345 if (!cond)
1346 return;
1347
1348 list_for_each_entry_safe(suite, suiteb, &cond->suites, list) {
1349 list_for_each_entry_safe(term, termb, &suite->terms, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001350 LIST_DELETE(&term->list);
Amaury Denoyelle68fd7e42021-03-25 17:15:52 +01001351 free(term);
1352 }
Willy Tarreau2b718102021-04-21 07:32:39 +02001353 LIST_DELETE(&suite->list);
Amaury Denoyelle68fd7e42021-03-25 17:15:52 +01001354 free(suite);
1355 }
1356
1357 free(cond);
1358}
1359
Willy Tarreaua84d3742007-05-07 00:36:48 +02001360/************************************************************************/
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001361/* All supported sample and ACL keywords must be declared here. */
1362/************************************************************************/
1363
1364/* Note: must not be declared <const> as its list will be overwritten.
Willy Tarreau61612d42012-04-19 18:42:05 +02001365 * Please take care of keeping this list alphabetically sorted.
1366 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001367static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001368 { /* END */ },
Willy Tarreaua84d3742007-05-07 00:36:48 +02001369}};
1370
Willy Tarreau0108d902018-11-25 19:14:37 +01001371INITCALL1(STG_REGISTER, acl_register_keywords, &acl_kws);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001372
1373/*
1374 * Local variables:
1375 * c-indent-level: 8
1376 * c-basic-offset: 8
1377 * End:
1378 */