gnunet_json_lib.h File Reference

functions to parse JSON objects into GNUnet objects More...

#include "gnunet_util_lib.h"
#include "gnunet_gnsrecord_lib.h"
#include <jansson.h>
#include <microhttpd.h>

Include dependency graph for gnunet_json_lib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GNUNET_JSON_Specification
	Entry in parser specification for GNUNET_JSON_parse(). More...

Macros
#define	GNUNET_JSON_spec_fixed_auto(name, obj)   GNUNET_JSON_spec_fixed (name, obj, sizeof(*obj))
	Fixed size object (in network byte order, encoded using Crockford Base32hex encoding). More...
#define	GNUNET_JSON_from_data_auto(ptr)   GNUNET_JSON_from_data (ptr, sizeof(*ptr))
	Convert binary data to a JSON string with the base32crockford encoding. More...

Typedefs
typedef int(*	GNUNET_JSON_Parser) (void *cls, json_t *root, struct GNUNET_JSON_Specification *spec)
	Function called to parse JSON argument. More...
typedef void(*	GNUNET_JSON_Cleaner) (void *cls, struct GNUNET_JSON_Specification *spec)
	Function called to clean up data from earlier parsing. More...

Enumerations
enum	GNUNET_JSON_PostResult {   GNUNET_JSON_PR_SUCCESS, GNUNET_JSON_PR_CONTINUE, GNUNET_JSON_PR_OUT_OF_MEMORY, GNUNET_JSON_PR_REQUEST_TOO_LARGE,   GNUNET_JSON_PR_JSON_INVALID }
	Return codes from GNUNET_JSON_post_parser(). More...

Functions
int	GNUNET_JSON_parse (const json_t *root, struct GNUNET_JSON_Specification *spec, const char **error_json_name, unsigned int *error_line)
	Navigate and parse data in a JSON tree. More...
void	GNUNET_JSON_parse_free (struct GNUNET_JSON_Specification *spec)
	Frees all elements allocated during a GNUNET_JSON_parse() operation. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_end (void)
	End of a parser specification. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_mark_optional (struct GNUNET_JSON_Specification spec)
	Set the "optional" flag for a parser specification entry. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_fixed (const char *name, void *obj, size_t size)
	Variable size object (in network byte order, encoded using Crockford Base32hex encoding). More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_varsize (const char *name, void **obj, size_t *size)
	Variable size object (in network byte order, encoded using Crockford Base32hex encoding). More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_string (const char *name, const char **strptr)
	The expected field stores a string. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_json (const char *name, json_t **jsonp)
	JSON object. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_uint8 (const char *name, uint8_t *u8)
	8-bit integer. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_uint16 (const char *name, uint16_t *u16)
	16-bit integer. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_uint32 (const char *name, uint32_t *u32)
	32-bit integer. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_uint64 (const char *name, uint64_t *u64)
	64-bit integer. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_boolean (const char *name, int *boolean)
	Boolean (true mapped to GNUNET_YES, false mapped to GNUNET_NO). More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_absolute_time (const char *name, struct GNUNET_TIME_Absolute *at)
	Absolute time. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_absolute_time_nbo (const char *name, struct GNUNET_TIME_AbsoluteNBO *at)
	Absolute time in network byte order. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_relative_time (const char *name, struct GNUNET_TIME_Relative *rt)
	Relative time. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_rsa_public_key (const char *name, struct GNUNET_CRYPTO_RsaPublicKey **pk)
	Specification for parsing an RSA public key. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_rsa_signature (const char *name, struct GNUNET_CRYPTO_RsaSignature **sig)
	Specification for parsing an RSA signature. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_gnsrecord (struct GNUNET_GNSRECORD_Data **rd, unsigned int *rd_count, char **name)
	JSON Specification for GNS Records. More...
json_t *	GNUNET_JSON_from_data (const void *data, size_t size)
	Convert binary data to a JSON string with the base32crockford encoding. More...
json_t *	GNUNET_JSON_from_time_abs (struct GNUNET_TIME_Absolute stamp)
	Convert absolute timestamp to a json string. More...
json_t *	GNUNET_JSON_from_time_abs_nbo (struct GNUNET_TIME_AbsoluteNBO stamp)
	Convert absolute timestamp to a json string. More...
