rlm_json.c File Reference

Parses JSON responses. More...

#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/server/map_proc.h>
#include <freeradius-devel/util/base16.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/sbuff.h>
#include <freeradius-devel/util/types.h>
#include <freeradius-devel/util/value.h>
#include <freeradius-devel/unlang/xlat_func.h>
#include <freeradius-devel/json/base.h>

Include dependency graph for rlm_json.c:

Go to the source code of this file.

Data Structures
struct	rlm_json_jpath_cache
struct	rlm_json_jpath_to_eval_t
struct	rlm_json_t
	rlm_json module instance More...

Typedefs
typedef struct rlm_json_jpath_cache	rlm_json_jpath_cache_t
	Forms a linked list of jpath head node pointers (a list of jpaths) More...

Functions
static int	_json_map_proc_get_value (TALLOC_CTX *ctx, fr_pair_list_t *out, request_t *request, map_t const *map, void *uctx)
	Converts a string value into a fr_pair_t. More...
static xlat_action_t	json_encode_xlat (TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
	Convert given attributes to a JSON document. More...
static xlat_action_t	json_escape (TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in, bool quote)
static xlat_action_t	json_escape_xlat (TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
	Ensure contents are escaped correctly for a JSON document. More...
static xlat_action_t	json_jpath_validate_xlat (TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
	Determine if a jpath expression is valid. More...
static xlat_action_t	json_quote_xlat (TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
	Ensure contents are quoted correctly for a JSON document. More...
static int	mod_bootstrap (module_inst_ctx_t const *mctx)
static int	mod_instantiate (module_inst_ctx_t const *mctx)
static int	mod_load (void)
static unlang_action_t	mod_map_proc (rlm_rcode_t *p_result, UNUSED void const *mod_inst, void *proc_inst, request_t *request, fr_value_box_list_t *json, map_list_t const *maps)
	Parses a JSON string, and executes jpath queries against it to map values to attributes. More...
static int	mod_map_proc_instantiate (CONF_SECTION *cs, UNUSED void const *mod_inst, void *proc_inst, tmpl_t const *src, map_list_t const *maps)
	Pre-parse and validate literal jpath expressions for maps. More...
static void	mod_unload (void)

Variables
static fr_sbuff_parse_rules_t const	json_arg_parse_rules
static xlat_arg_parser_t const	json_encode_xlat_arg []
static xlat_arg_parser_t const	json_escape_xlat_arg []
static xlat_arg_parser_t const	json_jpath_validate_xlat_arg []
static conf_parser_t const	module_config []
module_rlm_t	rlm_json

Detailed Description

Parses JSON responses.

Id

8cc447c7d890b2870d66730ab44ea78371ef73f7

Author

Arran Cudbard-Bell

Matthew Newton

Copyright

2015 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

2015,2020 Network RADIUS SAS (legal.nosp@m.@net.nosp@m.workr.nosp@m.adiu.nosp@m.s.com)

2015 The FreeRADIUS Server Project

Definition in file rlm_json.c.

---

Data Structure Documentation

rlm_json_jpath_cache

struct rlm_json_jpath_cache

Definition at line 72 of file rlm_json.c.

Collaboration diagram for rlm_json_jpath_cache:

Data Fields
fr_jpath_node_t *	jpath	First node in jpath expression.
rlm_json_jpath_cache_t *	next	Next jpath cache entry.

rlm_json_jpath_to_eval_t

struct rlm_json_jpath_to_eval_t

Definition at line 77 of file rlm_json.c.

Collaboration diagram for rlm_json_jpath_to_eval_t:

Data Fields
fr_jpath_node_t const *	jpath
json_object *	root

rlm_json_t

struct rlm_json_t

rlm_json module instance

Definition at line 57 of file rlm_json.c.

Collaboration diagram for rlm_json_t:

Data Fields
fr_json_format_t *	format

Typedef Documentation

rlm_json_jpath_cache_t

typedef struct rlm_json_jpath_cache rlm_json_jpath_cache_t

Forms a linked list of jpath head node pointers (a list of jpaths)

Definition at line 62 of file rlm_json.c.

Function Documentation

_json_map_proc_get_value()

static int _json_map_proc_get_value ( TALLOC_CTX *  ctx, fr_pair_list_t *  out, request_t *  request, map_t const *  map, void *  uctx  )

static

Converts a string value into a fr_pair_t.

Parameters

[in,out]	ctx	to allocate fr_pair_t (s).
[out]	out	where to write the resulting fr_pair_t.
[in]	request	The current request.
[in]	map	to process.
[in]	uctx	The json tree/jpath expression to evaluate.

Returns

• 0 on success.
• -1 on failure.

Definition at line 404 of file rlm_json.c.

Here is the call graph for this function:

Here is the caller graph for this function:

json_escape()

static xlat_action_t json_escape ( TALLOC_CTX *  ctx, fr_dcursor_t *  out, UNUSED xlat_ctx_t const *  xctx, request_t *  request, fr_value_box_list_t *  in, bool  quote  )

static

Definition at line 87 of file rlm_json.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_bootstrap()

static int mod_bootstrap ( module_inst_ctx_t const *  mctx )

static

Definition at line 574 of file rlm_json.c.

Here is the call graph for this function:

mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const *  mctx )

static

Definition at line 554 of file rlm_json.c.

Here is the call graph for this function:

mod_load()

static int mod_load ( void  )

static

Definition at line 587 of file rlm_json.c.

Here is the call graph for this function:

mod_map_proc()

static unlang_action_t mod_map_proc ( rlm_rcode_t *  p_result, UNUSED void const *  mod_inst, void *  proc_inst, request_t *  request, fr_value_box_list_t *  json, map_list_t const *  maps  )

static

Parses a JSON string, and executes jpath queries against it to map values to attributes.

Parameters

p_result	Result of applying map: RLM_MODULE_NOOP no rows were returned or columns matched. RLM_MODULE_UPDATED if one or more fr_pair_t were added to the request_t. RLM_MODULE_FAIL if a fault occurred.
mod_inst	unused.
proc_inst	cached jpath sequences.
request	The current request.
json	JSON string to parse.
maps	Head of the map list.

Returns

UNLANG_ACTION_CALCULATE_RESULT

Definition at line 454 of file rlm_json.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_map_proc_instantiate()

static int mod_map_proc_instantiate ( CONF_SECTION *  cs, UNUSED void const *  mod_inst, void *  proc_inst, tmpl_t const *  src, map_list_t const *  maps  )

static

Pre-parse and validate literal jpath expressions for maps.

Parameters

[in]	cs	CONF_SECTION that defined the map instance.
[in]	mod_inst	module instance (unused).
[in]	proc_inst	the cache structure to fill.
[in]	src	Where to get the JSON data from.
[in]	maps	set of maps to translate to jpaths.

Returns

• 0 on success.
  • -1 on failure.

Definition at line 328 of file rlm_json.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_unload()

static void mod_unload ( void  )

static

Definition at line 603 of file rlm_json.c.

Here is the call graph for this function:

Variable Documentation

json_arg_parse_rules

fr_sbuff_parse_rules_t const json_arg_parse_rules

static

Initial value:

= {
        .terminals = &FR_SBUFF_TERMS(
                L("\t"),
                L(" "),
                L("!")
        )
}

Definition at line 46 of file rlm_json.c.

json_encode_xlat_arg

xlat_arg_parser_t const json_encode_xlat_arg[]

static

Initial value:

= {
        { .required = true, .concat = true, .type = FR_TYPE_STRING },
        XLAT_ARG_PARSER_TERMINATOR
}

Definition at line 194 of file rlm_json.c.

json_escape_xlat_arg

xlat_arg_parser_t const json_escape_xlat_arg[]

static

Initial value:

= {
        { .type = FR_TYPE_VOID },
        XLAT_ARG_PARSER_TERMINATOR
}

Definition at line 82 of file rlm_json.c.

json_jpath_validate_xlat_arg

xlat_arg_parser_t const json_jpath_validate_xlat_arg[]

static

Initial value:

= {
        { .required = true, .concat = true, .type = FR_TYPE_STRING },
        XLAT_ARG_PARSER_TERMINATOR
}

Definition at line 135 of file rlm_json.c.

module_config

conf_parser_t const module_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_SUBSECTION("encode", 0, rlm_json_t, format, fr_json_format_config),
          .subcs_size = sizeof(fr_json_format_t), .subcs_type = "fr_json_format_t" },
 
        CONF_PARSER_TERMINATOR
}

Definition at line 62 of file rlm_json.c.

rlm_json

module_rlm_t rlm_json

Initial value:

= {
        .common = {
                .magic          = MODULE_MAGIC_INIT,
                .name           = "json",
                .onload         = mod_load,
                .unload         = mod_unload,
                .config         = module_config,
                .inst_size      = sizeof(rlm_json_t),
                .bootstrap      = mod_bootstrap,
                .instantiate    = mod_instantiate
        }
}

Definition at line 620 of file rlm_json.c.