blob: a9cf7a15e83970ac6b0bc5e8aa468a862b9aa5cf [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>
18#include <common/mini-clist.h>
19#include <common/standard.h>
Krzysztof Piotr Oledzki8c8bd452010-01-29 19:29:32 +010020#include <common/uri_auth.h>
Willy Tarreaua84d3742007-05-07 00:36:48 +020021
Willy Tarreau2b5285d2010-05-09 23:45:24 +020022#include <types/global.h>
23
Willy Tarreaua84d3742007-05-07 00:36:48 +020024#include <proto/acl.h>
Willy Tarreau34db1082012-04-19 17:16:54 +020025#include <proto/arg.h>
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +010026#include <proto/auth.h>
Willy Tarreauc7e42382012-08-24 19:22:53 +020027#include <proto/channel.h>
Willy Tarreau404e8ab2009-07-26 19:40:40 +020028#include <proto/log.h>
Thierry FOURNIERed66c292013-11-28 11:05:19 +010029#include <proto/pattern.h>
Willy Tarreau0b1cd942010-05-16 22:18:27 +020030#include <proto/proxy.h>
Willy Tarreau8ed669b2013-01-11 15:49:37 +010031#include <proto/sample.h>
Willy Tarreaud28c3532012-04-19 19:28:33 +020032#include <proto/stick_table.h>
Willy Tarreaua84d3742007-05-07 00:36:48 +020033
Willy Tarreauc4262962010-05-10 23:42:40 +020034#include <ebsttree.h>
35
Willy Tarreaua84d3742007-05-07 00:36:48 +020036/* List head of all known ACL keywords */
37static struct acl_kw_list acl_keywords = {
38 .list = LIST_HEAD_INIT(acl_keywords.list)
39};
40
Willy Tarreau0cba6072013-11-28 22:21:02 +010041/* input values are 0 or 3, output is the same */
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +010042static inline enum acl_test_res pat2acl(struct pattern *pat)
Willy Tarreau0cba6072013-11-28 22:21:02 +010043{
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +010044 if (pat)
45 return ACL_TEST_PASS;
46 else
47 return ACL_TEST_FAIL;
Willy Tarreau0cba6072013-11-28 22:21:02 +010048}
49
Willy Tarreaua5909832007-06-17 20:40:25 +020050/*
Willy Tarreaua84d3742007-05-07 00:36:48 +020051 * Registers the ACL keyword list <kwl> as a list of valid keywords for next
52 * parsing sessions.
53 */
54void acl_register_keywords(struct acl_kw_list *kwl)
55{
56 LIST_ADDQ(&acl_keywords.list, &kwl->list);
57}
58
59/*
60 * Unregisters the ACL keyword list <kwl> from the list of valid keywords.
61 */
62void acl_unregister_keywords(struct acl_kw_list *kwl)
63{
64 LIST_DEL(&kwl->list);
65 LIST_INIT(&kwl->list);
66}
67
68/* Return a pointer to the ACL <name> within the list starting at <head>, or
69 * NULL if not found.
70 */
71struct acl *find_acl_by_name(const char *name, struct list *head)
72{
73 struct acl *acl;
74 list_for_each_entry(acl, head, list) {
75 if (strcmp(acl->name, name) == 0)
76 return acl;
77 }
78 return NULL;
79}
80
81/* Return a pointer to the ACL keyword <kw>, or NULL if not found. Note that if
Willy Tarreau4bfa4222013-12-16 22:01:06 +010082 * <kw> contains an opening parenthesis or a comma, only the left part of it is
83 * checked.
Willy Tarreaua84d3742007-05-07 00:36:48 +020084 */
85struct acl_keyword *find_acl_kw(const char *kw)
86{
87 int index;
88 const char *kwend;
89 struct acl_kw_list *kwl;
90
Willy Tarreau4bfa4222013-12-16 22:01:06 +010091 kwend = kw;
92 while (*kwend && *kwend != '(' && *kwend != ',')
93 kwend++;
Willy Tarreaua84d3742007-05-07 00:36:48 +020094
95 list_for_each_entry(kwl, &acl_keywords.list, list) {
96 for (index = 0; kwl->kw[index].kw != NULL; index++) {
97 if ((strncmp(kwl->kw[index].kw, kw, kwend - kw) == 0) &&
98 kwl->kw[index].kw[kwend-kw] == 0)
99 return &kwl->kw[index];
100 }
101 }
102 return NULL;
103}
104
Willy Tarreaua84d3742007-05-07 00:36:48 +0200105static struct acl_expr *prune_acl_expr(struct acl_expr *expr)
106{
Willy Tarreau34db1082012-04-19 17:16:54 +0200107 struct arg *arg;
Willy Tarreau145325e2017-04-12 23:03:31 +0200108 int unresolved = 0;
Willy Tarreau34db1082012-04-19 17:16:54 +0200109
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100110 pattern_prune(&expr->pat);
Willy Tarreau34db1082012-04-19 17:16:54 +0200111
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100112 for (arg = expr->smp->arg_p; arg; arg++) {
Willy Tarreau34db1082012-04-19 17:16:54 +0200113 if (arg->type == ARGT_STOP)
114 break;
Willy Tarreau496aa012012-06-01 10:38:29 +0200115 if (arg->type == ARGT_STR || arg->unresolved) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200116 free(arg->data.str.area);
117 arg->data.str.area = NULL;
118 arg->data.str.data = 0;
Willy Tarreau145325e2017-04-12 23:03:31 +0200119 unresolved |= arg->unresolved;
Willy Tarreau496aa012012-06-01 10:38:29 +0200120 arg->unresolved = 0;
Willy Tarreau34db1082012-04-19 17:16:54 +0200121 }
Willy Tarreau34db1082012-04-19 17:16:54 +0200122 }
123
Willy Tarreau145325e2017-04-12 23:03:31 +0200124 if (expr->smp->arg_p != empty_arg_list && !unresolved)
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100125 free(expr->smp->arg_p);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200126 return expr;
127}
128
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200129/* Parse an ACL expression starting at <args>[0], and return it. If <err> is
130 * not NULL, it will be filled with a pointer to an error message in case of
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200131 * error. This pointer must be freeable or NULL. <al> is an arg_list serving
132 * as a list head to report missing dependencies.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200133 *
Willy Tarreaua84d3742007-05-07 00:36:48 +0200134 * Right now, the only accepted syntax is :
135 * <subject> [<value>...]
136 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100137struct acl_expr *parse_acl_expr(const char **args, char **err, struct arg_list *al,
138 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200139{
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100140 __label__ out_return, out_free_expr;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200141 struct acl_expr *expr;
142 struct acl_keyword *aclkw;
Christopher Faulet54ceb042017-06-14 14:41:33 +0200143 int refflags, patflags;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200144 const char *arg;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100145 struct sample_expr *smp = NULL;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100146 int idx = 0;
147 char *ckw = NULL;
148 const char *begw;
149 const char *endw;
Willy Tarreau131b4662013-12-13 01:08:36 +0100150 const char *endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100151 int cur_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100152 int nbargs;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100153 int operator = STD_OP_EQ;
154 int op;
155 int contain_colon, have_dot;
156 const char *dot;
157 signed long long value, minor;
158 /* The following buffer contain two numbers, a ':' separator and the final \0. */
159 char buffer[NB_LLMAX_STR + 1 + NB_LLMAX_STR + 1];
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100160 int is_loaded;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100161 int unique_id;
162 char *error;
163 struct pat_ref *ref;
164 struct pattern_expr *pattern_expr;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100165 int load_as_map = 0;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200166 int acl_conv_found = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200167
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100168 /* First, we look for an ACL keyword. And if we don't find one, then
169 * we look for a sample fetch expression starting with a sample fetch
170 * keyword.
Willy Tarreaubef91e72013-03-31 23:14:46 +0200171 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100172
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100173 al->ctx = ARGC_ACL; // to report errors while resolving args late
Willy Tarreau131b4662013-12-13 01:08:36 +0100174 al->kw = *args;
175 al->conv = NULL;
176
Willy Tarreaua84d3742007-05-07 00:36:48 +0200177 aclkw = find_acl_kw(args[0]);
Willy Tarreau20490922014-03-17 18:04:27 +0100178 if (aclkw) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100179 /* OK we have a real ACL keyword */
Willy Tarreau9987ea92013-06-11 21:09:06 +0200180
Willy Tarreau131b4662013-12-13 01:08:36 +0100181 /* build new sample expression for this ACL */
Vincent Bernat02779b62016-04-03 13:48:43 +0200182 smp = calloc(1, sizeof(*smp));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100183 if (!smp) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100184 memprintf(err, "out of memory when parsing ACL expression");
185 goto out_return;
186 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100187 LIST_INIT(&(smp->conv_exprs));
188 smp->fetch = aclkw->smp;
189 smp->arg_p = empty_arg_list;
Willy Tarreau34db1082012-04-19 17:16:54 +0200190
Joseph Herlant68082792018-11-15 14:55:09 -0800191 /* look for the beginning of the subject arguments */
Willy Tarreau131b4662013-12-13 01:08:36 +0100192 for (arg = args[0]; *arg && *arg != '(' && *arg != ','; arg++);
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100193
Willy Tarreau131b4662013-12-13 01:08:36 +0100194 endt = arg;
195 if (*endt == '(') {
196 /* look for the end of this term and skip the opening parenthesis */
197 endt = ++arg;
198 while (*endt && *endt != ')')
199 endt++;
200 if (*endt != ')') {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100201 memprintf(err, "missing closing ')' after arguments to ACL keyword '%s'", aclkw->kw);
202 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100203 }
204 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100205
Willy Tarreau131b4662013-12-13 01:08:36 +0100206 /* At this point, we have :
207 * - args[0] : beginning of the keyword
208 * - arg : end of the keyword, first character not part of keyword
209 * nor the opening parenthesis (so first character of args
210 * if present).
211 * - endt : end of the term (=arg or last parenthesis if args are present)
212 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100213 nbargs = make_arg_list(arg, endt - arg, smp->fetch->arg_mask, &smp->arg_p,
Willy Tarreau131b4662013-12-13 01:08:36 +0100214 err, NULL, NULL, al);
215 if (nbargs < 0) {
216 /* note that make_arg_list will have set <err> here */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100217 memprintf(err, "ACL keyword '%s' : %s", aclkw->kw, *err);
218 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100219 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100220
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100221 if (!smp->arg_p) {
222 smp->arg_p = empty_arg_list;
Willy Tarreau131b4662013-12-13 01:08:36 +0100223 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100224 else if (smp->fetch->val_args && !smp->fetch->val_args(smp->arg_p, err)) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100225 /* invalid keyword argument, error must have been
226 * set by val_args().
227 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100228 memprintf(err, "in argument to '%s', %s", aclkw->kw, *err);
229 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100230 }
231 arg = endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100232
Joseph Herlant68082792018-11-15 14:55:09 -0800233 /* look for the beginning of the converters list. Those directly attached
Willy Tarreau131b4662013-12-13 01:08:36 +0100234 * to the ACL keyword are found just after <arg> which points to the comma.
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200235 * If we find any converter, then we don't use the ACL keyword's match
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200236 * anymore but the one related to the converter's output type.
Willy Tarreau131b4662013-12-13 01:08:36 +0100237 */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200238 cur_type = smp->fetch->out_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100239 while (*arg) {
240 struct sample_conv *conv;
241 struct sample_conv_expr *conv_expr;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100242
Willy Tarreau131b4662013-12-13 01:08:36 +0100243 if (*arg == ')') /* skip last closing parenthesis */
244 arg++;
245
246 if (*arg && *arg != ',') {
247 if (ckw)
Willy Tarreau97108e02016-11-25 07:33:24 +0100248 memprintf(err, "ACL keyword '%s' : missing comma after converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100249 aclkw->kw, ckw);
Willy Tarreau131b4662013-12-13 01:08:36 +0100250 else
251 memprintf(err, "ACL keyword '%s' : missing comma after fetch keyword.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100252 aclkw->kw);
253 goto out_free_smp;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200254 }
Willy Tarreauae52f062012-04-26 12:13:35 +0200255
Willy Tarreau131b4662013-12-13 01:08:36 +0100256 while (*arg == ',') /* then trailing commas */
257 arg++;
Willy Tarreau2e845be2012-10-19 19:49:09 +0200258
Willy Tarreau97108e02016-11-25 07:33:24 +0100259 begw = arg; /* start of converter keyword */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100260
Willy Tarreau131b4662013-12-13 01:08:36 +0100261 if (!*begw)
262 /* none ? end of converters */
263 break;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100264
Willy Tarreau131b4662013-12-13 01:08:36 +0100265 for (endw = begw; *endw && *endw != '(' && *endw != ','; endw++);
Willy Tarreau9ca69362013-10-22 19:10:06 +0200266
Willy Tarreau131b4662013-12-13 01:08:36 +0100267 free(ckw);
268 ckw = my_strndup(begw, endw - begw);
Willy Tarreauf75d0082013-04-07 21:20:44 +0200269
Willy Tarreau131b4662013-12-13 01:08:36 +0100270 conv = find_sample_conv(begw, endw - begw);
271 if (!conv) {
272 /* Unknown converter method */
Willy Tarreau97108e02016-11-25 07:33:24 +0100273 memprintf(err, "ACL keyword '%s' : unknown converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100274 aclkw->kw, ckw);
275 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100276 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100277
Willy Tarreau131b4662013-12-13 01:08:36 +0100278 arg = endw;
279 if (*arg == '(') {
280 /* look for the end of this term */
281 while (*arg && *arg != ')')
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100282 arg++;
Willy Tarreau131b4662013-12-13 01:08:36 +0100283 if (*arg != ')') {
Willy Tarreau97108e02016-11-25 07:33:24 +0100284 memprintf(err, "ACL keyword '%s' : syntax error: missing ')' after converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100285 aclkw->kw, ckw);
286 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100287 }
Willy Tarreau131b4662013-12-13 01:08:36 +0100288 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100289
Willy Tarreau131b4662013-12-13 01:08:36 +0100290 if (conv->in_type >= SMP_TYPES || conv->out_type >= SMP_TYPES) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100291 memprintf(err, "ACL keyword '%s' : returns type of converter '%s' is unknown.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100292 aclkw->kw, ckw);
293 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100294 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100295
Willy Tarreau131b4662013-12-13 01:08:36 +0100296 /* If impossible type conversion */
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200297 if (!sample_casts[cur_type][conv->in_type]) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100298 memprintf(err, "ACL keyword '%s' : converter '%s' cannot be applied.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100299 aclkw->kw, ckw);
300 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100301 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100302
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200303 cur_type = conv->out_type;
Vincent Bernat02779b62016-04-03 13:48:43 +0200304 conv_expr = calloc(1, sizeof(*conv_expr));
Willy Tarreau131b4662013-12-13 01:08:36 +0100305 if (!conv_expr)
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100306 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100307
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100308 LIST_ADDQ(&(smp->conv_exprs), &(conv_expr->list));
Willy Tarreau131b4662013-12-13 01:08:36 +0100309 conv_expr->conv = conv;
Willy Tarreau6f0ddca2014-08-29 17:36:40 +0200310 acl_conv_found = 1;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100311
Willy Tarreau131b4662013-12-13 01:08:36 +0100312 if (arg != endw) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100313 int err_arg;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100314
Willy Tarreau131b4662013-12-13 01:08:36 +0100315 if (!conv->arg_mask) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100316 memprintf(err, "ACL keyword '%s' : converter '%s' does not support any args.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100317 aclkw->kw, ckw);
318 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100319 }
320
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100321 al->kw = smp->fetch->kw;
Willy Tarreau131b4662013-12-13 01:08:36 +0100322 al->conv = conv_expr->conv->kw;
Willy Tarreauadaddc22013-12-13 01:30:22 +0100323 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 +0100324 memprintf(err, "ACL keyword '%s' : invalid arg %d in converter '%s' : %s.",
Willy Tarreauadaddc22013-12-13 01:30:22 +0100325 aclkw->kw, err_arg+1, ckw, *err);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100326 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100327 }
328
Willy Tarreau131b4662013-12-13 01:08:36 +0100329 if (!conv_expr->arg_p)
330 conv_expr->arg_p = empty_arg_list;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100331
Thierry FOURNIEReeaa9512014-02-11 14:00:19 +0100332 if (conv->val_args && !conv->val_args(conv_expr->arg_p, conv, file, line, err)) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100333 memprintf(err, "ACL keyword '%s' : invalid args in converter '%s' : %s.",
Willy Tarreauadaddc22013-12-13 01:30:22 +0100334 aclkw->kw, ckw, *err);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100335 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100336 }
337 }
Willy Tarreau131b4662013-12-13 01:08:36 +0100338 else if (ARGM(conv->arg_mask)) {
Willy Tarreau97108e02016-11-25 07:33:24 +0100339 memprintf(err, "ACL keyword '%s' : missing args for converter '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100340 aclkw->kw, ckw);
341 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100342 }
Willy Tarreau61612d42012-04-19 18:42:05 +0200343 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200344 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100345 else {
346 /* This is not an ACL keyword, so we hope this is a sample fetch
347 * keyword that we're going to transparently use as an ACL. If
348 * so, we retrieve a completely parsed expression with args and
349 * convs already done.
350 */
Thierry FOURNIEReeaa9512014-02-11 14:00:19 +0100351 smp = sample_parse_expr((char **)args, &idx, file, line, err, al);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100352 if (!smp) {
353 memprintf(err, "%s in ACL expression '%s'", *err, *args);
354 goto out_return;
355 }
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200356 cur_type = smp_expr_output_type(smp);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100357 }
358
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200359 expr = calloc(1, sizeof(*expr));
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100360 if (!expr) {
361 memprintf(err, "out of memory when parsing ACL expression");
362 goto out_return;
363 }
364
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100365 pattern_init_head(&expr->pat);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100366
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200367 expr->pat.expect_type = cur_type;
368 expr->smp = smp;
369 expr->kw = smp->fetch->kw;
370 smp = NULL; /* don't free it anymore */
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100371
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200372 if (aclkw && !acl_conv_found) {
373 expr->kw = aclkw->kw;
374 expr->pat.parse = aclkw->parse ? aclkw->parse : pat_parse_fcts[aclkw->match_type];
375 expr->pat.index = aclkw->index ? aclkw->index : pat_index_fcts[aclkw->match_type];
376 expr->pat.match = aclkw->match ? aclkw->match : pat_match_fcts[aclkw->match_type];
377 expr->pat.delete = aclkw->delete ? aclkw->delete : pat_delete_fcts[aclkw->match_type];
378 expr->pat.prune = aclkw->prune ? aclkw->prune : pat_prune_fcts[aclkw->match_type];
Thierry FOURNIERc5a4e982014-03-05 16:07:08 +0100379 }
380
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100381 if (!expr->pat.parse) {
Willy Tarreauaa4e32e2014-08-29 19:09:48 +0200382 /* Parse/index/match functions depend on the expression type,
383 * so we have to map them now. Some types can be automatically
384 * converted.
385 */
386 switch (cur_type) {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100387 case SMP_T_BOOL:
388 expr->pat.parse = pat_parse_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100389 expr->pat.index = pat_index_fcts[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100390 expr->pat.match = pat_match_fcts[PAT_MATCH_BOOL];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100391 expr->pat.delete = pat_delete_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100392 expr->pat.prune = pat_prune_fcts[PAT_MATCH_BOOL];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100393 expr->pat.expect_type = pat_match_types[PAT_MATCH_BOOL];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100394 break;
395 case SMP_T_SINT:
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100396 expr->pat.parse = pat_parse_fcts[PAT_MATCH_INT];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100397 expr->pat.index = pat_index_fcts[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100398 expr->pat.match = pat_match_fcts[PAT_MATCH_INT];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100399 expr->pat.delete = pat_delete_fcts[PAT_MATCH_INT];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100400 expr->pat.prune = pat_prune_fcts[PAT_MATCH_INT];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100401 expr->pat.expect_type = pat_match_types[PAT_MATCH_INT];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100402 break;
403 case SMP_T_IPV4:
404 case SMP_T_IPV6:
405 expr->pat.parse = pat_parse_fcts[PAT_MATCH_IP];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100406 expr->pat.index = pat_index_fcts[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100407 expr->pat.match = pat_match_fcts[PAT_MATCH_IP];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100408 expr->pat.delete = pat_delete_fcts[PAT_MATCH_IP];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100409 expr->pat.prune = pat_prune_fcts[PAT_MATCH_IP];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100410 expr->pat.expect_type = pat_match_types[PAT_MATCH_IP];
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100411 break;
Thierry FOURNIER9fefbd52014-05-11 15:15:00 +0200412 case SMP_T_STR:
413 expr->pat.parse = pat_parse_fcts[PAT_MATCH_STR];
414 expr->pat.index = pat_index_fcts[PAT_MATCH_STR];
415 expr->pat.match = pat_match_fcts[PAT_MATCH_STR];
416 expr->pat.delete = pat_delete_fcts[PAT_MATCH_STR];
417 expr->pat.prune = pat_prune_fcts[PAT_MATCH_STR];
418 expr->pat.expect_type = pat_match_types[PAT_MATCH_STR];
419 break;
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100420 }
421 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200422
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100423 /* Additional check to protect against common mistakes */
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100424 if (expr->pat.parse && cur_type != SMP_T_BOOL && !*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100425 ha_warning("parsing acl keyword '%s' :\n"
426 " no pattern to match against were provided, so this ACL will never match.\n"
427 " If this is what you intended, please add '--' to get rid of this warning.\n"
428 " If you intended to match only for existence, please use '-m found'.\n"
429 " If you wanted to force an int to match as a bool, please use '-m bool'.\n"
430 "\n",
431 args[0]);
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100432 }
433
Willy Tarreaua84d3742007-05-07 00:36:48 +0200434 args++;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200435
436 /* check for options before patterns. Supported options are :
437 * -i : ignore case for all patterns by default
438 * -f : read patterns from those files
Willy Tarreau5adeda12013-03-31 22:13:34 +0200439 * -m : force matching method (must be used before -f)
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100440 * -M : load the file as map file
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100441 * -u : force the unique id of the acl
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200442 * -- : everything after this is not an option
443 */
Christopher Faulet54ceb042017-06-14 14:41:33 +0200444 refflags = PAT_REF_ACL;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200445 patflags = 0;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100446 is_loaded = 0;
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100447 unique_id = -1;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200448 while (**args == '-') {
Willy Tarreau2039bba2014-05-11 09:43:46 +0200449 if (strcmp(*args, "-i") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200450 patflags |= PAT_MF_IGNORE_CASE;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200451 else if (strcmp(*args, "-n") == 0)
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200452 patflags |= PAT_MF_NO_DNS;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200453 else if (strcmp(*args, "-u") == 0) {
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100454 unique_id = strtol(args[1], &error, 10);
455 if (*error != '\0') {
456 memprintf(err, "the argument of -u must be an integer");
457 goto out_free_expr;
458 }
459
460 /* Check if this id is really unique. */
461 if (pat_ref_lookupid(unique_id)) {
462 memprintf(err, "the id is already used");
463 goto out_free_expr;
464 }
465
466 args++;
467 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200468 else if (strcmp(*args, "-f") == 0) {
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100469 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200470 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 +0200471 goto out_free_expr;
472 }
473
Christopher Faulet54ceb042017-06-14 14:41:33 +0200474 if (!pattern_read_from_file(&expr->pat, refflags, args[1], patflags, load_as_map, err, file, line))
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200475 goto out_free_expr;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100476 is_loaded = 1;
Willy Tarreau5adeda12013-03-31 22:13:34 +0200477 args++;
478 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200479 else if (strcmp(*args, "-m") == 0) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200480 int idx;
481
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100482 if (is_loaded) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200483 memprintf(err, "'-m' must only be specified before patterns and files in parsing ACL expression");
484 goto out_free_expr;
485 }
486
Willy Tarreau6f8fe312013-11-28 22:24:25 +0100487 idx = pat_find_match_name(args[1]);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200488 if (idx < 0) {
489 memprintf(err, "unknown matching method '%s' when parsing ACL expression", args[1]);
490 goto out_free_expr;
491 }
492
493 /* Note: -m found is always valid, bool/int are compatible, str/bin/reg/len are compatible */
Willy Tarreau9bb49f62015-09-24 16:37:12 +0200494 if (idx != PAT_MATCH_FOUND && !sample_casts[cur_type][pat_match_types[idx]]) {
Willy Tarreau93fddf12013-03-31 22:59:32 +0200495 memprintf(err, "matching method '%s' cannot be used with fetch keyword '%s'", args[1], expr->kw);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200496 goto out_free_expr;
497 }
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100498 expr->pat.parse = pat_parse_fcts[idx];
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100499 expr->pat.index = pat_index_fcts[idx];
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100500 expr->pat.match = pat_match_fcts[idx];
Thierry FOURNIERb1136502014-01-15 11:38:49 +0100501 expr->pat.delete = pat_delete_fcts[idx];
Thierry FOURNIER6f7203d2014-01-14 16:24:51 +0100502 expr->pat.prune = pat_prune_fcts[idx];
Thierry FOURNIER5d344082014-01-27 14:19:53 +0100503 expr->pat.expect_type = pat_match_types[idx];
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200504 args++;
505 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200506 else if (strcmp(*args, "-M") == 0) {
Christopher Faulet54ceb042017-06-14 14:41:33 +0200507 refflags |= PAT_REF_MAP;
Thierry FOURNIER9860c412014-01-29 14:23:29 +0100508 load_as_map = 1;
509 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200510 else if (strcmp(*args, "--") == 0) {
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200511 args++;
512 break;
513 }
Willy Tarreau2039bba2014-05-11 09:43:46 +0200514 else {
515 memprintf(err, "'%s' is not a valid ACL option. Please use '--' before any pattern beginning with a '-'", args[0]);
516 goto out_free_expr;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200517 break;
Willy Tarreau2039bba2014-05-11 09:43:46 +0200518 }
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200519 args++;
520 }
521
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100522 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200523 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 +0200524 goto out_free_expr;
525 }
526
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100527 /* Create displayed reference */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200528 snprintf(trash.area, trash.size, "acl '%s' file '%s' line %d",
529 expr->kw, file, line);
530 trash.area[trash.size - 1] = '\0';
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100531
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100532 /* Create new patern reference. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200533 ref = pat_ref_newid(unique_id, trash.area, PAT_REF_ACL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100534 if (!ref) {
535 memprintf(err, "memory error");
536 goto out_free_expr;
537 }
538
539 /* Create new pattern expression associated to this reference. */
Emeric Brun7d27f3c2017-07-03 17:54:23 +0200540 pattern_expr = pattern_new_expr(&expr->pat, ref, patflags, err, NULL);
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100541 if (!pattern_expr)
542 goto out_free_expr;
543
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200544 /* now parse all patterns */
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100545 while (**args) {
546 arg = *args;
547
548 /* Compatibility layer. Each pattern can parse only one string per pattern,
549 * but the pat_parser_int() and pat_parse_dotted_ver() parsers were need
550 * optionnaly two operators. The first operator is the match method: eq,
551 * le, lt, ge and gt. pat_parse_int() and pat_parse_dotted_ver() functions
552 * can have a compatibility syntax based on ranges:
553 *
554 * pat_parse_int():
555 *
556 * "eq x" -> "x" or "x:x"
557 * "le x" -> ":x"
558 * "lt x" -> ":y" (with y = x - 1)
559 * "ge x" -> "x:"
560 * "gt x" -> "y:" (with y = x + 1)
561 *
562 * pat_parse_dotted_ver():
563 *
564 * "eq x.y" -> "x.y" or "x.y:x.y"
565 * "le x.y" -> ":x.y"
566 * "lt x.y" -> ":w.z" (with w.z = x.y - 1)
567 * "ge x.y" -> "x.y:"
568 * "gt x.y" -> "w.z:" (with w.z = x.y + 1)
569 *
570 * If y is not present, assume that is "0".
571 *
572 * The syntax eq, le, lt, ge and gt are proper to the acl syntax. The
573 * following block of code detect the operator, and rewrite each value
574 * in parsable string.
575 */
576 if (expr->pat.parse == pat_parse_int ||
577 expr->pat.parse == pat_parse_dotted_ver) {
578 /* Check for operator. If the argument is operator, memorise it and
579 * continue to the next argument.
580 */
581 op = get_std_op(arg);
582 if (op != -1) {
583 operator = op;
584 args++;
585 continue;
586 }
587
588 /* Check if the pattern contain ':' or '-' character. */
589 contain_colon = (strchr(arg, ':') || strchr(arg, '-'));
590
591 /* If the pattern contain ':' or '-' character, give it to the parser as is.
592 * If no contain ':' and operator is STD_OP_EQ, give it to the parser as is.
593 * In other case, try to convert the value according with the operator.
594 */
595 if (!contain_colon && operator != STD_OP_EQ) {
596 /* Search '.' separator. */
597 dot = strchr(arg, '.');
598 if (!dot) {
599 have_dot = 0;
600 minor = 0;
601 dot = arg + strlen(arg);
602 }
603 else
604 have_dot = 1;
605
606 /* convert the integer minor part for the pat_parse_dotted_ver() function. */
607 if (expr->pat.parse == pat_parse_dotted_ver && have_dot) {
608 if (strl2llrc(dot+1, strlen(dot+1), &minor) != 0) {
609 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100610 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100611 }
612 if (minor >= 65536) {
613 memprintf(err, "'%s' contains too large a minor value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100614 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100615 }
616 }
617
618 /* convert the integer value for the pat_parse_int() function, and the
619 * integer major part for the pat_parse_dotted_ver() function.
620 */
621 if (strl2llrc(arg, dot - arg, &value) != 0) {
622 memprintf(err, "'%s' is neither a number nor a supported operator", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100623 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100624 }
625 if (expr->pat.parse == pat_parse_dotted_ver) {
626 if (value >= 65536) {
627 memprintf(err, "'%s' contains too large a major value", arg);
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100628 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100629 }
630 value = (value << 16) | (minor & 0xffff);
631 }
632
633 switch (operator) {
634
635 case STD_OP_EQ: /* this case is not possible. */
636 memprintf(err, "internal error");
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100637 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100638
639 case STD_OP_GT:
640 value++; /* gt = ge + 1 */
641
642 case STD_OP_GE:
643 if (expr->pat.parse == pat_parse_int)
644 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld:", value);
645 else
646 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, "%lld.%lld:",
647 value >> 16, value & 0xffff);
648 arg = buffer;
649 break;
650
651 case STD_OP_LT:
652 value--; /* lt = le - 1 */
653
654 case STD_OP_LE:
655 if (expr->pat.parse == pat_parse_int)
656 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld", value);
657 else
658 snprintf(buffer, NB_LLMAX_STR+NB_LLMAX_STR+2, ":%lld.%lld",
659 value >> 16, value & 0xffff);
660 arg = buffer;
661 break;
662 }
663 }
664 }
665
Thierry FOURNIER3534d882014-01-20 17:01:44 +0100666 /* Add sample to the reference, and try to compile it fior each pattern
667 * using this value.
668 */
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200669 if (!pat_ref_add(ref, arg, NULL, err))
Thierry FOURNIERb9b08462013-12-13 15:12:32 +0100670 goto out_free_expr;
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100671 args++;
672 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200673
674 return expr;
675
Willy Tarreaua84d3742007-05-07 00:36:48 +0200676 out_free_expr:
677 prune_acl_expr(expr);
678 free(expr);
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100679 free(ckw);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100680 out_free_smp:
681 free(smp);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200682 out_return:
683 return NULL;
684}
685
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200686/* Purge everything in the acl <acl>, then return <acl>. */
687struct acl *prune_acl(struct acl *acl) {
688
689 struct acl_expr *expr, *exprb;
690
691 free(acl->name);
692
693 list_for_each_entry_safe(expr, exprb, &acl->expr, list) {
694 LIST_DEL(&expr->list);
695 prune_acl_expr(expr);
696 free(expr);
697 }
698
699 return acl;
700}
701
Willy Tarreaua84d3742007-05-07 00:36:48 +0200702/* Parse an ACL with the name starting at <args>[0], and with a list of already
703 * known ACLs in <acl>. If the ACL was not in the list, it will be added.
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100704 * A pointer to that ACL is returned. If the ACL has an empty name, then it's
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200705 * an anonymous one and it won't be merged with any other one. If <err> is not
706 * NULL, it will be filled with an appropriate error. This pointer must be
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200707 * freeable or NULL. <al> is the arg_list serving as a head for unresolved
708 * dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200709 *
710 * args syntax: <aclname> <acl_expr>
711 */
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100712struct acl *parse_acl(const char **args, struct list *known_acl, char **err, struct arg_list *al,
713 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200714{
715 __label__ out_return, out_free_acl_expr, out_free_name;
716 struct acl *cur_acl;
717 struct acl_expr *acl_expr;
718 char *name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200719 const char *pos;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200720
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200721 if (**args && (pos = invalid_char(*args))) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200722 memprintf(err, "invalid character in ACL name : '%c'", *pos);
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100723 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200724 }
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100725
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100726 acl_expr = parse_acl_expr(args + 1, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200727 if (!acl_expr) {
728 /* parse_acl_expr will have filled <err> here */
Willy Tarreaua84d3742007-05-07 00:36:48 +0200729 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200730 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200731
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200732 /* Check for args beginning with an opening parenthesis just after the
733 * subject, as this is almost certainly a typo. Right now we can only
734 * emit a warning, so let's do so.
735 */
Krzysztof Piotr Oledzki4cdd8312009-10-05 00:23:35 +0200736 if (!strchr(args[1], '(') && *args[2] == '(')
Christopher Faulet767a84b2017-11-24 16:50:31 +0100737 ha_warning("parsing acl '%s' :\n"
738 " matching '%s' for pattern '%s' is likely a mistake and probably\n"
739 " not what you want. Maybe you need to remove the extraneous space before '('.\n"
740 " If you are really sure this is not an error, please insert '--' between the\n"
741 " match and the pattern to make this warning message disappear.\n",
742 args[0], args[1], args[2]);
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200743
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100744 if (*args[0])
745 cur_acl = find_acl_by_name(args[0], known_acl);
746 else
747 cur_acl = NULL;
748
Willy Tarreaua84d3742007-05-07 00:36:48 +0200749 if (!cur_acl) {
750 name = strdup(args[0]);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200751 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200752 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200753 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200754 }
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200755 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200756 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200757 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200758 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200759 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200760
761 LIST_INIT(&cur_acl->expr);
762 LIST_ADDQ(known_acl, &cur_acl->list);
763 cur_acl->name = name;
764 }
765
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100766 /* We want to know what features the ACL needs (typically HTTP parsing),
767 * and where it may be used. If an ACL relies on multiple matches, it is
768 * OK if at least one of them may match in the context where it is used.
769 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100770 cur_acl->use |= acl_expr->smp->fetch->use;
771 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200772 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
773 return cur_acl;
774
775 out_free_name:
776 free(name);
777 out_free_acl_expr:
778 prune_acl_expr(acl_expr);
779 free(acl_expr);
780 out_return:
781 return NULL;
782}
783
Willy Tarreau16fbe822007-06-17 11:54:31 +0200784/* Some useful ACLs provided by default. Only those used are allocated. */
785
786const struct {
787 const char *name;
788 const char *expr[4]; /* put enough for longest expression */
789} default_acl_list[] = {
Willy Tarreau58393e12008-07-20 10:39:22 +0200790 { .name = "TRUE", .expr = {"always_true",""}},
791 { .name = "FALSE", .expr = {"always_false",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200792 { .name = "LOCALHOST", .expr = {"src","127.0.0.1/8",""}},
Willy Tarreau2492d5b2009-07-11 00:06:00 +0200793 { .name = "HTTP", .expr = {"req_proto_http",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200794 { .name = "HTTP_1.0", .expr = {"req_ver","1.0",""}},
795 { .name = "HTTP_1.1", .expr = {"req_ver","1.1",""}},
796 { .name = "METH_CONNECT", .expr = {"method","CONNECT",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200797 { .name = "METH_DELETE", .expr = {"method","DELETE",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200798 { .name = "METH_GET", .expr = {"method","GET","HEAD",""}},
799 { .name = "METH_HEAD", .expr = {"method","HEAD",""}},
800 { .name = "METH_OPTIONS", .expr = {"method","OPTIONS",""}},
801 { .name = "METH_POST", .expr = {"method","POST",""}},
Daniel Schneller9ff96c72016-04-11 17:45:29 +0200802 { .name = "METH_PUT", .expr = {"method","PUT",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200803 { .name = "METH_TRACE", .expr = {"method","TRACE",""}},
804 { .name = "HTTP_URL_ABS", .expr = {"url_reg","^[^/:]*://",""}},
805 { .name = "HTTP_URL_SLASH", .expr = {"url_beg","/",""}},
806 { .name = "HTTP_URL_STAR", .expr = {"url","*",""}},
807 { .name = "HTTP_CONTENT", .expr = {"hdr_val(content-length)","gt","0",""}},
Emeric Brunbede3d02009-06-30 17:54:00 +0200808 { .name = "RDP_COOKIE", .expr = {"req_rdp_cookie_cnt","gt","0",""}},
Willy Tarreauc6317702008-07-20 09:29:50 +0200809 { .name = "REQ_CONTENT", .expr = {"req_len","gt","0",""}},
Willy Tarreaub6fb4202008-07-20 11:18:28 +0200810 { .name = "WAIT_END", .expr = {"wait_end",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200811 { .name = NULL, .expr = {""}}
812};
813
814/* Find a default ACL from the default_acl list, compile it and return it.
815 * If the ACL is not found, NULL is returned. In theory, it cannot fail,
816 * except when default ACLs are broken, in which case it will return NULL.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200817 * If <known_acl> is not NULL, the ACL will be queued at its tail. If <err> is
818 * not NULL, it will be filled with an error message if an error occurs. This
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200819 * pointer must be freeable or NULL. <al> is an arg_list serving as a list head
820 * to report missing dependencies.
Willy Tarreau16fbe822007-06-17 11:54:31 +0200821 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200822static struct acl *find_acl_default(const char *acl_name, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100823 char **err, struct arg_list *al,
824 const char *file, int line)
Willy Tarreau16fbe822007-06-17 11:54:31 +0200825{
826 __label__ out_return, out_free_acl_expr, out_free_name;
827 struct acl *cur_acl;
828 struct acl_expr *acl_expr;
829 char *name;
830 int index;
831
832 for (index = 0; default_acl_list[index].name != NULL; index++) {
833 if (strcmp(acl_name, default_acl_list[index].name) == 0)
834 break;
835 }
836
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200837 if (default_acl_list[index].name == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200838 memprintf(err, "no such ACL : '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200839 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200840 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200841
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100842 acl_expr = parse_acl_expr((const char **)default_acl_list[index].expr, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200843 if (!acl_expr) {
844 /* parse_acl_expr must have filled err here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200845 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200846 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200847
848 name = strdup(acl_name);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200849 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200850 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200851 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200852 }
853
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200854 cur_acl = calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200855 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200856 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200857 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200858 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200859
860 cur_acl->name = name;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100861 cur_acl->use |= acl_expr->smp->fetch->use;
862 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreau16fbe822007-06-17 11:54:31 +0200863 LIST_INIT(&cur_acl->expr);
864 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
865 if (known_acl)
866 LIST_ADDQ(known_acl, &cur_acl->list);
867
868 return cur_acl;
869
870 out_free_name:
871 free(name);
872 out_free_acl_expr:
873 prune_acl_expr(acl_expr);
874 free(acl_expr);
875 out_return:
876 return NULL;
877}
Willy Tarreaua84d3742007-05-07 00:36:48 +0200878
879/* Purge everything in the acl_cond <cond>, then return <cond>. */
880struct acl_cond *prune_acl_cond(struct acl_cond *cond)
881{
882 struct acl_term_suite *suite, *tmp_suite;
883 struct acl_term *term, *tmp_term;
884
885 /* iterate through all term suites and free all terms and all suites */
886 list_for_each_entry_safe(suite, tmp_suite, &cond->suites, list) {
887 list_for_each_entry_safe(term, tmp_term, &suite->terms, list)
888 free(term);
889 free(suite);
890 }
891 return cond;
892}
893
894/* Parse an ACL condition starting at <args>[0], relying on a list of already
895 * known ACLs passed in <known_acl>. The new condition is returned (or NULL in
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200896 * case of low memory). Supports multiple conditions separated by "or". If
897 * <err> is not NULL, it will be filled with a pointer to an error message in
898 * case of error, that the caller is responsible for freeing. The initial
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200899 * location must either be freeable or NULL. The list <al> serves as a list head
900 * for unresolved dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200901 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200902struct acl_cond *parse_acl_cond(const char **args, struct list *known_acl,
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100903 enum acl_cond_pol pol, char **err, struct arg_list *al,
904 const char *file, int line)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200905{
906 __label__ out_return, out_free_suite, out_free_term;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200907 int arg, neg;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200908 const char *word;
909 struct acl *cur_acl;
910 struct acl_term *cur_term;
911 struct acl_term_suite *cur_suite;
912 struct acl_cond *cond;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100913 unsigned int suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200914
Vincent Bernat3c2f2f22016-04-03 13:48:42 +0200915 cond = calloc(1, sizeof(*cond));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200916 if (cond == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200917 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200918 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200919 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200920
921 LIST_INIT(&cond->list);
922 LIST_INIT(&cond->suites);
923 cond->pol = pol;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100924 cond->val = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200925
926 cur_suite = NULL;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100927 suite_val = ~0U;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200928 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200929 for (arg = 0; *args[arg]; arg++) {
930 word = args[arg];
931
932 /* remove as many exclamation marks as we can */
933 while (*word == '!') {
934 neg = !neg;
935 word++;
936 }
937
938 /* an empty word is allowed because we cannot force the user to
939 * always think about not leaving exclamation marks alone.
940 */
941 if (!*word)
942 continue;
943
Willy Tarreau16fbe822007-06-17 11:54:31 +0200944 if (strcasecmp(word, "or") == 0 || strcmp(word, "||") == 0) {
Willy Tarreaua84d3742007-05-07 00:36:48 +0200945 /* new term suite */
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100946 cond->val |= suite_val;
947 suite_val = ~0U;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200948 cur_suite = NULL;
949 neg = 0;
950 continue;
951 }
952
Willy Tarreau95fa4692010-02-01 13:05:50 +0100953 if (strcmp(word, "{") == 0) {
954 /* we may have a complete ACL expression between two braces,
955 * find the last one.
956 */
957 int arg_end = arg + 1;
958 const char **args_new;
959
960 while (*args[arg_end] && strcmp(args[arg_end], "}") != 0)
961 arg_end++;
962
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200963 if (!*args[arg_end]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200964 memprintf(err, "missing closing '}' in condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100965 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200966 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100967
968 args_new = calloc(1, (arg_end - arg + 1) * sizeof(*args_new));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200969 if (!args_new) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200970 memprintf(err, "out of memory when parsing condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100971 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200972 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100973
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100974 args_new[0] = "";
Willy Tarreau95fa4692010-02-01 13:05:50 +0100975 memcpy(args_new + 1, args + arg + 1, (arg_end - arg) * sizeof(*args_new));
976 args_new[arg_end - arg] = "";
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100977 cur_acl = parse_acl(args_new, known_acl, err, al, file, line);
Willy Tarreau95fa4692010-02-01 13:05:50 +0100978 free(args_new);
979
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200980 if (!cur_acl) {
981 /* note that parse_acl() must have filled <err> here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200982 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200983 }
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100984 word = args[arg + 1];
Willy Tarreau95fa4692010-02-01 13:05:50 +0100985 arg = arg_end;
986 }
987 else {
988 /* search for <word> in the known ACL names. If we do not find
989 * it, let's look for it in the default ACLs, and if found, add
990 * it to the list of ACLs of this proxy. This makes it possible
991 * to override them.
992 */
993 cur_acl = find_acl_by_name(word, known_acl);
994 if (cur_acl == NULL) {
Thierry FOURNIER0d6ba512014-02-11 03:31:34 +0100995 cur_acl = find_acl_default(word, known_acl, err, al, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200996 if (cur_acl == NULL) {
997 /* note that find_acl_default() must have filled <err> here */
Willy Tarreau95fa4692010-02-01 13:05:50 +0100998 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200999 }
Willy Tarreau95fa4692010-02-01 13:05:50 +01001000 }
Willy Tarreau16fbe822007-06-17 11:54:31 +02001001 }
Willy Tarreaua84d3742007-05-07 00:36:48 +02001002
Vincent Bernat3c2f2f22016-04-03 13:48:42 +02001003 cur_term = calloc(1, sizeof(*cur_term));
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001004 if (cur_term == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001005 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +02001006 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001007 }
Willy Tarreaua84d3742007-05-07 00:36:48 +02001008
1009 cur_term->acl = cur_acl;
1010 cur_term->neg = neg;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001011
1012 /* Here it is a bit complex. The acl_term_suite is a conjunction
1013 * of many terms. It may only be used if all of its terms are
1014 * usable at the same time. So the suite's validity domain is an
1015 * AND between all ACL keywords' ones. But, the global condition
1016 * is valid if at least one term suite is OK. So it's an OR between
1017 * all of their validity domains. We could emit a warning as soon
1018 * as suite_val is null because it means that the last ACL is not
1019 * compatible with the previous ones. Let's remain simple for now.
1020 */
1021 cond->use |= cur_acl->use;
1022 suite_val &= cur_acl->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001023
1024 if (!cur_suite) {
Vincent Bernat3c2f2f22016-04-03 13:48:42 +02001025 cur_suite = calloc(1, sizeof(*cur_suite));
Willy Tarreauf678b7f2013-01-24 00:25:39 +01001026 if (cur_suite == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001027 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +02001028 goto out_free_term;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001029 }
Willy Tarreaua84d3742007-05-07 00:36:48 +02001030 LIST_INIT(&cur_suite->terms);
1031 LIST_ADDQ(&cond->suites, &cur_suite->list);
1032 }
1033 LIST_ADDQ(&cur_suite->terms, &cur_term->list);
Willy Tarreau74b98a82007-06-16 19:35:18 +02001034 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001035 }
1036
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001037 cond->val |= suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001038 return cond;
1039
1040 out_free_term:
1041 free(cur_term);
1042 out_free_suite:
1043 prune_acl_cond(cond);
1044 free(cond);
1045 out_return:
1046 return NULL;
1047}
1048
Willy Tarreau2bbba412010-01-28 16:48:33 +01001049/* Builds an ACL condition starting at the if/unless keyword. The complete
1050 * condition is returned. NULL is returned in case of error or if the first
1051 * word is neither "if" nor "unless". It automatically sets the file name and
Willy Tarreau25320b22013-03-24 07:22:08 +01001052 * the line number in the condition for better error reporting, and sets the
1053 * HTTP intiailization requirements in the proxy. If <err> is not NULL, it will
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001054 * be filled with a pointer to an error message in case of error, that the
1055 * caller is responsible for freeing. The initial location must either be
1056 * freeable or NULL.
Willy Tarreau2bbba412010-01-28 16:48:33 +01001057 */
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001058struct acl_cond *build_acl_cond(const char *file, int line, struct list *known_acl,
1059 struct proxy *px, const char **args, char **err)
Willy Tarreau2bbba412010-01-28 16:48:33 +01001060{
Willy Tarreau0cba6072013-11-28 22:21:02 +01001061 enum acl_cond_pol pol = ACL_COND_NONE;
Willy Tarreau2bbba412010-01-28 16:48:33 +01001062 struct acl_cond *cond = NULL;
1063
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001064 if (err)
1065 *err = NULL;
1066
Willy Tarreau2bbba412010-01-28 16:48:33 +01001067 if (!strcmp(*args, "if")) {
1068 pol = ACL_COND_IF;
1069 args++;
1070 }
1071 else if (!strcmp(*args, "unless")) {
1072 pol = ACL_COND_UNLESS;
1073 args++;
1074 }
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001075 else {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001076 memprintf(err, "conditions must start with either 'if' or 'unless'");
Willy Tarreau2bbba412010-01-28 16:48:33 +01001077 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001078 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001079
Christopher Faulet1b421ea2017-09-22 14:38:56 +02001080 cond = parse_acl_cond(args, known_acl, pol, err, &px->conf.args, file, line);
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001081 if (!cond) {
1082 /* note that parse_acl_cond must have filled <err> here */
Willy Tarreau2bbba412010-01-28 16:48:33 +01001083 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +02001084 }
Willy Tarreau2bbba412010-01-28 16:48:33 +01001085
1086 cond->file = file;
1087 cond->line = line;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001088 px->http_needed |= !!(cond->use & SMP_USE_HTTP_ANY);
Willy Tarreau2bbba412010-01-28 16:48:33 +01001089 return cond;
1090}
1091
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001092/* Execute condition <cond> and return either ACL_TEST_FAIL, ACL_TEST_MISS or
1093 * ACL_TEST_PASS depending on the test results. ACL_TEST_MISS may only be
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001094 * returned if <opt> does not contain SMP_OPT_FINAL, indicating that incomplete
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001095 * data is being examined. The function automatically sets SMP_OPT_ITERATE. This
1096 * function only computes the condition, it does not apply the polarity required
1097 * by IF/UNLESS, it's up to the caller to do this using something like this :
Willy Tarreau11382812008-07-09 16:18:21 +02001098 *
1099 * res = acl_pass(res);
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001100 * if (res == ACL_TEST_MISS)
Willy Tarreaub6866442008-07-14 23:54:42 +02001101 * return 0;
Willy Tarreau11382812008-07-09 16:18:21 +02001102 * if (cond->pol == ACL_COND_UNLESS)
1103 * res = !res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001104 */
Willy Tarreau192252e2015-04-04 01:47:55 +02001105enum 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 +02001106{
1107 __label__ fetch_next;
1108 struct acl_term_suite *suite;
1109 struct acl_term *term;
1110 struct acl_expr *expr;
1111 struct acl *acl;
Willy Tarreau37406352012-04-23 16:16:37 +02001112 struct sample smp;
Willy Tarreau0cba6072013-11-28 22:21:02 +01001113 enum acl_test_res acl_res, suite_res, cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001114
Willy Tarreau7a777ed2012-04-26 11:44:02 +02001115 /* ACLs are iterated over all values, so let's always set the flag to
1116 * indicate this to the fetch functions.
1117 */
1118 opt |= SMP_OPT_ITERATE;
1119
Willy Tarreau11382812008-07-09 16:18:21 +02001120 /* We're doing a logical OR between conditions so we initialize to FAIL.
1121 * The MISS status is propagated down from the suites.
1122 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001123 cond_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001124 list_for_each_entry(suite, &cond->suites, list) {
Willy Tarreau11382812008-07-09 16:18:21 +02001125 /* Evaluate condition suite <suite>. We stop at the first term
Willy Tarreau0cba6072013-11-28 22:21:02 +01001126 * which returns ACL_TEST_FAIL. The MISS status is still propagated
Willy Tarreau11382812008-07-09 16:18:21 +02001127 * in case of uncertainty in the result.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001128 */
1129
1130 /* we're doing a logical AND between terms, so we must set the
1131 * initial value to PASS.
1132 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001133 suite_res = ACL_TEST_PASS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001134 list_for_each_entry(term, &suite->terms, list) {
1135 acl = term->acl;
1136
1137 /* FIXME: use cache !
1138 * check acl->cache_idx for this.
1139 */
1140
1141 /* ACL result not cached. Let's scan all the expressions
1142 * and use the first one to match.
1143 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001144 acl_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001145 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaud41f8d82007-06-10 10:06:18 +02001146 /* we need to reset context and flags */
Willy Tarreau37406352012-04-23 16:16:37 +02001147 memset(&smp, 0, sizeof(smp));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001148 fetch_next:
Willy Tarreau192252e2015-04-04 01:47:55 +02001149 if (!sample_process(px, sess, strm, opt, expr->smp, &smp)) {
Willy Tarreaub6866442008-07-14 23:54:42 +02001150 /* maybe we could not fetch because of missing data */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001151 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001152 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001153 continue;
Willy Tarreaub6866442008-07-14 23:54:42 +02001154 }
Willy Tarreauc4262962010-05-10 23:42:40 +02001155
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +01001156 acl_res |= pat2acl(pattern_exec_match(&expr->pat, &smp, 0));
Willy Tarreaua84d3742007-05-07 00:36:48 +02001157 /*
Willy Tarreau11382812008-07-09 16:18:21 +02001158 * OK now acl_res holds the result of this expression
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001159 * as one of ACL_TEST_FAIL, ACL_TEST_MISS or ACL_TEST_PASS.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001160 *
Willy Tarreau11382812008-07-09 16:18:21 +02001161 * Then if (!MISS) we can cache the result, and put
Willy Tarreau37406352012-04-23 16:16:37 +02001162 * (smp.flags & SMP_F_VOLATILE) in the cache flags.
Willy Tarreaua84d3742007-05-07 00:36:48 +02001163 *
1164 * FIXME: implement cache.
1165 *
1166 */
1167
Willy Tarreau11382812008-07-09 16:18:21 +02001168 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001169 if (acl_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001170 break;
1171
Willy Tarreau37406352012-04-23 16:16:37 +02001172 if (smp.flags & SMP_F_NOT_LAST)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001173 goto fetch_next;
Willy Tarreaub6866442008-07-14 23:54:42 +02001174
1175 /* sometimes we know the fetched data is subject to change
1176 * later and give another chance for a new match (eg: request
1177 * size, time, ...)
1178 */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +02001179 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001180 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001181 }
1182 /*
1183 * Here we have the result of an ACL (cached or not).
1184 * ACLs are combined, negated or not, to form conditions.
1185 */
1186
Willy Tarreaua84d3742007-05-07 00:36:48 +02001187 if (term->neg)
Willy Tarreau11382812008-07-09 16:18:21 +02001188 acl_res = acl_neg(acl_res);
Willy Tarreaua84d3742007-05-07 00:36:48 +02001189
1190 suite_res &= acl_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001191
Willy Tarreau79c412b2013-10-30 19:30:32 +01001192 /* we're ANDing these terms, so a single FAIL or MISS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001193 if (suite_res != ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001194 break;
1195 }
1196 cond_res |= suite_res;
Willy Tarreau11382812008-07-09 16:18:21 +02001197
1198 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001199 if (cond_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +02001200 break;
1201 }
Willy Tarreau11382812008-07-09 16:18:21 +02001202 return cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +02001203}
1204
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001205/* Returns a pointer to the first ACL conflicting with usage at place <where>
1206 * which is one of the SMP_VAL_* bits indicating a check place, or NULL if
1207 * no conflict is found. Only full conflicts are detected (ACL is not usable).
1208 * Use the next function to check for useless keywords.
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001209 */
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001210const struct acl *acl_cond_conflicts(const struct acl_cond *cond, unsigned int where)
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001211{
1212 struct acl_term_suite *suite;
1213 struct acl_term *term;
1214 struct acl *acl;
1215
1216 list_for_each_entry(suite, &cond->suites, list) {
1217 list_for_each_entry(term, &suite->terms, list) {
1218 acl = term->acl;
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001219 if (!(acl->val & where))
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001220 return acl;
1221 }
1222 }
1223 return NULL;
1224}
1225
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001226/* Returns a pointer to the first ACL and its first keyword to conflict with
1227 * usage at place <where> which is one of the SMP_VAL_* bits indicating a check
1228 * place. Returns true if a conflict is found, with <acl> and <kw> set (if non
1229 * null), or false if not conflict is found. The first useless keyword is
1230 * returned.
1231 */
Willy Tarreau93fddf12013-03-31 22:59:32 +02001232int 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 +01001233{
1234 struct acl_term_suite *suite;
1235 struct acl_term *term;
1236 struct acl_expr *expr;
1237
1238 list_for_each_entry(suite, &cond->suites, list) {
1239 list_for_each_entry(term, &suite->terms, list) {
1240 list_for_each_entry(expr, &term->acl->expr, list) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001241 if (!(expr->smp->fetch->val & where)) {
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001242 if (acl)
1243 *acl = term->acl;
1244 if (kw)
1245 *kw = expr->kw;
1246 return 1;
1247 }
1248 }
1249 }
1250 }
1251 return 0;
1252}
1253
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001254/*
1255 * Find targets for userlist and groups in acl. Function returns the number
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001256 * of errors or OK if everything is fine. It must be called only once sample
1257 * fetch arguments have been resolved (after smp_resolve_args()).
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001258 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001259int acl_find_targets(struct proxy *p)
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001260{
1261
1262 struct acl *acl;
1263 struct acl_expr *expr;
Thierry FOURNIER3ead5b92013-12-13 12:12:18 +01001264 struct pattern_list *pattern;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001265 int cfgerr = 0;
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001266 struct pattern_expr_list *pexp;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001267
1268 list_for_each_entry(acl, &p->acl, list) {
1269 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001270 if (!strcmp(expr->kw, "http_auth_group")) {
1271 /* Note: the ARGT_USR argument may only have been resolved earlier
1272 * by smp_resolve_args().
1273 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001274 if (expr->smp->arg_p->unresolved) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001275 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 +02001276 p->id, *acl->name ? "" : "anonymous ", acl->name, expr->kw,
1277 expr->smp->arg_p->data.str.area);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001278 cfgerr++;
Willy Tarreau496aa012012-06-01 10:38:29 +02001279 continue;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001280 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001281
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001282 if (LIST_ISEMPTY(&expr->pat.head)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001283 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1284 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001285 cfgerr++;
1286 continue;
1287 }
1288
Thierry FOURNIER9eec0a62014-01-22 18:38:02 +01001289 /* For each pattern, check if the group exists. */
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001290 list_for_each_entry(pexp, &expr->pat.head, list) {
1291 if (LIST_ISEMPTY(&pexp->expr->patterns)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001292 ha_alert("proxy %s: acl %s %s(): no groups specified.\n",
1293 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001294 cfgerr++;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001295 continue;
1296 }
1297
Thierry FOURNIERc5959fd2014-01-20 14:29:33 +01001298 list_for_each_entry(pattern, &pexp->expr->patterns, list) {
1299 /* this keyword only has one argument */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001300 if (!check_group(expr->smp->arg_p->data.usr, pattern->pat.ptr.str)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001301 ha_alert("proxy %s: acl %s %s(): invalid group '%s'.\n",
1302 p->id, acl->name, expr->kw, pattern->pat.ptr.str);
Thierry FOURNIER1e00d382014-02-11 11:31:40 +01001303 cfgerr++;
1304 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001305 }
1306 }
1307 }
1308 }
1309 }
1310
1311 return cfgerr;
1312}
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001313
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001314/* initializes ACLs by resolving the sample fetch names they rely upon.
1315 * Returns 0 on success, otherwise an error.
1316 */
1317int init_acl()
1318{
1319 int err = 0;
1320 int index;
1321 const char *name;
1322 struct acl_kw_list *kwl;
1323 struct sample_fetch *smp;
1324
1325 list_for_each_entry(kwl, &acl_keywords.list, list) {
1326 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1327 name = kwl->kw[index].fetch_kw;
1328 if (!name)
1329 name = kwl->kw[index].kw;
1330
1331 smp = find_sample_fetch(name, strlen(name));
1332 if (!smp) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001333 ha_alert("Critical internal error: ACL keyword '%s' relies on sample fetch '%s' which was not registered!\n",
1334 kwl->kw[index].kw, name);
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001335 err++;
1336 continue;
1337 }
1338 kwl->kw[index].smp = smp;
1339 }
1340 }
1341 return err;
1342}
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001343
Willy Tarreaua84d3742007-05-07 00:36:48 +02001344/************************************************************************/
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001345/* All supported sample and ACL keywords must be declared here. */
1346/************************************************************************/
1347
1348/* Note: must not be declared <const> as its list will be overwritten.
Willy Tarreau61612d42012-04-19 18:42:05 +02001349 * Please take care of keeping this list alphabetically sorted.
1350 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001351static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001352 { /* END */ },
Willy Tarreaua84d3742007-05-07 00:36:48 +02001353}};
1354
Willy Tarreaua84d3742007-05-07 00:36:48 +02001355__attribute__((constructor))
1356static void __acl_init(void)
1357{
Willy Tarreaua84d3742007-05-07 00:36:48 +02001358 acl_register_keywords(&acl_kws);
1359}
1360
1361
1362/*
1363 * Local variables:
1364 * c-indent-level: 8
1365 * c-basic-offset: 8
1366 * End:
1367 */