1 /* Zebra Policy Based Routing (PBR) main handling.
2 * Copyright (C) 2018 Cumulus Networks, Inc.
4 * This file is part of FRR.
6 * FRR is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2, or (at your option) any
11 * FRR is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with FRR; see the file COPYING. If not, write to the Free
18 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
29 #include "zebra/zebra_router.h"
30 #include "zebra/zebra_pbr.h"
32 #include "zebra/zapi_msg.h"
33 #include "zebra/zserv.h"
34 #include "zebra/debug.h"
37 DEFINE_MTYPE_STATIC(ZEBRA
, PBR_IPTABLE_IFNAME
, "PBR interface list");
40 static const struct message ipset_type_msg
[] = {
41 {IPSET_NET_PORT_NET
, "net,port,net"},
42 {IPSET_NET_PORT
, "net,port"},
43 {IPSET_NET_NET
, "net,net"},
48 const struct message icmp_typecode_str
[] = {
49 { 0 << 8, "echo-reply"},
51 { 3 << 8, "network-unreachable"},
52 { (3 << 8) + 1, "host-unreachable"},
53 { (3 << 8) + 2, "protocol-unreachable"},
54 { (3 << 8) + 3, "port-unreachable"},
55 { (3 << 8) + 4, "fragmentation-needed"},
56 { (3 << 8) + 5, "source-route-failed"},
57 { (3 << 8) + 6, "network-unknown"},
58 { (3 << 8) + 7, "host-unknown"},
59 { (3 << 8) + 9, "network-prohibited"},
60 { (3 << 8) + 10, "host-prohibited"},
61 { (3 << 8) + 11, "TOS-network-unreachable"},
62 { (3 << 8) + 12, "TOS-host-unreachable"},
63 { (3 << 8) + 13, "communication-prohibited"},
64 { (3 << 8) + 14, "host-precedence-violation"},
65 { (3 << 8) + 15, "precedence-cutoff"},
66 { 4 << 8, "source-quench"},
67 { 5 << 8, "network-redirect"},
68 { (5 << 8) + 1, "host-redirect"},
69 { (5 << 8) + 2, "TOS-network-redirect"},
70 { (5 << 8) + 3, "TOS-host-redirect"},
71 { 8 << 8, "echo-request"},
73 { 9 << 8, "router-advertisement"},
74 { 10 << 8, "router-solicitation"},
75 { 11 << 8, "ttl-zero-during-transit"},
76 { (11 << 8) + 1, "ttl-zero-during-reassembly"},
77 { 12 << 8, "ip-header-bad"},
78 { (12 << 8) + 1, "required-option-missing"},
79 { 13 << 8, "timestamp-request"},
80 { 14 << 8, "timestamp-reply"},
81 { 17 << 8, "address-mask-request"},
82 { 18 << 8, "address-mask-reply"},
86 const struct message icmpv6_typecode_str
[] = {
87 { 128 << 8, "echo-request"},
88 { 129 << 8, "echo-reply"},
89 { 1 << 8, "no-route"},
90 { (1 << 8) + 1, "communication-prohibited"},
91 { (1 << 8) + 3, "address-unreachable"},
92 { (1 << 8) + 4, "port-unreachable"},
93 { (2 << 8), "packet-too-big"},
94 { 3 << 0, "ttl-zero-during-transit"},
95 { (3 << 8) + 1, "ttl-zero-during-reassembly"},
96 { 4 << 0, "bad-header"},
97 { (4 << 0) + 1, "unknown-header-type"},
98 { (4 << 0) + 2, "unknown-option"},
99 { 133 << 8, "router-solicitation"},
100 { 134 << 8, "router-advertisement"},
101 { 135 << 8, "neighbor-solicitation"},
102 { 136 << 8, "neighbor-advertisement"},
103 { 137 << 8, "redirect"},
108 static const struct message tcp_value_str
[] = {
109 {TCP_HEADER_FIN
, "FIN"},
110 {TCP_HEADER_SYN
, "SYN"},
111 {TCP_HEADER_RST
, "RST"},
112 {TCP_HEADER_PSH
, "PSH"},
113 {TCP_HEADER_ACK
, "ACK"},
114 {TCP_HEADER_URG
, "URG"},
118 static const struct message fragment_value_str
[] = {
119 {1, "dont-fragment"},
121 {4, "first-fragment"},
122 {8, "last-fragment"},
126 /* static function declarations */
127 DEFINE_HOOK(zebra_pbr_ipset_entry_get_stat
,
128 (struct zebra_pbr_ipset_entry
*ipset
, uint64_t *pkts
,
130 (ipset
, pkts
, bytes
));
132 DEFINE_HOOK(zebra_pbr_iptable_get_stat
,
133 (struct zebra_pbr_iptable
*iptable
, uint64_t *pkts
,
135 (iptable
, pkts
, bytes
));
137 DEFINE_HOOK(zebra_pbr_iptable_update
,
138 (int cmd
, struct zebra_pbr_iptable
*iptable
), (cmd
, iptable
));
140 DEFINE_HOOK(zebra_pbr_ipset_entry_update
,
141 (int cmd
, struct zebra_pbr_ipset_entry
*ipset
), (cmd
, ipset
));
143 DEFINE_HOOK(zebra_pbr_ipset_update
,
144 (int cmd
, struct zebra_pbr_ipset
*ipset
), (cmd
, ipset
));
146 /* Private functions */
148 /* Public functions */
149 void zebra_pbr_rules_free(void *arg
)
151 struct zebra_pbr_rule
*rule
;
153 rule
= (struct zebra_pbr_rule
*)arg
;
155 (void)dplane_pbr_rule_delete(rule
);
156 XFREE(MTYPE_TMP
, rule
);
159 uint32_t zebra_pbr_rules_hash_key(const void *arg
)
161 const struct zebra_pbr_rule
*rule
;
165 key
= jhash_3words(rule
->rule
.seq
, rule
->rule
.priority
,
166 rule
->rule
.action
.table
,
167 prefix_hash_key(&rule
->rule
.filter
.src_ip
));
169 key
= jhash_3words(rule
->rule
.filter
.fwmark
, rule
->vrf_id
,
170 rule
->rule
.filter
.ip_proto
, key
);
172 key
= jhash(rule
->ifname
, strlen(rule
->ifname
), key
);
174 return jhash_3words(rule
->rule
.filter
.src_port
,
175 rule
->rule
.filter
.dst_port
,
176 prefix_hash_key(&rule
->rule
.filter
.dst_ip
),
177 jhash_1word(rule
->rule
.unique
, key
));
180 bool zebra_pbr_rules_hash_equal(const void *arg1
, const void *arg2
)
182 const struct zebra_pbr_rule
*r1
, *r2
;
184 r1
= (const struct zebra_pbr_rule
*)arg1
;
185 r2
= (const struct zebra_pbr_rule
*)arg2
;
187 if (r1
->rule
.seq
!= r2
->rule
.seq
)
190 if (r1
->rule
.priority
!= r2
->rule
.priority
)
193 if (r1
->rule
.unique
!= r2
->rule
.unique
)
196 if (r1
->rule
.action
.table
!= r2
->rule
.action
.table
)
199 if (r1
->rule
.filter
.src_port
!= r2
->rule
.filter
.src_port
)
202 if (r1
->rule
.filter
.dst_port
!= r2
->rule
.filter
.dst_port
)
205 if (r1
->rule
.filter
.fwmark
!= r2
->rule
.filter
.fwmark
)
208 if (r1
->rule
.filter
.ip_proto
!= r2
->rule
.filter
.ip_proto
)
211 if (!prefix_same(&r1
->rule
.filter
.src_ip
, &r2
->rule
.filter
.src_ip
))
214 if (!prefix_same(&r1
->rule
.filter
.dst_ip
, &r2
->rule
.filter
.dst_ip
))
217 if (strcmp(r1
->rule
.ifname
, r2
->rule
.ifname
) != 0)
220 if (r1
->vrf_id
!= r2
->vrf_id
)
226 struct pbr_rule_unique_lookup
{
227 struct zebra_pbr_rule
*rule
;
229 char ifname
[INTERFACE_NAMSIZ
+ 1];
233 static int pbr_rule_lookup_unique_walker(struct hash_bucket
*b
, void *data
)
235 struct pbr_rule_unique_lookup
*pul
= data
;
236 struct zebra_pbr_rule
*rule
= b
->data
;
238 if (pul
->unique
== rule
->rule
.unique
239 && strncmp(pul
->ifname
, rule
->rule
.ifname
, INTERFACE_NAMSIZ
) == 0
240 && pul
->vrf_id
== rule
->vrf_id
) {
242 return HASHWALK_ABORT
;
245 return HASHWALK_CONTINUE
;
248 static struct zebra_pbr_rule
*
249 pbr_rule_lookup_unique(struct zebra_pbr_rule
*zrule
)
251 struct pbr_rule_unique_lookup pul
;
253 pul
.unique
= zrule
->rule
.unique
;
254 strlcpy(pul
.ifname
, zrule
->rule
.ifname
, INTERFACE_NAMSIZ
);
256 pul
.vrf_id
= zrule
->vrf_id
;
257 hash_walk(zrouter
.rules_hash
, &pbr_rule_lookup_unique_walker
, &pul
);
262 void zebra_pbr_ipset_free(void *arg
)
264 struct zebra_pbr_ipset
*ipset
;
266 ipset
= (struct zebra_pbr_ipset
*)arg
;
267 hook_call(zebra_pbr_ipset_update
, 0, ipset
);
268 XFREE(MTYPE_TMP
, ipset
);
271 uint32_t zebra_pbr_ipset_hash_key(const void *arg
)
273 const struct zebra_pbr_ipset
*ipset
= arg
;
274 uint32_t *pnt
= (uint32_t *)&ipset
->ipset_name
;
275 uint32_t key
= jhash_1word(ipset
->vrf_id
, 0x63ab42de);
277 key
= jhash_1word(ipset
->family
, key
);
279 return jhash2(pnt
, ZEBRA_IPSET_NAME_HASH_SIZE
, key
);
282 bool zebra_pbr_ipset_hash_equal(const void *arg1
, const void *arg2
)
284 const struct zebra_pbr_ipset
*r1
, *r2
;
286 r1
= (const struct zebra_pbr_ipset
*)arg1
;
287 r2
= (const struct zebra_pbr_ipset
*)arg2
;
289 if (r1
->type
!= r2
->type
)
291 if (r1
->unique
!= r2
->unique
)
293 if (r1
->vrf_id
!= r2
->vrf_id
)
295 if (r1
->family
!= r2
->family
)
298 if (strncmp(r1
->ipset_name
, r2
->ipset_name
,
299 ZEBRA_IPSET_NAME_SIZE
))
304 void zebra_pbr_ipset_entry_free(void *arg
)
306 struct zebra_pbr_ipset_entry
*ipset
;
308 ipset
= (struct zebra_pbr_ipset_entry
*)arg
;
310 hook_call(zebra_pbr_ipset_entry_update
, 0, ipset
);
312 XFREE(MTYPE_TMP
, ipset
);
315 uint32_t zebra_pbr_ipset_entry_hash_key(const void *arg
)
317 const struct zebra_pbr_ipset_entry
*ipset
;
321 key
= prefix_hash_key(&ipset
->src
);
322 key
= jhash_1word(ipset
->unique
, key
);
323 key
= jhash_1word(prefix_hash_key(&ipset
->dst
), key
);
324 key
= jhash(&ipset
->dst_port_min
, 2, key
);
325 key
= jhash(&ipset
->dst_port_max
, 2, key
);
326 key
= jhash(&ipset
->src_port_min
, 2, key
);
327 key
= jhash(&ipset
->src_port_max
, 2, key
);
328 key
= jhash(&ipset
->proto
, 1, key
);
333 bool zebra_pbr_ipset_entry_hash_equal(const void *arg1
, const void *arg2
)
335 const struct zebra_pbr_ipset_entry
*r1
, *r2
;
337 r1
= (const struct zebra_pbr_ipset_entry
*)arg1
;
338 r2
= (const struct zebra_pbr_ipset_entry
*)arg2
;
340 if (r1
->unique
!= r2
->unique
)
343 if (!prefix_same(&r1
->src
, &r2
->src
))
346 if (!prefix_same(&r1
->dst
, &r2
->dst
))
349 if (r1
->src_port_min
!= r2
->src_port_min
)
352 if (r1
->src_port_max
!= r2
->src_port_max
)
355 if (r1
->dst_port_min
!= r2
->dst_port_min
)
358 if (r1
->dst_port_max
!= r2
->dst_port_max
)
361 if (r1
->proto
!= r2
->proto
)
366 /* this function gives option to flush plugin memory contexts
367 * with all parameter. set it to true to flush all
368 * set it to false to flush only passed arg argument
370 static void _zebra_pbr_iptable_free_all(void *arg
, bool all
)
372 struct zebra_pbr_iptable
*iptable
;
373 struct listnode
*node
, *nnode
;
376 iptable
= (struct zebra_pbr_iptable
*)arg
;
379 hook_call(zebra_pbr_iptable_update
, 0, iptable
);
381 if (iptable
->interface_name_list
) {
382 for (ALL_LIST_ELEMENTS(iptable
->interface_name_list
, node
,
384 XFREE(MTYPE_PBR_IPTABLE_IFNAME
, name
);
385 list_delete_node(iptable
->interface_name_list
, node
);
387 list_delete(&iptable
->interface_name_list
);
389 XFREE(MTYPE_TMP
, iptable
);
392 void zebra_pbr_iptable_free(void *arg
)
394 _zebra_pbr_iptable_free_all(arg
, false);
397 uint32_t zebra_pbr_iptable_hash_key(const void *arg
)
399 const struct zebra_pbr_iptable
*iptable
= arg
;
400 uint32_t *pnt
= (uint32_t *)&(iptable
->ipset_name
);
403 key
= jhash2(pnt
, ZEBRA_IPSET_NAME_HASH_SIZE
,
405 key
= jhash_1word(iptable
->fwmark
, key
);
406 key
= jhash_1word(iptable
->family
, key
);
407 key
= jhash_1word(iptable
->flow_label
, key
);
408 key
= jhash_1word(iptable
->pkt_len_min
, key
);
409 key
= jhash_1word(iptable
->pkt_len_max
, key
);
410 key
= jhash_1word(iptable
->tcp_flags
, key
);
411 key
= jhash_1word(iptable
->tcp_mask_flags
, key
);
412 key
= jhash_1word(iptable
->dscp_value
, key
);
413 key
= jhash_1word(iptable
->protocol
, key
);
414 key
= jhash_1word(iptable
->fragment
, key
);
415 key
= jhash_1word(iptable
->vrf_id
, key
);
417 return jhash_3words(iptable
->filter_bm
, iptable
->type
,
418 iptable
->unique
, key
);
421 bool zebra_pbr_iptable_hash_equal(const void *arg1
, const void *arg2
)
423 const struct zebra_pbr_iptable
*r1
, *r2
;
425 r1
= (const struct zebra_pbr_iptable
*)arg1
;
426 r2
= (const struct zebra_pbr_iptable
*)arg2
;
428 if (r1
->vrf_id
!= r2
->vrf_id
)
430 if (r1
->type
!= r2
->type
)
432 if (r1
->unique
!= r2
->unique
)
434 if (r1
->filter_bm
!= r2
->filter_bm
)
436 if (r1
->fwmark
!= r2
->fwmark
)
438 if (r1
->action
!= r2
->action
)
440 if (strncmp(r1
->ipset_name
, r2
->ipset_name
,
441 ZEBRA_IPSET_NAME_SIZE
))
443 if (r1
->family
!= r2
->family
)
445 if (r1
->flow_label
!= r2
->flow_label
)
447 if (r1
->pkt_len_min
!= r2
->pkt_len_min
)
449 if (r1
->pkt_len_max
!= r2
->pkt_len_max
)
451 if (r1
->tcp_flags
!= r2
->tcp_flags
)
453 if (r1
->tcp_mask_flags
!= r2
->tcp_mask_flags
)
455 if (r1
->dscp_value
!= r2
->dscp_value
)
457 if (r1
->fragment
!= r2
->fragment
)
459 if (r1
->protocol
!= r2
->protocol
)
464 static void *pbr_rule_alloc_intern(void *arg
)
466 struct zebra_pbr_rule
*zpr
;
467 struct zebra_pbr_rule
*new;
469 zpr
= (struct zebra_pbr_rule
*)arg
;
471 new = XCALLOC(MTYPE_TMP
, sizeof(*new));
473 memcpy(new, zpr
, sizeof(*zpr
));
478 static int pbr_rule_release(struct zebra_pbr_rule
*rule
)
480 struct zebra_pbr_rule
*lookup
;
482 lookup
= hash_lookup(zrouter
.rules_hash
, rule
);
487 hash_release(zrouter
.rules_hash
, lookup
);
488 XFREE(MTYPE_TMP
, lookup
);
493 void zebra_pbr_add_rule(struct zebra_pbr_rule
*rule
)
495 struct zebra_pbr_rule
*found
;
498 * Check if we already have it (this checks via a unique ID, walking
499 * over the hash table, not via a hash operation).
501 found
= pbr_rule_lookup_unique(rule
);
503 /* If found, this is an update */
505 if (IS_ZEBRA_DEBUG_PBR
)
507 "%s: seq: %d, prior: %d, unique: %d, ifname: %s -- update",
508 __func__
, rule
->rule
.seq
, rule
->rule
.priority
,
509 rule
->rule
.unique
, rule
->rule
.ifname
);
511 (void)dplane_pbr_rule_update(found
, rule
);
513 if (pbr_rule_release(found
))
515 "%s: Rule being updated we know nothing about",
519 if (IS_ZEBRA_DEBUG_PBR
)
521 "%s: seq: %d, prior: %d, unique: %d, ifname: %s -- new",
522 __func__
, rule
->rule
.seq
, rule
->rule
.priority
,
523 rule
->rule
.unique
, rule
->rule
.ifname
);
525 (void)dplane_pbr_rule_add(rule
);
528 (void)hash_get(zrouter
.rules_hash
, rule
, pbr_rule_alloc_intern
);
531 void zebra_pbr_del_rule(struct zebra_pbr_rule
*rule
)
533 if (IS_ZEBRA_DEBUG_PBR
)
534 zlog_debug("%s: seq: %d, prior: %d, unique: %d, ifname: %s",
535 __func__
, rule
->rule
.seq
, rule
->rule
.priority
,
536 rule
->rule
.unique
, rule
->rule
.ifname
);
538 (void)dplane_pbr_rule_delete(rule
);
540 if (pbr_rule_release(rule
))
541 zlog_debug("%s: Rule being deleted we know nothing about",
545 void zebra_pbr_process_iptable(struct zebra_dplane_ctx
*ctx
)
548 struct zebra_pbr_iptable ipt
;
550 if (dplane_ctx_get_op(ctx
) == DPLANE_OP_IPTABLE_ADD
)
555 dplane_ctx_get_pbr_iptable(ctx
, &ipt
);
557 ret
= hook_call(zebra_pbr_iptable_update
, mode
, &ipt
);
559 dplane_ctx_set_status(ctx
, ZEBRA_DPLANE_REQUEST_SUCCESS
);
561 dplane_ctx_set_status(ctx
, ZEBRA_DPLANE_REQUEST_FAILURE
);
564 void zebra_pbr_process_ipset(struct zebra_dplane_ctx
*ctx
)
567 struct zebra_pbr_ipset ipset
;
569 if (dplane_ctx_get_op(ctx
) == DPLANE_OP_IPSET_ADD
)
574 dplane_ctx_get_pbr_ipset(ctx
, &ipset
);
576 ret
= hook_call(zebra_pbr_ipset_update
, mode
, &ipset
);
578 dplane_ctx_set_status(ctx
, ZEBRA_DPLANE_REQUEST_SUCCESS
);
580 dplane_ctx_set_status(ctx
, ZEBRA_DPLANE_REQUEST_FAILURE
);
583 void zebra_pbr_process_ipset_entry(struct zebra_dplane_ctx
*ctx
)
586 struct zebra_pbr_ipset_entry ipset_entry
;
587 struct zebra_pbr_ipset ipset
;
589 if (dplane_ctx_get_op(ctx
) == DPLANE_OP_IPSET_ENTRY_ADD
)
594 dplane_ctx_get_pbr_ipset_entry(ctx
, &ipset_entry
);
595 dplane_ctx_get_pbr_ipset(ctx
, &ipset
);
597 ipset_entry
.backpointer
= &ipset
;
599 ret
= hook_call(zebra_pbr_ipset_entry_update
, mode
, &ipset_entry
);
601 dplane_ctx_set_status(ctx
, ZEBRA_DPLANE_REQUEST_SUCCESS
);
603 dplane_ctx_set_status(ctx
, ZEBRA_DPLANE_REQUEST_FAILURE
);
606 static void zebra_pbr_cleanup_rules(struct hash_bucket
*b
, void *data
)
608 struct zebra_pbr_rule
*rule
= b
->data
;
611 if (rule
->sock
== *sock
) {
612 (void)dplane_pbr_rule_delete(rule
);
613 if (hash_release(zrouter
.rules_hash
, rule
))
614 XFREE(MTYPE_TMP
, rule
);
617 "%s: Rule seq: %u is being cleaned but we can't find it in our tables",
618 __func__
, rule
->rule
.seq
);
622 static void zebra_pbr_cleanup_ipset(struct hash_bucket
*b
, void *data
)
624 struct zebra_pbr_ipset
*ipset
= b
->data
;
627 if (ipset
->sock
== *sock
) {
628 if (hash_release(zrouter
.ipset_hash
, ipset
))
629 zebra_pbr_ipset_free(ipset
);
631 hook_call(zebra_pbr_ipset_update
, 0, ipset
);
635 static void zebra_pbr_cleanup_ipset_entry(struct hash_bucket
*b
, void *data
)
637 struct zebra_pbr_ipset_entry
*ipset
= b
->data
;
640 if (ipset
->sock
== *sock
) {
641 if (hash_release(zrouter
.ipset_entry_hash
, ipset
))
642 zebra_pbr_ipset_entry_free(ipset
);
644 hook_call(zebra_pbr_ipset_entry_update
, 0, ipset
);
648 static void zebra_pbr_cleanup_iptable(struct hash_bucket
*b
, void *data
)
650 struct zebra_pbr_iptable
*iptable
= b
->data
;
653 if (iptable
->sock
== *sock
) {
654 if (hash_release(zrouter
.iptable_hash
, iptable
))
655 _zebra_pbr_iptable_free_all(iptable
, true);
657 hook_call(zebra_pbr_iptable_update
, 0, iptable
);
661 static int zebra_pbr_client_close_cleanup(struct zserv
*client
)
663 int sock
= client
->sock
;
667 hash_iterate(zrouter
.rules_hash
, zebra_pbr_cleanup_rules
, &sock
);
668 hash_iterate(zrouter
.iptable_hash
, zebra_pbr_cleanup_iptable
, &sock
);
669 hash_iterate(zrouter
.ipset_entry_hash
, zebra_pbr_cleanup_ipset_entry
,
671 hash_iterate(zrouter
.ipset_hash
, zebra_pbr_cleanup_ipset
, &sock
);
675 void zebra_pbr_init(void)
677 hook_register(zserv_client_close
, zebra_pbr_client_close_cleanup
);
680 static void *pbr_ipset_alloc_intern(void *arg
)
682 struct zebra_pbr_ipset
*zpi
;
683 struct zebra_pbr_ipset
*new;
685 zpi
= (struct zebra_pbr_ipset
*)arg
;
687 new = XCALLOC(MTYPE_TMP
, sizeof(struct zebra_pbr_ipset
));
689 memcpy(new, zpi
, sizeof(*zpi
));
694 void zebra_pbr_create_ipset(struct zebra_pbr_ipset
*ipset
)
696 (void)hash_get(zrouter
.ipset_hash
, ipset
, pbr_ipset_alloc_intern
);
697 (void)dplane_pbr_ipset_add(ipset
);
700 void zebra_pbr_destroy_ipset(struct zebra_pbr_ipset
*ipset
)
702 struct zebra_pbr_ipset
*lookup
;
704 lookup
= hash_lookup(zrouter
.ipset_hash
, ipset
);
705 (void)dplane_pbr_ipset_delete(ipset
);
707 hash_release(zrouter
.ipset_hash
, lookup
);
708 XFREE(MTYPE_TMP
, lookup
);
711 "%s: IPSet Entry being deleted we know nothing about",
715 struct pbr_ipset_name_lookup
{
716 struct zebra_pbr_ipset
*ipset
;
717 char ipset_name
[ZEBRA_IPSET_NAME_SIZE
];
720 const char *zebra_pbr_ipset_type2str(uint32_t type
)
722 return lookup_msg(ipset_type_msg
, type
,
723 "Unrecognized IPset Type");
726 static int zebra_pbr_ipset_pername_walkcb(struct hash_bucket
*bucket
, void *arg
)
728 struct pbr_ipset_name_lookup
*pinl
=
729 (struct pbr_ipset_name_lookup
*)arg
;
730 struct zebra_pbr_ipset
*zpi
= (struct zebra_pbr_ipset
*)bucket
->data
;
732 if (!strncmp(pinl
->ipset_name
, zpi
->ipset_name
,
733 ZEBRA_IPSET_NAME_SIZE
)) {
735 return HASHWALK_ABORT
;
737 return HASHWALK_CONTINUE
;
740 struct zebra_pbr_ipset
*zebra_pbr_lookup_ipset_pername(char *ipsetname
)
742 struct pbr_ipset_name_lookup pinl
;
743 struct pbr_ipset_name_lookup
*ptr
= &pinl
;
747 memset(ptr
, 0, sizeof(struct pbr_ipset_name_lookup
));
748 snprintf((char *)ptr
->ipset_name
, ZEBRA_IPSET_NAME_SIZE
, "%s",
750 hash_walk(zrouter
.ipset_hash
, zebra_pbr_ipset_pername_walkcb
, ptr
);
754 static void *pbr_ipset_entry_alloc_intern(void *arg
)
756 struct zebra_pbr_ipset_entry
*zpi
;
757 struct zebra_pbr_ipset_entry
*new;
759 zpi
= (struct zebra_pbr_ipset_entry
*)arg
;
761 new = XCALLOC(MTYPE_TMP
, sizeof(struct zebra_pbr_ipset_entry
));
763 memcpy(new, zpi
, sizeof(*zpi
));
768 void zebra_pbr_add_ipset_entry(struct zebra_pbr_ipset_entry
*ipset
)
770 (void)hash_get(zrouter
.ipset_entry_hash
, ipset
,
771 pbr_ipset_entry_alloc_intern
);
772 (void)dplane_pbr_ipset_entry_add(ipset
);
775 void zebra_pbr_del_ipset_entry(struct zebra_pbr_ipset_entry
*ipset
)
777 struct zebra_pbr_ipset_entry
*lookup
;
779 lookup
= hash_lookup(zrouter
.ipset_entry_hash
, ipset
);
780 (void)dplane_pbr_ipset_entry_delete(ipset
);
782 hash_release(zrouter
.ipset_entry_hash
, lookup
);
783 XFREE(MTYPE_TMP
, lookup
);
785 zlog_debug("%s: IPSet being deleted we know nothing about",
789 static void *pbr_iptable_alloc_intern(void *arg
)
791 struct zebra_pbr_iptable
*zpi
;
792 struct zebra_pbr_iptable
*new;
796 zpi
= (struct zebra_pbr_iptable
*)arg
;
798 new = XCALLOC(MTYPE_TMP
, sizeof(struct zebra_pbr_iptable
));
800 /* Deep structure copy */
801 memcpy(new, zpi
, sizeof(*zpi
));
802 new->interface_name_list
= list_new();
804 if (zpi
->interface_name_list
) {
805 for (ALL_LIST_ELEMENTS_RO(zpi
->interface_name_list
, ln
, ifname
))
806 listnode_add(new->interface_name_list
,
807 XSTRDUP(MTYPE_PBR_IPTABLE_IFNAME
, ifname
));
813 void zebra_pbr_add_iptable(struct zebra_pbr_iptable
*iptable
)
815 (void)hash_get(zrouter
.iptable_hash
, iptable
, pbr_iptable_alloc_intern
);
816 (void)dplane_pbr_iptable_add(iptable
);
819 void zebra_pbr_del_iptable(struct zebra_pbr_iptable
*iptable
)
821 struct zebra_pbr_iptable
*lookup
;
823 lookup
= hash_lookup(zrouter
.iptable_hash
, iptable
);
824 (void)dplane_pbr_iptable_delete(iptable
);
826 struct listnode
*node
, *nnode
;
829 hash_release(zrouter
.iptable_hash
, lookup
);
830 for (ALL_LIST_ELEMENTS(iptable
->interface_name_list
,
831 node
, nnode
, name
)) {
832 XFREE(MTYPE_PBR_IPTABLE_IFNAME
, name
);
833 list_delete_node(iptable
->interface_name_list
,
836 list_delete(&iptable
->interface_name_list
);
837 XFREE(MTYPE_TMP
, lookup
);
839 zlog_debug("%s: IPTable being deleted we know nothing about",
844 * Handle success or failure of rule (un)install in the kernel.
846 void zebra_pbr_dplane_result(struct zebra_dplane_ctx
*ctx
)
848 enum zebra_dplane_result res
;
851 res
= dplane_ctx_get_status(ctx
);
852 op
= dplane_ctx_get_op(ctx
);
853 if (op
== DPLANE_OP_RULE_ADD
|| op
== DPLANE_OP_RULE_UPDATE
)
854 zsend_rule_notify_owner(ctx
, res
== ZEBRA_DPLANE_REQUEST_SUCCESS
855 ? ZAPI_RULE_INSTALLED
856 : ZAPI_RULE_FAIL_INSTALL
);
857 else if (op
== DPLANE_OP_RULE_DELETE
)
858 zsend_rule_notify_owner(ctx
, res
== ZEBRA_DPLANE_REQUEST_SUCCESS
860 : ZAPI_RULE_FAIL_REMOVE
);
861 else if (op
== DPLANE_OP_IPTABLE_ADD
)
862 zsend_iptable_notify_owner(ctx
,
863 res
== ZEBRA_DPLANE_REQUEST_SUCCESS
864 ? ZAPI_IPTABLE_INSTALLED
865 : ZAPI_IPTABLE_FAIL_INSTALL
);
866 else if (op
== DPLANE_OP_IPTABLE_DELETE
)
867 zsend_iptable_notify_owner(ctx
,
868 res
== ZEBRA_DPLANE_REQUEST_SUCCESS
869 ? ZAPI_IPTABLE_REMOVED
870 : ZAPI_IPTABLE_FAIL_REMOVE
);
871 else if (op
== DPLANE_OP_IPSET_ADD
)
872 zsend_ipset_notify_owner(ctx
,
873 res
== ZEBRA_DPLANE_REQUEST_SUCCESS
874 ? ZAPI_IPSET_INSTALLED
875 : ZAPI_IPSET_FAIL_INSTALL
);
876 else if (op
== DPLANE_OP_IPSET_DELETE
)
877 zsend_ipset_notify_owner(ctx
,
878 res
== ZEBRA_DPLANE_REQUEST_SUCCESS
880 : ZAPI_IPSET_FAIL_REMOVE
);
881 else if (op
== DPLANE_OP_IPSET_ENTRY_ADD
)
882 zsend_ipset_entry_notify_owner(
883 ctx
, res
== ZEBRA_DPLANE_REQUEST_SUCCESS
884 ? ZAPI_IPSET_ENTRY_INSTALLED
885 : ZAPI_IPSET_ENTRY_FAIL_INSTALL
);
886 else if (op
== DPLANE_OP_IPSET_ENTRY_DELETE
)
887 zsend_ipset_entry_notify_owner(
888 ctx
, res
== ZEBRA_DPLANE_REQUEST_SUCCESS
889 ? ZAPI_IPSET_ENTRY_REMOVED
890 : ZAPI_IPSET_ENTRY_FAIL_REMOVE
);
893 EC_ZEBRA_PBR_RULE_UPDATE
,
894 "Context received in pbr rule dplane result handler with incorrect OP code (%u)",
898 dplane_ctx_fini(&ctx
);
902 * Handle rule delete notification from kernel.
904 int kernel_pbr_rule_del(struct zebra_pbr_rule
*rule
)
909 struct zebra_pbr_ipset_entry_unique_display
{
910 struct zebra_pbr_ipset
*zpi
;
912 struct zebra_ns
*zns
;
915 struct zebra_pbr_env_display
{
916 struct zebra_ns
*zns
;
921 static const char *zebra_pbr_prefix2str(union prefixconstptr pu
,
924 const struct prefix
*p
= pu
.p
;
925 char buf
[PREFIX2STR_BUFFER
];
927 if ((p
->family
== AF_INET
&& p
->prefixlen
== IPV4_MAX_BITLEN
)
928 || (p
->family
== AF_INET6
&& p
->prefixlen
== IPV6_MAX_BITLEN
)) {
929 snprintf(str
, size
, "%s", inet_ntop(p
->family
, &p
->u
.prefix
,
930 buf
, PREFIX2STR_BUFFER
));
933 return prefix2str(pu
, str
, size
);
936 static void zebra_pbr_display_icmp(struct vty
*vty
,
937 struct zebra_pbr_ipset_entry
*zpie
)
939 char decoded_str
[20];
941 struct zebra_pbr_ipset
*zpi
;
943 zpi
= zpie
->backpointer
;
945 /* range icmp type */
946 if (zpie
->src_port_max
|| zpie
->dst_port_max
) {
947 vty_out(vty
, ":icmp:[type <%u:%u>;code <%u:%u>",
948 zpie
->src_port_min
, zpie
->src_port_max
,
949 zpie
->dst_port_min
, zpie
->dst_port_max
);
951 port
= ((zpie
->src_port_min
<< 8) & 0xff00) +
952 (zpie
->dst_port_min
& 0xff);
953 memset(decoded_str
, 0, sizeof(decoded_str
));
954 snprintf(decoded_str
, sizeof(decoded_str
), "%u/%u",
955 zpie
->src_port_min
, zpie
->dst_port_min
);
956 vty_out(vty
, ":%s:%s",
957 zpi
->family
== AF_INET6
? "ipv6-icmp" : "icmp",
958 lookup_msg(zpi
->family
== AF_INET6
?
959 icmpv6_typecode_str
: icmp_typecode_str
,
964 static void zebra_pbr_display_port(struct vty
*vty
, uint32_t filter_bm
,
965 uint16_t port_min
, uint16_t port_max
,
968 if (!(filter_bm
& PBR_FILTER_PROTO
)) {
970 vty_out(vty
, ":udp/tcp:%d-%d",
973 vty_out(vty
, ":udp/tcp:%d",
977 vty_out(vty
, ":proto %d:%d-%d",
978 proto
, port_min
, port_max
);
980 vty_out(vty
, ":proto %d:%d",
985 static int zebra_pbr_show_ipset_entry_walkcb(struct hash_bucket
*bucket
,
988 struct zebra_pbr_ipset_entry_unique_display
*unique
=
989 (struct zebra_pbr_ipset_entry_unique_display
*)arg
;
990 struct zebra_pbr_ipset
*zpi
= unique
->zpi
;
991 struct vty
*vty
= unique
->vty
;
992 struct zebra_pbr_ipset_entry
*zpie
=
993 (struct zebra_pbr_ipset_entry
*)bucket
->data
;
994 uint64_t pkts
= 0, bytes
= 0;
997 if (zpie
->backpointer
!= zpi
)
998 return HASHWALK_CONTINUE
;
1000 if ((zpi
->type
== IPSET_NET_NET
) ||
1001 (zpi
->type
== IPSET_NET_PORT_NET
)) {
1002 char buf
[PREFIX_STRLEN
];
1004 zebra_pbr_prefix2str(&(zpie
->src
), buf
, sizeof(buf
));
1005 vty_out(vty
, "\tfrom %s", buf
);
1006 if (zpie
->filter_bm
& PBR_FILTER_SRC_PORT
&&
1007 zpie
->proto
!= IPPROTO_ICMP
)
1008 zebra_pbr_display_port(vty
, zpie
->filter_bm
,
1012 vty_out(vty
, " to ");
1013 zebra_pbr_prefix2str(&(zpie
->dst
), buf
, sizeof(buf
));
1014 vty_out(vty
, "%s", buf
);
1015 if (zpie
->filter_bm
& PBR_FILTER_DST_PORT
&&
1016 zpie
->proto
!= IPPROTO_ICMP
)
1017 zebra_pbr_display_port(vty
, zpie
->filter_bm
,
1021 if (zpie
->proto
== IPPROTO_ICMP
)
1022 zebra_pbr_display_icmp(vty
, zpie
);
1023 } else if ((zpi
->type
== IPSET_NET
) ||
1024 (zpi
->type
== IPSET_NET_PORT
)) {
1025 char buf
[PREFIX_STRLEN
];
1027 if (zpie
->filter_bm
& PBR_FILTER_SRC_IP
) {
1028 zebra_pbr_prefix2str(&(zpie
->src
), buf
, sizeof(buf
));
1029 vty_out(vty
, "\tfrom %s", buf
);
1031 if (zpie
->filter_bm
& PBR_FILTER_SRC_PORT
&&
1032 zpie
->proto
!= IPPROTO_ICMP
)
1033 zebra_pbr_display_port(vty
, zpie
->filter_bm
,
1037 if (zpie
->filter_bm
& PBR_FILTER_DST_IP
) {
1038 zebra_pbr_prefix2str(&(zpie
->dst
), buf
, sizeof(buf
));
1039 vty_out(vty
, "\tto %s", buf
);
1041 if (zpie
->filter_bm
& PBR_FILTER_DST_PORT
&&
1042 zpie
->proto
!= IPPROTO_ICMP
)
1043 zebra_pbr_display_port(vty
, zpie
->filter_bm
,
1047 if (zpie
->proto
== IPPROTO_ICMP
)
1048 zebra_pbr_display_icmp(vty
, zpie
);
1050 vty_out(vty
, " (%u)\n", zpie
->unique
);
1052 ret
= hook_call(zebra_pbr_ipset_entry_get_stat
, zpie
, &pkts
,
1054 if (ret
&& pkts
> 0)
1055 vty_out(vty
, "\t pkts %" PRIu64
", bytes %" PRIu64
"\n",
1057 return HASHWALK_CONTINUE
;
1060 static int zebra_pbr_show_ipset_walkcb(struct hash_bucket
*bucket
, void *arg
)
1062 struct zebra_pbr_env_display
*uniqueipset
=
1063 (struct zebra_pbr_env_display
*)arg
;
1064 struct zebra_pbr_ipset
*zpi
= (struct zebra_pbr_ipset
*)bucket
->data
;
1065 struct zebra_pbr_ipset_entry_unique_display unique
;
1066 struct vty
*vty
= uniqueipset
->vty
;
1067 struct zebra_ns
*zns
= uniqueipset
->zns
;
1069 vty_out(vty
, "IPset %s type %s family %s\n", zpi
->ipset_name
,
1070 zebra_pbr_ipset_type2str(zpi
->type
),
1071 family2str(zpi
->family
));
1075 hash_walk(zrouter
.ipset_entry_hash
, zebra_pbr_show_ipset_entry_walkcb
,
1078 return HASHWALK_CONTINUE
;
1081 size_t zebra_pbr_tcpflags_snprintf(char *buffer
, size_t len
,
1084 size_t len_written
= 0;
1085 static struct message nt
= {0};
1086 const struct message
*pnt
;
1089 for (pnt
= tcp_value_str
;
1090 memcmp(pnt
, &nt
, sizeof(struct message
)); pnt
++)
1091 if (pnt
->key
& tcp_val
) {
1092 len_written
+= snprintf(buffer
+ len_written
,
1103 void zebra_pbr_show_ipset_list(struct vty
*vty
, char *ipsetname
)
1105 struct zebra_pbr_ipset
*zpi
;
1106 struct zebra_ns
*zns
= zebra_ns_lookup(NS_DEFAULT
);
1107 struct zebra_pbr_ipset_entry_unique_display unique
;
1108 struct zebra_pbr_env_display uniqueipset
;
1111 zpi
= zebra_pbr_lookup_ipset_pername(ipsetname
);
1113 vty_out(vty
, "No IPset %s found\n", ipsetname
);
1116 vty_out(vty
, "IPset %s type %s family %s\n", ipsetname
,
1117 zebra_pbr_ipset_type2str(zpi
->type
),
1118 family2str(zpi
->family
));
1122 hash_walk(zrouter
.ipset_entry_hash
,
1123 zebra_pbr_show_ipset_entry_walkcb
, &unique
);
1126 uniqueipset
.zns
= zns
;
1127 uniqueipset
.vty
= vty
;
1128 uniqueipset
.name
= NULL
;
1129 hash_walk(zrouter
.ipset_hash
, zebra_pbr_show_ipset_walkcb
,
1133 struct pbr_rule_fwmark_lookup
{
1134 struct zebra_pbr_rule
*ptr
;
1138 static int zebra_pbr_rule_lookup_fwmark_walkcb(struct hash_bucket
*bucket
,
1141 struct pbr_rule_fwmark_lookup
*iprule
=
1142 (struct pbr_rule_fwmark_lookup
*)arg
;
1143 struct zebra_pbr_rule
*zpr
= (struct zebra_pbr_rule
*)bucket
->data
;
1145 if (iprule
->fwmark
== zpr
->rule
.filter
.fwmark
) {
1147 return HASHWALK_ABORT
;
1149 return HASHWALK_CONTINUE
;
1152 static void zebra_pbr_show_iptable_unit(struct zebra_pbr_iptable
*iptable
,
1154 struct zebra_ns
*zns
)
1157 uint64_t pkts
= 0, bytes
= 0;
1159 vty_out(vty
, "IPtable %s family %s action %s (%u)\n",
1160 iptable
->ipset_name
,
1161 family2str(iptable
->family
),
1162 iptable
->action
== ZEBRA_IPTABLES_DROP
? "drop" : "redirect",
1164 if (iptable
->type
== IPSET_NET_PORT
||
1165 iptable
->type
== IPSET_NET_PORT_NET
) {
1166 if (!(iptable
->filter_bm
& MATCH_ICMP_SET
)) {
1167 if (iptable
->filter_bm
& PBR_FILTER_DST_PORT
)
1168 vty_out(vty
, "\t lookup dst port\n");
1169 else if (iptable
->filter_bm
& PBR_FILTER_SRC_PORT
)
1170 vty_out(vty
, "\t lookup src port\n");
1173 if (iptable
->pkt_len_min
|| iptable
->pkt_len_max
) {
1174 if (!iptable
->pkt_len_max
)
1175 vty_out(vty
, "\t pkt len %u\n",
1176 iptable
->pkt_len_min
);
1178 vty_out(vty
, "\t pkt len [%u;%u]\n",
1179 iptable
->pkt_len_min
,
1180 iptable
->pkt_len_max
);
1182 if (iptable
->tcp_flags
|| iptable
->tcp_mask_flags
) {
1183 char tcp_flag_str
[64];
1184 char tcp_flag_mask_str
[64];
1186 zebra_pbr_tcpflags_snprintf(tcp_flag_str
,
1187 sizeof(tcp_flag_str
),
1188 iptable
->tcp_flags
);
1189 zebra_pbr_tcpflags_snprintf(tcp_flag_mask_str
,
1190 sizeof(tcp_flag_mask_str
),
1191 iptable
->tcp_mask_flags
);
1192 vty_out(vty
, "\t tcpflags [%s/%s]\n",
1193 tcp_flag_str
, tcp_flag_mask_str
);
1195 if (iptable
->filter_bm
& (MATCH_DSCP_SET
| MATCH_DSCP_INVERSE_SET
)) {
1196 vty_out(vty
, "\t dscp %s %d\n",
1197 iptable
->filter_bm
& MATCH_DSCP_INVERSE_SET
?
1198 "not" : "", iptable
->dscp_value
);
1200 if (iptable
->filter_bm
& (MATCH_FLOW_LABEL_SET
|
1201 MATCH_FLOW_LABEL_INVERSE_SET
)) {
1202 vty_out(vty
, "\t flowlabel %s %d\n",
1203 iptable
->filter_bm
& MATCH_FLOW_LABEL_INVERSE_SET
?
1204 "not" : "", iptable
->flow_label
);
1206 if (iptable
->fragment
) {
1209 snprintf(val_str
, sizeof(val_str
), "%d", iptable
->fragment
);
1210 vty_out(vty
, "\t fragment%s %s\n",
1211 iptable
->filter_bm
& MATCH_FRAGMENT_INVERSE_SET
?
1212 " not" : "", lookup_msg(fragment_value_str
,
1213 iptable
->fragment
, val_str
));
1215 if (iptable
->protocol
) {
1216 vty_out(vty
, "\t protocol %d\n",
1219 ret
= hook_call(zebra_pbr_iptable_get_stat
, iptable
, &pkts
,
1221 if (ret
&& pkts
> 0)
1222 vty_out(vty
, "\t pkts %" PRIu64
", bytes %" PRIu64
"\n",
1224 if (iptable
->action
!= ZEBRA_IPTABLES_DROP
) {
1225 struct pbr_rule_fwmark_lookup prfl
;
1227 prfl
.fwmark
= iptable
->fwmark
;
1229 hash_walk(zrouter
.rules_hash
,
1230 &zebra_pbr_rule_lookup_fwmark_walkcb
, &prfl
);
1232 struct zebra_pbr_rule
*zpr
= prfl
.ptr
;
1234 vty_out(vty
, "\t table %u, fwmark %u\n",
1235 zpr
->rule
.action
.table
,
1241 static int zebra_pbr_show_iptable_walkcb(struct hash_bucket
*bucket
, void *arg
)
1243 struct zebra_pbr_iptable
*iptable
=
1244 (struct zebra_pbr_iptable
*)bucket
->data
;
1245 struct zebra_pbr_env_display
*env
= (struct zebra_pbr_env_display
*)arg
;
1246 struct vty
*vty
= env
->vty
;
1247 struct zebra_ns
*zns
= env
->zns
;
1248 char *iptable_name
= env
->name
;
1251 zebra_pbr_show_iptable_unit(iptable
, vty
, zns
);
1252 else if (!strncmp(iptable_name
,
1253 iptable
->ipset_name
,
1254 ZEBRA_IPSET_NAME_SIZE
))
1255 zebra_pbr_show_iptable_unit(iptable
, vty
, zns
);
1256 return HASHWALK_CONTINUE
;
1259 void zebra_pbr_show_iptable(struct vty
*vty
, char *iptable_name
)
1261 struct zebra_ns
*zns
= zebra_ns_lookup(NS_DEFAULT
);
1262 struct zebra_pbr_env_display env
;
1266 env
.name
= iptable_name
;
1267 hash_walk(zrouter
.iptable_hash
, zebra_pbr_show_iptable_walkcb
, &env
);
1270 void zebra_pbr_iptable_update_interfacelist(struct stream
*s
,
1271 struct zebra_pbr_iptable
*zpi
)
1273 uint32_t i
= 0, index
;
1274 struct interface
*ifp
;
1277 for (i
= 0; i
< zpi
->nb_interface
; i
++) {
1278 STREAM_GETL(s
, index
);
1279 ifp
= if_lookup_by_index(index
, zpi
->vrf_id
);
1282 name
= XSTRDUP(MTYPE_PBR_IPTABLE_IFNAME
, ifp
->name
);
1283 listnode_add(zpi
->interface_name_list
, name
);