[apple/xnu.git] / bsd / netinet6 / ip6_fw.h

/*
 * Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1993 Daniel Boulet
 * Copyright (c) 1994 Ugen J.S.Antsilevich
 *
 * Redistribution and use in source forms, with and without modification,
 * are permitted provided that this entire comment appears intact.
 *
 * Redistribution in binary form may occur without any restrictions.
 * Obviously, it would be nice if you gave credit where credit is due
 * but requiring it would be too onerous.
 *
 * This software is provided ``AS IS'' without any warranties of any kind.
 *
 */

#ifndef _IP6_FW_H
#define _IP6_FW_H
#include <sys/appleapiopts.h>

#include <net/if.h>

#define IPV6_FW_CURRENT_API_VERSION 20	/* Version of this API */


/*
 * This union structure identifies an interface, either explicitly
 * by name or implicitly by IP address. The flags IP_FW_F_IIFNAME
 * and IP_FW_F_OIFNAME say how to interpret this structure. An
 * interface unit number of -1 matches any unit number, while an
 * IP address of 0.0.0.0 indicates matches any interface.
 *
 * The receive and transmit interfaces are only compared against the
 * the packet if the corresponding bit (IP_FW_F_IIFACE or IP_FW_F_OIFACE)
 * is set. Note some packets lack a receive or transmit interface
 * (in which case the missing "interface" never matches).
 */

union ip6_fw_if {
    struct in6_addr fu_via_ip6;	/* Specified by IPv6 address */
    struct {			/* Specified by interface name */
#define IP6FW_IFNLEN     IFNAMSIZ
	    char  name[IP6FW_IFNLEN];
	    short unit;		/* -1 means match any unit */
    } fu_via_if;
};

/*
 * Format of an IP firewall descriptor
 *
 * fw_src, fw_dst, fw_smsk, fw_dmsk are always stored in network byte order.
 * fw_flg and fw_n*p are stored in host byte order (of course).
 * Port numbers are stored in HOST byte order.
 * Warning: setsockopt() will fail if sizeof(struct ip_fw) > MLEN (108)
 */

struct ip6_fw {
	u_int32_t version;		/* Version of this structure.  Should always be */
							/* set to IP6_FW_CURRENT_API_VERSION by clients. */
	void *context;			/* Context that is usable by user processes to */
							/* identify this rule. */
    u_long fw_pcnt,fw_bcnt;		/* Packet and byte counters */
    struct in6_addr fw_src, fw_dst;	/* Source and destination IPv6 addr */
    struct in6_addr fw_smsk, fw_dmsk;	/* Mask for src and dest IPv6 addr */
    u_short fw_number;			/* Rule number */
    u_short fw_flg;			/* Flags word */
#define IPV6_FW_MAX_PORTS	10	/* A reasonable maximum */
    u_int fw_ipflg;			/* IP flags word */
    u_short fw_pts[IPV6_FW_MAX_PORTS];	/* Array of port numbers to match */
    u_char fw_ip6opt,fw_ip6nopt;	/* IPv6 options set/unset */
    u_char fw_tcpf,fw_tcpnf;		/* TCP flags set/unset */
#define IPV6_FW_ICMPTYPES_DIM (256 / (sizeof(unsigned) * 8))
    unsigned fw_icmp6types[IPV6_FW_ICMPTYPES_DIM]; /* ICMP types bitmap */
    long timestamp;			/* timestamp (tv_sec) of last match */
    union ip6_fw_if fw_in_if, fw_out_if;/* Incoming and outgoing interfaces */
    union {
	u_short fu_divert_port;		/* Divert/tee port (options IP6DIVERT) */
	u_short fu_skipto_rule;		/* SKIPTO command rule number */
	u_short fu_reject_code;		/* REJECT response code */
    } fw_un;
    u_char fw_prot;			/* IPv6 protocol */
    u_char fw_nports;			/* N'of src ports and # of dst ports */
					/* in ports array (dst ports follow */
					/* src ports; max of 10 ports in all; */
					/* count of 0 means match all ports) */
};

#define IPV6_FW_GETNSRCP(rule)		((rule)->fw_nports & 0x0f)
#define IPV6_FW_SETNSRCP(rule, n)		do {				\
					  (rule)->fw_nports &= ~0x0f;	\
					  (rule)->fw_nports |= (n);	\
					} while (0)
