gnunet_json_lib.h File Reference

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

#include "gnunet_util_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...
struct	GNUNET_JSON_PackSpec
	Element in the array to give to the packer. 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_spec_fixed64_auto(name, obj)    GNUNET_JSON_spec_fixed (name, obj, sizeof(*obj))
	Fixed size object (in network byte order, encoded using base64 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...
#define	GNUNET_JSON_from_data64_auto(ptr)    GNUNET_JSON_from_data64 (ptr, sizeof(*ptr))
	Convert binary data to a JSON string with base64 encoding. More...
#define	GNUNET_JSON_PACK(...)
	Pack a JSON object from a spec. More...
#define	GNUNET_JSON_pack_data_auto(name, blob)    GNUNET_JSON_pack_data_varsize (name, blob, sizeof (*blob))
	Generate packer instruction for a JSON field where the size is automatically determined from the argument. More...
#define	GNUNET_JSON_pack_data64_auto(name, blob)    GNUNET_JSON_pack_data64_varsize (name, blob, sizeof (*blob))
	Generate packer instruction for a JSON field where the size is automatically determined from the argument. More...

Typedefs
typedef enum GNUNET_GenericReturnValue(*	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...
typedef json_t *(*	GNUNET_JSON_PackCallback) (const struct GNUNET_JSON_PackSpec *se)
	Function called to pack an element into the JSON object as part of GNUNET_JSON_pack_(). 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
enum GNUNET_GenericReturnValue	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, bool *missing)
	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_fixed64 (const char *name, void *obj, size_t size)
	Variable size object (in network byte order, encoded using base64 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_bool (const char *name, bool *b)
	boolean. 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_int64 (const char *name, int64_t *i64)
	64-bit signed 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_timestamp (const char *name, struct GNUNET_TIME_Timestamp *t)
	Timestamp. More...
struct GNUNET_JSON_Specification	GNUNET_JSON_spec_timestamp_nbo (const char *name, struct GNUNET_TIME_TimestampNBO *tn)
	Timestamp 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...
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_data64 (const void *data, size_t size)
	Convert binary data to a JSON string with base64 encoding. More...
json_t *	GNUNET_JSON_from_timestamp (struct GNUNET_TIME_Timestamp stamp)
	Convert timestamp to a json string. More...
json_t *	GNUNET_JSON_from_timestamp_nbo (struct GNUNET_TIME_TimestampNBO stamp)
	Convert 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...
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...
json_t *	GNUNET_JSON_pack_ (struct GNUNET_JSON_PackSpec spec[])
	Pack a JSON object from a spec. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_end_ (void)
	Do not use directly. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_allow_null (struct GNUNET_JSON_PackSpec in)
	Modify packer instruction to allow NULL as a value. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_bool (const char *name, bool b)
	Generate packer instruction for a JSON field of type bool. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_string (const char *name, const char *s)
	Generate packer instruction for a JSON field of type string. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_uint64 (const char *name, uint64_t num)
	Generate packer instruction for a JSON field of type unsigned integer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_int64 (const char *name, int64_t num)
	Generate packer instruction for a JSON field of type signed integer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_object_steal (const char *name, json_t *o)
	Generate packer instruction for a JSON field of type JSON object where the reference is taken over by the packer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_object_incref (const char *name, json_t *o)
	Generate packer instruction for a JSON field of type JSON object where the reference counter is incremented by the packer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_array_steal (const char *name, json_t *a)
	Generate packer instruction for a JSON field of type JSON array where the reference is taken over by the packer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_array_incref (const char *name, json_t *a)
	Generate packer instruction for a JSON field of type JSON array where the reference counter is incremented by the packer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_data_varsize (const char *name, const void *blob, size_t blob_size)
	Generate packer instruction for a JSON field of type variable size binary blob. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_data64_varsize (const char *name, const void *blob, size_t blob_size)
	Generate packer instruction for a JSON field of type variable size binary blob. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_timestamp (const char *name, struct GNUNET_TIME_Timestamp at)
	Generate packer instruction for a JSON field of type timestamp. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_timestamp_nbo (const char *name, struct GNUNET_TIME_TimestampNBO at)
	Generate packer instruction for a JSON field of type timestamp in network byte order. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_time_rel (const char *name, struct GNUNET_TIME_Relative rt)
	Generate packer instruction for a JSON field of type relative time. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_time_rel_nbo (const char *name, struct GNUNET_TIME_RelativeNBO rt)
	Generate packer instruction for a JSON field of type relative time in network byte order. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_rsa_public_key (const char *name, const struct GNUNET_CRYPTO_RsaPublicKey *pk)
	Generate packer instruction for a JSON field of type RSA public key. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_rsa_signature (const char *name, const struct GNUNET_CRYPTO_RsaSignature *sig)
	Generate packer instruction for a JSON field of type RSA signature. 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 196 of file gnunet_json_lib.h.

GNUNET_JSON_spec_fixed64_auto

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

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

Parameters

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

Definition at line 219 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 429 of file gnunet_json_lib.h.

GNUNET_JSON_from_data64_auto

#define GNUNET_JSON_from_data64_auto

(

ptr

)

GNUNET_JSON_from_data64 (ptr, sizeof(*ptr))

Convert binary data to a JSON string with base64 encoding.

Parameters

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

Returns

json string that encodes data

Definition at line 440 of file gnunet_json_lib.h.

GNUNET_JSON_PACK

#define GNUNET_JSON_PACK

(

...

)

Value:

  GNUNET_JSON_pack_ ((struct GNUNET_JSON_PackSpec[]) {__VA_ARGS__, \
                                                      GNUNET_JSON_pack_end_ ()})

Pack a JSON object from a spec.

Aborts if packing fails.

Parameters

...	list of specification objects

Returns

JSON object

Definition at line 645 of file gnunet_json_lib.h.

GNUNET_JSON_pack_data_auto

#define GNUNET_JSON_pack_data_auto	(		name,
			blob
	)		GNUNET_JSON_pack_data_varsize (name, blob, sizeof (*blob))

Generate packer instruction for a JSON field where the size is automatically determined from the argument.

Parameters

name	name of the field to add to the object
blob	data to pack, must not be an array

Returns

json pack specification

Definition at line 801 of file gnunet_json_lib.h.

GNUNET_JSON_pack_data64_auto

#define GNUNET_JSON_pack_data64_auto	(		name,
			blob
	)		GNUNET_JSON_pack_data64_varsize (name, blob, sizeof (*blob))

