2 * Zebra Policy Based Routing (PBR) Data structures and definitions
3 * These are public definitions referenced by multiple files.
4 * Copyright (C) 2018 Cumulus Networks, Inc.
6 * This file is part of FRR.
8 * FRR is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2, or (at your option) any
13 * FRR is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with FRR; see the file COPYING. If not, write to the Free
20 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
35 struct zebra_pbr_rule
{
40 struct interface
*ifp
;
43 #define IS_RULE_FILTERING_ON_SRC_IP(r) \
44 (r->rule.filter.filter_bm & PBR_FILTER_SRC_IP)
45 #define IS_RULE_FILTERING_ON_DST_IP(r) \
46 (r->rule.filter.filter_bm & PBR_FILTER_DST_IP)
47 #define IS_RULE_FILTERING_ON_SRC_PORT(r) \
48 (r->rule.filter.filter_bm & PBR_FILTER_SRC_PORT)
49 #define IS_RULE_FILTERING_ON_DST_PORT(r) \
50 (r->rule.filter.filter_bm & PBR_FILTER_DST_PORT)
51 #define IS_RULE_FILTERING_ON_FWMARK(r) \
52 (r->rule.filter.filter_bm & PBR_FILTER_FWMARK)
55 * An IPSet Entry Filter
57 * This is a filter mapped on ipset entries
59 struct zebra_pbr_ipset
{
61 * Originating zclient sock fd, so we can know who to send
70 /* type is encoded as uint32_t
71 * but value is an enum ipset_type
74 char ipset_name
[ZEBRA_IPSET_NAME_SIZE
];
78 * An IPSet Entry Filter
80 * This is a filter mapped on ipset entries
82 struct zebra_pbr_ipset_entry
{
84 * Originating zclient sock fd, so we can know who to send
94 /* udp/tcp src port or icmp type */
95 uint16_t src_port_min
;
96 uint16_t src_port_max
;
97 /* udp/tcp dst port or icmp code */
98 uint16_t dst_port_min
;
99 uint16_t dst_port_max
;
105 struct zebra_pbr_ipset
*backpointer
;
111 * This is a filter mapped on ipset entries
113 struct zebra_pbr_iptable
{
115 * Originating zclient sock fd, so we can know who to send
124 /* include ipset type
128 /* include which IP is to be filtered
136 uint16_t pkt_len_min
;
137 uint16_t pkt_len_max
;
139 uint16_t tcp_mask_flags
;
143 uint32_t nb_interface
;
145 struct list
*interface_name_list
;
147 char ipset_name
[ZEBRA_IPSET_NAME_SIZE
];
150 extern const struct message icmp_typecode_str
[];
152 const char *zebra_pbr_ipset_type2str(uint32_t type
);
154 void zebra_pbr_add_rule(struct zebra_ns
*zns
, struct zebra_pbr_rule
*rule
);
155 void zebra_pbr_del_rule(struct zebra_ns
*zns
, struct zebra_pbr_rule
*rule
);
156 void zebra_pbr_create_ipset(struct zebra_ns
*zns
,
157 struct zebra_pbr_ipset
*ipset
);
158 void zebra_pbr_destroy_ipset(struct zebra_ns
*zns
,
159 struct zebra_pbr_ipset
*ipset
);
160 struct zebra_pbr_ipset
*zebra_pbr_lookup_ipset_pername(struct zebra_ns
*zns
,
162 void zebra_pbr_add_ipset_entry(struct zebra_ns
*zns
,
163 struct zebra_pbr_ipset_entry
*ipset
);
164 void zebra_pbr_del_ipset_entry(struct zebra_ns
*zns
,
165 struct zebra_pbr_ipset_entry
*ipset
);
167 void zebra_pbr_add_iptable(struct zebra_ns
*zns
,
168 struct zebra_pbr_iptable
*iptable
);
169 void zebra_pbr_del_iptable(struct zebra_ns
*zns
,
170 struct zebra_pbr_iptable
*iptable
);
173 * Install specified rule for a specific interface.
174 * It is possible that the user-defined sequence number and the one in the
175 * forwarding plane may not coincide, hence the API requires a separate
176 * rule priority - maps to preference/FRA_PRIORITY on Linux.
178 extern enum dp_req_result
kernel_add_pbr_rule(struct zebra_pbr_rule
*rule
);
181 * Uninstall specified rule for a specific interface.
183 extern enum dp_req_result
kernel_del_pbr_rule(struct zebra_pbr_rule
*rule
);
186 * Get to know existing PBR rules in the kernel - typically called at startup.
188 extern void kernel_read_pbr_rules(struct zebra_ns
*zns
);
191 * Handle success or failure of rule (un)install in the kernel.
193 extern void kernel_pbr_rule_add_del_status(struct zebra_pbr_rule
*rule
,
194 enum dp_results res
);
197 * Handle success or failure of ipset kinds (un)install in the kernel.
199 extern void kernel_pbr_ipset_add_del_status(struct zebra_pbr_ipset
*ipset
,
200 enum dp_results res
);
202 extern void kernel_pbr_ipset_entry_add_del_status(
203 struct zebra_pbr_ipset_entry
*ipset
,
204 enum dp_results res
);
206 extern void kernel_pbr_iptable_add_del_status(struct zebra_pbr_iptable
*iptable
,
207 enum dp_results res
);
210 * Handle rule delete notification from kernel.
212 extern int kernel_pbr_rule_del(struct zebra_pbr_rule
*rule
);
214 extern void zebra_pbr_rules_free(void *arg
);
215 extern uint32_t zebra_pbr_rules_hash_key(void *arg
);
216 extern int zebra_pbr_rules_hash_equal(const void *arg1
, const void *arg2
);
218 /* has operates on 32bit pointer
219 * and field is a string of 8bit
221 #define ZEBRA_IPSET_NAME_HASH_SIZE (ZEBRA_IPSET_NAME_SIZE / 4)
223 extern void zebra_pbr_ipset_free(void *arg
);
224 extern uint32_t zebra_pbr_ipset_hash_key(void *arg
);
225 extern int zebra_pbr_ipset_hash_equal(const void *arg1
, const void *arg2
);
227 extern void zebra_pbr_ipset_entry_free(void *arg
);
228 extern uint32_t zebra_pbr_ipset_entry_hash_key(void *arg
);
229 extern int zebra_pbr_ipset_entry_hash_equal(const void *arg1
, const void *arg2
);
231 extern void zebra_pbr_iptable_free(void *arg
);
232 extern uint32_t zebra_pbr_iptable_hash_key(void *arg
);
233 extern int zebra_pbr_iptable_hash_equal(const void *arg1
, const void *arg2
);
235 extern void zebra_pbr_init(void);
236 extern void zebra_pbr_show_ipset_list(struct vty
*vty
, char *ipsetname
);
237 extern void zebra_pbr_show_iptable(struct vty
*vty
, char *iptable
);
238 extern void zebra_pbr_iptable_update_interfacelist(struct stream
*s
,
239 struct zebra_pbr_iptable
*zpi
);
240 size_t zebra_pbr_tcpflags_snprintf(char *buffer
, size_t len
,
243 DECLARE_HOOK(zebra_pbr_ipset_entry_wrap_script_get_stat
, (struct zebra_ns
*zns
,
244 struct zebra_pbr_ipset_entry
*ipset
,
245 uint64_t *pkts
, uint64_t *bytes
),
246 (zns
, ipset
, pkts
, bytes
))
247 DECLARE_HOOK(zebra_pbr_iptable_wrap_script_get_stat
, (struct zebra_ns
*zns
,
248 struct zebra_pbr_iptable
*iptable
,
249 uint64_t *pkts
, uint64_t *bytes
),
250 (zns
, iptable
, pkts
, bytes
))
251 DECLARE_HOOK(zebra_pbr_iptable_wrap_script_update
, (struct zebra_ns
*zns
,
253 struct zebra_pbr_iptable
*iptable
),
254 (zns
, cmd
, iptable
));
256 DECLARE_HOOK(zebra_pbr_ipset_entry_wrap_script_update
, (struct zebra_ns
*zns
,
258 struct zebra_pbr_ipset_entry
*ipset
),
260 DECLARE_HOOK(zebra_pbr_ipset_wrap_script_update
, (struct zebra_ns
*zns
,
262 struct zebra_pbr_ipset
*ipset
),
265 #endif /* _ZEBRA_PBR_H */