filter.c File Reference

Functions to handle basic LDAP filter parsing and filtering. More...

#include <freeradius-devel/ldap/base.h>

Include dependency graph for filter.c:

Go to the source code of this file.

Macros
#define	DEBUG_LDAP_ATTR_VAL
#define	FILTER_ATTR_MAX_LEN   256
#define	FILTER_VALUE_MAX_LEN   256

Functions
bool	fr_ldap_filter_eval (fr_dlist_head_t *root, fr_ldap_connection_t *conn, LDAPMessage *msg)
	Evaluate an LDAP filter. More...
fr_slen_t	fr_ldap_filter_parse (TALLOC_CTX *ctx, fr_dlist_head_t **root, fr_sbuff_t *filter, filter_attr_check_t attr_check, void *uctx)
	Parse an LDAP filter into its component nodes. More...
static bool	ldap_filter_group_eval (ldap_filter_t *group, fr_ldap_connection_t *conn, LDAPMessage *msg, int depth)
	Evaluate a group of LDAP filters. More...
static bool	ldap_filter_node_eval (ldap_filter_t *node, fr_ldap_connection_t *conn, LDAPMessage *msg, int depth)
	Evaluate a single LDAP filter node. More...
static fr_slen_t	ldap_filter_parse_filter (ldap_filter_t *node, fr_sbuff_t *sbuff, int depth, filter_attr_check_t attr_check, void *uctx)
	Parse individual LDAP filter. More...
static fr_slen_t	ldap_filter_parse_logic (ldap_filter_t *node, fr_sbuff_t *sbuff, int depth, filter_attr_check_t attr_check, void *uctx)
	Parse LDAP filter logic group. More...
static fr_slen_t	ldap_filter_parse_node (ldap_filter_t *node, fr_sbuff_t *sbuff, int depth, filter_attr_check_t attr_check, void *uctx)
	Parse individual LDAP filter nodes. More...

Variables
static bool const	fr_ldap_attr_allowed_chars [UINT8_MAX+1]
static fr_table_num_sorted_t const	ldap_filter_op_table []
static size_t	ldap_filter_op_table_len = NUM_ELEMENTS(ldap_filter_op_table)

Detailed Description

Functions to handle basic LDAP filter parsing and filtering.

Id

f62246f98c32488ea3287c3b5732984cd1033607

Copyright

2022 Network RADIUS SAS (legal.nosp@m.@net.nosp@m.workr.nosp@m.adiu.nosp@m.s.com)

Definition in file filter.c.

Macro Definition Documentation

DEBUG_LDAP_ATTR_VAL

#define DEBUG_LDAP_ATTR_VAL

Value:

        if (DEBUG_ENABLED3) { \
        fr_value_box_t  value_box; \
        fr_ldap_berval_to_value_str_shallow(&value_box, values[i]); \
        DEBUG3("%*s  Evaluating attribute \"%s\", value \"%pV\"", depth, "", node->attr, &value_box); \
}

Definition at line 411 of file filter.c.

FILTER_ATTR_MAX_LEN

#define FILTER_ATTR_MAX_LEN   256

Definition at line 39 of file filter.c.

FILTER_VALUE_MAX_LEN

#define FILTER_VALUE_MAX_LEN   256

Definition at line 40 of file filter.c.

Function Documentation

fr_ldap_filter_eval()

bool fr_ldap_filter_eval	(	fr_dlist_head_t *	root,
		fr_ldap_connection_t *	conn,
		LDAPMessage *	msg
	)

Evaluate an LDAP filter.

Parameters

[in]	root	of the LDAP filter to evaluate.
[in]	conn	LDAP connection the message being filtered was returned on.
[in]	msg	to filter.

Returns

true or false result of the node evaluation.

Definition at line 583 of file filter.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_ldap_filter_parse()

fr_slen_t fr_ldap_filter_parse	(	TALLOC_CTX *	ctx,
		fr_dlist_head_t **	root,
		fr_sbuff_t *	filter,
		filter_attr_check_t	attr_check,
		void *	uctx
	)

Parse an LDAP filter into its component nodes.

Parameters

[in]	ctx	to allocate nodes in.
[in,out]	root	where to allocate the root of the parsed filter.
[in]	filter	to parse.
[in]	attr_check	callback to check if required attributes are in the query.
[in]	uctx	passed to attribute check callback.

Returns

