4 Copyright (C) Andrew Tridgell 2004
5 Copyright (C) Stefan Metzmacher 2004
6 Copyright (C) Simo Sorce 2005-2006
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 3 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, see <http://www.gnu.org/licenses/>.
29 * Component: ldb header
31 * Description: defines for base ldb API
33 * Author: Andrew Tridgell
34 * Author: Stefan Metzmacher
38 \file ldb.h Samba's ldb database
40 This header file provides the main API for ldb.
45 /*! \cond DOXYGEN_IGNORE */
52 #include "ldb_errors.h"
55 major restrictions as compared to normal LDAP:
57 - each record must have a unique key field
58 - the key must be representable as a NULL terminated C string and may not
59 contain a comma or braces
61 major restrictions as compared to tdb:
63 - no explicit locking calls, but we have transactions when using ldb_tdb
71 An individual lump of data in a result comes in this format. The
72 pointer will usually be to a UTF-8 string if the application is
73 sensible, but it can be to anything you like, including binary data
74 blobs of arbitrary size.
76 \note the data is null (0x00) terminated, but the length does not
77 include the terminator.
80 uint8_t *data; /*!< result data */
81 size_t length; /*!< length of data */
85 /*! \cond DOXYGEN_IGNORE */
86 #ifndef PRINTF_ATTRIBUTE
87 #define PRINTF_ATTRIBUTE(a,b)
91 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
92 #define _DEPRECATED_ __attribute__ ((deprecated))
99 /* opaque ldb_dn structures, see ldb_dn.c for internals */
100 struct ldb_dn_component;
104 There are a number of flags that are used with ldap_modify() in
105 ldb_message_element.flags fields. The LDB_FLAGS_MOD_ADD,
106 LDB_FLAGS_MOD_DELETE and LDB_FLAGS_MOD_REPLACE flags are used in
107 ldap_modify() calls to specify whether attributes are being added,
108 deleted or modified respectively.
110 #define LDB_FLAG_MOD_MASK 0x3
113 Flag value used in ldap_modify() to indicate that attributes are
116 \sa LDB_FLAG_MOD_MASK
118 #define LDB_FLAG_MOD_ADD 1
121 Flag value used in ldap_modify() to indicate that attributes are
124 \sa LDB_FLAG_MOD_MASK
126 #define LDB_FLAG_MOD_REPLACE 2
129 Flag value used in ldap_modify() to indicate that attributes are
132 \sa LDB_FLAG_MOD_MASK
134 #define LDB_FLAG_MOD_DELETE 3
137 OID for logic AND comaprison.
139 This is the well known object ID for a logical AND comparitor.
141 #define LDB_OID_COMPARATOR_AND "1.2.840.113556.1.4.803"
144 OID for logic OR comparison.
146 This is the well known object ID for a logical OR comparitor.
148 #define LDB_OID_COMPARATOR_OR "1.2.840.113556.1.4.804"
151 results are given back as arrays of ldb_message_element
153 struct ldb_message_element {
156 unsigned int num_values;
157 struct ldb_val *values;
162 a ldb_message represents all or part of a record. It can contain an arbitrary
167 unsigned int num_elements;
168 struct ldb_message_element *elements;
171 enum ldb_changetype {
172 LDB_CHANGETYPE_NONE=0,
174 LDB_CHANGETYPE_DELETE,
175 LDB_CHANGETYPE_MODIFY
181 This structure contains a LDIF record, as returned from ldif_read()
182 and equivalent functions.
185 enum ldb_changetype changetype; /*!< The type of change */
186 struct ldb_message *msg; /*!< The changes */
189 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
191 LDB_SCOPE_ONELEVEL=1,
192 LDB_SCOPE_SUBTREE=2};
195 struct tevent_context;
197 /* debugging uses one of the following levels */
198 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
199 LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
202 the user can optionally supply a debug function. The function
203 is based on the vfprintf() style of interface, but with the addition
206 struct ldb_debug_ops {
207 void (*debug)(void *context, enum ldb_debug_level level,
208 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
213 The user can optionally supply a custom utf8 functions,
214 to handle comparisons and casefolding.
216 struct ldb_utf8_fns {
218 char *(*casefold)(void *context, TALLOC_CTX *mem_ctx, const char *s, size_t n);
222 Flag value for database connection mode.
224 If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
225 opened read-only, if possible.
227 #define LDB_FLG_RDONLY 1
230 Flag value for database connection mode.
232 If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
233 opened without synchronous operations, if possible.
235 #define LDB_FLG_NOSYNC 2
238 Flag value to specify autoreconnect mode.
240 If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
241 be opened in a way that makes it try to auto reconnect if the
242 connection is dropped (actually make sense only with ldap).
244 #define LDB_FLG_RECONNECT 4
247 Flag to tell backends not to use mmap
249 #define LDB_FLG_NOMMAP 8
252 Flag to tell ldif handlers not to force encoding of binary
255 #define LDB_FLG_SHOW_BINARY 16
258 Flags to enable ldb tracing
260 #define LDB_FLG_ENABLE_TRACING 32
263 structures for ldb_parse_tree handling code
265 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
266 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
267 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
268 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
270 struct ldb_parse_tree {
271 enum ldb_parse_op operation;
274 struct ldb_parse_tree *child;
278 struct ldb_val value;
282 int start_with_wildcard;
283 int end_with_wildcard;
284 struct ldb_val **chunks;
291 struct ldb_val value;
297 struct ldb_val value;
300 unsigned int num_elements;
301 struct ldb_parse_tree **elements;
306 struct ldb_parse_tree *ldb_parse_tree(TALLOC_CTX *mem_ctx, const char *s);
307 char *ldb_filter_from_tree(TALLOC_CTX *mem_ctx, struct ldb_parse_tree *tree);
312 This function encodes a binary blob using the encoding rules in RFC
313 2254 (Section 4). This function also escapes any non-printable
316 \param mem_ctx the memory context to allocate the return string in.
317 \param val the (potentially) binary data to be encoded
319 \return the encoded data as a null terminated string
321 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
323 char *ldb_binary_encode(TALLOC_CTX *mem_ctx, struct ldb_val val);
328 This function encodes a string using the encoding rules in RFC 2254
329 (Section 4). This function also escapes any non-printable
332 \param mem_ctx the memory context to allocate the return string in.
333 \param string the string to be encoded
335 \return the encoded data as a null terminated string
337 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
339 char *ldb_binary_encode_string(TALLOC_CTX *mem_ctx, const char *string);
342 functions for controlling attribute handling
344 typedef int (*ldb_attr_handler_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, struct ldb_val *);
345 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, const struct ldb_val *);
348 attribute handler structure
350 attr -> The attribute name
351 ldif_read_fn -> convert from ldif to binary format
352 ldif_write_fn -> convert from binary to ldif format
353 canonicalise_fn -> canonicalise a value, for use by indexing and dn construction
354 comparison_fn -> compare two values
357 struct ldb_schema_syntax {
359 ldb_attr_handler_t ldif_read_fn;
360 ldb_attr_handler_t ldif_write_fn;
361 ldb_attr_handler_t canonicalise_fn;
362 ldb_attr_comparison_t comparison_fn;
365 struct ldb_schema_attribute {
368 const struct ldb_schema_syntax *syntax;
371 const struct ldb_schema_attribute *ldb_schema_attribute_by_name(struct ldb_context *ldb,
374 struct ldb_dn_extended_syntax {
376 ldb_attr_handler_t read_fn;
377 ldb_attr_handler_t write_clear_fn;
378 ldb_attr_handler_t write_hex_fn;
381 const struct ldb_dn_extended_syntax *ldb_dn_extended_syntax_by_name(struct ldb_context *ldb,
385 The attribute is not returned by default
387 #define LDB_ATTR_FLAG_HIDDEN (1<<0)
389 /* the attribute handler name should be freed when released */
390 #define LDB_ATTR_FLAG_ALLOCATED (1<<1)
393 The attribute is supplied by the application and should not be removed
395 #define LDB_ATTR_FLAG_FIXED (1<<2)
398 when this is set, attempts to create two records which have the same
399 value for this attribute will return LDB_ERR_ENTRY_ALREADY_EXISTS
401 #define LDB_ATTR_FLAG_UNIQUE_INDEX (1<<3)
404 when this is set, attempts to create two attribute values for this attribute on a single DN will return LDB_ERR_CONSTRAINT_VIOLATION
406 #define LDB_ATTR_FLAG_SINGLE_VALUE (1<<4)
409 LDAP attribute syntax for a DN
411 This is the well-known LDAP attribute syntax for a DN.
413 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
415 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
418 LDAP attribute syntax for a Directory String
420 This is the well-known LDAP attribute syntax for a Directory String.
422 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
424 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
427 LDAP attribute syntax for an integer
429 This is the well-known LDAP attribute syntax for an integer.
431 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
433 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
436 LDAP attribute syntax for a boolean
438 This is the well-known LDAP attribute syntax for a boolean.
440 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
442 #define LDB_SYNTAX_BOOLEAN "1.3.6.1.4.1.1466.115.121.1.7"
445 LDAP attribute syntax for an octet string
447 This is the well-known LDAP attribute syntax for an octet string.
449 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
451 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
454 LDAP attribute syntax for UTC time.
456 This is the well-known LDAP attribute syntax for a UTC time.
458 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
460 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
462 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
464 /* sorting helpers */
465 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
467 /* Individual controls */
470 OID for getting and manipulating attributes from the ldb
471 without interception in the operational module.
472 It can be used to access attribute that used to be stored in the sam
473 and that are now calculated.
475 #define LDB_CONTROL_BYPASSOPERATIONAL_OID "1.3.6.1.4.1.7165.4.3.13"
478 OID for recalculate SD control. This control force the
479 dsdb code to recalculate the SD of the object as if the
480 object was just created.
483 #define LDB_CONTROL_RECALCULATE_SD_OID "1.3.6.1.4.1.7165.4.3.5"
486 REVEAL_INTERNALS is used to reveal internal attributes and DN
487 components which are not normally shown to the user
489 #define LDB_CONTROL_REVEAL_INTERNALS "1.3.6.1.4.1.7165.4.3.6"
492 LDB_CONTROL_AS_SYSTEM is used to skip access checks on operations
493 that are performed by the system, but with a user's credentials, e.g.
496 #define LDB_CONTROL_AS_SYSTEM_OID "1.3.6.1.4.1.7165.4.3.7"
501 OID for the paged results control. This control is included in the
502 searchRequest and searchResultDone messages as part of the controls
503 field of the LDAPMessage, as defined in Section 4.1.12 of
506 \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
508 #define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
511 OID for specifying the returned elements of the ntSecurityDescriptor
513 \sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_sd_flags_oid.asp">Microsoft documentation of this OID</a>
515 #define LDB_CONTROL_SD_FLAGS_OID "1.2.840.113556.1.4.801"
518 OID for specifying an advanced scope for the search (one partition)
520 \sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_domain_scope_oid.asp">Microsoft documentation of this OID</a>
522 #define LDB_CONTROL_DOMAIN_SCOPE_OID "1.2.840.113556.1.4.1339"
525 OID for specifying an advanced scope for a search
527 \sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_search_options_oid.asp">Microsoft documentation of this OID</a>
529 #define LDB_CONTROL_SEARCH_OPTIONS_OID "1.2.840.113556.1.4.1340"
534 \sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_notification_oid.asp">Microsoft documentation of this OID</a>
536 #define LDB_CONTROL_NOTIFICATION_OID "1.2.840.113556.1.4.528"
539 OID for performing subtree deletes
541 \sa <a href="http://msdn.microsoft.com/en-us/library/aa366991(v=VS.85).aspx">Microsoft documentation of this OID</a>
543 #define LDB_CONTROL_TREE_DELETE_OID "1.2.840.113556.1.4.805"
546 OID for getting deleted objects
548 \sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_show_deleted_oid.asp">Microsoft documentation of this OID</a>
550 #define LDB_CONTROL_SHOW_DELETED_OID "1.2.840.113556.1.4.417"
553 OID for getting recycled objects
555 \sa <a href="http://msdn.microsoft.com/en-us/library/dd304621(PROT.13).aspx">Microsoft documentation of this OID</a>
557 #define LDB_CONTROL_SHOW_RECYCLED_OID "1.2.840.113556.1.4.2064"
560 OID for getting deactivated linked attributes
562 \sa <a href="http://msdn.microsoft.com/en-us/library/dd302781(PROT.13).aspx">Microsoft documentation of this OID</a>
564 #define LDB_CONTROL_SHOW_DEACTIVATED_LINK_OID "1.2.840.113556.1.4.2065"
569 \sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_extended_dn_oid.asp">Microsoft documentation of this OID</a>
571 #define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
574 OID for LDAP server sort result extension.
576 This control is included in the searchRequest message as part of
577 the controls field of the LDAPMessage, as defined in Section 4.1.12
578 of LDAP v3. The controlType is set to
579 "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
580 FALSE (where absent is also equivalent to FALSE) at the client's
583 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
585 #define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
588 OID for LDAP server sort result response extension.
590 This control is included in the searchResultDone message as part of
591 the controls field of the LDAPMessage, as defined in Section 4.1.12 of
594 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
596 #define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
599 OID for LDAP Attribute Scoped Query extension.
601 This control is included in SearchRequest or SearchResponse
602 messages as part of the controls field of the LDAPMessage.
604 #define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
607 OID for LDAP Directory Sync extension.
609 This control is included in SearchRequest or SearchResponse
610 messages as part of the controls field of the LDAPMessage.
612 #define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
616 OID for LDAP Virtual List View Request extension.
618 This control is included in SearchRequest messages
619 as part of the controls field of the LDAPMessage.
621 #define LDB_CONTROL_VLV_REQ_OID "2.16.840.1.113730.3.4.9"
624 OID for LDAP Virtual List View Response extension.
626 This control is included in SearchResponse messages
627 as part of the controls field of the LDAPMessage.
629 #define LDB_CONTROL_VLV_RESP_OID "2.16.840.1.113730.3.4.10"
632 OID to let modifies don't give an error when adding an existing
633 attribute with the same value or deleting an nonexisting one attribute
635 \sa <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/ldap/ldap/ldap_server_permissive_modify_oid.asp">Microsoft documentation of this OID</a>
637 #define LDB_CONTROL_PERMISSIVE_MODIFY_OID "1.2.840.113556.1.4.1413"
640 OID to allow the server to be more 'fast and loose' with the data being added.
645 #define LDB_CONTROL_SERVER_LAZY_COMMIT "1.2.840.113556.1.4.619"
648 OID for LDAP Extended Operation FAST_BIND
650 This Extended operations is used to perform a fast bind.
652 #define LDB_EXTENDED_FAST_BIND_OID "1.2.840.113556.1.4.1781"
655 OID for LDAP Extended Operation START_TLS.
657 This Extended operation is used to start a new TLS channel on top of a clear
660 #define LDB_EXTENDED_START_TLS_OID "1.3.6.1.4.1.1466.20037"
663 OID for LDAP Extended Operation DYNAMIC_REFRESH.
665 This Extended operation is used to create and maintain objects which exist
666 only a specific time, e.g. when a certain client or a certain person is
667 logged in. Data refreshes have to be periodically sent in a specific
668 interval. Otherwise the entry is going to be removed.
670 #define LDB_EXTENDED_DYNAMIC_OID "1.3.6.1.4.1.1466.101.119.1"
672 /* Other standardised controls */
675 OID for the allowing client to request temporary relaxed
676 enforcement of constraints of the x.500 model.
678 \sa <a href="http://opends.dev.java.net/public/standards/draft-zeilenga-ldap-managedit.txt">draft managedit</a>.
680 #define LDB_CONTROL_RELAX_OID "1.3.6.1.4.1.4203.666.5.12"
683 control for RODC join
684 See [MS-ADTS] section 3.1.1.3.4.1.23
686 #define LDB_CONTROL_RODC_DCPROMO_OID "1.2.840.113556.1.4.1341"
689 OID for LDAP Extended Operation PASSWORD_CHANGE.
691 This Extended operation is used to allow user password changes by the user
694 #define LDB_EXTENDED_PASSWORD_CHANGE_OID "1.3.6.1.4.1.4203.1.11.1"
697 struct ldb_sd_flags_control {
699 * request the owner 0x00000001
700 * request the group 0x00000002
701 * request the DACL 0x00000004
702 * request the SACL 0x00000008
704 unsigned secinfo_flags;
708 * DOMAIN_SCOPE 0x00000001
709 * this limits the search to one partition,
710 * and no referrals will be returned.
711 * (Note this doesn't limit the entries by there
712 * objectSid belonging to a domain! Builtin and Foreign Sids
713 * are still returned)
715 * PHANTOM_ROOT 0x00000002
716 * this search on the whole tree on a domain controller
717 * over multiple partitions without referrals.
718 * (This is the default behavior on the Global Catalog Port)
721 #define LDB_SEARCH_OPTION_DOMAIN_SCOPE 0x00000001
722 #define LDB_SEARCH_OPTION_PHANTOM_ROOT 0x00000002
724 struct ldb_search_options_control {
725 unsigned search_options;
728 struct ldb_paged_control {
734 struct ldb_extended_dn_control {
738 struct ldb_server_sort_control {
739 const char *attributeName;
740 const char *orderingRule;
744 struct ldb_sort_resp_control {
749 struct ldb_asq_control {
751 char *source_attribute;
756 struct ldb_dirsync_control {
763 struct ldb_vlv_req_control {
781 struct ldb_vlv_resp_control {
795 enum ldb_request_type {
802 LDB_REQ_REGISTER_CONTROL,
803 LDB_REQ_REGISTER_PARTITION
806 enum ldb_reply_type {
823 struct ldb_extended {
825 void *data; /* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
828 #define LDB_EXTENDED_SEQUENCE_NUMBER "1.3.6.1.4.1.7165.4.4.3"
830 enum ldb_sequence_type {
832 LDB_SEQ_HIGHEST_TIMESTAMP,
836 #define LDB_SEQ_GLOBAL_SEQUENCE 0x01
837 #define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
839 struct ldb_seqnum_request {
840 enum ldb_sequence_type type;
843 struct ldb_seqnum_result {
850 struct ldb_message **msgs;
851 struct ldb_extended *extended;
852 struct ldb_control **controls;
858 enum ldb_reply_type type;
859 struct ldb_message *message;
860 struct ldb_extended *response;
861 struct ldb_control **controls;
870 enum ldb_scope scope;
871 struct ldb_parse_tree *tree;
872 const char * const *attrs;
873 struct ldb_result *res;
877 const struct ldb_message *message;
881 const struct ldb_message *message;
889 struct ldb_dn *olddn;
890 struct ldb_dn *newdn;
893 struct ldb_register_control {
897 struct ldb_register_partition {
901 typedef int (*ldb_request_callback_t)(struct ldb_request *, struct ldb_reply *);
905 enum ldb_request_type operation;
908 struct ldb_search search;
910 struct ldb_modify mod;
911 struct ldb_delete del;
912 struct ldb_rename rename;
913 struct ldb_extended extended;
914 struct ldb_register_control reg_control;
915 struct ldb_register_partition reg_partition;
918 struct ldb_control **controls;
921 ldb_request_callback_t callback;
925 struct ldb_handle *handle;
928 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
929 int ldb_request_done(struct ldb_request *req, int status);
930 bool ldb_request_is_done(struct ldb_request *req);
932 int ldb_modules_wait(struct ldb_handle *handle);
933 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
935 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
936 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
937 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
938 void ldb_set_modules_dir(struct ldb_context *ldb, const char *path);
939 struct tevent_context;
940 void ldb_set_event_context(struct ldb_context *ldb, struct tevent_context *ev);
941 struct tevent_context * ldb_get_event_context(struct ldb_context *ldb);
944 Initialise ldbs' global information
946 This is required before any other LDB call
948 \return 0 if initialisation succeeded, -1 otherwise
950 int ldb_global_init(void);
953 Initialise an ldb context
955 This is required before any other LDB call.
957 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
958 no suitable context available.
960 \return pointer to ldb_context that should be free'd (using talloc_free())
961 at the end of the program.
963 struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev_ctx);
966 Connect to a database.
968 This is typically called soon after ldb_init(), and is required prior to
969 any search or database modification operations.
971 The URL can be one of the following forms:
977 \param ldb the context associated with the database (from ldb_init())
978 \param url the URL of the database to connect to, as noted above
979 \param flags a combination of LDB_FLG_* to modify the connection behaviour
980 \param options backend specific options - passed uninterpreted to the backend
982 \return result code (LDB_SUCCESS on success, or a failure code)
984 \note It is an error to connect to a database that does not exist in readonly mode
985 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
986 created if it does not exist.
989 typedef void (*ldb_async_timeout_fn) (void *);
990 typedef bool (*ldb_async_callback_fn) (void *);
991 typedef int (*ldb_async_ctx_add_op_fn)(void *, time_t, void *, ldb_async_timeout_fn, ldb_async_callback_fn);
992 typedef int (*ldb_async_ctx_wait_op_fn)(void *);
994 void ldb_async_ctx_set_private_data(struct ldb_context *ldb,
996 void ldb_async_ctx_set_add_op(struct ldb_context *ldb,
997 ldb_async_ctx_add_op_fn add_op);
998 void ldb_async_ctx_set_wait_op(struct ldb_context *ldb,
999 ldb_async_ctx_wait_op_fn wait_op);
1001 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
1004 return an automatic basedn from the rootDomainNamingContext of the rootDSE
1005 This value have been set in an opaque pointer at connection time
1007 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
1010 return an automatic basedn from the configurationNamingContext of the rootDSE
1011 This value have been set in an opaque pointer at connection time
1013 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
1016 return an automatic basedn from the schemaNamingContext of the rootDSE
1017 This value have been set in an opaque pointer at connection time
1019 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
1022 return an automatic baseDN from the defaultNamingContext of the rootDSE
1023 This value have been set in an opaque pointer at connection time
1025 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
1028 The default async search callback function
1030 \param req the request we are callback of
1031 \param ares a single reply from the async core
1033 \return result code (LDB_SUCCESS on success, or a failure code)
1035 \note this function expects req->context to always be an struct ldb_result pointer
1036 AND a talloc context, this function will steal on the context each message
1037 from the ares reply passed on by the async core so that in the end all the
1038 messages will be in the context (ldb_result) memory tree.
1039 Freeing the passed context (ldb_result tree) will free all the resources
1040 (the request need to be freed separately and the result doe not depend on the
1041 request that can be freed as sson as the search request is finished)
1044 int ldb_search_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1047 The default async extended operation callback function
1049 \param req the request we are callback of
1050 \param ares a single reply from the async core
1052 \return result code (LDB_SUCCESS on success, or a failure code)
1054 int ldb_op_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1056 int ldb_modify_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1059 Helper function to build a search request
1061 \param ret_req the request structure is returned here (talloced on mem_ctx)
1062 \param ldb the context associated with the database (from ldb_init())
1063 \param mem_ctx a talloc memory context (used as parent of ret_req)
1064 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1065 \param scope the search scope for the query
1066 \param expression the search expression to use for this query
1067 \param attrs the search attributes for the query (pass NULL if none required)
1068 \param controls an array of controls
1069 \param context the callback function context
1070 \param the callback function to handle the async replies
1071 \param the parent request if any
1073 \return result code (LDB_SUCCESS on success, or a failure code)
1076 int ldb_build_search_req(struct ldb_request **ret_req,
1077 struct ldb_context *ldb,
1078 TALLOC_CTX *mem_ctx,
1079 struct ldb_dn *base,
1080 enum ldb_scope scope,
1081 const char *expression,
1082 const char * const *attrs,
1083 struct ldb_control **controls,
1085 ldb_request_callback_t callback,
1086 struct ldb_request *parent);
1088 int ldb_build_search_req_ex(struct ldb_request **ret_req,
1089 struct ldb_context *ldb,
1090 TALLOC_CTX *mem_ctx,
1091 struct ldb_dn *base,
1092 enum ldb_scope scope,
1093 struct ldb_parse_tree *tree,
1094 const char * const *attrs,
1095 struct ldb_control **controls,
1097 ldb_request_callback_t callback,
1098 struct ldb_request *parent);
1101 Helper function to build an add request
1103 \param ret_req the request structure is returned here (talloced on mem_ctx)
1104 \param ldb the context associated with the database (from ldb_init())
1105 \param mem_ctx a talloc memory context (used as parent of ret_req)
1106 \param message contains the entry to be added
1107 \param controls an array of controls
1108 \param context the callback function context
1109 \param the callback function to handle the async replies
1110 \param the parent request if any
1112 \return result code (LDB_SUCCESS on success, or a failure code)
1115 int ldb_build_add_req(struct ldb_request **ret_req,
1116 struct ldb_context *ldb,
1117 TALLOC_CTX *mem_ctx,
1118 const struct ldb_message *message,
1119 struct ldb_control **controls,
1121 ldb_request_callback_t callback,
1122 struct ldb_request *parent);
1125 Helper function to build a modify request
1127 \param ret_req the request structure is returned here (talloced on mem_ctx)
1128 \param ldb the context associated with the database (from ldb_init())
1129 \param mem_ctx a talloc memory context (used as parent of ret_req)
1130 \param message contains the entry to be modified
1131 \param controls an array of controls
1132 \param context the callback function context
1133 \param the callback function to handle the async replies
1134 \param the parent request if any
1136 \return result code (LDB_SUCCESS on success, or a failure code)
1139 int ldb_build_mod_req(struct ldb_request **ret_req,
1140 struct ldb_context *ldb,
1141 TALLOC_CTX *mem_ctx,
1142 const struct ldb_message *message,
1143 struct ldb_control **controls,
1145 ldb_request_callback_t callback,
1146 struct ldb_request *parent);
1149 Helper function to build a delete request
1151 \param ret_req the request structure is returned here (talloced on mem_ctx)
1152 \param ldb the context associated with the database (from ldb_init())
1153 \param mem_ctx a talloc memory context (used as parent of ret_req)
1154 \param dn the DN to be deleted
1155 \param controls an array of controls
1156 \param context the callback function context
1157 \param the callback function to handle the async replies
1158 \param the parent request if any
1160 \return result code (LDB_SUCCESS on success, or a failure code)
1163 int ldb_build_del_req(struct ldb_request **ret_req,
1164 struct ldb_context *ldb,
1165 TALLOC_CTX *mem_ctx,
1167 struct ldb_control **controls,
1169 ldb_request_callback_t callback,
1170 struct ldb_request *parent);
1173 Helper function to build a rename request
1175 \param ret_req the request structure is returned here (talloced on mem_ctx)
1176 \param ldb the context associated with the database (from ldb_init())
1177 \param mem_ctx a talloc memory context (used as parent of ret_req)
1178 \param olddn the old DN
1179 \param newdn the new DN
1180 \param controls an array of controls
1181 \param context the callback function context
1182 \param the callback function to handle the async replies
1183 \param the parent request if any
1185 \return result code (LDB_SUCCESS on success, or a failure code)
1188 int ldb_build_rename_req(struct ldb_request **ret_req,
1189 struct ldb_context *ldb,
1190 TALLOC_CTX *mem_ctx,
1191 struct ldb_dn *olddn,
1192 struct ldb_dn *newdn,
1193 struct ldb_control **controls,
1195 ldb_request_callback_t callback,
1196 struct ldb_request *parent);
1199 Add a ldb_control to a ldb_request
1201 \param req the request struct where to add the control
1202 \param oid the object identifier of the control as string
1203 \param critical whether the control should be critical or not
1204 \param data a talloc pointer to the control specific data
1206 \return result code (LDB_SUCCESS on success, or a failure code)
1208 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1211 check if a control with the specified "oid" exist and return it
1212 \param req the request struct where to add the control
1213 \param oid the object identifier of the control as string
1215 \return the control, NULL if not found
1217 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid);
1220 check if a control with the specified "oid" exist and return it
1221 \param rep the reply struct where to add the control
1222 \param oid the object identifier of the control as string
1224 \return the control, NULL if not found
1226 struct ldb_control *ldb_reply_get_control(struct ldb_reply *rep, const char *oid);
1231 This function searches the database, and returns
1232 records that match an LDAP-like search expression
1234 \param ldb the context associated with the database (from ldb_init())
1235 \param mem_ctx the memory context to use for the request and the results
1236 \param result the return result
1237 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1238 \param scope the search scope for the query
1239 \param attrs the search attributes for the query (pass NULL if none required)
1240 \param exp_fmt the search expression to use for this query (printf like)
1242 \return result code (LDB_SUCCESS on success, or a failure code)
1244 \note use talloc_free() to free the ldb_result returned
1246 int ldb_search(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1247 struct ldb_result **result, struct ldb_dn *base,
1248 enum ldb_scope scope, const char * const *attrs,
1249 const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1252 Add a record to the database.
1254 This function adds a record to the database. This function will fail
1255 if a record with the specified class and key already exists in the
1258 \param ldb the context associated with the database (from
1260 \param message the message containing the record to add.
1262 \return result code (LDB_SUCCESS if the record was added, otherwise
1265 int ldb_add(struct ldb_context *ldb,
1266 const struct ldb_message *message);
1269 Modify the specified attributes of a record
1271 This function modifies a record that is in the database.
1273 \param ldb the context associated with the database (from
1275 \param message the message containing the changes required.
1277 \return result code (LDB_SUCCESS if the record was modified as
1278 requested, otherwise a failure code)
1280 int ldb_modify(struct ldb_context *ldb,
1281 const struct ldb_message *message);
1284 Rename a record in the database
1286 This function renames a record in the database.
1288 \param ldb the context associated with the database (from
1290 \param olddn the DN for the record to be renamed.
1291 \param newdn the new DN
1293 \return result code (LDB_SUCCESS if the record was renamed as
1294 requested, otherwise a failure code)
1296 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1299 Delete a record from the database
1301 This function deletes a record from the database.
1303 \param ldb the context associated with the database (from
1305 \param dn the DN for the record to be deleted.
1307 \return result code (LDB_SUCCESS if the record was deleted,
1308 otherwise a failure code)
1310 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1313 The default async extended operation callback function
1315 \param req the request we are callback of
1316 \param ares a single reply from the async core
1318 \return result code (LDB_SUCCESS on success, or a failure code)
1320 \note this function expects req->context to always be an struct ldb_result pointer
1321 AND a talloc context, this function will steal on the context each message
1322 from the ares reply passed on by the async core so that in the end all the
1323 messages will be in the context (ldb_result) memory tree.
1324 Freeing the passed context (ldb_result tree) will free all the resources
1325 (the request need to be freed separately and the result doe not depend on the
1326 request that can be freed as sson as the search request is finished)
1329 int ldb_extended_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1333 Helper function to build a extended request
1335 \param ret_req the request structure is returned here (talloced on mem_ctx)
1336 \param ldb the context associated with the database (from ldb_init())
1337 \param mem_ctx a talloc memory context (used as parent of ret_req)
1338 \param oid the OID of the extended operation.
1339 \param data a void pointer a the extended operation specific parameters,
1340 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1341 \param controls an array of controls
1342 \param context the callback function context
1343 \param the callback function to handle the async replies
1344 \param the parent request if any
1346 \return result code (LDB_SUCCESS on success, or a failure code)
1348 int ldb_build_extended_req(struct ldb_request **ret_req,
1349 struct ldb_context *ldb,
1350 TALLOC_CTX *mem_ctx,
1352 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1353 struct ldb_control **controls,
1355 ldb_request_callback_t callback,
1356 struct ldb_request *parent);
1359 call an extended operation
1361 This function deletes a record from the database.
1363 \param ldb the context associated with the database (from ldb_init())
1364 \param oid the OID of the extended operation.
1365 \param data a void pointer a the extended operation specific parameters,
1366 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1367 \param res the result of the extended operation
1369 \return result code (LDB_SUCCESS if the extended operation returned fine,
1370 otherwise a failure code)
1372 int ldb_extended(struct ldb_context *ldb,
1374 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1375 struct ldb_result **res);
1378 Obtain current/next database sequence number
1380 int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num);
1385 int ldb_transaction_start(struct ldb_context *ldb);
1388 first phase of two phase commit
1390 int ldb_transaction_prepare_commit(struct ldb_context *ldb);
1393 commit a transaction
1395 int ldb_transaction_commit(struct ldb_context *ldb);
1398 cancel a transaction
1400 int ldb_transaction_cancel(struct ldb_context *ldb);
1403 cancel a transaction with no error if no transaction is pending
1404 used when we fork() to clear any parent transactions
1406 int ldb_transaction_cancel_noerr(struct ldb_context *ldb);
1410 return extended error information from the last call
1412 const char *ldb_errstring(struct ldb_context *ldb);
1415 return a string explaining what a ldb error constant meancs
1417 const char *ldb_strerror(int ldb_err);
1420 setup the default utf8 functions
1421 FIXME: these functions do not yet handle utf8
1423 void ldb_set_utf8_default(struct ldb_context *ldb);
1428 \param ldb the ldb context
1429 \param mem_ctx the memory context to allocate the result string
1431 \param s the string that is to be folded
1432 \return a copy of the string, converted to upper case
1434 \note The default function is not yet UTF8 aware. Provide your own
1435 set of functions through ldb_set_utf8_fns()
1437 char *ldb_casefold(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s, size_t n);
1440 Check the attribute name is valid according to rfc2251
1441 \param s the string to check
1443 \return 1 if the name is ok
1445 int ldb_valid_attr_name(const char *s);
1448 ldif manipulation functions
1452 Write an LDIF message
1454 This function writes an LDIF message using a caller supplied write
1457 \param ldb the ldb context (from ldb_init())
1458 \param fprintf_fn a function pointer for the write function. This must take
1459 a private data pointer, followed by a format string, and then a variable argument
1461 \param private_data pointer that will be provided back to the write
1462 function. This is useful for maintaining state or context.
1463 \param ldif the message to write out
1465 \return the total number of bytes written, or an error code as returned
1466 from the write function.
1468 \sa ldb_ldif_write_file for a more convenient way to write to a
1471 \sa ldb_ldif_read for the reader equivalent to this function.
1473 int ldb_ldif_write(struct ldb_context *ldb,
1474 int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1476 const struct ldb_ldif *ldif);
1479 Clean up an LDIF message
1481 This function cleans up a LDIF message read using ldb_ldif_read()
1482 or related functions (such as ldb_ldif_read_string() and
1483 ldb_ldif_read_file().
1485 \param ldb the ldb context (from ldb_init())
1486 \param msg the message to clean up and free
1489 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1492 Read an LDIF message
1494 This function creates an LDIF message using a caller supplied read
1497 \param ldb the ldb context (from ldb_init())
1498 \param fgetc_fn a function pointer for the read function. This must
1499 take a private data pointer, and must return a pointer to an
1500 integer corresponding to the next byte read (or EOF if there is no
1501 more data to be read).
1502 \param private_data pointer that will be provided back to the read
1503 function. This is udeful for maintaining state or context.
1505 \return the LDIF message that has been read in
1507 \note You must free the LDIF message when no longer required, using
1508 ldb_ldif_read_free().
1510 \sa ldb_ldif_read_file for a more convenient way to read from a
1513 \sa ldb_ldif_read_string for a more convenient way to read from a
1514 string (char array).
1516 \sa ldb_ldif_write for the writer equivalent to this function.
1518 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1519 int (*fgetc_fn)(void *), void *private_data);
1522 Read an LDIF message from a file
1524 This function reads the next LDIF message from the contents of a
1525 file stream. If you want to get all of the LDIF messages, you will
1526 need to repeatedly call this function, until it returns NULL.
1528 \param ldb the ldb context (from ldb_init())
1529 \param f the file stream to read from (typically from fdopen())
1531 \sa ldb_ldif_read_string for an equivalent function that will read
1532 from a string (char array).
1534 \sa ldb_ldif_write_file for the writer equivalent to this function.
1537 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1540 Read an LDIF message from a string
1542 This function reads the next LDIF message from the contents of a char
1543 array. If you want to get all of the LDIF messages, you will need
1544 to repeatedly call this function, until it returns NULL.
1546 \param ldb the ldb context (from ldb_init())
1547 \param s pointer to the char array to read from
1549 \sa ldb_ldif_read_file for an equivalent function that will read
1552 \sa ldb_ldif_write for a more general (arbitrary read function)
1553 version of this function.
1555 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1558 Write an LDIF message to a file
1560 \param ldb the ldb context (from ldb_init())
1561 \param f the file stream to write to (typically from fdopen())
1562 \param msg the message to write out
1564 \return the total number of bytes written, or a negative error code
1566 \sa ldb_ldif_read_file for the reader equivalent to this function.
1568 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1571 Write an LDIF message to a string
1573 \param ldb the ldb context (from ldb_init())
1574 \param mem_ctx the talloc context on which to attach the string)
1575 \param msg the message to write out
1577 \return the string containing the LDIF, or NULL on error
1579 \sa ldb_ldif_read_string for the reader equivalent to this function.
1581 char * ldb_ldif_write_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1582 const struct ldb_ldif *msg);
1586 Produce a string form of an ldb message
1588 convenient function to turn a ldb_message into a string. Useful for
1591 char *ldb_ldif_message_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1592 enum ldb_changetype changetype,
1593 const struct ldb_message *msg);
1597 Base64 encode a buffer
1599 \param mem_ctx the memory context that the result is allocated
1601 \param buf pointer to the array that is to be encoded
1602 \param len the number of elements in the array to be encoded
1604 \return pointer to an array containing the encoded data
1606 \note The caller is responsible for freeing the result
1608 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len);
1611 Base64 decode a buffer
1613 This function decodes a base64 encoded string in place.
1615 \param s the string to decode.
1617 \return the length of the returned (decoded) string.
1619 \note the string is null terminated, but the null terminator is not
1620 included in the length.
1622 int ldb_base64_decode(char *s);
1624 /* The following definitions come from lib/ldb/common/ldb_dn.c */
1627 Get the linear form of a DN (without any extended components)
1629 \param dn The DN to linearize
1632 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1635 Allocate a copy of the linear form of a DN (without any extended components) onto the supplied memory context
1637 \param dn The DN to linearize
1638 \param mem_ctx TALLOC context to return result on
1641 char *ldb_dn_alloc_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1644 Get the linear form of a DN (with any extended components)
1646 \param mem_ctx TALLOC context to return result on
1647 \param dn The DN to linearize
1648 \param mode Style of extended DN to return (0 is HEX representation of binary form, 1 is a string form)
1650 char *ldb_dn_get_extended_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn, int mode);
1651 const struct ldb_val *ldb_dn_get_extended_component(struct ldb_dn *dn, const char *name);
1652 int ldb_dn_set_extended_component(struct ldb_dn *dn, const char *name, const struct ldb_val *val);
1653 void ldb_dn_extended_filter(struct ldb_dn *dn, const char * const *accept);
1654 void ldb_dn_remove_extended_components(struct ldb_dn *dn);
1655 bool ldb_dn_has_extended(struct ldb_dn *dn);
1657 int ldb_dn_extended_add_syntax(struct ldb_context *ldb,
1659 const struct ldb_dn_extended_syntax *syntax);
1662 Allocate a new DN from a string
1664 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1665 \param dn The new DN
1667 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1670 struct ldb_dn *ldb_dn_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn);
1672 Allocate a new DN from a printf style format string and arguments
1674 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1675 \param new_fms The new DN as a format string (plus arguments)
1677 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1680 struct ldb_dn *ldb_dn_new_fmt(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1682 Allocate a new DN from a struct ldb_val (useful to avoid buffer overrun)
1684 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1685 \param dn The new DN
1687 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1690 struct ldb_dn *ldb_dn_from_ldb_val(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const struct ldb_val *strdn);
1693 Determine if this DN is syntactically valid
1695 \param dn The DN to validate
1698 bool ldb_dn_validate(struct ldb_dn *dn);
1700 char *ldb_dn_escape_value(TALLOC_CTX *mem_ctx, struct ldb_val value);
1701 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1702 char *ldb_dn_alloc_casefold(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1704 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1705 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1707 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1708 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1709 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1710 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1711 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1712 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1714 struct ldb_dn *ldb_dn_copy(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1715 struct ldb_dn *ldb_dn_get_parent(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1716 char *ldb_dn_canonical_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1717 char *ldb_dn_canonical_ex_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1718 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1719 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1720 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1721 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1722 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1723 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1725 bool ldb_dn_is_valid(struct ldb_dn *dn);
1726 bool ldb_dn_is_special(struct ldb_dn *dn);
1727 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1728 bool ldb_dn_is_null(struct ldb_dn *dn);
1729 int ldb_dn_update_components(struct ldb_dn *dn, const struct ldb_dn *ref_dn);
1733 Compare two attributes
1735 This function compares to attribute names. Note that this is a
1736 case-insensitive comparison.
1738 \param a the first attribute name to compare
1739 \param b the second attribute name to compare
1741 \return 0 if the attribute names are the same, or only differ in
1742 case; non-zero if there are any differences
1744 attribute names are restricted by rfc2251 so using
1745 strcasecmp and toupper here is ok.
1748 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1749 char *ldb_attr_casefold(TALLOC_CTX *mem_ctx, const char *s);
1750 int ldb_attr_dn(const char *attr);
1753 Create an empty message
1755 \param mem_ctx the memory context to create in. You can pass NULL
1756 to get the top level context, however the ldb context (from
1757 ldb_init()) may be a better choice
1759 struct ldb_message *ldb_msg_new(TALLOC_CTX *mem_ctx);
1762 Find an element within an message
1764 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1765 const char *attr_name);
1768 Compare two ldb_val values
1770 \param v1 first ldb_val structure to be tested
1771 \param v2 second ldb_val structure to be tested
1773 \return 1 for a match, 0 if there is any difference
1775 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1778 find a value within an ldb_message_element
1780 \param el the element to search
1781 \param val the value to search for
1783 \note This search is case sensitive
1785 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1786 struct ldb_val *val);
1789 add a new empty element to a ldb_message
1791 int ldb_msg_add_empty(struct ldb_message *msg,
1792 const char *attr_name,
1794 struct ldb_message_element **return_el);
1797 add a element to a ldb_message
1799 int ldb_msg_add(struct ldb_message *msg,
1800 const struct ldb_message_element *el,
1802 int ldb_msg_add_value(struct ldb_message *msg,
1803 const char *attr_name,
1804 const struct ldb_val *val,
1805 struct ldb_message_element **return_el);
1806 int ldb_msg_add_steal_value(struct ldb_message *msg,
1807 const char *attr_name,
1808 struct ldb_val *val);
1809 int ldb_msg_add_steal_string(struct ldb_message *msg,
1810 const char *attr_name, char *str);
1811 int ldb_msg_add_string(struct ldb_message *msg,
1812 const char *attr_name, const char *str);
1813 int ldb_msg_add_linearized_dn(struct ldb_message *msg, const char *attr_name,
1815 int ldb_msg_add_fmt(struct ldb_message *msg,
1816 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1819 compare two message elements - return 0 on match
1821 int ldb_msg_element_compare(struct ldb_message_element *el1,
1822 struct ldb_message_element *el2);
1823 int ldb_msg_element_compare_name(struct ldb_message_element *el1,
1824 struct ldb_message_element *el2);
1827 Find elements in a message.
1829 This function finds elements and converts to a specific type, with
1830 a give default value if not found. Assumes that elements are
1833 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1834 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1835 const char *attr_name,
1837 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1838 const char *attr_name,
1839 unsigned int default_value);
1840 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1841 const char *attr_name,
1842 int64_t default_value);
1843 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1844 const char *attr_name,
1845 uint64_t default_value);
1846 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1847 const char *attr_name,
1848 double default_value);
1849 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1850 const char *attr_name,
1852 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1853 const char *attr_name,
1854 const char *default_value);
1856 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1857 TALLOC_CTX *mem_ctx,
1858 const struct ldb_message *msg,
1859 const char *attr_name);
1861 void ldb_msg_sort_elements(struct ldb_message *msg);
1863 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx,
1864 const struct ldb_message *msg);
1865 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx,
1866 const struct ldb_message *msg);
1869 * ldb_msg_canonicalize() is now depreciated
1870 * Please use ldb_msg_normalize() instead
1872 * NOTE: Returned ldb_message object is allocated
1873 * into *ldb's context. Callers are recommended
1874 * to steal the returned object into a TALLOC_CTX
1875 * with short lifetime.
1877 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1878 const struct ldb_message *msg) _DEPRECATED_;
1880 int ldb_msg_normalize(struct ldb_context *ldb,
1881 TALLOC_CTX *mem_ctx,
1882 const struct ldb_message *msg,
1883 struct ldb_message **_msg_out);
1887 * ldb_msg_diff() is now depreciated
1888 * Please use ldb_msg_difference() instead
1890 * NOTE: Returned ldb_message object is allocated
1891 * into *ldb's context. Callers are recommended
1892 * to steal the returned object into a TALLOC_CTX
1893 * with short lifetime.
1895 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1896 struct ldb_message *msg1,
1897 struct ldb_message *msg2) _DEPRECATED_;
1900 * return a ldb_message representing the differences between msg1 and msg2.
1901 * If you then use this in a ldb_modify() call,
1902 * it can be used to save edits to a message
1904 * Result message is constructed as follows:
1905 * - LDB_FLAG_MOD_ADD - elements found only in msg2
1906 * - LDB_FLAG_MOD_REPLACE - elements in msg2 that have
1907 * different value in msg1
1908 * Value for msg2 element is used
1909 * - LDB_FLAG_MOD_DELETE - elements found only in msg2
1911 * @return LDB_SUCCESS or LDB_ERR_OPERATIONS_ERROR
1913 int ldb_msg_difference(struct ldb_context *ldb,
1914 TALLOC_CTX *mem_ctx,
1915 struct ldb_message *msg1,
1916 struct ldb_message *msg2,
1917 struct ldb_message **_msg_out);
1920 Tries to find a certain string attribute in a message
1922 \param msg the message to check
1923 \param name attribute name
1924 \param value attribute value
1926 \return 1 on match and 0 otherwise.
1928 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1933 Integrity check an ldb_message
1935 This function performs basic sanity / integrity checks on an
1938 \param ldb context in which to perform the checks
1939 \param msg the message to check
1941 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1942 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1943 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1946 int ldb_msg_sanity_check(struct ldb_context *ldb,
1947 const struct ldb_message *msg);
1950 Duplicate an ldb_val structure
1952 This function copies an ldb value structure.
1954 \param mem_ctx the memory context that the duplicated value will be
1956 \param v the ldb_val to be duplicated.
1958 \return the duplicated ldb_val structure.
1960 struct ldb_val ldb_val_dup(TALLOC_CTX *mem_ctx, const struct ldb_val *v);
1963 this allows the user to set a debug function for error reporting
1965 int ldb_set_debug(struct ldb_context *ldb,
1966 void (*debug)(void *context, enum ldb_debug_level level,
1967 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1971 this allows the user to set custom utf8 function for error reporting
1973 void ldb_set_utf8_fns(struct ldb_context *ldb,
1975 char *(*casefold)(void *, void *, const char *, size_t n));
1978 this sets up debug to print messages on stderr
1980 int ldb_set_debug_stderr(struct ldb_context *ldb);
1982 /* control backend specific opaque values */
1983 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1984 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1986 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs);
1987 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr);
1988 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1990 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1991 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1992 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1993 void ldb_msg_remove_element(struct ldb_message *msg, struct ldb_message_element *el);
1996 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1998 const char *replace);
2001 shallow copy a tree - copying only the elements array so that the caller
2002 can safely add new elements without changing the message
2004 struct ldb_parse_tree *ldb_parse_tree_copy_shallow(TALLOC_CTX *mem_ctx,
2005 const struct ldb_parse_tree *ot);
2008 Convert a time structure to a string
2010 This function converts a time_t structure to an LDAP formatted
2011 GeneralizedTime string.
2013 \param mem_ctx the memory context to allocate the return string in
2014 \param t the time structure to convert
2016 \return the formatted string, or NULL if the time structure could
2019 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t);
2022 Convert a string to a time structure
2024 This function converts an LDAP formatted GeneralizedTime string
2025 to a time_t structure.
2027 \param s the string to convert
2029 \return the time structure, or 0 if the string cannot be converted
2031 time_t ldb_string_to_time(const char *s);
2034 convert a LDAP GeneralizedTime string in ldb_val format to a
2037 int ldb_val_to_time(const struct ldb_val *v, time_t *t);
2040 Convert a time structure to a string
2042 This function converts a time_t structure to an LDAP formatted
2045 \param mem_ctx the memory context to allocate the return string in
2046 \param t the time structure to convert
2048 \return the formatted string, or NULL if the time structure could
2051 char *ldb_timestring_utc(TALLOC_CTX *mem_ctx, time_t t);
2054 Convert a string to a time structure
2056 This function converts an LDAP formatted UTCTime string
2057 to a time_t structure.
2059 \param s the string to convert
2061 \return the time structure, or 0 if the string cannot be converted
2063 time_t ldb_string_utc_to_time(const char *s);
2066 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
2068 #ifndef discard_const
2069 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
2073 a wrapper around ldb_qsort() that ensures the comparison function is
2074 type safe. This will produce a compilation warning if the types
2077 #define LDB_TYPESAFE_QSORT(base, numel, opaque, comparison) \
2080 ldb_qsort(base, numel, sizeof((base)[0]), discard_const(opaque), (ldb_qsort_cmp_fn_t)comparison); \
2081 comparison(&((base)[0]), &((base)[1]), opaque); \
2085 /* allow ldb to also call TYPESAFE_QSORT() */
2086 #ifndef TYPESAFE_QSORT
2087 #define TYPESAFE_QSORT(base, numel, comparison) \
2090 qsort(base, numel, sizeof((base)[0]), (int (*)(const void *, const void *))comparison); \
2091 comparison(&((base)[0]), &((base)[1])); \
2099 Convert an array of string represention of a control into an array of ldb_control structures
2101 \param ldb LDB context
2102 \param mem_ctx TALLOC context to return result on, and to allocate error_string on
2103 \param control_strings Array of string-formatted controls
2105 \return array of ldb_control elements
2107 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings);
2110 return the ldb flags
2112 unsigned int ldb_get_flags(struct ldb_context *ldb);
2114 /* set the ldb flags */
2115 void ldb_set_flags(struct ldb_context *ldb, unsigned flags);
2118 struct ldb_dn *ldb_dn_binary_from_ldb_val(TALLOC_CTX *mem_ctx,
2119 struct ldb_context *ldb,
2120 const struct ldb_val *strdn);
2122 int ldb_dn_get_binary(struct ldb_dn *dn, struct ldb_val *val);
2123 int ldb_dn_set_binary(struct ldb_dn *dn, struct ldb_val *val);