ipfw2.h revision 316446
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 316446 2017-04-03 08:50:54Z 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_dynamic; /* display dynamic rules */ 41187767Sluigi int do_expired; /* display expired dynamic rules */ 42187767Sluigi int do_compact; /* show rules in compact mode */ 43187767Sluigi int do_force; /* do not ask for confirmation */ 44187767Sluigi int show_sets; /* display the set each rule belongs to */ 45187767Sluigi int test_only; /* only check syntax */ 46187767Sluigi int comment_only; /* only print action and comment */ 47187767Sluigi int verbose; /* be verbose on some commands */ 48187767Sluigi 49187767Sluigi /* The options below can have multiple values. */ 50187767Sluigi 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 59187767Sluigiextern struct cmdline_opts co; 60187767Sluigi 61187767Sluigi/* 62187767Sluigi * _s_x is a structure that stores a string <-> token pairs, used in 63187767Sluigi * various places in the parser. Entries are stored in arrays, 64187767Sluigi * with an entry with s=NULL as terminator. 65187767Sluigi * The search routines are match_token() and match_value(). 66187767Sluigi * Often, an element with x=0 contains an error string. 67187767Sluigi * 68187767Sluigi */ 69187767Sluigistruct _s_x { 70187767Sluigi char const *s; 71187767Sluigi int x; 72187767Sluigi}; 73187767Sluigi 74270424Smelifaroextern struct _s_x f_ipdscp[]; 75270424Smelifaro 76187769Sluigienum tokens { 77187769Sluigi TOK_NULL=0, 78187769Sluigi 79187769Sluigi TOK_OR, 80187769Sluigi TOK_NOT, 81187769Sluigi TOK_STARTBRACE, 82187769Sluigi TOK_ENDBRACE, 83187769Sluigi 84187769Sluigi TOK_ACCEPT, 85187769Sluigi TOK_COUNT, 86298016Sae TOK_EACTION, 87187769Sluigi TOK_PIPE, 88204591Sluigi TOK_LINK, 89187769Sluigi TOK_QUEUE, 90204591Sluigi TOK_FLOWSET, 91204591Sluigi TOK_SCHED, 92187769Sluigi TOK_DIVERT, 93187769Sluigi TOK_TEE, 94187769Sluigi TOK_NETGRAPH, 95187769Sluigi TOK_NGTEE, 96187769Sluigi TOK_FORWARD, 97187769Sluigi TOK_SKIPTO, 98187769Sluigi TOK_DENY, 99187769Sluigi TOK_REJECT, 100187769Sluigi TOK_RESET, 101187769Sluigi TOK_UNREACH, 102187769Sluigi TOK_CHECKSTATE, 103187769Sluigi TOK_NAT, 104190633Spiso TOK_REASS, 105223666Sae TOK_CALL, 106223666Sae TOK_RETURN, 107187769Sluigi 108187769Sluigi TOK_ALTQ, 109187769Sluigi TOK_LOG, 110187769Sluigi TOK_TAG, 111187769Sluigi TOK_UNTAG, 112187769Sluigi 113187769Sluigi TOK_TAGGED, 114187769Sluigi TOK_UID, 115187769Sluigi TOK_GID, 116187769Sluigi TOK_JAIL, 117187769Sluigi TOK_IN, 118187769Sluigi TOK_LIMIT, 119187769Sluigi TOK_KEEPSTATE, 120187769Sluigi TOK_LAYER2, 121187769Sluigi TOK_OUT, 122187769Sluigi TOK_DIVERTED, 123187769Sluigi TOK_DIVERTEDLOOPBACK, 124187769Sluigi TOK_DIVERTEDOUTPUT, 125187769Sluigi TOK_XMIT, 126187769Sluigi TOK_RECV, 127187769Sluigi TOK_VIA, 128187769Sluigi TOK_FRAG, 129187769Sluigi TOK_IPOPTS, 130187769Sluigi TOK_IPLEN, 131187769Sluigi TOK_IPID, 132187769Sluigi TOK_IPPRECEDENCE, 133205169Sluigi TOK_DSCP, 134187769Sluigi TOK_IPTOS, 135187769Sluigi TOK_IPTTL, 136187769Sluigi TOK_IPVER, 137187769Sluigi TOK_ESTAB, 138187769Sluigi TOK_SETUP, 139187769Sluigi TOK_TCPDATALEN, 140187769Sluigi TOK_TCPFLAGS, 141187769Sluigi TOK_TCPOPTS, 142187769Sluigi TOK_TCPSEQ, 143187769Sluigi TOK_TCPACK, 144187769Sluigi TOK_TCPWIN, 145187769Sluigi TOK_ICMPTYPES, 146187769Sluigi TOK_MAC, 147187769Sluigi TOK_MACTYPE, 148187769Sluigi TOK_VERREVPATH, 149187769Sluigi TOK_VERSRCREACH, 150187769Sluigi TOK_ANTISPOOF, 151187769Sluigi TOK_IPSEC, 152187769Sluigi TOK_COMMENT, 153187769Sluigi 154187769Sluigi TOK_PLR, 155187769Sluigi TOK_NOERROR, 156187769Sluigi TOK_BUCKETS, 157187769Sluigi TOK_DSTIP, 158187769Sluigi TOK_SRCIP, 159187769Sluigi TOK_DSTPORT, 160187769Sluigi TOK_SRCPORT, 161187769Sluigi TOK_ALL, 162187769Sluigi TOK_MASK, 163204591Sluigi TOK_FLOW_MASK, 164204591Sluigi TOK_SCHED_MASK, 165187769Sluigi TOK_BW, 166187769Sluigi TOK_DELAY, 167204591Sluigi TOK_PROFILE, 168194930Soleg TOK_BURST, 169187769Sluigi TOK_RED, 170187769Sluigi TOK_GRED, 171266941Shiren TOK_ECN, 172187769Sluigi TOK_DROPTAIL, 173187769Sluigi TOK_PROTO, 174300779Struckman#ifdef NEW_AQM 175300779Struckman /* AQM tokens*/ 176300779Struckman TOK_NO_ECN, 177300779Struckman TOK_CODEL, 178300779Struckman TOK_FQ_CODEL, 179300779Struckman TOK_TARGET, 180300779Struckman TOK_INTERVAL, 181300779Struckman TOK_FLOWS, 182300779Struckman TOK_QUANTUM, 183300779Struckman 184300779Struckman TOK_PIE, 185300779Struckman TOK_FQ_PIE, 186300779Struckman TOK_TUPDATE, 187300779Struckman TOK_MAX_BURST, 188300779Struckman TOK_MAX_ECNTH, 189300779Struckman TOK_ALPHA, 190300779Struckman TOK_BETA, 191300779Struckman TOK_CAPDROP, 192300779Struckman TOK_NO_CAPDROP, 193300779Struckman TOK_ONOFF, 194300779Struckman TOK_DRE, 195300779Struckman TOK_TS, 196300779Struckman TOK_DERAND, 197300779Struckman TOK_NO_DERAND, 198300779Struckman#endif 199204591Sluigi /* dummynet tokens */ 200187769Sluigi TOK_WEIGHT, 201204591Sluigi TOK_LMAX, 202204591Sluigi TOK_PRI, 203204591Sluigi TOK_TYPE, 204204591Sluigi TOK_SLOTSIZE, 205204591Sluigi 206187769Sluigi TOK_IP, 207187769Sluigi TOK_IF, 208187769Sluigi TOK_ALOG, 209187769Sluigi TOK_DENY_INC, 210187769Sluigi TOK_SAME_PORTS, 211187769Sluigi TOK_UNREG_ONLY, 212223080Sae TOK_SKIP_GLOBAL, 213187769Sluigi TOK_RESET_ADDR, 214187769Sluigi TOK_ALIAS_REV, 215187769Sluigi TOK_PROXY_ONLY, 216187769Sluigi TOK_REDIR_ADDR, 217187769Sluigi TOK_REDIR_PORT, 218220804Sglebius TOK_REDIR_PROTO, 219187769Sluigi 220187769Sluigi TOK_IPV6, 221187769Sluigi TOK_FLOWID, 222187769Sluigi TOK_ICMP6TYPES, 223187769Sluigi TOK_EXT6HDR, 224187769Sluigi TOK_DSTIP6, 225187769Sluigi TOK_SRCIP6, 226187769Sluigi 227187769Sluigi TOK_IPV4, 228187769Sluigi TOK_UNREACH6, 229187769Sluigi TOK_RESET6, 230187769Sluigi 231187769Sluigi TOK_FIB, 232187769Sluigi TOK_SETFIB, 233200567Sluigi TOK_LOOKUP, 234215179Sluigi TOK_SOCKARG, 235248552Smelifaro TOK_SETDSCP, 236272840Smelifaro TOK_FLOW, 237272840Smelifaro TOK_IFLIST, 238272840Smelifaro /* Table tokens */ 239272840Smelifaro TOK_CREATE, 240272840Smelifaro TOK_DESTROY, 241272840Smelifaro TOK_LIST, 242272840Smelifaro TOK_INFO, 243272840Smelifaro TOK_DETAIL, 244272840Smelifaro TOK_MODIFY, 245272840Smelifaro TOK_FLUSH, 246272840Smelifaro TOK_SWAP, 247272840Smelifaro TOK_ADD, 248272840Smelifaro TOK_DEL, 249272840Smelifaro TOK_VALTYPE, 250272840Smelifaro TOK_ALGO, 251272840Smelifaro TOK_TALIST, 252272840Smelifaro TOK_ATOMIC, 253272840Smelifaro TOK_LOCK, 254272840Smelifaro TOK_UNLOCK, 255272840Smelifaro TOK_VLIST, 256290330Sae TOK_OLIST, 257316446Sae 258316446Sae /* NAT64 tokens */ 259316446Sae TOK_NAT64STL, 260316446Sae TOK_NAT64LSN, 261316444Sae TOK_STATS, 262316446Sae TOK_STATES, 263316446Sae TOK_CONFIG, 264316446Sae TOK_TABLE4, 265316446Sae TOK_TABLE6, 266316446Sae TOK_PREFIX4, 267316446Sae TOK_PREFIX6, 268316446Sae TOK_AGG_LEN, 269316446Sae TOK_AGG_COUNT, 270316446Sae TOK_MAX_PORTS, 271316446Sae TOK_JMAXLEN, 272316446Sae TOK_PORT_RANGE, 273316446Sae TOK_HOST_DEL_AGE, 274316446Sae TOK_PG_DEL_AGE, 275316446Sae TOK_TCP_SYN_AGE, 276316446Sae TOK_TCP_CLOSE_AGE, 277316446Sae TOK_TCP_EST_AGE, 278316446Sae TOK_UDP_AGE, 279316446Sae TOK_ICMP_AGE, 280316446Sae TOK_LOGOFF, 281316444Sae 282316444Sae /* NPTv6 tokens */ 283316444Sae TOK_NPTV6, 284316444Sae TOK_INTPREFIX, 285316444Sae TOK_EXTPREFIX, 286316444Sae TOK_PREFIXLEN, 287187769Sluigi}; 288272840Smelifaro 289187767Sluigi/* 290187767Sluigi * the following macro returns an error message if we run out of 291187767Sluigi * arguments. 292187767Sluigi */ 293204591Sluigi#define NEED(_p, msg) {if (!_p) errx(EX_USAGE, msg);} 294204591Sluigi#define NEED1(msg) {if (!(*av)) errx(EX_USAGE, msg);} 295187767Sluigi 296270424Smelifarostruct buf_pr { 297270424Smelifaro char *buf; /* allocated buffer */ 298270424Smelifaro char *ptr; /* current pointer */ 299270424Smelifaro size_t size; /* total buffer size */ 300270424Smelifaro size_t avail; /* available storage */ 301270424Smelifaro size_t needed; /* length needed */ 302270424Smelifaro}; 303187787Sluigi 304270424Smelifaroint pr_u64(struct buf_pr *bp, uint64_t *pd, int width); 305270424Smelifaroint bp_alloc(struct buf_pr *b, size_t size); 306270424Smelifarovoid bp_free(struct buf_pr *b); 307270424Smelifaroint bprintf(struct buf_pr *b, char *format, ...); 308270424Smelifaro 309270424Smelifaro 310187767Sluigi/* memory allocation support */ 311187767Sluigivoid *safe_calloc(size_t number, size_t size); 312187767Sluigivoid *safe_realloc(void *ptr, size_t size); 313187767Sluigi 314187770Sluigi/* string comparison functions used for historical compatibility */ 315187767Sluigiint _substrcmp(const char *str1, const char* str2); 316187769Sluigiint _substrcmp2(const char *str1, const char* str2, const char* str3); 317272840Smelifaroint stringnum_cmp(const char *a, const char *b); 318187767Sluigi 319187770Sluigi/* utility functions */ 320298016Saeint match_token(struct _s_x *table, const char *string); 321298016Saeint match_token_relaxed(struct _s_x *table, const char *string); 322298016Saeint get_token(struct _s_x *table, const char *string, const char *errbase); 323187770Sluigichar const *match_value(struct _s_x *p, int value); 324272840Smelifarosize_t concat_tokens(char *buf, size_t bufsize, struct _s_x *table, 325272840Smelifaro char *delimiter); 326272840Smelifaroint fill_flags(struct _s_x *flags, char *p, char **e, uint32_t *set, 327272840Smelifaro uint32_t *clear); 328272840Smelifarovoid print_flags_buffer(char *buf, size_t sz, struct _s_x *list, uint32_t set); 329187770Sluigi 330272840Smelifarostruct _ip_fw3_opheader; 331187769Sluigiint do_cmd(int optname, void *optval, uintptr_t optlen); 332316274Saeint do_set3(int optname, struct _ip_fw3_opheader *op3, size_t optlen); 333272840Smelifaroint do_get3(int optname, struct _ip_fw3_opheader *op3, size_t *optlen); 334187769Sluigi 335187769Sluigistruct in6_addr; 336187769Sluigivoid n2mask(struct in6_addr *mask, int n); 337187770Sluigiint contigmask(uint8_t *p, int len); 338187769Sluigi 339187819Sluigi/* 340187819Sluigi * Forward declarations to avoid include way too many headers. 341187819Sluigi * C does not allow duplicated typedefs, so we use the base struct 342187819Sluigi * that the typedef points to. 343187819Sluigi * Should the typedefs use a different type, the compiler will 344187819Sluigi * still detect the change when compiling the body of the 345187819Sluigi * functions involved, so we do not lose error checking. 346187819Sluigi */ 347187819Sluigistruct _ipfw_insn; 348187983Sluigistruct _ipfw_insn_altq; 349187819Sluigistruct _ipfw_insn_u32; 350187819Sluigistruct _ipfw_insn_ip6; 351187819Sluigistruct _ipfw_insn_icmp6; 352187769Sluigi 353187767Sluigi/* 354187767Sluigi * The reserved set numer. This is a constant in ip_fw.h 355187767Sluigi * but we store it in a variable so other files do not depend 356187767Sluigi * in that header just for one constant. 357187767Sluigi */ 358187767Sluigiextern int resvd_set_number; 359187767Sluigi 360187770Sluigi/* first-level command handlers */ 361204591Sluigivoid ipfw_add(char *av[]); 362187767Sluigivoid ipfw_show_nat(int ac, char **av); 363187767Sluigivoid ipfw_config_pipe(int ac, char **av); 364187767Sluigivoid ipfw_config_nat(int ac, char **av); 365204591Sluigivoid ipfw_sets_handler(char *av[]); 366187767Sluigivoid ipfw_table_handler(int ac, char *av[]); 367204591Sluigivoid ipfw_sysctl_handler(char *av[], int which); 368204591Sluigivoid ipfw_delete(char *av[]); 369187767Sluigivoid ipfw_flush(int force); 370187767Sluigivoid ipfw_zero(int ac, char *av[], int optname); 371187767Sluigivoid ipfw_list(int ac, char *av[], int show_counters); 372272840Smelifarovoid ipfw_internal_handler(int ac, char *av[]); 373316446Saevoid ipfw_nat64lsn_handler(int ac, char *av[]); 374316446Saevoid ipfw_nat64stl_handler(int ac, char *av[]); 375316444Saevoid ipfw_nptv6_handler(int ac, char *av[]); 376298016Saeint ipfw_check_object_name(const char *name); 377187767Sluigi 378261797Sglebius#ifdef PF 379187983Sluigi/* altq.c */ 380187983Sluigivoid altq_set_enabled(int enabled); 381187983Sluigiu_int32_t altq_name_to_qid(const char *name); 382270424Smelifarovoid print_altq_cmd(struct buf_pr *bp, struct _ipfw_insn_altq *altqptr); 383261797Sglebius#else 384261797Sglebius#define NO_ALTQ 385261797Sglebius#endif 386187983Sluigi 387187770Sluigi/* dummynet.c */ 388204591Sluigivoid dummynet_list(int ac, char *av[], int show_counters); 389204591Sluigivoid dummynet_flush(void); 390187769Sluigiint ipfw_delete_pipe(int pipe_or_queue, int n); 391187769Sluigi 392187770Sluigi/* ipv6.c */ 393297981Saevoid print_unreach6_code(struct buf_pr *bp, uint16_t code); 394270424Smelifarovoid print_ip6(struct buf_pr *bp, struct _ipfw_insn_ip6 *cmd, char const *s); 395270424Smelifarovoid print_flow6id(struct buf_pr *bp, struct _ipfw_insn_u32 *cmd); 396270424Smelifarovoid print_icmp6types(struct buf_pr *bp, struct _ipfw_insn_u32 *cmd); 397270424Smelifarovoid print_ext6hdr(struct buf_pr *bp, struct _ipfw_insn *cmd ); 398187770Sluigi 399308970Saestruct tidx; 400308970Saestruct _ipfw_insn *add_srcip6(struct _ipfw_insn *cmd, char *av, int cblen, 401308970Sae struct tidx *tstate); 402308970Saestruct _ipfw_insn *add_dstip6(struct _ipfw_insn *cmd, char *av, int cblen, 403308970Sae struct tidx *tstate); 404187770Sluigi 405247712Smelifarovoid fill_flow6(struct _ipfw_insn_u32 *cmd, char *av, int cblen); 406187770Sluigivoid fill_unreach6_code(u_short *codep, char *str); 407247712Smelifarovoid fill_icmp6types(struct _ipfw_insn_icmp6 *cmd, char *av, int cblen); 408187819Sluigiint fill_ext6hdr(struct _ipfw_insn *cmd, char *av); 409272840Smelifaro 410302979Sae/* ipfw2.c */ 411302979Saevoid bp_flush(struct buf_pr *b); 412308970Saevoid fill_table(struct _ipfw_insn *cmd, char *av, uint8_t opcode, 413308970Sae struct tidx *tstate); 414302979Sae 415272840Smelifaro/* tables.c */ 416272840Smelifarostruct _ipfw_obj_ctlv; 417316446Saestruct _ipfw_obj_ntlv; 418298016Saeint table_check_name(const char *tablename); 419272840Smelifarovoid ipfw_list_ta(int ac, char *av[]); 420272840Smelifarovoid ipfw_list_values(int ac, char *av[]); 421316446Saevoid table_fill_ntlv(struct _ipfw_obj_ntlv *ntlv, const char *name, 422316446Sae uint8_t set, uint16_t uidx); 423272840Smelifaro 424