json_t *	GNUNET_JSON_from_time_rel (struct GNUNET_TIME_Relative stamp)
	Convert relative timestamp to a json string. More...
json_t *	GNUNET_JSON_from_rsa_public_key (const struct GNUNET_CRYPTO_RsaPublicKey *pk)
	Convert RSA public key to JSON. More...
json_t *	GNUNET_JSON_from_rsa_signature (const struct GNUNET_CRYPTO_RsaSignature *sig)
	Convert RSA signature to JSON. More...
json_t *	GNUNET_JSON_from_gnsrecord (const char *rname, const struct GNUNET_GNSRECORD_Data *rd, unsigned int rd_count)
	Convert Gns record to JSON. More...
enum GNUNET_JSON_PostResult	GNUNET_JSON_post_parser (size_t buffer_max, struct MHD_Connection *connection, void **con_cls, const char *upload_data, size_t *upload_data_size, json_t **json)
	Process a POST request containing a JSON object. More...
void	GNUNET_JSON_post_parser_cleanup (void *con_cls)
	Function called whenever we are done with a request to clean up our state. More...
struct GNUNET_GETOPT_CommandLineOption	GNUNET_JSON_getopt (char shortName, const char *name, const char *argumentHelp, const char *description, json_t **json)
	Allow user to specify a JSON input value. More...

Detailed Description

functions to parse JSON objects into GNUnet objects

Author

Florian Dold

Benedikt Mueller

Christian Grothoff

Definition in file gnunet_json_lib.h.

Macro Definition Documentation

GNUNET_JSON_spec_fixed_auto

#define GNUNET_JSON_spec_fixed_auto	(		name,
			obj
	)		GNUNET_JSON_spec_fixed (name, obj, sizeof(*obj))

Fixed size object (in network byte order, encoded using Crockford Base32hex encoding).

Parameters

name	name of the JSON field
obj	pointer where to write the data (type of *obj will determine size)

Definition at line 184 of file gnunet_json_lib.h.

GNUNET_JSON_from_data_auto

#define GNUNET_JSON_from_data_auto

(

ptr

)

GNUNET_JSON_from_data (ptr, sizeof(*ptr))

Convert binary data to a JSON string with the base32crockford encoding.

Parameters

ptr	binary data, sizeof (*ptr) must yield correct size

Returns

json string that encodes data

Definition at line 360 of file gnunet_json_lib.h.

Typedef Documentation

GNUNET_JSON_Parser

typedef int(* GNUNET_JSON_Parser) (void *cls, json_t *root, struct GNUNET_JSON_Specification *spec)

Function called to parse JSON argument.

Parameters

cls	closure
root	JSON to parse
spec	our specification entry with further details

Returns

GNUNET_SYSERR on error, GNUNET_OK on success

Definition at line 52 of file gnunet_json_lib.h.

GNUNET_JSON_Cleaner

typedef void(* GNUNET_JSON_Cleaner) (void *cls, struct GNUNET_JSON_Specification *spec)

Function called to clean up data from earlier parsing.

Parameters

cls	closure
spec	our specification entry with data to clean.

Definition at line 63 of file gnunet_json_lib.h.

Enumeration Type Documentation

GNUNET_JSON_PostResult

enum GNUNET_JSON_PostResult

Return codes from GNUNET_JSON_post_parser().

Enumerator
GNUNET_JSON_PR_SUCCESS	Parsing successful, JSON result is in *json.
GNUNET_JSON_PR_CONTINUE	Parsing continues, call again soon!
GNUNET_JSON_PR_OUT_OF_MEMORY	Sorry, memory allocation (malloc()) failed.
GNUNET_JSON_PR_REQUEST_TOO_LARGE	Request size exceeded buffer_max argument.
GNUNET_JSON_PR_JSON_INVALID	JSON parsing failed. This was not a JSON upload.

Definition at line 430 of file gnunet_json_lib.h.

{
  GNUNET_JSON_PR_SUCCESS,

  GNUNET_JSON_PR_CONTINUE,

  GNUNET_JSON_PR_OUT_OF_MEMORY,

  GNUNET_JSON_PR_REQUEST_TOO_LARGE,

  GNUNET_JSON_PR_JSON_INVALID
};

Function Documentation

GNUNET_JSON_parse()

