Merge branch 'master' of gnunet.org:gnunet
[oweals/gnunet.git] / src / cadet / gnunet-service-cadet.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2001-2013, 2017 GNUnet e.V.
4
5      GNUnet is free software: you can redistribute it and/or modify it
6      under the terms of the GNU Affero General Public License as published
7      by the Free Software Foundation, either version 3 of the License,
8      or (at your 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      Affero General Public License for more details.
14
15      You should have received a copy of the GNU Affero General Public License
16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
17
18      SPDX-License-Identifier: AGPL3.0-or-later
19 */
20
21 /**
22  * @file cadet/gnunet-service-cadet.c
23  * @brief GNUnet CADET service with encryption
24  * @author Bartlomiej Polot
25  * @author Christian Grothoff
26  *
27  * Dictionary:
28  * - peer: other cadet instance. If there is direct connection it's a neighbor.
29  * - path: series of directly connected peer from one peer to another.
30  * - connection: path which is being used in a tunnel.
31  * - tunnel: encrypted connection to a peer, neighbor or not.
32  * - channel: logical link between two clients, on the same or different peers.
33  *            have properties like reliability.
34  */
35
36 #include "platform.h"
37 #include "gnunet_util_lib.h"
38 #include "cadet.h"
39 #include "gnunet_statistics_service.h"
40 #include "gnunet-service-cadet.h"
41 #include "gnunet-service-cadet_channel.h"
42 #include "gnunet-service-cadet_connection.h"
43 #include "gnunet-service-cadet_core.h"
44 #include "gnunet-service-cadet_dht.h"
45 #include "gnunet-service-cadet_hello.h"
46 #include "gnunet-service-cadet_tunnels.h"
47 #include "gnunet-service-cadet_peer.h"
48 #include "gnunet-service-cadet_paths.h"
49
50 #define LOG(level, ...) GNUNET_log (level,__VA_ARGS__)
51
52
53 /**
54  * Struct containing information about a client of the service
55  */
56 struct CadetClient
57 {
58   /**
59    * Linked list next
60    */
61   struct CadetClient *next;
62
63   /**
64    * Linked list prev
65    */
66   struct CadetClient *prev;
67
68   /**
69    * Tunnels that belong to this client, indexed by local id,
70    * value is a `struct CadetChannel`.
71    */
72   struct GNUNET_CONTAINER_MultiHashMap32 *channels;
73
74   /**
75    * Handle to communicate with the client
76    */
77   struct GNUNET_MQ_Handle *mq;
78
79   /**
80    * Client handle.
81    */
82   struct GNUNET_SERVICE_Client *client;
83
84   /**
85    * Ports that this client has declared interest in.
86    * Indexed by port, contains `struct OpenPort`
87    */
88   struct GNUNET_CONTAINER_MultiHashMap *ports;
89
90   /**
91    * Channel ID to use for the next incoming channel for this client.
92    * Wraps around (in theory).
93    */
94   struct GNUNET_CADET_ClientChannelNumber next_ccn;
95
96   /**
97    * ID of the client, mainly for debug messages. Purely internal to this file.
98    */
99   unsigned int id;
100 };
101
102
103 /******************************************************************************/
104 /***********************      GLOBAL VARIABLES     ****************************/
105 /******************************************************************************/
106
107 /****************************** Global variables ******************************/
108
109 /**
110  * Handle to our configuration.
111  */
112 const struct GNUNET_CONFIGURATION_Handle *cfg;
113
114 /**
115  * Handle to the statistics service.
116  */
117 struct GNUNET_STATISTICS_Handle *stats;
118
119 /**
120  * Handle to communicate with ATS.
121  */
122 struct GNUNET_ATS_ConnectivityHandle *ats_ch;
123
124 /**
125  * Local peer own ID.
126  */
127 struct GNUNET_PeerIdentity my_full_id;
128
129 /**
130  * Own private key.
131  */
132 struct GNUNET_CRYPTO_EddsaPrivateKey *my_private_key;
133
134 /**
135  * Signal that shutdown is happening: prevent recovery measures.
136  */
137 int shutting_down;
138
139 /**
140  * DLL with all the clients, head.
141  */
142 static struct CadetClient *clients_head;
143
144 /**
145  * DLL with all the clients, tail.
146  */
147 static struct CadetClient *clients_tail;
148
149 /**
150  * Next ID to assign to a client.
151  */
152 static unsigned int next_client_id;
153
154 /**
155  * All ports clients of this peer have opened.  Maps from
156  * a hashed port to a `struct OpenPort`.
157  */
158 struct GNUNET_CONTAINER_MultiHashMap *open_ports;
159
160 /**
161  * Map from ports to channels where the ports were closed at the
162  * time we got the inbound connection.
163  * Indexed by h_port, contains `struct CadetChannel`.
164  */
165 struct GNUNET_CONTAINER_MultiHashMap *loose_channels;
166
167 /**
168  * Map from PIDs to `struct CadetPeer` entries.
169  */
170 struct GNUNET_CONTAINER_MultiPeerMap *peers;
171
172 /**
173  * Map from `struct GNUNET_CADET_ConnectionTunnelIdentifier`
174  * hash codes to `struct CadetConnection` objects.
175  */
176 struct GNUNET_CONTAINER_MultiShortmap *connections;
177
178 /**
179  * How many messages are needed to trigger an AXOLOTL ratchet advance.
180  */
181 unsigned long long ratchet_messages;
182
183 /**
184  * How long until we trigger a ratched advance due to time.
185  */
186 struct GNUNET_TIME_Relative ratchet_time;
187
188 /**
189  * How frequently do we send KEEPALIVE messages on idle connections?
190  */
191 struct GNUNET_TIME_Relative keepalive_period;
192
193 /**
194  * Set to non-zero values to create random drops to test retransmissions.
195  */
196 unsigned long long drop_percent;
197
198
199 /**
200  * Send a message to a client.
201  *
202  * @param c client to get the message
203  * @param env envelope with the message
204  */
205 void
206 GSC_send_to_client (struct CadetClient *c,
207                     struct GNUNET_MQ_Envelope *env)
208 {
209   GNUNET_MQ_send (c->mq,
210                   env);
211 }
212
213
214 /**
215  * Return identifier for a client as a string.
216  *
217  * @param c client to identify
218  * @return string for debugging
219  */
220 const char *
221 GSC_2s (struct CadetClient *c)
222 {
223   static char buf[32];
224
225   GNUNET_snprintf (buf,
226                    sizeof (buf),
227                    "Client(%u)",
228                    c->id);
229   return buf;
230 }
231
232
233 /**
234  * Lookup channel of client @a c by @a ccn.
235  *
236  * @param c client to look in
237  * @param ccn channel ID to look up
238  * @return NULL if no such channel exists
239  */
240 static struct CadetChannel *
241 lookup_channel (struct CadetClient *c,
242                 struct GNUNET_CADET_ClientChannelNumber ccn)
243 {
244   return GNUNET_CONTAINER_multihashmap32_get (c->channels,
245                                               ntohl (ccn.channel_of_client));
246 }
247
248
249 /**
250  * Obtain the next LID to use for incoming connections to
251  * the given client.
252  *
253  * @param c client handle
254  */
255 static struct GNUNET_CADET_ClientChannelNumber
256 client_get_next_ccn (struct CadetClient *c)
257 {
258   struct GNUNET_CADET_ClientChannelNumber ccn = c->next_ccn;
259
260   /* increment until we have a free one... */
261   while (NULL !=
262          lookup_channel (c,
263                          ccn))
264   {
265     ccn.channel_of_client
266       = htonl (1 + (ntohl (ccn.channel_of_client)));
267     if (ntohl (ccn.channel_of_client) >=
268         GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
269       ccn.channel_of_client = htonl (0);
270   }
271   c->next_ccn.channel_of_client
272     = htonl (1 + (ntohl (ccn.channel_of_client)));
273   return ccn;
274 }
275
276
277 /**
278  * Bind incoming channel to this client, and notify client about
279  * incoming connection.  Caller is responsible for notifying the other
280  * peer about our acceptance of the channel.
281  *
282  * @param c client to bind to
283  * @param ch channel to be bound
284  * @param dest peer that establishes the connection
285  * @param port port number
286  * @param options options
287  * @return local channel number assigned to the new client
288  */
289 struct GNUNET_CADET_ClientChannelNumber
290 GSC_bind (struct CadetClient *c,
291           struct CadetChannel *ch,
292           struct CadetPeer *dest,
293           const struct GNUNET_HashCode *port,
294           uint32_t options)
295 {
296   struct GNUNET_MQ_Envelope *env;
297   struct GNUNET_CADET_LocalChannelCreateMessage *cm;
298   struct GNUNET_CADET_ClientChannelNumber ccn;
299
300   ccn = client_get_next_ccn (c);
301   GNUNET_assert (GNUNET_YES ==
302                  GNUNET_CONTAINER_multihashmap32_put (c->channels,
303                                                       ntohl (ccn.channel_of_client),
304                                                       ch,
305                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
306   LOG (GNUNET_ERROR_TYPE_DEBUG,
307        "Accepting incoming %s from %s on open port %s (%u), assigning ccn %X\n",
308        GCCH_2s (ch),
309        GCP_2s (dest),
310        GNUNET_h2s (port),
311        (uint32_t) ntohl (options),
312        (uint32_t) ntohl (ccn.channel_of_client));
313   /* notify local client about incoming connection! */
314   env = GNUNET_MQ_msg (cm,
315                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE);
316   cm->ccn = ccn;
317   cm->port = *port;
318   cm->opt = htonl (options);
319   cm->peer = *GCP_get_id (dest);
320   GSC_send_to_client (c,
321                       env);
322   return ccn;
323 }
324
325
326 /**
327  * Callback invoked on all peers to destroy all tunnels
328  * that may still exist.
329  *
330  * @param cls NULL
331  * @param pid identify of a peer
332  * @param value a `struct CadetPeer` that may still have a tunnel
333  * @return #GNUNET_OK (iterate over all entries)
334  */
335 static int
336 destroy_tunnels_now (void *cls,
337                      const struct GNUNET_PeerIdentity *pid,
338                      void *value)
339 {
340   struct CadetPeer *cp = value;
341   struct CadetTunnel *t = GCP_get_tunnel (cp,
342                                           GNUNET_NO);
343
344   if (NULL != t)
345     GCT_destroy_tunnel_now (t);
346   return GNUNET_OK;
347 }
348
349
350 /**
351  * Callback invoked on all peers to destroy all tunnels
352  * that may still exist.
353  *
354  * @param cls NULL
355  * @param pid identify of a peer
356  * @param value a `struct CadetPeer` that may still have a tunnel
357  * @return #GNUNET_OK (iterate over all entries)
358  */
359 static int
360 destroy_paths_now (void *cls,
361                    const struct GNUNET_PeerIdentity *pid,
362                    void *value)
363 {
364   struct CadetPeer *cp = value;
365
366   GCP_drop_owned_paths (cp);
367   return GNUNET_OK;
368 }
369
370
371 /**
372  * Shutdown everything once the clients have disconnected.
373  */
374 static void
375 shutdown_rest ()
376 {
377   if (NULL != stats)
378   {
379     GNUNET_STATISTICS_destroy (stats,
380                                GNUNET_NO);
381     stats = NULL;
382   }
383   /* Destroy tunnels.  Note that all channels must be destroyed first! */
384   GCP_iterate_all (&destroy_tunnels_now,
385                    NULL);
386   /* All tunnels, channels, connections and CORE must be down before this point. */
387   GCP_iterate_all (&destroy_paths_now,
388                    NULL);
389   /* All paths, tunnels, channels, connections and CORE must be down before this point. */
390   GCP_destroy_all_peers ();
391   if (NULL != open_ports)
392   {
393     GNUNET_CONTAINER_multihashmap_destroy (open_ports);
394     open_ports = NULL;
395   }
396   if (NULL != loose_channels)
397   {
398     GNUNET_CONTAINER_multihashmap_destroy (loose_channels);
399     loose_channels = NULL;
400   }
401   if (NULL != peers)
402   {
403     GNUNET_CONTAINER_multipeermap_destroy (peers);
404     peers = NULL;
405   }
406   if (NULL != connections)
407   {
408     GNUNET_CONTAINER_multishortmap_destroy (connections);
409     connections = NULL;
410   }
411   if (NULL != ats_ch)
412   {
413     GNUNET_ATS_connectivity_done (ats_ch);
414     ats_ch = NULL;
415   }
416   GCD_shutdown ();
417   GCH_shutdown ();
418   GNUNET_free_non_null (my_private_key);
419   my_private_key = NULL;
420 }
421
422
423 /**
424  * Task run during shutdown.
425  *
426  * @param cls unused
427  */
428 static void
429 shutdown_task (void *cls)
430 {
431   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
432               "Shutting down\n");
433   shutting_down = GNUNET_YES;
434   GCO_shutdown ();
435   if (NULL == clients_head)
436     shutdown_rest ();
437 }
438
439
440 /**
441  * We had a remote connection @a value to port @a h_port before
442  * client @a cls opened port @a port.  Bind them now.
443  *
444  * @param cls the `struct CadetClient`
445  * @param h_port the hashed port
446  * @param value the `struct CadetChannel`
447  * @return #GNUNET_YES (iterate over all such channels)
448  */
449 static int
450 bind_loose_channel (void *cls,
451                     const struct GNUNET_HashCode *port,
452                     void *value)
453 {
454   struct OpenPort *op = cls;
455   struct CadetChannel *ch = value;
456
457   GCCH_bind (ch,
458              op->c,
459              &op->port);
460   GNUNET_assert (GNUNET_YES ==
461                  GNUNET_CONTAINER_multihashmap_remove (loose_channels,
462                                                        &op->h_port,
463                                                        ch));
464   return GNUNET_YES;
465 }
466
467
468 /**
469  * Handle port open request.  Creates a mapping from the
470  * port to the respective client and checks whether we have
471  * loose channels trying to bind to the port.  If so, those
472  * are bound.
473  *
474  * @param cls Identification of the client.
475  * @param pmsg The actual message.
476  */
477 static void
478 handle_port_open (void *cls,
479                   const struct GNUNET_CADET_PortMessage *pmsg)
480 {
481   struct CadetClient *c = cls;
482   struct OpenPort *op;
483
484   LOG (GNUNET_ERROR_TYPE_DEBUG,
485        "Open port %s requested by %s\n",
486        GNUNET_h2s (&pmsg->port),
487        GSC_2s (c));
488   if (NULL == c->ports)
489     c->ports = GNUNET_CONTAINER_multihashmap_create (4,
490                                                      GNUNET_NO);
491   op = GNUNET_new (struct OpenPort);
492   op->c = c;
493   op->port = pmsg->port;
494   GCCH_hash_port (&op->h_port,
495                   &pmsg->port,
496                   &my_full_id);
497   if (GNUNET_OK !=
498       GNUNET_CONTAINER_multihashmap_put (c->ports,
499                                          &op->port,
500                                          op,
501                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
502   {
503     GNUNET_break (0);
504     GNUNET_SERVICE_client_drop (c->client);
505     return;
506   }
507   (void) GNUNET_CONTAINER_multihashmap_put (open_ports,
508                                             &op->h_port,
509                                             op,
510                                             GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
511   GNUNET_CONTAINER_multihashmap_get_multiple (loose_channels,
512                                               &op->h_port,
513                                               &bind_loose_channel,
514                                               op);
515   GNUNET_SERVICE_client_continue (c->client);
516 }
517
518
519 /**
520  * Handler for port close requests.  Marks this port as closed
521  * (unless of course we have another client with the same port
522  * open).  Note that existing channels accepted on the port are
523  * not affected.
524  *
525  * @param cls Identification of the client.
526  * @param pmsg The actual message.
527  */
528 static void
529 handle_port_close (void *cls,
530                    const struct GNUNET_CADET_PortMessage *pmsg)
531 {
532   struct CadetClient *c = cls;
533   struct OpenPort *op;
534
535   LOG (GNUNET_ERROR_TYPE_DEBUG,
536        "Closing port %s as requested by %s\n",
537        GNUNET_h2s (&pmsg->port),
538        GSC_2s (c));
539   if (NULL == c->ports)
540   {
541     /* Client closed a port despite _never_ having opened one? */
542     GNUNET_break (0);
543     GNUNET_SERVICE_client_drop (c->client);
544     return;
545   }
546   op = GNUNET_CONTAINER_multihashmap_get (c->ports,
547                                           &pmsg->port);
548   if (NULL == op)
549   {
550     GNUNET_break (0);
551     GNUNET_SERVICE_client_drop (c->client);
552     return;
553   }
554   GNUNET_assert (GNUNET_YES ==
555                  GNUNET_CONTAINER_multihashmap_remove (c->ports,
556                                                        &op->port,
557                                                        op));
558   GNUNET_assert (GNUNET_YES ==
559                  GNUNET_CONTAINER_multihashmap_remove (open_ports,
560                                                        &op->h_port,
561                                                        op));
562   GNUNET_free (op);
563   GNUNET_SERVICE_client_continue (c->client);
564 }
565
566
567 /**
568  * Handler for requests for us creating a new channel to another peer and port.
569  *
570  * @param cls Identification of the client.
571  * @param tcm The actual message.
572  */
573 static void
574 handle_channel_create (void *cls,
575                        const struct GNUNET_CADET_LocalChannelCreateMessage *tcm)
576 {
577   struct CadetClient *c = cls;
578   struct CadetChannel *ch;
579
580   if (ntohl (tcm->ccn.channel_of_client) < GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
581   {
582     /* Channel ID not in allowed range. */
583     GNUNET_break (0);
584     GNUNET_SERVICE_client_drop (c->client);
585     return;
586   }
587   ch = lookup_channel (c,
588                        tcm->ccn);
589   if (NULL != ch)
590   {
591     /* Channel ID already in use. Not allowed. */
592     GNUNET_break (0);
593     GNUNET_SERVICE_client_drop (c->client);
594     return;
595   }
596   LOG (GNUNET_ERROR_TYPE_DEBUG,
597        "New channel to %s at port %s requested by %s\n",
598        GNUNET_i2s (&tcm->peer),
599        GNUNET_h2s (&tcm->port),
600        GSC_2s (c));
601
602   /* Create channel */
603   ch = GCCH_channel_local_new (c,
604                                tcm->ccn,
605                                GCP_get (&tcm->peer,
606                                         GNUNET_YES),
607                                &tcm->port,
608                                ntohl (tcm->opt));
609   if (NULL == ch)
610   {
611     GNUNET_break (0);
612     GNUNET_SERVICE_client_drop (c->client);
613     return;
614   }
615   GNUNET_assert (GNUNET_YES ==
616                  GNUNET_CONTAINER_multihashmap32_put (c->channels,
617                                                       ntohl (tcm->ccn.channel_of_client),
618                                                       ch,
619                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
620
621   GNUNET_SERVICE_client_continue (c->client);
622 }
623
624
625 /**
626  * Handler for requests of destroying an existing channel.
627  *
628  * @param cls client identification of the client
629  * @param msg the actual message
630  */
631 static void
632 handle_channel_destroy (void *cls,
633                         const struct GNUNET_CADET_LocalChannelDestroyMessage *msg)
634 {
635   struct CadetClient *c = cls;
636   struct CadetChannel *ch;
637
638   ch = lookup_channel (c,
639                        msg->ccn);
640   if (NULL == ch)
641   {
642     /* Client attempted to destroy unknown channel.
643        Can happen if the other side went down at the same time.*/
644     LOG (GNUNET_ERROR_TYPE_DEBUG,
645          "%s tried to destroy unknown channel %X\n",
646          GSC_2s(c),
647          (uint32_t) ntohl (msg->ccn.channel_of_client));
648     GNUNET_SERVICE_client_continue (c->client);
649     return;
650   }
651   LOG (GNUNET_ERROR_TYPE_DEBUG,
652        "%s is destroying %s\n",
653        GSC_2s(c),
654        GCCH_2s (ch));
655   GNUNET_assert (GNUNET_YES ==
656                  GNUNET_CONTAINER_multihashmap32_remove (c->channels,
657                                                          ntohl (msg->ccn.channel_of_client),
658                                                          ch));
659   GCCH_channel_local_destroy (ch,
660                               c,
661                               msg->ccn);
662   GNUNET_SERVICE_client_continue (c->client);
663 }
664
665
666 /**
667  * Check for client traffic data message is well-formed.
668  *
669  * @param cls identification of the client
670  * @param msg the actual message
671  * @return #GNUNET_OK if @a msg is OK, #GNUNET_SYSERR if not
672  */
673 static int
674 check_local_data (void *cls,
675                   const struct GNUNET_CADET_LocalData *msg)
676 {
677   size_t payload_size;
678   size_t payload_claimed_size;
679   const char *buf;
680   struct GNUNET_MessageHeader pa;
681
682   /* FIXME: what is the format we shall allow for @a msg?
683      ONE payload item or multiple? Seems current cadet_api
684      at least in theory allows more than one. Next-gen
685      cadet_api will likely no more, so we could then
686      simplify this mess again. */
687   /* Sanity check for message size */
688   payload_size = ntohs (msg->header.size) - sizeof (*msg);
689   buf = (const char *) &msg[1];
690   while (payload_size >= sizeof (struct GNUNET_MessageHeader))
691   {
692     /* need to memcpy() for alignment */
693     GNUNET_memcpy (&pa,
694                    buf,
695                    sizeof (pa));
696     payload_claimed_size = ntohs (pa.size);
697     if ( (payload_size < payload_claimed_size) ||
698          (payload_claimed_size < sizeof (struct GNUNET_MessageHeader)) ||
699          (GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE < payload_claimed_size) )
700     {
701       GNUNET_break (0);
702       LOG (GNUNET_ERROR_TYPE_DEBUG,
703            "Local data of %u total size had sub-message %u at %u with %u bytes\n",
704            ntohs (msg->header.size),
705            ntohs (pa.type),
706            (unsigned int) (buf - (const char *) &msg[1]),
707            (unsigned int) payload_claimed_size);
708       return GNUNET_SYSERR;
709     }
710     payload_size -= payload_claimed_size;
711     buf += payload_claimed_size;
712   }
713   if (0 != payload_size)
714   {
715     GNUNET_break_op (0);
716     return GNUNET_SYSERR;
717   }
718   return GNUNET_OK;
719 }
720
721
722 /**
723  * Handler for client payload traffic to be send on a channel to
724  * another peer.
725  *
726  * @param cls identification of the client
727  * @param msg the actual message
728  */
729 static void
730 handle_local_data (void *cls,
731                    const struct GNUNET_CADET_LocalData *msg)
732 {
733   struct CadetClient *c = cls;
734   struct CadetChannel *ch;
735   size_t payload_size;
736   const char *buf;
737
738   ch = lookup_channel (c,
739                        msg->ccn);
740   if (NULL == ch)
741   {
742     /* Channel does not exist (anymore) */
743     LOG (GNUNET_ERROR_TYPE_WARNING,
744          "Dropping payload for channel %u from client (channel unknown, other endpoint may have disconnected)\n",
745          (unsigned int) ntohl (msg->ccn.channel_of_client));
746     GNUNET_SERVICE_client_continue (c->client);
747     return;
748   }
749   payload_size = ntohs (msg->header.size) - sizeof (*msg);
750   GNUNET_STATISTICS_update (stats,
751                             "# payload received from clients",
752                             payload_size,
753                             GNUNET_NO);
754   buf = (const char *) &msg[1];
755   LOG (GNUNET_ERROR_TYPE_DEBUG,
756        "Received %u bytes payload from %s for %s\n",
757        (unsigned int) payload_size,
758        GSC_2s (c),
759        GCCH_2s (ch));
760   if (GNUNET_OK !=
761       GCCH_handle_local_data (ch,
762                               msg->ccn,
763                               buf,
764                               payload_size))
765   {
766     GNUNET_break (0);
767     GNUNET_SERVICE_client_drop (c->client);
768     return;
769   }
770   GNUNET_SERVICE_client_continue (c->client);
771 }
772
773
774 /**
775  * Handler for client's ACKs for payload traffic.
776  *
777  * @param cls identification of the client.
778  * @param msg The actual message.
779  */
780 static void
781 handle_local_ack (void *cls,
782                   const struct GNUNET_CADET_LocalAck *msg)
783 {
784   struct CadetClient *c = cls;
785   struct CadetChannel *ch;
786
787   ch = lookup_channel (c,
788                        msg->ccn);
789   if (NULL == ch)
790   {
791     /* Channel does not exist (anymore) */
792     LOG (GNUNET_ERROR_TYPE_WARNING,
793          "Ignoring local ACK for channel %u from client (channel unknown, other endpoint may have disconnected)\n",
794          (unsigned int) ntohl (msg->ccn.channel_of_client));
795     GNUNET_SERVICE_client_continue (c->client);
796     return;
797   }
798   LOG (GNUNET_ERROR_TYPE_DEBUG,
799        "Got a local ACK from %s for %s\n",
800        GSC_2s(c),
801        GCCH_2s (ch));
802   GCCH_handle_local_ack (ch,
803                          msg->ccn);
804   GNUNET_SERVICE_client_continue (c->client);
805 }
806
807
808 /**
809  * Iterator over all peers to send a monitoring client info about each peer.
810  *
811  * @param cls Closure ().
812  * @param peer Peer ID (tunnel remote peer).
813  * @param value Peer info.
814  * @return #GNUNET_YES, to keep iterating.
815  */
816 static int
817 get_all_peers_iterator (void *cls,
818                         const struct GNUNET_PeerIdentity *peer,
819                         void *value)
820 {
821   struct CadetClient *c = cls;
822   struct CadetPeer *p = value;
823   struct GNUNET_MQ_Envelope *env;
824   struct GNUNET_CADET_LocalInfoPeers *msg;
825
826   env = GNUNET_MQ_msg (msg,
827                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
828   msg->destination = *peer;
829   msg->paths = htons (GCP_count_paths (p));
830   msg->tunnel = htons (NULL != GCP_get_tunnel (p,
831                                                GNUNET_NO));
832   msg->best_path_length = htonl (0); // FIXME: get length of shortest known path!
833   GNUNET_MQ_send (c->mq,
834                   env);
835   return GNUNET_YES;
836 }
837
838
839 /**
840  * Handler for client's INFO PEERS request.
841  *
842  * @param cls Identification of the client.
843  * @param message The actual message.
844  */
845 static void
846 handle_get_peers (void *cls,
847                   const struct GNUNET_MessageHeader *message)
848 {
849   struct CadetClient *c = cls;
850   struct GNUNET_MQ_Envelope *env;
851   struct GNUNET_MessageHeader *reply;
852
853   GCP_iterate_all (&get_all_peers_iterator,
854                    c);
855   env = GNUNET_MQ_msg (reply,
856                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS_END);
857   GNUNET_MQ_send (c->mq,
858                   env);
859   GNUNET_SERVICE_client_continue (c->client);
860 }
861
862
863 /**
864  * Iterator over all paths of a peer to build an InfoPeer message.
865  * Message contains blocks of peers, first not included.
866  *
867  * @param cls message queue for transmission
868  * @param path Path itself
869  * @param off offset of the peer on @a path
870  * @return #GNUNET_YES if should keep iterating.
871  *         #GNUNET_NO otherwise.
872  */
873 static int
874 path_info_iterator (void *cls,
875                     struct CadetPeerPath *path,
876                     unsigned int off)
877 {
878   struct GNUNET_MQ_Handle *mq = cls;
879   struct GNUNET_MQ_Envelope *env;
880   struct GNUNET_CADET_LocalInfoPath *resp;
881   struct GNUNET_PeerIdentity *id;
882   size_t path_size;
883   unsigned int path_length;
884
885   path_length = GCPP_get_length (path);
886   path_size = sizeof (struct GNUNET_PeerIdentity) * path_length;
887   if (sizeof (*resp) + path_size > UINT16_MAX)
888   {
889     /* try just giving the relevant path */
890     path_length = GNUNET_MIN ((UINT16_MAX - sizeof (*resp)) / sizeof (struct GNUNET_PeerIdentity),
891                               off);
892     path_size = sizeof (struct GNUNET_PeerIdentity) * path_length;
893   }
894   if (sizeof (*resp) + path_size > UINT16_MAX)
895   {
896     LOG (GNUNET_ERROR_TYPE_WARNING,
897          "Path of %u entries is too long for info message\n",
898          path_length);
899     return GNUNET_YES;
900   }
901   env = GNUNET_MQ_msg_extra (resp,
902                              path_size,
903                              GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PATH);
904   id = (struct GNUNET_PeerIdentity *) &resp[1];
905
906   /* Don't copy first peer.  First peer is always the local one.  Last
907    * peer is always the destination (leave as 0, EOL).
908    */
909   for (unsigned int i = 0; i < path_length; i++)
910     id[i] = *GCP_get_id (GCPP_get_peer_at_offset (path,
911                                                   i));
912   resp->off = htonl (off);
913   GNUNET_MQ_send (mq,
914                   env);
915   return GNUNET_YES;
916 }
917
918
919 /**
920  * Handler for client's #GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_PATH request.
921  *
922  * @param cls Identification of the client.
923  * @param msg The actual message.
924  */
925 static void
926 handle_show_path (void *cls,
927                   const struct GNUNET_CADET_RequestPathInfoMessage *msg)
928 {
929   struct CadetClient *c = cls;
930   struct CadetPeer *p;
931   struct GNUNET_MQ_Envelope *env;
932   struct GNUNET_MessageHeader *resp;
933
934   p = GCP_get (&msg->peer,
935                GNUNET_NO);
936   if (NULL != p)
937     GCP_iterate_indirect_paths (p,
938                                 &path_info_iterator,
939                                 c->mq);
940   env = GNUNET_MQ_msg (resp,
941                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PATH_END);
942   GNUNET_MQ_send (c->mq,
943                   env);
944   GNUNET_SERVICE_client_continue (c->client);
945 }
946
947
948 /**
949  * Iterator over all tunnels to send a monitoring client info about each tunnel.
950  *
951  * @param cls Closure ().
952  * @param peer Peer ID (tunnel remote peer).
953  * @param value a `struct CadetPeer`
954  * @return #GNUNET_YES, to keep iterating.
955  */
956 static int
957 get_all_tunnels_iterator (void *cls,
958                           const struct GNUNET_PeerIdentity *peer,
959                           void *value)
960 {
961   struct CadetClient *c = cls;
962   struct CadetPeer *p = value;
963   struct GNUNET_MQ_Envelope *env;
964   struct GNUNET_CADET_LocalInfoTunnel *msg;
965   struct CadetTunnel *t;
966
967   t = GCP_get_tunnel (p,
968                       GNUNET_NO);
969   if (NULL == t)
970     return GNUNET_YES;
971   env = GNUNET_MQ_msg (msg,
972                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
973   msg->destination = *peer;
974   msg->channels = htonl (GCT_count_channels (t));
975   msg->connections = htonl (GCT_count_any_connections (t));
976   msg->cstate = htons (0);
977   msg->estate = htons ((uint16_t) GCT_get_estate (t));
978   GNUNET_MQ_send (c->mq,
979                   env);
980   return GNUNET_YES;
981 }
982
983
984 /**
985  * Handler for client's #GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_TUNNELS request.
986  *
987  * @param cls client Identification of the client.
988  * @param message The actual message.
989  */
990 static void
991 handle_info_tunnels (void *cls,
992                      const struct GNUNET_MessageHeader *message)
993 {
994   struct CadetClient *c = cls;
995   struct GNUNET_MQ_Envelope *env;
996   struct GNUNET_MessageHeader *reply;
997
998   GCP_iterate_all (&get_all_tunnels_iterator,
999                    c);
1000   env = GNUNET_MQ_msg (reply,
1001                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS_END);
1002   GNUNET_MQ_send (c->mq,
1003                   env);
1004   GNUNET_SERVICE_client_continue (c->client);
1005 }
1006
1007
1008 /**
1009  * Callback called when a client connects to the service.
1010  *
1011  * @param cls closure for the service
1012  * @param client the new client that connected to the service
1013  * @param mq the message queue used to send messages to the client
1014  * @return @a c
1015  */
1016 static void *
1017 client_connect_cb (void *cls,
1018                    struct GNUNET_SERVICE_Client *client,
1019                    struct GNUNET_MQ_Handle *mq)
1020 {
1021   struct CadetClient *c;
1022
1023   c = GNUNET_new (struct CadetClient);
1024   c->client = client;
1025   c->mq = mq;
1026   c->id = next_client_id++; /* overflow not important: just for debug */
1027   c->channels
1028     = GNUNET_CONTAINER_multihashmap32_create (32);
1029   GNUNET_CONTAINER_DLL_insert (clients_head,
1030                                clients_tail,
1031                                c);
1032   GNUNET_STATISTICS_update (stats,
1033                             "# clients",
1034                             +1,
1035                             GNUNET_NO);
1036   LOG (GNUNET_ERROR_TYPE_DEBUG,
1037        "%s connected\n",
1038        GSC_2s (c));
1039   return c;
1040 }
1041
1042
1043 /**
1044  * A channel was destroyed by the other peer. Tell our client.
1045  *
1046  * @param c client that lost a channel
1047  * @param ccn channel identification number for the client
1048  * @param ch the channel object
1049  */
1050 void
1051 GSC_handle_remote_channel_destroy (struct CadetClient *c,
1052                                    struct GNUNET_CADET_ClientChannelNumber ccn,
1053                                    struct CadetChannel *ch)
1054 {
1055   struct GNUNET_MQ_Envelope *env;
1056   struct GNUNET_CADET_LocalChannelDestroyMessage *tdm;
1057
1058   env = GNUNET_MQ_msg (tdm,
1059                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
1060   tdm->ccn = ccn;
1061   GSC_send_to_client (c,
1062                       env);
1063   GNUNET_assert (GNUNET_YES ==
1064                  GNUNET_CONTAINER_multihashmap32_remove (c->channels,
1065                                                          ntohl (ccn.channel_of_client),
1066                                                          ch));
1067 }
1068
1069
1070 /**
1071  * A client that created a loose channel that was not bound to a port
1072  * disconnected, drop it from the #loose_channels list.
1073  *
1074  * @param h_port the hashed port the channel was trying to bind to
1075  * @param ch the channel that was lost
1076  */
1077 void
1078 GSC_drop_loose_channel (const struct GNUNET_HashCode *h_port,
1079                         struct CadetChannel *ch)
1080 {
1081   GNUNET_assert (GNUNET_YES ==
1082                  GNUNET_CONTAINER_multihashmap_remove (loose_channels,
1083                                                        h_port,
1084                                                        ch));
1085 }
1086
1087
1088 /**
1089  * Iterator for deleting each channel whose client endpoint disconnected.
1090  *
1091  * @param cls Closure (client that has disconnected).
1092  * @param key The local channel id in host byte order
1093  * @param value The value stored at the key (channel to destroy).
1094  * @return #GNUNET_OK, keep iterating.
1095  */
1096 static int
1097 channel_destroy_iterator (void *cls,
1098                           uint32_t key,
1099                           void *value)
1100 {
1101   struct CadetClient *c = cls;
1102   struct GNUNET_CADET_ClientChannelNumber ccn;
1103   struct CadetChannel *ch = value;
1104
1105   LOG (GNUNET_ERROR_TYPE_DEBUG,
1106        "Destroying %s, due to %s disconnecting.\n",
1107        GCCH_2s (ch),
1108        GSC_2s (c));
1109   ccn.channel_of_client = htonl (key);
1110   GCCH_channel_local_destroy (ch,
1111                               c,
1112                               ccn);
1113   GNUNET_assert (GNUNET_YES ==
1114                  GNUNET_CONTAINER_multihashmap32_remove (c->channels,
1115                                                          key,
1116                                                          ch));
1117   return GNUNET_OK;
1118 }
1119
1120
1121 /**
1122  * Remove client's ports from the global hashmap on disconnect.
1123  *
1124  * @param cls the `struct CadetClient`
1125  * @param port the port.
1126  * @param value the `struct OpenPort` to remove
1127  * @return #GNUNET_OK, keep iterating.
1128  */
1129 static int
1130 client_release_ports (void *cls,
1131                       const struct GNUNET_HashCode *port,
1132                       void *value)
1133 {
1134   struct CadetClient *c = cls;
1135   struct OpenPort *op = value;
1136
1137   GNUNET_assert (c == op->c);
1138   LOG (GNUNET_ERROR_TYPE_DEBUG,
1139        "Closing port %s due to %s disconnect.\n",
1140        GNUNET_h2s (port),
1141        GSC_2s (c));
1142   GNUNET_assert (GNUNET_YES ==
1143                  GNUNET_CONTAINER_multihashmap_remove (open_ports,
1144                                                        &op->h_port,
1145                                                        op));
1146   GNUNET_assert (GNUNET_YES ==
1147                  GNUNET_CONTAINER_multihashmap_remove (c->ports,
1148                                                        port,
1149                                                        op));
1150   GNUNET_free (op);
1151   return GNUNET_OK;
1152 }
1153
1154
1155 /**
1156  * Callback called when a client disconnected from the service
1157  *
1158  * @param cls closure for the service
1159  * @param client the client that disconnected
1160  * @param internal_cls should be equal to @a c
1161  */
1162 static void
1163 client_disconnect_cb (void *cls,
1164                       struct GNUNET_SERVICE_Client *client,
1165                       void *internal_cls)
1166 {
1167   struct CadetClient *c = internal_cls;
1168
1169   GNUNET_assert (c->client == client);
1170   LOG (GNUNET_ERROR_TYPE_DEBUG,
1171        "%s is disconnecting.\n",
1172        GSC_2s (c));
1173   if (NULL != c->channels)
1174   {
1175     GNUNET_CONTAINER_multihashmap32_iterate (c->channels,
1176                                              &channel_destroy_iterator,
1177                                              c);
1178     GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap32_size (c->channels));
1179     GNUNET_CONTAINER_multihashmap32_destroy (c->channels);
1180   }
1181   if (NULL != c->ports)
1182   {
1183     GNUNET_CONTAINER_multihashmap_iterate (c->ports,
1184                                            &client_release_ports,
1185                                            c);
1186     GNUNET_CONTAINER_multihashmap_destroy (c->ports);
1187   }
1188   GNUNET_CONTAINER_DLL_remove (clients_head,
1189                                clients_tail,
1190                                c);
1191   GNUNET_STATISTICS_update (stats,
1192                             "# clients",
1193                             -1,
1194                             GNUNET_NO);
1195   GNUNET_free (c);
1196   if ( (NULL == clients_head) &&
1197        (GNUNET_YES == shutting_down) )
1198     shutdown_rest ();
1199 }
1200
1201
1202 /**
1203  * Setup CADET internals.
1204  *
1205  * @param cls closure
1206  * @param server the initialized server
1207  * @param c configuration to use
1208  */
1209 static void
1210 run (void *cls,
1211      const struct GNUNET_CONFIGURATION_Handle *c,
1212      struct GNUNET_SERVICE_Handle *service)
1213 {
1214   cfg = c;
1215   if (GNUNET_OK !=
1216       GNUNET_CONFIGURATION_get_value_number (c,
1217                                              "CADET",
1218                                              "RATCHET_MESSAGES",
1219                                              &ratchet_messages))
1220   {
1221     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1222                                "CADET",
1223                                "RATCHET_MESSAGES",
1224                                "needs to be a number");
1225     ratchet_messages = 64;
1226   }
1227   if (GNUNET_OK !=
1228       GNUNET_CONFIGURATION_get_value_time (c,
1229                                            "CADET",
1230                                            "RATCHET_TIME",
1231                                            &ratchet_time))
1232   {
1233     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1234                                "CADET",
1235                                "RATCHET_TIME",
1236                                "need delay value");
1237     ratchet_time = GNUNET_TIME_UNIT_HOURS;
1238   }
1239   if (GNUNET_OK !=
1240       GNUNET_CONFIGURATION_get_value_time (c,
1241                                            "CADET",
1242                                            "REFRESH_CONNECTION_TIME",
1243                                            &keepalive_period))
1244   {
1245     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1246                                "CADET",
1247                                "REFRESH_CONNECTION_TIME",
1248                                "need delay value");
1249     keepalive_period = GNUNET_TIME_UNIT_MINUTES;
1250   }
1251   if (GNUNET_OK !=
1252       GNUNET_CONFIGURATION_get_value_number (c,
1253                                              "CADET",
1254                                              "DROP_PERCENT",
1255                                              &drop_percent))
1256   {
1257     drop_percent = 0;
1258   }
1259   else
1260   {
1261     LOG (GNUNET_ERROR_TYPE_WARNING, "**************************************\n");
1262     LOG (GNUNET_ERROR_TYPE_WARNING, "Cadet is running with DROP enabled.\n");
1263     LOG (GNUNET_ERROR_TYPE_WARNING, "This is NOT a good idea!\n");
1264     LOG (GNUNET_ERROR_TYPE_WARNING, "Remove DROP_PERCENT from config file.\n");
1265     LOG (GNUNET_ERROR_TYPE_WARNING, "**************************************\n");
1266   }
1267   my_private_key = GNUNET_CRYPTO_eddsa_key_create_from_configuration (c);
1268   if (NULL == my_private_key)
1269   {
1270     GNUNET_break (0);
1271     GNUNET_SCHEDULER_shutdown ();
1272     return;
1273   }
1274   GNUNET_CRYPTO_eddsa_key_get_public (my_private_key,
1275                                       &my_full_id.public_key);
1276   stats = GNUNET_STATISTICS_create ("cadet",
1277                                     c);
1278   GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
1279                                  NULL);
1280   ats_ch = GNUNET_ATS_connectivity_init (c);
1281   /* FIXME: optimize code to allow GNUNET_YES here! */
1282   open_ports = GNUNET_CONTAINER_multihashmap_create (16,
1283                                                      GNUNET_NO);
1284   loose_channels = GNUNET_CONTAINER_multihashmap_create (16,
1285                                                          GNUNET_NO);
1286   peers = GNUNET_CONTAINER_multipeermap_create (16,
1287                                                 GNUNET_YES);
1288   connections = GNUNET_CONTAINER_multishortmap_create (256,
1289                                                        GNUNET_YES);
1290   GCH_init (c);
1291   GCD_init (c);
1292   GCO_init (c);
1293   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1294               "CADET started for peer %s\n",
1295               GNUNET_i2s (&my_full_id));
1296
1297 }
1298
1299
1300 /**
1301  * Define "main" method using service macro.
1302  */
1303 GNUNET_SERVICE_MAIN
1304 ("cadet",
1305  GNUNET_SERVICE_OPTION_NONE,
1306  &run,
1307  &client_connect_cb,
1308  &client_disconnect_cb,
1309  NULL,
1310  GNUNET_MQ_hd_fixed_size (port_open,
1311                           GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN,
1312                           struct GNUNET_CADET_PortMessage,
1313                           NULL),
1314  GNUNET_MQ_hd_fixed_size (port_close,
1315                           GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE,
1316                           struct GNUNET_CADET_PortMessage,
1317                           NULL),
1318  GNUNET_MQ_hd_fixed_size (channel_create,
1319                           GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE,
1320                           struct GNUNET_CADET_LocalChannelCreateMessage,
1321                           NULL),
1322  GNUNET_MQ_hd_fixed_size (channel_destroy,
1323                           GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY,
1324                           struct GNUNET_CADET_LocalChannelDestroyMessage,
1325                           NULL),
1326  GNUNET_MQ_hd_var_size (local_data,
1327                         GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
1328                         struct GNUNET_CADET_LocalData,
1329                         NULL),
1330  GNUNET_MQ_hd_fixed_size (local_ack,
1331                           GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK,
1332                           struct GNUNET_CADET_LocalAck,
1333                           NULL),
1334  GNUNET_MQ_hd_fixed_size (get_peers,
1335                           GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_PEERS,
1336                           struct GNUNET_MessageHeader,
1337                           NULL),
1338  GNUNET_MQ_hd_fixed_size (show_path,
1339                           GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_PATH,
1340                           struct GNUNET_CADET_RequestPathInfoMessage,
1341                           NULL),
1342  GNUNET_MQ_hd_fixed_size (info_tunnels,
1343                           GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_TUNNELS,
1344                           struct GNUNET_MessageHeader,
1345                           NULL),
1346  GNUNET_MQ_handler_end ());
1347
1348 /* end of gnunet-service-cadet-new.c */