src/identity/gnunet-service-identity.c

   1 /*
   2   This file is part of GNUnet.
   3   (C) 2013 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 3, 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 identity/gnunet-service-identity.c
  23  * @brief identity management service
  24  * @author Christian Grothoff
  25  *
  26  * The purpose of this service is to manage private keys that
  27  * represent the various egos/pseudonyms/identities of a GNUnet user.
  28  *
  29  * TODO:
  30  * - disk operations
  31  * - default identity set/get handlers
  32  */
  33 #include "platform.h"
  34 #include "gnunet_util_lib.h"
  35 #include "gnunet_constants.h"
  36 #include "gnunet_protocols.h"
  37 #include "gnunet_statistics_service.h"
  38 #include "gnunet_identity_service.h"
  39 #include "identity.h"
  40
  41
  42 /**
  43  * Information we keep about each ego.
  44  */
  45 struct Ego
  46 {
  47
  48   /**
  49    * We keep egos in a DLL.
  50    */
  51   struct Ego *next;
  52
  53   /**
  54    * We keep egos in a DLL.
  55    */
  56   struct Ego *prev;
  57
  58   /**
  59    * Private key of the ego.
  60    */
  61   struct GNUNET_CRYPTO_EccPrivateKey *pk;
  62
  63   /**
  64    * String identifier for the ego.
  65    */
  66   char *identifier;
  67
  68 };
  69
  70
  71 /**
  72  * Handle to our current configuration.
  73  */
  74 static const struct GNUNET_CONFIGURATION_Handle *cfg;
  75
  76 /**
  77  * Handle to subsystem configuration which for each subsystem contains
  78  * the name of the default ego.
  79  */
  80 static struct GNUNET_CONFIGURATION_Handle *subsystem_cfg;
  81
  82 /**
  83  * Handle to the statistics service.
  84  */
  85 static struct GNUNET_STATISTICS_Handle *stats;
  86
  87 /**
  88  * Notification context, simplifies client broadcasts.
  89  */
  90 static struct GNUNET_SERVER_NotificationContext *nc;
  91
  92 /**
  93  * Directory where we store the identities.
  94  */
  95 static char *ego_directory;
  96
  97 /**
  98  * Configuration file name where subsystem information is kept.
  99  */
 100 static char *subsystem_cfg_file;
 101
 102 /**
 103  * Head of DLL of all egos.
 104  */
 105 static struct Ego *ego_head;
 106
 107 /**
 108  * Tail of DLL of all egos.
 109  */
 110 static struct Ego *ego_tail;
 111
 112
 113 /**
 114  * Task run during shutdown.
 115  *
 116  * @param cls unused
 117  * @param tc unused
 118  */
 119 static void
 120 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 121 {
 122   struct Ego *e;
 123
 124   if (NULL != nc)
 125   {
 126     GNUNET_SERVER_notification_context_destroy (nc);
 127     nc = NULL;
 128   }
 129   if (NULL != stats)
 130   {
 131     GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
 132     stats = NULL;
 133   }
 134   GNUNET_CONFIGURATION_destroy (subsystem_cfg);
 135   subsystem_cfg = NULL;
 136   GNUNET_free (subsystem_cfg_file);
 137   subsystem_cfg_file = NULL;
 138   GNUNET_free (ego_directory);
 139   ego_directory = NULL;
 140   while (NULL != (e = ego_head))
 141   {
 142     GNUNET_CONTAINER_DLL_remove (ego_head, ego_tail, e);
 143     GNUNET_CRYPTO_ecc_key_free (e->pk);
 144     GNUNET_free (e);
 145   }
 146 }
 147
 148
 149 /**
 150  * Send a result code back to the client.
 151  *
 152  * @param client client that should receive the result code
 153  * @param result_code code to transmit
 154  * @param emsg error message to include (or NULL for none)
 155  */
 156 static void
 157 send_result_code (struct GNUNET_SERVER_Client *client,
 158                   uint32_t result_code,
 159                   const char *emsg)
 160 {
 161   struct GNUNET_IDENTITY_ResultCodeMessage *rcm;
 162   size_t elen;
 163
 164   if (NULL == emsg)
 165     elen = 0;
 166   else
 167     elen = strlen (emsg) + 1;
 168   rcm = GNUNET_malloc (sizeof (struct GNUNET_IDENTITY_ResultCodeMessage) + elen);
 169   rcm->header.type = htons (GNUNET_MESSAGE_TYPE_IDENTITY_RESULT_CODE);
 170   rcm->header.size = htons (sizeof (struct GNUNET_IDENTITY_ResultCodeMessage) + elen);
 171   rcm->result_code = htonl (result_code);
 172   memcpy (&rcm[1], emsg, elen);
 173   GNUNET_SERVER_notification_context_unicast (nc, client, &rcm->header, GNUNET_YES);
 174   GNUNET_free (rcm);
 175 }
 176
 177
 178 /**
 179  * Create an update message with information about the current state of an ego.
 180  *
 181  * @param ego ego to create message for
 182  * @return corresponding update message
 183  */
 184 static struct GNUNET_IDENTITY_UpdateMessage *
 185 create_update_message (struct Ego *ego)
 186 {
 187   struct GNUNET_IDENTITY_UpdateMessage *um;
 188   char *str;
 189   uint16_t pk_len;
 190   size_t name_len;
 191   struct GNUNET_CRYPTO_EccPrivateKeyBinaryEncoded *enc;
 192
 193   name_len = (NULL == ego->identifier) ? 0 : (strlen (ego->identifier) + 1);
 194   enc = GNUNET_CRYPTO_ecc_encode_key (ego->pk);
 195   pk_len = ntohs (enc->size);
 196   um = GNUNET_malloc (sizeof (struct GNUNET_IDENTITY_UpdateMessage) + pk_len + name_len);
 197   um->header.type = htons (GNUNET_MESSAGE_TYPE_IDENTITY_UPDATE);
 198   um->header.size = htons (sizeof (struct GNUNET_IDENTITY_UpdateMessage) + pk_len + name_len);
 199   um->name_len = htons (name_len);
 200   um->pk_len = htons (pk_len);
 201   str = (char *) &um[1];
 202   memcpy (str, enc, pk_len);
 203   memcpy (&str[pk_len], ego->identifier, name_len);
 204   GNUNET_free (enc);
 205   return um;
 206 }
 207
 208
 209 /**
 210  * Handler for START message from client, sends information
 211  * about all identities to the client immediately and
 212  * adds the client to the notification context for future
 213  * updates.
 214  *
 215  * @param cls unused
 216  * @param client who sent the message
 217  * @param message the message received
 218  */
 219 static void
 220 handle_start_message (void *cls, struct GNUNET_SERVER_Client *client,
 221                       const struct GNUNET_MessageHeader *message)
 222 {
 223   struct GNUNET_IDENTITY_UpdateMessage *um;
 224   struct Ego *ego;
 225
 226   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 227               "Received START message from client\n");
 228   GNUNET_SERVER_notification_context_add (nc, client);
 229   for (ego = ego_head; NULL != ego; ego = ego->next)
 230   {
 231     um = create_update_message (ego);
 232     GNUNET_SERVER_notification_context_unicast (nc, client, &um->header, GNUNET_YES);
 233     GNUNET_free (um);
 234   }
 235   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 236 }
 237
 238
 239 /**
 240  * Handler for GET_DEFAULT message from client, returns
 241  * default identity for some service.
 242  *
 243  * @param cls unused
 244  * @param client who sent the message
 245  * @param message the message received
 246  */
 247 static void
 248 handle_get_default_message (void *cls, struct GNUNET_SERVER_Client *client,
 249                             const struct GNUNET_MessageHeader *message)
 250 {
 251   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 252               "Received GET_DEFAULT message from client\n");
 253   // setup_estimate_message (&em);
 254   // GNUNET_SERVER_notification_context_unicast (nc, client, &em.header, GNUNET_YES);
 255   GNUNET_break (0); // not implemented!
 256   GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 257 }
 258
 259
 260 /**
 261  * Handler for SET_DEFAULT message from client, updates
 262  * default identity for some service.
 263  *
 264  * @param cls unused
 265  * @param client who sent the message
 266  * @param message the message received
 267  */
 268 static void
 269 handle_set_default_message (void *cls, struct GNUNET_SERVER_Client *client,
 270                             const struct GNUNET_MessageHeader *message)
 271 {
 272   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 273               "Received SET_DEFAULT message from client\n");
 274   // setup_estimate_message (&em);
 275   // GNUNET_SERVER_notification_context_unicast (nc, client, &em.header, GNUNET_YES);
 276   GNUNET_break (0); // not implemented!
 277   GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 278 }
 279
 280
 281 /**
 282  * Send an updated message for the given ego to all listeners.
 283  *
 284  * @param ego ego to send the update for
 285  */
 286 static void
 287 notify_listeners (struct Ego *ego)
 288 {
 289   struct GNUNET_IDENTITY_UpdateMessage *um;
 290
 291   um = create_update_message (ego);
 292   GNUNET_SERVER_notification_context_broadcast (nc, &um->header, GNUNET_YES);
 293   GNUNET_free (um);
 294 }
 295
 296
 297 /**
 298  * Handler for CREATE message from client, creates
 299  * new identity.
 300  *
 301  * @param cls unused
 302  * @param client who sent the message
 303  * @param message the message received
 304  */
 305 static void
 306 handle_create_message (void *cls, struct GNUNET_SERVER_Client *client,
 307                        const struct GNUNET_MessageHeader *message)
 308 {
 309   const struct GNUNET_IDENTITY_CreateRequestMessage *crm;
 310   uint16_t size;
 311   uint16_t name_len;
 312   uint16_t pk_len;
 313   struct Ego *ego;
 314   const char *str;
 315   struct GNUNET_CRYPTO_EccPrivateKey *pk;
 316
 317   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 318               "Received CREATE message from client\n");
 319   size = ntohs (message->size);
 320   if (size <= sizeof (struct GNUNET_IDENTITY_CreateRequestMessage))
 321   {
 322     GNUNET_break (0);
 323     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 324     return;
 325   }
 326   crm = (const struct GNUNET_IDENTITY_CreateRequestMessage *) message;
 327   name_len = ntohs (crm->name_len);
 328   pk_len = ntohs (crm->pk_len);
 329   str = (const char *) &crm[1];
 330   if ( (name_len + pk_len + sizeof (struct GNUNET_IDENTITY_CreateRequestMessage) != size) ||
 331        (NULL == (pk = GNUNET_CRYPTO_ecc_decode_key (str, pk_len, GNUNET_YES))) )
 332   {
 333     GNUNET_break (0);
 334     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 335     return;
 336   }
 337   str = &str[pk_len];
 338   if ('\0' != str[name_len - 1])
 339   {
 340     GNUNET_break (0);
 341     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 342     return;
 343   }
 344   for (ego = ego_head; NULL != ego; ego = ego->next)
 345   {
 346     if (0 == strcmp (ego->identifier,
 347                      str))
 348     {
 349       send_result_code (client, 1, gettext_noop ("identifier already in use for another ego"));
 350       GNUNET_SERVER_receive_done (client, GNUNET_OK);
 351       GNUNET_CRYPTO_ecc_key_free (pk);
 352       return;
 353     }
 354   }
 355   ego = GNUNET_new (struct Ego);
 356   ego->pk = pk;
 357   ego->identifier = GNUNET_strdup (str);
 358   GNUNET_CONTAINER_DLL_insert (ego_head,
 359                                ego_tail,
 360                                ego);
 361   send_result_code (client, 0, NULL);
 362   /* FIXME: also write to file! */
 363   notify_listeners (ego);
 364   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 365 }
 366
 367
 368
 369 /**
 370  * Handler for RENAME message from client, creates
 371  * new identity.
 372  *
 373  * @param cls unused
 374  * @param client who sent the message
 375  * @param message the message received
 376  */
 377 static void
 378 handle_rename_message (void *cls, struct GNUNET_SERVER_Client *client,
 379                        const struct GNUNET_MessageHeader *message)
 380 {
 381   const struct GNUNET_IDENTITY_RenameMessage *rm;
 382   uint16_t size;
 383   uint16_t old_name_len;
 384   uint16_t new_name_len;
 385   struct Ego *ego;
 386   const char *old_name;
 387   const char *new_name;
 388
 389   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 390               "Received RENAME message from client\n");
 391   size = ntohs (message->size);
 392   if (size <= sizeof (struct GNUNET_IDENTITY_RenameMessage))
 393   {
 394     GNUNET_break (0);
 395     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 396     return;
 397   }
 398   rm = (const struct GNUNET_IDENTITY_RenameMessage *) message;
 399   old_name_len = ntohs (rm->old_name_len);
 400   new_name_len = ntohs (rm->new_name_len);
 401   old_name = (const char *) &rm[1];
 402   new_name = &old_name[old_name_len];
 403   if ( (old_name_len + new_name_len + sizeof (struct GNUNET_IDENTITY_RenameMessage) != size) ||
 404        ('\0' != old_name[old_name_len - 1]) ||
 405        ('\0' != new_name[new_name_len - 1]) )
 406   {
 407     GNUNET_break (0);
 408     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 409     return;
 410   }
 411   for (ego = ego_head; NULL != ego; ego = ego->next)
 412   {
 413     if (0 == strcmp (ego->identifier,
 414                      old_name))
 415     {
 416       GNUNET_free (ego->identifier);
 417       ego->identifier = GNUNET_strdup (new_name);
 418       /* FIXME: also rename file! */
 419       notify_listeners (ego);
 420       send_result_code (client, 0, NULL);
 421       GNUNET_SERVER_receive_done (client, GNUNET_OK);
 422       return;
 423     }
 424   }
 425
 426   send_result_code (client, 1, gettext_noop ("no matching ego found"));
 427   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 428 }
 429
 430
 431 /**
 432  * Handler for DELETE message from client, creates
 433  * new identity.
 434  *
 435  * @param cls unused
 436  * @param client who sent the message
 437  * @param message the message received
 438  */
 439 static void
 440 handle_delete_message (void *cls, struct GNUNET_SERVER_Client *client,
 441                        const struct GNUNET_MessageHeader *message)
 442 {
 443   const struct GNUNET_IDENTITY_DeleteMessage *dm;
 444   uint16_t size;
 445   uint16_t name_len;
 446   struct Ego *ego;
 447   const char *name;
 448
 449   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 450               "Received DELETE message from client\n");
 451   size = ntohs (message->size);
 452   if (size <= sizeof (struct GNUNET_IDENTITY_DeleteMessage))
 453   {
 454     GNUNET_break (0);
 455     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 456     return;
 457   }
 458   dm = (const struct GNUNET_IDENTITY_DeleteMessage *) message;
 459   name = (const char *) &dm[1];
 460   name_len = ntohs (dm->name_len);
 461   if ( (name_len + sizeof (struct GNUNET_IDENTITY_DeleteMessage) != size) ||
 462        (0 != ntohs (dm->reserved)) ||
 463        ('\0' != name[name_len - 1]) )
 464   {
 465     GNUNET_break (0);
 466     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 467     return;
 468   }
 469   for (ego = ego_head; NULL != ego; ego = ego->next)
 470   {
 471     if (0 == strcmp (ego->identifier,
 472                      name))
 473     {
 474       GNUNET_CONTAINER_DLL_remove (ego_head,
 475                                    ego_tail,
 476                                    ego);
 477       /* FIXME: also delete file! */
 478       GNUNET_free (ego->identifier);
 479       ego->identifier = NULL;
 480       notify_listeners (ego);
 481       GNUNET_CRYPTO_ecc_key_free (ego->pk);
 482       GNUNET_free (ego);
 483       send_result_code (client, 0, NULL);
 484       GNUNET_SERVER_receive_done (client, GNUNET_OK);
 485       return;
 486     }
 487   }
 488
 489   send_result_code (client, 1, gettext_noop ("no matching ego found"));
 490   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 491 }
 492
 493
 494 /**
 495  * Process the given file from the "EGODIR".  Parses the file
 496  * and creates the respective 'struct Ego' in memory.
 497  *
 498  * @param cls NULL
 499  * @param filename name of the file to parse
 500  */
 501 static void
 502 process_ego_file (void *cls,
 503                   const char *filename)
 504 {
 505   GNUNET_break (0); // not implemented
 506 }
 507
 508
 509 /**
 510  * Handle network size estimate clients.
 511  *
 512  * @param cls closure
 513  * @param server the initialized server
 514  * @param c configuration to use
 515  */
 516 static void
 517 run (void *cls,
 518      struct GNUNET_SERVER_Handle *server,
 519      const struct GNUNET_CONFIGURATION_Handle *c)
 520 {
 521   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
 522     {&handle_start_message, NULL,
 523      GNUNET_MESSAGE_TYPE_IDENTITY_START, sizeof (struct GNUNET_MessageHeader)},
 524     {&handle_get_default_message, NULL,
 525      GNUNET_MESSAGE_TYPE_IDENTITY_GET_DEFAULT, 0},
 526     {&handle_set_default_message, NULL,
 527      GNUNET_MESSAGE_TYPE_IDENTITY_SET_DEFAULT, 0},
 528     {&handle_create_message, NULL,
 529      GNUNET_MESSAGE_TYPE_IDENTITY_CREATE, 0},
 530     {&handle_rename_message, NULL,
 531      GNUNET_MESSAGE_TYPE_IDENTITY_RENAME, 0},
 532     {&handle_delete_message, NULL,
 533      GNUNET_MESSAGE_TYPE_IDENTITY_DELETE, 0},
 534     {NULL, NULL, 0, 0}
 535   };
 536
 537   cfg = c;
 538   if (GNUNET_OK !=
 539       GNUNET_CONFIGURATION_get_value_filename (cfg, "identity",
 540                                                "EGODIR",
 541                                                &ego_directory))
 542   {
 543     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "identity", "EGODIR");
 544     GNUNET_SCHEDULER_shutdown ();
 545     return;
 546   }
 547   if (GNUNET_OK !=
 548       GNUNET_CONFIGURATION_get_value_filename (cfg, "identity",
 549                                                "SUBSYSTEM_CFG",
 550                                                &subsystem_cfg_file))
 551   {
 552     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "identity", "SUBSYSTEM_CFG");
 553     GNUNET_SCHEDULER_shutdown ();
 554     return;
 555   }
 556   subsystem_cfg = GNUNET_CONFIGURATION_create ();
 557   if ( (GNUNET_YES ==
 558         GNUNET_DISK_file_test (subsystem_cfg_file)) &&
 559        (GNUNET_OK !=
 560         GNUNET_CONFIGURATION_parse (subsystem_cfg,
 561                                     subsystem_cfg_file)) )
 562   {
 563     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 564                 _("Failed to parse subsystem identity configuration file `%s'\n"),
 565                 subsystem_cfg_file);
 566     GNUNET_SCHEDULER_shutdown ();
 567     return;
 568   }
 569   stats = GNUNET_STATISTICS_create ("identity", cfg);
 570   GNUNET_SERVER_add_handlers (server, handlers);
 571   nc = GNUNET_SERVER_notification_context_create (server, 1);
 572   GNUNET_DISK_directory_scan (ego_directory,
 573                               &process_ego_file,
 574                               NULL);
 575   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
 576                                 NULL);
 577 }
 578
 579
 580 /**
 581  * The main function for the network size estimation service.
 582  *
 583  * @param argc number of arguments from the command line
 584  * @param argv command line arguments
 585  * @return 0 ok, 1 on error
 586  */
 587 int
 588 main (int argc, char *const *argv)
 589 {
 590   return (GNUNET_OK ==
 591           GNUNET_SERVICE_run (argc, argv, "identity",
 592                               GNUNET_SERVICE_OPTION_NONE,
 593                               &run, NULL)) ? 0 : 1;
 594 }
 595
 596
 597 /* end of gnunet-service-identity.c */