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"
33 #define PS_METADATA_DIR DIR_SEPARATOR_STR "data" DIR_SEPARATOR_STR "pseudonyms/metadata" DIR_SEPARATOR_STR
34 #define PS_NAMES_DIR DIR_SEPARATOR_STR "data" DIR_SEPARATOR_STR "pseudonyms/names" DIR_SEPARATOR_STR
36 struct DiscoveryCallback
38 struct DiscoveryCallback *next;
39 GNUNET_PSEUDONYM_Iterator callback;
43 static struct DiscoveryCallback *head;
46 * Internal notification about new tracked URI.
49 internal_notify (const GNUNET_HashCode * id,
50 const struct GNUNET_CONTAINER_MetaData *md, int rating)
52 struct DiscoveryCallback *pos;
57 pos->callback (pos->closure, id, md, rating);
63 * Register callback to be invoked whenever we discover
67 GNUNET_PSEUDONYM_discovery_callback_register (struct
68 GNUNET_CONFIGURATION_Handle
70 GNUNET_PSEUDONYM_Iterator
71 iterator, void *closure)
73 struct DiscoveryCallback *list;
75 list = GNUNET_malloc (sizeof (struct DiscoveryCallback));
76 list->callback = iterator;
77 list->closure = closure;
80 GNUNET_PSEUDONYM_list_all (cfg, iterator, closure);
85 * Unregister pseudonym discovery callback.
88 GNUNET_PSEUDONYM_discovery_callback_unregister (GNUNET_PSEUDONYM_Iterator
89 iterator, void *closure)
91 struct DiscoveryCallback *prev;
92 struct DiscoveryCallback *pos;
96 while ((pos != NULL) &&
97 ((pos->callback != iterator) || (pos->closure != closure)))
103 return GNUNET_SYSERR;
107 prev->next = pos->next;
114 * Get the filename (or directory name) for the given
115 * pseudonym identifier and directory prefix.
118 get_data_filename (struct GNUNET_CONFIGURATION_Handle
119 *cfg, const char *prefix, const GNUNET_HashCode * psid)
121 struct GNUNET_CRYPTO_HashAsciiEncoded enc;
124 GNUNET_CRYPTO_hash_to_enc (psid, &enc);
125 return GNUNET_DISK_get_home_filename (cfg,
126 GNUNET_CLIENT_SERVICE_NAME,
129 NULL) ? NULL : (const char *) &enc,
134 write_pseudonym_info (struct GNUNET_CONFIGURATION_Handle *cfg,
135 const GNUNET_HashCode * nsid,
136 const struct GNUNET_CONTAINER_MetaData *meta,
137 int32_t ranking, const char *ns_name)
145 fn = get_data_filename (cfg, PS_METADATA_DIR, nsid);
146 GNUNET_assert (fn != NULL);
147 size = GNUNET_CONTAINER_meta_data_get_serialized_size (meta,
148 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL);
149 tag = size + sizeof (int) + 1;
153 off = strlen (ns_name);
156 buf = GNUNET_malloc (tag);
157 ((int *) buf)[0] = htonl (ranking); /* ranking */
160 memcpy (&buf[sizeof (int)], ns_name, off + 1);
164 buf[sizeof (int)] = '\0';
167 (size == GNUNET_CONTAINER_meta_data_serialize (meta,
172 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL));
173 GNUNET_DISK_file_write (fn, buf, tag, "660");
176 /* create entry for pseudonym name in names */
177 GNUNET_free_non_null (GNUNET_PSEUDONYM_id_to_name (cfg, nsid));
181 read_info (struct GNUNET_CONFIGURATION_Handle *cfg,
182 const GNUNET_HashCode * nsid,
183 struct GNUNET_CONTAINER_MetaData **meta,
184 int32_t * ranking, char **ns_name)
186 unsigned long long len;
197 fn = get_data_filename (cfg, PS_METADATA_DIR, nsid);
198 GNUNET_assert (fn != NULL);
200 if ((0 != STAT (fn, &sbuf))
201 || (GNUNET_OK != GNUNET_DISK_file_size (fn, &len, GNUNET_YES)))
204 return GNUNET_SYSERR;
206 if (len <= sizeof (int) + 1)
209 return GNUNET_SYSERR;
211 if (len > 16 * 1024 * 1024)
213 /* too big, must be invalid! remove! */
215 if (0 != UNLINK (fn))
216 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
218 return GNUNET_SYSERR;
220 buf = GNUNET_malloc (len);
221 if (len != GNUNET_DISK_file_read (fn, len, buf))
225 return GNUNET_SYSERR;
228 *ranking = ntohl (((int *) buf)[0]);
230 while ((zend < len) && (buf[zend] != '\0'))
236 return GNUNET_SYSERR;
240 if (zend != sizeof (int))
241 *ns_name = GNUNET_strdup (&buf[sizeof (int)]);
249 *meta = GNUNET_CONTAINER_meta_data_deserialize (&buf[zend], size);
252 /* invalid data! remove! */
254 if (0 != UNLINK (fn))
255 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
259 return GNUNET_SYSERR;
270 * Return the unique, human readable name for the given namespace.
272 * @return NULL on failure (should never happen)
275 GNUNET_PSEUDONYM_id_to_name (struct GNUNET_CONFIGURATION_Handle *cfg,
276 const GNUNET_HashCode * nsid)
278 struct GNUNET_CONTAINER_MetaData *meta;
282 unsigned long long len;
291 if (GNUNET_OK == read_info (cfg, nsid, &meta, NULL, &name))
293 if ((meta != NULL) && (name == NULL))
294 name = GNUNET_CONTAINER_meta_data_get_first_by_types (meta,
297 EXTRACTOR_DESCRIPTION,
307 GNUNET_CONTAINER_meta_data_destroy (meta);
312 name = GNUNET_strdup (_("no-name"));
313 GNUNET_CRYPTO_hash (name, strlen (name), &nh);
314 fn = get_data_filename (cfg, PS_NAMES_DIR, &nh);
315 GNUNET_assert (fn != NULL);
318 if (0 == STAT (fn, &sbuf))
319 GNUNET_DISK_file_size (fn, &len, GNUNET_YES);
320 fd = GNUNET_DISK_file_open (fn, O_CREAT | O_RDWR, S_IRUSR | S_IWUSR);
323 while ((len >= sizeof (GNUNET_HashCode)) &&
324 (sizeof (GNUNET_HashCode)
325 == READ (fd, &nh, sizeof (GNUNET_HashCode))))
327 if (0 == memcmp (&nh, nsid, sizeof (GNUNET_HashCode)))
333 len -= sizeof (GNUNET_HashCode);
338 if (sizeof (GNUNET_HashCode) !=
339 WRITE (fd, nsid, sizeof (GNUNET_HashCode)))
340 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", fn);
343 ret = GNUNET_malloc (strlen (name) + 32);
344 GNUNET_snprintf (ret, strlen (name) + 32, "%s-%u", name, idx);
351 * Get the namespace ID belonging to the given namespace name.
353 * @return GNUNET_OK on success
356 GNUNET_PSEUDONYM_name_to_id (struct GNUNET_CONFIGURATION_Handle *cfg,
357 const char *ns_uname, GNUNET_HashCode * nsid)
360 unsigned long long len;
368 slen = strlen (ns_uname);
369 while ((slen > 0) && (1 != sscanf (&ns_uname[slen - 1], "-%u", &idx)))
372 return GNUNET_SYSERR;
373 name = GNUNET_strdup (ns_uname);
374 name[slen - 1] = '\0';
375 GNUNET_CRYPTO_hash (name, strlen (name), &nh);
377 fn = get_data_filename (cfg, PS_NAMES_DIR, &nh);
378 GNUNET_assert (fn != NULL);
380 if ((GNUNET_OK != GNUNET_DISK_file_test (fn) ||
381 (GNUNET_OK != GNUNET_DISK_file_size (fn, &len, GNUNET_YES))) ||
382 ((idx + 1) * sizeof (GNUNET_HashCode) > len))
385 return GNUNET_SYSERR;
387 fd = GNUNET_DISK_file_open (fn, O_CREAT | O_RDWR, S_IRUSR | S_IWUSR);
389 LSEEK (fd, idx * sizeof (GNUNET_HashCode), SEEK_SET);
390 if (sizeof (GNUNET_HashCode) != READ (fd, nsid, sizeof (GNUNET_HashCode)))
393 return GNUNET_SYSERR;
402 struct ListPseudonymClosure
404 GNUNET_PSEUDONYM_Iterator iterator;
406 struct GNUNET_CONFIGURATION_Handle *cfg;
410 list_pseudonym_helper (void *cls, const char *fullname)
412 struct ListPseudonymClosure *c = cls;
416 struct GNUNET_CONTAINER_MetaData *meta;
419 if (strlen (fullname) < sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded))
422 &fullname[strlen (fullname) + 1 -
423 sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
424 if (fn[-1] != DIR_SEPARATOR)
427 if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (fn, &id))
428 return GNUNET_OK; /* invalid name */
429 if (GNUNET_OK != read_info (c->cfg, &id, &meta, &rating, NULL))
430 return GNUNET_OK; /* ignore entry */
431 if (c->iterator != NULL)
432 ret = c->iterator (c->closure, &id, meta, rating);
433 GNUNET_CONTAINER_meta_data_destroy (meta);
438 * List all available pseudonyms.
441 GNUNET_PSEUDONYM_list_all (struct GNUNET_CONFIGURATION_Handle *cfg,
442 GNUNET_PSEUDONYM_Iterator iterator, void *closure)
444 struct ListPseudonymClosure cls;
448 cls.iterator = iterator;
449 cls.closure = closure;
451 fn = get_data_filename (cfg, PS_METADATA_DIR, NULL);
452 GNUNET_assert (fn != NULL);
453 GNUNET_DISK_directory_create (fn);
454 ret = GNUNET_DISK_directory_scan (fn, &list_pseudonym_helper, &cls);
460 * Change the ranking of a pseudonym.
462 * @param nsid id of the pseudonym
463 * @param delta by how much should the rating be
465 * @return new rating of the pseudonym
468 GNUNET_PSEUDONYM_rank (struct GNUNET_CONFIGURATION_Handle *cfg,
469 const GNUNET_HashCode * nsid, int delta)
471 struct GNUNET_CONTAINER_MetaData *meta;
477 ret = read_info (cfg, nsid, &meta, &ranking, &name);
478 if (ret == GNUNET_SYSERR)
481 meta = GNUNET_CONTAINER_meta_data_create ();
484 write_pseudonym_info (cfg, nsid, meta, ranking, name);
485 GNUNET_CONTAINER_meta_data_destroy (meta);
486 GNUNET_free_non_null (name);
491 * Insert metadata into existing MD record (passed as cls).
494 merge_meta_helper (EXTRACTOR_KeywordType type, const char *data, void *cls)
496 struct GNUNET_CONTAINER_MetaData *meta = cls;
497 GNUNET_CONTAINER_meta_data_insert (meta, type, data);
504 * Add a pseudonym to the set of known pseudonyms.
505 * For all pseudonym advertisements that we discover
506 * FSUI should automatically call this function.
508 * @param id the pseudonym identifier
511 GNUNET_PSEUDONYM_add (struct GNUNET_CONFIGURATION_Handle *cfg,
512 const GNUNET_HashCode * id,
513 const struct GNUNET_CONTAINER_MetaData *meta)
517 struct GNUNET_CONTAINER_MetaData *old;
522 fn = get_data_filename (cfg, PS_METADATA_DIR, id);
523 GNUNET_assert (fn != NULL);
525 if ((0 == STAT (fn, &sbuf)) &&
526 (GNUNET_OK == read_info (cfg, id, &old, &ranking, &name)))
528 GNUNET_CONTAINER_meta_data_get_contents (meta, &merge_meta_helper, old);
529 write_pseudonym_info (cfg, id, old, ranking, name);
530 GNUNET_CONTAINER_meta_data_destroy (old);
531 GNUNET_free_non_null (name);
535 write_pseudonym_info (cfg, id, meta, ranking, NULL);
538 internal_notify (id, meta, ranking);
545 /* end of pseudonym.c */