2 This file is part of GNUnet.
3 Copyright (C) 2009-2014 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 fs/gnunet-service-fs.c
23 * @brief gnunet anonymity protocol implementation
24 * @author Christian Grothoff
28 #include "gnunet_constants.h"
29 #include "gnunet_core_service.h"
30 #include "gnunet_dht_service.h"
31 #include "gnunet_datastore_service.h"
32 #include "gnunet_load_lib.h"
33 #include "gnunet_peer_lib.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_signatures.h"
36 #include "gnunet_statistics_service.h"
37 #include "gnunet_transport_service.h"
38 #include "gnunet_util_lib.h"
39 #include "gnunet-service-fs_cp.h"
40 #include "gnunet-service-fs_indexing.h"
41 #include "gnunet-service-fs_lc.h"
42 #include "gnunet-service-fs_pe.h"
43 #include "gnunet-service-fs_pr.h"
44 #include "gnunet-service-fs_push.h"
45 #include "gnunet-service-fs_put.h"
46 #include "gnunet-service-fs_cadet.h"
51 * Size for the hash map for DHT requests from the FS
52 * service. Should be about the number of concurrent
53 * DHT requests we plan to make.
55 #define FS_DHT_HT_SIZE 1024
59 * How quickly do we age cover traffic? At the given
60 * time interval, remaining cover traffic counters are
61 * decremented by 1/16th.
63 #define COVER_AGE_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
66 * Collect an instane number of statistics? May cause excessive IPC.
68 #define INSANE_STATISTICS GNUNET_NO
71 /* ****************************** globals ****************************** */
74 * Our connection to the datastore.
76 struct GNUNET_DATASTORE_Handle *GSF_dsh;
81 const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
84 * Handle for reporting statistics.
86 struct GNUNET_STATISTICS_Handle *GSF_stats;
89 * Handle for DHT operations.
91 struct GNUNET_DHT_Handle *GSF_dht;
94 * How long do requests typically stay in the routing table?
96 struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
99 * Running average of the observed latency to other peers (round trip).
100 * Initialized to 5s as the initial default.
102 struct GNUNET_TIME_Relative GSF_avg_latency = { 500 };
105 * Handle to ATS service.
107 struct GNUNET_ATS_PerformanceHandle *GSF_ats;
111 * Typical priorities we're seeing from other peers right now. Since
112 * most priorities will be zero, this value is the weighted average of
113 * non-zero priorities seen "recently". In order to ensure that new
114 * values do not dramatically change the ratio, values are first
115 * "capped" to a reasonable range (+N of the current value) and then
116 * averaged into the existing value by a ratio of 1:N. Hence
117 * receiving the largest possible priority can still only raise our
118 * "current_priorities" by at most 1.
120 double GSF_current_priorities;
123 * Size of the datastore queue we assume for common requests.
125 unsigned int GSF_datastore_queue_size;
128 * How many query messages have we received 'recently' that
129 * have not yet been claimed as cover traffic?
131 unsigned int GSF_cover_query_count;
134 * How many content messages have we received 'recently' that
135 * have not yet been claimed as cover traffic?
137 unsigned int GSF_cover_content_count;
142 struct GNUNET_BLOCK_Context *GSF_block_ctx;
145 * Pointer to handle to the core service (points to NULL until we've
148 struct GNUNET_CORE_Handle *GSF_core;
151 * Are we introducing randomized delays for better anonymity?
153 int GSF_enable_randomized_delays;
155 /* ***************************** locals ******************************* */
158 * Configuration for block library.
160 static struct GNUNET_CONFIGURATION_Handle *block_cfg;
163 * Private key of this peer. Used to sign LOC URI requests.
165 static struct GNUNET_CRYPTO_EddsaPrivateKey *pk;
168 * ID of our task that we use to age the cover counters.
170 static struct GNUNET_SCHEDULER_Task * cover_age_task;
173 * Datastore 'GET' load tracking.
175 static struct GNUNET_LOAD_Value *datastore_get_load;
178 * Identity of this peer.
180 static struct GNUNET_PeerIdentity my_id;
184 * Task that periodically ages our cover traffic statistics.
186 * @param cls unused closure
187 * @param tc task context
190 age_cover_counters (void *cls,
191 const struct GNUNET_SCHEDULER_TaskContext *tc)
193 GSF_cover_content_count = (GSF_cover_content_count * 15) / 16;
194 GSF_cover_query_count = (GSF_cover_query_count * 15) / 16;
196 GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
202 * We've just now completed a datastore request. Update our
203 * datastore load calculations.
205 * @param start time when the datastore request was issued
208 GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start)
210 struct GNUNET_TIME_Relative delay;
212 delay = GNUNET_TIME_absolute_get_duration (start);
213 GNUNET_LOAD_update (datastore_get_load, delay.rel_value_us);
218 * Test if the DATABASE (GET) load on this peer is too high
219 * to even consider processing the query at
222 * @param priority priority of the request (used as a reference point to compare with the load)
223 * @return #GNUNET_YES if the load is too high to do anything (load high)
224 * #GNUNET_NO to process normally (load normal)
225 * #GNUNET_SYSERR to process for free (load low)
228 GSF_test_get_load_too_high_ (uint32_t priority)
232 ld = GNUNET_LOAD_get_load (datastore_get_load);
234 return GNUNET_SYSERR;
242 * We've received peer performance information. Update
243 * our running average for the P2P latency.
246 * @param address the address
247 * @param active is this address in active use
248 * @param bandwidth_out assigned outbound bandwidth for the connection
249 * @param bandwidth_in assigned inbound bandwidth for the connection
250 * @param prop performance data for the address (as far as known)
253 update_latencies (void *cls,
254 const struct GNUNET_HELLO_Address *address,
256 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
257 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
258 const struct GNUNET_ATS_Properties *prop)
262 /* ATS service temporarily disconnected */
266 if (GNUNET_YES != active)
268 GSF_update_peer_latency_ (&address->peer,
270 GSF_avg_latency.rel_value_us =
271 (GSF_avg_latency.rel_value_us * 31 +
272 GNUNET_MIN (5000, prop->delay.rel_value_us)) / 32;
273 GNUNET_STATISTICS_set (GSF_stats,
274 gettext_noop ("# running average P2P latency (ms)"),
275 GSF_avg_latency.rel_value_us / 1000LL,
281 * Handle P2P "PUT" message.
283 * @param cls closure, always NULL
284 * @param other the other peer involved (sender or receiver, NULL
285 * for loopback messages where we are both sender and receiver)
286 * @param message the actual message
287 * @return #GNUNET_OK to keep the connection open,
288 * #GNUNET_SYSERR to close it (signal serious error)
291 handle_p2p_put (void *cls,
292 const struct GNUNET_PeerIdentity *other,
293 const struct GNUNET_MessageHeader *message)
295 struct GSF_ConnectedPeer *cp;
297 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
298 "Received P2P PUT from %s\n",
300 cp = GSF_peer_get_ (other);
306 GSF_cover_content_count++;
307 return GSF_handle_p2p_content_ (cp, message);
312 * We have a new request, consider forwarding it to the given
315 * @param cls the `struct GSF_PendingRequest`
316 * @param peer identity of the peer
317 * @param cp handle to the connected peer record
318 * @param ppd peer performance data
321 consider_request_for_forwarding (void *cls,
322 const struct GNUNET_PeerIdentity *peer,
323 struct GSF_ConnectedPeer *cp,
324 const struct GSF_PeerPerformanceData *ppd)
326 struct GSF_PendingRequest *pr = cls;
328 if (GNUNET_YES != GSF_pending_request_test_target_ (pr, peer))
330 #if INSANE_STATISTICS
331 GNUNET_STATISTICS_update (GSF_stats,
332 gettext_noop ("# Loopback routes suppressed"), 1,
337 GSF_plan_add_ (cp, pr);
342 * Function to be called after we're done processing
343 * replies from the local lookup. If the result status
344 * code indicates that there may be more replies, plan
345 * forwarding the request.
347 * @param cls closure (NULL)
348 * @param pr the pending request we were processing
349 * @param result final datastore lookup result
352 consider_forwarding (void *cls,
353 struct GSF_PendingRequest *pr,
354 enum GNUNET_BLOCK_EvaluationResult result)
356 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
357 return; /* we're done... */
358 GSF_iterate_connected_peers_ (&consider_request_for_forwarding, pr);
363 * Handle P2P "GET" request.
365 * @param cls closure, always NULL
366 * @param other the other peer involved (sender or receiver, NULL
367 * for loopback messages where we are both sender and receiver)
368 * @param message the actual message
369 * @return #GNUNET_OK to keep the connection open,
370 * #GNUNET_SYSERR to close it (signal serious error)
373 handle_p2p_get (void *cls,
374 const struct GNUNET_PeerIdentity *other,
375 const struct GNUNET_MessageHeader *message)
377 struct GSF_PendingRequest *pr;
379 pr = GSF_handle_p2p_query_ (other, message);
381 return GNUNET_SYSERR;
382 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
383 GSF_local_lookup_ (pr,
384 &consider_forwarding, NULL);
390 * We're done with the local lookup, now consider
391 * P2P processing (depending on request options and
392 * result status). Also signal that we can now
393 * receive more request information from the client.
395 * @param cls the client doing the request (`struct GNUNET_SERVER_Client`)
396 * @param pr the pending request we were processing
397 * @param result final datastore lookup result
400 start_p2p_processing (void *cls,
401 struct GSF_PendingRequest *pr,
402 enum GNUNET_BLOCK_EvaluationResult result)
404 struct GNUNET_SERVER_Client *client = cls;
405 struct GSF_PendingRequestData *prd;
407 GNUNET_SERVER_receive_done (client,
409 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
410 return; /* we're done, 'pr' was already destroyed... */
411 prd = GSF_pending_request_get_data_ (pr);
412 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
413 "Finished database lookup for local request `%s' with result %d\n",
414 GNUNET_h2s (&prd->query), result);
415 if (0 == prd->anonymity_level)
419 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
420 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
421 /* the above block types MAY be available via 'cadet' */
422 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
423 "Considering cadet-based download for block\n");
424 GSF_cadet_lookup_ (pr);
426 case GNUNET_BLOCK_TYPE_FS_UBLOCK:
427 /* the above block types are in the DHT */
428 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
429 "Considering DHT-based search for block\n");
430 GSF_dht_lookup_ (pr);
437 consider_forwarding (NULL, pr, result);
442 * Handle START_SEARCH-message (search request from client).
445 * @param client identification of the client
446 * @param message the actual message
449 handle_start_search (void *cls,
450 struct GNUNET_SERVER_Client *client,
451 const struct GNUNET_MessageHeader *message)
453 struct GSF_PendingRequest *pr;
457 ret = GSF_local_client_start_search_handler_ (client,
463 GNUNET_SERVER_receive_done (client,
467 GNUNET_SERVER_receive_done (client,
471 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
472 GSF_local_lookup_ (pr,
473 &start_p2p_processing,
483 * Handle request to sign a LOC URI (from client).
485 * @param cls closure (NULL)
486 * @param client identification of the client
487 * @param message the actual message
490 handle_loc_sign (void *cls,
491 struct GNUNET_SERVER_Client *client,
492 const struct GNUNET_MessageHeader *message)
494 const struct RequestLocSignatureMessage *msg;
495 struct GNUNET_FS_Uri base;
496 struct GNUNET_FS_Uri *loc;
497 struct ResponseLocSignatureMessage resp;
498 struct GSF_LocalClient *lc;
500 msg = (const struct RequestLocSignatureMessage *) message;
501 GNUNET_break (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT ==
502 ntohl (msg->purpose));
503 base.type = GNUNET_FS_URI_CHK;
504 base.data.chk.chk = msg->chk;
505 base.data.chk.file_length = GNUNET_ntohll (msg->file_length);
506 loc = GNUNET_FS_uri_loc_create (&base,
508 GNUNET_TIME_absolute_ntoh (msg->expiration_time));
509 resp.header.size = htons (sizeof (struct ResponseLocSignatureMessage));
510 resp.header.type = htons (GNUNET_MESSAGE_TYPE_FS_REQUEST_LOC_SIGNATURE);
511 resp.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
512 resp.expiration_time = GNUNET_TIME_absolute_hton (loc->data.loc.expirationTime);
513 resp.signature = loc->data.loc.contentSignature;
514 resp.peer = loc->data.loc.peer;
515 GNUNET_FS_uri_destroy (loc);
516 lc = GSF_local_client_lookup_ (client);
517 GSF_local_client_transmit_ (lc,
519 GNUNET_SERVER_receive_done (client, GNUNET_OK);
524 * Task run during shutdown.
530 shutdown_task (void *cls,
531 const struct GNUNET_SCHEDULER_TaskContext *tc)
533 GSF_cadet_stop_client ();
534 GSF_cadet_stop_server ();
535 if (NULL != GSF_core)
537 GNUNET_CORE_disconnect (GSF_core);
542 GNUNET_ATS_performance_done (GSF_ats);
547 GSF_pending_request_done_ ();
549 GSF_connected_peer_done_ ();
550 GNUNET_DATASTORE_disconnect (GSF_dsh, GNUNET_NO);
552 GNUNET_DHT_disconnect (GSF_dht);
554 GNUNET_BLOCK_context_destroy (GSF_block_ctx);
555 GSF_block_ctx = NULL;
556 GNUNET_CONFIGURATION_destroy (block_cfg);
558 GNUNET_STATISTICS_destroy (GSF_stats, GNUNET_NO);
560 if (NULL != cover_age_task)
562 GNUNET_SCHEDULER_cancel (cover_age_task);
563 cover_age_task = NULL;
565 GNUNET_FS_indexing_done ();
566 GNUNET_LOAD_value_free (datastore_get_load);
567 datastore_get_load = NULL;
568 GNUNET_LOAD_value_free (GSF_rt_entry_lifetime);
569 GSF_rt_entry_lifetime = NULL;
574 * Function called for each pending request whenever a new
575 * peer connects, giving us a chance to decide about submitting
576 * the existing request to the new peer.
578 * @param cls the 'struct GSF_ConnectedPeer' of the new peer
579 * @param key query for the request
580 * @param pr handle to the pending request
581 * @return #GNUNET_YES to continue to iterate
584 consider_peer_for_forwarding (void *cls,
585 const struct GNUNET_HashCode *key,
586 struct GSF_PendingRequest *pr)
588 struct GSF_ConnectedPeer *cp = cls;
589 struct GNUNET_PeerIdentity pid;
591 GSF_connected_peer_get_identity_ (cp, &pid);
592 if (GNUNET_YES != GSF_pending_request_test_target_ (pr, &pid))
594 GNUNET_STATISTICS_update (GSF_stats,
595 gettext_noop ("# Loopback routes suppressed"), 1,
599 GSF_plan_add_ (cp, pr);
605 * Function called after the creation of a connected peer record is complete.
607 * @param cls closure (unused)
608 * @param cp handle to the newly created connected peer record
611 connected_peer_cb (void *cls, struct GSF_ConnectedPeer *cp)
615 GSF_iterate_pending_requests_ (&consider_peer_for_forwarding, cp);
620 * Method called whenever a given peer connects.
622 * @param cls closure, not used
623 * @param peer peer identity this notification is about
626 peer_connect_handler (void *cls,
627 const struct GNUNET_PeerIdentity *peer)
630 GNUNET_CRYPTO_cmp_peer_identity (&my_id,
633 GSF_peer_connect_handler_ (peer,
640 * Function called after GNUNET_CORE_connect has succeeded
641 * (or failed for good). Note that the private key of the
642 * peer is intentionally not exposed here; if you need it,
643 * your process should try to read the private key file
644 * directly (which should work if you are authorized...).
647 * @param my_identity ID of this peer, NULL if we failed
650 peer_init_handler (void *cls,
651 const struct GNUNET_PeerIdentity *my_identity)
653 if (0 != GNUNET_CRYPTO_cmp_peer_identity (&my_id,
656 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
657 "Peer identity missmatch, refusing to start!\n");
658 GNUNET_SCHEDULER_shutdown ();
664 * Process fs requests.
666 * @param server the initialized server
667 * @param c configuration to use
670 main_init (struct GNUNET_SERVER_Handle *server,
671 const struct GNUNET_CONFIGURATION_Handle *c)
673 static const struct GNUNET_CORE_MessageHandler no_p2p_handlers[] = {
676 static const struct GNUNET_CORE_MessageHandler p2p_handlers[] = {
678 GNUNET_MESSAGE_TYPE_FS_GET, 0 },
680 GNUNET_MESSAGE_TYPE_FS_PUT, 0 },
681 { &GSF_handle_p2p_migration_stop_,
682 GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP,
683 sizeof (struct MigrationStopMessage) },
686 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
687 { &GNUNET_FS_handle_index_start, NULL,
688 GNUNET_MESSAGE_TYPE_FS_INDEX_START, 0 },
689 { &GNUNET_FS_handle_index_list_get, NULL,
690 GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET,
691 sizeof (struct GNUNET_MessageHeader) },
692 { &GNUNET_FS_handle_unindex, NULL,
693 GNUNET_MESSAGE_TYPE_FS_UNINDEX,
694 sizeof (struct UnindexMessage) },
695 { &handle_start_search, NULL,
696 GNUNET_MESSAGE_TYPE_FS_START_SEARCH, 0 },
697 { &handle_loc_sign, NULL,
698 GNUNET_MESSAGE_TYPE_FS_REQUEST_LOC_SIGN,
699 sizeof (struct RequestLocSignatureMessage) },
705 /* this option is really only for testcases that need to disable
706 _anonymous_ file-sharing for some reason */
707 anon_p2p_off = (GNUNET_YES ==
708 GNUNET_CONFIGURATION_get_value_yesno (GSF_cfg,
710 "DISABLE_ANON_TRANSFER"));
713 GNUNET_CONFIGURATION_get_value_filename (GSF_cfg,
718 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
719 _("FS service is lacking HOSTKEY configuration setting. Exiting.\n"));
720 GNUNET_SCHEDULER_shutdown ();
721 return GNUNET_SYSERR;
723 pk = GNUNET_CRYPTO_eddsa_key_create_from_file (keyfile);
724 GNUNET_free (keyfile);
725 GNUNET_assert (NULL != pk);
726 GNUNET_CRYPTO_eddsa_key_get_public (pk,
729 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
731 GNUNET_i2s (&my_id));
733 = GNUNET_CORE_connect (GSF_cfg, NULL,
735 &peer_connect_handler,
736 &GSF_peer_disconnect_handler_,
739 (GNUNET_YES == anon_p2p_off)
742 if (NULL == GSF_core)
744 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
745 _("Failed to connect to `%s' service.\n"), "core");
746 return GNUNET_SYSERR;
748 GNUNET_SERVER_disconnect_notify (server, &GSF_client_disconnect_handler_,
750 GNUNET_SERVER_add_handlers (server, handlers);
752 GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
754 datastore_get_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
755 GSF_cadet_start_server ();
756 GSF_cadet_start_client ();
757 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
764 * Process fs requests.
767 * @param server the initialized server
768 * @param cfg configuration to use
771 run (void *cls, struct GNUNET_SERVER_Handle *server,
772 const struct GNUNET_CONFIGURATION_Handle *cfg)
774 unsigned long long dqs;
778 GNUNET_CONFIGURATION_get_value_size (GSF_cfg, "fs", "DATASTORE_QUEUE_SIZE",
781 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_INFO,
782 "fs", "DATASTORE_QUEUE_SIZE");
785 GSF_datastore_queue_size = (unsigned int) dqs;
786 GSF_enable_randomized_delays =
787 GNUNET_CONFIGURATION_get_value_yesno (cfg, "fs", "DELAY");
788 GSF_dsh = GNUNET_DATASTORE_connect (cfg);
791 GNUNET_SCHEDULER_shutdown ();
794 GSF_rt_entry_lifetime = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_FOREVER_REL);
795 GSF_stats = GNUNET_STATISTICS_create ("fs", cfg);
796 block_cfg = GNUNET_CONFIGURATION_create ();
797 GSF_block_ctx = GNUNET_BLOCK_context_create (block_cfg);
798 GNUNET_assert (NULL != GSF_block_ctx);
799 GSF_dht = GNUNET_DHT_connect (cfg, FS_DHT_HT_SIZE);
801 GSF_pending_request_init_ ();
802 GSF_connected_peer_init_ ();
803 GSF_ats = GNUNET_ATS_performance_init (GSF_cfg, &update_latencies, NULL);
806 if ((GNUNET_OK != GNUNET_FS_indexing_init (cfg, GSF_dsh)) ||
807 (GNUNET_OK != main_init (server, cfg)))
809 GNUNET_SCHEDULER_shutdown ();
810 shutdown_task (NULL, NULL);
817 * The main function for the fs service.
819 * @param argc number of arguments from the command line
820 * @param argv command line arguments
821 * @return 0 ok, 1 on error
824 main (int argc, char *const *argv)
827 GNUNET_SERVICE_run (argc, argv, "fs", GNUNET_SERVICE_OPTION_NONE,
828 &run, NULL)) ? 0 : 1;
831 /* end of gnunet-service-fs.c */