2 This file is part of GNUnet.
3 (C) 2010,2011 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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file transport/gnunet-service-transport-new.c
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_statistics_service.h"
29 #include "gnunet_transport_service.h"
30 #include "gnunet_peerinfo_service.h"
31 #include "gnunet_ats_service.h"
32 #include "gnunet-service-transport.h"
33 #include "gnunet-service-transport_blacklist.h"
34 #include "gnunet-service-transport_clients.h"
35 #include "gnunet-service-transport_hello.h"
36 #include "gnunet-service-transport_neighbours.h"
37 #include "gnunet-service-transport_plugins.h"
38 #include "gnunet-service-transport_validation.h"
39 #include "transport.h"
46 struct GNUNET_STATISTICS_Handle *GST_stats;
49 * Configuration handle.
51 const struct GNUNET_CONFIGURATION_Handle *GST_cfg;
54 * Configuration handle.
56 struct GNUNET_PeerIdentity GST_my_identity;
59 * Handle to peerinfo service.
61 struct GNUNET_PEERINFO_Handle *GST_peerinfo;
66 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded GST_my_public_key;
71 struct GNUNET_CRYPTO_RsaPrivateKey *GST_my_private_key;
76 struct GNUNET_ATS_SchedulingHandle *GST_ats;
80 * Transmit our HELLO message to the given (connected) neighbour.
82 * @param cls the 'HELLO' message
83 * @param target a connected neighbour
84 * @param ats performance information (unused)
85 * @param ats_count number of records in ats (unused)
86 * @param transport plugin
88 * @param addrlen address length
91 transmit_our_hello (void *cls, const struct GNUNET_PeerIdentity *target,
92 const struct GNUNET_TRANSPORT_ATS_Information *ats,
94 const char * transport,
98 const struct GNUNET_MessageHeader *hello = cls;
100 GST_neighbours_send (target, (const char *) hello, ntohs (hello->size),
101 GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION, NULL, NULL);
106 * My HELLO has changed. Tell everyone who should know.
109 * @param hello new HELLO
112 process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello)
114 GST_clients_broadcast (hello, GNUNET_NO);
115 GST_neighbours_iterate (&transmit_our_hello, (void *) hello);
120 * Try to initiate a connection to the given peer if the blacklist
123 * @param cls closure (unused, NULL)
124 * @param peer identity of peer that was tested
125 * @param result GNUNET_OK if the connection is allowed,
129 try_connect_if_allowed (void *cls, const struct GNUNET_PeerIdentity *peer,
132 if (GNUNET_OK != result)
133 return; /* not allowed */
134 GST_neighbours_try_connect (peer);
139 * Function called by the transport for each received message.
140 * This function should also be called with "NULL" for the
141 * message to signal that the other peer disconnected.
143 * @param cls closure, const char* with the name of the plugin we received the message from
144 * @param peer (claimed) identity of the other peer
145 * @param message the message, NULL if we only care about
146 * learning about the delay until we should receive again -- FIXME!
147 * @param ats performance information
148 * @param ats_count number of records in ats
149 * @param session identifier used for this session (NULL for plugins
150 * that do not offer bi-directional communication to the sender
151 * using the same "connection")
152 * @param sender_address binary address of the sender (if we established the
153 * connection or are otherwise sure of it; should be NULL
154 * for inbound TCP/UDP connections since it it not clear
155 * that we could establish ourselves a connection to that
156 * IP address and get the same system)
157 * @param sender_address_len number of bytes in sender_address
158 * @return how long the plugin should wait until receiving more data
159 * (plugins that do not support this, can ignore the return value)
161 static struct GNUNET_TIME_Relative
162 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
163 const struct GNUNET_MessageHeader *message,
164 const struct GNUNET_TRANSPORT_ATS_Information *ats,
165 uint32_t ats_count, struct Session *session,
166 const char *sender_address,
167 uint16_t sender_address_len)
169 const char *plugin_name = cls;
171 struct GNUNET_TIME_Relative ret;
174 ret = GNUNET_TIME_UNIT_ZERO;
177 type = ntohs (message->type);
180 case GNUNET_MESSAGE_TYPE_HELLO:
181 GST_validation_handle_hello (message);
183 case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
185 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
186 "Processing `%s' from `%s'\n", "PING",
187 (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
192 GST_validation_handle_ping (peer, message, plugin_name, session,
193 sender_address, sender_address_len);
195 case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
197 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
198 "Processing `%s' from `%s'\n", "PONG",
199 (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
204 GST_validation_handle_pong (peer, message);
206 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
207 (void) GST_blacklist_test_allowed (peer, NULL, &try_connect_if_allowed,
209 /* TODO: if 'session != NULL', and timestamp more recent than the
210 * previous one, maybe notify ATS that this is now the preferred
211 * * way to communicate with this peer (other peer switched transport) */
213 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
214 /* FIXME: do some validation to prevent an attacker from sending
215 * a fake disconnect message... */
216 GST_neighbours_force_disconnect (peer);
218 case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
219 GST_neighbours_keepalive (peer);
222 /* should be payload */
223 do_forward = GNUNET_SYSERR;
225 GST_neighbours_calculate_receive_delay (peer,
228 ntohs (message->size),
230 if (do_forward == GNUNET_YES)
232 struct InboundMessage *im;
233 size_t size = sizeof (struct InboundMessage) + ntohs (message->size);
235 im = GNUNET_malloc (size);
236 im->header.size = htons (size);
237 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
238 im->ats_count = htonl (0);
239 memcpy (&(im->peer), peer, sizeof (struct GNUNET_PeerIdentity));
240 memcpy (&im[1], message, ntohs (message->size));
241 GST_clients_broadcast ((const struct GNUNET_MessageHeader *) im,
250 FIXME: this gives an address that might not have been validated to
251 ATS for 'selection', which is probably not what we want; this
252 might be particularly wrong (as in, possibly hiding bugs with address
253 validation) as 'GNUNET_ATS_address_update' currently ignores
254 the expiration given.
256 if ((ats_count > 0) && (ats != NULL))
257 GNUNET_ATS_address_update (GST_ats, peer,
258 plugin_name, sender_address, sender_address_len,
266 * Function that will be called for each address the transport
267 * is aware that it might be reachable under. Update our HELLO.
269 * @param cls name of the plugin (const char*)
270 * @param add_remove should the address added (YES) or removed (NO) from the
271 * set of valid addresses?
272 * @param addr one of the addresses of the host
273 * the specific address format depends on the transport
274 * @param addrlen length of the address
277 plugin_env_address_change_notification (void *cls, int add_remove,
278 const void *addr, size_t addrlen)
280 const char *plugin_name = cls;
282 GST_hello_modify_addresses (add_remove, plugin_name, addr, addrlen);
287 * Function that will be called whenever the plugin internally
288 * cleans up a session pointer and hence the service needs to
289 * discard all of those sessions as well. Plugins that do not
290 * use sessions can simply omit calling this function and always
291 * use NULL wherever a session pointer is needed. This function
292 * should be called BEFORE a potential "TransmitContinuation"
293 * from the "TransmitFunction".
296 * @param peer which peer was the session for
297 * @param session which session is being destoyed
300 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
301 struct Session *session)
304 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
305 "Session %X to peer `%s' ended \n",
306 session, GNUNET_i2s (peer));
308 GNUNET_ATS_address_destroyed(GST_ats, peer, NULL, NULL, 0, session);
309 GST_neighbours_session_terminated (peer, session);
314 * Function called by ATS to notify the callee that the
315 * assigned bandwidth or address for a given peer was changed. If the
316 * callback is called with address/bandwidth assignments of zero, the
317 * ATS disconnect function will still be called once the disconnect
321 * @param peer identity of the peer
322 * @param plugin_name name of the transport plugin, NULL to disconnect
323 * @param session session to use (if available)
324 * @param plugin_addr address to use (if available)
325 * @param plugin_addr_len number of bytes in addr
326 * @param bandwidth_out assigned outbound bandwidth for the connection
327 * @param bandwidth_in assigned inbound bandwidth for the connection
330 ats_request_address_change (void *cls, const struct GNUNET_PeerIdentity *peer,
331 const char *plugin_name,
332 const void *plugin_addr, size_t plugin_addr_len,
333 struct Session *session,
334 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
335 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
337 GST_neighbours_switch_to_address (peer, plugin_name, plugin_addr,
338 plugin_addr_len, session, NULL, 0);
339 GST_neighbours_set_incoming_quota (peer, bandwidth_in);
342 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending outbound quota of %u Bps for peer `%s' to all clients\n",
343 ntohl (bandwidth_out.value__), GNUNET_i2s (target));
345 struct QuotaSetMessage msg;
346 msg.header.size = htons (sizeof (struct QuotaSetMessage));
347 msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
348 msg.quota = bandwidth_out;
350 GST_clients_broadcast ((struct GNUNET_MessageHeader *) &msg, GNUNET_NO);
353 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Setting inbound quota of %u for peer `%s' to \n",
354 ntohl (bandwidth_in.value__), GNUNET_i2s (target));
356 GST_neighbours_set_incoming_quota (peer, bandwidth_in);
361 * Function called to notify transport users that another
362 * peer connected to us.
365 * @param peer the peer that connected
366 * @param ats performance data
367 * @param ats_count number of entries in ats
370 neighbours_connect_notification (void *cls,
371 const struct GNUNET_PeerIdentity *peer,
372 const struct GNUNET_TRANSPORT_ATS_Information
373 *ats, uint32_t ats_count)
375 char buf[sizeof (struct ConnectInfoMessage) +
376 ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)];
377 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
379 connect_msg->header.size = htons (sizeof (buf));
380 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
381 connect_msg->ats_count = htonl (ats_count);
382 connect_msg->id = *peer;
383 memcpy (&connect_msg->ats, &connect_msg->ats,
384 ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
385 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
390 * Function called to notify transport users that another
391 * peer disconnected from us.
394 * @param peer the peer that disconnected
397 neighbours_disconnect_notification (void *cls,
398 const struct GNUNET_PeerIdentity *peer)
400 struct DisconnectInfoMessage disconnect_msg;
402 disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
403 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
404 disconnect_msg.reserved = htonl (0);
405 disconnect_msg.peer = *peer;
406 GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
411 * Function called when the service shuts down. Unloads our plugins
412 * and cancels pending validations.
414 * @param cls closure, unused
415 * @param tc task context (unused)
418 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
420 GST_validation_stop ();
421 GST_plugins_unload ();
422 GST_neighbours_stop ();
423 GNUNET_ATS_scheduling_done (GST_ats);
426 GST_blacklist_stop ();
429 if (GST_peerinfo != NULL)
431 GNUNET_PEERINFO_disconnect (GST_peerinfo);
434 if (GST_stats != NULL)
436 GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
439 if (GST_my_private_key != NULL)
441 GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
442 GST_my_private_key = NULL;
448 * Initiate transport service.
451 * @param server the initialized server
452 * @param c configuration to use
455 run (void *cls, struct GNUNET_SERVER_Handle *server,
456 const struct GNUNET_CONFIGURATION_Handle *c)
463 GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
466 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
468 ("Transport service is lacking key configuration settings. Exiting.\n"));
469 GNUNET_SCHEDULER_shutdown ();
472 GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
473 GNUNET_free (keyfile);
474 if (GST_my_private_key == NULL)
476 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
477 _("Transport service could not access hostkey. Exiting.\n"));
478 GNUNET_SCHEDULER_shutdown ();
481 GST_stats = GNUNET_STATISTICS_create ("transport", c);
482 GST_peerinfo = GNUNET_PEERINFO_connect (c);
483 GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
484 GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
485 &GST_my_identity.hashPubKey);
486 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
488 if (GST_peerinfo == NULL)
490 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
491 _("Could not access PEERINFO service. Exiting.\n"));
492 GNUNET_SCHEDULER_shutdown ();
496 /* start subsystems */
497 GST_hello_start (&process_hello_update, NULL);
498 GST_blacklist_start (server);
499 GST_plugins_load (&plugin_env_receive_callback,
500 &plugin_env_address_change_notification,
501 &plugin_env_session_end);
502 GST_ats = GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
503 GST_neighbours_start (NULL, &neighbours_connect_notification,
504 &neighbours_disconnect_notification);
505 GST_clients_start (server);
506 GST_validation_start ();
511 * The main function for the transport service.
513 * @param argc number of arguments from the command line
514 * @param argv command line arguments
515 * @return 0 ok, 1 on error
518 main (int argc, char *const *argv)
521 GNUNET_SERVICE_run (argc, argv, "transport",
522 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
525 /* end of file gnunet-service-transport-new.c */