2 This file is part of GNUnet
3 Copyright (C) 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 secretsharing/gnunet-secretsharing-profiler.c
23 * @brief profiling tool for distributed key generation and decryption
24 * @author Florian Dold
27 #include "gnunet_util_lib.h"
28 #include "gnunet_secretsharing_service.h"
29 #include "gnunet_testbed_service.h"
32 * How many peers should participate in the key generation?
34 static unsigned int num_peers = 3;
37 * What should the threshold for then key be?
39 static unsigned int threshold = 2;
42 * Should we try to decrypt a value after the key generation?
44 static unsigned int decrypt = GNUNET_NO;
47 * When would we like to see the operation finished?
49 static struct GNUNET_TIME_Relative timeout;
52 * When should dkg communication start?
54 static struct GNUNET_TIME_Relative delay;
57 * Handles for secretsharing sessions.
59 static struct GNUNET_SECRETSHARING_Session **session_handles;
61 static struct GNUNET_SECRETSHARING_DecryptionHandle **decrypt_handles;
64 * Shares we got from the distributed key generation.
66 static struct GNUNET_SECRETSHARING_Share **shares;
68 static struct GNUNET_SECRETSHARING_PublicKey common_pubkey;
71 static unsigned int num_connected_sessions;
73 static unsigned int num_connected_decrypt;
76 * Handles to the running peers.
77 * When peers[i] is NULL, the i-th peer has stopped.
79 static struct GNUNET_TESTBED_Peer **peers;
81 static struct GNUNET_PeerIdentity *peer_ids;
83 static unsigned int num_retrieved_peer_ids;
85 static unsigned int num_generated;
87 static unsigned int num_decrypted;
89 static struct GNUNET_HashCode session_id;
93 static struct GNUNET_SECRETSHARING_Plaintext reference_plaintext;
95 static struct GNUNET_SECRETSHARING_Ciphertext ciphertext;
97 static struct GNUNET_TIME_Absolute dkg_start;
99 static struct GNUNET_TIME_Absolute dkg_deadline;
102 static struct GNUNET_TIME_Absolute decrypt_start;
104 static struct GNUNET_TIME_Absolute decrypt_deadline;
107 * Connect operations, one for every peer.
109 static struct GNUNET_TESTBED_Operation **connect_ops;
112 * Are we performing a shutdown right now?
114 static int in_shutdown;
118 * Signature of the event handler function called by the
119 * respective event controller.
122 * @param event information about the event
125 controller_cb (void *cls,
126 const struct GNUNET_TESTBED_EventInformation *event)
133 * Callback to be called when a service connect operation is completed
135 * @param cls the callback closure from functions generating an operation
136 * @param op the operation that has been finished
137 * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
138 * @param emsg error message in case the operation has failed; will be NULL if
139 * operation has executed successfully.
142 session_connect_complete (void *cls,
143 struct GNUNET_TESTBED_Operation *op,
150 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
151 "testbed connect emsg: %s\n",
156 num_connected_sessions++;
158 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
159 "dkg: session connect complete\n");
161 if (num_connected_sessions == num_peers)
163 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
164 "dkg: all peers connected\n");
170 * Callback to be called when a service connect operation is completed
172 * @param cls the callback closure from functions generating an operation
173 * @param op the operation that has been finished
174 * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
175 * @param emsg error message in case the operation has failed; will be NULL if
176 * operation has executed successfully.
179 decrypt_connect_complete (void *cls,
180 struct GNUNET_TESTBED_Operation *op,
187 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
188 "testbed connect emsg: %s\n",
193 num_connected_decrypt++;
195 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
196 "decrypt: session connect complete\n");
198 if (num_connected_decrypt == num_peers)
200 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
201 "decrypt: all peers connected\n");
207 * Called when a decryption has succeeded.
209 * @param cls Plaintext
210 * @param plaintext Plaintext
212 static void decrypt_cb (void *cls,
213 const struct GNUNET_SECRETSHARING_Plaintext *plaintext)
215 struct GNUNET_SECRETSHARING_DecryptionHandle **dhp = cls;
216 unsigned int n = dhp - decrypt_handles;
221 // we should still be connected if this is called
222 GNUNET_assert (NULL != connect_ops[n]);
224 GNUNET_TESTBED_operation_done (connect_ops[n]);
226 if (NULL == plaintext)
228 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "decrypt failed for peer %u\n", n);
231 else if (0 == memcmp (&reference_plaintext, plaintext, sizeof (struct GNUNET_SECRETSHARING_Plaintext)))
232 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "decrypt got correct result for peer %u\n", n);
234 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "decrypt got wrong result for peer %u\n", n);
236 if (num_decrypted == num_peers)
238 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "every peer decrypted\n");
239 GNUNET_SCHEDULER_shutdown ();
248 * Adapter function called to establish a connection to
252 * @param cfg configuration of the peer to connect to; will be available until
253 * GNUNET_TESTBED_operation_done() is called on the operation returned
254 * from GNUNET_TESTBED_service_connect()
255 * @return service handle to return in 'op_result', NULL on error
258 decrypt_connect_adapter (void *cls,
259 const struct GNUNET_CONFIGURATION_Handle *cfg)
261 struct GNUNET_SECRETSHARING_DecryptionHandle **hp = cls;
262 unsigned int n = hp - decrypt_handles;
264 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
265 "decrypt connect adapter, %d peers\n",
267 *hp = GNUNET_SECRETSHARING_decrypt (cfg, shares[n], &ciphertext,
268 decrypt_start, decrypt_deadline,
277 * Adapter function called to destroy a connection to
281 * @param op_result service handle returned from the connect adapter
284 decrypt_disconnect_adapter(void *cls, void *op_result)
286 struct GNUNET_SECRETSHARING_DecryptionHandle **dh = cls;
287 unsigned int n = dh - decrypt_handles;
289 GNUNET_assert (*dh == decrypt_handles[n]);
293 GNUNET_SECRETSHARING_decrypt_cancel (*dh);
297 GNUNET_assert (NULL != connect_ops[n]);
298 connect_ops[n] = NULL;
303 secret_ready_cb (void *cls,
304 struct GNUNET_SECRETSHARING_Share *my_share,
305 struct GNUNET_SECRETSHARING_PublicKey *public_key,
306 unsigned int num_ready_peers,
307 const struct GNUNET_PeerIdentity *ready_peers)
309 struct GNUNET_SECRETSHARING_Session **sp = cls;
310 unsigned int n = sp - session_handles;
311 char pubkey_str[1024];
316 shares[n] = my_share;
317 if (NULL == my_share)
319 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "key generation failed for peer #%u\n", n);
323 ret = GNUNET_STRINGS_data_to_string (public_key, sizeof *public_key, pubkey_str, 1024);
324 GNUNET_assert (NULL != ret);
326 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "key generation successful for peer #%u, pubkey %s\n", n,
329 /* we're the first to get the key -> store it */
330 if (num_generated == 1)
332 common_pubkey = *public_key;
334 else if (0 != memcmp (public_key, &common_pubkey, sizeof (struct GNUNET_SECRETSHARING_PublicKey)))
336 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "generated public keys do not match\n");
337 GNUNET_SCHEDULER_shutdown ();
342 // we should still be connected
343 GNUNET_assert (NULL != connect_ops[n]);
345 // disconnect from the service, will call the disconnect callback
346 GNUNET_TESTBED_operation_done (connect_ops[n]);
352 * Adapter function called to establish a connection to
356 * @param cfg configuration of the peer to connect to; will be available until
357 * GNUNET_TESTBED_operation_done() is called on the operation returned
358 * from GNUNET_TESTBED_service_connect()
359 * @return service handle to return in 'op_result', NULL on error
362 session_connect_adapter (void *cls,
363 const struct GNUNET_CONFIGURATION_Handle *cfg)
365 struct GNUNET_SECRETSHARING_Session **sp = cls;
367 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
368 "connect adapter, %d peers\n",
370 *sp = GNUNET_SECRETSHARING_create_session (cfg,
377 &secret_ready_cb, sp);
384 * Adapter function called to destroy a connection to
388 * @param op_result service handle returned from the connect adapter
391 session_disconnect_adapter (void *cls, void *op_result)
393 struct GNUNET_SECRETSHARING_Session **sp = cls;
394 unsigned int n = (sp - session_handles);
396 GNUNET_assert (*sp == session_handles[n]);
400 GNUNET_SECRETSHARING_session_destroy (*sp);
404 GNUNET_assert (NULL != connect_ops[n]);
405 connect_ops[n] = NULL;
407 if (GNUNET_YES == in_shutdown)
410 // all peers received their secret
411 if (num_generated == num_peers)
415 // only do decryption if requested by the user
416 if (GNUNET_NO == decrypt)
418 GNUNET_SCHEDULER_shutdown ();
422 decrypt_start = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (), delay);
423 decrypt_deadline = GNUNET_TIME_absolute_add (decrypt_start, timeout);
425 // compute g^42 as the plaintext which we will decrypt and then
426 // cooperatively decrypt
427 GNUNET_SECRETSHARING_plaintext_generate_i (&reference_plaintext, 42);
428 GNUNET_SECRETSHARING_encrypt (&common_pubkey, &reference_plaintext, &ciphertext);
430 for (i = 0; i < num_peers; i++)
432 GNUNET_TESTBED_service_connect (NULL, peers[i], "secretsharing", &decrypt_connect_complete, NULL,
433 &decrypt_connect_adapter, &decrypt_disconnect_adapter, &decrypt_handles[i]);
439 * Callback to be called when the requested peer information is available
441 * @param cb_cls the closure from GNUNET_TETSBED_peer_get_information()
442 * @param op the operation this callback corresponds to
443 * @param pinfo the result; will be NULL if the operation has failed
444 * @param emsg error message if the operation has failed; will be NULL if the
445 * operation is successfull
448 peer_info_cb (void *cb_cls,
449 struct GNUNET_TESTBED_Operation *op,
450 const struct GNUNET_TESTBED_PeerInformation *pinfo,
453 struct GNUNET_PeerIdentity *p;
456 GNUNET_assert (NULL == emsg);
458 p = (struct GNUNET_PeerIdentity *) cb_cls;
460 if (pinfo->pit == GNUNET_TESTBED_PIT_IDENTITY)
462 *p = *pinfo->result.id;
463 num_retrieved_peer_ids++;
464 if (num_retrieved_peer_ids == num_peers)
465 for (i = 0; i < num_peers; i++)
467 GNUNET_TESTBED_service_connect (NULL, peers[i], "secretsharing", session_connect_complete, NULL,
468 session_connect_adapter, session_disconnect_adapter, &session_handles[i]);
475 GNUNET_TESTBED_operation_done (op);
480 * Signature of the main function of a task.
485 handle_shutdown (void *cls)
487 in_shutdown = GNUNET_YES;
489 if (NULL != connect_ops)
492 for (i = 0; i < num_peers; i++)
493 if (NULL != connect_ops[i])
495 // the disconnect callback will set the op to NULL
496 GNUNET_TESTBED_operation_done (connect_ops[i]);
498 GNUNET_free (connect_ops);
501 // killing the testbed operation will take care of remaining
502 // service handles in the disconnect callback
507 * Signature of a main function for a testcase.
510 * @param h the run handle
511 * @param num_peers number of peers in 'peers'
512 * @param started_peers handle to peers run in the testbed. NULL upon timeout (see
513 * GNUNET_TESTBED_test_run()).
514 * @param links_succeeded the number of overlay link connection attempts that
516 * @param links_failed the number of overlay link connection attempts that
520 test_master (void *cls,
521 struct GNUNET_TESTBED_RunHandle *h,
522 unsigned int num_peers,
523 struct GNUNET_TESTBED_Peer **started_peers,
524 unsigned int links_succeeded,
525 unsigned int links_failed)
529 GNUNET_log_setup ("gnunet-secretsharing-profiler", "INFO", NULL);
531 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "test master\n");
533 GNUNET_SCHEDULER_add_shutdown (&handle_shutdown, NULL);
535 peers = started_peers;
537 peer_ids = GNUNET_malloc (num_peers * sizeof (struct GNUNET_PeerIdentity));
539 session_handles = GNUNET_new_array (num_peers, struct GNUNET_SECRETSHARING_Session *);
540 decrypt_handles = GNUNET_new_array (num_peers, struct GNUNET_SECRETSHARING_DecryptionHandle *);
541 connect_ops = GNUNET_new_array (num_peers, struct GNUNET_TESTBED_Operation *);
542 shares = GNUNET_new_array (num_peers, struct GNUNET_SECRETSHARING_Share *);
544 for (i = 0; i < num_peers; i++)
546 // we do not store the returned operation, as peer_info_cb
547 // will receive it as a parameter and call GNUNET_TESTBED_operation_done.
548 GNUNET_TESTBED_peer_get_information (peers[i],
549 GNUNET_TESTBED_PIT_IDENTITY,
557 run (void *cls, char *const *args, const char *cfgfile,
558 const struct GNUNET_CONFIGURATION_Handle *cfg)
560 static char *session_str = "gnunet-secretsharing/test";
562 int topology_cmp_result;
564 dkg_start = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (), delay);
565 dkg_deadline = GNUNET_TIME_absolute_add (dkg_start, timeout);
567 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "testbed", "OVERLAY_TOPOLOGY", &topology))
570 "'OVERLAY_TOPOLOGY' not found in 'testbed' config section, "
571 "seems like you passed the wrong configuration file\n");
575 topology_cmp_result = strcasecmp (topology, "NONE");
576 GNUNET_free (topology);
578 if (0 == topology_cmp_result)
581 "'OVERLAY_TOPOLOGY' set to 'NONE', "
582 "seems like you passed the wrong configuration file\n");
586 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
587 "running gnunet-secretsharing-profiler\n");
589 GNUNET_CRYPTO_hash (session_str, strlen (session_str), &session_id);
591 (void) GNUNET_TESTBED_test_run ("gnunet-secretsharing-profiler",
603 main (int argc, char **argv)
605 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
606 { 'n', "num-peers", NULL,
607 gettext_noop ("number of peers in consensus"),
608 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_peers },
609 { 'D', "delay", NULL,
610 gettext_noop ("dkg start delay"),
611 GNUNET_YES, &GNUNET_GETOPT_set_relative_time, &delay },
612 { 't', "timeout", NULL,
613 gettext_noop ("dkg timeout"),
614 GNUNET_YES, &GNUNET_GETOPT_set_relative_time, &timeout },
615 { 'k', "threshold", NULL,
616 gettext_noop ("threshold"),
617 GNUNET_YES, &GNUNET_GETOPT_set_uint, &threshold },
618 { 'd', "decrypt", NULL,
619 gettext_noop ("also profile decryption"),
620 GNUNET_NO, &GNUNET_GETOPT_set_one, &decrypt },
621 { 'V', "verbose", NULL,
622 gettext_noop ("be more verbose (print received values)"),
623 GNUNET_NO, &GNUNET_GETOPT_set_one, &verbose },
624 GNUNET_GETOPT_OPTION_END
626 delay = GNUNET_TIME_UNIT_ZERO;
627 timeout = GNUNET_TIME_UNIT_MINUTES;
628 GNUNET_PROGRAM_run2 (argc, argv, "gnunet-secretsharing-profiler",
630 options, &run, NULL, GNUNET_YES);