]> git.meshlink.io Git - meshlink/blob - src/protocol.h
Ensure we can pass arbitrary binary blobs for keys.
[meshlink] / src / protocol.h
1 #ifndef MESHLINK_PROTOCOL_H
2 #define MESHLINK_PROTOCOL_H
3
4 /*
5     protocol.h -- header for protocol.c
6     Copyright (C) 2014, 2017 Guus Sliepen <guus@meshlink.io>
7
8     This program is free software; you can redistribute it and/or modify
9     it under the terms of the GNU General Public License as published by
10     the Free Software Foundation; either version 2 of the License, or
11     (at your option) any later version.
12
13     This program is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16     GNU General Public License for more details.
17
18     You should have received a copy of the GNU General Public License along
19     with this program; if not, write to the Free Software Foundation, Inc.,
20     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 */
22
23 #include "ecdsa.h"
24
25 /* Protocol version. Different major versions are incompatible. */
26
27 #define PROT_MAJOR 17
28 #define PROT_MINOR 3 /* Should not exceed 255! */
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         /* Tinc 1.1 requests */
48         CONTROL,
49         REQ_PUBKEY, ANS_PUBKEY,
50         REQ_SPTPS,
51         LAST                                            /* Guardian for the highest request number */
52 } request_t;
53
54 typedef struct past_request_t {
55         const char *request;
56         time_t firstseen;
57 } past_request_t;
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
71 /* Basic functions */
72
73 extern bool send_request(struct meshlink_handle *mesh, struct connection_t *, struct submesh_t *s, const char *, ...) __attribute__((__format__(printf, 4, 5)));
74 extern void forward_request(struct meshlink_handle *mesh, struct connection_t *, struct submesh_t *, const char *);
75 extern bool receive_request(struct meshlink_handle *mesh, struct connection_t *, const char *);
76 extern bool check_id(const char *);
77
78 extern void init_requests(struct meshlink_handle *mesh);
79 extern void exit_requests(struct meshlink_handle *mesh);
80 extern bool seen_request(struct meshlink_handle *mesh, const char *);
81
82 /* Requests */
83
84 extern bool send_id(struct meshlink_handle *mesh, struct connection_t *);
85 extern bool send_ack(struct meshlink_handle *mesh, struct connection_t *);
86 extern bool send_ping(struct meshlink_handle *mesh, struct connection_t *);
87 extern bool send_pong(struct meshlink_handle *mesh, struct connection_t *);
88 extern bool send_add_edge(struct meshlink_handle *mesh, struct connection_t *, const struct edge_t *, int contradictions);
89 extern bool send_del_edge(struct meshlink_handle *mesh, struct connection_t *, const struct edge_t *, int contradictions);
90 extern void send_key_changed(struct meshlink_handle *mesh);
91 extern bool send_req_key(struct meshlink_handle *mesh, struct node_t *);
92
93 /* Request handlers  */
94
95 extern bool id_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
96 extern bool ack_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
97 extern bool status_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
98 extern bool error_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
99 extern bool termreq_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
100 extern bool ping_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
101 extern bool pong_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
102 extern bool add_edge_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
103 extern bool del_edge_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
104 extern bool key_changed_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
105 extern bool req_key_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
106 extern bool ans_key_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
107 extern bool tcppacket_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
108
109 #endif