git.meshlink.io Git - meshlink/blob - src/protocol.c

   1 /*
   2     protocol.c -- handle the meta-protocol, basic functions
   3     Copyright (C) 2014-2017 Guus Sliepen <guus@meshlink.io>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include "system.h"
  21
  22 #include "conf.h"
  23 #include "connection.h"
  24 #include "logger.h"
  25 #include "meshlink_internal.h"
  26 #include "meta.h"
  27 #include "protocol.h"
  28 #include "utils.h"
  29 #include "xalloc.h"
  30 #include "submesh.h"
  31
  32 /* Jumptable for the request handlers */
  33
  34 static bool (*request_handlers[NUM_REQUESTS])(meshlink_handle_t *, connection_t *, const char *) = {
  35         [ID] = id_h,
  36         [ACK] = ack_h,
  37         [STATUS] = status_h,
  38         [ERROR] = error_h,
  39         [TERMREQ] = termreq_h,
  40         [PING] = ping_h,
  41         [PONG] = pong_h,
  42         [ADD_EDGE] = add_edge_h,
  43         [DEL_EDGE] = del_edge_h,
  44         [KEY_CHANGED] = key_changed_h,
  45         [REQ_KEY] = req_key_h,
  46         [ANS_KEY] = ans_key_h,
  47 };
  48
  49 /* Request names */
  50
  51 static const char *request_name[NUM_REQUESTS] = {
  52         [ID] = "ID",
  53         [ACK] = "ACK",
  54         [STATUS] = "STATUS",
  55         [ERROR] = "ERROR",
  56         [TERMREQ] = "TERMREQ",
  57         [PING] = "PING",
  58         [PONG] = "PONG",
  59         [ADD_EDGE] = "ADD_EDGE",
  60         [DEL_EDGE] = "DEL_EDGE",
  61         [KEY_CHANGED] = "KEY_CHANGED",
  62         [REQ_KEY] = "REQ_KEY",
  63         [ANS_KEY] = "ANS_KEY",
  64 };
  65
  66 bool check_id(const char *id) {
  67         if(!id || !*id) {
  68                 return false;
  69         }
  70
  71         for(; *id; id++)
  72                 if(!isalnum(*id) && *id != '_' && *id != '-') {
  73                         return false;
  74                 }
  75
  76         return true;
  77 }
  78
  79 /* Generic request routines - takes care of logging and error
  80    detection as well */
  81
  82 bool send_request(meshlink_handle_t *mesh, connection_t *c, const submesh_t *s, const char *format, ...) {
  83         assert(format);
  84         assert(*format);
  85
  86         if(!c) {
  87                 logger(mesh, MESHLINK_ERROR, "Trying to send request to non-existing connection");
  88                 return false;
  89         }
  90
  91         va_list args;
  92         char request[MAXBUFSIZE];
  93         int len;
  94
  95         /* Use vsnprintf instead of vxasprintf: faster, no memory
  96            fragmentation, cleanup is automatic, and there is a limit on the
  97            input buffer anyway */
  98
  99         va_start(args, format);
 100         len = vsnprintf(request, MAXBUFSIZE, format, args);
 101         va_end(args);
 102
 103         if(len < 0 || len > MAXBUFSIZE - 1) {
 104                 logger(mesh, MESHLINK_ERROR, "Output buffer overflow while sending request to %s", c->name);
 105                 return false;
 106         }
 107
 108         logger(mesh, MESHLINK_DEBUG, "Sending %s to %s: %s", request_name[atoi(request)], c->name, request);
 109
 110         request[len++] = '\n';
 111
 112         if(c == mesh->everyone) {
 113
 114                 if(s) {
 115                         broadcast_submesh_meta(mesh, NULL, s, request, len);
 116                 } else {
 117                         broadcast_meta(mesh, NULL, request, len);
 118                 }
 119
 120                 return true;
 121         } else {
 122                 return send_meta(mesh, c, request, len);
 123         }
 124 }
 125
 126 void forward_request(meshlink_handle_t *mesh, connection_t *from, const submesh_t *s, const char *request) {
 127         assert(from);
 128         assert(request);
 129         assert(*request);
 130
 131         logger(mesh, MESHLINK_DEBUG, "Forwarding %s from %s: %s", request_name[atoi(request)], from->name, request);
 132
 133         // Create a temporary newline-terminated copy of the request
 134         int len = strlen(request);
 135         char tmp[len + 1];
 136
 137         memcpy(tmp, request, len);
 138         tmp[len] = '\n';
 139
 140         if(s) {
 141                 broadcast_submesh_meta(mesh, from, s, tmp, sizeof(tmp));
 142         } else {
 143                 broadcast_meta(mesh, from, tmp, sizeof(tmp));
 144         }
 145 }
 146
 147 bool receive_request(meshlink_handle_t *mesh, connection_t *c, const char *request) {
 148         assert(request);
 149
 150         int reqno = atoi(request);
 151
 152         if(reqno || *request == '0') {
 153                 if((reqno < 0) || (reqno >= NUM_REQUESTS) || !request_handlers[reqno]) {
 154                         logger(mesh, MESHLINK_DEBUG, "Unknown request from %s: %s", c->name, request);
 155                         return false;
 156                 } else {
 157                         logger(mesh, MESHLINK_DEBUG, "Got %s from %s: %s", request_name[reqno], c->name, request);
 158                 }
 159
 160                 if((c->allow_request != ALL) && (c->allow_request != reqno) && (reqno != ERROR)) {
 161                         logger(mesh, MESHLINK_ERROR, "Unauthorized request from %s", c->name);
 162                         return false;
 163                 }
 164
 165                 if(!request_handlers[reqno](mesh, c, request)) {
 166                         /* Something went wrong. Probably scriptkiddies. Terminate. */
 167
 168                         logger(mesh, MESHLINK_ERROR, "Error while processing %s from %s", request_name[reqno], c->name);
 169                         return false;
 170                 }
 171         } else {
 172                 logger(mesh, MESHLINK_ERROR, "Bogus data received from %s", c->name);
 173                 return false;
 174         }
 175
 176         return true;
 177 }
 178
 179 static int past_request_compare(const past_request_t *a, const past_request_t *b) {
 180         return strcmp(a->request, b->request);
 181 }
 182
 183 static void free_past_request(past_request_t *r) {
 184         if(r->request) {
 185                 free((void *)r->request);
 186         }
 187
 188         free(r);
 189 }
 190
 191 static const int request_timeout = 60;
 192
 193 static void age_past_requests(event_loop_t *loop, void *data) {
 194         (void)data;
 195         meshlink_handle_t *mesh = loop->data;
 196         int left = 0, deleted = 0;
 197
 198         for splay_each(past_request_t, p, mesh->past_request_tree) {
 199                 if(p->firstseen + request_timeout <= mesh->loop.now.tv_sec) {
 200                         splay_delete_node(mesh->past_request_tree, splay_node), deleted++;
 201                 } else {
 202                         left++;
 203                 }
 204         }
 205
 206         if(left || deleted) {
 207                 logger(mesh, MESHLINK_DEBUG, "Aging past requests: deleted %d, left %d", deleted, left);
 208         }
 209
 210         if(left) {
 211                 timeout_set(&mesh->loop, &mesh->past_request_timeout, &(struct timespec) {
 212                         10, prng(mesh, TIMER_FUDGE)
 213                 });
 214         }
 215 }
 216
 217 bool seen_request(meshlink_handle_t *mesh, const char *request) {
 218         assert(request);
 219         assert(*request);
 220
 221         past_request_t *new, p = {.request = request};
 222
 223         if(splay_search(mesh->past_request_tree, &p)) {
 224                 logger(mesh, MESHLINK_DEBUG, "Already seen request");
 225                 return true;
 226         } else {
 227                 new = xmalloc(sizeof(*new));
 228                 new->request = xstrdup(request);
 229                 new->firstseen = mesh->loop.now.tv_sec;
 230
 231                 if(!mesh->past_request_tree->head) {
 232                         timeout_set(&mesh->loop, &mesh->past_request_timeout, &(struct timespec) {
 233                                 10, prng(mesh, TIMER_FUDGE)
 234                         });
 235                 }
 236
 237                 splay_insert(mesh->past_request_tree, new);
 238                 return false;
 239         }
 240 }
 241
 242 void init_requests(meshlink_handle_t *mesh) {
 243         assert(!mesh->past_request_tree);
 244
 245         mesh->past_request_tree = splay_alloc_tree((splay_compare_t) past_request_compare, (splay_action_t) free_past_request);
 246         timeout_add(&mesh->loop, &mesh->past_request_timeout, age_past_requests, NULL, &(struct timespec) {
 247                 0, 0
 248         });
 249 }
 250
 251 void exit_requests(meshlink_handle_t *mesh) {
 252         if(mesh->past_request_tree) {
 253                 splay_delete_tree(mesh->past_request_tree);
 254         }
 255
 256         mesh->past_request_tree = NULL;
 257
 258         timeout_del(&mesh->loop, &mesh->past_request_timeout);
 259 }