1 #ifndef MESHLINK_PROTOCOL_H
2 #define MESHLINK_PROTOCOL_H
5 protocol.h -- header for protocol.c
6 Copyright (C) 2014, 2017 Guus Sliepen <guus@meshlink.io>
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.
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.
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.
25 /* Protocol version. Different major versions are incompatible. */
28 #define PROT_MINOR 3 /* Should not exceed 255! */
38 typedef enum request_t {
39 ALL = -1, /* Guardian for allow_request */
40 ID = 0, METAKEY, CHALLENGE, CHAL_REPLY, ACK,
41 STATUS, ERROR, TERMREQ,
43 ADD_SUBNET, DEL_SUBNET,
45 KEY_CHANGED, REQ_KEY, ANS_KEY,
47 /* Extended requests */
49 REQ_PUBKEY, ANS_PUBKEY,
55 typedef enum request_error_t {
60 typedef struct past_request_t {
65 /* Protocol support flags */
67 static const uint32_t PROTOCOL_TINY = 1; // Peer is using meshlink-tiny
69 /* Maximum size of strings in a request.
70 * scanf terminates %2048s with a NUL character,
71 * but the NUL character can be written after the 2048th non-NUL character.
74 #define MAX_STRING_SIZE 2049
75 #define MAX_STRING "%2048s"
83 bool send_request(struct meshlink_handle *mesh, struct connection_t *, const struct submesh_t *s, const char *, ...) __attribute__((__format__(printf, 4, 5)));
84 void forward_request(struct meshlink_handle *mesh, struct connection_t *, const struct submesh_t *, const char *);
85 bool receive_request(struct meshlink_handle *mesh, struct connection_t *, const char *);
86 bool check_id(const char *);
88 void init_requests(struct meshlink_handle *mesh);
89 void exit_requests(struct meshlink_handle *mesh);
90 bool seen_request(struct meshlink_handle *mesh, const char *);
94 bool send_id(struct meshlink_handle *mesh, struct connection_t *);
95 bool send_ack(struct meshlink_handle *mesh, struct connection_t *);
96 bool send_error(struct meshlink_handle *mesh, struct connection_t *, request_error_t, const char *);
97 bool send_ping(struct meshlink_handle *mesh, struct connection_t *);
98 bool send_pong(struct meshlink_handle *mesh, struct connection_t *);
99 bool send_add_edge(struct meshlink_handle *mesh, struct connection_t *, const struct edge_t *, int contradictions);
100 bool send_del_edge(struct meshlink_handle *mesh, struct connection_t *, const struct edge_t *, int contradictions);
101 bool send_req_key(struct meshlink_handle *mesh, struct node_t *);
102 bool send_canonical_address(struct meshlink_handle *mesh, struct node_t *);
103 bool send_raw_packet(struct meshlink_handle *mesh, struct connection_t *, const vpn_packet_t *);
105 /* Request handlers */
107 bool id_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
108 bool ack_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
109 bool status_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
110 bool error_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
111 bool termreq_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
112 bool ping_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
113 bool pong_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
114 bool add_edge_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
115 bool del_edge_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
116 bool key_changed_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
117 bool req_key_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
118 bool ans_key_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
119 bool tcppacket_h(struct meshlink_handle *mesh, struct connection_t *, const char *);
120 bool raw_packet_h(struct meshlink_handle *mesh, struct connection_t *, const char *);