int GNUNET_JSON_parse	(	const json_t *	root,
		struct GNUNET_JSON_Specification *	spec,
		const char **	error_json_name,
		unsigned int *	error_line
	)

Navigate and parse data in a JSON tree.

Tries to parse the root to find all of the values given in the spec. If one of the entries in spec cannot be found or parsed, the name of the JSON field is returned in error_json_name, and the offset of the entry in spec is returned in error_line.

Parameters

	root	the JSON node to start the navigation at.
	spec	parse specification array
[out]	error_json_name	which JSON field was problematic
[out]	which	index into spec did we encounter an error

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 45 of file json.c.

References GNUNET_JSON_Specification::field, GNUNET_JSON_parse_free(), GNUNET_OK, GNUNET_SYSERR, and GNUNET_JSON_Specification::parser.

Referenced by add_attribute_cont(), consume_ticket_cont(), namestore_add(), and revoke_ticket_cont().

{
  if (NULL == root)
    return GNUNET_SYSERR;
  for (unsigned int i = 0; NULL != spec[i].parser; i++)
  {
    json_t *pos;

    if (NULL == spec[i].field)
      pos = (json_t *) root;
    else
      pos = json_object_get (root, spec[i].field);
    if ((NULL == pos) && (spec[i].is_optional))
      continue;
    if ((NULL == pos) ||
        (GNUNET_OK != spec[i].parser (spec[i].cls, pos, &spec[i])))
    {
      if (NULL != error_json_name)
        *error_json_name = spec[i].field;
      if (NULL != error_line)
        *error_line = i;
      GNUNET_JSON_parse_free (spec);
      return GNUNET_SYSERR;
    }
  }
  return GNUNET_OK; /* all OK! */
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_JSON_parse_free()

void GNUNET_JSON_parse_free

(

struct GNUNET_JSON_Specification *

spec

)

Frees all elements allocated during a GNUNET_JSON_parse() operation.

Parameters

spec	specification of the parse operation

Definition at line 100 of file json.c.

References GNUNET_JSON_Specification::cleaner, GNUNET_JSON_Specification::cls, and GNUNET_JSON_Specification::parser.

Referenced by add_attribute_cont(), consume_ticket_cont(), GNUNET_JSON_parse(), namestore_add(), and revoke_ticket_cont().

{
  for (unsigned int i = 0; NULL != spec[i].parser; i++)
    if (NULL != spec[i].cleaner)
      spec[i].cleaner (spec[i].cls, &spec[i]);
}

Here is the caller graph for this function:

GNUNET_JSON_spec_end()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_end

(

void

)

End of a parser specification.

Definition at line 35 of file json_helper.c.

References GNUNET_JSON_Specification::parser, and ret.

Referenced by add_attribute_cont(), consume_ticket_cont(), namestore_add(), and revoke_ticket_cont().

{
  struct GNUNET_JSON_Specification ret = {
    .parser = NULL,
    .cleaner = NULL,
    .cls = NULL
  };

  return ret;
}

Here is the caller graph for this function:

GNUNET_JSON_spec_mark_optional()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_mark_optional

(

struct GNUNET_JSON_Specification

spec

)

Set the "optional" flag for a parser specification entry.

Parameters

spec	specification to modify

Returns

spec copy of spec with optional bit set

Definition at line 84 of file json.c.

References GNUNET_YES, GNUNET_JSON_Specification::is_optional, and ret.

{
  struct GNUNET_JSON_Specification ret = spec;

  ret.is_optional = GNUNET_YES;
  return ret;
}

GNUNET_JSON_spec_fixed()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_fixed	(	const char *	name,
		void *	obj,
		size_t	size
	)

Variable size object (in network byte order, encoded using Crockford Base32hex encoding).

Parameters

	name	name of the JSON field
[out]	obj	pointer where to write the data, must have size bytes
	size	number of bytes expected in obj

Definition at line 96 of file json_helper.c.

References name, parse_fixed_data(), GNUNET_JSON_Specification::parser, ret, and size.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_fixed_data,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = obj,
    .ptr_size = size,
    .size_ptr = NULL
  };

  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_varsize()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_varsize	(	const char *	name,
		void **	obj,
		size_t *	size
	)

Variable size object (in network byte order, encoded using Crockford Base32hex encoding).

