2 This file is part of GNUnet.
3 Copyright (C) 2013 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-revocation.c
23 * @brief tool for revoking public keys
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_revocation_service.h"
29 #include "gnunet_identity_service.h"
45 static char *filename;
50 static char *revoke_ego;
55 static char *test_ego;
58 * Handle for revocation query.
60 static struct GNUNET_REVOCATION_Query *q;
63 * Handle for revocation.
65 static struct GNUNET_REVOCATION_Handle *h;
68 * Handle for our ego lookup.
70 static struct GNUNET_IDENTITY_EgoLookup *el;
75 static const struct GNUNET_CONFIGURATION_Handle *cfg;
78 * Number of matching bits required for revocation.
80 static unsigned long long matching_bits;
83 * Task used for proof-of-work calculation.
85 static struct GNUNET_SCHEDULER_Task *pow_task;
89 * Function run if the user aborts with CTRL-C.
94 do_shutdown(void *cls)
98 GNUNET_IDENTITY_ego_lookup_cancel(el);
103 GNUNET_REVOCATION_query_cancel(q);
108 GNUNET_REVOCATION_revoke_cancel(h);
115 * Print the result from a revocation query.
118 * @param is_valid #GNUNET_YES if the key is still valid, #GNUNET_NO if not, #GNUNET_SYSERR on error
121 print_query_result(void *cls, int is_valid)
127 fprintf(stdout, _("Key `%s' is valid\n"), test_ego);
131 fprintf(stdout, _("Key `%s' has been revoked\n"), test_ego);
135 fprintf(stdout, "%s", _("Internal error\n"));
142 GNUNET_SCHEDULER_shutdown();
147 * Print the result from a revocation request.
150 * @param is_valid #GNUNET_YES if the key is still valid, #GNUNET_NO if not, #GNUNET_SYSERR on error
153 print_revocation_result(void *cls, int is_valid)
159 if (NULL != revoke_ego)
161 _("Key for ego `%s' is still valid, revocation failed (!)\n"),
164 fprintf(stdout, "%s", _("Revocation failed (!)\n"));
168 if (NULL != revoke_ego)
170 _("Key for ego `%s' has been successfully revoked\n"),
173 fprintf(stdout, "%s", _("Revocation successful.\n"));
179 _("Internal error, key revocation might have failed\n"));
186 GNUNET_SCHEDULER_shutdown();
191 * Data needed to perform a revocation.
193 struct RevocationData {
197 struct GNUNET_CRYPTO_EcdsaPublicKey key;
200 * Revocation signature data.
202 struct GNUNET_CRYPTO_EcdsaSignature sig;
205 * Proof of work (in NBO).
207 uint64_t pow GNUNET_PACKED;
212 * Perform the revocation.
215 perform_revocation(const struct RevocationData *rd)
217 h = GNUNET_REVOCATION_revoke(cfg,
221 &print_revocation_result,
227 * Write the current state of the revocation data
230 * @param rd data to sync
233 sync_rd(const struct RevocationData *rd)
235 if ((NULL != filename) &&
236 (sizeof(struct RevocationData) ==
237 GNUNET_DISK_fn_write(filename,
240 GNUNET_DISK_PERM_USER_READ |
241 GNUNET_DISK_PERM_USER_WRITE)))
242 GNUNET_log_strerror_file(GNUNET_ERROR_TYPE_ERROR, "write", filename);
247 * Perform the proof-of-work calculation.
249 * @param cls the `struct RevocationData`
252 calculate_pow_shutdown(void *cls)
254 struct RevocationData *rd = cls;
256 if (NULL != pow_task)
258 GNUNET_SCHEDULER_cancel(pow_task);
267 * Perform the proof-of-work calculation.
269 * @param cls the `struct RevocationData`
272 calculate_pow(void *cls)
274 struct RevocationData *rd = cls;
276 /* store temporary results */
278 if (0 == (rd->pow % 128))
280 /* display progress estimate */
281 if ((0 == ((1 << matching_bits) / 100 / 50)) ||
282 (0 == (rd->pow % ((1 << matching_bits) / 100 / 50))))
283 fprintf(stderr, "%s", ".");
284 if ((0 != rd->pow) && ((0 == ((1 << matching_bits) / 100)) ||
285 (0 == (rd->pow % ((1 << matching_bits) / 100)))))
287 " - @ %3u%% (estimate)\n",
288 (unsigned int)(rd->pow * 100) / (1 << matching_bits));
289 /* actually do POW calculation */
291 if (GNUNET_OK == GNUNET_REVOCATION_check_pow(&rd->key,
293 (unsigned int)matching_bits))
295 if ((NULL != filename) &&
296 (sizeof(struct RevocationData) !=
297 GNUNET_DISK_fn_write(filename,
299 sizeof(struct RevocationData),
300 GNUNET_DISK_PERM_USER_READ |
301 GNUNET_DISK_PERM_USER_WRITE)))
302 GNUNET_log_strerror_file(GNUNET_ERROR_TYPE_ERROR, "write", filename);
305 perform_revocation(rd);
309 fprintf(stderr, "%s", "\n");
311 _("Revocation certificate for `%s' stored in `%s'\n"),
314 GNUNET_SCHEDULER_shutdown();
318 pow_task = GNUNET_SCHEDULER_add_now(&calculate_pow, rd);
323 * Function called with the result from the ego lookup.
326 * @param ego the ego, NULL if not found
329 ego_callback(void *cls, const struct GNUNET_IDENTITY_Ego *ego)
331 struct RevocationData *rd;
332 struct GNUNET_CRYPTO_EcdsaPublicKey key;
337 fprintf(stdout, _("Ego `%s' not found.\n"), revoke_ego);
338 GNUNET_SCHEDULER_shutdown();
341 GNUNET_IDENTITY_ego_get_public_key(ego, &key);
342 rd = GNUNET_new(struct RevocationData);
343 if ((NULL != filename) && (GNUNET_YES == GNUNET_DISK_file_test(filename)) &&
344 (sizeof(struct RevocationData) ==
345 GNUNET_DISK_fn_read(filename, rd, sizeof(struct RevocationData))))
347 if (0 != GNUNET_memcmp(&rd->key, &key))
350 _("Error: revocation certificate in `%s' is not for `%s'\n"),
359 GNUNET_REVOCATION_sign_revocation(GNUNET_IDENTITY_ego_get_private_key(
365 GNUNET_REVOCATION_check_pow(&key, rd->pow, (unsigned int)matching_bits))
367 fprintf(stderr, "%s", _("Revocation certificate ready\n"));
369 perform_revocation(rd);
371 GNUNET_SCHEDULER_shutdown();
377 _("Revocation certificate not ready, calculating proof of work\n"));
378 pow_task = GNUNET_SCHEDULER_add_now(&calculate_pow, rd);
379 GNUNET_SCHEDULER_add_shutdown(&calculate_pow_shutdown, rd);
384 * Main function that will be run by the scheduler.
387 * @param args remaining command-line arguments
388 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
389 * @param c configuration
395 const struct GNUNET_CONFIGURATION_Handle *c)
397 struct GNUNET_CRYPTO_EcdsaPublicKey pk;
398 struct RevocationData rd;
401 if (NULL != test_ego)
404 GNUNET_CRYPTO_ecdsa_public_key_from_string(test_ego,
408 fprintf(stderr, _("Public key `%s' malformed\n"), test_ego);
411 GNUNET_SCHEDULER_add_shutdown(&do_shutdown, NULL);
412 q = GNUNET_REVOCATION_query(cfg, &pk, &print_query_result, NULL);
413 if (NULL != revoke_ego)
418 "Testing and revoking at the same time is not allowed, only executing test.\n"));
421 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number(cfg,
426 GNUNET_log_config_missing(GNUNET_ERROR_TYPE_ERROR,
431 if (NULL != revoke_ego)
433 if (!perform && (NULL == filename))
437 _("No filename to store revocation certificate given.\n"));
441 el = GNUNET_IDENTITY_ego_lookup(cfg, revoke_ego, &ego_callback, NULL);
442 GNUNET_SCHEDULER_add_shutdown(&do_shutdown, NULL);
445 if ((NULL != filename) && (perform))
447 if (sizeof(rd) != GNUNET_DISK_fn_read(filename, &rd, sizeof(rd)))
450 _("Failed to read revocation certificate from `%s'\n"),
454 GNUNET_SCHEDULER_add_shutdown(&do_shutdown, NULL);
456 GNUNET_REVOCATION_check_pow(&rd.key,
458 (unsigned int)matching_bits))
460 struct RevocationData *cp = GNUNET_new(struct RevocationData);
463 pow_task = GNUNET_SCHEDULER_add_now(&calculate_pow, cp);
464 GNUNET_SCHEDULER_add_shutdown(&calculate_pow_shutdown, cp);
467 perform_revocation(&rd);
470 fprintf(stderr, "%s", _("No action specified. Nothing to do.\n"));
475 * The main function of gnunet-revocation.
477 * @param argc number of arguments from the command line
478 * @param argv command line arguments
479 * @return 0 ok, 1 on error
482 main(int argc, char *const *argv)
484 struct GNUNET_GETOPT_CommandLineOption options[] = {
485 GNUNET_GETOPT_option_string('f',
489 "use NAME for the name of the revocation file"),
492 GNUNET_GETOPT_option_string(
497 "revoke the private key associated for the the private key associated with the ego NAME "),
500 GNUNET_GETOPT_option_flag(
504 "actually perform revocation, otherwise we just do the precomputation"),
507 GNUNET_GETOPT_option_string('t',
511 "test if the public key KEY has been revoked"),
514 GNUNET_GETOPT_OPTION_END
517 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args(argc, argv, &argc, &argv))
520 ret = (GNUNET_OK == GNUNET_PROGRAM_run(argc,
523 gettext_noop("help text"),
529 GNUNET_free((void *)argv);
533 /* end of gnunet-revocation.c */