Generate packer instruction for a JSON field where the size is automatically determined from the argument.

Use base64-encoding, instead of the more common Crockford base32-encoding.

Parameters

name	name of the field to add to the object
blob	data to pack, must not be an array

Returns

json pack specification

Definition at line 832 of file gnunet_json_lib.h.

Typedef Documentation

GNUNET_JSON_Parser

typedef enum GNUNET_GenericReturnValue(* 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 1 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 64 of file gnunet_json_lib.h.

GNUNET_JSON_PackCallback

typedef json_t*(* GNUNET_JSON_PackCallback) (const struct GNUNET_JSON_PackSpec *se)

Function called to pack an element into the JSON object as part of GNUNET_JSON_pack_().

Parameters

se	pack specification to execute

Returns

json object to pack, NULL to pack nothing

Definition at line 598 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 498 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()

enum GNUNET_GenericReturnValue 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]	error_line	which index into spec did we encounter an error

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 1 of file json.c.

{
  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) ||
           (json_is_null (pos) ) ) &&
         (spec[i].is_optional) )
    {
      if (NULL != spec[i].missing)
        *spec[i].missing = true;
      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;
      else
        GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                    "Parsing failed for field `%s:%u`\n",
                    spec[i].field,
                    i);
      if (NULL != error_line)
        *error_line = i;
      GNUNET_JSON_parse_free (spec);
      return GNUNET_SYSERR;
    }
    if (NULL != spec[i].missing)
      *spec[i].missing = false;
  }
  return GNUNET_OK; /* all OK! */
}

