[apple/xnu.git] / bsd / net / if_utun.h

/*
 * Copyright (c) 2008-2013 Apple 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@
 */


#ifndef	_NET_IF_UTUN_H_
#define	_NET_IF_UTUN_H_

#ifdef PRIVATE
#include <net/if_utun_crypto.h>
#endif /* PRIVATE */

#ifdef KERNEL_PRIVATE

#include <sys/kern_control.h>

/* Control block allocated for each kernel control connection */
struct utun_pcb {
	kern_ctl_ref	utun_ctlref;
	ifnet_t			utun_ifp;
	u_int32_t		utun_unit;
	u_int32_t		utun_flags;
	int				utun_ext_ifdata_stats;
	utun_crypto_ctx_t utun_crypto_ctx[UTUN_CRYPTO_CTX_NUM_DIRS];
};

void* utun_alloc(size_t size);
void utun_free(void *ptr);
errno_t utun_register_control(void);

#endif

/*
 * Name registered by the utun kernel control
 */
#define UTUN_CONTROL_NAME "com.apple.net.utun_control"

/*
 * Socket option names to manage utun
 */
#define UTUN_OPT_FLAGS							1
#define UTUN_OPT_IFNAME							2
#define UTUN_OPT_EXT_IFDATA_STATS				3	/* get|set (type int) */
#define UTUN_OPT_INC_IFDATA_STATS_IN			4	/* set to increment stat counters (type struct utun_stats_param) */ 
#define UTUN_OPT_INC_IFDATA_STATS_OUT			5	/* set to increment stat counters (type struct utun_stats_param) */ 

#ifdef PRIVATE
#define UTUN_OPT_ENABLE_CRYPTO					6
#define UTUN_OPT_CONFIG_CRYPTO_KEYS				7
#define UTUN_OPT_UNCONFIG_CRYPTO_KEYS			8
#define UTUN_OPT_GENERATE_CRYPTO_KEYS_IDX		9
#define UTUN_OPT_DISABLE_CRYPTO					10
#define UTUN_OPT_STOP_CRYPTO_DATA_TRAFFIC		11
#define UTUN_OPT_START_CRYPTO_DATA_TRAFFIC		12
#define UTUN_OPT_CONFIG_CRYPTO_FRAMER			13
#define UTUN_OPT_UNCONFIG_CRYPTO_FRAMER			14
#endif /* PRIVATE */

#define UTUN_OPT_SET_DELEGATE_INTERFACE			15      /* set the delegate interface (char[]) */

/*
 * Flags for by UTUN_OPT_FLAGS 
 */
#define	UTUN_FLAGS_NO_OUTPUT		0x0001
#define UTUN_FLAGS_NO_INPUT			0x0002

#ifdef PRIVATE
#define UTUN_FLAGS_CRYPTO			0x0004
#define UTUN_FLAGS_CRYPTO_STOP_DATA_TRAFFIC	0x0008
#endif /* PRIVATE */

/*
 * utun stats parameter structure
 */
struct utun_stats_param {
        u_int64_t       utsp_packets;
        u_int64_t       utsp_bytes;
        u_int64_t       utsp_errors;
};

#endif
Commit	Line	Data
1c79356b	1	/*
39236c6e	2	* Copyright (c) 2008-2013 Apple Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b	27	*/
1c79356b A	28
1c79356b A	29
b0d623f7 A	30	#ifndef _NET_IF_UTUN_H_
	31	#define _NET_IF_UTUN_H_
	32
39236c6e	33	#ifdef PRIVATE
316670eb	34	#include <net/if_utun_crypto.h>
39236c6e	35	#endif /* PRIVATE */
316670eb	36
b0d623f7 A	37	#ifdef KERNEL_PRIVATE
b0d623f7 A	38
316670eb A	39	#include <sys/kern_control.h>
	40
	41	/* Control block allocated for each kernel control connection */
	42	struct utun_pcb {
	43	kern_ctl_ref utun_ctlref;
	44	ifnet_t utun_ifp;
	45	u_int32_t utun_unit;
	46	u_int32_t utun_flags;
	47	int utun_ext_ifdata_stats;
	48	utun_crypto_ctx_t utun_crypto_ctx[UTUN_CRYPTO_CTX_NUM_DIRS];
	49	};
	50
	51	void* utun_alloc(size_t size);
	52	void utun_free(void *ptr);
b0d623f7 A	53	errno_t utun_register_control(void);
b0d623f7 A	54
1c79356b A	55	#endif
1c79356b A	56
d1ecb069 A	57	/*
	58	* Name registered by the utun kernel control
	59	*/
b0d623f7	60	#define UTUN_CONTROL_NAME "com.apple.net.utun_control"
1c79356b	61
d1ecb069 A	62	/*
	63	* Socket option names to manage utun
	64	*/
316670eb A	65	#define UTUN_OPT_FLAGS 1
	66	#define UTUN_OPT_IFNAME 2
	67	#define UTUN_OPT_EXT_IFDATA_STATS 3 /* get\|set (type int) */
	68	#define UTUN_OPT_INC_IFDATA_STATS_IN 4 /* set to increment stat counters (type struct utun_stats_param) */
	69	#define UTUN_OPT_INC_IFDATA_STATS_OUT 5 /* set to increment stat counters (type struct utun_stats_param) */
39236c6e A	70
39236c6e A	71	#ifdef PRIVATE
316670eb A	72	#define UTUN_OPT_ENABLE_CRYPTO 6
	73	#define UTUN_OPT_CONFIG_CRYPTO_KEYS 7
	74	#define UTUN_OPT_UNCONFIG_CRYPTO_KEYS 8
	75	#define UTUN_OPT_GENERATE_CRYPTO_KEYS_IDX 9
	76	#define UTUN_OPT_DISABLE_CRYPTO 10
	77	#define UTUN_OPT_STOP_CRYPTO_DATA_TRAFFIC 11
	78	#define UTUN_OPT_START_CRYPTO_DATA_TRAFFIC 12
39236c6e A	79	#define UTUN_OPT_CONFIG_CRYPTO_FRAMER 13
	80	#define UTUN_OPT_UNCONFIG_CRYPTO_FRAMER 14
	81	#endif /* PRIVATE */
	82
	83	#define UTUN_OPT_SET_DELEGATE_INTERFACE 15 /* set the delegate interface (char[]) */
d1ecb069 A	84
	85	/*
	86	* Flags for by UTUN_OPT_FLAGS
	87	*/
	88	#define UTUN_FLAGS_NO_OUTPUT 0x0001
	89	#define UTUN_FLAGS_NO_INPUT 0x0002
39236c6e A	90
39236c6e A	91	#ifdef PRIVATE
316670eb A	92	#define UTUN_FLAGS_CRYPTO 0x0004
316670eb A	93	#define UTUN_FLAGS_CRYPTO_STOP_DATA_TRAFFIC 0x0008
39236c6e	94	#endif /* PRIVATE */
d1ecb069 A	95
	96	/*
	97	* utun stats parameter structure
	98	*/
	99	struct utun_stats_param {
	100	u_int64_t utsp_packets;
	101	u_int64_t utsp_bytes;
	102	u_int64_t utsp_errors;
b0d623f7 A	103	};
	104
	105	#endif