fa6e6891aa9ae8c6990cf51a6910857dffaaa92e
[debian/uanytun.git] / src / tun.h
1 /*
2  *  uAnytun
3  *
4  *  uAnytun is a tiny implementation of SATP. Unlike Anytun which is a full
5  *  featured implementation uAnytun has no support for multiple connections
6  *  or synchronisation. It is a small single threaded implementation intended
7  *  to act as a client on small platforms.
8  *  The secure anycast tunneling protocol (satp) defines a protocol used
9  *  for communication between any combination of unicast and anycast
10  *  tunnel endpoints.  It has less protocol overhead than IPSec in Tunnel
11  *  mode and allows tunneling of every ETHER TYPE protocol (e.g.
12  *  ethernet, ip, arp ...). satp directly includes cryptography and
13  *  message authentication based on the methods used by SRTP.  It is
14  *  intended to deliver a generic, scaleable and secure solution for
15  *  tunneling and relaying of packets of any protocol.
16  *
17  *
18  *  Copyright (C) 2007-2014 Christian Pointner <equinox@anytun.org>
19  *
20  *  This file is part of uAnytun.
21  *
22  *  uAnytun is free software: you can redistribute it and/or modify
23  *  it under the terms of the GNU General Public License as published by
24  *  the Free Software Foundation, either version 3 of the License, or
25  *  any later version.
26  *
27  *  uAnytun is distributed in the hope that it will be useful,
28  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
29  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  *  GNU General Public License for more details.
31  *
32  *  You should have received a copy of the GNU General Public License
33  *  along with uAnytun. If not, see <http://www.gnu.org/licenses/>.
34  *
35  *  In addition, as a special exception, the copyright holders give
36  *  permission to link the code of portions of this program with the
37  *  OpenSSL library under certain conditions as described in each
38  *  individual source file, and distribute linked combinations
39  *  including the two.
40  *  You must obey the GNU General Public License in all respects
41  *  for all of the code used other than OpenSSL.  If you modify
42  *  file(s) with this exception, you may extend this exception to your
43  *  version of the file(s), but you are not obligated to do so.  If you
44  *  do not wish to do so, delete this exception statement from your
45  *  version.  If you delete this exception statement from all source
46  *  files in the program, then also delete it here.
47  */
48
49 #ifndef UANYTUN_tun_h_INCLUDED
50 #define UANYTUN_tun_h_INCLUDED
51
52 #include <stdlib.h>
53
54 enum device_type_enum { TYPE_UNDEF, TYPE_TUN, TYPE_TAP };
55 typedef enum device_type_enum device_type_t;
56
57 struct tun_device_struct {
58   int fd_;
59   unsigned int with_pi_;
60   char* actual_name_;
61   device_type_t type_;
62   u_int16_t mtu_;
63   char* net_addr_;
64   char* net_mask_;
65   u_int16_t prefix_length_;
66 };
67 typedef struct tun_device_struct tun_device_t;
68
69 int tun_init(tun_device_t* dev, const char* dev_name, const char* dev_type, const char* ifcfg_addr, u_int16_t ifcfg_prefix);
70 int tun_init_post(tun_device_t* dev);
71 void tun_do_ifconfig(tun_device_t* dev);
72 void tun_close(tun_device_t* dev);
73
74 int tun_read(tun_device_t* dev, u_int8_t* buf, u_int32_t len);
75 int tun_write(tun_device_t* dev, u_int8_t* buf, u_int32_t len);
76
77 // in tun_helper.h
78 void tun_conf(tun_device_t* dev, const char* dev_name, const char* dev_type, const char* ifcfg_addr, u_int16_t ifcfg_prefix, u_int16_t mtu);
79 int tun_fix_return(int ret, size_t pi_length);
80 const char* tun_get_type_string(tun_device_t* dev);
81
82 #endif