-handle get default
[oweals/gnunet.git] / 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  * Create a set default message with information about the current state of an ego.
211  *
212  * @param ego ego to create message for
213  * @return corresponding set default message
214  */
215 static struct GNUNET_IDENTITY_SetDefaultMessage *
216 create_set_default_message (struct Ego *ego)
217 {
218   struct GNUNET_IDENTITY_SetDefaultMessage *sdm;
219   char *str;
220   uint16_t pk_len;
221   size_t name_len;
222   struct GNUNET_CRYPTO_EccPrivateKeyBinaryEncoded *enc;
223
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);
235   GNUNET_free (enc);
236   return sdm;
237 }
238
239
240 /**
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
244  * updates.
245  *
246  * @param cls unused
247  * @param client who sent the message
248  * @param message the message received
249  */
250 static void
251 handle_start_message (void *cls, struct GNUNET_SERVER_Client *client,
252                       const struct GNUNET_MessageHeader *message)
253 {
254   struct GNUNET_IDENTITY_UpdateMessage *um;
255   struct Ego *ego;
256
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)
261   {
262     um = create_update_message (ego);
263     GNUNET_SERVER_notification_context_unicast (nc, client, &um->header, GNUNET_YES);
264     GNUNET_free (um);
265   }
266   GNUNET_SERVER_receive_done (client, GNUNET_OK);
267 }
268
269
270 /**
271  * Handler for GET_DEFAULT message from client, returns
272  * default identity for some service.
273  *
274  * @param cls unused
275  * @param client who sent the message
276  * @param message the message received
277  */
278 static void
279 handle_get_default_message (void *cls, struct GNUNET_SERVER_Client *client,
280                             const struct GNUNET_MessageHeader *message)
281 {
282   const struct GNUNET_IDENTITY_GetDefaultMessage *gdm;
283   struct GNUNET_IDENTITY_SetDefaultMessage *sdm;
284   uint16_t size;
285   uint16_t name_len;
286   struct Ego *ego;
287   const char *name;
288   char *identifier;
289
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))
294   {
295     GNUNET_break (0);
296     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
297     return;
298   }
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]) )
305   {
306     GNUNET_break (0);
307     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
308     return;
309   }
310   if (GNUNET_OK !=
311       GNUNET_CONFIGURATION_get_value_string (subsystem_cfg,
312                                              name,
313                                              "DEFAULT_IDENTIFIER",
314                                              &identifier))
315   {
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);   
319     return;
320   }
321   for (ego = ego_head; NULL != ego; ego = ego->next)
322   {
323     if (0 == strcmp (ego->identifier,
324                      identifier))
325     {
326       sdm = create_set_default_message (ego);
327       GNUNET_SERVER_notification_context_broadcast (nc, &sdm->header, GNUNET_YES);
328       GNUNET_free (sdm);
329       GNUNET_SERVER_receive_done (client, GNUNET_OK);
330       return;
331     }
332   }
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);
337 }
338
339
340 /**
341  * Handler for SET_DEFAULT message from client, updates
342  * default identity for some service.
343  *
344  * @param cls unused
345  * @param client who sent the message
346  * @param message the message received
347  */
348 static void
349 handle_set_default_message (void *cls, struct GNUNET_SERVER_Client *client,
350                             const struct GNUNET_MessageHeader *message)
351 {
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);
358 }
359
360
361 /**
362  * Send an updated message for the given ego to all listeners.
363  *
364  * @param ego ego to send the update for
365  */
366 static void
367 notify_listeners (struct Ego *ego)
368 {
369   struct GNUNET_IDENTITY_UpdateMessage *um;
370
371   um = create_update_message (ego);
372   GNUNET_SERVER_notification_context_broadcast (nc, &um->header, GNUNET_YES);
373   GNUNET_free (um);
374 }
375
376
377 /**
378  * Handler for CREATE message from client, creates
379  * new identity.
380  *
381  * @param cls unused
382  * @param client who sent the message
383  * @param message the message received
384  */
385 static void
386 handle_create_message (void *cls, struct GNUNET_SERVER_Client *client,
387                        const struct GNUNET_MessageHeader *message)
388 {
389   const struct GNUNET_IDENTITY_CreateRequestMessage *crm;
390   uint16_t size;
391   uint16_t name_len;
392   uint16_t pk_len;
393   struct Ego *ego;
394   const char *str;
395   struct GNUNET_CRYPTO_EccPrivateKey *pk;
396
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))
401   {
402     GNUNET_break (0);
403     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
404     return;
405   }
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))) )
412   {
413     GNUNET_break (0);
414     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
415     return;
416   }
417   str = &str[pk_len];
418   if ('\0' != str[name_len - 1])
419   {
420     GNUNET_break (0);
421     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
422     return;
423   }
424   for (ego = ego_head; NULL != ego; ego = ego->next)
425   {
426     if (0 == strcmp (ego->identifier,
427                      str))
428     {
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);
432       return;
433     }
434   }
435   ego = GNUNET_new (struct Ego);
436   ego->pk = pk;
437   ego->identifier = GNUNET_strdup (str);
438   GNUNET_CONTAINER_DLL_insert (ego_head,
439                                ego_tail,
440                                ego);
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);
445 }
446
447
448
449 /**
450  * Handler for RENAME message from client, creates
451  * new identity.
452  *
453  * @param cls unused
454  * @param client who sent the message
455  * @param message the message received
456  */
457 static void
458 handle_rename_message (void *cls, struct GNUNET_SERVER_Client *client,
459                        const struct GNUNET_MessageHeader *message)
460 {
461   const struct GNUNET_IDENTITY_RenameMessage *rm;
462   uint16_t size;
463   uint16_t old_name_len;
464   uint16_t new_name_len;
465   struct Ego *ego;
466   const char *old_name;
467   const char *new_name;
468
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))
473   {
474     GNUNET_break (0);
475     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
476     return;
477   }
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]) )
486   {
487     GNUNET_break (0);
488     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
489     return;
490   }
491   for (ego = ego_head; NULL != ego; ego = ego->next)
492   {
493     if (0 == strcmp (ego->identifier,
494                      old_name))
495     {
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);
502       return;
503     }
504   }
505
506   send_result_code (client, 1, gettext_noop ("no matching ego found"));
507   GNUNET_SERVER_receive_done (client, GNUNET_OK);
508 }
509
510
511 /**
512  * Handler for DELETE message from client, creates
513  * new identity.
514  *
515  * @param cls unused
516  * @param client who sent the message
517  * @param message the message received
518  */
519 static void
520 handle_delete_message (void *cls, struct GNUNET_SERVER_Client *client,
521                        const struct GNUNET_MessageHeader *message)
522 {
523   const struct GNUNET_IDENTITY_DeleteMessage *dm;
524   uint16_t size;
525   uint16_t name_len;
526   struct Ego *ego;
527   const char *name;
528
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))
533   {
534     GNUNET_break (0);
535     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
536     return;
537   }
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]) )
544   {
545     GNUNET_break (0);
546     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
547     return;
548   }
549   for (ego = ego_head; NULL != ego; ego = ego->next)
550   {
551     if (0 == strcmp (ego->identifier,
552                      name))
553     {
554       GNUNET_CONTAINER_DLL_remove (ego_head,
555                                    ego_tail,
556                                    ego);
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);
562       GNUNET_free (ego);
563       send_result_code (client, 0, NULL);
564       GNUNET_SERVER_receive_done (client, GNUNET_OK);
565       return;
566     }
567   }
568
569   send_result_code (client, 1, gettext_noop ("no matching ego found"));
570   GNUNET_SERVER_receive_done (client, GNUNET_OK);
571 }
572
573
574 /**
575  * Process the given file from the "EGODIR".  Parses the file
576  * and creates the respective 'struct Ego' in memory.
577  *
578  * @param cls NULL
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!
583  */
584 static int
585 process_ego_file (void *cls,
586                   const char *filename)
587 {
588   GNUNET_break (0); // not implemented
589   return GNUNET_OK;
590 }
591
592
593 /**
594  * Handle network size estimate clients.
595  *
596  * @param cls closure
597  * @param server the initialized server
598  * @param c configuration to use
599  */
600 static void
601 run (void *cls, 
602      struct GNUNET_SERVER_Handle *server,
603      const struct GNUNET_CONFIGURATION_Handle *c)
604 {
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},
618     {NULL, NULL, 0, 0}
619   };
620
621   cfg = c;
622   if (GNUNET_OK !=
623       GNUNET_CONFIGURATION_get_value_filename (cfg, "identity",
624                                                "EGODIR",
625                                                &ego_directory))
626   {
627     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "identity", "EGODIR");
628     GNUNET_SCHEDULER_shutdown ();
629     return;
630   }
631   if (GNUNET_OK !=
632       GNUNET_CONFIGURATION_get_value_filename (cfg, "identity",
633                                                "SUBSYSTEM_CFG",
634                                                &subsystem_cfg_file))
635   {
636     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "identity", "SUBSYSTEM_CFG");
637     GNUNET_SCHEDULER_shutdown ();
638     return;
639   }
640   subsystem_cfg = GNUNET_CONFIGURATION_create ();
641   if ( (GNUNET_YES ==
642         GNUNET_DISK_file_test (subsystem_cfg_file)) &&
643        (GNUNET_OK != 
644         GNUNET_CONFIGURATION_parse (subsystem_cfg,
645                                     subsystem_cfg_file)) )
646   {
647     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
648                 _("Failed to parse subsystem identity configuration file `%s'\n"),
649                 subsystem_cfg_file);
650     GNUNET_SCHEDULER_shutdown ();
651     return;
652   }
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,
657                               &process_ego_file,
658                               NULL);
659   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
660                                 NULL);
661 }
662
663
664 /**
665  * The main function for the network size estimation service.
666  *
667  * @param argc number of arguments from the command line
668  * @param argv command line arguments
669  * @return 0 ok, 1 on error
670  */
671 int
672 main (int argc, char *const *argv)
673 {
674   return (GNUNET_OK ==
675           GNUNET_SERVICE_run (argc, argv, "identity", 
676                               GNUNET_SERVICE_OPTION_NONE,
677                               &run, NULL)) ? 0 : 1;
678 }
679
680
681 /* end of gnunet-service-identity.c */