Start documenting the SPTPS protocol.
[tinc] / src / protocol_misc.c
1 /*
2     protocol_misc.c -- handle the meta-protocol, miscellaneous functions
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 #include "system.h"
22
23 #include "conf.h"
24 #include "connection.h"
25 #include "logger.h"
26 #include "meta.h"
27 #include "net.h"
28 #include "netutl.h"
29 #include "protocol.h"
30 #include "utils.h"
31
32 int maxoutbufsize = 0;
33
34 /* Status and error notification routines */
35
36 bool send_status(connection_t *c, int statusno, const char *statusstring) {
37         if(!statusstring)
38                 statusstring = "Status";
39
40         return send_request(c, "%d %d %s", STATUS, statusno, statusstring);
41 }
42
43 bool status_h(connection_t *c, char *request) {
44         int statusno;
45         char statusstring[MAX_STRING_SIZE];
46
47         if(sscanf(request, "%*d %d " MAX_STRING, &statusno, statusstring) != 2) {
48                 logger(DEBUG_ALWAYS, LOG_ERR, "Got bad %s from %s (%s)", "STATUS",
49                            c->name, c->hostname);
50                 return false;
51         }
52
53         logger(DEBUG_STATUS, LOG_NOTICE, "Status message from %s (%s): %d: %s",
54                            c->name, c->hostname, statusno, statusstring);
55
56         return true;
57 }
58
59 bool send_error(connection_t *c, int err, const char *errstring) {
60         if(!errstring)
61                 errstring = "Error";
62
63         return send_request(c, "%d %d %s", ERROR, err, errstring);
64 }
65
66 bool error_h(connection_t *c, char *request) {
67         int err;
68         char errorstring[MAX_STRING_SIZE];
69
70         if(sscanf(request, "%*d %d " MAX_STRING, &err, errorstring) != 2) {
71                 logger(DEBUG_ALWAYS, LOG_ERR, "Got bad %s from %s (%s)", "ERROR",
72                            c->name, c->hostname);
73                 return false;
74         }
75
76         logger(DEBUG_ERROR, LOG_NOTICE, "Error message from %s (%s): %d: %s",
77                            c->name, c->hostname, err, errorstring);
78
79         return false;
80 }
81
82 bool send_termreq(connection_t *c) {
83         return send_request(c, "%d", TERMREQ);
84 }
85
86 bool termreq_h(connection_t *c, char *request) {
87         return false;
88 }
89
90 bool send_ping(connection_t *c) {
91         c->status.pinged = true;
92         c->last_ping_time = time(NULL);
93
94         return send_request(c, "%d", PING);
95 }
96
97 bool ping_h(connection_t *c, char *request) {
98         return send_pong(c);
99 }
100
101 bool send_pong(connection_t *c) {
102         return send_request(c, "%d", PONG);
103 }
104
105 bool pong_h(connection_t *c, char *request) {
106         c->status.pinged = false;
107
108         /* Succesful connection, reset timeout if this is an outgoing connection. */
109
110         if(c->outgoing)
111                 c->outgoing->timeout = 0;
112
113         return true;
114 }
115
116 /* Sending and receiving packets via TCP */
117
118 bool send_tcppacket(connection_t *c, const vpn_packet_t *packet) {
119         /* If there already is a lot of data in the outbuf buffer, discard this packet.
120            We use a very simple Random Early Drop algorithm. */
121
122         if(2.0 * c->outbuf.len / (float)maxoutbufsize - 1 > (float)rand()/(float)RAND_MAX)
123                 return true;
124
125         if(!send_request(c, "%d %hd", PACKET, packet->len))
126                 return false;
127
128         return send_meta(c, (char *)packet->data, packet->len);
129 }
130
131 bool tcppacket_h(connection_t *c, char *request) {
132         short int len;
133
134         if(sscanf(request, "%*d %hd", &len) != 1) {
135                 logger(DEBUG_ALWAYS, LOG_ERR, "Got bad %s from %s (%s)", "PACKET", c->name,
136                            c->hostname);
137                 return false;
138         }
139
140         /* Set reqlen to len, this will tell receive_meta() that a tcppacket is coming. */
141
142         c->tcplen = len;
143
144         return true;
145 }