blob: 259b79a7b96f0696b629a87828f9be4de9e8245a [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 Tarreaudcc048a2020-06-04 19:11:43 +020017#include <haproxy/acl.h>
Willy Tarreauac13aea2020-06-04 10:36:03 +020018#include <haproxy/auth.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020019#include <haproxy/api.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020020#include <haproxy/list.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020021#include <haproxy/pattern.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020022#include <haproxy/tools.h>
Willy Tarreaua84d3742007-05-07 00:36:48 +020023
Willy Tarreauf268ee82020-06-04 17:05:57 +020024#include <haproxy/global.h>
Willy Tarreau2b5285d2010-05-09 23:45:24 +020025
Willy Tarreauaa74c4e2020-06-04 10:19:23 +020026#include <haproxy/arg.h>
Willy Tarreauc7e42382012-08-24 19:22:53 +020027#include <proto/channel.h>
Willy Tarreau404e8ab2009-07-26 19:40:40 +020028#include <proto/log.h>
Willy Tarreau0b1cd942010-05-16 22:18:27 +020029#include <proto/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020030#include <haproxy/sample.h>
Willy Tarreau872f2ea2020-06-04 18:46:44 +020031#include <haproxy/stick_table.h>
Willy Tarreaua84d3742007-05-07 00:36:48 +020032
Willy Tarreau8d2b7772020-05-27 10:58:19 +020033#include <import/ebsttree.h>
Willy Tarreauc4262962010-05-10 23:42:40 +020034
Willy Tarreaua84d3742007-05-07 00:36:48 +020035/* List head of all known ACL keywords */
36static struct acl_kw_list acl_keywords = {
37 .list = LIST_HEAD_INIT(acl_keywords.list)
38};
39
Willy Tarreau0cba6072013-11-28 22:21:02 +010040/* input values are 0 or 3, output is the same */
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +010041static inline enum acl_test_res pat2acl(struct pattern *pat)
Willy Tarreau0cba6072013-11-28 22:21:02 +010042{
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +010043 if (pat)
44 return ACL_TEST_PASS;
45 else
46 return ACL_TEST_FAIL;
Willy Tarreau0cba6072013-11-28 22:21:02 +010047}
48
Willy Tarreaua5909832007-06-17 20:40:25 +020049/*
Willy Tarreaua84d3742007-05-07 00:36:48 +020050 * Registers the ACL keyword list <kwl> as a list of valid keywords for next
51 * parsing sessions.
52 */
53void acl_register_keywords(struct acl_kw_list *kwl)
54{
55 LIST_ADDQ(&acl_keywords.list, &kwl->list);
56}
57
58/*
59 * Unregisters the ACL keyword list <kwl> from the list of valid keywords.
60 */
61void acl_unregister_keywords(struct acl_kw_list *kwl)
62{
63 LIST_DEL(&kwl->list);
64 LIST_INIT(&kwl->list);
65}
66
67/* Return a pointer to the ACL <name> within the list starting at <head>, or
68 * NULL if not found.
69 */
70struct acl *find_acl_by_name(const char *name, struct list *head)
71{
72 struct acl *acl;
73 list_for_each_entry(acl, head, list) {
74 if (strcmp(acl->name, name) == 0)
75 return acl;
76 }
77 return NULL;
78}
79
80/* Return a pointer to the ACL keyword <kw>, or NULL if not found. Note that if
Willy Tarreau4bfa4222013-12-16 22:01:06 +010081 * <kw> contains an opening parenthesis or a comma, only the left part of it is
82 * checked.
Willy Tarreaua84d3742007-05-07 00:36:48 +020083 */
84struct acl_keyword *find_acl_kw(const char *kw)
85{
86 int index;
87 const char *kwend;
88 struct acl_kw_list *kwl;
89
Willy Tarreau4bfa4222013-12-16 22:01:06 +010090 kwend = kw;
Willy Tarreaued2c6622020-02-14 18:27:10 +010091 while (is_idchar(*kwend))
Willy Tarreau4bfa4222013-12-16 22:01:06 +010092 kwend++;
Willy Tarreaua84d3742007-05-07 00:36:48 +020093
94 list_for_each_entry(kwl, &acl_keywords.list, list) {
95 for (index = 0; kwl->kw[index].kw != NULL; index++) {
96 if ((strncmp(kwl->kw[index].kw, kw, kwend - kw) == 0) &&
97 kwl->kw[index].kw[kwend-kw] == 0)
98 return &kwl->kw[index];
99 }
100 }
101 return NULL;
102}
103
Willy Tarreaua84d3742007-05-07 00:36:48 +0200104static struct acl_expr *prune_acl_expr(struct acl_expr *expr)
105{
Willy Tarreau34db1082012-04-19 17:16:54 +0200106 struct arg *arg;
Willy Tarreau145325e2017-04-12 23:03:31 +0200107 int unresolved = 0;
Willy Tarreau34db1082012-04-19 17:16:54 +0200108
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100109 pattern_prune(&expr->pat);
Willy Tarreau34db1082012-04-19 17:16:54 +0200110
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100111 for (arg = expr->smp->arg_p; arg; arg++) {
Willy Tarreau34db1082012-04-19 17:16:54 +0200112 if (arg->type == ARGT_STOP)
113 break;
Willy Tarreau496aa012012-06-01 10:38:29 +0200114 if (arg->type == ARGT_STR || arg->unresolved) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200115 free(arg->data.str.area);
116 arg->data.str.area = NULL;
117 arg->data.str.data = 0;
Willy Tarreau145325e2017-04-12 23:03:31 +0200118 unresolved |= arg->unresolved;
Willy Tarreau496aa012012-06-01 10:38:29 +0200119 arg->unresolved = 0;
Willy Tarreau34db1082012-04-19 17:16:54 +0200120 }
Willy Tarreau34db1082012-04-19 17:16:54 +0200121 }
122
Willy Tarreau145325e2017-04-12 23:03:31 +0200123 if (expr->smp->arg_p != empty_arg_list && !unresolved)
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100124 free(expr->smp->arg_p);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200125 return expr;
126}
127
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200128/* Parse an ACL expression starting at <args>[0], and return it. If <err> is
129 * not NULL, it will be filled with a pointer to an error message in case of
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200130 * error. This pointer must be freeable or NULL. <al> is an arg_list serving
131 * as a list head to report missing dependencies.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200132 *
Willy Tarreaua84d3742007-05-07 00:36:48 +0200133 * Right now, the only accepted syntax is :
134 * <subject> [<value>...]
135 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100136struct acl_expr *parse_acl_expr(const char **args, char **err, struct arg_list *al,
137 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200138{
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100139 __label__ out_return, out_free_expr;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200140 struct acl_expr *expr;
141 struct acl_keyword *aclkw;
Christopher Faulet54ceb042017-06-14 14:41:33 +0200142 int refflags, patflags;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200143 const char *arg;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100144 struct sample_expr *smp = NULL;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100145 int idx = 0;
146 char *ckw = NULL;
147 const char *begw;
148 const char *endw;
Willy Tarreau131b4662013-12-13 01:08:36 +0100149 const char *endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100150 int cur_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100151 int nbargs;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100152 int operator = STD_OP_EQ;
153 int op;
154 int contain_colon, have_dot;
155 const char *dot;
156 signed long long value, minor;
157 /* The following buffer contain two numbers, a ':' separator and the final \0. */
158 char buffer[NB_LLMAX_STR + 1 + NB_LLMAX_STR + 1];
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100159 int is_loaded;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100160 int unique_id;
161 char *error;
162 struct pat_ref *ref;
163 struct pattern_expr *pattern_expr;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100164 int load_as_map = 0;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200165 int acl_conv_found = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200166
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100167 /* First, we look for an ACL keyword. And if we don't find one, then
168 * we look for a sample fetch expression starting with a sample fetch
169 * keyword.
Willy Tarreaubef91e72013-03-31 23:14:46 +0200170 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100171
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100172 al->ctx = ARGC_ACL; // to report errors while resolving args late
Willy Tarreau131b4662013-12-13 01:08:36 +0100173 al->kw = *args;
174 al->conv = NULL;
175
Willy Tarreaua84d3742007-05-07 00:36:48 +0200176 aclkw = find_acl_kw(args[0]);
Willy Tarreau20490922014-03-17 18:04:27 +0100177 if (aclkw) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100178 /* OK we have a real ACL keyword */
Willy Tarreau9987ea92013-06-11 21:09:06 +0200179
Willy Tarreau131b4662013-12-13 01:08:36 +0100180 /* build new sample expression for this ACL */
Vincent Bernat02779b62016-04-03 13:48:43 +0200181 smp = calloc(1, sizeof(*smp));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100182 if (!smp) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100183 memprintf(err, "out of memory when parsing ACL expression");
184 goto out_return;
185 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100186 LIST_INIT(&(smp->conv_exprs));
187 smp->fetch = aclkw->smp;
188 smp->arg_p = empty_arg_list;
Willy Tarreau34db1082012-04-19 17:16:54 +0200189
Joseph Herlant68082792018-11-15 14:55:09 -0800190 /* look for the beginning of the subject arguments */
Willy Tarreaued2c6622020-02-14 18:27:10 +0100191 for (arg = args[0]; is_idchar(*arg); arg++)
192 ;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100193
Willy Tarreau131b4662013-12-13 01:08:36 +0100194 /* At this point, we have :
195 * - args[0] : beginning of the keyword
196 * - arg : end of the keyword, first character not part of keyword
Willy Tarreau131b4662013-12-13 01:08:36 +0100197 */
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100198 nbargs = make_arg_list(arg, -1, smp->fetch->arg_mask, &smp->arg_p,
199 err, &endt, NULL, al);
Willy Tarreau131b4662013-12-13 01:08:36 +0100200 if (nbargs < 0) {
201 /* note that make_arg_list will have set <err> here */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100202 memprintf(err, "ACL keyword '%s' : %s", aclkw->kw, *err);
203 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100204 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100205
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100206 if (!smp->arg_p) {
207 smp->arg_p = empty_arg_list;
Willy Tarreau131b4662013-12-13 01:08:36 +0100208 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100209 else if (smp->fetch->val_args && !smp->fetch->val_args(smp->arg_p, err)) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100210 /* invalid keyword argument, error must have been
211 * set by val_args().
212 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100213 memprintf(err, "in argument to '%s', %s", aclkw->kw, *err);
214 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100215 }
216 arg = endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100217
Joseph Herlant68082792018-11-15 14:55:09 -0800218 /* look for the beginning of the converters list. Those directly attached
Willy Tarreau131b4662013-12-13 01:08:36 +0100219 * to the ACL keyword are found just after <arg> which points to the comma.
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200220 * If we find any converter, then we don't use the ACL keyword's match
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200221 * anymore but the one related to the converter's output type.
Willy Tarreau131b4662013-12-13 01:08:36 +0100222 */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200223 cur_type = smp->fetch->out_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100224 while (*arg) {
225 struct sample_conv *conv;
226 struct sample_conv_expr *conv_expr;
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100227 int err_arg;
228 int argcnt;
Willy Tarreau131b4662013-12-13 01:08:36 +0100229
230 if (*arg && *arg != ',') {
231 if (ckw)
Willy Tarreau97108e02016-11-25 07:33:24 +0100232 memprintf(err, "ACL keyword '%s' : missing comma after converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100233 aclkw->kw, ckw);
Willy Tarreau131b4662013-12-13 01:08:36 +0100234 else
235 memprintf(err, "ACL keyword '%s' : missing comma after fetch keyword.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100236 aclkw->kw);
237 goto out_free_smp;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200238 }
Willy Tarreauae52f062012-04-26 12:13:35 +0200239
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100240 /* FIXME: how long should we support such idiocies ? Maybe we
241 * should already warn ?
242 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100243 while (*arg == ',') /* then trailing commas */
244 arg++;
Willy Tarreau2e845be2012-10-19 19:49:09 +0200245
Willy Tarreau97108e02016-11-25 07:33:24 +0100246 begw = arg; /* start of converter keyword */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100247
Willy Tarreau131b4662013-12-13 01:08:36 +0100248 if (!*begw)
249 /* none ? end of converters */
250 break;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100251
Willy Tarreaued2c6622020-02-14 18:27:10 +0100252 for (endw = begw; is_idchar(*endw); endw++)
253 ;
Willy Tarreau9ca69362013-10-22 19:10:06 +0200254
Willy Tarreau131b4662013-12-13 01:08:36 +0100255 free(ckw);
256 ckw = my_strndup(begw, endw - begw);
Willy Tarreauf75d0082013-04-07 21:20:44 +0200257
Willy Tarreau131b4662013-12-13 01:08:36 +0100258 conv = find_sample_conv(begw, endw - begw);
259 if (!conv) {
260 /* Unknown converter method */
Willy Tarreau97108e02016-11-25 07:33:24 +0100261 memprintf(err, "ACL keyword '%s' : unknown converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100262 aclkw->kw, ckw);
263 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100264 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100265
Willy Tarreau131b4662013-12-13 01:08:36 +0100266 arg = endw;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100267
Willy Tarreau131b4662013-12-13 01:08:36 +0100268 if (conv->in_type >= SMP_TYPES || conv->out_type >= SMP_TYPES) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100269 memprintf(err, "ACL keyword '%s' : returns type of converter '%s' is unknown.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100270 aclkw->kw, ckw);
271 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100272 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100273
Willy Tarreau131b4662013-12-13 01:08:36 +0100274 /* If impossible type conversion */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200275 if (!sample_casts[cur_type][conv->in_type]) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100276 memprintf(err, "ACL keyword '%s' : converter '%s' cannot be applied.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100277 aclkw->kw, ckw);
278 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100279 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100280
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200281 cur_type = conv->out_type;
Vincent Bernat02779b62016-04-03 13:48:43 +0200282 conv_expr = calloc(1, sizeof(*conv_expr));
Willy Tarreau131b4662013-12-13 01:08:36 +0100283 if (!conv_expr)
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100284 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100285
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100286 LIST_ADDQ(&(smp->conv_exprs), &(conv_expr->list));
Willy Tarreau131b4662013-12-13 01:08:36 +0100287 conv_expr->conv = conv;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200288 acl_conv_found = 1;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100289
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100290 al->kw = smp->fetch->kw;
291 al->conv = conv_expr->conv->kw;
292 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 }
Christopher Faulet361935a2019-09-13 09:50:15 +0200313 free(ckw);
314 ckw = NULL;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200315 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100316 else {
317 /* This is not an ACL keyword, so we hope this is a sample fetch
318 * keyword that we're going to transparently use as an ACL. If
319 * so, we retrieve a completely parsed expression with args and
320 * convs already done.
321 */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100322 smp = sample_parse_expr((char **)args, &idx, file, line, err, al, NULL);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100323 if (!smp) {
324 memprintf(err, "%s in ACL expression '%s'", *err, *args);
325 goto out_return;
326 }
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200327 cur_type = smp_expr_output_type(smp);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100328 }
329
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200330 expr = calloc(1, sizeof(*expr));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100331 if (!expr) {
332 memprintf(err, "out of memory when parsing ACL expression");
Christopher Faulet361935a2019-09-13 09:50:15 +0200333 goto out_free_smp;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100334 }
335
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100336 pattern_init_head(&expr->pat);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100337
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200338 expr->pat.expect_type = cur_type;
339 expr->smp = smp;
340 expr->kw = smp->fetch->kw;
341 smp = NULL; /* don't free it anymore */
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100342
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200343 if (aclkw && !acl_conv_found) {
344 expr->kw = aclkw->kw;
345 expr->pat.parse = aclkw->parse ? aclkw->parse : pat_parse_fcts[aclkw->match_type];
346 expr->pat.index = aclkw->index ? aclkw->index : pat_index_fcts[aclkw->match_type];
347 expr->pat.match = aclkw->match ? aclkw->match : pat_match_fcts[aclkw->match_type];
348 expr->pat.delete = aclkw->delete ? aclkw->delete : pat_delete_fcts[aclkw->match_type];
349 expr->pat.prune = aclkw->prune ? aclkw->prune : pat_prune_fcts[aclkw->match_type];
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100350 }
351
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100352 if (!expr->pat.parse) {
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200353 /* Parse/index/match functions depend on the expression type,
354 * so we have to map them now. Some types can be automatically
355 * converted.
356 */
357 switch (cur_type) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100358 case SMP_T_BOOL:
359 expr->pat.parse = pat_parse_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100360 expr->pat.index = pat_index_fcts[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100361 expr->pat.match = pat_match_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100362 expr->pat.delete = pat_delete_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100363 expr->pat.prune = pat_prune_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100364 expr->pat.expect_type = pat_match_types[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100365 break;
366 case SMP_T_SINT:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100367 expr->pat.parse = pat_parse_fcts[PAT_MATCH_INT];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100368 expr->pat.index = pat_index_fcts[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100369 expr->pat.match = pat_match_fcts[PAT_MATCH_INT];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100370 expr->pat.delete = pat_delete_fcts[PAT_MATCH_INT];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100371 expr->pat.prune = pat_prune_fcts[PAT_MATCH_INT];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100372 expr->pat.expect_type = pat_match_types[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100373 break;
Willy Tarreau78c5eec2019-04-19 11:45:20 +0200374 case SMP_T_ADDR:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100375 case SMP_T_IPV4:
376 case SMP_T_IPV6:
377 expr->pat.parse = pat_parse_fcts[PAT_MATCH_IP];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100378 expr->pat.index = pat_index_fcts[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100379 expr->pat.match = pat_match_fcts[PAT_MATCH_IP];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100380 expr->pat.delete = pat_delete_fcts[PAT_MATCH_IP];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100381 expr->pat.prune = pat_prune_fcts[PAT_MATCH_IP];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100382 expr->pat.expect_type = pat_match_types[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100383 break;
Thierry FOURNIER9fefbd52014-05-11 15:15:00 +0200384 case SMP_T_STR:
385 expr->pat.parse = pat_parse_fcts[PAT_MATCH_STR];
386 expr->pat.index = pat_index_fcts[PAT_MATCH_STR];
387 expr->pat.match = pat_match_fcts[PAT_MATCH_STR];
388 expr->pat.delete = pat_delete_fcts[PAT_MATCH_STR];
389 expr->pat.prune = pat_prune_fcts[PAT_MATCH_STR];
390 expr->pat.expect_type = pat_match_types[PAT_MATCH_STR];
391 break;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100392 }
393 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200394
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100395 /* Additional check to protect against common mistakes */
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100396 if (expr->pat.parse && cur_type != SMP_T_BOOL && !*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100397 ha_warning("parsing acl keyword '%s' :\n"
398 " no pattern to match against were provided, so this ACL will never match.\n"
399 " If this is what you intended, please add '--' to get rid of this warning.\n"
400 " If you intended to match only for existence, please use '-m found'.\n"
401 " If you wanted to force an int to match as a bool, please use '-m bool'.\n"
402 "\n",
403 args[0]);
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100404 }
405
Willy Tarreaua84d3742007-05-07 00:36:48 +0200406 args++;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200407
408 /* check for options before patterns. Supported options are :
409 * -i : ignore case for all patterns by default
410 * -f : read patterns from those files
Willy Tarreau5adeda12013-03-31 22:13:34 +0200411 * -m : force matching method (must be used before -f)
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100412 * -M : load the file as map file
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100413 * -u : force the unique id of the acl
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200414 * -- : everything after this is not an option
415 */
Christopher Faulet54ceb042017-06-14 14:41:33 +0200416 refflags = PAT_REF_ACL;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200417 patflags = 0;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100418 is_loaded = 0;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100419 unique_id = -1;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200420 while (**args == '-') {
Willy Tarreau2039bba2014-05-11 09:43:46 +0200421 if (strcmp(*args, "-i") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200422 patflags |= PAT_MF_IGNORE_CASE;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200423 else if (strcmp(*args, "-n") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200424 patflags |= PAT_MF_NO_DNS;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200425 else if (strcmp(*args, "-u") == 0) {
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100426 unique_id = strtol(args[1], &error, 10);
427 if (*error != '\0') {
428 memprintf(err, "the argument of -u must be an integer");
429 goto out_free_expr;
430 }
431
432 /* Check if this id is really unique. */
433 if (pat_ref_lookupid(unique_id)) {
434 memprintf(err, "the id is already used");
435 goto out_free_expr;
436 }
437
438 args++;
439 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200440 else if (strcmp(*args, "-f") == 0) {
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100441 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200442 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 +0200443 goto out_free_expr;
444 }
445
Christopher Faulet54ceb042017-06-14 14:41:33 +0200446 if (!pattern_read_from_file(&expr->pat, refflags, args[1], patflags, load_as_map, err, file, line))
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200447 goto out_free_expr;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100448 is_loaded = 1;
Willy Tarreau5adeda12013-03-31 22:13:34 +0200449 args++;
450 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200451 else if (strcmp(*args, "-m") == 0) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200452 int idx;
453
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100454 if (is_loaded) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200455 memprintf(err, "'-m' must only be specified before patterns and files in parsing ACL expression");
456 goto out_free_expr;
457 }
458
Willy Tarreau6f8fe312013-11-28 22:24:25 +0100459 idx = pat_find_match_name(args[1]);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200460 if (idx < 0) {
461 memprintf(err, "unknown matching method '%s' when parsing ACL expression", args[1]);
462 goto out_free_expr;
463 }
464
465 /* Note: -m found is always valid, bool/int are compatible, str/bin/reg/len are compatible */
Willy Tarreau9bb49f62015-09-24 16:37:12 +0200466 if (idx != PAT_MATCH_FOUND && !sample_casts[cur_type][pat_match_types[idx]]) {
Willy Tarreau93fddf12013-03-31 22:59:32 +0200467 memprintf(err, "matching method '%s' cannot be used with fetch keyword '%s'", args[1], expr->kw);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200468 goto out_free_expr;
469 }
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100470 expr->pat.parse = pat_parse_fcts[idx];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100471 expr->pat.index = pat_index_fcts[idx];
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100472 expr->pat.match = pat_match_fcts[idx];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100473 expr->pat.delete = pat_delete_fcts[idx];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100474 expr->pat.prune = pat_prune_fcts[idx];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100475 expr->pat.expect_type = pat_match_types[idx];
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200476 args++;
477 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200478 else if (strcmp(*args, "-M") == 0) {
Christopher Faulet54ceb042017-06-14 14:41:33 +0200479 refflags |= PAT_REF_MAP;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100480 load_as_map = 1;
481 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200482 else if (strcmp(*args, "--") == 0) {
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200483 args++;
484 break;
485 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200486 else {
487 memprintf(err, "'%s' is not a valid ACL option. Please use '--' before any pattern beginning with a '-'", args[0]);
488 goto out_free_expr;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200489 break;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200490 }
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200491 args++;
492 }
493
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100494 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200495 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 +0200496 goto out_free_expr;
497 }
498
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100499 /* Create displayed reference */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200500 snprintf(trash.area, trash.size, "acl '%s' file '%s' line %d",
501 expr->kw, file, line);
502 trash.area[trash.size - 1] = '\0';
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100503
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500504 /* Create new pattern reference. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200505 ref = pat_ref_newid(unique_id, trash.area, PAT_REF_ACL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100506 if (!ref) {
507 memprintf(err, "memory error");
508 goto out_free_expr;
509 }
510
511 /* Create new pattern expression associated to this reference. */
Emeric Brun7d27f3c2017-07-03 17:54:23 +0200512 pattern_expr = pattern_new_expr(&expr->pat, ref, patflags, err, NULL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100513 if (!pattern_expr)
514 goto out_free_expr;
515
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200516 /* now parse all patterns */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100517 while (**args) {
518 arg = *args;
519
520 /* Compatibility layer. Each pattern can parse only one string per pattern,
521 * but the pat_parser_int() and pat_parse_dotted_ver() parsers were need
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500522 * optionally two operators. The first operator is the match method: eq,
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100523 * le, lt, ge and gt. pat_parse_int() and pat_parse_dotted_ver() functions
524 * can have a compatibility syntax based on ranges:
525 *
526 * pat_parse_int():
527 *
528 * "eq x" -> "x" or "x:x"
529 * "le x" -> ":x"
530 * "lt x" -> ":y" (with y = x - 1)
531 * "ge x" -> "x:"
532 * "gt x" -> "y:" (with y = x + 1)
533 *
534 * pat_parse_dotted_ver():
535 *
536 * "eq x.y" -> "x.y" or "x.y:x.y"
537 * "le x.y" -> ":x.y"
538 * "lt x.y" -> ":w.z" (with w.z = x.y - 1)
539 * "ge x.y" -> "x.y:"
540 * "gt x.y" -> "w.z:" (with w.z = x.y + 1)
541 *
542 * If y is not present, assume that is "0".
543 *
544 * The syntax eq, le, lt, ge and gt are proper to the acl syntax. The
545 * following block of code detect the operator, and rewrite each value
546 * in parsable string.
547 */
548 if (expr->pat.parse == pat_parse_int ||
549 expr->pat.parse == pat_parse_dotted_ver) {
550 /* Check for operator. If the argument is operator, memorise it and
551 * continue to the next argument.
552 */
553 op = get_std_op(arg);
554 if (op != -1) {
555 operator = op;
556 args++;
557 continue;
558 }
559
560 /* Check if the pattern contain ':' or '-' character. */
561 contain_colon = (strchr(arg, ':') || strchr(arg, '-'));
562
563 /* If the pattern contain ':' or '-' character, give it to the parser as is.
564 * If no contain ':' and operator is STD_OP_EQ, give it to the parser as is.
565 * In other case, try to convert the value according with the operator.
566 */
567 if (!contain_colon && operator != STD_OP_EQ) {
568 /* Search '.' separator. */
569 dot = strchr(arg, '.');
570 if (!dot) {
571 have_dot = 0;
572 minor = 0;
573 dot = arg + strlen(arg);
574 }
575 else
576 have_dot = 1;
577
578 /* convert the integer minor part for the pat_parse_dotted_ver() function. */
579 if (expr->pat.parse == pat_parse_dotted_ver && have_dot) {
580 if (strl2llrc(dot+1, strlen(dot+1), &minor) != 0) {
581 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100582 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100583 }
584 if (minor >= 65536) {
585 memprintf(err, "'%s' contains too large a minor value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100586 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100587 }
588 }
589
590 /* convert the integer value for the pat_parse_int() function, and the
591 * integer major part for the pat_parse_dotted_ver() function.
592 */
593 if (strl2llrc(arg, dot - arg, &value) != 0) {
594 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100595 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100596 }
597 if (expr->pat.parse == pat_parse_dotted_ver) {
598 if (value >= 65536) {
599 memprintf(err, "'%s' contains too large a major value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100600 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100601 }
602 value = (value << 16) | (minor & 0xffff);
603 }
604
605 switch (operator) {
606
607 case STD_OP_EQ: /* this case is not possible. */
608 memprintf(err, "internal error");
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100609 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100610
611 case STD_OP_GT:
612 value++; /* gt = ge + 1 */
613
614 case STD_OP_GE:
615 if (expr->pat.parse == pat_parse_int)
616 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld:", value);
617 else
618 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld.%lld:",
619 value >> 16, value & 0xffff);
620 arg = buffer;
621 break;
622
623 case STD_OP_LT:
624 value--; /* lt = le - 1 */
625
626 case STD_OP_LE:
627 if (expr->pat.parse == pat_parse_int)
628 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld", value);
629 else
630 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld.%lld",
631 value >> 16, value & 0xffff);
632 arg = buffer;
633 break;
634 }
635 }
636 }
637
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100638 /* Add sample to the reference, and try to compile it fior each pattern
639 * using this value.
640 */
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200641 if (!pat_ref_add(ref, arg, NULL, err))
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100642 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100643 args++;
644 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200645
646 return expr;
647
Willy Tarreaua84d3742007-05-07 00:36:48 +0200648 out_free_expr:
649 prune_acl_expr(expr);
650 free(expr);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100651 out_free_smp:
Christopher Faulet361935a2019-09-13 09:50:15 +0200652 free(ckw);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100653 free(smp);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200654 out_return:
655 return NULL;
656}
657
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200658/* Purge everything in the acl <acl>, then return <acl>. */
659struct acl *prune_acl(struct acl *acl) {
660
661 struct acl_expr *expr, *exprb;
662
663 free(acl->name);
664
665 list_for_each_entry_safe(expr, exprb, &acl->expr, list) {
666 LIST_DEL(&expr->list);
667 prune_acl_expr(expr);
668 free(expr);
669 }
670
671 return acl;
672}
673
Willy Tarreaua84d3742007-05-07 00:36:48 +0200674/* Parse an ACL with the name starting at <args>[0], and with a list of already
675 * known ACLs in <acl>. If the ACL was not in the list, it will be added.
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100676 * A pointer to that ACL is returned. If the ACL has an empty name, then it's
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200677 * an anonymous one and it won't be merged with any other one. If <err> is not
678 * NULL, it will be filled with an appropriate error. This pointer must be
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200679 * freeable or NULL. <al> is the arg_list serving as a head for unresolved
680 * dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200681 *
682 * args syntax: <aclname> <acl_expr>
683 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100684struct acl *parse_acl(const char **args, struct list *known_acl, char **err, struct arg_list *al,
685 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200686{
687 __label__ out_return, out_free_acl_expr, out_free_name;
688 struct acl *cur_acl;
689 struct acl_expr *acl_expr;
690 char *name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200691 const char *pos;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200692
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200693 if (**args && (pos = invalid_char(*args))) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200694 memprintf(err, "invalid character in ACL name : '%c'", *pos);
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100695 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200696 }
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100697
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100698 acl_expr = parse_acl_expr(args + 1, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200699 if (!acl_expr) {
700 /* parse_acl_expr will have filled <err> here */
Willy Tarreaua84d3742007-05-07 00:36:48 +0200701 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200702 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200703
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200704 /* Check for args beginning with an opening parenthesis just after the
705 * subject, as this is almost certainly a typo. Right now we can only
706 * emit a warning, so let's do so.
707 */
Krzysztof Piotr Oledzki4cdd8312009-10-05 00:23:35 +0200708 if (!strchr(args[1], '(') && *args[2] == '(')
Christopher Faulet767a84b2017-11-24 16:50:31 +0100709 ha_warning("parsing acl '%s' :\n"
710 " matching '%s' for pattern '%s' is likely a mistake and probably\n"
711 " not what you want. Maybe you need to remove the extraneous space before '('.\n"
712 " If you are really sure this is not an error, please insert '--' between the\n"
713 " match and the pattern to make this warning message disappear.\n",
714 args[0], args[1], args[2]);
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200715
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100716 if (*args[0])
717 cur_acl = find_acl_by_name(args[0], known_acl);
718 else
719 cur_acl = NULL;
720
Willy Tarreaua84d3742007-05-07 00:36:48 +0200721 if (!cur_acl) {
722 name = strdup(args[0]);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200723 if (!name) {
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_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200726 }
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200727 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200728 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200729 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200730 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200731 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200732
733 LIST_INIT(&cur_acl->expr);
734 LIST_ADDQ(known_acl, &cur_acl->list);
735 cur_acl->name = name;
736 }
737
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100738 /* We want to know what features the ACL needs (typically HTTP parsing),
739 * and where it may be used. If an ACL relies on multiple matches, it is
740 * OK if at least one of them may match in the context where it is used.
741 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100742 cur_acl->use |= acl_expr->smp->fetch->use;
743 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200744 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
745 return cur_acl;
746
747 out_free_name:
748 free(name);
749 out_free_acl_expr:
750 prune_acl_expr(acl_expr);
751 free(acl_expr);
752 out_return:
753 return NULL;
754}
755
Willy Tarreau16fbe822007-06-17 11:54:31 +0200756/* Some useful ACLs provided by default. Only those used are allocated. */
757
758const struct {
759 const char *name;
760 const char *expr[4]; /* put enough for longest expression */
761} default_acl_list[] = {
Willy Tarreau58393e12008-07-20 10:39:22 +0200762 { .name = "TRUE", .expr = {"always_true",""}},
763 { .name = "FALSE", .expr = {"always_false",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200764 { .name = "LOCALHOST", .expr = {"src","127.0.0.1/8",""}},
Willy Tarreau2492d5b2009-07-11 00:06:00 +0200765 { .name = "HTTP", .expr = {"req_proto_http",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200766 { .name = "HTTP_1.0", .expr = {"req_ver","1.0",""}},
767 { .name = "HTTP_1.1", .expr = {"req_ver","1.1",""}},
768 { .name = "METH_CONNECT", .expr = {"method","CONNECT",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200769 { .name = "METH_DELETE", .expr = {"method","DELETE",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200770 { .name = "METH_GET", .expr = {"method","GET","HEAD",""}},
771 { .name = "METH_HEAD", .expr = {"method","HEAD",""}},
772 { .name = "METH_OPTIONS", .expr = {"method","OPTIONS",""}},
773 { .name = "METH_POST", .expr = {"method","POST",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200774 { .name = "METH_PUT", .expr = {"method","PUT",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200775 { .name = "METH_TRACE", .expr = {"method","TRACE",""}},
776 { .name = "HTTP_URL_ABS", .expr = {"url_reg","^[^/:]*://",""}},
777 { .name = "HTTP_URL_SLASH", .expr = {"url_beg","/",""}},
778 { .name = "HTTP_URL_STAR", .expr = {"url","*",""}},
779 { .name = "HTTP_CONTENT", .expr = {"hdr_val(content-length)","gt","0",""}},
Emeric Brunbede3d02009-06-30 17:54:00 +0200780 { .name = "RDP_COOKIE", .expr = {"req_rdp_cookie_cnt","gt","0",""}},
Willy Tarreauc6317702008-07-20 09:29:50 +0200781 { .name = "REQ_CONTENT", .expr = {"req_len","gt","0",""}},
Willy Tarreaub6fb4202008-07-20 11:18:28 +0200782 { .name = "WAIT_END", .expr = {"wait_end",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200783 { .name = NULL, .expr = {""}}
784};
785
786/* Find a default ACL from the default_acl list, compile it and return it.
787 * If the ACL is not found, NULL is returned. In theory, it cannot fail,
788 * except when default ACLs are broken, in which case it will return NULL.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200789 * If <known_acl> is not NULL, the ACL will be queued at its tail. If <err> is
790 * not NULL, it will be filled with an error message if an error occurs. This
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200791 * pointer must be freeable or NULL. <al> is an arg_list serving as a list head
792 * to report missing dependencies.
Willy Tarreau16fbe822007-06-17 11:54:31 +0200793 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200794static struct acl *find_acl_default(const char *acl_name, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100795 char **err, struct arg_list *al,
796 const char *file, int line)
Willy Tarreau16fbe822007-06-17 11:54:31 +0200797{
798 __label__ out_return, out_free_acl_expr, out_free_name;
799 struct acl *cur_acl;
800 struct acl_expr *acl_expr;
801 char *name;
802 int index;
803
804 for (index = 0; default_acl_list[index].name != NULL; index++) {
805 if (strcmp(acl_name, default_acl_list[index].name) == 0)
806 break;
807 }
808
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200809 if (default_acl_list[index].name == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200810 memprintf(err, "no such ACL : '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200811 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200812 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200813
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100814 acl_expr = parse_acl_expr((const char **)default_acl_list[index].expr, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200815 if (!acl_expr) {
816 /* parse_acl_expr must have filled err here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200817 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200818 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200819
820 name = strdup(acl_name);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200821 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200822 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200823 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200824 }
825
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200826 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200827 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200828 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200829 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200830 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200831
832 cur_acl->name = name;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100833 cur_acl->use |= acl_expr->smp->fetch->use;
834 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreau16fbe822007-06-17 11:54:31 +0200835 LIST_INIT(&cur_acl->expr);
836 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
837 if (known_acl)
838 LIST_ADDQ(known_acl, &cur_acl->list);
839
840 return cur_acl;
841
842 out_free_name:
843 free(name);
844 out_free_acl_expr:
845 prune_acl_expr(acl_expr);
846 free(acl_expr);
847 out_return:
848 return NULL;
849}
Willy Tarreaua84d3742007-05-07 00:36:48 +0200850
851/* Purge everything in the acl_cond <cond>, then return <cond>. */
852struct acl_cond *prune_acl_cond(struct acl_cond *cond)
853{
854 struct acl_term_suite *suite, *tmp_suite;
855 struct acl_term *term, *tmp_term;
856
857 /* iterate through all term suites and free all terms and all suites */
858 list_for_each_entry_safe(suite, tmp_suite, &cond->suites, list) {
859 list_for_each_entry_safe(term, tmp_term, &suite->terms, list)
860 free(term);
861 free(suite);
862 }
863 return cond;
864}
865
866/* Parse an ACL condition starting at <args>[0], relying on a list of already
867 * known ACLs passed in <known_acl>. The new condition is returned (or NULL in
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200868 * case of low memory). Supports multiple conditions separated by "or". If
869 * <err> is not NULL, it will be filled with a pointer to an error message in
870 * case of error, that the caller is responsible for freeing. The initial
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200871 * location must either be freeable or NULL. The list <al> serves as a list head
872 * for unresolved dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200873 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200874struct acl_cond *parse_acl_cond(const char **args, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100875 enum acl_cond_pol pol, char **err, struct arg_list *al,
876 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200877{
878 __label__ out_return, out_free_suite, out_free_term;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200879 int arg, neg;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200880 const char *word;
881 struct acl *cur_acl;
882 struct acl_term *cur_term;
883 struct acl_term_suite *cur_suite;
884 struct acl_cond *cond;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100885 unsigned int suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200886
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200887 cond = calloc(1, sizeof(*cond));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200888 if (cond == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200889 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200890 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200891 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200892
893 LIST_INIT(&cond->list);
894 LIST_INIT(&cond->suites);
895 cond->pol = pol;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100896 cond->val = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200897
898 cur_suite = NULL;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100899 suite_val = ~0U;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200900 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200901 for (arg = 0; *args[arg]; arg++) {
902 word = args[arg];
903
904 /* remove as many exclamation marks as we can */
905 while (*word == '!') {
906 neg = !neg;
907 word++;
908 }
909
910 /* an empty word is allowed because we cannot force the user to
911 * always think about not leaving exclamation marks alone.
912 */
913 if (!*word)
914 continue;
915
Willy Tarreau16fbe822007-06-17 11:54:31 +0200916 if (strcasecmp(word, "or") == 0 || strcmp(word, "||") == 0) {
Willy Tarreaua84d3742007-05-07 00:36:48 +0200917 /* new term suite */
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100918 cond->val |= suite_val;
919 suite_val = ~0U;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200920 cur_suite = NULL;
921 neg = 0;
922 continue;
923 }
924
Willy Tarreau95fa4692010-02-01 13:05:50 +0100925 if (strcmp(word, "{") == 0) {
926 /* we may have a complete ACL expression between two braces,
927 * find the last one.
928 */
929 int arg_end = arg + 1;
930 const char **args_new;
931
932 while (*args[arg_end] && strcmp(args[arg_end], "}") != 0)
933 arg_end++;
934
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200935 if (!*args[arg_end]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200936 memprintf(err, "missing closing '}' in condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100937 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200938 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100939
940 args_new = calloc(1, (arg_end - arg + 1) * sizeof(*args_new));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200941 if (!args_new) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200942 memprintf(err, "out of memory when parsing condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100943 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200944 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100945
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100946 args_new[0] = "";
Willy Tarreau95fa4692010-02-01 13:05:50 +0100947 memcpy(args_new + 1, args + arg + 1, (arg_end - arg) * sizeof(*args_new));
948 args_new[arg_end - arg] = "";
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100949 cur_acl = parse_acl(args_new, known_acl, err, al, file, line);
Willy Tarreau95fa4692010-02-01 13:05:50 +0100950 free(args_new);
951
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200952 if (!cur_acl) {
953 /* note that parse_acl() must have filled <err> here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200954 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200955 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100956 arg = arg_end;
957 }
958 else {
959 /* search for <word> in the known ACL names. If we do not find
960 * it, let's look for it in the default ACLs, and if found, add
961 * it to the list of ACLs of this proxy. This makes it possible
962 * to override them.
963 */
964 cur_acl = find_acl_by_name(word, known_acl);
965 if (cur_acl == NULL) {
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100966 cur_acl = find_acl_default(word, known_acl, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200967 if (cur_acl == NULL) {
968 /* note that find_acl_default() must have filled <err> here */
Willy Tarreau95fa4692010-02-01 13:05:50 +0100969 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200970 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100971 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200972 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200973
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200974 cur_term = calloc(1, sizeof(*cur_term));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200975 if (cur_term == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200976 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200977 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200978 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200979
980 cur_term->acl = cur_acl;
981 cur_term->neg = neg;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100982
983 /* Here it is a bit complex. The acl_term_suite is a conjunction
984 * of many terms. It may only be used if all of its terms are
985 * usable at the same time. So the suite's validity domain is an
986 * AND between all ACL keywords' ones. But, the global condition
987 * is valid if at least one term suite is OK. So it's an OR between
988 * all of their validity domains. We could emit a warning as soon
989 * as suite_val is null because it means that the last ACL is not
990 * compatible with the previous ones. Let's remain simple for now.
991 */
992 cond->use |= cur_acl->use;
993 suite_val &= cur_acl->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200994
995 if (!cur_suite) {
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200996 cur_suite = calloc(1, sizeof(*cur_suite));
Willy Tarreauf678b7f2013-01-24 00:25:39 +0100997 if (cur_suite == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200998 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200999 goto out_free_term;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001000 }
Willy Tarreaua84d3742007-05-07 00:36:48 +02001001 LIST_INIT(&cur_suite->terms);
1002 LIST_ADDQ(&cond->suites, &cur_suite->list);
1003 }
1004 LIST_ADDQ(&cur_suite->terms, &cur_term->list);
Willy Tarreau74b98a82007-06-16 19:35:18 +02001005 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001006 }
1007
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001008 cond->val |= suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001009 return cond;
1010
1011 out_free_term:
1012 free(cur_term);
1013 out_free_suite:
1014 prune_acl_cond(cond);
1015 free(cond);
1016 out_return:
1017 return NULL;
1018}
1019
Willy Tarreau2bbba412010-01-28 16:48:33 +01001020/* Builds an ACL condition starting at the if/unless keyword. The complete
1021 * condition is returned. NULL is returned in case of error or if the first
1022 * word is neither "if" nor "unless". It automatically sets the file name and
Willy Tarreau25320b22013-03-24 07:22:08 +01001023 * the line number in the condition for better error reporting, and sets the
1024 * HTTP intiailization requirements in the proxy. If <err> is not NULL, it will
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001025 * be filled with a pointer to an error message in case of error, that the
1026 * caller is responsible for freeing. The initial location must either be
1027 * freeable or NULL.
Willy Tarreau2bbba412010-01-28 16:48:33 +01001028 */
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001029struct acl_cond *build_acl_cond(const char *file, int line, struct list *known_acl,
1030 struct proxy *px, const char **args, char **err)
Willy Tarreau2bbba412010-01-28 16:48:33 +01001031{
Willy Tarreau0cba6072013-11-28 22:21:02 +01001032 enum acl_cond_pol pol = ACL_COND_NONE;
Willy Tarreau2bbba412010-01-28 16:48:33 +01001033 struct acl_cond *cond = NULL;
1034
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001035 if (err)
1036 *err = NULL;
1037
Willy Tarreau2bbba412010-01-28 16:48:33 +01001038 if (!strcmp(*args, "if")) {
1039 pol = ACL_COND_IF;
1040 args++;
1041 }
1042 else if (!strcmp(*args, "unless")) {
1043 pol = ACL_COND_UNLESS;
1044 args++;
1045 }
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001046 else {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001047 memprintf(err, "conditions must start with either 'if' or 'unless'");
Willy Tarreau2bbba412010-01-28 16:48:33 +01001048 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001049 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001050
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001051 cond = parse_acl_cond(args, known_acl, pol, err, &px->conf.args, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001052 if (!cond) {
1053 /* note that parse_acl_cond must have filled <err> here */
Willy Tarreau2bbba412010-01-28 16:48:33 +01001054 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001055 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001056
1057 cond->file = file;
1058 cond->line = line;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001059 px->http_needed |= !!(cond->use & SMP_USE_HTTP_ANY);
Willy Tarreau2bbba412010-01-28 16:48:33 +01001060 return cond;
1061}
1062
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001063/* Execute condition <cond> and return either ACL_TEST_FAIL, ACL_TEST_MISS or
1064 * ACL_TEST_PASS depending on the test results. ACL_TEST_MISS may only be
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001065 * returned if <opt> does not contain SMP_OPT_FINAL, indicating that incomplete
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001066 * data is being examined. The function automatically sets SMP_OPT_ITERATE. This
1067 * function only computes the condition, it does not apply the polarity required
1068 * by IF/UNLESS, it's up to the caller to do this using something like this :
Willy Tarreau11382812008-07-09 16:18:21 +02001069 *
1070 * res = acl_pass(res);
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001071 * if (res == ACL_TEST_MISS)
Willy Tarreaub6866442008-07-14 23:54:42 +02001072 * return 0;
Willy Tarreau11382812008-07-09 16:18:21 +02001073 * if (cond->pol == ACL_COND_UNLESS)
1074 * res = !res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001075 */
Willy Tarreau192252e2015-04-04 01:47:55 +02001076enum 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 +02001077{
1078 __label__ fetch_next;
1079 struct acl_term_suite *suite;
1080 struct acl_term *term;
1081 struct acl_expr *expr;
1082 struct acl *acl;
Willy Tarreau37406352012-04-23 16:16:37 +02001083 struct sample smp;
Willy Tarreau0cba6072013-11-28 22:21:02 +01001084 enum acl_test_res acl_res, suite_res, cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001085
Willy Tarreau7a777ed2012-04-26 11:44:02 +02001086 /* ACLs are iterated over all values, so let's always set the flag to
1087 * indicate this to the fetch functions.
1088 */
1089 opt |= SMP_OPT_ITERATE;
1090
Willy Tarreau11382812008-07-09 16:18:21 +02001091 /* We're doing a logical OR between conditions so we initialize to FAIL.
1092 * The MISS status is propagated down from the suites.
1093 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001094 cond_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001095 list_for_each_entry(suite, &cond->suites, list) {
Willy Tarreau11382812008-07-09 16:18:21 +02001096 /* Evaluate condition suite <suite>. We stop at the first term
Willy Tarreau0cba6072013-11-28 22:21:02 +01001097 * which returns ACL_TEST_FAIL. The MISS status is still propagated
Willy Tarreau11382812008-07-09 16:18:21 +02001098 * in case of uncertainty in the result.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001099 */
1100
1101 /* we're doing a logical AND between terms, so we must set the
1102 * initial value to PASS.
1103 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001104 suite_res = ACL_TEST_PASS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001105 list_for_each_entry(term, &suite->terms, list) {
1106 acl = term->acl;
1107
1108 /* FIXME: use cache !
1109 * check acl->cache_idx for this.
1110 */
1111
1112 /* ACL result not cached. Let's scan all the expressions
1113 * and use the first one to match.
1114 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001115 acl_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001116 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaud41f8d82007-06-10 10:06:18 +02001117 /* we need to reset context and flags */
Willy Tarreau37406352012-04-23 16:16:37 +02001118 memset(&smp, 0, sizeof(smp));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001119 fetch_next:
Willy Tarreau192252e2015-04-04 01:47:55 +02001120 if (!sample_process(px, sess, strm, opt, expr->smp, &smp)) {
Willy Tarreaub6866442008-07-14 23:54:42 +02001121 /* maybe we could not fetch because of missing data */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001122 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001123 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001124 continue;
Willy Tarreaub6866442008-07-14 23:54:42 +02001125 }
Willy Tarreauc4262962010-05-10 23:42:40 +02001126
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +01001127 acl_res |= pat2acl(pattern_exec_match(&expr->pat, &smp, 0));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001128 /*
Willy Tarreau11382812008-07-09 16:18:21 +02001129 * OK now acl_res holds the result of this expression
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001130 * as one of ACL_TEST_FAIL, ACL_TEST_MISS or ACL_TEST_PASS.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001131 *
Willy Tarreau11382812008-07-09 16:18:21 +02001132 * Then if (!MISS) we can cache the result, and put
Willy Tarreau37406352012-04-23 16:16:37 +02001133 * (smp.flags & SMP_F_VOLATILE) in the cache flags.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001134 *
1135 * FIXME: implement cache.
1136 *
1137 */
1138
Willy Tarreau11382812008-07-09 16:18:21 +02001139 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001140 if (acl_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001141 break;
1142
Willy Tarreau37406352012-04-23 16:16:37 +02001143 if (smp.flags & SMP_F_NOT_LAST)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001144 goto fetch_next;
Willy Tarreaub6866442008-07-14 23:54:42 +02001145
1146 /* sometimes we know the fetched data is subject to change
1147 * later and give another chance for a new match (eg: request
1148 * size, time, ...)
1149 */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001150 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001151 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001152 }
1153 /*
1154 * Here we have the result of an ACL (cached or not).
1155 * ACLs are combined, negated or not, to form conditions.
1156 */
1157
Willy Tarreaua84d3742007-05-07 00:36:48 +02001158 if (term->neg)
Willy Tarreau11382812008-07-09 16:18:21 +02001159 acl_res = acl_neg(acl_res);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001160
1161 suite_res &= acl_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001162
Willy Tarreau79c412b2013-10-30 19:30:32 +01001163 /* we're ANDing these terms, so a single FAIL or MISS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001164 if (suite_res != ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001165 break;
1166 }
1167 cond_res |= suite_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001168
1169 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001170 if (cond_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001171 break;
1172 }
Willy Tarreau11382812008-07-09 16:18:21 +02001173 return cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001174}
1175
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001176/* Returns a pointer to the first ACL conflicting with usage at place <where>
1177 * which is one of the SMP_VAL_* bits indicating a check place, or NULL if
1178 * no conflict is found. Only full conflicts are detected (ACL is not usable).
1179 * Use the next function to check for useless keywords.
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001180 */
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001181const struct acl *acl_cond_conflicts(const struct acl_cond *cond, unsigned int where)
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001182{
1183 struct acl_term_suite *suite;
1184 struct acl_term *term;
1185 struct acl *acl;
1186
1187 list_for_each_entry(suite, &cond->suites, list) {
1188 list_for_each_entry(term, &suite->terms, list) {
1189 acl = term->acl;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001190 if (!(acl->val & where))
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001191 return acl;
1192 }
1193 }
1194 return NULL;
1195}
1196
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001197/* Returns a pointer to the first ACL and its first keyword to conflict with
1198 * usage at place <where> which is one of the SMP_VAL_* bits indicating a check
1199 * place. Returns true if a conflict is found, with <acl> and <kw> set (if non
1200 * null), or false if not conflict is found. The first useless keyword is
1201 * returned.
1202 */
Willy Tarreau93fddf12013-03-31 22:59:32 +02001203int 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 +01001204{
1205 struct acl_term_suite *suite;
1206 struct acl_term *term;
1207 struct acl_expr *expr;
1208
1209 list_for_each_entry(suite, &cond->suites, list) {
1210 list_for_each_entry(term, &suite->terms, list) {
1211 list_for_each_entry(expr, &term->acl->expr, list) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001212 if (!(expr->smp->fetch->val & where)) {
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001213 if (acl)
1214 *acl = term->acl;
1215 if (kw)
1216 *kw = expr->kw;
1217 return 1;
1218 }
1219 }
1220 }
1221 }
1222 return 0;
1223}
1224
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001225/*
1226 * Find targets for userlist and groups in acl. Function returns the number
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001227 * of errors or OK if everything is fine. It must be called only once sample
1228 * fetch arguments have been resolved (after smp_resolve_args()).
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001229 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001230int acl_find_targets(struct proxy *p)
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001231{
1232
1233 struct acl *acl;
1234 struct acl_expr *expr;
Thierry FOURNIER3ead5b92013-12-13 12:12:18 +01001235 struct pattern_list *pattern;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001236 int cfgerr = 0;
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001237 struct pattern_expr_list *pexp;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001238
1239 list_for_each_entry(acl, &p->acl, list) {
1240 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001241 if (!strcmp(expr->kw, "http_auth_group")) {
1242 /* Note: the ARGT_USR argument may only have been resolved earlier
1243 * by smp_resolve_args().
1244 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001245 if (expr->smp->arg_p->unresolved) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001246 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 +02001247 p->id, *acl->name ? "" : "anonymous ", acl->name, expr->kw,
1248 expr->smp->arg_p->data.str.area);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001249 cfgerr++;
Willy Tarreau496aa012012-06-01 10:38:29 +02001250 continue;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001251 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001252
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001253 if (LIST_ISEMPTY(&expr->pat.head)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001254 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1255 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001256 cfgerr++;
1257 continue;
1258 }
1259
Thierry FOURNIER9eec0a62014-01-22 18:38:02 +01001260 /* For each pattern, check if the group exists. */
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001261 list_for_each_entry(pexp, &expr->pat.head, list) {
1262 if (LIST_ISEMPTY(&pexp->expr->patterns)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001263 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1264 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001265 cfgerr++;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001266 continue;
1267 }
1268
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001269 list_for_each_entry(pattern, &pexp->expr->patterns, list) {
1270 /* this keyword only has one argument */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001271 if (!check_group(expr->smp->arg_p->data.usr, pattern->pat.ptr.str)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001272 ha_alert("proxy %s: acl %s %s(): invalid group '%s'.\n",
1273 p->id, acl->name, expr->kw, pattern->pat.ptr.str);
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001274 cfgerr++;
1275 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001276 }
1277 }
1278 }
1279 }
1280 }
1281
1282 return cfgerr;
1283}
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001284
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001285/* initializes ACLs by resolving the sample fetch names they rely upon.
1286 * Returns 0 on success, otherwise an error.
1287 */
1288int init_acl()
1289{
1290 int err = 0;
1291 int index;
1292 const char *name;
1293 struct acl_kw_list *kwl;
1294 struct sample_fetch *smp;
1295
1296 list_for_each_entry(kwl, &acl_keywords.list, list) {
1297 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1298 name = kwl->kw[index].fetch_kw;
1299 if (!name)
1300 name = kwl->kw[index].kw;
1301
1302 smp = find_sample_fetch(name, strlen(name));
1303 if (!smp) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001304 ha_alert("Critical internal error: ACL keyword '%s' relies on sample fetch '%s' which was not registered!\n",
1305 kwl->kw[index].kw, name);
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001306 err++;
1307 continue;
1308 }
1309 kwl->kw[index].smp = smp;
1310 }
1311 }
1312 return err;
1313}
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001314
Willy Tarreaua84d3742007-05-07 00:36:48 +02001315/************************************************************************/
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001316/* All supported sample and ACL keywords must be declared here. */
1317/************************************************************************/
1318
1319/* Note: must not be declared <const> as its list will be overwritten.
Willy Tarreau61612d42012-04-19 18:42:05 +02001320 * Please take care of keeping this list alphabetically sorted.
1321 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001322static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001323 { /* END */ },
Willy Tarreaua84d3742007-05-07 00:36:48 +02001324}};
1325
Willy Tarreau0108d902018-11-25 19:14:37 +01001326INITCALL1(STG_REGISTER, acl_register_keywords, &acl_kws);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001327
1328/*
1329 * Local variables:
1330 * c-indent-level: 8
1331 * c-basic-offset: 8
1332 * End:
1333 */