blob: b598088ad14014d665d82917e68fab58f25fd46d [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
17#include <common/config.h>
Willy Tarreau0108d902018-11-25 19:14:37 +010018#include <common/initcall.h>
Willy Tarreaua84d3742007-05-07 00:36:48 +020019#include <common/mini-clist.h>
20#include <common/standard.h>
Krzysztof Piotr Oledzki8c8bd452010-01-29 19:29:32 +010021#include <common/uri_auth.h>
Willy Tarreaua84d3742007-05-07 00:36:48 +020022
Willy Tarreau2b5285d2010-05-09 23:45:24 +020023#include <types/global.h>
24
Willy Tarreaua84d3742007-05-07 00:36:48 +020025#include <proto/acl.h>
Willy Tarreau34db1082012-04-19 17:16:54 +020026#include <proto/arg.h>
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +010027#include <proto/auth.h>
Willy Tarreauc7e42382012-08-24 19:22:53 +020028#include <proto/channel.h>
Willy Tarreau404e8ab2009-07-26 19:40:40 +020029#include <proto/log.h>
Thierry FOURNIERed66c292013-11-28 11:05:19 +010030#include <proto/pattern.h>
Willy Tarreau0b1cd942010-05-16 22:18:27 +020031#include <proto/proxy.h>
Willy Tarreau8ed669b2013-01-11 15:49:37 +010032#include <proto/sample.h>
Willy Tarreaud28c3532012-04-19 19:28:33 +020033#include <proto/stick_table.h>
Willy Tarreaua84d3742007-05-07 00:36:48 +020034
Willy Tarreauc4262962010-05-10 23:42:40 +020035#include <ebsttree.h>
36
Willy Tarreaua84d3742007-05-07 00:36:48 +020037/* List head of all known ACL keywords */
38static struct acl_kw_list acl_keywords = {
39 .list = LIST_HEAD_INIT(acl_keywords.list)
40};
41
Willy Tarreau0cba6072013-11-28 22:21:02 +010042/* input values are 0 or 3, output is the same */
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +010043static inline enum acl_test_res pat2acl(struct pattern *pat)
Willy Tarreau0cba6072013-11-28 22:21:02 +010044{
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +010045 if (pat)
46 return ACL_TEST_PASS;
47 else
48 return ACL_TEST_FAIL;
Willy Tarreau0cba6072013-11-28 22:21:02 +010049}
50
Willy Tarreaua5909832007-06-17 20:40:25 +020051/*
Willy Tarreaua84d3742007-05-07 00:36:48 +020052 * Registers the ACL keyword list <kwl> as a list of valid keywords for next
53 * parsing sessions.
54 */
55void acl_register_keywords(struct acl_kw_list *kwl)
56{
57 LIST_ADDQ(&acl_keywords.list, &kwl->list);
58}
59
60/*
61 * Unregisters the ACL keyword list <kwl> from the list of valid keywords.
62 */
63void acl_unregister_keywords(struct acl_kw_list *kwl)
64{
65 LIST_DEL(&kwl->list);
66 LIST_INIT(&kwl->list);
67}
68
69/* Return a pointer to the ACL <name> within the list starting at <head>, or
70 * NULL if not found.
71 */
72struct acl *find_acl_by_name(const char *name, struct list *head)
73{
74 struct acl *acl;
75 list_for_each_entry(acl, head, list) {
76 if (strcmp(acl->name, name) == 0)
77 return acl;
78 }
79 return NULL;
80}
81
82/* Return a pointer to the ACL keyword <kw>, or NULL if not found. Note that if
Willy Tarreau4bfa4222013-12-16 22:01:06 +010083 * <kw> contains an opening parenthesis or a comma, only the left part of it is
84 * checked.
Willy Tarreaua84d3742007-05-07 00:36:48 +020085 */
86struct acl_keyword *find_acl_kw(const char *kw)
87{
88 int index;
89 const char *kwend;
90 struct acl_kw_list *kwl;
91
Willy Tarreau4bfa4222013-12-16 22:01:06 +010092 kwend = kw;
93 while (*kwend && *kwend != '(' && *kwend != ',')
94 kwend++;
Willy Tarreaua84d3742007-05-07 00:36:48 +020095
96 list_for_each_entry(kwl, &acl_keywords.list, list) {
97 for (index = 0; kwl->kw[index].kw != NULL; index++) {
98 if ((strncmp(kwl->kw[index].kw, kw, kwend - kw) == 0) &&
99 kwl->kw[index].kw[kwend-kw] == 0)
100 return &kwl->kw[index];
101 }
102 }
103 return NULL;
104}
105
Willy Tarreaua84d3742007-05-07 00:36:48 +0200106static struct acl_expr *prune_acl_expr(struct acl_expr *expr)
107{
Willy Tarreau34db1082012-04-19 17:16:54 +0200108 struct arg *arg;
Willy Tarreau145325e2017-04-12 23:03:31 +0200109 int unresolved = 0;
Willy Tarreau34db1082012-04-19 17:16:54 +0200110
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100111 pattern_prune(&expr->pat);
Willy Tarreau34db1082012-04-19 17:16:54 +0200112
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100113 for (arg = expr->smp->arg_p; arg; arg++) {
Willy Tarreau34db1082012-04-19 17:16:54 +0200114 if (arg->type == ARGT_STOP)
115 break;
Willy Tarreau496aa012012-06-01 10:38:29 +0200116 if (arg->type == ARGT_STR || arg->unresolved) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200117 free(arg->data.str.area);
118 arg->data.str.area = NULL;
119 arg->data.str.data = 0;
Willy Tarreau145325e2017-04-12 23:03:31 +0200120 unresolved |= arg->unresolved;
Willy Tarreau496aa012012-06-01 10:38:29 +0200121 arg->unresolved = 0;
Willy Tarreau34db1082012-04-19 17:16:54 +0200122 }
Willy Tarreau34db1082012-04-19 17:16:54 +0200123 }
124
Willy Tarreau145325e2017-04-12 23:03:31 +0200125 if (expr->smp->arg_p != empty_arg_list && !unresolved)
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100126 free(expr->smp->arg_p);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200127 return expr;
128}
129
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200130/* Parse an ACL expression starting at <args>[0], and return it. If <err> is
131 * not NULL, it will be filled with a pointer to an error message in case of
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200132 * error. This pointer must be freeable or NULL. <al> is an arg_list serving
133 * as a list head to report missing dependencies.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200134 *
Willy Tarreaua84d3742007-05-07 00:36:48 +0200135 * Right now, the only accepted syntax is :
136 * <subject> [<value>...]
137 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100138struct acl_expr *parse_acl_expr(const char **args, char **err, struct arg_list *al,
139 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200140{
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100141 __label__ out_return, out_free_expr;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200142 struct acl_expr *expr;
143 struct acl_keyword *aclkw;
Christopher Faulet54ceb042017-06-14 14:41:33 +0200144 int refflags, patflags;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200145 const char *arg;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100146 struct sample_expr *smp = NULL;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100147 int idx = 0;
148 char *ckw = NULL;
149 const char *begw;
150 const char *endw;
Willy Tarreau131b4662013-12-13 01:08:36 +0100151 const char *endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100152 int cur_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100153 int nbargs;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100154 int operator = STD_OP_EQ;
155 int op;
156 int contain_colon, have_dot;
157 const char *dot;
158 signed long long value, minor;
159 /* The following buffer contain two numbers, a ':' separator and the final \0. */
160 char buffer[NB_LLMAX_STR + 1 + NB_LLMAX_STR + 1];
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100161 int is_loaded;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100162 int unique_id;
163 char *error;
164 struct pat_ref *ref;
165 struct pattern_expr *pattern_expr;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100166 int load_as_map = 0;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200167 int acl_conv_found = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200168
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100169 /* First, we look for an ACL keyword. And if we don't find one, then
170 * we look for a sample fetch expression starting with a sample fetch
171 * keyword.
Willy Tarreaubef91e72013-03-31 23:14:46 +0200172 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100173
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100174 al->ctx = ARGC_ACL; // to report errors while resolving args late
Willy Tarreau131b4662013-12-13 01:08:36 +0100175 al->kw = *args;
176 al->conv = NULL;
177
Willy Tarreaua84d3742007-05-07 00:36:48 +0200178 aclkw = find_acl_kw(args[0]);
Willy Tarreau20490922014-03-17 18:04:27 +0100179 if (aclkw) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100180 /* OK we have a real ACL keyword */
Willy Tarreau9987ea92013-06-11 21:09:06 +0200181
Willy Tarreau131b4662013-12-13 01:08:36 +0100182 /* build new sample expression for this ACL */
Vincent Bernat02779b62016-04-03 13:48:43 +0200183 smp = calloc(1, sizeof(*smp));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100184 if (!smp) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100185 memprintf(err, "out of memory when parsing ACL expression");
186 goto out_return;
187 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100188 LIST_INIT(&(smp->conv_exprs));
189 smp->fetch = aclkw->smp;
190 smp->arg_p = empty_arg_list;
Willy Tarreau34db1082012-04-19 17:16:54 +0200191
Joseph Herlant68082792018-11-15 14:55:09 -0800192 /* look for the beginning of the subject arguments */
Willy Tarreau131b4662013-12-13 01:08:36 +0100193 for (arg = args[0]; *arg && *arg != '(' && *arg != ','; arg++);
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100194
Willy Tarreau131b4662013-12-13 01:08:36 +0100195 endt = arg;
196 if (*endt == '(') {
197 /* look for the end of this term and skip the opening parenthesis */
198 endt = ++arg;
199 while (*endt && *endt != ')')
200 endt++;
201 if (*endt != ')') {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100202 memprintf(err, "missing closing ')' after arguments to ACL keyword '%s'", aclkw->kw);
203 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100204 }
205 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100206
Willy Tarreau131b4662013-12-13 01:08:36 +0100207 /* At this point, we have :
208 * - args[0] : beginning of the keyword
209 * - arg : end of the keyword, first character not part of keyword
210 * nor the opening parenthesis (so first character of args
211 * if present).
212 * - endt : end of the term (=arg or last parenthesis if args are present)
213 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100214 nbargs = make_arg_list(arg, endt - arg, smp->fetch->arg_mask, &smp->arg_p,
Willy Tarreau131b4662013-12-13 01:08:36 +0100215 err, NULL, NULL, al);
216 if (nbargs < 0) {
217 /* note that make_arg_list will have set <err> here */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100218 memprintf(err, "ACL keyword '%s' : %s", aclkw->kw, *err);
219 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100220 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100221
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100222 if (!smp->arg_p) {
223 smp->arg_p = empty_arg_list;
Willy Tarreau131b4662013-12-13 01:08:36 +0100224 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100225 else if (smp->fetch->val_args && !smp->fetch->val_args(smp->arg_p, err)) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100226 /* invalid keyword argument, error must have been
227 * set by val_args().
228 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100229 memprintf(err, "in argument to '%s', %s", aclkw->kw, *err);
230 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100231 }
232 arg = endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100233
Joseph Herlant68082792018-11-15 14:55:09 -0800234 /* look for the beginning of the converters list. Those directly attached
Willy Tarreau131b4662013-12-13 01:08:36 +0100235 * to the ACL keyword are found just after <arg> which points to the comma.
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200236 * If we find any converter, then we don't use the ACL keyword's match
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200237 * anymore but the one related to the converter's output type.
Willy Tarreau131b4662013-12-13 01:08:36 +0100238 */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200239 cur_type = smp->fetch->out_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100240 while (*arg) {
241 struct sample_conv *conv;
242 struct sample_conv_expr *conv_expr;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100243
Willy Tarreau131b4662013-12-13 01:08:36 +0100244 if (*arg == ')') /* skip last closing parenthesis */
245 arg++;
246
247 if (*arg && *arg != ',') {
248 if (ckw)
Willy Tarreau97108e02016-11-25 07:33:24 +0100249 memprintf(err, "ACL keyword '%s' : missing comma after converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100250 aclkw->kw, ckw);
Willy Tarreau131b4662013-12-13 01:08:36 +0100251 else
252 memprintf(err, "ACL keyword '%s' : missing comma after fetch keyword.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100253 aclkw->kw);
254 goto out_free_smp;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200255 }
Willy Tarreauae52f062012-04-26 12:13:35 +0200256
Willy Tarreau131b4662013-12-13 01:08:36 +0100257 while (*arg == ',') /* then trailing commas */
258 arg++;
Willy Tarreau2e845be2012-10-19 19:49:09 +0200259
Willy Tarreau97108e02016-11-25 07:33:24 +0100260 begw = arg; /* start of converter keyword */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100261
Willy Tarreau131b4662013-12-13 01:08:36 +0100262 if (!*begw)
263 /* none ? end of converters */
264 break;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100265
Willy Tarreau131b4662013-12-13 01:08:36 +0100266 for (endw = begw; *endw && *endw != '(' && *endw != ','; endw++);
Willy Tarreau9ca69362013-10-22 19:10:06 +0200267
Willy Tarreau131b4662013-12-13 01:08:36 +0100268 free(ckw);
269 ckw = my_strndup(begw, endw - begw);
Willy Tarreauf75d0082013-04-07 21:20:44 +0200270
Willy Tarreau131b4662013-12-13 01:08:36 +0100271 conv = find_sample_conv(begw, endw - begw);
272 if (!conv) {
273 /* Unknown converter method */
Willy Tarreau97108e02016-11-25 07:33:24 +0100274 memprintf(err, "ACL keyword '%s' : unknown converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100275 aclkw->kw, ckw);
276 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100277 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100278
Willy Tarreau131b4662013-12-13 01:08:36 +0100279 arg = endw;
280 if (*arg == '(') {
281 /* look for the end of this term */
282 while (*arg && *arg != ')')
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100283 arg++;
Willy Tarreau131b4662013-12-13 01:08:36 +0100284 if (*arg != ')') {
Willy Tarreau97108e02016-11-25 07:33:24 +0100285 memprintf(err, "ACL keyword '%s' : syntax error: missing ')' after converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100286 aclkw->kw, ckw);
287 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100288 }
Willy Tarreau131b4662013-12-13 01:08:36 +0100289 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100290
Willy Tarreau131b4662013-12-13 01:08:36 +0100291 if (conv->in_type >= SMP_TYPES || conv->out_type >= SMP_TYPES) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100292 memprintf(err, "ACL keyword '%s' : returns type of converter '%s' is unknown.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100293 aclkw->kw, ckw);
294 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100295 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100296
Willy Tarreau131b4662013-12-13 01:08:36 +0100297 /* If impossible type conversion */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200298 if (!sample_casts[cur_type][conv->in_type]) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100299 memprintf(err, "ACL keyword '%s' : converter '%s' cannot be applied.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100300 aclkw->kw, ckw);
301 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100302 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100303
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200304 cur_type = conv->out_type;
Vincent Bernat02779b62016-04-03 13:48:43 +0200305 conv_expr = calloc(1, sizeof(*conv_expr));
Willy Tarreau131b4662013-12-13 01:08:36 +0100306 if (!conv_expr)
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100307 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100308
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100309 LIST_ADDQ(&(smp->conv_exprs), &(conv_expr->list));
Willy Tarreau131b4662013-12-13 01:08:36 +0100310 conv_expr->conv = conv;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200311 acl_conv_found = 1;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100312
Willy Tarreau131b4662013-12-13 01:08:36 +0100313 if (arg != endw) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100314 int err_arg;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100315
Willy Tarreau131b4662013-12-13 01:08:36 +0100316 if (!conv->arg_mask) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100317 memprintf(err, "ACL keyword '%s' : converter '%s' does not support any args.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100318 aclkw->kw, ckw);
319 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100320 }
321
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100322 al->kw = smp->fetch->kw;
Willy Tarreau131b4662013-12-13 01:08:36 +0100323 al->conv = conv_expr->conv->kw;
Willy Tarreauadaddc22013-12-13 01:30:22 +0100324 if (make_arg_list(endw + 1, arg - endw - 1, conv->arg_mask, &conv_expr->arg_p, err, NULL, &err_arg, al) < 0) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100325 memprintf(err, "ACL keyword '%s' : invalid arg %d in converter '%s' : %s.",
Willy Tarreauadaddc22013-12-13 01:30:22 +0100326 aclkw->kw, err_arg+1, ckw, *err);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100327 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100328 }
329
Willy Tarreau131b4662013-12-13 01:08:36 +0100330 if (!conv_expr->arg_p)
331 conv_expr->arg_p = empty_arg_list;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100332
Thierry FOURNIEReeaa9512014-02-11 14:00:19 +0100333 if (conv->val_args && !conv->val_args(conv_expr->arg_p, conv, file, line, err)) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100334 memprintf(err, "ACL keyword '%s' : invalid args in converter '%s' : %s.",
Willy Tarreauadaddc22013-12-13 01:30:22 +0100335 aclkw->kw, ckw, *err);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100336 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100337 }
338 }
Willy Tarreau131b4662013-12-13 01:08:36 +0100339 else if (ARGM(conv->arg_mask)) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100340 memprintf(err, "ACL keyword '%s' : missing args for converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100341 aclkw->kw, ckw);
342 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100343 }
Willy Tarreau61612d42012-04-19 18:42:05 +0200344 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200345 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100346 else {
347 /* This is not an ACL keyword, so we hope this is a sample fetch
348 * keyword that we're going to transparently use as an ACL. If
349 * so, we retrieve a completely parsed expression with args and
350 * convs already done.
351 */
Thierry FOURNIEReeaa9512014-02-11 14:00:19 +0100352 smp = sample_parse_expr((char **)args, &idx, file, line, err, al);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100353 if (!smp) {
354 memprintf(err, "%s in ACL expression '%s'", *err, *args);
355 goto out_return;
356 }
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200357 cur_type = smp_expr_output_type(smp);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100358 }
359
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200360 expr = calloc(1, sizeof(*expr));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100361 if (!expr) {
362 memprintf(err, "out of memory when parsing ACL expression");
363 goto out_return;
364 }
365
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100366 pattern_init_head(&expr->pat);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100367
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200368 expr->pat.expect_type = cur_type;
369 expr->smp = smp;
370 expr->kw = smp->fetch->kw;
371 smp = NULL; /* don't free it anymore */
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100372
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200373 if (aclkw && !acl_conv_found) {
374 expr->kw = aclkw->kw;
375 expr->pat.parse = aclkw->parse ? aclkw->parse : pat_parse_fcts[aclkw->match_type];
376 expr->pat.index = aclkw->index ? aclkw->index : pat_index_fcts[aclkw->match_type];
377 expr->pat.match = aclkw->match ? aclkw->match : pat_match_fcts[aclkw->match_type];
378 expr->pat.delete = aclkw->delete ? aclkw->delete : pat_delete_fcts[aclkw->match_type];
379 expr->pat.prune = aclkw->prune ? aclkw->prune : pat_prune_fcts[aclkw->match_type];
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100380 }
381
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100382 if (!expr->pat.parse) {
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200383 /* Parse/index/match functions depend on the expression type,
384 * so we have to map them now. Some types can be automatically
385 * converted.
386 */
387 switch (cur_type) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100388 case SMP_T_BOOL:
389 expr->pat.parse = pat_parse_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100390 expr->pat.index = pat_index_fcts[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100391 expr->pat.match = pat_match_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100392 expr->pat.delete = pat_delete_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100393 expr->pat.prune = pat_prune_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100394 expr->pat.expect_type = pat_match_types[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100395 break;
396 case SMP_T_SINT:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100397 expr->pat.parse = pat_parse_fcts[PAT_MATCH_INT];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100398 expr->pat.index = pat_index_fcts[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100399 expr->pat.match = pat_match_fcts[PAT_MATCH_INT];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100400 expr->pat.delete = pat_delete_fcts[PAT_MATCH_INT];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100401 expr->pat.prune = pat_prune_fcts[PAT_MATCH_INT];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100402 expr->pat.expect_type = pat_match_types[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100403 break;
404 case SMP_T_IPV4:
405 case SMP_T_IPV6:
406 expr->pat.parse = pat_parse_fcts[PAT_MATCH_IP];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100407 expr->pat.index = pat_index_fcts[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100408 expr->pat.match = pat_match_fcts[PAT_MATCH_IP];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100409 expr->pat.delete = pat_delete_fcts[PAT_MATCH_IP];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100410 expr->pat.prune = pat_prune_fcts[PAT_MATCH_IP];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100411 expr->pat.expect_type = pat_match_types[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100412 break;
Thierry FOURNIER9fefbd52014-05-11 15:15:00 +0200413 case SMP_T_STR:
414 expr->pat.parse = pat_parse_fcts[PAT_MATCH_STR];
415 expr->pat.index = pat_index_fcts[PAT_MATCH_STR];
416 expr->pat.match = pat_match_fcts[PAT_MATCH_STR];
417 expr->pat.delete = pat_delete_fcts[PAT_MATCH_STR];
418 expr->pat.prune = pat_prune_fcts[PAT_MATCH_STR];
419 expr->pat.expect_type = pat_match_types[PAT_MATCH_STR];
420 break;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100421 }
422 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200423
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100424 /* Additional check to protect against common mistakes */
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100425 if (expr->pat.parse && cur_type != SMP_T_BOOL && !*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100426 ha_warning("parsing acl keyword '%s' :\n"
427 " no pattern to match against were provided, so this ACL will never match.\n"
428 " If this is what you intended, please add '--' to get rid of this warning.\n"
429 " If you intended to match only for existence, please use '-m found'.\n"
430 " If you wanted to force an int to match as a bool, please use '-m bool'.\n"
431 "\n",
432 args[0]);
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100433 }
434
Willy Tarreaua84d3742007-05-07 00:36:48 +0200435 args++;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200436
437 /* check for options before patterns. Supported options are :
438 * -i : ignore case for all patterns by default
439 * -f : read patterns from those files
Willy Tarreau5adeda12013-03-31 22:13:34 +0200440 * -m : force matching method (must be used before -f)
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100441 * -M : load the file as map file
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100442 * -u : force the unique id of the acl
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200443 * -- : everything after this is not an option
444 */
Christopher Faulet54ceb042017-06-14 14:41:33 +0200445 refflags = PAT_REF_ACL;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200446 patflags = 0;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100447 is_loaded = 0;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100448 unique_id = -1;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200449 while (**args == '-') {
Willy Tarreau2039bba2014-05-11 09:43:46 +0200450 if (strcmp(*args, "-i") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200451 patflags |= PAT_MF_IGNORE_CASE;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200452 else if (strcmp(*args, "-n") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200453 patflags |= PAT_MF_NO_DNS;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200454 else if (strcmp(*args, "-u") == 0) {
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100455 unique_id = strtol(args[1], &error, 10);
456 if (*error != '\0') {
457 memprintf(err, "the argument of -u must be an integer");
458 goto out_free_expr;
459 }
460
461 /* Check if this id is really unique. */
462 if (pat_ref_lookupid(unique_id)) {
463 memprintf(err, "the id is already used");
464 goto out_free_expr;
465 }
466
467 args++;
468 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200469 else if (strcmp(*args, "-f") == 0) {
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100470 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200471 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 +0200472 goto out_free_expr;
473 }
474
Christopher Faulet54ceb042017-06-14 14:41:33 +0200475 if (!pattern_read_from_file(&expr->pat, refflags, args[1], patflags, load_as_map, err, file, line))
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200476 goto out_free_expr;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100477 is_loaded = 1;
Willy Tarreau5adeda12013-03-31 22:13:34 +0200478 args++;
479 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200480 else if (strcmp(*args, "-m") == 0) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200481 int idx;
482
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100483 if (is_loaded) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200484 memprintf(err, "'-m' must only be specified before patterns and files in parsing ACL expression");
485 goto out_free_expr;
486 }
487
Willy Tarreau6f8fe312013-11-28 22:24:25 +0100488 idx = pat_find_match_name(args[1]);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200489 if (idx < 0) {
490 memprintf(err, "unknown matching method '%s' when parsing ACL expression", args[1]);
491 goto out_free_expr;
492 }
493
494 /* Note: -m found is always valid, bool/int are compatible, str/bin/reg/len are compatible */
Willy Tarreau9bb49f62015-09-24 16:37:12 +0200495 if (idx != PAT_MATCH_FOUND && !sample_casts[cur_type][pat_match_types[idx]]) {
Willy Tarreau93fddf12013-03-31 22:59:32 +0200496 memprintf(err, "matching method '%s' cannot be used with fetch keyword '%s'", args[1], expr->kw);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200497 goto out_free_expr;
498 }
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100499 expr->pat.parse = pat_parse_fcts[idx];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100500 expr->pat.index = pat_index_fcts[idx];
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100501 expr->pat.match = pat_match_fcts[idx];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100502 expr->pat.delete = pat_delete_fcts[idx];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100503 expr->pat.prune = pat_prune_fcts[idx];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100504 expr->pat.expect_type = pat_match_types[idx];
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200505 args++;
506 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200507 else if (strcmp(*args, "-M") == 0) {
Christopher Faulet54ceb042017-06-14 14:41:33 +0200508 refflags |= PAT_REF_MAP;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100509 load_as_map = 1;
510 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200511 else if (strcmp(*args, "--") == 0) {
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200512 args++;
513 break;
514 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200515 else {
516 memprintf(err, "'%s' is not a valid ACL option. Please use '--' before any pattern beginning with a '-'", args[0]);
517 goto out_free_expr;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200518 break;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200519 }
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200520 args++;
521 }
522
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100523 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200524 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 +0200525 goto out_free_expr;
526 }
527
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100528 /* Create displayed reference */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200529 snprintf(trash.area, trash.size, "acl '%s' file '%s' line %d",
530 expr->kw, file, line);
531 trash.area[trash.size - 1] = '\0';
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100532
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100533 /* Create new patern reference. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200534 ref = pat_ref_newid(unique_id, trash.area, PAT_REF_ACL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100535 if (!ref) {
536 memprintf(err, "memory error");
537 goto out_free_expr;
538 }
539
540 /* Create new pattern expression associated to this reference. */
Emeric Brun7d27f3c2017-07-03 17:54:23 +0200541 pattern_expr = pattern_new_expr(&expr->pat, ref, patflags, err, NULL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100542 if (!pattern_expr)
543 goto out_free_expr;
544
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200545 /* now parse all patterns */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100546 while (**args) {
547 arg = *args;
548
549 /* Compatibility layer. Each pattern can parse only one string per pattern,
550 * but the pat_parser_int() and pat_parse_dotted_ver() parsers were need
551 * optionnaly two operators. The first operator is the match method: eq,
552 * le, lt, ge and gt. pat_parse_int() and pat_parse_dotted_ver() functions
553 * can have a compatibility syntax based on ranges:
554 *
555 * pat_parse_int():
556 *
557 * "eq x" -> "x" or "x:x"
558 * "le x" -> ":x"
559 * "lt x" -> ":y" (with y = x - 1)
560 * "ge x" -> "x:"
561 * "gt x" -> "y:" (with y = x + 1)
562 *
563 * pat_parse_dotted_ver():
564 *
565 * "eq x.y" -> "x.y" or "x.y:x.y"
566 * "le x.y" -> ":x.y"
567 * "lt x.y" -> ":w.z" (with w.z = x.y - 1)
568 * "ge x.y" -> "x.y:"
569 * "gt x.y" -> "w.z:" (with w.z = x.y + 1)
570 *
571 * If y is not present, assume that is "0".
572 *
573 * The syntax eq, le, lt, ge and gt are proper to the acl syntax. The
574 * following block of code detect the operator, and rewrite each value
575 * in parsable string.
576 */
577 if (expr->pat.parse == pat_parse_int ||
578 expr->pat.parse == pat_parse_dotted_ver) {
579 /* Check for operator. If the argument is operator, memorise it and
580 * continue to the next argument.
581 */
582 op = get_std_op(arg);
583 if (op != -1) {
584 operator = op;
585 args++;
586 continue;
587 }
588
589 /* Check if the pattern contain ':' or '-' character. */
590 contain_colon = (strchr(arg, ':') || strchr(arg, '-'));
591
592 /* If the pattern contain ':' or '-' character, give it to the parser as is.
593 * If no contain ':' and operator is STD_OP_EQ, give it to the parser as is.
594 * In other case, try to convert the value according with the operator.
595 */
596 if (!contain_colon && operator != STD_OP_EQ) {
597 /* Search '.' separator. */
598 dot = strchr(arg, '.');
599 if (!dot) {
600 have_dot = 0;
601 minor = 0;
602 dot = arg + strlen(arg);
603 }
604 else
605 have_dot = 1;
606
607 /* convert the integer minor part for the pat_parse_dotted_ver() function. */
608 if (expr->pat.parse == pat_parse_dotted_ver && have_dot) {
609 if (strl2llrc(dot+1, strlen(dot+1), &minor) != 0) {
610 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100611 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100612 }
613 if (minor >= 65536) {
614 memprintf(err, "'%s' contains too large a minor value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100615 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100616 }
617 }
618
619 /* convert the integer value for the pat_parse_int() function, and the
620 * integer major part for the pat_parse_dotted_ver() function.
621 */
622 if (strl2llrc(arg, dot - arg, &value) != 0) {
623 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100624 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100625 }
626 if (expr->pat.parse == pat_parse_dotted_ver) {
627 if (value >= 65536) {
628 memprintf(err, "'%s' contains too large a major value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100629 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100630 }
631 value = (value << 16) | (minor & 0xffff);
632 }
633
634 switch (operator) {
635
636 case STD_OP_EQ: /* this case is not possible. */
637 memprintf(err, "internal error");
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100638 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100639
640 case STD_OP_GT:
641 value++; /* gt = ge + 1 */
642
643 case STD_OP_GE:
644 if (expr->pat.parse == pat_parse_int)
645 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld:", value);
646 else
647 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld.%lld:",
648 value >> 16, value & 0xffff);
649 arg = buffer;
650 break;
651
652 case STD_OP_LT:
653 value--; /* lt = le - 1 */
654
655 case STD_OP_LE:
656 if (expr->pat.parse == pat_parse_int)
657 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld", value);
658 else
659 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld.%lld",
660 value >> 16, value & 0xffff);
661 arg = buffer;
662 break;
663 }
664 }
665 }
666
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100667 /* Add sample to the reference, and try to compile it fior each pattern
668 * using this value.
669 */
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200670 if (!pat_ref_add(ref, arg, NULL, err))
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100671 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100672 args++;
673 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200674
675 return expr;
676
Willy Tarreaua84d3742007-05-07 00:36:48 +0200677 out_free_expr:
678 prune_acl_expr(expr);
679 free(expr);
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100680 free(ckw);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100681 out_free_smp:
682 free(smp);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200683 out_return:
684 return NULL;
685}
686
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200687/* Purge everything in the acl <acl>, then return <acl>. */
688struct acl *prune_acl(struct acl *acl) {
689
690 struct acl_expr *expr, *exprb;
691
692 free(acl->name);
693
694 list_for_each_entry_safe(expr, exprb, &acl->expr, list) {
695 LIST_DEL(&expr->list);
696 prune_acl_expr(expr);
697 free(expr);
698 }
699
700 return acl;
701}
702
Willy Tarreaua84d3742007-05-07 00:36:48 +0200703/* Parse an ACL with the name starting at <args>[0], and with a list of already
704 * known ACLs in <acl>. If the ACL was not in the list, it will be added.
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100705 * A pointer to that ACL is returned. If the ACL has an empty name, then it's
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200706 * an anonymous one and it won't be merged with any other one. If <err> is not
707 * NULL, it will be filled with an appropriate error. This pointer must be
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200708 * freeable or NULL. <al> is the arg_list serving as a head for unresolved
709 * dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200710 *
711 * args syntax: <aclname> <acl_expr>
712 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100713struct acl *parse_acl(const char **args, struct list *known_acl, char **err, struct arg_list *al,
714 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200715{
716 __label__ out_return, out_free_acl_expr, out_free_name;
717 struct acl *cur_acl;
718 struct acl_expr *acl_expr;
719 char *name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200720 const char *pos;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200721
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200722 if (**args && (pos = invalid_char(*args))) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200723 memprintf(err, "invalid character in ACL name : '%c'", *pos);
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100724 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200725 }
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100726
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100727 acl_expr = parse_acl_expr(args + 1, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200728 if (!acl_expr) {
729 /* parse_acl_expr will have filled <err> here */
Willy Tarreaua84d3742007-05-07 00:36:48 +0200730 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200731 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200732
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200733 /* Check for args beginning with an opening parenthesis just after the
734 * subject, as this is almost certainly a typo. Right now we can only
735 * emit a warning, so let's do so.
736 */
Krzysztof Piotr Oledzki4cdd8312009-10-05 00:23:35 +0200737 if (!strchr(args[1], '(') && *args[2] == '(')
Christopher Faulet767a84b2017-11-24 16:50:31 +0100738 ha_warning("parsing acl '%s' :\n"
739 " matching '%s' for pattern '%s' is likely a mistake and probably\n"
740 " not what you want. Maybe you need to remove the extraneous space before '('.\n"
741 " If you are really sure this is not an error, please insert '--' between the\n"
742 " match and the pattern to make this warning message disappear.\n",
743 args[0], args[1], args[2]);
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200744
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100745 if (*args[0])
746 cur_acl = find_acl_by_name(args[0], known_acl);
747 else
748 cur_acl = NULL;
749
Willy Tarreaua84d3742007-05-07 00:36:48 +0200750 if (!cur_acl) {
751 name = strdup(args[0]);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200752 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200753 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200754 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200755 }
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200756 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200757 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200758 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200759 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200760 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200761
762 LIST_INIT(&cur_acl->expr);
763 LIST_ADDQ(known_acl, &cur_acl->list);
764 cur_acl->name = name;
765 }
766
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100767 /* We want to know what features the ACL needs (typically HTTP parsing),
768 * and where it may be used. If an ACL relies on multiple matches, it is
769 * OK if at least one of them may match in the context where it is used.
770 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100771 cur_acl->use |= acl_expr->smp->fetch->use;
772 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200773 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
774 return cur_acl;
775
776 out_free_name:
777 free(name);
778 out_free_acl_expr:
779 prune_acl_expr(acl_expr);
780 free(acl_expr);
781 out_return:
782 return NULL;
783}
784
Willy Tarreau16fbe822007-06-17 11:54:31 +0200785/* Some useful ACLs provided by default. Only those used are allocated. */
786
787const struct {
788 const char *name;
789 const char *expr[4]; /* put enough for longest expression */
790} default_acl_list[] = {
Willy Tarreau58393e12008-07-20 10:39:22 +0200791 { .name = "TRUE", .expr = {"always_true",""}},
792 { .name = "FALSE", .expr = {"always_false",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200793 { .name = "LOCALHOST", .expr = {"src","127.0.0.1/8",""}},
Willy Tarreau2492d5b2009-07-11 00:06:00 +0200794 { .name = "HTTP", .expr = {"req_proto_http",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200795 { .name = "HTTP_1.0", .expr = {"req_ver","1.0",""}},
796 { .name = "HTTP_1.1", .expr = {"req_ver","1.1",""}},
797 { .name = "METH_CONNECT", .expr = {"method","CONNECT",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200798 { .name = "METH_DELETE", .expr = {"method","DELETE",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200799 { .name = "METH_GET", .expr = {"method","GET","HEAD",""}},
800 { .name = "METH_HEAD", .expr = {"method","HEAD",""}},
801 { .name = "METH_OPTIONS", .expr = {"method","OPTIONS",""}},
802 { .name = "METH_POST", .expr = {"method","POST",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200803 { .name = "METH_PUT", .expr = {"method","PUT",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200804 { .name = "METH_TRACE", .expr = {"method","TRACE",""}},
805 { .name = "HTTP_URL_ABS", .expr = {"url_reg","^[^/:]*://",""}},
806 { .name = "HTTP_URL_SLASH", .expr = {"url_beg","/",""}},
807 { .name = "HTTP_URL_STAR", .expr = {"url","*",""}},
808 { .name = "HTTP_CONTENT", .expr = {"hdr_val(content-length)","gt","0",""}},
Emeric Brunbede3d02009-06-30 17:54:00 +0200809 { .name = "RDP_COOKIE", .expr = {"req_rdp_cookie_cnt","gt","0",""}},
Willy Tarreauc6317702008-07-20 09:29:50 +0200810 { .name = "REQ_CONTENT", .expr = {"req_len","gt","0",""}},
Willy Tarreaub6fb4202008-07-20 11:18:28 +0200811 { .name = "WAIT_END", .expr = {"wait_end",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200812 { .name = NULL, .expr = {""}}
813};
814
815/* Find a default ACL from the default_acl list, compile it and return it.
816 * If the ACL is not found, NULL is returned. In theory, it cannot fail,
817 * except when default ACLs are broken, in which case it will return NULL.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200818 * If <known_acl> is not NULL, the ACL will be queued at its tail. If <err> is
819 * not NULL, it will be filled with an error message if an error occurs. This
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200820 * pointer must be freeable or NULL. <al> is an arg_list serving as a list head
821 * to report missing dependencies.
Willy Tarreau16fbe822007-06-17 11:54:31 +0200822 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200823static struct acl *find_acl_default(const char *acl_name, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100824 char **err, struct arg_list *al,
825 const char *file, int line)
Willy Tarreau16fbe822007-06-17 11:54:31 +0200826{
827 __label__ out_return, out_free_acl_expr, out_free_name;
828 struct acl *cur_acl;
829 struct acl_expr *acl_expr;
830 char *name;
831 int index;
832
833 for (index = 0; default_acl_list[index].name != NULL; index++) {
834 if (strcmp(acl_name, default_acl_list[index].name) == 0)
835 break;
836 }
837
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200838 if (default_acl_list[index].name == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200839 memprintf(err, "no such ACL : '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200840 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200841 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200842
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100843 acl_expr = parse_acl_expr((const char **)default_acl_list[index].expr, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200844 if (!acl_expr) {
845 /* parse_acl_expr must have filled err here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200846 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200847 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200848
849 name = strdup(acl_name);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200850 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200851 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200852 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200853 }
854
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200855 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200856 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200857 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200858 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200859 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200860
861 cur_acl->name = name;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100862 cur_acl->use |= acl_expr->smp->fetch->use;
863 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreau16fbe822007-06-17 11:54:31 +0200864 LIST_INIT(&cur_acl->expr);
865 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
866 if (known_acl)
867 LIST_ADDQ(known_acl, &cur_acl->list);
868
869 return cur_acl;
870
871 out_free_name:
872 free(name);
873 out_free_acl_expr:
874 prune_acl_expr(acl_expr);
875 free(acl_expr);
876 out_return:
877 return NULL;
878}
Willy Tarreaua84d3742007-05-07 00:36:48 +0200879
880/* Purge everything in the acl_cond <cond>, then return <cond>. */
881struct acl_cond *prune_acl_cond(struct acl_cond *cond)
882{
883 struct acl_term_suite *suite, *tmp_suite;
884 struct acl_term *term, *tmp_term;
885
886 /* iterate through all term suites and free all terms and all suites */
887 list_for_each_entry_safe(suite, tmp_suite, &cond->suites, list) {
888 list_for_each_entry_safe(term, tmp_term, &suite->terms, list)
889 free(term);
890 free(suite);
891 }
892 return cond;
893}
894
895/* Parse an ACL condition starting at <args>[0], relying on a list of already
896 * known ACLs passed in <known_acl>. The new condition is returned (or NULL in
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200897 * case of low memory). Supports multiple conditions separated by "or". If
898 * <err> is not NULL, it will be filled with a pointer to an error message in
899 * case of error, that the caller is responsible for freeing. The initial
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200900 * location must either be freeable or NULL. The list <al> serves as a list head
901 * for unresolved dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200902 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200903struct acl_cond *parse_acl_cond(const char **args, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100904 enum acl_cond_pol pol, char **err, struct arg_list *al,
905 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200906{
907 __label__ out_return, out_free_suite, out_free_term;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200908 int arg, neg;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200909 const char *word;
910 struct acl *cur_acl;
911 struct acl_term *cur_term;
912 struct acl_term_suite *cur_suite;
913 struct acl_cond *cond;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100914 unsigned int suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200915
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200916 cond = calloc(1, sizeof(*cond));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200917 if (cond == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200918 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200919 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200920 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200921
922 LIST_INIT(&cond->list);
923 LIST_INIT(&cond->suites);
924 cond->pol = pol;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100925 cond->val = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200926
927 cur_suite = NULL;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100928 suite_val = ~0U;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200929 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200930 for (arg = 0; *args[arg]; arg++) {
931 word = args[arg];
932
933 /* remove as many exclamation marks as we can */
934 while (*word == '!') {
935 neg = !neg;
936 word++;
937 }
938
939 /* an empty word is allowed because we cannot force the user to
940 * always think about not leaving exclamation marks alone.
941 */
942 if (!*word)
943 continue;
944
Willy Tarreau16fbe822007-06-17 11:54:31 +0200945 if (strcasecmp(word, "or") == 0 || strcmp(word, "||") == 0) {
Willy Tarreaua84d3742007-05-07 00:36:48 +0200946 /* new term suite */
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100947 cond->val |= suite_val;
948 suite_val = ~0U;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200949 cur_suite = NULL;
950 neg = 0;
951 continue;
952 }
953
Willy Tarreau95fa4692010-02-01 13:05:50 +0100954 if (strcmp(word, "{") == 0) {
955 /* we may have a complete ACL expression between two braces,
956 * find the last one.
957 */
958 int arg_end = arg + 1;
959 const char **args_new;
960
961 while (*args[arg_end] && strcmp(args[arg_end], "}") != 0)
962 arg_end++;
963
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200964 if (!*args[arg_end]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200965 memprintf(err, "missing closing '}' in condition");
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
969 args_new = calloc(1, (arg_end - arg + 1) * sizeof(*args_new));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200970 if (!args_new) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200971 memprintf(err, "out of memory when parsing condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100972 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200973 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100974
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100975 args_new[0] = "";
Willy Tarreau95fa4692010-02-01 13:05:50 +0100976 memcpy(args_new + 1, args + arg + 1, (arg_end - arg) * sizeof(*args_new));
977 args_new[arg_end - arg] = "";
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100978 cur_acl = parse_acl(args_new, known_acl, err, al, file, line);
Willy Tarreau95fa4692010-02-01 13:05:50 +0100979 free(args_new);
980
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200981 if (!cur_acl) {
982 /* note that parse_acl() must have filled <err> here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200983 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200984 }
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100985 word = args[arg + 1];
Willy Tarreau95fa4692010-02-01 13:05:50 +0100986 arg = arg_end;
987 }
988 else {
989 /* search for <word> in the known ACL names. If we do not find
990 * it, let's look for it in the default ACLs, and if found, add
991 * it to the list of ACLs of this proxy. This makes it possible
992 * to override them.
993 */
994 cur_acl = find_acl_by_name(word, known_acl);
995 if (cur_acl == NULL) {
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100996 cur_acl = find_acl_default(word, known_acl, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200997 if (cur_acl == NULL) {
998 /* note that find_acl_default() must have filled <err> here */
Willy Tarreau95fa4692010-02-01 13:05:50 +0100999 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001000 }
Willy Tarreau95fa4692010-02-01 13:05:50 +01001001 }
Willy Tarreau16fbe822007-06-17 11:54:31 +02001002 }
Willy Tarreaua84d3742007-05-07 00:36:48 +02001003
Vincent Bernat3c2f2f22016-04-03 13:48:42 +02001004 cur_term = calloc(1, sizeof(*cur_term));
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001005 if (cur_term == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001006 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +02001007 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001008 }
Willy Tarreaua84d3742007-05-07 00:36:48 +02001009
1010 cur_term->acl = cur_acl;
1011 cur_term->neg = neg;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001012
1013 /* Here it is a bit complex. The acl_term_suite is a conjunction
1014 * of many terms. It may only be used if all of its terms are
1015 * usable at the same time. So the suite's validity domain is an
1016 * AND between all ACL keywords' ones. But, the global condition
1017 * is valid if at least one term suite is OK. So it's an OR between
1018 * all of their validity domains. We could emit a warning as soon
1019 * as suite_val is null because it means that the last ACL is not
1020 * compatible with the previous ones. Let's remain simple for now.
1021 */
1022 cond->use |= cur_acl->use;
1023 suite_val &= cur_acl->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001024
1025 if (!cur_suite) {
Vincent Bernat3c2f2f22016-04-03 13:48:42 +02001026 cur_suite = calloc(1, sizeof(*cur_suite));
Willy Tarreauf678b7f2013-01-24 00:25:39 +01001027 if (cur_suite == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001028 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +02001029 goto out_free_term;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001030 }
Willy Tarreaua84d3742007-05-07 00:36:48 +02001031 LIST_INIT(&cur_suite->terms);
1032 LIST_ADDQ(&cond->suites, &cur_suite->list);
1033 }
1034 LIST_ADDQ(&cur_suite->terms, &cur_term->list);
Willy Tarreau74b98a82007-06-16 19:35:18 +02001035 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001036 }
1037
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001038 cond->val |= suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001039 return cond;
1040
1041 out_free_term:
1042 free(cur_term);
1043 out_free_suite:
1044 prune_acl_cond(cond);
1045 free(cond);
1046 out_return:
1047 return NULL;
1048}
1049
Willy Tarreau2bbba412010-01-28 16:48:33 +01001050/* Builds an ACL condition starting at the if/unless keyword. The complete
1051 * condition is returned. NULL is returned in case of error or if the first
1052 * word is neither "if" nor "unless". It automatically sets the file name and
Willy Tarreau25320b22013-03-24 07:22:08 +01001053 * the line number in the condition for better error reporting, and sets the
1054 * HTTP intiailization requirements in the proxy. If <err> is not NULL, it will
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001055 * be filled with a pointer to an error message in case of error, that the
1056 * caller is responsible for freeing. The initial location must either be
1057 * freeable or NULL.
Willy Tarreau2bbba412010-01-28 16:48:33 +01001058 */
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001059struct acl_cond *build_acl_cond(const char *file, int line, struct list *known_acl,
1060 struct proxy *px, const char **args, char **err)
Willy Tarreau2bbba412010-01-28 16:48:33 +01001061{
Willy Tarreau0cba6072013-11-28 22:21:02 +01001062 enum acl_cond_pol pol = ACL_COND_NONE;
Willy Tarreau2bbba412010-01-28 16:48:33 +01001063 struct acl_cond *cond = NULL;
1064
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001065 if (err)
1066 *err = NULL;
1067
Willy Tarreau2bbba412010-01-28 16:48:33 +01001068 if (!strcmp(*args, "if")) {
1069 pol = ACL_COND_IF;
1070 args++;
1071 }
1072 else if (!strcmp(*args, "unless")) {
1073 pol = ACL_COND_UNLESS;
1074 args++;
1075 }
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001076 else {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001077 memprintf(err, "conditions must start with either 'if' or 'unless'");
Willy Tarreau2bbba412010-01-28 16:48:33 +01001078 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001079 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001080
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001081 cond = parse_acl_cond(args, known_acl, pol, err, &px->conf.args, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001082 if (!cond) {
1083 /* note that parse_acl_cond must have filled <err> here */
Willy Tarreau2bbba412010-01-28 16:48:33 +01001084 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001085 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001086
1087 cond->file = file;
1088 cond->line = line;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001089 px->http_needed |= !!(cond->use & SMP_USE_HTTP_ANY);
Willy Tarreau2bbba412010-01-28 16:48:33 +01001090 return cond;
1091}
1092
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001093/* Execute condition <cond> and return either ACL_TEST_FAIL, ACL_TEST_MISS or
1094 * ACL_TEST_PASS depending on the test results. ACL_TEST_MISS may only be
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001095 * returned if <opt> does not contain SMP_OPT_FINAL, indicating that incomplete
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001096 * data is being examined. The function automatically sets SMP_OPT_ITERATE. This
1097 * function only computes the condition, it does not apply the polarity required
1098 * by IF/UNLESS, it's up to the caller to do this using something like this :
Willy Tarreau11382812008-07-09 16:18:21 +02001099 *
1100 * res = acl_pass(res);
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001101 * if (res == ACL_TEST_MISS)
Willy Tarreaub6866442008-07-14 23:54:42 +02001102 * return 0;
Willy Tarreau11382812008-07-09 16:18:21 +02001103 * if (cond->pol == ACL_COND_UNLESS)
1104 * res = !res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001105 */
Willy Tarreau192252e2015-04-04 01:47:55 +02001106enum 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 +02001107{
1108 __label__ fetch_next;
1109 struct acl_term_suite *suite;
1110 struct acl_term *term;
1111 struct acl_expr *expr;
1112 struct acl *acl;
Willy Tarreau37406352012-04-23 16:16:37 +02001113 struct sample smp;
Willy Tarreau0cba6072013-11-28 22:21:02 +01001114 enum acl_test_res acl_res, suite_res, cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001115
Willy Tarreau7a777ed2012-04-26 11:44:02 +02001116 /* ACLs are iterated over all values, so let's always set the flag to
1117 * indicate this to the fetch functions.
1118 */
1119 opt |= SMP_OPT_ITERATE;
1120
Willy Tarreau11382812008-07-09 16:18:21 +02001121 /* We're doing a logical OR between conditions so we initialize to FAIL.
1122 * The MISS status is propagated down from the suites.
1123 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001124 cond_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001125 list_for_each_entry(suite, &cond->suites, list) {
Willy Tarreau11382812008-07-09 16:18:21 +02001126 /* Evaluate condition suite <suite>. We stop at the first term
Willy Tarreau0cba6072013-11-28 22:21:02 +01001127 * which returns ACL_TEST_FAIL. The MISS status is still propagated
Willy Tarreau11382812008-07-09 16:18:21 +02001128 * in case of uncertainty in the result.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001129 */
1130
1131 /* we're doing a logical AND between terms, so we must set the
1132 * initial value to PASS.
1133 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001134 suite_res = ACL_TEST_PASS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001135 list_for_each_entry(term, &suite->terms, list) {
1136 acl = term->acl;
1137
1138 /* FIXME: use cache !
1139 * check acl->cache_idx for this.
1140 */
1141
1142 /* ACL result not cached. Let's scan all the expressions
1143 * and use the first one to match.
1144 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001145 acl_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001146 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaud41f8d82007-06-10 10:06:18 +02001147 /* we need to reset context and flags */
Willy Tarreau37406352012-04-23 16:16:37 +02001148 memset(&smp, 0, sizeof(smp));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001149 fetch_next:
Willy Tarreau192252e2015-04-04 01:47:55 +02001150 if (!sample_process(px, sess, strm, opt, expr->smp, &smp)) {
Willy Tarreaub6866442008-07-14 23:54:42 +02001151 /* maybe we could not fetch because of missing data */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001152 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001153 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001154 continue;
Willy Tarreaub6866442008-07-14 23:54:42 +02001155 }
Willy Tarreauc4262962010-05-10 23:42:40 +02001156
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +01001157 acl_res |= pat2acl(pattern_exec_match(&expr->pat, &smp, 0));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001158 /*
Willy Tarreau11382812008-07-09 16:18:21 +02001159 * OK now acl_res holds the result of this expression
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001160 * as one of ACL_TEST_FAIL, ACL_TEST_MISS or ACL_TEST_PASS.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001161 *
Willy Tarreau11382812008-07-09 16:18:21 +02001162 * Then if (!MISS) we can cache the result, and put
Willy Tarreau37406352012-04-23 16:16:37 +02001163 * (smp.flags & SMP_F_VOLATILE) in the cache flags.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001164 *
1165 * FIXME: implement cache.
1166 *
1167 */
1168
Willy Tarreau11382812008-07-09 16:18:21 +02001169 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001170 if (acl_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001171 break;
1172
Willy Tarreau37406352012-04-23 16:16:37 +02001173 if (smp.flags & SMP_F_NOT_LAST)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001174 goto fetch_next;
Willy Tarreaub6866442008-07-14 23:54:42 +02001175
1176 /* sometimes we know the fetched data is subject to change
1177 * later and give another chance for a new match (eg: request
1178 * size, time, ...)
1179 */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001180 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001181 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001182 }
1183 /*
1184 * Here we have the result of an ACL (cached or not).
1185 * ACLs are combined, negated or not, to form conditions.
1186 */
1187
Willy Tarreaua84d3742007-05-07 00:36:48 +02001188 if (term->neg)
Willy Tarreau11382812008-07-09 16:18:21 +02001189 acl_res = acl_neg(acl_res);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001190
1191 suite_res &= acl_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001192
Willy Tarreau79c412b2013-10-30 19:30:32 +01001193 /* we're ANDing these terms, so a single FAIL or MISS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001194 if (suite_res != ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001195 break;
1196 }
1197 cond_res |= suite_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001198
1199 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001200 if (cond_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001201 break;
1202 }
Willy Tarreau11382812008-07-09 16:18:21 +02001203 return cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001204}
1205
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001206/* Returns a pointer to the first ACL conflicting with usage at place <where>
1207 * which is one of the SMP_VAL_* bits indicating a check place, or NULL if
1208 * no conflict is found. Only full conflicts are detected (ACL is not usable).
1209 * Use the next function to check for useless keywords.
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001210 */
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001211const struct acl *acl_cond_conflicts(const struct acl_cond *cond, unsigned int where)
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001212{
1213 struct acl_term_suite *suite;
1214 struct acl_term *term;
1215 struct acl *acl;
1216
1217 list_for_each_entry(suite, &cond->suites, list) {
1218 list_for_each_entry(term, &suite->terms, list) {
1219 acl = term->acl;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001220 if (!(acl->val & where))
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001221 return acl;
1222 }
1223 }
1224 return NULL;
1225}
1226
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001227/* Returns a pointer to the first ACL and its first keyword to conflict with
1228 * usage at place <where> which is one of the SMP_VAL_* bits indicating a check
1229 * place. Returns true if a conflict is found, with <acl> and <kw> set (if non
1230 * null), or false if not conflict is found. The first useless keyword is
1231 * returned.
1232 */
Willy Tarreau93fddf12013-03-31 22:59:32 +02001233int 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 +01001234{
1235 struct acl_term_suite *suite;
1236 struct acl_term *term;
1237 struct acl_expr *expr;
1238
1239 list_for_each_entry(suite, &cond->suites, list) {
1240 list_for_each_entry(term, &suite->terms, list) {
1241 list_for_each_entry(expr, &term->acl->expr, list) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001242 if (!(expr->smp->fetch->val & where)) {
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001243 if (acl)
1244 *acl = term->acl;
1245 if (kw)
1246 *kw = expr->kw;
1247 return 1;
1248 }
1249 }
1250 }
1251 }
1252 return 0;
1253}
1254
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001255/*
1256 * Find targets for userlist and groups in acl. Function returns the number
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001257 * of errors or OK if everything is fine. It must be called only once sample
1258 * fetch arguments have been resolved (after smp_resolve_args()).
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001259 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001260int acl_find_targets(struct proxy *p)
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001261{
1262
1263 struct acl *acl;
1264 struct acl_expr *expr;
Thierry FOURNIER3ead5b92013-12-13 12:12:18 +01001265 struct pattern_list *pattern;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001266 int cfgerr = 0;
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001267 struct pattern_expr_list *pexp;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001268
1269 list_for_each_entry(acl, &p->acl, list) {
1270 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001271 if (!strcmp(expr->kw, "http_auth_group")) {
1272 /* Note: the ARGT_USR argument may only have been resolved earlier
1273 * by smp_resolve_args().
1274 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001275 if (expr->smp->arg_p->unresolved) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001276 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 +02001277 p->id, *acl->name ? "" : "anonymous ", acl->name, expr->kw,
1278 expr->smp->arg_p->data.str.area);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001279 cfgerr++;
Willy Tarreau496aa012012-06-01 10:38:29 +02001280 continue;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001281 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001282
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001283 if (LIST_ISEMPTY(&expr->pat.head)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001284 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1285 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001286 cfgerr++;
1287 continue;
1288 }
1289
Thierry FOURNIER9eec0a62014-01-22 18:38:02 +01001290 /* For each pattern, check if the group exists. */
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001291 list_for_each_entry(pexp, &expr->pat.head, list) {
1292 if (LIST_ISEMPTY(&pexp->expr->patterns)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001293 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1294 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001295 cfgerr++;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001296 continue;
1297 }
1298
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001299 list_for_each_entry(pattern, &pexp->expr->patterns, list) {
1300 /* this keyword only has one argument */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001301 if (!check_group(expr->smp->arg_p->data.usr, pattern->pat.ptr.str)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001302 ha_alert("proxy %s: acl %s %s(): invalid group '%s'.\n",
1303 p->id, acl->name, expr->kw, pattern->pat.ptr.str);
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001304 cfgerr++;
1305 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001306 }
1307 }
1308 }
1309 }
1310 }
1311
1312 return cfgerr;
1313}
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001314
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001315/* initializes ACLs by resolving the sample fetch names they rely upon.
1316 * Returns 0 on success, otherwise an error.
1317 */
1318int init_acl()
1319{
1320 int err = 0;
1321 int index;
1322 const char *name;
1323 struct acl_kw_list *kwl;
1324 struct sample_fetch *smp;
1325
1326 list_for_each_entry(kwl, &acl_keywords.list, list) {
1327 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1328 name = kwl->kw[index].fetch_kw;
1329 if (!name)
1330 name = kwl->kw[index].kw;
1331
1332 smp = find_sample_fetch(name, strlen(name));
1333 if (!smp) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001334 ha_alert("Critical internal error: ACL keyword '%s' relies on sample fetch '%s' which was not registered!\n",
1335 kwl->kw[index].kw, name);
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001336 err++;
1337 continue;
1338 }
1339 kwl->kw[index].smp = smp;
1340 }
1341 }
1342 return err;
1343}
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001344
Willy Tarreaua84d3742007-05-07 00:36:48 +02001345/************************************************************************/
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001346/* All supported sample and ACL keywords must be declared here. */
1347/************************************************************************/
1348
1349/* Note: must not be declared <const> as its list will be overwritten.
Willy Tarreau61612d42012-04-19 18:42:05 +02001350 * Please take care of keeping this list alphabetically sorted.
1351 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001352static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001353 { /* END */ },
Willy Tarreaua84d3742007-05-07 00:36:48 +02001354}};
1355
Willy Tarreau0108d902018-11-25 19:14:37 +01001356INITCALL1(STG_REGISTER, acl_register_keywords, &acl_kws);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001357
1358/*
1359 * Local variables:
1360 * c-indent-level: 8
1361 * c-basic-offset: 8
1362 * End:
1363 */