Ensure all parameters have names in header files.
[tinc] / src / protocol.h
index b092681..a055f28 100644 (file)
@@ -1,6 +1,10 @@
+#ifndef TINC_PROTOCOL_H
+#define TINC_PROTOCOL_H
+
 /*
     protocol.h -- header for protocol.c
-    Copyright (C) 1999 Ivo Timmermans <zarq@iname.com>
+    Copyright (C) 1999-2005 Ivo Timmermans,
+                  2000-2015 Guus Sliepen <guus@tinc-vpn.org>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef __TINC_PROTOCOL_H__
-#define __TINC_PROTOCOL_H__
+/* Protocol version. Different versions are incompatible,
+   incompatible version have different protocols.
+ */
+
+#define PROT_CURRENT 17
+
+/* Silly Windows */
+
+#ifdef ERROR
+#undef ERROR
+#endif
+
+/* Request numbers */
+
+typedef enum request_t {
+       PROXY = -2,
+       ALL = -1,                                       /* Guardian for allow_request */
+       ID = 0, METAKEY, CHALLENGE, CHAL_REPLY, ACK,
+       STATUS, ERROR, TERMREQ,
+       PING, PONG,
+       ADD_SUBNET, DEL_SUBNET,
+       ADD_EDGE, DEL_EDGE,
+       KEY_CHANGED, REQ_KEY, ANS_KEY,
+       PACKET,
+       LAST                                            /* Guardian for the highest request number */
+} request_t;
+
+typedef struct past_request_t {
+       char *request;
+       time_t firstseen;
+} past_request_t;
+
+extern bool tunnelserver;
+extern bool strictsubnets;
 
+/* Maximum size of strings in a request.
+ * scanf terminates %2048s with a NUL character,
+ * but the NUL character can be written after the 2048th non-NUL character.
+ */
+
+#define MAX_STRING_SIZE 2049
+#define MAX_STRING "%2048s"
+
+#include "edge.h"
 #include "net.h"
+#include "node.h"
+#include "subnet.h"
+
+/* Basic functions */
+
+extern bool send_request(struct connection_t *c, const char *format, ...) __attribute__((__format__(printf, 2, 3)));
+extern void forward_request(struct connection_t *c);
+extern bool receive_request(struct connection_t *c);
+extern bool check_id(const char *name);
+
+extern void init_requests(void);
+extern void exit_requests(void);
+extern bool seen_request(char *request);
+extern void age_past_requests(void);
+
+/* Requests */
+
+extern bool send_id(struct connection_t *c);
+extern bool send_metakey(struct connection_t *c);
+extern bool send_challenge(struct connection_t *c);
+extern bool send_chal_reply(struct connection_t *c);
+extern bool send_ack(struct connection_t *c);
+extern bool send_ping(struct connection_t *c);
+extern bool send_pong(struct connection_t *c);
+extern bool send_add_subnet(struct connection_t *c, const struct subnet_t *subnet);
+extern bool send_del_subnet(struct connection_t *c, const struct subnet_t *subnet);
+extern bool send_add_edge(struct connection_t *c, const struct edge_t *e);
+extern bool send_del_edge(struct connection_t *c, const struct edge_t *e);
+extern void send_key_changed(void);
+extern bool send_req_key(struct node_t *n);
+extern bool send_ans_key(struct node_t *n);
+extern bool send_tcppacket(struct connection_t *c, const struct vpn_packet_t *packet);
+
+/* Request handlers  */
 
-enum {
-  PROT_RESERVED = 0,                 /* reserved: do not use. */
-  PROT_NOT_IN_USE,
-  PROT_TOO_OLD = 2,
-  PROT_3,
-  PROT_4,
-  PROT_ECHELON,
-  PROT_CURRENT,                      /* protocol currently in use */
-};
-
-enum {
-  ACK = 1,              /* acknowledged */
-  AUTH_S_INIT = 10,     /* initiate authentication */
-  AUTH_C_INIT,
-  AUTH_S_SPP,           /* send passphrase */
-  AUTH_C_SPP,
-  AUTH_S_SKEY,          /* send g^k */
-  AUTH_C_SKEY,
-  AUTH_S_SACK,          /* send ack */
-  AUTH_C_RACK,          /* waiting for ack */
-  TERMREQ = 30,         /* terminate connection */
-  PINGTIMEOUT,          /* terminate due to ping t.o. */
-  DEL_HOST,            /* forward a termreq to others */
-  PING = 40,            /* ping */
-  PONG,
-  ADD_HOST = 60,        /* Add new given host to connection list */
-  BASIC_INFO,           /* some basic info follows */
-  PASSPHRASE,           /* encrypted passphrase */
-  PUBLIC_KEY,           /* public key in base-36 */
-  HOLD = 80,            /* don't send any data */
-  RESUME,               /* resume dataflow with new encryption key */
-  CALCULATE = 100,      /* calculate the following numer^privkey and send me the result */  
-  CALC_RES,             /* result of the above */
-  ALMOST_KEY,           /* this number^privkey is the shared key */
-  REQ_KEY = 160,        /* request public key */
-  ANS_KEY,              /* answer to such request */
-  KEY_CHANGED,         /* public key has changed */
-};
-
-extern int (*request_handlers[256])(conn_list_t*);
-
-extern int send_ping(conn_list_t*);
-extern int send_basic_info(conn_list_t *);
-extern int send_termreq(conn_list_t *);
-extern int send_timeout(conn_list_t *);
-extern int send_key_request(ip_t);
-extern void send_key_changed2(void);
-
-#endif /* __TINC_PROTOCOL_H__ */
+extern bool id_h(struct connection_t *c);
+extern bool metakey_h(struct connection_t *c);
+extern bool challenge_h(struct connection_t *c);
+extern bool chal_reply_h(struct connection_t *c);
+extern bool ack_h(struct connection_t *c);
+extern bool ping_h(struct connection_t *c);
+extern bool pong_h(struct connection_t *c);
+extern bool add_subnet_h(struct connection_t *c);
+extern bool del_subnet_h(struct connection_t *c);
+extern bool add_edge_h(struct connection_t *c);
+extern bool del_edge_h(struct connection_t *c);
+extern bool key_changed_h(struct connection_t *c);
+extern bool req_key_h(struct connection_t *c);
+extern bool ans_key_h(struct connection_t *c);
+extern bool tcppacket_h(struct connection_t *c);
 
+#endif