2 This file is part of GNUnet
3 (C) 2003-2013 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
21 * @file fs/fs_pseudonym.c
22 * @brief pseudonym functions
23 * @author Christian Grothoff
26 #include "gnunet_util_lib.h"
27 #include "gnunet_fs_service.h"
30 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
32 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
34 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
38 * Name of the directory which stores meta data for pseudonym
40 #define PS_METADATA_DIR DIR_SEPARATOR_STR "data" DIR_SEPARATOR_STR "pseudonym" DIR_SEPARATOR_STR "metadata" DIR_SEPARATOR_STR
43 * Name of the directory which stores names for pseudonyms
45 #define PS_NAMES_DIR DIR_SEPARATOR_STR "data" DIR_SEPARATOR_STR "pseudonym" DIR_SEPARATOR_STR "names" DIR_SEPARATOR_STR
49 * Configuration section we use.
51 #define GNUNET_CLIENT_SERVICE_NAME "fs"
54 /* ************************* Disk operations (pseudonym data mgmt) **************** */
57 * Registered callbacks for discovery of pseudonyms.
59 struct GNUNET_FS_Pseudonym_DiscoveryHandle
62 * This is a doubly linked list.
64 struct GNUNET_FS_Pseudonym_DiscoveryHandle *next;
67 * This is a doubly linked list.
69 struct GNUNET_FS_Pseudonym_DiscoveryHandle *prev;
72 * Function to call each time a pseudonym is discovered.
74 GNUNET_FS_PseudonymIterator callback;
77 * Closure for callback.
84 * Head of the linked list of functions to call when
85 * new pseudonyms are added.
87 static struct GNUNET_FS_Pseudonym_DiscoveryHandle *disco_head;
90 * Tail of the linked list of functions to call when
91 * new pseudonyms are added.
93 static struct GNUNET_FS_Pseudonym_DiscoveryHandle *disco_tail;
97 * Internal notification about new tracked URI.
99 * @param pseudonym public key of the pseudonym
100 * @param md meta data to be written
101 * @param rating rating of pseudonym
104 internal_notify (const struct GNUNET_CRYPTO_EccPublicKey *pseudonym,
105 const struct GNUNET_CONTAINER_MetaData *md, int rating)
107 struct GNUNET_FS_Pseudonym_DiscoveryHandle *pos;
109 for (pos = disco_head; NULL != pos; pos = pos->next)
110 pos->callback (pos->callback_cls, pseudonym, NULL, NULL, md, rating);
115 * Register callback to be invoked whenever we discover
117 * Will immediately call provided iterator callback for all
118 * already discovered pseudonyms.
120 * @param cfg configuration to use
121 * @param iterator iterator over pseudonym
122 * @param iterator_cls point to a closure
123 * @return registration handle
125 struct GNUNET_FS_Pseudonym_DiscoveryHandle *
126 GNUNET_FS_pseudonym_discovery_callback_register (const struct
127 GNUNET_CONFIGURATION_Handle *cfg,
128 GNUNET_FS_PseudonymIterator iterator,
131 struct GNUNET_FS_Pseudonym_DiscoveryHandle *dh;
133 dh = GNUNET_new (struct GNUNET_FS_Pseudonym_DiscoveryHandle);
134 dh->callback = iterator;
135 dh->callback_cls = iterator_cls;
136 GNUNET_CONTAINER_DLL_insert (disco_head, disco_tail, dh);
137 GNUNET_FS_pseudonym_list_all (cfg, iterator, iterator_cls);
143 * Unregister pseudonym discovery callback.
145 * @param dh registration to unregister
148 GNUNET_FS_pseudonym_discovery_callback_unregister (struct GNUNET_FS_Pseudonym_DiscoveryHandle *dh)
150 GNUNET_CONTAINER_DLL_remove (disco_head, disco_tail, dh);
156 * Get the filename (or directory name) for the given
157 * pseudonym identifier and directory prefix.
159 * @param cfg configuration to use
160 * @param prefix path components to append to the private directory name
161 * @param pseudonym the pseudonym, can be NULL
162 * @return filename of the pseudonym (if pseudonym != NULL) or directory with the data (if pseudonym == NULL)
165 get_data_filename (const struct GNUNET_CONFIGURATION_Handle *cfg,
167 const struct GNUNET_CRYPTO_EccPublicKey *pseudonym)
169 struct GNUNET_CRYPTO_HashAsciiEncoded enc;
170 struct GNUNET_HashCode psid;
172 if (NULL != pseudonym)
174 GNUNET_CRYPTO_hash (pseudonym,
175 sizeof (struct GNUNET_CRYPTO_EccPublicKey),
177 GNUNET_CRYPTO_hash_to_enc (&psid, &enc);
179 return GNUNET_DISK_get_home_filename (cfg,
180 GNUNET_CLIENT_SERVICE_NAME, prefix,
183 : (const char *) &enc,
189 * Get the filename (or directory name) for the given
190 * hash code and directory prefix.
192 * @param cfg configuration to use
193 * @param prefix path components to append to the private directory name
194 * @param hc some hash code
195 * @return filename of the pseudonym (if hc != NULL) or directory with the data (if hc == NULL)
198 get_data_filename_hash (const struct GNUNET_CONFIGURATION_Handle *cfg,
200 const struct GNUNET_HashCode *hc)
202 struct GNUNET_CRYPTO_HashAsciiEncoded enc;
205 GNUNET_CRYPTO_hash_to_enc (hc, &enc);
206 return GNUNET_DISK_get_home_filename (cfg,
207 GNUNET_CLIENT_SERVICE_NAME, prefix,
210 : (const char *) &enc,
216 * Set the pseudonym metadata, rank and name.
217 * Writes the pseudonym infomation into a file
219 * @param cfg overall configuration
220 * @param pseudonym id of the pseudonym
221 * @param name name to set. Must be the non-unique version of it.
222 * May be NULL, in which case it erases pseudonym's name!
223 * @param md metadata to set
224 * May be NULL, in which case it erases pseudonym's metadata!
225 * @param rank rank to assign
226 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
229 GNUNET_FS_pseudonym_set_info (const struct GNUNET_CONFIGURATION_Handle *cfg,
230 const struct GNUNET_CRYPTO_EccPublicKey *pseudonym,
232 const struct GNUNET_CONTAINER_MetaData *md,
236 struct GNUNET_BIO_WriteHandle *fileW;
238 fn = get_data_filename (cfg, PS_METADATA_DIR, pseudonym);
239 if (NULL == (fileW = GNUNET_BIO_write_open (fn)))
242 return GNUNET_SYSERR;
244 if ((GNUNET_OK != GNUNET_BIO_write (fileW, pseudonym,
245 sizeof (struct GNUNET_CRYPTO_EccPublicKey))) ||
246 (GNUNET_OK != GNUNET_BIO_write_int32 (fileW, rank)) ||
247 (GNUNET_OK != GNUNET_BIO_write_string (fileW, name)) ||
248 (GNUNET_OK != GNUNET_BIO_write_meta_data (fileW, md)))
250 (void) GNUNET_BIO_write_close (fileW);
251 GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
253 return GNUNET_SYSERR;
255 if (GNUNET_OK != GNUNET_BIO_write_close (fileW))
257 GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
259 return GNUNET_SYSERR;
262 /* create entry for pseudonym name in names */
264 GNUNET_free_non_null (GNUNET_FS_pseudonym_name_uniquify (cfg, pseudonym,
271 * Read pseudonym infomation from a file
273 * @param cfg configuration to use
274 * @param pseudonym hash code of a pseudonym
275 * @param meta meta data to be read from a file
276 * @param rank rank of a pseudonym
277 * @param ns_name name of a pseudonym
278 * @return GNUNET_OK on success, GNUNET_SYSERR on error
281 read_info (const struct GNUNET_CONFIGURATION_Handle *cfg,
282 const struct GNUNET_CRYPTO_EccPublicKey *pseudonym,
283 struct GNUNET_CONTAINER_MetaData **meta,
287 struct GNUNET_CRYPTO_EccPublicKey pd;
290 struct GNUNET_BIO_ReadHandle *fileR;
292 fn = get_data_filename (cfg, PS_METADATA_DIR, pseudonym);
294 GNUNET_DISK_file_test (fn))
297 return GNUNET_SYSERR;
299 if (NULL == (fileR = GNUNET_BIO_read_open (fn)))
302 return GNUNET_SYSERR;
306 if ( (GNUNET_OK != GNUNET_BIO_read (fileR, "pseudonym", &pd, sizeof (pd))) ||
307 (0 != memcmp (&pd, pseudonym, sizeof (pd))) ||
308 (GNUNET_OK != GNUNET_BIO_read_int32 (fileR, rank)) ||
310 GNUNET_BIO_read_string (fileR, "Read string error!", ns_name, 200)) ||
312 GNUNET_BIO_read_meta_data (fileR, "Read meta data error!", meta)) )
314 (void) GNUNET_BIO_read_close (fileR, &emsg);
315 GNUNET_free_non_null (emsg);
316 GNUNET_free_non_null (*ns_name);
318 GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
320 return GNUNET_SYSERR;
322 if (GNUNET_OK != GNUNET_BIO_read_close (fileR, &emsg))
324 LOG (GNUNET_ERROR_TYPE_WARNING,
325 _("Failed to parse metadata about pseudonym from file `%s': %s\n"), fn,
327 GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
328 GNUNET_CONTAINER_meta_data_destroy (*meta);
330 GNUNET_free_non_null (*ns_name);
332 GNUNET_free_non_null (emsg);
334 return GNUNET_SYSERR;
342 * Return unique variant of the namespace name. Use it after
343 * GNUNET_FS_pseudonym_get_info() to make sure that name is unique.
345 * @param cfg configuration
346 * @param pseudonym public key of the pseudonym
347 * @param name name to uniquify
348 * @param suffix if not NULL, filled with the suffix value
349 * @return NULL on failure (should never happen), name on success.
350 * Free the name with GNUNET_free().
353 GNUNET_FS_pseudonym_name_uniquify (const struct GNUNET_CONFIGURATION_Handle *cfg,
354 const struct GNUNET_CRYPTO_EccPublicKey *pseudonym,
356 unsigned int *suffix)
358 struct GNUNET_HashCode nh;
359 struct GNUNET_CRYPTO_EccPublicKey pi;
362 struct GNUNET_DISK_FileHandle *fh;
368 GNUNET_CRYPTO_hash (name, strlen (name), &nh);
369 fn = get_data_filename_hash (cfg, PS_NAMES_DIR, &nh);
371 if (0 == STAT (fn, &sbuf))
372 GNUNET_break (GNUNET_OK == GNUNET_DISK_file_size (fn, &len, GNUNET_YES, GNUNET_YES));
373 fh = GNUNET_DISK_file_open (fn,
374 GNUNET_DISK_OPEN_CREATE |
375 GNUNET_DISK_OPEN_READWRITE,
376 GNUNET_DISK_PERM_USER_READ |
377 GNUNET_DISK_PERM_USER_WRITE);
380 while ((len >= sizeof (struct GNUNET_CRYPTO_EccPublicKey)) &&
381 (sizeof (struct GNUNET_CRYPTO_EccPublicKey) ==
382 GNUNET_DISK_file_read (fh, &pi, sizeof (struct GNUNET_CRYPTO_EccPublicKey))))
384 if (0 == memcmp (&pi, pseudonym, sizeof (struct GNUNET_CRYPTO_EccPublicKey)))
390 len -= sizeof (struct GNUNET_HashCode);
395 if (sizeof (struct GNUNET_CRYPTO_EccPublicKey) !=
396 GNUNET_DISK_file_write (fh, pseudonym, sizeof (struct GNUNET_CRYPTO_EccPublicKey)))
397 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "write", fn);
399 GNUNET_DISK_file_close (fh);
400 ret = GNUNET_malloc (strlen (name) + 32);
401 GNUNET_snprintf (ret, strlen (name) + 32, "%s-%u", name, idx);
410 * Get namespace name, metadata and rank
411 * This is a wrapper around internal read_info() call, and ensures that
412 * returned data is not invalid (not NULL).
414 * @param cfg configuration
415 * @param pseudonym public key of the pseudonym
416 * @param ret_meta a location to store metadata pointer. NULL, if metadata
417 * is not needed. Destroy with GNUNET_CONTAINER_meta_data_destroy().
418 * @param ret_rank a location to store rank. NULL, if rank not needed.
419 * @param ret_name a location to store human-readable name. Name is not unique.
420 * NULL, if name is not needed. Free with GNUNET_free().
421 * @param name_is_a_dup is set to GNUNET_YES, if ret_name was filled with
422 * a duplicate of a "no-name" placeholder
423 * @return GNUNET_OK on success. GNUENT_SYSERR if the data was
424 * unobtainable (in that case ret_* are filled with placeholders -
425 * empty metadata container, rank -1 and a "no-name" name).
428 GNUNET_FS_pseudonym_get_info (const struct GNUNET_CONFIGURATION_Handle *cfg,
429 const struct GNUNET_CRYPTO_EccPublicKey *pseudonym,
430 struct GNUNET_CONTAINER_MetaData **ret_meta,
435 struct GNUNET_CONTAINER_MetaData *meta;
441 if (GNUNET_OK == read_info (cfg, pseudonym, &meta, &rank, &name))
443 if ((meta != NULL) && (name == NULL))
445 GNUNET_CONTAINER_meta_data_get_first_by_types (meta,
446 EXTRACTOR_METATYPE_TITLE,
447 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME,
448 EXTRACTOR_METATYPE_FILENAME,
449 EXTRACTOR_METATYPE_DESCRIPTION,
450 EXTRACTOR_METATYPE_SUBJECT,
451 EXTRACTOR_METATYPE_PUBLISHER,
452 EXTRACTOR_METATYPE_AUTHOR_NAME,
453 EXTRACTOR_METATYPE_COMMENT,
454 EXTRACTOR_METATYPE_SUMMARY,
456 if (ret_name != NULL)
460 name = GNUNET_strdup (_("no-name"));
461 if (name_is_a_dup != NULL)
462 *name_is_a_dup = GNUNET_YES;
464 else if (name_is_a_dup != NULL)
465 *name_is_a_dup = GNUNET_NO;
468 else if (name != NULL)
471 if (ret_meta != NULL)
474 meta = GNUNET_CONTAINER_meta_data_create ();
477 else if (meta != NULL)
478 GNUNET_CONTAINER_meta_data_destroy (meta);
480 if (ret_rank != NULL)
485 if (ret_name != NULL)
486 *ret_name = GNUNET_strdup (_("no-name"));
487 if (ret_meta != NULL)
488 *ret_meta = GNUNET_CONTAINER_meta_data_create ();
489 if (ret_rank != NULL)
491 if (name_is_a_dup != NULL)
492 *name_is_a_dup = GNUNET_YES;
493 return GNUNET_SYSERR;
498 * Get the namespace ID belonging to the given namespace name.
500 * @param cfg configuration to use
501 * @param ns_uname unique (!) human-readable name for the namespace
502 * @param pseudonym set to public key of pseudonym based on 'ns_uname'
503 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
506 GNUNET_FS_pseudonym_name_to_id (const struct GNUNET_CONFIGURATION_Handle *cfg,
507 const char *ns_uname,
508 struct GNUNET_CRYPTO_EccPublicKey *pseudonym)
514 struct GNUNET_HashCode nh;
516 struct GNUNET_DISK_FileHandle *fh;
519 slen = strlen (ns_uname);
520 while ((slen > 0) && (1 != SSCANF (&ns_uname[slen - 1], "-%u", &idx)))
523 return GNUNET_SYSERR;
524 name = GNUNET_strdup (ns_uname);
525 name[slen - 1] = '\0';
527 GNUNET_CRYPTO_hash (name, strlen (name), &nh);
529 fn = get_data_filename_hash (cfg, PS_NAMES_DIR, &nh);
531 if ((GNUNET_OK != GNUNET_DISK_file_test (fn) ||
532 (GNUNET_OK != GNUNET_DISK_file_size (fn, &len, GNUNET_YES, GNUNET_YES))) ||
533 ((idx + 1) * sizeof (struct GNUNET_CRYPTO_EccPublicKey) > len))
536 return GNUNET_SYSERR;
538 fh = GNUNET_DISK_file_open (fn,
539 GNUNET_DISK_OPEN_CREATE |
540 GNUNET_DISK_OPEN_READWRITE,
541 GNUNET_DISK_PERM_USER_READ |
542 GNUNET_DISK_PERM_USER_WRITE);
545 GNUNET_DISK_file_seek (fh, idx * sizeof (struct GNUNET_CRYPTO_EccPublicKey),
546 GNUNET_DISK_SEEK_SET))
548 GNUNET_DISK_file_close (fh);
549 return GNUNET_SYSERR;
551 if (sizeof (struct GNUNET_CRYPTO_EccPublicKey) !=
552 GNUNET_DISK_file_read (fh, pseudonym, sizeof (struct GNUNET_CRYPTO_EccPublicKey)))
554 GNUNET_DISK_file_close (fh);
555 return GNUNET_SYSERR;
557 GNUNET_DISK_file_close (fh);
564 * struct used to list the pseudonym
566 struct ListPseudonymClosure
570 * iterator over pseudonym
572 GNUNET_FS_PseudonymIterator iterator;
575 * Closure for iterator.
580 * Configuration to use.
582 const struct GNUNET_CONFIGURATION_Handle *cfg;
588 * Helper function to list all available pseudonyms
590 * @param cls point to a struct ListPseudonymClosure
591 * @param fullname name of pseudonym
594 list_pseudonym_helper (void *cls, const char *fullname)
596 struct ListPseudonymClosure *lpc = cls;
597 struct GNUNET_CRYPTO_EccPublicKey pd;
599 struct GNUNET_BIO_ReadHandle *fileR;
602 struct GNUNET_CONTAINER_MetaData *meta;
606 if (NULL == (fileR = GNUNET_BIO_read_open (fullname)))
607 return GNUNET_SYSERR;
610 if ( (GNUNET_OK != GNUNET_BIO_read (fileR, "pseudonym", &pd, sizeof (pd))) ||
611 (GNUNET_OK != GNUNET_BIO_read_int32 (fileR, &rank)) ||
613 GNUNET_BIO_read_string (fileR, "Read string error!", &ns_name, 200)) ||
615 GNUNET_BIO_read_meta_data (fileR, "Read meta data error!", &meta)) )
617 (void) GNUNET_BIO_read_close (fileR, &emsg);
618 GNUNET_free_non_null (emsg);
619 GNUNET_free_non_null (ns_name);
620 GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fullname));
621 return GNUNET_SYSERR;
624 ns_name = GNUNET_strdup (_("no-name"));
625 if (GNUNET_OK != GNUNET_BIO_read_close (fileR, &emsg))
627 LOG (GNUNET_ERROR_TYPE_WARNING,
628 _("Failed to parse metadata about pseudonym from file `%s': %s\n"), fullname,
630 GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fullname));
631 GNUNET_CONTAINER_meta_data_destroy (meta);
632 GNUNET_free (ns_name);
633 GNUNET_free_non_null (emsg);
634 return GNUNET_SYSERR;
637 name_unique = GNUNET_FS_pseudonym_name_uniquify (lpc->cfg, &pd, ns_name, NULL);
638 if (NULL != lpc->iterator)
639 ret = lpc->iterator (lpc->iterator_cls, &pd, ns_name, name_unique, meta, rank);
640 GNUNET_free (ns_name);
641 GNUNET_free_non_null (name_unique);
642 GNUNET_CONTAINER_meta_data_destroy (meta);
648 * List all available pseudonyms.
650 * @param cfg overall configuration
651 * @param iterator function to call for each pseudonym
652 * @param iterator_cls closure for iterator
653 * @return number of pseudonyms found
656 GNUNET_FS_pseudonym_list_all (const struct GNUNET_CONFIGURATION_Handle *cfg,
657 GNUNET_FS_PseudonymIterator iterator,
660 struct ListPseudonymClosure cls;
664 cls.iterator = iterator;
665 cls.iterator_cls = iterator_cls;
667 fn = get_data_filename (cfg, PS_METADATA_DIR, NULL);
668 GNUNET_assert (fn != NULL);
669 GNUNET_DISK_directory_create (fn);
670 ret = GNUNET_DISK_directory_scan (fn, &list_pseudonym_helper, &cls);
677 * Change the rank of a pseudonym.
679 * @param cfg overall configuration
680 * @param pseudonym the pseudonym
681 * @param delta by how much should the rating be changed?
682 * @return new rating of the pseudonym
685 GNUNET_FS_pseudonym_rank (const struct GNUNET_CONFIGURATION_Handle *cfg,
686 const struct GNUNET_CRYPTO_EccPublicKey *pseudonym,
689 struct GNUNET_CONTAINER_MetaData *meta;
695 ret = read_info (cfg, pseudonym, &meta, &rank, &name);
696 if (ret == GNUNET_SYSERR)
699 meta = GNUNET_CONTAINER_meta_data_create ();
702 GNUNET_FS_pseudonym_set_info (cfg, pseudonym, name, meta, rank);
703 GNUNET_CONTAINER_meta_data_destroy (meta);
704 GNUNET_free_non_null (name);
710 * Add a pseudonym to the set of known pseudonyms.
711 * For all pseudonym advertisements that we discover
712 * FS should automatically call this function.
714 * @param cfg overall configuration
715 * @param pseudonym the pseudonym to add
716 * @param meta metadata for the pseudonym
717 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
720 GNUNET_FS_pseudonym_add (const struct GNUNET_CONFIGURATION_Handle *cfg,
721 const struct GNUNET_CRYPTO_EccPublicKey *pseudonym,
722 const struct GNUNET_CONTAINER_MetaData *meta)
726 struct GNUNET_CONTAINER_MetaData *old;
732 fn = get_data_filename (cfg, PS_METADATA_DIR, pseudonym);
733 GNUNET_assert (fn != NULL);
735 if ((0 == STAT (fn, &sbuf)) &&
736 (GNUNET_OK == read_info (cfg, pseudonym, &old, &rank, &name)))
738 GNUNET_CONTAINER_meta_data_merge (old, meta);
739 ret = GNUNET_FS_pseudonym_set_info (cfg, pseudonym, name, old, rank);
740 GNUNET_CONTAINER_meta_data_destroy (old);
741 GNUNET_free_non_null (name);
745 ret = GNUNET_FS_pseudonym_set_info (cfg, pseudonym, NULL, meta, rank);
748 internal_notify (pseudonym, meta, rank);
754 /* end of pseudonym.c */