#define IPV6_FW_GETNDSTP(rule)		((rule)->fw_nports >> 4)
#define IPV6_FW_SETNDSTP(rule, n)		do {				\
					  (rule)->fw_nports &= ~0xf0;	\
					  (rule)->fw_nports |= (n) << 4;\
					} while (0)

#define fw_divert_port	fw_un.fu_divert_port
#define fw_skipto_rule	fw_un.fu_skipto_rule
#define fw_reject_code	fw_un.fu_reject_code

struct ip6_fw_chain {
        LIST_ENTRY(ip6_fw_chain) chain;
        struct ip6_fw    *rule;
};

/*
 * Values for "flags" field .
 */
#define IPV6_FW_F_IN	0x0001	/* Check inbound packets		*/
#define IPV6_FW_F_OUT	0x0002	/* Check outbound packets		*/
#define IPV6_FW_F_IIFACE	0x0004	/* Apply inbound interface test		*/
#define IPV6_FW_F_OIFACE	0x0008	/* Apply outbound interface test	*/

#define IPV6_FW_F_COMMAND 0x0070	/* Mask for type of chain entry:	*/
#define IPV6_FW_F_DENY	0x0000	/* This is a deny rule			*/
#define IPV6_FW_F_REJECT	0x0010	/* Deny and send a response packet	*/
#define IPV6_FW_F_ACCEPT	0x0020	/* This is an accept rule		*/
#define IPV6_FW_F_COUNT	0x0030	/* This is a count rule			*/
#define IPV6_FW_F_DIVERT	0x0040	/* This is a divert rule		*/
#define IPV6_FW_F_TEE	0x0050	/* This is a tee rule			*/
#define IPV6_FW_F_SKIPTO	0x0060	/* This is a skipto rule		*/

#define IPV6_FW_F_PRN	0x0080	/* Print if this rule matches		*/

#define IPV6_FW_F_SRNG	0x0100	/* The first two src ports are a min	*
				 * and max range (stored in host byte	*
				 * order).				*/

#define IPV6_FW_F_DRNG	0x0200	/* The first two dst ports are a min	*
				 * and max range (stored in host byte	*
				 * order).				*/

#define IPV6_FW_F_IIFNAME	0x0400	/* In interface by name/unit (not IP)	*/
#define IPV6_FW_F_OIFNAME	0x0800	/* Out interface by name/unit (not IP)	*/

#define IPV6_FW_F_INVSRC	0x1000	/* Invert sense of src check		*/
#define IPV6_FW_F_INVDST	0x2000	/* Invert sense of dst check		*/

#define IPV6_FW_F_FRAG	0x4000	/* Fragment				*/

#define IPV6_FW_F_ICMPBIT 0x8000	/* ICMP type bitmap is valid		*/

#define IPV6_FW_F_MASK	0xFFFF	/* All possible flag bits mask		*/

/* 
 * Flags for the 'fw_ipflg' field, for comparing values of ip and its protocols. */
#define	IPV6_FW_IF_TCPEST 0x00000020	/* established TCP connection	*/
#define IPV6_FW_IF_TCPMSK 0x00000020	/* mask of all TCP values */

/*
 * For backwards compatibility with rules specifying "via iface" but
 * not restricted to only "in" or "out" packets, we define this combination
 * of bits to represent this configuration.
 */

#define IF6_FW_F_VIAHACK	(IPV6_FW_F_IN|IPV6_FW_F_OUT|IPV6_FW_F_IIFACE|IPV6_FW_F_OIFACE)

/*
 * Definitions for REJECT response codes.
 * Values less than 256 correspond to ICMP unreachable codes.
 */
#define IPV6_FW_REJECT_RST	0x0100		/* TCP packets: send RST */

/*
 * Definitions for IPv6 option names.
 */
#define IPV6_FW_IP6OPT_HOPOPT	0x01
#define IPV6_FW_IP6OPT_ROUTE	0x02
#define IPV6_FW_IP6OPT_FRAG	0x04
#define IPV6_FW_IP6OPT_ESP	0x08
#define IPV6_FW_IP6OPT_AH	0x10
#define IPV6_FW_IP6OPT_NONXT	0x20
#define IPV6_FW_IP6OPT_OPTS	0x40

/*
 * Definitions for TCP flags.
 */
