]> git.meshlink.io Git - meshlink/blob - src/libmeshlink.h
Change my email address.
[meshlink] / src / libmeshlink.h
1 /*
2     libmeshlink.h -- Tincd Library
3     Copyright (C) 2014 Guus Sliepen <guus@meshlink.io> Saverio Proto <zioproto@gmail.com>
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 #include "node.h"
22 //#include "tincctl.h"
23 #include "xalloc.h"
24 #include "logger.h"
25 #include "route.h"
26
27 extern char *hosts_dir;
28 extern FILE *fopenmask(const char *filename, const char *mode, mode_t perms);
29
30 extern int check_port(char *name);
31
32 bool tinc_main_thread(void * in);
33
34 /* OLD: tinc_configuration_t provides all information required to setup "/etc/tinc"
35 I think tinc_setup() should basically do what cmd_init() from src/tincctl.c does, except it doesn't have to generate a tinc-up script.
36 */
37 bool tinc_setup(const char* confbase, const char* name);
38
39 bool tinc_start(const char* path);
40
41 bool tinc_stop();
42
43 typedef struct tincpackethdr {
44   u_int8_t destination[16];
45   u_int8_t source[16];
46 } __attribute__ ((__packed__)) tincpackethdr;
47
48 // can be called from any thread
49 bool tinc_send_packet(node_t *receiver, const char* buf, unsigned int len);
50
51 // handler runs in tinc thread and should return immediately
52 bool tinc_set_packet_receive_handler(void (*handler)(const char* sender, const char* buf, unsigned int len));
53
54
55 //It might also be a good idea to add the option of looking up hosts by public
56 //key (fingerprints) instead of names.
57
58 node_t *tinc_get_host(const char *name);
59
60 bool tinc_get_hosts(node_t** hosts);
61 //This tinc_host_t is redundant because node_t should be ok
62 /*
63 struct tinc_host_t
64 {
65     char* name;
66     sockaddr_t address;
67     char *hostname;
68     char *fingerprint;
69     unsigned int maxpacketsize;
70     //TODO: anything else?
71 }
72 */
73 bool tinc_sign(const char* payload, unsigned int len, const char** signature);
74
75 int tinc_verify(const char* sender, const char* payload, unsigned int plen, const char* signature, unsigned int slen);
76
77 /*
78 TODO: It would be good to add a void pointer here that will be passed on to the
79 handler function whenever it is called, or have a void pointer in node_t
80 that can be filled in by the application. That way, you can easily link an
81 application-specific data structure to a node_t.
82 */
83 void channel_set_packet_send_handler(int (*handler)(const char* receiver, const char* buf, unsigned int len));
84 void channel_packet_receive_handler(const char* sender, const char* buf, unsigned int len);
85
86 bool channel_open(const char* partner, void(*read)(int id, const char* buf, unsigned int len), void(*result)(int result, int id));
87 void channel_close(int id);
88 bool channel_write(int id, const char* buf, unsigned int len, void(*result)(int result, int id, unsigned int written));
89
90
91 //We do need some more functions. First of all, we need to be able to add nodes
92 //to a VPN. To do that, either an invitation protocol should be used:
93
94 bool tinc_join_network(const char *invitation);
95 const char *tinc_generate_invitation(const char *name);
96
97 /*
98 Or two nodes should exchange some information (their name, address, public
99 key). If the application provides a way to exchange some data with another
100 node, then:
101 */
102
103 bool tinc_export(char *buf, size_t *len);
104 node_t *tinc_import(const char *buf, size_t len);
105 /*
106 Last but not least, some way to get rid of unwanted nodes. Simplest is a
107 function that just blacklists a node.
108 Which should immediately cause the local tincd to ignore any data from that
109 host from that point on. Of course, a somewhat centrally managed,
110 automatically distributed blacklist or whitelist would be the next step.
111 */
112 bool tinc_blacklist(node_t *host);
113
114
115
116