npfctl.h revision 1.49 1 /*-
2 * Copyright (c) 2009-2017 The NetBSD Foundation, Inc.
3 * All rights reserved.
4 *
5 * This material is based upon work partially supported by The
6 * NetBSD Foundation under a contract with Mindaugas Rasiukevicius.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 #ifndef _NPFCTL_H_
31 #define _NPFCTL_H_
32
33 #include <stdio.h>
34 #include <stdbool.h>
35 #include <inttypes.h>
36 #include <assert.h>
37 #include <util.h>
38
39 #define NPF_BPFCOP
40 #include <net/npf.h>
41
42 #define _NPF_PRIVATE
43 #include <npf.h>
44
45 #include "npf_var.h"
46
47 #define NPF_DEV_PATH "/dev/npf"
48 #define NPF_CONF_PATH "/etc/npf.conf"
49 #define NPF_DB_PATH "/var/db/npf.db"
50
51 typedef struct fam_addr_mask {
52 sa_family_t fam_family;
53 npf_addr_t fam_addr;
54 npf_netmask_t fam_mask;
55 unsigned long fam_ifindex;
56 } fam_addr_mask_t;
57
58 typedef struct ifnet_addr {
59 char * ifna_name;
60 unsigned long ifna_index;
61 sa_family_t ifna_family;
62 npfvar_t * ifna_filter;
63 npfvar_t * ifna_addrs;
64 } ifnet_addr_t;
65
66 typedef struct port_range {
67 in_port_t pr_start;
68 in_port_t pr_end;
69 } port_range_t;
70
71 typedef struct addr_port {
72 npfvar_t * ap_netaddr;
73 npfvar_t * ap_portrange;
74 } addr_port_t;
75
76 typedef struct filt_opts {
77 addr_port_t fo_from;
78 addr_port_t fo_to;
79 bool fo_finvert;
80 bool fo_tinvert;
81 } filt_opts_t;
82
83 typedef struct opt_proto {
84 int op_proto;
85 npfvar_t * op_opts;
86 } opt_proto_t;
87
88 typedef struct rule_group {
89 const char * rg_name;
90 uint32_t rg_attr;
91 const char * rg_ifname;
92 bool rg_default;
93 } rule_group_t;
94
95 typedef struct proc_call {
96 const char * pc_name;
97 npfvar_t * pc_opts;
98 } proc_call_t;
99
100 typedef struct proc_param {
101 const char * pp_param;
102 const char * pp_value;
103 } proc_param_t;
104
105 enum { NPFCTL_PARSE_FILE, NPFCTL_PARSE_STRING };
106
107 #define NPF_IFNET_TABLE_PREF ".ifnet-"
108 #define NPF_IFNET_TABLE_PREFLEN (sizeof(NPF_IFNET_TABLE_PREF) - 1)
109
110 bool join(char *, size_t, int, char **, const char *);
111 void yyerror(const char *, ...) __printflike(1, 2) __dead;
112 void npfctl_bpfjit(bool);
113 void npfctl_parse_file(const char *);
114 void npfctl_parse_string(const char *);
115
116 void npfctl_print_error(const npf_error_t *);
117 char * npfctl_print_addrmask(int, const char *, const npf_addr_t *,
118 npf_netmask_t);
119 void npfctl_note_interface(const char *);
120 unsigned npfctl_table_getid(const char *);
121 const char * npfctl_table_getname(nl_config_t *, unsigned, bool *);
122 int npfctl_protono(const char *);
123 in_port_t npfctl_portno(const char *);
124 uint8_t npfctl_icmpcode(int, uint8_t, const char *);
125 uint8_t npfctl_icmptype(int, const char *);
126 npfvar_t * npfctl_ifnet_table(const char *);
127 npfvar_t * npfctl_parse_ifnet(const char *, const int);
128 npfvar_t * npfctl_parse_tcpflag(const char *);
129 npfvar_t * npfctl_parse_table_id(const char *);
130 npfvar_t * npfctl_parse_icmp(int, int, int);
131 npfvar_t * npfctl_parse_port_range(in_port_t, in_port_t);
132 npfvar_t * npfctl_parse_port_range_variable(const char *, npfvar_t *);
133 npfvar_t * npfctl_parse_fam_addr_mask(const char *, const char *,
134 unsigned long *);
135 bool npfctl_parse_cidr(char *, fam_addr_mask_t *, int *);
136 uint16_t npfctl_npt66_calcadj(npf_netmask_t, const npf_addr_t *,
137 const npf_addr_t *);
138
139 /*
140 * NPF extension loading.
141 */
142
143 typedef struct npf_extmod npf_extmod_t;
144
145 npf_extmod_t * npf_extmod_get(const char *, nl_ext_t **);
146 int npf_extmod_param(npf_extmod_t *, nl_ext_t *,
147 const char *, const char *);
148
149 /*
150 * BFF byte-code generation interface.
151 */
152
153 typedef struct npf_bpf npf_bpf_t;
154
155 #define MATCH_DST 0x01
156 #define MATCH_SRC 0x02
157 #define MATCH_INVERT 0x04
158
159 enum {
160 BM_IPVER, BM_PROTO, BM_SRC_CIDR, BM_SRC_TABLE, BM_DST_CIDR,
161 BM_DST_TABLE, BM_SRC_PORTS, BM_DST_PORTS, BM_TCPFL, BM_ICMP_TYPE,
162 BM_ICMP_CODE,
163 };
164
165 npf_bpf_t * npfctl_bpf_create(void);
166 struct bpf_program *npfctl_bpf_complete(npf_bpf_t *);
167 const void * npfctl_bpf_bmarks(npf_bpf_t *, size_t *);
168 void npfctl_bpf_destroy(npf_bpf_t *);
169
170 void npfctl_bpf_group_enter(npf_bpf_t *);
171 void npfctl_bpf_group_exit(npf_bpf_t *, bool);
172
173 void npfctl_bpf_proto(npf_bpf_t *, sa_family_t, int);
174 void npfctl_bpf_cidr(npf_bpf_t *, u_int, sa_family_t,
175 const npf_addr_t *, const npf_netmask_t);
176 void npfctl_bpf_ports(npf_bpf_t *, u_int, in_port_t, in_port_t);
177 void npfctl_bpf_tcpfl(npf_bpf_t *, uint8_t, uint8_t, bool);
178 void npfctl_bpf_icmp(npf_bpf_t *, int, int);
179 void npfctl_bpf_table(npf_bpf_t *, u_int, u_int);
180
181 /*
182 * Configuration building interface.
183 */
184
185 #define NPFCTL_NAT_DYNAMIC 1
186 #define NPFCTL_NAT_STATIC 2
187
188 void npfctl_config_init(bool);
189 int npfctl_config_send(int);
190 nl_config_t * npfctl_config_ref(void);
191 int npfctl_config_show(int);
192 void npfctl_config_save(nl_config_t *, const char *);
193 void npfctl_config_debug(const char *);
194
195 void npfctl_show_init(void);
196 int npfctl_ruleset_show(int, const char *);
197
198 nl_rule_t * npfctl_rule_ref(void);
199 bool npfctl_debug_addif(const char *);
200
201 void npfctl_build_alg(const char *);
202 void npfctl_build_rproc(const char *, npfvar_t *);
203 void npfctl_build_group(const char *, int, const char *, bool);
204 void npfctl_build_group_end(void);
205 void npfctl_build_rule(uint32_t, const char *, sa_family_t,
206 const opt_proto_t *, const filt_opts_t *,
207 const char *, const char *);
208 void npfctl_build_natseg(int, int, unsigned, const char *,
209 const addr_port_t *, const addr_port_t *,
210 const opt_proto_t *, const filt_opts_t *, unsigned);
211 void npfctl_build_maprset(const char *, int, const char *);
212 void npfctl_build_table(const char *, u_int, const char *);
213
214 void npfctl_setparam(const char *, int);
215
216 /*
217 * For the systems which do not define TH_ECE and TW_CRW.
218 */
219 #ifndef TH_ECE
220 #define TH_ECE 0x40
221 #endif
222 #ifndef TH_CWR
223 #define TH_CWR 0x80
224 #endif
225
226 #endif
227