src/identity/gnunet-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  * @file identity/gnunet-identity.c
  22  * @brief IDENTITY management command line tool
  23  * @author Christian Grothoff
  24  *
  25  * Todo:
  26  * - add options to get/set default egos
  27  * - print short hashes of egos when printing
  28  */
  29 #include "platform.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_identity_service.h"
  32
  33 /**
  34  * Handle to IDENTITY service.
  35  */
  36 static struct GNUNET_IDENTITY_Handle *sh;
  37
  38 /**
  39  * Was "list" specified?
  40  */
  41 static int list;
  42
  43 /**
  44  * Was "monitor" specified?
  45  */
  46 static int monitor;
  47
  48 /**
  49  * -C option
  50  */
  51 static char *create_ego;
  52
  53 /**
  54  * -D option
  55  */
  56 static char *delete_ego;
  57
  58 /**
  59  * Handle for create operation.
  60  */
  61 static struct GNUNET_IDENTITY_Operation *create_op;
  62
  63 /**
  64  * Handle for delete operation.
  65  */
  66 static struct GNUNET_IDENTITY_Operation *delete_op;
  67
  68
  69 /**
  70  * Task run on shutdown.
  71  *
  72  * @param cls NULL
  73  * @param tc unused
  74  */
  75 static void
  76 shutdown_task (void *cls,
  77                const struct GNUNET_SCHEDULER_TaskContext *tc)
  78 {
  79   GNUNET_IDENTITY_disconnect (sh);
  80   sh = NULL;
  81 }
  82
  83
  84
  85 /**
  86  * Test if we are finished yet.
  87  */
  88 static void
  89 test_finished ()
  90 {
  91   if ( (NULL == create_op) &&
  92        (NULL == delete_op) &&
  93        (! list) &&
  94        (! monitor) )
  95     GNUNET_SCHEDULER_shutdown ();
  96 }
  97
  98
  99 /**
 100  * Deletion operation finished.
 101  *
 102  * @param cls pointer to operation handle
 103  * @param emsg NULL on success, otherwise an error message
 104  */
 105 static void
 106 delete_finished (void *cls,
 107                  const char *emsg)
 108 {
 109   struct GNUNET_IDENTITY_Operation **op = cls;
 110
 111   *op = NULL;
 112   if (NULL != emsg)
 113     fprintf (stderr,
 114              "%s\n",
 115              gettext (emsg));
 116   test_finished ();
 117 }
 118
 119
 120 /**
 121  * Creation operation finished.
 122  *
 123  * @param cls pointer to operation handle
 124  * @param ego ego handle
 125  * @param ctx context for application to store data for this ego
 126  *                 (during the lifetime of this process, initially NULL)
 127  * @param identifier identifier assigned by the user for this ego
 128  */
 129 static void
 130 create_finished (void *cls,
 131                  struct GNUNET_IDENTITY_Ego *ego,
 132                  void **ctx,
 133                  const char *identifier)
 134 {
 135   struct GNUNET_IDENTITY_Operation **op = cls;
 136
 137   *op = NULL;
 138   if (NULL == ego)
 139     fprintf (stderr,
 140              "%s\n",
 141              _("Failed to create ego\n"));
 142   test_finished ();
 143 }
 144
 145
 146 /**
 147  * If listing is enabled, prints information about the egos.
 148  *
 149  * This function is initially called for all egos and then again
 150  * whenever a ego's identifier changes or if it is deleted.  At the
 151  * end of the initial pass over all egos, the function is once called
 152  * with 'NULL' for 'ego'. That does NOT mean that the callback won't
 153  * be invoked in the future or that there was an error.
 154  *
 155  * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get',
 156  * this function is only called ONCE, and 'NULL' being passed in
 157  * 'ego' does indicate an error (i.e. name is taken or no default
 158  * value is known).  If 'ego' is non-NULL and if '*ctx'
 159  * is set in those callbacks, the value WILL be passed to a subsequent
 160  * call to the identity callback of 'GNUNET_IDENTITY_connect' (if
 161  * that one was not NULL).
 162  *
 163  * When an identity is renamed, this function is called with the
 164  * (known) ego but the NEW identifier.
 165  *
 166  * When an identity is deleted, this function is called with the
 167  * (known) ego and "NULL" for the 'identifier'.  In this case,
 168  * the 'ego' is henceforth invalid (and the 'ctx' should also be
 169  * cleaned up).
 170  *
 171  * @param cls closure
 172  * @param ego ego handle
 173  * @param ctx context for application to store data for this ego
 174  *                 (during the lifetime of this process, initially NULL)
 175  * @param identifier identifier assigned by the user for this ego,
 176  *                   NULL if the user just deleted the ego and it
 177  *                   must thus no longer be used
 178 */
 179 static void
 180 print_ego (void *cls,
 181            struct GNUNET_IDENTITY_Ego *ego,
 182            void **ctx,
 183            const char *identifier)
 184 {
 185
 186   if (! (list | monitor))
 187     return;
 188   if ( (NULL == ego) && (! monitor) )
 189   {
 190     GNUNET_SCHEDULER_shutdown ();
 191     return;
 192   }
 193   fprintf (stderr, "%s\n", identifier);
 194 }
 195
 196
 197 /**
 198  * Main function that will be run by the scheduler.
 199  *
 200  * @param cls closure
 201  * @param args remaining command-line arguments
 202  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 203  * @param cfg configuration
 204  */
 205 static void
 206 run (void *cls, char *const *args, const char *cfgfile,
 207      const struct GNUNET_CONFIGURATION_Handle *cfg)
 208 {
 209   sh = GNUNET_IDENTITY_connect (cfg, &print_ego, NULL);
 210   if (NULL != delete_ego)
 211     delete_op = GNUNET_IDENTITY_delete (sh,
 212                                         delete_ego,
 213                                         &delete_finished,
 214                                         &delete_op);
 215   if (NULL != create_ego)
 216     create_op = GNUNET_IDENTITY_create (sh,
 217                                         create_ego,
 218                                         &create_finished,
 219                                         &create_op);
 220   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 221                                 &shutdown_task, NULL);
 222   test_finished ();
 223 }
 224
 225
 226 /**
 227  * The main function.
 228  *
 229  * @param argc number of arguments from the command line
 230  * @param argv command line arguments
 231  * @return 0 ok, 1 on error
 232  */
 233 int
 234 main (int argc, char *const *argv)
 235 {
 236   int res;
 237
 238   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 239     {'C', "create", "NAME",
 240      gettext_noop ("create ego NAME"),
 241      1, &GNUNET_GETOPT_set_string, &create_ego},
 242     {'D', "delete", "NAME",
 243      gettext_noop ("delete ego NAME "),
 244      1, &GNUNET_GETOPT_set_string, &delete_ego},
 245     {'L', "list", NULL,
 246      gettext_noop ("list all egos"),
 247      0, &GNUNET_GETOPT_set_one, &list},
 248     {'m', "monitor", NULL,
 249      gettext_noop ("run in monitor mode egos"),
 250      0, &GNUNET_GETOPT_set_one, &monitor},
 251     GNUNET_GETOPT_OPTION_END
 252   };
 253
 254   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 255     return 2;
 256
 257   res = GNUNET_PROGRAM_run (argc, argv, "gnunet-identity",
 258                             gettext_noop ("Maintain egos"),
 259                             options, &run,
 260                             NULL);
 261   GNUNET_free ((void *) argv);
 262
 263   if (GNUNET_OK != res)
 264     return 1;
 265   return 0;
 266 }
 267
 268 /* end of gnunet-identity.c */