src/cadet/gnunet-service-cadet_tunnel.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2013 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file cadet/gnunet-service-cadet_tunnel.h
  23  * @brief cadet service; dealing with tunnels and crypto
  24  * @author Bartlomiej Polot
  25  *
  26  * All functions in this file should use the prefix GMT (Gnunet Cadet Tunnel)
  27  */
  28
  29 #ifndef GNUNET_SERVICE_CADET_TUNNEL_H
  30 #define GNUNET_SERVICE_CADET_TUNNEL_H
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 #include "platform.h"
  41 #include "gnunet_util_lib.h"
  42
  43 #define CONNECTIONS_PER_TUNNEL 3
  44
  45 /**
  46  * All the connectivity states a tunnel can be in.
  47  */
  48 enum CadetTunnelCState
  49 {
  50     /**
  51      * Uninitialized status, should never appear in operation.
  52      */
  53   CADET_TUNNEL_NEW,
  54
  55     /**
  56      * No path to the peer known yet.
  57      */
  58   CADET_TUNNEL_SEARCHING,
  59
  60     /**
  61      * Request sent, not yet answered.
  62      */
  63   CADET_TUNNEL_WAITING,
  64
  65     /**
  66      * Peer connected and ready to accept data.
  67      */
  68   CADET_TUNNEL_READY,
  69
  70   /**
  71    * Tunnel being shut down, don't try to keep it alive.
  72    */
  73   CADET_TUNNEL_SHUTDOWN
  74 };
  75
  76
  77 /**
  78  * All the encryption states a tunnel can be in.
  79  */
  80 enum CadetTunnelEState
  81 {
  82   /**
  83    * Uninitialized status, should never appear in operation.
  84    */
  85   CADET_TUNNEL_KEY_UNINITIALIZED,
  86
  87   /**
  88    * Ephemeral key sent, waiting for peer's key.
  89    */
  90   CADET_TUNNEL_KEY_SENT,
  91
  92   /**
  93    * New ephemeral key and ping sent, waiting for pong.
  94    * This means that we DO have the peer's ephemeral key, otherwise the
  95    * state would be KEY_SENT. We DO NOT have a valid session key (either no
  96    * previous key or previous key expired).
  97    */
  98   CADET_TUNNEL_KEY_PING,
  99
 100   /**
 101    * Handshake completed: session key available.
 102    */
 103   CADET_TUNNEL_KEY_OK,
 104
 105   /**
 106    * New ephemeral key and ping sent, waiting for pong. Unlike KEY_PING,
 107    * we still have a valid session key and therefore we *can* still send
 108    * traffic on the tunnel.
 109    */
 110   CADET_TUNNEL_KEY_REKEY,
 111 };
 112
 113 /**
 114  * Struct containing all information regarding a given peer
 115  */
 116 struct CadetTunnel;
 117
 118
 119 #include "gnunet-service-cadet_channel.h"
 120 #include "gnunet-service-cadet_connection.h"
 121 #include "gnunet-service-cadet_peer.h"
 122
 123 /**
 124  * Handle for messages queued but not yet sent.
 125  */
 126 struct CadetTunnelQueue;
 127
 128 /**
 129  * Callback called when a queued message is sent.
 130  *
 131  * @param cls Closure.
 132  * @param t Tunnel this message was on.
 133  * @param type Type of message sent.
 134  * @param size Size of the message.
 135  */
 136 typedef void (*GCT_sent) (void *cls,
 137                           struct CadetTunnel *t,
 138                           struct CadetTunnelQueue *q,
 139                           uint16_t type, size_t size);
 140
 141 typedef void (*GCT_conn_iter) (void *cls, struct CadetConnection *c);
 142 typedef void (*GCT_chan_iter) (void *cls, struct CadetChannel *ch);
 143
 144
 145 /******************************************************************************/
 146 /********************************    API    ***********************************/
 147 /******************************************************************************/
 148
 149 /**
 150  * Initialize tunnel subsystem.
 151  *
 152  * @param c Configuration handle.
 153  * @param key ECC private key, to derive all other keys and do crypto.
 154  */
 155 void
 156 GCT_init (const struct GNUNET_CONFIGURATION_Handle *c,
 157           const struct GNUNET_CRYPTO_EddsaPrivateKey *key);
 158
 159 /**
 160  * Shut down the tunnel subsystem.
 161  */
 162 void
 163 GCT_shutdown (void);
 164
 165 /**
 166  * Create a tunnel.
 167  *
 168  * @param destination Peer this tunnel is towards.
 169  */
 170 struct CadetTunnel *
 171 GCT_new (struct CadetPeer *destination);
 172
 173 /**
 174  * Tunnel is empty: destroy it.
 175  *
 176  * Notifies all connections about the destruction.
 177  *
 178  * @param t Tunnel to destroy.
 179  */
 180 void
 181 GCT_destroy_empty (struct CadetTunnel *t);
 182
 183 /**
 184  * Destroy tunnel if empty (no more channels).
 185  *
 186  * @param t Tunnel to destroy if empty.
 187  */
 188 void
 189 GCT_destroy_if_empty (struct CadetTunnel *t);
 190
 191 /**
 192  * Destroy the tunnel.
 193  *
 194  * This function does not generate any warning traffic to clients or peers.
 195  *
 196  * Tasks:
 197  * Cancel messages belonging to this tunnel queued to neighbors.
 198  * Free any allocated resources linked to the tunnel.
 199  *
 200  * @param t The tunnel to destroy.
 201  */
 202 void
 203 GCT_destroy (struct CadetTunnel *t);
 204
 205
 206 /**
 207  * Change the tunnel's connection state.
 208  *
 209  * @param t Tunnel whose connection state to change.
 210  * @param cstate New connection state.
 211  */
 212 void
 213 GCT_change_cstate (struct CadetTunnel* t, enum CadetTunnelCState cstate);
 214
 215
 216 /**
 217  * Change the tunnel encryption state.
 218  *
 219  * @param t Tunnel whose encryption state to change.
 220  * @param state New encryption state.
 221  */
 222 void
 223 GCT_change_estate (struct CadetTunnel* t, enum CadetTunnelEState state);
 224
 225 /**
 226  * Add a connection to a tunnel.
 227  *
 228  * @param t Tunnel.
 229  * @param c Connection.
 230  */
 231 void
 232 GCT_add_connection (struct CadetTunnel *t, struct CadetConnection *c);
 233
 234 /**
 235  * Remove a connection from a tunnel.
 236  *
 237  * @param t Tunnel.
 238  * @param c Connection.
 239  */
 240 void
 241 GCT_remove_connection (struct CadetTunnel *t, struct CadetConnection *c);
 242
 243 /**
 244  * Add a channel to a tunnel.
 245  *
 246  * @param t Tunnel.
 247  * @param ch Channel.
 248  */
 249 void
 250 GCT_add_channel (struct CadetTunnel *t, struct CadetChannel *ch);
 251
 252 /**
 253  * Remove a channel from a tunnel.
 254  *
 255  * @param t Tunnel.
 256  * @param ch Channel.
 257  */
 258 void
 259 GCT_remove_channel (struct CadetTunnel *t, struct CadetChannel *ch);
 260
 261 /**
 262  * Search for a channel by global ID.
 263  *
 264  * @param t Tunnel containing the channel.
 265  * @param chid Public channel number.
 266  *
 267  * @return channel handler, NULL if doesn't exist
 268  */
 269 struct CadetChannel *
 270 GCT_get_channel (struct CadetTunnel *t, CADET_ChannelNumber chid);
 271
 272 /**
 273  * Decrypt and demultiplex by message type. Call appropriate handler
 274  * for a message towards a channel of a local tunnel.
 275  *
 276  * @param t Tunnel this message came on.
 277  * @param msg Message header.
 278  */
 279 void
 280 GCT_handle_encrypted (struct CadetTunnel *t,
 281                       const struct GNUNET_MessageHeader *msg);
 282
 283
 284 /**
 285  * Demultiplex an encapsulated KX message by message type.
 286  *
 287  * @param t Tunnel on which the message came.
 288  * @param message KX message itself.
 289  */
 290 void
 291 GCT_handle_kx (struct CadetTunnel *t,
 292                const struct GNUNET_MessageHeader *message);
 293
 294 /**
 295  * @brief Use the given path for the tunnel.
 296  * Update the next and prev hops (and RCs).
 297  * (Re)start the path refresh in case the tunnel is locally owned.
 298  *
 299  * @param t Tunnel to update.
 300  * @param p Path to use.
 301  *
 302  * @return Connection created.
 303  */
 304 struct CadetConnection *
 305 GCT_use_path (struct CadetTunnel *t, struct CadetPeerPath *p);
 306
 307 /**
 308  * Count all created connections of a tunnel. Not necessarily ready connections!
 309  *
 310  * @param t Tunnel on which to count.
 311  *
 312  * @return Number of connections created, either being established or ready.
 313  */
 314 unsigned int
 315 GCT_count_any_connections (struct CadetTunnel *t);
 316
 317 /**
 318  * Count established (ready) connections of a tunnel.
 319  *
 320  * @param t Tunnel on which to count.
 321  *
 322  * @return Number of connections.
 323  */
 324 unsigned int
 325 GCT_count_connections (struct CadetTunnel *t);
 326
 327 /**
 328  * Count channels of a tunnel.
 329  *
 330  * @param t Tunnel on which to count.
 331  *
 332  * @return Number of channels.
 333  */
 334 unsigned int
 335 GCT_count_channels (struct CadetTunnel *t);
 336
 337 /**
 338  * Get the connectivity state of a tunnel.
 339  *
 340  * @param t Tunnel.
 341  *
 342  * @return Tunnel's connectivity state.
 343  */
 344 enum CadetTunnelCState
 345 GCT_get_cstate (struct CadetTunnel *t);
 346
 347 /**
 348  * Get the encryption state of a tunnel.
 349  *
 350  * @param t Tunnel.
 351  *
 352  * @return Tunnel's encryption state.
 353  */
 354 enum CadetTunnelEState
 355 GCT_get_estate (struct CadetTunnel *t);
 356
 357 /**
 358  * Get the maximum buffer space for a tunnel towards a local client.
 359  *
 360  * @param t Tunnel.
 361  *
 362  * @return Biggest buffer space offered by any channel in the tunnel.
 363  */
 364 unsigned int
 365 GCT_get_channels_buffer (struct CadetTunnel *t);
 366
 367 /**
 368  * Get the total buffer space for a tunnel for P2P traffic.
 369  *
 370  * @param t Tunnel.
 371  *
 372  * @return Buffer space offered by all connections in the tunnel.
 373  */
 374 unsigned int
 375 GCT_get_connections_buffer (struct CadetTunnel *t);
 376
 377 /**
 378  * Get the tunnel's destination.
 379  *
 380  * @param t Tunnel.
 381  *
 382  * @return ID of the destination peer.
 383  */
 384 const struct GNUNET_PeerIdentity *
 385 GCT_get_destination (struct CadetTunnel *t);
 386
 387 /**
 388  * Get the tunnel's next free Channel ID.
 389  *
 390  * @param t Tunnel.
 391  *
 392  * @return ID of a channel free to use.
 393  */
 394 CADET_ChannelNumber
 395 GCT_get_next_chid (struct CadetTunnel *t);
 396
 397 /**
 398  * Send ACK on one or more channels due to buffer in connections.
 399  *
 400  * @param t Channel which has some free buffer space.
 401  */
 402 void
 403 GCT_unchoke_channels (struct CadetTunnel *t);
 404
 405 /**
 406  * Send ACK on one or more connections due to buffer space to the client.
 407  *
 408  * Iterates all connections of the tunnel and sends ACKs appropriately.
 409  *
 410  * @param t Tunnel which has some free buffer space.
 411  */
 412 void
 413 GCT_send_connection_acks (struct CadetTunnel *t);
 414
 415 /**
 416  * Cancel a previously sent message while it's in the queue.
 417  *
 418  * ONLY can be called before the continuation given to the send function
 419  * is called. Once the continuation is called, the message is no longer in the
 420  * queue.
 421  *
 422  * @param q Handle to the queue.
 423  */
 424 void
 425 GCT_cancel (struct CadetTunnelQueue *q);
 426
 427 /**
 428  * Sends an already built message on a tunnel, encrypting it and
 429  * choosing the best connection.
 430  *
 431  * @param message Message to send. Function modifies it.
 432  * @param t Tunnel on which this message is transmitted.
 433  * @param c Connection to use (autoselect if NULL).
 434  * @param force Force the tunnel to take the message (buffer overfill).
 435  * @param cont Continuation to call once message is really sent.
 436  * @param cont_cls Closure for @c cont.
 437  *
 438  * @return Handle to cancel message. NULL if @c cont is NULL.
 439  */
 440 struct CadetTunnelQueue *
 441 GCT_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
 442                            struct CadetTunnel *t, struct CadetConnection *c,
 443                            int force, GCT_sent cont, void *cont_cls);
 444
 445 /**
 446  * Send an Axolotl KX message.
 447  *
 448  * @param t Tunnel on which to send it.
 449  * @param force_reply Force the other peer to reply with a KX message.
 450  */
 451 void
 452 GCT_send_ax_kx (struct CadetTunnel *t, int force_reply);
 453
 454 /**
 455  * Sends an already built and encrypted message on a tunnel, choosing the best
 456  * connection. Useful for re-queueing messages queued on a destroyed connection.
 457  *
 458  * @param message Message to send. Function modifies it.
 459  * @param t Tunnel on which this message is transmitted.
 460  */
 461 void
 462 GCT_resend_message (const struct GNUNET_MessageHeader *message,
 463                     struct CadetTunnel *t);
 464
 465 /**
 466  * Is the tunnel directed towards the local peer?
 467  *
 468  * @param t Tunnel.
 469  *
 470  * @return #GNUNET_YES if it is loopback.
 471  */
 472 int
 473 GCT_is_loopback (const struct CadetTunnel *t);
 474
 475 /**
 476  * Is the tunnel using this path already?
 477  *
 478  * @param t Tunnel.
 479  * @param p Path.
 480  *
 481  * @return #GNUNET_YES a connection uses this path.
 482  */
 483 int
 484 GCT_is_path_used (const struct CadetTunnel *t, const struct CadetPeerPath *p);
 485
 486 /**
 487  * Get a cost of a path for a tunnel considering existing connections.
 488  *
 489  * @param t Tunnel.
 490  * @param path Candidate path.
 491  *
 492  * @return Cost of the path (path length + number of overlapping nodes)
 493  */
 494 unsigned int
 495 GCT_get_path_cost (const struct CadetTunnel *t,
 496                    const struct CadetPeerPath *path);
 497
 498 /**
 499  * Get the static string for the peer this tunnel is directed.
 500  *
 501  * @param t Tunnel.
 502  *
 503  * @return Static string the destination peer's ID.
 504  */
 505 const char *
 506 GCT_2s (const struct CadetTunnel *t);
 507
 508 /**
 509  * Log all possible info about the tunnel state.
 510  *
 511  * @param t Tunnel to debug.
 512  * @param level Debug level to use.
 513  */
 514 void
 515 GCT_debug (const struct CadetTunnel *t, enum GNUNET_ErrorType level);
 516
 517 /**
 518  * Iterate all tunnels.
 519  *
 520  * @param iter Iterator.
 521  * @param cls Closure for @c iter.
 522  */
 523 void
 524 GCT_iterate_all (GNUNET_CONTAINER_PeerMapIterator iter, void *cls);
 525
 526 /**
 527  * Count all tunnels.
 528  *
 529  * @return Number of tunnels to remote peers kept by this peer.
 530  */
 531 unsigned int
 532 GCT_count_all (void);
 533
 534 /**
 535  * Iterate all connections of a tunnel.
 536  *
 537  * @param t Tunnel whose connections to iterate.
 538  * @param iter Iterator.
 539  * @param cls Closure for @c iter.
 540  */
 541 void
 542 GCT_iterate_connections (struct CadetTunnel *t, GCT_conn_iter iter, void *cls);
 543
 544 /**
 545  * Iterate all channels of a tunnel.
 546  *
 547  * @param t Tunnel whose channels to iterate.
 548  * @param iter Iterator.
 549  * @param cls Closure for @c iter.
 550  */
 551 void
 552 GCT_iterate_channels (struct CadetTunnel *t, GCT_chan_iter iter, void *cls);
 553
 554 #if 0                           /* keep Emacsens' auto-indent happy */
 555 {
 556 #endif
 557 #ifdef __cplusplus
 558 }
 559 #endif
 560
 561 /* ifndef GNUNET_CADET_SERVICE_TUNNEL_H */
 562 #endif
 563 /* end of gnunet-cadet-service_tunnel.h */