2 This file is part of GNUnet.
3 Copyright (C) 2009-2014, 2016 GNUnet e.V.
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 struct GNUNET_PeerIdentity GSF_my_id;
184 * Task that periodically ages our cover traffic statistics.
186 * @param cls unused closure
189 age_cover_counters (void *cls)
191 GSF_cover_content_count = (GSF_cover_content_count * 15) / 16;
192 GSF_cover_query_count = (GSF_cover_query_count * 15) / 16;
194 GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY,
201 * We've just now completed a datastore request. Update our
202 * datastore load calculations.
204 * @param start time when the datastore request was issued
207 GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start)
209 struct GNUNET_TIME_Relative delay;
211 delay = GNUNET_TIME_absolute_get_duration (start);
212 GNUNET_LOAD_update (datastore_get_load, delay.rel_value_us);
217 * Test if the DATABASE (GET) load on this peer is too high
218 * to even consider processing the query at
221 * @param priority priority of the request (used as a reference point to compare with the load)
222 * @return #GNUNET_YES if the load is too high to do anything (load high)
223 * #GNUNET_NO to process normally (load normal)
224 * #GNUNET_SYSERR to process for free (load low)
227 GSF_test_get_load_too_high_ (uint32_t priority)
231 ld = GNUNET_LOAD_get_load (datastore_get_load);
233 return GNUNET_SYSERR;
241 * We've received peer performance information. Update
242 * our running average for the P2P latency.
245 * @param address the address
246 * @param active is this address in active use
247 * @param bandwidth_out assigned outbound bandwidth for the connection
248 * @param bandwidth_in assigned inbound bandwidth for the connection
249 * @param prop performance data for the address (as far as known)
252 update_latencies (void *cls,
253 const struct GNUNET_HELLO_Address *address,
255 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
256 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
257 const struct GNUNET_ATS_Properties *prop)
261 /* ATS service temporarily disconnected */
265 if (GNUNET_YES != active)
267 GSF_update_peer_latency_ (&address->peer,
269 GSF_avg_latency.rel_value_us =
270 (GSF_avg_latency.rel_value_us * 31 +
271 GNUNET_MIN (5000, prop->delay.rel_value_us)) / 32;
272 GNUNET_STATISTICS_set (GSF_stats,
273 gettext_noop ("# running average P2P latency (ms)"),
274 GSF_avg_latency.rel_value_us / 1000LL,
280 * Check P2P "PUT" message.
282 * @param cls closure with the `struct GSF_ConnectedPeer`
283 * @param message the actual message
284 * @return #GNUNET_OK to keep the connection open,
285 * #GNUNET_SYSERR to close it (signal serious error)
288 check_p2p_put (void *cls,
289 const struct PutMessage *put)
291 enum GNUNET_BLOCK_Type type;
293 type = ntohl (put->type);
294 if (GNUNET_BLOCK_TYPE_FS_ONDEMAND == type)
297 return GNUNET_SYSERR;
304 * We have a new request, consider forwarding it to the given
307 * @param cls the `struct GSF_PendingRequest`
308 * @param peer identity of the peer
309 * @param cp handle to the connected peer record
310 * @param ppd peer performance data
313 consider_request_for_forwarding (void *cls,
314 const struct GNUNET_PeerIdentity *peer,
315 struct GSF_ConnectedPeer *cp,
316 const struct GSF_PeerPerformanceData *ppd)
318 struct GSF_PendingRequest *pr = cls;
321 GSF_pending_request_test_target_ (pr, peer))
323 #if INSANE_STATISTICS
324 GNUNET_STATISTICS_update (GSF_stats,
325 gettext_noop ("# Loopback routes suppressed"), 1,
336 * Function to be called after we're done processing
337 * replies from the local lookup. If the result status
338 * code indicates that there may be more replies, plan
339 * forwarding the request.
341 * @param cls closure (NULL)
342 * @param pr the pending request we were processing
343 * @param result final datastore lookup result
346 GSF_consider_forwarding (void *cls,
347 struct GSF_PendingRequest *pr,
348 enum GNUNET_BLOCK_EvaluationResult result)
350 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
351 return; /* we're done... */
353 GSF_pending_request_test_active_ (pr))
354 return; /* request is not actually active, skip! */
355 GSF_iterate_connected_peers_ (&consider_request_for_forwarding,
361 * Check P2P "GET" request.
364 * @param gm the actual message
365 * @return #GNUNET_OK to keep the connection open,
366 * #GNUNET_SYSERR to close it (signal serious error)
369 check_p2p_get (void *cls,
370 const struct GetMessage *gm)
377 msize = ntohs (gm->header.size);
378 bm = ntohl (gm->hash_bitmap);
386 if (msize < sizeof (struct GetMessage) + bits * sizeof (struct GNUNET_PeerIdentity))
389 return GNUNET_SYSERR;
391 bfsize = msize - sizeof (struct GetMessage) - bits * sizeof (struct GNUNET_PeerIdentity);
392 /* bfsize must be power of 2, check! */
393 if (0 != ((bfsize - 1) & bfsize))
396 return GNUNET_SYSERR;
403 * We're done with the local lookup, now consider
404 * P2P processing (depending on request options and
405 * result status). Also signal that we can now
406 * receive more request information from the client.
408 * @param cls the client doing the request (`struct GNUNET_SERVER_Client`)
409 * @param pr the pending request we were processing
410 * @param result final datastore lookup result
413 start_p2p_processing (void *cls,
414 struct GSF_PendingRequest *pr,
415 enum GNUNET_BLOCK_EvaluationResult result)
417 struct GNUNET_SERVER_Client *client = cls;
418 struct GSF_PendingRequestData *prd;
420 GNUNET_SERVER_receive_done (client,
422 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
423 return; /* we're done, 'pr' was already destroyed... */
424 prd = GSF_pending_request_get_data_ (pr);
425 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
426 "Finished database lookup for local request `%s' with result %d\n",
427 GNUNET_h2s (&prd->query),
429 if (0 == prd->anonymity_level)
433 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
434 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
435 /* the above block types MAY be available via 'cadet' */
436 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
437 "Considering cadet-based download for block\n");
438 GSF_cadet_lookup_ (pr);
440 case GNUNET_BLOCK_TYPE_FS_UBLOCK:
441 /* the above block types are in the DHT */
442 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
443 "Considering DHT-based search for block\n");
444 GSF_dht_lookup_ (pr);
451 GSF_consider_forwarding (NULL, pr, result);
456 * Handle #GNUNET_MESSAGE_TYPE_FS_START_SEARCH-message (search request
460 * @param client identification of the client
461 * @param message the actual message
464 handle_start_search (void *cls,
465 struct GNUNET_SERVER_Client *client,
466 const struct GNUNET_MessageHeader *message)
468 struct GSF_PendingRequest *pr;
472 ret = GSF_local_client_start_search_handler_ (client,
478 GNUNET_SERVER_receive_done (client,
482 GNUNET_SERVER_receive_done (client,
486 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
487 GSF_local_lookup_ (pr,
488 &start_p2p_processing,
498 * Handle request to sign a LOC URI (from client).
500 * @param cls closure (NULL)
501 * @param client identification of the client
502 * @param message the actual message
505 handle_loc_sign (void *cls,
506 struct GNUNET_SERVER_Client *client,
507 const struct GNUNET_MessageHeader *message)
509 const struct RequestLocSignatureMessage *msg;
510 struct GNUNET_FS_Uri base;
511 struct GNUNET_FS_Uri *loc;
512 struct ResponseLocSignatureMessage resp;
513 struct GSF_LocalClient *lc;
515 msg = (const struct RequestLocSignatureMessage *) message;
516 GNUNET_break (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT ==
517 ntohl (msg->purpose));
518 base.type = GNUNET_FS_URI_CHK;
519 base.data.chk.chk = msg->chk;
520 base.data.chk.file_length = GNUNET_ntohll (msg->file_length);
521 loc = GNUNET_FS_uri_loc_create (&base,
523 GNUNET_TIME_absolute_ntoh (msg->expiration_time));
524 resp.header.size = htons (sizeof (struct ResponseLocSignatureMessage));
525 resp.header.type = htons (GNUNET_MESSAGE_TYPE_FS_REQUEST_LOC_SIGNATURE);
526 resp.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
527 resp.expiration_time = GNUNET_TIME_absolute_hton (loc->data.loc.expirationTime);
528 resp.signature = loc->data.loc.contentSignature;
529 resp.peer = loc->data.loc.peer;
530 GNUNET_FS_uri_destroy (loc);
531 lc = GSF_local_client_lookup_ (client);
532 GSF_local_client_transmit_ (lc,
534 GNUNET_SERVER_receive_done (client, GNUNET_OK);
539 * Task run during shutdown.
544 shutdown_task (void *cls)
546 GSF_cadet_stop_client ();
547 GSF_cadet_stop_server ();
548 if (NULL != GSF_core)
550 GNUNET_CORE_disconnecT (GSF_core);
555 GNUNET_ATS_performance_done (GSF_ats);
560 GSF_pending_request_done_ ();
562 GSF_connected_peer_done_ ();
563 GNUNET_DATASTORE_disconnect (GSF_dsh, GNUNET_NO);
565 GNUNET_DHT_disconnect (GSF_dht);
567 GNUNET_BLOCK_context_destroy (GSF_block_ctx);
568 GSF_block_ctx = NULL;
569 GNUNET_CONFIGURATION_destroy (block_cfg);
571 GNUNET_STATISTICS_destroy (GSF_stats, GNUNET_NO);
573 if (NULL != cover_age_task)
575 GNUNET_SCHEDULER_cancel (cover_age_task);
576 cover_age_task = NULL;
578 GNUNET_FS_indexing_done ();
579 GNUNET_LOAD_value_free (datastore_get_load);
580 datastore_get_load = NULL;
581 GNUNET_LOAD_value_free (GSF_rt_entry_lifetime);
582 GSF_rt_entry_lifetime = NULL;
587 * Function called after GNUNET_CORE_connecT has succeeded
588 * (or failed for good). Note that the private key of the
589 * peer is intentionally not exposed here; if you need it,
590 * your process should try to read the private key file
591 * directly (which should work if you are authorized...).
594 * @param my_identity ID of this peer, NULL if we failed
597 peer_init_handler (void *cls,
598 const struct GNUNET_PeerIdentity *my_identity)
600 if (0 != GNUNET_CRYPTO_cmp_peer_identity (&GSF_my_id,
603 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
604 "Peer identity missmatch, refusing to start!\n");
605 GNUNET_SCHEDULER_shutdown ();
611 * Process fs requests.
613 * @param server the initialized server
614 * @param c configuration to use
617 main_init (struct GNUNET_SERVER_Handle *server,
618 const struct GNUNET_CONFIGURATION_Handle *c)
620 struct GNUNET_MQ_MessageHandler no_p2p_handlers[] = {
621 GNUNET_MQ_handler_end ()
623 struct GNUNET_MQ_MessageHandler p2p_handlers[] = {
624 GNUNET_MQ_hd_var_size (p2p_get,
625 GNUNET_MESSAGE_TYPE_FS_GET,
628 GNUNET_MQ_hd_var_size (p2p_put,
629 GNUNET_MESSAGE_TYPE_FS_PUT,
632 GNUNET_MQ_hd_fixed_size (p2p_migration_stop,
633 GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP,
634 struct MigrationStopMessage,
636 GNUNET_MQ_handler_end ()
638 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
639 { &GNUNET_FS_handle_index_start, NULL,
640 GNUNET_MESSAGE_TYPE_FS_INDEX_START, 0 },
641 { &GNUNET_FS_handle_index_list_get, NULL,
642 GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET,
643 sizeof (struct GNUNET_MessageHeader) },
644 { &GNUNET_FS_handle_unindex, NULL,
645 GNUNET_MESSAGE_TYPE_FS_UNINDEX,
646 sizeof (struct UnindexMessage) },
647 { &handle_start_search, NULL,
648 GNUNET_MESSAGE_TYPE_FS_START_SEARCH, 0 },
649 { &handle_loc_sign, NULL,
650 GNUNET_MESSAGE_TYPE_FS_REQUEST_LOC_SIGN,
651 sizeof (struct RequestLocSignatureMessage) },
657 /* this option is really only for testcases that need to disable
658 _anonymous_ file-sharing for some reason */
659 anon_p2p_off = (GNUNET_YES ==
660 GNUNET_CONFIGURATION_get_value_yesno (GSF_cfg,
662 "DISABLE_ANON_TRANSFER"));
665 GNUNET_CONFIGURATION_get_value_filename (GSF_cfg,
670 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
671 _("FS service is lacking HOSTKEY configuration setting. Exiting.\n"));
672 GNUNET_SCHEDULER_shutdown ();
673 return GNUNET_SYSERR;
675 pk = GNUNET_CRYPTO_eddsa_key_create_from_file (keyfile);
676 GNUNET_free (keyfile);
677 GNUNET_assert (NULL != pk);
678 GNUNET_CRYPTO_eddsa_key_get_public (pk,
679 &GSF_my_id.public_key);
681 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
683 GNUNET_i2s (&GSF_my_id));
685 = GNUNET_CORE_connecT (GSF_cfg,
688 &GSF_peer_connect_handler,
689 &GSF_peer_disconnect_handler,
690 (GNUNET_YES == anon_p2p_off)
693 if (NULL == GSF_core)
695 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
696 _("Failed to connect to `%s' service.\n"),
698 return GNUNET_SYSERR;
700 GNUNET_SERVER_disconnect_notify (server,
701 &GSF_client_disconnect_handler_,
703 GNUNET_SERVER_add_handlers (server, handlers);
705 GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY,
708 datastore_get_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
709 GSF_cadet_start_server ();
710 GSF_cadet_start_client ();
711 GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
718 * Process fs requests.
721 * @param server the initialized server
722 * @param cfg configuration to use
725 run (void *cls, struct GNUNET_SERVER_Handle *server,
726 const struct GNUNET_CONFIGURATION_Handle *cfg)
728 unsigned long long dqs;
732 GNUNET_CONFIGURATION_get_value_size (GSF_cfg, "fs", "DATASTORE_QUEUE_SIZE",
735 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_INFO,
736 "fs", "DATASTORE_QUEUE_SIZE");
739 GSF_datastore_queue_size = (unsigned int) dqs;
740 GSF_enable_randomized_delays =
741 GNUNET_CONFIGURATION_get_value_yesno (cfg, "fs", "DELAY");
742 GSF_dsh = GNUNET_DATASTORE_connect (cfg);
745 GNUNET_SCHEDULER_shutdown ();
748 GSF_rt_entry_lifetime = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_FOREVER_REL);
749 GSF_stats = GNUNET_STATISTICS_create ("fs", cfg);
750 block_cfg = GNUNET_CONFIGURATION_create ();
751 GSF_block_ctx = GNUNET_BLOCK_context_create (block_cfg);
752 GNUNET_assert (NULL != GSF_block_ctx);
753 GSF_dht = GNUNET_DHT_connect (cfg, FS_DHT_HT_SIZE);
755 GSF_pending_request_init_ ();
756 GSF_connected_peer_init_ ();
757 GSF_ats = GNUNET_ATS_performance_init (GSF_cfg, &update_latencies, NULL);
760 if ((GNUNET_OK != GNUNET_FS_indexing_init (cfg, GSF_dsh)) ||
761 (GNUNET_OK != main_init (server, cfg)))
763 GNUNET_SCHEDULER_shutdown ();
764 shutdown_task (NULL);
771 * The main function for the fs service.
773 * @param argc number of arguments from the command line
774 * @param argv command line arguments
775 * @return 0 ok, 1 on error
778 main (int argc, char *const *argv)
781 GNUNET_SERVICE_run (argc, argv, "fs", GNUNET_SERVICE_OPTION_NONE,
782 &run, NULL)) ? 0 : 1;
785 /* end of gnunet-service-fs.c */