blob: 35feea983be25acca20600da85a7745854c5fe84 [file] [log] [blame]
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +01001/*
2 * MAP management functions.
3 *
4 * Copyright 2000-2013 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
13#include <limits.h>
14#include <stdio.h>
15
16#include <common/standard.h>
17
18#include <types/global.h>
19#include <types/map.h>
Thierry FOURNIER1e00d382014-02-11 11:31:40 +010020#include <types/pattern.h>
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010021
22#include <proto/arg.h>
Thierry FOURNIERb0c0a0f2013-12-10 15:05:34 +010023#include <proto/map.h>
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010024#include <proto/pattern.h>
25#include <proto/sample.h>
26
Thierry FOURNIERb2f8f082015-08-04 19:35:46 +020027/* Parse an IPv4 or IPv6 address and store it into the sample.
28 * The output type is IPv4 or IPv6.
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010029 */
Thierry FOURNIER503bb092015-08-19 08:35:43 +020030int map_parse_ip(const char *text, struct sample_data *data)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010031{
Thierry FOURNIERb2f8f082015-08-04 19:35:46 +020032 int len = strlen(text);
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010033
Thierry FOURNIERb2f8f082015-08-04 19:35:46 +020034 if (buf2ip(text, len, &data->u.ipv4)) {
35 data->type = SMP_T_IPV4;
36 return 1;
37 }
38 if (buf2ip6(text, len, &data->u.ipv6)) {
39 data->type = SMP_T_IPV6;
40 return 1;
41 }
42 return 0;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010043}
44
45/* Parse a string and store a pointer to it into the sample. The original
46 * string must be left in memory because we return a direct memory reference.
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +010047 * The output type is SMP_T_STR. There is no risk that the data will be
48 * overwritten because sample_conv_map() makes a const sample with this
49 * output.
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010050 */
Thierry FOURNIER503bb092015-08-19 08:35:43 +020051int map_parse_str(const char *text, struct sample_data *data)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010052{
Thierry FOURNIER136f9d32015-08-19 09:07:19 +020053 data->u.str.str = (char *)text;
54 data->u.str.len = strlen(text);
55 data->u.str.size = data->u.str.len + 1;
Thierry FOURNIER503bb092015-08-19 08:35:43 +020056 data->type = SMP_T_STR;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010057 return 1;
58}
59
60/* Parse an integer and convert it to a sample. The output type is SINT if the
61 * number is negative, or UINT if it is positive or null. The function returns
62 * zero (error) if the number is too large.
63 */
Thierry FOURNIER503bb092015-08-19 08:35:43 +020064int map_parse_int(const char *text, struct sample_data *data)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010065{
Thierry FOURNIER503bb092015-08-19 08:35:43 +020066 data->type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +020067 data->u.sint = read_int64(&text, text + strlen(text));
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020068 if (*text != '\0')
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010069 return 0;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010070 return 1;
71}
72
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010073/* This crete and initialize map descriptor.
74 * Return NULL if out of memory error
75 */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +010076static struct map_descriptor *map_create_descriptor(struct sample_conv *conv)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010077{
78 struct map_descriptor *desc;
79
80 desc = calloc(1, sizeof(*desc));
81 if (!desc)
82 return NULL;
83
84 desc->conv = conv;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010085
86 return desc;
87}
88
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010089/* This function load the map file according with data type declared into
90 * the "struct sample_conv".
91 *
92 * This function choose the indexation type (ebtree or list) according with
93 * the type of match needed.
94 */
Thierry FOURNIER3def3932015-04-07 11:27:54 +020095int sample_load_map(struct arg *arg, struct sample_conv *conv,
96 const char *file, int line, char **err)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010097{
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010098 struct map_descriptor *desc;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010099
100 /* create new map descriptor */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100101 desc = map_create_descriptor(conv);
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100102 if (!desc) {
103 memprintf(err, "out of memory");
104 return 0;
105 }
106
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100107 /* Initialize pattern */
108 pattern_init_head(&desc->pat);
109
110 /* This is original pattern, must free */
111 desc->do_free = 1;
112
113 /* Set the match method. */
Thierry FOURNIER1edc9712014-12-15 16:18:39 +0100114 desc->pat.match = pat_match_fcts[(long)conv->private];
115 desc->pat.parse = pat_parse_fcts[(long)conv->private];
116 desc->pat.index = pat_index_fcts[(long)conv->private];
117 desc->pat.delete = pat_delete_fcts[(long)conv->private];
118 desc->pat.prune = pat_prune_fcts[(long)conv->private];
119 desc->pat.expect_type = pat_match_types[(long)conv->private];
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100120
121 /* Set the output parse method. */
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100122 switch (desc->conv->out_type) {
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100123 case SMP_T_STR: desc->pat.parse_smp = map_parse_str; break;
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200124 case SMP_T_SINT: desc->pat.parse_smp = map_parse_int; break;
Thierry FOURNIERb2f8f082015-08-04 19:35:46 +0200125 case SMP_T_ADDR: desc->pat.parse_smp = map_parse_ip; break;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100126 default:
127 memprintf(err, "map: internal haproxy error: no default parse case for the input type <%d>.",
128 conv->out_type);
129 return 0;
130 }
131
Thierry FOURNIER39bef452014-01-29 13:29:45 +0100132 /* Load map. */
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200133 if (!pattern_read_from_file(&desc->pat, PAT_REF_MAP, arg[0].data.str.str, PAT_MF_NO_DNS,
Thierry FOURNIER94580c92014-02-11 14:36:45 +0100134 1, err, file, line))
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100135 return 0;
Thierry FOURNIER0ffe78c2013-12-05 14:40:25 +0100136
Thierry FOURNIERb2f8f082015-08-04 19:35:46 +0200137 /* the maps of type IP have a string as defaultvalue. This
138 * string canbe anipv4 or an ipv6, we must convert it.
139 */
140 if (desc->conv->out_type == SMP_T_ADDR) {
141 struct sample_data data;
142 if (!map_parse_ip(arg[1].data.str.str, &data)) {
143 memprintf(err, "map: cannot parse default ip <%s>.", arg[1].data.str.str);
144 return 0;
145 }
146 if (data.type == SMP_T_IPV4) {
147 arg[1].type = ARGT_IPV4;
148 arg[1].data.ipv4 = data.u.ipv4;
149 } else {
150 arg[1].type = ARGT_IPV6;
151 arg[1].data.ipv6 = data.u.ipv6;
152 }
153 }
154
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100155 /* replace the first argument by this definition */
156 arg[0].type = ARGT_MAP;
157 arg[0].data.map = desc;
158
159 return 1;
160}
161
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +0200162static int sample_conv_map(const struct arg *arg_p, struct sample *smp, void *private)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100163{
164 struct map_descriptor *desc;
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100165 struct pattern *pat;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100166
167 /* get config */
168 desc = arg_p[0].data.map;
169
170 /* Execute the match function. */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100171 pat = pattern_exec_match(&desc->pat, smp, 1);
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100172
173 /* Match case. */
174 if (pat) {
175 /* Copy sample. */
Thierry FOURNIER503bb092015-08-19 08:35:43 +0200176 if (pat->data) {
Thierry FOURNIER5cc18d42015-08-19 09:02:36 +0200177 smp->data = *pat->data;
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100178 smp->flags |= SMP_F_CONST;
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100179 return 1;
180 }
181
182 /* Return just int sample containing 1. */
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200183 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200184 smp->data.u.sint = 1;
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100185 return 1;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100186 }
187
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100188 /* If no default value avalaible, the converter fails. */
Thierry FOURNIER933e5de2015-03-13 00:10:16 +0100189 if (arg_p[1].type == ARGT_STOP)
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100190 return 0;
191
192 /* Return the default value. */
Thierry FOURNIER933e5de2015-03-13 00:10:16 +0100193 switch (desc->conv->out_type) {
194
195 case SMP_T_STR:
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200196 smp->data.type = SMP_T_STR;
Thierry FOURNIER933e5de2015-03-13 00:10:16 +0100197 smp->flags |= SMP_F_CONST;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200198 smp->data.u.str = arg_p[1].data.str;
Thierry FOURNIER933e5de2015-03-13 00:10:16 +0100199 break;
200
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200201 case SMP_T_SINT:
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200202 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200203 smp->data.u.sint = arg_p[1].data.sint;
Thierry FOURNIER933e5de2015-03-13 00:10:16 +0100204 break;
205
Thierry FOURNIERb2f8f082015-08-04 19:35:46 +0200206 case SMP_T_ADDR:
207 if (arg_p[1].type == ARGT_IPV4) {
208 smp->data.type = SMP_T_IPV4;
209 smp->data.u.ipv4 = arg_p[1].data.ipv4;
210 } else {
211 smp->data.type = SMP_T_IPV6;
212 smp->data.u.ipv6 = arg_p[1].data.ipv6;
213 }
Thierry FOURNIER933e5de2015-03-13 00:10:16 +0100214 break;
215 }
216
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100217 return 1;
218}
219
220/* Note: must not be declared <const> as its list will be overwritten
221 *
222 * For the map_*_int keywords, the output is declared as SMP_T_UINT, but the converter function
223 * can provide SMP_T_UINT, SMP_T_SINT or SMP_T_BOOL depending on how the patterns found in the
224 * file can be parsed.
225 *
226 * For the map_*_ip keyword, the output is declared as SMP_T_IPV4, but the converter function
227 * can provide SMP_T_IPV4 or SMP_T_IPV6 depending on the patterns found in the file.
228 *
229 * The map_* keywords only emit strings.
230 *
231 * The output type is only used during the configuration parsing. It is used for detecting
232 * compatibility problems.
233 *
234 * The arguments are: <file>[,<default value>]
235 */
236static struct sample_conv_kw_list sample_conv_kws = {ILH, {
Thierry FOURNIER1edc9712014-12-15 16:18:39 +0100237 { "map", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_STR },
238 { "map_str", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_STR },
239 { "map_beg", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_BEG },
240 { "map_sub", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_SUB },
241 { "map_dir", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_DIR },
242 { "map_dom", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_DOM },
243 { "map_end", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_END },
244 { "map_reg", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_REG },
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200245 { "map_int", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_SINT, SMP_T_STR, (void *)PAT_MATCH_INT },
Thierry FOURNIER1edc9712014-12-15 16:18:39 +0100246 { "map_ip", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_ADDR, SMP_T_STR, (void *)PAT_MATCH_IP },
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100247
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +0200248 { "map_str_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_STR },
249 { "map_beg_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_BEG },
250 { "map_sub_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_SUB },
251 { "map_dir_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_DIR },
252 { "map_dom_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_DOM },
253 { "map_end_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_END },
254 { "map_reg_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_REG },
255 { "map_int_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_SINT, SMP_T_SINT, (void *)PAT_MATCH_INT },
256 { "map_ip_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_ADDR, SMP_T_SINT, (void *)PAT_MATCH_IP },
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100257
Thierry FOURNIERb2f8f082015-08-04 19:35:46 +0200258 { "map_str_ip", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_ADDR, (void *)PAT_MATCH_STR },
259 { "map_beg_ip", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_ADDR, (void *)PAT_MATCH_BEG },
260 { "map_sub_ip", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_ADDR, (void *)PAT_MATCH_SUB },
261 { "map_dir_ip", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_ADDR, (void *)PAT_MATCH_DIR },
262 { "map_dom_ip", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_ADDR, (void *)PAT_MATCH_DOM },
263 { "map_end_ip", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_ADDR, (void *)PAT_MATCH_END },
264 { "map_reg_ip", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_ADDR, (void *)PAT_MATCH_REG },
265 { "map_int_ip", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_SINT, SMP_T_ADDR, (void *)PAT_MATCH_INT },
266 { "map_ip_ip", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_ADDR, SMP_T_ADDR, (void *)PAT_MATCH_IP },
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100267
268 { /* END */ },
269}};
270
271__attribute__((constructor))
272static void __map_init(void)
273{
274 /* register format conversion keywords */
275 sample_register_convs(&sample_conv_kws);
276}