• number of bytes parsed on success < 0 on failure

Definition at line 343 of file filter.c.

Here is the call graph for this function:

Here is the caller graph for this function:

ldap_filter_group_eval()

static bool ldap_filter_group_eval ( ldap_filter_t *  group, fr_ldap_connection_t *  conn, LDAPMessage *  msg, int  depth  )

static

Evaluate a group of LDAP filters.

Groups have a logical operator of &, | or !

Parameters

[in]	group	to evaluate.
[in]	conn	LDAP connection the message being filtered was returned on
[in]	msg	to filter
[in]	depth	to indent debug messages, reflecting group nesting

Returns

true or false result of the group evaluation

Definition at line 377 of file filter.c.

Here is the call graph for this function:

Here is the caller graph for this function:

ldap_filter_node_eval()

static bool ldap_filter_node_eval ( ldap_filter_t *  node, fr_ldap_connection_t *  conn, LDAPMessage *  msg, int  depth  )

static

Evaluate a single LDAP filter node.

Parameters

[in]	node	to evaluate.
[in]	conn	LDAP connection the message being filtered was returned on.
[in]	msg	to filter.
[in]	depth	to indent debug messages, reflecting group nesting.

Returns

true or false result of the node evaluation.

Definition at line 425 of file filter.c.

Here is the call graph for this function:

Here is the caller graph for this function:

ldap_filter_parse_filter()

static fr_slen_t ldap_filter_parse_filter ( ldap_filter_t *  node, fr_sbuff_t *  sbuff, int  depth, filter_attr_check_t  attr_check, void *  uctx  )

static

Parse individual LDAP filter.

Parameters

[in,out]	node	to populate with parsed filter.
[in]	sbuff	pointing to filter to parse.
[in]	depth	to indent debug output, indicating nesting of groups.
[in]	attr_check	callback to check if required attributes are in the query.
[in]	uctx	passed to attribute check callback.

Returns

• number of bytes parsed on success
• < 0 on error

Definition at line 121 of file filter.c.

Here is the call graph for this function:

Here is the caller graph for this function:

ldap_filter_parse_logic()

static fr_slen_t ldap_filter_parse_logic ( ldap_filter_t *  node, fr_sbuff_t *  sbuff, int  depth, filter_attr_check_t  attr_check, void *  uctx  )

static

Parse LDAP filter logic group.

Parameters

[in,out]	node	to populate with parsed filter.
[in]	sbuff	pointing to filter to parse.
[in]	depth	to indent debug output, indicating nesting of groups.
[in]	attr_check	callback to check if required attributes are in the query.
[in]	uctx	passed to attribute check callback.

Returns

• number of bytes parsed on success
• < 0 on error

Definition at line 56 of file filter.c.

Here is the call graph for this function:

Here is the caller graph for this function:

ldap_filter_parse_node()

static fr_slen_t ldap_filter_parse_node ( ldap_filter_t *  node, fr_sbuff_t *  sbuff, int  depth, filter_attr_check_t  attr_check, void *  uctx  )

static

Parse individual LDAP filter nodes.

A node can either be a group of nodes joined with a logical operator or an individual filter.

Parameters

[in,out]	node	to populate with parsed filter.
[in]	sbuff	pointing to filter to parse.
[in]	depth	to indent debug output, indicating nesting of groups.
[in]	attr_check	callback to check if required attributes are in the query.
[in]	uctx	passed to attribute check callback.

Returns

• number of bytes parsed on success
• < 0 on error

Definition at line 283 of file filter.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

fr_ldap_attr_allowed_chars

bool const fr_ldap_attr_allowed_chars[UINT8_MAX+1]

static

Initial value:

= {
                                ['-'] = true,
                                SBUFF_CHAR_CLASS_ALPHA_NUM
}

Definition at line 34 of file filter.c.

ldap_filter_op_table

fr_table_num_sorted_t const ldap_filter_op_table[]

static

Initial value:

= {
        { L("<="),      LDAP_FILTER_OP_LE       },
        { L("="),       LDAP_FILTER_OP_EQ       },
        { L(">="),      LDAP_FILTER_OP_GE       }
}

Definition at line 27 of file filter.c.

ldap_filter_op_table_len

size_t ldap_filter_op_table_len = NUM_ELEMENTS(ldap_filter_op_table)

static

Definition at line 32 of file filter.c.