Parameters

	name	name of the JSON field
[out]	obj	pointer where to write the data, will be allocated
[out]	size	where to store the number of bytes allocated for obj

Definition at line 189 of file json_helper.c.

References clean_variable_data(), name, parse_variable_data(), GNUNET_JSON_Specification::parser, ret, and size.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_variable_data,
    .cleaner = &clean_variable_data,
    .cls = NULL,
    .field = name,
    .ptr = obj,
    .ptr_size = 0,
    .size_ptr = size
  };

  *obj = NULL;
  *size = 0;
  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_string()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_string	(	const char *	name,
		const char **	strptr
	)

The expected field stores a string.

Parameters

name	name of the JSON field
strptr	where to store a pointer to the field

Definition at line 242 of file json_helper.c.

References name, parse_string(), GNUNET_JSON_Specification::parser, and ret.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_string,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = strptr,
    .ptr_size = 0,
    .size_ptr = NULL
  };

  *strptr = NULL;
  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_json()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_json	(	const char *	name,
		json_t **	jsonp
	)

JSON object.

Parameters

	name	name of the JSON field
[out]	jsonp	where to store the JSON found under name

Definition at line 311 of file json_helper.c.

References clean_object(), name, parse_object(), GNUNET_JSON_Specification::parser, and ret.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_object,
    .cleaner = &clean_object,
    .cls = NULL,
    .field = name,
    .ptr = jsonp,
    .ptr_size = 0,
    .size_ptr = NULL
  };

  *jsonp = NULL;
  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_uint8()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_uint8	(	const char *	name,
		uint8_t *	u8
	)

8-bit integer.

Parameters

	name	name of the JSON field
[out]	u8	where to store the integer found under name

Definition at line 368 of file json_helper.c.

References name, parse_u8(), GNUNET_JSON_Specification::parser, ret, and GNUNET_JSON_Specification::size_ptr.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_u8,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = u8,
    .ptr_size = sizeof(uint8_t),
    .size_ptr = NULL
  };

  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_uint16()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_uint16	(	const char *	name,
		uint16_t *	u16
	)

16-bit integer.

Parameters

	name	name of the JSON field
[out]	u16	where to store the integer found under name

Definition at line 424 of file json_helper.c.

References name, parse_u16(), GNUNET_JSON_Specification::parser, ret, and GNUNET_JSON_Specification::size_ptr.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_u16,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = u16,
    .ptr_size = sizeof(uint16_t),
    .size_ptr = NULL
  };

  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_uint32()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_uint32	(	const char *	name,
		uint32_t *	u32
	)

32-bit integer.

Parameters

	name	name of the JSON field
[out]	u32	where to store the integer found under name

Definition at line 480 of file json_helper.c.

References name, parse_u32(), GNUNET_JSON_Specification::parser, ret, and GNUNET_JSON_Specification::size_ptr.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_u32,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = u32,
    .ptr_size = sizeof(uint32_t),
    .size_ptr = NULL
  };

  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_uint64()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_uint64	(	const char *	name,
		uint64_t *	u64
	)

64-bit integer.

Parameters

	name	name of the JSON field
[out]	u64	where to store the integer found under name

Definition at line 531 of file json_helper.c.

References name, parse_u64(), GNUNET_JSON_Specification::parser, ret, and GNUNET_JSON_Specification::size_ptr.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_u64,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = u64,
    .ptr_size = sizeof(uint64_t),
    .size_ptr = NULL
  };

  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_boolean()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_boolean	(	const char *	name,
		int *	boolean
	)

Boolean (true mapped to GNUNET_YES, false mapped to GNUNET_NO).

Parameters

	name	name of the JSON field
[out]	boolean	where to store the boolean found under name

Boolean (true mapped to GNUNET_YES, false mapped to GNUNET_NO).

Parameters

	name	name of the JSON field
[out]	boolean	where to store the boolean found under name

Definition at line 996 of file json_helper.c.

References name, parse_boolean(), GNUNET_JSON_Specification::parser, ret, and GNUNET_JSON_Specification::size_ptr.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_boolean,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = boolean,
    .ptr_size = sizeof(int),
    .size_ptr = NULL
  };

  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_absolute_time()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_absolute_time	(	const char *	name,
		struct GNUNET_TIME_Absolute *	at
	)