References GNUNET_JSON_Specification::field, GNUNET_ERROR_TYPE_WARNING, GNUNET_JSON_parse_free(), GNUNET_log, GNUNET_OK, GNUNET_SYSERR, GNUNET_JSON_Specification::missing, consensus-simulation::parser, and GNUNET_JSON_Specification::parser.

Referenced by add_attribute_cont(), add_credential_cont(), bulk_tx_start(), consume_ticket_cont(), namestore_add_or_update(), and revoke_ticket_cont().

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 94 of file json.c.

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

Referenced by add_attribute_cont(), add_credential_cont(), consume_ticket_cont(), GNUNET_JSON_parse(), namestore_add_or_update(), and revoke_ticket_cont().

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 1 of file json_helper.c.

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

References ret.

Referenced by add_attribute_cont(), add_credential_cont(), bulk_tx_start(), consume_ticket_cont(), namestore_add_or_update(), and revoke_ticket_cont().

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,
		bool *	missing
	)

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

Parameters

	spec	specification to modify
[out]	missing	set to true if the argument is missing, NULL is allowed.

Returns

spec copy of spec with optional bit set

Definition at line 1 of file json.c.

{
  struct GNUNET_JSON_Specification ret = spec;
 
  ret.is_optional = true;
  ret.missing = missing;
  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 1 of file json_helper.c.

{
  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;
}

GNUNET_JSON_spec_fixed64()

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

Variable size object (in network byte order, encoded using base64 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 1 of file json_helper.c.

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

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 215 of file json_helper.c.

{
  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;
}

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 215 of file json_helper.c.

{
  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;
}

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 326 of file json_helper.c.

{
  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;
}

GNUNET_JSON_spec_bool()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_bool	(	const char *	name,
		bool *	b
	)

boolean.

Parameters

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

Definition at line 326 of file json_helper.c.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_bool,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = b,
    .ptr_size = sizeof(bool),
    .size_ptr = NULL
  };
 
  return ret;
}

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 326 of file json_helper.c.

{
  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;
}

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 326 of file json_helper.c.

{
  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;
}

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 326 of file json_helper.c.

{
  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;
}

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 326 of file json_helper.c.

{
  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;
}

GNUNET_JSON_spec_int64()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_int64	(	const char *	name,
		int64_t *	i64
	)

64-bit signed integer.

Parameters

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

Definition at line 326 of file json_helper.c.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_i64,
    .cleaner = NULL,
    .cls = NULL,
    .field = name,
    .ptr = i64,
    .ptr_size = sizeof(int64_t),
    .size_ptr = NULL
  };
 
  return ret;
}

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

Definition at line 978 of file json_helper.c.

{
  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;
}

GNUNET_JSON_spec_timestamp()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_timestamp	(	const char *	name,
		struct GNUNET_TIME_Timestamp *	t
	)

Timestamp.

Parameters

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

Definition at line 326 of file json_helper.c.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_timestamp,
    .field = name,
    .ptr = t,
    .ptr_size = sizeof(struct GNUNET_TIME_Timestamp)
  };
 
  return ret;
}

GNUNET_JSON_spec_timestamp_nbo()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_timestamp_nbo	(	const char *	name,
		struct GNUNET_TIME_TimestampNBO *	tn
	)

Timestamp in network byte order.

Parameters

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

Definition at line 326 of file json_helper.c.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_timestamp_nbo,
    .field = name,
    .ptr = at,
    .ptr_size = sizeof(struct GNUNET_TIME_TimestampNBO)
  };
 
  return ret;
}

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 326 of file json_helper.c.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_rel_time,
    .field = name,
    .ptr = rt,
    .ptr_size = sizeof(struct GNUNET_TIME_Relative)
  };
 
  return ret;
}

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 893 of file json_helper.c.

