4 Copyright (C) Andrew Tridgell 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 3 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, see <http://www.gnu.org/licenses/>.
24 register handlers for specific attributes and objectclass relationships
26 this allows a backend to store its schema information in any format
27 it likes (or to not have any schema information at all) while keeping the
28 message matching logic generic
31 #include "ldb_includes.h"
34 add a attribute to the ldb_schema
36 if flags contains LDB_ATTR_FLAG_ALLOCATED
37 the attribute name string will be copied using
38 talloc_strdup(), otherwise it needs to be a static const
39 string at least with a lifetime longer than the ldb struct!
41 the ldb_schema_syntax structure should be a pointer
42 to a static const struct or at least it needs to be
43 a struct with a longer lifetime than the ldb context!
46 int ldb_schema_attribute_add_with_syntax(struct ldb_context *ldb,
47 const char *attribute,
49 const struct ldb_schema_syntax *syntax)
52 struct ldb_schema_attribute *a;
55 return LDB_ERR_OPERATIONS_ERROR;
58 n = ldb->schema.num_attributes + 1;
60 a = talloc_realloc(ldb, ldb->schema.attributes,
61 struct ldb_schema_attribute, n);
66 ldb->schema.attributes = a;
68 for (i = 0; i < ldb->schema.num_attributes; i++) {
69 int cmp = ldb_attr_cmp(attribute, a[i].name);
71 /* silently ignore attempts to overwrite fixed attributes */
72 if (a[i].flags & LDB_ATTR_FLAG_FIXED) {
75 if (a[i].flags & LDB_ATTR_FLAG_ALLOCATED) {
76 talloc_free(discard_const_p(char, a[i].name));
78 /* To cancel out increment below */
79 ldb->schema.num_attributes--;
82 memmove(a+i+1, a+i, sizeof(*a) * (ldb->schema.num_attributes-i));
86 ldb->schema.num_attributes++;
88 a[i].name = attribute;
92 if (a[i].flags & LDB_ATTR_FLAG_ALLOCATED) {
93 a[i].name = talloc_strdup(a, a[i].name);
94 if (a[i].name == NULL) {
103 static const struct ldb_schema_syntax ldb_syntax_default = {
104 .name = LDB_SYNTAX_OCTET_STRING,
105 .ldif_read_fn = ldb_handler_copy,
106 .ldif_write_fn = ldb_handler_copy,
107 .canonicalise_fn = ldb_handler_copy,
108 .comparison_fn = ldb_comparison_binary
111 static const struct ldb_schema_attribute ldb_attribute_default = {
114 .syntax = &ldb_syntax_default
118 return the attribute handlers for a given attribute
120 const struct ldb_schema_attribute *ldb_schema_attribute_by_name(struct ldb_context *ldb,
124 const struct ldb_schema_attribute *def = &ldb_attribute_default;
126 /* as handlers are sorted, '*' must be the first if present */
127 if (strcmp(ldb->schema.attributes[0].name, "*") == 0) {
128 def = &ldb->schema.attributes[0];
132 /* do a binary search on the array */
133 e = ldb->schema.num_attributes - 1;
139 r = ldb_attr_cmp(name, ldb->schema.attributes[i].name);
141 return &ldb->schema.attributes[i];
156 add to the list of ldif handlers for this ldb context
158 void ldb_schema_attribute_remove(struct ldb_context *ldb, const char *name)
160 const struct ldb_schema_attribute *a;
163 a = ldb_schema_attribute_by_name(ldb, name);
164 if (a == NULL || a->name == NULL) {
168 /* FIXED attributes are never removed */
169 if (a->flags & LDB_ATTR_FLAG_FIXED) {
173 if (a->flags & LDB_ATTR_FLAG_ALLOCATED) {
174 talloc_free(discard_const_p(char, a->name));
177 i = a - ldb->schema.attributes;
178 if (i < ldb->schema.num_attributes - 1) {
179 memmove(&ldb->schema.attributes[i],
180 a+1, sizeof(*a) * (ldb->schema.num_attributes-(i+1)));
183 ldb->schema.num_attributes--;
187 setup a attribute handler using a standard syntax
189 int ldb_schema_attribute_add(struct ldb_context *ldb,
190 const char *attribute,
194 const struct ldb_schema_syntax *s = ldb_standard_syntax_by_name(ldb, syntax);
195 return ldb_schema_attribute_add_with_syntax(ldb, attribute, flags, s);
199 setup the attribute handles for well known attributes
201 int ldb_setup_wellknown_attributes(struct ldb_context *ldb)
207 { "dn", LDB_SYNTAX_DN },
208 { "distinguishedName", LDB_SYNTAX_DN },
209 { "cn", LDB_SYNTAX_DIRECTORY_STRING },
210 { "dc", LDB_SYNTAX_DIRECTORY_STRING },
211 { "ou", LDB_SYNTAX_DIRECTORY_STRING },
212 { "objectClass", LDB_SYNTAX_OBJECTCLASS }
217 for (i=0;i<ARRAY_SIZE(wellknown);i++) {
218 ret = ldb_schema_attribute_add(ldb, wellknown[i].attr, 0,
219 wellknown[i].syntax);
220 if (ret != LDB_SUCCESS) {
230 add a extended dn syntax to the ldb_schema
232 int ldb_dn_extended_add_syntax(struct ldb_context *ldb,
234 const struct ldb_dn_extended_syntax *syntax)
237 struct ldb_dn_extended_syntax *a;
240 return LDB_ERR_OPERATIONS_ERROR;
243 n = ldb->schema.num_dn_extended_syntax + 1;
245 a = talloc_realloc(ldb, ldb->schema.dn_extended_syntax,
246 struct ldb_dn_extended_syntax, n);
249 return LDB_ERR_OPERATIONS_ERROR;
252 a[ldb->schema.num_dn_extended_syntax] = *syntax;
253 ldb->schema.dn_extended_syntax = a;
255 ldb->schema.num_dn_extended_syntax = n;
261 return the extended dn syntax for a given name
263 const struct ldb_dn_extended_syntax *ldb_dn_extended_syntax_by_name(struct ldb_context *ldb,
267 for (i=0; i < ldb->schema.num_dn_extended_syntax; i++) {
268 if (ldb_attr_cmp(ldb->schema.dn_extended_syntax[i].name, name) == 0) {
269 return &ldb->schema.dn_extended_syntax[i];