2 This file is part of GNUnet.
3 Copyright (C) 2012 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file cadet/gnunet-cadet.c
23 * @brief Print information about cadet tunnels and peers.
24 * @author Bartlomiej Polot
27 #include "gnunet_util_lib.h"
28 #include "gnunet_cadet_service.h"
35 static int monitor_mode;
40 static int request_peers;
50 static int request_tunnels;
55 static char *tunnel_id;
65 static char *channel_id;
68 * Port to listen on (-p).
70 static uint32_t listen_port;
73 * Request echo service
78 * Request a debug dump
83 * Time of last echo request.
85 struct GNUNET_TIME_Absolute echo_time;
88 * Task for next echo request.
90 struct GNUNET_SCHEDULER_Task * echo_task;
95 static char *target_id;
100 static uint32_t target_port;
103 * Data pending in netcat mode.
111 static struct GNUNET_CADET_Handle *mh;
116 static struct GNUNET_CADET_Channel *ch;
121 static struct GNUNET_CADET_TransmitHandle *th;
124 * Shutdown task handle.
126 struct GNUNET_SCHEDULER_Task * sd;
135 * Convert encryption status to human readable string.
137 * @param status Encryption status.
139 * @return Human readable string.
142 enc_2s (uint16_t status)
161 * Convert connection status to human readable string.
163 * @param status Connection status.
165 * @return Human readable string.
168 conn_2s (uint16_t status)
188 * Task run in monitor mode when the user presses CTRL-C to abort.
189 * Stops monitoring activity.
191 * @param cls Closure (unused).
192 * @param tc scheduler context
195 shutdown_task (void *cls,
196 const struct GNUNET_SCHEDULER_TaskContext *tc)
198 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutdown\n");
201 GNUNET_CADET_channel_destroy (ch);
206 GNUNET_CADET_disconnect (mh);
213 * Function called to notify a client about the connection
214 * begin ready to queue more data. "buf" will be
215 * NULL and "size" zero if the connection was closed for
216 * writing in the meantime.
221 * @param size number of bytes available in buf
222 * @param buf where the callee should write the message
223 * @return number of bytes written to buf
226 data_ready (void *cls, size_t size, void *buf)
228 struct GNUNET_MessageHeader *msg;
233 if (NULL == buf || 0 == size)
235 GNUNET_SCHEDULER_shutdown();
239 total_size = data_size + sizeof (struct GNUNET_MessageHeader);
240 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sending %u bytes\n", data_size);
241 GNUNET_assert (size >= total_size);
244 msg->size = htons (total_size);
245 msg->type = htons (GNUNET_MESSAGE_TYPE_CADET_CLI);
246 memcpy (&msg[1], cls, data_size);
247 if (GNUNET_NO == echo)
253 echo_time = GNUNET_TIME_absolute_get ();
261 * Task run in stdio mode, after some data is available at stdin.
263 * @param cls Closure (unused).
264 * @param tc scheduler context
267 read_stdio (void *cls,
268 const struct GNUNET_SCHEDULER_TaskContext *tc)
270 static char buf[60000];
272 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
277 data_size = read (0, buf, 60000);
278 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "stdio read %u bytes\n", data_size);
281 GNUNET_SCHEDULER_shutdown();
284 GNUNET_assert (NULL == th);
285 th = GNUNET_CADET_notify_transmit_ready (ch, GNUNET_NO,
286 GNUNET_TIME_UNIT_FOREVER_REL,
287 sizeof (struct GNUNET_MessageHeader)
294 * Start listening to stdin
299 struct GNUNET_NETWORK_FDSet *rs;
301 rs = GNUNET_NETWORK_fdset_create ();
302 GNUNET_NETWORK_fdset_set_native (rs, 0);
303 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
304 GNUNET_TIME_UNIT_FOREVER_REL,
307 GNUNET_NETWORK_fdset_destroy (rs);
312 * Function called whenever a channel is destroyed. Should clean up
313 * any associated state.
315 * It must NOT call #GNUNET_CADET_channel_destroy on the channel.
317 * @param cls closure (set from #GNUNET_CADET_connect)
318 * @param channel connection to the other end (henceforth invalid)
319 * @param channel_ctx place where local state associated
320 * with the channel is stored
323 channel_ended (void *cls,
324 const struct GNUNET_CADET_Channel *channel,
327 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Channel ended!\n");
331 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "ended: %p, expected: %p\n", channel, ch);
335 GNUNET_CADET_notify_transmit_ready_cancel (th);
340 GNUNET_SCHEDULER_shutdown ();
345 * Method called whenever another peer has added us to a channel
346 * the other peer initiated.
347 * Only called (once) upon reception of data with a message type which was
348 * subscribed to in #GNUNET_CADET_connect.
350 * A call to #GNUNET_CADET_channel_destroy causes te channel to be ignored. In
351 * this case the handler MUST return NULL.
354 * @param channel new handle to the channel
355 * @param initiator peer that started the channel
356 * @param port Port this channel is for.
357 * @param options CadetOption flag field, with all active option bits set to 1.
359 * @return initial channel context for the channel
360 * (can be NULL -- that's not an error)
363 channel_incoming (void *cls,
364 struct GNUNET_CADET_Channel * channel,
365 const struct GNUNET_PeerIdentity * initiator,
366 uint32_t port, enum GNUNET_CADET_ChannelOption options)
368 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
369 "Incoming channel %p on port %u\n",
373 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
374 "A channel already exists (%p)\n", channel);
375 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
376 "Incoming channel %p on port %u\n", channel, port);
379 if (0 == listen_port)
381 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Not listening to channels\n");
385 if (GNUNET_NO == echo)
395 * @brief Send an echo request to the remote peer.
397 * @param cls Closure (NULL).
398 * @param tc Task context.
401 send_echo (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
403 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) || NULL == ch)
406 GNUNET_assert (NULL == th);
407 th = GNUNET_CADET_notify_transmit_ready (ch, GNUNET_NO,
408 GNUNET_TIME_UNIT_FOREVER_REL,
409 sizeof (struct GNUNET_MessageHeader),
415 * Call CADET's monitor API, request debug dump on the service.
417 * @param cls Closure (unused).
418 * @param tc TaskContext
421 request_dump (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
423 GNUNET_CADET_request_dump (mh);
424 GNUNET_SCHEDULER_cancel (sd);
425 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &shutdown_task, NULL);
430 * Call CADET's monitor API, get info of one connection.
432 * @param cls Closure (unused).
433 * @param tc TaskContext
436 create_channel (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
438 struct GNUNET_PeerIdentity pid;
439 enum GNUNET_CADET_ChannelOption opt;
441 GNUNET_assert (NULL == ch);
444 GNUNET_CRYPTO_eddsa_public_key_from_string (target_id,
449 _("Invalid target `%s'\n"),
451 GNUNET_SCHEDULER_shutdown ();
454 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to `%s'\n", target_id);
455 opt = GNUNET_CADET_OPTION_DEFAULT | GNUNET_CADET_OPTION_RELIABLE;
456 ch = GNUNET_CADET_channel_create (mh, NULL, &pid, target_port, opt);
457 if (GNUNET_NO == echo)
460 GNUNET_SCHEDULER_add_now (send_echo, NULL);
465 * Function called whenever a message is received.
467 * Each time the function must call #GNUNET_CADET_receive_done on the channel
468 * in order to receive the next message. This doesn't need to be immediate:
469 * can be delayed if some processing is done on the message.
471 * @param cls Closure (set from #GNUNET_CADET_connect).
472 * @param channel Connection to the other end.
473 * @param channel_ctx Place to store local state associated with the channel.
474 * @param message The actual message.
475 * @return #GNUNET_OK to keep the channel open,
476 * #GNUNET_SYSERR to close it (signal serious error).
479 data_callback (void *cls,
480 struct GNUNET_CADET_Channel *channel,
482 const struct GNUNET_MessageHeader *message)
488 GNUNET_break (ch == channel);
489 GNUNET_CADET_receive_done (channel);
491 if (GNUNET_YES == echo)
493 if (0 != listen_port)
495 /* Just listening to echo incoming messages*/
498 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
499 "Last echo reply not yet sent, dropping current reply.\n");
502 th = GNUNET_CADET_notify_transmit_ready (channel, GNUNET_NO,
503 GNUNET_TIME_UNIT_FOREVER_REL,
504 sizeof (struct GNUNET_MessageHeader),
510 struct GNUNET_TIME_Relative latency;
512 latency = GNUNET_TIME_absolute_get_duration (echo_time);
513 echo_time = GNUNET_TIME_UNIT_FOREVER_ABS;
514 FPRINTF (stdout, "time: %s\n",
515 GNUNET_STRINGS_relative_time_to_string (latency, GNUNET_NO));
516 echo_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
521 len = ntohs (message->size) - sizeof (*message);
522 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got %u bytes\n", len);
523 buf = (const char *) &message[1];
527 done = write (1, &buf[off], len - off);
531 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
533 return GNUNET_SYSERR;
542 * Method called to retrieve information about all peers in CADET, called
545 * After last peer has been reported, an additional call with NULL is done.
547 * @param cls Closure.
548 * @param peer Peer, or NULL on "EOF".
549 * @param tunnel Do we have a tunnel towards this peer?
550 * @param n_paths Number of known paths towards this peer.
551 * @param best_path How long is the best path?
552 * (0 = unknown, 1 = ourselves, 2 = neighbor)
555 peers_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
556 int tunnel, unsigned int n_paths, unsigned int best_path)
560 if (GNUNET_YES != monitor_mode)
562 GNUNET_SCHEDULER_shutdown();
566 FPRINTF (stdout, "%s tunnel: %c, paths: %u\n",
567 GNUNET_i2s_full (peer), tunnel ? 'Y' : 'N', n_paths);
571 * Method called to retrieve information about a specific peer
572 * known to the service.
574 * @param cls Closure.
575 * @param peer Peer ID.
576 * @param tunnel Do we have a tunnel towards this peer? #GNUNET_YES/#GNUNET_NO
577 * @param neighbor Is this a direct neighbor? #GNUNET_YES/#GNUNET_NO
578 * @param n_paths Number of paths known towards peer.
579 * @param paths Array of PEER_IDs representing all paths to reach the peer.
580 * Each path starts with the local peer.
581 * Each path ends with the destination peer (given in @c peer).
584 peer_callback (void *cls,
585 const struct GNUNET_PeerIdentity *peer,
588 unsigned int n_paths,
589 struct GNUNET_PeerIdentity *paths)
592 struct GNUNET_PeerIdentity *p;
594 FPRINTF (stdout, "%s [TUNNEL: %s, NEIGHBOR: %s, PATHS: %u]\n",
595 GNUNET_i2s_full (peer),
596 tunnel ? "Y" : "N", neighbor ? "Y" : "N", n_paths);
598 for (i = 0; i < n_paths && NULL != p;)
600 FPRINTF (stdout, "%s ", GNUNET_i2s (p));
601 if (0 == memcmp (p, peer, sizeof (*p)))
603 FPRINTF (stdout, "\n");
609 GNUNET_SCHEDULER_shutdown();
614 * Method called to retrieve information about all tunnels in CADET.
616 * @param cls Closure.
617 * @param peer Destination peer.
618 * @param channels Number of channels.
619 * @param connections Number of connections.
620 * @param estate Encryption state.
621 * @param cstate Connectivity state.
624 tunnels_callback (void *cls,
625 const struct GNUNET_PeerIdentity *peer,
626 unsigned int channels,
627 unsigned int connections,
633 if (GNUNET_YES != monitor_mode)
635 GNUNET_SCHEDULER_shutdown();
639 FPRINTF (stdout, "%s [ENC: %s, CON: %s] CHs: %u, CONNs: %u\n",
640 GNUNET_i2s_full (peer),
641 enc_2s (estate), conn_2s (cstate),
642 channels, connections);
647 * Method called to retrieve information about a specific tunnel the cadet peer
648 * has established, o`r is trying to establish.
650 * @param cls Closure.
651 * @param peer Peer towards whom the tunnel is directed.
652 * @param n_channels Number of channels.
653 * @param n_connections Number of connections.
654 * @param channels Channels.
655 * @param connections Connections.
656 * @param estate Encryption status.
657 * @param cstate Connectivity status.
660 tunnel_callback (void *cls,
661 const struct GNUNET_PeerIdentity *peer,
662 unsigned int n_channels,
663 unsigned int n_connections,
665 struct GNUNET_CADET_Hash *connections,
673 FPRINTF (stdout, "Tunnel %s\n", GNUNET_i2s_full (peer));
674 FPRINTF (stdout, "\t%u channels\n", n_channels);
675 for (i = 0; i < n_channels; i++)
676 FPRINTF (stdout, "\t\t%X\n", ntohl (channels[i]));
677 FPRINTF (stdout, "\t%u connections\n", n_connections);
678 for (i = 0; i < n_connections; i++)
679 FPRINTF (stdout, "\t\t%s\n", GC_h2s (&connections[i]));
680 FPRINTF (stdout, "\tencryption state: %s\n", enc_2s (estate));
681 FPRINTF (stdout, "\tconnection state: %s\n", conn_2s (cstate));
683 if (GNUNET_YES != monitor_mode)
685 GNUNET_SCHEDULER_shutdown();
692 * Call CADET's meta API, get all peers known to a peer.
694 * @param cls Closure (unused).
695 * @param tc TaskContext
698 get_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
700 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
702 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutdown\n");
705 GNUNET_CADET_get_peers (mh, &peers_callback, NULL);
710 * Call CADET's monitor API, get info of one peer.
712 * @param cls Closure (unused).
713 * @param tc TaskContext
716 show_peer (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
718 struct GNUNET_PeerIdentity pid;
721 GNUNET_CRYPTO_eddsa_public_key_from_string (peer_id,
726 _("Invalid peer ID `%s'\n"),
728 GNUNET_SCHEDULER_shutdown();
731 GNUNET_CADET_get_peer (mh, &pid, peer_callback, NULL);
735 * Call CADET's meta API, get all tunnels known to a peer.
737 * @param cls Closure (unused).
738 * @param tc TaskContext
741 get_tunnels (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
743 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
745 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutdown\n");
748 GNUNET_CADET_get_tunnels (mh, &tunnels_callback, NULL);
753 * Call CADET's monitor API, get info of one tunnel.
755 * @param cls Closure (unused).
756 * @param tc TaskContext
759 show_tunnel (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
761 struct GNUNET_PeerIdentity pid;
764 GNUNET_CRYPTO_eddsa_public_key_from_string (tunnel_id,
769 _("Invalid tunnel owner `%s'\n"),
771 GNUNET_SCHEDULER_shutdown();
774 GNUNET_CADET_get_tunnel (mh, &pid, tunnel_callback, NULL);
779 * Call CADET's monitor API, get info of one channel.
781 * @param cls Closure (unused).
782 * @param tc TaskContext
785 show_channel (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
792 * Call CADET's monitor API, get info of one connection.
794 * @param cls Closure (unused).
795 * @param tc TaskContext
798 show_connection (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
805 * Main function that will be run by the scheduler.
808 * @param args remaining command-line arguments
809 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
810 * @param cfg configuration
813 run (void *cls, char *const *args, const char *cfgfile,
814 const struct GNUNET_CONFIGURATION_Handle *cfg)
816 GNUNET_CADET_InboundChannelNotificationHandler *newch = NULL;
817 GNUNET_CADET_ChannelEndHandler *endch = NULL;
818 static const struct GNUNET_CADET_MessageHandler handlers[] = {
819 {&data_callback, GNUNET_MESSAGE_TYPE_CADET_CLI, 0},
820 {NULL, 0, 0} /* FIXME add option to monitor msg types */
822 static uint32_t *ports = NULL;
823 /* FIXME add option to monitor apps */
826 target_port = args[0] && args[1] ? atoi(args[1]) : 0;
827 if ( (0 != (request_peers | request_tunnels)
831 || NULL != channel_id)
832 && target_id != NULL)
835 _("You must NOT give a TARGET "
836 "when using 'request all' options\n"));
840 if (GNUNET_YES == dump)
842 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
843 "requesting debug dump\n");
844 GNUNET_SCHEDULER_add_now (&request_dump, NULL);
846 else if (NULL != target_id)
848 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
849 "Creating channel to %s\n",
851 GNUNET_SCHEDULER_add_now (&create_channel, NULL);
852 endch = &channel_ended;
854 else if (0 != listen_port)
856 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Listen\n");
857 newch = &channel_incoming;
858 endch = &channel_ended;
859 ports = GNUNET_malloc (sizeof (uint32_t) * 2);
860 ports[0] = listen_port;
862 else if (NULL != peer_id)
864 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show peer\n");
865 GNUNET_SCHEDULER_add_now (&show_peer, NULL);
867 else if (NULL != tunnel_id)
869 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show tunnel\n");
870 GNUNET_SCHEDULER_add_now (&show_tunnel, NULL);
872 else if (NULL != channel_id)
874 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show channel\n");
875 GNUNET_SCHEDULER_add_now (&show_channel, NULL);
877 else if (NULL != conn_id)
879 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show connection\n");
880 GNUNET_SCHEDULER_add_now (&show_connection, NULL);
882 else if (GNUNET_YES == request_peers)
884 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show all peers\n");
885 GNUNET_SCHEDULER_add_now (&get_peers, NULL);
887 else if (GNUNET_YES == request_tunnels)
889 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show all tunnels\n");
890 GNUNET_SCHEDULER_add_now (&get_tunnels, NULL);
894 FPRINTF (stderr, "No action requested\n");
898 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to cadet\n");
899 mh = GNUNET_CADET_connect (cfg,
901 newch, /* new channel */
905 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Done\n");
907 GNUNET_SCHEDULER_add_now (shutdown_task, NULL);
909 sd = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
910 shutdown_task, NULL);
916 * The main function to obtain peer information.
918 * @param argc number of arguments from the command line
919 * @param argv command line arguments
920 * @return 0 ok, 1 on error
923 main (int argc, char *const *argv)
926 const char helpstr[] = "Create channels and retreive info about cadets status.";
927 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
928 // {'a', "channel", "TUNNEL_ID:CHANNEL_ID",
929 // gettext_noop ("provide information about a particular channel"),
930 // GNUNET_YES, &GNUNET_GETOPT_set_string, &channel_id},
931 {'C', "connection", "CONNECTION_ID",
932 gettext_noop ("provide information about a particular connection"),
933 GNUNET_YES, &GNUNET_GETOPT_set_string, &conn_id},
935 gettext_noop ("activate echo mode"),
936 GNUNET_NO, &GNUNET_GETOPT_set_one, &echo},
938 gettext_noop ("dump debug information to STDERR"),
939 GNUNET_NO, &GNUNET_GETOPT_set_one, &dump},
940 // {'m', "monitor", NULL,
941 // gettext_noop ("provide information about all events (continuously)"),
942 // GNUNET_NO, &GNUNET_GETOPT_set_one, &monitor_mode},
943 {'o', "open-port", NULL,
944 gettext_noop ("port to listen to (default; 0)"),
945 GNUNET_YES, &GNUNET_GETOPT_set_uint, &listen_port},
946 {'p', "peer", "PEER_ID",
947 gettext_noop ("provide information about a patricular peer"),
948 GNUNET_YES, &GNUNET_GETOPT_set_string, &peer_id},
950 gettext_noop ("provide information about all peers"),
951 GNUNET_NO, &GNUNET_GETOPT_set_one, &request_peers},
952 {'t', "tunnel", "TUNNEL_ID",
953 gettext_noop ("provide information about a particular tunnel"),
954 GNUNET_YES, &GNUNET_GETOPT_set_string, &tunnel_id},
955 {'T', "tunnels", NULL,
956 gettext_noop ("provide information about all tunnels"),
957 GNUNET_NO, &GNUNET_GETOPT_set_one, &request_tunnels},
959 GNUNET_GETOPT_OPTION_END
962 monitor_mode = GNUNET_NO;
964 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
967 res = GNUNET_PROGRAM_run (argc, argv, "gnunet-cadet (OPTIONS | TARGET PORT)",
968 gettext_noop (helpstr),
969 options, &run, NULL);
971 GNUNET_free ((void *) argv);
973 if (GNUNET_OK == res)
979 /* end of gnunet-cadet.c */