{
  struct GNUNET_JSON_Specification ret = {
    .parser = &parse_rsa_public_key,
    .cleaner = &clean_rsa_public_key,
    .field = name,
    .ptr = pk
  };
 
  *pk = NULL;
  return ret;
}

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 978 of file json_helper.c.

{
  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;
}

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 31 of file json_generator.c.

{
  char *buf;
  json_t *json;
 
  if ((size * 8 + 4) / 5 + 1 >=
      GNUNET_MAX_MALLOC_CHECKED)
  {
    GNUNET_break (0);
    return NULL;
  }
  buf = GNUNET_STRINGS_data_to_string_alloc (data,
                                             size);
  json = json_string (buf);
  GNUNET_free (buf);
  GNUNET_break (NULL != json);
  return json;
}

References buf, data, GNUNET_break, GNUNET_free, GNUNET_MAX_MALLOC_CHECKED, GNUNET_STRINGS_data_to_string_alloc(), and size.

Referenced by GNUNET_JSON_from_rsa_public_key(), and GNUNET_JSON_from_rsa_signature().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_JSON_from_data64()

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

Convert binary data to a JSON string with base64 encoding.

Parameters

data	binary data
size	size of data in bytes

Returns

json string that encodes data

Definition at line 53 of file json_generator.c.

{
  char *buf = NULL;
  json_t *json;
  size_t len;
 
  if ((size * 8 + 5) / 6 + 1 >=
      GNUNET_MAX_MALLOC_CHECKED)
  {
    GNUNET_break (0);
    return NULL;
  }
  len = GNUNET_STRINGS_base64_encode (data,
                                      size,
                                      &buf);
  if (NULL == buf)
  {
    GNUNET_break (0);
    return NULL;
  }
  json = json_stringn (buf,
                       len);
  GNUNET_free (buf);
  GNUNET_break (NULL != json);
  return json;
}

References buf, data, GNUNET_break, GNUNET_free, GNUNET_MAX_MALLOC_CHECKED, GNUNET_STRINGS_base64_encode(), len, and size.

Here is the call graph for this function:

GNUNET_JSON_from_timestamp()

json_t* GNUNET_JSON_from_timestamp

(

struct GNUNET_TIME_Timestamp

stamp

)

Convert timestamp to a json string.

Parameters

stamp

the time stamp

Returns

a json string with the timestamp in stamp

Definition at line 83 of file json_generator.c.

{
  json_t *j;
 
  j = json_object ();
  if (NULL == j)
  {
    GNUNET_break (0);
    return NULL;
  }
  if (GNUNET_TIME_absolute_is_never (stamp.abs_time))
  {
    if (0 !=
        json_object_set_new (j,
                             "t_s",
                             json_string ("never")))
    {
      GNUNET_break (0);
      json_decref (j);
      return NULL;
    }
    return j;
  }
  GNUNET_assert (
    0 ==
    (stamp.abs_time.abs_value_us
     % GNUNET_TIME_UNIT_SECONDS.rel_value_us));
  if (0 !=
      json_object_set_new (
        j,
        "t_s",
        json_integer (
          (json_int_t) (stamp.abs_time.abs_value_us
                        / GNUNET_TIME_UNIT_SECONDS.rel_value_us))))
  {
    GNUNET_break (0);
    json_decref (j);
    return NULL;
  }
  return j;
}

References GNUNET_TIME_Timestamp::abs_time, GNUNET_TIME_Absolute::abs_value_us, GNUNET_assert, GNUNET_break, GNUNET_TIME_absolute_is_never(), and GNUNET_TIME_UNIT_SECONDS.

Referenced by GNUNET_JSON_from_timestamp_nbo().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_JSON_from_timestamp_nbo()

