command line tool to inspect the name cache More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_identity_service.h"
#include "gnunet_gnsrecord_lib.h"
#include "gnunet_namecache_service.h"

Include dependency graph for gnunet-namecache.c:

Functions
static void	do_shutdown (void *cls)
	Task run on shutdown.

static void	display_records_from_block (void cls, unsigned int rd_len, const struct GNUNET_GNSRECORD_Data rd)
	Process a record that was stored in the namecache in a block.

static void	handle_block (void cls, const struct GNUNET_GNSRECORD_Block block)
	Display block obtained from listing (by name).

static void	handle_delete (void cls, int32_t success, const char emsg)
	Block removal finished.

static void	run (void cls, char const args, const char cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
	Main function that will be run.

int	main (int argc, char const argv)
	The main function for gnunet-namecache.

Variables
static struct GNUNET_NAMECACHE_Handle *	ns
	Handle to the namecache.

static struct GNUNET_NAMECACHE_QueueEntry *	qe
	Queue entry for the 'query' operation.

static char *	name
	Name (label) of the records to list.

static struct GNUNET_CRYPTO_BlindablePublicKey	pubkey
	Public key of the zone to look in.

static char *	pkey
	Public key of the zone to look in, in ASCII.

static int	ret
	Global return value.

static int	del
	Remove the block instead of displaying it?

Detailed Description

command line tool to inspect the name cache

Author: Christian Grothoff

TODO:

test

Definition in file gnunet-namecache.c.

Function Documentation

◆ do_shutdown()

static void do_shutdown ( void * cls )

static

Task run on shutdown.

Cleans up everything.

Parameters

cls unused

Definition at line 77 of file gnunet-namecache.c.

{
  if (NULL != qe)
  {
    GNUNET_NAMECACHE_cancel (qe);
    qe = NULL;
  }
  if (NULL != ns)
  {
    GNUNET_NAMECACHE_disconnect (ns);
    ns = NULL;
  }
}

References GNUNET_NAMECACHE_cancel(), GNUNET_NAMECACHE_disconnect(), ns, and qe.

Here is the call graph for this function:

◆ display_records_from_block()

static void display_records_from_block	(	void *	cls,
		unsigned int	rd_len,
		const struct GNUNET_GNSRECORD_Data *	rd
	)

static

Process a record that was stored in the namecache in a block.

Parameters

cls	closure, NULL
rd_len	number of entries in rd array
rd	array of records with data to store

Definition at line 100 of file gnunet-namecache.c.

{
  const char *typestring;
  char *s;
  unsigned int i;
 
  if (0 == rd_len)
  {
    fprintf (stdout, _ ("No records found for `%s'"), name);
    return;
  }
  fprintf (stdout, "%s:\n", name);
  for (i = 0; i < rd_len; i++)
  {
    typestring = GNUNET_GNSRECORD_number_to_typename (rd[i].record_type);
    s = GNUNET_GNSRECORD_value_to_string (rd[i].record_type,
                                          rd[i].data,
                                          rd[i].data_size);
    if (NULL == s)
    {
      fprintf (stdout,
               _ ("\tCorrupt or unsupported record of type %u\n"),
               (unsigned int) rd[i].record_type);
      continue;
    }
    fprintf (stdout, "\t%s: %s\n", typestring, s);
    GNUNET_free (s);
  }
  fprintf (stdout, "%s", "\n");
}

References _, data, data_size, GNUNET_free, GNUNET_GNSRECORD_number_to_typename(), GNUNET_GNSRECORD_value_to_string(), name, rd, and typestring.

Referenced by handle_block().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handle_block()

static void handle_block	(	void *	cls,
		const struct GNUNET_GNSRECORD_Block *	block
	)

static

Display block obtained from listing (by name).

Parameters

cls	NULL
block	NULL if not found

Definition at line 141 of file gnunet-namecache.c.

{
  qe = NULL;
  if (NULL == block)
  {
    fprintf (stderr, "No matching block found\n");
  }
  else if (GNUNET_OK !=
           GNUNET_GNSRECORD_block_decrypt (block,
                                           &pubkey,
                                           name,
                                           &display_records_from_block,
                                           NULL))
  {
    fprintf (stderr, "Failed to decrypt block!\n");
  }
  GNUNET_SCHEDULER_shutdown ();
}

References display_records_from_block(), GNUNET_GNSRECORD_block_decrypt(), GNUNET_OK, GNUNET_SCHEDULER_shutdown(), name, pubkey, and qe.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handle_delete()

static void handle_delete	(	void *	cls,
		int32_t	success,
		const char *	emsg
	)

static

Block removal finished.

Parameters

cls	NULL
success	GNUNET_OK if a block was removed, GNUNET_NO if there was none, GNUNET_SYSERR on error
emsg	error message, NULL on success

Definition at line 170 of file gnunet-namecache.c.

{
  qe = NULL;
  switch (success)
  {
  case GNUNET_OK:
    fprintf (stdout,
             _ ("Removed cached block for `%s'\n"),
             name);
    break;
 
  case GNUNET_NO:
    fprintf (stdout,
             _ ("No cached block for `%s'\n"),
             name);
    break;
 
  default:
    fprintf (stderr,
             _ ("Failed to remove cached block for `%s': %s\n"),
             name,
             (NULL != emsg) ? emsg : "unknown error");
    ret = 1;
    break;
  }
  GNUNET_SCHEDULER_shutdown ();
}

References _, GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_shutdown(), name, qe, and ret.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

static void run	(	void *	cls,
		char const	args,
		const char *	cfgfile,
		const struct GNUNET_CONFIGURATION_Handle *	cfg
	)

static

Main function that will be run.

Parameters

cls	closure
args	remaining command-line arguments
cfgfile	name of the configuration file used (for saving, can be NULL!)
cfg	configuration

Definition at line 210 of file gnunet-namecache.c.

{
  struct GNUNET_HashCode dhash;
 
  if (NULL == pkey)
  {
    fprintf (stderr, _ ("You must specify which zone should be accessed\n"));
    return;
  }
 
  if (GNUNET_OK !=
      GNUNET_CRYPTO_blindable_public_key_from_string (pkey, &pubkey))
  {
    fprintf (stderr, _ ("Invalid public key for zone `%s'\n"), pkey);
    GNUNET_SCHEDULER_shutdown ();
    return;
  }
  if (NULL == name)
  {
    fprintf (stderr, _ ("You must specify a name\n"));
    return;
  }
 
  GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
  ns = GNUNET_NAMECACHE_connect (cfg);
  GNUNET_GNSRECORD_query_from_public_key (&pubkey, name, &dhash);
  if (del)
    qe = GNUNET_NAMECACHE_block_delete (ns, &dhash, &handle_delete, NULL);
  else
    qe = GNUNET_NAMECACHE_lookup_block (ns, &dhash, &handle_block, NULL);
}

References _, cfg, del, do_shutdown, GNUNET_CRYPTO_blindable_public_key_from_string(), GNUNET_GNSRECORD_query_from_public_key(), GNUNET_NAMECACHE_block_delete(), GNUNET_NAMECACHE_connect(), GNUNET_NAMECACHE_lookup_block(), GNUNET_OK, GNUNET_SCHEDULER_add_shutdown(), GNUNET_SCHEDULER_shutdown(), handle_block(), handle_delete(), name, ns, pkey, pubkey, and qe.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ main()

int main	(	int	argc,
		char const	argv
	)

The main function for gnunet-namecache.

Parameters

argc	number of arguments from the command line
argv	command line arguments

Returns: 0 ok, 1 on error

Definition at line 254 of file gnunet-namecache.c.

{
  struct GNUNET_GETOPT_CommandLineOption options[] =
  { GNUNET_GETOPT_option_flag ('d',
                               "delete",
                               gettext_noop (
                                 "remove the cached block, so that the next resolution goes to the DHT"),
                               &del),
 
    GNUNET_GETOPT_option_string ('n',
                                 "name",
                                 "NAME",
                                 gettext_noop (
                                   "name of the record to add/delete/display"),
                                 &name),
 
    GNUNET_GETOPT_option_string (
      'z',
      "zone",
      "PKEY",
      gettext_noop ("specifies the public key of the zone to look in"),
      &pkey),
 
    GNUNET_GETOPT_OPTION_END };
 
  GNUNET_log_setup ("gnunet-namecache", "WARNING", NULL);
  if (GNUNET_OK !=
      GNUNET_PROGRAM_run (GNUNET_OS_project_data_gnunet (),
                          argc,
                          argv,
                          "gnunet-namecache",
                          _ ("GNUnet zone manipulation tool"),
                          options,
                          &run,
                          NULL))
  {
    return 1;
  }
  return ret;
}