Ensure all parameters have names in header files.
[tinc] / src / connection.h
1 #ifndef TINC_CONNECTION_H
2 #define TINC_CONNECTION_H
3
4 /*
5     connection.h -- header for connection.c
6     Copyright (C) 2000-2016 Guus Sliepen <guus@tinc-vpn.org>,
7                   2000-2005 Ivo Timmermans
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 <openssl/rsa.h>
25 #include <openssl/evp.h>
26
27 #include "avl_tree.h"
28
29 #define OPTION_INDIRECT         0x0001
30 #define OPTION_TCPONLY          0x0002
31 #define OPTION_PMTU_DISCOVERY   0x0004
32 #define OPTION_CLAMP_MSS        0x0008
33
34 typedef struct connection_status_t {
35         unsigned int pinged: 1;         /* sent ping */
36         unsigned int active: 1;         /* 1 if active.. */
37         unsigned int connecting: 1;     /* 1 if we are waiting for a non-blocking connect() to finish */
38         unsigned int unused_termreq: 1; /* the termination of this connection was requested */
39         unsigned int remove: 1;         /* Set to 1 if you want this connection removed */
40         unsigned int timeout: 1;        /* 1 if gotten timeout */
41         unsigned int encryptout: 1;     /* 1 if we can encrypt outgoing traffic */
42         unsigned int decryptin: 1;      /* 1 if we have to decrypt incoming traffic */
43         unsigned int mst: 1;            /* 1 if this connection is part of a minimum spanning tree */
44         unsigned int proxy_passed: 1;   /* 1 if we are connecting via a proxy and we have finished talking with it */
45         unsigned int unused: 22;
46 } connection_status_t;
47
48 #include "edge.h"
49 #include "net.h"
50 #include "node.h"
51
52 typedef struct connection_t {
53         char *name;                     /* name he claims to have */
54
55         union sockaddr_t address;       /* his real (internet) ip */
56         char *hostname;                 /* the hostname of its real ip */
57         int protocol_version;           /* used protocol */
58
59         int socket;                     /* socket used for this connection */
60         uint32_t options;               /* options for this connection */
61         connection_status_t status;     /* status info */
62         int estimated_weight;           /* estimation for the weight of the edge for this connection */
63         struct timeval start;           /* time this connection was started, used for above estimation */
64         struct outgoing_t *outgoing;    /* used to keep track of outgoing connections */
65
66         struct node_t *node;            /* node associated with the other end */
67         struct edge_t *edge;            /* edge associated with this connection */
68
69         RSA *rsa_key;                   /* his public/private key */
70         const EVP_CIPHER *incipher;     /* Cipher he will use to send data to us */
71         const EVP_CIPHER *outcipher;    /* Cipher we will use to send data to him */
72         EVP_CIPHER_CTX *inctx;          /* Context of encrypted meta data that will come from him to us */
73         EVP_CIPHER_CTX *outctx;         /* Context of encrypted meta data that will be sent from us to him */
74         uint64_t inbudget;              /* Encrypted bytes send budget */
75         uint64_t outbudget;             /* Encrypted bytes receive budget */
76         char *inkey;                    /* His symmetric meta key + iv */
77         char *outkey;                   /* Our symmetric meta key + iv */
78         int inkeylength;                /* Length of his key + iv */
79         int outkeylength;               /* Length of our key + iv */
80         const EVP_MD *indigest;
81         const EVP_MD *outdigest;
82         int inmaclength;
83         int outmaclength;
84         int incompression;
85         int outcompression;
86         char *mychallenge;              /* challenge we received from him */
87         char *hischallenge;             /* challenge we sent to him */
88
89         char buffer[MAXBUFSIZE];        /* metadata input buffer */
90         int buflen;                     /* bytes read into buffer */
91         int reqlen;                     /* length of incoming request */
92         length_t tcplen;                /* length of incoming TCPpacket */
93         int allow_request;              /* defined if there's only one request possible */
94
95         char *outbuf;                   /* metadata output buffer */
96         int outbufstart;                /* index of first meaningful byte in output buffer */
97         int outbuflen;                  /* number of meaningful bytes in output buffer */
98         int outbufsize;                 /* number of bytes allocated to output buffer */
99
100         time_t last_ping_time;          /* last time we saw some activity from the other end or pinged them */
101         time_t last_flushed_time;       /* last time buffer was empty. Only meaningful if outbuflen > 0 */
102
103         avl_tree_t *config_tree;        /* Pointer to configuration tree belonging to him */
104 } connection_t;
105
106 extern avl_tree_t *connection_tree;
107 extern connection_t *everyone;
108
109 extern void init_connections(void);
110 extern void exit_connections(void);
111 extern connection_t *new_connection(void) __attribute__((__malloc__));
112 extern void free_connection(connection_t *c);
113 extern void free_connection_partially(connection_t *c);
114 extern void connection_add(connection_t *c);
115 extern void connection_del(connection_t *c);
116 extern void dump_connections(void);
117
118 #endif