Home | History | Annotate | Line # | Download | only in npfctl
npfctl.h revision 1.52
      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 typedef enum {
    106 	NPFCTL_PARSE_DEFAULT,
    107 	NPFCTL_PARSE_RULE,
    108 	NPFCTL_PARSE_MAP
    109 } parse_entry_t;
    110 
    111 #define	NPF_IFNET_TABLE_PREF		".ifnet-"
    112 #define	NPF_IFNET_TABLE_PREFLEN		(sizeof(NPF_IFNET_TABLE_PREF) - 1)
    113 
    114 bool		join(char *, size_t, int, char **, const char *);
    115 void		yyerror(const char *, ...) __printflike(1, 2) __dead;
    116 void		npfctl_bpfjit(bool);
    117 void		npfctl_parse_file(const char *);
    118 void		npfctl_parse_string(const char *, parse_entry_t);
    119 
    120 void		npfctl_print_error(const npf_error_t *);
    121 char *		npfctl_print_addrmask(int, const char *, const npf_addr_t *,
    122 		    npf_netmask_t);
    123 void		npfctl_note_interface(const char *);
    124 nl_table_t *	npfctl_table_getbyname(nl_config_t *, const char *);
    125 unsigned	npfctl_table_getid(const char *);
    126 const char *	npfctl_table_getname(nl_config_t *, unsigned, bool *);
    127 int		npfctl_protono(const char *);
    128 in_port_t	npfctl_portno(const char *);
    129 uint8_t		npfctl_icmpcode(int, uint8_t, const char *);
    130 uint8_t		npfctl_icmptype(int, const char *);
    131 npfvar_t *	npfctl_ifnet_table(const char *);
    132 npfvar_t *	npfctl_parse_ifnet(const char *, const int);
    133 npfvar_t *	npfctl_parse_tcpflag(const char *);
    134 npfvar_t *	npfctl_parse_table_id(const char *);
    135 npfvar_t * 	npfctl_parse_icmp(int, int, int);
    136 npfvar_t *	npfctl_parse_port_range(in_port_t, in_port_t);
    137 npfvar_t *	npfctl_parse_port_range_variable(const char *, npfvar_t *);
    138 npfvar_t *	npfctl_parse_fam_addr_mask(const char *, const char *,
    139 		    unsigned long *);
    140 bool		npfctl_parse_cidr(char *, fam_addr_mask_t *, int *);
    141 uint16_t	npfctl_npt66_calcadj(npf_netmask_t, const npf_addr_t *,
    142 		    const npf_addr_t *);
    143 int		npfctl_nat_ruleset_p(const char *, bool *);
    144 
    145 /*
    146  * NPF extension loading.
    147  */
    148 
    149 typedef struct npf_extmod npf_extmod_t;
    150 
    151 npf_extmod_t *	npf_extmod_get(const char *, nl_ext_t **);
    152 int		npf_extmod_param(npf_extmod_t *, nl_ext_t *,
    153 		    const char *, const char *);
    154 
    155 /*
    156  * BFF byte-code generation interface.
    157  */
    158 
    159 typedef struct npf_bpf npf_bpf_t;
    160 
    161 #define	MATCH_DST	0x01
    162 #define	MATCH_SRC	0x02
    163 #define	MATCH_INVERT	0x04
    164 
    165 enum {
    166 	BM_IPVER, BM_PROTO, BM_SRC_CIDR, BM_SRC_TABLE, BM_DST_CIDR,
    167 	BM_DST_TABLE, BM_SRC_PORTS, BM_DST_PORTS, BM_TCPFL, BM_ICMP_TYPE,
    168 	BM_ICMP_CODE,
    169 };
    170 
    171 npf_bpf_t *	npfctl_bpf_create(void);
    172 struct bpf_program *npfctl_bpf_complete(npf_bpf_t *);
    173 const void *	npfctl_bpf_bmarks(npf_bpf_t *, size_t *);
    174 void		npfctl_bpf_destroy(npf_bpf_t *);
    175 
    176 void		npfctl_bpf_group_enter(npf_bpf_t *);
    177 void		npfctl_bpf_group_exit(npf_bpf_t *, bool);
    178 
    179 void		npfctl_bpf_proto(npf_bpf_t *, sa_family_t, int);
    180 void		npfctl_bpf_cidr(npf_bpf_t *, u_int, sa_family_t,
    181 		    const npf_addr_t *, const npf_netmask_t);
    182 void		npfctl_bpf_ports(npf_bpf_t *, u_int, in_port_t, in_port_t);
    183 void		npfctl_bpf_tcpfl(npf_bpf_t *, uint8_t, uint8_t, bool);
    184 void		npfctl_bpf_icmp(npf_bpf_t *, int, int);
    185 void		npfctl_bpf_table(npf_bpf_t *, u_int, u_int);
    186 
    187 /*
    188  * Configuration building interface.
    189  */
    190 
    191 #define	NPFCTL_NAT_DYNAMIC	1
    192 #define	NPFCTL_NAT_STATIC	2
    193 
    194 void		npfctl_config_init(bool);
    195 void		npfctl_config_build(void);
    196 int		npfctl_config_send(int);
    197 nl_config_t *	npfctl_config_ref(void);
    198 int		npfctl_config_show(int);
    199 void		npfctl_config_save(nl_config_t *, const char *);
    200 void		npfctl_config_debug(const char *);
    201 
    202 void		npfctl_show_init(void);
    203 int		npfctl_ruleset_show(int, const char *);
    204 
    205 nl_rule_t *	npfctl_rule_ref(void);
    206 nl_table_t *	npfctl_table_ref(void);
    207 bool		npfctl_debug_addif(const char *);
    208 
    209 nl_table_t *	npfctl_load_table(const char *, int, u_int, const char *, FILE *);
    210 
    211 void		npfctl_build_alg(const char *);
    212 void		npfctl_build_rproc(const char *, npfvar_t *);
    213 void		npfctl_build_group(const char *, int, const char *, bool);
    214 void		npfctl_build_group_end(void);
    215 void		npfctl_build_rule(uint32_t, const char *, sa_family_t,
    216 		    const opt_proto_t *, const filt_opts_t *,
    217 		    const char *, const char *);
    218 void		npfctl_build_natseg(int, int, unsigned, const char *,
    219 		    const addr_port_t *, const addr_port_t *,
    220 		    const opt_proto_t *, const filt_opts_t *, unsigned);
    221 void		npfctl_build_maprset(const char *, int, const char *);
    222 void		npfctl_build_table(const char *, u_int, const char *);
    223 
    224 void		npfctl_setparam(const char *, int);
    225 
    226 /*
    227  * For the systems which do not define TH_ECE and TW_CRW.
    228  */
    229 #ifndef TH_ECE
    230 #define	TH_ECE	  0x40
    231 #endif
    232 #ifndef TH_CWR
    233 #define	TH_CWR	  0x80
    234 #endif
    235 
    236 #endif
    237