summaryrefslogtreecommitdiff
path: root/src/escrow/escrow_plugin_helper.c
blob: ca45b68371b606613ad87e19f5d8cdb3a0310d97 (plain)
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
/*
   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 escrow/escrow_plugin.c
 * 
 * @brief helper functions for escrow plugins
 */

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_identity_service.h"
#include "gnunet_escrow_plugin.h"


/**
 * Maintains the ego list for an escrow plugin.
 * This function is an implementation of GNUNET_IDENTITY_Callback.
 *
 * It is initially called for all egos and then again
 * whenever a ego's identifier changes or if it is deleted.  At the
 * end of the initial pass over all egos, the function is once called
 * with 'NULL' for 'ego'. That does NOT mean that the callback won't
 * be invoked in the future or that there was an error.
 *
 * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get',
 * this function is only called ONCE, and 'NULL' being passed in
 * 'ego' does indicate an error (i.e. name is taken or no default
 * value is known).  If 'ego' is non-NULL and if '*ctx'
 * is set in those callbacks, the value WILL be passed to a subsequent
 * call to the identity callback of 'GNUNET_IDENTITY_connect' (if
 * that one was not NULL).
 *
 * When an identity is renamed, this function is called with the
 * (known) ego but the NEW identifier.
 *
 * When an identity is deleted, this function is called with the
 * (known) ego and "NULL" for the 'identifier'.  In this case,
 * the 'ego' is henceforth invalid (and the 'ctx' should also be
 * cleaned up).
 *
 * @param cls plugin handle
 * @param ego ego handle
 * @param ctx context for application to store data for this ego
 *                 (during the lifetime of this process, initially NULL)
 * @param identifier identifier assigned by the user for this ego,
 *                   NULL if the user just deleted the ego and it
 *                   must thus no longer be used
 */
void
ESCROW_list_ego (void *cls,
                 struct GNUNET_IDENTITY_Ego *ego,
                 void **ctx,
                 const char *identifier)
{
  struct ESCROW_PluginHandle *ph = cls;
  struct EgoEntry *ego_entry;
  struct GNUNET_CRYPTO_EcdsaPublicKey pk;

  /* don't add/change/delete egos when we are already cleaning up */
  if (ESCROW_PLUGIN_STATE_CLEANUP == ph->state)
    return;

  if ((NULL == ego) && (ESCROW_PLUGIN_STATE_INIT == ph->state))
  {
    ph->state = ESCROW_PLUGIN_STATE_POST_INIT;
    /* call IdentityInitContinuation */
    ph->id_init_cont ();
    return;
  }
  GNUNET_assert (NULL != ego);

  if (ESCROW_PLUGIN_STATE_INIT == ph->state)
  {
    ego_entry = GNUNET_new (struct EgoEntry);
    GNUNET_IDENTITY_ego_get_public_key (ego, &pk);
    ego_entry->keystring = GNUNET_CRYPTO_ecdsa_public_key_to_string (&pk);
    ego_entry->ego = ego;
    ego_entry->identifier = GNUNET_strdup (identifier);
    GNUNET_CONTAINER_DLL_insert_tail (ph->ego_head,
                                      ph->ego_tail,
                                      ego_entry);
    return;
  }
  /* Ego renamed or added */
  if (identifier != NULL)
  {
    for (ego_entry = ph->ego_head; NULL != ego_entry;
         ego_entry = ego_entry->next)
    {
      if (ego_entry->ego == ego)
      {
        /* Rename */
        GNUNET_free (ego_entry->identifier);
        ego_entry->identifier = GNUNET_strdup (identifier);
        /* TODO: this handles an edge case when the user restores an ego
           that already exists, i.e. with the same private key. In that case,
           @param ego is the same for the new as for the existing ego and this
           method thinks it is a rename. */
        if (NULL != ph->ego_create_cont)
          ph->ego_create_cont (ego);
        break;
      }
    }
    if (NULL == ego_entry)
    {
      /* Add */
      ego_entry = GNUNET_new (struct EgoEntry);
      GNUNET_IDENTITY_ego_get_public_key (ego, &pk);
      ego_entry->keystring = GNUNET_CRYPTO_ecdsa_public_key_to_string (&pk);
      ego_entry->ego = ego;
      ego_entry->identifier = GNUNET_strdup (identifier);
      GNUNET_CONTAINER_DLL_insert_tail (ph->ego_head,
                                        ph->ego_tail,
                                        ego_entry);
      /* new ego is added to the list, call ego_create_cont if this was
         because of an ESCROW_get operation, i.e. ego_create_cont != NULL */
      if (NULL != ph->ego_create_cont)
        ph->ego_create_cont (ego);
    }
  }
  else
  {
    /* Delete */
    for (ego_entry = ph->ego_head; NULL != ego_entry;
         ego_entry = ego_entry->next)
    {
      if (ego_entry->ego == ego)
        break;
    }
    if (NULL == ego_entry)
      return; /* Not found */

    GNUNET_CONTAINER_DLL_remove (ph->ego_head,
                                 ph->ego_tail,
                                 ego_entry);
    GNUNET_free (ego_entry->identifier);
    GNUNET_free (ego_entry->keystring);
    GNUNET_free (ego_entry);
    return;
  }
}


