Ensure all parameters have names in header files.
[oweals/tinc.git] / src / net.h
1 #ifndef TINC_NET_H
2 #define TINC_NET_H
3
4 /*
5     net.h -- header for net.c
6     Copyright (C) 1998-2005 Ivo Timmermans
7                   2000-2016 Guus Sliepen <guus@tinc-vpn.org>
8
9     This program is free software; you can redistribute it and/or modify
10     it under the terms of the GNU General Public License as published by
11     the Free Software Foundation; either version 2 of the License, or
12     (at your option) any later version.
13
14     This program is distributed in the hope that it will be useful,
15     but WITHOUT ANY WARRANTY; without even the implied warranty of
16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17     GNU General Public License for more details.
18
19     You should have received a copy of the GNU General Public License along
20     with this program; if not, write to the Free Software Foundation, Inc.,
21     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 */
23
24 #include "ipv6.h"
25 #include "cipher.h"
26 #include "digest.h"
27 #include "event.h"
28
29 #ifdef ENABLE_JUMBOGRAMS
30 #define MTU 9018        /* 9000 bytes payload + 14 bytes ethernet header + 4 bytes VLAN tag */
31 #else
32 #define MTU 1518        /* 1500 bytes payload + 14 bytes ethernet header + 4 bytes VLAN tag */
33 #endif
34
35 /* MAXSIZE is the maximum size of an encapsulated packet: MTU + seqno + srcid + dstid + padding + HMAC + compressor overhead */
36 #define MAXSIZE (MTU + 4 + sizeof(node_id_t) + sizeof(node_id_t) + CIPHER_MAX_BLOCK_SIZE + DIGEST_MAX_SIZE + MTU/64 + 20)
37
38 /* MAXBUFSIZE is the maximum size of a request: enough for a MAXSIZEd packet or a 8192 bits RSA key */
39 #define MAXBUFSIZE ((MAXSIZE > 2048 ? MAXSIZE : 2048) + 128)
40
41 #define MAXSOCKETS 8    /* Probably overkill... */
42
43 typedef struct mac_t {
44         uint8_t x[6];
45 } mac_t;
46
47 typedef struct ipv4_t {
48         uint8_t x[4];
49 } ipv4_t;
50
51 typedef struct ipv6_t {
52         uint16_t x[8];
53 } ipv6_t;
54
55 typedef struct node_id_t {
56         uint8_t x[6];
57 } node_id_t;
58
59 typedef short length_t;
60 typedef uint32_t seqno_t;
61
62 #define AF_UNKNOWN 255
63
64 struct sockaddr_unknown {
65         uint16_t family;
66         uint16_t pad1;
67         uint32_t pad2;
68         char *address;
69         char *port;
70 };
71
72 typedef union sockaddr_t {
73         struct sockaddr sa;
74         struct sockaddr_in in;
75         struct sockaddr_in6 in6;
76         struct sockaddr_unknown unknown;
77 #ifdef HAVE_STRUCT_SOCKADDR_STORAGE
78         struct sockaddr_storage storage;
79 #endif
80 } sockaddr_t;
81
82 #ifdef SA_LEN
83 #define SALEN(s) SA_LEN(&s)
84 #else
85 #define SALEN(s) (s.sa_family==AF_INET?sizeof(struct sockaddr_in):sizeof(struct sockaddr_in6))
86 #endif
87
88 #define SEQNO(x) ((x)->data + (x)->offset - 4)
89 #define SRCID(x) ((node_id_t *)((x)->data + (x)->offset - 6))
90 #define DSTID(x) ((node_id_t *)((x)->data + (x)->offset - 12))
91 #define DATA(x) ((x)->data + (x)->offset)
92 #define DEFAULT_PACKET_OFFSET 12
93
94 typedef struct vpn_packet_t {
95         length_t len;           /* The actual number of valid bytes in the `data' field (including seqno or dstid/srcid) */
96         length_t offset;        /* Offset in the buffer where the packet data starts (righter after seqno or dstid/srcid) */
97         int priority;           /* priority or TOS */
98         uint8_t data[MAXSIZE];
99 } vpn_packet_t;
100
101 /* Packet types when using SPTPS */
102
103 #define PKT_COMPRESSED 1
104 #define PKT_MAC 2
105 #define PKT_PROBE 4
106
107 typedef enum packet_type_t {
108         PACKET_NORMAL,
109         PACKET_COMPRESSED,
110         PACKET_PROBE
111 } packet_type_t;
112
113 typedef struct listen_socket_t {
114         io_t tcp;
115         io_t udp;
116         sockaddr_t sa;
117         bool bindto;
118         int priority;
119 } listen_socket_t;
120
121 #include "conf.h"
122 #include "list.h"
123
124 typedef struct outgoing_t {
125         char *name;
126         int timeout;
127         splay_tree_t *config_tree;
128         struct config_t *cfg;
129         struct addrinfo *ai;  // addresses from config files
130         struct addrinfo *aip;
131         struct addrinfo *kai; // addresses known via other online nodes (use free_known_addresses())
132         timeout_t ev;
133 } outgoing_t;
134
135 extern list_t *outgoing_list;
136
137 extern int maxoutbufsize;
138 extern int seconds_till_retry;
139 extern int addressfamily;
140 extern unsigned replaywin;
141 extern bool localdiscovery;
142
143 extern bool udp_discovery;
144 extern int udp_discovery_keepalive_interval;
145 extern int udp_discovery_interval;
146 extern int udp_discovery_timeout;
147
148 extern int mtu_info_interval;
149 extern int udp_info_interval;
150
151 extern listen_socket_t listen_socket[MAXSOCKETS];
152 extern int listen_sockets;
153 extern io_t unix_socket;
154 extern int keylifetime;
155 extern int udp_rcvbuf;
156 extern int udp_sndbuf;
157 extern int max_connection_burst;
158 extern bool do_prune;
159 extern char *myport;
160 extern bool device_standby;
161 extern bool autoconnect;
162 extern bool disablebuggypeers;
163 extern int contradicting_add_edge;
164 extern int contradicting_del_edge;
165 extern time_t last_config_check;
166
167 extern char *proxyhost;
168 extern char *proxyport;
169 extern char *proxyuser;
170 extern char *proxypass;
171 typedef enum proxytype_t {
172         PROXY_NONE = 0,
173         PROXY_SOCKS4,
174         PROXY_SOCKS4A,
175         PROXY_SOCKS5,
176         PROXY_HTTP,
177         PROXY_EXEC,
178 } proxytype_t;
179 extern proxytype_t proxytype;
180
181 extern char *scriptinterpreter;
182 extern char *scriptextension;
183
184 /* Yes, very strange placement indeed, but otherwise the typedefs get all tangled up */
185 #include "connection.h"
186 #include "node.h"
187
188 extern void retry_outgoing(outgoing_t *outgoing);
189 extern void handle_incoming_vpn_data(void *data, int flags);
190 extern void finish_connecting(struct connection_t *c);
191 extern bool do_outgoing_connection(struct outgoing_t *outgoing);
192 extern void handle_new_meta_connection(void *data, int flags);
193 extern void handle_new_unix_connection(void *data, int flags);
194 extern int setup_listen_socket(const sockaddr_t *sa);
195 extern int setup_vpn_in_socket(const sockaddr_t *sa);
196 extern bool send_sptps_data(node_t *to, node_t *from, int type, const void *data, size_t len);
197 extern bool receive_sptps_record(void *handle, uint8_t type, const void *data, uint16_t len);
198 extern void send_packet(struct node_t *n, vpn_packet_t *packet);
199 extern void receive_tcppacket(struct connection_t *c, const char *buffer, int length);
200 extern bool receive_tcppacket_sptps(struct connection_t *c, const char *buffer, int length);
201 extern void broadcast_packet(const struct node_t *n, vpn_packet_t *packet);
202 extern char *get_name(void);
203 extern void device_enable(void);
204 extern void device_disable(void);
205 extern bool setup_myself_reloadable(void);
206 extern bool setup_network(void);
207 extern void setup_outgoing_connection(struct outgoing_t *outgoing, bool verbose);
208 extern void try_outgoing_connections(void);
209 extern void close_network_connections(void);
210 extern int main_loop(void);
211 extern void terminate_connection(struct connection_t *c, bool report);
212 extern bool node_read_ecdsa_public_key(struct node_t *n);
213 extern bool read_ecdsa_public_key(struct connection_t *c);
214 extern bool read_rsa_public_key(struct connection_t *c);
215 extern void handle_device_data(void *data, int flags);
216 extern void handle_meta_connection_data(struct connection_t *c);
217 extern void regenerate_key(void);
218 extern void purge(void);
219 extern void retry(void);
220 extern int reload_configuration(void);
221 extern void load_all_nodes(void);
222 extern void try_tx(struct node_t *n, bool mtu);
223
224 #ifndef HAVE_MINGW
225 #define closesocket(s) close(s)
226 #endif
227
228 #endif