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");
221 while (line != NULL) {
222 zone_private_key = strtok (line, ",");
223 if (NULL == zone_private_key)
225 rvalue = strtok (NULL, ",");
228 record_count = strtok (NULL, ",");
229 if (NULL == record_count)
231 record_data_b64 = strtok (NULL, ",");
232 if (NULL == record_data_b64)
234 label = strtok (NULL, ",");
237 line = strtok (NULL, "\n");
238 entry = GNUNET_new (struct FlatFileEntry);
239 if (1 != sscanf (rvalue,
243 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
244 "Error parsing entry\n");
248 if (1 != sscanf (record_count,
250 &entry->record_count))
252 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
253 "Error parsing entry\n");
257 entry->label = GNUNET_strdup (label);
259 = GNUNET_STRINGS_base64_decode (record_data_b64,
260 strlen (record_data_b64),
263 GNUNET_new_array (entry->record_count,
264 struct GNUNET_GNSRECORD_Data);
266 GNUNET_GNSRECORD_records_deserialize (record_data_size,
271 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
272 "Unable to deserialize record %s\n",
274 GNUNET_free (entry->label);
276 GNUNET_free (record_data);
279 GNUNET_free (record_data);
280 GNUNET_STRINGS_base64_decode (zone_private_key,
281 strlen (zone_private_key),
282 (char**)&entry->private_key);
283 key_len = strlen (label) + sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey);
284 key = GNUNET_malloc (strlen (label) + sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey));
288 GNUNET_memcpy (key+strlen(label),
290 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey));
291 GNUNET_CRYPTO_hash (key,
296 GNUNET_CONTAINER_multihashmap_put (plugin->hm,
299 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
306 GNUNET_free (buffer);
312 * Store values in hashmap in file and free data
314 * @param plugin the plugin context
315 * @param key key in the map
316 * @param value a `struct FlatFileEntry`
319 store_and_free_entries (void *cls,
320 const struct GNUNET_HashCode *key,
323 struct GNUNET_DISK_FileHandle *fh = cls;
324 struct FlatFileEntry *entry = value;
326 char *zone_private_key;
327 char *record_data_b64;
331 GNUNET_STRINGS_base64_encode ((char*)entry->private_key,
332 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey),
334 data_size = GNUNET_GNSRECORD_records_get_size (entry->record_count,
337 char data[data_size];
340 ret = GNUNET_GNSRECORD_records_serialize (entry->record_count,
345 (data_size != (size_t) ret) )
348 GNUNET_free (zone_private_key);
349 return GNUNET_SYSERR;
351 GNUNET_STRINGS_base64_encode (data,
355 GNUNET_asprintf (&line,
362 GNUNET_free (record_data_b64);
363 GNUNET_free (zone_private_key);
365 GNUNET_DISK_file_write (fh,
370 GNUNET_free (entry->private_key);
371 GNUNET_free (entry->label);
372 GNUNET_free (entry->record_data);
379 * Shutdown database connection and associate data
381 * @param plugin the plugin context (state for this module)
384 database_shutdown (struct Plugin *plugin)
386 struct GNUNET_DISK_FileHandle *fh;
388 fh = GNUNET_DISK_file_open (plugin->fn,
389 GNUNET_DISK_OPEN_CREATE |
390 GNUNET_DISK_OPEN_TRUNCATE |
391 GNUNET_DISK_OPEN_READWRITE,
392 GNUNET_DISK_PERM_USER_WRITE |
393 GNUNET_DISK_PERM_USER_READ);
396 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
397 _("Unable to initialize file: %s.\n"),
402 GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
403 &store_and_free_entries,
405 GNUNET_CONTAINER_multihashmap_destroy (plugin->hm);
406 GNUNET_DISK_file_close (fh);
411 * Store a record in the datastore. Removes any existing record in the
412 * same zone with the same name.
414 * @param cls closure (internal context for the plugin)
415 * @param zone_key private key of the zone
416 * @param label name that is being mapped (at most 255 characters long)
417 * @param rd_count number of entries in @a rd array
418 * @param rd array of records with data to store
419 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
422 namestore_flat_store_records (void *cls,
423 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
425 unsigned int rd_count,
426 const struct GNUNET_GNSRECORD_Data *rd)
428 struct Plugin *plugin = cls;
432 struct GNUNET_HashCode hkey;
433 struct FlatFileEntry *entry;
435 rvalue = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK,
437 key_len = strlen (label) + sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey);
438 key = GNUNET_malloc (key_len);
439 GNUNET_memcpy (key, label, strlen (label));
440 GNUNET_memcpy (key+strlen(label),
442 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey));
443 GNUNET_CRYPTO_hash (key,
447 GNUNET_CONTAINER_multihashmap_remove_all (plugin->hm, &hkey);
451 entry = GNUNET_new (struct FlatFileEntry);
452 entry->private_key = GNUNET_new (struct GNUNET_CRYPTO_EcdsaPrivateKey);
453 GNUNET_asprintf (&entry->label,
456 GNUNET_memcpy (entry->private_key,
458 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey));
459 entry->rvalue = rvalue;
460 entry->record_count = rd_count;
461 entry->record_data = GNUNET_new_array (rd_count,
462 struct GNUNET_GNSRECORD_Data);
463 for (unsigned int i = 0; i < rd_count; i++)
465 entry->record_data[i].expiration_time = rd[i].expiration_time;
466 entry->record_data[i].record_type = rd[i].record_type;
467 entry->record_data[i].flags = rd[i].flags;
468 entry->record_data[i].data_size = rd[i].data_size;
469 entry->record_data[i].data = GNUNET_malloc (rd[i].data_size);
470 GNUNET_memcpy ((char*)entry->record_data[i].data, rd[i].data, rd[i].data_size);
472 return GNUNET_CONTAINER_multihashmap_put (plugin->hm,
475 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
482 * Lookup records in the datastore for which we are the authority.
484 * @param cls closure (internal context for the plugin)
485 * @param zone private key of the zone
486 * @param label name of the record in the zone
487 * @param iter function to call with the result
488 * @param iter_cls closure for @a iter
489 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
492 namestore_flat_lookup_records (void *cls,
493 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
495 GNUNET_NAMESTORE_RecordIterator iter,
498 struct Plugin *plugin = cls;
499 struct FlatFileEntry *entry;
500 struct GNUNET_HashCode hkey;
505 return GNUNET_SYSERR;
506 key_len = strlen (label) + sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey);
507 key = GNUNET_malloc (key_len);
511 GNUNET_memcpy (key+strlen(label),
513 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey));
514 GNUNET_CRYPTO_hash (key,
519 entry = GNUNET_CONTAINER_multihashmap_get (plugin->hm,
536 * Closure for #iterate_zones.
538 struct IterateContext
541 * How many more records should we skip before returning results?
546 * How many more records should we return?
551 * What is the position of the current entry, counting
559 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone;
562 * Function to call on each record.
564 GNUNET_NAMESTORE_RecordIterator iter;
567 * Closure for @e iter.
575 * Helper function for #namestore_flat_iterate_records().
577 * @param cls a `struct IterateContext`
579 * @param value a `struct FlatFileEntry`
580 * @return #GNUNET_YES to continue the iteration
583 iterate_zones (void *cls,
584 const struct GNUNET_HashCode *key,
587 struct IterateContext *ic = cls;
588 struct FlatFileEntry *entry = value;
594 if ( (NULL != ic->zone) &&
595 (0 != memcmp (entry->private_key,
597 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey))) )
604 ic->iter (ic->iter_cls,
618 * Iterate over the results for a particular key and zone in the
619 * datastore. Will return at most one result to the iterator.
621 * @param cls closure (internal context for the plugin)
622 * @param zone hash of public key of the zone, NULL to iterate over all zones
623 * @param serial serial number to exclude in the list of all matching records
624 * @param limit maximum number of results to return to @a iter
625 * @param iter function to call with the result
626 * @param iter_cls closure for @a iter
627 * @return #GNUNET_OK on success, #GNUNET_NO if there were no more results, #GNUNET_SYSERR on error
630 namestore_flat_iterate_records (void *cls,
631 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
634 GNUNET_NAMESTORE_RecordIterator iter,
637 struct Plugin *plugin = cls;
638 struct IterateContext ic;
644 ic.iter_cls = iter_cls;
646 GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
649 return (0 == ic.limit) ? GNUNET_OK : GNUNET_NO;
654 zone_to_name (void *cls,
655 const struct GNUNET_HashCode *key,
658 struct Plugin *plugin = cls;
659 struct FlatFileEntry *entry = value;
662 if (0 != memcmp (entry->private_key,
664 sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey)))
667 for (unsigned int i = 0; i < entry->record_count; i++)
669 if (GNUNET_GNSRECORD_TYPE_PKEY != entry->record_data[i].record_type)
671 if (0 == memcmp (plugin->iter_pkey,
672 entry->record_data[i].data,
673 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey)))
675 plugin->iter (plugin->iter_cls,
681 plugin->iter_result_found = GNUNET_YES;
690 * Look for an existing PKEY delegation record for a given public key.
691 * Returns at most one result to the iterator.
693 * @param cls closure (internal context for the plugin)
694 * @param zone private key of the zone to look up in, never NULL
695 * @param value_zone public key of the target zone (value), never NULL
696 * @param iter function to call with the result
697 * @param iter_cls closure for @a iter
698 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
701 namestore_flat_zone_to_name (void *cls,
702 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
703 const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone,
704 GNUNET_NAMESTORE_RecordIterator iter,
707 struct Plugin *plugin = cls;
709 /* FIXME: maybe use separate closure to better handle
712 plugin->iter_cls = iter_cls;
713 plugin->iter_zone = zone;
714 plugin->iter_pkey = value_zone;
715 plugin->iter_result_found = GNUNET_NO;
716 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
717 "Performing reverse lookup for `%s'\n",
718 GNUNET_GNSRECORD_z2s (value_zone));
719 GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
722 return plugin->iter_result_found;
727 * Entry point for the plugin.
729 * @param cls the "struct GNUNET_NAMESTORE_PluginEnvironment*"
730 * @return NULL on error, otherwise the plugin context
733 libgnunet_plugin_namestore_flat_init (void *cls)
735 static struct Plugin plugin;
736 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
737 struct GNUNET_NAMESTORE_PluginFunctions *api;
739 if (NULL != plugin.cfg)
740 return NULL; /* can only initialize once! */
743 sizeof (struct Plugin));
745 if (GNUNET_OK != database_setup (&plugin))
747 database_shutdown (&plugin);
750 api = GNUNET_new (struct GNUNET_NAMESTORE_PluginFunctions);
752 api->store_records = &namestore_flat_store_records;
753 api->iterate_records = &namestore_flat_iterate_records;
754 api->zone_to_name = &namestore_flat_zone_to_name;
755 api->lookup_records = &namestore_flat_lookup_records;
756 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
757 _("flat file database running\n"));
763 * Exit point from the plugin.
765 * @param cls the plugin context (as returned by "init")
766 * @return always NULL
769 libgnunet_plugin_namestore_flat_done (void *cls)
771 struct GNUNET_NAMESTORE_PluginFunctions *api = cls;
772 struct Plugin *plugin = api->cls;
774 database_shutdown (plugin);
777 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
778 "flat file plugin is finished\n");
782 /* end of plugin_namestore_flat.c */