src/cadet/gnunet-service-cadet-new_tunnels.h

   1
   2 /*
   3      This file is part of GNUnet.
   4      Copyright (C) 2001-2017 GNUnet e.V.
   5
   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.
  10
  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.
  15
  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.
  20 */
  21
  22 /**
  23  * @file cadet/gnunet-service-cadet-new_tunnels.h
  24  * @brief Information we track per tunnel.
  25  * @author Bartlomiej Polot
  26  * @author Christian Grothoff
  27  */
  28 #ifndef GNUNET_SERVICE_CADET_TUNNELS_H
  29 #define GNUNET_SERVICE_CADET_TUNNELS_H
  30
  31 #include "gnunet-service-cadet-new.h"
  32 #include "cadet_protocol.h"
  33
  34
  35 /**
  36  * How many connections would we like to have per tunnel?
  37  */
  38 #define DESIRED_CONNECTIONS_PER_TUNNEL 3
  39
  40
  41 /**
  42  * All the encryption states a tunnel can be in.
  43  */
  44 enum CadetTunnelEState
  45 {
  46   /**
  47    * Uninitialized status, we need to send KX.  We will stay
  48    * in this state until the first connection is up.
  49    */
  50   CADET_TUNNEL_KEY_UNINITIALIZED,
  51
  52   /**
  53    * Ephemeral key sent, waiting for peer's key.
  54    */
  55   CADET_TUNNEL_KEY_SENT,
  56
  57   /**
  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
  61    * anyway.
  62    */
  63   CADET_TUNNEL_KEY_PING,
  64
  65   /**
  66    * Handshake completed: session key available.
  67    */
  68   CADET_TUNNEL_KEY_OK,
  69
  70   /**
  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.
  74    */
  75   CADET_TUNNEL_KEY_REKEY
  76 };
  77
  78
  79 /**
  80  * Get the static string for the peer this tunnel is directed.
  81  *
  82  * @param t Tunnel.
  83  *
  84  * @return Static string the destination peer's ID.
  85  */
  86 const char *
  87 GCT_2s (const struct CadetTunnel *t);
  88
  89
  90 /**
  91  * Create a tunnel to @a destionation.  Must only be called
  92  * from within #GCP_get_tunnel().
  93  *
  94  * @param destination where to create the tunnel to
  95  * @return new tunnel to @a destination
  96  */
  97 struct CadetTunnel *
  98 GCT_create_tunnel (struct CadetPeer *destination);
  99
 100
 101 /**
 102  * Destroys the tunnel @a t now, without delay. Used during shutdown.
 103  *
 104  * @param t tunnel to destroy
 105  */
 106 void
 107 GCT_destroy_tunnel_now (struct CadetTunnel *t);
 108
 109
 110 /**
 111  * Add a @a connection to the @a tunnel.
 112  *
 113  * @param t a tunnel
 114  * @param cid connection identifer to use for the connection
 115  * @param path path to use for the connection
 116  */
 117 void
 118 GCT_add_inbound_connection (struct CadetTunnel *t,
 119                             const struct GNUNET_CADET_ConnectionTunnelIdentifier *cid,
 120                             struct CadetPeerPath *path);
 121
 122
 123 /**
 124  * Return the peer to which this tunnel goes.
 125  *
 126  * @param t a tunnel
 127  * @return the destination of the tunnel
 128  */
 129 struct CadetPeer *
 130 GCT_get_destination (struct CadetTunnel *t);
 131
 132
 133 /**
 134  * Consider using the path @a p for the tunnel @a t.
 135  * The tunnel destination is at offset @a off in path @a p.
 136  *
 137  * @param cls our tunnel
 138  * @param path a path to our destination
 139  * @param off offset of the destination on path @a path
 140  */
 141 void
 142 GCT_consider_path (struct CadetTunnel *t,
 143                    struct CadetPeerPath *p,
 144                    unsigned int off);
 145
 146
 147 /**
 148  * Add a channel to a tunnel.
 149  *
 150  * @param t Tunnel.
 151  * @param ch Channel
 152  * @return unique number identifying @a ch within @a t
 153  */
 154 struct GNUNET_CADET_ChannelTunnelNumber
 155 GCT_add_channel (struct CadetTunnel *t,
 156                  struct CadetChannel *ch);
 157
 158
 159 /**
 160  * Remove a channel from a tunnel.
 161  *
 162  * @param t Tunnel.
 163  * @param ch Channel
 164  * @param ctn unique number identifying @a ch within @a t
 165  */
 166 void
 167 GCT_remove_channel (struct CadetTunnel *t,
 168                     struct CadetChannel *ch,
 169                     struct GNUNET_CADET_ChannelTunnelNumber ctn);
 170
 171
 172 /**
 173  * Send a DESTROY message via the tunnel.
 174  *
 175  * @param t the tunnel to transmit over
 176  * @param ctn ID of the channel to destroy
 177  */
 178 void
 179 GCT_send_channel_destroy (struct CadetTunnel *t,
 180                           struct GNUNET_CADET_ChannelTunnelNumber ctn);
 181
 182
 183 /**
 184  * Sends an already built message on a tunnel, encrypting it and
 185  * choosing the best connection if not provided.
 186  *
 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.
 192  */
 193 struct CadetTunnelQueueEntry *
 194 GCT_send (struct CadetTunnel *t,
 195           const struct GNUNET_MessageHeader *message,
 196           GNUNET_SCHEDULER_TaskCallback cont,
 197           void *cont_cls);
 198
 199
 200 /**
 201  * Cancel a previously sent message while it's in the queue.
 202  *
 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!
 206  *
 207  * @param q Handle to the queue entry to cancel.
 208  */
 209 void
 210 GCT_send_cancel (struct CadetTunnelQueueEntry *q);
 211
 212
 213 /**
 214  * Return the number of channels using a tunnel.
 215  *
 216  * @param t tunnel to count obtain the number of channels for
 217  * @return number of channels using the tunnel
 218  */
 219 unsigned int
 220 GCT_count_channels (struct CadetTunnel *t);
 221
 222
 223 /**
 224  * Return the number of connections available for a tunnel.
 225  *
 226  * @param t tunnel to count obtain the number of connections for
 227  * @return number of connections available for the tunnel
 228  */
 229 unsigned int
 230 GCT_count_any_connections (struct CadetTunnel *t);
 231
 232
 233 /**
 234  * Iterator over connections.
 235  *
 236  * @param cls closure
 237  * @param c one of the connections
 238  */
 239 typedef void
 240 (*GCT_ConnectionIterator) (void *cls,
 241                            struct CadetConnection *c);
 242
 243
 244 /**
 245  * Iterate over all connections of a tunnel.
 246  *
 247  * @param t Tunnel whose connections to iterate.
 248  * @param iter Iterator.
 249  * @param iter_cls Closure for @c iter.
 250  */
 251 void
 252 GCT_iterate_connections (struct CadetTunnel *t,
 253                          GCT_ConnectionIterator iter,
 254                          void *iter_cls);
 255
 256
 257 /**
 258  * Iterator over channels.
 259  *
 260  * @param cls closure
 261  * @param ch one of the channels
 262  */
 263 typedef void
 264 (*GCT_ChannelIterator) (void *cls,
 265                         struct CadetChannel *ch);
 266
 267
 268 /**
 269  * Iterate over all channels of a tunnel.
 270  *
 271  * @param t Tunnel whose channels to iterate.
 272  * @param iter Iterator.
 273  * @param iter_cls Closure for @c iter.
 274  */
 275 void
 276 GCT_iterate_channels (struct CadetTunnel *t,
 277                       GCT_ChannelIterator iter,
 278                       void *iter_cls);
 279
 280
 281 /**
 282  * Get the encryption state of a tunnel.
 283  *
 284  * @param t Tunnel.
 285  *
 286  * @return Tunnel's encryption state.
 287  */
 288 enum CadetTunnelEState
 289 GCT_get_estate (struct CadetTunnel *t);
 290
 291
 292 /**
 293  * Handle KX message.
 294  *
 295  * @param ct connection/tunnel combo that received encrypted message
 296  * @param msg the key exchange message
 297  */
 298 void
 299 GCT_handle_kx (struct CadetTConnection *ct,
 300                const struct GNUNET_CADET_TunnelKeyExchangeMessage *msg);
 301
 302
 303 /**
 304  * Handle encrypted message.
 305  *
 306  * @param ct connection/tunnel combo that received encrypted message
 307  * @param msg the encrypted message to decrypt
 308  */
 309 void
 310 GCT_handle_encrypted (struct CadetTConnection *ct,
 311                       const struct GNUNET_CADET_TunnelEncryptedMessage *msg);
 312
 313
 314 /**
 315  * Log all possible info about the tunnel state.
 316  *
 317  * @param t Tunnel to debug.
 318  * @param level Debug level to use.
 319  */
 320 void
 321 GCT_debug (const struct CadetTunnel *t,
 322            enum GNUNET_ErrorType level);
 323
 324
 325 #endif