2 This file is part of GNUnet.
3 (C) 2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file mesh/gnunet-service-mesh_tunnel.h
23 * @brief mesh service; dealing with tunnels and crypto
24 * @author Bartlomiej Polot
26 * All functions in this file should use the prefix GMT (Gnunet Mesh Tunnel)
29 #ifndef GNUNET_SERVICE_MESH_TUNNEL_H
30 #define GNUNET_SERVICE_MESH_TUNNEL_H
35 #if 0 /* keep Emacsens' auto-indent happy */
41 #include "gnunet_util_lib.h"
44 * All the states a tunnel can be in.
49 * Uninitialized status, should never appear in operation.
54 * Path to the peer not known yet
56 MESH_TUNNEL3_SEARCHING,
59 * Request sent, not yet answered.
64 * Ephemeral key sent, waiting for peer's key.
66 MESH_TUNNEL3_KEY_SENT,
69 * Have peer's key, sent ping, waiting for pong.
71 MESH_TUNNEL3_PING_SENT,
74 * Peer connected and ready to accept data
79 * Peer connected previosly but not responding
81 MESH_TUNNEL3_RECONNECTING,
84 * New ephemeral key and ping sent, waiting for pong.
90 * Struct containing all information regarding a given peer
95 #include "gnunet-service-mesh_channel.h"
96 #include "gnunet-service-mesh_connection.h"
97 #include "gnunet-service-mesh_peer.h"
100 /******************************************************************************/
101 /******************************** API ***********************************/
102 /******************************************************************************/
105 * Initialize tunnel subsystem.
107 * @param c Configuration handle.
108 * @param key ECC private key, to derive all other keys and do crypto.
111 GMT_init (const struct GNUNET_CONFIGURATION_Handle *c,
112 const struct GNUNET_CRYPTO_EddsaPrivateKey *key);
115 * Shut down the tunnel subsystem.
123 * @param destination Peer this tunnel is towards.
126 GMT_new (struct MeshPeer *destination);
129 * Tunnel is empty: destroy it.
131 * Notifies all connections about the destruction.
133 * @param t Tunnel to destroy.
136 GMT_destroy_empty (struct MeshTunnel3 *t);
139 * Destroy tunnel if empty (no more channels).
141 * @param t Tunnel to destroy if empty.
144 GMT_destroy_if_empty (struct MeshTunnel3 *t);
147 * Destroy the tunnel.
149 * This function does not generate any warning traffic to clients or peers.
152 * Cancel messages belonging to this tunnel queued to neighbors.
153 * Free any allocated resources linked to the tunnel.
155 * @param t The tunnel to destroy.
158 GMT_destroy (struct MeshTunnel3 *t);
161 * Change the tunnel state.
163 * @param t Tunnel whose state to change.
164 * @param state New state.
167 GMT_change_state (struct MeshTunnel3* t, enum MeshTunnel3State state);
170 * Add a connection to a tunnel.
173 * @param c Connection.
176 GMT_add_connection (struct MeshTunnel3 *t, struct MeshConnection *c);
179 * Remove a connection from a tunnel.
182 * @param c Connection.
185 GMT_remove_connection (struct MeshTunnel3 *t, struct MeshConnection *c);
188 * Add a channel to a tunnel.
194 GMT_add_channel (struct MeshTunnel3 *t, struct MeshChannel *ch);
197 * Remove a channel from a tunnel.
203 GMT_remove_channel (struct MeshTunnel3 *t, struct MeshChannel *ch);
206 * Search for a channel by global ID.
208 * @param t Tunnel containing the channel.
209 * @param chid Public channel number.
211 * @return channel handler, NULL if doesn't exist
214 GMT_get_channel (struct MeshTunnel3 *t, MESH_ChannelNumber chid);
217 * Decrypt and demultiplex by message type. Call appropriate handler
219 * towards a channel of a local tunnel.
221 * @param t Tunnel this message came on.
222 * @param msg Message header.
223 * @param fwd Is this message fwd?
226 GMT_handle_encrypted (struct MeshTunnel3 *t,
227 const struct GNUNET_MESH_Encrypted *msg,
231 * Demultiplex an encapsulated KX message by message type.
233 * @param t Tunnel on which the message came.
234 * @param message KX message itself.
237 GMT_handle_kx (struct MeshTunnel3 *t,
238 const struct GNUNET_MessageHeader *message);
241 * Cache a message to be sent once tunnel is online.
243 * @param t Tunnel to hold the message.
244 * @param ch Channel the message is about.
245 * @param msg Message itself (copy will be made).
246 * @param fwd Is this fwd?
249 GMT_queue_data (struct MeshTunnel3 *t,
250 struct MeshChannel *ch,
251 struct GNUNET_MessageHeader *msg,
255 * Send all cached messages that we can, tunnel is online.
257 * @param t Tunnel that holds the messages.
258 * @param fwd Is this fwd?
261 GMT_send_queued_data (struct MeshTunnel3 *t, int fwd);
264 * @brief Use the given path for the tunnel.
265 * Update the next and prev hops (and RCs).
266 * (Re)start the path refresh in case the tunnel is locally owned.
268 * @param t Tunnel to update.
269 * @param p Path to use.
271 * @return Connection created.
273 struct MeshConnection *
274 GMT_use_path (struct MeshTunnel3 *t, struct MeshPeerPath *p);
277 * Count established (ready) connections of a tunnel.
279 * @param t Tunnel on which to count.
281 * @return Number of connections.
284 GMT_count_connections (struct MeshTunnel3 *t);
287 * Count channels of a tunnel.
289 * @param t Tunnel on which to count.
291 * @return Number of channels.
294 GMT_count_channels (struct MeshTunnel3 *t);
297 * Get the state of a tunnel.
301 * @return Tunnel's state.
303 enum MeshTunnel3State
304 GMT_get_state (struct MeshTunnel3 *t);
307 * Get the total buffer space for a tunnel.
309 * FIXME get a ch parameter in case of loopback tunnels
312 * @param fwd Is this for FWD traffic?
314 * @return Buffer space offered by all connections in the tunnel.
317 GMT_get_buffer (struct MeshTunnel3 *t, int fwd);
320 * Get the tunnel's destination.
324 * @return ID of the destination peer.
326 const struct GNUNET_PeerIdentity *
327 GMT_get_destination (struct MeshTunnel3 *t);
330 * Get the tunnel's next free Channel ID.
334 * @return ID of a channel free to use.
337 GMT_get_next_chid (struct MeshTunnel3 *t);
340 * Send ACK on one or more channels due to buffer in connections.
342 * @param t Channel which has some free buffer space.
343 * @param fwd Is this for FWD traffic? (ACK goes to root)
346 GMT_unchoke_channels (struct MeshTunnel3 *t, int fwd);
349 * Send ACK on one or more connections due to buffer space to the client.
351 * Iterates all connections of the tunnel and sends ACKs appropriately.
353 * @param t Tunnel which has some free buffer space.
354 * @param fwd Is this in for FWD traffic? (ACK goes dest->root)
357 GMT_send_acks (struct MeshTunnel3 *t, int fwd);
360 * Sends an already built message on a tunnel, encrypting it and
361 * choosing the best connection.
363 * @param message Message to send. Function modifies it.
364 * @param t Tunnel on which this message is transmitted.
365 * @param ch Channel on which this message is transmitted.
366 * @param fwd Is this a fwd message?
369 GMT_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
370 struct MeshTunnel3 *t,
371 struct MeshChannel *ch,
375 * Is the tunnel directed towards the local peer?
379 * @return GNUNET_YES if it is loopback.
382 GMT_is_loopback (const struct MeshTunnel3 *t);
385 * Is the tunnel using this path already?
390 * @return GNUNET_YES a connection uses this path.
393 GMT_is_path_used (const struct MeshTunnel3 *t, const struct MeshPeerPath *p);
396 * Get a cost of a path for a tunnel considering existing connections.
399 * @param path Candidate path.
401 * @return Cost of the path (path length + number of overlapping nodes)
404 GMT_get_path_cost (const struct MeshTunnel3 *t,
405 const struct MeshPeerPath *path);
408 * Get the static string for the peer this tunnel is directed.
412 * @return Static string the destination peer's ID.
415 GMT_2s (const struct MeshTunnel3 *t);
417 #if 0 /* keep Emacsens' auto-indent happy */
424 /* ifndef GNUNET_MESH_SERVICE_TUNNEL_H */
426 /* end of gnunet-mesh-service_tunnel.h */