ipfw2.h revision 332229 
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: stable/11/sbin/ipfw/ipfw2.h 332229 2018-04-07 20:27:11Z tuexen $
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
32struct 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
59extern 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 */
69struct _s_x {
70	char const *s;
71	int x;
72};
73
74extern struct _s_x f_ipdscp[];
75
76enum tokens {
77	TOK_NULL=0,
78
79	TOK_OR,
80	TOK_NOT,
81	TOK_STARTBRACE,
82	TOK_ENDBRACE,
83
84	TOK_ABORT6,
85	TOK_ABORT,
86	TOK_ACCEPT,
87	TOK_COUNT,
88	TOK_EACTION,
89	TOK_PIPE,
90	TOK_LINK,
91	TOK_QUEUE,
92	TOK_FLOWSET,
93	TOK_SCHED,
94	TOK_DIVERT,
95	TOK_TEE,
96	TOK_NETGRAPH,
97	TOK_NGTEE,
98	TOK_FORWARD,
99	TOK_SKIPTO,
100	TOK_DENY,
101	TOK_REJECT,
102	TOK_RESET,
103	TOK_UNREACH,
104	TOK_CHECKSTATE,
105	TOK_NAT,
106	TOK_REASS,
107	TOK_CALL,
108	TOK_RETURN,
109
110	TOK_ALTQ,
111	TOK_LOG,
112	TOK_TAG,
113	TOK_UNTAG,
114
115	TOK_TAGGED,
116	TOK_UID,
117	TOK_GID,
118	TOK_JAIL,
119	TOK_IN,
120	TOK_LIMIT,
121	TOK_KEEPSTATE,
122	TOK_LAYER2,
123	TOK_OUT,
124	TOK_DIVERTED,
125	TOK_DIVERTEDLOOPBACK,
126	TOK_DIVERTEDOUTPUT,
127	TOK_XMIT,
128	TOK_RECV,
129	TOK_VIA,
130	TOK_FRAG,
131	TOK_IPOPTS,
132	TOK_IPLEN,
133	TOK_IPID,
134	TOK_IPPRECEDENCE,
135	TOK_DSCP,
136	TOK_IPTOS,
137	TOK_IPTTL,
138	TOK_IPVER,
139	TOK_ESTAB,
140	TOK_SETUP,
141	TOK_TCPDATALEN,
142	TOK_TCPFLAGS,
143	TOK_TCPOPTS,
144	TOK_TCPSEQ,
145	TOK_TCPACK,
146	TOK_TCPWIN,
147	TOK_ICMPTYPES,
148	TOK_MAC,
149	TOK_MACTYPE,
150	TOK_VERREVPATH,
151	TOK_VERSRCREACH,
152	TOK_ANTISPOOF,
153	TOK_IPSEC,
154	TOK_COMMENT,
155
156	TOK_PLR,
157	TOK_NOERROR,
158	TOK_BUCKETS,
159	TOK_DSTIP,
160	TOK_SRCIP,
161	TOK_DSTPORT,
162	TOK_SRCPORT,
163	TOK_ALL,
164	TOK_MASK,
165	TOK_FLOW_MASK,
166	TOK_SCHED_MASK,
167	TOK_BW,
168	TOK_DELAY,
169	TOK_PROFILE,
170	TOK_BURST,
171	TOK_RED,
172	TOK_GRED,
173	TOK_ECN,
174	TOK_DROPTAIL,
175	TOK_PROTO,
176#ifdef NEW_AQM
177	/* AQM tokens*/
178	TOK_NO_ECN,
179	TOK_CODEL,
180	TOK_FQ_CODEL,
181	TOK_TARGET,
182	TOK_INTERVAL,
183	TOK_FLOWS,
184	TOK_QUANTUM,
185
186	TOK_PIE,
187	TOK_FQ_PIE,
188	TOK_TUPDATE,
189	TOK_MAX_BURST,
190	TOK_MAX_ECNTH,
191	TOK_ALPHA,
192	TOK_BETA,
193	TOK_CAPDROP,
194	TOK_NO_CAPDROP,
195	TOK_ONOFF,
196	TOK_DRE,
197	TOK_TS,
198	TOK_DERAND,
199	TOK_NO_DERAND,
200#endif
201	/* dummynet tokens */
202	TOK_WEIGHT,
203	TOK_LMAX,
204	TOK_PRI,
205	TOK_TYPE,
206	TOK_SLOTSIZE,
207
208	TOK_IP,
209	TOK_IF,
210	TOK_ALOG,
211	TOK_DENY_INC,
212	TOK_SAME_PORTS,
213	TOK_UNREG_ONLY,
214	TOK_SKIP_GLOBAL,
215	TOK_RESET_ADDR,
216	TOK_ALIAS_REV,
217	TOK_PROXY_ONLY,
218	TOK_REDIR_ADDR,
219	TOK_REDIR_PORT,
220	TOK_REDIR_PROTO,
221
222	TOK_IPV6,
223	TOK_FLOWID,
224	TOK_ICMP6TYPES,
225	TOK_EXT6HDR,
226	TOK_DSTIP6,
227	TOK_SRCIP6,
228
229	TOK_IPV4,
230	TOK_UNREACH6,
231	TOK_RESET6,
232
233	TOK_FIB,
234	TOK_SETFIB,
235	TOK_LOOKUP,
236	TOK_SOCKARG,
237	TOK_SETDSCP,
238	TOK_FLOW,
239	TOK_IFLIST,
240	/* Table tokens */
241	TOK_CREATE,
242	TOK_DESTROY,
243	TOK_LIST,
244	TOK_INFO,
245	TOK_DETAIL,
246	TOK_MODIFY,
247	TOK_FLUSH,
248	TOK_SWAP,
249	TOK_ADD,
250	TOK_DEL,
251	TOK_VALTYPE,
252	TOK_ALGO,
253	TOK_TALIST,
254	TOK_ATOMIC,
255	TOK_LOCK,
256	TOK_UNLOCK,
257	TOK_VLIST,
258	TOK_OLIST,
259
260	/* NAT64 tokens */
261	TOK_NAT64STL,
262	TOK_NAT64LSN,
263	TOK_STATS,
264	TOK_STATES,
265	TOK_CONFIG,
266	TOK_TABLE4,
267	TOK_TABLE6,
268	TOK_PREFIX4,
269	TOK_PREFIX6,
270	TOK_AGG_LEN,
271	TOK_AGG_COUNT,
272	TOK_MAX_PORTS,
273	TOK_JMAXLEN,
274	TOK_PORT_RANGE,
275	TOK_HOST_DEL_AGE,
276	TOK_PG_DEL_AGE,
277	TOK_TCP_SYN_AGE,
278	TOK_TCP_CLOSE_AGE,
279	TOK_TCP_EST_AGE,
280	TOK_UDP_AGE,
281	TOK_ICMP_AGE,
282	TOK_LOGOFF,
283
284	/* NPTv6 tokens */
285	TOK_NPTV6,
286	TOK_INTPREFIX,
287	TOK_EXTPREFIX,
288	TOK_PREFIXLEN,
289
290	TOK_TCPSETMSS,
291};
292
293/*
294 * the following macro returns an error message if we run out of
295 * arguments.
296 */
297#define NEED(_p, msg)      {if (!_p) errx(EX_USAGE, msg);}
298#define NEED1(msg)      {if (!(*av)) errx(EX_USAGE, msg);}
299
300struct buf_pr {
301	char	*buf;	/* allocated buffer */
302	char	*ptr;	/* current pointer */
303	size_t	size;	/* total buffer size */
304	size_t	avail;	/* available storage */
305	size_t	needed;	/* length needed */
306};
307
308int pr_u64(struct buf_pr *bp, uint64_t *pd, int width);
309int bp_alloc(struct buf_pr *b, size_t size);
310void bp_free(struct buf_pr *b);
311int bprintf(struct buf_pr *b, char *format, ...);
312
313
314/* memory allocation support */
315void *safe_calloc(size_t number, size_t size);
316void *safe_realloc(void *ptr, size_t size);
317
318/* string comparison functions used for historical compatibility */
319int _substrcmp(const char *str1, const char* str2);
320int _substrcmp2(const char *str1, const char* str2, const char* str3);
321int stringnum_cmp(const char *a, const char *b);
322
323/* utility functions */
324int match_token(struct _s_x *table, const char *string);
325int match_token_relaxed(struct _s_x *table, const char *string);
326int get_token(struct _s_x *table, const char *string, const char *errbase);
327char const *match_value(struct _s_x *p, int value);
328size_t concat_tokens(char *buf, size_t bufsize, struct _s_x *table,
329    char *delimiter);
330int fill_flags(struct _s_x *flags, char *p, char **e, uint32_t *set,
331    uint32_t *clear);
332void print_flags_buffer(char *buf, size_t sz, struct _s_x *list, uint32_t set);
333
334struct _ip_fw3_opheader;
335int do_cmd(int optname, void *optval, uintptr_t optlen);
336int do_set3(int optname, struct _ip_fw3_opheader *op3, size_t optlen);
337int do_get3(int optname, struct _ip_fw3_opheader *op3, size_t *optlen);
338
339struct in6_addr;
340void n2mask(struct in6_addr *mask, int n);
341int contigmask(uint8_t *p, int len);
342
343/*
344 * Forward declarations to avoid include way too many headers.
345 * C does not allow duplicated typedefs, so we use the base struct
346 * that the typedef points to.
347 * Should the typedefs use a different type, the compiler will
348 * still detect the change when compiling the body of the
349 * functions involved, so we do not lose error checking.
350 */
351struct _ipfw_insn;
352struct _ipfw_insn_altq;
353struct _ipfw_insn_u32;
354struct _ipfw_insn_ip6;
355struct _ipfw_insn_icmp6;
356
357/*
358 * The reserved set numer. This is a constant in ip_fw.h
359 * but we store it in a variable so other files do not depend
360 * in that header just for one constant.
361 */
362extern int resvd_set_number;
363
364/* first-level command handlers */
365void ipfw_add(char *av[]);
366void ipfw_show_nat(int ac, char **av);
367void ipfw_config_pipe(int ac, char **av);
368void ipfw_config_nat(int ac, char **av);
369void ipfw_sets_handler(char *av[]);
370void ipfw_table_handler(int ac, char *av[]);
371void ipfw_sysctl_handler(char *av[], int which);
372void ipfw_delete(char *av[]);
373void ipfw_flush(int force);
374void ipfw_zero(int ac, char *av[], int optname);
375void ipfw_list(int ac, char *av[], int show_counters);
376void ipfw_internal_handler(int ac, char *av[]);
377void ipfw_nat64lsn_handler(int ac, char *av[]);
378void ipfw_nat64stl_handler(int ac, char *av[]);
379void ipfw_nptv6_handler(int ac, char *av[]);
380int ipfw_check_object_name(const char *name);
381
382#ifdef PF
383/* altq.c */
384void altq_set_enabled(int enabled);
385u_int32_t altq_name_to_qid(const char *name);
386void print_altq_cmd(struct buf_pr *bp, struct _ipfw_insn_altq *altqptr);
387#else
388#define NO_ALTQ
389#endif
390
391/* dummynet.c */
392void dummynet_list(int ac, char *av[], int show_counters);
393void dummynet_flush(void);
394int ipfw_delete_pipe(int pipe_or_queue, int n);
395
396/* ipv6.c */
397void print_unreach6_code(struct buf_pr *bp, uint16_t code);
398void print_ip6(struct buf_pr *bp, struct _ipfw_insn_ip6 *cmd, char const *s);
399void print_flow6id(struct buf_pr *bp, struct _ipfw_insn_u32 *cmd);
400void print_icmp6types(struct buf_pr *bp, struct _ipfw_insn_u32 *cmd);
401void print_ext6hdr(struct buf_pr *bp, struct _ipfw_insn *cmd );
402
403struct tidx;
404struct _ipfw_insn *add_srcip6(struct _ipfw_insn *cmd, char *av, int cblen,
405    struct tidx *tstate);
406struct _ipfw_insn *add_dstip6(struct _ipfw_insn *cmd, char *av, int cblen,
407    struct tidx *tstate);
408
409void fill_flow6(struct _ipfw_insn_u32 *cmd, char *av, int cblen);
410void fill_unreach6_code(u_short *codep, char *str);
411void fill_icmp6types(struct _ipfw_insn_icmp6 *cmd, char *av, int cblen);
412int fill_ext6hdr(struct _ipfw_insn *cmd, char *av);
413
414/* ipfw2.c */
415void bp_flush(struct buf_pr *b);
416void fill_table(struct _ipfw_insn *cmd, char *av, uint8_t opcode,
417    struct tidx *tstate);
418
419/* tables.c */
420struct _ipfw_obj_ctlv;
421struct _ipfw_obj_ntlv;
422int table_check_name(const char *tablename);
423void ipfw_list_ta(int ac, char *av[]);
424void ipfw_list_values(int ac, char *av[]);
425void table_fill_ntlv(struct _ipfw_obj_ntlv *ntlv, const char *name,
426    uint8_t set, uint16_t uidx);
427
428