/**
 * Cleanup the ego list of an escrow plugin.
 * 
 * @param ph handle for the plugin
 */
void
ESCROW_cleanup_ego_list (struct ESCROW_PluginHandle *ph)
{
  struct EgoEntry *ego_entry;

  while (NULL != (ego_entry = ph->ego_head))
  {
    GNUNET_CONTAINER_DLL_remove (ph->ego_head, ph->ego_tail, ego_entry);
    GNUNET_free (ego_entry->identifier);
    GNUNET_free (ego_entry->keystring);
    GNUNET_free (ego_entry);
  }
}


static char *
string_to_upper (const char *str)
{
  char *str_upper;
  uint16_t i;

  str_upper = GNUNET_strdup (str);

  for (i = 0; i < strlen(str_upper); i++)
  {
    if (str_upper[i] >= 'a' && str_upper[i] <= 'z')
      str_upper[i] -= 32; // 'a' - 'A' = 32
  }

  return str_upper;
}


static int
write_config (struct GNUNET_ESCROW_Handle *h)
{
  char *conf_file;

  GNUNET_assert (GNUNET_OK ==
                 GNUNET_CONFIGURATION_get_value_filename (h->cfg,
                                                          "PATHS",
                                                          "DEFAULTCONFIG",
                                                          &conf_file));
  if (GNUNET_OK != GNUNET_CONFIGURATION_write (h->cfg, conf_file))
  {
    fprintf (stderr, "unable to write config file\n");
    GNUNET_free (conf_file);
    return GNUNET_NO;
  }

  GNUNET_free (conf_file);

  return GNUNET_OK;
}


static char *
get_config_section (struct GNUNET_IDENTITY_Ego *ego)
{
  struct GNUNET_CRYPTO_EcdsaPublicKey *pub;
  char *config_section, *pubkey_string;

  pub = GNUNET_new (struct GNUNET_CRYPTO_EcdsaPublicKey);
  GNUNET_IDENTITY_ego_get_public_key (ego, pub);
  pubkey_string = GNUNET_CRYPTO_ecdsa_public_key_to_string (pub);

  // allocate enough space for "escrow-PUBKEY"
  config_section = GNUNET_malloc (7 + strlen (pubkey_string) + 1);
  sprintf (config_section, "escrow-%s", pubkey_string);

  GNUNET_free (pubkey_string);

  return config_section;
}


/**
 * Update the status of an escrow in the configuration after a successful
 * VERIFY operation.
 * 
 * @param h handle for the escrow component
 * @param ego the ego of which the escrow status is updated
 * @param plugin_name the name of the used plugin
 * 
 * @return GNUNET_OK on success
 */