Absolute time.

Parameters

	name	name of the JSON field
[out]	at	where to store the absolute time found under name

Definition at line 609 of file json_helper.c.

References name, parse_abs_time(), GNUNET_JSON_Specification::parser, ret, and GNUNET_JSON_Specification::size_ptr.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_abs_time,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = at,
    .ptr_size = sizeof(uint64_t),
    .size_ptr = NULL
  };

  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_absolute_time_nbo()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_absolute_time_nbo	(	const char *	name,
		struct GNUNET_TIME_AbsoluteNBO *	at
	)

Absolute time in network byte order.

Parameters

	name	name of the JSON field
[out]	at	where to store the absolute time found under name

Definition at line 687 of file json_helper.c.

References name, parse_abs_time_nbo(), GNUNET_JSON_Specification::parser, ret, and GNUNET_JSON_Specification::size_ptr.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_abs_time_nbo,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = at,
    .ptr_size = sizeof(uint64_t),
    .size_ptr = NULL
  };

  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_relative_time()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_relative_time	(	const char *	name,
		struct GNUNET_TIME_Relative *	rt
	)

Relative time.

Parameters

	name	name of the JSON field
[out]	rt	where to store the relative time found under name

Definition at line 759 of file json_helper.c.

References name, parse_rel_time(), GNUNET_JSON_Specification::parser, ret, and GNUNET_JSON_Specification::size_ptr.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_rel_time,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = rt,
    .ptr_size = sizeof(uint64_t),
    .size_ptr = NULL
  };

  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_rsa_public_key()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_rsa_public_key	(	const char *	name,
		struct GNUNET_CRYPTO_RsaPublicKey **	pk
	)

Specification for parsing an RSA public key.

Parameters

name	name of the JSON field
pk	where to store the RSA key found under name

Definition at line 852 of file json_helper.c.

References clean_rsa_public_key(), name, parse_rsa_public_key(), GNUNET_JSON_Specification::parser, pk, and ret.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_rsa_public_key,
    .cleaner = &clean_rsa_public_key,
    .cls = NULL,
    .field = name,
    .ptr = pk,
    .ptr_size = 0,
    .size_ptr = NULL
  };

  *pk = NULL;
  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_rsa_signature()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_rsa_signature	(	const char *	name,
		struct GNUNET_CRYPTO_RsaSignature **	sig
	)

Specification for parsing an RSA signature.

Parameters

name	name of the JSON field
sig	where to store the RSA signature found under name

Definition at line 946 of file json_helper.c.

References clean_rsa_signature(), name, parse_rsa_signature(), GNUNET_JSON_Specification::parser, and ret.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_rsa_signature,
    .cleaner = &clean_rsa_signature,
    .cls = NULL,
    .field = name,
    .ptr = sig,
    .ptr_size = 0,
    .size_ptr = NULL
  };

  *sig = NULL;
  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_spec_gnsrecord()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_gnsrecord	(	struct GNUNET_GNSRECORD_Data **	rd,
		unsigned int *	rd_count,
		char **	name
	)

JSON Specification for GNS Records.

Parameters

gnsrecord_object

struct of GNUNET_GNSRECORD_Data to fill

Returns

JSON Specification

Definition at line 239 of file json_gnsrecord.c.

References clean_gnsrecordobject(), GNUNET_new, GnsRecordInfo::name, parse_gnsrecordobject(), GNUNET_JSON_Specification::parser, GnsRecordInfo::rd, GnsRecordInfo::rd_count, and ret.

Referenced by namestore_add().

