firewall3: add UBUS support for redirect sections
[project/firewall3.git] / ipsets.c
1 /*
2  * firewall3 - 3rd OpenWrt UCI firewall implementation
3  *
4  *   Copyright (C) 2013 Jo-Philipp Wich <jo@mein.io>
5  *
6  * Permission to use, copy, modify, and/or distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18
19 #include "ipsets.h"
20
21
22 const struct fw3_option fw3_ipset_opts[] = {
23         FW3_OPT("enabled",       bool,           ipset,     enabled),
24
25         FW3_OPT("name",          string,         ipset,     name),
26         FW3_OPT("family",        family,         ipset,     family),
27
28         FW3_OPT("storage",       ipset_method,   ipset,     method),
29         FW3_LIST("match",        ipset_datatype, ipset,     datatypes),
30
31         FW3_OPT("iprange",       address,        ipset,     iprange),
32         FW3_OPT("portrange",     port,           ipset,     portrange),
33
34         FW3_OPT("netmask",       int,            ipset,     netmask),
35         FW3_OPT("maxelem",       int,            ipset,     maxelem),
36         FW3_OPT("hashsize",      int,            ipset,     hashsize),
37         FW3_OPT("timeout",       int,            ipset,     timeout),
38
39         FW3_OPT("external",      string,         ipset,     external),
40
41         { }
42 };
43
44 #define T(m, t1, t2, t3, r, o) \
45         { FW3_IPSET_METHOD_##m, \
46           FW3_IPSET_TYPE_##t1 | (FW3_IPSET_TYPE_##t2 << 8) | (FW3_IPSET_TYPE_##t3 << 16), \
47           r, o }
48
49 enum ipset_optflag {
50         OPT_IPRANGE   = (1 << 0),
51         OPT_PORTRANGE = (1 << 1),
52         OPT_NETMASK   = (1 << 2),
53         OPT_HASHSIZE  = (1 << 3),
54         OPT_MAXELEM   = (1 << 4),
55         OPT_FAMILY    = (1 << 5),
56 };
57
58 struct ipset_type {
59         enum fw3_ipset_method method;
60         uint32_t types;
61         uint8_t required;
62         uint8_t optional;
63 };
64
65 static struct ipset_type ipset_types[] = {
66         T(BITMAP, IP,   UNSPEC, UNSPEC, OPT_IPRANGE, OPT_NETMASK),
67         T(BITMAP, IP,   MAC,    UNSPEC, OPT_IPRANGE, 0),
68         T(BITMAP, PORT, UNSPEC, UNSPEC, OPT_PORTRANGE, 0),
69
70         T(HASH,   IP,   UNSPEC, UNSPEC, 0,
71           OPT_FAMILY | OPT_HASHSIZE | OPT_MAXELEM | OPT_NETMASK),
72         T(HASH,   NET,  UNSPEC, UNSPEC, 0,
73           OPT_FAMILY | OPT_HASHSIZE | OPT_MAXELEM),
74         T(HASH,   IP,   PORT,   UNSPEC, 0,
75           OPT_FAMILY | OPT_HASHSIZE | OPT_MAXELEM),
76         T(HASH,   NET,  PORT,   UNSPEC, 0,
77           OPT_FAMILY | OPT_HASHSIZE | OPT_MAXELEM),
78         T(HASH,   IP,   PORT,   IP,     0,
79           OPT_FAMILY | OPT_HASHSIZE | OPT_MAXELEM),
80         T(HASH,   IP,   PORT,   NET,    0,
81           OPT_FAMILY | OPT_HASHSIZE | OPT_MAXELEM),
82
83         T(LIST,   SET,  UNSPEC, UNSPEC, 0, OPT_MAXELEM),
84 };
85
86
87 static bool
88 check_types(struct uci_element *e, struct fw3_ipset *ipset)
89 {
90         int i = 0;
91         uint32_t typelist = 0;
92         struct fw3_ipset_datatype *type;
93
94         list_for_each_entry(type, &ipset->datatypes, list)
95         {
96                 if (i >= 3)
97                 {
98                         warn_elem(e, "must not have more than 3 datatypes assigned");
99                         return false;
100                 }
101
102                 typelist |= (type->type << (i++ * 8));
103         }
104
105         /* find a suitable storage method if none specified */
106         if (ipset->method == FW3_IPSET_METHOD_UNSPEC)
107         {
108                 for (i = 0; i < ARRAY_SIZE(ipset_types); i++)
109                 {
110                         /* skip type for v6 if it does not support family */
111                         if (ipset->family != FW3_FAMILY_V4 &&
112                             !(ipset_types[i].optional & OPT_FAMILY))
113                                 continue;
114
115                         if (ipset_types[i].types == typelist)
116                         {
117                                 ipset->method = ipset_types[i].method;
118
119                                 warn_elem(e, "defines no storage method, assuming '%s'",
120                                           fw3_ipset_method_names[ipset->method]);
121
122                                 break;
123                         }
124                 }
125         }
126
127         //typelist |= ipset->method;
128
129         for (i = 0; i < ARRAY_SIZE(ipset_types); i++)
130         {
131                 if (ipset_types[i].method == ipset->method &&
132                     ipset_types[i].types == typelist)
133                 {
134                         if (!ipset->external)
135                         {
136                                 if ((ipset_types[i].required & OPT_IPRANGE) &&
137                                         !ipset->iprange.set)
138                                 {
139                                         warn_elem(e, "requires an ip range");
140                                         return false;
141                                 }
142
143                                 if ((ipset_types[i].required & OPT_PORTRANGE) &&
144                                     !ipset->portrange.set)
145                                 {
146                                         warn_elem(e, "requires a port range");
147                                         return false;
148                                 }
149
150                                 if (!(ipset_types[i].required & OPT_IPRANGE) &&
151                                     ipset->iprange.set)
152                                 {
153                                         warn_elem(e, "iprange ignored");
154                                         ipset->iprange.set = false;
155                                 }
156
157                                 if (!(ipset_types[i].required & OPT_PORTRANGE) &&
158                                     ipset->portrange.set)
159                                 {
160                                         warn_elem(e, "portrange ignored");
161                                         ipset->portrange.set = false;
162                                 }
163
164                                 if (!(ipset_types[i].optional & OPT_NETMASK) &&
165                                     ipset->netmask > 0)
166                                 {
167                                         warn_elem(e, "netmask ignored");
168                                         ipset->netmask = 0;
169                                 }
170
171                                 if (!(ipset_types[i].optional & OPT_HASHSIZE) &&
172                                     ipset->hashsize > 0)
173                                 {
174                                         warn_elem(e, "hashsize ignored");
175                                         ipset->hashsize = 0;
176                                 }
177
178                                 if (!(ipset_types[i].optional & OPT_MAXELEM) &&
179                                     ipset->maxelem > 0)
180                                 {
181                                         warn_elem(e, "maxelem ignored");
182                                         ipset->maxelem = 0;
183                                 }
184
185                                 if (!(ipset_types[i].optional & OPT_FAMILY) &&
186                                     ipset->family != FW3_FAMILY_V4)
187                                 {
188                                         warn_elem(e, "family ignored");
189                                         ipset->family = FW3_FAMILY_V4;
190                                 }
191                         }
192
193                         return true;
194                 }
195         }
196
197         warn_elem(e, "has an invalid combination of storage method and matches");
198         return false;
199 }
200
201 struct fw3_ipset *
202 fw3_alloc_ipset(void)
203 {
204         struct fw3_ipset *ipset;
205
206         ipset = calloc(1, sizeof(*ipset));
207         if (!ipset)
208                 return NULL;
209
210         INIT_LIST_HEAD(&ipset->datatypes);
211
212         ipset->enabled = true;
213         ipset->family  = FW3_FAMILY_V4;
214
215         return ipset;
216 }
217
218 void
219 fw3_load_ipsets(struct fw3_state *state, struct uci_package *p)
220 {
221         struct uci_section *s;
222         struct uci_element *e;
223         struct fw3_ipset *ipset;
224
225         INIT_LIST_HEAD(&state->ipsets);
226
227         if (state->disable_ipsets)
228                 return;
229
230         uci_foreach_element(&p->sections, e)
231         {
232                 s = uci_to_section(e);
233
234                 if (strcmp(s->type, "ipset"))
235                         continue;
236
237                 ipset = fw3_alloc_ipset();
238
239                 if (!ipset)
240                         continue;
241
242                 if (!fw3_parse_options(ipset, fw3_ipset_opts, s))
243                         warn_elem(e, "has invalid options");
244
245                 if (ipset->external)
246                 {
247                         if (!*ipset->external)
248                                 ipset->external = NULL;
249                         else if (!ipset->name)
250                                 ipset->name = ipset->external;
251                 }
252
253                 if (!ipset->name || !*ipset->name)
254                 {
255                         warn_elem(e, "must have a name assigned");
256                 }
257                 //else if (fw3_lookup_ipset(state, ipset->name) != NULL)
258                 //{
259                 //      warn_elem(e, "has duplicated set name '%s'", ipset->name);
260                 //}
261                 else if (ipset->family == FW3_FAMILY_ANY)
262                 {
263                         warn_elem(e, "must not have family 'any'");
264                 }
265                 else if (ipset->iprange.set && ipset->family != ipset->iprange.family)
266                 {
267                         warn_elem(e, "has iprange of wrong address family");
268                 }
269                 else if (list_empty(&ipset->datatypes))
270                 {
271                         warn_elem(e, "has no datatypes assigned");
272                 }
273                 else if (check_types(e, ipset))
274                 {
275                         list_add_tail(&ipset->list, &state->ipsets);
276                         continue;
277                 }
278
279                 fw3_free_ipset(ipset);
280         }
281 }
282
283
284 static void
285 create_ipset(struct fw3_ipset *ipset, struct fw3_state *state)
286 {
287         bool first = true;
288
289         struct fw3_ipset_datatype *type;
290
291         info(" * Creating ipset %s", ipset->name);
292
293         first = true;
294         fw3_pr("create %s %s", ipset->name, fw3_ipset_method_names[ipset->method]);
295
296         list_for_each_entry(type, &ipset->datatypes, list)
297         {
298                 fw3_pr("%c%s", first ? ':' : ',', fw3_ipset_type_names[type->type]);
299                 first = false;
300         }
301
302         if (ipset->method == FW3_IPSET_METHOD_HASH)
303                 fw3_pr(" family inet%s", (ipset->family == FW3_FAMILY_V4) ? "" : "6");
304
305         if (ipset->iprange.set)
306         {
307                 fw3_pr(" range %s", fw3_address_to_string(&ipset->iprange, false, true));
308         }
309         else if (ipset->portrange.set)
310         {
311                 fw3_pr(" range %u-%u",
312                        ipset->portrange.port_min, ipset->portrange.port_max);
313         }
314
315         if (ipset->timeout > 0)
316                 fw3_pr(" timeout %u", ipset->timeout);
317
318         if (ipset->maxelem > 0)
319                 fw3_pr(" maxelem %u", ipset->maxelem);
320
321         if (ipset->netmask > 0)
322                 fw3_pr(" netmask %u", ipset->netmask);
323
324         if (ipset->hashsize > 0)
325                 fw3_pr(" hashsize %u", ipset->hashsize);
326
327         fw3_pr("\n");
328 }
329
330 void
331 fw3_create_ipsets(struct fw3_state *state)
332 {
333         int tries;
334         bool exec = false;
335         struct fw3_ipset *ipset;
336
337         if (state->disable_ipsets)
338                 return;
339
340         /* spawn ipsets */
341         list_for_each_entry(ipset, &state->ipsets, list)
342         {
343                 if (ipset->external)
344                         continue;
345
346                 if (!exec)
347                 {
348                         exec = fw3_command_pipe(false, "ipset", "-exist", "-");
349
350                         if (!exec)
351                                 return;
352                 }
353
354                 create_ipset(ipset, state);
355         }
356
357         if (exec)
358         {
359                 fw3_pr("quit\n");
360                 fw3_command_close();
361         }
362
363         /* wait for ipsets to appear */
364         list_for_each_entry(ipset, &state->ipsets, list)
365         {
366                 if (ipset->external)
367                         continue;
368
369                 for (tries = 0; !fw3_check_ipset(ipset) && tries < 10; tries++)
370                         usleep(50000);
371         }
372 }
373
374 void
375 fw3_destroy_ipsets(struct fw3_state *state)
376 {
377         int tries;
378         bool exec = false;
379         struct fw3_ipset *ipset;
380
381         /* destroy ipsets */
382         list_for_each_entry(ipset, &state->ipsets, list)
383         {
384                 if (!exec)
385                 {
386                         exec = fw3_command_pipe(false, "ipset", "-exist", "-");
387
388                         if (!exec)
389                                 return;
390                 }
391
392                 info(" * Deleting ipset %s", ipset->name);
393
394                 fw3_pr("flush %s\n", ipset->name);
395                 fw3_pr("destroy %s\n", ipset->name);
396         }
397
398         if (exec)
399         {
400                 fw3_pr("quit\n");
401                 fw3_command_close();
402         }
403
404         /* wait for ipsets to disappear */
405         list_for_each_entry(ipset, &state->ipsets, list)
406         {
407                 if (ipset->external)
408                         continue;
409
410                 for (tries = 0; fw3_check_ipset(ipset) && tries < 10; tries++)
411                         usleep(50000);
412         }
413 }
414
415 struct fw3_ipset *
416 fw3_lookup_ipset(struct fw3_state *state, const char *name)
417 {
418         struct fw3_ipset *s;
419
420         if (list_empty(&state->ipsets))
421                 return NULL;
422
423         list_for_each_entry(s, &state->ipsets, list)
424         {
425                 if (strcmp(s->name, name))
426                         continue;
427
428                 return s;
429         }
430
431         return NULL;
432 }
433
434 bool
435 fw3_check_ipset(struct fw3_ipset *set)
436 {
437         bool rv = false;
438
439         socklen_t sz;
440         int s = socket(AF_INET, SOCK_RAW, IPPROTO_RAW);
441         struct ip_set_req_version req_ver;
442         struct ip_set_req_get_set req_name;
443
444         if (s < 0 || fcntl(s, F_SETFD, FD_CLOEXEC))
445                 goto out;
446
447         sz = sizeof(req_ver);
448         req_ver.op = IP_SET_OP_VERSION;
449
450         if (getsockopt(s, SOL_IP, SO_IP_SET, &req_ver, &sz))
451                 goto out;
452
453         sz = sizeof(req_name);
454         req_name.op = IP_SET_OP_GET_BYNAME;
455         req_name.version = req_ver.version;
456         snprintf(req_name.set.name, IPSET_MAXNAMELEN - 1, "%s",
457                  set->external ? set->external : set->name);
458
459         if (getsockopt(s, SOL_IP, SO_IP_SET, &req_name, &sz))
460                 goto out;
461
462         rv = ((sz == sizeof(req_name)) && (req_name.set.index != IPSET_INVALID_ID));
463
464 out:
465         if (s >= 0)
466                 close(s);
467
468         return rv;
469 }