int
ESCROW_update_escrow_status_verify (struct GNUNET_ESCROW_Handle *h,
                                    struct GNUNET_IDENTITY_Ego *ego,
                                    const char *plugin_name)
{
  char *config_section, *config_option, *plugin_name_upper;
  struct GNUNET_TIME_Absolute now, next_verification;
  struct GNUNET_TIME_Relative escrow_interval;

  config_section = get_config_section (ego);

  // allocate enough space for "<plugin_name>_VERIFY_INTERVAL"
  config_option = GNUNET_malloc (strlen (plugin_name) + 16 + 1);
  plugin_name_upper = string_to_upper (plugin_name);
  sprintf (config_option, "%s_VERIFY_INTERVAL", plugin_name_upper);

  now = GNUNET_TIME_absolute_get ();
  GNUNET_CONFIGURATION_set_value_number (h->cfg,
                                         config_section,
                                         "LAST_SUCCESSFUL_VERIFICATION_TIME",
                                         (unsigned long long)now.abs_value_us);
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (h->cfg,
                                                        "escrow",
                                                        config_option,
                                                        &escrow_interval))
  {
    fprintf (stderr, "could not find config value for verification interval\n");
    GNUNET_free (config_section);
    GNUNET_free (config_option);
    GNUNET_free (plugin_name_upper);
    return GNUNET_NO;
  }
  next_verification = GNUNET_TIME_absolute_add (now, escrow_interval);
  GNUNET_CONFIGURATION_set_value_number (h->cfg,
                                         config_section,
                                         "NEXT_RECOMMENDED_VERIFICATION_TIME",
                                         (unsigned long long)next_verification.abs_value_us);

  if (GNUNET_OK != write_config (h))
  {
    GNUNET_free (config_section);
    GNUNET_free (config_option);
    GNUNET_free (plugin_name_upper);
    return GNUNET_NO;
  }

  GNUNET_free (config_section);
  GNUNET_free (config_option);
  GNUNET_free (plugin_name_upper);

  return GNUNET_OK;
}


/**
 * Update the status of an escrow in the configuration after a PUT operation.
 * 
 * @param h handle for the escrow component
 * @param ego the ego of which the escrow status is updated
 * @param plugin_name the name of the used plugin
 * 
 * @return GNUNET_OK on success
 */
int
ESCROW_update_escrow_status_put (struct GNUNET_ESCROW_Handle *h,
                                 struct GNUNET_IDENTITY_Ego *ego,
                                 const char *plugin_name)
{
  char *config_section;

  config_section = get_config_section (ego);

  GNUNET_CONFIGURATION_set_value_string (h->cfg,
                                         config_section,
                                         "ESCROW_METHOD",
                                         plugin_name);

  if (GNUNET_OK != write_config (h))
  {
    GNUNET_free (config_section);
    return GNUNET_NO;
  }

  GNUNET_free (config_section);

  return GNUNET_OK;
}


/**
 * Get the status of an escrow from the configuration.
 * 
 * @param h handle for the escrow component
 * @param ego the ego of which the escrow status has to be obtained
 * 
 * @return the status of the escrow, packed into a GNUNET_ESCROW_Status struct
 */
struct GNUNET_ESCROW_Status *
ESCROW_get_escrow_status (struct GNUNET_ESCROW_Handle *h,
                          struct GNUNET_IDENTITY_Ego *ego)
{
  struct GNUNET_ESCROW_Status *status;
  unsigned long long conf_last_verification, conf_next_verification;
  char *config_section, *conf_escrow_method;

  config_section = get_config_section (ego);
  
  status = GNUNET_new (struct GNUNET_ESCROW_Status);
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (h->cfg,
                                                          config_section,
                                                          "LAST_SUCCESSFUL_VERIFICATION_TIME",
                                                          &conf_last_verification))
  {
    /* failed to get value from config, set last verification time to zero */
    status->last_successful_verification_time = GNUNET_TIME_absolute_get_zero_();
  }
  else
    status->last_successful_verification_time.abs_value_us = (uint64_t)conf_last_verification;
  
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (h->cfg,
                                                          config_section,
                                                          "NEXT_RECOMMENDED_VERIFICATION_TIME",
                                                          &conf_next_verification))
  {
    /* failed to get value from config, set next recommended verification to now */
    status->next_recommended_verification_time = GNUNET_TIME_absolute_get ();
  }
  else
    status->next_recommended_verification_time.abs_value_us = (uint64_t)conf_next_verification;

  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (h->cfg,
                                                          config_section,
                                                          "ESCROW_METHOD",
                                                          &conf_escrow_method))
  {
    /* failed to get value from config, set last method to NONE */
    status->last_method = GNUNET_ESCROW_KEY_NONE;
  }
  else  
    status->last_method = GNUNET_ESCROW_method_string_to_number (conf_escrow_method);
  
  GNUNET_free (config_section);
  if (NULL != conf_escrow_method)
    GNUNET_free (conf_escrow_method);
  
  return status;
}


/* end of escrow_plugin.c */