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

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