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_notify_transmit_ready_cancel (th);
206 GNUNET_CADET_channel_destroy (ch);
211 GNUNET_CADET_disconnect (mh);
218 * Function called to notify a client about the connection
219 * begin ready to queue more data. "buf" will be
220 * NULL and "size" zero if the connection was closed for
221 * writing in the meantime.
226 * @param size number of bytes available in buf
227 * @param buf where the callee should write the message
228 * @return number of bytes written to buf
231 data_ready (void *cls, size_t size, void *buf)
233 struct GNUNET_MessageHeader *msg;
238 if (NULL == buf || 0 == size)
240 GNUNET_SCHEDULER_shutdown();
244 total_size = data_size + sizeof (struct GNUNET_MessageHeader);
245 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sending %u bytes\n", data_size);
246 GNUNET_assert (size >= total_size);
249 msg->size = htons (total_size);
250 msg->type = htons (GNUNET_MESSAGE_TYPE_CADET_CLI);
251 memcpy (&msg[1], cls, data_size);
252 if (GNUNET_NO == echo)
258 echo_time = GNUNET_TIME_absolute_get ();
266 * Task run in stdio mode, after some data is available at stdin.
268 * @param cls Closure (unused).
269 * @param tc scheduler context
272 read_stdio (void *cls,
273 const struct GNUNET_SCHEDULER_TaskContext *tc)
275 static char buf[60000];
277 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
282 data_size = read (0, buf, 60000);
283 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "stdio read %u bytes\n", data_size);
286 GNUNET_SCHEDULER_shutdown();
289 GNUNET_assert (NULL == th);
290 th = GNUNET_CADET_notify_transmit_ready (ch, GNUNET_NO,
291 GNUNET_TIME_UNIT_FOREVER_REL,
292 sizeof (struct GNUNET_MessageHeader)
299 * Start listening to stdin
304 struct GNUNET_NETWORK_FDSet *rs;
306 rs = GNUNET_NETWORK_fdset_create ();
307 GNUNET_NETWORK_fdset_set_native (rs, 0);
308 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
309 GNUNET_TIME_UNIT_FOREVER_REL,
312 GNUNET_NETWORK_fdset_destroy (rs);
317 * Function called whenever a channel is destroyed. Should clean up
318 * any associated state.
320 * It must NOT call #GNUNET_CADET_channel_destroy on the channel.
322 * @param cls closure (set from #GNUNET_CADET_connect)
323 * @param channel connection to the other end (henceforth invalid)
324 * @param channel_ctx place where local state associated
325 * with the channel is stored
328 channel_ended (void *cls,
329 const struct GNUNET_CADET_Channel *channel,
332 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Channel ended!\n");
336 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "ended: %p, expected: %p\n", channel, ch);
344 GNUNET_CADET_notify_transmit_ready_cancel (th);
348 GNUNET_SCHEDULER_shutdown ();
353 * Method called whenever another peer has added us to a channel
354 * the other peer initiated.
355 * Only called (once) upon reception of data with a message type which was
356 * subscribed to in #GNUNET_CADET_connect.
358 * A call to #GNUNET_CADET_channel_destroy causes te channel to be ignored. In
359 * this case the handler MUST return NULL.
362 * @param channel new handle to the channel
363 * @param initiator peer that started the channel
364 * @param port Port this channel is for.
365 * @param options CadetOption flag field, with all active option bits set to 1.
367 * @return initial channel context for the channel
368 * (can be NULL -- that's not an error)
371 channel_incoming (void *cls,
372 struct GNUNET_CADET_Channel * channel,
373 const struct GNUNET_PeerIdentity * initiator,
374 uint32_t port, enum GNUNET_CADET_ChannelOption options)
376 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
377 "Incoming channel %p on port %u\n",
382 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
383 "A channel already exists (%p)\n", ch);
384 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
385 "Incoming channel %p on port %u\n", channel, port);
388 if (0 == listen_port)
390 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Not listening to channels\n");
394 if (GNUNET_NO == echo)
404 * @brief Send an echo request to the remote peer.
406 * @param cls Closure (NULL).
407 * @param tc Task context.
410 send_echo (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
412 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) || NULL == ch)
415 GNUNET_assert (NULL == th);
416 th = GNUNET_CADET_notify_transmit_ready (ch, GNUNET_NO,
417 GNUNET_TIME_UNIT_FOREVER_REL,
418 sizeof (struct GNUNET_MessageHeader),
424 * Call CADET's monitor API, request debug dump on the service.
426 * @param cls Closure (unused).
427 * @param tc TaskContext
430 request_dump (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
432 GNUNET_CADET_request_dump (mh);
433 GNUNET_SCHEDULER_cancel (sd);
434 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &shutdown_task, NULL);
439 * Call CADET's monitor API, get info of one connection.
441 * @param cls Closure (unused).
442 * @param tc TaskContext
445 create_channel (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
447 struct GNUNET_PeerIdentity pid;
448 enum GNUNET_CADET_ChannelOption opt;
450 GNUNET_assert (NULL == ch);
453 GNUNET_CRYPTO_eddsa_public_key_from_string (target_id,
458 _("Invalid target `%s'\n"),
460 GNUNET_SCHEDULER_shutdown ();
463 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to `%s'\n", target_id);
464 opt = GNUNET_CADET_OPTION_DEFAULT | GNUNET_CADET_OPTION_RELIABLE;
465 ch = GNUNET_CADET_channel_create (mh, NULL, &pid, target_port, opt);
466 if (GNUNET_NO == echo)
469 GNUNET_SCHEDULER_add_now (send_echo, NULL);
474 * Function called whenever a message is received.
476 * Each time the function must call #GNUNET_CADET_receive_done on the channel
477 * in order to receive the next message. This doesn't need to be immediate:
478 * can be delayed if some processing is done on the message.
480 * @param cls Closure (set from #GNUNET_CADET_connect).
481 * @param channel Connection to the other end.
482 * @param channel_ctx Place to store local state associated with the channel.
483 * @param message The actual message.
484 * @return #GNUNET_OK to keep the channel open,
485 * #GNUNET_SYSERR to close it (signal serious error).
488 data_callback (void *cls,
489 struct GNUNET_CADET_Channel *channel,
491 const struct GNUNET_MessageHeader *message)
497 GNUNET_break (ch == channel);
498 GNUNET_CADET_receive_done (channel);
500 if (GNUNET_YES == echo)
502 if (0 != listen_port)
504 /* Just listening to echo incoming messages*/
507 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
508 "Last echo reply not yet sent, dropping current reply.\n");
511 th = GNUNET_CADET_notify_transmit_ready (channel, GNUNET_NO,
512 GNUNET_TIME_UNIT_FOREVER_REL,
513 sizeof (struct GNUNET_MessageHeader),
519 struct GNUNET_TIME_Relative latency;
521 latency = GNUNET_TIME_absolute_get_duration (echo_time);
522 echo_time = GNUNET_TIME_UNIT_FOREVER_ABS;
523 FPRINTF (stdout, "time: %s\n",
524 GNUNET_STRINGS_relative_time_to_string (latency, GNUNET_NO));
525 echo_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
530 len = ntohs (message->size) - sizeof (*message);
531 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got %u bytes\n", len);
532 buf = (const char *) &message[1];
536 done = write (1, &buf[off], len - off);
540 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
542 return GNUNET_SYSERR;
551 * Method called to retrieve information about all peers in CADET, called
554 * After last peer has been reported, an additional call with NULL is done.
556 * @param cls Closure.
557 * @param peer Peer, or NULL on "EOF".
558 * @param tunnel Do we have a tunnel towards this peer?
559 * @param n_paths Number of known paths towards this peer.
560 * @param best_path How long is the best path?
561 * (0 = unknown, 1 = ourselves, 2 = neighbor)
564 peers_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
565 int tunnel, unsigned int n_paths, unsigned int best_path)
569 if (GNUNET_YES != monitor_mode)
571 GNUNET_SCHEDULER_shutdown();
575 FPRINTF (stdout, "%s tunnel: %c, paths: %u\n",
576 GNUNET_i2s_full (peer), tunnel ? 'Y' : 'N', n_paths);
580 * Method called to retrieve information about a specific peer
581 * known to the service.
583 * @param cls Closure.
584 * @param peer Peer ID.
585 * @param tunnel Do we have a tunnel towards this peer? #GNUNET_YES/#GNUNET_NO
586 * @param neighbor Is this a direct neighbor? #GNUNET_YES/#GNUNET_NO
587 * @param n_paths Number of paths known towards peer.
588 * @param paths Array of PEER_IDs representing all paths to reach the peer.
589 * Each path starts with the local peer.
590 * Each path ends with the destination peer (given in @c peer).
593 peer_callback (void *cls,
594 const struct GNUNET_PeerIdentity *peer,
597 unsigned int n_paths,
598 struct GNUNET_PeerIdentity *paths)
601 struct GNUNET_PeerIdentity *p;
603 FPRINTF (stdout, "%s [TUNNEL: %s, NEIGHBOR: %s, PATHS: %u]\n",
604 GNUNET_i2s_full (peer),
605 tunnel ? "Y" : "N", neighbor ? "Y" : "N", n_paths);
607 for (i = 0; i < n_paths && NULL != p;)
609 FPRINTF (stdout, "%s ", GNUNET_i2s (p));
610 if (0 == memcmp (p, peer, sizeof (*p)))
612 FPRINTF (stdout, "\n");
618 GNUNET_SCHEDULER_shutdown();
623 * Method called to retrieve information about all tunnels in CADET.
625 * @param cls Closure.
626 * @param peer Destination peer.
627 * @param channels Number of channels.
628 * @param connections Number of connections.
629 * @param estate Encryption state.
630 * @param cstate Connectivity state.
633 tunnels_callback (void *cls,
634 const struct GNUNET_PeerIdentity *peer,
635 unsigned int channels,
636 unsigned int connections,
642 if (GNUNET_YES != monitor_mode)
644 GNUNET_SCHEDULER_shutdown();
648 FPRINTF (stdout, "%s [ENC: %s, CON: %s] CHs: %u, CONNs: %u\n",
649 GNUNET_i2s_full (peer),
650 enc_2s (estate), conn_2s (cstate),
651 channels, connections);
656 * Method called to retrieve information about a specific tunnel the cadet peer
657 * has established, o`r is trying to establish.
659 * @param cls Closure.
660 * @param peer Peer towards whom the tunnel is directed.
661 * @param n_channels Number of channels.
662 * @param n_connections Number of connections.
663 * @param channels Channels.
664 * @param connections Connections.
665 * @param estate Encryption status.
666 * @param cstate Connectivity status.
669 tunnel_callback (void *cls,
670 const struct GNUNET_PeerIdentity *peer,
671 unsigned int n_channels,
672 unsigned int n_connections,
674 struct GNUNET_CADET_Hash *connections,
682 FPRINTF (stdout, "Tunnel %s\n", GNUNET_i2s_full (peer));
683 FPRINTF (stdout, "\t%u channels\n", n_channels);
684 for (i = 0; i < n_channels; i++)
685 FPRINTF (stdout, "\t\t%X\n", ntohl (channels[i]));
686 FPRINTF (stdout, "\t%u connections\n", n_connections);
687 for (i = 0; i < n_connections; i++)
688 FPRINTF (stdout, "\t\t%s\n", GC_h2s (&connections[i]));
689 FPRINTF (stdout, "\tencryption state: %s\n", enc_2s (estate));
690 FPRINTF (stdout, "\tconnection state: %s\n", conn_2s (cstate));
692 if (GNUNET_YES != monitor_mode)
694 GNUNET_SCHEDULER_shutdown();
701 * Call CADET's meta API, get all peers known to a peer.
703 * @param cls Closure (unused).
704 * @param tc TaskContext
707 get_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
709 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
711 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutdown\n");
714 GNUNET_CADET_get_peers (mh, &peers_callback, NULL);
719 * Call CADET's monitor API, get info of one peer.
721 * @param cls Closure (unused).
722 * @param tc TaskContext
725 show_peer (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
727 struct GNUNET_PeerIdentity pid;
730 GNUNET_CRYPTO_eddsa_public_key_from_string (peer_id,
735 _("Invalid peer ID `%s'\n"),
737 GNUNET_SCHEDULER_shutdown();
740 GNUNET_CADET_get_peer (mh, &pid, peer_callback, NULL);
744 * Call CADET's meta API, get all tunnels known to a peer.
746 * @param cls Closure (unused).
747 * @param tc TaskContext
750 get_tunnels (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
752 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
754 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutdown\n");
757 GNUNET_CADET_get_tunnels (mh, &tunnels_callback, NULL);
762 * Call CADET's monitor API, get info of one tunnel.
764 * @param cls Closure (unused).
765 * @param tc TaskContext
768 show_tunnel (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
770 struct GNUNET_PeerIdentity pid;
773 GNUNET_CRYPTO_eddsa_public_key_from_string (tunnel_id,
778 _("Invalid tunnel owner `%s'\n"),
780 GNUNET_SCHEDULER_shutdown();
783 GNUNET_CADET_get_tunnel (mh, &pid, tunnel_callback, NULL);
788 * Call CADET's monitor API, get info of one channel.
790 * @param cls Closure (unused).
791 * @param tc TaskContext
794 show_channel (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
801 * Call CADET's monitor API, get info of one connection.
803 * @param cls Closure (unused).
804 * @param tc TaskContext
807 show_connection (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
814 * Main function that will be run by the scheduler.
817 * @param args remaining command-line arguments
818 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
819 * @param cfg configuration
822 run (void *cls, char *const *args, const char *cfgfile,
823 const struct GNUNET_CONFIGURATION_Handle *cfg)
825 GNUNET_CADET_InboundChannelNotificationHandler *newch = NULL;
826 GNUNET_CADET_ChannelEndHandler *endch = NULL;
827 static const struct GNUNET_CADET_MessageHandler handlers[] = {
828 {&data_callback, GNUNET_MESSAGE_TYPE_CADET_CLI, 0},
829 {NULL, 0, 0} /* FIXME add option to monitor msg types */
831 static uint32_t *ports = NULL;
832 /* FIXME add option to monitor apps */
835 target_port = args[0] && args[1] ? atoi(args[1]) : 0;
836 if ( (0 != (request_peers | request_tunnels)
840 || NULL != channel_id)
841 && target_id != NULL)
844 _("You must NOT give a TARGET "
845 "when using 'request all' options\n"));
849 if (GNUNET_YES == dump)
851 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
852 "requesting debug dump\n");
853 GNUNET_SCHEDULER_add_now (&request_dump, NULL);
855 else if (NULL != target_id)
857 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
858 "Creating channel to %s\n",
860 GNUNET_SCHEDULER_add_now (&create_channel, NULL);
861 endch = &channel_ended;
863 else if (0 != listen_port)
865 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Listen\n");
866 newch = &channel_incoming;
867 endch = &channel_ended;
868 ports = GNUNET_malloc (sizeof (uint32_t) * 2);
869 ports[0] = listen_port;
871 else if (NULL != peer_id)
873 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show peer\n");
874 GNUNET_SCHEDULER_add_now (&show_peer, NULL);
876 else if (NULL != tunnel_id)
878 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show tunnel\n");
879 GNUNET_SCHEDULER_add_now (&show_tunnel, NULL);
881 else if (NULL != channel_id)
883 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show channel\n");
884 GNUNET_SCHEDULER_add_now (&show_channel, NULL);
886 else if (NULL != conn_id)
888 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show connection\n");
889 GNUNET_SCHEDULER_add_now (&show_connection, NULL);
891 else if (GNUNET_YES == request_peers)
893 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show all peers\n");
894 GNUNET_SCHEDULER_add_now (&get_peers, NULL);
896 else if (GNUNET_YES == request_tunnels)
898 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Show all tunnels\n");
899 GNUNET_SCHEDULER_add_now (&get_tunnels, NULL);
903 FPRINTF (stderr, "No action requested\n");
907 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to cadet\n");
908 mh = GNUNET_CADET_connect (cfg,
910 newch, /* new channel */
914 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Done\n");
916 GNUNET_SCHEDULER_add_now (shutdown_task, NULL);
918 sd = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
919 shutdown_task, NULL);
925 * The main function to obtain peer information.
927 * @param argc number of arguments from the command line
928 * @param argv command line arguments
929 * @return 0 ok, 1 on error
932 main (int argc, char *const *argv)
935 const char helpstr[] = "Create channels and retreive info about cadets status.";
936 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
937 // {'a', "channel", "TUNNEL_ID:CHANNEL_ID",
938 // gettext_noop ("provide information about a particular channel"),
939 // GNUNET_YES, &GNUNET_GETOPT_set_string, &channel_id},
940 {'C', "connection", "CONNECTION_ID",
941 gettext_noop ("provide information about a particular connection"),
942 GNUNET_YES, &GNUNET_GETOPT_set_string, &conn_id},
944 gettext_noop ("activate echo mode"),
945 GNUNET_NO, &GNUNET_GETOPT_set_one, &echo},
947 gettext_noop ("dump debug information to STDERR"),
948 GNUNET_NO, &GNUNET_GETOPT_set_one, &dump},
949 // {'m', "monitor", NULL,
950 // gettext_noop ("provide information about all events (continuously)"),
951 // GNUNET_NO, &GNUNET_GETOPT_set_one, &monitor_mode},
952 {'o', "open-port", NULL,
953 gettext_noop ("port to listen to (default; 0)"),
954 GNUNET_YES, &GNUNET_GETOPT_set_uint, &listen_port},
955 {'p', "peer", "PEER_ID",
956 gettext_noop ("provide information about a patricular peer"),
957 GNUNET_YES, &GNUNET_GETOPT_set_string, &peer_id},
959 gettext_noop ("provide information about all peers"),
960 GNUNET_NO, &GNUNET_GETOPT_set_one, &request_peers},
961 {'t', "tunnel", "TUNNEL_ID",
962 gettext_noop ("provide information about a particular tunnel"),
963 GNUNET_YES, &GNUNET_GETOPT_set_string, &tunnel_id},
964 {'T', "tunnels", NULL,
965 gettext_noop ("provide information about all tunnels"),
966 GNUNET_NO, &GNUNET_GETOPT_set_one, &request_tunnels},
968 GNUNET_GETOPT_OPTION_END
971 monitor_mode = GNUNET_NO;
973 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
976 res = GNUNET_PROGRAM_run (argc, argv, "gnunet-cadet (OPTIONS | TARGET PORT)",
977 gettext_noop (helpstr),
978 options, &run, NULL);
980 GNUNET_free ((void *) argv);
982 if (GNUNET_OK == res)
988 /* end of gnunet-cadet.c */