BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file dataproto.h
3 * @author Ambroz Bizjak <ambrop7@gmail.com>
4 *
5 * @section LICENSE
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of the author nor the
15 * names of its contributors may be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * @section DESCRIPTION
30 *
31 * Definitions for DataProto, the protocol for data transport between VPN peers.
32 *
33 * All multi-byte integers in structs are little-endian, unless stated otherwise.
34 *
35 * A DataProto packet consists of:
36 * - the header (struct {@link dataproto_header})
37 * - between zero and DATAPROTO_MAX_PEER_IDS destination peer IDs (struct {@link dataproto_peer_id})
38 * - the payload, e.g. Ethernet frame
39 */
40  
41 #ifndef BADVPN_PROTOCOL_DATAPROTO_H
42 #define BADVPN_PROTOCOL_DATAPROTO_H
43  
44 #include <stdint.h>
45  
46 #include <protocol/scproto.h>
47 #include <misc/packed.h>
48  
49 #define DATAPROTO_MAX_PEER_IDS 1
50  
51 #define DATAPROTO_FLAGS_RECEIVING_KEEPALIVES 1
52  
53 /**
54 * DataProto header.
55 */
56 B_START_PACKED
57 struct dataproto_header {
58 /**
59 * Bitwise OR of flags. Possible flags:
60 * - DATAPROTO_FLAGS_RECEIVING_KEEPALIVES
61 * Indicates that when the peer sent this packet, it has received at least
62 * one packet from the other peer in the last keep-alive tolerance time.
63 */
64 uint8_t flags;
65  
66 /**
67 * ID of the peer this frame originates from.
68 */
69 peerid_t from_id;
70  
71 /**
72 * Number of destination peer IDs that follow.
73 * Must be <=DATAPROTO_MAX_PEER_IDS.
74 */
75 peerid_t num_peer_ids;
76 } B_PACKED;
77 B_END_PACKED
78  
79 /**
80 * Structure for a destination peer ID in DataProto.
81 * Wraps a single peerid_t in a packed struct for easy access.
82 */
83 B_START_PACKED
84 struct dataproto_peer_id {
85 peerid_t id;
86 } B_PACKED;
87 B_END_PACKED
88  
89 #define DATAPROTO_MAX_OVERHEAD (sizeof(struct dataproto_header) + DATAPROTO_MAX_PEER_IDS * sizeof(struct dataproto_peer_id))
90  
91 #endif