aboutsummaryrefslogtreecommitdiff
path: root/src/escrow/gnunet-escrow.c
blob: 9fa219d2febc51d9fee7503e8d5152bebd1d4598 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
/*
   This file is part of GNUnet.
   Copyright (C) 2020 GNUnet e.V.

   GNUnet is free software: you can redistribute it and/or modify it
   under the terms of the GNU Affero General Public License as published
   by the Free Software Foundation, either version 3 of the License,
   or (at your option) any later version.

   GNUnet is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

     SPDX-License-Identifier: AGPL3.0-or-later
 */
/**
 * @author Johannes Späth
 * @file src/escrow/gnunet-escrow.c
 * @brief Identity Escrow utility
 *
 */

#include "platform.h"

#include "gnunet_util_lib.h"
#include "gnunet_escrow_lib.h"
#include "../identity/identity.h"

/**
 * return value
 */
static int ret;

/**
 * -P option
 */
static char *put_ego;

/**
 * -V option
 */
static char *verify_ego;

/**
 * -G option
 */
static int get_flag;

/**
 * -S option
 */
static char *status_ego;

/**
 * The ego
 */
struct GNUNET_IDENTITY_Ego *ego;

/**
 * User secret string
 */
static char *user_secret_string;

/**
 * Anchor string
 */
static char *anchor_string;

/**
 * The escrow anchor
 */
struct GNUNET_ESCROW_Anchor *anchor;

/**
 * Plugin name
 */
static char *method_name;

/**
 * Escrow method
 */
enum GNUNET_ESCROW_Key_Escrow_Method method;

/**
 * Handle to the escrow component
 */
static struct GNUNET_ESCROW_Handle *escrow_handle;

/**
 * Escrow operation
 */
static struct GNUNET_ESCROW_Operation *escrow_op;

/**
 * Escrow status
 */
static struct GNUNET_ESCROW_Status *escrow_status;

/**
 * Handle to the identity service
 */
static struct GNUNET_IDENTITY_Handle *identity_handle;

/**
 * Cleanup task
 */
static struct GNUNET_SCHEDULER_Task *cleanup_task;


/**
 * Called to clean up the escrow component
 */
static void
do_cleanup (void *cls)
{
  cleanup_task = NULL;
  if (NULL != escrow_op)
  {
    GNUNET_ESCROW_cancel (escrow_op);
    escrow_op = NULL;
  }
  if (NULL != escrow_handle)
    GNUNET_ESCROW_fini (escrow_handle);
  if (NULL != identity_handle)
    GNUNET_IDENTITY_disconnect (identity_handle);
  if (NULL != method_name)
  {
    GNUNET_free (method_name);
    method_name = NULL;
  }
  if (NULL != user_secret_string)
  {
    GNUNET_free (user_secret_string);
    user_secret_string = NULL;
  }
  if (NULL != anchor_string)
  {
    GNUNET_free (anchor_string);
    anchor_string = NULL;
  }
  if (NULL != anchor)
  {
    GNUNET_free (anchor);
    anchor = NULL;
  }
  if (NULL != put_ego)
  {
    GNUNET_free (put_ego);
    put_ego = NULL;
  }
  if (NULL != verify_ego)
  {
    GNUNET_free (verify_ego);
    verify_ego = NULL;
  }
  if (NULL != status_ego)
  {
    GNUNET_free (status_ego);
    status_ego = NULL;
  }
  if (NULL != escrow_status)
  {
    GNUNET_free (escrow_status);
    escrow_status = NULL;
  }
  if (NULL != ego)
  {
    /* does not have to be freed, as this is done when
       cleaning up the ego list in the plugin */
    ego = NULL;
  }
  method = -1;
}


static void
put_cb (void *cls,
        struct GNUNET_ESCROW_Anchor *anchor,
        const char *emsg)
{
  char *anchorString;

  escrow_op = NULL;

  if (NULL == anchor)
  {
    ret = 1;
    if (NULL != emsg)
      fprintf (stderr, "Escrow failed: %s", emsg);
  }
  else
  {
    anchorString = GNUNET_ESCROW_anchor_data_to_string (anchor);

    fprintf (stdout, "Escrow finished! Please keep the following anchor "
             "in order to restore the key later!\n%s\n", anchorString);
  }
  cleanup_task = GNUNET_SCHEDULER_add_now (&do_cleanup, NULL);
  GNUNET_free (anchor);
}


