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