4 Copyright (C) Andrew Tridgell 2004
5 Copyright (C) Stefan Metzmacher 2004
6 Copyright (C) Simo Sorce 2005
8 ** NOTE! The following LGPL license applies to the ldb
9 ** library. This does NOT imply that all of Samba is released
12 This library is free software; you can redistribute it and/or
13 modify it under the terms of the GNU Lesser General Public
14 License as published by the Free Software Foundation; either
15 version 2 of the License, or (at your option) any later version.
17 This library is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 Lesser General Public License for more details.
22 You should have received a copy of the GNU Lesser General Public
23 License along with this library; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * Component: ldb header
32 * Description: defines for base ldb API
34 * Author: Andrew Tridgell
35 * Author: Stefan Metzmacher
42 major restrictions as compared to normal LDAP:
45 - each record must have a unique key field
46 - the key must be representable as a NULL terminated C string and may not
47 contain a comma or braces
49 major restrictions as compared to tdb:
51 - no explicit locking calls
52 UPDATE: we have transactions now, better than locking --SSS.
57 an individual lump of data in a result comes in this format. The
58 pointer will usually be to a UTF-8 string if the application is
59 sensible, but it can be to anything you like, including binary data
60 blobs of arbitrary size.
69 /* internal ldb exploded dn structures */
70 struct ldb_dn_component {
76 struct ldb_dn_component *components;
79 /* these flags are used in ldd_message_element.flags fields. The
80 LDA_FLAGS_MOD_* flags are used in ldap_modify() calls to specify
81 whether attributes are being added, deleted or modified */
82 #define LDB_FLAG_MOD_MASK 0x3
83 #define LDB_FLAG_MOD_ADD 1
84 #define LDB_FLAG_MOD_REPLACE 2
85 #define LDB_FLAG_MOD_DELETE 3
91 #define LDB_OID_COMPARATOR_AND "1.2.840.113556.1.4.803"
92 #define LDB_OID_COMPARATOR_OR "1.2.840.113556.1.4.804"
95 results are given back as arrays of ldb_message_element
97 struct ldb_message_element {
100 unsigned int num_values;
101 struct ldb_val *values;
106 a ldb_message represents all or part of a record. It can contain an arbitrary
111 unsigned int num_elements;
112 struct ldb_message_element *elements;
113 void *private_data; /* private to the backend */
116 enum ldb_changetype {
117 LDB_CHANGETYPE_NONE=0,
119 LDB_CHANGETYPE_DELETE,
120 LDB_CHANGETYPE_MODIFY
124 a ldif record - from ldif_read
127 enum ldb_changetype changetype;
128 struct ldb_message *msg;
131 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
133 LDB_SCOPE_ONELEVEL=1,
134 LDB_SCOPE_SUBTREE=2};
139 the fuction type for the callback used in traversing the database
141 typedef int (*ldb_traverse_fn)(struct ldb_context *, const struct ldb_message *);
146 /* module initialisation function */
147 typedef struct ldb_module *(*ldb_module_init_t)(struct ldb_context *, const char **);
150 /* debugging uses one of the following levels */
151 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
152 LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
155 the user can optionally supply a debug function. The function
156 is based on the vfprintf() style of interface, but with the addition
159 struct ldb_debug_ops {
160 void (*debug)(void *context, enum ldb_debug_level level,
161 const char *fmt, va_list ap);
165 #define LDB_FLG_RDONLY 1
166 #define LDB_FLG_NOSYNC 2
168 #ifndef PRINTF_ATTRIBUTE
169 #define PRINTF_ATTRIBUTE(a,b)
172 /* structures for ldb_parse_tree handling code */
173 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
174 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
175 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
176 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
178 struct ldb_parse_tree {
179 enum ldb_parse_op operation;
182 struct ldb_parse_tree *child;
186 struct ldb_val value;
190 int start_with_wildcard;
191 int end_with_wildcard;
192 struct ldb_val **chunks;
199 struct ldb_val value;
205 struct ldb_val value;
208 unsigned int num_elements;
209 struct ldb_parse_tree **elements;
214 struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
215 char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
216 char *ldb_binary_encode(void *ctx, struct ldb_val val);
220 functions for controlling attribute handling
222 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
223 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
225 struct ldb_attrib_handler {
228 /* LDB_ATTR_FLAG_* */
231 /* convert from ldif to binary format */
232 ldb_attr_handler_t ldif_read_fn;
234 /* convert from binary to ldif format */
235 ldb_attr_handler_t ldif_write_fn;
237 /* canonicalise a value, for use by indexing and dn construction */
238 ldb_attr_handler_t canonicalise_fn;
240 /* compare two values */
241 ldb_attr_comparison_t comparison_fn;
244 #define LDB_ATTR_FLAG_HIDDEN (1<<0) /* the attribute is not returned by default */
245 #define LDB_ATTR_FLAG_CONSTRUCTED (1<<1) /* the attribute is constructed from other attributes */
248 /* well-known ldap attribute syntaxes - see rfc2252 section 4.3.2 */
249 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
250 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
251 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
252 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
253 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
254 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
257 initialise a ldb context
259 struct ldb_context *ldb_init(void *mem_ctx);
262 connect to a database. The URL can either be one of the following forms
266 flags is made up of LDB_FLG_*
268 the options are passed uninterpreted to the backend, and are
271 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
274 search the database given a LDAP-like search expression
276 return the number of records found, or -1 on error
278 use talloc_free to free the ldb_message returned
280 int ldb_search(struct ldb_context *ldb,
281 const struct ldb_dn *base,
282 enum ldb_scope scope,
283 const char *expression,
284 const char * const *attrs, struct ldb_message ***res);
287 like ldb_search() but takes a parse tree
289 int ldb_search_bytree(struct ldb_context *ldb,
290 const struct ldb_dn *base,
291 enum ldb_scope scope,
292 struct ldb_parse_tree *tree,
293 const char * const *attrs, struct ldb_message ***res);
296 add a record to the database. Will fail if a record with the given class and key
299 int ldb_add(struct ldb_context *ldb,
300 const struct ldb_message *message);
303 modify the specified attributes of a record
305 int ldb_modify(struct ldb_context *ldb,
306 const struct ldb_message *message);
309 rename a record in the database
311 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);
314 delete a record from the database
316 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);
321 int ldb_transaction_start(struct ldb_context *ldb);
326 int ldb_transaction_commit(struct ldb_context *ldb);
331 int ldb_transaction_cancel(struct ldb_context *ldb);
335 return extended error information from the last call
337 const char *ldb_errstring(struct ldb_context *ldb);
340 casefold a string (should be UTF8, but at the moment it isn't)
342 char *ldb_casefold(void *mem_ctx, const char *s);
343 int ldb_caseless_cmp(const char *s1, const char *s2);
346 ldif manipulation functions
348 int ldb_ldif_write(struct ldb_context *ldb,
349 int (*fprintf_fn)(void *, const char *, ...),
351 const struct ldb_ldif *ldif);
352 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *);
353 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
354 int (*fgetc_fn)(void *), void *private_data);
355 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
356 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
357 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
358 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
359 int ldb_base64_decode(char *s);
360 int ldb_attrib_add_handlers(struct ldb_context *ldb,
361 const struct ldb_attrib_handler *handlers,
362 unsigned num_handlers);
364 /* The following definitions come from lib/ldb/common/ldb_dn.c */
366 int ldb_dn_is_special(const struct ldb_dn *dn);
367 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check);
368 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
369 struct ldb_dn *ldb_dn_new(void *mem_ctx);
370 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);
371 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn);
372 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
373 int ldb_dn_compare_base(struct ldb_context *ldb, const struct ldb_dn *base, const struct ldb_dn *dn);
374 int ldb_dn_compare(struct ldb_context *ldb, const struct ldb_dn *edn0, const struct ldb_dn *edn1);
375 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
376 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, const char *dn);
377 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el);
378 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn);
379 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn);
380 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
382 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
384 const struct ldb_dn *base);
385 struct ldb_dn *ldb_dn_make_child(void *mem_ctx,
386 const struct ldb_dn_component *component,
387 const struct ldb_dn *base);
388 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2);
389 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...) PRINTF_ATTRIBUTE(3,4);
390 struct ldb_dn_component *ldb_dn_get_rdn(void *mem_ctx, const struct ldb_dn *dn);
392 /* useful functions for ldb_message structure manipulation */
393 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
394 int ldb_attr_cmp(const char *attr1, const char *attr2);
395 int ldb_attr_dn(const char *attr);
396 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
398 /* create an empty message */
399 struct ldb_message *ldb_msg_new(void *mem_ctx);
401 /* find an element within an message */
402 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
403 const char *attr_name);
405 /* compare two ldb_val values - return 0 on match */
406 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
408 /* find a value within an ldb_message_element */
409 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
410 struct ldb_val *val);
412 /* add a new empty element to a ldb_message */
413 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags);
415 /* add a element to a ldb_message */
416 int ldb_msg_add(struct ldb_message *msg,
417 const struct ldb_message_element *el,
419 int ldb_msg_add_value(struct ldb_message *msg,
420 const char *attr_name,
421 const struct ldb_val *val);
422 int ldb_msg_add_string(struct ldb_message *msg,
423 const char *attr_name, const char *str);
424 int ldb_msg_add_fmt(struct ldb_message *msg,
425 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
427 /* compare two message elements - return 0 on match */
428 int ldb_msg_element_compare(struct ldb_message_element *el1,
429 struct ldb_message_element *el2);
431 /* find elements in a message and convert to a specific type, with
432 a give default value if not found. Assumes that elements are
434 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
435 int ldb_msg_find_int(const struct ldb_message *msg,
436 const char *attr_name,
438 unsigned int ldb_msg_find_uint(const struct ldb_message *msg,
439 const char *attr_name,
440 unsigned int default_value);
441 int64_t ldb_msg_find_int64(const struct ldb_message *msg,
442 const char *attr_name,
443 int64_t default_value);
444 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg,
445 const char *attr_name,
446 uint64_t default_value);
447 double ldb_msg_find_double(const struct ldb_message *msg,
448 const char *attr_name,
449 double default_value);
450 const char *ldb_msg_find_string(const struct ldb_message *msg,
451 const char *attr_name,
452 const char *default_value);
454 void ldb_msg_sort_elements(struct ldb_message *msg);
456 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
457 const struct ldb_message *msg);
458 struct ldb_message *ldb_msg_copy(void *mem_ctx,
459 const struct ldb_message *msg);
461 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
462 const struct ldb_message *msg);
465 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
466 struct ldb_message *msg1,
467 struct ldb_message *msg2);
469 int ldb_msg_sanity_check(const struct ldb_message *msg);
471 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
474 this allows the user to set a debug function for error reporting
476 int ldb_set_debug(struct ldb_context *ldb,
477 void (*debug)(void *context, enum ldb_debug_level level,
478 const char *fmt, va_list ap),
481 /* this sets up debug to print messages on stderr */
482 int ldb_set_debug_stderr(struct ldb_context *ldb);
484 /* control backend specific opaque values */
485 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
486 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
488 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
492 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
493 int ldb_attr_in_list(const char * const *attrs, const char *attr);
496 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
498 const char *replace);
500 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
501 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
502 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
504 char *ldb_timestring(void *mem_ctx, time_t t);
505 time_t ldb_string_to_time(const char *s);
507 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn);
508 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn);