blob: e5c1b42df6a8801b14024c1c326ee813ace371c1 [file] [log] [blame]
Thierry FOURNIERed66c292013-11-28 11:05:19 +01001/*
2 * include/proto/pattern.h
3 * This file provides structures and types for pattern matching.
4 *
5 * Copyright (C) 2000-2013 Willy Tarreau - w@1wt.eu
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22#ifndef _PROTO_PATTERN_H
23#define _PROTO_PATTERN_H
24
Willy Tarreau6f8fe312013-11-28 22:24:25 +010025#include <string.h>
26
Willy Tarreau0cba6072013-11-28 22:21:02 +010027#include <common/config.h>
28#include <common/standard.h>
29#include <types/pattern.h>
30
Thierry FOURNIER7148ce62013-12-06 19:06:43 +010031/* parse the <args> with <expr> compliant parser. <pattern> is a context for
Thierry FOURNIERed66c292013-11-28 11:05:19 +010032 * the current parsed acl. It must initialized at NULL:
33 *
Thierry FOURNIERa65b3432013-11-28 18:22:00 +010034 * struct pattern *pattern = NULL
35 * pattern_register(..., &pattern, ...);
Thierry FOURNIERed66c292013-11-28 11:05:19 +010036 *
Thierry FOURNIERa65b3432013-11-28 18:22:00 +010037 * patflag are a lot of 'PAT_F_*' flags pattern compatible. see
Thierry FOURNIERed66c292013-11-28 11:05:19 +010038 * <types/acl.h>.
39 *
Thierry FOURNIER7148ce62013-12-06 19:06:43 +010040 * The function returns 1 if the processing is ok, return 0
41 * if the parser fails, with <err> message filled.
Thierry FOURNIERed66c292013-11-28 11:05:19 +010042 */
Thierry FOURNIER7148ce62013-12-06 19:06:43 +010043int pattern_register(struct pattern_expr *expr, const char **args, struct sample_storage *smp, struct pattern **pattern, int patflags, char **err);
Thierry FOURNIERed66c292013-11-28 11:05:19 +010044
Willy Tarreau6f8fe312013-11-28 22:24:25 +010045/* return the PAT_MATCH_* index for match name "name", or < 0 if not found */
46static inline int pat_find_match_name(const char *name)
47{
48 int i;
49
50 for (i = 0; i < PAT_MATCH_NUM; i++)
51 if (strcmp(name, pat_match_names[i]) == 0)
52 return i;
53 return -1;
54}
55
Thierry FOURNIERed66c292013-11-28 11:05:19 +010056/* This function executes a pattern match on a sample. It applies pattern <expr>
57 * to sample <smp>. If <sample> is not NULL, a pointer to an optional sample
58 * associated to the matching patterned will be put there. The function returns
Thierry FOURNIERa65b3432013-11-28 18:22:00 +010059 * PAT_MATCH or PAT_NOMATCH.
Thierry FOURNIERed66c292013-11-28 11:05:19 +010060 */
Thierry FOURNIER76090642013-12-10 15:03:38 +010061enum pat_match_res pattern_exec_match(struct pattern_expr *expr, struct sample *smp, struct sample_storage **sample, struct pattern **pat, struct pat_idx_elt **elt);
Thierry FOURNIERed66c292013-11-28 11:05:19 +010062
63/*
64 *
65 * The following functions are general purpose pattern matching functions.
66 *
67 */
68
69
70/* ignore the current line */
Thierry FOURNIER0b2fe4a2013-12-06 20:33:50 +010071int pat_parse_nothing(const char **text, struct pattern *pattern, enum pat_usage usage, int *opaque, char **err);
Thierry FOURNIERed66c292013-11-28 11:05:19 +010072
Thierry FOURNIERed66c292013-11-28 11:05:19 +010073/* Parse an integer. It is put both in min and max. */
Thierry FOURNIER0b2fe4a2013-12-06 20:33:50 +010074int pat_parse_int(const char **text, struct pattern *pattern, enum pat_usage usage, int *opaque, char **err);
Thierry FOURNIERed66c292013-11-28 11:05:19 +010075
Thierry FOURNIERcc0e0b32013-12-06 16:56:40 +010076/* Parse len like an integer, but specify expected string type */
Thierry FOURNIER0b2fe4a2013-12-06 20:33:50 +010077int pat_parse_len(const char **text, struct pattern *pattern, enum pat_usage usage, int *opaque, char **err);
Thierry FOURNIERcc0e0b32013-12-06 16:56:40 +010078
Thierry FOURNIERed66c292013-11-28 11:05:19 +010079/* Parse an version. It is put both in min and max. */
Thierry FOURNIER0b2fe4a2013-12-06 20:33:50 +010080int pat_parse_dotted_ver(const char **text, struct pattern *pattern, enum pat_usage usage, int *opaque, char **err);
Thierry FOURNIERed66c292013-11-28 11:05:19 +010081
82/* Parse a range of integers delimited by either ':' or '-'. If only one
83 * integer is read, it is set as both min and max.
84 */
Thierry FOURNIER0b2fe4a2013-12-06 20:33:50 +010085int pat_parse_range(const char **text, struct pattern *pattern, enum pat_usage usage, int *opaque, char **err);
Thierry FOURNIERed66c292013-11-28 11:05:19 +010086
87/* Parse a string. It is allocated and duplicated. */
Thierry FOURNIER0b2fe4a2013-12-06 20:33:50 +010088int pat_parse_str(const char **text, struct pattern *pattern, enum pat_usage usage, int *opaque, char **err);
Thierry FOURNIERed66c292013-11-28 11:05:19 +010089
90/* Parse a hexa binary definition. It is allocated and duplicated. */
Thierry FOURNIER0b2fe4a2013-12-06 20:33:50 +010091int pat_parse_bin(const char **text, struct pattern *pattern, enum pat_usage usage, int *opaque, char **err);
Thierry FOURNIERed66c292013-11-28 11:05:19 +010092
93/* Parse and concatenate strings into one. It is allocated and duplicated. */
Thierry FOURNIER0b2fe4a2013-12-06 20:33:50 +010094int pat_parse_strcat(const char **text, struct pattern *pattern, enum pat_usage usage, int *opaque, char **err);
Thierry FOURNIERed66c292013-11-28 11:05:19 +010095
96/* Parse a regex. It is allocated. */
Thierry FOURNIER0b2fe4a2013-12-06 20:33:50 +010097int pat_parse_reg(const char **text, struct pattern *pattern, enum pat_usage usage, int *opaque, char **err);
Thierry FOURNIERed66c292013-11-28 11:05:19 +010098
99/* Parse an IP address and an optional mask in the form addr[/mask].
100 * The addr may either be an IPv4 address or a hostname. The mask
101 * may either be a dotted mask or a number of bits. Returns 1 if OK,
102 * otherwise 0.
103 */
Thierry FOURNIER0b2fe4a2013-12-06 20:33:50 +0100104int pat_parse_ip(const char **text, struct pattern *pattern, enum pat_usage usage, int *opaque, char **err);
Thierry FOURNIERed66c292013-11-28 11:05:19 +0100105
Thierry FOURNIERe7ba2362014-01-21 11:25:41 +0100106/* NB: For two strings to be identical, it is required that their lengths match */
107enum pat_match_res pat_match_str(struct sample *smp, struct pattern *pattern);
108
109/* NB: For two binary buffers to be identical, it is required that their lengths match */
110enum pat_match_res pat_match_bin(struct sample *smp, struct pattern *pattern);
111
112/* Checks that the length of the pattern in <test> is included between min and max */
113enum pat_match_res pat_match_len(struct sample *smp, struct pattern *pattern);
114
115/* Checks that the integer in <test> is included between min and max */
116enum pat_match_res pat_match_int(struct sample *smp, struct pattern *pattern);
117
Thierry FOURNIERed66c292013-11-28 11:05:19 +0100118/* always return false */
Willy Tarreau0cba6072013-11-28 22:21:02 +0100119enum pat_match_res pat_match_nothing(struct sample *smp, struct pattern *pattern);
Thierry FOURNIERed66c292013-11-28 11:05:19 +0100120
121/* Checks that the pattern matches the end of the tested string. */
Willy Tarreau0cba6072013-11-28 22:21:02 +0100122enum pat_match_res pat_match_end(struct sample *smp, struct pattern *pattern);
Thierry FOURNIERed66c292013-11-28 11:05:19 +0100123
124/* Checks that the pattern matches the beginning of the tested string. */
Willy Tarreau0cba6072013-11-28 22:21:02 +0100125enum pat_match_res pat_match_beg(struct sample *smp, struct pattern *pattern);
Thierry FOURNIERed66c292013-11-28 11:05:19 +0100126
127/* Checks that the pattern is included inside the tested string. */
Willy Tarreau0cba6072013-11-28 22:21:02 +0100128enum pat_match_res pat_match_sub(struct sample *smp, struct pattern *pattern);
Thierry FOURNIERed66c292013-11-28 11:05:19 +0100129
130/* Checks that the pattern is included inside the tested string, but enclosed
131 * between slashes or at the beginning or end of the string. Slashes at the
132 * beginning or end of the pattern are ignored.
133 */
Willy Tarreau0cba6072013-11-28 22:21:02 +0100134enum pat_match_res pat_match_dir(struct sample *smp, struct pattern *pattern);
Thierry FOURNIERed66c292013-11-28 11:05:19 +0100135
136/* Checks that the pattern is included inside the tested string, but enclosed
137 * between dots or at the beginning or end of the string. Dots at the beginning
138 * or end of the pattern are ignored.
139 */
Willy Tarreau0cba6072013-11-28 22:21:02 +0100140enum pat_match_res pat_match_dom(struct sample *smp, struct pattern *pattern);
Thierry FOURNIERed66c292013-11-28 11:05:19 +0100141
142/* Check that the IPv4 address in <test> matches the IP/mask in pattern */
Willy Tarreau0cba6072013-11-28 22:21:02 +0100143enum pat_match_res pat_match_ip(struct sample *smp, struct pattern *pattern);
Thierry FOURNIERed66c292013-11-28 11:05:19 +0100144
145/* Executes a regex. It temporarily changes the data to add a trailing zero,
146 * and restores the previous character when leaving.
147 */
Willy Tarreau0cba6072013-11-28 22:21:02 +0100148enum pat_match_res pat_match_reg(struct sample *smp, struct pattern *pattern);
Thierry FOURNIERed66c292013-11-28 11:05:19 +0100149
Thierry FOURNIERa65b3432013-11-28 18:22:00 +0100150int pattern_read_from_file(struct pattern_expr *expr, const char *filename, int patflags, char **err);
151void pattern_free(struct pattern *pat);
152void pattern_prune_expr(struct pattern_expr *expr);
153void pattern_init_expr(struct pattern_expr *expr);
Thierry FOURNIER01cdcd42013-12-10 15:08:01 +0100154int pattern_lookup(const char *args, struct pattern_expr *expr, struct pattern **pat_elt, struct pat_idx_elt **idx_elt, char **err);
155
Thierry FOURNIERed66c292013-11-28 11:05:19 +0100156
157#endif