2 This file is part of GNUnet.
3 (C) 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.
22 * @file identity/gnunet-service-identity.c
23 * @brief identity management service
24 * @author Christian Grothoff
26 * The purpose of this service is to manage private keys that
27 * represent the various egos/pseudonyms/identities of a GNUnet user.
31 * - default identity set/get handlers
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"
43 * Information we keep about each ego.
49 * We keep egos in a DLL.
54 * We keep egos in a DLL.
59 * Private key of the ego.
61 struct GNUNET_CRYPTO_EccPrivateKey *pk;
64 * String identifier for the ego.
72 * Handle to our current configuration.
74 static const struct GNUNET_CONFIGURATION_Handle *cfg;
77 * Handle to subsystem configuration which for each subsystem contains
78 * the name of the default ego.
80 static struct GNUNET_CONFIGURATION_Handle *subsystem_cfg;
83 * Handle to the statistics service.
85 static struct GNUNET_STATISTICS_Handle *stats;
88 * Notification context, simplifies client broadcasts.
90 static struct GNUNET_SERVER_NotificationContext *nc;
93 * Directory where we store the identities.
95 static char *ego_directory;
98 * Configuration file name where subsystem information is kept.
100 static char *subsystem_cfg_file;
103 * Head of DLL of all egos.
105 static struct Ego *ego_head;
108 * Tail of DLL of all egos.
110 static struct Ego *ego_tail;
114 * Task run during shutdown.
120 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
126 GNUNET_SERVER_notification_context_destroy (nc);
131 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
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))
142 GNUNET_CONTAINER_DLL_remove (ego_head, ego_tail, e);
143 GNUNET_CRYPTO_ecc_key_free (e->pk);
150 * Send a result code back to the client.
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)
157 send_result_code (struct GNUNET_SERVER_Client *client,
158 uint32_t result_code,
161 struct GNUNET_IDENTITY_ResultCodeMessage *rcm;
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);
179 * Create an update message with information about the current state of an ego.
181 * @param ego ego to create message for
182 * @return corresponding update message
184 static struct GNUNET_IDENTITY_UpdateMessage *
185 create_update_message (struct Ego *ego)
187 struct GNUNET_IDENTITY_UpdateMessage *um;
191 struct GNUNET_CRYPTO_EccPrivateKeyBinaryEncoded *enc;
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);
210 * Create a set default message with information about the current state of an ego.
212 * @param ego ego to create message for
213 * @return corresponding set default message
215 static struct GNUNET_IDENTITY_SetDefaultMessage *
216 create_set_default_message (struct Ego *ego)
218 struct GNUNET_IDENTITY_SetDefaultMessage *sdm;
222 struct GNUNET_CRYPTO_EccPrivateKeyBinaryEncoded *enc;
224 name_len = (NULL == ego->identifier) ? 0 : (strlen (ego->identifier) + 1);
225 enc = GNUNET_CRYPTO_ecc_encode_key (ego->pk);
226 pk_len = ntohs (enc->size);
227 sdm = GNUNET_malloc (sizeof (struct GNUNET_IDENTITY_SetDefaultMessage) + pk_len + name_len);
228 sdm->header.type = htons (GNUNET_MESSAGE_TYPE_IDENTITY_SET_DEFAULT);
229 sdm->header.size = htons (sizeof (struct GNUNET_IDENTITY_SetDefaultMessage) + pk_len + name_len);
230 sdm->name_len = htons (name_len);
231 sdm->pk_len = htons (pk_len);
232 str = (char *) &sdm[1];
233 memcpy (str, enc, pk_len);
234 memcpy (&str[pk_len], ego->identifier, name_len);
241 * Handler for START message from client, sends information
242 * about all identities to the client immediately and
243 * adds the client to the notification context for future
247 * @param client who sent the message
248 * @param message the message received
251 handle_start_message (void *cls, struct GNUNET_SERVER_Client *client,
252 const struct GNUNET_MessageHeader *message)
254 struct GNUNET_IDENTITY_UpdateMessage *um;
257 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
258 "Received START message from client\n");
259 GNUNET_SERVER_notification_context_add (nc, client);
260 for (ego = ego_head; NULL != ego; ego = ego->next)
262 um = create_update_message (ego);
263 GNUNET_SERVER_notification_context_unicast (nc, client, &um->header, GNUNET_YES);
266 GNUNET_SERVER_receive_done (client, GNUNET_OK);
271 * Handler for GET_DEFAULT message from client, returns
272 * default identity for some service.
275 * @param client who sent the message
276 * @param message the message received
279 handle_get_default_message (void *cls, struct GNUNET_SERVER_Client *client,
280 const struct GNUNET_MessageHeader *message)
282 const struct GNUNET_IDENTITY_GetDefaultMessage *gdm;
283 struct GNUNET_IDENTITY_SetDefaultMessage *sdm;
290 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
291 "Received GET_DEFAULT message from client\n");
292 size = ntohs (message->size);
293 if (size <= sizeof (struct GNUNET_IDENTITY_GetDefaultMessage))
296 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
299 gdm = (const struct GNUNET_IDENTITY_GetDefaultMessage *) message;
300 name = (const char *) &gdm[1];
301 name_len = ntohs (gdm->name_len);
302 if ( (name_len + sizeof (struct GNUNET_IDENTITY_GetDefaultMessage) != size) ||
303 (0 != ntohs (gdm->reserved)) ||
304 ('\0' != name[name_len - 1]) )
307 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
311 GNUNET_CONFIGURATION_get_value_string (subsystem_cfg,
313 "DEFAULT_IDENTIFIER",
316 /* FIXME: not sure client API handles this case correctly right now... */
317 send_result_code (client, 1, gettext_noop ("no default known"));
318 GNUNET_SERVER_receive_done (client, GNUNET_OK);
321 for (ego = ego_head; NULL != ego; ego = ego->next)
323 if (0 == strcmp (ego->identifier,
326 sdm = create_set_default_message (ego);
327 GNUNET_SERVER_notification_context_broadcast (nc, &sdm->header, GNUNET_YES);
329 GNUNET_SERVER_receive_done (client, GNUNET_OK);
333 /* FIXME: not sure client API handles this case correctly right now... */
334 send_result_code (client, 1,
335 gettext_noop ("default configured, but ego unknown (internal error)"));
336 GNUNET_SERVER_receive_done (client, GNUNET_OK);
341 * Handler for SET_DEFAULT message from client, updates
342 * default identity for some service.
345 * @param client who sent the message
346 * @param message the message received
349 handle_set_default_message (void *cls, struct GNUNET_SERVER_Client *client,
350 const struct GNUNET_MessageHeader *message)
352 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
353 "Received SET_DEFAULT message from client\n");
354 // setup_estimate_message (&em);
355 // GNUNET_SERVER_notification_context_unicast (nc, client, &em.header, GNUNET_YES);
356 GNUNET_break (0); // not implemented!
357 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
362 * Send an updated message for the given ego to all listeners.
364 * @param ego ego to send the update for
367 notify_listeners (struct Ego *ego)
369 struct GNUNET_IDENTITY_UpdateMessage *um;
371 um = create_update_message (ego);
372 GNUNET_SERVER_notification_context_broadcast (nc, &um->header, GNUNET_YES);
378 * Handler for CREATE message from client, creates
382 * @param client who sent the message
383 * @param message the message received
386 handle_create_message (void *cls, struct GNUNET_SERVER_Client *client,
387 const struct GNUNET_MessageHeader *message)
389 const struct GNUNET_IDENTITY_CreateRequestMessage *crm;
395 struct GNUNET_CRYPTO_EccPrivateKey *pk;
397 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
398 "Received CREATE message from client\n");
399 size = ntohs (message->size);
400 if (size <= sizeof (struct GNUNET_IDENTITY_CreateRequestMessage))
403 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
406 crm = (const struct GNUNET_IDENTITY_CreateRequestMessage *) message;
407 name_len = ntohs (crm->name_len);
408 pk_len = ntohs (crm->pk_len);
409 str = (const char *) &crm[1];
410 if ( (name_len + pk_len + sizeof (struct GNUNET_IDENTITY_CreateRequestMessage) != size) ||
411 (NULL == (pk = GNUNET_CRYPTO_ecc_decode_key (str, pk_len, GNUNET_YES))) )
414 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
418 if ('\0' != str[name_len - 1])
421 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
424 for (ego = ego_head; NULL != ego; ego = ego->next)
426 if (0 == strcmp (ego->identifier,
429 send_result_code (client, 1, gettext_noop ("identifier already in use for another ego"));
430 GNUNET_SERVER_receive_done (client, GNUNET_OK);
431 GNUNET_CRYPTO_ecc_key_free (pk);
435 ego = GNUNET_new (struct Ego);
437 ego->identifier = GNUNET_strdup (str);
438 GNUNET_CONTAINER_DLL_insert (ego_head,
441 send_result_code (client, 0, NULL);
442 /* FIXME: also write to file! */
443 notify_listeners (ego);
444 GNUNET_SERVER_receive_done (client, GNUNET_OK);
450 * Handler for RENAME message from client, creates
454 * @param client who sent the message
455 * @param message the message received
458 handle_rename_message (void *cls, struct GNUNET_SERVER_Client *client,
459 const struct GNUNET_MessageHeader *message)
461 const struct GNUNET_IDENTITY_RenameMessage *rm;
463 uint16_t old_name_len;
464 uint16_t new_name_len;
466 const char *old_name;
467 const char *new_name;
469 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
470 "Received RENAME message from client\n");
471 size = ntohs (message->size);
472 if (size <= sizeof (struct GNUNET_IDENTITY_RenameMessage))
475 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
478 rm = (const struct GNUNET_IDENTITY_RenameMessage *) message;
479 old_name_len = ntohs (rm->old_name_len);
480 new_name_len = ntohs (rm->new_name_len);
481 old_name = (const char *) &rm[1];
482 new_name = &old_name[old_name_len];
483 if ( (old_name_len + new_name_len + sizeof (struct GNUNET_IDENTITY_RenameMessage) != size) ||
484 ('\0' != old_name[old_name_len - 1]) ||
485 ('\0' != new_name[new_name_len - 1]) )
488 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
491 for (ego = ego_head; NULL != ego; ego = ego->next)
493 if (0 == strcmp (ego->identifier,
496 GNUNET_free (ego->identifier);
497 ego->identifier = GNUNET_strdup (new_name);
498 /* FIXME: also rename file! */
499 notify_listeners (ego);
500 send_result_code (client, 0, NULL);
501 GNUNET_SERVER_receive_done (client, GNUNET_OK);
506 send_result_code (client, 1, gettext_noop ("no matching ego found"));
507 GNUNET_SERVER_receive_done (client, GNUNET_OK);
512 * Handler for DELETE message from client, creates
516 * @param client who sent the message
517 * @param message the message received
520 handle_delete_message (void *cls, struct GNUNET_SERVER_Client *client,
521 const struct GNUNET_MessageHeader *message)
523 const struct GNUNET_IDENTITY_DeleteMessage *dm;
529 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
530 "Received DELETE message from client\n");
531 size = ntohs (message->size);
532 if (size <= sizeof (struct GNUNET_IDENTITY_DeleteMessage))
535 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
538 dm = (const struct GNUNET_IDENTITY_DeleteMessage *) message;
539 name = (const char *) &dm[1];
540 name_len = ntohs (dm->name_len);
541 if ( (name_len + sizeof (struct GNUNET_IDENTITY_DeleteMessage) != size) ||
542 (0 != ntohs (dm->reserved)) ||
543 ('\0' != name[name_len - 1]) )
546 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
549 for (ego = ego_head; NULL != ego; ego = ego->next)
551 if (0 == strcmp (ego->identifier,
554 GNUNET_CONTAINER_DLL_remove (ego_head,
557 /* FIXME: also delete file! */
558 GNUNET_free (ego->identifier);
559 ego->identifier = NULL;
560 notify_listeners (ego);
561 GNUNET_CRYPTO_ecc_key_free (ego->pk);
563 send_result_code (client, 0, NULL);
564 GNUNET_SERVER_receive_done (client, GNUNET_OK);
569 send_result_code (client, 1, gettext_noop ("no matching ego found"));
570 GNUNET_SERVER_receive_done (client, GNUNET_OK);
575 * Process the given file from the "EGODIR". Parses the file
576 * and creates the respective 'struct Ego' in memory.
579 * @param filename name of the file to parse
580 * @return GNUNET_OK to continue to iterate,
581 * GNUNET_NO to stop iteration with no error,
582 * GNUNET_SYSERR to abort iteration with error!
585 process_ego_file (void *cls,
586 const char *filename)
588 GNUNET_break (0); // not implemented
594 * Handle network size estimate clients.
597 * @param server the initialized server
598 * @param c configuration to use
602 struct GNUNET_SERVER_Handle *server,
603 const struct GNUNET_CONFIGURATION_Handle *c)
605 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
606 {&handle_start_message, NULL,
607 GNUNET_MESSAGE_TYPE_IDENTITY_START, sizeof (struct GNUNET_MessageHeader)},
608 {&handle_get_default_message, NULL,
609 GNUNET_MESSAGE_TYPE_IDENTITY_GET_DEFAULT, 0},
610 {&handle_set_default_message, NULL,
611 GNUNET_MESSAGE_TYPE_IDENTITY_SET_DEFAULT, 0},
612 {&handle_create_message, NULL,
613 GNUNET_MESSAGE_TYPE_IDENTITY_CREATE, 0},
614 {&handle_rename_message, NULL,
615 GNUNET_MESSAGE_TYPE_IDENTITY_RENAME, 0},
616 {&handle_delete_message, NULL,
617 GNUNET_MESSAGE_TYPE_IDENTITY_DELETE, 0},
623 GNUNET_CONFIGURATION_get_value_filename (cfg, "identity",
627 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "identity", "EGODIR");
628 GNUNET_SCHEDULER_shutdown ();
632 GNUNET_CONFIGURATION_get_value_filename (cfg, "identity",
634 &subsystem_cfg_file))
636 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "identity", "SUBSYSTEM_CFG");
637 GNUNET_SCHEDULER_shutdown ();
640 subsystem_cfg = GNUNET_CONFIGURATION_create ();
642 GNUNET_DISK_file_test (subsystem_cfg_file)) &&
644 GNUNET_CONFIGURATION_parse (subsystem_cfg,
645 subsystem_cfg_file)) )
647 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
648 _("Failed to parse subsystem identity configuration file `%s'\n"),
650 GNUNET_SCHEDULER_shutdown ();
653 stats = GNUNET_STATISTICS_create ("identity", cfg);
654 GNUNET_SERVER_add_handlers (server, handlers);
655 nc = GNUNET_SERVER_notification_context_create (server, 1);
656 GNUNET_DISK_directory_scan (ego_directory,
659 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
665 * The main function for the network size estimation service.
667 * @param argc number of arguments from the command line
668 * @param argv command line arguments
669 * @return 0 ok, 1 on error
672 main (int argc, char *const *argv)
675 GNUNET_SERVICE_run (argc, argv, "identity",
676 GNUNET_SERVICE_OPTION_NONE,
677 &run, NULL)) ? 0 : 1;
681 /* end of gnunet-service-identity.c */