#define IPV6_FW_TCPF_FIN	TH_FIN
#define IPV6_FW_TCPF_SYN	TH_SYN
#define IPV6_FW_TCPF_RST	TH_RST
#define IPV6_FW_TCPF_PSH	TH_PUSH
#define IPV6_FW_TCPF_ACK	TH_ACK
#define IPV6_FW_TCPF_URG	TH_URG

/*
 * Main firewall chains definitions and global var's definitions.
 */
#ifdef KERNEL
#ifdef __APPLE_API_PRIVATE

#define M_IP6FW M_IPFW


/*
 * Function definitions.
 */
void ip6_fw_init(void);

/* Firewall hooks */
struct ip6_hdr;
struct sockopt;
typedef	int ip6_fw_chk_t __P((struct ip6_hdr**, struct ifnet*,
				u_short *, struct mbuf**));
typedef	int ip6_fw_ctl_t __P((struct sockopt *));
extern	ip6_fw_chk_t *ip6_fw_chk_ptr;
extern	ip6_fw_ctl_t *ip6_fw_ctl_ptr;
extern	int ip6_fw_enable;

#endif /* __APPLE_API_PRIVATE */
#endif /* KERNEL */

#endif /* _IP6_FW_H */
Commit	Line	Data
9bccf70c A	1	/*
	2	* Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
e5568f75 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
9bccf70c	11	*
e5568f75 A	12	* This Original Code and all software distributed under the License are
e5568f75 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
9bccf70c A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
9bccf70c A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
e5568f75 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
9bccf70c A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
1c79356b A	22	/*
	23	* Copyright (c) 1993 Daniel Boulet
	24	* Copyright (c) 1994 Ugen J.S.Antsilevich
	25	*
	26	* Redistribution and use in source forms, with and without modification,
	27	* are permitted provided that this entire comment appears intact.
	28	*
	29	* Redistribution in binary form may occur without any restrictions.
	30	* Obviously, it would be nice if you gave credit where credit is due
	31	* but requiring it would be too onerous.
	32	*
	33	* This software is provided ``AS IS'' without any warranties of any kind.
	34	*
	35	*/
	36
	37	#ifndef _IP6_FW_H
	38	#define _IP6_FW_H
