]> git.meshlink.io Git - meshlink/blob - src/protocol.h
Simplify reading lines from configuration files.
[meshlink] / 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 versions are incompatible,
25    incompatible version have different protocols.
26  */
27
28 #define PROT_CURRENT 17
29
30 /* Silly Windows */
31
32 #ifdef ERROR
33 #undef ERROR
34 #endif
35
36 /* Request numbers */
37
38 typedef enum request_t {
39         ALL = -1,                                       /* Guardian for allow_request */
40         ID = 0, METAKEY, CHALLENGE, CHAL_REPLY, ACK,
41         STATUS, ERROR, TERMREQ,
42         PING, PONG,
43         ADD_SUBNET, DEL_SUBNET,
44         ADD_EDGE, DEL_EDGE,
45         KEY_CHANGED, REQ_KEY, ANS_KEY,
46         PACKET,
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
57 /* Maximum size of strings in a request.
58  * scanf terminates %2048s with a NUL character,
59  * but the NUL character can be written after the 2048th non-NUL character.
60  */
61
62 #define MAX_STRING_SIZE 2049
63 #define MAX_STRING "%2048s"
64
65 #include "edge.h"
66 #include "net.h"
67 #include "node.h"
68 #include "subnet.h"
69
70 /* Basic functions */
71
72 extern bool send_request(struct connection_t *, const char *, ...) __attribute__ ((__format__(printf, 2, 3)));
73 extern void forward_request(struct connection_t *);
74 extern bool receive_request(struct connection_t *);
75 extern bool check_id(const char *);
76
77 extern void init_requests(void);
78 extern void exit_requests(void);
79 extern bool seen_request(char *);
80 extern void age_past_requests(void);
81
82 /* Requests */
83
84 extern bool send_id(struct connection_t *);
85 extern bool send_metakey(struct connection_t *);
86 extern bool send_challenge(struct connection_t *);
87 extern bool send_chal_reply(struct connection_t *);
88 extern bool send_ack(struct connection_t *);
89 extern bool send_status(struct connection_t *, int, const char *);
90 extern bool send_error(struct connection_t *, int,const  char *);
91 extern bool send_termreq(struct connection_t *);
92 extern bool send_ping(struct connection_t *);
93 extern bool send_pong(struct connection_t *);
94 extern bool send_add_subnet(struct connection_t *, const struct subnet_t *);
95 extern bool send_del_subnet(struct connection_t *, const struct subnet_t *);
96 extern bool send_add_edge(struct connection_t *, const struct edge_t *);
97 extern bool send_del_edge(struct connection_t *, const struct edge_t *);
98 extern void send_key_changed();
99 extern bool send_req_key(struct node_t *);
100 extern bool send_ans_key(struct node_t *);
101 extern bool send_tcppacket(struct connection_t *, struct vpn_packet_t *);
102
103 /* Request handlers  */
104
105 extern bool id_h(struct connection_t *);
106 extern bool metakey_h(struct connection_t *);
107 extern bool challenge_h(struct connection_t *);
108 extern bool chal_reply_h(struct connection_t *);
109 extern bool ack_h(struct connection_t *);
110 extern bool status_h(struct connection_t *);
111 extern bool error_h(struct connection_t *);
112 extern bool termreq_h(struct connection_t *);
113 extern bool ping_h(struct connection_t *);
114 extern bool pong_h(struct connection_t *);
115 extern bool add_subnet_h(struct connection_t *);
116 extern bool del_subnet_h(struct connection_t *);
117 extern bool add_edge_h(struct connection_t *);
118 extern bool del_edge_h(struct connection_t *);
119 extern bool key_changed_h(struct connection_t *);
120 extern bool req_key_h(struct connection_t *);
121 extern bool ans_key_h(struct connection_t *);
122 extern bool tcppacket_h(struct connection_t *);
123
124 #endif                                                  /* __TINC_PROTOCOL_H__ */