pair_print.c File Reference

Pair serialisation API. More...

#include <freeradius-devel/util/pair.h>
#include <freeradius-devel/util/talloc.h>
#include <freeradius-devel/util/proto.h>
#include <freeradius-devel/util/pair_legacy.h>

Include dependency graph for pair_print.c:

Go to the source code of this file.

Macros
#define	fr_pair_reset_parent(parent)

Functions
void	_fr_pair_list_debug (FILE *fp, int lvl, fr_pair_t *parent, fr_pair_list_t const *list)
	Print a list of attributes and enumv.
void	_fr_pair_list_log (fr_log_t const *log, int lvl, fr_pair_t *parent, fr_pair_list_t const *list, char const *file, int line)
	Print a list of attributes and enumv.
void	fr_pair_debug (FILE *fp, fr_pair_t const *pair)
	Dumps a pair to the default logging destination - Useful for calling from debuggers.
void	fr_pair_list_debug (FILE *fp, fr_pair_list_t const *list)
	Dumps a list to the default logging destination - Useful for calling from debuggers.
static void	fr_pair_list_debug_sbuff (FILE *fp, int lvl, fr_pair_t *parent, fr_pair_list_t const *list, fr_sbuff_t *sbuff)
static void	fr_pair_list_log_sbuff (fr_log_t const *log, int lvl, fr_pair_t *parent, fr_pair_list_t const *list, char const *file, int line, fr_sbuff_t *sbuff)
ssize_t	fr_pair_list_print (fr_sbuff_t *out, fr_dict_attr_t const *parent, fr_pair_list_t const *list)
	Print a pair list.
ssize_t	fr_pair_print (fr_sbuff_t *out, fr_dict_attr_t const *parent, fr_pair_t const *vp)
	Print one attribute and value to a string.
ssize_t	fr_pair_print_secure (fr_sbuff_t *out, fr_dict_attr_t const *parent, fr_pair_t const *vp)
	Print one attribute and value to a string with escape rules.
ssize_t	fr_pair_print_value_quoted (fr_sbuff_t *out, fr_pair_t const *vp, fr_token_t quote)
	Print the value of an attribute to a string.

Detailed Description

Pair serialisation API.

Copyright

2020 The FreeRADIUS server project

Definition in file pair_print.c.

Macro Definition Documentation

fr_pair_reset_parent

#define fr_pair_reset_parent

(

parent

)

Value:

        do { \
        if (parent && (parent->type == FR_TYPE_GROUP)) { \
                parent = fr_dict_attr_ref(parent); \
                if (parent->flags.is_root) parent = NULL; \
        } \
        if (parent && (parent == vp->da)) parent = NULL; \
  } while (0)

Definition at line 22 of file pair_print.c.

Function Documentation

_fr_pair_list_debug()

void _fr_pair_list_debug	(	FILE *	fp,
		int	lvl,
		fr_pair_t *	parent,
		fr_pair_list_t const *	list
	)

Print a list of attributes and enumv.

Parameters

[in]	fp	to output to.
[in]	lvl	depth in structural attribute.
[in]	parent	parent attribute
[in]	list	to print.

Definition at line 372 of file pair_print.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_fr_pair_list_log()

void _fr_pair_list_log	(	fr_log_t const *	log,
		int	lvl,
		fr_pair_t *	parent,
		fr_pair_list_t const *	list,
		char const *	file,
		int	line
	)

Print a list of attributes and enumv.

Parameters

[in]	log	to output to.
[in]	lvl	depth in structural attribute.
[in]	parent	parent attribute
[in]	list	to print.
[in]	file	where the message originated
[in]	line	where the message originated

Definition at line 322 of file pair_print.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_pair_debug()

void fr_pair_debug	(	FILE *	fp,
		fr_pair_t const *	pair
	)

Dumps a pair to the default logging destination - Useful for calling from debuggers.

Definition at line 394 of file pair_print.c.

Here is the call graph for this function:

fr_pair_list_debug()

void fr_pair_list_debug	(	FILE *	fp,
		fr_pair_list_t const *	list
	)

Dumps a list to the default logging destination - Useful for calling from debuggers.

Definition at line 385 of file pair_print.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_pair_list_debug_sbuff()

static void fr_pair_list_debug_sbuff ( FILE *  fp, int  lvl, fr_pair_t *  parent, fr_pair_list_t const *  list, fr_sbuff_t *  sbuff  )

static

Definition at line 332 of file pair_print.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_pair_list_log_sbuff()

static void fr_pair_list_log_sbuff ( fr_log_t const *  log, int  lvl, fr_pair_t *  parent, fr_pair_list_t const *  list, char const *  file, int  line, fr_sbuff_t *  sbuff  )

static

Definition at line 277 of file pair_print.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_pair_list_print()

ssize_t fr_pair_list_print	(	fr_sbuff_t *	out,
		fr_dict_attr_t const *	parent,
		fr_pair_list_t const *	list
	)

Print a pair list.

Parameters

[in]	out	Where to write the string.
[in]	parent	parent da to start from
[in]	list	pair list

Returns

• Length of data written to out.
• value >= outlen on truncation.

Definition at line 253 of file pair_print.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_pair_print()

ssize_t fr_pair_print	(	fr_sbuff_t *	out,
		fr_dict_attr_t const *	parent,
		fr_pair_t const *	vp
	)

Print one attribute and value to a string.

Print a fr_pair_t in the format:

        <attribute_name> <op> <value>

to a string.

Parameters

[in]	out	Where to write the string.
[in]	parent	If not NULL, only print OID components from this parent to the VP.
[in]	vp	to print.

Returns

• Length of data written to out.
• value >= outlen on truncation.

Definition at line 117 of file pair_print.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_pair_print_secure()

ssize_t fr_pair_print_secure	(	fr_sbuff_t *	out,
		fr_dict_attr_t const *	parent,
		fr_pair_t const *	vp
	)

Print one attribute and value to a string with escape rules.

Similar to fr_pair_print(), but secrets are omitted. This function duplicates parts of the functionality of fr_pair_print(). fr_pair_print_value_quoted(), and fr_value_box_print_quoted(), but for the special case of secure strings.

Note that only secrets of type "string" and "octets" are omitted. Other "secret" data types are still printed as-is.

"octets" are still printed as "<<< secret >>>". Which won't parse correctly, but that's fine. Because omitted data is not meant to be parsed into real data.

Parameters

[in]	out	Where to write the string.
[in]	parent	If not NULL, only print OID components from this parent to the VP.
[in]	vp	to print.

Returns

• < 0 on error
• Length of data written to out.
• value >= outlen on truncation.

Definition at line 187 of file pair_print.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_pair_print_value_quoted()

ssize_t fr_pair_print_value_quoted	(	fr_sbuff_t *	out,
		fr_pair_t const *	vp,
		fr_token_t	quote
	)

Print the value of an attribute to a string.

Parameters

[in]	out	Where to write the string.
[in]	vp	to print.
[in]	quote	Char to add before and after printed value, if 0 no char will be added, if < 0 raw string will be added.

Returns

• >= 0 length of data written to out.
• <0 the number of bytes we would have needed to write the complete string to out.

Definition at line 53 of file pair_print.c.

Here is the call graph for this function:

Here is the caller graph for this function: