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