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_hello.c
23 * @brief hello management implementation
24 * @author Christian Grothoff
27 #include "gnunet_hello_lib.h"
28 #include "gnunet_peerinfo_service.h"
29 #include "gnunet_statistics_service.h"
30 #include "gnunet-service-transport_hello.h"
31 #include "gnunet-service-transport.h"
32 #include "gnunet-service-transport_plugins.h"
36 * How often do we refresh our HELLO (due to expiration concerns)?
38 #define HELLO_REFRESH_PERIOD GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 6)
42 * Entry in linked list of network addresses for ourselves. Also
43 * includes a cached signature for 'struct TransportPongMessage's.
48 * This is a doubly-linked list.
50 struct OwnAddressList *next;
53 * This is a doubly-linked list.
55 struct OwnAddressList *prev;
63 * How long until the current signature expires? (ZERO if the
64 * signature was never created).
66 struct GNUNET_TIME_Absolute pong_sig_expires;
69 * Signature for a 'struct TransportPongMessage' for this address.
71 struct GNUNET_CRYPTO_RsaSignature pong_signature;
84 static struct GNUNET_HELLO_Message *our_hello;
87 * Function to call on HELLO changes.
89 static GST_HelloCallback hello_cb;
92 * Closure for 'hello_cb'.
94 static void *hello_cb_cls;
97 * Head of my addresses.
99 struct OwnAddressList *oal_head;
102 * Tail of my addresses.
104 struct OwnAddressList *oal_tail;
107 * Identifier of 'refresh_hello' task.
109 static GNUNET_SCHEDULER_TaskIdentifier hello_task;
113 * Closure for 'address_generator'.
115 struct GeneratorContext
118 * Where are we in the DLL?
120 struct OwnAddressList *addr_pos;
123 * When do addresses expire?
125 struct GNUNET_TIME_Absolute expiration;
130 * Add an address from the 'OwnAddressList' to the buffer.
132 * @param cls the 'struct GeneratorContext'
133 * @param max maximum number of bytes left
134 * @param buf where to write the address
137 address_generator (void *cls, size_t max, void *buf)
139 struct GeneratorContext *gc = cls;
142 if (NULL == gc->addr_pos)
145 GNUNET_HELLO_add_address (gc->addr_pos->plugin_name, gc->expiration,
146 &gc->addr_pos[1], gc->addr_pos->addrlen, buf,
148 gc->addr_pos = gc->addr_pos->next;
154 * Construct our HELLO message from all of the addresses of
155 * all of the transports.
158 * @param tc scheduler context
161 refresh_hello_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
163 struct GeneratorContext gc;
165 hello_task = GNUNET_SCHEDULER_NO_TASK;
166 gc.addr_pos = oal_head;
168 GNUNET_TIME_relative_to_absolute (GST_HELLO_ADDRESS_EXPIRATION);
169 GNUNET_free (our_hello);
170 our_hello = GNUNET_HELLO_create (&GST_my_public_key, &address_generator, &gc);
172 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
173 "Refreshed my `%s', new size is %d\n", "HELLO",
174 GNUNET_HELLO_size (our_hello));
176 GNUNET_STATISTICS_update (GST_stats, gettext_noop ("# refreshed my HELLO"), 1,
178 if (NULL != hello_cb)
179 hello_cb (hello_cb_cls, GST_hello_get ());
180 GNUNET_PEERINFO_add_peer (GST_peerinfo, our_hello);
182 GNUNET_SCHEDULER_add_delayed (HELLO_REFRESH_PERIOD, &refresh_hello_task,
189 * Schedule task to refresh hello (unless such a
190 * task exists already).
195 if (hello_task != GNUNET_SCHEDULER_NO_TASK)
196 GNUNET_SCHEDULER_cancel (hello_task);
197 hello_task = GNUNET_SCHEDULER_add_now (&refresh_hello_task, NULL);
202 * Initialize the HELLO module.
204 * @param cb function to call whenever our HELLO changes
205 * @param cb_cls closure for cb
208 GST_hello_start (GST_HelloCallback cb, void *cb_cls)
211 hello_cb_cls = cb_cls;
212 our_hello = GNUNET_HELLO_create (&GST_my_public_key, NULL, NULL);
218 * Shutdown the HELLO module.
225 if (GNUNET_SCHEDULER_NO_TASK != hello_task)
227 GNUNET_SCHEDULER_cancel (hello_task);
228 hello_task = GNUNET_SCHEDULER_NO_TASK;
230 if (NULL != our_hello)
232 GNUNET_free (our_hello);
239 * Obtain this peers HELLO message.
241 * @return our HELLO message
243 const struct GNUNET_MessageHeader *
246 return (struct GNUNET_MessageHeader *) our_hello;
251 * Add or remove an address from this peer's HELLO message.
253 * @param addremove GNUNET_YES to add, GNUNET_NO to remove
254 * @param plugin_name name of the plugin for which this is an address
255 * @param plugin_address address in a plugin-specific format
256 * @param plugin_address_len number of bytes in plugin_address
259 GST_hello_modify_addresses (int addremove, const char *plugin_name,
260 const void *plugin_address,
261 size_t plugin_address_len)
263 struct OwnAddressList *al;
266 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
268 GNUNET_YES) ? "Adding `%s':%s to the set of our addresses\n" :
269 "Removing `%s':%s from the set of our addresses\n",
270 GST_plugins_a2s (plugin_name, addr, addrlen), p->short_name);
272 GNUNET_assert (plugin_address != NULL);
273 if (GNUNET_NO == addremove)
275 for (al = oal_head; al != NULL; al = al->next)
276 if ((plugin_address_len == al->addrlen) &&
277 (0 == strcmp (al->plugin_name, plugin_name)) &&
278 (0 == memcmp (plugin_address, &al[1], plugin_address_len)))
280 GNUNET_CONTAINER_DLL_remove (oal_head, oal_tail, al);
281 GNUNET_free (al->plugin_name);
286 /* address to be removed not found!? */
290 al = GNUNET_malloc (sizeof (struct OwnAddressList) + plugin_address_len);
291 GNUNET_CONTAINER_DLL_insert (oal_head, oal_tail, al);
292 al->plugin_name = GNUNET_strdup (plugin_name);
293 al->addrlen = plugin_address_len;
294 memcpy (&al[1], plugin_address, plugin_address_len);
300 * Test if a particular address is one of ours.
302 * @param plugin_name name of the plugin for which this is an address
303 * @param plugin_address address in a plugin-specific format
304 * @param plugin_address_len number of bytes in plugin_address
305 * @param sig location where to cache PONG signatures for this address [set]
306 * @param sig_expiration how long until the current 'sig' expires?
307 * (ZERO if sig was never created) [set]
308 * @return GNUNET_YES if this is one of our addresses,
312 GST_hello_test_address (const char *plugin_name, const void *plugin_address,
313 size_t plugin_address_len,
314 struct GNUNET_CRYPTO_RsaSignature **sig,
315 struct GNUNET_TIME_Absolute **sig_expiration)
317 struct OwnAddressList *al;
319 for (al = oal_head; al != NULL; al = al->next)
320 if ((plugin_address_len == al->addrlen) &&
321 (0 == strcmp (al->plugin_name, plugin_name)) &&
322 (0 == memcmp (plugin_address, &al[1], plugin_address_len)))
324 *sig = &al->pong_signature;
325 *sig_expiration = &al->pong_sig_expires;
329 *sig_expiration = NULL;
334 /* end of file gnunet-service-transport_hello.c */