2 This file is part of GNUnet.
3 (C) 2012 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.
21 * @file gnunet-namestore.c
22 * @brief command line tool to manipulate the local zone
23 * @author Christian Grothoff
26 * - allow users to set record options (not just 'RF_AUTHORITY')
28 * - parsing SOA, PTR and MX value specifications (and define format!)
29 * - add options to list/lookup individual records
32 #include <gnunet_util_lib.h>
33 #include <gnunet_dnsparser_lib.h>
34 #include <gnunet_namestore_service.h>
37 * Handle to the namestore.
39 static struct GNUNET_NAMESTORE_Handle *ns;
42 * Hash of the public key of our zone.
44 static GNUNET_HashCode zone;
47 * Private key for the our zone.
49 static struct GNUNET_CRYPTO_RsaPrivateKey *zone_pkey;
52 * Keyfile to manipulate.
57 * Desired action is to add a record.
62 * Queue entry for the 'add' operation.
64 static struct GNUNET_NAMESTORE_QueueEntry *add_qe;
67 * Desired action is to list records.
72 * List iterator for the 'list' operation.
74 static struct GNUNET_NAMESTORE_ZoneIterator *list_it;
77 * Desired action is to remove a record.
82 * Queue entry for the 'del' operation.
84 static struct GNUNET_NAMESTORE_QueueEntry *del_qe;
87 * Name of the records to add/list/remove.
92 * Value of the record to add/remove.
97 * Type of the record to add/remove, NULL to remove all.
99 static char *typestring;
102 * Desired expiration time.
104 static char *expirationstring;
108 * Task run on shutdown. Cleans up everything.
111 * @param tc scheduler context
114 do_shutdown (void *cls,
115 const struct GNUNET_SCHEDULER_TaskContext *tc)
119 GNUNET_NAMESTORE_disconnect (ns, GNUNET_NO);
122 if (NULL != zone_pkey)
124 GNUNET_CRYPTO_rsa_key_free (zone_pkey);
131 * Continuation called to notify client about result of the
134 * @param cls closure, unused
135 * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
136 * GNUNET_NO if content was already there
137 * GNUNET_YES (or other positive value) on success
138 * @param emsg NULL on success, otherwise an error message
141 add_continuation (void *cls,
146 if (success != GNUNET_YES)
148 _("Adding record failed: %s\n"),
149 (success == GNUNET_NO) ? "record exists" : emsg);
150 if ( (NULL == del_qe) &&
152 GNUNET_SCHEDULER_shutdown ();
157 * Continuation called to notify client about result of the
160 * @param cls closure, unused
161 * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
162 * GNUNET_NO if content was already there
163 * GNUNET_YES (or other positive value) on success
164 * @param emsg NULL on success, otherwise an error message
167 del_continuation (void *cls,
172 if (success != GNUNET_YES)
174 _("Deleting record failed: %s\n"),
176 if ( (NULL == add_qe) &&
178 GNUNET_SCHEDULER_shutdown ();
183 * Process a record that was stored in the namestore.
186 * @param zone_key public key of the zone
187 * @param expire when does the corresponding block in the DHT expire (until
188 * when should we never do a DHT lookup for the same name again)?;
189 * GNUNET_TIME_UNIT_ZERO_ABS if there are no records of any type in the namestore,
190 * or the expiration time of the block in the namestore (even if there are zero
191 * records matching the desired record type)
192 * @param name name that is being mapped (at most 255 characters long)
193 * @param rd_len number of entries in 'rd' array
194 * @param rd array of records with data to store
195 * @param signature signature of the record block, NULL if signature is unavailable (i.e.
196 * because the user queried for a particular record type only)
199 display_record (void *cls,
200 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
201 struct GNUNET_TIME_Absolute expire,
204 const struct GNUNET_NAMESTORE_RecordData *rd,
205 const struct GNUNET_CRYPTO_RsaSignature *signature)
207 const char *typestring;
214 if ( (NULL == del_qe) &&
216 GNUNET_SCHEDULER_shutdown ();
222 for (i=0;i<rd_len;i++)
224 typestring = GNUNET_NAMESTORE_number_to_typename (rd[i].record_type);
225 s = GNUNET_NAMESTORE_value_to_string (rd[i].record_type,
230 FPRINTF (stdout, _("\tCorrupt or unsupported record of type %u\n"),
231 (unsigned int) rd[i].record_type);
234 FPRINTF (stdout, "\t%s: %s\n", typestring, s);
237 FPRINTF (stdout, "%s", "\n");
238 GNUNET_NAMESTORE_zone_iterator_next (list_it);
243 * Main function that will be run.
246 * @param args remaining command-line arguments
247 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
248 * @param cfg configuration
251 run (void *cls, char *const *args, const char *cfgfile,
252 const struct GNUNET_CONFIGURATION_Handle *cfg)
254 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pub;
257 size_t data_size = 0;
258 struct GNUNET_TIME_Relative etime;
259 struct GNUNET_NAMESTORE_RecordData rd;
264 _("Option `%s' not given, but I need a zone key file!\n"),
268 zone_pkey = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
269 GNUNET_free (keyfile);
271 if (! (add|del|list))
273 /* nothing more to be done */
274 GNUNET_CRYPTO_rsa_key_free (zone_pkey);
278 if (NULL == zone_pkey)
280 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
281 _("Failed to read or create private zone key\n"));
284 GNUNET_CRYPTO_rsa_key_get_public (zone_pkey,
286 GNUNET_CRYPTO_hash (&pub, sizeof (pub), &zone);
288 ns = GNUNET_NAMESTORE_connect (cfg);
291 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
292 _("Failed to connect to namestore\n"));
295 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
297 if (NULL == typestring)
300 type = GNUNET_NAMESTORE_typename_to_number (typestring);
301 if (UINT32_MAX == type)
303 fprintf (stderr, _("Unsupported type `%s'\n"), typestring);
304 GNUNET_SCHEDULER_shutdown ();
306 } else if (add | del)
309 _("Missing option `%s' for operation `%s'\n"),
311 GNUNET_SCHEDULER_shutdown ();
317 GNUNET_NAMESTORE_string_to_value (type,
322 fprintf (stderr, _("Value `%s' invalid for record type `%s'\n"),
325 GNUNET_SCHEDULER_shutdown ();
328 } else if (add | del)
331 _("Missing option `%s' for operation `%s'\n"),
333 GNUNET_SCHEDULER_shutdown ();
336 if (NULL != expirationstring)
339 GNUNET_STRINGS_fancy_time_to_relative (expirationstring,
343 _("Invalid time format `%s'\n"),
345 GNUNET_SCHEDULER_shutdown ();
348 } else if (add | del)
351 _("Missing option `%s' for operation `%s'\n"),
353 GNUNET_SCHEDULER_shutdown ();
361 _("Missing option `%s' for operation `%s'\n"),
363 GNUNET_SCHEDULER_shutdown ();
367 rd.data_size = data_size;
368 rd.record_type = type;
369 rd.expiration = GNUNET_TIME_relative_to_absolute (etime);
370 rd.flags = GNUNET_NAMESTORE_RF_AUTHORITY; // FIXME: not always...
371 add_qe = GNUNET_NAMESTORE_record_create (ns,
383 _("Missing option `%s' for operation `%s'\n"),
385 GNUNET_SCHEDULER_shutdown ();
389 rd.data_size = data_size;
390 rd.record_type = type;
391 rd.expiration = GNUNET_TIME_relative_to_absolute (etime);
392 rd.flags = GNUNET_NAMESTORE_RF_AUTHORITY; // FIXME: not always...
393 del_qe = GNUNET_NAMESTORE_record_remove (ns,
402 list_it = GNUNET_NAMESTORE_zone_iteration_start (ns,
408 GNUNET_free_non_null (data);
413 * The main function for gnunet-namestore.
415 * @param argc number of arguments from the command line
416 * @param argv command line arguments
417 * @return 0 ok, 1 on error
420 main (int argc, char *const *argv)
422 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
424 gettext_noop ("add record"), 0,
425 &GNUNET_GETOPT_set_one, &add},
426 {'d', "delete", NULL,
427 gettext_noop ("delete record"), 0,
428 &GNUNET_GETOPT_set_one, &del},
429 {'D', "display", NULL,
430 gettext_noop ("display records"), 0,
431 &GNUNET_GETOPT_set_one, &list},
432 {'e', "expiration", "TIME",
433 gettext_noop ("expiration time for record to use (for adding only)"), 1,
434 &GNUNET_GETOPT_set_string, &expirationstring},
435 {'n', "name", "NAME",
436 gettext_noop ("name of the record to add/delete/display"), 1,
437 &GNUNET_GETOPT_set_string, &name},
438 {'t', "type", "TYPE",
439 gettext_noop ("type of the record to add/delete/display"), 1,
440 &GNUNET_GETOPT_set_string, &typestring},
441 {'V', "value", "VALUE",
442 gettext_noop ("value of the record to add/delete"), 1,
443 &GNUNET_GETOPT_set_string, &value},
444 {'z', "zonekey", "FILENAME",
445 gettext_noop ("filename with the zone key"), 1,
446 &GNUNET_GETOPT_set_string, &keyfile},
447 GNUNET_GETOPT_OPTION_END
452 GNUNET_log_setup ("gnunet-namestore", "WARNING", NULL);
455 GNUNET_PROGRAM_run (argc, argv, "gnunet-namestore",
456 _("GNUnet zone manipulation tool"),
458 &run, NULL)) ? 0 : 1;
463 /* end of gnunet-namestore.c */