9bccf70c	39	#include <sys/appleapiopts.h>
1c79356b A	40
1c79356b A	41	#include <net/if.h>
9bccf70c	42
55e303ae	43	#define IPV6_FW_CURRENT_API_VERSION 20 /* Version of this API */
9bccf70c	44
1c79356b A	45
	46	/*
	47	* This union structure identifies an interface, either explicitly
	48	* by name or implicitly by IP address. The flags IP_FW_F_IIFNAME
	49	* and IP_FW_F_OIFNAME say how to interpret this structure. An
	50	* interface unit number of -1 matches any unit number, while an
	51	* IP address of 0.0.0.0 indicates matches any interface.
	52	*
	53	* The receive and transmit interfaces are only compared against the
	54	* the packet if the corresponding bit (IP_FW_F_IIFACE or IP_FW_F_OIFACE)
	55	* is set. Note some packets lack a receive or transmit interface
	56	* (in which case the missing "interface" never matches).
	57	*/
	58
	59	union ip6_fw_if {
	60	struct in6_addr fu_via_ip6; /* Specified by IPv6 address */
	61	struct { /* Specified by interface name */
9bccf70c A	62	#define IP6FW_IFNLEN IFNAMSIZ
9bccf70c A	63	char name[IP6FW_IFNLEN];
1c79356b A	64	short unit; /* -1 means match any unit */
	65	} fu_via_if;
	66	};
	67
	68	/*
	69	* Format of an IP firewall descriptor
	70	*
	71	* fw_src, fw_dst, fw_smsk, fw_dmsk are always stored in network byte order.
	72	* fw_flg and fw_n*p are stored in host byte order (of course).
	73	* Port numbers are stored in HOST byte order.
	74	* Warning: setsockopt() will fail if sizeof(struct ip_fw) > MLEN (108)
	75	*/
	76
	77	struct ip6_fw {
9bccf70c A	78	u_int32_t version; /* Version of this structure. Should always be */
	79	/* set to IP6_FW_CURRENT_API_VERSION by clients. */
	80	void context; / Context that is usable by user processes to */
	81	/* identify this rule. */
1c79356b A	82	u_long fw_pcnt,fw_bcnt; /* Packet and byte counters */
	83	struct in6_addr fw_src, fw_dst; /* Source and destination IPv6 addr */
	84	struct in6_addr fw_smsk, fw_dmsk; /* Mask for src and dest IPv6 addr */
	85	u_short fw_number; /* Rule number */
	86	u_short fw_flg; /* Flags word */
	87	#define IPV6_FW_MAX_PORTS 10 /* A reasonable maximum */
9bccf70c	88	u_int fw_ipflg; /* IP flags word */
1c79356b A	89	u_short fw_pts[IPV6_FW_MAX_PORTS]; /* Array of port numbers to match */
	90	u_char fw_ip6opt,fw_ip6nopt; /* IPv6 options set/unset */
	91	u_char fw_tcpf,fw_tcpnf; /* TCP flags set/unset */
9bccf70c	92	#define IPV6_FW_ICMPTYPES_DIM (256 / (sizeof(unsigned) * 8))
1c79356b A	93	unsigned fw_icmp6types[IPV6_FW_ICMPTYPES_DIM]; /* ICMP types bitmap */
	94	long timestamp; /* timestamp (tv_sec) of last match */
	95	union ip6_fw_if fw_in_if, fw_out_if;/* Incoming and outgoing interfaces */
	96	union {
	97	u_short fu_divert_port; /* Divert/tee port (options IP6DIVERT) */
	98	u_short fu_skipto_rule; /* SKIPTO command rule number */
	99	u_short fu_reject_code; /* REJECT response code */
	100	} fw_un;
	101	u_char fw_prot; /* IPv6 protocol */
	102	u_char fw_nports; /* N'of src ports and # of dst ports */
	103	/* in ports array (dst ports follow */
	104	/* src ports; max of 10 ports in all; */
	105	/* count of 0 means match all ports) */
	106	};
	107
	108	#define IPV6_FW_GETNSRCP(rule) ((rule)->fw_nports & 0x0f)
	109	#define IPV6_FW_SETNSRCP(rule, n) do { \
	110	(rule)->fw_nports &= ~0x0f; \
	111	(rule)->fw_nports \|= (n); \
	112	} while (0)
	113	#define IPV6_FW_GETNDSTP(rule) ((rule)->fw_nports >> 4)
	114	#define IPV6_FW_SETNDSTP(rule, n) do { \
	115	(rule)->fw_nports &= ~0xf0; \
	116	(rule)->fw_nports \|= (n) << 4;\
	117	} while (0)
	118
	119	#define fw_divert_port fw_un.fu_divert_port
	120	#define fw_skipto_rule fw_un.fu_skipto_rule
	121	#define fw_reject_code fw_un.fu_reject_code
	122
	123	struct ip6_fw_chain {
	124	LIST_ENTRY(ip6_fw_chain) chain;
	125	struct ip6_fw *rule;
	126	};
	127
	128	/*
	129	* Values for "flags" field .
	130	*/
	131	#define IPV6_FW_F_IN 0x0001 /* Check inbound packets */
	132	#define IPV6_FW_F_OUT 0x0002 /* Check outbound packets */
	133	#define IPV6_FW_F_IIFACE 0x0004 /* Apply inbound interface test */
	134	#define IPV6_FW_F_OIFACE 0x0008 /* Apply outbound interface test */
	135
	136	#define IPV6_FW_F_COMMAND 0x0070 /* Mask for type of chain entry: */
	137	#define IPV6_FW_F_DENY 0x0000 /* This is a deny rule */
	138	#define IPV6_FW_F_REJECT 0x0010 /* Deny and send a response packet */
	139	#define IPV6_FW_F_ACCEPT 0x0020 /* This is an accept rule */
	140	#define IPV6_FW_F_COUNT 0x0030 /* This is a count rule */
	141	#define IPV6_FW_F_DIVERT 0x0040 /* This is a divert rule */
	142	#define IPV6_FW_F_TEE 0x0050 /* This is a tee rule */
	143	#define IPV6_FW_F_SKIPTO 0x0060 /* This is a skipto rule */
	144
	145	#define IPV6_FW_F_PRN 0x0080 /* Print if this rule matches */
	146
	147	#define IPV6_FW_F_SRNG 0x0100 /* The first two src ports are a min *
	148	* and max range (stored in host byte *
	149	* order). */
	150
	151	#define IPV6_FW_F_DRNG 0x0200 /* The first two dst ports are a min *
	152	* and max range (stored in host byte *
	153	* order). */
	154
	155	#define IPV6_FW_F_IIFNAME 0x0400 /* In interface by name/unit (not IP) */
	156	#define IPV6_FW_F_OIFNAME 0x0800 /* Out interface by name/unit (not IP) */