json_t* GNUNET_JSON_from_timestamp_nbo

(

struct GNUNET_TIME_TimestampNBO

stamp

)

Convert timestamp to a json string.

Parameters

stamp

the time stamp

Returns

a json string with the timestamp in stamp

Definition at line 127 of file json_generator.c.

{
  return GNUNET_JSON_from_timestamp (GNUNET_TIME_timestamp_ntoh (stamp));
}

References GNUNET_JSON_from_timestamp(), and GNUNET_TIME_timestamp_ntoh().

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 134 of file json_generator.c.

{
  json_t *j;
 
  j = json_object ();
  if (NULL == j)
  {
    GNUNET_break (0);
    return NULL;
  }
  if (GNUNET_TIME_relative_is_forever (stamp))
  {
    if (0 !=
        json_object_set_new (j,
                             "d_us",
                             json_string ("forever")))
    {
      GNUNET_break (0);
      json_decref (j);
      return NULL;
    }
    return j;
  }
  if (stamp.rel_value_us >= (1LLU << 53))
  {
    /* value is larger than allowed */
    GNUNET_break (0);
    return NULL;
  }
  if (0 !=
      json_object_set_new (
        j,
        "d_us",
        json_integer ((json_int_t) stamp.rel_value_us)))
  {
    GNUNET_break (0);
    json_decref (j);
    return NULL;
  }
  return j;
}

References GNUNET_break, GNUNET_TIME_relative_is_forever(), and GNUNET_TIME_Relative::rel_value_us.

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 178 of file json_generator.c.

{
  void *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;
}

References buf, GNUNET_CRYPTO_rsa_public_key_encode(), GNUNET_free, GNUNET_JSON_from_data(), pk, and 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 194 of file json_generator.c.

{
  void *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;
}

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

Here is the call 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 122 of file json_mhd.c.

{
  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_error_t err;
 
    *json = json_loadb (r->data,
                        r->fill,
                        0,
                        &err);
    if (NULL == *json)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                  "Failed to parse JSON request body of %u byte at offset %d: %s\n",
                  (unsigned int) r->fill,
                  err.position,
                  err.text);
      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;
}

Referenced by create_response().

Here is the caller 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 367 of file json_mhd.c.

{
  struct Buffer *r = con_cls;
 
  if (NULL != r)
  {
    buffer_deinit (r);
    GNUNET_free (r);
  }
}

References buffer_deinit(), and GNUNET_free.

Referenced by create_response().

Here is the call graph for this function:

Here is the caller 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 94 of file json.c.

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

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

GNUNET_JSON_pack_()

json_t* GNUNET_JSON_pack_

(

struct GNUNET_JSON_PackSpec

spec[]

)

Pack a JSON object from a spec.

Aborts if packing fails.

Parameters

spec	specification object

Returns

JSON object

Definition at line 30 of file json_pack.c.

{
  json_t *ret;
 
  if (NULL == spec[0].field_name)
  {
    ret = spec[0].object;
    spec[0].object = NULL;
    return ret;
  }
  ret = json_object ();
  GNUNET_assert (NULL != ret);
  for (unsigned int i = 0;
       NULL != spec[i].field_name;
       i++)
  {
    if (NULL == spec[i].object)
    {
      GNUNET_assert (spec[i].allow_null);
    }
    else
    {
      GNUNET_assert (0 ==
                     json_object_set_new (ret,
                                          spec[i].field_name,
                                          spec[i].object));
      spec[i].object = NULL;
    }
  }
  return ret;
}

References GNUNET_JSON_PackSpec::field_name, GNUNET_assert, GNUNET_JSON_PackSpec::object, and ret.

GNUNET_JSON_pack_end_()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_end_

(

void

)

Do not use directly.

Use GNUNET_JSON_PACK.

Returns

array terminator

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = NULL
  };
 
  return ps;
}

GNUNET_JSON_pack_allow_null()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_allow_null

