lib/libpfctl/libpfctl.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2021 Rubicon Communications, LLC (Netgate)
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  *    - Redistributions of source code must retain the above copyright
  12  *      notice, this list of conditions and the following disclaimer.
  13  *    - Redistributions in binary form must reproduce the above
  14  *      copyright notice, this list of conditions and the following
  15  *      disclaimer in the documentation and/or other materials provided
  16  *      with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  21  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  22  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  24  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  28  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  *
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef _PFCTL_IOCTL_H_
  35 #define _PFCTL_IOCTL_H_
  36
  37 #include <netpfil/pf/pf.h>
  38
  39 struct pfctl_anchor;
  40 struct pfctl_eth_anchor;
  41
  42 struct pfctl_status_counter {
  43         uint64_t         id;
  44         uint64_t         counter;
  45         char            *name;
  46
  47         TAILQ_ENTRY(pfctl_status_counter) entry;
  48 };
  49 TAILQ_HEAD(pfctl_status_counters, pfctl_status_counter);
  50
  51 struct pfctl_status {
  52         bool            running;
  53         uint32_t        since;
  54         uint32_t        debug;
  55         uint32_t        hostid;
  56         uint64_t        states;
  57         uint64_t        src_nodes;
  58         char            ifname[IFNAMSIZ];
  59         uint8_t         pf_chksum[PF_MD5_DIGEST_LENGTH];
  60
  61         struct pfctl_status_counters     counters;
  62         struct pfctl_status_counters     lcounters;
  63         struct pfctl_status_counters     fcounters;
  64         struct pfctl_status_counters     scounters;
  65         uint64_t        pcounters[2][2][3];
  66         uint64_t        bcounters[2][2];
  67 };
  68
  69 struct pfctl_eth_rulesets_info {
  70         uint32_t        nr;
  71 };
  72
  73 struct pfctl_eth_rules_info {
  74         uint32_t        nr;
  75         uint32_t        ticket;
  76 };
  77
  78 struct pfctl_eth_addr {
  79         uint8_t addr[ETHER_ADDR_LEN];
  80         uint8_t mask[ETHER_ADDR_LEN];
  81         bool    neg;
  82         bool    isset;
  83 };
  84
  85 struct pfctl_eth_rule {
  86         uint32_t                 nr;
  87
  88         bool                     quick;
  89
  90         /* Filter */
  91         char                     ifname[IFNAMSIZ];
  92         uint8_t                  ifnot;
  93         uint8_t                  direction;
  94         uint16_t                 proto;
  95         struct pfctl_eth_addr    src, dst;
  96         struct pf_rule_addr      ipsrc, ipdst;
  97
  98         /* Stats */
  99         uint64_t                 evaluations;
 100         uint64_t                 packets[2];
 101         uint64_t                 bytes[2];
 102
 103         /* Action */
 104         char                     qname[PF_QNAME_SIZE];
 105         char                     tagname[PF_TAG_NAME_SIZE];
 106         uint16_t                 dnpipe;
 107         uint32_t                 dnflags;
 108         uint8_t                  action;
 109
 110         struct pfctl_eth_anchor *anchor;
 111         uint8_t                  anchor_relative;
 112         uint8_t                  anchor_wildcard;
 113
 114         TAILQ_ENTRY(pfctl_eth_rule)      entries;
 115 };
 116 TAILQ_HEAD(pfctl_eth_rules, pfctl_eth_rule);
 117
 118 struct pfctl_eth_ruleset_info {
 119         uint32_t        nr;
 120         char            name[PF_ANCHOR_NAME_SIZE];
 121         char            path[MAXPATHLEN];
 122 };
 123
 124 struct pfctl_eth_ruleset {
 125         struct pfctl_eth_rules   rules;
 126         struct pfctl_eth_anchor *anchor;
 127 };
 128
 129 struct pfctl_eth_anchor {
 130         struct pfctl_eth_anchor         *parent;
 131         char                             name[PF_ANCHOR_NAME_SIZE];
 132         char                             path[MAXPATHLEN];
 133         struct pfctl_eth_ruleset         ruleset;
 134         int                              refcnt;        /* anchor rules */
 135         int                              match; /* XXX: used for pfctl black magic */
 136 };
 137
 138 struct pfctl_pool {
 139         struct pf_palist         list;
 140         struct pf_pooladdr      *cur;
 141         struct pf_poolhashkey    key;
 142         struct pf_addr           counter;
 143         struct pf_mape_portset   mape;
 144         int                      tblidx;
 145         uint16_t                 proxy_port[2];
 146         uint8_t                  opts;
 147 };
 148
 149 struct pfctl_rules_info {
 150         uint32_t        nr;
 151         uint32_t        ticket;
 152 };
 153
 154 struct pfctl_rule {
 155         struct pf_rule_addr      src;
 156         struct pf_rule_addr      dst;
 157         union pf_rule_ptr        skip[PF_SKIP_COUNT];
 158         char                     label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE];
 159         uint32_t                 ridentifier;
 160         char                     ifname[IFNAMSIZ];
 161         char                     qname[PF_QNAME_SIZE];
 162         char                     pqname[PF_QNAME_SIZE];
 163         char                     tagname[PF_TAG_NAME_SIZE];
 164         char                     match_tagname[PF_TAG_NAME_SIZE];
 165
 166         char                     overload_tblname[PF_TABLE_NAME_SIZE];
 167
 168         TAILQ_ENTRY(pfctl_rule)  entries;
 169         struct pfctl_pool        rpool;
 170
 171         uint64_t                 evaluations;
 172         uint64_t                 packets[2];
 173         uint64_t                 bytes[2];
 174
 175         struct pfi_kif          *kif;
 176         struct pfctl_anchor     *anchor;
 177         struct pfr_ktable       *overload_tbl;
 178
 179         pf_osfp_t                os_fingerprint;
 180
 181         int                      rtableid;
 182         uint32_t                 timeout[PFTM_MAX];
 183         uint32_t                 max_states;
 184         uint32_t                 max_src_nodes;
 185         uint32_t                 max_src_states;
 186         uint32_t                 max_src_conn;
 187         struct {
 188                 uint32_t                limit;
 189                 uint32_t                seconds;
 190         }                        max_src_conn_rate;
 191         uint32_t                 qid;
 192         uint32_t                 pqid;
 193         uint16_t                 dnpipe;
 194         uint16_t                 dnrpipe;
 195         uint32_t                 free_flags;
 196         uint32_t                 nr;
 197         uint32_t                 prob;
 198         uid_t                    cuid;
 199         pid_t                    cpid;
 200
 201         uint64_t                 states_cur;
 202         uint64_t                 states_tot;
 203         uint64_t                 src_nodes;
 204
 205         uint16_t                 return_icmp;
 206         uint16_t                 return_icmp6;
 207         uint16_t                 max_mss;
 208         uint16_t                 tag;
 209         uint16_t                 match_tag;
 210         uint16_t                 scrub_flags;
 211
 212         struct pf_rule_uid       uid;
 213         struct pf_rule_gid       gid;
 214
 215         uint32_t                 rule_flag;
 216         uint8_t                  action;
 217         uint8_t                  direction;
 218         uint8_t                  log;
 219         uint8_t                  logif;
 220         uint8_t                  quick;
 221         uint8_t                  ifnot;
 222         uint8_t                  match_tag_not;
 223         uint8_t                  natpass;
 224
 225         uint8_t                  keep_state;
 226         sa_family_t              af;
 227         uint8_t                  proto;
 228         uint8_t                  type;
 229         uint8_t                  code;
 230         uint8_t                  flags;
 231         uint8_t                  flagset;
 232         uint8_t                  min_ttl;
 233         uint8_t                  allow_opts;
 234         uint8_t                  rt;
 235         uint8_t                  return_ttl;
 236         uint8_t                  tos;
 237         uint8_t                  set_tos;
 238         uint8_t                  anchor_relative;
 239         uint8_t                  anchor_wildcard;
 240
 241         uint8_t                  flush;
 242         uint8_t                  prio;
 243         uint8_t                  set_prio[2];
 244
 245         struct {
 246                 struct pf_addr          addr;
 247                 uint16_t                port;
 248         }                       divert;
 249 };
 250
 251 TAILQ_HEAD(pfctl_rulequeue, pfctl_rule);
 252
 253 struct pfctl_ruleset {
 254         struct {
 255                 struct pfctl_rulequeue   queues[2];
 256                 struct {
 257                         struct pfctl_rulequeue  *ptr;
 258                         struct pfctl_rule       **ptr_array;
 259                         uint32_t                 rcount;
 260                         uint32_t                 ticket;
 261                         int                      open;
 262                 }                        active, inactive;
 263         }                        rules[PF_RULESET_MAX];
 264         struct pfctl_anchor     *anchor;
 265         uint32_t                 tticket;
 266         int                      tables;
 267         int                      topen;
 268 };
 269
 270 RB_HEAD(pfctl_anchor_global, pfctl_anchor);
 271 RB_HEAD(pfctl_anchor_node, pfctl_anchor);
 272 struct pfctl_anchor {
 273         RB_ENTRY(pfctl_anchor)   entry_global;
 274         RB_ENTRY(pfctl_anchor)   entry_node;
 275         struct pfctl_anchor     *parent;
 276         struct pfctl_anchor_node children;
 277         char                     name[PF_ANCHOR_NAME_SIZE];
 278         char                     path[MAXPATHLEN];
 279         struct pfctl_ruleset     ruleset;
 280         int                      refcnt;        /* anchor rules */
 281         int                      match; /* XXX: used for pfctl black magic */
 282 };
 283 RB_PROTOTYPE(pfctl_anchor_global, pfctl_anchor, entry_global,
 284     pf_anchor_compare);
 285 RB_PROTOTYPE(pfctl_anchor_node, pfctl_anchor, entry_node,
 286     pf_anchor_compare);
 287
 288 struct pfctl_state_cmp {
 289         uint64_t        id;
 290         uint32_t        creatorid;
 291         uint8_t         direction;
 292 };
 293
 294 struct pfctl_kill {
 295         struct pfctl_state_cmp  cmp;
 296         sa_family_t             af;
 297         int                     proto;
 298         struct pf_rule_addr     src;
 299         struct pf_rule_addr     dst;
 300         struct pf_rule_addr     rt_addr;
 301         char                    ifname[IFNAMSIZ];
 302         char                    label[PF_RULE_LABEL_SIZE];
 303         bool                    kill_match;
 304 };
 305
 306 struct pfctl_state_peer {
 307         uint32_t                         seqlo;
 308         uint32_t                         seqhi;
 309         uint32_t                         seqdiff;
 310         uint8_t                          state;
 311         uint8_t                          wscale;
 312 };
 313
 314 struct pfctl_state_key {
 315         struct pf_addr   addr[2];
 316         uint16_t         port[2];
 317         sa_family_t      af;
 318         uint8_t          proto;
 319 };
 320
 321 struct pfctl_state {
 322         TAILQ_ENTRY(pfctl_state)        entry;
 323
 324         uint64_t                 id;
 325         uint32_t                 creatorid;
 326         uint8_t                  direction;
 327
 328         struct pfctl_state_peer  src;
 329         struct pfctl_state_peer  dst;
 330
 331         uint32_t                 rule;
 332         uint32_t                 anchor;
 333         uint32_t                 nat_rule;
 334         struct pf_addr           rt_addr;
 335         struct pfctl_state_key   key[2];        /* addresses stack and wire  */
 336         char                     ifname[IFNAMSIZ];
 337         char                     orig_ifname[IFNAMSIZ];
 338         uint64_t                 packets[2];
 339         uint64_t                 bytes[2];
 340         uint32_t                 creation;
 341         uint32_t                 expire;
 342         uint32_t                 pfsync_time;
 343         uint8_t                  state_flags;
 344         uint32_t                 sync_flags;
 345 };
 346
 347 TAILQ_HEAD(pfctl_statelist, pfctl_state);
 348 struct pfctl_states {
 349         struct pfctl_statelist  states;
 350         size_t                  count;
 351 };
 352
 353 enum pfctl_syncookies_mode {
 354         PFCTL_SYNCOOKIES_NEVER,
 355         PFCTL_SYNCOOKIES_ALWAYS,
 356         PFCTL_SYNCOOKIES_ADAPTIVE
 357 };
 358 extern const char* PFCTL_SYNCOOKIES_MODE_NAMES[];
 359
 360 struct pfctl_syncookies {
 361         enum pfctl_syncookies_mode      mode;
 362         uint8_t                         highwater;      /* Percent */
 363         uint8_t                         lowwater;       /* Percent */
 364 };
 365
 366 struct pfctl_status* pfctl_get_status(int dev);
 367 void    pfctl_free_status(struct pfctl_status *status);
 368
 369 int     pfctl_get_eth_rulesets_info(int dev,
 370             struct pfctl_eth_rulesets_info *ri, const char *path);
 371 int     pfctl_get_eth_ruleset(int dev, const char *path, int nr,
 372             struct pfctl_eth_ruleset_info *ri);
 373 int     pfctl_get_eth_rules_info(int dev, struct pfctl_eth_rules_info *rules,
 374             const char *path);
 375 int     pfctl_get_eth_rule(int dev, uint32_t nr, uint32_t ticket,
 376             const char *path, struct pfctl_eth_rule *rule, bool clear,
 377             char *anchor_call);
 378 int     pfctl_add_eth_rule(int dev, const struct pfctl_eth_rule *r,
 379             const char *anchor, const char *anchor_call, uint32_t ticket);
 380 int     pfctl_get_rules_info(int dev, struct pfctl_rules_info *rules,
 381             uint32_t ruleset, const char *path);
 382 int     pfctl_get_rule(int dev, uint32_t nr, uint32_t ticket,
 383             const char *anchor, uint32_t ruleset, struct pfctl_rule *rule,
 384             char *anchor_call);
 385 int     pfctl_get_clear_rule(int dev, uint32_t nr, uint32_t ticket,
 386             const char *anchor, uint32_t ruleset, struct pfctl_rule *rule,
 387             char *anchor_call, bool clear);
 388 int     pfctl_add_rule(int dev, const struct pfctl_rule *r,
 389             const char *anchor, const char *anchor_call, uint32_t ticket,
 390             uint32_t pool_ticket);
 391 int     pfctl_set_keepcounters(int dev, bool keep);
 392 int     pfctl_get_states(int dev, struct pfctl_states *states);
 393 void    pfctl_free_states(struct pfctl_states *states);
 394 int     pfctl_clear_states(int dev, const struct pfctl_kill *kill,
 395             unsigned int *killed);
 396 int     pfctl_kill_states(int dev, const struct pfctl_kill *kill,
 397             unsigned int *killed);
 398 int     pfctl_clear_rules(int dev, const char *anchorname);
 399 int     pfctl_clear_nat(int dev, const char *anchorname);
 400 int     pfctl_clear_eth_rules(int dev, const char *anchorname);
 401 int     pfctl_set_syncookies(int dev, const struct pfctl_syncookies *s);
 402 int     pfctl_get_syncookies(int dev, struct pfctl_syncookies *s);
 403 int     pfctl_table_add_addrs(int dev, struct pfr_table *tbl, struct pfr_addr
 404             *addr, int size, int *nadd, int flags);
 405 int     pfctl_table_del_addrs(int dev, struct pfr_table *tbl, struct pfr_addr
 406             *addr, int size, int *ndel, int flags);
 407 int     pfctl_table_set_addrs(int dev, struct pfr_table *tbl, struct pfr_addr
 408             *addr, int size, int *size2, int *nadd, int *ndel, int *nchange,
 409             int flags);
 410 int     pfctl_table_get_addrs(int dev, struct pfr_table *tbl, struct pfr_addr
 411             *addr, int *size, int flags);
 412 #endif