4 Copyright (C) Simo Sorce 2005
6 ** NOTE! The following LGPL license applies to the ldb
7 ** library. This does NOT imply that all of Samba is released
10 This library is free software; you can redistribute it and/or
11 modify it under the terms of the GNU Lesser General Public
12 License as published by the Free Software Foundation; either
13 version 2 of the License, or (at your option) any later version.
15 This library is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public
21 License along with this library; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 * Component: ldb dn explode and utility functions
30 * Description: - explode a dn into it's own basic elements
31 * and put them in a structure
32 * - manipulate ldb_dn structures
38 #include "ldb/include/ldb.h"
39 #include "ldb/include/ldb_private.h"
42 #define LDB_DN_NULL_FAILED(x) if (!(x)) goto failed
44 #define LDB_SPECIAL "@SPECIAL"
46 int ldb_dn_is_special(const struct ldb_dn *dn)
48 if (dn == NULL || dn->comp_num != 1) return 0;
50 return ! strcmp(dn->components[0].name, LDB_SPECIAL);
53 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check)
55 if (dn == NULL || dn->comp_num != 1) return 0;
57 return ! strcmp((char *)dn->components[0].value.data, check);
60 static int ldb_dn_is_valid_attribute_name(const char *name)
62 if (name == NULL) return 0;
65 if (! isascii(*name)) {
68 if (! (isalnum((unsigned char)*name) || *name == '-')) {
77 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value)
79 const char *p, *s, *src;
86 p = s = src = (const char *)value.data;
89 /* allocate destination string, it will be at most 3 times the source */
90 dst = d = talloc_array(mem_ctx, char, len * 3 + 1);
91 LDB_DN_NULL_FAILED(dst);
93 while (p - src < len) {
95 p += strcspn(p, ",=\n+<>#;\\\"");
97 if (p - src == len) /* found no escapable chars */
100 memcpy(d, s, p - s); /* copy the part of the string before the stop */
101 d += (p - s); /* move to current position */
103 if (*p) { /* it is a normal escapable character */
106 } else { /* we have a zero byte in the string */
107 strncpy(d, "\00", 3); /* escape the zero */
109 p++; /* skip the zero */
111 s = p; /* move forward */
114 /* copy the last part (with zero) and return */
115 memcpy(d, s, &src[len] - s + 1);
124 static struct ldb_val ldb_dn_unescape_value(void *mem_ctx, const char *src)
126 struct ldb_val value;
128 char *p, *dst = NULL, *end;
130 memset(&value, 0, sizeof(value));
132 LDB_DN_NULL_FAILED(src);
134 dst = p = talloc_memdup(mem_ctx, src, strlen(src) + 1);
135 LDB_DN_NULL_FAILED(dst);
137 end = &dst[strlen(dst)];
140 p += strcspn(p, ",=\n+<>#;\\\"");
143 if (strchr(",=\n+<>#;\\\"", p[1])) {
144 memmove(p, p + 1, end - (p + 1) + 1);
150 if (sscanf(p + 1, "%02x", &x) == 1) {
151 *p = (unsigned char)x;
152 memmove(p + 1, p + 3, end - (p + 3) + 1);
159 /* a string with not escaped specials is invalid (tested) */
165 value.length = end - dst;
166 value.data = (uint8_t *)dst;
174 /* check if the string contains quotes
175 * skips leading and trailing spaces
176 * - returns 0 if no quotes found
177 * - returns 1 if quotes are found and put their position
178 * in *quote_start and *quote_end parameters
179 * - return -1 if there are open quotes
182 static int get_quotes_position(const char *source, int *quote_start, int *quote_end)
186 if (source == NULL || quote_start == NULL || quote_end == NULL) return -1;
190 /* check if there are quotes surrounding the value */
191 p += strspn(p, " \n"); /* skip white spaces */
194 *quote_start = p - source;
199 LDB_DN_NULL_FAILED(p);
201 if (*(p - 1) == '\\')
205 *quote_end = p - source;
215 static char *seek_to_separator(char *string, const char *separators)
220 if (string == NULL || separators == NULL) return NULL;
222 p = strchr(string, '=');
223 LDB_DN_NULL_FAILED(p);
227 /* check if there are quotes surrounding the value */
229 ret = get_quotes_position(p, &qs, &qe);
233 if (ret == 1) { /* quotes found */
235 p += qe; /* positioning after quotes */
236 p += strspn(p, " \n"); /* skip white spaces after the quote */
238 if (strcspn(p, separators) != 0) /* if there are characters between quotes */
239 return NULL; /* and separators, the dn is invalid */
241 return p; /* return on the separator */
244 /* no quotes found seek to separators */
245 ret = strcspn(p, separators);
246 if (ret == 0) /* no separators ?! bail out */
255 static char *ldb_dn_trim_string(char *string, const char *edge)
259 /* seek out edge from start of string */
260 s = string + strspn(string, edge);
262 /* backwards skip from end of string */
263 p = &s[strlen(s) - 1];
264 while (p > s && strchr(edge, *p)) {
272 /* we choosed to not support multpile valued components */
273 static struct ldb_dn_component ldb_dn_explode_component(void *mem_ctx, char *raw_component)
275 struct ldb_dn_component dc;
279 memset(&dc, 0, sizeof(dc));
281 if (raw_component == NULL) {
285 /* find attribute type/value separator */
286 p = strchr(raw_component, '=');
287 LDB_DN_NULL_FAILED(p);
289 *p++ = '\0'; /* terminate name and point to value */
291 /* copy and trim name in the component */
292 dc.name = talloc_strdup(mem_ctx, ldb_dn_trim_string(raw_component, " \n"));
296 if (! ldb_dn_is_valid_attribute_name(dc.name)) {
300 ret = get_quotes_position(p, &qs, &qe);
303 case 0: /* no quotes trim the string */
304 p = ldb_dn_trim_string(p, " \n");
305 dc.value = ldb_dn_unescape_value(mem_ctx, p);
308 case 1: /* quotes found get the unquoted string */
311 dc.value.length = strlen(p);
312 dc.value.data = talloc_memdup(mem_ctx, p, dc.value.length + 1);
315 default: /* mismatched quotes ot other error, bail out */
319 if (dc.value.length == 0) {
326 talloc_free(dc.name);
331 struct ldb_dn *ldb_dn_new(void *mem_ctx)
335 edn = talloc(mem_ctx, struct ldb_dn);
336 LDB_DN_NULL_FAILED(edn);
338 /* Initially there are no components */
340 edn->components = NULL;
348 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn)
350 struct ldb_dn *edn; /* the exploded dn */
353 if (dn == NULL) return NULL;
355 /* Allocate a structure to hold the exploded DN */
356 edn = ldb_dn_new(mem_ctx);
364 /* Special DNs case */
367 edn->components = talloc(edn, struct ldb_dn_component);
368 if (edn->components == NULL) goto failed;
369 edn->components[0].name = talloc_strdup(edn->components, LDB_SPECIAL);
370 if (edn->components[0].name == NULL) goto failed;
371 edn->components[0].value.data = (uint8_t *)talloc_strdup(edn->components, dn);
372 if (edn->components[0].value.data== NULL) goto failed;
373 edn->components[0].value.length = strlen(dn);
377 pdn = p = talloc_strdup(edn, dn);
378 LDB_DN_NULL_FAILED(pdn);
380 /* get the components */
384 /* terminate the current component and return pointer to the next one */
385 t = seek_to_separator(p, ",;");
386 LDB_DN_NULL_FAILED(t);
388 if (*t) { /* here there is a separator */
389 *t = '\0'; /*terminate */
390 t++; /* a separtor means another component follows */
393 /* allocate space to hold the dn component */
394 edn->components = talloc_realloc(edn, edn->components,
395 struct ldb_dn_component,
397 if (edn->components == NULL)
400 /* store the exploded component in the main structure */
401 edn->components[edn->comp_num] = ldb_dn_explode_component(edn, p);
402 LDB_DN_NULL_FAILED(edn->components[edn->comp_num].name);
406 /* jump to the next component if any */
420 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn)
425 if (edn == NULL) return NULL;
428 if (ldb_dn_is_special(edn)) {
429 dn = talloc_strdup(mem_ctx, (char *)edn->components[0].value.data);
433 dn = talloc_strdup(mem_ctx, "");
434 LDB_DN_NULL_FAILED(dn);
436 for (i = 0; i < edn->comp_num; i++) {
437 value = ldb_dn_escape_value(dn, edn->components[i].value);
438 LDB_DN_NULL_FAILED(value);
441 dn = talloc_asprintf_append(dn, "%s=%s", edn->components[i].name, value);
443 dn = talloc_asprintf_append(dn, ",%s=%s", edn->components[i].name, value);
445 LDB_DN_NULL_FAILED(dn);
457 /* compare DNs using casefolding compare functions */
459 int ldb_dn_compare_base(struct ldb_context *ldb,
460 const struct ldb_dn *base,
461 const struct ldb_dn *dn)
466 if (base->comp_num > dn->comp_num) {
467 return (dn->comp_num - base->comp_num);
470 if (base == NULL || base->comp_num == 0) return 0;
471 if (dn == NULL || dn->comp_num == 0) return -1;
472 if (base->comp_num > dn->comp_num) return -1;
474 /* if the number of components doesn't match they differ */
475 n0 = base->comp_num - 1;
476 n1 = dn->comp_num - 1;
477 while (n0 >= 0 && n1 >= 0) {
478 const struct ldb_attrib_handler *h;
480 /* compare names (attribute names are guaranteed to be ASCII only) */
481 ret = ldb_caseless_cmp(base->components[n0].name,
482 dn->components[n1].name);
487 /* names match, compare values */
488 h = ldb_attrib_handler(ldb, base->components[n0].name);
489 ret = h->comparison_fn(ldb, ldb, &(base->components[n0].value),
490 &(dn->components[n1].value));
501 int ldb_dn_compare(struct ldb_context *ldb,
502 const struct ldb_dn *edn0,
503 const struct ldb_dn *edn1)
505 if (edn0 == NULL || edn1 == NULL) return edn1 - edn0;
507 if (edn0->comp_num != edn1->comp_num)
508 return (edn1->comp_num - edn0->comp_num);
510 return ldb_dn_compare_base(ldb, edn0, edn1);
513 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn0, const char *dn1)
519 if (dn0 == NULL || dn1 == NULL) return dn1 - dn0;
521 edn0 = ldb_dn_explode_casefold(ldb, dn0);
522 if (edn0 == NULL) return 1;
524 edn1 = ldb_dn_explode_casefold(ldb, dn1);
530 ret = ldb_dn_compare(ldb, edn0, edn1);
539 casefold a dn. We need to casefold the attribute names, and canonicalize
540 attribute values of case insensitive attributes.
542 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, const struct ldb_dn *edn)
547 if (edn == NULL) return NULL;
549 cedn = ldb_dn_new(ldb);
550 LDB_DN_NULL_FAILED(cedn);
552 cedn->comp_num = edn->comp_num;
553 cedn->components = talloc_array(cedn, struct ldb_dn_component, edn->comp_num);
554 LDB_DN_NULL_FAILED(cedn->components);
556 for (i = 0; i < edn->comp_num; i++) {
557 struct ldb_dn_component dc;
558 const struct ldb_attrib_handler *h;
560 dc.name = ldb_casefold(cedn, edn->components[i].name);
561 LDB_DN_NULL_FAILED(dc.name);
563 h = ldb_attrib_handler(ldb, dc.name);
564 if (h->canonicalise_fn(ldb, cedn, &(edn->components[i].value), &(dc.value)) != 0) {
568 cedn->components[i] = dc;
578 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, const char *dn)
580 struct ldb_dn *edn, *cdn;
582 if (dn == NULL) return NULL;
584 edn = ldb_dn_explode(ldb, dn);
585 if (edn == NULL) return NULL;
587 cdn = ldb_dn_casefold(ldb, edn);
593 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, const struct ldb_dn *edn)
598 if (edn == NULL) return NULL;
601 if (ldb_dn_is_special(edn)) {
602 dn = talloc_strdup(ldb, (char *)edn->components[0].value.data);
606 cdn = ldb_dn_casefold(ldb, edn);
607 if (cdn == NULL) return NULL;
609 dn = ldb_dn_linearize(ldb, cdn);
619 static struct ldb_dn_component ldb_dn_copy_component(void *mem_ctx, struct ldb_dn_component *src)
621 struct ldb_dn_component dst;
623 memset(&dst, 0, sizeof(dst));
629 dst.value = ldb_val_dup(mem_ctx, &(src->value));
630 if (dst.value.data == NULL) {
634 dst.name = talloc_strdup(mem_ctx, src->name);
635 if (dst.name == NULL) {
636 talloc_free(dst.value.data);
642 /* copy specified number of elements of a dn into a new one
643 element are copied from top level up to the unique rdn
644 num_el may be greater then dn->comp_num (see ldb_dn_make_child)
646 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el)
651 if (dn == NULL) return NULL;
652 if (num_el <= 0) return NULL;
654 new = ldb_dn_new(mem_ctx);
655 LDB_DN_NULL_FAILED(new);
657 new->comp_num = num_el;
658 n = new->comp_num - 1;
659 new->components = talloc_array(new, struct ldb_dn_component, new->comp_num);
661 if (dn->comp_num == 0) return new;
662 e = dn->comp_num - 1;
664 for (i = 0; i < new->comp_num; i++) {
665 new->components[n - i] = ldb_dn_copy_component(new->components,
666 &(dn->components[e - i]));
679 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn)
681 if (dn == NULL) return NULL;
682 return ldb_dn_copy_partial(mem_ctx, dn, dn->comp_num);
685 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn)
687 if (dn == NULL) return NULL;
688 return ldb_dn_copy_partial(mem_ctx, dn, dn->comp_num - 1);
691 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
694 struct ldb_dn_component *dc;
696 if (attr == NULL || val == NULL) return NULL;
698 dc = talloc(mem_ctx, struct ldb_dn_component);
699 if (dc == NULL) return NULL;
701 dc->name = talloc_strdup(dc, attr);
702 if (dc->name == NULL) {
707 dc->value.data = (uint8_t *)talloc_strdup(dc, val);
708 if (dc->value.data == NULL) {
713 dc->value.length = strlen(val);
718 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
720 const struct ldb_dn *base)
723 if (! ldb_dn_is_valid_attribute_name(attr)) return NULL;
724 if (value == NULL || value == '\0') return NULL;
727 new = ldb_dn_copy_partial(mem_ctx, base, base->comp_num + 1);
728 LDB_DN_NULL_FAILED(new);
730 new = ldb_dn_new(mem_ctx);
731 LDB_DN_NULL_FAILED(new);
734 new->components = talloc_array(new, struct ldb_dn_component, new->comp_num);
737 new->components[0].name = talloc_strdup(new->components, attr);
738 LDB_DN_NULL_FAILED(new->components[0].name);
740 new->components[0].value.data = (uint8_t *)talloc_strdup(new->components, value);
741 LDB_DN_NULL_FAILED(new->components[0].value.data);
742 new->components[0].value.length = strlen((char *)new->components[0].value.data);
752 struct ldb_dn *ldb_dn_make_child(void *mem_ctx, const struct ldb_dn_component *component,
753 const struct ldb_dn *base)
755 if (component == NULL) return NULL;
757 return ldb_dn_build_child(mem_ctx, component->name,
758 (char *)component->value.data, base);
761 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2)
766 if (dn2 == NULL && dn1 == NULL) {
771 new = ldb_dn_new(mem_ctx);
772 LDB_DN_NULL_FAILED(new);
774 new->comp_num = dn1->comp_num;
775 new->components = talloc_array(new, struct ldb_dn_component, new->comp_num);
777 int comp_num = dn2->comp_num;
778 if (dn1 != NULL) comp_num += dn1->comp_num;
779 new = ldb_dn_copy_partial(mem_ctx, dn2, comp_num);
786 for (i = 0; i < dn1->comp_num; i++) {
787 new->components[i] = ldb_dn_copy_component(new->components,
788 &(dn1->components[i]));
798 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...)
805 if (child_fmt == NULL) return NULL;
807 va_start(ap, child_fmt);
808 ret = vasprintf(&child_str, child_fmt, ap);
811 if (ret <= 0) return NULL;
813 dn = ldb_dn_compose(mem_ctx, ldb_dn_explode(mem_ctx, child_str), base);
820 struct ldb_dn_component *ldb_dn_get_rdn(void *mem_ctx, const struct ldb_dn *dn)
822 struct ldb_dn_component *rdn;
824 if (dn == NULL) return NULL;
826 if (dn->comp_num < 1) {
830 rdn = talloc(mem_ctx, struct ldb_dn_component);
831 if (rdn == NULL) return NULL;
833 *rdn = ldb_dn_copy_component(mem_ctx, &dn->components[0]);
834 if (rdn->name == NULL) {
842 /* Create a 'canonical name' string from a DN:
844 ie dc=samba,dc=org -> samba.org/
845 uid=administrator,ou=users,dc=samba,dc=org = samba.org/users/administrator
847 There are two formats, the EX format has the last / replaced with a newline (\n).
850 static char *ldb_dn_canonical(void *mem_ctx, const struct ldb_dn *dn, int ex_format) {
852 char *cracked = NULL;
854 /* Walk backwards down the DN, grabbing 'dc' components at first */
855 for (i = dn->comp_num - 1 ; i >= 0; i--) {
856 if (ldb_attr_cmp(dn->components[i].name, "dc") != 0) {
860 cracked = talloc_asprintf(mem_ctx, "%s.%s",
861 ldb_dn_escape_value(mem_ctx, dn->components[i].value),
864 cracked = ldb_dn_escape_value(mem_ctx, dn->components[i].value);
871 /* Only domain components? Finish here */
874 cracked = talloc_asprintf(mem_ctx, "%s\n", cracked);
876 cracked = talloc_asprintf(mem_ctx, "%s/", cracked);
881 /* Now walk backwards appending remaining components */
883 cracked = talloc_asprintf(mem_ctx, "%s/%s", cracked,
884 ldb_dn_escape_value(mem_ctx, dn->components[i].value));
890 /* Last one, possibly a newline for the 'ex' format */
892 cracked = talloc_asprintf(mem_ctx, "%s\n%s", cracked,
893 ldb_dn_escape_value(mem_ctx, dn->components[i].value));
895 cracked = talloc_asprintf(mem_ctx, "%s/%s", cracked,
896 ldb_dn_escape_value(mem_ctx, dn->components[i].value));
901 /* Wrapper functions for the above, for the two different string formats */
902 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn) {
903 return ldb_dn_canonical(mem_ctx, dn, 0);
907 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn) {
908 return ldb_dn_canonical(mem_ctx, dn, 1);