(

struct GNUNET_JSON_PackSpec

in

)

Modify packer instruction to allow NULL as a value.

Parameters

in	json pack specification to modify

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  in.allow_null = true;
  return in;
}

GNUNET_JSON_pack_bool()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_bool	(	const char *	name,
		bool	b
	)

Generate packer instruction for a JSON field of type bool.

Parameters

name	name of the field to add to the object
b	boolean value

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = json_boolean (b)
  };
 
  return ps;
}

GNUNET_JSON_pack_string()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_string	(	const char *	name,
		const char *	s
	)

Generate packer instruction for a JSON field of type string.

Parameters

name	name of the field to add to the object
s	string value

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = json_string (s)
  };
 
  return ps;
}

GNUNET_JSON_pack_uint64()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_uint64	(	const char *	name,
		uint64_t	num
	)

Generate packer instruction for a JSON field of type unsigned integer.

Note that the maximum allowed value is still limited by JSON and not UINT64_MAX.

Parameters

name	name of the field to add to the object
num	numeric value

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = json_integer ((json_int_t) num)
  };
 
#if JSON_INTEGER_IS_LONG_LONG
  GNUNET_assert (num <= LLONG_MAX);
#else
  GNUNET_assert (num <= LONG_MAX);
#endif
  return ps;
}

GNUNET_JSON_pack_int64()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_int64	(	const char *	name,
		int64_t	num
	)

Generate packer instruction for a JSON field of type signed integer.

Parameters

name	name of the field to add to the object
num	numeric value

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = json_integer ((json_int_t) num)
  };
 
#if JSON_INTEGER_IS_LONG_LONG
  GNUNET_assert (num <= LLONG_MAX);
  GNUNET_assert (num >= LLONG_MIN);
#else
  GNUNET_assert (num <= LONG_MAX);
  GNUNET_assert (num >= LONG_MIN);
#endif
  return ps;
}

GNUNET_JSON_pack_object_steal()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_object_steal	(	const char *	name,
		json_t *	o
	)

Generate packer instruction for a JSON field of type JSON object where the reference is taken over by the packer.

Parameters

name	name of the field to add to the object
o	object to steal

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = o
  };
 
  if (NULL == o)
    return ps;
  if (! json_is_object (o))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Expected JSON object for field `%s'\n",
                name);
    GNUNET_assert (0);
  }
  return ps;
}

GNUNET_JSON_pack_object_incref()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_object_incref	(	const char *	name,
		json_t *	o
	)

Generate packer instruction for a JSON field of type JSON object where the reference counter is incremented by the packer.

Note that a deep copy is not performed.

Parameters

name	name of the field to add to the object
o	object to increment reference counter of

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = o
  };
 
  if (NULL == o)
    return ps;
  (void) json_incref (o);
  if (! json_is_object (o))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Expected JSON object for field `%s'\n",
                name);
    GNUNET_assert (0);
  }
  return ps;
}

GNUNET_JSON_pack_array_steal()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_array_steal	(	const char *	name,
		json_t *	a
	)

Generate packer instruction for a JSON field of type JSON array where the reference is taken over by the packer.

Parameters

name	name of the field to add to the object
a	array to steal

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = a
  };
 
  if (NULL == a)
    return ps;
  if (! json_is_array (a))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Expected JSON array for field `%s'\n",
                name);
    GNUNET_assert (0);
  }
  return ps;
}

GNUNET_JSON_pack_array_incref()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_array_incref	(	const char *	name,
		json_t *	a
	)

Generate packer instruction for a JSON field of type JSON array where the reference counter is incremented by the packer.

Note that a deep copy is not performed.

Parameters

name	name of the field to add to the object
a	array to increment reference counter of

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = a
  };
 
  if (NULL == a)
    return ps;
  (void) json_incref (a);
  if (! json_is_array (a))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Expected JSON array for field `%s'\n",
                name);
    GNUNET_assert (0);
  }
  return ps;
}

