3 This file is part of GNUnet.
4 Copyright (C) 2001-2017 GNUnet e.V.
6 GNUnet is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published
8 by the Free Software Foundation; either version 3, or (at your
9 option) any later version.
11 GNUnet is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNUnet; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA.
23 * @file cadet/gnunet-service-cadet-new_tunnels.h
24 * @brief Information we track per tunnel.
25 * @author Bartlomiej Polot
26 * @author Christian Grothoff
28 #ifndef GNUNET_SERVICE_CADET_TUNNELS_H
29 #define GNUNET_SERVICE_CADET_TUNNELS_H
31 #include "gnunet-service-cadet-new.h"
32 #include "cadet_protocol.h"
36 * How many connections would we like to have per tunnel?
38 #define DESIRED_CONNECTIONS_PER_TUNNEL 3
42 * All the encryption states a tunnel can be in.
44 enum CadetTunnelEState
47 * Uninitialized status, we need to send KX. We will stay
48 * in this state until the first connection is up.
50 CADET_TUNNEL_KEY_UNINITIALIZED,
53 * Ephemeral key sent, waiting for peer's key.
55 CADET_TUNNEL_KEY_SENT,
58 * Key received and we sent ours back, but we got no traffic yet.
59 * We will not yet send traffic, as this might have been a replay.
60 * The other (initiating) peer should send a CHANNEL_OPEN next
63 CADET_TUNNEL_KEY_PING,
66 * Handshake completed: session key available.
74 * Get the static string for the peer this tunnel is directed.
78 * @return Static string the destination peer's ID.
81 GCT_2s (const struct CadetTunnel *t);
85 * Create a tunnel to @a destionation. Must only be called
86 * from within #GCP_get_tunnel().
88 * @param destination where to create the tunnel to
89 * @return new tunnel to @a destination
92 GCT_create_tunnel (struct CadetPeer *destination);
96 * Destroys the tunnel @a t now, without delay. Used during shutdown.
98 * @param t tunnel to destroy
101 GCT_destroy_tunnel_now (struct CadetTunnel *t);
105 * Add a @a connection to the @a tunnel.
108 * @param cid connection identifer to use for the connection
109 * @param path path to use for the connection
110 * @return #GNUNET_OK on success,
111 * #GNUNET_SYSERR on failure (duplicate connection)
114 GCT_add_inbound_connection (struct CadetTunnel *t,
115 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cid,
116 struct CadetPeerPath *path);
120 * We lost a connection, remove it from our list and clean up
121 * the connection object itself.
123 * @param ct binding of connection to tunnel of the connection that was lost.
126 GCT_connection_lost (struct CadetTConnection *ct);
130 * Return the peer to which this tunnel goes.
133 * @return the destination of the tunnel
136 GCT_get_destination (struct CadetTunnel *t);
140 * Consider using the path @a p for the tunnel @a t.
141 * The tunnel destination is at offset @a off in path @a p.
143 * @param cls our tunnel
144 * @param path a path to our destination
145 * @param off offset of the destination on path @a path
148 GCT_consider_path (struct CadetTunnel *t,
149 struct CadetPeerPath *p,
154 * Add a channel to a tunnel.
158 * @return unique number identifying @a ch within @a t
160 struct GNUNET_CADET_ChannelTunnelNumber
161 GCT_add_channel (struct CadetTunnel *t,
162 struct CadetChannel *ch);
166 * Remove a channel from a tunnel.
170 * @param ctn unique number identifying @a ch within @a t
173 GCT_remove_channel (struct CadetTunnel *t,
174 struct CadetChannel *ch,
175 struct GNUNET_CADET_ChannelTunnelNumber ctn);
179 * Send a DESTROY message via the tunnel.
181 * @param t the tunnel to transmit over
182 * @param ctn ID of the channel to destroy
185 GCT_send_channel_destroy (struct CadetTunnel *t,
186 struct GNUNET_CADET_ChannelTunnelNumber ctn);
190 * Sends an already built message on a tunnel, encrypting it and
191 * choosing the best connection if not provided.
193 * @param message Message to send. Function modifies it.
194 * @param t Tunnel on which this message is transmitted.
195 * @param cont Continuation to call once message is really sent.
196 * @param cont_cls Closure for @c cont.
197 * @return Handle to cancel message.
199 struct CadetTunnelQueueEntry *
200 GCT_send (struct CadetTunnel *t,
201 const struct GNUNET_MessageHeader *message,
202 GNUNET_SCHEDULER_TaskCallback cont,
207 * Cancel a previously sent message while it's in the queue.
209 * ONLY can be called before the continuation given to the send
210 * function is called. Once the continuation is called, the message is
211 * no longer in the queue!
213 * @param q Handle to the queue entry to cancel.
216 GCT_send_cancel (struct CadetTunnelQueueEntry *q);
220 * Return the number of channels using a tunnel.
222 * @param t tunnel to count obtain the number of channels for
223 * @return number of channels using the tunnel
226 GCT_count_channels (struct CadetTunnel *t);
230 * Return the number of connections available for a tunnel.
232 * @param t tunnel to count obtain the number of connections for
233 * @return number of connections available for the tunnel
236 GCT_count_any_connections (struct CadetTunnel *t);
240 * Iterator over connections.
243 * @param c one of the connections
246 (*GCT_ConnectionIterator) (void *cls,
247 struct CadetConnection *c);
251 * Iterate over all connections of a tunnel.
253 * @param t Tunnel whose connections to iterate.
254 * @param iter Iterator.
255 * @param iter_cls Closure for @c iter.
258 GCT_iterate_connections (struct CadetTunnel *t,
259 GCT_ConnectionIterator iter,
264 * Iterator over channels.
267 * @param ch one of the channels
270 (*GCT_ChannelIterator) (void *cls,
271 struct CadetChannel *ch);
275 * Iterate over all channels of a tunnel.
277 * @param t Tunnel whose channels to iterate.
278 * @param iter Iterator.
279 * @param iter_cls Closure for @c iter.
282 GCT_iterate_channels (struct CadetTunnel *t,
283 GCT_ChannelIterator iter,
288 * Get the encryption state of a tunnel.
292 * @return Tunnel's encryption state.
294 enum CadetTunnelEState
295 GCT_get_estate (struct CadetTunnel *t);
301 * @param ct connection/tunnel combo that received encrypted message
302 * @param msg the key exchange message
305 GCT_handle_kx (struct CadetTConnection *ct,
306 const struct GNUNET_CADET_TunnelKeyExchangeMessage *msg);
310 * Handle encrypted message.
312 * @param ct connection/tunnel combo that received encrypted message
313 * @param msg the encrypted message to decrypt
316 GCT_handle_encrypted (struct CadetTConnection *ct,
317 const struct GNUNET_CADET_TunnelEncryptedMessage *msg);
321 * Log all possible info about the tunnel state.
323 * @param t Tunnel to debug.
324 * @param level Debug level to use.
327 GCT_debug (const struct CadetTunnel *t,
328 enum GNUNET_ErrorType level);