/*
ldb database library
Copyright (C) Andrew Tridgell 2004
** NOTE! The following LGPL license applies to the ldb
** library. This does NOT imply that all of Samba is released
** under the LGPL
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 3 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see .
*/
/*
* Name: ldb
*
* Component: ldb expression parsing
*
* Description: parse LDAP-like search expressions
*
* Author: Andrew Tridgell
*/
/*
TODO:
- add RFC2254 binary string handling
- possibly add ~=, <= and >= handling
- expand the test suite
- add better parse error handling
*/
#include "ldb_private.h"
#include "system/locale.h"
/*
* Maximum depth of the filter parse tree, the value chosen is small enough to
* avoid triggering ASAN stack overflow checks. But large enough to be useful.
*
* On Windows clients the maximum number of levels of recursion allowed is 100.
* In the LDAP server, Windows restricts clients to 512 nested
* (eg) OR statements.
*/
#define LDB_MAX_PARSE_TREE_DEPTH 128
/*
a filter is defined by:
::= '(' ')'
::= | | |
::= '&'
::= '|'
::= '!'
::= |
::=
::= '=' | '~=' | '<=' | '>='
*/
/*
decode a RFC2254 binary string representation of a buffer.
Used in LDAP filters.
*/
struct ldb_val ldb_binary_decode(TALLOC_CTX *mem_ctx, const char *str)
{
size_t i, j;
struct ldb_val ret;
size_t slen = str?strlen(str):0;
ret.data = (uint8_t *)talloc_size(mem_ctx, slen+1);
ret.length = 0;
if (ret.data == NULL) return ret;
for (i=j=0;i 0x7E || strchr(" *()\\&|!\"", cval)) {
return true;
}
return false;
}
/*
encode a blob as a RFC2254 binary string, escaping any
non-printable or '\' characters
*/
char *ldb_binary_encode(TALLOC_CTX *mem_ctx, struct ldb_val val)
{
size_t i;
char *ret;
size_t len = val.length;
unsigned char *buf = val.data;
for (i=0;idata == NULL) return NULL;
val++;
}
if (ret != NULL) {
ret[val] = NULL;
}
return ret;
}
static struct ldb_parse_tree *ldb_parse_filter(
TALLOC_CTX *mem_ctx,
const char **s,
unsigned depth,
unsigned max_depth);
/*
parse an extended match
possible forms:
(attr:oid:=value)
(attr:dn:oid:=value)
(attr:dn:=value)
(:dn:oid:=value)
the ':dn' part sets the dnAttributes boolean if present
the oid sets the rule_id string
*/
static struct ldb_parse_tree *ldb_parse_extended(struct ldb_parse_tree *ret,
char *attr, char *value)
{
char *p1, *p2;
ret->operation = LDB_OP_EXTENDED;
ret->u.extended.value = ldb_binary_decode(ret, value);
if (ret->u.extended.value.data == NULL) goto failed;
p1 = strchr(attr, ':');
if (p1 == NULL) goto failed;
p2 = strchr(p1+1, ':');
*p1 = 0;
if (p2) *p2 = 0;
ret->u.extended.attr = attr;
if (strcmp(p1+1, "dn") == 0) {
ret->u.extended.dnAttributes = 1;
if (p2) {
ret->u.extended.rule_id = talloc_strdup(ret, p2+1);
if (ret->u.extended.rule_id == NULL) goto failed;
} else {
ret->u.extended.rule_id = NULL;
}
} else {
ret->u.extended.dnAttributes = 0;
ret->u.extended.rule_id = talloc_strdup(ret, p1+1);
if (ret->u.extended.rule_id == NULL) goto failed;
}
return ret;
failed:
talloc_free(ret);
return NULL;
}
static enum ldb_parse_op ldb_parse_filtertype(TALLOC_CTX *mem_ctx, char **type, char **value, const char **s)
{
enum ldb_parse_op filter = 0;
char *name, *val, *k;
const char *p = *s;
const char *t, *t1;
/* retrieve attributetype name */
t = p;
if (*p == '@') { /* for internal attributes the first char can be @ */
p++;
}
while ((isascii(*p) && isalnum((unsigned char)*p)) || (*p == '-') || (*p == '.')) {
/* attribute names can only be alphanums */
p++;
}
if (*p == ':') { /* but extended searches have : and . chars too */
p = strstr(p, ":=");
if (p == NULL) { /* malformed attribute name */
return 0;
}
}
t1 = p;
while (isspace((unsigned char)*p)) p++;
if (!strchr("=<>~:", *p)) {
return 0;
}
/* save name */
name = (char *)talloc_memdup(mem_ctx, t, t1 - t + 1);
if (name == NULL) return 0;
name[t1 - t] = '\0';
/* retrieve filtertype */
if (*p == '=') {
filter = LDB_OP_EQUALITY;
} else if (*p != '\0' && *(p + 1) == '=') {
switch (*p) {
case '<':
filter = LDB_OP_LESS;
p++;
break;
case '>':
filter = LDB_OP_GREATER;
p++;
break;
case '~':
filter = LDB_OP_APPROX;
p++;
break;
case ':':
filter = LDB_OP_EXTENDED;
p++;
break;
}
}
if (!filter) {
talloc_free(name);
return 0;
}
p++;
while (isspace((unsigned char)*p)) p++;
/* retrieve value */
t = p;
while (*p && ((*p != ')') || ((*p == ')') && (*(p - 1) == '\\')))) p++;
val = (char *)talloc_memdup(mem_ctx, t, p - t + 1);
if (val == NULL) {
talloc_free(name);
return 0;
}
val[p - t] = '\0';
k = &(val[p - t]);
/* remove trailing spaces from value */
while ((k > val) && (isspace((unsigned char)*(k - 1)))) k--;
*k = '\0';
*type = name;
*value = val;
*s = p;
return filter;
}
/*
::=
*/
static struct ldb_parse_tree *ldb_parse_simple(TALLOC_CTX *mem_ctx, const char **s)
{
char *attr, *value;
struct ldb_parse_tree *ret;
enum ldb_parse_op filtertype;
ret = talloc_zero(mem_ctx, struct ldb_parse_tree);
if (!ret) {
errno = ENOMEM;
return NULL;
}
filtertype = ldb_parse_filtertype(ret, &attr, &value, s);
if (!filtertype) {
talloc_free(ret);
return NULL;
}
switch (filtertype) {
case LDB_OP_PRESENT:
ret->operation = LDB_OP_PRESENT;
ret->u.present.attr = attr;
break;
case LDB_OP_EQUALITY:
if (strcmp(value, "*") == 0) {
ret->operation = LDB_OP_PRESENT;
ret->u.present.attr = attr;
break;
}
if (ldb_parse_find_wildcard(value) != NULL) {
ret->operation = LDB_OP_SUBSTRING;
ret->u.substring.attr = attr;
ret->u.substring.start_with_wildcard = 0;
ret->u.substring.end_with_wildcard = 0;
ret->u.substring.chunks = ldb_wildcard_decode(ret, value);
if (ret->u.substring.chunks == NULL){
talloc_free(ret);
return NULL;
}
if (value[0] == '*')
ret->u.substring.start_with_wildcard = 1;
if (value[strlen(value) - 1] == '*')
ret->u.substring.end_with_wildcard = 1;
talloc_free(value);
break;
}
ret->operation = LDB_OP_EQUALITY;
ret->u.equality.attr = attr;
ret->u.equality.value = ldb_binary_decode(ret, value);
if (ret->u.equality.value.data == NULL) {
talloc_free(ret);
return NULL;
}
talloc_free(value);
break;
case LDB_OP_GREATER:
ret->operation = LDB_OP_GREATER;
ret->u.comparison.attr = attr;
ret->u.comparison.value = ldb_binary_decode(ret, value);
if (ret->u.comparison.value.data == NULL) {
talloc_free(ret);
return NULL;
}
talloc_free(value);
break;
case LDB_OP_LESS:
ret->operation = LDB_OP_LESS;
ret->u.comparison.attr = attr;
ret->u.comparison.value = ldb_binary_decode(ret, value);
if (ret->u.comparison.value.data == NULL) {
talloc_free(ret);
return NULL;
}
talloc_free(value);
break;
case LDB_OP_APPROX:
ret->operation = LDB_OP_APPROX;
ret->u.comparison.attr = attr;
ret->u.comparison.value = ldb_binary_decode(ret, value);
if (ret->u.comparison.value.data == NULL) {
talloc_free(ret);
return NULL;
}
talloc_free(value);
break;
case LDB_OP_EXTENDED:
ret = ldb_parse_extended(ret, attr, value);
break;
default:
talloc_free(ret);
return NULL;
}
return ret;
}
/*
parse a filterlist
::= '&'
::= '|'
::= |
*/
static struct ldb_parse_tree *ldb_parse_filterlist(
TALLOC_CTX *mem_ctx,
const char **s,
unsigned depth,
unsigned max_depth)
{
struct ldb_parse_tree *ret, *next;
enum ldb_parse_op op;
const char *p = *s;
switch (*p) {
case '&':
op = LDB_OP_AND;
break;
case '|':
op = LDB_OP_OR;
break;
default:
return NULL;
}
p++;
while (isspace((unsigned char)*p)) p++;
ret = talloc(mem_ctx, struct ldb_parse_tree);
if (!ret) {
errno = ENOMEM;
return NULL;
}
ret->operation = op;
ret->u.list.num_elements = 1;
ret->u.list.elements = talloc(ret, struct ldb_parse_tree *);
if (!ret->u.list.elements) {
errno = ENOMEM;
talloc_free(ret);
return NULL;
}
ret->u.list.elements[0] =
ldb_parse_filter(ret->u.list.elements, &p, depth, max_depth);
if (!ret->u.list.elements[0]) {
talloc_free(ret);
return NULL;
}
while (isspace((unsigned char)*p)) p++;
while (*p) {
struct ldb_parse_tree **e;
if (*p == ')') {
break;
}
next = ldb_parse_filter(
ret->u.list.elements, &p, depth, max_depth);
if (next == NULL) {
/* an invalid filter element */
talloc_free(ret);
return NULL;
}
e = talloc_realloc(ret, ret->u.list.elements,
struct ldb_parse_tree *,
ret->u.list.num_elements + 1);
if (!e) {
errno = ENOMEM;
talloc_free(ret);
return NULL;
}
ret->u.list.elements = e;
ret->u.list.elements[ret->u.list.num_elements] = next;
ret->u.list.num_elements++;
while (isspace((unsigned char)*p)) p++;
}
*s = p;
return ret;
}
/*
::= '!'
*/
static struct ldb_parse_tree *ldb_parse_not(
TALLOC_CTX *mem_ctx,
const char **s,
unsigned depth,
unsigned max_depth)
{
struct ldb_parse_tree *ret;
const char *p = *s;
if (*p != '!') {
return NULL;
}
p++;
ret = talloc(mem_ctx, struct ldb_parse_tree);
if (!ret) {
errno = ENOMEM;
return NULL;
}
ret->operation = LDB_OP_NOT;
ret->u.isnot.child = ldb_parse_filter(ret, &p, depth, max_depth);
if (!ret->u.isnot.child) {
talloc_free(ret);
return NULL;
}
*s = p;
return ret;
}
/*
parse a filtercomp
::= | | |
*/
static struct ldb_parse_tree *ldb_parse_filtercomp(
TALLOC_CTX *mem_ctx,
const char **s,
unsigned depth,
unsigned max_depth)
{
struct ldb_parse_tree *ret;
const char *p = *s;
while (isspace((unsigned char)*p)) p++;
switch (*p) {
case '&':
ret = ldb_parse_filterlist(mem_ctx, &p, depth, max_depth);
break;
case '|':
ret = ldb_parse_filterlist(mem_ctx, &p, depth, max_depth);
break;
case '!':
ret = ldb_parse_not(mem_ctx, &p, depth, max_depth);
break;
case '(':
case ')':
return NULL;
default:
ret = ldb_parse_simple(mem_ctx, &p);
}
*s = p;
return ret;
}
/*
::= '(' ')'
*/
static struct ldb_parse_tree *ldb_parse_filter(
TALLOC_CTX *mem_ctx,
const char **s,
unsigned depth,
unsigned max_depth)
{
struct ldb_parse_tree *ret;
const char *p = *s;
/*
* Check the depth of the parse tree, and reject the input if
* max_depth exceeded. This avoids stack overflow
* issues.
*/
if (depth > max_depth) {
return NULL;
}
depth++;
if (*p != '(') {
return NULL;
}
p++;
ret = ldb_parse_filtercomp(mem_ctx, &p, depth, max_depth);
if (*p != ')') {
return NULL;
}
p++;
while (isspace((unsigned char)*p)) {
p++;
}
*s = p;
return ret;
}
/*
main parser entry point. Takes a search string and returns a parse tree
expression ::= |
*/
struct ldb_parse_tree *ldb_parse_tree(TALLOC_CTX *mem_ctx, const char *s)
{
unsigned depth = 0;
while (s && isspace((unsigned char)*s)) s++;
if (s == NULL || *s == 0) {
s = "(|(objectClass=*)(distinguishedName=*))";
}
if (*s == '(') {
return ldb_parse_filter(
mem_ctx, &s, depth, LDB_MAX_PARSE_TREE_DEPTH);
}
return ldb_parse_simple(mem_ctx, &s);
}
/*
construct a ldap parse filter given a parse tree
*/
char *ldb_filter_from_tree(TALLOC_CTX *mem_ctx, const struct ldb_parse_tree *tree)
{
char *s, *s2, *ret;
unsigned int i;
if (tree == NULL) {
return NULL;
}
switch (tree->operation) {
case LDB_OP_AND:
case LDB_OP_OR:
ret = talloc_asprintf(mem_ctx, "(%c", tree->operation==LDB_OP_AND?'&':'|');
if (ret == NULL) return NULL;
for (i=0;iu.list.num_elements;i++) {
s = ldb_filter_from_tree(mem_ctx, tree->u.list.elements[i]);
if (s == NULL) {
talloc_free(ret);
return NULL;
}
s2 = talloc_asprintf_append(ret, "%s", s);
talloc_free(s);
if (s2 == NULL) {
talloc_free(ret);
return NULL;
}
ret = s2;
}
s = talloc_asprintf_append(ret, ")");
if (s == NULL) {
talloc_free(ret);
return NULL;
}
return s;
case LDB_OP_NOT:
s = ldb_filter_from_tree(mem_ctx, tree->u.isnot.child);
if (s == NULL) return NULL;
ret = talloc_asprintf(mem_ctx, "(!%s)", s);
talloc_free(s);
return ret;
case LDB_OP_EQUALITY:
s = ldb_binary_encode(mem_ctx, tree->u.equality.value);
if (s == NULL) return NULL;
ret = talloc_asprintf(mem_ctx, "(%s=%s)",
tree->u.equality.attr, s);
talloc_free(s);
return ret;
case LDB_OP_SUBSTRING:
ret = talloc_asprintf(mem_ctx, "(%s=%s", tree->u.substring.attr,
tree->u.substring.start_with_wildcard?"*":"");
if (ret == NULL) return NULL;
for (i = 0; tree->u.substring.chunks && tree->u.substring.chunks[i]; i++) {
s2 = ldb_binary_encode(mem_ctx, *(tree->u.substring.chunks[i]));
if (s2 == NULL) {
talloc_free(ret);
return NULL;
}
if (tree->u.substring.chunks[i+1] ||
tree->u.substring.end_with_wildcard) {
s = talloc_asprintf_append(ret, "%s*", s2);
} else {
s = talloc_asprintf_append(ret, "%s", s2);
}
if (s == NULL) {
talloc_free(ret);
return NULL;
}
ret = s;
}
s = talloc_asprintf_append(ret, ")");
if (s == NULL) {
talloc_free(ret);
return NULL;
}
ret = s;
return ret;
case LDB_OP_GREATER:
s = ldb_binary_encode(mem_ctx, tree->u.comparison.value);
if (s == NULL) return NULL;
ret = talloc_asprintf(mem_ctx, "(%s>=%s)",
tree->u.comparison.attr, s);
talloc_free(s);
return ret;
case LDB_OP_LESS:
s = ldb_binary_encode(mem_ctx, tree->u.comparison.value);
if (s == NULL) return NULL;
ret = talloc_asprintf(mem_ctx, "(%s<=%s)",
tree->u.comparison.attr, s);
talloc_free(s);
return ret;
case LDB_OP_PRESENT:
ret = talloc_asprintf(mem_ctx, "(%s=*)", tree->u.present.attr);
return ret;
case LDB_OP_APPROX:
s = ldb_binary_encode(mem_ctx, tree->u.comparison.value);
if (s == NULL) return NULL;
ret = talloc_asprintf(mem_ctx, "(%s~=%s)",
tree->u.comparison.attr, s);
talloc_free(s);
return ret;
case LDB_OP_EXTENDED:
s = ldb_binary_encode(mem_ctx, tree->u.extended.value);
if (s == NULL) return NULL;
ret = talloc_asprintf(mem_ctx, "(%s%s%s%s:=%s)",
tree->u.extended.attr?tree->u.extended.attr:"",
tree->u.extended.dnAttributes?":dn":"",
tree->u.extended.rule_id?":":"",
tree->u.extended.rule_id?tree->u.extended.rule_id:"",
s);
talloc_free(s);
return ret;
}
return NULL;
}
/*
walk a parse tree, calling the provided callback on each node
*/
int ldb_parse_tree_walk(struct ldb_parse_tree *tree,
int (*callback)(struct ldb_parse_tree *tree, void *),
void *private_context)
{
unsigned int i;
int ret;
ret = callback(tree, private_context);
if (ret != LDB_SUCCESS) {
return ret;
}
switch (tree->operation) {
case LDB_OP_AND:
case LDB_OP_OR:
for (i=0;iu.list.num_elements;i++) {
ret = ldb_parse_tree_walk(tree->u.list.elements[i], callback, private_context);
if (ret != LDB_SUCCESS) {
return ret;
}
}
break;
case LDB_OP_NOT:
ret = ldb_parse_tree_walk(tree->u.isnot.child, callback, private_context);
if (ret != LDB_SUCCESS) {
return ret;
}
break;
case LDB_OP_EQUALITY:
case LDB_OP_GREATER:
case LDB_OP_LESS:
case LDB_OP_APPROX:
case LDB_OP_SUBSTRING:
case LDB_OP_PRESENT:
case LDB_OP_EXTENDED:
break;
}
return LDB_SUCCESS;
}
struct parse_tree_attr_replace_ctx {
const char *attr;
const char *replace;
};
/*
callback for ldb_parse_tree_attr_replace()
*/
static int parse_tree_attr_replace(struct ldb_parse_tree *tree, void *private_context)
{
struct parse_tree_attr_replace_ctx *ctx = private_context;
switch (tree->operation) {
case LDB_OP_EQUALITY:
if (ldb_attr_cmp(tree->u.equality.attr, ctx->attr) == 0) {
tree->u.equality.attr = ctx->replace;
}
break;
case LDB_OP_GREATER:
case LDB_OP_LESS:
case LDB_OP_APPROX:
if (ldb_attr_cmp(tree->u.comparison.attr, ctx->attr) == 0) {
tree->u.comparison.attr = ctx->replace;
}
break;
case LDB_OP_SUBSTRING:
if (ldb_attr_cmp(tree->u.substring.attr, ctx->attr) == 0) {
tree->u.substring.attr = ctx->replace;
}
break;
case LDB_OP_PRESENT:
if (ldb_attr_cmp(tree->u.present.attr, ctx->attr) == 0) {
tree->u.present.attr = ctx->replace;
}
break;
case LDB_OP_EXTENDED:
if (tree->u.extended.attr &&
ldb_attr_cmp(tree->u.extended.attr, ctx->attr) == 0) {
tree->u.extended.attr = ctx->replace;
}
break;
default:
break;
}
return LDB_SUCCESS;
}
/*
replace any occurrences of an attribute name in the parse tree with a
new name
*/
void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
const char *attr,
const char *replace)
{
struct parse_tree_attr_replace_ctx ctx;
ctx.attr = attr;
ctx.replace = replace;
ldb_parse_tree_walk(tree, parse_tree_attr_replace, &ctx);
}
/*
shallow copy a tree - copying only the elements array so that the caller
can safely add new elements without changing the message
*/
struct ldb_parse_tree *ldb_parse_tree_copy_shallow(TALLOC_CTX *mem_ctx,
const struct ldb_parse_tree *ot)
{
unsigned int i;
struct ldb_parse_tree *nt;
nt = talloc(mem_ctx, struct ldb_parse_tree);
if (!nt) {
return NULL;
}
*nt = *ot;
switch (ot->operation) {
case LDB_OP_AND:
case LDB_OP_OR:
nt->u.list.elements = talloc_array(nt, struct ldb_parse_tree *,
ot->u.list.num_elements);
if (!nt->u.list.elements) {
talloc_free(nt);
return NULL;
}
for (i=0;iu.list.num_elements;i++) {
nt->u.list.elements[i] =
ldb_parse_tree_copy_shallow(nt->u.list.elements,
ot->u.list.elements[i]);
if (!nt->u.list.elements[i]) {
talloc_free(nt);
return NULL;
}
}
break;
case LDB_OP_NOT:
nt->u.isnot.child = ldb_parse_tree_copy_shallow(nt,
ot->u.isnot.child);
if (!nt->u.isnot.child) {
talloc_free(nt);
return NULL;
}
break;
case LDB_OP_EQUALITY:
case LDB_OP_GREATER:
case LDB_OP_LESS:
case LDB_OP_APPROX:
case LDB_OP_SUBSTRING:
case LDB_OP_PRESENT:
case LDB_OP_EXTENDED:
break;
}
return nt;
}
/* Get the attribute (if any) associated with the top node of a parse tree. */
const char *ldb_parse_tree_get_attr(const struct ldb_parse_tree *tree)
{
switch (tree->operation) {
case LDB_OP_AND:
case LDB_OP_OR:
case LDB_OP_NOT:
return NULL;
case LDB_OP_EQUALITY:
return tree->u.equality.attr;
case LDB_OP_SUBSTRING:
return tree->u.substring.attr;
case LDB_OP_GREATER:
case LDB_OP_LESS:
case LDB_OP_APPROX:
return tree->u.comparison.attr;
case LDB_OP_PRESENT:
return tree->u.present.attr;
case LDB_OP_EXTENDED:
return tree->u.extended.attr;
}
return NULL;
}