blob: cf7dd91a9e5fddd5d595d3d43cb5e343b490269f [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 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100308 ha_free(&ckw);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200309 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100310 else {
311 /* This is not an ACL keyword, so we hope this is a sample fetch
312 * keyword that we're going to transparently use as an ACL. If
313 * so, we retrieve a completely parsed expression with args and
314 * convs already done.
315 */
Willy Tarreaue3b57bf2020-02-14 16:50:14 +0100316 smp = sample_parse_expr((char **)args, &idx, file, line, err, al, NULL);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100317 if (!smp) {
318 memprintf(err, "%s in ACL expression '%s'", *err, *args);
319 goto out_return;
320 }
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200321 cur_type = smp_expr_output_type(smp);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100322 }
323
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200324 expr = calloc(1, sizeof(*expr));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100325 if (!expr) {
326 memprintf(err, "out of memory when parsing ACL expression");
Christopher Faulet361935a2019-09-13 09:50:15 +0200327 goto out_free_smp;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100328 }
329
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100330 pattern_init_head(&expr->pat);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100331
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200332 expr->pat.expect_type = cur_type;
333 expr->smp = smp;
334 expr->kw = smp->fetch->kw;
335 smp = NULL; /* don't free it anymore */
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100336
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200337 if (aclkw && !acl_conv_found) {
338 expr->kw = aclkw->kw;
339 expr->pat.parse = aclkw->parse ? aclkw->parse : pat_parse_fcts[aclkw->match_type];
340 expr->pat.index = aclkw->index ? aclkw->index : pat_index_fcts[aclkw->match_type];
341 expr->pat.match = aclkw->match ? aclkw->match : pat_match_fcts[aclkw->match_type];
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200342 expr->pat.prune = aclkw->prune ? aclkw->prune : pat_prune_fcts[aclkw->match_type];
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100343 }
344
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100345 if (!expr->pat.parse) {
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200346 /* Parse/index/match functions depend on the expression type,
347 * so we have to map them now. Some types can be automatically
348 * converted.
349 */
350 switch (cur_type) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100351 case SMP_T_BOOL:
352 expr->pat.parse = pat_parse_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100353 expr->pat.index = pat_index_fcts[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100354 expr->pat.match = pat_match_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100355 expr->pat.prune = pat_prune_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100356 expr->pat.expect_type = pat_match_types[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100357 break;
358 case SMP_T_SINT:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100359 expr->pat.parse = pat_parse_fcts[PAT_MATCH_INT];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100360 expr->pat.index = pat_index_fcts[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100361 expr->pat.match = pat_match_fcts[PAT_MATCH_INT];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100362 expr->pat.prune = pat_prune_fcts[PAT_MATCH_INT];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100363 expr->pat.expect_type = pat_match_types[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100364 break;
Willy Tarreau78c5eec2019-04-19 11:45:20 +0200365 case SMP_T_ADDR:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100366 case SMP_T_IPV4:
367 case SMP_T_IPV6:
368 expr->pat.parse = pat_parse_fcts[PAT_MATCH_IP];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100369 expr->pat.index = pat_index_fcts[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100370 expr->pat.match = pat_match_fcts[PAT_MATCH_IP];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100371 expr->pat.prune = pat_prune_fcts[PAT_MATCH_IP];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100372 expr->pat.expect_type = pat_match_types[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100373 break;
Thierry FOURNIER9fefbd52014-05-11 15:15:00 +0200374 case SMP_T_STR:
375 expr->pat.parse = pat_parse_fcts[PAT_MATCH_STR];
376 expr->pat.index = pat_index_fcts[PAT_MATCH_STR];
377 expr->pat.match = pat_match_fcts[PAT_MATCH_STR];
Thierry FOURNIER9fefbd52014-05-11 15:15:00 +0200378 expr->pat.prune = pat_prune_fcts[PAT_MATCH_STR];
379 expr->pat.expect_type = pat_match_types[PAT_MATCH_STR];
380 break;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100381 }
382 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200383
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100384 /* Additional check to protect against common mistakes */
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100385 if (expr->pat.parse && cur_type != SMP_T_BOOL && !*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100386 ha_warning("parsing acl keyword '%s' :\n"
387 " no pattern to match against were provided, so this ACL will never match.\n"
388 " If this is what you intended, please add '--' to get rid of this warning.\n"
389 " If you intended to match only for existence, please use '-m found'.\n"
390 " If you wanted to force an int to match as a bool, please use '-m bool'.\n"
391 "\n",
392 args[0]);
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100393 }
394
Willy Tarreaua84d3742007-05-07 00:36:48 +0200395 args++;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200396
397 /* check for options before patterns. Supported options are :
398 * -i : ignore case for all patterns by default
399 * -f : read patterns from those files
Willy Tarreau5adeda12013-03-31 22:13:34 +0200400 * -m : force matching method (must be used before -f)
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100401 * -M : load the file as map file
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100402 * -u : force the unique id of the acl
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200403 * -- : everything after this is not an option
404 */
Christopher Faulet54ceb042017-06-14 14:41:33 +0200405 refflags = PAT_REF_ACL;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200406 patflags = 0;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100407 is_loaded = 0;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100408 unique_id = -1;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200409 while (**args == '-') {
Willy Tarreau2039bba2014-05-11 09:43:46 +0200410 if (strcmp(*args, "-i") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200411 patflags |= PAT_MF_IGNORE_CASE;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200412 else if (strcmp(*args, "-n") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200413 patflags |= PAT_MF_NO_DNS;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200414 else if (strcmp(*args, "-u") == 0) {
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100415 unique_id = strtol(args[1], &error, 10);
416 if (*error != '\0') {
417 memprintf(err, "the argument of -u must be an integer");
418 goto out_free_expr;
419 }
420
421 /* Check if this id is really unique. */
422 if (pat_ref_lookupid(unique_id)) {
423 memprintf(err, "the id is already used");
424 goto out_free_expr;
425 }
426
427 args++;
428 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200429 else if (strcmp(*args, "-f") == 0) {
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100430 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200431 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 +0200432 goto out_free_expr;
433 }
434
Christopher Faulet54ceb042017-06-14 14:41:33 +0200435 if (!pattern_read_from_file(&expr->pat, refflags, args[1], patflags, load_as_map, err, file, line))
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200436 goto out_free_expr;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100437 is_loaded = 1;
Willy Tarreau5adeda12013-03-31 22:13:34 +0200438 args++;
439 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200440 else if (strcmp(*args, "-m") == 0) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200441 int idx;
442
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100443 if (is_loaded) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200444 memprintf(err, "'-m' must only be specified before patterns and files in parsing ACL expression");
445 goto out_free_expr;
446 }
447
Willy Tarreau6f8fe312013-11-28 22:24:25 +0100448 idx = pat_find_match_name(args[1]);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200449 if (idx < 0) {
450 memprintf(err, "unknown matching method '%s' when parsing ACL expression", args[1]);
451 goto out_free_expr;
452 }
453
454 /* Note: -m found is always valid, bool/int are compatible, str/bin/reg/len are compatible */
Willy Tarreau9bb49f62015-09-24 16:37:12 +0200455 if (idx != PAT_MATCH_FOUND && !sample_casts[cur_type][pat_match_types[idx]]) {
Willy Tarreau93fddf12013-03-31 22:59:32 +0200456 memprintf(err, "matching method '%s' cannot be used with fetch keyword '%s'", args[1], expr->kw);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200457 goto out_free_expr;
458 }
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100459 expr->pat.parse = pat_parse_fcts[idx];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100460 expr->pat.index = pat_index_fcts[idx];
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100461 expr->pat.match = pat_match_fcts[idx];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100462 expr->pat.prune = pat_prune_fcts[idx];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100463 expr->pat.expect_type = pat_match_types[idx];
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200464 args++;
465 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200466 else if (strcmp(*args, "-M") == 0) {
Christopher Faulet54ceb042017-06-14 14:41:33 +0200467 refflags |= PAT_REF_MAP;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100468 load_as_map = 1;
469 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200470 else if (strcmp(*args, "--") == 0) {
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200471 args++;
472 break;
473 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200474 else {
475 memprintf(err, "'%s' is not a valid ACL option. Please use '--' before any pattern beginning with a '-'", args[0]);
476 goto out_free_expr;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200477 break;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200478 }
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200479 args++;
480 }
481
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100482 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200483 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 +0200484 goto out_free_expr;
485 }
486
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100487 /* Create displayed reference */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200488 snprintf(trash.area, trash.size, "acl '%s' file '%s' line %d",
489 expr->kw, file, line);
490 trash.area[trash.size - 1] = '\0';
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100491
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500492 /* Create new pattern reference. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200493 ref = pat_ref_newid(unique_id, trash.area, PAT_REF_ACL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100494 if (!ref) {
495 memprintf(err, "memory error");
496 goto out_free_expr;
497 }
498
499 /* Create new pattern expression associated to this reference. */
Emeric Brun7d27f3c2017-07-03 17:54:23 +0200500 pattern_expr = pattern_new_expr(&expr->pat, ref, patflags, err, NULL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100501 if (!pattern_expr)
502 goto out_free_expr;
503
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200504 /* now parse all patterns */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100505 while (**args) {
506 arg = *args;
507
508 /* Compatibility layer. Each pattern can parse only one string per pattern,
509 * but the pat_parser_int() and pat_parse_dotted_ver() parsers were need
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500510 * optionally two operators. The first operator is the match method: eq,
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100511 * le, lt, ge and gt. pat_parse_int() and pat_parse_dotted_ver() functions
512 * can have a compatibility syntax based on ranges:
513 *
514 * pat_parse_int():
515 *
516 * "eq x" -> "x" or "x:x"
517 * "le x" -> ":x"
518 * "lt x" -> ":y" (with y = x - 1)
519 * "ge x" -> "x:"
520 * "gt x" -> "y:" (with y = x + 1)
521 *
522 * pat_parse_dotted_ver():
523 *
524 * "eq x.y" -> "x.y" or "x.y:x.y"
525 * "le x.y" -> ":x.y"
526 * "lt x.y" -> ":w.z" (with w.z = x.y - 1)
527 * "ge x.y" -> "x.y:"
528 * "gt x.y" -> "w.z:" (with w.z = x.y + 1)
529 *
530 * If y is not present, assume that is "0".
531 *
532 * The syntax eq, le, lt, ge and gt are proper to the acl syntax. The
533 * following block of code detect the operator, and rewrite each value
534 * in parsable string.
535 */
536 if (expr->pat.parse == pat_parse_int ||
537 expr->pat.parse == pat_parse_dotted_ver) {
538 /* Check for operator. If the argument is operator, memorise it and
539 * continue to the next argument.
540 */
541 op = get_std_op(arg);
542 if (op != -1) {
543 operator = op;
544 args++;
545 continue;
546 }
547
548 /* Check if the pattern contain ':' or '-' character. */
549 contain_colon = (strchr(arg, ':') || strchr(arg, '-'));
550
551 /* If the pattern contain ':' or '-' character, give it to the parser as is.
552 * If no contain ':' and operator is STD_OP_EQ, give it to the parser as is.
553 * In other case, try to convert the value according with the operator.
554 */
555 if (!contain_colon && operator != STD_OP_EQ) {
556 /* Search '.' separator. */
557 dot = strchr(arg, '.');
558 if (!dot) {
559 have_dot = 0;
560 minor = 0;
561 dot = arg + strlen(arg);
562 }
563 else
564 have_dot = 1;
565
566 /* convert the integer minor part for the pat_parse_dotted_ver() function. */
567 if (expr->pat.parse == pat_parse_dotted_ver && have_dot) {
568 if (strl2llrc(dot+1, strlen(dot+1), &minor) != 0) {
569 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100570 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100571 }
572 if (minor >= 65536) {
573 memprintf(err, "'%s' contains too large a minor value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100574 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100575 }
576 }
577
578 /* convert the integer value for the pat_parse_int() function, and the
579 * integer major part for the pat_parse_dotted_ver() function.
580 */
581 if (strl2llrc(arg, dot - arg, &value) != 0) {
582 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100583 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100584 }
585 if (expr->pat.parse == pat_parse_dotted_ver) {
586 if (value >= 65536) {
587 memprintf(err, "'%s' contains too large a major value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100588 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100589 }
590 value = (value << 16) | (minor & 0xffff);
591 }
592
593 switch (operator) {
594
595 case STD_OP_EQ: /* this case is not possible. */
596 memprintf(err, "internal error");
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100597 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100598
599 case STD_OP_GT:
600 value++; /* gt = ge + 1 */
Tim Duesterhus588b3142020-05-29 14:35:51 +0200601 /* fall through */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100602
603 case STD_OP_GE:
604 if (expr->pat.parse == pat_parse_int)
605 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld:", value);
606 else
607 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld.%lld:",
608 value >> 16, value & 0xffff);
609 arg = buffer;
610 break;
611
612 case STD_OP_LT:
613 value--; /* lt = le - 1 */
Tim Duesterhus588b3142020-05-29 14:35:51 +0200614 /* fall through */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100615
616 case STD_OP_LE:
617 if (expr->pat.parse == pat_parse_int)
618 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld", value);
619 else
620 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld.%lld",
621 value >> 16, value & 0xffff);
622 arg = buffer;
623 break;
624 }
625 }
626 }
627
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100628 /* Add sample to the reference, and try to compile it fior each pattern
629 * using this value.
630 */
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200631 if (!pat_ref_add(ref, arg, NULL, err))
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100632 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100633 args++;
634 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200635
636 return expr;
637
Willy Tarreaua84d3742007-05-07 00:36:48 +0200638 out_free_expr:
639 prune_acl_expr(expr);
640 free(expr);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100641 out_free_smp:
Christopher Faulet361935a2019-09-13 09:50:15 +0200642 free(ckw);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100643 free(smp);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200644 out_return:
645 return NULL;
646}
647
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200648/* Purge everything in the acl <acl>, then return <acl>. */
649struct acl *prune_acl(struct acl *acl) {
650
651 struct acl_expr *expr, *exprb;
652
653 free(acl->name);
654
655 list_for_each_entry_safe(expr, exprb, &acl->expr, list) {
656 LIST_DEL(&expr->list);
657 prune_acl_expr(expr);
658 free(expr);
659 }
660
661 return acl;
662}
663
Willy Tarreaua84d3742007-05-07 00:36:48 +0200664/* Parse an ACL with the name starting at <args>[0], and with a list of already
665 * known ACLs in <acl>. If the ACL was not in the list, it will be added.
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100666 * A pointer to that ACL is returned. If the ACL has an empty name, then it's
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200667 * an anonymous one and it won't be merged with any other one. If <err> is not
668 * NULL, it will be filled with an appropriate error. This pointer must be
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200669 * freeable or NULL. <al> is the arg_list serving as a head for unresolved
670 * dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200671 *
672 * args syntax: <aclname> <acl_expr>
673 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100674struct acl *parse_acl(const char **args, struct list *known_acl, char **err, struct arg_list *al,
675 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200676{
677 __label__ out_return, out_free_acl_expr, out_free_name;
678 struct acl *cur_acl;
679 struct acl_expr *acl_expr;
680 char *name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200681 const char *pos;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200682
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200683 if (**args && (pos = invalid_char(*args))) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200684 memprintf(err, "invalid character in ACL name : '%c'", *pos);
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100685 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200686 }
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100687
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100688 acl_expr = parse_acl_expr(args + 1, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200689 if (!acl_expr) {
690 /* parse_acl_expr will have filled <err> here */
Willy Tarreaua84d3742007-05-07 00:36:48 +0200691 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200692 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200693
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200694 /* Check for args beginning with an opening parenthesis just after the
695 * subject, as this is almost certainly a typo. Right now we can only
696 * emit a warning, so let's do so.
697 */
Krzysztof Piotr Oledzki4cdd8312009-10-05 00:23:35 +0200698 if (!strchr(args[1], '(') && *args[2] == '(')
Christopher Faulet767a84b2017-11-24 16:50:31 +0100699 ha_warning("parsing acl '%s' :\n"
700 " matching '%s' for pattern '%s' is likely a mistake and probably\n"
701 " not what you want. Maybe you need to remove the extraneous space before '('.\n"
702 " If you are really sure this is not an error, please insert '--' between the\n"
703 " match and the pattern to make this warning message disappear.\n",
704 args[0], args[1], args[2]);
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200705
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100706 if (*args[0])
707 cur_acl = find_acl_by_name(args[0], known_acl);
708 else
709 cur_acl = NULL;
710
Willy Tarreaua84d3742007-05-07 00:36:48 +0200711 if (!cur_acl) {
712 name = strdup(args[0]);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200713 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200714 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200715 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200716 }
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200717 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200718 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200719 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200720 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200721 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200722
723 LIST_INIT(&cur_acl->expr);
724 LIST_ADDQ(known_acl, &cur_acl->list);
725 cur_acl->name = name;
726 }
727
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100728 /* We want to know what features the ACL needs (typically HTTP parsing),
729 * and where it may be used. If an ACL relies on multiple matches, it is
730 * OK if at least one of them may match in the context where it is used.
731 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100732 cur_acl->use |= acl_expr->smp->fetch->use;
733 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200734 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
735 return cur_acl;
736
737 out_free_name:
738 free(name);
739 out_free_acl_expr:
740 prune_acl_expr(acl_expr);
741 free(acl_expr);
742 out_return:
743 return NULL;
744}
745
Willy Tarreau16fbe822007-06-17 11:54:31 +0200746/* Some useful ACLs provided by default. Only those used are allocated. */
747
748const struct {
749 const char *name;
750 const char *expr[4]; /* put enough for longest expression */
751} default_acl_list[] = {
Willy Tarreau58393e12008-07-20 10:39:22 +0200752 { .name = "TRUE", .expr = {"always_true",""}},
753 { .name = "FALSE", .expr = {"always_false",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200754 { .name = "LOCALHOST", .expr = {"src","127.0.0.1/8",""}},
Willy Tarreau2492d5b2009-07-11 00:06:00 +0200755 { .name = "HTTP", .expr = {"req_proto_http",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200756 { .name = "HTTP_1.0", .expr = {"req_ver","1.0",""}},
757 { .name = "HTTP_1.1", .expr = {"req_ver","1.1",""}},
758 { .name = "METH_CONNECT", .expr = {"method","CONNECT",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200759 { .name = "METH_DELETE", .expr = {"method","DELETE",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200760 { .name = "METH_GET", .expr = {"method","GET","HEAD",""}},
761 { .name = "METH_HEAD", .expr = {"method","HEAD",""}},
762 { .name = "METH_OPTIONS", .expr = {"method","OPTIONS",""}},
763 { .name = "METH_POST", .expr = {"method","POST",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200764 { .name = "METH_PUT", .expr = {"method","PUT",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200765 { .name = "METH_TRACE", .expr = {"method","TRACE",""}},
766 { .name = "HTTP_URL_ABS", .expr = {"url_reg","^[^/:]*://",""}},
767 { .name = "HTTP_URL_SLASH", .expr = {"url_beg","/",""}},
768 { .name = "HTTP_URL_STAR", .expr = {"url","*",""}},
769 { .name = "HTTP_CONTENT", .expr = {"hdr_val(content-length)","gt","0",""}},
Emeric Brunbede3d02009-06-30 17:54:00 +0200770 { .name = "RDP_COOKIE", .expr = {"req_rdp_cookie_cnt","gt","0",""}},
Willy Tarreauc6317702008-07-20 09:29:50 +0200771 { .name = "REQ_CONTENT", .expr = {"req_len","gt","0",""}},
Willy Tarreaub6fb4202008-07-20 11:18:28 +0200772 { .name = "WAIT_END", .expr = {"wait_end",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200773 { .name = NULL, .expr = {""}}
774};
775
776/* Find a default ACL from the default_acl list, compile it and return it.
777 * If the ACL is not found, NULL is returned. In theory, it cannot fail,
778 * except when default ACLs are broken, in which case it will return NULL.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200779 * If <known_acl> is not NULL, the ACL will be queued at its tail. If <err> is
780 * not NULL, it will be filled with an error message if an error occurs. This
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200781 * pointer must be freeable or NULL. <al> is an arg_list serving as a list head
782 * to report missing dependencies.
Willy Tarreau16fbe822007-06-17 11:54:31 +0200783 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200784static struct acl *find_acl_default(const char *acl_name, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100785 char **err, struct arg_list *al,
786 const char *file, int line)
Willy Tarreau16fbe822007-06-17 11:54:31 +0200787{
788 __label__ out_return, out_free_acl_expr, out_free_name;
789 struct acl *cur_acl;
790 struct acl_expr *acl_expr;
791 char *name;
792 int index;
793
794 for (index = 0; default_acl_list[index].name != NULL; index++) {
795 if (strcmp(acl_name, default_acl_list[index].name) == 0)
796 break;
797 }
798
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200799 if (default_acl_list[index].name == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200800 memprintf(err, "no such ACL : '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200801 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200802 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200803
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100804 acl_expr = parse_acl_expr((const char **)default_acl_list[index].expr, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200805 if (!acl_expr) {
806 /* parse_acl_expr must have filled err here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200807 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200808 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200809
810 name = strdup(acl_name);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200811 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200812 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200813 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200814 }
815
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200816 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200817 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200818 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200819 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200820 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200821
822 cur_acl->name = name;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100823 cur_acl->use |= acl_expr->smp->fetch->use;
824 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreau16fbe822007-06-17 11:54:31 +0200825 LIST_INIT(&cur_acl->expr);
826 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
827 if (known_acl)
828 LIST_ADDQ(known_acl, &cur_acl->list);
829
830 return cur_acl;
831
832 out_free_name:
833 free(name);
834 out_free_acl_expr:
835 prune_acl_expr(acl_expr);
836 free(acl_expr);
837 out_return:
838 return NULL;
839}
Willy Tarreaua84d3742007-05-07 00:36:48 +0200840
841/* Purge everything in the acl_cond <cond>, then return <cond>. */
842struct acl_cond *prune_acl_cond(struct acl_cond *cond)
843{
844 struct acl_term_suite *suite, *tmp_suite;
845 struct acl_term *term, *tmp_term;
846
847 /* iterate through all term suites and free all terms and all suites */
848 list_for_each_entry_safe(suite, tmp_suite, &cond->suites, list) {
849 list_for_each_entry_safe(term, tmp_term, &suite->terms, list)
850 free(term);
851 free(suite);
852 }
853 return cond;
854}
855
856/* Parse an ACL condition starting at <args>[0], relying on a list of already
857 * known ACLs passed in <known_acl>. The new condition is returned (or NULL in
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200858 * case of low memory). Supports multiple conditions separated by "or". If
859 * <err> is not NULL, it will be filled with a pointer to an error message in
860 * case of error, that the caller is responsible for freeing. The initial
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200861 * location must either be freeable or NULL. The list <al> serves as a list head
862 * for unresolved dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200863 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200864struct acl_cond *parse_acl_cond(const char **args, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100865 enum acl_cond_pol pol, char **err, struct arg_list *al,
866 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200867{
868 __label__ out_return, out_free_suite, out_free_term;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200869 int arg, neg;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200870 const char *word;
871 struct acl *cur_acl;
872 struct acl_term *cur_term;
873 struct acl_term_suite *cur_suite;
874 struct acl_cond *cond;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100875 unsigned int suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200876
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200877 cond = calloc(1, sizeof(*cond));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200878 if (cond == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200879 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200880 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200881 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200882
883 LIST_INIT(&cond->list);
884 LIST_INIT(&cond->suites);
885 cond->pol = pol;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100886 cond->val = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200887
888 cur_suite = NULL;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100889 suite_val = ~0U;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200890 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200891 for (arg = 0; *args[arg]; arg++) {
892 word = args[arg];
893
894 /* remove as many exclamation marks as we can */
895 while (*word == '!') {
896 neg = !neg;
897 word++;
898 }
899
900 /* an empty word is allowed because we cannot force the user to
901 * always think about not leaving exclamation marks alone.
902 */
903 if (!*word)
904 continue;
905
Willy Tarreau16fbe822007-06-17 11:54:31 +0200906 if (strcasecmp(word, "or") == 0 || strcmp(word, "||") == 0) {
Willy Tarreaua84d3742007-05-07 00:36:48 +0200907 /* new term suite */
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100908 cond->val |= suite_val;
909 suite_val = ~0U;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200910 cur_suite = NULL;
911 neg = 0;
912 continue;
913 }
914
Willy Tarreau95fa4692010-02-01 13:05:50 +0100915 if (strcmp(word, "{") == 0) {
916 /* we may have a complete ACL expression between two braces,
917 * find the last one.
918 */
919 int arg_end = arg + 1;
920 const char **args_new;
921
922 while (*args[arg_end] && strcmp(args[arg_end], "}") != 0)
923 arg_end++;
924
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200925 if (!*args[arg_end]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200926 memprintf(err, "missing closing '}' in condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100927 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200928 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100929
930 args_new = calloc(1, (arg_end - arg + 1) * sizeof(*args_new));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200931 if (!args_new) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200932 memprintf(err, "out of memory when parsing condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100933 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200934 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100935
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100936 args_new[0] = "";
Willy Tarreau95fa4692010-02-01 13:05:50 +0100937 memcpy(args_new + 1, args + arg + 1, (arg_end - arg) * sizeof(*args_new));
938 args_new[arg_end - arg] = "";
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100939 cur_acl = parse_acl(args_new, known_acl, err, al, file, line);
Willy Tarreau95fa4692010-02-01 13:05:50 +0100940 free(args_new);
941
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200942 if (!cur_acl) {
943 /* note that parse_acl() must have filled <err> here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200944 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200945 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100946 arg = arg_end;
947 }
948 else {
949 /* search for <word> in the known ACL names. If we do not find
950 * it, let's look for it in the default ACLs, and if found, add
951 * it to the list of ACLs of this proxy. This makes it possible
952 * to override them.
953 */
954 cur_acl = find_acl_by_name(word, known_acl);
955 if (cur_acl == NULL) {
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100956 cur_acl = find_acl_default(word, known_acl, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200957 if (cur_acl == NULL) {
958 /* note that find_acl_default() must have filled <err> here */
Willy Tarreau95fa4692010-02-01 13:05:50 +0100959 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200960 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100961 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200962 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200963
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200964 cur_term = calloc(1, sizeof(*cur_term));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200965 if (cur_term == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200966 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200967 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200968 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200969
970 cur_term->acl = cur_acl;
971 cur_term->neg = neg;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100972
973 /* Here it is a bit complex. The acl_term_suite is a conjunction
974 * of many terms. It may only be used if all of its terms are
975 * usable at the same time. So the suite's validity domain is an
976 * AND between all ACL keywords' ones. But, the global condition
977 * is valid if at least one term suite is OK. So it's an OR between
978 * all of their validity domains. We could emit a warning as soon
979 * as suite_val is null because it means that the last ACL is not
980 * compatible with the previous ones. Let's remain simple for now.
981 */
982 cond->use |= cur_acl->use;
983 suite_val &= cur_acl->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200984
985 if (!cur_suite) {
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200986 cur_suite = calloc(1, sizeof(*cur_suite));
Willy Tarreauf678b7f2013-01-24 00:25:39 +0100987 if (cur_suite == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200988 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200989 goto out_free_term;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200990 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200991 LIST_INIT(&cur_suite->terms);
992 LIST_ADDQ(&cond->suites, &cur_suite->list);
993 }
994 LIST_ADDQ(&cur_suite->terms, &cur_term->list);
Willy Tarreau74b98a82007-06-16 19:35:18 +0200995 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200996 }
997
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100998 cond->val |= suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200999 return cond;
1000
1001 out_free_term:
1002 free(cur_term);
1003 out_free_suite:
1004 prune_acl_cond(cond);
1005 free(cond);
1006 out_return:
1007 return NULL;
1008}
1009
Willy Tarreau2bbba412010-01-28 16:48:33 +01001010/* Builds an ACL condition starting at the if/unless keyword. The complete
1011 * condition is returned. NULL is returned in case of error or if the first
1012 * word is neither "if" nor "unless". It automatically sets the file name and
Willy Tarreau25320b22013-03-24 07:22:08 +01001013 * the line number in the condition for better error reporting, and sets the
1014 * HTTP intiailization requirements in the proxy. If <err> is not NULL, it will
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001015 * be filled with a pointer to an error message in case of error, that the
1016 * caller is responsible for freeing. The initial location must either be
1017 * freeable or NULL.
Willy Tarreau2bbba412010-01-28 16:48:33 +01001018 */
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001019struct acl_cond *build_acl_cond(const char *file, int line, struct list *known_acl,
1020 struct proxy *px, const char **args, char **err)
Willy Tarreau2bbba412010-01-28 16:48:33 +01001021{
Willy Tarreau0cba6072013-11-28 22:21:02 +01001022 enum acl_cond_pol pol = ACL_COND_NONE;
Willy Tarreau2bbba412010-01-28 16:48:33 +01001023 struct acl_cond *cond = NULL;
1024
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001025 if (err)
1026 *err = NULL;
1027
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001028 if (strcmp(*args, "if") == 0) {
Willy Tarreau2bbba412010-01-28 16:48:33 +01001029 pol = ACL_COND_IF;
1030 args++;
1031 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001032 else if (strcmp(*args, "unless") == 0) {
Willy Tarreau2bbba412010-01-28 16:48:33 +01001033 pol = ACL_COND_UNLESS;
1034 args++;
1035 }
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001036 else {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001037 memprintf(err, "conditions must start with either 'if' or 'unless'");
Willy Tarreau2bbba412010-01-28 16:48:33 +01001038 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001039 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001040
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001041 cond = parse_acl_cond(args, known_acl, pol, err, &px->conf.args, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001042 if (!cond) {
1043 /* note that parse_acl_cond must have filled <err> here */
Willy Tarreau2bbba412010-01-28 16:48:33 +01001044 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001045 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001046
1047 cond->file = file;
1048 cond->line = line;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001049 px->http_needed |= !!(cond->use & SMP_USE_HTTP_ANY);
Willy Tarreau2bbba412010-01-28 16:48:33 +01001050 return cond;
1051}
1052
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001053/* Execute condition <cond> and return either ACL_TEST_FAIL, ACL_TEST_MISS or
1054 * ACL_TEST_PASS depending on the test results. ACL_TEST_MISS may only be
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001055 * returned if <opt> does not contain SMP_OPT_FINAL, indicating that incomplete
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001056 * data is being examined. The function automatically sets SMP_OPT_ITERATE. This
1057 * function only computes the condition, it does not apply the polarity required
1058 * by IF/UNLESS, it's up to the caller to do this using something like this :
Willy Tarreau11382812008-07-09 16:18:21 +02001059 *
1060 * res = acl_pass(res);
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001061 * if (res == ACL_TEST_MISS)
Willy Tarreaub6866442008-07-14 23:54:42 +02001062 * return 0;
Willy Tarreau11382812008-07-09 16:18:21 +02001063 * if (cond->pol == ACL_COND_UNLESS)
1064 * res = !res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001065 */
Willy Tarreau192252e2015-04-04 01:47:55 +02001066enum 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 +02001067{
1068 __label__ fetch_next;
1069 struct acl_term_suite *suite;
1070 struct acl_term *term;
1071 struct acl_expr *expr;
1072 struct acl *acl;
Willy Tarreau37406352012-04-23 16:16:37 +02001073 struct sample smp;
Willy Tarreau0cba6072013-11-28 22:21:02 +01001074 enum acl_test_res acl_res, suite_res, cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001075
Willy Tarreau7a777ed2012-04-26 11:44:02 +02001076 /* ACLs are iterated over all values, so let's always set the flag to
1077 * indicate this to the fetch functions.
1078 */
1079 opt |= SMP_OPT_ITERATE;
1080
Willy Tarreau11382812008-07-09 16:18:21 +02001081 /* We're doing a logical OR between conditions so we initialize to FAIL.
1082 * The MISS status is propagated down from the suites.
1083 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001084 cond_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001085 list_for_each_entry(suite, &cond->suites, list) {
Willy Tarreau11382812008-07-09 16:18:21 +02001086 /* Evaluate condition suite <suite>. We stop at the first term
Willy Tarreau0cba6072013-11-28 22:21:02 +01001087 * which returns ACL_TEST_FAIL. The MISS status is still propagated
Willy Tarreau11382812008-07-09 16:18:21 +02001088 * in case of uncertainty in the result.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001089 */
1090
1091 /* we're doing a logical AND between terms, so we must set the
1092 * initial value to PASS.
1093 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001094 suite_res = ACL_TEST_PASS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001095 list_for_each_entry(term, &suite->terms, list) {
1096 acl = term->acl;
1097
1098 /* FIXME: use cache !
1099 * check acl->cache_idx for this.
1100 */
1101
1102 /* ACL result not cached. Let's scan all the expressions
1103 * and use the first one to match.
1104 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001105 acl_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001106 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaud41f8d82007-06-10 10:06:18 +02001107 /* we need to reset context and flags */
Willy Tarreau37406352012-04-23 16:16:37 +02001108 memset(&smp, 0, sizeof(smp));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001109 fetch_next:
Willy Tarreau192252e2015-04-04 01:47:55 +02001110 if (!sample_process(px, sess, strm, opt, expr->smp, &smp)) {
Willy Tarreaub6866442008-07-14 23:54:42 +02001111 /* maybe we could not fetch because of missing data */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001112 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001113 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001114 continue;
Willy Tarreaub6866442008-07-14 23:54:42 +02001115 }
Willy Tarreauc4262962010-05-10 23:42:40 +02001116
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +01001117 acl_res |= pat2acl(pattern_exec_match(&expr->pat, &smp, 0));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001118 /*
Willy Tarreau11382812008-07-09 16:18:21 +02001119 * OK now acl_res holds the result of this expression
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001120 * as one of ACL_TEST_FAIL, ACL_TEST_MISS or ACL_TEST_PASS.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001121 *
Willy Tarreau11382812008-07-09 16:18:21 +02001122 * Then if (!MISS) we can cache the result, and put
Willy Tarreau37406352012-04-23 16:16:37 +02001123 * (smp.flags & SMP_F_VOLATILE) in the cache flags.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001124 *
1125 * FIXME: implement cache.
1126 *
1127 */
1128
Willy Tarreau11382812008-07-09 16:18:21 +02001129 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001130 if (acl_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001131 break;
1132
Willy Tarreau37406352012-04-23 16:16:37 +02001133 if (smp.flags & SMP_F_NOT_LAST)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001134 goto fetch_next;
Willy Tarreaub6866442008-07-14 23:54:42 +02001135
1136 /* sometimes we know the fetched data is subject to change
1137 * later and give another chance for a new match (eg: request
1138 * size, time, ...)
1139 */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001140 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001141 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001142 }
1143 /*
1144 * Here we have the result of an ACL (cached or not).
1145 * ACLs are combined, negated or not, to form conditions.
1146 */
1147
Willy Tarreaua84d3742007-05-07 00:36:48 +02001148 if (term->neg)
Willy Tarreau11382812008-07-09 16:18:21 +02001149 acl_res = acl_neg(acl_res);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001150
1151 suite_res &= acl_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001152
Willy Tarreau79c412b2013-10-30 19:30:32 +01001153 /* we're ANDing these terms, so a single FAIL or MISS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001154 if (suite_res != ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001155 break;
1156 }
1157 cond_res |= suite_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001158
1159 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001160 if (cond_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001161 break;
1162 }
Willy Tarreau11382812008-07-09 16:18:21 +02001163 return cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001164}
1165
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001166/* Returns a pointer to the first ACL conflicting with usage at place <where>
1167 * which is one of the SMP_VAL_* bits indicating a check place, or NULL if
1168 * no conflict is found. Only full conflicts are detected (ACL is not usable).
1169 * Use the next function to check for useless keywords.
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001170 */
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001171const struct acl *acl_cond_conflicts(const struct acl_cond *cond, unsigned int where)
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001172{
1173 struct acl_term_suite *suite;
1174 struct acl_term *term;
1175 struct acl *acl;
1176
1177 list_for_each_entry(suite, &cond->suites, list) {
1178 list_for_each_entry(term, &suite->terms, list) {
1179 acl = term->acl;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001180 if (!(acl->val & where))
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001181 return acl;
1182 }
1183 }
1184 return NULL;
1185}
1186
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001187/* Returns a pointer to the first ACL and its first keyword to conflict with
1188 * usage at place <where> which is one of the SMP_VAL_* bits indicating a check
1189 * place. Returns true if a conflict is found, with <acl> and <kw> set (if non
1190 * null), or false if not conflict is found. The first useless keyword is
1191 * returned.
1192 */
Willy Tarreau93fddf12013-03-31 22:59:32 +02001193int 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 +01001194{
1195 struct acl_term_suite *suite;
1196 struct acl_term *term;
1197 struct acl_expr *expr;
1198
1199 list_for_each_entry(suite, &cond->suites, list) {
1200 list_for_each_entry(term, &suite->terms, list) {
1201 list_for_each_entry(expr, &term->acl->expr, list) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001202 if (!(expr->smp->fetch->val & where)) {
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001203 if (acl)
1204 *acl = term->acl;
1205 if (kw)
1206 *kw = expr->kw;
1207 return 1;
1208 }
1209 }
1210 }
1211 }
1212 return 0;
1213}
1214
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001215/*
1216 * Find targets for userlist and groups in acl. Function returns the number
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001217 * of errors or OK if everything is fine. It must be called only once sample
1218 * fetch arguments have been resolved (after smp_resolve_args()).
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001219 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001220int acl_find_targets(struct proxy *p)
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001221{
1222
1223 struct acl *acl;
1224 struct acl_expr *expr;
Thierry FOURNIER3ead5b92013-12-13 12:12:18 +01001225 struct pattern_list *pattern;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001226 int cfgerr = 0;
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001227 struct pattern_expr_list *pexp;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001228
1229 list_for_each_entry(acl, &p->acl, list) {
1230 list_for_each_entry(expr, &acl->expr, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001231 if (strcmp(expr->kw, "http_auth_group") == 0) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001232 /* Note: the ARGT_USR argument may only have been resolved earlier
1233 * by smp_resolve_args().
1234 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001235 if (expr->smp->arg_p->unresolved) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001236 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 +02001237 p->id, *acl->name ? "" : "anonymous ", acl->name, expr->kw,
1238 expr->smp->arg_p->data.str.area);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001239 cfgerr++;
Willy Tarreau496aa012012-06-01 10:38:29 +02001240 continue;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001241 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001242
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001243 if (LIST_ISEMPTY(&expr->pat.head)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001244 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1245 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001246 cfgerr++;
1247 continue;
1248 }
1249
Thierry FOURNIER9eec0a62014-01-22 18:38:02 +01001250 /* For each pattern, check if the group exists. */
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001251 list_for_each_entry(pexp, &expr->pat.head, list) {
1252 if (LIST_ISEMPTY(&pexp->expr->patterns)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001253 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1254 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001255 cfgerr++;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001256 continue;
1257 }
1258
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001259 list_for_each_entry(pattern, &pexp->expr->patterns, list) {
1260 /* this keyword only has one argument */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001261 if (!check_group(expr->smp->arg_p->data.usr, pattern->pat.ptr.str)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001262 ha_alert("proxy %s: acl %s %s(): invalid group '%s'.\n",
1263 p->id, acl->name, expr->kw, pattern->pat.ptr.str);
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001264 cfgerr++;
1265 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001266 }
1267 }
1268 }
1269 }
1270 }
1271
1272 return cfgerr;
1273}
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001274
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001275/* initializes ACLs by resolving the sample fetch names they rely upon.
1276 * Returns 0 on success, otherwise an error.
1277 */
1278int init_acl()
1279{
1280 int err = 0;
1281 int index;
1282 const char *name;
1283 struct acl_kw_list *kwl;
1284 struct sample_fetch *smp;
1285
1286 list_for_each_entry(kwl, &acl_keywords.list, list) {
1287 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1288 name = kwl->kw[index].fetch_kw;
1289 if (!name)
1290 name = kwl->kw[index].kw;
1291
1292 smp = find_sample_fetch(name, strlen(name));
1293 if (!smp) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001294 ha_alert("Critical internal error: ACL keyword '%s' relies on sample fetch '%s' which was not registered!\n",
1295 kwl->kw[index].kw, name);
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001296 err++;
1297 continue;
1298 }
1299 kwl->kw[index].smp = smp;
1300 }
1301 }
1302 return err;
1303}
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001304
Willy Tarreaua84d3742007-05-07 00:36:48 +02001305/************************************************************************/
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001306/* All supported sample and ACL keywords must be declared here. */
1307/************************************************************************/
1308
1309/* Note: must not be declared <const> as its list will be overwritten.
Willy Tarreau61612d42012-04-19 18:42:05 +02001310 * Please take care of keeping this list alphabetically sorted.
1311 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001312static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001313 { /* END */ },
Willy Tarreaua84d3742007-05-07 00:36:48 +02001314}};
1315
Willy Tarreau0108d902018-11-25 19:14:37 +01001316INITCALL1(STG_REGISTER, acl_register_keywords, &acl_kws);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001317
1318/*
1319 * Local variables:
1320 * c-indent-level: 8
1321 * c-basic-offset: 8
1322 * End:
1323 */