blob: e3fcf62c8229bf8c8cceacac661a7fe06e0bdf0b [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;
Willy Tarreau145325e2017-04-12 23:03:31 +0200104 int unresolved = 0;
Willy Tarreau34db1082012-04-19 17:16:54 +0200105
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100106 pattern_prune(&expr->pat);
Willy Tarreau34db1082012-04-19 17:16:54 +0200107
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100108 for (arg = expr->smp->arg_p; arg; arg++) {
Willy Tarreau34db1082012-04-19 17:16:54 +0200109 if (arg->type == ARGT_STOP)
110 break;
Willy Tarreau496aa012012-06-01 10:38:29 +0200111 if (arg->type == ARGT_STR || arg->unresolved) {
Christopher Faulet6ad7df42020-08-07 11:45:18 +0200112 chunk_destroy(&arg->data.str);
Willy Tarreau145325e2017-04-12 23:03:31 +0200113 unresolved |= arg->unresolved;
Willy Tarreau496aa012012-06-01 10:38:29 +0200114 arg->unresolved = 0;
Willy Tarreau34db1082012-04-19 17:16:54 +0200115 }
Willy Tarreau34db1082012-04-19 17:16:54 +0200116 }
117
Tim Duesterhus9fa0df52020-07-04 11:49:38 +0200118 release_sample_expr(expr->smp);
119
Willy Tarreaua84d3742007-05-07 00:36:48 +0200120 return expr;
121}
122
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200123/* Parse an ACL expression starting at <args>[0], and return it. If <err> is
124 * not NULL, it will be filled with a pointer to an error message in case of
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200125 * error. This pointer must be freeable or NULL. <al> is an arg_list serving
Christopher Faulet45bb15f2021-09-30 08:48:56 +0200126 * as a list head to report missing dependencies. It may be NULL if such
127 * dependencies are not allowed.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200128 *
Willy Tarreaua84d3742007-05-07 00:36:48 +0200129 * Right now, the only accepted syntax is :
130 * <subject> [<value>...]
131 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100132struct acl_expr *parse_acl_expr(const char **args, char **err, struct arg_list *al,
133 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200134{
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100135 __label__ out_return, out_free_expr;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200136 struct acl_expr *expr;
137 struct acl_keyword *aclkw;
Christopher Faulet54ceb042017-06-14 14:41:33 +0200138 int refflags, patflags;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200139 const char *arg;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100140 struct sample_expr *smp = NULL;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100141 int idx = 0;
142 char *ckw = NULL;
143 const char *begw;
144 const char *endw;
Willy Tarreau131b4662013-12-13 01:08:36 +0100145 const char *endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100146 int cur_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100147 int nbargs;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100148 int operator = STD_OP_EQ;
149 int op;
150 int contain_colon, have_dot;
151 const char *dot;
152 signed long long value, minor;
153 /* The following buffer contain two numbers, a ':' separator and the final \0. */
154 char buffer[NB_LLMAX_STR + 1 + NB_LLMAX_STR + 1];
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100155 int is_loaded;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100156 int unique_id;
157 char *error;
158 struct pat_ref *ref;
159 struct pattern_expr *pattern_expr;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100160 int load_as_map = 0;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200161 int acl_conv_found = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200162
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100163 /* First, we look for an ACL keyword. And if we don't find one, then
164 * we look for a sample fetch expression starting with a sample fetch
165 * keyword.
Willy Tarreaubef91e72013-03-31 23:14:46 +0200166 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100167
Christopher Faulet45bb15f2021-09-30 08:48:56 +0200168 if (al) {
169 al->ctx = ARGC_ACL; // to report errors while resolving args late
170 al->kw = *args;
171 al->conv = NULL;
172 }
Willy Tarreau131b4662013-12-13 01:08:36 +0100173
Willy Tarreaua84d3742007-05-07 00:36:48 +0200174 aclkw = find_acl_kw(args[0]);
Willy Tarreau20490922014-03-17 18:04:27 +0100175 if (aclkw) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100176 /* OK we have a real ACL keyword */
Willy Tarreau9987ea92013-06-11 21:09:06 +0200177
Willy Tarreau131b4662013-12-13 01:08:36 +0100178 /* build new sample expression for this ACL */
Vincent Bernat02779b62016-04-03 13:48:43 +0200179 smp = calloc(1, sizeof(*smp));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100180 if (!smp) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100181 memprintf(err, "out of memory when parsing ACL expression");
182 goto out_return;
183 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100184 LIST_INIT(&(smp->conv_exprs));
185 smp->fetch = aclkw->smp;
186 smp->arg_p = empty_arg_list;
Willy Tarreau34db1082012-04-19 17:16:54 +0200187
Joseph Herlant68082792018-11-15 14:55:09 -0800188 /* look for the beginning of the subject arguments */
Willy Tarreaued2c6622020-02-14 18:27:10 +0100189 for (arg = args[0]; is_idchar(*arg); arg++)
190 ;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100191
Willy Tarreau131b4662013-12-13 01:08:36 +0100192 /* At this point, we have :
193 * - args[0] : beginning of the keyword
194 * - arg : end of the keyword, first character not part of keyword
Willy Tarreau131b4662013-12-13 01:08:36 +0100195 */
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100196 nbargs = make_arg_list(arg, -1, smp->fetch->arg_mask, &smp->arg_p,
197 err, &endt, NULL, al);
Willy Tarreau131b4662013-12-13 01:08:36 +0100198 if (nbargs < 0) {
199 /* note that make_arg_list will have set <err> here */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100200 memprintf(err, "ACL keyword '%s' : %s", aclkw->kw, *err);
201 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100202 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100203
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100204 if (!smp->arg_p) {
205 smp->arg_p = empty_arg_list;
Willy Tarreau131b4662013-12-13 01:08:36 +0100206 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100207 else if (smp->fetch->val_args && !smp->fetch->val_args(smp->arg_p, err)) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100208 /* invalid keyword argument, error must have been
209 * set by val_args().
210 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100211 memprintf(err, "in argument to '%s', %s", aclkw->kw, *err);
212 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100213 }
214 arg = endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100215
Joseph Herlant68082792018-11-15 14:55:09 -0800216 /* look for the beginning of the converters list. Those directly attached
Willy Tarreau131b4662013-12-13 01:08:36 +0100217 * to the ACL keyword are found just after <arg> which points to the comma.
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200218 * If we find any converter, then we don't use the ACL keyword's match
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200219 * anymore but the one related to the converter's output type.
Willy Tarreau131b4662013-12-13 01:08:36 +0100220 */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200221 cur_type = smp->fetch->out_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100222 while (*arg) {
223 struct sample_conv *conv;
224 struct sample_conv_expr *conv_expr;
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100225 int err_arg;
226 int argcnt;
Willy Tarreau131b4662013-12-13 01:08:36 +0100227
228 if (*arg && *arg != ',') {
229 if (ckw)
Willy Tarreau97108e02016-11-25 07:33:24 +0100230 memprintf(err, "ACL keyword '%s' : missing comma after converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100231 aclkw->kw, ckw);
Willy Tarreau131b4662013-12-13 01:08:36 +0100232 else
233 memprintf(err, "ACL keyword '%s' : missing comma after fetch keyword.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100234 aclkw->kw);
235 goto out_free_smp;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200236 }
Willy Tarreauae52f062012-04-26 12:13:35 +0200237
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100238 /* FIXME: how long should we support such idiocies ? Maybe we
239 * should already warn ?
240 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100241 while (*arg == ',') /* then trailing commas */
242 arg++;
Willy Tarreau2e845be2012-10-19 19:49:09 +0200243
Willy Tarreau97108e02016-11-25 07:33:24 +0100244 begw = arg; /* start of converter keyword */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100245
Willy Tarreau131b4662013-12-13 01:08:36 +0100246 if (!*begw)
247 /* none ? end of converters */
248 break;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100249
Willy Tarreaued2c6622020-02-14 18:27:10 +0100250 for (endw = begw; is_idchar(*endw); endw++)
251 ;
Willy Tarreau9ca69362013-10-22 19:10:06 +0200252
Willy Tarreau131b4662013-12-13 01:08:36 +0100253 free(ckw);
254 ckw = my_strndup(begw, endw - begw);
Willy Tarreauf75d0082013-04-07 21:20:44 +0200255
Willy Tarreau131b4662013-12-13 01:08:36 +0100256 conv = find_sample_conv(begw, endw - begw);
257 if (!conv) {
258 /* Unknown converter method */
Willy Tarreau97108e02016-11-25 07:33:24 +0100259 memprintf(err, "ACL keyword '%s' : unknown converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100260 aclkw->kw, ckw);
261 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100262 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100263
Willy Tarreau131b4662013-12-13 01:08:36 +0100264 arg = endw;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100265
Willy Tarreau131b4662013-12-13 01:08:36 +0100266 if (conv->in_type >= SMP_TYPES || conv->out_type >= SMP_TYPES) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100267 memprintf(err, "ACL keyword '%s' : returns type of converter '%s' is unknown.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100268 aclkw->kw, ckw);
269 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100270 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100271
Willy Tarreau131b4662013-12-13 01:08:36 +0100272 /* If impossible type conversion */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200273 if (!sample_casts[cur_type][conv->in_type]) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100274 memprintf(err, "ACL keyword '%s' : converter '%s' cannot be applied.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100275 aclkw->kw, ckw);
276 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100277 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100278
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200279 cur_type = conv->out_type;
Vincent Bernat02779b62016-04-03 13:48:43 +0200280 conv_expr = calloc(1, sizeof(*conv_expr));
Willy Tarreau131b4662013-12-13 01:08:36 +0100281 if (!conv_expr)
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100282 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100283
Willy Tarreau2b718102021-04-21 07:32:39 +0200284 LIST_APPEND(&(smp->conv_exprs), &(conv_expr->list));
Willy Tarreau131b4662013-12-13 01:08:36 +0100285 conv_expr->conv = conv;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200286 acl_conv_found = 1;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100287
Christopher Faulet45bb15f2021-09-30 08:48:56 +0200288 if (al) {
289 al->kw = smp->fetch->kw;
290 al->conv = conv_expr->conv->kw;
291 }
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100292 argcnt = make_arg_list(endw, -1, conv->arg_mask, &conv_expr->arg_p, err, &arg, &err_arg, al);
293 if (argcnt < 0) {
294 memprintf(err, "ACL keyword '%s' : invalid arg %d in converter '%s' : %s.",
295 aclkw->kw, err_arg+1, ckw, *err);
296 goto out_free_smp;
297 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100298
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100299 if (argcnt && !conv->arg_mask) {
300 memprintf(err, "converter '%s' does not support any args", ckw);
301 goto out_free_smp;
302 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100303
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100304 if (!conv_expr->arg_p)
305 conv_expr->arg_p = empty_arg_list;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100306
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100307 if (conv->val_args && !conv->val_args(conv_expr->arg_p, conv, file, line, err)) {
308 memprintf(err, "ACL keyword '%s' : invalid args in converter '%s' : %s.",
309 aclkw->kw, ckw, *err);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100310 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100311 }
Willy Tarreau61612d42012-04-19 18:42:05 +0200312 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100313 ha_free(&ckw);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200314 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100315 else {
316 /* This is not an ACL keyword, so we hope this is a sample fetch
317 * keyword that we're going to transparently use as an ACL. If
318 * so, we retrieve a completely parsed expression with args and
319 * convs already done.
320 */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100321 smp = sample_parse_expr((char **)args, &idx, file, line, err, al, NULL);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100322 if (!smp) {
323 memprintf(err, "%s in ACL expression '%s'", *err, *args);
324 goto out_return;
325 }
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200326 cur_type = smp_expr_output_type(smp);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100327 }
328
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200329 expr = calloc(1, sizeof(*expr));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100330 if (!expr) {
331 memprintf(err, "out of memory when parsing ACL expression");
Christopher Faulet361935a2019-09-13 09:50:15 +0200332 goto out_free_smp;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100333 }
334
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100335 pattern_init_head(&expr->pat);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100336
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200337 expr->pat.expect_type = cur_type;
338 expr->smp = smp;
339 expr->kw = smp->fetch->kw;
340 smp = NULL; /* don't free it anymore */
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100341
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200342 if (aclkw && !acl_conv_found) {
343 expr->kw = aclkw->kw;
344 expr->pat.parse = aclkw->parse ? aclkw->parse : pat_parse_fcts[aclkw->match_type];
345 expr->pat.index = aclkw->index ? aclkw->index : pat_index_fcts[aclkw->match_type];
346 expr->pat.match = aclkw->match ? aclkw->match : pat_match_fcts[aclkw->match_type];
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200347 expr->pat.prune = aclkw->prune ? aclkw->prune : pat_prune_fcts[aclkw->match_type];
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100348 }
349
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100350 if (!expr->pat.parse) {
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200351 /* Parse/index/match functions depend on the expression type,
352 * so we have to map them now. Some types can be automatically
353 * converted.
354 */
355 switch (cur_type) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100356 case SMP_T_BOOL:
357 expr->pat.parse = pat_parse_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100358 expr->pat.index = pat_index_fcts[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100359 expr->pat.match = pat_match_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100360 expr->pat.prune = pat_prune_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100361 expr->pat.expect_type = pat_match_types[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100362 break;
363 case SMP_T_SINT:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100364 expr->pat.parse = pat_parse_fcts[PAT_MATCH_INT];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100365 expr->pat.index = pat_index_fcts[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100366 expr->pat.match = pat_match_fcts[PAT_MATCH_INT];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100367 expr->pat.prune = pat_prune_fcts[PAT_MATCH_INT];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100368 expr->pat.expect_type = pat_match_types[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100369 break;
Willy Tarreau78c5eec2019-04-19 11:45:20 +0200370 case SMP_T_ADDR:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100371 case SMP_T_IPV4:
372 case SMP_T_IPV6:
373 expr->pat.parse = pat_parse_fcts[PAT_MATCH_IP];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100374 expr->pat.index = pat_index_fcts[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100375 expr->pat.match = pat_match_fcts[PAT_MATCH_IP];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100376 expr->pat.prune = pat_prune_fcts[PAT_MATCH_IP];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100377 expr->pat.expect_type = pat_match_types[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100378 break;
Thierry FOURNIER9fefbd52014-05-11 15:15:00 +0200379 case SMP_T_STR:
380 expr->pat.parse = pat_parse_fcts[PAT_MATCH_STR];
381 expr->pat.index = pat_index_fcts[PAT_MATCH_STR];
382 expr->pat.match = pat_match_fcts[PAT_MATCH_STR];
Thierry FOURNIER9fefbd52014-05-11 15:15:00 +0200383 expr->pat.prune = pat_prune_fcts[PAT_MATCH_STR];
384 expr->pat.expect_type = pat_match_types[PAT_MATCH_STR];
385 break;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100386 }
387 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200388
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100389 /* Additional check to protect against common mistakes */
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100390 if (expr->pat.parse && cur_type != SMP_T_BOOL && !*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100391 ha_warning("parsing acl keyword '%s' :\n"
392 " no pattern to match against were provided, so this ACL will never match.\n"
393 " If this is what you intended, please add '--' to get rid of this warning.\n"
394 " If you intended to match only for existence, please use '-m found'.\n"
395 " If you wanted to force an int to match as a bool, please use '-m bool'.\n"
396 "\n",
397 args[0]);
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100398 }
399
Willy Tarreaua84d3742007-05-07 00:36:48 +0200400 args++;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200401
402 /* check for options before patterns. Supported options are :
403 * -i : ignore case for all patterns by default
404 * -f : read patterns from those files
Willy Tarreau5adeda12013-03-31 22:13:34 +0200405 * -m : force matching method (must be used before -f)
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100406 * -M : load the file as map file
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100407 * -u : force the unique id of the acl
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200408 * -- : everything after this is not an option
409 */
Christopher Faulet54ceb042017-06-14 14:41:33 +0200410 refflags = PAT_REF_ACL;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200411 patflags = 0;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100412 is_loaded = 0;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100413 unique_id = -1;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200414 while (**args == '-') {
Willy Tarreau2039bba2014-05-11 09:43:46 +0200415 if (strcmp(*args, "-i") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200416 patflags |= PAT_MF_IGNORE_CASE;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200417 else if (strcmp(*args, "-n") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200418 patflags |= PAT_MF_NO_DNS;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200419 else if (strcmp(*args, "-u") == 0) {
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100420 unique_id = strtol(args[1], &error, 10);
421 if (*error != '\0') {
422 memprintf(err, "the argument of -u must be an integer");
423 goto out_free_expr;
424 }
425
426 /* Check if this id is really unique. */
427 if (pat_ref_lookupid(unique_id)) {
428 memprintf(err, "the id is already used");
429 goto out_free_expr;
430 }
431
432 args++;
433 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200434 else if (strcmp(*args, "-f") == 0) {
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100435 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200436 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 +0200437 goto out_free_expr;
438 }
439
Christopher Faulet54ceb042017-06-14 14:41:33 +0200440 if (!pattern_read_from_file(&expr->pat, refflags, args[1], patflags, load_as_map, err, file, line))
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200441 goto out_free_expr;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100442 is_loaded = 1;
Willy Tarreau5adeda12013-03-31 22:13:34 +0200443 args++;
444 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200445 else if (strcmp(*args, "-m") == 0) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200446 int idx;
447
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100448 if (is_loaded) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200449 memprintf(err, "'-m' must only be specified before patterns and files in parsing ACL expression");
450 goto out_free_expr;
451 }
452
Willy Tarreau6f8fe312013-11-28 22:24:25 +0100453 idx = pat_find_match_name(args[1]);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200454 if (idx < 0) {
455 memprintf(err, "unknown matching method '%s' when parsing ACL expression", args[1]);
456 goto out_free_expr;
457 }
458
459 /* Note: -m found is always valid, bool/int are compatible, str/bin/reg/len are compatible */
Willy Tarreau9bb49f62015-09-24 16:37:12 +0200460 if (idx != PAT_MATCH_FOUND && !sample_casts[cur_type][pat_match_types[idx]]) {
Willy Tarreau93fddf12013-03-31 22:59:32 +0200461 memprintf(err, "matching method '%s' cannot be used with fetch keyword '%s'", args[1], expr->kw);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200462 goto out_free_expr;
463 }
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100464 expr->pat.parse = pat_parse_fcts[idx];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100465 expr->pat.index = pat_index_fcts[idx];
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100466 expr->pat.match = pat_match_fcts[idx];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100467 expr->pat.prune = pat_prune_fcts[idx];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100468 expr->pat.expect_type = pat_match_types[idx];
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200469 args++;
470 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200471 else if (strcmp(*args, "-M") == 0) {
Christopher Faulet54ceb042017-06-14 14:41:33 +0200472 refflags |= PAT_REF_MAP;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100473 load_as_map = 1;
474 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200475 else if (strcmp(*args, "--") == 0) {
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200476 args++;
477 break;
478 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200479 else {
480 memprintf(err, "'%s' is not a valid ACL option. Please use '--' before any pattern beginning with a '-'", args[0]);
481 goto out_free_expr;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200482 break;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200483 }
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200484 args++;
485 }
486
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100487 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200488 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 +0200489 goto out_free_expr;
490 }
491
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100492 /* Create displayed reference */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200493 snprintf(trash.area, trash.size, "acl '%s' file '%s' line %d",
494 expr->kw, file, line);
495 trash.area[trash.size - 1] = '\0';
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100496
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500497 /* Create new pattern reference. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200498 ref = pat_ref_newid(unique_id, trash.area, PAT_REF_ACL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100499 if (!ref) {
500 memprintf(err, "memory error");
501 goto out_free_expr;
502 }
503
504 /* Create new pattern expression associated to this reference. */
Emeric Brun7d27f3c2017-07-03 17:54:23 +0200505 pattern_expr = pattern_new_expr(&expr->pat, ref, patflags, err, NULL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100506 if (!pattern_expr)
507 goto out_free_expr;
508
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200509 /* now parse all patterns */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100510 while (**args) {
511 arg = *args;
512
513 /* Compatibility layer. Each pattern can parse only one string per pattern,
514 * but the pat_parser_int() and pat_parse_dotted_ver() parsers were need
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500515 * optionally two operators. The first operator is the match method: eq,
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100516 * le, lt, ge and gt. pat_parse_int() and pat_parse_dotted_ver() functions
517 * can have a compatibility syntax based on ranges:
518 *
519 * pat_parse_int():
520 *
521 * "eq x" -> "x" or "x:x"
522 * "le x" -> ":x"
523 * "lt x" -> ":y" (with y = x - 1)
524 * "ge x" -> "x:"
525 * "gt x" -> "y:" (with y = x + 1)
526 *
527 * pat_parse_dotted_ver():
528 *
529 * "eq x.y" -> "x.y" or "x.y:x.y"
530 * "le x.y" -> ":x.y"
531 * "lt x.y" -> ":w.z" (with w.z = x.y - 1)
532 * "ge x.y" -> "x.y:"
533 * "gt x.y" -> "w.z:" (with w.z = x.y + 1)
534 *
535 * If y is not present, assume that is "0".
536 *
537 * The syntax eq, le, lt, ge and gt are proper to the acl syntax. The
538 * following block of code detect the operator, and rewrite each value
539 * in parsable string.
540 */
541 if (expr->pat.parse == pat_parse_int ||
542 expr->pat.parse == pat_parse_dotted_ver) {
543 /* Check for operator. If the argument is operator, memorise it and
544 * continue to the next argument.
545 */
546 op = get_std_op(arg);
547 if (op != -1) {
548 operator = op;
549 args++;
550 continue;
551 }
552
553 /* Check if the pattern contain ':' or '-' character. */
554 contain_colon = (strchr(arg, ':') || strchr(arg, '-'));
555
556 /* If the pattern contain ':' or '-' character, give it to the parser as is.
557 * If no contain ':' and operator is STD_OP_EQ, give it to the parser as is.
558 * In other case, try to convert the value according with the operator.
559 */
560 if (!contain_colon && operator != STD_OP_EQ) {
561 /* Search '.' separator. */
562 dot = strchr(arg, '.');
563 if (!dot) {
564 have_dot = 0;
565 minor = 0;
566 dot = arg + strlen(arg);
567 }
568 else
569 have_dot = 1;
570
571 /* convert the integer minor part for the pat_parse_dotted_ver() function. */
572 if (expr->pat.parse == pat_parse_dotted_ver && have_dot) {
573 if (strl2llrc(dot+1, strlen(dot+1), &minor) != 0) {
574 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100575 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100576 }
577 if (minor >= 65536) {
578 memprintf(err, "'%s' contains too large a minor value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100579 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100580 }
581 }
582
583 /* convert the integer value for the pat_parse_int() function, and the
584 * integer major part for the pat_parse_dotted_ver() function.
585 */
586 if (strl2llrc(arg, dot - arg, &value) != 0) {
587 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100588 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100589 }
590 if (expr->pat.parse == pat_parse_dotted_ver) {
591 if (value >= 65536) {
592 memprintf(err, "'%s' contains too large a major value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100593 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100594 }
595 value = (value << 16) | (minor & 0xffff);
596 }
597
598 switch (operator) {
599
600 case STD_OP_EQ: /* this case is not possible. */
601 memprintf(err, "internal error");
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100602 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100603
604 case STD_OP_GT:
605 value++; /* gt = ge + 1 */
Tim Duesterhus588b3142020-05-29 14:35:51 +0200606 /* fall through */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100607
608 case STD_OP_GE:
609 if (expr->pat.parse == pat_parse_int)
610 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld:", value);
611 else
612 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld.%lld:",
613 value >> 16, value & 0xffff);
614 arg = buffer;
615 break;
616
617 case STD_OP_LT:
618 value--; /* lt = le - 1 */
Tim Duesterhus588b3142020-05-29 14:35:51 +0200619 /* fall through */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100620
621 case STD_OP_LE:
622 if (expr->pat.parse == pat_parse_int)
623 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld", value);
624 else
625 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld.%lld",
626 value >> 16, value & 0xffff);
627 arg = buffer;
628 break;
629 }
630 }
631 }
632
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100633 /* Add sample to the reference, and try to compile it fior each pattern
634 * using this value.
635 */
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200636 if (!pat_ref_add(ref, arg, NULL, err))
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100637 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100638 args++;
639 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200640
641 return expr;
642
Willy Tarreaua84d3742007-05-07 00:36:48 +0200643 out_free_expr:
644 prune_acl_expr(expr);
645 free(expr);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100646 out_free_smp:
Christopher Faulet361935a2019-09-13 09:50:15 +0200647 free(ckw);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100648 free(smp);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200649 out_return:
650 return NULL;
651}
652
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200653/* Purge everything in the acl <acl>, then return <acl>. */
654struct acl *prune_acl(struct acl *acl) {
655
656 struct acl_expr *expr, *exprb;
657
658 free(acl->name);
659
660 list_for_each_entry_safe(expr, exprb, &acl->expr, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200661 LIST_DELETE(&expr->list);
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200662 prune_acl_expr(expr);
663 free(expr);
664 }
665
666 return acl;
667}
668
Willy Tarreaua84d3742007-05-07 00:36:48 +0200669/* Parse an ACL with the name starting at <args>[0], and with a list of already
670 * known ACLs in <acl>. If the ACL was not in the list, it will be added.
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100671 * A pointer to that ACL is returned. If the ACL has an empty name, then it's
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200672 * an anonymous one and it won't be merged with any other one. If <err> is not
673 * NULL, it will be filled with an appropriate error. This pointer must be
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200674 * freeable or NULL. <al> is the arg_list serving as a head for unresolved
Christopher Faulet45bb15f2021-09-30 08:48:56 +0200675 * dependencies. It may be NULL if such dependencies are not allowed.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200676 *
677 * args syntax: <aclname> <acl_expr>
678 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100679struct acl *parse_acl(const char **args, struct list *known_acl, char **err, struct arg_list *al,
680 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200681{
682 __label__ out_return, out_free_acl_expr, out_free_name;
683 struct acl *cur_acl;
684 struct acl_expr *acl_expr;
685 char *name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200686 const char *pos;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200687
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200688 if (**args && (pos = invalid_char(*args))) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200689 memprintf(err, "invalid character in ACL name : '%c'", *pos);
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100690 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200691 }
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100692
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100693 acl_expr = parse_acl_expr(args + 1, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200694 if (!acl_expr) {
695 /* parse_acl_expr will have filled <err> here */
Willy Tarreaua84d3742007-05-07 00:36:48 +0200696 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200697 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200698
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200699 /* Check for args beginning with an opening parenthesis just after the
700 * subject, as this is almost certainly a typo. Right now we can only
701 * emit a warning, so let's do so.
702 */
Krzysztof Piotr Oledzki4cdd8312009-10-05 00:23:35 +0200703 if (!strchr(args[1], '(') && *args[2] == '(')
Christopher Faulet767a84b2017-11-24 16:50:31 +0100704 ha_warning("parsing acl '%s' :\n"
705 " matching '%s' for pattern '%s' is likely a mistake and probably\n"
706 " not what you want. Maybe you need to remove the extraneous space before '('.\n"
707 " If you are really sure this is not an error, please insert '--' between the\n"
708 " match and the pattern to make this warning message disappear.\n",
709 args[0], args[1], args[2]);
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200710
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100711 if (*args[0])
712 cur_acl = find_acl_by_name(args[0], known_acl);
713 else
714 cur_acl = NULL;
715
Willy Tarreaua84d3742007-05-07 00:36:48 +0200716 if (!cur_acl) {
717 name = strdup(args[0]);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200718 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200719 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200720 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200721 }
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200722 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200723 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200724 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200725 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200726 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200727
728 LIST_INIT(&cur_acl->expr);
Willy Tarreau2b718102021-04-21 07:32:39 +0200729 LIST_APPEND(known_acl, &cur_acl->list);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200730 cur_acl->name = name;
731 }
732
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100733 /* We want to know what features the ACL needs (typically HTTP parsing),
734 * and where it may be used. If an ACL relies on multiple matches, it is
735 * OK if at least one of them may match in the context where it is used.
736 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100737 cur_acl->use |= acl_expr->smp->fetch->use;
738 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreau2b718102021-04-21 07:32:39 +0200739 LIST_APPEND(&cur_acl->expr, &acl_expr->list);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200740 return cur_acl;
741
742 out_free_name:
743 free(name);
744 out_free_acl_expr:
745 prune_acl_expr(acl_expr);
746 free(acl_expr);
747 out_return:
748 return NULL;
749}
750
Willy Tarreau16fbe822007-06-17 11:54:31 +0200751/* Some useful ACLs provided by default. Only those used are allocated. */
752
753const struct {
754 const char *name;
755 const char *expr[4]; /* put enough for longest expression */
756} default_acl_list[] = {
Willy Tarreau58393e12008-07-20 10:39:22 +0200757 { .name = "TRUE", .expr = {"always_true",""}},
758 { .name = "FALSE", .expr = {"always_false",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200759 { .name = "LOCALHOST", .expr = {"src","127.0.0.1/8",""}},
Christopher Faulet779184e2021-04-01 17:24:04 +0200760 { .name = "HTTP", .expr = {"req.proto_http",""}},
761 { .name = "HTTP_1.0", .expr = {"req.ver","1.0",""}},
762 { .name = "HTTP_1.1", .expr = {"req.ver","1.1",""}},
Christopher Faulet8043e832021-03-26 16:00:54 +0100763 { .name = "HTTP_2.0", .expr = {"req.ver","2.0",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200764 { .name = "METH_CONNECT", .expr = {"method","CONNECT",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200765 { .name = "METH_DELETE", .expr = {"method","DELETE",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200766 { .name = "METH_GET", .expr = {"method","GET","HEAD",""}},
767 { .name = "METH_HEAD", .expr = {"method","HEAD",""}},
768 { .name = "METH_OPTIONS", .expr = {"method","OPTIONS",""}},
769 { .name = "METH_POST", .expr = {"method","POST",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200770 { .name = "METH_PUT", .expr = {"method","PUT",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200771 { .name = "METH_TRACE", .expr = {"method","TRACE",""}},
772 { .name = "HTTP_URL_ABS", .expr = {"url_reg","^[^/:]*://",""}},
773 { .name = "HTTP_URL_SLASH", .expr = {"url_beg","/",""}},
774 { .name = "HTTP_URL_STAR", .expr = {"url","*",""}},
Christopher Faulet779184e2021-04-01 17:24:04 +0200775 { .name = "HTTP_CONTENT", .expr = {"req.hdr_val(content-length)","gt","0",""}},
776 { .name = "RDP_COOKIE", .expr = {"req.rdp_cookie_cnt","gt","0",""}},
777 { .name = "REQ_CONTENT", .expr = {"req.len","gt","0",""}},
Willy Tarreaub6fb4202008-07-20 11:18:28 +0200778 { .name = "WAIT_END", .expr = {"wait_end",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200779 { .name = NULL, .expr = {""}}
780};
781
782/* Find a default ACL from the default_acl list, compile it and return it.
783 * If the ACL is not found, NULL is returned. In theory, it cannot fail,
784 * except when default ACLs are broken, in which case it will return NULL.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200785 * If <known_acl> is not NULL, the ACL will be queued at its tail. If <err> is
786 * not NULL, it will be filled with an error message if an error occurs. This
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200787 * pointer must be freeable or NULL. <al> is an arg_list serving as a list head
Christopher Faulet45bb15f2021-09-30 08:48:56 +0200788 * to report missing dependencies. It may be NULL if such dependencies are not
789 * allowed.
Willy Tarreau16fbe822007-06-17 11:54:31 +0200790 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200791static struct acl *find_acl_default(const char *acl_name, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100792 char **err, struct arg_list *al,
793 const char *file, int line)
Willy Tarreau16fbe822007-06-17 11:54:31 +0200794{
795 __label__ out_return, out_free_acl_expr, out_free_name;
796 struct acl *cur_acl;
797 struct acl_expr *acl_expr;
798 char *name;
799 int index;
800
801 for (index = 0; default_acl_list[index].name != NULL; index++) {
802 if (strcmp(acl_name, default_acl_list[index].name) == 0)
803 break;
804 }
805
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200806 if (default_acl_list[index].name == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200807 memprintf(err, "no such ACL : '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200808 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200809 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200810
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100811 acl_expr = parse_acl_expr((const char **)default_acl_list[index].expr, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200812 if (!acl_expr) {
813 /* parse_acl_expr must have filled err here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200814 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200815 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200816
817 name = strdup(acl_name);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200818 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200819 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200820 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200821 }
822
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200823 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200824 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200825 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200826 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200827 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200828
829 cur_acl->name = name;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100830 cur_acl->use |= acl_expr->smp->fetch->use;
831 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreau16fbe822007-06-17 11:54:31 +0200832 LIST_INIT(&cur_acl->expr);
Willy Tarreau2b718102021-04-21 07:32:39 +0200833 LIST_APPEND(&cur_acl->expr, &acl_expr->list);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200834 if (known_acl)
Willy Tarreau2b718102021-04-21 07:32:39 +0200835 LIST_APPEND(known_acl, &cur_acl->list);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200836
837 return cur_acl;
838
839 out_free_name:
840 free(name);
841 out_free_acl_expr:
842 prune_acl_expr(acl_expr);
843 free(acl_expr);
844 out_return:
845 return NULL;
846}
Willy Tarreaua84d3742007-05-07 00:36:48 +0200847
848/* Purge everything in the acl_cond <cond>, then return <cond>. */
849struct acl_cond *prune_acl_cond(struct acl_cond *cond)
850{
851 struct acl_term_suite *suite, *tmp_suite;
852 struct acl_term *term, *tmp_term;
853
854 /* iterate through all term suites and free all terms and all suites */
855 list_for_each_entry_safe(suite, tmp_suite, &cond->suites, list) {
856 list_for_each_entry_safe(term, tmp_term, &suite->terms, list)
857 free(term);
858 free(suite);
859 }
860 return cond;
861}
862
863/* Parse an ACL condition starting at <args>[0], relying on a list of already
864 * known ACLs passed in <known_acl>. The new condition is returned (or NULL in
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200865 * case of low memory). Supports multiple conditions separated by "or". If
866 * <err> is not NULL, it will be filled with a pointer to an error message in
867 * case of error, that the caller is responsible for freeing. The initial
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200868 * location must either be freeable or NULL. The list <al> serves as a list head
Christopher Faulet45bb15f2021-09-30 08:48:56 +0200869 * for unresolved dependencies. It may be NULL if such dependencies are not
870 * allowed.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200871 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200872struct acl_cond *parse_acl_cond(const char **args, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100873 enum acl_cond_pol pol, char **err, struct arg_list *al,
874 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200875{
876 __label__ out_return, out_free_suite, out_free_term;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200877 int arg, neg;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200878 const char *word;
879 struct acl *cur_acl;
880 struct acl_term *cur_term;
881 struct acl_term_suite *cur_suite;
882 struct acl_cond *cond;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100883 unsigned int suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200884
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200885 cond = calloc(1, sizeof(*cond));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200886 if (cond == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200887 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200888 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200889 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200890
891 LIST_INIT(&cond->list);
892 LIST_INIT(&cond->suites);
893 cond->pol = pol;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100894 cond->val = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200895
896 cur_suite = NULL;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100897 suite_val = ~0U;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200898 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200899 for (arg = 0; *args[arg]; arg++) {
900 word = args[arg];
901
902 /* remove as many exclamation marks as we can */
903 while (*word == '!') {
904 neg = !neg;
905 word++;
906 }
907
908 /* an empty word is allowed because we cannot force the user to
909 * always think about not leaving exclamation marks alone.
910 */
911 if (!*word)
912 continue;
913
Willy Tarreau16fbe822007-06-17 11:54:31 +0200914 if (strcasecmp(word, "or") == 0 || strcmp(word, "||") == 0) {
Willy Tarreaua84d3742007-05-07 00:36:48 +0200915 /* new term suite */
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100916 cond->val |= suite_val;
917 suite_val = ~0U;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200918 cur_suite = NULL;
919 neg = 0;
920 continue;
921 }
922
Willy Tarreau95fa4692010-02-01 13:05:50 +0100923 if (strcmp(word, "{") == 0) {
924 /* we may have a complete ACL expression between two braces,
925 * find the last one.
926 */
927 int arg_end = arg + 1;
928 const char **args_new;
929
930 while (*args[arg_end] && strcmp(args[arg_end], "}") != 0)
931 arg_end++;
932
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200933 if (!*args[arg_end]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200934 memprintf(err, "missing closing '}' in condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100935 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200936 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100937
938 args_new = calloc(1, (arg_end - arg + 1) * sizeof(*args_new));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200939 if (!args_new) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200940 memprintf(err, "out of memory when parsing condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100941 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200942 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100943
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100944 args_new[0] = "";
Willy Tarreau95fa4692010-02-01 13:05:50 +0100945 memcpy(args_new + 1, args + arg + 1, (arg_end - arg) * sizeof(*args_new));
946 args_new[arg_end - arg] = "";
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100947 cur_acl = parse_acl(args_new, known_acl, err, al, file, line);
Willy Tarreau95fa4692010-02-01 13:05:50 +0100948 free(args_new);
949
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200950 if (!cur_acl) {
951 /* note that parse_acl() must have filled <err> here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200952 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200953 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100954 arg = arg_end;
955 }
956 else {
957 /* search for <word> in the known ACL names. If we do not find
958 * it, let's look for it in the default ACLs, and if found, add
959 * it to the list of ACLs of this proxy. This makes it possible
960 * to override them.
961 */
962 cur_acl = find_acl_by_name(word, known_acl);
963 if (cur_acl == NULL) {
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100964 cur_acl = find_acl_default(word, known_acl, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200965 if (cur_acl == NULL) {
966 /* note that find_acl_default() must have filled <err> here */
Willy Tarreau95fa4692010-02-01 13:05:50 +0100967 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200968 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100969 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200970 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200971
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200972 cur_term = calloc(1, sizeof(*cur_term));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200973 if (cur_term == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200974 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200975 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200976 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200977
978 cur_term->acl = cur_acl;
979 cur_term->neg = neg;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100980
981 /* Here it is a bit complex. The acl_term_suite is a conjunction
982 * of many terms. It may only be used if all of its terms are
983 * usable at the same time. So the suite's validity domain is an
984 * AND between all ACL keywords' ones. But, the global condition
985 * is valid if at least one term suite is OK. So it's an OR between
986 * all of their validity domains. We could emit a warning as soon
987 * as suite_val is null because it means that the last ACL is not
988 * compatible with the previous ones. Let's remain simple for now.
989 */
990 cond->use |= cur_acl->use;
991 suite_val &= cur_acl->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200992
993 if (!cur_suite) {
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200994 cur_suite = calloc(1, sizeof(*cur_suite));
Willy Tarreauf678b7f2013-01-24 00:25:39 +0100995 if (cur_suite == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200996 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200997 goto out_free_term;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200998 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200999 LIST_INIT(&cur_suite->terms);
Willy Tarreau2b718102021-04-21 07:32:39 +02001000 LIST_APPEND(&cond->suites, &cur_suite->list);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001001 }
Willy Tarreau2b718102021-04-21 07:32:39 +02001002 LIST_APPEND(&cur_suite->terms, &cur_term->list);
Willy Tarreau74b98a82007-06-16 19:35:18 +02001003 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001004 }
1005
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001006 cond->val |= suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001007 return cond;
1008
1009 out_free_term:
1010 free(cur_term);
1011 out_free_suite:
1012 prune_acl_cond(cond);
1013 free(cond);
1014 out_return:
1015 return NULL;
1016}
1017
Willy Tarreau2bbba412010-01-28 16:48:33 +01001018/* Builds an ACL condition starting at the if/unless keyword. The complete
1019 * condition is returned. NULL is returned in case of error or if the first
1020 * word is neither "if" nor "unless". It automatically sets the file name and
Willy Tarreau25320b22013-03-24 07:22:08 +01001021 * the line number in the condition for better error reporting, and sets the
1022 * HTTP intiailization requirements in the proxy. If <err> is not NULL, it will
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001023 * be filled with a pointer to an error message in case of error, that the
1024 * caller is responsible for freeing. The initial location must either be
1025 * freeable or NULL.
Willy Tarreau2bbba412010-01-28 16:48:33 +01001026 */
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001027struct acl_cond *build_acl_cond(const char *file, int line, struct list *known_acl,
1028 struct proxy *px, const char **args, char **err)
Willy Tarreau2bbba412010-01-28 16:48:33 +01001029{
Willy Tarreau0cba6072013-11-28 22:21:02 +01001030 enum acl_cond_pol pol = ACL_COND_NONE;
Willy Tarreau2bbba412010-01-28 16:48:33 +01001031 struct acl_cond *cond = NULL;
1032
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001033 if (err)
1034 *err = NULL;
1035
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001036 if (strcmp(*args, "if") == 0) {
Willy Tarreau2bbba412010-01-28 16:48:33 +01001037 pol = ACL_COND_IF;
1038 args++;
1039 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001040 else if (strcmp(*args, "unless") == 0) {
Willy Tarreau2bbba412010-01-28 16:48:33 +01001041 pol = ACL_COND_UNLESS;
1042 args++;
1043 }
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001044 else {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001045 memprintf(err, "conditions must start with either 'if' or 'unless'");
Willy Tarreau2bbba412010-01-28 16:48:33 +01001046 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001047 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001048
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001049 cond = parse_acl_cond(args, known_acl, pol, err, &px->conf.args, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001050 if (!cond) {
1051 /* note that parse_acl_cond must have filled <err> here */
Willy Tarreau2bbba412010-01-28 16:48:33 +01001052 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001053 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001054
1055 cond->file = file;
1056 cond->line = line;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001057 px->http_needed |= !!(cond->use & SMP_USE_HTTP_ANY);
Willy Tarreau2bbba412010-01-28 16:48:33 +01001058 return cond;
1059}
1060
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001061/* Execute condition <cond> and return either ACL_TEST_FAIL, ACL_TEST_MISS or
1062 * ACL_TEST_PASS depending on the test results. ACL_TEST_MISS may only be
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001063 * returned if <opt> does not contain SMP_OPT_FINAL, indicating that incomplete
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001064 * data is being examined. The function automatically sets SMP_OPT_ITERATE. This
1065 * function only computes the condition, it does not apply the polarity required
1066 * by IF/UNLESS, it's up to the caller to do this using something like this :
Willy Tarreau11382812008-07-09 16:18:21 +02001067 *
1068 * res = acl_pass(res);
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001069 * if (res == ACL_TEST_MISS)
Willy Tarreaub6866442008-07-14 23:54:42 +02001070 * return 0;
Willy Tarreau11382812008-07-09 16:18:21 +02001071 * if (cond->pol == ACL_COND_UNLESS)
1072 * res = !res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001073 */
Willy Tarreau192252e2015-04-04 01:47:55 +02001074enum 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 +02001075{
1076 __label__ fetch_next;
1077 struct acl_term_suite *suite;
1078 struct acl_term *term;
1079 struct acl_expr *expr;
1080 struct acl *acl;
Willy Tarreau37406352012-04-23 16:16:37 +02001081 struct sample smp;
Willy Tarreau0cba6072013-11-28 22:21:02 +01001082 enum acl_test_res acl_res, suite_res, cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001083
Willy Tarreau7a777ed2012-04-26 11:44:02 +02001084 /* ACLs are iterated over all values, so let's always set the flag to
1085 * indicate this to the fetch functions.
1086 */
1087 opt |= SMP_OPT_ITERATE;
1088
Willy Tarreau11382812008-07-09 16:18:21 +02001089 /* We're doing a logical OR between conditions so we initialize to FAIL.
1090 * The MISS status is propagated down from the suites.
1091 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001092 cond_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001093 list_for_each_entry(suite, &cond->suites, list) {
Willy Tarreau11382812008-07-09 16:18:21 +02001094 /* Evaluate condition suite <suite>. We stop at the first term
Willy Tarreau0cba6072013-11-28 22:21:02 +01001095 * which returns ACL_TEST_FAIL. The MISS status is still propagated
Willy Tarreau11382812008-07-09 16:18:21 +02001096 * in case of uncertainty in the result.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001097 */
1098
1099 /* we're doing a logical AND between terms, so we must set the
1100 * initial value to PASS.
1101 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001102 suite_res = ACL_TEST_PASS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001103 list_for_each_entry(term, &suite->terms, list) {
1104 acl = term->acl;
1105
1106 /* FIXME: use cache !
1107 * check acl->cache_idx for this.
1108 */
1109
1110 /* ACL result not cached. Let's scan all the expressions
1111 * and use the first one to match.
1112 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001113 acl_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001114 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaud41f8d82007-06-10 10:06:18 +02001115 /* we need to reset context and flags */
Willy Tarreau37406352012-04-23 16:16:37 +02001116 memset(&smp, 0, sizeof(smp));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001117 fetch_next:
Willy Tarreau192252e2015-04-04 01:47:55 +02001118 if (!sample_process(px, sess, strm, opt, expr->smp, &smp)) {
Willy Tarreaub6866442008-07-14 23:54:42 +02001119 /* maybe we could not fetch because of missing data */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001120 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001121 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001122 continue;
Willy Tarreaub6866442008-07-14 23:54:42 +02001123 }
Willy Tarreauc4262962010-05-10 23:42:40 +02001124
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +01001125 acl_res |= pat2acl(pattern_exec_match(&expr->pat, &smp, 0));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001126 /*
Willy Tarreau11382812008-07-09 16:18:21 +02001127 * OK now acl_res holds the result of this expression
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001128 * as one of ACL_TEST_FAIL, ACL_TEST_MISS or ACL_TEST_PASS.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001129 *
Willy Tarreau11382812008-07-09 16:18:21 +02001130 * Then if (!MISS) we can cache the result, and put
Willy Tarreau37406352012-04-23 16:16:37 +02001131 * (smp.flags & SMP_F_VOLATILE) in the cache flags.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001132 *
1133 * FIXME: implement cache.
1134 *
1135 */
1136
Willy Tarreau11382812008-07-09 16:18:21 +02001137 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001138 if (acl_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001139 break;
1140
Willy Tarreau37406352012-04-23 16:16:37 +02001141 if (smp.flags & SMP_F_NOT_LAST)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001142 goto fetch_next;
Willy Tarreaub6866442008-07-14 23:54:42 +02001143
1144 /* sometimes we know the fetched data is subject to change
1145 * later and give another chance for a new match (eg: request
1146 * size, time, ...)
1147 */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001148 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001149 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001150 }
1151 /*
1152 * Here we have the result of an ACL (cached or not).
1153 * ACLs are combined, negated or not, to form conditions.
1154 */
1155
Willy Tarreaua84d3742007-05-07 00:36:48 +02001156 if (term->neg)
Willy Tarreau11382812008-07-09 16:18:21 +02001157 acl_res = acl_neg(acl_res);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001158
1159 suite_res &= acl_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001160
Willy Tarreau79c412b2013-10-30 19:30:32 +01001161 /* we're ANDing these terms, so a single FAIL or MISS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001162 if (suite_res != ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001163 break;
1164 }
1165 cond_res |= suite_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001166
1167 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001168 if (cond_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001169 break;
1170 }
Willy Tarreau11382812008-07-09 16:18:21 +02001171 return cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001172}
1173
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001174/* Returns a pointer to the first ACL conflicting with usage at place <where>
1175 * which is one of the SMP_VAL_* bits indicating a check place, or NULL if
1176 * no conflict is found. Only full conflicts are detected (ACL is not usable).
1177 * Use the next function to check for useless keywords.
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001178 */
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001179const struct acl *acl_cond_conflicts(const struct acl_cond *cond, unsigned int where)
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001180{
1181 struct acl_term_suite *suite;
1182 struct acl_term *term;
1183 struct acl *acl;
1184
1185 list_for_each_entry(suite, &cond->suites, list) {
1186 list_for_each_entry(term, &suite->terms, list) {
1187 acl = term->acl;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001188 if (!(acl->val & where))
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001189 return acl;
1190 }
1191 }
1192 return NULL;
1193}
1194
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001195/* Returns a pointer to the first ACL and its first keyword to conflict with
1196 * usage at place <where> which is one of the SMP_VAL_* bits indicating a check
1197 * place. Returns true if a conflict is found, with <acl> and <kw> set (if non
1198 * null), or false if not conflict is found. The first useless keyword is
1199 * returned.
1200 */
Willy Tarreau93fddf12013-03-31 22:59:32 +02001201int 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 +01001202{
1203 struct acl_term_suite *suite;
1204 struct acl_term *term;
1205 struct acl_expr *expr;
1206
1207 list_for_each_entry(suite, &cond->suites, list) {
1208 list_for_each_entry(term, &suite->terms, list) {
1209 list_for_each_entry(expr, &term->acl->expr, list) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001210 if (!(expr->smp->fetch->val & where)) {
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001211 if (acl)
1212 *acl = term->acl;
1213 if (kw)
1214 *kw = expr->kw;
1215 return 1;
1216 }
1217 }
1218 }
1219 }
1220 return 0;
1221}
1222
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001223/*
1224 * Find targets for userlist and groups in acl. Function returns the number
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001225 * of errors or OK if everything is fine. It must be called only once sample
1226 * fetch arguments have been resolved (after smp_resolve_args()).
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001227 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001228int acl_find_targets(struct proxy *p)
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001229{
1230
1231 struct acl *acl;
1232 struct acl_expr *expr;
Thierry FOURNIER3ead5b92013-12-13 12:12:18 +01001233 struct pattern_list *pattern;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001234 int cfgerr = 0;
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001235 struct pattern_expr_list *pexp;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001236
1237 list_for_each_entry(acl, &p->acl, list) {
1238 list_for_each_entry(expr, &acl->expr, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001239 if (strcmp(expr->kw, "http_auth_group") == 0) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001240 /* Note: the ARGT_USR argument may only have been resolved earlier
1241 * by smp_resolve_args().
1242 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001243 if (expr->smp->arg_p->unresolved) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001244 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 +02001245 p->id, *acl->name ? "" : "anonymous ", acl->name, expr->kw,
1246 expr->smp->arg_p->data.str.area);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001247 cfgerr++;
Willy Tarreau496aa012012-06-01 10:38:29 +02001248 continue;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001249 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001250
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001251 if (LIST_ISEMPTY(&expr->pat.head)) {
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++;
1255 continue;
1256 }
1257
Thierry FOURNIER9eec0a62014-01-22 18:38:02 +01001258 /* For each pattern, check if the group exists. */
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001259 list_for_each_entry(pexp, &expr->pat.head, list) {
1260 if (LIST_ISEMPTY(&pexp->expr->patterns)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001261 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1262 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001263 cfgerr++;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001264 continue;
1265 }
1266
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001267 list_for_each_entry(pattern, &pexp->expr->patterns, list) {
1268 /* this keyword only has one argument */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001269 if (!check_group(expr->smp->arg_p->data.usr, pattern->pat.ptr.str)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001270 ha_alert("proxy %s: acl %s %s(): invalid group '%s'.\n",
1271 p->id, acl->name, expr->kw, pattern->pat.ptr.str);
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001272 cfgerr++;
1273 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001274 }
1275 }
1276 }
1277 }
1278 }
1279
1280 return cfgerr;
1281}
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001282
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001283/* initializes ACLs by resolving the sample fetch names they rely upon.
1284 * Returns 0 on success, otherwise an error.
1285 */
1286int init_acl()
1287{
1288 int err = 0;
1289 int index;
1290 const char *name;
1291 struct acl_kw_list *kwl;
1292 struct sample_fetch *smp;
1293
1294 list_for_each_entry(kwl, &acl_keywords.list, list) {
1295 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1296 name = kwl->kw[index].fetch_kw;
1297 if (!name)
1298 name = kwl->kw[index].kw;
1299
1300 smp = find_sample_fetch(name, strlen(name));
1301 if (!smp) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001302 ha_alert("Critical internal error: ACL keyword '%s' relies on sample fetch '%s' which was not registered!\n",
1303 kwl->kw[index].kw, name);
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001304 err++;
1305 continue;
1306 }
1307 kwl->kw[index].smp = smp;
1308 }
1309 }
1310 return err;
1311}
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001312
Amaury Denoyelle68fd7e42021-03-25 17:15:52 +01001313void free_acl_cond(struct acl_cond *cond)
1314{
1315 struct acl_term_suite *suite, *suiteb;
1316 struct acl_term *term, *termb;
1317
1318 if (!cond)
1319 return;
1320
1321 list_for_each_entry_safe(suite, suiteb, &cond->suites, list) {
1322 list_for_each_entry_safe(term, termb, &suite->terms, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001323 LIST_DELETE(&term->list);
Amaury Denoyelle68fd7e42021-03-25 17:15:52 +01001324 free(term);
1325 }
Willy Tarreau2b718102021-04-21 07:32:39 +02001326 LIST_DELETE(&suite->list);
Amaury Denoyelle68fd7e42021-03-25 17:15:52 +01001327 free(suite);
1328 }
1329
1330 free(cond);
1331}
1332
Willy Tarreaua84d3742007-05-07 00:36:48 +02001333/************************************************************************/
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001334/* All supported sample and ACL keywords must be declared here. */
1335/************************************************************************/
1336
1337/* Note: must not be declared <const> as its list will be overwritten.
Willy Tarreau61612d42012-04-19 18:42:05 +02001338 * Please take care of keeping this list alphabetically sorted.
1339 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001340static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001341 { /* END */ },
Willy Tarreaua84d3742007-05-07 00:36:48 +02001342}};
1343
Willy Tarreau0108d902018-11-25 19:14:37 +01001344INITCALL1(STG_REGISTER, acl_register_keywords, &acl_kws);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001345
1346/*
1347 * Local variables:
1348 * c-indent-level: 8
1349 * c-basic-offset: 8
1350 * End:
1351 */