static void
verify_cb (void *cls,
           int verificationResult,
           const char *emsg)
{
  escrow_op = NULL;

  switch (verificationResult)
  {
    case GNUNET_ESCROW_VALID:
      fprintf (stdout, "Escrow is valid!\n");
      break;
    case GNUNET_ESCROW_SHARES_MISSING:
      fprintf (stdout, "Escrow can be restored, but some shares are missing! "
               "Please perform a new escrow.\n");
      break;
    case GNUNET_ESCROW_INVALID:
      ret = 2;
      fprintf (stdout, "Escrow is INvalid! Please perform a new escrow.\n");
      break;
    default:
      ret = 1;
      if (NULL != emsg)
        fprintf (stderr, "invalid verificationResult: %s", emsg);
  }
  cleanup_task = GNUNET_SCHEDULER_add_now (&do_cleanup, NULL);
}


static void
get_cb (void *cls,
        const struct GNUNET_IDENTITY_Ego *ego,
        const char *emsg)
{
  escrow_op = NULL;

  if (NULL == ego)
  {
    ret = 1;
    if (NULL != emsg)
      fprintf (stderr, "Escrow failed: %s", emsg);
  }
  else
    fprintf (stdout, "Identity %s could successfully be restored!\n", ego->name);
  cleanup_task = GNUNET_SCHEDULER_add_now (&do_cleanup, NULL);
}


static void
start_process ()
{
  /* put */
  if (NULL != put_ego)
  {
    if (NULL == ego)
    {
      ret = 1;
      fprintf (stderr, "Ego %s not found\n", put_ego);
      cleanup_task = GNUNET_SCHEDULER_add_now (&do_cleanup, NULL);
      return;
    }
    escrow_op = GNUNET_ESCROW_put (escrow_handle,
                                   ego,
                                   user_secret_string,
                                   method,
                                   &put_cb,
                                   NULL);
    return;
  }
  /* verify */
  if (NULL != verify_ego)
  {
    if (NULL == ego)
    {
      ret = 1;
      fprintf (stderr, "Ego %s not found\n", verify_ego);
      cleanup_task = GNUNET_SCHEDULER_add_now (&do_cleanup, NULL);
      return;
    }
    escrow_op = GNUNET_ESCROW_verify (escrow_handle,
                                      ego,
                                      anchor,
                                      method,
                                      &verify_cb,
                                      NULL);
    return;
  }
  /* get */
  if (GNUNET_YES == get_flag)
  {
    escrow_op = GNUNET_ESCROW_get (escrow_handle,
                                   anchor,
                                   &get_cb,
                                   NULL);
    return;
  }
  /* status */
  if (NULL != status_ego)
  {
    if (NULL == ego)
    {
      ret = 1;
      fprintf (stderr, "Ego %s not found\n", status_ego);
      cleanup_task = GNUNET_SCHEDULER_add_now (&do_cleanup, NULL);
      return;
    }
    escrow_status = GNUNET_ESCROW_get_status (escrow_handle,
                                              ego,
                                              method);

    if (GNUNET_ESCROW_KEY_NONE == escrow_status->last_method)
      fprintf (stdout, "No escrow has been performed for identity %s!\n", ego->name);
    else
    {
      fprintf (stdout, "Escrow STATUS information for identity %s\n", ego->name);
      fprintf (stdout, "=======================================================\n");
      if (0 == escrow_status->last_successful_verification_time.abs_value_us)
        fprintf (stdout, "No successful verification! Please VERIFY now.\n");
      else
      {
        fprintf (stdout, "Last successful verification:\t%s\n",
                 GNUNET_STRINGS_absolute_time_to_string (escrow_status->last_successful_verification_time));
        fprintf (stdout, "Next recommended verification:\t%s\n",
                 GNUNET_STRINGS_absolute_time_to_string (escrow_status->next_recommended_verification_time));
      }
      fprintf (stdout, "Last method:\t\t\t%s\n",
               GNUNET_ESCROW_method_number_to_string (escrow_status->last_method));
    }

    cleanup_task = GNUNET_SCHEDULER_add_now (&do_cleanup, NULL);
    return;
  }
}


static int init = GNUNET_YES;

static void
ego_cb (void *cls,
        struct GNUNET_IDENTITY_Ego *e,
        void **ctx,
        const char *name)
{
  char *ego_name = cls;

  if (NULL == name)
  {
    if (GNUNET_YES == init)
    {
      init = GNUNET_NO;
      start_process ();
    }
    return;
  }
  if (NULL != ego_name && 0 != strcmp (name, ego_name))
    return;
  ego = e;
}


