2 This file is part of GNUnet.
3 Copyright (C) 2013, 2014, 2016 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file revocation/gnunet-service-revocation.c
23 * @brief key revocation service
24 * @author Christian Grothoff
26 * The purpose of this service is to allow users to permanently revoke
27 * (compromised) keys. This is done by flooding the network with the
28 * revocation requests. To reduce the attack potential offered by such
29 * flooding, revocations must include a proof of work. We use the
30 * set service for efficiently computing the union of revocations of
34 * - optimization: avoid sending revocation back to peer that we got it from;
35 * - optimization: have randomized delay in sending revocations to other peers
36 * to make it rare to traverse each link twice (NSE-style)
40 #include "gnunet_util_lib.h"
41 #include "gnunet_block_lib.h"
42 #include "gnunet_constants.h"
43 #include "gnunet_protocols.h"
44 #include "gnunet_signatures.h"
45 #include "gnunet_statistics_service.h"
46 #include "gnunet_core_service.h"
47 #include "gnunet_revocation_service.h"
48 #include "gnunet_set_service.h"
49 #include "revocation.h"
54 * Per-peer information.
59 * Queue for sending messages to this peer.
61 struct GNUNET_MQ_Handle *mq;
64 * What is the identity of the peer?
66 struct GNUNET_PeerIdentity id;
69 * Tasked used to trigger the set union operation.
71 struct GNUNET_SCHEDULER_Task *transmit_task;
74 * Handle to active set union operation (over revocation sets).
76 struct GNUNET_SET_OperationHandle *so;
81 * Set from all revocations known to us.
83 static struct GNUNET_SET_Handle *revocation_set;
86 * Hash map with all revoked keys, maps the hash of the public key
87 * to the respective `struct RevokeMessage`.
89 static struct GNUNET_CONTAINER_MultiHashMap *revocation_map;
92 * Handle to our current configuration.
94 static const struct GNUNET_CONFIGURATION_Handle *cfg;
97 * Handle to the statistics service.
99 static struct GNUNET_STATISTICS_Handle *stats;
102 * Handle to the core service (for flooding)
104 static struct GNUNET_CORE_Handle *core_api;
107 * Map of all connected peers.
109 static struct GNUNET_CONTAINER_MultiPeerMap *peers;
112 * The peer identity of this peer.
114 static struct GNUNET_PeerIdentity my_identity;
117 * File handle for the revocation database.
119 static struct GNUNET_DISK_FileHandle *revocation_db;
122 * Handle for us listening to incoming revocation set union requests.
124 static struct GNUNET_SET_ListenHandle *revocation_union_listen_handle;
127 * Amount of work required (W-bit collisions) for REVOCATION proofs, in collision-bits.
129 static unsigned long long revocation_work_required;
132 * Our application ID for set union operations. Must be the
133 * same for all (compatible) peers.
135 static struct GNUNET_HashCode revocation_set_union_app_id;
139 * Create a new PeerEntry and add it to the peers multipeermap.
141 * @param peer the peer identity
142 * @return a pointer to the new PeerEntry
144 static struct PeerEntry *
145 new_peer_entry (const struct GNUNET_PeerIdentity *peer)
147 struct PeerEntry *peer_entry;
149 peer_entry = GNUNET_new (struct PeerEntry);
150 peer_entry->id = *peer;
151 GNUNET_assert (GNUNET_OK ==
152 GNUNET_CONTAINER_multipeermap_put (peers,
155 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
161 * An revoke message has been received, check that it is well-formed.
163 * @param rm the message to verify
164 * @return #GNUNET_YES if the message is verified
165 * #GNUNET_NO if the key/signature don't verify
168 verify_revoke_message (const struct RevokeMessage *rm)
171 GNUNET_REVOCATION_check_pow (&rm->public_key,
173 (unsigned int) revocation_work_required))
175 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
176 "Proof of work invalid!\n");
181 GNUNET_CRYPTO_ecdsa_verify (GNUNET_SIGNATURE_PURPOSE_REVOCATION,
194 * Handle client connecting to the service.
197 * @param client the new client
198 * @param mq the message queue of @a client
202 client_connect_cb (void *cls,
203 struct GNUNET_SERVICE_Client *client,
204 struct GNUNET_MQ_Handle *mq)
211 * Handle client connecting to the service.
214 * @param client the new client
215 * @param app_cls must alias @a client
218 client_disconnect_cb (void *cls,
219 struct GNUNET_SERVICE_Client *client,
222 GNUNET_assert (client == app_cls);
227 * Handle QUERY message from client.
229 * @param cls client who sent the message
230 * @param qm the message received
233 handle_query_message (void *cls,
234 const struct QueryMessage *qm)
236 struct GNUNET_SERVICE_Client *client = cls;
237 struct GNUNET_MQ_Envelope *env;
238 struct QueryResponseMessage *qrm;
239 struct GNUNET_HashCode hc;
242 GNUNET_CRYPTO_hash (&qm->key,
243 sizeof(struct GNUNET_CRYPTO_EcdsaPublicKey),
245 res = GNUNET_CONTAINER_multihashmap_contains (revocation_map,
247 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
249 ? "Received revocation check for valid key `%s' from client\n"
250 : "Received revocation check for revoked key `%s' from client\n",
252 env = GNUNET_MQ_msg (qrm,
253 GNUNET_MESSAGE_TYPE_REVOCATION_QUERY_RESPONSE);
254 qrm->is_valid = htonl ((GNUNET_YES == res) ? GNUNET_NO : GNUNET_YES);
255 GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client),
257 GNUNET_SERVICE_client_continue (client);
262 * Flood the given revocation message to all neighbours.
264 * @param cls the `struct RevokeMessage` to flood
265 * @param target a neighbour
266 * @param value our `struct PeerEntry` for the neighbour
267 * @return #GNUNET_OK (continue to iterate)
271 const struct GNUNET_PeerIdentity *target,
274 const struct RevokeMessage *rm = cls;
275 struct PeerEntry *pe = value;
276 struct GNUNET_MQ_Envelope *e;
277 struct RevokeMessage *cp;
280 return GNUNET_OK; /* peer connected to us via SET,
281 but we have no direct CORE
282 connection for flooding */
283 e = GNUNET_MQ_msg (cp,
284 GNUNET_MESSAGE_TYPE_REVOCATION_REVOKE);
286 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
287 "Flooding revocation to `%s'\n",
288 GNUNET_i2s (target));
289 GNUNET_MQ_send (pe->mq,
296 * Publicize revocation message. Stores the message locally in the
297 * database and passes it to all connected neighbours (and adds it to
298 * the set for future connections).
300 * @param rm message to publicize
301 * @return #GNUNET_OK on success, #GNUNET_NO if we encountered an error,
302 * #GNUNET_SYSERR if the message was malformed
305 publicize_rm (const struct RevokeMessage *rm)
307 struct RevokeMessage *cp;
308 struct GNUNET_HashCode hc;
309 struct GNUNET_SET_Element e;
311 GNUNET_CRYPTO_hash (&rm->public_key,
312 sizeof(struct GNUNET_CRYPTO_EcdsaPublicKey),
315 GNUNET_CONTAINER_multihashmap_contains (revocation_map,
318 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
319 "Duplicate revocation received from peer. Ignored.\n");
323 verify_revoke_message (rm))
326 return GNUNET_SYSERR;
329 if (sizeof(struct RevokeMessage) !=
330 GNUNET_DISK_file_write (revocation_db,
332 sizeof(struct RevokeMessage)))
334 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
339 GNUNET_DISK_file_sync (revocation_db))
341 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
345 /* keep copy in memory */
346 cp = (struct RevokeMessage *) GNUNET_copy_message (&rm->header);
347 GNUNET_break (GNUNET_OK ==
348 GNUNET_CONTAINER_multihashmap_put (revocation_map,
351 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
352 /* add to set for future connections */
353 e.size = htons (rm->header.size);
354 e.element_type = GNUNET_BLOCK_TYPE_REVOCATION;
357 GNUNET_SET_add_element (revocation_set,
367 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
368 "Added revocation info to SET\n");
370 /* flood to neighbours */
371 GNUNET_CONTAINER_multipeermap_iterate (peers,
379 * Handle REVOKE message from client.
381 * @param cls client who sent the message
382 * @param rm the message received
385 handle_revoke_message (void *cls,
386 const struct RevokeMessage *rm)
388 struct GNUNET_SERVICE_Client *client = cls;
389 struct GNUNET_MQ_Envelope *env;
390 struct RevocationResponseMessage *rrm;
393 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
394 "Received REVOKE message from client\n");
395 if (GNUNET_SYSERR == (ret = publicize_rm (rm)))
398 GNUNET_SERVICE_client_drop (client);
401 env = GNUNET_MQ_msg (rrm,
402 GNUNET_MESSAGE_TYPE_REVOCATION_REVOKE_RESPONSE);
403 rrm->is_valid = htonl ((GNUNET_OK == ret) ? GNUNET_NO : GNUNET_YES);
404 GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client),
406 GNUNET_SERVICE_client_continue (client);
411 * Core handler for flooded revocation messages.
413 * @param cls closure unused
414 * @param rm revocation message
417 handle_p2p_revoke (void *cls,
418 const struct RevokeMessage *rm)
420 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
421 "Received REVOKE message\n");
422 GNUNET_break_op (GNUNET_SYSERR !=
428 * Callback for set operation results. Called for each element in the
429 * result set. Each element contains a revocation, which we should
430 * validate and then add to our revocation list (and set).
433 * @param element a result element, only valid if status is #GNUNET_SET_STATUS_OK
434 * @param current_size current set size
435 * @param status see `enum GNUNET_SET_Status`
438 add_revocation (void *cls,
439 const struct GNUNET_SET_Element *element,
440 uint64_t current_size,
441 enum GNUNET_SET_Status status)
443 struct PeerEntry *peer_entry = cls;
444 const struct RevokeMessage *rm;
448 case GNUNET_SET_STATUS_OK:
449 if (element->size != sizeof(struct RevokeMessage))
454 if (GNUNET_BLOCK_TYPE_REVOCATION != element->element_type)
456 GNUNET_STATISTICS_update (stats,
458 "# unsupported revocations received via set union"),
464 (void) handle_p2p_revoke (NULL,
466 GNUNET_STATISTICS_update (stats,
468 "# revocation messages received via set union"),
472 case GNUNET_SET_STATUS_FAILURE:
473 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
474 _ ("Error computing revocation set union with %s\n"),
475 GNUNET_i2s (&peer_entry->id));
476 peer_entry->so = NULL;
477 GNUNET_STATISTICS_update (stats,
478 gettext_noop ("# revocation set unions failed"),
483 case GNUNET_SET_STATUS_HALF_DONE:
486 case GNUNET_SET_STATUS_DONE:
487 peer_entry->so = NULL;
488 GNUNET_STATISTICS_update (stats,
490 "# revocation set unions completed"),
503 * The timeout for performing the set union has expired,
504 * run the set operation on the revocation certificates.
509 transmit_task_cb (void *cls)
511 struct PeerEntry *peer_entry = cls;
513 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
514 "Starting set exchange with peer `%s'\n",
515 GNUNET_i2s (&peer_entry->id));
516 peer_entry->transmit_task = NULL;
517 GNUNET_assert (NULL == peer_entry->so);
518 peer_entry->so = GNUNET_SET_prepare (&peer_entry->id,
519 &revocation_set_union_app_id,
521 GNUNET_SET_RESULT_ADDED,
522 (struct GNUNET_SET_Option[]) { { 0 } },
526 GNUNET_SET_commit (peer_entry->so,
529 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
530 _ ("SET service crashed, terminating revocation service\n"));
531 GNUNET_SCHEDULER_shutdown ();
538 * Method called whenever a peer connects. Sets up the PeerEntry and
539 * schedules the initial revocation set exchange with this peer.
542 * @param peer peer identity this notification is about
545 handle_core_connect (void *cls,
546 const struct GNUNET_PeerIdentity *peer,
547 struct GNUNET_MQ_Handle *mq)
549 struct PeerEntry *peer_entry;
550 struct GNUNET_HashCode my_hash;
551 struct GNUNET_HashCode peer_hash;
553 if (0 == GNUNET_memcmp (peer,
559 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
560 "Peer `%s' connected to us\n",
562 GNUNET_STATISTICS_update (stats,
566 peer_entry = GNUNET_CONTAINER_multipeermap_get (peers,
568 if (NULL != peer_entry)
570 /* This can happen if "core"'s notification is a tad late
571 and CADET+SET were faster and already produced a
572 #handle_revocation_union_request() for us to deal
573 with. This should be rare, but isn't impossible. */
577 peer_entry = new_peer_entry (peer);
579 GNUNET_CRYPTO_hash (&my_identity,
582 GNUNET_CRYPTO_hash (peer,
585 if (0 < GNUNET_CRYPTO_hash_cmp (&my_hash,
588 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
589 "Starting SET operation with peer `%s'\n",
591 peer_entry->transmit_task =
592 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
601 * Method called whenever a peer disconnects. Deletes the PeerEntry and cancels
602 * any pending transmission requests to that peer.
605 * @param peer peer identity this notification is about
606 * @param internal_cls our `struct PeerEntry` for this peer
609 handle_core_disconnect (void *cls,
610 const struct GNUNET_PeerIdentity *peer,
613 struct PeerEntry *peer_entry = internal_cls;
615 if (0 == GNUNET_memcmp (peer,
618 GNUNET_assert (NULL != peer_entry);
619 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
620 "Peer `%s' disconnected from us\n",
622 GNUNET_assert (GNUNET_YES ==
623 GNUNET_CONTAINER_multipeermap_remove (peers,
626 if (NULL != peer_entry->transmit_task)
628 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
629 peer_entry->transmit_task = NULL;
631 if (NULL != peer_entry->so)
633 GNUNET_SET_operation_cancel (peer_entry->so);
634 peer_entry->so = NULL;
636 GNUNET_free (peer_entry);
637 GNUNET_STATISTICS_update (stats,
645 * Free all values in a hash map.
649 * @param value value to free
650 * @return #GNUNET_OK (continue to iterate)
653 free_entry (void *cls,
654 const struct GNUNET_HashCode *key,
663 * Task run during shutdown.
668 shutdown_task (void *cls)
670 if (NULL != revocation_set)
672 GNUNET_SET_destroy (revocation_set);
673 revocation_set = NULL;
675 if (NULL != revocation_union_listen_handle)
677 GNUNET_SET_listen_cancel (revocation_union_listen_handle);
678 revocation_union_listen_handle = NULL;
680 if (NULL != core_api)
682 GNUNET_CORE_disconnect (core_api);
687 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
692 GNUNET_CONTAINER_multipeermap_destroy (peers);
695 if (NULL != revocation_db)
697 GNUNET_DISK_file_close (revocation_db);
698 revocation_db = NULL;
700 GNUNET_CONTAINER_multihashmap_iterate (revocation_map,
703 GNUNET_CONTAINER_multihashmap_destroy (revocation_map);
708 * Called on core init/fail.
710 * @param cls service closure
711 * @param identity the public identity of this peer
714 core_init (void *cls,
715 const struct GNUNET_PeerIdentity *identity)
717 if (NULL == identity)
719 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
720 "Connection to core FAILED!\n");
721 GNUNET_SCHEDULER_shutdown ();
724 my_identity = *identity;
729 * Called when another peer wants to do a set operation with the
730 * local peer. If a listen error occurs, the 'request' is NULL.
733 * @param other_peer the other peer
734 * @param context_msg message with application specific information from
736 * @param request request from the other peer (never NULL), use GNUNET_SET_accept()
737 * to accept it, otherwise the request will be refused
738 * Note that we can't just return value from the listen callback,
739 * as it is also necessary to specify the set we want to do the
740 * operation with, whith sometimes can be derived from the context
741 * message. It's necessary to specify the timeout.
744 handle_revocation_union_request (void *cls,
745 const struct GNUNET_PeerIdentity *other_peer,
746 const struct GNUNET_MessageHeader *context_msg,
747 struct GNUNET_SET_Request *request)
749 struct PeerEntry *peer_entry;
756 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
757 "Received set exchange request from peer `%s'\n",
758 GNUNET_i2s (other_peer));
759 peer_entry = GNUNET_CONTAINER_multipeermap_get (peers,
761 if (NULL == peer_entry)
763 peer_entry = new_peer_entry (other_peer);
765 if (NULL != peer_entry->so)
770 peer_entry->so = GNUNET_SET_accept (request,
771 GNUNET_SET_RESULT_ADDED,
772 (struct GNUNET_SET_Option[]) { { 0 } },
776 GNUNET_SET_commit (peer_entry->so,
780 GNUNET_SCHEDULER_shutdown ();
787 * Handle network size estimate clients.
790 * @param server the initialized server
791 * @param c configuration to use
795 const struct GNUNET_CONFIGURATION_Handle *c,
796 struct GNUNET_SERVICE_Handle *service)
798 struct GNUNET_MQ_MessageHandler core_handlers[] = {
799 GNUNET_MQ_hd_fixed_size (p2p_revoke,
800 GNUNET_MESSAGE_TYPE_REVOCATION_REVOKE,
801 struct RevokeMessage,
803 GNUNET_MQ_handler_end ()
807 struct RevokeMessage *rm;
808 struct GNUNET_HashCode hc;
810 GNUNET_CRYPTO_hash ("revocation-set-union-application-id",
811 strlen ("revocation-set-union-application-id"),
812 &revocation_set_union_app_id);
814 GNUNET_CONFIGURATION_get_value_filename (c,
819 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
822 GNUNET_SCHEDULER_shutdown ();
826 revocation_map = GNUNET_CONTAINER_multihashmap_create (16,
829 GNUNET_CONFIGURATION_get_value_number (cfg,
832 &revocation_work_required))
834 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
837 GNUNET_SCHEDULER_shutdown ();
841 if (revocation_work_required >= sizeof(struct GNUNET_HashCode) * 8)
843 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
846 _ ("Value is too large.\n"));
847 GNUNET_SCHEDULER_shutdown ();
851 revocation_set = GNUNET_SET_create (cfg,
852 GNUNET_SET_OPERATION_UNION);
853 revocation_union_listen_handle
854 = GNUNET_SET_listen (cfg,
855 GNUNET_SET_OPERATION_UNION,
856 &revocation_set_union_app_id,
857 &handle_revocation_union_request,
859 revocation_db = GNUNET_DISK_file_open (fn,
860 GNUNET_DISK_OPEN_READWRITE
861 | GNUNET_DISK_OPEN_CREATE,
862 GNUNET_DISK_PERM_USER_READ
863 | GNUNET_DISK_PERM_USER_WRITE
864 | GNUNET_DISK_PERM_GROUP_READ
865 | GNUNET_DISK_PERM_OTHER_READ);
866 if (NULL == revocation_db)
868 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
871 _ ("Could not open revocation database file!"));
872 GNUNET_SCHEDULER_shutdown ();
877 GNUNET_DISK_file_size (fn, &left, GNUNET_YES, GNUNET_YES))
879 while (left > sizeof(struct RevokeMessage))
881 rm = GNUNET_new (struct RevokeMessage);
882 if (sizeof(struct RevokeMessage) !=
883 GNUNET_DISK_file_read (revocation_db,
885 sizeof(struct RevokeMessage)))
887 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
891 GNUNET_SCHEDULER_shutdown ();
895 GNUNET_break (0 == ntohl (rm->reserved));
896 GNUNET_CRYPTO_hash (&rm->public_key,
897 sizeof(struct GNUNET_CRYPTO_EcdsaPublicKey),
899 GNUNET_break (GNUNET_OK ==
900 GNUNET_CONTAINER_multihashmap_put (revocation_map,
903 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
907 GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
909 peers = GNUNET_CONTAINER_multipeermap_create (128,
911 /* Connect to core service and register core handlers */
912 core_api = GNUNET_CORE_connect (cfg, /* Main configuration */
913 NULL, /* Closure passed to functions */
914 &core_init, /* Call core_init once connected */
915 &handle_core_connect, /* Handle connects */
916 &handle_core_disconnect, /* Handle disconnects */
917 core_handlers); /* Register these handlers */
918 if (NULL == core_api)
920 GNUNET_SCHEDULER_shutdown ();
923 stats = GNUNET_STATISTICS_create ("revocation",
929 * Define "main" method using service macro.
933 GNUNET_SERVICE_OPTION_NONE,
936 &client_disconnect_cb,
938 GNUNET_MQ_hd_fixed_size (query_message,
939 GNUNET_MESSAGE_TYPE_REVOCATION_QUERY,
942 GNUNET_MQ_hd_fixed_size (revoke_message,
943 GNUNET_MESSAGE_TYPE_REVOCATION_REVOKE,
944 struct RevokeMessage,
946 GNUNET_MQ_handler_end ());
949 #if defined(LINUX) && defined(__GLIBC__)
953 * MINIMIZE heap size (way below 128k) since this process doesn't need much.
955 void __attribute__ ((constructor))
956 GNUNET_REVOCATION_memory_init ()
958 mallopt (M_TRIM_THRESHOLD, 4 * 1024);
959 mallopt (M_TOP_PAD, 1 * 1024);
966 /* end of gnunet-service-revocation.c */