bsd/net/if_utun.h

   1 /*
   2  * Copyright (c) 2008-2013 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   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
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29
  30 #ifndef _NET_IF_UTUN_H_
  31 #define _NET_IF_UTUN_H_
  32
  33 #ifdef PRIVATE
  34 #include <net/if_utun_crypto.h>
  35 #endif /* PRIVATE */
  36
  37 #ifdef KERNEL_PRIVATE
  38
  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         u_int32_t               utun_max_pending_packets;
  49         utun_crypto_ctx_t utun_crypto_ctx[UTUN_CRYPTO_CTX_NUM_DIRS];
  50 };
  51
  52 void* utun_alloc(size_t size);
  53 void utun_free(void *ptr);
  54 errno_t utun_register_control(void);
  55
  56 #endif
  57
  58 /*
  59  * Name registered by the utun kernel control
  60  */
  61 #define UTUN_CONTROL_NAME "com.apple.net.utun_control"
  62
  63 /*
  64  * Socket option names to manage utun
  65  */
  66 #define UTUN_OPT_FLAGS                                                  1
  67 #define UTUN_OPT_IFNAME                                                 2
  68 #define UTUN_OPT_EXT_IFDATA_STATS                               3       /* get|set (type int) */
  69 #define UTUN_OPT_INC_IFDATA_STATS_IN                    4       /* set to increment stat counters (type struct utun_stats_param) */
  70 #define UTUN_OPT_INC_IFDATA_STATS_OUT                   5       /* set to increment stat counters (type struct utun_stats_param) */
  71
  72 #ifdef PRIVATE
  73 #define UTUN_OPT_ENABLE_CRYPTO                                  6
  74 #define UTUN_OPT_CONFIG_CRYPTO_KEYS                             7
  75 #define UTUN_OPT_UNCONFIG_CRYPTO_KEYS                   8
  76 #define UTUN_OPT_GENERATE_CRYPTO_KEYS_IDX               9
  77 #define UTUN_OPT_DISABLE_CRYPTO                                 10
  78 #define UTUN_OPT_STOP_CRYPTO_DATA_TRAFFIC               11
  79 #define UTUN_OPT_START_CRYPTO_DATA_TRAFFIC              12
  80 #define UTUN_OPT_CONFIG_CRYPTO_FRAMER                   13
  81 #define UTUN_OPT_UNCONFIG_CRYPTO_FRAMER                 14
  82 #endif /* PRIVATE */
  83
  84 #define UTUN_OPT_SET_DELEGATE_INTERFACE                 15      /* set the delegate interface (char[]) */
  85 #define UTUN_OPT_MAX_PENDING_PACKETS                    16      /* the number of packets that can be waiting to be read
  86                                                                                                                         from the control socket at a time */
  87
  88 /*
  89  * Flags for by UTUN_OPT_FLAGS
  90  */
  91 #define UTUN_FLAGS_NO_OUTPUT            0x0001
  92 #define UTUN_FLAGS_NO_INPUT                     0x0002
  93
  94 #ifdef PRIVATE
  95 #define UTUN_FLAGS_CRYPTO                       0x0004
  96 #define UTUN_FLAGS_CRYPTO_STOP_DATA_TRAFFIC     0x0008
  97 #endif /* PRIVATE */
  98
  99 /*
 100  * utun stats parameter structure
 101  */
 102 struct utun_stats_param {
 103         u_int64_t       utsp_packets;
 104         u_int64_t       utsp_bytes;
 105         u_int64_t       utsp_errors;
 106 };
 107
 108 #endif