2 * This file is part of GNUnet
3 * Copyright (C) 2009-2015, 2018 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 namestore/plugin_namestore_flat.c
23 * @brief file-based namestore backend
24 * @author Martin Schanzenbach
25 * @author Christian Grothoff
29 #include "gnunet_namestore_plugin.h"
30 #include "gnunet_namestore_service.h"
31 #include "gnunet_gnsrecord_lib.h"
32 #include "namestore.h"
35 * Context for all functions in this plugin.
40 const struct GNUNET_CONFIGURATION_Handle *cfg;
50 struct GNUNET_CONTAINER_MultiHashMap *hm;
60 uint32_t target_offset;
70 GNUNET_NAMESTORE_RecordIterator iter;
75 const struct GNUNET_CRYPTO_EcdsaPrivateKey *iter_zone;
78 * PKEY to look for in zone to name
80 const struct GNUNET_CRYPTO_EcdsaPublicKey *iter_pkey;
83 * Iteration result found
85 int iter_result_found;
95 struct GNUNET_CRYPTO_EcdsaPrivateKey *private_key;
100 uint32_t record_count;
110 struct GNUNET_GNSRECORD_Data *record_data;
122 * Initialize the database connections and associated
123 * data structures (create tables and indices
124 * as needed as well).
126 * @param plugin the plugin context (state for this module)
127 * @return #GNUNET_OK on success
130 database_setup (struct Plugin *plugin)
135 char *zone_private_key;
136 char *record_data_b64;
142 size_t record_data_size;
145 struct GNUNET_HashCode hkey;
146 struct GNUNET_DISK_FileHandle *fh;
147 struct FlatFileEntry *entry;
150 GNUNET_CONFIGURATION_get_value_filename (plugin->cfg,
155 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
158 return GNUNET_SYSERR;
161 GNUNET_DISK_file_test (afsdir))
164 GNUNET_DISK_directory_create_for_file (afsdir))
167 GNUNET_free (afsdir);
168 return GNUNET_SYSERR;
171 /* afsdir should be UTF-8-encoded. If it isn't, it's a bug */
174 /* Load data from file into hashmap */
175 plugin->hm = GNUNET_CONTAINER_multihashmap_create (10,
177 fh = GNUNET_DISK_file_open (afsdir,
178 GNUNET_DISK_OPEN_CREATE |
179 GNUNET_DISK_OPEN_READWRITE,
180 GNUNET_DISK_PERM_USER_WRITE |
181 GNUNET_DISK_PERM_USER_READ);
184 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
185 _("Unable to initialize file: %s.\n"),
187 return GNUNET_SYSERR;
190 GNUNET_DISK_file_size (afsdir,
195 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
196 _("Unable to get filesize: %s.\n"),
198 GNUNET_DISK_file_close (fh);
199 return GNUNET_SYSERR;
202 buffer = GNUNET_malloc (size + 1);
204 GNUNET_DISK_file_read (fh,
208 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
209 _("Unable to read file: %s.\n"),
211 GNUNET_free (buffer);
212 GNUNET_DISK_file_close (fh);
213 return GNUNET_SYSERR;
216 GNUNET_DISK_file_close (fh);
220 line = strtok (buffer, "\n");
223 zone_private_key = strtok (line, ",");
224 if (NULL == zone_private_key)
226 rvalue = strtok (NULL, ",");
229 record_count = strtok (NULL, ",");
230 if (NULL == record_count)
232 record_data_b64 = strtok (NULL, ",");
233 if (NULL == record_data_b64)
235 label = strtok (NULL, ",");
238 line = strtok (NULL, "\n");
239 entry = GNUNET_new (struct FlatFileEntry);
241 unsigned long long ll;
243 if (1 != sscanf (rvalue,
247 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
248 "Error parsing entry\n");
252 entry->rvalue = (uint64_t) ll;
257 if (1 != sscanf (record_count,
261 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
262 "Error parsing entry\n");
266 entry->record_count = (uint32_t) ui;
268 entry->label = GNUNET_strdup (label);
270 = GNUNET_STRINGS_base64_decode (record_data_b64,
271 strlen (record_data_b64),
274 GNUNET_new_array (entry->record_count,
275 struct GNUNET_GNSRECORD_Data);
277 GNUNET_GNSRECORD_records_deserialize (record_data_size,
282 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
283 "Unable to deserialize record %s\n",
285 GNUNET_free (entry->label);
287 GNUNET_free (record_data);
290 GNUNET_free (record_data);
291 GNUNET_STRINGS_base64_decode (zone_private_key,
292 strlen (zone_private_key),
293 (char**)&entry->private_key);
294 key_len = strlen (label) + sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey);
295 key = GNUNET_malloc (strlen (label) + sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey));
299 GNUNET_memcpy (key+strlen(label),
301 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey));
302 GNUNET_CRYPTO_hash (key,
307 GNUNET_CONTAINER_multihashmap_put (plugin->hm,
310 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
317 GNUNET_free (buffer);
323 * Store values in hashmap in file and free data
325 * @param plugin the plugin context
326 * @param key key in the map
327 * @param value a `struct FlatFileEntry`
330 store_and_free_entries (void *cls,
331 const struct GNUNET_HashCode *key,
334 struct GNUNET_DISK_FileHandle *fh = cls;
335 struct FlatFileEntry *entry = value;
337 char *zone_private_key;
338 char *record_data_b64;
342 GNUNET_STRINGS_base64_encode ((char*)entry->private_key,
343 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey),
345 data_size = GNUNET_GNSRECORD_records_get_size (entry->record_count,
348 char data[data_size];
351 ret = GNUNET_GNSRECORD_records_serialize (entry->record_count,
356 (data_size != (size_t) ret) )
359 GNUNET_free (zone_private_key);
360 return GNUNET_SYSERR;
362 GNUNET_STRINGS_base64_encode (data,
366 GNUNET_asprintf (&line,
367 "%s,%llu,%u,%s,%s\n",
369 (unsigned long long) entry->rvalue,
370 (unsigned int) entry->record_count,
373 GNUNET_free (record_data_b64);
374 GNUNET_free (zone_private_key);
376 GNUNET_DISK_file_write (fh,
381 GNUNET_free (entry->private_key);
382 GNUNET_free (entry->label);
383 GNUNET_free (entry->record_data);
390 * Shutdown database connection and associate data
392 * @param plugin the plugin context (state for this module)
395 database_shutdown (struct Plugin *plugin)
397 struct GNUNET_DISK_FileHandle *fh;
399 fh = GNUNET_DISK_file_open (plugin->fn,
400 GNUNET_DISK_OPEN_CREATE |
401 GNUNET_DISK_OPEN_TRUNCATE |
402 GNUNET_DISK_OPEN_READWRITE,
403 GNUNET_DISK_PERM_USER_WRITE |
404 GNUNET_DISK_PERM_USER_READ);
407 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
408 _("Unable to initialize file: %s.\n"),
413 GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
414 &store_and_free_entries,
416 GNUNET_CONTAINER_multihashmap_destroy (plugin->hm);
417 GNUNET_DISK_file_close (fh);
422 * Store a record in the datastore. Removes any existing record in the
423 * same zone with the same name.
425 * @param cls closure (internal context for the plugin)
426 * @param zone_key private key of the zone
427 * @param label name that is being mapped (at most 255 characters long)
428 * @param rd_count number of entries in @a rd array
429 * @param rd array of records with data to store
430 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
433 namestore_flat_store_records (void *cls,
434 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
436 unsigned int rd_count,
437 const struct GNUNET_GNSRECORD_Data *rd)
439 struct Plugin *plugin = cls;
443 struct GNUNET_HashCode hkey;
444 struct FlatFileEntry *entry;
446 rvalue = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK,
448 key_len = strlen (label) + sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey);
449 key = GNUNET_malloc (key_len);
453 GNUNET_memcpy (key + strlen(label),
455 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey));
456 GNUNET_CRYPTO_hash (key,
459 GNUNET_CONTAINER_multihashmap_remove_all (plugin->hm,
463 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
468 entry = GNUNET_new (struct FlatFileEntry);
469 entry->private_key = GNUNET_new (struct GNUNET_CRYPTO_EcdsaPrivateKey);
470 GNUNET_asprintf (&entry->label,
473 GNUNET_memcpy (entry->private_key,
475 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey));
476 entry->rvalue = rvalue;
477 entry->record_count = rd_count;
478 entry->record_data = GNUNET_new_array (rd_count,
479 struct GNUNET_GNSRECORD_Data);
480 for (unsigned int i = 0; i < rd_count; i++)
482 entry->record_data[i].expiration_time = rd[i].expiration_time;
483 entry->record_data[i].record_type = rd[i].record_type;
484 entry->record_data[i].flags = rd[i].flags;
485 entry->record_data[i].data_size = rd[i].data_size;
486 entry->record_data[i].data = GNUNET_malloc (rd[i].data_size);
487 GNUNET_memcpy ((char*)entry->record_data[i].data,
491 return GNUNET_CONTAINER_multihashmap_put (plugin->hm,
494 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
499 * Lookup records in the datastore for which we are the authority.
501 * @param cls closure (internal context for the plugin)
502 * @param zone private key of the zone
503 * @param label name of the record in the zone
504 * @param iter function to call with the result
505 * @param iter_cls closure for @a iter
506 * @return #GNUNET_OK on success, #GNUNET_NO for no results, else #GNUNET_SYSERR
509 namestore_flat_lookup_records (void *cls,
510 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
512 GNUNET_NAMESTORE_RecordIterator iter,
515 struct Plugin *plugin = cls;
516 struct FlatFileEntry *entry;
517 struct GNUNET_HashCode hkey;
524 return GNUNET_SYSERR;
526 key_len = strlen (label) + sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey);
527 key = GNUNET_malloc (key_len);
531 GNUNET_memcpy (key+strlen(label),
533 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey));
534 GNUNET_CRYPTO_hash (key,
539 entry = GNUNET_CONTAINER_multihashmap_get (plugin->hm,
556 * Closure for #iterate_zones.
558 struct IterateContext
561 * How many more records should we skip before returning results?
566 * How many more records should we return?
571 * What is the position of the current entry, counting
579 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone;
582 * Function to call on each record.
584 GNUNET_NAMESTORE_RecordIterator iter;
587 * Closure for @e iter.
595 * Helper function for #namestore_flat_iterate_records().
597 * @param cls a `struct IterateContext`
599 * @param value a `struct FlatFileEntry`
600 * @return #GNUNET_YES to continue the iteration
603 iterate_zones (void *cls,
604 const struct GNUNET_HashCode *key,
607 struct IterateContext *ic = cls;
608 struct FlatFileEntry *entry = value;
614 if ( (NULL != ic->zone) &&
615 (0 != memcmp (entry->private_key,
617 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey))) )
624 ic->iter (ic->iter_cls,
638 * Iterate over the results for a particular key and zone in the
639 * datastore. Will return at most one result to the iterator.
641 * @param cls closure (internal context for the plugin)
642 * @param zone hash of public key of the zone, NULL to iterate over all zones
643 * @param serial serial number to exclude in the list of all matching records
644 * @param limit maximum number of results to return to @a iter
645 * @param iter function to call with the result
646 * @param iter_cls closure for @a iter
647 * @return #GNUNET_OK on success, #GNUNET_NO if there were no more results, #GNUNET_SYSERR on error
650 namestore_flat_iterate_records (void *cls,
651 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
654 GNUNET_NAMESTORE_RecordIterator iter,
657 struct Plugin *plugin = cls;
658 struct IterateContext ic;
664 ic.iter_cls = iter_cls;
666 GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
669 return (0 == ic.limit) ? GNUNET_OK : GNUNET_NO;
674 zone_to_name (void *cls,
675 const struct GNUNET_HashCode *key,
678 struct Plugin *plugin = cls;
679 struct FlatFileEntry *entry = value;
682 if (0 != memcmp (entry->private_key,
684 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey)))
687 for (unsigned int i = 0; i < entry->record_count; i++)
689 if (GNUNET_GNSRECORD_TYPE_PKEY != entry->record_data[i].record_type)
691 if (0 == memcmp (plugin->iter_pkey,
692 entry->record_data[i].data,
693 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey)))
695 plugin->iter (plugin->iter_cls,
701 plugin->iter_result_found = GNUNET_YES;
710 * Look for an existing PKEY delegation record for a given public key.
711 * Returns at most one result to the iterator.
713 * @param cls closure (internal context for the plugin)
714 * @param zone private key of the zone to look up in, never NULL
715 * @param value_zone public key of the target zone (value), never NULL
716 * @param iter function to call with the result
717 * @param iter_cls closure for @a iter
718 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
721 namestore_flat_zone_to_name (void *cls,
722 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
723 const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone,
724 GNUNET_NAMESTORE_RecordIterator iter,
727 struct Plugin *plugin = cls;
729 /* FIXME: maybe use separate closure to better handle
732 plugin->iter_cls = iter_cls;
733 plugin->iter_zone = zone;
734 plugin->iter_pkey = value_zone;
735 plugin->iter_result_found = GNUNET_NO;
736 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
737 "Performing reverse lookup for `%s'\n",
738 GNUNET_GNSRECORD_z2s (value_zone));
739 GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
742 return plugin->iter_result_found;
747 * Entry point for the plugin.
749 * @param cls the "struct GNUNET_NAMESTORE_PluginEnvironment*"
750 * @return NULL on error, otherwise the plugin context
753 libgnunet_plugin_namestore_flat_init (void *cls)
755 static struct Plugin plugin;
756 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
757 struct GNUNET_NAMESTORE_PluginFunctions *api;
759 if (NULL != plugin.cfg)
760 return NULL; /* can only initialize once! */
763 sizeof (struct Plugin));
765 if (GNUNET_OK != database_setup (&plugin))
767 database_shutdown (&plugin);
770 api = GNUNET_new (struct GNUNET_NAMESTORE_PluginFunctions);
772 api->store_records = &namestore_flat_store_records;
773 api->iterate_records = &namestore_flat_iterate_records;
774 api->zone_to_name = &namestore_flat_zone_to_name;
775 api->lookup_records = &namestore_flat_lookup_records;
776 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
777 _("flat file database running\n"));
783 * Exit point from the plugin.
785 * @param cls the plugin context (as returned by "init")
786 * @return always NULL
789 libgnunet_plugin_namestore_flat_done (void *cls)
791 struct GNUNET_NAMESTORE_PluginFunctions *api = cls;
792 struct Plugin *plugin = api->cls;
794 database_shutdown (plugin);
797 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
798 "flat file plugin is finished\n");
802 /* end of plugin_namestore_flat.c */