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