157
158	#define IPV6_FW_F_INVSRC 0x1000 /* Invert sense of src check */
159	#define IPV6_FW_F_INVDST 0x2000 /* Invert sense of dst check */
160
161	#define IPV6_FW_F_FRAG 0x4000 /* Fragment */
162
163	#define IPV6_FW_F_ICMPBIT 0x8000 /* ICMP type bitmap is valid */
164
165	#define IPV6_FW_F_MASK 0xFFFF /* All possible flag bits mask */
166
9bccf70c A	167	/*
	168	* Flags for the 'fw_ipflg' field, for comparing values of ip and its protocols. */
	169	#define IPV6_FW_IF_TCPEST 0x00000020 /* established TCP connection */
	170	#define IPV6_FW_IF_TCPMSK 0x00000020 /* mask of all TCP values */
	171
1c79356b A	172	/*
	173	* For backwards compatibility with rules specifying "via iface" but
	174	* not restricted to only "in" or "out" packets, we define this combination
	175	* of bits to represent this configuration.
	176	*/
	177
	178	#define IF6_FW_F_VIAHACK (IPV6_FW_F_IN\|IPV6_FW_F_OUT\|IPV6_FW_F_IIFACE\|IPV6_FW_F_OIFACE)
	179
	180	/*
	181	* Definitions for REJECT response codes.
	182	* Values less than 256 correspond to ICMP unreachable codes.
	183	*/
	184	#define IPV6_FW_REJECT_RST 0x0100 /* TCP packets: send RST */
	185
	186	/*
	187	* Definitions for IPv6 option names.
	188	*/
	189	#define IPV6_FW_IP6OPT_HOPOPT 0x01
	190	#define IPV6_FW_IP6OPT_ROUTE 0x02
	191	#define IPV6_FW_IP6OPT_FRAG 0x04
	192	#define IPV6_FW_IP6OPT_ESP 0x08
	193	#define IPV6_FW_IP6OPT_AH 0x10
	194	#define IPV6_FW_IP6OPT_NONXT 0x20
	195	#define IPV6_FW_IP6OPT_OPTS 0x40
	196
	197	/*
	198	* Definitions for TCP flags.
	199	*/
	200	#define IPV6_FW_TCPF_FIN TH_FIN
	201	#define IPV6_FW_TCPF_SYN TH_SYN
	202	#define IPV6_FW_TCPF_RST TH_RST
	203	#define IPV6_FW_TCPF_PSH TH_PUSH
	204	#define IPV6_FW_TCPF_ACK TH_ACK
	205	#define IPV6_FW_TCPF_URG TH_URG
1c79356b A	206
	207	/*
	208	* Main firewall chains definitions and global var's definitions.
	209	*/
9bccf70c	210	#ifdef KERNEL
55e303ae	211	#ifdef __APPLE_API_PRIVATE
9bccf70c A	212
	213	#define M_IP6FW M_IPFW
	214
1c79356b A	215
	216	/*
	217	* Function definitions.
	218	*/
	219	void ip6_fw_init(void);
	220
	221	/* Firewall hooks */
	222	struct ip6_hdr;
55e303ae	223	struct sockopt;
1c79356b A	224	typedef int ip6_fw_chk_t __P((struct ip6_hdr*, struct ifnet,
1c79356b A	225	u_short , struct mbuf*));
55e303ae	226	typedef int ip6_fw_ctl_t __P((struct sockopt *));
1c79356b A	227	extern ip6_fw_chk_t *ip6_fw_chk_ptr;
1c79356b A	228	extern ip6_fw_ctl_t *ip6_fw_ctl_ptr;
9bccf70c	229	extern int ip6_fw_enable;
1c79356b	230
9bccf70c	231	#endif /* __APPLE_API_PRIVATE */
55e303ae	232	#endif /* KERNEL */
1c79356b A	233
1c79356b A	234	#endif /* _IP6_FW_H */