tinc-gui: Reformat codebase according to PEP8
[tinc] / src / connection.h
1 /*
2     connection.h -- header for connection.c
3     Copyright (C) 2000-2013 Guus Sliepen <guus@tinc-vpn.org>,
4                   2000-2005 Ivo Timmermans
5
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     This program is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License along
17     with this program; if not, write to the Free Software Foundation, Inc.,
18     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 */
20
21 #ifndef __TINC_CONNECTION_H__
22 #define __TINC_CONNECTION_H__
23
24 #include "buffer.h"
25 #include "cipher.h"
26 #include "digest.h"
27 #include "rsa.h"
28 #include "list.h"
29 #include "sptps.h"
30
31 #define OPTION_INDIRECT         0x0001
32 #define OPTION_TCPONLY          0x0002
33 #define OPTION_PMTU_DISCOVERY   0x0004
34 #define OPTION_CLAMP_MSS        0x0008
35 #define OPTION_VERSION(x) ((x) >> 24) /* Top 8 bits are for protocol minor version */
36
37 typedef struct connection_status_t {
38                 unsigned int pinged:1;                  /* sent ping */
39                 unsigned int unused_active:1;
40                 unsigned int connecting:1;              /* 1 if we are waiting for a non-blocking connect() to finish */
41                 unsigned int unused_termreq:1;          /* the termination of this connection was requested */
42                 unsigned int remove_unused:1;           /* Set to 1 if you want this connection removed */
43                 unsigned int timeout_unused:1;          /* 1 if gotten timeout */
44                 unsigned int encryptout:1;              /* 1 if we can encrypt outgoing traffic */
45                 unsigned int decryptin:1;               /* 1 if we have to decrypt incoming traffic */
46                 unsigned int mst:1;                     /* 1 if this connection is part of a minimum spanning tree */
47                 unsigned int control:1;                 /* 1 if this is a control connection */
48                 unsigned int pcap:1;                    /* 1 if this is a control connection requesting packet capture */
49                 unsigned int log:1;                     /* 1 if this is a control connection requesting log dump */
50                 unsigned int invitation:1;              /* 1 if this is an invitation */
51                 unsigned int invitation_used:1;         /* 1 if the invitation has been consumed */
52                 unsigned int unused:18;
53 } connection_status_t;
54
55 #include "ecdsa.h"
56 #include "edge.h"
57 #include "net.h"
58 #include "node.h"
59
60 typedef struct connection_t {
61         char *name;                     /* name he claims to have */
62         char *hostname;                 /* the hostname of its real ip */
63
64         union sockaddr_t address;       /* his real (internet) ip */
65         int protocol_major;             /* used protocol */
66         int protocol_minor;             /* used protocol */
67
68         int socket;                     /* socket used for this connection */
69         uint32_t options;               /* options for this connection */
70         connection_status_t status;     /* status info */
71         int estimated_weight;           /* estimation for the weight of the edge for this connection */
72         struct timeval start;           /* time this connection was started, used for above estimation */
73         struct outgoing_t *outgoing;    /* used to keep track of outgoing connections */
74
75         struct node_t *node;            /* node associated with the other end */
76         struct edge_t *edge;            /* edge associated with this connection */
77
78 #ifndef DISABLE_LEGACY
79         rsa_t *rsa;                     /* his public RSA key */
80         cipher_t *incipher;             /* Cipher he will use to send data to us */
81         cipher_t *outcipher;            /* Cipher we will use to send data to him */
82         digest_t *indigest;
83         digest_t *outdigest;
84 #endif
85
86         ecdsa_t *ecdsa;                 /* his public ECDSA key */
87         sptps_t sptps;
88
89         int inmaclength;
90         int outmaclength;
91         int incompression;
92         int outcompression;
93
94         char *hischallenge;             /* The challenge we sent to him */
95
96         struct buffer_t inbuf;
97         struct buffer_t outbuf;
98         io_t io;                        /* input/output event on this metadata connection */
99         int tcplen;                     /* length of incoming TCPpacket */
100         int sptpslen;                   /* length of incoming SPTPS packet */
101         int allow_request;              /* defined if there's only one request possible */
102
103         time_t last_ping_time;          /* last time we saw some activity from the other end or pinged them */
104
105         splay_tree_t *config_tree;      /* Pointer to configuration tree belonging to him */
106 } connection_t;
107
108 extern list_t *connection_list;
109 extern connection_t *everyone;
110
111 extern void init_connections(void);
112 extern void exit_connections(void);
113 extern connection_t *new_connection(void) __attribute__ ((__malloc__));
114 extern void free_connection(connection_t *);
115 extern void connection_add(connection_t *);
116 extern void connection_del(connection_t *);
117 extern bool dump_connections(struct connection_t *);
118
119 #endif /* __TINC_CONNECTION_H__ */