2 This file is part of GNUnet.
3 (C) 2009, 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 nse/gnunet-service-nse.c
23 * @brief network size estimation service
24 * @author Nathan Evans
25 * @author Christian Grothoff
27 * The purpose of this service is to estimate the size of the network.
28 * Given a specified interval, each peer hashes the most recent
29 * timestamp which is evenly divisible by that interval. This hash is
30 * compared in distance to the peer identity to choose an offset. The
31 * closer the peer identity to the hashed timestamp, the earlier the
32 * peer sends out a "nearest peer" message. The closest peer's
33 * message should thus be received before any others, which stops
34 * those peer from sending their messages at a later duration. So
35 * every peer should receive the same nearest peer message, and from
36 * this can calculate the expected number of peers in the network.
40 #include "gnunet_util_lib.h"
41 #include "gnunet_constants.h"
42 #include "gnunet_protocols.h"
43 #include "gnunet_signatures.h"
44 #include "gnunet_statistics_service.h"
45 #include "gnunet_core_service.h"
46 #include "gnunet_nse_service.h"
50 * Should messages be delayed randomly? This option should be set to
51 * GNUNET_NO only for experiments, not in production. It should also
52 * be removed once the initial experiments have been completed.
54 #define USE_RANDOM_DELAYS GNUNET_YES
57 * Should we generate a histogram with the time stamps of when we received
58 * NSE messages to disk? (for performance evaluation only, not useful in
59 * production). The associated code should also probably be removed
60 * once we're done with experiments.
62 #define ENABLE_HISTOGRAM GNUNET_NO
65 * Over how many values do we calculate the weighted average?
67 #define HISTORY_SIZE 64
70 * Message priority to use.
72 #define NSE_PRIORITY 5
75 #define log2(a) (log(a)/log(2))
79 * Amount of work required (W-bit collisions) for NSE proofs, in collision-bits.
81 static unsigned long long nse_work_required;
84 * Interval for sending network size estimation flood requests.
86 static struct GNUNET_TIME_Relative gnunet_nse_interval;
89 * Interval between proof find runs.
91 static struct GNUNET_TIME_Relative proof_find_delay;
95 * Handle for writing when we received messages to disk.
97 static struct GNUNET_BIO_WriteHandle *wh;
102 * Per-peer information.
108 * Pending message for this peer.
110 struct GNUNET_MessageHeader *pending_message;
113 * Core handle for sending messages to this peer.
115 struct GNUNET_CORE_TransmitHandle *th;
118 * What is the identity of the peer?
120 struct GNUNET_PeerIdentity id;
123 * Task scheduled to send message to this peer.
125 GNUNET_SCHEDULER_TaskIdentifier transmit_task;
128 * Did we receive or send a message about the previous round
129 * to this peer yet? GNUNET_YES if the previous round has
130 * been taken care of.
137 * Network size estimate reply; sent when "this"
138 * peer's timer has run out before receiving a
139 * valid reply from another peer.
141 struct GNUNET_NSE_FloodMessage
144 * Type: GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD
146 struct GNUNET_MessageHeader header;
149 * Number of hops this message has taken so far.
151 uint32_t hop_count GNUNET_PACKED;
156 struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
159 * The current timestamp value (which all
160 * peers should agree on).
162 struct GNUNET_TIME_AbsoluteNBO timestamp;
165 * Number of matching bits between the hash
166 * of timestamp and the initiator's public
169 uint32_t matching_bits GNUNET_PACKED;
172 * Public key of the originator.
174 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pkey;
177 * Proof of work, causing leading zeros when hashed with pkey.
179 uint64_t proof_of_work GNUNET_PACKED;
182 * Signature (over range specified in purpose).
184 struct GNUNET_CRYPTO_RsaSignature signature;
189 * Handle to our current configuration.
191 static const struct GNUNET_CONFIGURATION_Handle *cfg;
194 * Handle to the statistics service.
196 static struct GNUNET_STATISTICS_Handle *stats;
199 * Handle to the core service.
201 static struct GNUNET_CORE_Handle *coreAPI;
204 * Map of all connected peers.
206 static struct GNUNET_CONTAINER_MultiHashMap *peers;
209 * The current network size estimate. Number of bits matching on
212 static double current_size_estimate;
215 * The standard deviation of the last HISTORY_SIZE network
218 static double current_std_dev = NAN;
221 * Current hop counter estimate (estimate for network diameter).
223 static uint32_t hop_count_max;
226 * Message for the next round, if we got any.
228 static struct GNUNET_NSE_FloodMessage next_message;
231 * Array of recent size estimate messages.
233 static struct GNUNET_NSE_FloodMessage size_estimate_messages[HISTORY_SIZE];
236 * Index of most recent estimate.
238 static unsigned int estimate_index;
241 * Number of valid entries in the history.
243 static unsigned int estimate_count;
246 * Task scheduled to update our flood message for the next round.
248 static GNUNET_SCHEDULER_TaskIdentifier flood_task;
251 * Task scheduled to compute our proof.
253 static GNUNET_SCHEDULER_TaskIdentifier proof_task;
256 * Notification context, simplifies client broadcasts.
258 static struct GNUNET_SERVER_NotificationContext *nc;
261 * The next major time.
263 static struct GNUNET_TIME_Absolute next_timestamp;
266 * The current major time.
268 static struct GNUNET_TIME_Absolute current_timestamp;
271 * The public key of this peer.
273 static struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
276 * The private key of this peer.
278 static struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;
281 * The peer identity of this peer.
283 static struct GNUNET_PeerIdentity my_identity;
286 * Proof of work for this peer.
288 static uint64_t my_proof;
292 * Initialize a message to clients with the current network
295 * @param em message to fill in
298 setup_estimate_message (struct GNUNET_NSE_ClientMessage *em)
309 /* Weighted incremental algorithm for stddev according to West (1979) */
321 for (i = 0; i < estimate_count; i++)
323 j = (estimate_index - i + HISTORY_SIZE) % HISTORY_SIZE;
324 val = htonl (size_estimate_messages[j].matching_bits);
325 weight = estimate_count + 1 - i;
327 temp = weight + sumweight;
329 r = q * weight / temp;
331 sum += sumweight * q * r;
334 if (estimate_count > 0)
335 variance = (sum / sumweight) * estimate_count / (estimate_count - 1.0);
337 /* trivial version for debugging */
340 /* non-weighted trivial version */
346 for (i = 0; i < estimate_count; i++)
348 j = (estimate_index - i + HISTORY_SIZE) % HISTORY_SIZE;
349 val = htonl (size_estimate_messages[j].matching_bits);
353 if (0 != estimate_count)
355 mean = sum / estimate_count;
356 variance = (vsq - mean * sum) / (estimate_count - 1.0); // terrible for numerical stability...
359 GNUNET_assert (variance >= 0);
360 std_dev = sqrt (variance);
361 current_std_dev = std_dev;
362 current_size_estimate = mean;
364 em->header.size = htons (sizeof (struct GNUNET_NSE_ClientMessage));
365 em->header.type = htons (GNUNET_MESSAGE_TYPE_NSE_ESTIMATE);
366 em->reserved = htonl (0);
367 em->timestamp = GNUNET_TIME_absolute_hton (GNUNET_TIME_absolute_get ());
368 em->size_estimate = mean - 0.332747;
369 nsize = log2 (GNUNET_CONTAINER_multihashmap_size (peers) + 1);
370 if (em->size_estimate < nsize)
371 em->size_estimate = nsize;
372 em->std_deviation = std_dev;
373 GNUNET_STATISTICS_set (stats, "# nodes in the network (estimate)",
374 (uint64_t) pow (2, mean - 1.0 / 3.0), GNUNET_NO);
379 * Handler for START message from client, triggers an
380 * immediate current network estimate notification.
381 * Also, we remember the client for updates upon future
382 * estimate measurements.
385 * @param client who sent the message
386 * @param message the message received
389 handle_start_message (void *cls, struct GNUNET_SERVER_Client *client,
390 const struct GNUNET_MessageHeader *message)
392 struct GNUNET_NSE_ClientMessage em;
395 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received START message from client\n");
397 GNUNET_SERVER_notification_context_add (nc, client);
398 setup_estimate_message (&em);
399 GNUNET_SERVER_notification_context_unicast (nc, client, &em.header,
401 GNUNET_SERVER_receive_done (client, GNUNET_OK);
406 * How long should we delay a message to go the given number of
409 * @param matching_bits number of matching bits to consider
412 get_matching_bits_delay (uint32_t matching_bits)
414 /* Calculated as: S + f/2 - (f / pi) * (atan(x - p')) */
415 // S is next_timestamp (ignored in return value)
416 // f is frequency (gnunet_nse_interval)
417 // x is matching_bits
418 // p' is current_size_estimate
419 return ((double) gnunet_nse_interval.rel_value / (double) 2.0) -
420 ((gnunet_nse_interval.rel_value / M_PI) *
421 atan (matching_bits - current_size_estimate));
426 * What delay randomization should we apply for a given number of matching bits?
428 * @param matching_bits number of matching bits
429 * @return random delay to apply
431 static struct GNUNET_TIME_Relative
432 get_delay_randomization (uint32_t matching_bits)
434 #if USE_RANDOM_DELAYS
435 struct GNUNET_TIME_Relative ret;
439 if (matching_bits == 0)
440 return GNUNET_TIME_UNIT_ZERO;
441 d = get_matching_bits_delay (matching_bits - 1);
442 i = (uint32_t) (d / (double) (hop_count_max + 1));
443 ret.rel_value = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, i + 1);
446 return GNUNET_TIME_UNIT_ZERO;
452 * Get the number of matching bits that the given timestamp has to the given peer ID.
454 * @param timestamp time to generate key
455 * @param id peer identity to compare with
456 * @return number of matching bits
459 get_matching_bits (struct GNUNET_TIME_Absolute timestamp,
460 const struct GNUNET_PeerIdentity *id)
462 GNUNET_HashCode timestamp_hash;
464 GNUNET_CRYPTO_hash (×tamp.abs_value, sizeof (timestamp.abs_value),
466 return GNUNET_CRYPTO_hash_matching_bits (×tamp_hash, &id->hashPubKey);
471 * Get the transmission delay that should be applied for a
474 * @param round_offset -1 for the previous round (random delay between 0 and 50ms)
475 * 0 for the current round (based on our proximity to time key)
476 * @return delay that should be applied
478 static struct GNUNET_TIME_Relative
479 get_transmit_delay (int round_offset)
481 struct GNUNET_TIME_Relative ret;
482 struct GNUNET_TIME_Absolute tgt;
484 uint32_t matching_bits;
486 switch (round_offset)
489 /* previous round is randomized between 0 and 50 ms */
490 #if USE_RANDOM_DELAYS
491 ret.rel_value = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK, 50);
493 ret = GNUNET_TIME_UNIT_ZERO;
496 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
497 "Transmitting previous round behind schedule in %llu ms\n",
498 (unsigned long long) ret.rel_value);
502 /* current round is based on best-known matching_bits */
504 ntohl (size_estimate_messages[estimate_index].matching_bits);
505 dist_delay = get_matching_bits_delay (matching_bits);
506 dist_delay += get_delay_randomization (matching_bits).rel_value;
507 ret.rel_value = (uint64_t) dist_delay;
509 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
510 "For round %llu, delay for %u matching bits is %llu ms\n",
511 (unsigned long long) current_timestamp.abs_value,
512 (unsigned int) matching_bits,
513 (unsigned long long) ret.rel_value);
515 /* now consider round start time and add delay to it */
516 tgt = GNUNET_TIME_absolute_add (current_timestamp, ret);
517 return GNUNET_TIME_absolute_get_remaining (tgt);
520 return GNUNET_TIME_UNIT_FOREVER_REL;
525 * Task that triggers a NSE P2P transmission.
527 * @param cls the 'struct NSEPeerEntry'
528 * @param tc scheduler context
531 transmit_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
535 * Called when core is ready to send a message we asked for
536 * out to the destination.
538 * @param cls closure (NULL)
539 * @param size number of bytes available in buf
540 * @param buf where the callee should write the message
541 * @return number of bytes written to buf
544 transmit_ready (void *cls, size_t size, void *buf)
546 struct NSEPeerEntry *peer_entry = cls;
549 peer_entry->th = NULL;
552 /* client disconnected */
555 GNUNET_assert (size >= sizeof (struct GNUNET_NSE_FloodMessage));
556 idx = estimate_index;
557 if (peer_entry->previous_round == GNUNET_NO)
559 idx = (idx + HISTORY_SIZE - 1) % HISTORY_SIZE;
560 peer_entry->previous_round = GNUNET_YES;
561 peer_entry->transmit_task =
562 GNUNET_SCHEDULER_add_delayed (get_transmit_delay (0), &transmit_task,
565 if ((ntohl (size_estimate_messages[idx].hop_count) == 0) &&
566 (GNUNET_SCHEDULER_NO_TASK != proof_task))
568 GNUNET_STATISTICS_update (stats,
569 "# flood messages not generated (no proof yet)",
574 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
575 "In round %llu, sending to `%s' estimate with %u bits\n",
577 GNUNET_TIME_absolute_ntoh (size_estimate_messages[idx].
578 timestamp).abs_value,
579 GNUNET_i2s (&peer_entry->id),
580 (unsigned int) ntohl (size_estimate_messages[idx].matching_bits));
582 if (ntohl (size_estimate_messages[idx].hop_count) == 0)
583 GNUNET_STATISTICS_update (stats, "# flood messages started", 1, GNUNET_NO);
584 GNUNET_STATISTICS_update (stats, "# flood messages transmitted", 1,
586 memcpy (buf, &size_estimate_messages[idx],
587 sizeof (struct GNUNET_NSE_FloodMessage));
588 GNUNET_STATISTICS_update (stats, "# flood messages sent", 1, GNUNET_NO);
589 return sizeof (struct GNUNET_NSE_FloodMessage);
594 * Task that triggers a NSE P2P transmission.
596 * @param cls the 'struct NSEPeerEntry'
597 * @param tc scheduler context
600 transmit_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
602 struct NSEPeerEntry *peer_entry = cls;
604 peer_entry->transmit_task = GNUNET_SCHEDULER_NO_TASK;
605 GNUNET_assert (NULL == peer_entry->th);
607 GNUNET_CORE_notify_transmit_ready (coreAPI, GNUNET_NO, NSE_PRIORITY,
608 GNUNET_TIME_UNIT_FOREVER_REL,
611 GNUNET_NSE_FloodMessage),
612 &transmit_ready, peer_entry);
617 * We've sent on our flood message or one that we received which was
618 * validated and closer than ours. Update the global list of recent
619 * messages and the average. Also re-broadcast the message to any
623 update_network_size_estimate ()
625 struct GNUNET_NSE_ClientMessage em;
627 setup_estimate_message (&em);
628 GNUNET_SERVER_notification_context_broadcast (nc, &em.header, GNUNET_YES);
633 * Setup a flood message in our history array at the given
634 * slot offset for the given timestamp.
636 * @param slot index to use
637 * @param ts timestamp to use
640 setup_flood_message (unsigned int slot, struct GNUNET_TIME_Absolute ts)
642 struct GNUNET_NSE_FloodMessage *fm;
643 uint32_t matching_bits;
645 matching_bits = get_matching_bits (ts, &my_identity);
646 fm = &size_estimate_messages[slot];
647 fm->header.size = htons (sizeof (struct GNUNET_NSE_FloodMessage));
648 fm->header.type = htons (GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD);
649 fm->hop_count = htonl (0);
650 fm->purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_NSE_SEND);
652 htonl (sizeof (struct GNUNET_NSE_FloodMessage) -
653 sizeof (struct GNUNET_MessageHeader) - sizeof (uint32_t) -
654 sizeof (struct GNUNET_CRYPTO_RsaSignature));
655 fm->matching_bits = htonl (matching_bits);
656 fm->timestamp = GNUNET_TIME_absolute_hton (ts);
657 fm->pkey = my_public_key;
658 fm->proof_of_work = my_proof;
659 if (nse_work_required > 0)
660 GNUNET_assert (GNUNET_OK ==
661 GNUNET_CRYPTO_rsa_sign (my_private_key, &fm->purpose,
664 memset (&fm->signature, 0, sizeof (fm->signature));
669 * Schedule transmission for the given peer for the current round based
670 * on what we know about the desired delay.
673 * @param key hash of peer identity
674 * @param value the 'struct NSEPeerEntry'
675 * @return GNUNET_OK (continue to iterate)
678 schedule_current_round (void *cls, const GNUNET_HashCode * key, void *value)
680 struct NSEPeerEntry *peer_entry = value;
681 struct GNUNET_TIME_Relative delay;
683 if (peer_entry->th != NULL)
685 peer_entry->previous_round = GNUNET_NO;
688 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
690 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
691 peer_entry->previous_round = GNUNET_NO;
694 get_transmit_delay ((peer_entry->previous_round == GNUNET_NO) ? -1 : 0);
695 peer_entry->transmit_task =
696 GNUNET_SCHEDULER_add_delayed (delay, &transmit_task, peer_entry);
702 * Update our flood message to be sent (and our timestamps).
705 * @param tc context for this message
708 update_flood_message (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
710 struct GNUNET_TIME_Relative offset;
713 flood_task = GNUNET_SCHEDULER_NO_TASK;
714 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
716 offset = GNUNET_TIME_absolute_get_remaining (next_timestamp);
717 if (0 != offset.rel_value)
719 /* somehow run early, delay more */
721 GNUNET_SCHEDULER_add_delayed (offset, &update_flood_message, NULL);
724 current_timestamp = next_timestamp;
726 GNUNET_TIME_absolute_add (current_timestamp, gnunet_nse_interval);
727 estimate_index = (estimate_index + 1) % HISTORY_SIZE;
728 if (estimate_count < HISTORY_SIZE)
730 if (next_timestamp.abs_value ==
731 GNUNET_TIME_absolute_ntoh (next_message.timestamp).abs_value)
733 /* we received a message for this round way early, use it! */
734 size_estimate_messages[estimate_index] = next_message;
735 size_estimate_messages[estimate_index].hop_count =
736 htonl (1 + ntohl (next_message.hop_count));
739 setup_flood_message (estimate_index, current_timestamp);
740 next_message.matching_bits = htonl (0); /* reset for 'next' round */
742 for (i = 0; i < HISTORY_SIZE; i++)
744 GNUNET_MAX (ntohl (size_estimate_messages[i].hop_count), hop_count_max);
745 GNUNET_CONTAINER_multihashmap_iterate (peers, &schedule_current_round, NULL);
747 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
748 (next_timestamp), &update_flood_message,
754 * Count the leading zeroes in hash.
757 * @return the number of leading zero bits.
760 count_leading_zeroes (const GNUNET_HashCode * hash)
762 unsigned int hash_count;
765 while ((0 == GNUNET_CRYPTO_hash_get_bit (hash, hash_count)))
772 * Check whether the given public key
773 * and integer are a valid proof of work.
775 * @param pkey the public key
776 * @param val the integer
778 * @return GNUNET_YES if valid, GNUNET_NO if not
781 check_proof_of_work (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *pkey,
784 char buf[sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
786 GNUNET_HashCode result;
788 memcpy (buf, &val, sizeof (val));
789 memcpy (&buf[sizeof (val)], pkey,
790 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
791 GNUNET_CRYPTO_hash (buf, sizeof (buf), &result);
792 return (count_leading_zeroes (&result) >=
793 nse_work_required) ? GNUNET_YES : GNUNET_NO;
798 * Write our current proof to disk.
806 GNUNET_CONFIGURATION_get_value_filename (cfg, "NSE", "PROOFFILE", &proof))
808 if (sizeof (my_proof) !=
809 GNUNET_DISK_fn_write (proof, &my_proof, sizeof (my_proof),
810 GNUNET_DISK_PERM_USER_READ |
811 GNUNET_DISK_PERM_USER_WRITE))
812 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", proof);
819 * Find our proof of work.
821 * @param cls closure (unused)
822 * @param tc task context
825 find_proof (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
827 #define ROUND_SIZE 10
829 char buf[sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
831 GNUNET_HashCode result;
833 const struct GNUNET_CRYPTO_RsaSignature *sig_cache;
835 proof_task = GNUNET_SCHEDULER_NO_TASK;
836 memcpy (&buf[sizeof (uint64_t)], &my_public_key,
837 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
840 while ((counter != UINT64_MAX) && (i < ROUND_SIZE))
842 memcpy (buf, &counter, sizeof (uint64_t));
843 GNUNET_CRYPTO_hash (buf, sizeof (buf), &result);
844 if (nse_work_required <= count_leading_zeroes (&result))
848 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Proof of work found: %llu!\n",
849 (unsigned long long) GNUNET_ntohll (counter));
852 for (i = 0; i < HISTORY_SIZE; i++)
853 if (ntohl (size_estimate_messages[i].hop_count) == 0)
855 size_estimate_messages[i].proof_of_work = my_proof;
856 if (nse_work_required > 0)
858 if (sig_cache == NULL)
860 GNUNET_assert (GNUNET_OK ==
861 GNUNET_CRYPTO_rsa_sign (my_private_key,
862 &size_estimate_messages
864 &size_estimate_messages
866 sig_cache = &size_estimate_messages[i].signature;
870 /* use cached signature */
871 size_estimate_messages[i].signature = *sig_cache;
876 /* no signature required */
877 memset (&size_estimate_messages[i].signature, 0, sizeof (struct GNUNET_CRYPTO_RsaSignature));
886 if (my_proof / (100 * ROUND_SIZE) < counter / (100 * ROUND_SIZE))
889 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing proofs currently at %llu\n",
890 (unsigned long long) counter);
892 /* remember progress every 100 rounds */
901 GNUNET_SCHEDULER_add_delayed (proof_find_delay, &find_proof, NULL);
906 * An incoming flood message has been received which claims
907 * to have more bits matching than any we know in this time
908 * period. Verify the signature and/or proof of work.
910 * @param incoming_flood the message to verify
912 * @return GNUNET_YES if the message is verified
913 * GNUNET_NO if the key/signature don't verify
916 verify_message_crypto (const struct GNUNET_NSE_FloodMessage *incoming_flood)
919 check_proof_of_work (&incoming_flood->pkey,
920 incoming_flood->proof_of_work))
922 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Proof of work invalid: %llu!\n"),
924 GNUNET_ntohll (incoming_flood->proof_of_work));
928 if ( (nse_work_required > 0) &&
930 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_NSE_SEND,
931 &incoming_flood->purpose,
932 &incoming_flood->signature,
933 &incoming_flood->pkey)) )
943 * Update transmissions for the given peer for the current round based
944 * on updated proximity information.
946 * @param cls peer entry to exclude from updates
947 * @param key hash of peer identity
948 * @param value the 'struct NSEPeerEntry'
949 * @return GNUNET_OK (continue to iterate)
952 update_flood_times (void *cls, const GNUNET_HashCode * key, void *value)
954 struct NSEPeerEntry *exclude = cls;
955 struct NSEPeerEntry *peer_entry = value;
956 struct GNUNET_TIME_Relative delay;
958 if (peer_entry->th != NULL)
959 return GNUNET_OK; /* already active */
960 if (peer_entry == exclude)
961 return GNUNET_OK; /* trigger of the update */
962 if (peer_entry->previous_round == GNUNET_NO)
964 /* still stuck in previous round, no point to update, check that
965 * we are active here though... */
966 GNUNET_break ((peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK) ||
967 (peer_entry->th != NULL));
970 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
972 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
973 peer_entry->transmit_task = GNUNET_SCHEDULER_NO_TASK;
975 delay = get_transmit_delay (0);
976 peer_entry->transmit_task =
977 GNUNET_SCHEDULER_add_delayed (delay, &transmit_task, peer_entry);
983 * Core handler for size estimate flooding messages.
985 * @param cls closure unused
986 * @param message message
987 * @param peer peer identity this message is from (ignored)
988 * @param atsi performance data (ignored)
989 * @param atsi_count number of records in 'atsi'
992 handle_p2p_size_estimate (void *cls, const struct GNUNET_PeerIdentity *peer,
993 const struct GNUNET_MessageHeader *message,
994 const struct GNUNET_ATS_Information *atsi,
995 unsigned int atsi_count)
997 const struct GNUNET_NSE_FloodMessage *incoming_flood;
998 struct GNUNET_TIME_Absolute ts;
999 struct NSEPeerEntry *peer_entry;
1000 uint32_t matching_bits;
1003 #if ENABLE_HISTOGRAM
1005 GNUNET_BIO_write_int64 (wh, GNUNET_TIME_absolute_get ().abs_value);
1007 incoming_flood = (const struct GNUNET_NSE_FloodMessage *) message;
1008 GNUNET_STATISTICS_update (stats, "# flood messages received", 1, GNUNET_NO);
1009 matching_bits = ntohl (incoming_flood->matching_bits);
1014 struct GNUNET_PeerIdentity os;
1016 GNUNET_CRYPTO_hash (&incoming_flood->pkey,
1017 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1019 GNUNET_snprintf (origin, sizeof (origin), "%s", GNUNET_i2s (&os));
1020 GNUNET_snprintf (pred, sizeof (pred), "%s", GNUNET_i2s (peer));
1021 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1022 "Flood at %llu from `%s' via `%s' at `%s' with bits %u\n",
1023 (unsigned long long)
1024 GNUNET_TIME_absolute_ntoh (incoming_flood->timestamp).abs_value,
1025 origin, pred, GNUNET_i2s (&my_identity),
1026 (unsigned int) matching_bits);
1030 peer_entry = GNUNET_CONTAINER_multihashmap_get (peers, &peer->hashPubKey);
1031 if (NULL == peer_entry)
1037 ts = GNUNET_TIME_absolute_ntoh (incoming_flood->timestamp);
1039 if (ts.abs_value == current_timestamp.abs_value)
1040 idx = estimate_index;
1041 else if (ts.abs_value ==
1042 current_timestamp.abs_value - gnunet_nse_interval.rel_value)
1043 idx = (estimate_index + HISTORY_SIZE - 1) % HISTORY_SIZE;
1044 else if (ts.abs_value ==
1045 next_timestamp.abs_value - gnunet_nse_interval.rel_value)
1047 if (matching_bits <= ntohl (next_message.matching_bits))
1048 return GNUNET_OK; /* ignore, simply too early/late */
1049 if (GNUNET_YES != verify_message_crypto (incoming_flood))
1051 GNUNET_break_op (0);
1054 next_message = *incoming_flood;
1059 GNUNET_STATISTICS_update (stats,
1060 "# flood messages discarded (clock skew too large)",
1064 if (0 == (memcmp (peer, &my_identity, sizeof (struct GNUNET_PeerIdentity))))
1066 /* send to self, update our own estimate IF this also comes from us! */
1068 memcmp (&incoming_flood->pkey, &my_public_key, sizeof (my_public_key)))
1069 update_network_size_estimate ();
1072 if (matching_bits >= ntohl (size_estimate_messages[idx].matching_bits))
1074 /* cancel transmission from us to this peer for this round */
1075 if (idx == estimate_index)
1077 if (peer_entry->previous_round == GNUNET_YES)
1079 /* cancel any activity for current round */
1080 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
1082 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
1083 peer_entry->transmit_task = GNUNET_SCHEDULER_NO_TASK;
1085 if (peer_entry->th != NULL)
1087 GNUNET_CORE_notify_transmit_ready_cancel (peer_entry->th);
1088 peer_entry->th = NULL;
1094 /* cancel previous round only */
1095 peer_entry->previous_round = GNUNET_YES;
1098 if (matching_bits == ntohl (size_estimate_messages[idx].matching_bits))
1100 if (matching_bits <= ntohl (size_estimate_messages[idx].matching_bits))
1102 if ((idx < estimate_index) && (peer_entry->previous_round == GNUNET_YES))
1103 peer_entry->previous_round = GNUNET_NO;
1104 /* push back our result now, that peer is spreading bad information... */
1105 if (NULL == peer_entry->th)
1107 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
1108 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
1109 peer_entry->transmit_task =
1110 GNUNET_SCHEDULER_add_now (&transmit_task, peer_entry);
1112 /* Not closer than our most recent message, no need to do work here */
1113 GNUNET_STATISTICS_update (stats,
1114 "# flood messages ignored (had closer already)",
1118 if (GNUNET_YES != verify_message_crypto (incoming_flood))
1120 GNUNET_break_op (0);
1123 size_estimate_messages[idx] = *incoming_flood;
1124 size_estimate_messages[idx].hop_count =
1125 htonl (ntohl (incoming_flood->hop_count) + 1);
1127 GNUNET_MAX (ntohl (incoming_flood->hop_count) + 1, hop_count_max);
1129 /* have a new, better size estimate, inform clients */
1130 update_network_size_estimate ();
1133 GNUNET_CONTAINER_multihashmap_iterate (peers, &update_flood_times,
1141 * Method called whenever a peer connects.
1143 * @param cls closure
1144 * @param peer peer identity this notification is about
1145 * @param atsi performance data
1146 * @param atsi_count number of records in 'atsi'
1149 handle_core_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
1150 const struct GNUNET_ATS_Information *atsi,
1151 unsigned int atsi_count)
1153 struct NSEPeerEntry *peer_entry;
1156 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s' connected to us\n",
1159 peer_entry = GNUNET_malloc (sizeof (struct NSEPeerEntry));
1160 peer_entry->id = *peer;
1161 GNUNET_assert (GNUNET_OK ==
1162 GNUNET_CONTAINER_multihashmap_put (peers, &peer->hashPubKey, peer_entry,
1163 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1164 peer_entry->transmit_task =
1165 GNUNET_SCHEDULER_add_delayed (get_transmit_delay (-1), &transmit_task,
1171 * Method called whenever a peer disconnects.
1173 * @param cls closure
1174 * @param peer peer identity this notification is about
1177 handle_core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
1179 struct NSEPeerEntry *pos;
1182 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s' disconnected from us\n",
1185 pos = GNUNET_CONTAINER_multihashmap_get (peers, &peer->hashPubKey);
1191 GNUNET_assert (GNUNET_YES ==
1192 GNUNET_CONTAINER_multihashmap_remove (peers, &peer->hashPubKey,
1194 if (pos->transmit_task != GNUNET_SCHEDULER_NO_TASK)
1195 GNUNET_SCHEDULER_cancel (pos->transmit_task);
1196 if (pos->th != NULL)
1198 GNUNET_CORE_notify_transmit_ready_cancel (pos->th);
1206 * Task run during shutdown.
1212 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1214 if (flood_task != GNUNET_SCHEDULER_NO_TASK)
1216 GNUNET_SCHEDULER_cancel (flood_task);
1217 flood_task = GNUNET_SCHEDULER_NO_TASK;
1219 if (proof_task != GNUNET_SCHEDULER_NO_TASK)
1221 GNUNET_SCHEDULER_cancel (proof_task);
1222 proof_task = GNUNET_SCHEDULER_NO_TASK;
1223 write_proof (); /* remember progress */
1227 GNUNET_SERVER_notification_context_destroy (nc);
1230 if (coreAPI != NULL)
1232 GNUNET_CORE_disconnect (coreAPI);
1237 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
1242 GNUNET_CONTAINER_multihashmap_destroy (peers);
1245 if (my_private_key != NULL)
1247 GNUNET_CRYPTO_rsa_key_free (my_private_key);
1248 my_private_key = NULL;
1250 #if ENABLE_HISTOGRAM
1253 GNUNET_BIO_write_close (wh);
1261 * Called on core init/fail.
1263 * @param cls service closure
1264 * @param server handle to the server for this service
1265 * @param identity the public identity of this peer
1268 core_init (void *cls, struct GNUNET_CORE_Handle *server,
1269 const struct GNUNET_PeerIdentity *identity)
1271 struct GNUNET_TIME_Absolute now;
1272 struct GNUNET_TIME_Absolute prev_time;
1278 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connection to core FAILED!\n");
1280 GNUNET_SCHEDULER_shutdown ();
1284 memcmp (&my_identity, identity,
1285 sizeof (struct GNUNET_PeerIdentity)));
1286 now = GNUNET_TIME_absolute_get ();
1287 current_timestamp.abs_value =
1288 (now.abs_value / gnunet_nse_interval.rel_value) *
1289 gnunet_nse_interval.rel_value;
1290 next_timestamp.abs_value =
1291 current_timestamp.abs_value + gnunet_nse_interval.rel_value;
1293 for (i = 0; i < HISTORY_SIZE; i++)
1295 prev_time.abs_value =
1296 current_timestamp.abs_value - (HISTORY_SIZE - i -
1297 1) * gnunet_nse_interval.rel_value;
1298 setup_flood_message (i, prev_time);
1300 estimate_index = HISTORY_SIZE - 1;
1303 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
1304 (next_timestamp), &update_flood_message,
1310 * Handle network size estimate clients.
1312 * @param cls closure
1313 * @param server the initialized server
1314 * @param c configuration to use
1317 run (void *cls, struct GNUNET_SERVER_Handle *server,
1318 const struct GNUNET_CONFIGURATION_Handle *c)
1323 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1324 {&handle_start_message, NULL, GNUNET_MESSAGE_TYPE_NSE_START,
1325 sizeof (struct GNUNET_MessageHeader)},
1328 static const struct GNUNET_CORE_MessageHandler core_handlers[] = {
1329 {&handle_p2p_size_estimate, GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD,
1330 sizeof (struct GNUNET_NSE_FloodMessage)},
1336 GNUNET_CONFIGURATION_get_value_time (cfg, "NSE", "INTERVAL",
1337 &gnunet_nse_interval)) ||
1339 GNUNET_CONFIGURATION_get_value_time (cfg, "NSE", "WORKDELAY",
1340 &proof_find_delay)) ||
1342 GNUNET_CONFIGURATION_get_value_number (cfg, "NSE", "WORKBITS",
1343 &nse_work_required)))
1345 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1347 ("NSE service is lacking key configuration settings. Exiting.\n"));
1348 GNUNET_SCHEDULER_shutdown ();
1351 if (nse_work_required >= sizeof (GNUNET_HashCode) * 8)
1353 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1354 _("Invalid work requirement for NSE service. Exiting.\n"));
1355 GNUNET_SCHEDULER_shutdown ();
1361 GNUNET_CONFIGURATION_get_value_filename (cfg, "GNUNETD", "HOSTKEY",
1364 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1366 ("NSE service is lacking key configuration settings. Exiting.\n"));
1367 GNUNET_SCHEDULER_shutdown ();
1370 my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
1371 GNUNET_free (keyfile);
1372 if (my_private_key == NULL)
1374 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1375 _("NSE service could not access hostkey. Exiting.\n"));
1376 GNUNET_SCHEDULER_shutdown ();
1379 GNUNET_CRYPTO_rsa_key_get_public (my_private_key, &my_public_key);
1380 GNUNET_CRYPTO_hash (&my_public_key, sizeof (my_public_key),
1381 &my_identity.hashPubKey);
1383 GNUNET_CONFIGURATION_get_value_filename (cfg, "NSE", "PROOFFILE", &proof))
1385 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1387 ("NSE service is lacking key configuration settings. Exiting.\n"));
1388 if (my_private_key != NULL)
1390 GNUNET_CRYPTO_rsa_key_free (my_private_key);
1391 my_private_key = NULL;
1393 GNUNET_SCHEDULER_shutdown ();
1396 if ((GNUNET_YES != GNUNET_DISK_file_test (proof)) ||
1397 (sizeof (my_proof) !=
1398 GNUNET_DISK_fn_read (proof, &my_proof, sizeof (my_proof))))
1400 GNUNET_free (proof);
1402 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1405 peers = GNUNET_CONTAINER_multihashmap_create (128);
1406 GNUNET_SERVER_add_handlers (server, handlers);
1407 nc = GNUNET_SERVER_notification_context_create (server, 1);
1408 /* Connect to core service and register core handlers */
1409 coreAPI = GNUNET_CORE_connect (cfg, /* Main configuration */
1411 NULL, /* Closure passed to functions */
1412 &core_init, /* Call core_init once connected */
1413 &handle_core_connect, /* Handle connects */
1414 &handle_core_disconnect, /* Handle disconnects */
1415 NULL, /* Don't want notified about all incoming messages */
1416 GNUNET_NO, /* For header only inbound notification */
1417 NULL, /* Don't want notified about all outbound messages */
1418 GNUNET_NO, /* For header only outbound notification */
1419 core_handlers); /* Register these handlers */
1420 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
1422 #if ENABLE_HISTOGRAM
1424 GNUNET_CONFIGURATION_get_value_filename (cfg, "NSE", "HISTOGRAM", &proof))
1426 wh = GNUNET_BIO_write_open (proof);
1427 GNUNET_free (proof);
1430 if (coreAPI == NULL)
1432 GNUNET_SCHEDULER_shutdown ();
1435 stats = GNUNET_STATISTICS_create ("nse", cfg);
1440 * The main function for the statistics service.
1442 * @param argc number of arguments from the command line
1443 * @param argv command line arguments
1444 * @return 0 ok, 1 on error
1447 main (int argc, char *const *argv)
1449 return (GNUNET_OK ==
1450 GNUNET_SERVICE_run (argc, argv, "nse", GNUNET_SERVICE_OPTION_NONE,
1451 &run, NULL)) ? 0 : 1;
1454 /* end of gnunet-service-nse.c */