2 This file is part of GNUnet
3 (C) 2003, 2004, 2005, 2006, 2007, 2008 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 2, 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.
22 * @file util/pseudonym.c
23 * @brief helper functions
24 * @author Christian Grothoff
28 #include "gnunet_common.h"
29 #include "gnunet_container_lib.h"
30 #include "gnunet_disk_lib.h"
31 #include "gnunet_pseudonym_lib.h"
32 #include "gnunet_bio_lib.h"
35 * Name of the directory which stores meta data for pseudonym
37 #define PS_METADATA_DIR DIR_SEPARATOR_STR "data" DIR_SEPARATOR_STR "pseudonyms" DIR_SEPARATOR_STR "metadata" DIR_SEPARATOR_STR
40 * Name of the directory which stores names for pseudonyms
42 #define PS_NAMES_DIR DIR_SEPARATOR_STR "data" DIR_SEPARATOR_STR "pseudonyms" DIR_SEPARATOR_STR "names" DIR_SEPARATOR_STR
46 * Registered callbacks for discovery of pseudonyms.
48 struct DiscoveryCallback
51 * This is a linked list.
53 struct DiscoveryCallback *next;
56 * Function to call each time a pseudonym is discovered.
58 GNUNET_PSEUDONYM_Iterator callback;
61 * Closure for callback.
68 * Head of the linked list of functions to call when
69 * new pseudonyms are added.
71 static struct DiscoveryCallback *head;
74 * Internal notification about new tracked URI.
75 * @param id a point to the hash code of pseudonym
76 * @param md meta data to be written
77 * @param rating rating of pseudonym
80 internal_notify (const GNUNET_HashCode * id,
81 const struct GNUNET_CONTAINER_MetaData *md, int rating)
83 struct DiscoveryCallback *pos;
88 pos->callback (pos->closure, id, md, rating);
94 * Register callback to be invoked whenever we discover
96 * @param cfg configuration to use
97 * @param iterator iterator over pseudonym
98 * @param closure point to a closure
101 GNUNET_PSEUDONYM_discovery_callback_register (const struct
102 GNUNET_CONFIGURATION_Handle *cfg,
103 GNUNET_PSEUDONYM_Iterator
104 iterator, void *closure)
106 struct DiscoveryCallback *list;
108 list = GNUNET_malloc (sizeof (struct DiscoveryCallback));
109 list->callback = iterator;
110 list->closure = closure;
113 GNUNET_PSEUDONYM_list_all (cfg, iterator, closure);
118 * Unregister pseudonym discovery callback.
119 * @param iterator iterator over pseudonym
120 * @param closure point to a closure
123 GNUNET_PSEUDONYM_discovery_callback_unregister (GNUNET_PSEUDONYM_Iterator
124 iterator, void *closure)
126 struct DiscoveryCallback *prev;
127 struct DiscoveryCallback *pos;
131 while ((pos != NULL) &&
132 ((pos->callback != iterator) || (pos->closure != closure)))
138 return GNUNET_SYSERR;
142 prev->next = pos->next;
149 * Get the filename (or directory name) for the given
150 * pseudonym identifier and directory prefix.
151 * @param cfg configuration to use
152 * @param prefix path components to append to the private directory name
153 * @param psid hash code of pseudonym, can be NULL
154 * @return filename of the pseudonym (if psid != NULL) or directory with the data (if psid == NULL)
157 get_data_filename (const struct GNUNET_CONFIGURATION_Handle *cfg,
158 const char *prefix, const GNUNET_HashCode * psid)
160 struct GNUNET_CRYPTO_HashAsciiEncoded enc;
163 GNUNET_CRYPTO_hash_to_enc (psid, &enc);
164 return GNUNET_DISK_get_home_filename (cfg, GNUNET_CLIENT_SERVICE_NAME, prefix,
166 NULL) ? NULL : (const char *) &enc,
172 * Write the pseudonym infomation into a file
173 * @param cfg configuration to use
174 * @param nsid hash code of a pseudonym
175 * @param meta meta data to be written into a file
176 * @param ranking ranking of a pseudonym
177 * @param ns_name name of a pseudonym
180 write_pseudonym_info (const struct GNUNET_CONFIGURATION_Handle *cfg,
181 const GNUNET_HashCode * nsid,
182 const struct GNUNET_CONTAINER_MetaData *meta,
183 int32_t ranking, const char *ns_name)
186 struct GNUNET_BIO_WriteHandle *fileW;
188 fn = get_data_filename (cfg, PS_METADATA_DIR, nsid);
189 GNUNET_assert (fn != NULL);
190 fileW = GNUNET_BIO_write_open (fn);
193 if ((GNUNET_OK != GNUNET_BIO_write_int32 (fileW, ranking)) ||
194 (GNUNET_OK != GNUNET_BIO_write_string (fileW, ns_name)) ||
195 (GNUNET_OK != GNUNET_BIO_write_meta_data (fileW, meta)))
197 (void) GNUNET_BIO_write_close (fileW);
198 GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
202 if (GNUNET_OK != GNUNET_BIO_write_close (fileW))
204 GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
210 /* create entry for pseudonym name in names */
211 /* FIXME: 90% of what this call does is not needed
212 * here => refactor code to only create the entry! */
213 GNUNET_free_non_null (GNUNET_PSEUDONYM_id_to_name (cfg, nsid));
218 * read the pseudonym infomation from a file
219 * @param cfg configuration to use
220 * @param nsid hash code of a pseudonym
221 * @param meta meta data to be read from a file
222 * @param ranking ranking of a pseudonym
223 * @param ns_name name of a pseudonym
226 read_info (const struct GNUNET_CONFIGURATION_Handle *cfg,
227 const GNUNET_HashCode * nsid,
228 struct GNUNET_CONTAINER_MetaData **meta, int32_t * ranking,
233 struct GNUNET_BIO_ReadHandle *fileR;
235 fn = get_data_filename (cfg, PS_METADATA_DIR, nsid);
236 GNUNET_assert (fn != NULL);
237 fileR = GNUNET_BIO_read_open (fn);
241 return GNUNET_SYSERR;
245 if ((GNUNET_OK != GNUNET_BIO_read_int32 (fileR, ranking)) ||
247 GNUNET_BIO_read_string (fileR, "Read string error!", ns_name, 200)) ||
249 GNUNET_BIO_read_meta_data (fileR, "Read meta data error!", meta)))
251 (void) GNUNET_BIO_read_close (fileR, &emsg);
252 GNUNET_free_non_null (emsg);
253 GNUNET_free_non_null (*ns_name);
255 GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
257 return GNUNET_SYSERR;
259 if (GNUNET_OK != GNUNET_BIO_read_close (fileR, &emsg))
261 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
263 ("Failed to parse metadata about pseudonym from file `%s': %s\n"),
265 GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
266 GNUNET_CONTAINER_meta_data_destroy (*meta);
268 GNUNET_free_non_null (*ns_name);
270 GNUNET_free_non_null (emsg);
272 return GNUNET_SYSERR;
281 * Return the unique, human readable name for the given namespace.
283 * @param cfg configuration
284 * @param nsid cryptographic ID of the namespace
285 * @return NULL on failure (should never happen)
288 GNUNET_PSEUDONYM_id_to_name (const struct GNUNET_CONFIGURATION_Handle *cfg,
289 const GNUNET_HashCode * nsid)
291 struct GNUNET_CONTAINER_MetaData *meta;
296 struct GNUNET_DISK_FileHandle *fh;
302 int32_t *rank = &temp;
306 if (GNUNET_OK == read_info (cfg, nsid, &meta, rank, &name))
308 if ((meta != NULL) && (name == NULL))
310 GNUNET_CONTAINER_meta_data_get_first_by_types (meta,
311 EXTRACTOR_METATYPE_TITLE,
312 EXTRACTOR_METATYPE_FILENAME,
313 EXTRACTOR_METATYPE_DESCRIPTION,
314 EXTRACTOR_METATYPE_SUBJECT,
315 EXTRACTOR_METATYPE_PUBLISHER,
316 EXTRACTOR_METATYPE_AUTHOR_NAME,
317 EXTRACTOR_METATYPE_COMMENT,
318 EXTRACTOR_METATYPE_SUMMARY,
322 GNUNET_CONTAINER_meta_data_destroy (meta);
327 name = GNUNET_strdup (_("no-name"));
328 GNUNET_CRYPTO_hash (name, strlen (name), &nh);
329 fn = get_data_filename (cfg, PS_NAMES_DIR, &nh);
330 GNUNET_assert (fn != NULL);
333 if (0 == STAT (fn, &sbuf))
334 GNUNET_DISK_file_size (fn, &len, GNUNET_YES);
335 fh = GNUNET_DISK_file_open (fn,
336 GNUNET_DISK_OPEN_CREATE |
337 GNUNET_DISK_OPEN_READWRITE,
338 GNUNET_DISK_PERM_USER_READ |
339 GNUNET_DISK_PERM_USER_WRITE);
342 while ((len >= sizeof (GNUNET_HashCode)) &&
343 (sizeof (GNUNET_HashCode) ==
344 GNUNET_DISK_file_read (fh, &nh, sizeof (GNUNET_HashCode))))
346 if (0 == memcmp (&nh, nsid, sizeof (GNUNET_HashCode)))
352 len -= sizeof (GNUNET_HashCode);
357 if (sizeof (GNUNET_HashCode) !=
358 GNUNET_DISK_file_write (fh, nsid, sizeof (GNUNET_HashCode)))
359 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", fn);
361 GNUNET_DISK_file_close (fh);
362 ret = GNUNET_malloc (strlen (name) + 32);
363 GNUNET_snprintf (ret, strlen (name) + 32, "%s-%u", name, idx);
370 * Get the namespace ID belonging to the given namespace name.
372 * @param cfg configuration to use
373 * @param ns_uname human-readable name for the namespace
374 * @param nsid set to namespace ID based on 'ns_uname'
375 * @return GNUNET_OK on success
378 GNUNET_PSEUDONYM_name_to_id (const struct GNUNET_CONFIGURATION_Handle *cfg,
379 const char *ns_uname, GNUNET_HashCode * nsid)
387 struct GNUNET_DISK_FileHandle *fh;
390 slen = strlen (ns_uname);
391 while ((slen > 0) && (1 != sscanf (&ns_uname[slen - 1], "-%u", &idx)))
394 return GNUNET_SYSERR;
395 name = GNUNET_strdup (ns_uname);
396 name[slen - 1] = '\0';
397 GNUNET_CRYPTO_hash (name, strlen (name), &nh);
399 fn = get_data_filename (cfg, PS_NAMES_DIR, &nh);
400 GNUNET_assert (fn != NULL);
402 if ((GNUNET_OK != GNUNET_DISK_file_test (fn) ||
403 (GNUNET_OK != GNUNET_DISK_file_size (fn, &len, GNUNET_YES))) ||
404 ((idx + 1) * sizeof (GNUNET_HashCode) > len))
407 return GNUNET_SYSERR;
409 fh = GNUNET_DISK_file_open (fn,
410 GNUNET_DISK_OPEN_CREATE |
411 GNUNET_DISK_OPEN_READWRITE,
412 GNUNET_DISK_PERM_USER_READ |
413 GNUNET_DISK_PERM_USER_WRITE);
415 GNUNET_DISK_file_seek (fh, idx * sizeof (GNUNET_HashCode),
416 GNUNET_DISK_SEEK_SET);
417 if (sizeof (GNUNET_HashCode) !=
418 GNUNET_DISK_file_read (fh, nsid, sizeof (GNUNET_HashCode)))
420 GNUNET_DISK_file_close (fh);
421 return GNUNET_SYSERR;
423 GNUNET_DISK_file_close (fh);
430 * struct used to list the pseudonym
432 struct ListPseudonymClosure
436 * iterator over pseudonym
438 GNUNET_PSEUDONYM_Iterator iterator;
441 * Closure for iterator.
446 * Configuration to use.
448 const struct GNUNET_CONFIGURATION_Handle *cfg;
454 * the help function to list all available pseudonyms
455 * @param cls point to a struct ListPseudonymClosure
456 * @param fullname name of pseudonym
459 list_pseudonym_helper (void *cls, const char *fullname)
461 struct ListPseudonymClosure *c = cls;
465 struct GNUNET_CONTAINER_MetaData *meta;
469 if (strlen (fullname) < sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded))
471 fn = &fullname[strlen (fullname) + 1 -
472 sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
473 if (fn[-1] != DIR_SEPARATOR)
476 if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (fn, &id))
477 return GNUNET_OK; /* invalid name */
479 if (GNUNET_OK != read_info (c->cfg, &id, &meta, &rating, &str))
480 return GNUNET_OK; /* ignore entry */
481 GNUNET_free_non_null (str);
482 if (c->iterator != NULL)
483 ret = c->iterator (c->closure, &id, meta, rating);
484 GNUNET_CONTAINER_meta_data_destroy (meta);
490 * List all available pseudonyms.
492 * @param cfg overall configuration
493 * @param iterator function to call for each pseudonym
494 * @param closure closure for iterator
495 * @return number of pseudonyms found
498 GNUNET_PSEUDONYM_list_all (const struct GNUNET_CONFIGURATION_Handle *cfg,
499 GNUNET_PSEUDONYM_Iterator iterator, void *closure)
501 struct ListPseudonymClosure cls;
505 cls.iterator = iterator;
506 cls.closure = closure;
508 fn = get_data_filename (cfg, PS_METADATA_DIR, NULL);
509 GNUNET_assert (fn != NULL);
510 GNUNET_DISK_directory_create (fn);
511 ret = GNUNET_DISK_directory_scan (fn, &list_pseudonym_helper, &cls);
518 * Change the ranking of a pseudonym.
520 * @param cfg overall configuration
521 * @param nsid id of the pseudonym
522 * @param delta by how much should the rating be
524 * @return new rating of the pseudonym
527 GNUNET_PSEUDONYM_rank (const struct GNUNET_CONFIGURATION_Handle *cfg,
528 const GNUNET_HashCode * nsid, int delta)
530 struct GNUNET_CONTAINER_MetaData *meta;
536 ret = read_info (cfg, nsid, &meta, &ranking, &name);
537 if (ret == GNUNET_SYSERR)
540 meta = GNUNET_CONTAINER_meta_data_create ();
543 write_pseudonym_info (cfg, nsid, meta, ranking, name);
544 GNUNET_CONTAINER_meta_data_destroy (meta);
545 GNUNET_free_non_null (name);
551 * Add a pseudonym to the set of known pseudonyms.
552 * For all pseudonym advertisements that we discover
553 * FS should automatically call this function.
555 * @param cfg overall configuration
556 * @param id the pseudonym identifier
557 * @param meta metadata for the pseudonym
560 GNUNET_PSEUDONYM_add (const struct GNUNET_CONFIGURATION_Handle *cfg,
561 const GNUNET_HashCode * id,
562 const struct GNUNET_CONTAINER_MetaData *meta)
566 struct GNUNET_CONTAINER_MetaData *old;
571 fn = get_data_filename (cfg, PS_METADATA_DIR, id);
572 GNUNET_assert (fn != NULL);
574 if ((0 == STAT (fn, &sbuf)) &&
575 (GNUNET_OK == read_info (cfg, id, &old, &ranking, &name)))
577 GNUNET_CONTAINER_meta_data_merge (old, meta);
578 write_pseudonym_info (cfg, id, old, ranking, name);
579 GNUNET_CONTAINER_meta_data_destroy (old);
580 GNUNET_free_non_null (name);
584 write_pseudonym_info (cfg, id, meta, ranking, NULL);
587 internal_notify (id, meta, ranking);
591 /* end of pseudonym.c */