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
33 * How many connections would we like to have per tunnel?
35 #define DESIRED_CONNECTIONS_PER_TUNNEL 3
39 * All the connectivity states a tunnel can be in.
41 enum CadetTunnelCState
44 * Uninitialized status, should never appear in operation.
49 * No path to the peer known yet.
51 CADET_TUNNEL_SEARCHING,
54 * Request sent, not yet answered.
59 * Peer connected and ready to accept data.
64 * Tunnel being shut down, don't try to keep it alive.
72 * All the encryption states a tunnel can be in.
74 enum CadetTunnelEState
77 * Uninitialized status, should never appear in operation.
79 CADET_TUNNEL_KEY_UNINITIALIZED,
82 * Ephemeral key sent, waiting for peer's key.
84 CADET_TUNNEL_KEY_SENT,
87 * In OTR: New ephemeral key and ping sent, waiting for pong.
89 * This means that we DO have the peer's ephemeral key, otherwise the
90 * state would be KEY_SENT. We DO NOT have a valid session key (either no
91 * previous key or previous key expired).
94 * In Axolotl: Key sent and received but no deciphered traffic yet.
96 * This means that we can send traffic (otherwise we would never complete
97 * the handshake), but we don't have complete confirmation. Since the first
98 * traffic MUST be a complete channel creation 3-way handshake, no payload
99 * will be sent before confirmation.
101 CADET_TUNNEL_KEY_PING,
104 * Handshake completed: session key available.
109 * New ephemeral key and ping sent, waiting for pong. Unlike KEY_PING,
110 * we still have a valid session key and therefore we *can* still send
111 * traffic on the tunnel.
113 CADET_TUNNEL_KEY_REKEY
118 * Number uniquely identifying a channel within a tunnel.
120 struct GCT_ChannelTunnelNumber
122 uint32_t channel_in_tunnel GNUNET_PACKED;
127 * Get the static string for the peer this tunnel is directed.
131 * @return Static string the destination peer's ID.
134 GCT_2s (const struct CadetTunnel *t);
138 * Create a tunnel to @a destionation. Must only be called
139 * from within #GCP_get_tunnel().
141 * @param destination where to create the tunnel to
142 * @return new tunnel to @a destination
145 GCT_create_tunnel (struct CadetPeer *destination);
149 * Return the peer to which this tunnel goes.
152 * @return the destination of the tunnel
155 GCT_get_destination (struct CadetTunnel *t);
159 * Add a channel to a tunnel.
163 * @return unique number identifying @a ch within @a t
165 struct GCT_ChannelTunnelNumber
166 GCT_add_channel (struct CadetTunnel *t,
167 struct CadetChannel *ch);
171 * Remove a channel from a tunnel.
175 * @param gid unique number identifying @a ch within @a t
178 GCT_remove_channel (struct CadetTunnel *t,
179 struct CadetChannel *ch,
180 struct GCT_ChannelTunnelNumber gid);
184 * Sends an already built message on a tunnel, encrypting it and
185 * choosing the best connection if not provided.
187 * @param message Message to send. Function modifies it.
188 * @param t Tunnel on which this message is transmitted.
189 * @param cont Continuation to call once message is really sent.
190 * @param cont_cls Closure for @c cont.
191 * @return Handle to cancel message. NULL if @c cont is NULL.
193 struct CadetTunnelQueueEntry *
194 GCT_send (struct CadetTunnel *t,
195 const struct GNUNET_MessageHeader *message,
196 GNUNET_SCHEDULER_TaskCallback cont,
201 * Cancel a previously sent message while it's in the queue.
203 * ONLY can be called before the continuation given to the send
204 * function is called. Once the continuation is called, the message is
205 * no longer in the queue!
207 * @param q Handle to the queue entry to cancel.
210 GCT_send_cancel (struct CadetTunnelQueueEntry *q);
214 * Return the number of channels using a tunnel.
216 * @param t tunnel to count obtain the number of channels for
217 * @return number of channels using the tunnel
220 GCT_count_channels (struct CadetTunnel *t);
224 * Return the number of connections available for a tunnel.
226 * @param t tunnel to count obtain the number of connections for
227 * @return number of connections available for the tunnel
230 GCT_count_any_connections (struct CadetTunnel *t);
234 * Iterator over connections.
237 * @param c one of the connections
240 (*GCT_ConnectionIterator) (void *cls,
241 struct CadetConnection *c);
245 * Iterate over all connections of a tunnel.
247 * @param t Tunnel whose connections to iterate.
248 * @param iter Iterator.
249 * @param iter_cls Closure for @c iter.
252 GCT_iterate_connections (struct CadetTunnel *t,
253 GCT_ConnectionIterator iter,
258 * Iterator over channels.
261 * @param ch one of the channels
264 (*GCT_ChannelIterator) (void *cls,
265 struct CadetChannel *ch);
269 * Iterate over all channels of a tunnel.
271 * @param t Tunnel whose channels to iterate.
272 * @param iter Iterator.
273 * @param iter_cls Closure for @c iter.
276 GCT_iterate_channels (struct CadetTunnel *t,
277 GCT_ChannelIterator iter,
282 * Get the connectivity state of a tunnel.
286 * @return Tunnel's connectivity state.
288 enum CadetTunnelCState
289 GCT_get_cstate (struct CadetTunnel *t);
293 * Get the encryption state of a tunnel.
297 * @return Tunnel's encryption state.
299 enum CadetTunnelEState
300 GCT_get_estate (struct CadetTunnel *t);
304 * Log all possible info about the tunnel state.
306 * @param t Tunnel to debug.
307 * @param level Debug level to use.
310 GCT_debug (const struct CadetTunnel *t,
311 enum GNUNET_ErrorType level);