GNUNET_JSON_pack_data_varsize()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_data_varsize	(	const char *	name,
		const void *	blob,
		size_t	blob_size
	)

Generate packer instruction for a JSON field of type variable size binary blob.

Parameters

name	name of the field to add to the object
blob	binary data to pack
blob_size	number of bytes in blob

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = (NULL != blob)
    ? GNUNET_JSON_from_data (blob,
                             blob_size)
    : NULL
  };
 
  return ps;
}

GNUNET_JSON_pack_data64_varsize()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_data64_varsize	(	const char *	name,
		const void *	blob,
		size_t	blob_size
	)

Generate packer instruction for a JSON field of type variable size binary blob.

Use base64-encoding, instead of the more common Crockford base32-encoding.

Parameters

name	name of the field to add to the object
blob	binary data to pack
blob_size	number of bytes in blob

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = (NULL != blob)
    ? GNUNET_JSON_from_data64 (blob,
                               blob_size)
    : NULL
  };
 
  return ps;
}

GNUNET_JSON_pack_timestamp()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_timestamp	(	const char *	name,
		struct GNUNET_TIME_Timestamp	at
	)

Generate packer instruction for a JSON field of type timestamp.

Parameters

name	name of the field to add to the object
at	timestamp pack, a value of 0 is only allowed with GNUNET_JSON_pack_allow_null()!

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name
  };
 
  if (! GNUNET_TIME_absolute_is_zero (t.abs_time))
  {
    ps.object = GNUNET_JSON_from_timestamp (t);
    GNUNET_assert (NULL != ps.object);
  }
  else
  {
    ps.object = NULL;
  }
  return ps;
}

GNUNET_JSON_pack_timestamp_nbo()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_timestamp_nbo	(	const char *	name,
		struct GNUNET_TIME_TimestampNBO	at
	)

Generate packer instruction for a JSON field of type timestamp in network byte order.

Parameters

name	name of the field to add to the object
at	timestamp to pack, a value of 0 is only allowed with GNUNET_JSON_pack_allow_null()!

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  return GNUNET_JSON_pack_timestamp (name,
                                     GNUNET_TIME_timestamp_ntoh (at));
}

GNUNET_JSON_pack_time_rel()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_time_rel	(	const char *	name,
		struct GNUNET_TIME_Relative	rt
	)

Generate packer instruction for a JSON field of type relative time.

Parameters

name	name of the field to add to the object
rt	relative time to pack

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  json_t *json;
 
  json = GNUNET_JSON_from_time_rel (rt);
  GNUNET_assert (NULL != json);
  return GNUNET_JSON_pack_object_steal (name,
                                        json);
}

GNUNET_JSON_pack_time_rel_nbo()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_time_rel_nbo	(	const char *	name,
		struct GNUNET_TIME_RelativeNBO	rt
	)

Generate packer instruction for a JSON field of type relative time in network byte order.

Parameters

name	name of the field to add to the object
rt	relative time to pack

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  return GNUNET_JSON_pack_time_rel (name,
                                    GNUNET_TIME_relative_ntoh (rt));
}

GNUNET_JSON_pack_rsa_public_key()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_rsa_public_key	(	const char *	name,
		const struct GNUNET_CRYPTO_RsaPublicKey *	pk
	)

Generate packer instruction for a JSON field of type RSA public key.

Parameters

name	name of the field to add to the object
pk	RSA public key

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = GNUNET_JSON_from_rsa_public_key (pk)
  };
 
  return ps;
}

GNUNET_JSON_pack_rsa_signature()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_rsa_signature	(	const char *	name,
		const struct GNUNET_CRYPTO_RsaSignature *	sig
	)

Generate packer instruction for a JSON field of type RSA signature.

Parameters

name	name of the field to add to the object
sig	RSA signature

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = GNUNET_JSON_from_rsa_signature (sig)
  };
 
  return ps;
}