ipfw2.h revision 263086
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/10/sbin/ipfw/ipfw2.h 263086 2014-03-12 10:45:58Z glebius $
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
74enum 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	TOK_CALL,
103	TOK_RETURN,
104
105	TOK_ALTQ,
106	TOK_LOG,
107	TOK_TAG,
108	TOK_UNTAG,
109
110	TOK_TAGGED,
111	TOK_UID,
112	TOK_GID,
113	TOK_JAIL,
114	TOK_IN,
115	TOK_LIMIT,
116	TOK_KEEPSTATE,
117	TOK_LAYER2,
118	TOK_OUT,
119	TOK_DIVERTED,
120	TOK_DIVERTEDLOOPBACK,
121	TOK_DIVERTEDOUTPUT,
122	TOK_XMIT,
123	TOK_RECV,
124	TOK_VIA,
125	TOK_FRAG,
126	TOK_IPOPTS,
127	TOK_IPLEN,
128	TOK_IPID,
129	TOK_IPPRECEDENCE,
130	TOK_DSCP,
131	TOK_IPTOS,
132	TOK_IPTTL,
133	TOK_IPVER,
134	TOK_ESTAB,
135	TOK_SETUP,
136	TOK_TCPDATALEN,
137	TOK_TCPFLAGS,
138	TOK_TCPOPTS,
139	TOK_TCPSEQ,
140	TOK_TCPACK,
141	TOK_TCPWIN,
142	TOK_ICMPTYPES,
143	TOK_MAC,
144	TOK_MACTYPE,
145	TOK_VERREVPATH,
146	TOK_VERSRCREACH,
147	TOK_ANTISPOOF,
148	TOK_IPSEC,
149	TOK_COMMENT,
150
151	TOK_PLR,
152	TOK_NOERROR,
153	TOK_BUCKETS,
154	TOK_DSTIP,
155	TOK_SRCIP,
156	TOK_DSTPORT,
157	TOK_SRCPORT,
158	TOK_ALL,
159	TOK_MASK,
160	TOK_FLOW_MASK,
161	TOK_SCHED_MASK,
162	TOK_BW,
163	TOK_DELAY,
164	TOK_PROFILE,
165	TOK_BURST,
166	TOK_RED,
167	TOK_GRED,
168	TOK_DROPTAIL,
169	TOK_PROTO,
170	/* dummynet tokens */
171	TOK_WEIGHT,
172	TOK_LMAX,
173	TOK_PRI,
174	TOK_TYPE,
175	TOK_SLOTSIZE,
176
177	TOK_IP,
178	TOK_IF,
179 	TOK_ALOG,
180 	TOK_DENY_INC,
181 	TOK_SAME_PORTS,
182 	TOK_UNREG_ONLY,
183	TOK_SKIP_GLOBAL,
184 	TOK_RESET_ADDR,
185 	TOK_ALIAS_REV,
186 	TOK_PROXY_ONLY,
187	TOK_REDIR_ADDR,
188	TOK_REDIR_PORT,
189	TOK_REDIR_PROTO,
190
191	TOK_IPV6,
192	TOK_FLOWID,
193	TOK_ICMP6TYPES,
194	TOK_EXT6HDR,
195	TOK_DSTIP6,
196	TOK_SRCIP6,
197
198	TOK_IPV4,
199	TOK_UNREACH6,
200	TOK_RESET6,
201
202	TOK_FIB,
203	TOK_SETFIB,
204	TOK_LOOKUP,
205	TOK_SOCKARG,
206	TOK_SETDSCP,
207};
208/*
209 * the following macro returns an error message if we run out of
210 * arguments.
211 */
212#define NEED(_p, msg)      {if (!_p) errx(EX_USAGE, msg);}
213#define NEED1(msg)      {if (!(*av)) errx(EX_USAGE, msg);}
214
215int pr_u64(uint64_t *pd, int width);
216
217/* memory allocation support */
218void *safe_calloc(size_t number, size_t size);
219void *safe_realloc(void *ptr, size_t size);
220
221/* string comparison functions used for historical compatibility */
222int _substrcmp(const char *str1, const char* str2);
223int _substrcmp2(const char *str1, const char* str2, const char* str3);
224
225/* utility functions */
226int match_token(struct _s_x *table, char *string);
227char const *match_value(struct _s_x *p, int value);
228
229int do_cmd(int optname, void *optval, uintptr_t optlen);
230
231struct in6_addr;
232void n2mask(struct in6_addr *mask, int n);
233int contigmask(uint8_t *p, int len);
234
235/*
236 * Forward declarations to avoid include way too many headers.
237 * C does not allow duplicated typedefs, so we use the base struct
238 * that the typedef points to.
239 * Should the typedefs use a different type, the compiler will
240 * still detect the change when compiling the body of the
241 * functions involved, so we do not lose error checking.
242 */
243struct _ipfw_insn;
244struct _ipfw_insn_altq;
245struct _ipfw_insn_u32;
246struct _ipfw_insn_ip6;
247struct _ipfw_insn_icmp6;
248
249/*
250 * The reserved set numer. This is a constant in ip_fw.h
251 * but we store it in a variable so other files do not depend
252 * in that header just for one constant.
253 */
254extern int resvd_set_number;
255
256/* first-level command handlers */
257void ipfw_add(char *av[]);
258void ipfw_show_nat(int ac, char **av);
259void ipfw_config_pipe(int ac, char **av);
260void ipfw_config_nat(int ac, char **av);
261void ipfw_sets_handler(char *av[]);
262void ipfw_table_handler(int ac, char *av[]);
263void ipfw_sysctl_handler(char *av[], int which);
264void ipfw_delete(char *av[]);
265void ipfw_flush(int force);
266void ipfw_zero(int ac, char *av[], int optname);
267void ipfw_list(int ac, char *av[], int show_counters);
268
269#ifdef PF
270/* altq.c */
271void altq_set_enabled(int enabled);
272u_int32_t altq_name_to_qid(const char *name);
273void print_altq_cmd(struct _ipfw_insn_altq *altqptr);
274#else
275#define NO_ALTQ
276#endif
277
278/* dummynet.c */
279void dummynet_list(int ac, char *av[], int show_counters);
280void dummynet_flush(void);
281int ipfw_delete_pipe(int pipe_or_queue, int n);
282
283/* ipv6.c */
284void print_unreach6_code(uint16_t code);
285void print_ip6(struct _ipfw_insn_ip6 *cmd, char const *s);
286void print_flow6id(struct _ipfw_insn_u32 *cmd);
287void print_icmp6types(struct _ipfw_insn_u32 *cmd);
288void print_ext6hdr(struct _ipfw_insn *cmd );
289
290struct _ipfw_insn *add_srcip6(struct _ipfw_insn *cmd, char *av, int cblen);
291struct _ipfw_insn *add_dstip6(struct _ipfw_insn *cmd, char *av, int cblen);
292
293void fill_flow6(struct _ipfw_insn_u32 *cmd, char *av, int cblen);
294void fill_unreach6_code(u_short *codep, char *str);
295void fill_icmp6types(struct _ipfw_insn_icmp6 *cmd, char *av, int cblen);
296int fill_ext6hdr(struct _ipfw_insn *cmd, char *av);
297