GNUnet 0.21.0
gnunet-gns.c File Reference

command line tool to access distributed GNS More...

Include dependency graph for gnunet-gns.c:

Go to the source code of this file.

Functions

static void do_shutdown (void *cls)
 Task run on shutdown. More...
 
static void do_timeout (void *cls)
 Task to run on timeout. More...
 
static void process_lookup_result (void *cls, int was_gns, uint32_t rd_count, const struct GNUNET_GNSRECORD_Data *rd)
 Function called with the result of a GNS lookup. More...
 
static void run (void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
 Main function that will be run. More...
 
int main (int argc, char *const *argv)
 The main function for gnunet-gns. More...
 

Variables

static const struct GNUNET_CONFIGURATION_Handlecfg
 Configuration we are using. More...
 
static struct GNUNET_GNS_Handlegns
 Handle to GNS service. More...
 
static char * lookup_name
 GNS name to lookup. More...
 
char * idna_name
 DNS IDNA name to lookup. More...
 
static int dns_compat
 DNS compatibility (name is given as DNS name, possible IDNA). More...
 
static char * lookup_type
 record type to look up (-t option) More...
 
static int raw
 raw output More...
 
static uint32_t rtype
 Desired record type. More...
 
static struct GNUNET_TIME_Relative timeout
 Timeout for lookup. More...
 
static struct GNUNET_SCHEDULER_Taskto_task
 Timeout task. More...
 
static struct GNUNET_GNS_LookupWithTldRequestlr
 Handle to lookup request. More...
 
static int global_ret
 Global return value. More...
 

Detailed Description

command line tool to access distributed GNS

binary version of gnunet-gns-import.sh (for OSes that have no POSIX shell).

Author
Christian Grothoff
LRN

Definition in file gnunet-gns.c.

Function Documentation

◆ do_shutdown()

static void do_shutdown ( void *  cls)
static

Task run on shutdown.

Cleans up everything.

Parameters
clsunused

Definition at line 116 of file gnunet-gns.c.

117{
118 (void) cls;
119 if (NULL != to_task)
120 {
122 to_task = NULL;
123 }
124 if (NULL != lr)
125 {
127 lr = NULL;
128 }
129 if (NULL != gns)
130 {
132 gns = NULL;
133 }
134 if (NULL != idna_name)
135 {
137 idna_name = NULL;
138 }
139}
static struct GNUNET_GNS_Handle * gns
Handle to GNS service.
Definition: gnunet-gns.c:53
static struct GNUNET_SCHEDULER_Task * to_task
Timeout task.
Definition: gnunet-gns.c:93
char * idna_name
DNS IDNA name to lookup.
Definition: gnunet-gns.c:63
static struct GNUNET_GNS_LookupWithTldRequest * lr
Handle to lookup request.
Definition: gnunet-gns.c:98
void GNUNET_GNS_disconnect(struct GNUNET_GNS_Handle *handle)
Shutdown connection with the GNS service.
Definition: gns_api.c:289
void * GNUNET_GNS_lookup_with_tld_cancel(struct GNUNET_GNS_LookupWithTldRequest *ltr)
Cancel pending lookup request.
Definition: gns_tld_api.c:331
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:975

References gns, GNUNET_free, GNUNET_GNS_disconnect(), GNUNET_GNS_lookup_with_tld_cancel(), GNUNET_SCHEDULER_cancel(), idna_name, lr, and to_task.

Referenced by run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ do_timeout()

static void do_timeout ( void *  cls)
static

Task to run on timeout.

Parameters
clsunused

Definition at line 148 of file gnunet-gns.c.

149{
150 to_task = NULL;
151 global_ret = 3; // Timeout
153}
static int global_ret
Global return value.
Definition: gnunet-gns.c:107
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:562

References global_ret, GNUNET_SCHEDULER_shutdown(), and to_task.

Referenced by run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ process_lookup_result()

static void process_lookup_result ( void *  cls,
int  was_gns,
uint32_t  rd_count,
const struct GNUNET_GNSRECORD_Data rd 
)
static

Function called with the result of a GNS lookup.

Parameters
clsthe 'const char *' name that was resolved
was_gnsGNUNET_NO if TLD did not indicate use of GNS
rd_countnumber of records returned
rdarray of rd_count records with the results

Definition at line 165 of file gnunet-gns.c.

169{
170 struct GNUNET_TIME_Relative block_exp;
171 const char *name = cls;
172 const char *typename;
173 char *string_val;
174
175 lr = NULL;
176 if (GNUNET_NO == was_gns)
177 {
178 global_ret = 4; /* not for GNS */
180 return;
181 }
184 rd_count,
185 rd,
187 if (! raw)
188 {
189 printf ("<<< %u record(s) found:\n\n", rd_count);
190 }
191 for (uint32_t i = 0; i < rd_count; i++)
192 {
194 record_type);
195 string_val = GNUNET_GNSRECORD_value_to_string (rd[i].record_type
196 ,
197 rd[i].data,
198 rd[i].data_size);
199 if (NULL == string_val)
200 {
201 fprintf (stderr,
202 "Record %u of type %d malformed, skipping\n",
203 (unsigned int) i,
204 (int) rd[i].record_type);
205 continue;
206 }
207 if (raw)
208 printf ("%s\n", string_val);
209 else
210 printf ("%s: `%s' %s\n",
211 typename,
212 string_val,
213 (0 != (rd[i].flags
214 &
216 ) ?
217 "(supplemental)" : "");
218 GNUNET_free (string_val);
219 }
220 if (! raw)
221 {
222 if (0 != rd_count)
223 printf ("\nRecord set expires in %s.\n",
225 block_exp, GNUNET_YES));
226 }
228}
static char * data
The data to insert into the dht.
static int raw
raw output
Definition: gnunet-gns.c:78
static char * name
Name (label) of the records to list.
static unsigned int rd_count
Number of records for currently parsed set.
static struct GNUNET_GNSRECORD_Data rd[50]
The record data under a single label.
static size_t data_size
Number of bytes in data.
const char * GNUNET_GNSRECORD_number_to_typename(uint32_t type)
Convert a type number to the corresponding type string (e.g.
Definition: gnsrecord.c:227
struct GNUNET_TIME_Absolute GNUNET_GNSRECORD_record_get_expiration_time(unsigned int rd_count, const struct GNUNET_GNSRECORD_Data *rd, struct GNUNET_TIME_Absolute min)
Returns the expiration time of the given block of records.
char * GNUNET_GNSRECORD_value_to_string(uint32_t type, const void *data, size_t data_size)
Convert the binary value data of a record of type type to a human-readable string.
Definition: gnsrecord.c:155
@ GNUNET_GNSRECORD_RF_SUPPLEMENTAL
This is a supplemental record.
@ GNUNET_YES
@ GNUNET_NO
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:405
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:570
#define GNUNET_TIME_UNIT_ZERO_ABS
Absolute time zero.
Time for relative time used by GNUnet, in microseconds.

References data, data_size, global_ret, GNUNET_free, GNUNET_GNSRECORD_number_to_typename(), GNUNET_GNSRECORD_record_get_expiration_time(), GNUNET_GNSRECORD_RF_SUPPLEMENTAL, GNUNET_GNSRECORD_value_to_string(), GNUNET_NO, GNUNET_SCHEDULER_shutdown(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_absolute_get_remaining(), GNUNET_TIME_UNIT_ZERO_ABS, GNUNET_YES, lr, name, raw, rd, and rd_count.

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 c 
)
static

Main function that will be run.

Parameters
clsclosure
argsremaining command-line arguments
cfgfilename of the configuration file used (for saving, can be NULL!)
cconfiguration

If DNS compatibility is requested, we first verify that the lookup_name is in a DNS format. If yes, we convert it to UTF-8.

Definition at line 240 of file gnunet-gns.c.

244{
245 (void) cls;
246 (void) args;
247 (void) cfgfile;
248
249 cfg = c;
250 to_task = NULL;
251 {
252 char *colon;
253
254 if (NULL != (colon = strchr (lookup_name, ':')))
255 *colon = '\0';
256 }
257
262 if (GNUNET_YES == dns_compat)
263 {
264 Idna_rc rc;
265
267 {
268 fprintf (stderr,
269 _ ("`%s' is not a valid DNS domain name\n"),
271 global_ret = 3;
272 return;
273 }
274 if (IDNA_SUCCESS !=
275 (rc = idna_to_unicode_8z8z (lookup_name, &idna_name,
276 IDNA_ALLOW_UNASSIGNED)))
277 {
278 fprintf (stderr,
279 _ (
280 "Failed to convert DNS IDNA name `%s' to UTF-8: %s\n"),
282 idna_strerror (rc));
283 global_ret = 4;
284 return;
285 }
287 }
288
289 if (GNUNET_YES !=
291 "arm"))
292 {
294 _ (
295 "Cannot resolve using GNS: GNUnet peer not running\n"));
296 global_ret = 5;
297 return;
298 }
300 &do_timeout,
301 NULL);
303 if (NULL == gns)
304 {
305 fprintf (stderr,
306 _ ("Failed to connect to GNS\n"));
307 global_ret = 2;
308 return;
309 }
311 NULL);
312 if (NULL != lookup_type)
314 else
316 if (UINT32_MAX == rtype)
317 {
318 fprintf (stderr,
319 _ ("Invalid typename specified, assuming `ANY'\n"));
321 }
322 if (! raw)
323 {
324 printf (">>> Looking for `%s' records under `%s'\n",
326 }
329 rtype,
333 if (NULL == lr)
334 {
335 global_ret = 2;
337 return;
338 }
339}
static void do_timeout(void *cls)
Task to run on timeout.
Definition: gnunet-gns.c:148
static char * lookup_name
GNS name to lookup.
Definition: gnunet-gns.c:58
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-gns.c:48
static void do_shutdown(void *cls)
Task run on shutdown.
Definition: gnunet-gns.c:116
static int dns_compat
DNS compatibility (name is given as DNS name, possible IDNA).
Definition: gnunet-gns.c:68
static struct GNUNET_TIME_Relative timeout
Timeout for lookup.
Definition: gnunet-gns.c:88
static void process_lookup_result(void *cls, int was_gns, uint32_t rd_count, const struct GNUNET_GNSRECORD_Data *rd)
Function called with the result of a GNS lookup.
Definition: gnunet-gns.c:165
static char * lookup_type
record type to look up (-t option)
Definition: gnunet-gns.c:73
static uint32_t rtype
Desired record type.
Definition: gnunet-gns.c:83
int GNUNET_CLIENT_test(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *service_name)
Test if the port or UNIXPATH of the given service_name is in use and thus (most likely) the respectiv...
Definition: client.c:903
#define GNUNET_DNSPARSER_TYPE_A
int GNUNET_DNSPARSER_check_name(const char *name)
Check if a hostname in UTF-8 format can be coded into valid IDNA.
Definition: dnsparser.c:79
struct GNUNET_GNS_LookupWithTldRequest * GNUNET_GNS_lookup_with_tld(struct GNUNET_GNS_Handle *handle, const char *name, uint32_t type, enum GNUNET_GNS_LocalOptions options, GNUNET_GNS_LookupResultProcessor2 proc, void *proc_cls)
Perform an asynchronous lookup operation on the GNS, determining the zone using the TLD of the given ...
Definition: gns_tld_api.c:240
struct GNUNET_GNS_Handle * GNUNET_GNS_connect(const struct GNUNET_CONFIGURATION_Handle *cfg)
Initialize the connection with the GNS service.
Definition: gns_api.c:267
@ GNUNET_GNS_LO_DEFAULT
Defaults, look in cache, then in DHT.
uint32_t GNUNET_GNSRECORD_typename_to_number(const char *dns_typename)
Convert a type name (e.g.
Definition: gnsrecord.c:200
#define GNUNET_GNSRECORD_TYPE_ANY
Record type indicating any record/'*'.
#define GNUNET_log(kind,...)
@ GNUNET_OK
@ GNUNET_ERROR_TYPE_WARNING
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received,...
Definition: scheduler.c:1334
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1272
#define _(String)
GNU gettext support macro.
Definition: platform.h:178

References _, consensus-simulation::args, cfg, dns_compat, do_shutdown(), do_timeout(), global_ret, gns, GNUNET_CLIENT_test(), GNUNET_DNSPARSER_check_name(), GNUNET_DNSPARSER_TYPE_A, GNUNET_ERROR_TYPE_WARNING, GNUNET_GNS_connect(), GNUNET_GNS_LO_DEFAULT, GNUNET_GNS_lookup_with_tld(), GNUNET_GNSRECORD_TYPE_ANY, GNUNET_GNSRECORD_typename_to_number(), GNUNET_log, GNUNET_OK, GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_add_shutdown(), GNUNET_SCHEDULER_shutdown(), GNUNET_YES, idna_name, lookup_name, lookup_type, lr, process_lookup_result(), raw, rtype, timeout, and to_task.

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-gns.

Parameters
argcnumber of arguments from the command line
argvcommand line arguments
Returns
0 ok, 1 on error

Definition at line 350 of file gnunet-gns.c.

351{
356 "lookup",
357 "NAME",
359 "Lookup a record for the given name"),
360 &lookup_name)),
362 "type",
363 "TYPE",
365 "Specify the type of the record to lookup"),
366 &lookup_type),
368 "timeout",
369 "TIMEOUT",
371 "Specify a timeout for the lookup"),
372 &timeout),
374 "raw",
375 gettext_noop ("No unneeded output"),
376 &raw),
378 "dns",
380 "DNS Compatibility: Name is passed in IDNA instead of UTF-8"),
381 &dns_compat),
383 int ret;
384
385 if (GNUNET_OK !=
387 &argc, &argv))
388 return 2;
389
390 GNUNET_log_setup ("gnunet-gns", "WARNING", NULL);
391 ret = GNUNET_PROGRAM_run (argc,
392 argv,
393 "gnunet-gns",
394 _ ("GNUnet GNS resolver tool"),
395 options,
396 &run,
397 NULL);
398 GNUNET_free_nz ((void *) argv);
399 if (GNUNET_OK != ret)
400 return 1;
401 return global_ret;
402}
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
#define gettext_noop(String)
Definition: gettext.h:70
static int ret
Final status code.
Definition: gnunet-arm.c:94
static void run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
Main function that will be run.
Definition: gnunet-gns.c:240
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_mandatory(struct GNUNET_GETOPT_CommandLineOption opt)
Make the given option mandatory.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_relative_time(char shortName, const char *name, const char *argumentHelp, const char *description, struct GNUNET_TIME_Relative *val)
Allow user to specify a struct GNUNET_TIME_Relative (using human-readable "fancy" time).
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_flag(char shortName, const char *name, const char *description, int *val)
Allow user to specify a flag (which internally means setting an integer to 1/GNUNET_YES/GNUNET_OK.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_string(char shortName, const char *name, const char *argumentHelp, const char *description, char **str)
Allow user to specify a string.
enum GNUNET_GenericReturnValue GNUNET_log_setup(const char *comp, const char *loglevel, const char *logfile)
Setup logging.
#define GNUNET_free_nz(ptr)
Wrapper around free.
enum GNUNET_GenericReturnValue GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration,...
Definition: program.c:400
enum GNUNET_GenericReturnValue GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1230
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
Definition of a command line option.

References _, dns_compat, gettext_noop, global_ret, GNUNET_free_nz, GNUNET_GETOPT_OPTION_END, GNUNET_GETOPT_option_flag(), GNUNET_GETOPT_option_mandatory(), GNUNET_GETOPT_option_relative_time(), GNUNET_GETOPT_option_string(), GNUNET_log_setup(), GNUNET_OK, GNUNET_PROGRAM_run(), GNUNET_STRINGS_get_utf8_args(), GNUNET_TIME_UNIT_FOREVER_REL, lookup_name, lookup_type, options, raw, ret, run(), and timeout.

Here is the call graph for this function:

Variable Documentation

◆ cfg

const struct GNUNET_CONFIGURATION_Handle* cfg
static

Configuration we are using.

Definition at line 48 of file gnunet-gns.c.

Referenced by run().

◆ gns

struct GNUNET_GNS_Handle* gns
static

Handle to GNS service.

Definition at line 53 of file gnunet-gns.c.

Referenced by do_shutdown(), and run().

◆ lookup_name

char* lookup_name
static

GNS name to lookup.

(-u option)

Definition at line 58 of file gnunet-gns.c.

Referenced by main(), and run().

◆ idna_name

char* idna_name

DNS IDNA name to lookup.

(set if -d option is set)

Definition at line 63 of file gnunet-gns.c.

Referenced by do_shutdown(), GNUNET_DNSPARSER_builder_add_name(), and run().

◆ dns_compat

int dns_compat
static

DNS compatibility (name is given as DNS name, possible IDNA).

Definition at line 68 of file gnunet-gns.c.

Referenced by main(), and run().

◆ lookup_type

char* lookup_type
static

record type to look up (-t option)

Definition at line 73 of file gnunet-gns.c.

Referenced by main(), and run().

◆ raw

◆ rtype

uint32_t rtype
static

Desired record type.

Definition at line 83 of file gnunet-gns.c.

Referenced by run().

◆ timeout

struct GNUNET_TIME_Relative timeout
static

Timeout for lookup.

Definition at line 88 of file gnunet-gns.c.

Referenced by main(), and run().

◆ to_task

struct GNUNET_SCHEDULER_Task* to_task
static

Timeout task.

Definition at line 93 of file gnunet-gns.c.

Referenced by do_shutdown(), do_timeout(), and run().

◆ lr

◆ global_ret

int global_ret
static

Global return value.

0 on success (default), 1 on internal failures 2 on launch failure, 4 if the name is not a GNS-supported TLD,

Definition at line 107 of file gnunet-gns.c.

Referenced by do_timeout(), main(), process_lookup_result(), and run().