src/util/pseudonym.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2003, 2004, 2005, 2006, 2007, 2008 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file util/pseudonym.c
  23  * @brief helper functions
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  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"
  33
  34 /**
  35  * Name of the directory which stores meta data for pseudonym
  36  */
  37 #define PS_METADATA_DIR DIR_SEPARATOR_STR "data" DIR_SEPARATOR_STR "pseudonyms" DIR_SEPARATOR_STR "metadata" DIR_SEPARATOR_STR
  38
  39 /**
  40  * Name of the directory which stores names for pseudonyms
  41  */
  42 #define PS_NAMES_DIR    DIR_SEPARATOR_STR "data" DIR_SEPARATOR_STR "pseudonyms" DIR_SEPARATOR_STR "names"    DIR_SEPARATOR_STR
  43
  44
  45 /**
  46  * Registered callbacks for discovery of pseudonyms.
  47  */
  48 struct DiscoveryCallback
  49 {
  50   /**
  51    * This is a linked list.
  52    */
  53   struct DiscoveryCallback *next;
  54
  55   /**
  56    * Function to call each time a pseudonym is discovered.
  57    */
  58   GNUNET_PSEUDONYM_Iterator callback;
  59
  60   /**
  61    * Closure for callback.
  62    */
  63   void *closure;
  64 };
  65
  66
  67 /**
  68  * Head of the linked list of functions to call when
  69  * new pseudonyms are added.
  70  */
  71 static struct DiscoveryCallback *head;
  72
  73 /**
  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
  78  */
  79 static void
  80 internal_notify (const GNUNET_HashCode * id,
  81                  const struct GNUNET_CONTAINER_MetaData *md, int rating)
  82 {
  83   struct DiscoveryCallback *pos;
  84
  85   pos = head;
  86   while (pos != NULL)
  87     {
  88       pos->callback (pos->closure, id, md, rating);
  89       pos = pos->next;
  90     }
  91 }
  92
  93 /**
  94  * Register callback to be invoked whenever we discover
  95  * a new pseudonym.
  96  * @param cfg configuration to use
  97  * @param iterator iterator over pseudonym
  98  * @param closure point to a closure
  99  */
 100 int
 101 GNUNET_PSEUDONYM_discovery_callback_register (const struct
 102                                               GNUNET_CONFIGURATION_Handle
 103                                               *cfg,
 104                                               GNUNET_PSEUDONYM_Iterator
 105                                               iterator, void *closure)
 106 {
 107   struct DiscoveryCallback *list;
 108
 109   list = GNUNET_malloc (sizeof (struct DiscoveryCallback));
 110   list->callback = iterator;
 111   list->closure = closure;
 112   list->next = head;
 113   head = list;
 114   GNUNET_PSEUDONYM_list_all (cfg, iterator, closure);
 115   return GNUNET_OK;
 116 }
 117
 118 /**
 119  * Unregister pseudonym discovery callback.
 120  * @param iterator iterator over pseudonym
 121  * @param closure point to a closure
 122  */
 123 int
 124 GNUNET_PSEUDONYM_discovery_callback_unregister (GNUNET_PSEUDONYM_Iterator
 125                                                 iterator, void *closure)
 126 {
 127   struct DiscoveryCallback *prev;
 128   struct DiscoveryCallback *pos;
 129
 130   prev = NULL;
 131   pos = head;
 132   while ((pos != NULL) &&
 133          ((pos->callback != iterator) || (pos->closure != closure)))
 134     {
 135       prev = pos;
 136       pos = pos->next;
 137     }
 138   if (pos == NULL)
 139     return GNUNET_SYSERR;
 140   if (prev == NULL)
 141     head = pos->next;
 142   else
 143     prev->next = pos->next;
 144   GNUNET_free (pos);
 145   return GNUNET_OK;
 146 }
 147
 148
 149 /**
 150  * Get the filename (or directory name) for the given
 151  * pseudonym identifier and directory prefix.
 152  * @param cfg configuration to use
 153  * @param prefix path components to append to the private directory name
 154  * @param psid hash code of pseudonym, can be NULL
 155  * @return filename of the pseudonym (if psid != NULL) or directory with the data (if psid == NULL)
 156  */
 157 static char *
 158 get_data_filename (const struct GNUNET_CONFIGURATION_Handle
 159                    *cfg, const char *prefix, const GNUNET_HashCode * psid)
 160 {
 161   struct GNUNET_CRYPTO_HashAsciiEncoded enc;
 162
 163   if (psid != NULL)
 164     GNUNET_CRYPTO_hash_to_enc (psid, &enc);
 165   return GNUNET_DISK_get_home_filename (cfg,
 166                                         GNUNET_CLIENT_SERVICE_NAME,
 167                                         prefix,
 168                                         (psid ==
 169                                          NULL) ? NULL : (const char *) &enc,
 170                                         NULL);
 171 }
 172
 173
 174 /**
 175  * Write the pseudonym infomation into a file
 176  * @param cfg configuration to use
 177  * @param nsid hash code of a pseudonym
 178  * @param meta meta data to be written into a file
 179  * @param ranking ranking of a pseudonym
 180  * @param ns_name name of a pseudonym
 181  */
 182 static void
 183 write_pseudonym_info (const struct GNUNET_CONFIGURATION_Handle *cfg,
 184                       const GNUNET_HashCode * nsid,
 185                       const struct GNUNET_CONTAINER_MetaData *meta,
 186                       int32_t ranking, const char *ns_name)
 187 {
 188   char *fn;
 189   struct GNUNET_BIO_WriteHandle *fileW;
 190
 191   fn = get_data_filename (cfg, PS_METADATA_DIR, nsid);
 192   GNUNET_assert (fn != NULL);
 193   fileW = GNUNET_BIO_write_open(fn);
 194   if (NULL != fileW)
 195     {
 196       if ( (GNUNET_OK != GNUNET_BIO_write_int32(fileW, ranking)) ||
 197            (GNUNET_OK != GNUNET_BIO_write_string(fileW, ns_name)) ||
 198            (GNUNET_OK != GNUNET_BIO_write_meta_data(fileW, meta)) )
 199         {
 200           (void) GNUNET_BIO_write_close(fileW);
 201           GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
 202           GNUNET_free (fn);
 203           return;
 204         }
 205       if (GNUNET_OK != GNUNET_BIO_write_close(fileW))
 206         {
 207           GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
 208           GNUNET_free (fn);
 209           return;
 210         }
 211     }
 212   GNUNET_free (fn);
 213   /* create entry for pseudonym name in names */
 214   /* FIXME: 90% of what this call does is not needed
 215      here => refactor code to only create the entry! */
 216   GNUNET_free_non_null (GNUNET_PSEUDONYM_id_to_name (cfg, nsid));
 217 }
 218
 219
 220 /**
 221  * read the pseudonym infomation from a file
 222  * @param cfg configuration to use
 223  * @param nsid hash code of a pseudonym
 224  * @param meta meta data to be read from a file
 225  * @param ranking ranking of a pseudonym
 226  * @param ns_name name of a pseudonym
 227  */
 228 static int
 229 read_info (const struct GNUNET_CONFIGURATION_Handle *cfg,
 230            const GNUNET_HashCode * nsid,
 231            struct GNUNET_CONTAINER_MetaData **meta,
 232            int32_t * ranking, char **ns_name)
 233 {
 234   char *fn;
 235   char *emsg;
 236   struct GNUNET_BIO_ReadHandle *fileR;
 237
 238   fn = get_data_filename (cfg, PS_METADATA_DIR, nsid);
 239   GNUNET_assert (fn != NULL);
 240   fileR = GNUNET_BIO_read_open(fn);
 241   if (fileR == NULL)
 242     {
 243       GNUNET_free (fn);
 244       return GNUNET_SYSERR;
 245     }
 246   emsg = NULL;
 247   *ns_name = NULL;
 248   if ( (GNUNET_OK != GNUNET_BIO_read_int32 (fileR, ranking)) ||
 249        (GNUNET_OK != GNUNET_BIO_read_string(fileR, "Read string error!", ns_name, 200)) ||
 250        (GNUNET_OK != GNUNET_BIO_read_meta_data(fileR, "Read meta data error!", meta)) )
 251     {
 252       (void) GNUNET_BIO_read_close(fileR, &emsg);
 253       GNUNET_free_non_null (emsg);
 254       GNUNET_free_non_null (*ns_name);
 255       *ns_name = NULL;
 256       GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
 257       GNUNET_free (fn);
 258       return GNUNET_SYSERR;
 259     }
 260   if (GNUNET_OK != GNUNET_BIO_read_close(fileR, &emsg))
 261     {
 262       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 263                   _("Failed to parse metadata about pseudonym from file `%s': %s\n"),
 264                   fn,
 265                   emsg);
 266       GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_remove (fn));
 267       GNUNET_CONTAINER_meta_data_destroy (*meta);
 268       *meta = NULL;
 269       GNUNET_free_non_null (*ns_name);
 270       *ns_name = NULL;
 271       GNUNET_free_non_null (emsg);
 272       GNUNET_free (fn);
 273       return GNUNET_SYSERR;
 274     }
 275   GNUNET_free (fn);
 276   return GNUNET_OK;
 277 }
 278
 279
 280
 281 /**
 282  * Return the unique, human readable name for the given namespace.
 283  *
 284  * @param cfg configuration
 285  * @param nsid cryptographic ID of the namespace
 286  * @return NULL on failure (should never happen)
 287  */
 288 char *
 289 GNUNET_PSEUDONYM_id_to_name (const struct GNUNET_CONFIGURATION_Handle *cfg,
 290                              const GNUNET_HashCode * nsid)
 291 {
 292   struct GNUNET_CONTAINER_MetaData *meta;
 293   char *name;
 294   GNUNET_HashCode nh;
 295   char *fn;
 296   uint64_t len;
 297   struct GNUNET_DISK_FileHandle *fh;
 298   unsigned int i;
 299   unsigned int idx;
 300   char *ret;
 301   struct stat sbuf;
 302   int32_t temp = 0;
 303   int32_t *rank = &temp;
 304
 305   meta = NULL;
 306   name = NULL;
 307   if (GNUNET_OK == read_info (cfg, nsid, &meta, rank, &name))
 308     {
 309       if ((meta != NULL) && (name == NULL))
 310         name = 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,
 319                                                               -1);
 320       if (meta != NULL)
 321         {
 322           GNUNET_CONTAINER_meta_data_destroy (meta);
 323           meta = NULL;
 324         }
 325     }
 326   if (name == NULL)
 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);
 331
 332   len = 0;
 333   if (0 == STAT (fn, &sbuf))
 334     GNUNET_DISK_file_size (fn, &len, GNUNET_YES);
 335   fh = GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_CREATE
 336                               | GNUNET_DISK_OPEN_READWRITE,
 337                               GNUNET_DISK_PERM_USER_READ |
 338                               GNUNET_DISK_PERM_USER_WRITE);
 339   i = 0;
 340   idx = -1;
 341   while ((len >= sizeof (GNUNET_HashCode)) &&
 342          (sizeof (GNUNET_HashCode)
 343           == GNUNET_DISK_file_read (fh, &nh, sizeof (GNUNET_HashCode))))
 344     {
 345       if (0 == memcmp (&nh, nsid, sizeof (GNUNET_HashCode)))
 346         {
 347           idx = i;
 348           break;
 349         }
 350       i++;
 351       len -= sizeof (GNUNET_HashCode);
 352     }
 353   if (idx == -1)
 354     {
 355       idx = i;
 356       if (sizeof (GNUNET_HashCode) !=
 357           GNUNET_DISK_file_write (fh, nsid, sizeof (GNUNET_HashCode)))
 358         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", fn);
 359     }
 360   GNUNET_DISK_file_close (fh);
 361   ret = GNUNET_malloc (strlen (name) + 32);
 362   GNUNET_snprintf (ret, strlen (name) + 32, "%s-%u", name, idx);
 363   GNUNET_free (name);
 364   GNUNET_free (fn);
 365   return ret;
 366 }
 367
 368 /**
 369  * Get the namespace ID belonging to the given namespace name.
 370  *
 371  * @param cfg configuration to use
 372  * @param ns_uname human-readable name for the namespace
 373  * @param nsid set to namespace ID based on 'ns_uname'
 374  * @return GNUNET_OK on success
 375  */
 376 int
 377 GNUNET_PSEUDONYM_name_to_id (const struct GNUNET_CONFIGURATION_Handle *cfg,
 378                              const char *ns_uname, GNUNET_HashCode * nsid)
 379 {
 380   size_t slen;
 381   uint64_t len;
 382   unsigned int idx;
 383   char *name;
 384   GNUNET_HashCode nh;
 385   char *fn;
 386   struct GNUNET_DISK_FileHandle *fh;
 387
 388   idx = -1;
 389   slen = strlen (ns_uname);
 390   while ((slen > 0) && (1 != sscanf (&ns_uname[slen - 1], "-%u", &idx)))
 391     slen--;
 392   if (slen == 0)
 393     return GNUNET_SYSERR;
 394   name = GNUNET_strdup (ns_uname);
 395   name[slen - 1] = '\0';
 396   GNUNET_CRYPTO_hash (name, strlen (name), &nh);
 397   GNUNET_free (name);
 398   fn = get_data_filename (cfg, PS_NAMES_DIR, &nh);
 399   GNUNET_assert (fn != NULL);
 400
 401   if ((GNUNET_OK != GNUNET_DISK_file_test (fn) ||
 402        (GNUNET_OK != GNUNET_DISK_file_size (fn, &len, GNUNET_YES))) ||
 403       ((idx + 1) * sizeof (GNUNET_HashCode) > len))
 404     {
 405       GNUNET_free (fn);
 406       return GNUNET_SYSERR;
 407     }
 408   fh = GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_CREATE
 409                               | GNUNET_DISK_OPEN_READWRITE,
 410                               GNUNET_DISK_PERM_USER_READ |
 411                               GNUNET_DISK_PERM_USER_WRITE);
 412   GNUNET_free (fn);
 413   GNUNET_DISK_file_seek (fh, idx * sizeof (GNUNET_HashCode),
 414                          GNUNET_DISK_SEEK_SET);
 415   if (sizeof (GNUNET_HashCode) !=
 416       GNUNET_DISK_file_read (fh, nsid, sizeof (GNUNET_HashCode)))
 417     {
 418       GNUNET_DISK_file_close (fh);
 419       return GNUNET_SYSERR;
 420     }
 421   GNUNET_DISK_file_close (fh);
 422   return GNUNET_OK;
 423 }
 424
 425
 426
 427 /**
 428  * struct used to list the pseudonym
 429  */
 430 struct ListPseudonymClosure
 431 {
 432
 433   /**
 434    * iterator over pseudonym
 435    */
 436   GNUNET_PSEUDONYM_Iterator iterator;
 437
 438   /**
 439    * Closure for iterator.
 440    */
 441   void *closure;
 442
 443   /**
 444    * Configuration to use.
 445    */
 446   const struct GNUNET_CONFIGURATION_Handle *cfg;
 447 };
 448
 449
 450
 451 /**
 452  * the help function to list all available pseudonyms
 453  * @param cls point to a struct ListPseudonymClosure
 454  * @param fullname name of pseudonym
 455  */
 456 static int
 457 list_pseudonym_helper (void *cls, const char *fullname)
 458 {
 459   struct ListPseudonymClosure *c = cls;
 460   int ret;
 461   GNUNET_HashCode id;
 462   int rating;
 463   struct GNUNET_CONTAINER_MetaData *meta;
 464   const char *fn;
 465   char *str;
 466
 467   if (strlen (fullname) < sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded))
 468     return GNUNET_OK;
 469   fn =
 470     &fullname[strlen (fullname) + 1 -
 471               sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
 472   if (fn[-1] != DIR_SEPARATOR)
 473     return GNUNET_OK;
 474   ret = GNUNET_OK;
 475   if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (fn, &id))
 476     return GNUNET_OK;           /* invalid name */
 477   str = NULL;
 478   if (GNUNET_OK != read_info (c->cfg, &id, &meta, &rating, &str))
 479     return GNUNET_OK;           /* ignore entry */
 480   GNUNET_free_non_null (str);
 481   if (c->iterator != NULL)
 482     ret = c->iterator (c->closure, &id, meta, rating);
 483   GNUNET_CONTAINER_meta_data_destroy (meta);
 484   return ret;
 485 }
 486
 487
 488 /**
 489  * List all available pseudonyms.
 490  *
 491  * @param cfg overall configuration
 492  * @param iterator function to call for each pseudonym
 493  * @param closure closure for iterator
 494  * @return number of pseudonyms found
 495  */
 496 int
 497 GNUNET_PSEUDONYM_list_all (const struct GNUNET_CONFIGURATION_Handle *cfg,
 498                            GNUNET_PSEUDONYM_Iterator iterator, void *closure)
 499 {
 500   struct ListPseudonymClosure cls;
 501   char *fn;
 502   int ret;
 503
 504   cls.iterator = iterator;
 505   cls.closure = closure;
 506   cls.cfg = cfg;
 507   fn = get_data_filename (cfg, PS_METADATA_DIR, NULL);
 508   GNUNET_assert (fn != NULL);
 509   GNUNET_DISK_directory_create (fn);
 510   ret = GNUNET_DISK_directory_scan (fn, &list_pseudonym_helper, &cls);
 511   GNUNET_free (fn);
 512   return ret;
 513 }
 514
 515
 516 /**
 517  * Change the ranking of a pseudonym.
 518  *
 519  * @param cfg overall configuration
 520  * @param nsid id of the pseudonym
 521  * @param delta by how much should the rating be
 522  *  changed?
 523  * @return new rating of the pseudonym
 524  */
 525 int
 526 GNUNET_PSEUDONYM_rank (const struct GNUNET_CONFIGURATION_Handle *cfg,
 527                        const GNUNET_HashCode * nsid, int delta)
 528 {
 529   struct GNUNET_CONTAINER_MetaData *meta;
 530   int ret;
 531   int32_t ranking;
 532   char *name;
 533
 534   name = NULL;
 535   ret = read_info (cfg, nsid, &meta, &ranking, &name);
 536   if (ret == GNUNET_SYSERR)
 537     {
 538       ranking = 0;
 539       meta = GNUNET_CONTAINER_meta_data_create ();
 540     }
 541   ranking += delta;
 542   write_pseudonym_info (cfg, nsid, meta, ranking, name);
 543   GNUNET_CONTAINER_meta_data_destroy (meta);
 544   GNUNET_free_non_null (name);
 545   return ranking;
 546 }
 547
 548
 549 /**
 550  * Add a pseudonym to the set of known pseudonyms.
 551  * For all pseudonym advertisements that we discover
 552  * FS should automatically call this function.
 553  *
 554  * @param cfg overall configuration
 555  * @param id the pseudonym identifier
 556  * @param meta metadata for the pseudonym
 557  */
 558 void
 559 GNUNET_PSEUDONYM_add (const struct GNUNET_CONFIGURATION_Handle *cfg,
 560                       const GNUNET_HashCode * id,
 561                       const struct GNUNET_CONTAINER_MetaData *meta)
 562 {
 563   char *name;
 564   int32_t ranking;
 565   struct GNUNET_CONTAINER_MetaData *old;
 566   char *fn;
 567   struct stat sbuf;
 568
 569   ranking = 0;
 570   fn = get_data_filename (cfg, PS_METADATA_DIR, id);
 571   GNUNET_assert (fn != NULL);
 572
 573   if ((0 == STAT (fn, &sbuf)) &&
 574       (GNUNET_OK == read_info (cfg, id, &old, &ranking, &name)))
 575     {
 576       GNUNET_CONTAINER_meta_data_merge (old, meta);
 577       write_pseudonym_info (cfg, id, old, ranking, name);
 578       GNUNET_CONTAINER_meta_data_destroy (old);
 579       GNUNET_free_non_null (name);
 580     }
 581   else
 582     {
 583       write_pseudonym_info (cfg, id, meta, ranking, NULL);
 584     }
 585   GNUNET_free (fn);
 586   internal_notify (id, meta, ranking);
 587 }
 588
 589
 590 /* end of pseudonym.c */