static void
run (void *cls,
     char *const *args,
     const char *cfgfile,
     const struct GNUNET_CONFIGURATION_Handle *c)
{
  char *ego_name;

  ret = 0;

  /* check if method is set (needed for all operations except GET) */
  if (NULL == method_name && GNUNET_YES != get_flag)
  {
    ret = 1;
    fprintf (stderr, _ ("Escrow method (-m option) is missing\n"));
    return;
  }

  if (NULL != put_ego)
  {
    if (NULL != verify_ego || GNUNET_YES == get_flag || NULL != status_ego)
    {
      ret = 1;
      fprintf (stderr, _ ("-P may only be used without -V, -G or -S!\n"));
      return;
    }
    /* put */
    ego_name = put_ego;
  }
  else if (NULL != verify_ego)
  {
    if (GNUNET_YES == get_flag || NULL != status_ego)
    {
      ret = 1;
      fprintf (stderr, _ ("-V may only be used without -P, -G or -S!\n"));
      return;
    }
    /* verify */
    if (NULL == anchor_string)
    {
      ret = 1;
      fprintf (stderr, _ ("-a is needed for -V!\n"));
      return;
    }
    ego_name = verify_ego;
  }
  else if (GNUNET_YES == get_flag)
  {
    if (NULL != status_ego)
    {
      ret = 1;
      fprintf (stderr, _ ("-G may only be used without -P, -V or -S!\n"));
      return;
    }
    /* get */
    if (NULL == anchor_string)
    {
      ret = 1;
      fprintf (stderr, _ ("-a is needed for -G!\n"));
      return;
    }
    ego_name = NULL;
  }
  else if (NULL != status_ego)
  {
    /* status */
    ego_name = status_ego;
  }
  else
  {
    /* nothing */
    ret = 1;
    fprintf (stderr, _ ("-P, -V, -G or -S option must be specified!\n"));
    return;
  }

  /* determine method */
  if (NULL != method_name)
  {
    method = GNUNET_ESCROW_method_string_to_number (method_name);
    if (GNUNET_ESCROW_KEY_NONE == method)
    {
      ret = 1;
      fprintf (stderr, _ ("unknown method name!\n"));
      return;
    }
  }
  else // initialize to error value (should not be used in this case)
    method = GNUNET_ESCROW_KEY_NONE;

  escrow_handle = GNUNET_ESCROW_init (c);
  
  if (NULL != anchor_string)
  {
    /* parse anchor_string according to method */
    anchor = GNUNET_ESCROW_anchor_string_to_data (anchor_string);
    if (NULL == anchor)
    {
      ret = 1;
      fprintf (stderr, _ ("failed to parse anchor string!\n"));
      cleanup_task = GNUNET_SCHEDULER_add_now (&do_cleanup, NULL);
      return;
    }
  }

  /* connect to identity service in order to get the egos */
  identity_handle = GNUNET_IDENTITY_connect (c, &ego_cb, ego_name);
}


int
main (int argc, char *const argv[])
{
  struct GNUNET_GETOPT_CommandLineOption options[] = {
    GNUNET_GETOPT_option_string ('P',
                                 "put",
                                 "NAME",
                                 gettext_noop ("Put the ego NAME in escrow"),
                                 &put_ego),
    GNUNET_GETOPT_option_string ('V',
                                 "verify",
                                 "NAME",
                                 gettext_noop ("Verify the escrow of the ego NAME"),
                                 &verify_ego),
    GNUNET_GETOPT_option_flag ('G',
                               "get",
                               gettext_noop ("Get an ego back from escrow"),
                               &get_flag),
    GNUNET_GETOPT_option_string ('S',
                                 "status",
                                 "NAME",
                                 gettext_noop ("Get the status of the escrow of ego NAME"),
                                 &status_ego),
    GNUNET_GETOPT_option_string ('u',
                                 "userSecret",
                                 "USER_SECRET",
                                 gettext_noop ("The user secret string"),
                                 &user_secret_string),
    GNUNET_GETOPT_option_string ('a',
                                 "anchor",
                                 "ANCHOR",
                                 gettext_noop ("The escrow anchor"),
                                 &anchor_string),
    GNUNET_GETOPT_option_string ('m',
                                 "method",
                                 "METHOD",
                                 gettext_noop ("The escrow method (and plugin) to use"),
                                 &method_name),
    GNUNET_GETOPT_OPTION_END
  };
  if (GNUNET_OK != GNUNET_PROGRAM_run (argc,
                                       argv,
                                       "gnunet-escrow",
                                       _ ("escrow command line tool"),
                                       options,
                                       &run,
                                       NULL))
    return 1;
  else
    return ret;
}