GNUnet  0.11.x
gnunet-revocation.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2013 GNUnet e.V.
4 
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.
9 
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.
14 
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/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
30 
34 static unsigned int pow_passes = 1;
35 
39 static int ret;
40 
44 static int perform;
45 
49 static char *filename;
50 
54 static char *revoke_ego;
55 
59 static char *test_ego;
60 
64 static unsigned int epochs = 1;
65 
69 static struct GNUNET_REVOCATION_Query *q;
70 
74 static struct GNUNET_REVOCATION_Handle *h;
75 
80 
84 static const struct GNUNET_CONFIGURATION_Handle *cfg;
85 
89 static unsigned long long matching_bits;
90 
95 
100 
105 
111 static void
112 do_shutdown (void *cls)
113 {
114  fprintf (stderr, "%s", _ ("Shutting down...\n"));
115  if (NULL != el)
116  {
118  el = NULL;
119  }
120  if (NULL != q)
121  {
123  q = NULL;
124  }
125  if (NULL != h)
126  {
128  h = NULL;
129  }
130 }
131 
132 
139 static void
140 print_query_result (void *cls, int is_valid)
141 {
142  q = NULL;
143  switch (is_valid)
144  {
145  case GNUNET_YES:
146  fprintf (stdout, _ ("Key `%s' is valid\n"), test_ego);
147  break;
148 
149  case GNUNET_NO:
150  fprintf (stdout, _ ("Key `%s' has been revoked\n"), test_ego);
151  break;
152 
153  case GNUNET_SYSERR:
154  fprintf (stdout, "%s", _ ("Internal error\n"));
155  break;
156 
157  default:
158  GNUNET_break (0);
159  break;
160  }
162 }
163 
164 
171 static void
172 print_revocation_result (void *cls, int is_valid)
173 {
174  h = NULL;
175  switch (is_valid)
176  {
177  case GNUNET_YES:
178  if (NULL != revoke_ego)
179  fprintf (stdout,
180  _ ("Key for ego `%s' is still valid, revocation failed (!)\n"),
181  revoke_ego);
182  else
183  fprintf (stdout, "%s", _ ("Revocation failed (!)\n"));
184  break;
185 
186  case GNUNET_NO:
187  if (NULL != revoke_ego)
188  fprintf (stdout,
189  _ ("Key for ego `%s' has been successfully revoked\n"),
190  revoke_ego);
191  else
192  fprintf (stdout, "%s", _ ("Revocation successful.\n"));
193  break;
194 
195  case GNUNET_SYSERR:
196  fprintf (stdout,
197  "%s",
198  _ ("Internal error, key revocation might have failed\n"));
199  break;
200 
201  default:
202  GNUNET_break (0);
203  break;
204  }
206 }
207 
208 
212 static void
214 {
215  h = GNUNET_REVOCATION_revoke (cfg,
216  &proof_of_work,
218  NULL);
219 }
220 
221 
228 static void
230 {
231  if ((NULL != filename) &&
232  (sizeof(struct GNUNET_REVOCATION_PowP) !=
234  &proof_of_work,
235  sizeof(struct GNUNET_REVOCATION_PowP),
239 }
240 
241 
247 static void
249 {
251  fprintf (stderr, "%s", _ ("Cancelling calculation.\n"));
252  sync_pow ();
253  if (NULL != pow_task)
254  {
255  GNUNET_SCHEDULER_cancel (pow_task);
256  pow_task = NULL;
257  }
258  if (NULL != ph)
260 }
261 
262 
268 static void
269 calculate_pow (void *cls)
270 {
272 
273  /* store temporary results */
274  pow_task = NULL;
275  if (0 == (pow_passes % 128))
276  sync_pow ();
277  /* actually do POW calculation */
279  {
280  if ((NULL != filename) &&
281  (sizeof(struct GNUNET_REVOCATION_PowP) !=
283  &proof_of_work,
284  sizeof(struct GNUNET_REVOCATION_PowP),
288  if (perform)
289  {
291  }
292  else
293  {
294  fprintf (stderr, "%s", "\n");
295  fprintf (stderr,
296  _ ("Revocation certificate for `%s' stored in `%s'\n"),
297  revoke_ego,
298  filename);
300  }
301  return;
302  }
303  pow_passes++;
307  if (0 == pow_passes % 128)
309  &calculate_pow,
310  ph);
311  else
313  &calculate_pow,
314  ph);
315 
316 }
317 
318 
325 static void
326 ego_callback (void *cls, struct GNUNET_IDENTITY_Ego *ego)
327 {
328  struct GNUNET_CRYPTO_EcdsaPublicKey key;
329  const struct GNUNET_CRYPTO_EcdsaPrivateKey *privkey;
331 
332  el = NULL;
333  if (NULL == ego)
334  {
335  fprintf (stdout, _ ("Ego `%s' not found.\n"), revoke_ego);
337  return;
338  }
340  privkey = GNUNET_IDENTITY_ego_get_private_key (ego);
341  memset (&proof_of_work, 0, sizeof (proof_of_work));
342  if ((NULL != filename) && (GNUNET_YES == GNUNET_DISK_file_test (filename)) &&
343  (sizeof(proof_of_work) ==
345  {
346  if (0 != GNUNET_memcmp (&proof_of_work.key, &key))
347  {
348  fprintf (stderr,
349  _ ("Error: revocation certificate in `%s' is not for `%s'\n"),
350  filename,
351  revoke_ego);
352  return;
353  }
354  if (GNUNET_YES ==
356  (unsigned int) matching_bits,
358  {
359  fprintf (stderr, "%s", _ ("Revocation certificate ready\n"));
360  if (perform)
362  else
364  return;
365  }
369  fprintf (stderr,
370  "%s",
371  _ ("Continuing calculation where left off...\n"));
373  epochs,
374  matching_bits);
375  }
376  fprintf (stderr,
377  "%s",
378  _ ("Revocation certificate not ready, calculating proof of work\n"));
379  if (NULL == ph)
380  {
382  &proof_of_work);
384  epochs, /* Epochs */
385  matching_bits);
386  }
387  pow_task = GNUNET_SCHEDULER_add_now (&calculate_pow, ph);
389 }
390 
391 
400 static void
401 run (void *cls,
402  char *const *args,
403  const char *cfgfile,
404  const struct GNUNET_CONFIGURATION_Handle *c)
405 {
407 
408  cfg = c;
409  if (NULL != test_ego)
410  {
411  if (GNUNET_OK !=
413  strlen (test_ego),
414  &pk))
415  {
416  fprintf (stderr, _ ("Public key `%s' malformed\n"), test_ego);
417  return;
418  }
420  q = GNUNET_REVOCATION_query (cfg, &pk, &print_query_result, NULL);
421  if (NULL != revoke_ego)
422  fprintf (
423  stderr,
424  "%s",
425  _ (
426  "Testing and revoking at the same time is not allowed, only executing test.\n"));
427  return;
428  }
430  "REVOCATION",
431  "WORKBITS",
432  &matching_bits))
433  {
435  "REVOCATION",
436  "WORKBITS");
437  return;
438  }
440  "REVOCATION",
441  "EPOCH_DURATION",
442  &epoch_duration))
443  {
445  "REVOCATION",
446  "EPOCH_DURATION");
447  return;
448  }
449 
450  if (NULL != revoke_ego)
451  {
452  if (! perform && (NULL == filename))
453  {
454  fprintf (stderr,
455  "%s",
456  _ ("No filename to store revocation certificate given.\n"));
457  return;
458  }
459  /* main code here */
462  return;
463  }
464  if ((NULL != filename) && (perform))
465  {
467  &proof_of_work,
468  sizeof(proof_of_work)))
469  {
470  fprintf (stderr,
471  _ ("Failed to read revocation certificate from `%s'\n"),
472  filename);
473  return;
474  }
476  if (GNUNET_YES !=
478  (unsigned int) matching_bits,
480  {
483  epochs, /* Epochs */
484  matching_bits);
485 
486  pow_task = GNUNET_SCHEDULER_add_now (&calculate_pow, ph);
488  return;
489  }
491  return;
492  }
493  fprintf (stderr, "%s", _ ("No action specified. Nothing to do.\n"));
494 }
495 
496 
504 int
505 main (int argc, char *const *argv)
506 {
507  struct GNUNET_GETOPT_CommandLineOption options[] = {
509  "filename",
510  "NAME",
511  gettext_noop (
512  "use NAME for the name of the revocation file"),
513  &filename),
514 
516  'R',
517  "revoke",
518  "NAME",
519  gettext_noop (
520  "revoke the private key associated for the the private key associated with the ego NAME "),
521  &revoke_ego),
522 
524  'p',
525  "perform",
526  gettext_noop (
527  "actually perform revocation, otherwise we just do the precomputation"),
528  &perform),
529 
531  "test",
532  "KEY",
533  gettext_noop (
534  "test if the public key KEY has been revoked"),
535  &test_ego),
537  "epochs",
538  "EPOCHS",
539  gettext_noop (
540  "number of epochs to calculate for"),
541  &epochs),
542 
544  };
545 
546  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
547  return 2;
548 
549  ret = (GNUNET_OK == GNUNET_PROGRAM_run (argc,
550  argv,
551  "gnunet-revocation",
552  gettext_noop ("help text"),
553  options,
554  &run,
555  NULL))
556  ? ret
557  : 1;
558  GNUNET_free_nz ((void *) argv);
559  return ret;
560 }
561 
562 
563 /* end of gnunet-revocation.c */
int GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory)...
Definition: disk.c:544
void GNUNET_REVOCATION_pow_init(const struct GNUNET_CRYPTO_EcdsaPrivateKey *key, struct GNUNET_REVOCATION_PowP *pow)
Initializes a fresh PoW computation.
static unsigned int epochs
-e option.
static struct GNUNET_IDENTITY_EgoLookup * el
Handle for our ego lookup.
void GNUNET_REVOCATION_query_cancel(struct GNUNET_REVOCATION_Query *q)
Cancel key revocation check.
int GNUNET_CONFIGURATION_get_value_time(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, struct GNUNET_TIME_Relative *time)
Get a configuration value that should be a relative time.
void GNUNET_IDENTITY_ego_lookup_cancel(struct GNUNET_IDENTITY_EgoLookup *el)
Abort ego lookup attempt.
Handle for ego lookup.
int GNUNET_CONFIGURATION_get_value_number(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number)
Get a configuration value that should be a number.
static struct GNUNET_REVOCATION_PowP proof_of_work
Proof-of-work object.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
struct GNUNET_CRYPTO_EcdsaPublicKey key
The revoked public key.
enum GNUNET_GenericReturnValue GNUNET_REVOCATION_pow_round(struct GNUNET_REVOCATION_PowCalculationHandle *pc)
Calculate a single round in the key revocation PoW.
static char * filename
-f option.
static int ret
Final status code.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received, or when GNUNET_SCHEDULER_shutdown() is being invoked.
Definition: scheduler.c:1331
int GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1458
Struct for a proof of work as part of the revocation.
static struct GNUNET_ATS_PerformanceHandle * ph
ATS performance handle used.
Definition: gnunet-ats.c:116
const struct GNUNET_CRYPTO_EcdsaPrivateKey * GNUNET_IDENTITY_ego_get_private_key(const struct GNUNET_IDENTITY_Ego *ego)
Obtain the ECC key associated with a ego.
Definition: identity_api.c:595
int main(int argc, char *const *argv)
The main function of gnunet-revocation.
Definition of a command line option.
Private ECC key encoded for transmission.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:531
static void print_query_result(void *cls, int is_valid)
Print the result from a revocation query.
static struct GNUNET_SCHEDULER_Task * pow_task
Task used for proof-of-work calculation.
static void perform_revocation()
Perform the revocation.
void GNUNET_REVOCATION_pow_stop(struct GNUNET_REVOCATION_PowCalculationHandle *pc)
Stop a PoW calculation.
ssize_t GNUNET_DISK_fn_write(const char *fn, const void *buffer, size_t n, enum GNUNET_DISK_AccessPermissions mode)
Write a buffer to a file.
Definition: disk.c:879
static void run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
Main function that will be run by the scheduler.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_string(char shortName, const char *name, const char *argumentHelp, const char *description, char **str)
Allow user to specify a string.
#define _(String)
GNU gettext support macro.
Definition: platform.h:184
static struct GNUNET_TIME_Relative epoch_duration
Epoch length.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1269
Handle for an ego.
Definition: identity.h:245
void GNUNET_log_config_missing(enum GNUNET_ErrorType kind, const char *section, const char *option)
Log error message about missing configuration option.
static void calculate_pow_shutdown(void *cls)
Perform the proof-of-work calculation.
static struct GNUNET_REVOCATION_Handle * h
Handle for revocation.
static void calculate_pow(void *cls)
Perform the proof-of-work calculation.
#define GNUNET_log_strerror_file(level, cmd, filename)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; with the mess...
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1296
static void sync_pow()
Write the current state of the revocation data to disk.
static void ego_callback(void *cls, struct GNUNET_IDENTITY_Ego *ego)
Function called with the result from the ego lookup.
static int perform
Was "-p" specified?
#define GNUNET_TIME_UNIT_MILLISECONDS
One millisecond.
static void do_shutdown(void *cls)
Function run if the user aborts with CTRL-C.
static struct GNUNET_REVOCATION_Query * q
Handle for revocation query.
#define GNUNET_free_nz(ptr)
Wrapper around free.
static char * test_ego
-t option.
static unsigned int pow_passes
Pow passes.
struct GNUNET_REVOCATION_PowCalculationHandle * GNUNET_REVOCATION_pow_start(struct GNUNET_REVOCATION_PowP *pow, int epochs, unsigned int difficulty)
Starts a proof-of-work calculation given the pow object as well as target epochs and difficulty...
Handle for the key revocation query.
#define GNUNET_memcmp(a, b)
Compare memory in a and b, where both must be of the same pointer type.
struct GNUNET_REVOCATION_Handle * GNUNET_REVOCATION_revoke(const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_REVOCATION_PowP *pow, GNUNET_REVOCATION_Callback func, void *func_cls)
Perform key revocation.
struct GNUNET_IDENTITY_EgoLookup * GNUNET_IDENTITY_ego_lookup(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *name, GNUNET_IDENTITY_EgoCallback cb, void *cb_cls)
Lookup an ego by name.
int GNUNET_CRYPTO_ecdsa_public_key_from_string(const char *enc, size_t enclen, struct GNUNET_CRYPTO_EcdsaPublicKey *pub)
Convert a string representing a public key to a public key.
Definition: crypto_ecc.c:366
static char * revoke_ego
-R option
configuration data
Definition: configuration.c:84
static void print_revocation_result(void *cls, int is_valid)
Print the result from a revocation request.
Public ECC key (always for Curve25519) encoded in a format suitable for network transmission and ECDS...
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_flag(char shortName, const char *name, const char *description, int *val)
Allow user to specify a flag (which internally means setting an integer to 1/GNUNET_YES/GNUNET_OK.
Entry in list of pending tasks.
Definition: scheduler.c:134
struct GNUNET_REVOCATION_Query * GNUNET_REVOCATION_query(const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_CRYPTO_EcdsaPublicKey *key, GNUNET_REVOCATION_Callback func, void *func_cls)
Check if a key was revoked.
Handle for the key revocation operation.
int GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration, parse options).
Definition: program.c:367
The handle to a PoW calculation.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_uint(char shortName, const char *name, const char *argumentHelp, const char *description, unsigned int *val)
Allow user to specify an unsigned int.
void GNUNET_REVOCATION_revoke_cancel(struct GNUNET_REVOCATION_Handle *h)
Cancel key revocation.
static unsigned long long matching_bits
Number of matching bits required for revocation.
void GNUNET_IDENTITY_ego_get_public_key(struct GNUNET_IDENTITY_Ego *ego, struct GNUNET_CRYPTO_EcdsaPublicKey *pk)
Get the identifier (public key) of an ego.
Definition: identity_api.c:608
ssize_t GNUNET_DISK_fn_read(const char *fn, void *result, size_t len)
Read the contents of a binary file into a buffer.
Definition: disk.c:794
Time for relative time used by GNUnet, in microseconds.
enum GNUNET_GenericReturnValue GNUNET_REVOCATION_check_pow(const struct GNUNET_REVOCATION_PowP *pow, unsigned int matching_bits, struct GNUNET_TIME_Relative epoch_duration)
Check if the given proof-of-work is valid.
#define gettext_noop(String)
Definition: gettext.h:69
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:972