ipfw/ipfw2.h

   1 /*
   2  * Copyright (c) 2002-2003 Luigi Rizzo
   3  * Copyright (c) 1996 Alex Nash, Paul Traina, Poul-Henning Kamp
   4  * Copyright (c) 1994 Ugen J.S.Antsilevich
   5  *
   6  * Idea and grammar partially left from:
   7  * Copyright (c) 1993 Daniel Boulet
   8  *
   9  * Redistribution and use in source forms, with and without modification,
  10  * are permitted provided that this entire comment appears intact.
  11  *
  12  * Redistribution in binary form may occur without any restrictions.
  13  * Obviously, it would be nice if you gave credit where credit is due
  14  * but requiring it would be too onerous.
  15  *
  16  * This software is provided ``AS IS'' without any warranties of any kind.
  17  *
  18  * NEW command line interface for IP firewall facility
  19  *
  20  * $FreeBSD: head/sbin/ipfw/ipfw2.h 206843 2010-04-19 15:11:45Z luigi $
  21  */
  22
  23 /*
  24  * Options that can be set on the command line.
  25  * When reading commands from a file, a subset of the options can also
  26  * be applied globally by specifying them before the file name.
  27  * After that, each line can contain its own option that changes
  28  * the global value.
  29  * XXX The context is not restored after each line.
  30  */
  31
  32 struct cmdline_opts {
  33         /* boolean options: */
  34         int     do_value_as_ip; /* show table value as IP */
  35         int     do_resolv;      /* try to resolve all ip to names */
  36         int     do_time;        /* Show time stamps */
  37         int     do_quiet;       /* Be quiet in add and flush */
  38         int     do_pipe;        /* this cmd refers to a pipe/queue/sched */
  39         int     do_nat;         /* this cmd refers to a nat config */
  40         int     do_dynamic;     /* display dynamic rules */
  41         int     do_expired;     /* display expired dynamic rules */
  42         int     do_compact;     /* show rules in compact mode */
  43         int     do_force;       /* do not ask for confirmation */
  44         int     show_sets;      /* display the set each rule belongs to */
  45         int     test_only;      /* only check syntax */
  46         int     comment_only;   /* only print action and comment */
  47         int     verbose;        /* be verbose on some commands */
  48
  49         /* The options below can have multiple values. */
  50
  51         int     do_sort;        /* field to sort results (0 = no) */
  52                 /* valid fields are 1 and above */
  53
  54         int     use_set;        /* work with specified set number */
  55                 /* 0 means all sets, otherwise apply to set use_set - 1 */
  56
  57 };
  58
  59 extern struct cmdline_opts co;
  60
  61 /*
  62  * _s_x is a structure that stores a string <-> token pairs, used in
  63  * various places in the parser. Entries are stored in arrays,
  64  * with an entry with s=NULL as terminator.
  65  * The search routines are match_token() and match_value().
  66  * Often, an element with x=0 contains an error string.
  67  *
  68  */
  69 struct _s_x {
  70         char const *s;
  71         int x;
  72 };
  73
  74 enum tokens {
  75         TOK_NULL=0,
  76
  77         TOK_OR,
  78         TOK_NOT,
  79         TOK_STARTBRACE,
  80         TOK_ENDBRACE,
  81
  82         TOK_ACCEPT,
  83         TOK_COUNT,
  84         TOK_PIPE,
  85         TOK_LINK,
  86         TOK_QUEUE,
  87         TOK_FLOWSET,
  88         TOK_SCHED,
  89         TOK_DIVERT,
  90         TOK_TEE,
  91         TOK_NETGRAPH,
  92         TOK_NGTEE,
  93         TOK_FORWARD,
  94         TOK_SKIPTO,
  95         TOK_DENY,
  96         TOK_REJECT,
  97         TOK_RESET,
  98         TOK_UNREACH,
  99         TOK_CHECKSTATE,
 100         TOK_NAT,
 101         TOK_REASS,
 102
 103         TOK_ALTQ,
 104         TOK_LOG,
 105         TOK_TAG,
 106         TOK_UNTAG,
 107
 108         TOK_TAGGED,
 109         TOK_UID,
 110         TOK_GID,
 111         TOK_JAIL,
 112         TOK_IN,
 113         TOK_LIMIT,
 114         TOK_KEEPSTATE,
 115         TOK_LAYER2,
 116         TOK_OUT,
 117         TOK_DIVERTED,
 118         TOK_DIVERTEDLOOPBACK,
 119         TOK_DIVERTEDOUTPUT,
 120         TOK_XMIT,
 121         TOK_RECV,
 122         TOK_VIA,
 123         TOK_FRAG,
 124         TOK_IPOPTS,
 125         TOK_IPLEN,
 126         TOK_IPID,
 127         TOK_IPPRECEDENCE,
 128         TOK_DSCP,
 129         TOK_IPTOS,
 130         TOK_IPTTL,
 131         TOK_IPVER,
 132         TOK_ESTAB,
 133         TOK_SETUP,
 134         TOK_TCPDATALEN,
 135         TOK_TCPFLAGS,
 136         TOK_TCPOPTS,
 137         TOK_TCPSEQ,
 138         TOK_TCPACK,
 139         TOK_TCPWIN,
 140         TOK_ICMPTYPES,
 141         TOK_MAC,
 142         TOK_MACTYPE,
 143         TOK_VERREVPATH,
 144         TOK_VERSRCREACH,
 145         TOK_ANTISPOOF,
 146         TOK_IPSEC,
 147         TOK_COMMENT,
 148
 149         TOK_PLR,
 150         TOK_NOERROR,
 151         TOK_BUCKETS,
 152         TOK_DSTIP,
 153         TOK_SRCIP,
 154         TOK_DSTPORT,
 155         TOK_SRCPORT,
 156         TOK_ALL,
 157         TOK_MASK,
 158         TOK_FLOW_MASK,
 159         TOK_SCHED_MASK,
 160         TOK_BW,
 161         TOK_DELAY,
 162         TOK_PROFILE,
 163         TOK_BURST,
 164         TOK_RED,
 165         TOK_GRED,
 166         TOK_DROPTAIL,
 167         TOK_PROTO,
 168         /* dummynet tokens */
 169         TOK_WEIGHT,
 170         TOK_LMAX,
 171         TOK_PRI,
 172         TOK_TYPE,
 173         TOK_SLOTSIZE,
 174
 175         TOK_IP,
 176         TOK_IF,
 177         TOK_ALOG,
 178         TOK_DENY_INC,
 179         TOK_SAME_PORTS,
 180         TOK_UNREG_ONLY,
 181         TOK_RESET_ADDR,
 182         TOK_ALIAS_REV,
 183         TOK_PROXY_ONLY,
 184         TOK_REDIR_ADDR,
 185         TOK_REDIR_PORT,
 186         TOK_REDIR_PROTO,
 187
 188         TOK_IPV6,
 189         TOK_FLOWID,
 190         TOK_ICMP6TYPES,
 191         TOK_EXT6HDR,
 192         TOK_DSTIP6,
 193         TOK_SRCIP6,
 194
 195         TOK_IPV4,
 196         TOK_UNREACH6,
 197         TOK_RESET6,
 198
 199         TOK_FIB,
 200         TOK_SETFIB,
 201         TOK_LOOKUP,
 202 };
 203 /*
 204  * the following macro returns an error message if we run out of
 205  * arguments.
 206  */
 207 #define NEED(_p, msg)      {if (!_p) errx(EX_USAGE, msg);}
 208 #define NEED1(msg)      {if (!(*av)) errx(EX_USAGE, msg);}
 209
 210 int pr_u64(uint64_t *pd, int width);
 211
 212 /* memory allocation support */
 213 void *safe_calloc(size_t number, size_t size);
 214 void *safe_realloc(void *ptr, size_t size);
 215
 216 /* string comparison functions used for historical compatibility */
 217 int _substrcmp(const char *str1, const char* str2);
 218 int _substrcmp2(const char *str1, const char* str2, const char* str3);
 219
 220 /* utility functions */
 221 int match_token(struct _s_x *table, char *string);
 222 char const *match_value(struct _s_x *p, int value);
 223
 224 int do_cmd(int optname, void *optval, uintptr_t optlen);
 225
 226 struct in6_addr;
 227 void n2mask(struct in6_addr *mask, int n);
 228 int contigmask(uint8_t *p, int len);
 229
 230 /*
 231  * Forward declarations to avoid include way too many headers.
 232  * C does not allow duplicated typedefs, so we use the base struct
 233  * that the typedef points to.
 234  * Should the typedefs use a different type, the compiler will
 235  * still detect the change when compiling the body of the
 236  * functions involved, so we do not lose error checking.
 237  */
 238 struct _ipfw_insn;
 239 struct _ipfw_insn_altq;
 240 struct _ipfw_insn_u32;
 241 struct _ipfw_insn_ip6;
 242 struct _ipfw_insn_icmp6;
 243
 244 /*
 245  * The reserved set numer. This is a constant in ip_fw.h
 246  * but we store it in a variable so other files do not depend
 247  * in that header just for one constant.
 248  */
 249 extern int resvd_set_number;
 250
 251 /* first-level command handlers */
 252 void ipfw_add(char *av[]);
 253 void ipfw_show_nat(int ac, char **av);
 254 void ipfw_config_pipe(int ac, char **av);
 255 void ipfw_config_nat(int ac, char **av);
 256 void ipfw_sets_handler(char *av[]);
 257 void ipfw_table_handler(int ac, char *av[]);
 258 void ipfw_sysctl_handler(char *av[], int which);
 259 void ipfw_delete(char *av[]);
 260 void ipfw_flush(int force);
 261 void ipfw_zero(int ac, char *av[], int optname);
 262 void ipfw_list(int ac, char *av[], int show_counters);
 263
 264 /* altq.c */
 265 void altq_set_enabled(int enabled);
 266 u_int32_t altq_name_to_qid(const char *name);
 267
 268 void print_altq_cmd(struct _ipfw_insn_altq *altqptr);
 269
 270 /* dummynet.c */
 271 void dummynet_list(int ac, char *av[], int show_counters);
 272 void dummynet_flush(void);
 273 int ipfw_delete_pipe(int pipe_or_queue, int n);
 274
 275 /* ipv6.c */
 276 void print_unreach6_code(uint16_t code);
 277 void print_ip6(struct _ipfw_insn_ip6 *cmd, char const *s);
 278 void print_flow6id(struct _ipfw_insn_u32 *cmd);
 279 void print_icmp6types(struct _ipfw_insn_u32 *cmd);
 280 void print_ext6hdr(struct _ipfw_insn *cmd );
 281
 282 struct _ipfw_insn *add_srcip6(struct _ipfw_insn *cmd, char *av);
 283 struct _ipfw_insn *add_dstip6(struct _ipfw_insn *cmd, char *av);
 284
 285 void fill_flow6(struct _ipfw_insn_u32 *cmd, char *av );
 286 void fill_unreach6_code(u_short *codep, char *str);
 287 void fill_icmp6types(struct _ipfw_insn_icmp6 *cmd, char *av);
 288 int fill_ext6hdr(struct _ipfw_insn *cmd, char *av);