Start documenting the SPTPS protocol.
[tinc] / src / protocol.h
1 /*
2     protocol.h -- header for protocol.c
3     Copyright (C) 1999-2005 Ivo Timmermans,
4                   2000-2009 Guus Sliepen <guus@tinc-vpn.org>
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_PROTOCOL_H__
22 #define __TINC_PROTOCOL_H__
23
24 /* Protocol version. Different major versions are incompatible. */
25
26 #define PROT_MAJOR 17
27 #define PROT_MINOR 2
28
29 /* Silly Windows */
30
31 #ifdef ERROR
32 #undef ERROR
33 #endif
34
35 /* Request numbers */
36
37 typedef enum request_t {
38         ALL = -1,                                       /* Guardian for allow_request */
39         ID = 0, METAKEY, CHALLENGE, CHAL_REPLY, ACK,
40         STATUS, ERROR, TERMREQ,
41         PING, PONG,
42         ADD_SUBNET, DEL_SUBNET,
43         ADD_EDGE, DEL_EDGE,
44         KEY_CHANGED, REQ_KEY, ANS_KEY,
45         PACKET,
46         CONTROL,
47         LAST                                            /* Guardian for the highest request number */
48 } request_t;
49
50 typedef struct past_request_t {
51         char *request;
52         time_t firstseen;
53 } past_request_t;
54
55 extern bool tunnelserver;
56 extern bool strictsubnets;
57 extern bool experimental;
58
59 /* Maximum size of strings in a request.
60  * scanf terminates %2048s with a NUL character,
61  * but the NUL character can be written after the 2048th non-NUL character.
62  */
63
64 #define MAX_STRING_SIZE 2049
65 #define MAX_STRING "%2048s"
66
67 #include "edge.h"
68 #include "net.h"
69 #include "node.h"
70 #include "subnet.h"
71
72 /* Basic functions */
73
74 extern bool send_request(struct connection_t *, const char *, ...) __attribute__ ((__format__(printf, 2, 3)));
75 extern void forward_request(struct connection_t *, char *);
76 extern bool receive_request(struct connection_t *, char *);
77 extern bool check_id(const char *);
78
79 extern void init_requests(void);
80 extern void exit_requests(void);
81 extern bool seen_request(char *);
82
83 /* Requests */
84
85 extern bool send_id(struct connection_t *);
86 extern bool send_metakey(struct connection_t *);
87 extern bool send_metakey_ec(struct connection_t *);
88 extern bool send_challenge(struct connection_t *);
89 extern bool send_chal_reply(struct connection_t *);
90 extern bool send_ack(struct connection_t *);
91 extern bool send_status(struct connection_t *, int, const char *);
92 extern bool send_error(struct connection_t *, int,const  char *);
93 extern bool send_termreq(struct connection_t *);
94 extern bool send_ping(struct connection_t *);
95 extern bool send_pong(struct connection_t *);
96 extern bool send_add_subnet(struct connection_t *, const struct subnet_t *);
97 extern bool send_del_subnet(struct connection_t *, const struct subnet_t *);
98 extern bool send_add_edge(struct connection_t *, const struct edge_t *);
99 extern bool send_del_edge(struct connection_t *, const struct edge_t *);
100 extern void send_key_changed(void);
101 extern bool send_req_key(struct node_t *);
102 extern bool send_ans_key(struct node_t *);
103 extern bool send_tcppacket(struct connection_t *, const struct vpn_packet_t *);
104
105 /* Request handlers  */
106
107 extern bool id_h(struct connection_t *, char *);
108 extern bool metakey_h(struct connection_t *, char *);
109 extern bool challenge_h(struct connection_t *, char *);
110 extern bool chal_reply_h(struct connection_t *, char *);
111 extern bool ack_h(struct connection_t *, char *);
112 extern bool status_h(struct connection_t *, char *);
113 extern bool error_h(struct connection_t *, char *);
114 extern bool termreq_h(struct connection_t *, char *);
115 extern bool ping_h(struct connection_t *, char *);
116 extern bool pong_h(struct connection_t *, char *);
117 extern bool add_subnet_h(struct connection_t *, char *);
118 extern bool del_subnet_h(struct connection_t *, char *);
119 extern bool add_edge_h(struct connection_t *, char *);
120 extern bool del_edge_h(struct connection_t *, char *);
121 extern bool key_changed_h(struct connection_t *, char *);
122 extern bool req_key_h(struct connection_t *, char *);
123 extern bool ans_key_h(struct connection_t *, char *);
124 extern bool tcppacket_h(struct connection_t *, char *);
125 extern bool control_h(struct connection_t *, char *);
126
127 #endif                                                  /* __TINC_PROTOCOL_H__ */