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