2 This file is part of GNUnet.
3 Copyright (C) 2012 GNUnet e.V.
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 static struct GNUNET_TIME_Absolute echo_time;
88 * Task for next echo request.
90 static struct GNUNET_SCHEDULER_Task *echo_task;
95 static char *target_id;
100 static uint32_t target_port;
103 * Data pending in netcat mode.
105 static size_t data_size;
110 static struct GNUNET_CADET_Handle *mh;
115 static struct GNUNET_CADET_Channel *ch;
120 static struct GNUNET_CADET_TransmitHandle *th;
123 * Shutdown task handle.
125 static struct GNUNET_SCHEDULER_Task *sd;
128 * Task for reading from stdin.
130 static struct GNUNET_SCHEDULER_Task *rd_task;
135 static struct GNUNET_SCHEDULER_Task *job;
143 * Convert encryption status to human readable string.
145 * @param status Encryption status.
147 * @return Human readable string.
150 enc_2s (uint16_t status)
169 * Convert connection status to human readable string.
171 * @param status Connection status.
173 * @return Human readable string.
176 conn_2s (uint16_t status)
198 * Task run in monitor mode when the user presses CTRL-C to abort.
199 * Stops monitoring activity.
201 * @param cls Closure (unused).
204 shutdown_task (void *cls)
206 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
210 GNUNET_CADET_notify_transmit_ready_cancel (th);
215 GNUNET_CADET_channel_destroy (ch);
220 GNUNET_CADET_disconnect (mh);
225 GNUNET_SCHEDULER_cancel (rd_task);
228 if (NULL != echo_task)
230 GNUNET_SCHEDULER_cancel (echo_task);
235 GNUNET_SCHEDULER_cancel (job);
242 * Function called to notify a client about the connection
243 * begin ready to queue more data. "buf" will be
244 * NULL and "size" zero if the connection was closed for
245 * writing in the meantime.
250 * @param size number of bytes available in buf
251 * @param buf where the callee should write the message
252 * @return number of bytes written to buf
255 data_ready (void *cls, size_t size, void *buf)
257 struct GNUNET_MessageHeader *msg;
262 if (NULL == buf || 0 == size)
264 GNUNET_SCHEDULER_shutdown();
268 total_size = data_size + sizeof (struct GNUNET_MessageHeader);
269 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sending %u bytes\n", data_size);
270 GNUNET_assert (size >= total_size);
273 msg->size = htons (total_size);
274 msg->type = htons (GNUNET_MESSAGE_TYPE_CADET_CLI);
275 memcpy (&msg[1], cls, data_size);
276 if (GNUNET_NO == echo)
282 echo_time = GNUNET_TIME_absolute_get ();
290 * Task run in stdio mode, after some data is available at stdin.
292 * @param cls Closure (unused).
295 read_stdio (void *cls)
297 static char buf[60000];
299 data_size = read (0, buf, 60000);
300 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "stdio read %u bytes\n", data_size);
303 GNUNET_SCHEDULER_shutdown();
306 GNUNET_assert (NULL == th);
307 th = GNUNET_CADET_notify_transmit_ready (ch, GNUNET_NO,
308 GNUNET_TIME_UNIT_FOREVER_REL,
309 sizeof (struct GNUNET_MessageHeader)
316 * Start listening to stdin
321 struct GNUNET_NETWORK_FDSet *rs;
323 rs = GNUNET_NETWORK_fdset_create ();
324 GNUNET_NETWORK_fdset_set_native (rs, 0);
325 rd_task = GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
326 GNUNET_TIME_UNIT_FOREVER_REL,
329 GNUNET_NETWORK_fdset_destroy (rs);
334 * Function called whenever a channel is destroyed. Should clean up
335 * any associated state.
337 * It must NOT call #GNUNET_CADET_channel_destroy on the channel.
339 * @param cls closure (set from #GNUNET_CADET_connect)
340 * @param channel connection to the other end (henceforth invalid)
341 * @param channel_ctx place where local state associated
342 * with the channel is stored
345 channel_ended (void *cls,
346 const struct GNUNET_CADET_Channel *channel,
349 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Channel ended!\n");
353 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "ended: %p, expected: %p\n", channel, ch);
361 GNUNET_CADET_notify_transmit_ready_cancel (th);
365 GNUNET_SCHEDULER_shutdown ();
370 * Method called whenever another peer has added us to a channel
371 * the other peer initiated.
372 * Only called (once) upon reception of data with a message type which was
373 * subscribed to in #GNUNET_CADET_connect.
375 * A call to #GNUNET_CADET_channel_destroy causes te channel to be ignored. In
376 * this case the handler MUST return NULL.
379 * @param channel new handle to the channel
380 * @param initiator peer that started the channel
381 * @param port Port this channel is for.
382 * @param options CadetOption flag field, with all active option bits set to 1.
384 * @return initial channel context for the channel
385 * (can be NULL -- that's not an error)
388 channel_incoming (void *cls,
389 struct GNUNET_CADET_Channel * channel,
390 const struct GNUNET_PeerIdentity * initiator,
391 uint32_t port, enum GNUNET_CADET_ChannelOption options)
393 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
394 "Incoming channel %p on port %u\n",
399 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
400 "A channel already exists (%p)\n", ch);
401 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
402 "Incoming channel %p on port %u\n", channel, port);
405 if (0 == listen_port)
407 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Not listening to channels\n");
411 if (GNUNET_NO == echo)
421 * @brief Send an echo request to the remote peer.
423 * @param cls Closure (NULL).
426 send_echo (void *cls)
430 GNUNET_assert (NULL == th);
431 th = GNUNET_CADET_notify_transmit_ready (ch, GNUNET_NO,
432 GNUNET_TIME_UNIT_FOREVER_REL,
433 sizeof (struct GNUNET_MessageHeader),
439 * Call CADET's monitor API, request debug dump on the service.
441 * @param cls Closure (unused).
444 request_dump (void *cls)
446 GNUNET_CADET_request_dump (mh);
447 GNUNET_SCHEDULER_cancel (sd);
448 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
449 &shutdown_task, NULL);
454 * Call CADET's monitor API, get info of one connection.
456 * @param cls Closure (unused).
459 create_channel (void *cls)
461 struct GNUNET_PeerIdentity pid;
462 enum GNUNET_CADET_ChannelOption opt;
464 GNUNET_assert (NULL == ch);
467 GNUNET_CRYPTO_eddsa_public_key_from_string (target_id,
472 _("Invalid target `%s'\n"),
474 GNUNET_SCHEDULER_shutdown ();
477 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to `%s'\n", target_id);
478 opt = GNUNET_CADET_OPTION_DEFAULT | GNUNET_CADET_OPTION_RELIABLE;
479 ch = GNUNET_CADET_channel_create (mh, NULL, &pid, target_port, opt);
480 if (GNUNET_NO == echo)
483 echo_task = GNUNET_SCHEDULER_add_now (&send_echo, NULL);
488 * Function called whenever a message is received.
490 * Each time the function must call #GNUNET_CADET_receive_done on the channel
491 * in order to receive the next message. This doesn't need to be immediate:
492 * can be delayed if some processing is done on the message.
494 * @param cls Closure (set from #GNUNET_CADET_connect).
495 * @param channel Connection to the other end.
496 * @param channel_ctx Place to store local state associated with the channel.
497 * @param message The actual message.
498 * @return #GNUNET_OK to keep the channel open,
499 * #GNUNET_SYSERR to close it (signal serious error).
502 data_callback (void *cls,
503 struct GNUNET_CADET_Channel *channel,
505 const struct GNUNET_MessageHeader *message)
511 GNUNET_break (ch == channel);
512 GNUNET_CADET_receive_done (channel);
514 if (GNUNET_YES == echo)
516 if (0 != listen_port)
518 /* Just listening to echo incoming messages*/
521 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
522 "Last echo reply not yet sent, dropping current reply.\n");
525 th = GNUNET_CADET_notify_transmit_ready (channel, GNUNET_NO,
526 GNUNET_TIME_UNIT_FOREVER_REL,
527 sizeof (struct GNUNET_MessageHeader),
533 struct GNUNET_TIME_Relative latency;
535 latency = GNUNET_TIME_absolute_get_duration (echo_time);
536 echo_time = GNUNET_TIME_UNIT_FOREVER_ABS;
537 FPRINTF (stdout, "time: %s\n",
538 GNUNET_STRINGS_relative_time_to_string (latency, GNUNET_NO));
539 echo_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
544 len = ntohs (message->size) - sizeof (*message);
545 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got %u bytes\n", len);
546 buf = (const char *) &message[1];
550 done = write (1, &buf[off], len - off);
554 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
556 return GNUNET_SYSERR;
565 * Method called to retrieve information about all peers in CADET, called
568 * After last peer has been reported, an additional call with NULL is done.
570 * @param cls Closure.
571 * @param peer Peer, or NULL on "EOF".
572 * @param tunnel Do we have a tunnel towards this peer?
573 * @param n_paths Number of known paths towards this peer.
574 * @param best_path How long is the best path?
575 * (0 = unknown, 1 = ourselves, 2 = neighbor)
578 peers_callback (void *cls,
579 const struct GNUNET_PeerIdentity *peer,
581 unsigned int n_paths,
582 unsigned int best_path)
586 if (GNUNET_YES != monitor_mode)
588 GNUNET_SCHEDULER_shutdown();
592 FPRINTF (stdout, "%s tunnel: %c, paths: %u\n",
593 GNUNET_i2s_full (peer), tunnel ? 'Y' : 'N', n_paths);
597 * Method called to retrieve information about a specific peer
598 * known to the service.
600 * @param cls Closure.
601 * @param peer Peer ID.
602 * @param tunnel Do we have a tunnel towards this peer? #GNUNET_YES/#GNUNET_NO
603 * @param neighbor Is this a direct neighbor? #GNUNET_YES/#GNUNET_NO
604 * @param n_paths Number of paths known towards peer.
605 * @param paths Array of PEER_IDs representing all paths to reach the peer.
606 * Each path starts with the local peer.
607 * Each path ends with the destination peer (given in @c peer).
610 peer_callback (void *cls,
611 const struct GNUNET_PeerIdentity *peer,
614 unsigned int n_paths,
615 struct GNUNET_PeerIdentity *paths)
618 struct GNUNET_PeerIdentity *p;
620 FPRINTF (stdout, "%s [TUNNEL: %s, NEIGHBOR: %s, PATHS: %u]\n",
621 GNUNET_i2s_full (peer),
622 tunnel ? "Y" : "N", neighbor ? "Y" : "N", n_paths);
624 for (i = 0; i < n_paths && NULL != p;)
626 FPRINTF (stdout, "%s ", GNUNET_i2s (p));
627 if (0 == memcmp (p, peer, sizeof (*p)))
629 FPRINTF (stdout, "\n");
635 GNUNET_SCHEDULER_shutdown();
640 * Method called to retrieve information about all tunnels in CADET.
642 * @param cls Closure.
643 * @param peer Destination peer.
644 * @param channels Number of channels.
645 * @param connections Number of connections.
646 * @param estate Encryption state.
647 * @param cstate Connectivity state.
650 tunnels_callback (void *cls,
651 const struct GNUNET_PeerIdentity *peer,
652 unsigned int channels,
653 unsigned int connections,
659 if (GNUNET_YES != monitor_mode)
661 GNUNET_SCHEDULER_shutdown();
665 FPRINTF (stdout, "%s [ENC: %s, CON: %s] CHs: %u, CONNs: %u\n",
666 GNUNET_i2s_full (peer),
667 enc_2s (estate), conn_2s (cstate),
668 channels, connections);
673 * Method called to retrieve information about a specific tunnel the cadet peer
674 * has established, o`r is trying to establish.
676 * @param cls Closure.
677 * @param peer Peer towards whom the tunnel is directed.
678 * @param n_channels Number of channels.
679 * @param n_connections Number of connections.
680 * @param channels Channels.
681 * @param connections Connections.
682 * @param estate Encryption status.
683 * @param cstate Connectivity status.
686 tunnel_callback (void *cls,
687 const struct GNUNET_PeerIdentity *peer,
688 unsigned int n_channels,
689 unsigned int n_connections,
691 struct GNUNET_CADET_Hash *connections,
699 FPRINTF (stdout, "Tunnel %s\n", GNUNET_i2s_full (peer));
700 FPRINTF (stdout, "\t%u channels\n", n_channels);
701 for (i = 0; i < n_channels; i++)
702 FPRINTF (stdout, "\t\t%X\n", ntohl (channels[i]));
703 FPRINTF (stdout, "\t%u connections\n", n_connections);
704 for (i = 0; i < n_connections; i++)
705 FPRINTF (stdout, "\t\t%s\n", GC_h2s (&connections[i]));
706 FPRINTF (stdout, "\tencryption state: %s\n", enc_2s (estate));
707 FPRINTF (stdout, "\tconnection state: %s\n", conn_2s (cstate));
709 if (GNUNET_YES != monitor_mode)
711 GNUNET_SCHEDULER_shutdown ();
718 * Call CADET's meta API, get all peers known to a peer.
720 * @param cls Closure (unused).
723 get_peers (void *cls)
726 GNUNET_CADET_get_peers (mh, &peers_callback, NULL);
731 * Call CADET's monitor API, get info of one peer.
733 * @param cls Closure (unused).
736 show_peer (void *cls)
738 struct GNUNET_PeerIdentity pid;
742 GNUNET_CRYPTO_eddsa_public_key_from_string (peer_id,
747 _("Invalid peer ID `%s'\n"),
749 GNUNET_SCHEDULER_shutdown();
752 GNUNET_CADET_get_peer (mh, &pid, peer_callback, NULL);
757 * Call CADET's meta API, get all tunnels known to a peer.
759 * @param cls Closure (unused).
762 get_tunnels (void *cls)
765 GNUNET_CADET_get_tunnels (mh, &tunnels_callback, NULL);
770 * Call CADET's monitor API, get info of one tunnel.
772 * @param cls Closure (unused).
775 show_tunnel (void *cls)
777 struct GNUNET_PeerIdentity pid;
780 GNUNET_CRYPTO_eddsa_public_key_from_string (tunnel_id,
785 _("Invalid tunnel owner `%s'\n"),
787 GNUNET_SCHEDULER_shutdown ();
790 GNUNET_CADET_get_tunnel (mh, &pid, tunnel_callback, NULL);
795 * Call CADET's monitor API, get info of one channel.
797 * @param cls Closure (unused).
800 show_channel (void *cls)
808 * Call CADET's monitor API, get info of one connection.
810 * @param cls Closure (unused).
813 show_connection (void *cls)
821 * Main function that will be run by the scheduler.
824 * @param args remaining command-line arguments
825 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
826 * @param cfg configuration
832 const struct GNUNET_CONFIGURATION_Handle *cfg)
834 GNUNET_CADET_InboundChannelNotificationHandler *newch = NULL;
835 GNUNET_CADET_ChannelEndHandler *endch = NULL;
836 static const struct GNUNET_CADET_MessageHandler handlers[] = {
837 {&data_callback, GNUNET_MESSAGE_TYPE_CADET_CLI, 0},
838 {NULL, 0, 0} /* FIXME add option to monitor msg types */
840 static uint32_t *ports = NULL;
841 /* FIXME add option to monitor apps */
844 target_port = args[0] && args[1] ? atoi(args[1]) : 0;
845 if ( (0 != (request_peers | request_tunnels)
849 || NULL != channel_id)
850 && target_id != NULL)
853 _("You must NOT give a TARGET "
854 "when using 'request all' options\n"));
858 if (GNUNET_YES == dump)
860 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
861 "requesting debug dump\n");
862 GNUNET_SCHEDULER_add_now (&request_dump, NULL);
864 else if (NULL != target_id)
866 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
867 "Creating channel to %s\n",
869 GNUNET_SCHEDULER_add_now (&create_channel, NULL);
870 endch = &channel_ended;
872 else if (0 != listen_port)
874 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Listen\n");
875 newch = &channel_incoming;
876 endch = &channel_ended;
877 ports = GNUNET_malloc (sizeof (uint32_t) * 2);
878 ports[0] = listen_port;
880 else if (NULL != peer_id)
882 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show peer\n");
883 job = GNUNET_SCHEDULER_add_now (&show_peer, NULL);
885 else if (NULL != tunnel_id)
887 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show tunnel\n");
888 job = GNUNET_SCHEDULER_add_now (&show_tunnel, NULL);
890 else if (NULL != channel_id)
892 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show channel\n");
893 job = GNUNET_SCHEDULER_add_now (&show_channel, NULL);
895 else if (NULL != conn_id)
897 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show connection\n");
898 job = GNUNET_SCHEDULER_add_now (&show_connection, NULL);
900 else if (GNUNET_YES == request_peers)
902 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show all peers\n");
903 job = GNUNET_SCHEDULER_add_now (&get_peers, NULL);
905 else if (GNUNET_YES == request_tunnels)
907 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show all tunnels\n");
908 job = GNUNET_SCHEDULER_add_now (&get_tunnels, NULL);
912 FPRINTF (stderr, "No action requested\n");
916 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to cadet\n");
917 mh = GNUNET_CADET_connect (cfg,
919 newch, /* new channel */
923 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Done\n");
925 GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
927 sd = GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
932 * The main function to obtain peer information.
934 * @param argc number of arguments from the command line
935 * @param argv command line arguments
936 * @return 0 ok, 1 on error
939 main (int argc, char *const *argv)
942 const char helpstr[] = "Create channels and retreive info about cadets status.";
943 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
944 // {'a', "channel", "TUNNEL_ID:CHANNEL_ID",
945 // gettext_noop ("provide information about a particular channel"),
946 // GNUNET_YES, &GNUNET_GETOPT_set_string, &channel_id},
947 {'C', "connection", "CONNECTION_ID",
948 gettext_noop ("provide information about a particular connection"),
949 GNUNET_YES, &GNUNET_GETOPT_set_string, &conn_id},
951 gettext_noop ("activate echo mode"),
952 GNUNET_NO, &GNUNET_GETOPT_set_one, &echo},
954 gettext_noop ("dump debug information to STDERR"),
955 GNUNET_NO, &GNUNET_GETOPT_set_one, &dump},
956 // {'m', "monitor", NULL,
957 // gettext_noop ("provide information about all events (continuously)"),
958 // GNUNET_NO, &GNUNET_GETOPT_set_one, &monitor_mode},
959 {'o', "open-port", NULL,
960 gettext_noop ("port to listen to (default; 0)"),
961 GNUNET_YES, &GNUNET_GETOPT_set_uint, &listen_port},
962 {'p', "peer", "PEER_ID",
963 gettext_noop ("provide information about a patricular peer"),
964 GNUNET_YES, &GNUNET_GETOPT_set_string, &peer_id},
966 gettext_noop ("provide information about all peers"),
967 GNUNET_NO, &GNUNET_GETOPT_set_one, &request_peers},
968 {'t', "tunnel", "TUNNEL_ID",
969 gettext_noop ("provide information about a particular tunnel"),
970 GNUNET_YES, &GNUNET_GETOPT_set_string, &tunnel_id},
971 {'T', "tunnels", NULL,
972 gettext_noop ("provide information about all tunnels"),
973 GNUNET_NO, &GNUNET_GETOPT_set_one, &request_tunnels},
975 GNUNET_GETOPT_OPTION_END
978 monitor_mode = GNUNET_NO;
980 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
983 res = GNUNET_PROGRAM_run (argc, argv, "gnunet-cadet (OPTIONS | TARGET PORT)",
984 gettext_noop (helpstr),
985 options, &run, NULL);
987 GNUNET_free ((void *) argv);
989 if (GNUNET_OK == res)
995 /* end of gnunet-cadet.c */