blob: d8a67f5eafa649245022e6157052333cd4a59502 [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{
52 LIST_ADDQ(&acl_keywords.list, &kwl->list);
53}
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{
60 LIST_DEL(&kwl->list);
61 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
126 * as a list head to report missing dependencies.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200127 *
Willy Tarreaua84d3742007-05-07 00:36:48 +0200128 * Right now, the only accepted syntax is :
129 * <subject> [<value>...]
130 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100131struct acl_expr *parse_acl_expr(const char **args, char **err, struct arg_list *al,
132 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200133{
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100134 __label__ out_return, out_free_expr;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200135 struct acl_expr *expr;
136 struct acl_keyword *aclkw;
Christopher Faulet54ceb042017-06-14 14:41:33 +0200137 int refflags, patflags;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200138 const char *arg;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100139 struct sample_expr *smp = NULL;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100140 int idx = 0;
141 char *ckw = NULL;
142 const char *begw;
143 const char *endw;
Willy Tarreau131b4662013-12-13 01:08:36 +0100144 const char *endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100145 int cur_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100146 int nbargs;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100147 int operator = STD_OP_EQ;
148 int op;
149 int contain_colon, have_dot;
150 const char *dot;
151 signed long long value, minor;
152 /* The following buffer contain two numbers, a ':' separator and the final \0. */
153 char buffer[NB_LLMAX_STR + 1 + NB_LLMAX_STR + 1];
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100154 int is_loaded;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100155 int unique_id;
156 char *error;
157 struct pat_ref *ref;
158 struct pattern_expr *pattern_expr;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100159 int load_as_map = 0;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200160 int acl_conv_found = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200161
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100162 /* First, we look for an ACL keyword. And if we don't find one, then
163 * we look for a sample fetch expression starting with a sample fetch
164 * keyword.
Willy Tarreaubef91e72013-03-31 23:14:46 +0200165 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100166
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100167 al->ctx = ARGC_ACL; // to report errors while resolving args late
Willy Tarreau131b4662013-12-13 01:08:36 +0100168 al->kw = *args;
169 al->conv = NULL;
170
Willy Tarreaua84d3742007-05-07 00:36:48 +0200171 aclkw = find_acl_kw(args[0]);
Willy Tarreau20490922014-03-17 18:04:27 +0100172 if (aclkw) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100173 /* OK we have a real ACL keyword */
Willy Tarreau9987ea92013-06-11 21:09:06 +0200174
Willy Tarreau131b4662013-12-13 01:08:36 +0100175 /* build new sample expression for this ACL */
Vincent Bernat02779b62016-04-03 13:48:43 +0200176 smp = calloc(1, sizeof(*smp));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100177 if (!smp) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100178 memprintf(err, "out of memory when parsing ACL expression");
179 goto out_return;
180 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100181 LIST_INIT(&(smp->conv_exprs));
182 smp->fetch = aclkw->smp;
183 smp->arg_p = empty_arg_list;
Willy Tarreau34db1082012-04-19 17:16:54 +0200184
Joseph Herlant68082792018-11-15 14:55:09 -0800185 /* look for the beginning of the subject arguments */
Willy Tarreaued2c6622020-02-14 18:27:10 +0100186 for (arg = args[0]; is_idchar(*arg); arg++)
187 ;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100188
Willy Tarreau131b4662013-12-13 01:08:36 +0100189 /* At this point, we have :
190 * - args[0] : beginning of the keyword
191 * - arg : end of the keyword, first character not part of keyword
Willy Tarreau131b4662013-12-13 01:08:36 +0100192 */
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100193 nbargs = make_arg_list(arg, -1, smp->fetch->arg_mask, &smp->arg_p,
194 err, &endt, NULL, al);
Willy Tarreau131b4662013-12-13 01:08:36 +0100195 if (nbargs < 0) {
196 /* note that make_arg_list will have set <err> here */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100197 memprintf(err, "ACL keyword '%s' : %s", aclkw->kw, *err);
198 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100199 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100200
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100201 if (!smp->arg_p) {
202 smp->arg_p = empty_arg_list;
Willy Tarreau131b4662013-12-13 01:08:36 +0100203 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100204 else if (smp->fetch->val_args && !smp->fetch->val_args(smp->arg_p, err)) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100205 /* invalid keyword argument, error must have been
206 * set by val_args().
207 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100208 memprintf(err, "in argument to '%s', %s", aclkw->kw, *err);
209 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100210 }
211 arg = endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100212
Joseph Herlant68082792018-11-15 14:55:09 -0800213 /* look for the beginning of the converters list. Those directly attached
Willy Tarreau131b4662013-12-13 01:08:36 +0100214 * to the ACL keyword are found just after <arg> which points to the comma.
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200215 * If we find any converter, then we don't use the ACL keyword's match
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200216 * anymore but the one related to the converter's output type.
Willy Tarreau131b4662013-12-13 01:08:36 +0100217 */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200218 cur_type = smp->fetch->out_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100219 while (*arg) {
220 struct sample_conv *conv;
221 struct sample_conv_expr *conv_expr;
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100222 int err_arg;
223 int argcnt;
Willy Tarreau131b4662013-12-13 01:08:36 +0100224
225 if (*arg && *arg != ',') {
226 if (ckw)
Willy Tarreau97108e02016-11-25 07:33:24 +0100227 memprintf(err, "ACL keyword '%s' : missing comma after converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100228 aclkw->kw, ckw);
Willy Tarreau131b4662013-12-13 01:08:36 +0100229 else
230 memprintf(err, "ACL keyword '%s' : missing comma after fetch keyword.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100231 aclkw->kw);
232 goto out_free_smp;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200233 }
Willy Tarreauae52f062012-04-26 12:13:35 +0200234
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100235 /* FIXME: how long should we support such idiocies ? Maybe we
236 * should already warn ?
237 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100238 while (*arg == ',') /* then trailing commas */
239 arg++;
Willy Tarreau2e845be2012-10-19 19:49:09 +0200240
Willy Tarreau97108e02016-11-25 07:33:24 +0100241 begw = arg; /* start of converter keyword */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100242
Willy Tarreau131b4662013-12-13 01:08:36 +0100243 if (!*begw)
244 /* none ? end of converters */
245 break;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100246
Willy Tarreaued2c6622020-02-14 18:27:10 +0100247 for (endw = begw; is_idchar(*endw); endw++)
248 ;
Willy Tarreau9ca69362013-10-22 19:10:06 +0200249
Willy Tarreau131b4662013-12-13 01:08:36 +0100250 free(ckw);
251 ckw = my_strndup(begw, endw - begw);
Willy Tarreauf75d0082013-04-07 21:20:44 +0200252
Willy Tarreau131b4662013-12-13 01:08:36 +0100253 conv = find_sample_conv(begw, endw - begw);
254 if (!conv) {
255 /* Unknown converter method */
Willy Tarreau97108e02016-11-25 07:33:24 +0100256 memprintf(err, "ACL keyword '%s' : unknown converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100257 aclkw->kw, ckw);
258 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100259 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100260
Willy Tarreau131b4662013-12-13 01:08:36 +0100261 arg = endw;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100262
Willy Tarreau131b4662013-12-13 01:08:36 +0100263 if (conv->in_type >= SMP_TYPES || conv->out_type >= SMP_TYPES) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100264 memprintf(err, "ACL keyword '%s' : returns type of converter '%s' is unknown.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100265 aclkw->kw, ckw);
266 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100267 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100268
Willy Tarreau131b4662013-12-13 01:08:36 +0100269 /* If impossible type conversion */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200270 if (!sample_casts[cur_type][conv->in_type]) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100271 memprintf(err, "ACL keyword '%s' : converter '%s' cannot be applied.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100272 aclkw->kw, ckw);
273 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100274 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100275
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200276 cur_type = conv->out_type;
Vincent Bernat02779b62016-04-03 13:48:43 +0200277 conv_expr = calloc(1, sizeof(*conv_expr));
Willy Tarreau131b4662013-12-13 01:08:36 +0100278 if (!conv_expr)
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100279 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100280
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100281 LIST_ADDQ(&(smp->conv_exprs), &(conv_expr->list));
Willy Tarreau131b4662013-12-13 01:08:36 +0100282 conv_expr->conv = conv;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200283 acl_conv_found = 1;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100284
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100285 al->kw = smp->fetch->kw;
286 al->conv = conv_expr->conv->kw;
287 argcnt = make_arg_list(endw, -1, conv->arg_mask, &conv_expr->arg_p, err, &arg, &err_arg, al);
288 if (argcnt < 0) {
289 memprintf(err, "ACL keyword '%s' : invalid arg %d in converter '%s' : %s.",
290 aclkw->kw, err_arg+1, ckw, *err);
291 goto out_free_smp;
292 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100293
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100294 if (argcnt && !conv->arg_mask) {
295 memprintf(err, "converter '%s' does not support any args", ckw);
296 goto out_free_smp;
297 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100298
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100299 if (!conv_expr->arg_p)
300 conv_expr->arg_p = empty_arg_list;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100301
Willy Tarreau80b53ff2020-02-14 08:40:37 +0100302 if (conv->val_args && !conv->val_args(conv_expr->arg_p, conv, file, line, err)) {
303 memprintf(err, "ACL keyword '%s' : invalid args in converter '%s' : %s.",
304 aclkw->kw, ckw, *err);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100305 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100306 }
Willy Tarreau61612d42012-04-19 18:42:05 +0200307 }
Christopher Faulet361935a2019-09-13 09:50:15 +0200308 free(ckw);
309 ckw = NULL;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200310 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100311 else {
312 /* This is not an ACL keyword, so we hope this is a sample fetch
313 * keyword that we're going to transparently use as an ACL. If
314 * so, we retrieve a completely parsed expression with args and
315 * convs already done.
316 */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100317 smp = sample_parse_expr((char **)args, &idx, file, line, err, al, NULL);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100318 if (!smp) {
319 memprintf(err, "%s in ACL expression '%s'", *err, *args);
320 goto out_return;
321 }
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200322 cur_type = smp_expr_output_type(smp);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100323 }
324
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200325 expr = calloc(1, sizeof(*expr));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100326 if (!expr) {
327 memprintf(err, "out of memory when parsing ACL expression");
Christopher Faulet361935a2019-09-13 09:50:15 +0200328 goto out_free_smp;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100329 }
330
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100331 pattern_init_head(&expr->pat);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100332
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200333 expr->pat.expect_type = cur_type;
334 expr->smp = smp;
335 expr->kw = smp->fetch->kw;
336 smp = NULL; /* don't free it anymore */
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100337
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200338 if (aclkw && !acl_conv_found) {
339 expr->kw = aclkw->kw;
340 expr->pat.parse = aclkw->parse ? aclkw->parse : pat_parse_fcts[aclkw->match_type];
341 expr->pat.index = aclkw->index ? aclkw->index : pat_index_fcts[aclkw->match_type];
342 expr->pat.match = aclkw->match ? aclkw->match : pat_match_fcts[aclkw->match_type];
343 expr->pat.delete = aclkw->delete ? aclkw->delete : pat_delete_fcts[aclkw->match_type];
344 expr->pat.prune = aclkw->prune ? aclkw->prune : pat_prune_fcts[aclkw->match_type];
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100345 }
346
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100347 if (!expr->pat.parse) {
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200348 /* Parse/index/match functions depend on the expression type,
349 * so we have to map them now. Some types can be automatically
350 * converted.
351 */
352 switch (cur_type) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100353 case SMP_T_BOOL:
354 expr->pat.parse = pat_parse_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100355 expr->pat.index = pat_index_fcts[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100356 expr->pat.match = pat_match_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100357 expr->pat.delete = pat_delete_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100358 expr->pat.prune = pat_prune_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100359 expr->pat.expect_type = pat_match_types[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100360 break;
361 case SMP_T_SINT:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100362 expr->pat.parse = pat_parse_fcts[PAT_MATCH_INT];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100363 expr->pat.index = pat_index_fcts[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100364 expr->pat.match = pat_match_fcts[PAT_MATCH_INT];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100365 expr->pat.delete = pat_delete_fcts[PAT_MATCH_INT];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100366 expr->pat.prune = pat_prune_fcts[PAT_MATCH_INT];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100367 expr->pat.expect_type = pat_match_types[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100368 break;
Willy Tarreau78c5eec2019-04-19 11:45:20 +0200369 case SMP_T_ADDR:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100370 case SMP_T_IPV4:
371 case SMP_T_IPV6:
372 expr->pat.parse = pat_parse_fcts[PAT_MATCH_IP];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100373 expr->pat.index = pat_index_fcts[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100374 expr->pat.match = pat_match_fcts[PAT_MATCH_IP];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100375 expr->pat.delete = pat_delete_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];
383 expr->pat.delete = pat_delete_fcts[PAT_MATCH_STR];
384 expr->pat.prune = pat_prune_fcts[PAT_MATCH_STR];
385 expr->pat.expect_type = pat_match_types[PAT_MATCH_STR];
386 break;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100387 }
388 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200389
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100390 /* Additional check to protect against common mistakes */
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100391 if (expr->pat.parse && cur_type != SMP_T_BOOL && !*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100392 ha_warning("parsing acl keyword '%s' :\n"
393 " no pattern to match against were provided, so this ACL will never match.\n"
394 " If this is what you intended, please add '--' to get rid of this warning.\n"
395 " If you intended to match only for existence, please use '-m found'.\n"
396 " If you wanted to force an int to match as a bool, please use '-m bool'.\n"
397 "\n",
398 args[0]);
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100399 }
400
Willy Tarreaua84d3742007-05-07 00:36:48 +0200401 args++;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200402
403 /* check for options before patterns. Supported options are :
404 * -i : ignore case for all patterns by default
405 * -f : read patterns from those files
Willy Tarreau5adeda12013-03-31 22:13:34 +0200406 * -m : force matching method (must be used before -f)
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100407 * -M : load the file as map file
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100408 * -u : force the unique id of the acl
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200409 * -- : everything after this is not an option
410 */
Christopher Faulet54ceb042017-06-14 14:41:33 +0200411 refflags = PAT_REF_ACL;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200412 patflags = 0;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100413 is_loaded = 0;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100414 unique_id = -1;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200415 while (**args == '-') {
Willy Tarreau2039bba2014-05-11 09:43:46 +0200416 if (strcmp(*args, "-i") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200417 patflags |= PAT_MF_IGNORE_CASE;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200418 else if (strcmp(*args, "-n") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200419 patflags |= PAT_MF_NO_DNS;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200420 else if (strcmp(*args, "-u") == 0) {
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100421 unique_id = strtol(args[1], &error, 10);
422 if (*error != '\0') {
423 memprintf(err, "the argument of -u must be an integer");
424 goto out_free_expr;
425 }
426
427 /* Check if this id is really unique. */
428 if (pat_ref_lookupid(unique_id)) {
429 memprintf(err, "the id is already used");
430 goto out_free_expr;
431 }
432
433 args++;
434 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200435 else if (strcmp(*args, "-f") == 0) {
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100436 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200437 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 +0200438 goto out_free_expr;
439 }
440
Christopher Faulet54ceb042017-06-14 14:41:33 +0200441 if (!pattern_read_from_file(&expr->pat, refflags, args[1], patflags, load_as_map, err, file, line))
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200442 goto out_free_expr;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100443 is_loaded = 1;
Willy Tarreau5adeda12013-03-31 22:13:34 +0200444 args++;
445 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200446 else if (strcmp(*args, "-m") == 0) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200447 int idx;
448
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100449 if (is_loaded) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200450 memprintf(err, "'-m' must only be specified before patterns and files in parsing ACL expression");
451 goto out_free_expr;
452 }
453
Willy Tarreau6f8fe312013-11-28 22:24:25 +0100454 idx = pat_find_match_name(args[1]);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200455 if (idx < 0) {
456 memprintf(err, "unknown matching method '%s' when parsing ACL expression", args[1]);
457 goto out_free_expr;
458 }
459
460 /* Note: -m found is always valid, bool/int are compatible, str/bin/reg/len are compatible */
Willy Tarreau9bb49f62015-09-24 16:37:12 +0200461 if (idx != PAT_MATCH_FOUND && !sample_casts[cur_type][pat_match_types[idx]]) {
Willy Tarreau93fddf12013-03-31 22:59:32 +0200462 memprintf(err, "matching method '%s' cannot be used with fetch keyword '%s'", args[1], expr->kw);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200463 goto out_free_expr;
464 }
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100465 expr->pat.parse = pat_parse_fcts[idx];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100466 expr->pat.index = pat_index_fcts[idx];
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100467 expr->pat.match = pat_match_fcts[idx];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100468 expr->pat.delete = pat_delete_fcts[idx];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100469 expr->pat.prune = pat_prune_fcts[idx];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100470 expr->pat.expect_type = pat_match_types[idx];
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200471 args++;
472 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200473 else if (strcmp(*args, "-M") == 0) {
Christopher Faulet54ceb042017-06-14 14:41:33 +0200474 refflags |= PAT_REF_MAP;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100475 load_as_map = 1;
476 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200477 else if (strcmp(*args, "--") == 0) {
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200478 args++;
479 break;
480 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200481 else {
482 memprintf(err, "'%s' is not a valid ACL option. Please use '--' before any pattern beginning with a '-'", args[0]);
483 goto out_free_expr;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200484 break;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200485 }
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200486 args++;
487 }
488
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100489 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200490 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 +0200491 goto out_free_expr;
492 }
493
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100494 /* Create displayed reference */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200495 snprintf(trash.area, trash.size, "acl '%s' file '%s' line %d",
496 expr->kw, file, line);
497 trash.area[trash.size - 1] = '\0';
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100498
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500499 /* Create new pattern reference. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200500 ref = pat_ref_newid(unique_id, trash.area, PAT_REF_ACL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100501 if (!ref) {
502 memprintf(err, "memory error");
503 goto out_free_expr;
504 }
505
506 /* Create new pattern expression associated to this reference. */
Emeric Brun7d27f3c2017-07-03 17:54:23 +0200507 pattern_expr = pattern_new_expr(&expr->pat, ref, patflags, err, NULL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100508 if (!pattern_expr)
509 goto out_free_expr;
510
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200511 /* now parse all patterns */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100512 while (**args) {
513 arg = *args;
514
515 /* Compatibility layer. Each pattern can parse only one string per pattern,
516 * but the pat_parser_int() and pat_parse_dotted_ver() parsers were need
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500517 * optionally two operators. The first operator is the match method: eq,
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100518 * le, lt, ge and gt. pat_parse_int() and pat_parse_dotted_ver() functions
519 * can have a compatibility syntax based on ranges:
520 *
521 * pat_parse_int():
522 *
523 * "eq x" -> "x" or "x:x"
524 * "le x" -> ":x"
525 * "lt x" -> ":y" (with y = x - 1)
526 * "ge x" -> "x:"
527 * "gt x" -> "y:" (with y = x + 1)
528 *
529 * pat_parse_dotted_ver():
530 *
531 * "eq x.y" -> "x.y" or "x.y:x.y"
532 * "le x.y" -> ":x.y"
533 * "lt x.y" -> ":w.z" (with w.z = x.y - 1)
534 * "ge x.y" -> "x.y:"
535 * "gt x.y" -> "w.z:" (with w.z = x.y + 1)
536 *
537 * If y is not present, assume that is "0".
538 *
539 * The syntax eq, le, lt, ge and gt are proper to the acl syntax. The
540 * following block of code detect the operator, and rewrite each value
541 * in parsable string.
542 */
543 if (expr->pat.parse == pat_parse_int ||
544 expr->pat.parse == pat_parse_dotted_ver) {
545 /* Check for operator. If the argument is operator, memorise it and
546 * continue to the next argument.
547 */
548 op = get_std_op(arg);
549 if (op != -1) {
550 operator = op;
551 args++;
552 continue;
553 }
554
555 /* Check if the pattern contain ':' or '-' character. */
556 contain_colon = (strchr(arg, ':') || strchr(arg, '-'));
557
558 /* If the pattern contain ':' or '-' character, give it to the parser as is.
559 * If no contain ':' and operator is STD_OP_EQ, give it to the parser as is.
560 * In other case, try to convert the value according with the operator.
561 */
562 if (!contain_colon && operator != STD_OP_EQ) {
563 /* Search '.' separator. */
564 dot = strchr(arg, '.');
565 if (!dot) {
566 have_dot = 0;
567 minor = 0;
568 dot = arg + strlen(arg);
569 }
570 else
571 have_dot = 1;
572
573 /* convert the integer minor part for the pat_parse_dotted_ver() function. */
574 if (expr->pat.parse == pat_parse_dotted_ver && have_dot) {
575 if (strl2llrc(dot+1, strlen(dot+1), &minor) != 0) {
576 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100577 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100578 }
579 if (minor >= 65536) {
580 memprintf(err, "'%s' contains too large a minor value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100581 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100582 }
583 }
584
585 /* convert the integer value for the pat_parse_int() function, and the
586 * integer major part for the pat_parse_dotted_ver() function.
587 */
588 if (strl2llrc(arg, dot - arg, &value) != 0) {
589 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100590 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100591 }
592 if (expr->pat.parse == pat_parse_dotted_ver) {
593 if (value >= 65536) {
594 memprintf(err, "'%s' contains too large a major value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100595 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100596 }
597 value = (value << 16) | (minor & 0xffff);
598 }
599
600 switch (operator) {
601
602 case STD_OP_EQ: /* this case is not possible. */
603 memprintf(err, "internal error");
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100604 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100605
606 case STD_OP_GT:
607 value++; /* gt = ge + 1 */
Tim Duesterhus588b3142020-05-29 14:35:51 +0200608 /* fall through */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100609
610 case STD_OP_GE:
611 if (expr->pat.parse == pat_parse_int)
612 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld:", value);
613 else
614 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld.%lld:",
615 value >> 16, value & 0xffff);
616 arg = buffer;
617 break;
618
619 case STD_OP_LT:
620 value--; /* lt = le - 1 */
Tim Duesterhus588b3142020-05-29 14:35:51 +0200621 /* fall through */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100622
623 case STD_OP_LE:
624 if (expr->pat.parse == pat_parse_int)
625 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld", value);
626 else
627 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld.%lld",
628 value >> 16, value & 0xffff);
629 arg = buffer;
630 break;
631 }
632 }
633 }
634
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100635 /* Add sample to the reference, and try to compile it fior each pattern
636 * using this value.
637 */
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200638 if (!pat_ref_add(ref, arg, NULL, err))
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100639 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100640 args++;
641 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200642
643 return expr;
644
Willy Tarreaua84d3742007-05-07 00:36:48 +0200645 out_free_expr:
646 prune_acl_expr(expr);
647 free(expr);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100648 out_free_smp:
Christopher Faulet361935a2019-09-13 09:50:15 +0200649 free(ckw);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100650 free(smp);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200651 out_return:
652 return NULL;
653}
654
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200655/* Purge everything in the acl <acl>, then return <acl>. */
656struct acl *prune_acl(struct acl *acl) {
657
658 struct acl_expr *expr, *exprb;
659
660 free(acl->name);
661
662 list_for_each_entry_safe(expr, exprb, &acl->expr, list) {
663 LIST_DEL(&expr->list);
664 prune_acl_expr(expr);
665 free(expr);
666 }
667
668 return acl;
669}
670
Willy Tarreaua84d3742007-05-07 00:36:48 +0200671/* Parse an ACL with the name starting at <args>[0], and with a list of already
672 * known ACLs in <acl>. If the ACL was not in the list, it will be added.
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100673 * A pointer to that ACL is returned. If the ACL has an empty name, then it's
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200674 * an anonymous one and it won't be merged with any other one. If <err> is not
675 * NULL, it will be filled with an appropriate error. This pointer must be
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200676 * freeable or NULL. <al> is the arg_list serving as a head for unresolved
677 * dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200678 *
679 * args syntax: <aclname> <acl_expr>
680 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100681struct acl *parse_acl(const char **args, struct list *known_acl, char **err, struct arg_list *al,
682 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200683{
684 __label__ out_return, out_free_acl_expr, out_free_name;
685 struct acl *cur_acl;
686 struct acl_expr *acl_expr;
687 char *name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200688 const char *pos;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200689
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200690 if (**args && (pos = invalid_char(*args))) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200691 memprintf(err, "invalid character in ACL name : '%c'", *pos);
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100692 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200693 }
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100694
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100695 acl_expr = parse_acl_expr(args + 1, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200696 if (!acl_expr) {
697 /* parse_acl_expr will have filled <err> here */
Willy Tarreaua84d3742007-05-07 00:36:48 +0200698 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200699 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200700
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200701 /* Check for args beginning with an opening parenthesis just after the
702 * subject, as this is almost certainly a typo. Right now we can only
703 * emit a warning, so let's do so.
704 */
Krzysztof Piotr Oledzki4cdd8312009-10-05 00:23:35 +0200705 if (!strchr(args[1], '(') && *args[2] == '(')
Christopher Faulet767a84b2017-11-24 16:50:31 +0100706 ha_warning("parsing acl '%s' :\n"
707 " matching '%s' for pattern '%s' is likely a mistake and probably\n"
708 " not what you want. Maybe you need to remove the extraneous space before '('.\n"
709 " If you are really sure this is not an error, please insert '--' between the\n"
710 " match and the pattern to make this warning message disappear.\n",
711 args[0], args[1], args[2]);
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200712
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100713 if (*args[0])
714 cur_acl = find_acl_by_name(args[0], known_acl);
715 else
716 cur_acl = NULL;
717
Willy Tarreaua84d3742007-05-07 00:36:48 +0200718 if (!cur_acl) {
719 name = strdup(args[0]);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200720 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200721 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200722 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200723 }
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200724 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200725 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200726 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200727 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200728 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200729
730 LIST_INIT(&cur_acl->expr);
731 LIST_ADDQ(known_acl, &cur_acl->list);
732 cur_acl->name = name;
733 }
734
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100735 /* We want to know what features the ACL needs (typically HTTP parsing),
736 * and where it may be used. If an ACL relies on multiple matches, it is
737 * OK if at least one of them may match in the context where it is used.
738 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100739 cur_acl->use |= acl_expr->smp->fetch->use;
740 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200741 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
742 return cur_acl;
743
744 out_free_name:
745 free(name);
746 out_free_acl_expr:
747 prune_acl_expr(acl_expr);
748 free(acl_expr);
749 out_return:
750 return NULL;
751}
752
Willy Tarreau16fbe822007-06-17 11:54:31 +0200753/* Some useful ACLs provided by default. Only those used are allocated. */
754
755const struct {
756 const char *name;
757 const char *expr[4]; /* put enough for longest expression */
758} default_acl_list[] = {
Willy Tarreau58393e12008-07-20 10:39:22 +0200759 { .name = "TRUE", .expr = {"always_true",""}},
760 { .name = "FALSE", .expr = {"always_false",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200761 { .name = "LOCALHOST", .expr = {"src","127.0.0.1/8",""}},
Christopher Faulet2c9c0c92021-04-01 17:24:04 +0200762 { .name = "HTTP", .expr = {"req.proto_http",""}},
763 { .name = "HTTP_1.0", .expr = {"req.ver","1.0",""}},
764 { .name = "HTTP_1.1", .expr = {"req.ver","1.1",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200765 { .name = "METH_CONNECT", .expr = {"method","CONNECT",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200766 { .name = "METH_DELETE", .expr = {"method","DELETE",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200767 { .name = "METH_GET", .expr = {"method","GET","HEAD",""}},
768 { .name = "METH_HEAD", .expr = {"method","HEAD",""}},
769 { .name = "METH_OPTIONS", .expr = {"method","OPTIONS",""}},
770 { .name = "METH_POST", .expr = {"method","POST",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200771 { .name = "METH_PUT", .expr = {"method","PUT",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200772 { .name = "METH_TRACE", .expr = {"method","TRACE",""}},
773 { .name = "HTTP_URL_ABS", .expr = {"url_reg","^[^/:]*://",""}},
774 { .name = "HTTP_URL_SLASH", .expr = {"url_beg","/",""}},
775 { .name = "HTTP_URL_STAR", .expr = {"url","*",""}},
Christopher Faulet2c9c0c92021-04-01 17:24:04 +0200776 { .name = "HTTP_CONTENT", .expr = {"req.hdr_val(content-length)","gt","0",""}},
777 { .name = "RDP_COOKIE", .expr = {"req.rdp_cookie_cnt","gt","0",""}},
778 { .name = "REQ_CONTENT", .expr = {"req.len","gt","0",""}},
Willy Tarreaub6fb4202008-07-20 11:18:28 +0200779 { .name = "WAIT_END", .expr = {"wait_end",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200780 { .name = NULL, .expr = {""}}
781};
782
783/* Find a default ACL from the default_acl list, compile it and return it.
784 * If the ACL is not found, NULL is returned. In theory, it cannot fail,
785 * except when default ACLs are broken, in which case it will return NULL.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200786 * If <known_acl> is not NULL, the ACL will be queued at its tail. If <err> is
787 * not NULL, it will be filled with an error message if an error occurs. This
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200788 * pointer must be freeable or NULL. <al> is an arg_list serving as a list head
789 * to report missing dependencies.
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);
833 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
834 if (known_acl)
835 LIST_ADDQ(known_acl, &cur_acl->list);
836
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
869 * for unresolved dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200870 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200871struct acl_cond *parse_acl_cond(const char **args, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100872 enum acl_cond_pol pol, char **err, struct arg_list *al,
873 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200874{
875 __label__ out_return, out_free_suite, out_free_term;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200876 int arg, neg;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200877 const char *word;
878 struct acl *cur_acl;
879 struct acl_term *cur_term;
880 struct acl_term_suite *cur_suite;
881 struct acl_cond *cond;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100882 unsigned int suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200883
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200884 cond = calloc(1, sizeof(*cond));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200885 if (cond == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200886 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200887 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200888 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200889
890 LIST_INIT(&cond->list);
891 LIST_INIT(&cond->suites);
892 cond->pol = pol;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100893 cond->val = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200894
895 cur_suite = NULL;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100896 suite_val = ~0U;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200897 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200898 for (arg = 0; *args[arg]; arg++) {
899 word = args[arg];
900
901 /* remove as many exclamation marks as we can */
902 while (*word == '!') {
903 neg = !neg;
904 word++;
905 }
906
907 /* an empty word is allowed because we cannot force the user to
908 * always think about not leaving exclamation marks alone.
909 */
910 if (!*word)
911 continue;
912
Willy Tarreau16fbe822007-06-17 11:54:31 +0200913 if (strcasecmp(word, "or") == 0 || strcmp(word, "||") == 0) {
Willy Tarreaua84d3742007-05-07 00:36:48 +0200914 /* new term suite */
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100915 cond->val |= suite_val;
916 suite_val = ~0U;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200917 cur_suite = NULL;
918 neg = 0;
919 continue;
920 }
921
Willy Tarreau95fa4692010-02-01 13:05:50 +0100922 if (strcmp(word, "{") == 0) {
923 /* we may have a complete ACL expression between two braces,
924 * find the last one.
925 */
926 int arg_end = arg + 1;
927 const char **args_new;
928
929 while (*args[arg_end] && strcmp(args[arg_end], "}") != 0)
930 arg_end++;
931
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200932 if (!*args[arg_end]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200933 memprintf(err, "missing closing '}' in condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100934 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200935 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100936
937 args_new = calloc(1, (arg_end - arg + 1) * sizeof(*args_new));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200938 if (!args_new) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200939 memprintf(err, "out of memory when parsing condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100940 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200941 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100942
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100943 args_new[0] = "";
Willy Tarreau95fa4692010-02-01 13:05:50 +0100944 memcpy(args_new + 1, args + arg + 1, (arg_end - arg) * sizeof(*args_new));
945 args_new[arg_end - arg] = "";
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100946 cur_acl = parse_acl(args_new, known_acl, err, al, file, line);
Willy Tarreau95fa4692010-02-01 13:05:50 +0100947 free(args_new);
948
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200949 if (!cur_acl) {
950 /* note that parse_acl() must have filled <err> here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200951 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200952 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100953 arg = arg_end;
954 }
955 else {
956 /* search for <word> in the known ACL names. If we do not find
957 * it, let's look for it in the default ACLs, and if found, add
958 * it to the list of ACLs of this proxy. This makes it possible
959 * to override them.
960 */
961 cur_acl = find_acl_by_name(word, known_acl);
962 if (cur_acl == NULL) {
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100963 cur_acl = find_acl_default(word, known_acl, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200964 if (cur_acl == NULL) {
965 /* note that find_acl_default() must have filled <err> here */
Willy Tarreau95fa4692010-02-01 13:05:50 +0100966 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200967 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100968 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200969 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200970
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200971 cur_term = calloc(1, sizeof(*cur_term));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200972 if (cur_term == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200973 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200974 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200975 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200976
977 cur_term->acl = cur_acl;
978 cur_term->neg = neg;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100979
980 /* Here it is a bit complex. The acl_term_suite is a conjunction
981 * of many terms. It may only be used if all of its terms are
982 * usable at the same time. So the suite's validity domain is an
983 * AND between all ACL keywords' ones. But, the global condition
984 * is valid if at least one term suite is OK. So it's an OR between
985 * all of their validity domains. We could emit a warning as soon
986 * as suite_val is null because it means that the last ACL is not
987 * compatible with the previous ones. Let's remain simple for now.
988 */
989 cond->use |= cur_acl->use;
990 suite_val &= cur_acl->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200991
992 if (!cur_suite) {
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200993 cur_suite = calloc(1, sizeof(*cur_suite));
Willy Tarreauf678b7f2013-01-24 00:25:39 +0100994 if (cur_suite == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200995 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200996 goto out_free_term;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200997 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200998 LIST_INIT(&cur_suite->terms);
999 LIST_ADDQ(&cond->suites, &cur_suite->list);
1000 }
1001 LIST_ADDQ(&cur_suite->terms, &cur_term->list);
Willy Tarreau74b98a82007-06-16 19:35:18 +02001002 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001003 }
1004
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001005 cond->val |= suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001006 return cond;
1007
1008 out_free_term:
1009 free(cur_term);
1010 out_free_suite:
1011 prune_acl_cond(cond);
1012 free(cond);
1013 out_return:
1014 return NULL;
1015}
1016
Willy Tarreau2bbba412010-01-28 16:48:33 +01001017/* Builds an ACL condition starting at the if/unless keyword. The complete
1018 * condition is returned. NULL is returned in case of error or if the first
1019 * word is neither "if" nor "unless". It automatically sets the file name and
Willy Tarreau25320b22013-03-24 07:22:08 +01001020 * the line number in the condition for better error reporting, and sets the
1021 * HTTP intiailization requirements in the proxy. If <err> is not NULL, it will
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001022 * be filled with a pointer to an error message in case of error, that the
1023 * caller is responsible for freeing. The initial location must either be
1024 * freeable or NULL.
Willy Tarreau2bbba412010-01-28 16:48:33 +01001025 */
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001026struct acl_cond *build_acl_cond(const char *file, int line, struct list *known_acl,
1027 struct proxy *px, const char **args, char **err)
Willy Tarreau2bbba412010-01-28 16:48:33 +01001028{
Willy Tarreau0cba6072013-11-28 22:21:02 +01001029 enum acl_cond_pol pol = ACL_COND_NONE;
Willy Tarreau2bbba412010-01-28 16:48:33 +01001030 struct acl_cond *cond = NULL;
1031
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001032 if (err)
1033 *err = NULL;
1034
Willy Tarreau2bbba412010-01-28 16:48:33 +01001035 if (!strcmp(*args, "if")) {
1036 pol = ACL_COND_IF;
1037 args++;
1038 }
1039 else if (!strcmp(*args, "unless")) {
1040 pol = ACL_COND_UNLESS;
1041 args++;
1042 }
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001043 else {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001044 memprintf(err, "conditions must start with either 'if' or 'unless'");
Willy Tarreau2bbba412010-01-28 16:48:33 +01001045 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001046 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001047
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001048 cond = parse_acl_cond(args, known_acl, pol, err, &px->conf.args, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001049 if (!cond) {
1050 /* note that parse_acl_cond must have filled <err> here */
Willy Tarreau2bbba412010-01-28 16:48:33 +01001051 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001052 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001053
1054 cond->file = file;
1055 cond->line = line;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001056 px->http_needed |= !!(cond->use & SMP_USE_HTTP_ANY);
Willy Tarreau2bbba412010-01-28 16:48:33 +01001057 return cond;
1058}
1059
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001060/* Execute condition <cond> and return either ACL_TEST_FAIL, ACL_TEST_MISS or
1061 * ACL_TEST_PASS depending on the test results. ACL_TEST_MISS may only be
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001062 * returned if <opt> does not contain SMP_OPT_FINAL, indicating that incomplete
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001063 * data is being examined. The function automatically sets SMP_OPT_ITERATE. This
1064 * function only computes the condition, it does not apply the polarity required
1065 * by IF/UNLESS, it's up to the caller to do this using something like this :
Willy Tarreau11382812008-07-09 16:18:21 +02001066 *
1067 * res = acl_pass(res);
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001068 * if (res == ACL_TEST_MISS)
Willy Tarreaub6866442008-07-14 23:54:42 +02001069 * return 0;
Willy Tarreau11382812008-07-09 16:18:21 +02001070 * if (cond->pol == ACL_COND_UNLESS)
1071 * res = !res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001072 */
Willy Tarreau192252e2015-04-04 01:47:55 +02001073enum 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 +02001074{
1075 __label__ fetch_next;
1076 struct acl_term_suite *suite;
1077 struct acl_term *term;
1078 struct acl_expr *expr;
1079 struct acl *acl;
Willy Tarreau37406352012-04-23 16:16:37 +02001080 struct sample smp;
Willy Tarreau0cba6072013-11-28 22:21:02 +01001081 enum acl_test_res acl_res, suite_res, cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001082
Willy Tarreau7a777ed2012-04-26 11:44:02 +02001083 /* ACLs are iterated over all values, so let's always set the flag to
1084 * indicate this to the fetch functions.
1085 */
1086 opt |= SMP_OPT_ITERATE;
1087
Willy Tarreau11382812008-07-09 16:18:21 +02001088 /* We're doing a logical OR between conditions so we initialize to FAIL.
1089 * The MISS status is propagated down from the suites.
1090 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001091 cond_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001092 list_for_each_entry(suite, &cond->suites, list) {
Willy Tarreau11382812008-07-09 16:18:21 +02001093 /* Evaluate condition suite <suite>. We stop at the first term
Willy Tarreau0cba6072013-11-28 22:21:02 +01001094 * which returns ACL_TEST_FAIL. The MISS status is still propagated
Willy Tarreau11382812008-07-09 16:18:21 +02001095 * in case of uncertainty in the result.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001096 */
1097
1098 /* we're doing a logical AND between terms, so we must set the
1099 * initial value to PASS.
1100 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001101 suite_res = ACL_TEST_PASS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001102 list_for_each_entry(term, &suite->terms, list) {
1103 acl = term->acl;
1104
1105 /* FIXME: use cache !
1106 * check acl->cache_idx for this.
1107 */
1108
1109 /* ACL result not cached. Let's scan all the expressions
1110 * and use the first one to match.
1111 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001112 acl_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001113 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaud41f8d82007-06-10 10:06:18 +02001114 /* we need to reset context and flags */
Willy Tarreau37406352012-04-23 16:16:37 +02001115 memset(&smp, 0, sizeof(smp));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001116 fetch_next:
Willy Tarreau192252e2015-04-04 01:47:55 +02001117 if (!sample_process(px, sess, strm, opt, expr->smp, &smp)) {
Willy Tarreaub6866442008-07-14 23:54:42 +02001118 /* maybe we could not fetch because of missing data */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001119 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001120 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001121 continue;
Willy Tarreaub6866442008-07-14 23:54:42 +02001122 }
Willy Tarreauc4262962010-05-10 23:42:40 +02001123
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +01001124 acl_res |= pat2acl(pattern_exec_match(&expr->pat, &smp, 0));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001125 /*
Willy Tarreau11382812008-07-09 16:18:21 +02001126 * OK now acl_res holds the result of this expression
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001127 * as one of ACL_TEST_FAIL, ACL_TEST_MISS or ACL_TEST_PASS.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001128 *
Willy Tarreau11382812008-07-09 16:18:21 +02001129 * Then if (!MISS) we can cache the result, and put
Willy Tarreau37406352012-04-23 16:16:37 +02001130 * (smp.flags & SMP_F_VOLATILE) in the cache flags.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001131 *
1132 * FIXME: implement cache.
1133 *
1134 */
1135
Willy Tarreau11382812008-07-09 16:18:21 +02001136 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001137 if (acl_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001138 break;
1139
Willy Tarreau37406352012-04-23 16:16:37 +02001140 if (smp.flags & SMP_F_NOT_LAST)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001141 goto fetch_next;
Willy Tarreaub6866442008-07-14 23:54:42 +02001142
1143 /* sometimes we know the fetched data is subject to change
1144 * later and give another chance for a new match (eg: request
1145 * size, time, ...)
1146 */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001147 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001148 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001149 }
1150 /*
1151 * Here we have the result of an ACL (cached or not).
1152 * ACLs are combined, negated or not, to form conditions.
1153 */
1154
Willy Tarreaua84d3742007-05-07 00:36:48 +02001155 if (term->neg)
Willy Tarreau11382812008-07-09 16:18:21 +02001156 acl_res = acl_neg(acl_res);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001157
1158 suite_res &= acl_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001159
Willy Tarreau79c412b2013-10-30 19:30:32 +01001160 /* we're ANDing these terms, so a single FAIL or MISS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001161 if (suite_res != ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001162 break;
1163 }
1164 cond_res |= suite_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001165
1166 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001167 if (cond_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001168 break;
1169 }
Willy Tarreau11382812008-07-09 16:18:21 +02001170 return cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001171}
1172
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001173/* Returns a pointer to the first ACL conflicting with usage at place <where>
1174 * which is one of the SMP_VAL_* bits indicating a check place, or NULL if
1175 * no conflict is found. Only full conflicts are detected (ACL is not usable).
1176 * Use the next function to check for useless keywords.
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001177 */
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001178const struct acl *acl_cond_conflicts(const struct acl_cond *cond, unsigned int where)
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001179{
1180 struct acl_term_suite *suite;
1181 struct acl_term *term;
1182 struct acl *acl;
1183
1184 list_for_each_entry(suite, &cond->suites, list) {
1185 list_for_each_entry(term, &suite->terms, list) {
1186 acl = term->acl;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001187 if (!(acl->val & where))
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001188 return acl;
1189 }
1190 }
1191 return NULL;
1192}
1193
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001194/* Returns a pointer to the first ACL and its first keyword to conflict with
1195 * usage at place <where> which is one of the SMP_VAL_* bits indicating a check
1196 * place. Returns true if a conflict is found, with <acl> and <kw> set (if non
1197 * null), or false if not conflict is found. The first useless keyword is
1198 * returned.
1199 */
Willy Tarreau93fddf12013-03-31 22:59:32 +02001200int 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 +01001201{
1202 struct acl_term_suite *suite;
1203 struct acl_term *term;
1204 struct acl_expr *expr;
1205
1206 list_for_each_entry(suite, &cond->suites, list) {
1207 list_for_each_entry(term, &suite->terms, list) {
1208 list_for_each_entry(expr, &term->acl->expr, list) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001209 if (!(expr->smp->fetch->val & where)) {
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001210 if (acl)
1211 *acl = term->acl;
1212 if (kw)
1213 *kw = expr->kw;
1214 return 1;
1215 }
1216 }
1217 }
1218 }
1219 return 0;
1220}
1221
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001222/*
1223 * Find targets for userlist and groups in acl. Function returns the number
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001224 * of errors or OK if everything is fine. It must be called only once sample
1225 * fetch arguments have been resolved (after smp_resolve_args()).
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001226 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001227int acl_find_targets(struct proxy *p)
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001228{
1229
1230 struct acl *acl;
1231 struct acl_expr *expr;
Thierry FOURNIER3ead5b92013-12-13 12:12:18 +01001232 struct pattern_list *pattern;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001233 int cfgerr = 0;
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001234 struct pattern_expr_list *pexp;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001235
1236 list_for_each_entry(acl, &p->acl, list) {
1237 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001238 if (!strcmp(expr->kw, "http_auth_group")) {
1239 /* Note: the ARGT_USR argument may only have been resolved earlier
1240 * by smp_resolve_args().
1241 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001242 if (expr->smp->arg_p->unresolved) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001243 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 +02001244 p->id, *acl->name ? "" : "anonymous ", acl->name, expr->kw,
1245 expr->smp->arg_p->data.str.area);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001246 cfgerr++;
Willy Tarreau496aa012012-06-01 10:38:29 +02001247 continue;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001248 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001249
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001250 if (LIST_ISEMPTY(&expr->pat.head)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001251 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1252 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001253 cfgerr++;
1254 continue;
1255 }
1256
Thierry FOURNIER9eec0a62014-01-22 18:38:02 +01001257 /* For each pattern, check if the group exists. */
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001258 list_for_each_entry(pexp, &expr->pat.head, list) {
1259 if (LIST_ISEMPTY(&pexp->expr->patterns)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001260 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1261 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001262 cfgerr++;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001263 continue;
1264 }
1265
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001266 list_for_each_entry(pattern, &pexp->expr->patterns, list) {
1267 /* this keyword only has one argument */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001268 if (!check_group(expr->smp->arg_p->data.usr, pattern->pat.ptr.str)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001269 ha_alert("proxy %s: acl %s %s(): invalid group '%s'.\n",
1270 p->id, acl->name, expr->kw, pattern->pat.ptr.str);
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001271 cfgerr++;
1272 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001273 }
1274 }
1275 }
1276 }
1277 }
1278
1279 return cfgerr;
1280}
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001281
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001282/* initializes ACLs by resolving the sample fetch names they rely upon.
1283 * Returns 0 on success, otherwise an error.
1284 */
1285int init_acl()
1286{
1287 int err = 0;
1288 int index;
1289 const char *name;
1290 struct acl_kw_list *kwl;
1291 struct sample_fetch *smp;
1292
1293 list_for_each_entry(kwl, &acl_keywords.list, list) {
1294 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1295 name = kwl->kw[index].fetch_kw;
1296 if (!name)
1297 name = kwl->kw[index].kw;
1298
1299 smp = find_sample_fetch(name, strlen(name));
1300 if (!smp) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001301 ha_alert("Critical internal error: ACL keyword '%s' relies on sample fetch '%s' which was not registered!\n",
1302 kwl->kw[index].kw, name);
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001303 err++;
1304 continue;
1305 }
1306 kwl->kw[index].smp = smp;
1307 }
1308 }
1309 return err;
1310}
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001311
Willy Tarreaua84d3742007-05-07 00:36:48 +02001312/************************************************************************/
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001313/* All supported sample and ACL keywords must be declared here. */
1314/************************************************************************/
1315
1316/* Note: must not be declared <const> as its list will be overwritten.
Willy Tarreau61612d42012-04-19 18:42:05 +02001317 * Please take care of keeping this list alphabetically sorted.
1318 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001319static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001320 { /* END */ },
Willy Tarreaua84d3742007-05-07 00:36:48 +02001321}};
1322
Willy Tarreau0108d902018-11-25 19:14:37 +01001323INITCALL1(STG_REGISTER, acl_register_keywords, &acl_kws);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001324
1325/*
1326 * Local variables:
1327 * c-indent-level: 8
1328 * c-basic-offset: 8
1329 * End:
1330 */