Imported Upstream version 0.3.6
[debian/uanytun.git] / src / encrypted_packet.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_encrypted_packet_h_INCLUDED
50 #define UANYTUN_encrypted_packet_h_INCLUDED
51
52 #define ENCRYPTED_PACKET_SIZE_MAX 1600
53
54 #define PAYLOAD_TYPE_TAP 0x6558
55 #define PAYLOAD_TYPE_TUN 0x0000
56 #define PAYLOAD_TYPE_TUN4 0x0800
57 #define PAYLOAD_TYPE_TUN6 0x86DD
58
59 struct __attribute__ ((__packed__)) encrypted_packet_header_struct {
60   seq_nr_t seq_nr_;
61   sender_id_t sender_id_;
62   mux_t mux_;
63 };
64 typedef struct encrypted_packet_header_struct encrypted_packet_header_t;
65
66 struct encrypted_packet_struct {
67   u_int32_t payload_length_;
68   u_int32_t auth_tag_length_;
69   union __attribute__ ((__packed__)) {
70     u_int8_t buf_[ENCRYPTED_PACKET_SIZE_MAX];
71     encrypted_packet_header_t header_;
72  } data_;
73 };
74 typedef struct encrypted_packet_struct encrypted_packet_t;
75
76 void encrypted_packet_init(encrypted_packet_t* packet, u_int32_t auth_tag_length);
77
78 u_int32_t encrypted_packet_get_minimum_length(encrypted_packet_t* packet);
79
80 u_int8_t* encrypted_packet_get_packet(encrypted_packet_t* packet);
81 u_int32_t encrypted_packet_get_length(encrypted_packet_t* packet);
82 void encrypted_packet_set_length(encrypted_packet_t* packet, u_int32_t len);
83
84 u_int8_t* encrypted_packet_get_payload(encrypted_packet_t* packet);
85 u_int32_t encrypted_packet_get_payload_length(encrypted_packet_t* packet);
86 void encrypted_packet_set_payload_length(encrypted_packet_t* packet, u_int32_t len);
87
88 u_int8_t* encrypted_packet_get_auth_portion(encrypted_packet_t* packet);
89 u_int32_t encrypted_packet_get_auth_portion_length(encrypted_packet_t* packet);
90
91 u_int8_t* encrypted_packet_get_auth_tag(encrypted_packet_t* packet);
92 u_int32_t encrypted_packet_get_auth_tag_length(encrypted_packet_t* packet);
93
94 seq_nr_t encrypted_packet_get_seq_nr(encrypted_packet_t* packet);
95 void encrypted_packet_set_seq_nr(encrypted_packet_t* packet, seq_nr_t seq_nr);
96
97 sender_id_t encrypted_packet_get_sender_id(encrypted_packet_t* packet);
98 void encrypted_packet_set_sender_id(encrypted_packet_t* packet, sender_id_t sender_id);
99
100 mux_t encrypted_packet_get_mux(encrypted_packet_t* packet);
101 void encrypted_packet_set_mux(encrypted_packet_t* packet, mux_t mux);
102
103
104 #endif