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
  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)
  53
  54 /*
  55  * An IPSet Entry Filter
  56  *
  57  * This is a filter mapped on ipset entries
  58  */
  59 struct zebra_pbr_ipset {
  60         /*
  61          * Originating zclient sock fd, so we can know who to send
  62          * back to.
  63          */
  64         int sock;
  65
  66         vrf_id_t vrf_id;
  67
  68         uint32_t unique;
  69
  70         /* type is encoded as uint32_t
  71          * but value is an enum ipset_type
  72          */
  73         uint32_t type;
  74         char ipset_name[ZEBRA_IPSET_NAME_SIZE];
  75 };
  76
  77 /*
  78  * An IPSet Entry Filter
  79  *
  80  * This is a filter mapped on ipset entries
  81  */
  82 struct zebra_pbr_ipset_entry {
  83         /*
  84          * Originating zclient sock fd, so we can know who to send
  85          * back to.
  86          */
  87         int sock;
  88
  89         uint32_t unique;
  90
  91         struct prefix src;
  92         struct prefix dst;
  93
  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;
 100
 101         uint8_t proto;
 102
 103         uint32_t filter_bm;
 104
 105         struct zebra_pbr_ipset *backpointer;
 106 };
 107
 108 /*
 109  * An IPTables Action
 110  *
 111  * This is a filter mapped on ipset entries
 112  */
 113 struct zebra_pbr_iptable {
 114         /*
 115          * Originating zclient sock fd, so we can know who to send
 116          * back to.
 117          */
 118         int sock;
 119
 120         vrf_id_t vrf_id;
 121
 122         uint32_t unique;
 123
 124         /* include ipset type
 125          */
 126         uint32_t type;
 127
 128         /* include which IP is to be filtered
 129          */
 130         uint32_t filter_bm;
 131
 132         uint32_t fwmark;
 133
 134         uint32_t action;
 135
 136         uint16_t pkt_len_min;
 137         uint16_t pkt_len_max;
 138         uint16_t tcp_flags;
 139         uint16_t tcp_mask_flags;
 140         uint8_t dscp_value;
 141         uint8_t fragment;
 142
 143         uint32_t nb_interface;
 144
 145         struct list *interface_name_list;
 146
 147         char ipset_name[ZEBRA_IPSET_NAME_SIZE];
 148 };
 149
 150 extern const struct message icmp_typecode_str[];
 151
 152 const char *zebra_pbr_ipset_type2str(uint32_t type);
 153
 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,
 161                                                        char *ipsetname);
 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);
 166
 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);
 171
 172 /*
 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.
 177  */
 178 extern enum dp_req_result kernel_add_pbr_rule(struct zebra_pbr_rule *rule);
 179
 180 /*
 181  * Uninstall specified rule for a specific interface.
 182  */
 183 extern enum dp_req_result kernel_del_pbr_rule(struct zebra_pbr_rule *rule);
 184
 185 /*
 186  * Get to know existing PBR rules in the kernel - typically called at startup.
 187  */
 188 extern void kernel_read_pbr_rules(struct zebra_ns *zns);
 189
 190 enum dp_results;
 191 /*
 192  * Handle success or failure of rule (un)install in the kernel.
 193  */
 194 extern void kernel_pbr_rule_add_del_status(struct zebra_pbr_rule *rule,
 195                                            enum dp_results res);
 196
 197 /*
 198  * Handle success or failure of ipset kinds (un)install in the kernel.
 199  */
 200 extern void kernel_pbr_ipset_add_del_status(struct zebra_pbr_ipset *ipset,
 201                                            enum dp_results res);
 202
 203 extern void kernel_pbr_ipset_entry_add_del_status(
 204                                 struct zebra_pbr_ipset_entry *ipset,
 205                                 enum dp_results res);
 206
 207 extern void kernel_pbr_iptable_add_del_status(struct zebra_pbr_iptable *iptable,
 208                               enum dp_results res);
 209
 210 /*
 211  * Handle rule delete notification from kernel.
 212  */
 213 extern int kernel_pbr_rule_del(struct zebra_pbr_rule *rule);
 214
 215 extern void zebra_pbr_rules_free(void *arg);
 216 extern uint32_t zebra_pbr_rules_hash_key(void *arg);
 217 extern int zebra_pbr_rules_hash_equal(const void *arg1, const void *arg2);
 218
 219 /* has operates on 32bit pointer
 220  * and field is a string of 8bit
 221  */
 222 #define ZEBRA_IPSET_NAME_HASH_SIZE (ZEBRA_IPSET_NAME_SIZE / 4)
 223
 224 extern void zebra_pbr_ipset_free(void *arg);
 225 extern uint32_t zebra_pbr_ipset_hash_key(void *arg);
 226 extern int zebra_pbr_ipset_hash_equal(const void *arg1, const void *arg2);
 227
 228 extern void zebra_pbr_ipset_entry_free(void *arg);
 229 extern uint32_t zebra_pbr_ipset_entry_hash_key(void *arg);
 230 extern int zebra_pbr_ipset_entry_hash_equal(const void *arg1, const void *arg2);
 231
 232 extern void zebra_pbr_iptable_free(void *arg);
 233 extern uint32_t zebra_pbr_iptable_hash_key(void *arg);
 234 extern int zebra_pbr_iptable_hash_equal(const void *arg1, const void *arg2);
 235
 236 extern void zebra_pbr_init(void);
 237 extern void zebra_pbr_show_ipset_list(struct vty *vty, char *ipsetname);
 238 extern void zebra_pbr_show_iptable(struct vty *vty, char *iptable);
 239 extern void zebra_pbr_iptable_update_interfacelist(struct stream *s,
 240                                    struct zebra_pbr_iptable *zpi);
 241 size_t zebra_pbr_tcpflags_snprintf(char *buffer, size_t len,
 242                                    uint16_t tcp_val);
 243
 244 DECLARE_HOOK(zebra_pbr_ipset_entry_wrap_script_get_stat, (struct zebra_ns *zns,
 245                                     struct zebra_pbr_ipset_entry *ipset,
 246                                     uint64_t *pkts, uint64_t *bytes),
 247                                      (zns, ipset, pkts, bytes))
 248 DECLARE_HOOK(zebra_pbr_iptable_wrap_script_get_stat, (struct zebra_ns *zns,
 249                                     struct zebra_pbr_iptable *iptable,
 250                                     uint64_t *pkts, uint64_t *bytes),
 251                                      (zns, iptable, pkts, bytes))
 252 DECLARE_HOOK(zebra_pbr_iptable_wrap_script_update, (struct zebra_ns *zns,
 253                                              int cmd,
 254                                              struct zebra_pbr_iptable *iptable),
 255                                              (zns, cmd, iptable));
 256
 257 DECLARE_HOOK(zebra_pbr_ipset_entry_wrap_script_update, (struct zebra_ns *zns,
 258                                   int cmd,
 259                                   struct zebra_pbr_ipset_entry *ipset),
 260                                      (zns, cmd, ipset));
 261 DECLARE_HOOK(zebra_pbr_ipset_wrap_script_update, (struct zebra_ns *zns,
 262                                   int cmd,
 263                                   struct zebra_pbr_ipset *ipset),
 264                                      (zns, cmd, ipset));
 265
 266 #endif /* _ZEBRA_PBR_H */