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.
71 * New ephemeral key and ping sent, waiting for pong. Unlike KEY_PING,
72 * we still have a valid session key and therefore we *can* still send
73 * traffic on the tunnel.
75 CADET_TUNNEL_KEY_REKEY
80 * Get the static string for the peer this tunnel is directed.
84 * @return Static string the destination peer's ID.
87 GCT_2s (const struct CadetTunnel *t);
91 * Create a tunnel to @a destionation. Must only be called
92 * from within #GCP_get_tunnel().
94 * @param destination where to create the tunnel to
95 * @return new tunnel to @a destination
98 GCT_create_tunnel (struct CadetPeer *destination);
102 * Add a @a connection to the @a tunnel.
105 * @param cid connection identifer to use for the connection
106 * @param path path to use for the connection
109 GCT_add_inbound_connection (struct CadetTunnel *t,
110 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cid,
111 struct CadetPeerPath *path);
115 * Return the peer to which this tunnel goes.
118 * @return the destination of the tunnel
121 GCT_get_destination (struct CadetTunnel *t);
125 * Consider using the path @a p for the tunnel @a t.
126 * The tunnel destination is at offset @a off in path @a p.
128 * @param cls our tunnel
129 * @param path a path to our destination
130 * @param off offset of the destination on path @a path
133 GCT_consider_path (struct CadetTunnel *t,
134 struct CadetPeerPath *p,
139 * Add a channel to a tunnel.
143 * @return unique number identifying @a ch within @a t
145 struct GNUNET_CADET_ChannelTunnelNumber
146 GCT_add_channel (struct CadetTunnel *t,
147 struct CadetChannel *ch);
151 * Remove a channel from a tunnel.
155 * @param gid unique number identifying @a ch within @a t
158 GCT_remove_channel (struct CadetTunnel *t,
159 struct CadetChannel *ch,
160 struct GNUNET_CADET_ChannelTunnelNumber gid);
164 * Send a DESTROY message via the tunnel.
166 * @param t the tunnel to transmit over
167 * @param chid ID of the channel to destroy
170 GCT_send_channel_destroy (struct CadetTunnel *t,
171 struct GNUNET_CADET_ChannelTunnelNumber chid);
175 * Sends an already built message on a tunnel, encrypting it and
176 * choosing the best connection if not provided.
178 * @param message Message to send. Function modifies it.
179 * @param t Tunnel on which this message is transmitted.
180 * @param cont Continuation to call once message is really sent.
181 * @param cont_cls Closure for @c cont.
182 * @return Handle to cancel message. NULL if @c cont is NULL.
184 struct CadetTunnelQueueEntry *
185 GCT_send (struct CadetTunnel *t,
186 const struct GNUNET_MessageHeader *message,
187 GNUNET_SCHEDULER_TaskCallback cont,
192 * Cancel a previously sent message while it's in the queue.
194 * ONLY can be called before the continuation given to the send
195 * function is called. Once the continuation is called, the message is
196 * no longer in the queue!
198 * @param q Handle to the queue entry to cancel.
201 GCT_send_cancel (struct CadetTunnelQueueEntry *q);
205 * Return the number of channels using a tunnel.
207 * @param t tunnel to count obtain the number of channels for
208 * @return number of channels using the tunnel
211 GCT_count_channels (struct CadetTunnel *t);
215 * Return the number of connections available for a tunnel.
217 * @param t tunnel to count obtain the number of connections for
218 * @return number of connections available for the tunnel
221 GCT_count_any_connections (struct CadetTunnel *t);
225 * Iterator over connections.
228 * @param c one of the connections
231 (*GCT_ConnectionIterator) (void *cls,
232 struct CadetConnection *c);
236 * Iterate over all connections of a tunnel.
238 * @param t Tunnel whose connections to iterate.
239 * @param iter Iterator.
240 * @param iter_cls Closure for @c iter.
243 GCT_iterate_connections (struct CadetTunnel *t,
244 GCT_ConnectionIterator iter,
249 * Iterator over channels.
252 * @param ch one of the channels
255 (*GCT_ChannelIterator) (void *cls,
256 struct CadetChannel *ch);
260 * Iterate over all channels of a tunnel.
262 * @param t Tunnel whose channels to iterate.
263 * @param iter Iterator.
264 * @param iter_cls Closure for @c iter.
267 GCT_iterate_channels (struct CadetTunnel *t,
268 GCT_ChannelIterator iter,
273 * Get the encryption state of a tunnel.
277 * @return Tunnel's encryption state.
279 enum CadetTunnelEState
280 GCT_get_estate (struct CadetTunnel *t);
286 * @param ct connection/tunnel combo that received encrypted message
287 * @param msg the key exchange message
290 GCT_handle_kx (struct CadetTConnection *ct,
291 const struct GNUNET_CADET_TunnelKeyExchangeMessage *msg);
295 * Handle encrypted message.
297 * @param ct connection/tunnel combo that received encrypted message
298 * @param msg the encrypted message to decrypt
301 GCT_handle_encrypted (struct CadetTConnection *ct,
302 const struct GNUNET_CADET_TunnelEncryptedMessage *msg);
306 * Log all possible info about the tunnel state.
308 * @param t Tunnel to debug.
309 * @param level Debug level to use.
312 GCT_debug (const struct CadetTunnel *t,
313 enum GNUNET_ErrorType level);