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

/*
 * Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The 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, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_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_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(struct ip6_hdr**, struct ifnet*,
				u_short *, struct mbuf**);
typedef	int ip6_fw_ctl_t(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 /* KERNEL_PRIVATE */

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