2 This file is part of GNUnet.
3 Copyright (C) 2009-2014 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 static struct GNUNET_PeerIdentity 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 * Handle P2P "PUT" message.
282 * @param cls closure, always NULL
283 * @param other the other peer involved (sender or receiver, NULL
284 * for loopback messages where we are both sender and receiver)
285 * @param message the actual message
286 * @return #GNUNET_OK to keep the connection open,
287 * #GNUNET_SYSERR to close it (signal serious error)
290 handle_p2p_put (void *cls,
291 const struct GNUNET_PeerIdentity *other,
292 const struct GNUNET_MessageHeader *message)
294 struct GSF_ConnectedPeer *cp;
296 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
297 "Received P2P PUT from %s\n",
299 cp = GSF_peer_get_ (other);
305 GSF_cover_content_count++;
306 return GSF_handle_p2p_content_ (cp, message);
311 * We have a new request, consider forwarding it to the given
314 * @param cls the `struct GSF_PendingRequest`
315 * @param peer identity of the peer
316 * @param cp handle to the connected peer record
317 * @param ppd peer performance data
320 consider_request_for_forwarding (void *cls,
321 const struct GNUNET_PeerIdentity *peer,
322 struct GSF_ConnectedPeer *cp,
323 const struct GSF_PeerPerformanceData *ppd)
325 struct GSF_PendingRequest *pr = cls;
327 if (GNUNET_YES != GSF_pending_request_test_target_ (pr, peer))
329 #if INSANE_STATISTICS
330 GNUNET_STATISTICS_update (GSF_stats,
331 gettext_noop ("# Loopback routes suppressed"), 1,
336 GSF_plan_add_ (cp, pr);
341 * Function to be called after we're done processing
342 * replies from the local lookup. If the result status
343 * code indicates that there may be more replies, plan
344 * forwarding the request.
346 * @param cls closure (NULL)
347 * @param pr the pending request we were processing
348 * @param result final datastore lookup result
351 consider_forwarding (void *cls,
352 struct GSF_PendingRequest *pr,
353 enum GNUNET_BLOCK_EvaluationResult result)
355 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
356 return; /* we're done... */
358 GSF_pending_request_test_active_ (pr))
359 return; /* request is not actually active, skip! */
360 GSF_iterate_connected_peers_ (&consider_request_for_forwarding,
366 * Handle P2P "GET" request.
368 * @param cls closure, always NULL
369 * @param other the other peer involved (sender or receiver, NULL
370 * for loopback messages where we are both sender and receiver)
371 * @param message the actual message
372 * @return #GNUNET_OK to keep the connection open,
373 * #GNUNET_SYSERR to close it (signal serious error)
376 handle_p2p_get (void *cls,
377 const struct GNUNET_PeerIdentity *other,
378 const struct GNUNET_MessageHeader *message)
380 struct GSF_PendingRequest *pr;
382 pr = GSF_handle_p2p_query_ (other,
385 return GNUNET_OK; /* exists, identical to existing request, or malformed */
386 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
387 GSF_local_lookup_ (pr,
388 &consider_forwarding,
395 * We're done with the local lookup, now consider
396 * P2P processing (depending on request options and
397 * result status). Also signal that we can now
398 * receive more request information from the client.
400 * @param cls the client doing the request (`struct GNUNET_SERVER_Client`)
401 * @param pr the pending request we were processing
402 * @param result final datastore lookup result
405 start_p2p_processing (void *cls,
406 struct GSF_PendingRequest *pr,
407 enum GNUNET_BLOCK_EvaluationResult result)
409 struct GNUNET_SERVER_Client *client = cls;
410 struct GSF_PendingRequestData *prd;
412 GNUNET_SERVER_receive_done (client,
414 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
415 return; /* we're done, 'pr' was already destroyed... */
416 prd = GSF_pending_request_get_data_ (pr);
417 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
418 "Finished database lookup for local request `%s' with result %d\n",
419 GNUNET_h2s (&prd->query), result);
420 if (0 == prd->anonymity_level)
424 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
425 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
426 /* the above block types MAY be available via 'cadet' */
427 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
428 "Considering cadet-based download for block\n");
429 GSF_cadet_lookup_ (pr);
431 case GNUNET_BLOCK_TYPE_FS_UBLOCK:
432 /* the above block types are in the DHT */
433 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
434 "Considering DHT-based search for block\n");
435 GSF_dht_lookup_ (pr);
442 consider_forwarding (NULL, pr, result);
447 * Handle #GNUNET_MESSAGE_TYPE_FS_START_SEARCH-message (search request
451 * @param client identification of the client
452 * @param message the actual message
455 handle_start_search (void *cls,
456 struct GNUNET_SERVER_Client *client,
457 const struct GNUNET_MessageHeader *message)
459 struct GSF_PendingRequest *pr;
463 ret = GSF_local_client_start_search_handler_ (client,
469 GNUNET_SERVER_receive_done (client,
473 GNUNET_SERVER_receive_done (client,
477 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
478 GSF_local_lookup_ (pr,
479 &start_p2p_processing,
489 * Handle request to sign a LOC URI (from client).
491 * @param cls closure (NULL)
492 * @param client identification of the client
493 * @param message the actual message
496 handle_loc_sign (void *cls,
497 struct GNUNET_SERVER_Client *client,
498 const struct GNUNET_MessageHeader *message)
500 const struct RequestLocSignatureMessage *msg;
501 struct GNUNET_FS_Uri base;
502 struct GNUNET_FS_Uri *loc;
503 struct ResponseLocSignatureMessage resp;
504 struct GSF_LocalClient *lc;
506 msg = (const struct RequestLocSignatureMessage *) message;
507 GNUNET_break (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT ==
508 ntohl (msg->purpose));
509 base.type = GNUNET_FS_URI_CHK;
510 base.data.chk.chk = msg->chk;
511 base.data.chk.file_length = GNUNET_ntohll (msg->file_length);
512 loc = GNUNET_FS_uri_loc_create (&base,
514 GNUNET_TIME_absolute_ntoh (msg->expiration_time));
515 resp.header.size = htons (sizeof (struct ResponseLocSignatureMessage));
516 resp.header.type = htons (GNUNET_MESSAGE_TYPE_FS_REQUEST_LOC_SIGNATURE);
517 resp.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
518 resp.expiration_time = GNUNET_TIME_absolute_hton (loc->data.loc.expirationTime);
519 resp.signature = loc->data.loc.contentSignature;
520 resp.peer = loc->data.loc.peer;
521 GNUNET_FS_uri_destroy (loc);
522 lc = GSF_local_client_lookup_ (client);
523 GSF_local_client_transmit_ (lc,
525 GNUNET_SERVER_receive_done (client, GNUNET_OK);
530 * Task run during shutdown.
535 shutdown_task (void *cls)
537 GSF_cadet_stop_client ();
538 GSF_cadet_stop_server ();
539 if (NULL != GSF_core)
541 GNUNET_CORE_disconnect (GSF_core);
546 GNUNET_ATS_performance_done (GSF_ats);
551 GSF_pending_request_done_ ();
553 GSF_connected_peer_done_ ();
554 GNUNET_DATASTORE_disconnect (GSF_dsh, GNUNET_NO);
556 GNUNET_DHT_disconnect (GSF_dht);
558 GNUNET_BLOCK_context_destroy (GSF_block_ctx);
559 GSF_block_ctx = NULL;
560 GNUNET_CONFIGURATION_destroy (block_cfg);
562 GNUNET_STATISTICS_destroy (GSF_stats, GNUNET_NO);
564 if (NULL != cover_age_task)
566 GNUNET_SCHEDULER_cancel (cover_age_task);
567 cover_age_task = NULL;
569 GNUNET_FS_indexing_done ();
570 GNUNET_LOAD_value_free (datastore_get_load);
571 datastore_get_load = NULL;
572 GNUNET_LOAD_value_free (GSF_rt_entry_lifetime);
573 GSF_rt_entry_lifetime = NULL;
578 * Function called for each pending request whenever a new
579 * peer connects, giving us a chance to decide about submitting
580 * the existing request to the new peer.
582 * @param cls the `struct GSF_ConnectedPeer` of the new peer
583 * @param key query for the request
584 * @param pr handle to the pending request
585 * @return #GNUNET_YES to continue to iterate
588 consider_peer_for_forwarding (void *cls,
589 const struct GNUNET_HashCode *key,
590 struct GSF_PendingRequest *pr)
592 struct GSF_ConnectedPeer *cp = cls;
593 struct GNUNET_PeerIdentity pid;
596 GSF_pending_request_test_active_ (pr))
597 return GNUNET_YES; /* request is not actually active, skip! */
598 GSF_connected_peer_get_identity_ (cp, &pid);
600 GSF_pending_request_test_target_ (pr, &pid))
602 GNUNET_STATISTICS_update (GSF_stats,
603 gettext_noop ("# Loopback routes suppressed"),
608 GSF_plan_add_ (cp, pr);
614 * Function called after the creation of a connected peer record is complete.
616 * @param cls closure (unused)
617 * @param cp handle to the newly created connected peer record
620 connected_peer_cb (void *cls,
621 struct GSF_ConnectedPeer *cp)
625 GSF_iterate_pending_requests_ (&consider_peer_for_forwarding,
631 * Method called whenever a given peer connects.
633 * @param cls closure, not used
634 * @param peer peer identity this notification is about
637 peer_connect_handler (void *cls,
638 const struct GNUNET_PeerIdentity *peer)
641 GNUNET_CRYPTO_cmp_peer_identity (&my_id,
644 GSF_peer_connect_handler_ (peer,
651 * Function called after GNUNET_CORE_connect has succeeded
652 * (or failed for good). Note that the private key of the
653 * peer is intentionally not exposed here; if you need it,
654 * your process should try to read the private key file
655 * directly (which should work if you are authorized...).
658 * @param my_identity ID of this peer, NULL if we failed
661 peer_init_handler (void *cls,
662 const struct GNUNET_PeerIdentity *my_identity)
664 if (0 != GNUNET_CRYPTO_cmp_peer_identity (&my_id,
667 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
668 "Peer identity missmatch, refusing to start!\n");
669 GNUNET_SCHEDULER_shutdown ();
675 * Process fs requests.
677 * @param server the initialized server
678 * @param c configuration to use
681 main_init (struct GNUNET_SERVER_Handle *server,
682 const struct GNUNET_CONFIGURATION_Handle *c)
684 static const struct GNUNET_CORE_MessageHandler no_p2p_handlers[] = {
687 static const struct GNUNET_CORE_MessageHandler p2p_handlers[] = {
689 GNUNET_MESSAGE_TYPE_FS_GET, 0 },
691 GNUNET_MESSAGE_TYPE_FS_PUT, 0 },
692 { &GSF_handle_p2p_migration_stop_,
693 GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP,
694 sizeof (struct MigrationStopMessage) },
697 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
698 { &GNUNET_FS_handle_index_start, NULL,
699 GNUNET_MESSAGE_TYPE_FS_INDEX_START, 0 },
700 { &GNUNET_FS_handle_index_list_get, NULL,
701 GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET,
702 sizeof (struct GNUNET_MessageHeader) },
703 { &GNUNET_FS_handle_unindex, NULL,
704 GNUNET_MESSAGE_TYPE_FS_UNINDEX,
705 sizeof (struct UnindexMessage) },
706 { &handle_start_search, NULL,
707 GNUNET_MESSAGE_TYPE_FS_START_SEARCH, 0 },
708 { &handle_loc_sign, NULL,
709 GNUNET_MESSAGE_TYPE_FS_REQUEST_LOC_SIGN,
710 sizeof (struct RequestLocSignatureMessage) },
716 /* this option is really only for testcases that need to disable
717 _anonymous_ file-sharing for some reason */
718 anon_p2p_off = (GNUNET_YES ==
719 GNUNET_CONFIGURATION_get_value_yesno (GSF_cfg,
721 "DISABLE_ANON_TRANSFER"));
724 GNUNET_CONFIGURATION_get_value_filename (GSF_cfg,
729 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
730 _("FS service is lacking HOSTKEY configuration setting. Exiting.\n"));
731 GNUNET_SCHEDULER_shutdown ();
732 return GNUNET_SYSERR;
734 pk = GNUNET_CRYPTO_eddsa_key_create_from_file (keyfile);
735 GNUNET_free (keyfile);
736 GNUNET_assert (NULL != pk);
737 GNUNET_CRYPTO_eddsa_key_get_public (pk,
740 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
742 GNUNET_i2s (&my_id));
744 = GNUNET_CORE_connect (GSF_cfg, NULL,
746 &peer_connect_handler,
747 &GSF_peer_disconnect_handler_,
750 (GNUNET_YES == anon_p2p_off)
753 if (NULL == GSF_core)
755 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
756 _("Failed to connect to `%s' service.\n"), "core");
757 return GNUNET_SYSERR;
759 GNUNET_SERVER_disconnect_notify (server, &GSF_client_disconnect_handler_,
761 GNUNET_SERVER_add_handlers (server, handlers);
763 GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY,
766 datastore_get_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
767 GSF_cadet_start_server ();
768 GSF_cadet_start_client ();
769 GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
776 * Process fs requests.
779 * @param server the initialized server
780 * @param cfg configuration to use
783 run (void *cls, struct GNUNET_SERVER_Handle *server,
784 const struct GNUNET_CONFIGURATION_Handle *cfg)
786 unsigned long long dqs;
790 GNUNET_CONFIGURATION_get_value_size (GSF_cfg, "fs", "DATASTORE_QUEUE_SIZE",
793 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_INFO,
794 "fs", "DATASTORE_QUEUE_SIZE");
797 GSF_datastore_queue_size = (unsigned int) dqs;
798 GSF_enable_randomized_delays =
799 GNUNET_CONFIGURATION_get_value_yesno (cfg, "fs", "DELAY");
800 GSF_dsh = GNUNET_DATASTORE_connect (cfg);
803 GNUNET_SCHEDULER_shutdown ();
806 GSF_rt_entry_lifetime = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_FOREVER_REL);
807 GSF_stats = GNUNET_STATISTICS_create ("fs", cfg);
808 block_cfg = GNUNET_CONFIGURATION_create ();
809 GSF_block_ctx = GNUNET_BLOCK_context_create (block_cfg);
810 GNUNET_assert (NULL != GSF_block_ctx);
811 GSF_dht = GNUNET_DHT_connect (cfg, FS_DHT_HT_SIZE);
813 GSF_pending_request_init_ ();
814 GSF_connected_peer_init_ ();
815 GSF_ats = GNUNET_ATS_performance_init (GSF_cfg, &update_latencies, NULL);
818 if ((GNUNET_OK != GNUNET_FS_indexing_init (cfg, GSF_dsh)) ||
819 (GNUNET_OK != main_init (server, cfg)))
821 GNUNET_SCHEDULER_shutdown ();
822 shutdown_task (NULL);
829 * The main function for the fs service.
831 * @param argc number of arguments from the command line
832 * @param argv command line arguments
833 * @return 0 ok, 1 on error
836 main (int argc, char *const *argv)
839 GNUNET_SERVICE_run (argc, argv, "fs", GNUNET_SERVICE_OPTION_NONE,
840 &run, NULL)) ? 0 : 1;
843 /* end of gnunet-service-fs.c */