blob: 96b21de42bf3e7d6bc86295ca8629b34fc23fe3c [file] [log] [blame]
Willy Tarreaua84d3742007-05-07 00:36:48 +02001/*
2 * ACL management functions.
3 *
4 * Copyright 2000-2007 Willy Tarreau <w@1wt.eu>
5 *
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>
20
21#include <proto/acl.h>
22
23#include <types/acl.h>
24#include <types/proxy.h>
25#include <types/session.h>
26
27/* List head of all known ACL keywords */
28static struct acl_kw_list acl_keywords = {
29 .list = LIST_HEAD_INIT(acl_keywords.list)
30};
31
32
Willy Tarreaua5909832007-06-17 20:40:25 +020033/*
34 * These functions are only used for debugging complex configurations.
Willy Tarreaua84d3742007-05-07 00:36:48 +020035 */
Willy Tarreaua5909832007-06-17 20:40:25 +020036
37/* ignore the current line */
38static int
39acl_parse_nothing(const char **text, struct acl_pattern *pattern, int *opaque)
40{
41 return 1;
42}
43
44/* always fake a data retrieval */
45static int
46acl_fetch_nothing(struct proxy *px, struct session *l4, void *l7, int dir,
47 struct acl_expr *expr, struct acl_test *test)
Willy Tarreaua84d3742007-05-07 00:36:48 +020048{
49 return 1;
50}
51
Willy Tarreaua5909832007-06-17 20:40:25 +020052/* always return true */
53static int
54acl_match_true(struct acl_test *test, struct acl_pattern *pattern)
55{
56 return 1;
57}
58
59/* always return false */
60static int
61acl_match_false(struct acl_test *test, struct acl_pattern *pattern)
62{
63 return 0;
64}
65
66
Willy Tarreaua84d3742007-05-07 00:36:48 +020067/* NB: For two strings to be identical, it is required that their lengths match */
68int acl_match_str(struct acl_test *test, struct acl_pattern *pattern)
69{
Willy Tarreauc8d7c962007-06-17 08:20:33 +020070 int icase;
71
Willy Tarreaua84d3742007-05-07 00:36:48 +020072 if (pattern->len != test->len)
73 return 0;
Willy Tarreauc8d7c962007-06-17 08:20:33 +020074
75 icase = pattern->flags & ACL_PAT_F_IGNORE_CASE;
76 if ((icase && strncasecmp(pattern->ptr.str, test->ptr, test->len) == 0) ||
77 (!icase && strncmp(pattern->ptr.str, test->ptr, test->len) == 0))
Willy Tarreaua84d3742007-05-07 00:36:48 +020078 return 1;
79 return 0;
80}
81
Willy Tarreauf3d25982007-05-08 22:45:09 +020082/* Executes a regex. It needs to change the data. If it is marked READ_ONLY
83 * then it will be allocated and duplicated in place so that others may use
84 * it later on. Note that this is embarrassing because we always try to avoid
85 * allocating memory at run time.
86 */
87int acl_match_reg(struct acl_test *test, struct acl_pattern *pattern)
88{
89 char old_char;
90 int ret;
91
92 if (unlikely(test->flags & ACL_TEST_F_READ_ONLY)) {
93 char *new_str;
94
95 new_str = calloc(1, test->len + 1);
96 if (!new_str)
97 return 0;
98
99 memcpy(new_str, test->ptr, test->len);
100 new_str[test->len] = 0;
101 if (test->flags & ACL_TEST_F_MUST_FREE)
102 free(test->ptr);
103 test->ptr = new_str;
104 test->flags |= ACL_TEST_F_MUST_FREE;
105 test->flags &= ~ACL_TEST_F_READ_ONLY;
106 }
107
108 old_char = test->ptr[test->len];
109 test->ptr[test->len] = 0;
110
111 if (regexec(pattern->ptr.reg, test->ptr, 0, NULL, 0) == 0)
112 ret = 1;
113 else
114 ret = 0;
115
116 test->ptr[test->len] = old_char;
117 return ret;
118}
119
Willy Tarreaua84d3742007-05-07 00:36:48 +0200120/* Checks that the pattern matches the beginning of the tested string. */
121int acl_match_beg(struct acl_test *test, struct acl_pattern *pattern)
122{
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200123 int icase;
124
Willy Tarreaua84d3742007-05-07 00:36:48 +0200125 if (pattern->len > test->len)
126 return 0;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200127
128 icase = pattern->flags & ACL_PAT_F_IGNORE_CASE;
129 if ((icase && strncasecmp(pattern->ptr.str, test->ptr, pattern->len) != 0) ||
130 (!icase && strncmp(pattern->ptr.str, test->ptr, pattern->len) != 0))
Willy Tarreaua84d3742007-05-07 00:36:48 +0200131 return 0;
132 return 1;
133}
134
135/* Checks that the pattern matches the end of the tested string. */
136int acl_match_end(struct acl_test *test, struct acl_pattern *pattern)
137{
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200138 int icase;
139
Willy Tarreaua84d3742007-05-07 00:36:48 +0200140 if (pattern->len > test->len)
141 return 0;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200142 icase = pattern->flags & ACL_PAT_F_IGNORE_CASE;
143 if ((icase && strncasecmp(pattern->ptr.str, test->ptr + test->len - pattern->len, pattern->len) != 0) ||
144 (!icase && strncmp(pattern->ptr.str, test->ptr + test->len - pattern->len, pattern->len) != 0))
Willy Tarreaua84d3742007-05-07 00:36:48 +0200145 return 0;
146 return 1;
147}
148
149/* Checks that the pattern is included inside the tested string.
150 * NB: Suboptimal, should be rewritten using a Boyer-Moore method.
151 */
152int acl_match_sub(struct acl_test *test, struct acl_pattern *pattern)
153{
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200154 int icase;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200155 char *end;
156 char *c;
157
158 if (pattern->len > test->len)
159 return 0;
160
161 end = test->ptr + test->len - pattern->len;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200162 icase = pattern->flags & ACL_PAT_F_IGNORE_CASE;
163 if (icase) {
164 for (c = test->ptr; c <= end; c++) {
165 if (tolower(*c) != tolower(*pattern->ptr.str))
166 continue;
167 if (strncasecmp(pattern->ptr.str, c, pattern->len) == 0)
168 return 1;
169 }
170 } else {
171 for (c = test->ptr; c <= end; c++) {
172 if (*c != *pattern->ptr.str)
173 continue;
174 if (strncmp(pattern->ptr.str, c, pattern->len) == 0)
175 return 1;
176 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200177 }
178 return 0;
179}
180
181/* This one is used by other real functions. It checks that the pattern is
182 * included inside the tested string, but enclosed between the specified
183 * delimitor, or a '/' or a '?' or at the beginning or end of the string.
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200184 * The delimitor is stripped at the beginning or end of the pattern.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200185 */
186static int match_word(struct acl_test *test, struct acl_pattern *pattern, char delim)
187{
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200188 int may_match, icase;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200189 char *c, *end;
190 char *ps;
191 int pl;
192
193 pl = pattern->len;
194 ps = pattern->ptr.str;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200195 while (pl > 0 && (*ps == delim || *ps == '/' || *ps == '?')) {
Willy Tarreaua84d3742007-05-07 00:36:48 +0200196 pl--;
197 ps++;
198 }
199
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200200 while (pl > 0 &&
201 (ps[pl - 1] == delim || ps[pl - 1] == '/' || ps[pl - 1] == '?'))
Willy Tarreaua84d3742007-05-07 00:36:48 +0200202 pl--;
203
204 if (pl > test->len)
205 return 0;
206
207 may_match = 1;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200208 icase = pattern->flags & ACL_PAT_F_IGNORE_CASE;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200209 end = test->ptr + test->len - pl;
210 for (c = test->ptr; c <= end; c++) {
211 if (*c == '/' || *c == delim || *c == '?') {
212 may_match = 1;
213 continue;
214 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200215
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200216 if (!may_match)
217 continue;
218
219 if (icase) {
220 if ((tolower(*c) == tolower(*ps)) &&
221 (strncasecmp(ps, c, pl) == 0) &&
222 (c == end || c[pl] == '/' || c[pl] == delim || c[pl] == '?'))
223 return 1;
224 } else {
225 if ((*c == *ps) &&
226 (strncmp(ps, c, pl) == 0) &&
227 (c == end || c[pl] == '/' || c[pl] == delim || c[pl] == '?'))
228 return 1;
229 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200230 may_match = 0;
231 }
232 return 0;
233}
234
235/* Checks that the pattern is included inside the tested string, but enclosed
236 * between slashes or at the beginning or end of the string. Slashes at the
237 * beginning or end of the pattern are ignored.
238 */
239int acl_match_dir(struct acl_test *test, struct acl_pattern *pattern)
240{
241 return match_word(test, pattern, '/');
242}
243
244/* Checks that the pattern is included inside the tested string, but enclosed
245 * between dots or at the beginning or end of the string. Dots at the beginning
246 * or end of the pattern are ignored.
247 */
248int acl_match_dom(struct acl_test *test, struct acl_pattern *pattern)
249{
250 return match_word(test, pattern, '.');
251}
252
253/* Checks that the integer in <test> is included between min and max */
Willy Tarreauae8b7962007-06-09 23:10:04 +0200254int acl_match_int(struct acl_test *test, struct acl_pattern *pattern)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200255{
Willy Tarreauae8b7962007-06-09 23:10:04 +0200256 if ((!pattern->val.range.min_set || pattern->val.range.min <= test->i) &&
257 (!pattern->val.range.max_set || test->i <= pattern->val.range.max))
Willy Tarreaua84d3742007-05-07 00:36:48 +0200258 return 1;
259 return 0;
260}
261
Willy Tarreaua67fad92007-05-08 19:50:09 +0200262int acl_match_ip(struct acl_test *test, struct acl_pattern *pattern)
263{
264 struct in_addr *s;
265
266 if (test->i != AF_INET)
267 return 0;
268
269 s = (void *)test->ptr;
270 if (((s->s_addr ^ pattern->val.ipv4.addr.s_addr) & pattern->val.ipv4.mask.s_addr) == 0)
271 return 1;
272 return 0;
273}
274
Willy Tarreaua84d3742007-05-07 00:36:48 +0200275/* Parse a string. It is allocated and duplicated. */
Willy Tarreauae8b7962007-06-09 23:10:04 +0200276int acl_parse_str(const char **text, struct acl_pattern *pattern, int *opaque)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200277{
278 int len;
279
Willy Tarreauae8b7962007-06-09 23:10:04 +0200280 len = strlen(*text);
281 pattern->ptr.str = strdup(*text);
Willy Tarreaua84d3742007-05-07 00:36:48 +0200282 if (!pattern->ptr.str)
283 return 0;
284 pattern->len = len;
285 return 1;
286}
287
Willy Tarreauf3d25982007-05-08 22:45:09 +0200288/* Parse a regex. It is allocated. */
Willy Tarreauae8b7962007-06-09 23:10:04 +0200289int acl_parse_reg(const char **text, struct acl_pattern *pattern, int *opaque)
Willy Tarreauf3d25982007-05-08 22:45:09 +0200290{
291 regex_t *preg;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200292 int icase;
Willy Tarreauf3d25982007-05-08 22:45:09 +0200293
294 preg = calloc(1, sizeof(regex_t));
295
296 if (!preg)
297 return 0;
298
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200299 icase = (pattern->flags & ACL_PAT_F_IGNORE_CASE) ? REG_ICASE : 0;
300 if (regcomp(preg, *text, REG_EXTENDED | REG_NOSUB | icase) != 0) {
Willy Tarreauf3d25982007-05-08 22:45:09 +0200301 free(preg);
302 return 0;
303 }
304
305 pattern->ptr.reg = preg;
306 return 1;
307}
308
Willy Tarreauae8b7962007-06-09 23:10:04 +0200309/* Parse a range of positive integers delimited by either ':' or '-'. If only
310 * one integer is read, it is set as both min and max. An operator may be
311 * specified as the prefix, among this list of 5 :
312 *
313 * 0:eq, 1:gt, 2:ge, 3:lt, 4:le
314 *
315 * The default operator is "eq". It supports range matching. Ranges are
316 * rejected for other operators. The operator may be changed at any time.
317 * The operator is stored in the 'opaque' argument.
318 *
Willy Tarreaua84d3742007-05-07 00:36:48 +0200319 */
Willy Tarreauae8b7962007-06-09 23:10:04 +0200320int acl_parse_int(const char **text, struct acl_pattern *pattern, int *opaque)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200321{
Willy Tarreauae8b7962007-06-09 23:10:04 +0200322 signed long long i;
323 unsigned int j, last, skip = 0;
324 const char *ptr = *text;
325
326
Willy Tarreau8f8e6452007-06-17 21:51:38 +0200327 while (!isdigit((unsigned char)*ptr)) {
Willy Tarreauae8b7962007-06-09 23:10:04 +0200328 if (strcmp(ptr, "eq") == 0) *opaque = 0;
329 else if (strcmp(ptr, "gt") == 0) *opaque = 1;
330 else if (strcmp(ptr, "ge") == 0) *opaque = 2;
331 else if (strcmp(ptr, "lt") == 0) *opaque = 3;
332 else if (strcmp(ptr, "le") == 0) *opaque = 4;
333 else
334 return 0;
335
336 skip++;
337 ptr = text[skip];
338 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200339
340 last = i = 0;
341 while (1) {
Willy Tarreauae8b7962007-06-09 23:10:04 +0200342 j = *ptr++;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200343 if ((j == '-' || j == ':') && !last) {
344 last++;
345 pattern->val.range.min = i;
346 i = 0;
347 continue;
348 }
349 j -= '0';
350 if (j > 9)
351 // also catches the terminating zero
352 break;
353 i *= 10;
354 i += j;
355 }
Willy Tarreauae8b7962007-06-09 23:10:04 +0200356
357 if (last && *opaque >= 1 && *opaque <= 4)
358 /* having a range with a min or a max is absurd */
359 return 0;
360
Willy Tarreaua84d3742007-05-07 00:36:48 +0200361 if (!last)
362 pattern->val.range.min = i;
363 pattern->val.range.max = i;
Willy Tarreauae8b7962007-06-09 23:10:04 +0200364
365 switch (*opaque) {
366 case 0: /* eq */
367 pattern->val.range.min_set = 1;
368 pattern->val.range.max_set = 1;
369 break;
370 case 1: /* gt */
371 pattern->val.range.min++; /* gt = ge + 1 */
372 case 2: /* ge */
373 pattern->val.range.min_set = 1;
374 pattern->val.range.max_set = 0;
375 break;
376 case 3: /* lt */
377 pattern->val.range.max--; /* lt = le - 1 */
378 case 4: /* le */
379 pattern->val.range.min_set = 0;
380 pattern->val.range.max_set = 1;
381 break;
382 }
383 return skip + 1;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200384}
385
Willy Tarreaua67fad92007-05-08 19:50:09 +0200386/* Parse an IP address and an optional mask in the form addr[/mask].
387 * The addr may either be an IPv4 address or a hostname. The mask
388 * may either be a dotted mask or a number of bits. Returns 1 if OK,
389 * otherwise 0.
390 */
Willy Tarreauae8b7962007-06-09 23:10:04 +0200391int acl_parse_ip(const char **text, struct acl_pattern *pattern, int *opaque)
Willy Tarreaua67fad92007-05-08 19:50:09 +0200392{
Willy Tarreauae8b7962007-06-09 23:10:04 +0200393 if (str2net(*text, &pattern->val.ipv4.addr, &pattern->val.ipv4.mask))
394 return 1;
395 else
396 return 0;
Willy Tarreaua67fad92007-05-08 19:50:09 +0200397}
398
Willy Tarreaua84d3742007-05-07 00:36:48 +0200399/*
400 * Registers the ACL keyword list <kwl> as a list of valid keywords for next
401 * parsing sessions.
402 */
403void acl_register_keywords(struct acl_kw_list *kwl)
404{
405 LIST_ADDQ(&acl_keywords.list, &kwl->list);
406}
407
408/*
409 * Unregisters the ACL keyword list <kwl> from the list of valid keywords.
410 */
411void acl_unregister_keywords(struct acl_kw_list *kwl)
412{
413 LIST_DEL(&kwl->list);
414 LIST_INIT(&kwl->list);
415}
416
417/* Return a pointer to the ACL <name> within the list starting at <head>, or
418 * NULL if not found.
419 */
420struct acl *find_acl_by_name(const char *name, struct list *head)
421{
422 struct acl *acl;
423 list_for_each_entry(acl, head, list) {
424 if (strcmp(acl->name, name) == 0)
425 return acl;
426 }
427 return NULL;
428}
429
430/* Return a pointer to the ACL keyword <kw>, or NULL if not found. Note that if
431 * <kw> contains an opening parenthesis, only the left part of it is checked.
432 */
433struct acl_keyword *find_acl_kw(const char *kw)
434{
435 int index;
436 const char *kwend;
437 struct acl_kw_list *kwl;
438
439 kwend = strchr(kw, '(');
440 if (!kwend)
441 kwend = kw + strlen(kw);
442
443 list_for_each_entry(kwl, &acl_keywords.list, list) {
444 for (index = 0; kwl->kw[index].kw != NULL; index++) {
445 if ((strncmp(kwl->kw[index].kw, kw, kwend - kw) == 0) &&
446 kwl->kw[index].kw[kwend-kw] == 0)
447 return &kwl->kw[index];
448 }
449 }
450 return NULL;
451}
452
453static void free_pattern(struct acl_pattern *pat)
454{
455 if (pat->ptr.ptr)
456 free(pat->ptr.ptr);
457 free(pat);
458}
459
460static void free_pattern_list(struct list *head)
461{
462 struct acl_pattern *pat, *tmp;
463 list_for_each_entry_safe(pat, tmp, head, list)
464 free_pattern(pat);
465}
466
467static struct acl_expr *prune_acl_expr(struct acl_expr *expr)
468{
469 free_pattern_list(&expr->patterns);
470 LIST_INIT(&expr->patterns);
471 if (expr->arg.str)
472 free(expr->arg.str);
473 expr->kw->use_cnt--;
474 return expr;
475}
476
477/* Parse an ACL expression starting at <args>[0], and return it.
478 * Right now, the only accepted syntax is :
479 * <subject> [<value>...]
480 */
481struct acl_expr *parse_acl_expr(const char **args)
482{
483 __label__ out_return, out_free_expr, out_free_pattern;
484 struct acl_expr *expr;
485 struct acl_keyword *aclkw;
486 struct acl_pattern *pattern;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200487 int opaque, patflags;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200488 const char *arg;
489
490 aclkw = find_acl_kw(args[0]);
491 if (!aclkw || !aclkw->parse)
492 goto out_return;
493
494 expr = (struct acl_expr *)calloc(1, sizeof(*expr));
495 if (!expr)
496 goto out_return;
497
498 expr->kw = aclkw;
499 aclkw->use_cnt++;
500 LIST_INIT(&expr->patterns);
501 expr->arg.str = NULL;
Willy Tarreaubb768912007-06-10 11:17:01 +0200502 expr->arg_len = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200503
504 arg = strchr(args[0], '(');
505 if (arg != NULL) {
506 char *end, *arg2;
507 /* there is an argument in the form "subject(arg)" */
508 arg++;
509 end = strchr(arg, ')');
510 if (!end)
511 goto out_free_expr;
512 arg2 = (char *)calloc(1, end - arg + 1);
513 if (!arg2)
514 goto out_free_expr;
515 memcpy(arg2, arg, end - arg);
516 arg2[end-arg] = '\0';
Willy Tarreaubb768912007-06-10 11:17:01 +0200517 expr->arg_len = end - arg;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200518 expr->arg.str = arg2;
519 }
520
Willy Tarreaua84d3742007-05-07 00:36:48 +0200521 args++;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200522
523 /* check for options before patterns. Supported options are :
524 * -i : ignore case for all patterns by default
525 * -f : read patterns from those files
526 * -- : everything after this is not an option
527 */
528 patflags = 0;
529 while (**args == '-') {
530 if ((*args)[1] == 'i')
531 patflags |= ACL_PAT_F_IGNORE_CASE;
532 else if ((*args)[1] == 'f')
533 patflags |= ACL_PAT_F_FROM_FILE;
534 else if ((*args)[1] == '-') {
535 args++;
536 break;
537 }
538 else
539 break;
540 args++;
541 }
542
543 /* now parse all patterns */
Willy Tarreauae8b7962007-06-09 23:10:04 +0200544 opaque = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200545 while (**args) {
Willy Tarreauae8b7962007-06-09 23:10:04 +0200546 int ret;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200547 pattern = (struct acl_pattern *)calloc(1, sizeof(*pattern));
548 if (!pattern)
549 goto out_free_expr;
Willy Tarreauc8d7c962007-06-17 08:20:33 +0200550 pattern->flags = patflags;
551
Willy Tarreauae8b7962007-06-09 23:10:04 +0200552 ret = aclkw->parse(args, pattern, &opaque);
553 if (!ret)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200554 goto out_free_pattern;
555 LIST_ADDQ(&expr->patterns, &pattern->list);
Willy Tarreauae8b7962007-06-09 23:10:04 +0200556 args += ret;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200557 }
558
559 return expr;
560
561 out_free_pattern:
562 free_pattern(pattern);
563 out_free_expr:
564 prune_acl_expr(expr);
565 free(expr);
566 out_return:
567 return NULL;
568}
569
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200570/* Purge everything in the acl <acl>, then return <acl>. */
571struct acl *prune_acl(struct acl *acl) {
572
573 struct acl_expr *expr, *exprb;
574
575 free(acl->name);
576
577 list_for_each_entry_safe(expr, exprb, &acl->expr, list) {
578 LIST_DEL(&expr->list);
579 prune_acl_expr(expr);
580 free(expr);
581 }
582
583 return acl;
584}
585
Willy Tarreaua84d3742007-05-07 00:36:48 +0200586/* Parse an ACL with the name starting at <args>[0], and with a list of already
587 * known ACLs in <acl>. If the ACL was not in the list, it will be added.
588 * A pointer to that ACL is returned.
589 *
590 * args syntax: <aclname> <acl_expr>
591 */
592struct acl *parse_acl(const char **args, struct list *known_acl)
593{
594 __label__ out_return, out_free_acl_expr, out_free_name;
595 struct acl *cur_acl;
596 struct acl_expr *acl_expr;
597 char *name;
598
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100599 if (invalid_char(*args))
600 goto out_return;
601
Willy Tarreaua84d3742007-05-07 00:36:48 +0200602 acl_expr = parse_acl_expr(args + 1);
603 if (!acl_expr)
604 goto out_return;
605
606 cur_acl = find_acl_by_name(args[0], known_acl);
607 if (!cur_acl) {
608 name = strdup(args[0]);
609 if (!name)
610 goto out_free_acl_expr;
611 cur_acl = (struct acl *)calloc(1, sizeof(*cur_acl));
612 if (cur_acl == NULL)
613 goto out_free_name;
614
615 LIST_INIT(&cur_acl->expr);
616 LIST_ADDQ(known_acl, &cur_acl->list);
617 cur_acl->name = name;
618 }
619
620 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
621 return cur_acl;
622
623 out_free_name:
624 free(name);
625 out_free_acl_expr:
626 prune_acl_expr(acl_expr);
627 free(acl_expr);
628 out_return:
629 return NULL;
630}
631
Willy Tarreau16fbe822007-06-17 11:54:31 +0200632/* Some useful ACLs provided by default. Only those used are allocated. */
633
634const struct {
635 const char *name;
636 const char *expr[4]; /* put enough for longest expression */
637} default_acl_list[] = {
Willy Tarreaua5909832007-06-17 20:40:25 +0200638 { .name = "TRUE", .expr = {"always_true","1",""}},
639 { .name = "FALSE", .expr = {"always_false","0",""}},
Willy Tarreau16fbe822007-06-17 11:54:31 +0200640 { .name = "LOCALHOST", .expr = {"src","127.0.0.1/8",""}},
641 { .name = "HTTP_1.0", .expr = {"req_ver","1.0",""}},
642 { .name = "HTTP_1.1", .expr = {"req_ver","1.1",""}},
643 { .name = "METH_CONNECT", .expr = {"method","CONNECT",""}},
644 { .name = "METH_GET", .expr = {"method","GET","HEAD",""}},
645 { .name = "METH_HEAD", .expr = {"method","HEAD",""}},
646 { .name = "METH_OPTIONS", .expr = {"method","OPTIONS",""}},
647 { .name = "METH_POST", .expr = {"method","POST",""}},
648 { .name = "METH_TRACE", .expr = {"method","TRACE",""}},
649 { .name = "HTTP_URL_ABS", .expr = {"url_reg","^[^/:]*://",""}},
650 { .name = "HTTP_URL_SLASH", .expr = {"url_beg","/",""}},
651 { .name = "HTTP_URL_STAR", .expr = {"url","*",""}},
652 { .name = "HTTP_CONTENT", .expr = {"hdr_val(content-length)","gt","0",""}},
653 { .name = NULL, .expr = {""}}
654};
655
656/* Find a default ACL from the default_acl list, compile it and return it.
657 * If the ACL is not found, NULL is returned. In theory, it cannot fail,
658 * except when default ACLs are broken, in which case it will return NULL.
659 * If <known_acl> is not NULL, the ACL will be queued at its tail.
660 */
661struct acl *find_acl_default(const char *acl_name, struct list *known_acl)
662{
663 __label__ out_return, out_free_acl_expr, out_free_name;
664 struct acl *cur_acl;
665 struct acl_expr *acl_expr;
666 char *name;
667 int index;
668
669 for (index = 0; default_acl_list[index].name != NULL; index++) {
670 if (strcmp(acl_name, default_acl_list[index].name) == 0)
671 break;
672 }
673
674 if (default_acl_list[index].name == NULL)
675 return NULL;
676
677 acl_expr = parse_acl_expr((const char **)default_acl_list[index].expr);
678 if (!acl_expr)
679 goto out_return;
680
681 name = strdup(acl_name);
682 if (!name)
683 goto out_free_acl_expr;
684 cur_acl = (struct acl *)calloc(1, sizeof(*cur_acl));
685 if (cur_acl == NULL)
686 goto out_free_name;
687
688 cur_acl->name = name;
689 LIST_INIT(&cur_acl->expr);
690 LIST_ADDQ(&cur_acl->expr, &acl_expr->list);
691 if (known_acl)
692 LIST_ADDQ(known_acl, &cur_acl->list);
693
694 return cur_acl;
695
696 out_free_name:
697 free(name);
698 out_free_acl_expr:
699 prune_acl_expr(acl_expr);
700 free(acl_expr);
701 out_return:
702 return NULL;
703}
Willy Tarreaua84d3742007-05-07 00:36:48 +0200704
705/* Purge everything in the acl_cond <cond>, then return <cond>. */
706struct acl_cond *prune_acl_cond(struct acl_cond *cond)
707{
708 struct acl_term_suite *suite, *tmp_suite;
709 struct acl_term *term, *tmp_term;
710
711 /* iterate through all term suites and free all terms and all suites */
712 list_for_each_entry_safe(suite, tmp_suite, &cond->suites, list) {
713 list_for_each_entry_safe(term, tmp_term, &suite->terms, list)
714 free(term);
715 free(suite);
716 }
717 return cond;
718}
719
720/* Parse an ACL condition starting at <args>[0], relying on a list of already
721 * known ACLs passed in <known_acl>. The new condition is returned (or NULL in
722 * case of low memory). Supports multiple conditions separated by "or".
723 */
724struct acl_cond *parse_acl_cond(const char **args, struct list *known_acl, int pol)
725{
726 __label__ out_return, out_free_suite, out_free_term;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200727 int arg, neg;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200728 const char *word;
729 struct acl *cur_acl;
730 struct acl_term *cur_term;
731 struct acl_term_suite *cur_suite;
732 struct acl_cond *cond;
733
734 cond = (struct acl_cond *)calloc(1, sizeof(*cond));
735 if (cond == NULL)
736 goto out_return;
737
738 LIST_INIT(&cond->list);
739 LIST_INIT(&cond->suites);
740 cond->pol = pol;
741
742 cur_suite = NULL;
Willy Tarreau74b98a82007-06-16 19:35:18 +0200743 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200744 for (arg = 0; *args[arg]; arg++) {
745 word = args[arg];
746
747 /* remove as many exclamation marks as we can */
748 while (*word == '!') {
749 neg = !neg;
750 word++;
751 }
752
753 /* an empty word is allowed because we cannot force the user to
754 * always think about not leaving exclamation marks alone.
755 */
756 if (!*word)
757 continue;
758
Willy Tarreau16fbe822007-06-17 11:54:31 +0200759 if (strcasecmp(word, "or") == 0 || strcmp(word, "||") == 0) {
Willy Tarreaua84d3742007-05-07 00:36:48 +0200760 /* new term suite */
761 cur_suite = NULL;
762 neg = 0;
763 continue;
764 }
765
Willy Tarreau16fbe822007-06-17 11:54:31 +0200766 /* search for <word> in the known ACL names. If we do not find
767 * it, let's look for it in the default ACLs, and if found, add
768 * it to the list of ACLs of this proxy. This makes it possible
769 * to override them.
770 */
Willy Tarreaua84d3742007-05-07 00:36:48 +0200771 cur_acl = find_acl_by_name(word, known_acl);
Willy Tarreau16fbe822007-06-17 11:54:31 +0200772 if (cur_acl == NULL) {
773 cur_acl = find_acl_default(word, known_acl);
774 if (cur_acl == NULL)
775 goto out_free_suite;
776 }
Willy Tarreaua84d3742007-05-07 00:36:48 +0200777
778 cur_term = (struct acl_term *)calloc(1, sizeof(*cur_term));
779 if (cur_term == NULL)
780 goto out_free_suite;
781
782 cur_term->acl = cur_acl;
783 cur_term->neg = neg;
784
785 if (!cur_suite) {
786 cur_suite = (struct acl_term_suite *)calloc(1, sizeof(*cur_suite));
787 if (cur_term == NULL)
788 goto out_free_term;
789 LIST_INIT(&cur_suite->terms);
790 LIST_ADDQ(&cond->suites, &cur_suite->list);
791 }
792 LIST_ADDQ(&cur_suite->terms, &cur_term->list);
Willy Tarreau74b98a82007-06-16 19:35:18 +0200793 neg = 0;
Willy Tarreaua84d3742007-05-07 00:36:48 +0200794 }
795
796 return cond;
797
798 out_free_term:
799 free(cur_term);
800 out_free_suite:
801 prune_acl_cond(cond);
802 free(cond);
803 out_return:
804 return NULL;
805}
806
807/* Execute condition <cond> and return 0 if test fails or 1 if test succeeds.
808 * This function only computes the condition, it does not apply the polarity
809 * required by IF/UNLESS, it's up to the caller to do this.
810 */
Willy Tarreaud41f8d82007-06-10 10:06:18 +0200811int acl_exec_cond(struct acl_cond *cond, struct proxy *px, struct session *l4, void *l7, int dir)
Willy Tarreaua84d3742007-05-07 00:36:48 +0200812{
813 __label__ fetch_next;
814 struct acl_term_suite *suite;
815 struct acl_term *term;
816 struct acl_expr *expr;
817 struct acl *acl;
818 struct acl_pattern *pattern;
819 struct acl_test test;
820 int acl_res, pat_res, suite_res, cond_res;
821
822 /* we're doing a logical OR between conditions so we initialize to FAIL */
823 cond_res = ACL_PAT_FAIL;
824 list_for_each_entry(suite, &cond->suites, list) {
825 /* evaluate condition suite <suite>. We stop at the first term
826 * which does not return ACL_PAT_PASS.
827 */
828
829 /* we're doing a logical AND between terms, so we must set the
830 * initial value to PASS.
831 */
832 suite_res = ACL_PAT_PASS;
833 list_for_each_entry(term, &suite->terms, list) {
834 acl = term->acl;
835
836 /* FIXME: use cache !
837 * check acl->cache_idx for this.
838 */
839
840 /* ACL result not cached. Let's scan all the expressions
841 * and use the first one to match.
842 */
843 acl_res = ACL_PAT_FAIL;
844 list_for_each_entry(expr, &acl->expr, list) {
Willy Tarreaud41f8d82007-06-10 10:06:18 +0200845 /* we need to reset context and flags */
846 memset(&test, 0, sizeof(test));
Willy Tarreaua84d3742007-05-07 00:36:48 +0200847 fetch_next:
Willy Tarreau97be1452007-06-10 11:47:14 +0200848 if (!expr->kw->fetch(px, l4, l7, dir, expr, &test))
Willy Tarreaua84d3742007-05-07 00:36:48 +0200849 continue;
850
851 /* apply all tests to this value */
852 list_for_each_entry(pattern, &expr->patterns, list) {
853 pat_res = expr->kw->match(&test, pattern);
854
855 if (pat_res & ACL_PAT_MISS) {
856 /* there is at least one test which might be worth retrying later. */
857 acl_res |= ACL_PAT_MISS;
858 continue;
859 } else if (pat_res & ACL_PAT_PASS) {
860 /* we found one ! */
861 acl_res |= ACL_PAT_PASS;
862 break;
863 }
864 }
865 /*
Willy Tarreau74b98a82007-06-16 19:35:18 +0200866 * OK now we have the result of this expression in acl_res.
Willy Tarreaua84d3742007-05-07 00:36:48 +0200867 * - we have the PASS bit set if at least one pattern matched ;
868 * - we have the MISS bit set if at least one pattern may match
869 * later so that we should not cache a failure ;
870 *
871 * Then if (PASS || !MISS) we can cache the result, and put
872 * (test.flags & ACL_TEST_F_VOLATILE) in the cache flags.
873 *
874 * FIXME: implement cache.
875 *
876 */
877
878 /* now we may have some cleanup to do */
879 if (test.flags & ACL_TEST_F_MUST_FREE) {
880 free(test.ptr);
881 test.len = 0;
882 }
883
884 if (acl_res & ACL_PAT_PASS)
885 break;
886
887 /* prepare to test another expression */
888 acl_res = ACL_PAT_FAIL;
889
890 if (test.flags & ACL_TEST_F_FETCH_MORE)
891 goto fetch_next;
892 }
893 /*
894 * Here we have the result of an ACL (cached or not).
895 * ACLs are combined, negated or not, to form conditions.
896 */
897
898 acl_res &= ACL_PAT_PASS;
899 if (term->neg)
900 acl_res ^= ACL_PAT_PASS;
901
902 suite_res &= acl_res;
903 if (!(suite_res & ACL_PAT_PASS))
904 break;
905 }
906 cond_res |= suite_res;
907 if (cond_res & ACL_PAT_PASS)
908 break;
909 }
910
911 return (cond_res & ACL_PAT_PASS) ? 1 : 0;
912}
913
914
915/************************************************************************/
916/* All supported keywords must be declared here. */
917/************************************************************************/
918
919/* Note: must not be declared <const> as its list will be overwritten */
920static struct acl_kw_list acl_kws = {{ },{
Willy Tarreaua5909832007-06-17 20:40:25 +0200921 { "always_true", acl_parse_nothing, acl_fetch_nothing, acl_match_true },
922 { "always_false", acl_parse_nothing, acl_fetch_nothing, acl_match_false },
Willy Tarreaua84d3742007-05-07 00:36:48 +0200923#if 0
924 { "time", acl_parse_time, acl_fetch_time, acl_match_time },
925#endif
926 { NULL, NULL, NULL, NULL }
927}};
928
929
930__attribute__((constructor))
931static void __acl_init(void)
932{
933 acl_register_keywords(&acl_kws);
934}
935
936
937/*
938 * Local variables:
939 * c-indent-level: 8
940 * c-basic-offset: 8
941 * End:
942 */