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

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