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_constants.h"
28 #include "gnunet_hello_lib.h"
29 #include "gnunet_peerinfo_service.h"
30 #include "gnunet_statistics_service.h"
31 #include "gnunet-service-transport_hello.h"
32 #include "gnunet-service-transport.h"
33 #include "gnunet-service-transport_plugins.h"
37 * How often do we refresh our HELLO (due to expiration concerns)?
39 #define HELLO_REFRESH_PERIOD GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 6)
42 * Hello address expiration
44 extern struct GNUNET_TIME_Relative hello_expiration;
48 * Entry in linked list of network addresses for ourselves. Also
49 * includes a cached signature for 'struct TransportPongMessage's.
54 * This is a doubly-linked list.
56 struct OwnAddressList *next;
59 * This is a doubly-linked list.
61 struct OwnAddressList *prev;
66 struct GNUNET_HELLO_Address *address;
69 * How long until the current signature expires? (ZERO if the
70 * signature was never created).
72 struct GNUNET_TIME_Absolute pong_sig_expires;
75 * Signature for a 'struct TransportPongMessage' for this address.
77 struct GNUNET_CRYPTO_EccSignature pong_signature;
85 static struct GNUNET_HELLO_Message *our_hello;
88 * Function to call on HELLO changes.
90 static GST_HelloCallback hello_cb;
93 * Closure for 'hello_cb'.
95 static void *hello_cb_cls;
98 * Head of my addresses.
100 struct OwnAddressList *oal_head;
103 * Tail of my addresses.
105 struct OwnAddressList *oal_tail;
108 * Identifier of 'refresh_hello' task.
110 static GNUNET_SCHEDULER_TaskIdentifier hello_task;
114 * Closure for 'address_generator'.
116 struct GeneratorContext
119 * Where are we in the DLL?
121 struct OwnAddressList *addr_pos;
124 * When do addresses expire?
126 struct GNUNET_TIME_Absolute expiration;
131 * Add an address from the 'OwnAddressList' to the buffer.
133 * @param cls the 'struct GeneratorContext'
134 * @param max maximum number of bytes left
135 * @param buf where to write the address
138 address_generator (void *cls, size_t max, void *buf)
140 struct GeneratorContext *gc = cls;
143 if (NULL == gc->addr_pos)
146 GNUNET_HELLO_add_address (gc->addr_pos->address, gc->expiration, 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;
166 hello_task = GNUNET_SCHEDULER_NO_TASK;
167 gc.addr_pos = oal_head;
168 gc.expiration = GNUNET_TIME_relative_to_absolute (hello_expiration);
171 friend_only = GNUNET_HELLO_is_friend_only (our_hello);
172 GNUNET_free (our_hello);
173 our_hello = GNUNET_HELLO_create (&GST_my_public_key, &address_generator, &gc, friend_only);
174 GNUNET_assert (NULL != our_hello);
175 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
176 "Refreshed my %s `%s', new size is %d\n",
177 (GNUNET_YES == GNUNET_HELLO_is_friend_only (our_hello)) ? "friend-only" : "public",
178 "HELLO", GNUNET_HELLO_size (our_hello));
179 GNUNET_STATISTICS_update (GST_stats, gettext_noop ("# refreshed my HELLO"), 1,
181 if (NULL != hello_cb)
182 hello_cb (hello_cb_cls, GST_hello_get ());
183 GNUNET_PEERINFO_add_peer (GST_peerinfo, our_hello, NULL, NULL);
185 GNUNET_SCHEDULER_add_delayed (HELLO_REFRESH_PERIOD, &refresh_hello_task,
192 * Schedule task to refresh hello (unless such a
193 * task exists already).
198 if (hello_task != GNUNET_SCHEDULER_NO_TASK)
199 GNUNET_SCHEDULER_cancel (hello_task);
200 hello_task = GNUNET_SCHEDULER_add_now (&refresh_hello_task, NULL);
205 * Initialize the HELLO module.
207 * @param friend_only use a friend only hello
208 * @param cb function to call whenever our HELLO changes
209 * @param cb_cls closure for cb
212 GST_hello_start (int friend_only, GST_HelloCallback cb, void *cb_cls)
215 hello_cb_cls = cb_cls;
216 our_hello = GNUNET_HELLO_create (&GST_my_public_key, NULL, NULL, friend_only);
217 GNUNET_assert (NULL != our_hello);
223 * Shutdown the HELLO module.
230 if (GNUNET_SCHEDULER_NO_TASK != hello_task)
232 GNUNET_SCHEDULER_cancel (hello_task);
233 hello_task = GNUNET_SCHEDULER_NO_TASK;
235 if (NULL != our_hello)
237 GNUNET_free (our_hello);
244 * Obtain this peers HELLO message.
246 * @return our HELLO message
248 const struct GNUNET_MessageHeader *
251 return (struct GNUNET_MessageHeader *) our_hello;
256 * Add or remove an address from this peer's HELLO message.
258 * @param addremove GNUNET_YES to add, GNUNET_NO to remove
259 * @param address address to add or remove
262 GST_hello_modify_addresses (int addremove,
263 const struct GNUNET_HELLO_Address *address)
265 struct OwnAddressList *al;
267 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
269 GNUNET_YES) ? "Adding `%s' to the set of our addresses\n" :
270 "Removing `%s' from the set of our addresses\n",
271 GST_plugins_a2s (address));
272 GNUNET_assert (address != NULL);
273 if (GNUNET_NO == addremove)
275 for (al = oal_head; al != NULL; al = al->next)
276 if (0 == GNUNET_HELLO_address_cmp (address, al->address))
278 GNUNET_CONTAINER_DLL_remove (oal_head, oal_tail, al);
279 GNUNET_HELLO_address_free (al->address);
284 /* address to be removed not found!? */
288 al = GNUNET_malloc (sizeof (struct OwnAddressList));
289 GNUNET_CONTAINER_DLL_insert (oal_head, oal_tail, al);
290 al->address = GNUNET_HELLO_address_copy (address);
296 * Test if a particular address is one of ours.
298 * @param address address to test
299 * @param sig location where to cache PONG signatures for this address [set]
300 * @param sig_expiration how long until the current 'sig' expires?
301 * (ZERO if sig was never created) [set]
302 * @return GNUNET_YES if this is one of our addresses,
306 GST_hello_test_address (const struct GNUNET_HELLO_Address *address,
307 struct GNUNET_CRYPTO_EccSignature **sig,
308 struct GNUNET_TIME_Absolute **sig_expiration)
310 struct OwnAddressList *al;
312 for (al = oal_head; al != NULL; al = al->next)
313 if (0 == GNUNET_HELLO_address_cmp (address, al->address))
315 *sig = &al->pong_signature;
316 *sig_expiration = &al->pong_sig_expires;
320 *sig_expiration = NULL;
325 /* end of file gnunet-service-transport_hello.c */