blob: b04c9dfa99def959ea5bdf4453ca074fa170b595 [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 */
42static inline enum acl_test_res pat2acl(enum pat_match_res res)
43{
44 return (enum acl_test_res)res;
45}
46
Willy Tarreaua5909832007-06-17 20:40:25 +020047/*
Willy Tarreaua84d3742007-05-07 00:36:48 +020048 * Registers the ACL keyword list <kwl> as a list of valid keywords for next
49 * parsing sessions.
50 */
51void acl_register_keywords(struct acl_kw_list *kwl)
52{
53 LIST_ADDQ(&acl_keywords.list, &kwl->list);
54}
55
56/*
57 * Unregisters the ACL keyword list <kwl> from the list of valid keywords.
58 */
59void acl_unregister_keywords(struct acl_kw_list *kwl)
60{
61 LIST_DEL(&kwl->list);
62 LIST_INIT(&kwl->list);
63}
64
65/* Return a pointer to the ACL <name> within the list starting at <head>, or
66 * NULL if not found.
67 */
68struct acl *find_acl_by_name(const char *name, struct list *head)
69{
70 struct acl *acl;
71 list_for_each_entry(acl, head, list) {
72 if (strcmp(acl->name, name) == 0)
73 return acl;
74 }
75 return NULL;
76}
77
78/* Return a pointer to the ACL keyword <kw>, or NULL if not found. Note that if
Willy Tarreau4bfa4222013-12-16 22:01:06 +010079 * <kw> contains an opening parenthesis or a comma, only the left part of it is
80 * checked.
Willy Tarreaua84d3742007-05-07 00:36:48 +020081 */
82struct acl_keyword *find_acl_kw(const char *kw)
83{
84 int index;
85 const char *kwend;
86 struct acl_kw_list *kwl;
87
Willy Tarreau4bfa4222013-12-16 22:01:06 +010088 kwend = kw;
89 while (*kwend && *kwend != '(' && *kwend != ',')
90 kwend++;
Willy Tarreaua84d3742007-05-07 00:36:48 +020091
92 list_for_each_entry(kwl, &acl_keywords.list, list) {
93 for (index = 0; kwl->kw[index].kw != NULL; index++) {
94 if ((strncmp(kwl->kw[index].kw, kw, kwend - kw) == 0) &&
95 kwl->kw[index].kw[kwend-kw] == 0)
96 return &kwl->kw[index];
97 }
98 }
99 return NULL;
100}
101
Willy Tarreaua84d3742007-05-07 00:36:48 +0200102static struct acl_expr *prune_acl_expr(struct acl_expr *expr)
103{
Willy Tarreau34db1082012-04-19 17:16:54 +0200104 struct arg *arg;
105
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100106 pattern_prune_expr(&expr->pat);
Willy Tarreau34db1082012-04-19 17:16:54 +0200107
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100108 for (arg = expr->smp->arg_p; arg; arg++) {
Willy Tarreau34db1082012-04-19 17:16:54 +0200109 if (arg->type == ARGT_STOP)
110 break;
Willy Tarreau496aa012012-06-01 10:38:29 +0200111 if (arg->type == ARGT_STR || arg->unresolved) {
Willy Tarreau34db1082012-04-19 17:16:54 +0200112 free(arg->data.str.str);
113 arg->data.str.str = NULL;
Willy Tarreau496aa012012-06-01 10:38:29 +0200114 arg->unresolved = 0;
Willy Tarreau34db1082012-04-19 17:16:54 +0200115 }
Willy Tarreau34db1082012-04-19 17:16:54 +0200116 }
117
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100118 if (expr->smp->arg_p != empty_arg_list)
119 free(expr->smp->arg_p);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200120 return expr;
121}
122
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200123/* Parse an ACL expression starting at <args>[0], and return it. If <err> is
124 * not NULL, it will be filled with a pointer to an error message in case of
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200125 * error. This pointer must be freeable or NULL. <al> is an arg_list serving
126 * as a list head to report missing dependencies.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200127 *
Willy Tarreaua84d3742007-05-07 00:36:48 +0200128 * Right now, the only accepted syntax is :
129 * <subject> [<value>...]
130 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200131struct acl_expr *parse_acl_expr(const char **args, char **err, struct arg_list *al)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200132{
133 __label__ out_return, out_free_expr, out_free_pattern;
134 struct acl_expr *expr;
135 struct acl_keyword *aclkw;
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100136 struct pattern *pattern;
Thierry FOURNIER7148ce62013-12-06 19:06:43 +0100137 int patflags;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200138 const char *arg;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100139 struct sample_expr *smp = NULL;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100140 int idx = 0;
141 char *ckw = NULL;
142 const char *begw;
143 const char *endw;
Willy Tarreau131b4662013-12-13 01:08:36 +0100144 const char *endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100145 unsigned long prev_type;
146 int cur_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100147 int nbargs;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200148
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100149 /* First, we look for an ACL keyword. And if we don't find one, then
150 * we look for a sample fetch expression starting with a sample fetch
151 * keyword.
Willy Tarreaubef91e72013-03-31 23:14:46 +0200152 */
Willy Tarreau131b4662013-12-13 01:08:36 +0100153
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100154 al->ctx = ARGC_ACL; // to report errors while resolving args late
Willy Tarreau131b4662013-12-13 01:08:36 +0100155 al->kw = *args;
156 al->conv = NULL;
157
Willy Tarreaua84d3742007-05-07 00:36:48 +0200158 aclkw = find_acl_kw(args[0]);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100159 if (aclkw && aclkw->parse) {
160 /* OK we have a real ACL keyword */
Willy Tarreau9987ea92013-06-11 21:09:06 +0200161
Willy Tarreau131b4662013-12-13 01:08:36 +0100162 /* build new sample expression for this ACL */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100163 smp = calloc(1, sizeof(struct sample_expr));
164 if (!smp) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100165 memprintf(err, "out of memory when parsing ACL expression");
166 goto out_return;
167 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100168 LIST_INIT(&(smp->conv_exprs));
169 smp->fetch = aclkw->smp;
170 smp->arg_p = empty_arg_list;
Willy Tarreau34db1082012-04-19 17:16:54 +0200171
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100172 /* look for the begining of the subject arguments */
Willy Tarreau131b4662013-12-13 01:08:36 +0100173 for (arg = args[0]; *arg && *arg != '(' && *arg != ','; arg++);
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100174
Willy Tarreau131b4662013-12-13 01:08:36 +0100175 endt = arg;
176 if (*endt == '(') {
177 /* look for the end of this term and skip the opening parenthesis */
178 endt = ++arg;
179 while (*endt && *endt != ')')
180 endt++;
181 if (*endt != ')') {
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100182 memprintf(err, "missing closing ')' after arguments to ACL keyword '%s'", aclkw->kw);
183 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100184 }
185 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100186
Willy Tarreau131b4662013-12-13 01:08:36 +0100187 /* At this point, we have :
188 * - args[0] : beginning of the keyword
189 * - arg : end of the keyword, first character not part of keyword
190 * nor the opening parenthesis (so first character of args
191 * if present).
192 * - endt : end of the term (=arg or last parenthesis if args are present)
193 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100194 nbargs = make_arg_list(arg, endt - arg, smp->fetch->arg_mask, &smp->arg_p,
Willy Tarreau131b4662013-12-13 01:08:36 +0100195 err, NULL, NULL, al);
196 if (nbargs < 0) {
197 /* note that make_arg_list will have set <err> here */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100198 memprintf(err, "ACL keyword '%s' : %s", aclkw->kw, *err);
199 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100200 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100201
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100202 if (!smp->arg_p) {
203 smp->arg_p = empty_arg_list;
Willy Tarreau131b4662013-12-13 01:08:36 +0100204 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100205 else if (smp->fetch->val_args && !smp->fetch->val_args(smp->arg_p, err)) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100206 /* invalid keyword argument, error must have been
207 * set by val_args().
208 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100209 memprintf(err, "in argument to '%s', %s", aclkw->kw, *err);
210 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100211 }
212 arg = endt;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100213
Willy Tarreau131b4662013-12-13 01:08:36 +0100214 /* look for the begining of the converters list. Those directly attached
215 * to the ACL keyword are found just after <arg> which points to the comma.
216 */
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100217 prev_type = smp->fetch->out_type;
Willy Tarreau131b4662013-12-13 01:08:36 +0100218 while (*arg) {
219 struct sample_conv *conv;
220 struct sample_conv_expr *conv_expr;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100221
Willy Tarreau131b4662013-12-13 01:08:36 +0100222 if (*arg == ')') /* skip last closing parenthesis */
223 arg++;
224
225 if (*arg && *arg != ',') {
226 if (ckw)
227 memprintf(err, "ACL keyword '%s' : missing comma after conv keyword '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100228 aclkw->kw, ckw);
Willy Tarreau131b4662013-12-13 01:08:36 +0100229 else
230 memprintf(err, "ACL keyword '%s' : missing comma after fetch keyword.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100231 aclkw->kw);
232 goto out_free_smp;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200233 }
Willy Tarreauae52f062012-04-26 12:13:35 +0200234
Willy Tarreau131b4662013-12-13 01:08:36 +0100235 while (*arg == ',') /* then trailing commas */
236 arg++;
Willy Tarreau2e845be2012-10-19 19:49:09 +0200237
Willy Tarreau131b4662013-12-13 01:08:36 +0100238 begw = arg; /* start of conv keyword */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100239
Willy Tarreau131b4662013-12-13 01:08:36 +0100240 if (!*begw)
241 /* none ? end of converters */
242 break;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100243
Willy Tarreau131b4662013-12-13 01:08:36 +0100244 for (endw = begw; *endw && *endw != '(' && *endw != ','; endw++);
Willy Tarreau9ca69362013-10-22 19:10:06 +0200245
Willy Tarreau131b4662013-12-13 01:08:36 +0100246 free(ckw);
247 ckw = my_strndup(begw, endw - begw);
Willy Tarreauf75d0082013-04-07 21:20:44 +0200248
Willy Tarreau131b4662013-12-13 01:08:36 +0100249 conv = find_sample_conv(begw, endw - begw);
250 if (!conv) {
251 /* Unknown converter method */
252 memprintf(err, "ACL keyword '%s' : unknown conv method '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100253 aclkw->kw, ckw);
254 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100255 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100256
Willy Tarreau131b4662013-12-13 01:08:36 +0100257 arg = endw;
258 if (*arg == '(') {
259 /* look for the end of this term */
260 while (*arg && *arg != ')')
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100261 arg++;
Willy Tarreau131b4662013-12-13 01:08:36 +0100262 if (*arg != ')') {
263 memprintf(err, "ACL keyword '%s' : syntax error: missing ')' after conv keyword '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100264 aclkw->kw, ckw);
265 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100266 }
Willy Tarreau131b4662013-12-13 01:08:36 +0100267 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100268
Willy Tarreau131b4662013-12-13 01:08:36 +0100269 if (conv->in_type >= SMP_TYPES || conv->out_type >= SMP_TYPES) {
270 memprintf(err, "ACL keyword '%s' : returns type of conv method '%s' is unknown.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100271 aclkw->kw, ckw);
272 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100273 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100274
Willy Tarreau131b4662013-12-13 01:08:36 +0100275 /* If impossible type conversion */
276 if (!sample_casts[prev_type][conv->in_type]) {
277 memprintf(err, "ACL keyword '%s' : conv method '%s' cannot be applied.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100278 aclkw->kw, ckw);
279 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100280 }
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100281
Willy Tarreau131b4662013-12-13 01:08:36 +0100282 prev_type = conv->out_type;
283 conv_expr = calloc(1, sizeof(struct sample_conv_expr));
284 if (!conv_expr)
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100285 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100286
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100287 LIST_ADDQ(&(smp->conv_exprs), &(conv_expr->list));
Willy Tarreau131b4662013-12-13 01:08:36 +0100288 conv_expr->conv = conv;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100289
Willy Tarreau131b4662013-12-13 01:08:36 +0100290 if (arg != endw) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100291 int err_arg;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100292
Willy Tarreau131b4662013-12-13 01:08:36 +0100293 if (!conv->arg_mask) {
294 memprintf(err, "ACL keyword '%s' : conv method '%s' does not support any args.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100295 aclkw->kw, ckw);
296 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100297 }
298
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100299 al->kw = smp->fetch->kw;
Willy Tarreau131b4662013-12-13 01:08:36 +0100300 al->conv = conv_expr->conv->kw;
Willy Tarreauadaddc22013-12-13 01:30:22 +0100301 if (make_arg_list(endw + 1, arg - endw - 1, conv->arg_mask, &conv_expr->arg_p, err, NULL, &err_arg, al) < 0) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100302 memprintf(err, "ACL keyword '%s' : invalid arg %d in conv method '%s' : %s.",
Willy Tarreauadaddc22013-12-13 01:30:22 +0100303 aclkw->kw, err_arg+1, ckw, *err);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100304 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100305 }
306
Willy Tarreau131b4662013-12-13 01:08:36 +0100307 if (!conv_expr->arg_p)
308 conv_expr->arg_p = empty_arg_list;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100309
Willy Tarreauadaddc22013-12-13 01:30:22 +0100310 if (conv->val_args && !conv->val_args(conv_expr->arg_p, conv, err)) {
Willy Tarreau131b4662013-12-13 01:08:36 +0100311 memprintf(err, "ACL keyword '%s' : invalid args in conv method '%s' : %s.",
Willy Tarreauadaddc22013-12-13 01:30:22 +0100312 aclkw->kw, ckw, *err);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100313 goto out_free_smp;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100314 }
315 }
Willy Tarreau131b4662013-12-13 01:08:36 +0100316 else if (ARGM(conv->arg_mask)) {
317 memprintf(err, "ACL keyword '%s' : missing args for conv method '%s'.",
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100318 aclkw->kw, ckw);
319 goto out_free_smp;
Willy Tarreau131b4662013-12-13 01:08:36 +0100320 }
Willy Tarreau61612d42012-04-19 18:42:05 +0200321 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200322 }
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100323 else {
324 /* This is not an ACL keyword, so we hope this is a sample fetch
325 * keyword that we're going to transparently use as an ACL. If
326 * so, we retrieve a completely parsed expression with args and
327 * convs already done.
328 */
329 smp = sample_parse_expr((char **)args, &idx, err, al);
330 if (!smp) {
331 memprintf(err, "%s in ACL expression '%s'", *err, *args);
332 goto out_return;
333 }
334 }
335
336 expr = (struct acl_expr *)calloc(1, sizeof(*expr));
337 if (!expr) {
338 memprintf(err, "out of memory when parsing ACL expression");
339 goto out_return;
340 }
341
342 pattern_init_expr(&expr->pat);
343
344 expr->kw = aclkw ? aclkw->kw : smp->fetch->kw;
345 expr->pat.parse = aclkw ? aclkw->parse : NULL;
346 expr->pat.match = aclkw ? aclkw->match : NULL;
347 expr->smp = smp;
348 smp = NULL;
349
350 if (!expr->pat.parse) {
351 /* some types can be automatically converted */
352
353 switch (expr->smp ? expr->smp->fetch->out_type : aclkw->smp->out_type) {
354 case SMP_T_BOOL:
355 expr->pat.parse = pat_parse_fcts[PAT_MATCH_BOOL];
356 expr->pat.match = pat_match_fcts[PAT_MATCH_BOOL];
357 break;
358 case SMP_T_SINT:
359 case SMP_T_UINT:
360 expr->pat.parse = pat_parse_fcts[PAT_MATCH_INT];
361 expr->pat.match = pat_match_fcts[PAT_MATCH_INT];
362 break;
363 case SMP_T_IPV4:
364 case SMP_T_IPV6:
365 expr->pat.parse = pat_parse_fcts[PAT_MATCH_IP];
366 expr->pat.match = pat_match_fcts[PAT_MATCH_IP];
367 break;
368 }
369 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200370
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100371 /* Additional check to protect against common mistakes */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100372 cur_type = smp_expr_output_type(expr->smp);
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100373 if (expr->pat.parse && cur_type != SMP_T_BOOL && !*args[1]) {
Willy Tarreau3c3dfd52013-11-04 18:09:12 +0100374 Warning("parsing acl keyword '%s' :\n"
375 " no pattern to match against were provided, so this ACL will never match.\n"
376 " If this is what you intended, please add '--' to get rid of this warning.\n"
377 " If you intended to match only for existence, please use '-m found'.\n"
378 " If you wanted to force an int to match as a bool, please use '-m bool'.\n"
379 "\n",
380 args[0]);
381 }
382
Willy Tarreaua84d3742007-05-07 00:36:48 +0200383 args++;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200384
385 /* check for options before patterns. Supported options are :
386 * -i : ignore case for all patterns by default
387 * -f : read patterns from those files
Willy Tarreau5adeda12013-03-31 22:13:34 +0200388 * -m : force matching method (must be used before -f)
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200389 * -- : everything after this is not an option
390 */
391 patflags = 0;
392 while (**args == '-') {
393 if ((*args)[1] == 'i')
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100394 patflags |= PAT_F_IGNORE_CASE;
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200395 else if ((*args)[1] == 'f') {
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100396 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200397 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 +0200398 goto out_free_expr;
399 }
400
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100401 if (!pattern_read_from_file(&expr->pat, args[1], patflags | PAT_F_FROM_FILE, err))
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200402 goto out_free_expr;
Willy Tarreau5adeda12013-03-31 22:13:34 +0200403 args++;
404 }
405 else if ((*args)[1] == 'm') {
406 int idx;
407
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100408 if (!LIST_ISEMPTY(&expr->pat.patterns) || !eb_is_empty(&expr->pat.pattern_tree)) {
Willy Tarreau5adeda12013-03-31 22:13:34 +0200409 memprintf(err, "'-m' must only be specified before patterns and files in parsing ACL expression");
410 goto out_free_expr;
411 }
412
Willy Tarreau6f8fe312013-11-28 22:24:25 +0100413 idx = pat_find_match_name(args[1]);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200414 if (idx < 0) {
415 memprintf(err, "unknown matching method '%s' when parsing ACL expression", args[1]);
416 goto out_free_expr;
417 }
418
419 /* Note: -m found is always valid, bool/int are compatible, str/bin/reg/len are compatible */
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100420 if (!sample_casts[cur_type][pat_match_types[idx]]) {
Willy Tarreau93fddf12013-03-31 22:59:32 +0200421 memprintf(err, "matching method '%s' cannot be used with fetch keyword '%s'", args[1], expr->kw);
Willy Tarreau5adeda12013-03-31 22:13:34 +0200422 goto out_free_expr;
423 }
Thierry FOURNIERe3ded592013-12-06 15:36:54 +0100424 expr->pat.parse = pat_parse_fcts[idx];
425 expr->pat.match = pat_match_fcts[idx];
Willy Tarreau2b5285d2010-05-09 23:45:24 +0200426 args++;
427 }
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200428 else if ((*args)[1] == '-') {
429 args++;
430 break;
431 }
432 else
433 break;
434 args++;
435 }
436
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +0100437 if (!expr->pat.parse) {
Willy Tarreau9987ea92013-06-11 21:09:06 +0200438 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 +0200439 goto out_free_expr;
440 }
441
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200442 /* now parse all patterns */
Thierry FOURNIER7148ce62013-12-06 19:06:43 +0100443 pattern = NULL;
444 if (!pattern_register(&expr->pat, args, NULL, &pattern, patflags, err))
445 goto out_free_pattern;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200446
447 return expr;
448
449 out_free_pattern:
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100450 pattern_free(pattern);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200451 out_free_expr:
452 prune_acl_expr(expr);
453 free(expr);
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100454 free(ckw);
Willy Tarreauc37a3c72013-12-13 01:24:09 +0100455 out_free_smp:
456 free(smp);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200457 out_return:
458 return NULL;
459}
460
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200461/* Purge everything in the acl <acl>, then return <acl>. */
462struct acl *prune_acl(struct acl *acl) {
463
464 struct acl_expr *expr, *exprb;
465
466 free(acl->name);
467
468 list_for_each_entry_safe(expr, exprb, &acl->expr, list) {
469 LIST_DEL(&expr->list);
470 prune_acl_expr(expr);
471 free(expr);
472 }
473
474 return acl;
475}
476
Willy Tarreaua84d3742007-05-07 00:36:48 +0200477/* Parse an ACL with the name starting at <args>[0], and with a list of already
478 * known ACLs in <acl>. If the ACL was not in the list, it will be added.
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100479 * A pointer to that ACL is returned. If the ACL has an empty name, then it's
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200480 * an anonymous one and it won't be merged with any other one. If <err> is not
481 * NULL, it will be filled with an appropriate error. This pointer must be
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200482 * freeable or NULL. <al> is the arg_list serving as a head for unresolved
483 * dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200484 *
485 * args syntax: <aclname> <acl_expr>
486 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200487struct acl *parse_acl(const char **args, struct list *known_acl, char **err, struct arg_list *al)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200488{
489 __label__ out_return, out_free_acl_expr, out_free_name;
490 struct acl *cur_acl;
491 struct acl_expr *acl_expr;
492 char *name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200493 const char *pos;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200494
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200495 if (**args && (pos = invalid_char(*args))) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200496 memprintf(err, "invalid character in ACL name : '%c'", *pos);
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100497 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200498 }
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100499
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200500 acl_expr = parse_acl_expr(args + 1, err, al);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200501 if (!acl_expr) {
502 /* parse_acl_expr will have filled <err> here */
Willy Tarreaua84d3742007-05-07 00:36:48 +0200503 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200504 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200505
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200506 /* Check for args beginning with an opening parenthesis just after the
507 * subject, as this is almost certainly a typo. Right now we can only
508 * emit a warning, so let's do so.
509 */
Krzysztof Piotr Oledzki4cdd8312009-10-05 00:23:35 +0200510 if (!strchr(args[1], '(') && *args[2] == '(')
Willy Tarreau404e8ab2009-07-26 19:40:40 +0200511 Warning("parsing acl '%s' :\n"
512 " matching '%s' for pattern '%s' is likely a mistake and probably\n"
513 " not what you want. Maybe you need to remove the extraneous space before '('.\n"
514 " If you are really sure this is not an error, please insert '--' between the\n"
515 " match and the pattern to make this warning message disappear.\n",
516 args[0], args[1], args[2]);
517
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100518 if (*args[0])
519 cur_acl = find_acl_by_name(args[0], known_acl);
520 else
521 cur_acl = NULL;
522
Willy Tarreaua84d3742007-05-07 00:36:48 +0200523 if (!cur_acl) {
524 name = strdup(args[0]);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200525 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200526 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200527 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200528 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200529 cur_acl = (struct acl *)calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200530 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200531 memprintf(err, "out of memory when parsing ACL");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200532 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200533 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200534
535 LIST_INIT(&cur_acl->expr);
536 LIST_ADDQ(known_acl, &cur_acl->list);
537 cur_acl->name = name;
538 }
539
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100540 /* We want to know what features the ACL needs (typically HTTP parsing),
541 * and where it may be used. If an ACL relies on multiple matches, it is
542 * OK if at least one of them may match in the context where it is used.
543 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100544 cur_acl->use |= acl_expr->smp->fetch->use;
545 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200546 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
547 return cur_acl;
548
549 out_free_name:
550 free(name);
551 out_free_acl_expr:
552 prune_acl_expr(acl_expr);
553 free(acl_expr);
554 out_return:
555 return NULL;
556}
557
Willy Tarreau16fbe822007-06-17 11:54:31 +0200558/* Some useful ACLs provided by default. Only those used are allocated. */
559
560const struct {
561 const char *name;
562 const char *expr[4]; /* put enough for longest expression */
563} default_acl_list[] = {
Willy Tarreau58393e12008-07-20 10:39:22 +0200564 { .name = "TRUE", .expr = {"always_true",""}},
565 { .name = "FALSE", .expr = {"always_false",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200566 { .name = "LOCALHOST", .expr = {"src","127.0.0.1/8",""}},
Willy Tarreau2492d5b2009-07-11 00:06:00 +0200567 { .name = "HTTP", .expr = {"req_proto_http",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200568 { .name = "HTTP_1.0", .expr = {"req_ver","1.0",""}},
569 { .name = "HTTP_1.1", .expr = {"req_ver","1.1",""}},
570 { .name = "METH_CONNECT", .expr = {"method","CONNECT",""}},
571 { .name = "METH_GET", .expr = {"method","GET","HEAD",""}},
572 { .name = "METH_HEAD", .expr = {"method","HEAD",""}},
573 { .name = "METH_OPTIONS", .expr = {"method","OPTIONS",""}},
574 { .name = "METH_POST", .expr = {"method","POST",""}},
575 { .name = "METH_TRACE", .expr = {"method","TRACE",""}},
576 { .name = "HTTP_URL_ABS", .expr = {"url_reg","^[^/:]*://",""}},
577 { .name = "HTTP_URL_SLASH", .expr = {"url_beg","/",""}},
578 { .name = "HTTP_URL_STAR", .expr = {"url","*",""}},
579 { .name = "HTTP_CONTENT", .expr = {"hdr_val(content-length)","gt","0",""}},
Emeric Brunbede3d02009-06-30 17:54:00 +0200580 { .name = "RDP_COOKIE", .expr = {"req_rdp_cookie_cnt","gt","0",""}},
Willy Tarreauc6317702008-07-20 09:29:50 +0200581 { .name = "REQ_CONTENT", .expr = {"req_len","gt","0",""}},
Willy Tarreaub6fb4202008-07-20 11:18:28 +0200582 { .name = "WAIT_END", .expr = {"wait_end",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200583 { .name = NULL, .expr = {""}}
584};
585
586/* Find a default ACL from the default_acl list, compile it and return it.
587 * If the ACL is not found, NULL is returned. In theory, it cannot fail,
588 * except when default ACLs are broken, in which case it will return NULL.
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200589 * If <known_acl> is not NULL, the ACL will be queued at its tail. If <err> is
590 * not NULL, it will be filled with an error message if an error occurs. This
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200591 * pointer must be freeable or NULL. <al> is an arg_list serving as a list head
592 * to report missing dependencies.
Willy Tarreau16fbe822007-06-17 11:54:31 +0200593 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200594static struct acl *find_acl_default(const char *acl_name, struct list *known_acl,
595 char **err, struct arg_list *al)
Willy Tarreau16fbe822007-06-17 11:54:31 +0200596{
597 __label__ out_return, out_free_acl_expr, out_free_name;
598 struct acl *cur_acl;
599 struct acl_expr *acl_expr;
600 char *name;
601 int index;
602
603 for (index = 0; default_acl_list[index].name != NULL; index++) {
604 if (strcmp(acl_name, default_acl_list[index].name) == 0)
605 break;
606 }
607
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200608 if (default_acl_list[index].name == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200609 memprintf(err, "no such ACL : '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200610 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200611 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200612
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200613 acl_expr = parse_acl_expr((const char **)default_acl_list[index].expr, err, al);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200614 if (!acl_expr) {
615 /* parse_acl_expr must have filled err here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200616 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200617 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200618
619 name = strdup(acl_name);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200620 if (!name) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200621 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200622 goto out_free_acl_expr;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200623 }
624
Willy Tarreau16fbe822007-06-17 11:54:31 +0200625 cur_acl = (struct acl *)calloc(1, sizeof(*cur_acl));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200626 if (cur_acl == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200627 memprintf(err, "out of memory when building default ACL '%s'", acl_name);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200628 goto out_free_name;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200629 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200630
631 cur_acl->name = name;
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100632 cur_acl->use |= acl_expr->smp->fetch->use;
633 cur_acl->val |= acl_expr->smp->fetch->val;
Willy Tarreau16fbe822007-06-17 11:54:31 +0200634 LIST_INIT(&cur_acl->expr);
635 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
636 if (known_acl)
637 LIST_ADDQ(known_acl, &cur_acl->list);
638
639 return cur_acl;
640
641 out_free_name:
642 free(name);
643 out_free_acl_expr:
644 prune_acl_expr(acl_expr);
645 free(acl_expr);
646 out_return:
647 return NULL;
648}
Willy Tarreaua84d3742007-05-07 00:36:48 +0200649
650/* Purge everything in the acl_cond <cond>, then return <cond>. */
651struct acl_cond *prune_acl_cond(struct acl_cond *cond)
652{
653 struct acl_term_suite *suite, *tmp_suite;
654 struct acl_term *term, *tmp_term;
655
656 /* iterate through all term suites and free all terms and all suites */
657 list_for_each_entry_safe(suite, tmp_suite, &cond->suites, list) {
658 list_for_each_entry_safe(term, tmp_term, &suite->terms, list)
659 free(term);
660 free(suite);
661 }
662 return cond;
663}
664
665/* Parse an ACL condition starting at <args>[0], relying on a list of already
666 * known ACLs passed in <known_acl>. The new condition is returned (or NULL in
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200667 * case of low memory). Supports multiple conditions separated by "or". If
668 * <err> is not NULL, it will be filled with a pointer to an error message in
669 * case of error, that the caller is responsible for freeing. The initial
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200670 * location must either be freeable or NULL. The list <al> serves as a list head
671 * for unresolved dependencies.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200672 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200673struct acl_cond *parse_acl_cond(const char **args, struct list *known_acl,
Willy Tarreau0cba6072013-11-28 22:21:02 +0100674 enum acl_cond_pol pol, char **err, struct arg_list *al)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200675{
676 __label__ out_return, out_free_suite, out_free_term;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200677 int arg, neg;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200678 const char *word;
679 struct acl *cur_acl;
680 struct acl_term *cur_term;
681 struct acl_term_suite *cur_suite;
682 struct acl_cond *cond;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100683 unsigned int suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200684
685 cond = (struct acl_cond *)calloc(1, sizeof(*cond));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200686 if (cond == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200687 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200688 goto out_return;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200689 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200690
691 LIST_INIT(&cond->list);
692 LIST_INIT(&cond->suites);
693 cond->pol = pol;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100694 cond->val = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200695
696 cur_suite = NULL;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100697 suite_val = ~0U;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200698 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200699 for (arg = 0; *args[arg]; arg++) {
700 word = args[arg];
701
702 /* remove as many exclamation marks as we can */
703 while (*word == '!') {
704 neg = !neg;
705 word++;
706 }
707
708 /* an empty word is allowed because we cannot force the user to
709 * always think about not leaving exclamation marks alone.
710 */
711 if (!*word)
712 continue;
713
Willy Tarreau16fbe822007-06-17 11:54:31 +0200714 if (strcasecmp(word, "or") == 0 || strcmp(word, "||") == 0) {
Willy Tarreaua84d3742007-05-07 00:36:48 +0200715 /* new term suite */
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100716 cond->val |= suite_val;
717 suite_val = ~0U;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200718 cur_suite = NULL;
719 neg = 0;
720 continue;
721 }
722
Willy Tarreau95fa4692010-02-01 13:05:50 +0100723 if (strcmp(word, "{") == 0) {
724 /* we may have a complete ACL expression between two braces,
725 * find the last one.
726 */
727 int arg_end = arg + 1;
728 const char **args_new;
729
730 while (*args[arg_end] && strcmp(args[arg_end], "}") != 0)
731 arg_end++;
732
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200733 if (!*args[arg_end]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200734 memprintf(err, "missing closing '}' in condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100735 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200736 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100737
738 args_new = calloc(1, (arg_end - arg + 1) * sizeof(*args_new));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200739 if (!args_new) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200740 memprintf(err, "out of memory when parsing condition");
Willy Tarreau95fa4692010-02-01 13:05:50 +0100741 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200742 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100743
Willy Tarreau2a56c5e2010-03-15 16:13:29 +0100744 args_new[0] = "";
Willy Tarreau95fa4692010-02-01 13:05:50 +0100745 memcpy(args_new + 1, args + arg + 1, (arg_end - arg) * sizeof(*args_new));
746 args_new[arg_end - arg] = "";
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200747 cur_acl = parse_acl(args_new, known_acl, err, al);
Willy Tarreau95fa4692010-02-01 13:05:50 +0100748 free(args_new);
749
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200750 if (!cur_acl) {
751 /* note that parse_acl() must have filled <err> here */
Willy Tarreau16fbe822007-06-17 11:54:31 +0200752 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200753 }
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100754 word = args[arg + 1];
Willy Tarreau95fa4692010-02-01 13:05:50 +0100755 arg = arg_end;
756 }
757 else {
758 /* search for <word> in the known ACL names. If we do not find
759 * it, let's look for it in the default ACLs, and if found, add
760 * it to the list of ACLs of this proxy. This makes it possible
761 * to override them.
762 */
763 cur_acl = find_acl_by_name(word, known_acl);
764 if (cur_acl == NULL) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200765 cur_acl = find_acl_default(word, known_acl, err, al);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200766 if (cur_acl == NULL) {
767 /* note that find_acl_default() must have filled <err> here */
Willy Tarreau95fa4692010-02-01 13:05:50 +0100768 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200769 }
Willy Tarreau95fa4692010-02-01 13:05:50 +0100770 }
Willy Tarreau16fbe822007-06-17 11:54:31 +0200771 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200772
773 cur_term = (struct acl_term *)calloc(1, sizeof(*cur_term));
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200774 if (cur_term == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200775 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200776 goto out_free_suite;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200777 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200778
779 cur_term->acl = cur_acl;
780 cur_term->neg = neg;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100781
782 /* Here it is a bit complex. The acl_term_suite is a conjunction
783 * of many terms. It may only be used if all of its terms are
784 * usable at the same time. So the suite's validity domain is an
785 * AND between all ACL keywords' ones. But, the global condition
786 * is valid if at least one term suite is OK. So it's an OR between
787 * all of their validity domains. We could emit a warning as soon
788 * as suite_val is null because it means that the last ACL is not
789 * compatible with the previous ones. Let's remain simple for now.
790 */
791 cond->use |= cur_acl->use;
792 suite_val &= cur_acl->val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200793
794 if (!cur_suite) {
795 cur_suite = (struct acl_term_suite *)calloc(1, sizeof(*cur_suite));
Willy Tarreauf678b7f2013-01-24 00:25:39 +0100796 if (cur_suite == NULL) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200797 memprintf(err, "out of memory when parsing condition");
Willy Tarreaua84d3742007-05-07 00:36:48 +0200798 goto out_free_term;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200799 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200800 LIST_INIT(&cur_suite->terms);
801 LIST_ADDQ(&cond->suites, &cur_suite->list);
802 }
803 LIST_ADDQ(&cur_suite->terms, &cur_term->list);
Willy Tarreau74b98a82007-06-16 19:35:18 +0200804 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200805 }
806
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100807 cond->val |= suite_val;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200808 return cond;
809
810 out_free_term:
811 free(cur_term);
812 out_free_suite:
813 prune_acl_cond(cond);
814 free(cond);
815 out_return:
816 return NULL;
817}
818
Willy Tarreau2bbba412010-01-28 16:48:33 +0100819/* Builds an ACL condition starting at the if/unless keyword. The complete
820 * condition is returned. NULL is returned in case of error or if the first
821 * word is neither "if" nor "unless". It automatically sets the file name and
Willy Tarreau25320b22013-03-24 07:22:08 +0100822 * the line number in the condition for better error reporting, and sets the
823 * HTTP intiailization requirements in the proxy. If <err> is not NULL, it will
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200824 * be filled with a pointer to an error message in case of error, that the
825 * caller is responsible for freeing. The initial location must either be
826 * freeable or NULL.
Willy Tarreau2bbba412010-01-28 16:48:33 +0100827 */
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200828struct acl_cond *build_acl_cond(const char *file, int line, struct proxy *px, const char **args, char **err)
Willy Tarreau2bbba412010-01-28 16:48:33 +0100829{
Willy Tarreau0cba6072013-11-28 22:21:02 +0100830 enum acl_cond_pol pol = ACL_COND_NONE;
Willy Tarreau2bbba412010-01-28 16:48:33 +0100831 struct acl_cond *cond = NULL;
832
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200833 if (err)
834 *err = NULL;
835
Willy Tarreau2bbba412010-01-28 16:48:33 +0100836 if (!strcmp(*args, "if")) {
837 pol = ACL_COND_IF;
838 args++;
839 }
840 else if (!strcmp(*args, "unless")) {
841 pol = ACL_COND_UNLESS;
842 args++;
843 }
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200844 else {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200845 memprintf(err, "conditions must start with either 'if' or 'unless'");
Willy Tarreau2bbba412010-01-28 16:48:33 +0100846 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200847 }
Willy Tarreau2bbba412010-01-28 16:48:33 +0100848
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200849 cond = parse_acl_cond(args, &px->acl, pol, err, &px->conf.args);
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200850 if (!cond) {
851 /* note that parse_acl_cond must have filled <err> here */
Willy Tarreau2bbba412010-01-28 16:48:33 +0100852 return NULL;
Willy Tarreaub7451bb2012-04-27 12:38:15 +0200853 }
Willy Tarreau2bbba412010-01-28 16:48:33 +0100854
855 cond->file = file;
856 cond->line = line;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100857 px->http_needed |= !!(cond->use & SMP_USE_HTTP_ANY);
Willy Tarreau2bbba412010-01-28 16:48:33 +0100858 return cond;
859}
860
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100861/* Execute condition <cond> and return either ACL_TEST_FAIL, ACL_TEST_MISS or
862 * ACL_TEST_PASS depending on the test results. ACL_TEST_MISS may only be
Willy Tarreau32a6f2e2012-04-25 10:13:36 +0200863 * returned if <opt> does not contain SMP_OPT_FINAL, indicating that incomplete
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100864 * data is being examined. The function automatically sets SMP_OPT_ITERATE. This
865 * function only computes the condition, it does not apply the polarity required
866 * by IF/UNLESS, it's up to the caller to do this using something like this :
Willy Tarreau11382812008-07-09 16:18:21 +0200867 *
868 * res = acl_pass(res);
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100869 * if (res == ACL_TEST_MISS)
Willy Tarreaub6866442008-07-14 23:54:42 +0200870 * return 0;
Willy Tarreau11382812008-07-09 16:18:21 +0200871 * if (cond->pol == ACL_COND_UNLESS)
872 * res = !res;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200873 */
Willy Tarreau0cba6072013-11-28 22:21:02 +0100874enum acl_test_res acl_exec_cond(struct acl_cond *cond, struct proxy *px, struct session *l4, void *l7, unsigned int opt)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200875{
876 __label__ fetch_next;
877 struct acl_term_suite *suite;
878 struct acl_term *term;
879 struct acl_expr *expr;
880 struct acl *acl;
Willy Tarreau37406352012-04-23 16:16:37 +0200881 struct sample smp;
Willy Tarreau0cba6072013-11-28 22:21:02 +0100882 enum acl_test_res acl_res, suite_res, cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200883
Willy Tarreau7a777ed2012-04-26 11:44:02 +0200884 /* ACLs are iterated over all values, so let's always set the flag to
885 * indicate this to the fetch functions.
886 */
887 opt |= SMP_OPT_ITERATE;
888
Willy Tarreau11382812008-07-09 16:18:21 +0200889 /* We're doing a logical OR between conditions so we initialize to FAIL.
890 * The MISS status is propagated down from the suites.
891 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100892 cond_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200893 list_for_each_entry(suite, &cond->suites, list) {
Willy Tarreau11382812008-07-09 16:18:21 +0200894 /* Evaluate condition suite <suite>. We stop at the first term
Willy Tarreau0cba6072013-11-28 22:21:02 +0100895 * which returns ACL_TEST_FAIL. The MISS status is still propagated
Willy Tarreau11382812008-07-09 16:18:21 +0200896 * in case of uncertainty in the result.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200897 */
898
899 /* we're doing a logical AND between terms, so we must set the
900 * initial value to PASS.
901 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100902 suite_res = ACL_TEST_PASS;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200903 list_for_each_entry(term, &suite->terms, list) {
904 acl = term->acl;
905
906 /* FIXME: use cache !
907 * check acl->cache_idx for this.
908 */
909
910 /* ACL result not cached. Let's scan all the expressions
911 * and use the first one to match.
912 */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100913 acl_res = ACL_TEST_FAIL;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200914 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaud41f8d82007-06-10 10:06:18 +0200915 /* we need to reset context and flags */
Willy Tarreau37406352012-04-23 16:16:37 +0200916 memset(&smp, 0, sizeof(smp));
Willy Tarreaua84d3742007-05-07 00:36:48 +0200917 fetch_next:
Thierry FOURNIER348971e2013-11-21 10:50:10 +0100918 if (!sample_process(px, l4, l7, opt, expr->smp, &smp)) {
Willy Tarreaub6866442008-07-14 23:54:42 +0200919 /* maybe we could not fetch because of missing data */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +0200920 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100921 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200922 continue;
Willy Tarreaub6866442008-07-14 23:54:42 +0200923 }
Willy Tarreauc4262962010-05-10 23:42:40 +0200924
Thierry FOURNIER76090642013-12-10 15:03:38 +0100925 acl_res |= pat2acl(pattern_exec_match(&expr->pat, &smp, NULL, NULL, NULL));
Willy Tarreaua84d3742007-05-07 00:36:48 +0200926 /*
Willy Tarreau11382812008-07-09 16:18:21 +0200927 * OK now acl_res holds the result of this expression
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100928 * as one of ACL_TEST_FAIL, ACL_TEST_MISS or ACL_TEST_PASS.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200929 *
Willy Tarreau11382812008-07-09 16:18:21 +0200930 * Then if (!MISS) we can cache the result, and put
Willy Tarreau37406352012-04-23 16:16:37 +0200931 * (smp.flags & SMP_F_VOLATILE) in the cache flags.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200932 *
933 * FIXME: implement cache.
934 *
935 */
936
Willy Tarreau11382812008-07-09 16:18:21 +0200937 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100938 if (acl_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200939 break;
940
Willy Tarreau37406352012-04-23 16:16:37 +0200941 if (smp.flags & SMP_F_NOT_LAST)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200942 goto fetch_next;
Willy Tarreaub6866442008-07-14 23:54:42 +0200943
944 /* sometimes we know the fetched data is subject to change
945 * later and give another chance for a new match (eg: request
946 * size, time, ...)
947 */
Willy Tarreau32a6f2e2012-04-25 10:13:36 +0200948 if (smp.flags & SMP_F_MAY_CHANGE && !(opt & SMP_OPT_FINAL))
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100949 acl_res |= ACL_TEST_MISS;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200950 }
951 /*
952 * Here we have the result of an ACL (cached or not).
953 * ACLs are combined, negated or not, to form conditions.
954 */
955
Willy Tarreaua84d3742007-05-07 00:36:48 +0200956 if (term->neg)
Willy Tarreau11382812008-07-09 16:18:21 +0200957 acl_res = acl_neg(acl_res);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200958
959 suite_res &= acl_res;
Willy Tarreau11382812008-07-09 16:18:21 +0200960
Willy Tarreau79c412b2013-10-30 19:30:32 +0100961 /* we're ANDing these terms, so a single FAIL or MISS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100962 if (suite_res != ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200963 break;
964 }
965 cond_res |= suite_res;
Willy Tarreau11382812008-07-09 16:18:21 +0200966
967 /* we're ORing these terms, so a single PASS is enough */
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100968 if (cond_res == ACL_TEST_PASS)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200969 break;
970 }
Willy Tarreau11382812008-07-09 16:18:21 +0200971 return cond_res;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200972}
973
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100974/* Returns a pointer to the first ACL conflicting with usage at place <where>
975 * which is one of the SMP_VAL_* bits indicating a check place, or NULL if
976 * no conflict is found. Only full conflicts are detected (ACL is not usable).
977 * Use the next function to check for useless keywords.
Willy Tarreaudd64f8d2008-07-27 22:02:32 +0200978 */
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100979const struct acl *acl_cond_conflicts(const struct acl_cond *cond, unsigned int where)
Willy Tarreaudd64f8d2008-07-27 22:02:32 +0200980{
981 struct acl_term_suite *suite;
982 struct acl_term *term;
983 struct acl *acl;
984
985 list_for_each_entry(suite, &cond->suites, list) {
986 list_for_each_entry(term, &suite->terms, list) {
987 acl = term->acl;
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100988 if (!(acl->val & where))
Willy Tarreaudd64f8d2008-07-27 22:02:32 +0200989 return acl;
990 }
991 }
992 return NULL;
993}
994
Willy Tarreaua91d0a52013-03-25 08:12:18 +0100995/* Returns a pointer to the first ACL and its first keyword to conflict with
996 * usage at place <where> which is one of the SMP_VAL_* bits indicating a check
997 * place. Returns true if a conflict is found, with <acl> and <kw> set (if non
998 * null), or false if not conflict is found. The first useless keyword is
999 * returned.
1000 */
Willy Tarreau93fddf12013-03-31 22:59:32 +02001001int 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 +01001002{
1003 struct acl_term_suite *suite;
1004 struct acl_term *term;
1005 struct acl_expr *expr;
1006
1007 list_for_each_entry(suite, &cond->suites, list) {
1008 list_for_each_entry(term, &suite->terms, list) {
1009 list_for_each_entry(expr, &term->acl->expr, list) {
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001010 if (!(expr->smp->fetch->val & where)) {
Willy Tarreaua91d0a52013-03-25 08:12:18 +01001011 if (acl)
1012 *acl = term->acl;
1013 if (kw)
1014 *kw = expr->kw;
1015 return 1;
1016 }
1017 }
1018 }
1019 }
1020 return 0;
1021}
1022
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001023/*
1024 * Find targets for userlist and groups in acl. Function returns the number
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001025 * of errors or OK if everything is fine. It must be called only once sample
1026 * fetch arguments have been resolved (after smp_resolve_args()).
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001027 */
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001028int acl_find_targets(struct proxy *p)
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001029{
1030
1031 struct acl *acl;
1032 struct acl_expr *expr;
Thierry FOURNIERa65b3432013-11-28 18:22:00 +01001033 struct pattern *pattern;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001034 int cfgerr = 0;
1035
1036 list_for_each_entry(acl, &p->acl, list) {
1037 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001038 if (!strcmp(expr->kw, "http_auth_group")) {
1039 /* Note: the ARGT_USR argument may only have been resolved earlier
1040 * by smp_resolve_args().
1041 */
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001042 if (expr->smp->arg_p->unresolved) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001043 Alert("Internal bug in proxy %s: %sacl %s %s() makes use of unresolved userlist '%s'. Please report this.\n",
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001044 p->id, *acl->name ? "" : "anonymous ", acl->name, expr->kw, expr->smp->arg_p->data.str.str);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001045 cfgerr++;
Willy Tarreau496aa012012-06-01 10:38:29 +02001046 continue;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001047 }
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001048
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +01001049 if (LIST_ISEMPTY(&expr->pat.patterns)) {
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001050 Alert("proxy %s: acl %s %s(): no groups specified.\n",
Willy Tarreau93fddf12013-03-31 22:59:32 +02001051 p->id, acl->name, expr->kw);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001052 cfgerr++;
1053 continue;
1054 }
1055
Thierry FOURNIERd163e1c2013-11-28 11:41:23 +01001056 list_for_each_entry(pattern, &expr->pat.patterns, list) {
Willy Tarreau7d1df412012-11-23 23:47:36 +01001057 /* this keyword only has one argument */
Thierry FOURNIER348971e2013-11-21 10:50:10 +01001058 pattern->val.group_mask = auth_resolve_groups(expr->smp->arg_p->data.usr, pattern->ptr.str);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001059
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001060 if (!pattern->val.group_mask) {
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001061 Alert("proxy %s: acl %s %s(): invalid group '%s'.\n",
1062 p->id, acl->name, expr->kw, pattern->ptr.str);
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001063 cfgerr++;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001064 }
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001065 free(pattern->ptr.str);
1066 pattern->ptr.str = NULL;
1067 pattern->len = 0;
Krzysztof Piotr Oledzkif9423ae2010-01-29 19:26:18 +01001068 }
1069 }
1070 }
1071 }
1072
1073 return cfgerr;
1074}
Willy Tarreaudd64f8d2008-07-27 22:02:32 +02001075
Willy Tarreau8ed669b2013-01-11 15:49:37 +01001076/* initializes ACLs by resolving the sample fetch names they rely upon.
1077 * Returns 0 on success, otherwise an error.
1078 */
1079int init_acl()
1080{
1081 int err = 0;
1082 int index;
1083 const char *name;
1084 struct acl_kw_list *kwl;
1085 struct sample_fetch *smp;
1086
1087 list_for_each_entry(kwl, &acl_keywords.list, list) {
1088 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1089 name = kwl->kw[index].fetch_kw;
1090 if (!name)
1091 name = kwl->kw[index].kw;
1092
1093 smp = find_sample_fetch(name, strlen(name));
1094 if (!smp) {
1095 Alert("Critical internal error: ACL keyword '%s' relies on sample fetch '%s' which was not registered!\n",
1096 kwl->kw[index].kw, name);
1097 err++;
1098 continue;
1099 }
1100 kwl->kw[index].smp = smp;
1101 }
1102 }
1103 return err;
1104}
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001105
Willy Tarreaua84d3742007-05-07 00:36:48 +02001106/************************************************************************/
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001107/* All supported sample and ACL keywords must be declared here. */
1108/************************************************************************/
1109
1110/* Note: must not be declared <const> as its list will be overwritten.
Willy Tarreau61612d42012-04-19 18:42:05 +02001111 * Please take care of keeping this list alphabetically sorted.
1112 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001113static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreaud4c33c82013-01-07 21:59:07 +01001114 { /* END */ },
Willy Tarreaua84d3742007-05-07 00:36:48 +02001115}};
1116
Willy Tarreaua84d3742007-05-07 00:36:48 +02001117__attribute__((constructor))
1118static void __acl_init(void)
1119{
Willy Tarreaua84d3742007-05-07 00:36:48 +02001120 acl_register_keywords(&acl_kws);
1121}
1122
1123
1124/*
1125 * Local variables:
1126 * c-indent-level: 8
1127 * c-basic-offset: 8
1128 * End:
1129 */