{
  struct GnsRecordInfo *gnsrecord_info = GNUNET_new (struct GnsRecordInfo);

  gnsrecord_info->rd = rd;
  gnsrecord_info->name = name;
  gnsrecord_info->rd_count = rd_count;
  struct GNUNET_JSON_Specification ret = { .parser = &parse_gnsrecordobject,
                                           .cleaner = &clean_gnsrecordobject,
                                           .cls = NULL,
                                           .field = NULL,
                                           .ptr = (struct GnsRecordInfo *)
                                                  gnsrecord_info,
                                           .ptr_size = 0,
                                           .size_ptr = NULL };
  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_JSON_from_data()

json_t* GNUNET_JSON_from_data	(	const void *	data,
		size_t	size
	)

Convert binary data to a JSON string with the base32crockford encoding.

Parameters

data	binary data
size	size of data in bytes

Returns

json string that encodes data

Definition at line 39 of file json_generator.c.

References buf, GNUNET_free, and GNUNET_STRINGS_data_to_string_alloc().

Referenced by GNUNET_JSON_from_rsa_public_key(), and GNUNET_JSON_from_rsa_signature().

{
  char *buf;
  json_t *json;

  buf = GNUNET_STRINGS_data_to_string_alloc (data, size);
  json = json_string (buf);
  GNUNET_free (buf);
  return json;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_JSON_from_time_abs()

json_t* GNUNET_JSON_from_time_abs

(

struct GNUNET_TIME_Absolute

stamp

)

Convert absolute timestamp to a json string.

Parameters

stamp

the time stamp

Returns

a json string with the timestamp in stamp

Definition at line 59 of file json_generator.c.

References GNUNET_TIME_Absolute::abs_value_us, GNUNET_asprintf(), GNUNET_assert, GNUNET_free, GNUNET_OK, GNUNET_TIME_round_abs(), GNUNET_TIME_UNIT_FOREVER_ABS, and ret.

Referenced by GNUNET_JSON_from_time_abs_nbo().

{
  json_t *j;
  char *mystr;
  int ret;

  GNUNET_assert (GNUNET_OK ==
                 GNUNET_TIME_round_abs (&stamp));
  if (stamp.abs_value_us == GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us)
    return json_string ("/never/");
  ret = GNUNET_asprintf (&mystr,
                         "/Date(%llu)/",
                         (unsigned long long) (stamp.abs_value_us / (1000LL
                                                                     * 1000LL)));
  GNUNET_assert (ret > 0);
  j = json_string (mystr);
  GNUNET_free (mystr);
  return j;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_JSON_from_time_abs_nbo()

json_t* GNUNET_JSON_from_time_abs_nbo

(

struct GNUNET_TIME_AbsoluteNBO

stamp

)

Convert absolute timestamp to a json string.

Parameters

stamp

the time stamp

Returns

a json string with the timestamp in stamp

Definition at line 87 of file json_generator.c.

References GNUNET_JSON_from_time_abs(), and GNUNET_TIME_absolute_ntoh().

{
  return GNUNET_JSON_from_time_abs (GNUNET_TIME_absolute_ntoh (stamp));
}

Here is the call graph for this function:

GNUNET_JSON_from_time_rel()

json_t* GNUNET_JSON_from_time_rel

(

struct GNUNET_TIME_Relative

stamp

)

Convert relative timestamp to a json string.

Parameters

stamp

the time stamp

Returns

a json string with the timestamp in stamp

Definition at line 100 of file json_generator.c.

References GNUNET_asprintf(), GNUNET_assert, GNUNET_free, GNUNET_OK, GNUNET_TIME_round_rel(), GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_TIME_Relative::rel_value_us, and ret.

{
  json_t *j;
  char *mystr;
  int ret;

  GNUNET_assert (GNUNET_OK ==
                 GNUNET_TIME_round_rel (&stamp));
  if (stamp.rel_value_us == GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us)
    return json_string ("/forever/");
  ret = GNUNET_asprintf (&mystr,
                         "/Delay(%llu)/",
                         (unsigned long long) (stamp.rel_value_us / (1000LL
                                                                     * 1000LL)));
  GNUNET_assert (ret > 0);
  j = json_string (mystr);
  GNUNET_free (mystr);
  return j;
}

Here is the call graph for this function:

GNUNET_JSON_from_rsa_public_key()

json_t* GNUNET_JSON_from_rsa_public_key

(

const struct GNUNET_CRYPTO_RsaPublicKey *

pk

)

Convert RSA public key to JSON.

Parameters

pk	public key to convert

Returns

corresponding JSON encoding

Definition at line 128 of file json_generator.c.

References buf, GNUNET_CRYPTO_rsa_public_key_encode(), GNUNET_free, GNUNET_JSON_from_data(), and ret.

{
  char *buf;
  size_t buf_len;
  json_t *ret;

  buf_len = GNUNET_CRYPTO_rsa_public_key_encode (pk,
                                                 &buf);
  ret = GNUNET_JSON_from_data (buf,
                               buf_len);
  GNUNET_free (buf);
  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_from_rsa_signature()

json_t* GNUNET_JSON_from_rsa_signature

(

const struct GNUNET_CRYPTO_RsaSignature *

sig

)

Convert RSA signature to JSON.

Parameters

sig	signature to convert

Returns

corresponding JSON encoding

Definition at line 150 of file json_generator.c.

References buf, GNUNET_CRYPTO_rsa_signature_encode(), GNUNET_free, GNUNET_JSON_from_data(), and ret.

{
  char *buf;
  size_t buf_len;
  json_t *ret;

  buf_len = GNUNET_CRYPTO_rsa_signature_encode (sig,
                                                &buf);
  ret = GNUNET_JSON_from_data (buf,
                               buf_len);
  GNUNET_free (buf);
  return ret;
}

Here is the call graph for this function:

GNUNET_JSON_from_gnsrecord()

json_t* GNUNET_JSON_from_gnsrecord	(	const char *	rname,
		const struct GNUNET_GNSRECORD_Data *	rd,
		unsigned int	rd_count
	)

Convert Gns record to JSON.

Parameters

rname	name of record
rd	record data

Returns

corresponding JSON encoding

Convert Gns record to JSON.

Parameters

rname	name of record
rd	record data

Returns

corresponding JSON encoding

Definition at line 173 of file json_generator.c.

References data, data_size, GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_GNSRECORD_number_to_typename(), GNUNET_GNSRECORD_record_get_expiration_time(), GNUNET_GNSRECORD_value_to_string(), GNUNET_log, GNUNET_STRINGS_absolute_time_to_string(), record(), and records.

Referenced by handle_gns_response(), and namestore_list_iteration().

{
  struct GNUNET_TIME_Absolute expiration_time;
  const char *expiration_time_str;
  const char *record_type_str;
  char *value_str;
  json_t *data;
  json_t *record;
  json_t *records;

  data = json_object ();
  json_object_set_new (data,
                       "record_name",
                       json_string (rname));
  records = json_array ();
  for (int i = 0; i < rd_count; i++)
  {
    value_str = GNUNET_GNSRECORD_value_to_string (rd[i].record_type,
                                                  rd[i].data,
                                                  rd[i].data_size);
    expiration_time = GNUNET_GNSRECORD_record_get_expiration_time (1, &rd[i]);
    expiration_time_str = GNUNET_STRINGS_absolute_time_to_string (
      expiration_time);
    record_type_str = GNUNET_GNSRECORD_number_to_typename (rd[i].record_type);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Packing %s %s %s %d\n",
                value_str, record_type_str, expiration_time_str, rd[i].flags);
    record = json_pack ("{s:s,s:s,s:s,s:i}",
                        "value",
                        value_str,
                        "record_type",
                        record_type_str,
                        "expiration_time",
                        expiration_time_str,
                        "flag",
                        rd[i].flags);
    GNUNET_assert (NULL != record);
    GNUNET_free (value_str);
    json_array_append_new (records, record);
  }
  json_object_set_new (data, "data", records);
  return data;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_JSON_post_parser()

enum GNUNET_JSON_PostResult GNUNET_JSON_post_parser	(	size_t	buffer_max,
		struct MHD_Connection *	connection,
		void **	con_cls,
		const char *	upload_data,
		size_t *	upload_data_size,
		json_t **	json
	)

Process a POST request containing a JSON object.

This function realizes an MHD POST processor that will (incrementally) process JSON data uploaded to the HTTP server. It will store the required state in the con_cls, which must be cleaned up using #GNUNET_JSON_post_parser_callback().

Parameters

buffer_max	maximum allowed size for the buffer
connection	MHD connection handle (for meta data about the upload)
con_cls	the closure (will point to a struct Buffer *)
upload_data	the POST data
upload_data_size	number of bytes in upload_data
json	the JSON object for a completed request

Returns

result code indicating the status of the operation

Definition at line 264 of file json_mhd.c.

References buffer_append(), buffer_deinit(), buffer_init(), Buffer::data, Buffer::fill, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_JSON_PR_CONTINUE, GNUNET_JSON_PR_JSON_INVALID, GNUNET_JSON_PR_OUT_OF_MEMORY, GNUNET_JSON_PR_REQUEST_TOO_LARGE, GNUNET_JSON_PR_SUCCESS, GNUNET_log, GNUNET_new, GNUNET_OK, inflate_data(), REQUEST_BUFFER_INITIAL, and ret.

{
  struct Buffer *r = *con_cls;
  const char *ce;
  int ret;

  *json = NULL;
  if (NULL == *con_cls)
  {
    /* We are seeing a fresh POST request. */
    r = GNUNET_new (struct Buffer);
    if (GNUNET_OK != buffer_init (r,
                                  upload_data,
                                  *upload_data_size,
                                  REQUEST_BUFFER_INITIAL,
                                  buffer_max))
    {
      *con_cls = NULL;
      buffer_deinit (r);
      GNUNET_free (r);
      return GNUNET_JSON_PR_OUT_OF_MEMORY;
    }
    /* everything OK, wait for more POST data */
    *upload_data_size = 0;
    *con_cls = r;
    return GNUNET_JSON_PR_CONTINUE;
  }
  if (0 != *upload_data_size)
  {
    /* We are seeing an old request with more data available. */

    if (GNUNET_OK !=
        buffer_append (r, upload_data, *upload_data_size, buffer_max))
    {
      /* Request too long */
      *con_cls = NULL;
      buffer_deinit (r);
      GNUNET_free (r);
      return GNUNET_JSON_PR_REQUEST_TOO_LARGE;
    }
    /* everything OK, wait for more POST data */
    *upload_data_size = 0;
    return GNUNET_JSON_PR_CONTINUE;
  }

  /* We have seen the whole request. */
  ce = MHD_lookup_connection_value (connection,
                                    MHD_HEADER_KIND,
                                    MHD_HTTP_HEADER_CONTENT_ENCODING);
  if ((NULL != ce) && (0 == strcasecmp ("deflate", ce)))
  {
    ret = inflate_data (r);
    if (GNUNET_JSON_PR_SUCCESS != ret)
    {
      buffer_deinit (r);
      GNUNET_free (r);
      *con_cls = NULL;
      return ret;
    }
  }

  *json = json_loadb (r->data, r->fill, 0, NULL);
  if (NULL == *json)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "Failed to parse JSON request body\n");
    buffer_deinit (r);
    GNUNET_free (r);
    *con_cls = NULL;
    return GNUNET_JSON_PR_JSON_INVALID;
  }
  buffer_deinit (r);
  GNUNET_free (r);
  *con_cls = NULL;

  return GNUNET_JSON_PR_SUCCESS;
}

Here is the call graph for this function:

GNUNET_JSON_post_parser_cleanup()

void GNUNET_JSON_post_parser_cleanup

(

void *

con_cls

)

Function called whenever we are done with a request to clean up our state.

Parameters

con_cls

value as it was left by GNUNET_JSON_post_parser(), to be cleaned up

Definition at line 356 of file json_mhd.c.

References buffer_deinit(), and GNUNET_free.

{
  struct Buffer *r = con_cls;

  if (NULL != r)
  {
    buffer_deinit (r);
    GNUNET_free (r);
  }
}

Here is the call graph for this function:

GNUNET_JSON_getopt()

struct GNUNET_GETOPT_CommandLineOption GNUNET_JSON_getopt	(	char	shortName,
		const char *	name,
		const char *	argumentHelp,
		const char *	description,
		json_t **	json
	)

Allow user to specify a JSON input value.

Parameters

	shortName	short name of the option
	name	long name of the option
	argumentHelp	help text for the option argument
	description	long help text for the option
[out]	val	set to the JSON specified at the command line

Definition at line 153 of file json.c.

References GNUNET_GETOPT_CommandLineOption::argumentHelp, GNUNET_GETOPT_CommandLineOption::description, name, set_json(), and GNUNET_GETOPT_CommandLineOption::shortName.

{
  struct GNUNET_GETOPT_CommandLineOption clo = { .shortName = shortName,
                                                 .name = name,
                                                 .argumentHelp = argumentHelp,
                                                 .description = description,
                                                 .require_argument = 1,
                                                 .processor = &set_json,
                                                 .scls = (void *) json };

  return clo;
}

Here is the call graph for this function: