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

   1 /*
   2     meshlink.h -- MeshLink API
   3     Copyright (C) 2014 Guus Sliepen <guus@meshlink.io>
   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 #ifndef MESHLINK_H
  21 #define MESHLINK_H
  22
  23 #include <stdbool.h>
  24 #include <stddef.h>
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /// A handle for an instance of MeshLink.
  31 typedef struct meshlink_handle meshlink_handle_t;
  32
  33 /// A handle for a MeshLink node.
  34 typedef struct meshlink_node meshlink_node_t;
  35
  36 /// Code of most recent error encountered.
  37 typedef enum {
  38         MESHLINK_OK,     // Everything is fine
  39         MESHLINK_ENOMEM, // Out of memory
  40         MESHLINK_ENOENT, // Node is not known
  41 } meshlink_errno_t;
  42 typedef struct outpacketqueue {
  43         meshlink_node_t *destination;
  44         const void *data;
  45         unsigned int len;
  46 } outpacketqueue_t;
  47
  48 #ifndef MESHLINK_INTERNAL_H
  49
  50 struct meshlink_handle {
  51         meshlink_errno_t meshlink_errno; /// Code of the last encountered error.
  52         const char *errstr;     /// Textual representation of most recent error encountered.
  53 };
  54
  55 struct meshlink_node {
  56         const char *name; // Textual name of this node.
  57         void *priv;       // Private pointer which the application can set at will.
  58 };
  59
  60 #endif // MESHLINK_INTERNAL_H
  61
  62 /// Get the text for the given MeshLink error code.
  63 /** This function returns a pointer to the string containing the description of the given error code.
  64  *
  65  *  @param errno    An error code returned by MeshLink.
  66  *
  67  *  @return         A pointer to a string containing the description of the error code.
  68  */
  69 extern const char *meshlink_strerror(meshlink_errno_t errno);
  70
  71 /// Initialize MeshLink's configuration directory.
  72 /** This function causes MeshLink to initialize its configuration directory,
  73  *  if it hasn't already been initialized.
  74  *  It only has to be run the first time the application starts,
  75  *  but it is not a problem if it is run more than once, as long as
  76  *  the arguments given are the same.
  77  *
  78  *  This function does not start any network I/O yet. The application should
  79  *  first set callbacks, and then call meshlink_start().
  80  *
  81  *  @param confbase The directory in which MeshLink will store its configuration files.
  82  *  @param name     The name which this instance of the application will use in the mesh.
  83  *
  84  *  @return         This function will return true if MeshLink has succesfully set up its configuration files, false otherwise.
  85  */
  86 extern meshlink_handle_t *meshlink_open(const char *confbase, const char *name);
  87
  88 /// Start MeshLink.
  89 /** This function causes MeshLink to open network sockets, make outgoing connections, and
  90  *  create a new thread, which will handle all network I/O.
  91  *
  92  *  @param confbase The directory in which MeshLink will store its configuration files.
  93  *
  94  *  @return         This function will return true if MeshLink has succesfully started its thread, false otherwise.
  95  */
  96 extern bool meshlink_start(meshlink_handle_t *mesh);
  97
  98 /// Stop MeshLink.
  99 /** This function causes MeshLink to disconnect from all other nodes,
 100  *  close all sockets, and shut down its own thread.
 101  *
 102  * @param handle    A handle which represents an instance of MeshLink.
 103  */
 104 extern void meshlink_stop(meshlink_handle_t *mesh);
 105
 106 /// Close the MeshLink handle.
 107 /** This function calls meshlink_stop() if necessary,
 108  *  and frees all memory allocated by MeshLink.
 109  *  Afterwards, the handle and any pointers to a struct meshlink_node are invalid.
 110  *
 111  * @param handle    A handle which represents an instance of MeshLink.
 112  */
 113 extern void meshlink_close(meshlink_handle_t *mesh);
 114
 115 /// A callback for receiving data from the mesh.
 116 /** @param handle    A handle which represents an instance of MeshLink.
 117  *  @param source    A pointer to a meshlink_node_t describing the source of the data.
 118  *  @param data      A pointer to a buffer containing the data sent by the source.
 119  *  @param len       The length of the received data.
 120  */
 121 typedef void (*meshlink_receive_cb_t)(meshlink_handle_t *mesh, meshlink_node_t *source, const void *data, size_t len);
 122
 123 /// Set the receive callback.
 124 /** This functions sets the callback that is called whenever another node sends data to the local node.
 125  *  The callback is run in MeshLink's own thread.
 126  *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 127  *  to hand the data over to the application's thread.
 128  *  The callback should also not block itself and return as quickly as possible.
 129  *
 130  *  @param handle    A handle which represents an instance of MeshLink.
 131  *  @param cb        A pointer to the function which will be called when another node sends data to the local node.
 132  */
 133 extern void meshlink_set_receive_cb(meshlink_handle_t *mesh, meshlink_receive_cb_t cb);
 134
 135 /// A callback reporting node status changes.
 136 /** @param handle     A handle which represents an instance of MeshLink.
 137  *  @param node       A pointer to a meshlink_node_t describing the node whose status changed.
 138  *  @param reachable  True if the node is reachable, false otherwise.
 139  */
 140 typedef void (*meshlink_node_status_cb_t)(meshlink_handle_t *mesh, meshlink_node_t *node, bool reachable);
 141
 142 /// Set the node status callback.
 143 /** This functions sets the callback that is called whenever another node's status changed.
 144  *  The callback is run in MeshLink's own thread.
 145  *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 146  *  to hand the data over to the application's thread.
 147  *  The callback should also not block itself and return as quickly as possible.
 148  *
 149  *  @param handle    A handle which represents an instance of MeshLink.
 150  *  @param cb        A pointer to the function which will be called when another node's status changes.
 151  */
 152 extern void meshlink_set_node_status_cb(meshlink_handle_t *mesh, meshlink_node_status_cb_t cb);
 153
 154 /// Severity of log messages generated by MeshLink.
 155 typedef enum {
 156         MESHLINK_DEBUG,    // Internal debugging messages. Only useful during application development.
 157         MESHLINK_INFO,     // Informational messages.
 158         MESHLINK_WARNING,  // Warnings which might indicate problems, but which are not real errors.
 159         MESHLINK_ERROR,    // Errors which hamper correct functioning of MeshLink, without causing it to fail completely.
 160         MESHLINK_CRITICAL, // Critical errors which cause MeshLink to fail completely.
 161 } meshlink_log_level_t;
 162
 163 /// A callback for receiving log messages generated by MeshLink.
 164 /** @param handle    A handle which represents an instance of MeshLink.
 165  *  @param level     An enum describing the severity level of the message.
 166  *  @param text      A pointer to a string containing the textual log message.
 167  */
 168 typedef void (*meshlink_log_cb_t)(meshlink_handle_t *mesh, meshlink_log_level_t level, const char *text);
 169
 170 /// Set the log callback.
 171 /** This functions sets the callback that is called whenever MeshLink has some information to log.
 172  *  The callback is run in MeshLink's own thread.
 173  *  It is important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 174  *  to hand the data over to the application's thread.
 175  *  The callback should also not block itself and return as quickly as possible.
 176  *
 177  *  @param handle    A handle which represents an instance of MeshLink.
 178  *  @param level     An enum describing the minimum severity level. Debugging information with a lower level will not trigger the callback.
 179  *  @param cb        A pointer to the function which will be called when another node sends data to the local node.
 180  */
 181 extern void meshlink_set_log_cb(meshlink_handle_t *mesh, meshlink_log_level_t level, meshlink_log_cb_t cb);
 182
 183 /// Send data to another node.
 184 /** This functions sends one packet of data to another node in the mesh.
 185  *  The packet is sent using UDP semantics, which means that
 186  *  the packet is sent as one unit and is received as one unit,
 187  *  and that there is no guarantee that the packet will arrive at the destination.
 188  *  The application should take care of getting an acknowledgement and retransmission if necessary.
 189  *
 190  *  @param handle       A handle which represents an instance of MeshLink.
 191  *  @param destination  A pointer to a meshlink_node_t describing the destination for the data.
 192  *  @param data         A pointer to a buffer containing the data to be sent to the source.
 193  *  @param len          The length of the data.
 194  *  @return             This function will return true if MeshLink has queued the message for transmission, and false otherwise.
 195  *                      A return value of true does not guarantee that the message will actually arrive at the destination.
 196  */
 197 extern bool meshlink_send(meshlink_handle_t *mesh, meshlink_node_t *destination, const void *data, unsigned int len);
 198
 199 /// Get a handle for a specific node.
 200 /** This function returns a handle for the node with the given name.
 201  *
 202  *  @param handle       A handle which represents an instance of MeshLink.
 203  *  @param name         The name of the node for which a handle is requested.
 204  *
 205  *  @return             A pointer to a meshlink_node_t which represents the requested node,
 206  *                      or NULL if the requested node does not exist.
 207  */
 208 extern meshlink_node_t *meshlink_get_node(meshlink_handle_t *mesh, const char *name);
 209
 210 /// Get a list of all nodes.
 211 /** This function returns a list with handles for all known nodes.
 212  *
 213  *  @param handle       A handle which represents an instance of MeshLink.
 214  *  @param nodes        A pointer to an array of pointers to meshlink_node_t, which should be allocated by the application.
 215  *  @param nmemb        The maximum number of pointers that can be stored in the nodes array.
 216  *
 217  *  @param return       The number of known nodes. This can be larger than nmemb, in which case not all nodes were stored in the nodes array.
 218  */
 219 extern size_t meshlink_get_all_nodes(meshlink_handle_t *mesh, meshlink_node_t **nodes, size_t nmemb);
 220
 221 /// Sign data using the local node's MeshLink key.
 222 /** This function signs data using the local node's MeshLink key.
 223  *  The generated signature can be securely verified by other nodes.
 224  *
 225  *  @param handle       A handle which represents an instance of MeshLink.
 226  *  @param data         A pointer to a buffer containing the data to be signed.
 227  *  @param len          The length of the data to be signed.
 228  *
 229  *  @return             This function returns a pointer to a string containing the signature, or NULL in case of an error.
 230  *                      The application should call free() after it has finished using the signature.
 231  */
 232 extern char *meshlink_sign(meshlink_handle_t *mesh, const char *data, size_t len);
 233
 234 /// Verify the signature generated by another node of a piece of data.
 235 /** This function verifies the signature that another node generated for a piece of data.
 236  *
 237  *  @param handle       A handle which represents an instance of MeshLink.
 238  *  @param source       A pointer to a meshlink_node_t describing the source of the signature.
 239  *  @param data         A pointer to a buffer containing the data to be verified.
 240  *  @param len          The length of the data to be verified.
 241  *  @param signature    A pointer to a string containing the signature.
 242  *
 243  *  @return             This function returns true if the signature is valid, false otherwise.
 244  */
 245 extern bool meshlink_verify(meshlink_handle_t *mesh, meshlink_node_t *source, const char *data, size_t len, const char *signature);
 246
 247 /// Add an Address for the local node.
 248 /** This function adds an Address for the local node, which will be used for invitation URLs.
 249  *
 250  *  @param mesh         A handle which represents an instance of MeshLink.
 251  *  @param address      A string containing the address, which can be either in numeric format or a hostname.
 252  *
 253  *  @return             This function returns true if the address was added, false otherwise.
 254  */
 255 extern bool meshlink_add_address(meshlink_handle_t *mesh, const char *address);
 256
 257 /// Invite another node into the mesh.
 258 /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
 259  *  The generated invitation is a string containing a URL.
 260  *  This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
 261  *  The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
 262  *
 263  *  @param handle       A handle which represents an instance of MeshLink.
 264  *  @param name         The name that the invitee will use in the mesh.
 265  *
 266  *  @return             This function returns a string that contains the invitation URL.
 267  *                      The application should call free() after it has finished using the URL.
 268  */
 269 extern char *meshlink_invite(meshlink_handle_t *mesh, const char *name);
 270
 271 /// Use an invitation to join a mesh.
 272 /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
 273  *  An invitation can only be used if the local node has never connected to other nodes before.
 274  *  After a succesfully accepted invitation, the name of the local node may have changed.
 275  *
 276  *  @param handle       A handle which represents an instance of MeshLink.
 277  *  @param invitation   A string containing the invitation URL.
 278  *
 279  *  @return             This function returns true if the local node joined the mesh it was invited to, false otherwise.
 280  */
 281 extern bool meshlink_join(meshlink_handle_t *mesh, const char *invitation);
 282
 283 /// Export the local node's key and addresses.
 284 /** This function generates a string that contains the local node's public key and one or more IP addresses.
 285  *  The application can pass it in some way to another node, which can then import it,
 286  *  granting the local node access to the other node's mesh.
 287  *
 288  *  @param handle       A handle which represents an instance of MeshLink.
 289  *
 290  *  @return             This function returns a string that contains the exported key and addresses.
 291  *                      The application should call free() after it has finished using this string.
 292  */
 293 extern char *meshlink_export(meshlink_handle_t *mesh);
 294
 295 /// Import another node's key and addresses.
 296 /** This function accepts a string containing the exported public key and addresses of another node.
 297  *  By importing this data, the local node grants the other node access to its mesh.
 298  *
 299  *  @param handle       A handle which represents an instance of MeshLink.
 300  *  @param data         A string containing the other node's exported key and addresses.
 301  *
 302  *  @return             This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise.
 303  */
 304 extern bool meshlink_import(meshlink_handle_t *mesh, const char *data);
 305
 306 /// Blacklist a node from the mesh.
 307 /** This function causes the local node to blacklist another node.
 308  *  The local node will drop any existing connections to that node,
 309  *  and will not send data to it nor accept any data received from it any more.
 310  *
 311  *  @param handle       A handle which represents an instance of MeshLink.
 312  *  @param node         A pointer to a meshlink_node_t describing the node to be blacklisted.
 313  */
 314 extern void meshlink_blacklist(meshlink_handle_t *mesh, meshlink_node_t *node);
 315
 316 #ifdef __cplusplus
 317 }
 318 #endif
 319
 320 #endif // MESHLINK_H