zebra/zebra_pbr.h

   1 /*
   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.
   5  *
   6  * This file is part of FRR.
   7  *
   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
  11  * later version.
  12  *
  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.
  17  *
  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
  21  * 02111-1307, USA.
  22  */
  23
  24 #ifndef _ZEBRA_PBR_H
  25 #define _ZEBRA_PBR_H
  26
  27 #include <zebra.h>
  28
  29 #include "prefix.h"
  30 #include "if.h"
  31
  32 #include "rt.h"
  33 #include "pbr.h"
  34
  35 struct zebra_pbr_rule {
  36         int sock;
  37
  38         struct pbr_rule rule;
  39
  40         struct interface *ifp;
  41
  42         vrf_id_t vrf_id;
  43 };
  44
  45 #define IS_RULE_FILTERING_ON_SRC_IP(r) \
  46         (r->rule.filter.filter_bm & PBR_FILTER_SRC_IP)
  47 #define IS_RULE_FILTERING_ON_DST_IP(r) \
  48         (r->rule.filter.filter_bm & PBR_FILTER_DST_IP)
  49 #define IS_RULE_FILTERING_ON_SRC_PORT(r) \
  50         (r->rule.filter.filter_bm & PBR_FILTER_SRC_PORT)
  51 #define IS_RULE_FILTERING_ON_DST_PORT(r) \
  52         (r->rule.filter.filter_bm & PBR_FILTER_DST_PORT)
  53 #define IS_RULE_FILTERING_ON_FWMARK(r) \
  54         (r->rule.filter.filter_bm & PBR_FILTER_FWMARK)
  55
  56 /*
  57  * An IPSet Entry Filter
  58  *
  59  * This is a filter mapped on ipset entries
  60  */
  61 struct zebra_pbr_ipset {
  62         /*
  63          * Originating zclient sock fd, so we can know who to send
  64          * back to.
  65          */
  66         int sock;
  67
  68         vrf_id_t vrf_id;
  69
  70         uint32_t unique;
  71
  72         /* type is encoded as uint32_t
  73          * but value is an enum ipset_type
  74          */
  75         uint32_t type;
  76         char ipset_name[ZEBRA_IPSET_NAME_SIZE];
  77 };
  78
  79 /*
  80  * An IPSet Entry Filter
  81  *
  82  * This is a filter mapped on ipset entries
  83  */
  84 struct zebra_pbr_ipset_entry {
  85         /*
  86          * Originating zclient sock fd, so we can know who to send
  87          * back to.
  88          */
  89         int sock;
  90
  91         uint32_t unique;
  92
  93         struct prefix src;
  94         struct prefix dst;
  95
  96         /* udp/tcp src port or icmp type */
  97         uint16_t src_port_min;
  98         uint16_t src_port_max;
  99         /* udp/tcp dst port or icmp code */
 100         uint16_t dst_port_min;
 101         uint16_t dst_port_max;
 102
 103         uint8_t proto;
 104
 105         uint32_t filter_bm;
 106
 107         struct zebra_pbr_ipset *backpointer;
 108 };
 109
 110 /*
 111  * An IPTables Action
 112  *
 113  * This is a filter mapped on ipset entries
 114  */
 115 struct zebra_pbr_iptable {
 116         /*
 117          * Originating zclient sock fd, so we can know who to send
 118          * back to.
 119          */
 120         int sock;
 121
 122         vrf_id_t vrf_id;
 123
 124         uint32_t unique;
 125
 126         /* include ipset type
 127          */
 128         uint32_t type;
 129
 130         /* include which IP is to be filtered
 131          */
 132         uint32_t filter_bm;
 133
 134         uint32_t fwmark;
 135
 136         uint32_t action;
 137
 138         uint16_t pkt_len_min;
 139         uint16_t pkt_len_max;
 140         uint16_t tcp_flags;
 141         uint16_t tcp_mask_flags;
 142         uint8_t dscp_value;
 143         uint8_t fragment;
 144
 145         uint32_t nb_interface;
 146
 147         struct list *interface_name_list;
 148
 149         char ipset_name[ZEBRA_IPSET_NAME_SIZE];
 150 };
 151
 152 extern const struct message icmp_typecode_str[];
 153
 154 const char *zebra_pbr_ipset_type2str(uint32_t type);
 155
 156 void zebra_pbr_add_rule(struct zebra_pbr_rule *rule);
 157 void zebra_pbr_del_rule(struct zebra_pbr_rule *rule);
 158 void zebra_pbr_create_ipset(struct zebra_ns *zns,
 159                             struct zebra_pbr_ipset *ipset);
 160 void zebra_pbr_destroy_ipset(struct zebra_ns *zns,
 161                              struct zebra_pbr_ipset *ipset);
 162 struct zebra_pbr_ipset *zebra_pbr_lookup_ipset_pername(struct zebra_ns *zns,
 163                                                        char *ipsetname);
 164 void zebra_pbr_add_ipset_entry(struct zebra_ns *zns,
 165                                struct zebra_pbr_ipset_entry *ipset);
 166 void zebra_pbr_del_ipset_entry(struct zebra_ns *zns,
 167                                struct zebra_pbr_ipset_entry *ipset);
 168
 169 void zebra_pbr_add_iptable(struct zebra_ns *zns,
 170                            struct zebra_pbr_iptable *iptable);
 171 void zebra_pbr_del_iptable(struct zebra_ns *zns,
 172                            struct zebra_pbr_iptable *iptable);
 173
 174 /*
 175  * Install specified rule for a specific interface.
 176  * It is possible that the user-defined sequence number and the one in the
 177  * forwarding plane may not coincide, hence the API requires a separate
 178  * rule priority - maps to preference/FRA_PRIORITY on Linux.
 179  */
 180 extern enum zebra_dplane_result kernel_add_pbr_rule(struct zebra_pbr_rule *rule);
 181
 182 /*
 183  * Uninstall specified rule for a specific interface.
 184  */
 185 extern enum zebra_dplane_result kernel_del_pbr_rule(struct zebra_pbr_rule *rule);
 186
 187 /*
 188  * Get to know existing PBR rules in the kernel - typically called at startup.
 189  */
 190 extern void kernel_read_pbr_rules(struct zebra_ns *zns);
 191
 192 /*
 193  * Handle success or failure of rule (un)install in the kernel.
 194  */
 195 extern void kernel_pbr_rule_add_del_status(struct zebra_pbr_rule *rule,
 196                                            enum zebra_dplane_status res);
 197
 198 /*
 199  * Handle success or failure of ipset kinds (un)install in the kernel.
 200  */
 201 extern void kernel_pbr_ipset_add_del_status(struct zebra_pbr_ipset *ipset,
 202                                            enum zebra_dplane_status res);
 203
 204 extern void kernel_pbr_ipset_entry_add_del_status(
 205                                 struct zebra_pbr_ipset_entry *ipset,
 206                                 enum zebra_dplane_status res);
 207
 208 extern void kernel_pbr_iptable_add_del_status(struct zebra_pbr_iptable *iptable,
 209                               enum zebra_dplane_status res);
 210
 211 /*
 212  * Handle rule delete notification from kernel.
 213  */
 214 extern int kernel_pbr_rule_del(struct zebra_pbr_rule *rule);
 215
 216 extern void zebra_pbr_rules_free(void *arg);
 217 extern uint32_t zebra_pbr_rules_hash_key(void *arg);
 218 extern bool zebra_pbr_rules_hash_equal(const void *arg1, const void *arg2);
 219
 220 /* has operates on 32bit pointer
 221  * and field is a string of 8bit
 222  */
 223 #define ZEBRA_IPSET_NAME_HASH_SIZE (ZEBRA_IPSET_NAME_SIZE / 4)
 224
 225 extern void zebra_pbr_ipset_free(void *arg);
 226 extern uint32_t zebra_pbr_ipset_hash_key(void *arg);
 227 extern bool zebra_pbr_ipset_hash_equal(const void *arg1, const void *arg2);
 228
 229 extern void zebra_pbr_ipset_entry_free(void *arg);
 230 extern uint32_t zebra_pbr_ipset_entry_hash_key(void *arg);
 231 extern bool zebra_pbr_ipset_entry_hash_equal(const void *arg1,
 232                                              const void *arg2);
 233
 234 extern void zebra_pbr_iptable_free(void *arg);
 235 extern uint32_t zebra_pbr_iptable_hash_key(void *arg);
 236 extern bool zebra_pbr_iptable_hash_equal(const void *arg1, const void *arg2);
 237
 238 extern void zebra_pbr_init(void);
 239 extern void zebra_pbr_show_ipset_list(struct vty *vty, char *ipsetname);
 240 extern void zebra_pbr_show_iptable(struct vty *vty, char *iptable);
 241 extern void zebra_pbr_iptable_update_interfacelist(struct stream *s,
 242                                    struct zebra_pbr_iptable *zpi);
 243 size_t zebra_pbr_tcpflags_snprintf(char *buffer, size_t len,
 244                                    uint16_t tcp_val);
 245
 246 DECLARE_HOOK(zebra_pbr_ipset_entry_wrap_script_get_stat, (struct zebra_ns *zns,
 247                                     struct zebra_pbr_ipset_entry *ipset,
 248                                     uint64_t *pkts, uint64_t *bytes),
 249                                      (zns, ipset, pkts, bytes))
 250 DECLARE_HOOK(zebra_pbr_iptable_wrap_script_get_stat, (struct zebra_ns *zns,
 251                                     struct zebra_pbr_iptable *iptable,
 252                                     uint64_t *pkts, uint64_t *bytes),
 253                                      (zns, iptable, pkts, bytes))
 254 DECLARE_HOOK(zebra_pbr_iptable_wrap_script_update, (struct zebra_ns *zns,
 255                                              int cmd,
 256                                              struct zebra_pbr_iptable *iptable),
 257                                              (zns, cmd, iptable));
 258
 259 DECLARE_HOOK(zebra_pbr_ipset_entry_wrap_script_update, (struct zebra_ns *zns,
 260                                   int cmd,
 261                                   struct zebra_pbr_ipset_entry *ipset),
 262                                      (zns, cmd, ipset));
 263 DECLARE_HOOK(zebra_pbr_ipset_wrap_script_update, (struct zebra_ns *zns,
 264                                   int cmd,
 265                                   struct zebra_pbr_ipset *ipset),
 266                                      (zns, cmd, ipset));
 267
 268 #endif /* _ZEBRA_PBR_H */