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