ipfw2.h revision 349573
1187767Sluigi/* 2187767Sluigi * Copyright (c) 2002-2003 Luigi Rizzo 3187767Sluigi * Copyright (c) 1996 Alex Nash, Paul Traina, Poul-Henning Kamp 4187767Sluigi * Copyright (c) 1994 Ugen J.S.Antsilevich 5187767Sluigi * 6187767Sluigi * Idea and grammar partially left from: 7187767Sluigi * Copyright (c) 1993 Daniel Boulet 8187767Sluigi * 9187767Sluigi * Redistribution and use in source forms, with and without modification, 10187767Sluigi * are permitted provided that this entire comment appears intact. 11187767Sluigi * 12187767Sluigi * Redistribution in binary form may occur without any restrictions. 13187767Sluigi * Obviously, it would be nice if you gave credit where credit is due 14187767Sluigi * but requiring it would be too onerous. 15187767Sluigi * 16187767Sluigi * This software is provided ``AS IS'' without any warranties of any kind. 17187767Sluigi * 18187767Sluigi * NEW command line interface for IP firewall facility 19187767Sluigi * 20187767Sluigi * $FreeBSD: stable/11/sbin/ipfw/ipfw2.h 349573 2019-07-01 10:03:38Z ae $ 21187767Sluigi */ 22187767Sluigi 23187767Sluigi/* 24187767Sluigi * Options that can be set on the command line. 25187767Sluigi * When reading commands from a file, a subset of the options can also 26187767Sluigi * be applied globally by specifying them before the file name. 27187767Sluigi * After that, each line can contain its own option that changes 28187767Sluigi * the global value. 29187767Sluigi * XXX The context is not restored after each line. 30187767Sluigi */ 31187767Sluigi 32187767Sluigistruct cmdline_opts { 33187767Sluigi /* boolean options: */ 34187767Sluigi int do_value_as_ip; /* show table value as IP */ 35187767Sluigi int do_resolv; /* try to resolve all ip to names */ 36187767Sluigi int do_time; /* Show time stamps */ 37187767Sluigi int do_quiet; /* Be quiet in add and flush */ 38204591Sluigi int do_pipe; /* this cmd refers to a pipe/queue/sched */ 39187767Sluigi int do_nat; /* this cmd refers to a nat config */ 40187767Sluigi int do_compact; /* show rules in compact mode */ 41187767Sluigi int do_force; /* do not ask for confirmation */ 42187767Sluigi int show_sets; /* display the set each rule belongs to */ 43187767Sluigi int test_only; /* only check syntax */ 44187767Sluigi int comment_only; /* only print action and comment */ 45187767Sluigi int verbose; /* be verbose on some commands */ 46187767Sluigi 47187767Sluigi /* The options below can have multiple values. */ 48187767Sluigi 49346205Sae int do_dynamic; /* 1 - display dynamic rules */ 50346205Sae /* 2 - display/delete only dynamic rules */ 51187767Sluigi int do_sort; /* field to sort results (0 = no) */ 52187767Sluigi /* valid fields are 1 and above */ 53187767Sluigi 54187767Sluigi int use_set; /* work with specified set number */ 55187767Sluigi /* 0 means all sets, otherwise apply to set use_set - 1 */ 56187767Sluigi 57187767Sluigi}; 58187767Sluigi 59332400Saeenum { 60332400Sae TIMESTAMP_NONE = 0, 61332400Sae TIMESTAMP_STRING, 62332400Sae TIMESTAMP_NUMERIC, 63332400Sae}; 64332400Sae 65187767Sluigiextern struct cmdline_opts co; 66187767Sluigi 67187767Sluigi/* 68187767Sluigi * _s_x is a structure that stores a string <-> token pairs, used in 69187767Sluigi * various places in the parser. Entries are stored in arrays, 70187767Sluigi * with an entry with s=NULL as terminator. 71187767Sluigi * The search routines are match_token() and match_value(). 72187767Sluigi * Often, an element with x=0 contains an error string. 73187767Sluigi * 74187767Sluigi */ 75187767Sluigistruct _s_x { 76187767Sluigi char const *s; 77187767Sluigi int x; 78187767Sluigi}; 79187767Sluigi 80270424Smelifaroextern struct _s_x f_ipdscp[]; 81270424Smelifaro 82187769Sluigienum tokens { 83187769Sluigi TOK_NULL=0, 84187769Sluigi 85187769Sluigi TOK_OR, 86187769Sluigi TOK_NOT, 87187769Sluigi TOK_STARTBRACE, 88187769Sluigi TOK_ENDBRACE, 89187769Sluigi 90332229Stuexen TOK_ABORT6, 91332229Stuexen TOK_ABORT, 92187769Sluigi TOK_ACCEPT, 93187769Sluigi TOK_COUNT, 94298016Sae TOK_EACTION, 95187769Sluigi TOK_PIPE, 96204591Sluigi TOK_LINK, 97187769Sluigi TOK_QUEUE, 98204591Sluigi TOK_FLOWSET, 99204591Sluigi TOK_SCHED, 100187769Sluigi TOK_DIVERT, 101187769Sluigi TOK_TEE, 102187769Sluigi TOK_NETGRAPH, 103187769Sluigi TOK_NGTEE, 104187769Sluigi TOK_FORWARD, 105187769Sluigi TOK_SKIPTO, 106187769Sluigi TOK_DENY, 107187769Sluigi TOK_REJECT, 108187769Sluigi TOK_RESET, 109187769Sluigi TOK_UNREACH, 110187769Sluigi TOK_CHECKSTATE, 111187769Sluigi TOK_NAT, 112190633Spiso TOK_REASS, 113223666Sae TOK_CALL, 114223666Sae TOK_RETURN, 115187769Sluigi 116187769Sluigi TOK_ALTQ, 117187769Sluigi TOK_LOG, 118187769Sluigi TOK_TAG, 119187769Sluigi TOK_UNTAG, 120187769Sluigi 121187769Sluigi TOK_TAGGED, 122187769Sluigi TOK_UID, 123187769Sluigi TOK_GID, 124187769Sluigi TOK_JAIL, 125187769Sluigi TOK_IN, 126187769Sluigi TOK_LIMIT, 127337461Sae TOK_SETLIMIT, 128187769Sluigi TOK_KEEPSTATE, 129337461Sae TOK_RECORDSTATE, 130187769Sluigi TOK_LAYER2, 131187769Sluigi TOK_OUT, 132187769Sluigi TOK_DIVERTED, 133187769Sluigi TOK_DIVERTEDLOOPBACK, 134187769Sluigi TOK_DIVERTEDOUTPUT, 135187769Sluigi TOK_XMIT, 136187769Sluigi TOK_RECV, 137187769Sluigi TOK_VIA, 138187769Sluigi TOK_FRAG, 139187769Sluigi TOK_IPOPTS, 140187769Sluigi TOK_IPLEN, 141187769Sluigi TOK_IPID, 142187769Sluigi TOK_IPPRECEDENCE, 143205169Sluigi TOK_DSCP, 144187769Sluigi TOK_IPTOS, 145187769Sluigi TOK_IPTTL, 146187769Sluigi TOK_IPVER, 147187769Sluigi TOK_ESTAB, 148187769Sluigi TOK_SETUP, 149187769Sluigi TOK_TCPDATALEN, 150187769Sluigi TOK_TCPFLAGS, 151187769Sluigi TOK_TCPOPTS, 152187769Sluigi TOK_TCPSEQ, 153187769Sluigi TOK_TCPACK, 154349573Sae TOK_TCPMSS, 155187769Sluigi TOK_TCPWIN, 156187769Sluigi TOK_ICMPTYPES, 157187769Sluigi TOK_MAC, 158187769Sluigi TOK_MACTYPE, 159187769Sluigi TOK_VERREVPATH, 160187769Sluigi TOK_VERSRCREACH, 161187769Sluigi TOK_ANTISPOOF, 162187769Sluigi TOK_IPSEC, 163187769Sluigi TOK_COMMENT, 164187769Sluigi 165187769Sluigi TOK_PLR, 166187769Sluigi TOK_NOERROR, 167187769Sluigi TOK_BUCKETS, 168187769Sluigi TOK_DSTIP, 169187769Sluigi TOK_SRCIP, 170187769Sluigi TOK_DSTPORT, 171187769Sluigi TOK_SRCPORT, 172187769Sluigi TOK_ALL, 173187769Sluigi TOK_MASK, 174204591Sluigi TOK_FLOW_MASK, 175204591Sluigi TOK_SCHED_MASK, 176187769Sluigi TOK_BW, 177187769Sluigi TOK_DELAY, 178204591Sluigi TOK_PROFILE, 179194930Soleg TOK_BURST, 180187769Sluigi TOK_RED, 181187769Sluigi TOK_GRED, 182266941Shiren TOK_ECN, 183187769Sluigi TOK_DROPTAIL, 184187769Sluigi TOK_PROTO, 185300779Struckman#ifdef NEW_AQM 186300779Struckman /* AQM tokens*/ 187300779Struckman TOK_NO_ECN, 188300779Struckman TOK_CODEL, 189300779Struckman TOK_FQ_CODEL, 190300779Struckman TOK_TARGET, 191300779Struckman TOK_INTERVAL, 192300779Struckman TOK_FLOWS, 193300779Struckman TOK_QUANTUM, 194300779Struckman 195300779Struckman TOK_PIE, 196300779Struckman TOK_FQ_PIE, 197300779Struckman TOK_TUPDATE, 198300779Struckman TOK_MAX_BURST, 199300779Struckman TOK_MAX_ECNTH, 200300779Struckman TOK_ALPHA, 201300779Struckman TOK_BETA, 202300779Struckman TOK_CAPDROP, 203300779Struckman TOK_NO_CAPDROP, 204300779Struckman TOK_ONOFF, 205300779Struckman TOK_DRE, 206300779Struckman TOK_TS, 207300779Struckman TOK_DERAND, 208300779Struckman TOK_NO_DERAND, 209300779Struckman#endif 210204591Sluigi /* dummynet tokens */ 211187769Sluigi TOK_WEIGHT, 212204591Sluigi TOK_LMAX, 213204591Sluigi TOK_PRI, 214204591Sluigi TOK_TYPE, 215204591Sluigi TOK_SLOTSIZE, 216204591Sluigi 217187769Sluigi TOK_IP, 218187769Sluigi TOK_IF, 219332210Stuexen TOK_ALOG, 220332210Stuexen TOK_DENY_INC, 221332210Stuexen TOK_SAME_PORTS, 222332210Stuexen TOK_UNREG_ONLY, 223223080Sae TOK_SKIP_GLOBAL, 224332210Stuexen TOK_RESET_ADDR, 225332210Stuexen TOK_ALIAS_REV, 226332210Stuexen TOK_PROXY_ONLY, 227187769Sluigi TOK_REDIR_ADDR, 228187769Sluigi TOK_REDIR_PORT, 229220804Sglebius TOK_REDIR_PROTO, 230187769Sluigi 231187769Sluigi TOK_IPV6, 232187769Sluigi TOK_FLOWID, 233187769Sluigi TOK_ICMP6TYPES, 234187769Sluigi TOK_EXT6HDR, 235187769Sluigi TOK_DSTIP6, 236187769Sluigi TOK_SRCIP6, 237187769Sluigi 238187769Sluigi TOK_IPV4, 239187769Sluigi TOK_UNREACH6, 240187769Sluigi TOK_RESET6, 241187769Sluigi 242187769Sluigi TOK_FIB, 243187769Sluigi TOK_SETFIB, 244200567Sluigi TOK_LOOKUP, 245215179Sluigi TOK_SOCKARG, 246248552Smelifaro TOK_SETDSCP, 247272840Smelifaro TOK_FLOW, 248272840Smelifaro TOK_IFLIST, 249272840Smelifaro /* Table tokens */ 250272840Smelifaro TOK_CREATE, 251272840Smelifaro TOK_DESTROY, 252272840Smelifaro TOK_LIST, 253272840Smelifaro TOK_INFO, 254272840Smelifaro TOK_DETAIL, 255272840Smelifaro TOK_MODIFY, 256272840Smelifaro TOK_FLUSH, 257272840Smelifaro TOK_SWAP, 258272840Smelifaro TOK_ADD, 259272840Smelifaro TOK_DEL, 260272840Smelifaro TOK_VALTYPE, 261272840Smelifaro TOK_ALGO, 262272840Smelifaro TOK_TALIST, 263272840Smelifaro TOK_ATOMIC, 264272840Smelifaro TOK_LOCK, 265272840Smelifaro TOK_UNLOCK, 266272840Smelifaro TOK_VLIST, 267290330Sae TOK_OLIST, 268316446Sae 269316446Sae /* NAT64 tokens */ 270316446Sae TOK_NAT64STL, 271316446Sae TOK_NAT64LSN, 272316444Sae TOK_STATS, 273316446Sae TOK_STATES, 274316446Sae TOK_CONFIG, 275316446Sae TOK_TABLE4, 276316446Sae TOK_TABLE6, 277316446Sae TOK_PREFIX4, 278316446Sae TOK_PREFIX6, 279316446Sae TOK_AGG_LEN, 280316446Sae TOK_AGG_COUNT, 281316446Sae TOK_MAX_PORTS, 282316446Sae TOK_JMAXLEN, 283316446Sae TOK_PORT_RANGE, 284316446Sae TOK_HOST_DEL_AGE, 285316446Sae TOK_PG_DEL_AGE, 286316446Sae TOK_TCP_SYN_AGE, 287316446Sae TOK_TCP_CLOSE_AGE, 288316446Sae TOK_TCP_EST_AGE, 289316446Sae TOK_UDP_AGE, 290316446Sae TOK_ICMP_AGE, 291316446Sae TOK_LOGOFF, 292346210Sae TOK_PRIVATE, 293346210Sae TOK_PRIVATEOFF, 294316444Sae 295346212Sae /* NAT64 CLAT tokens */ 296346212Sae TOK_NAT64CLAT, 297346212Sae TOK_PLAT_PREFIX, 298346212Sae TOK_CLAT_PREFIX, 299346212Sae 300316444Sae /* NPTv6 tokens */ 301316444Sae TOK_NPTV6, 302316444Sae TOK_INTPREFIX, 303316444Sae TOK_EXTPREFIX, 304316444Sae TOK_PREFIXLEN, 305317045Sae 306317045Sae TOK_TCPSETMSS, 307337461Sae 308337461Sae TOK_SKIPACTION, 309187769Sluigi}; 310272840Smelifaro 311187767Sluigi/* 312187767Sluigi * the following macro returns an error message if we run out of 313187767Sluigi * arguments. 314187767Sluigi */ 315204591Sluigi#define NEED(_p, msg) {if (!_p) errx(EX_USAGE, msg);} 316204591Sluigi#define NEED1(msg) {if (!(*av)) errx(EX_USAGE, msg);} 317187767Sluigi 318270424Smelifarostruct buf_pr { 319270424Smelifaro char *buf; /* allocated buffer */ 320270424Smelifaro char *ptr; /* current pointer */ 321270424Smelifaro size_t size; /* total buffer size */ 322270424Smelifaro size_t avail; /* available storage */ 323270424Smelifaro size_t needed; /* length needed */ 324270424Smelifaro}; 325187787Sluigi 326270424Smelifaroint pr_u64(struct buf_pr *bp, uint64_t *pd, int width); 327270424Smelifaroint bp_alloc(struct buf_pr *b, size_t size); 328270424Smelifarovoid bp_free(struct buf_pr *b); 329270424Smelifaroint bprintf(struct buf_pr *b, char *format, ...); 330270424Smelifaro 331270424Smelifaro 332187767Sluigi/* memory allocation support */ 333187767Sluigivoid *safe_calloc(size_t number, size_t size); 334187767Sluigivoid *safe_realloc(void *ptr, size_t size); 335187767Sluigi 336187770Sluigi/* string comparison functions used for historical compatibility */ 337187767Sluigiint _substrcmp(const char *str1, const char* str2); 338187769Sluigiint _substrcmp2(const char *str1, const char* str2, const char* str3); 339272840Smelifaroint stringnum_cmp(const char *a, const char *b); 340187767Sluigi 341187770Sluigi/* utility functions */ 342298016Saeint match_token(struct _s_x *table, const char *string); 343298016Saeint match_token_relaxed(struct _s_x *table, const char *string); 344298016Saeint get_token(struct _s_x *table, const char *string, const char *errbase); 345187770Sluigichar const *match_value(struct _s_x *p, int value); 346272840Smelifarosize_t concat_tokens(char *buf, size_t bufsize, struct _s_x *table, 347272840Smelifaro char *delimiter); 348272840Smelifaroint fill_flags(struct _s_x *flags, char *p, char **e, uint32_t *set, 349272840Smelifaro uint32_t *clear); 350272840Smelifarovoid print_flags_buffer(char *buf, size_t sz, struct _s_x *list, uint32_t set); 351187770Sluigi 352272840Smelifarostruct _ip_fw3_opheader; 353187769Sluigiint do_cmd(int optname, void *optval, uintptr_t optlen); 354316274Saeint do_set3(int optname, struct _ip_fw3_opheader *op3, size_t optlen); 355272840Smelifaroint do_get3(int optname, struct _ip_fw3_opheader *op3, size_t *optlen); 356187769Sluigi 357187769Sluigistruct in6_addr; 358187769Sluigivoid n2mask(struct in6_addr *mask, int n); 359187770Sluigiint contigmask(uint8_t *p, int len); 360187769Sluigi 361187819Sluigi/* 362187819Sluigi * Forward declarations to avoid include way too many headers. 363187819Sluigi * C does not allow duplicated typedefs, so we use the base struct 364187819Sluigi * that the typedef points to. 365187819Sluigi * Should the typedefs use a different type, the compiler will 366187819Sluigi * still detect the change when compiling the body of the 367187819Sluigi * functions involved, so we do not lose error checking. 368187819Sluigi */ 369187819Sluigistruct _ipfw_insn; 370187983Sluigistruct _ipfw_insn_altq; 371187819Sluigistruct _ipfw_insn_u32; 372187819Sluigistruct _ipfw_insn_ip6; 373187819Sluigistruct _ipfw_insn_icmp6; 374187769Sluigi 375187767Sluigi/* 376187767Sluigi * The reserved set numer. This is a constant in ip_fw.h 377187767Sluigi * but we store it in a variable so other files do not depend 378187767Sluigi * in that header just for one constant. 379187767Sluigi */ 380187767Sluigiextern int resvd_set_number; 381187767Sluigi 382187770Sluigi/* first-level command handlers */ 383204591Sluigivoid ipfw_add(char *av[]); 384187767Sluigivoid ipfw_show_nat(int ac, char **av); 385187767Sluigivoid ipfw_config_pipe(int ac, char **av); 386187767Sluigivoid ipfw_config_nat(int ac, char **av); 387204591Sluigivoid ipfw_sets_handler(char *av[]); 388187767Sluigivoid ipfw_table_handler(int ac, char *av[]); 389204591Sluigivoid ipfw_sysctl_handler(char *av[], int which); 390204591Sluigivoid ipfw_delete(char *av[]); 391187767Sluigivoid ipfw_flush(int force); 392187767Sluigivoid ipfw_zero(int ac, char *av[], int optname); 393187767Sluigivoid ipfw_list(int ac, char *av[], int show_counters); 394272840Smelifarovoid ipfw_internal_handler(int ac, char *av[]); 395346212Saevoid ipfw_nat64clat_handler(int ac, char *av[]); 396316446Saevoid ipfw_nat64lsn_handler(int ac, char *av[]); 397316446Saevoid ipfw_nat64stl_handler(int ac, char *av[]); 398316444Saevoid ipfw_nptv6_handler(int ac, char *av[]); 399298016Saeint ipfw_check_object_name(const char *name); 400334836Saeint ipfw_check_nat64prefix(const struct in6_addr *prefix, int length); 401187767Sluigi 402261797Sglebius#ifdef PF 403187983Sluigi/* altq.c */ 404187983Sluigivoid altq_set_enabled(int enabled); 405187983Sluigiu_int32_t altq_name_to_qid(const char *name); 406270424Smelifarovoid print_altq_cmd(struct buf_pr *bp, struct _ipfw_insn_altq *altqptr); 407261797Sglebius#else 408261797Sglebius#define NO_ALTQ 409261797Sglebius#endif 410187983Sluigi 411187770Sluigi/* dummynet.c */ 412204591Sluigivoid dummynet_list(int ac, char *av[], int show_counters); 413204591Sluigivoid dummynet_flush(void); 414187769Sluigiint ipfw_delete_pipe(int pipe_or_queue, int n); 415187769Sluigi 416187770Sluigi/* ipv6.c */ 417297981Saevoid print_unreach6_code(struct buf_pr *bp, uint16_t code); 418332763Saevoid print_ip6(struct buf_pr *bp, struct _ipfw_insn_ip6 *cmd); 419270424Smelifarovoid print_flow6id(struct buf_pr *bp, struct _ipfw_insn_u32 *cmd); 420270424Smelifarovoid print_icmp6types(struct buf_pr *bp, struct _ipfw_insn_u32 *cmd); 421270424Smelifarovoid print_ext6hdr(struct buf_pr *bp, struct _ipfw_insn *cmd ); 422187770Sluigi 423308970Saestruct tidx; 424308970Saestruct _ipfw_insn *add_srcip6(struct _ipfw_insn *cmd, char *av, int cblen, 425308970Sae struct tidx *tstate); 426308970Saestruct _ipfw_insn *add_dstip6(struct _ipfw_insn *cmd, char *av, int cblen, 427308970Sae struct tidx *tstate); 428187770Sluigi 429247712Smelifarovoid fill_flow6(struct _ipfw_insn_u32 *cmd, char *av, int cblen); 430187770Sluigivoid fill_unreach6_code(u_short *codep, char *str); 431247712Smelifarovoid fill_icmp6types(struct _ipfw_insn_icmp6 *cmd, char *av, int cblen); 432187819Sluigiint fill_ext6hdr(struct _ipfw_insn *cmd, char *av); 433272840Smelifaro 434302979Sae/* ipfw2.c */ 435302979Saevoid bp_flush(struct buf_pr *b); 436308970Saevoid fill_table(struct _ipfw_insn *cmd, char *av, uint8_t opcode, 437308970Sae struct tidx *tstate); 438302979Sae 439272840Smelifaro/* tables.c */ 440272840Smelifarostruct _ipfw_obj_ctlv; 441316446Saestruct _ipfw_obj_ntlv; 442298016Saeint table_check_name(const char *tablename); 443272840Smelifarovoid ipfw_list_ta(int ac, char *av[]); 444272840Smelifarovoid ipfw_list_values(int ac, char *av[]); 445316446Saevoid table_fill_ntlv(struct _ipfw_obj_ntlv *ntlv, const char *name, 446316446Sae uint8_t set, uint16_t uidx); 447272840Smelifaro 448