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 /* opaque ldb_dn structures, see ldb_dn.c for internals */
92 struct ldb_dn_component;
96 There are a number of flags that are used with ldap_modify() in
97 ldb_message_element.flags fields. The LDA_FLAGS_MOD_ADD,
98 LDA_FLAGS_MOD_DELETE and LDA_FLAGS_MOD_REPLACE flags are used in
99 ldap_modify() calls to specify whether attributes are being added,
100 deleted or modified respectively.
102 #define LDB_FLAG_MOD_MASK 0x3
105 Flag value used in ldap_modify() to indicate that attributes are
108 \sa LDB_FLAG_MOD_MASK
110 #define LDB_FLAG_MOD_ADD 1
113 Flag value used in ldap_modify() to indicate that attributes are
116 \sa LDB_FLAG_MOD_MASK
118 #define LDB_FLAG_MOD_REPLACE 2
121 Flag value used in ldap_modify() to indicate that attributes are
124 \sa LDB_FLAG_MOD_MASK
126 #define LDB_FLAG_MOD_DELETE 3
129 OID for logic AND comaprison.
131 This is the well known object ID for a logical AND comparitor.
133 #define LDB_OID_COMPARATOR_AND "1.2.840.113556.1.4.803"
136 OID for logic OR comparison.
138 This is the well known object ID for a logical OR comparitor.
140 #define LDB_OID_COMPARATOR_OR "1.2.840.113556.1.4.804"
143 results are given back as arrays of ldb_message_element
145 struct ldb_message_element {
148 unsigned int num_values;
149 struct ldb_val *values;
154 a ldb_message represents all or part of a record. It can contain an arbitrary
159 unsigned int num_elements;
160 struct ldb_message_element *elements;
163 enum ldb_changetype {
164 LDB_CHANGETYPE_NONE=0,
166 LDB_CHANGETYPE_DELETE,
167 LDB_CHANGETYPE_MODIFY
173 This structure contains a LDIF record, as returned from ldif_read()
174 and equivalent functions.
177 enum ldb_changetype changetype; /*!< The type of change */
178 struct ldb_message *msg; /*!< The changes */
181 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
183 LDB_SCOPE_ONELEVEL=1,
184 LDB_SCOPE_SUBTREE=2};
187 struct tevent_context;
189 /* debugging uses one of the following levels */
190 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
191 LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
194 the user can optionally supply a debug function. The function
195 is based on the vfprintf() style of interface, but with the addition
198 struct ldb_debug_ops {
199 void (*debug)(void *context, enum ldb_debug_level level,
200 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
205 The user can optionally supply a custom utf8 functions,
206 to handle comparisons and casefolding.
208 struct ldb_utf8_fns {
210 char *(*casefold)(void *context, TALLOC_CTX *mem_ctx, const char *s, size_t n);
214 Flag value for database connection mode.
216 If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
217 opened read-only, if possible.
219 #define LDB_FLG_RDONLY 1
222 Flag value for database connection mode.
224 If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
225 opened without synchronous operations, if possible.
227 #define LDB_FLG_NOSYNC 2
230 Flag value to specify autoreconnect mode.
232 If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
233 be opened in a way that makes it try to auto reconnect if the
234 connection is dropped (actually make sense only with ldap).
236 #define LDB_FLG_RECONNECT 4
239 Flag to tell backends not to use mmap
241 #define LDB_FLG_NOMMAP 8
244 structures for ldb_parse_tree handling code
246 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
247 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
248 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
249 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
251 struct ldb_parse_tree {
252 enum ldb_parse_op operation;
255 struct ldb_parse_tree *child;
259 struct ldb_val value;
263 int start_with_wildcard;
264 int end_with_wildcard;
265 struct ldb_val **chunks;
272 struct ldb_val value;
278 struct ldb_val value;
281 unsigned int num_elements;
282 struct ldb_parse_tree **elements;
287 struct ldb_parse_tree *ldb_parse_tree(TALLOC_CTX *mem_ctx, const char *s);
288 char *ldb_filter_from_tree(TALLOC_CTX *mem_ctx, struct ldb_parse_tree *tree);
293 This function encodes a binary blob using the encoding rules in RFC
294 2254 (Section 4). This function also escapes any non-printable
297 \param mem_ctx the memory context to allocate the return string in.
298 \param val the (potentially) binary data to be encoded
300 \return the encoded data as a null terminated string
302 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
304 char *ldb_binary_encode(TALLOC_CTX *mem_ctx, struct ldb_val val);
309 This function encodes a string using the encoding rules in RFC 2254
310 (Section 4). This function also escapes any non-printable
313 \param mem_ctx the memory context to allocate the return string in.
314 \param string the string to be encoded
316 \return the encoded data as a null terminated string
318 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
320 char *ldb_binary_encode_string(TALLOC_CTX *mem_ctx, const char *string);
323 functions for controlling attribute handling
325 typedef int (*ldb_attr_handler_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, struct ldb_val *);
326 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, const struct ldb_val *);
329 attribute handler structure
331 attr -> The attribute name
332 ldif_read_fn -> convert from ldif to binary format
333 ldif_write_fn -> convert from binary to ldif format
334 canonicalise_fn -> canonicalise a value, for use by indexing and dn construction
335 comparison_fn -> compare two values
338 struct ldb_schema_syntax {
340 ldb_attr_handler_t ldif_read_fn;
341 ldb_attr_handler_t ldif_write_fn;
342 ldb_attr_handler_t canonicalise_fn;
343 ldb_attr_comparison_t comparison_fn;
346 struct ldb_schema_attribute {
349 const struct ldb_schema_syntax *syntax;
352 const struct ldb_schema_attribute *ldb_schema_attribute_by_name(struct ldb_context *ldb,
355 struct ldb_dn_extended_syntax {
357 ldb_attr_handler_t read_fn;
358 ldb_attr_handler_t write_clear_fn;
359 ldb_attr_handler_t write_hex_fn;
362 const struct ldb_dn_extended_syntax *ldb_dn_extended_syntax_by_name(struct ldb_context *ldb,
366 The attribute is not returned by default
368 #define LDB_ATTR_FLAG_HIDDEN (1<<0)
370 /* the attribute handler name should be freed when released */
371 #define LDB_ATTR_FLAG_ALLOCATED (1<<1)
374 The attribute is supplied by the application and should not be removed
376 #define LDB_ATTR_FLAG_FIXED (1<<2)
379 LDAP attribute syntax for a DN
381 This is the well-known LDAP attribute syntax for a DN.
383 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
385 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
388 LDAP attribute syntax for a Directory String
390 This is the well-known LDAP attribute syntax for a Directory String.
392 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
394 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
397 LDAP attribute syntax for an integer
399 This is the well-known LDAP attribute syntax for an integer.
401 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
403 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
406 LDAP attribute syntax for an octet string
408 This is the well-known LDAP attribute syntax for an octet string.
410 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
412 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
415 LDAP attribute syntax for UTC time.
417 This is the well-known LDAP attribute syntax for a UTC time.
419 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
421 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
423 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
425 /* sorting helpers */
426 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
429 OID for the paged results control. This control is included in the
430 searchRequest and searchResultDone messages as part of the controls
431 field of the LDAPMessage, as defined in Section 4.1.12 of
434 \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
436 #define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
439 OID for specifying the returned elements of the ntSecurityDescriptor
441 \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>
443 #define LDB_CONTROL_SD_FLAGS_OID "1.2.840.113556.1.4.801"
446 OID for specifying an advanced scope for the search (one partition)
448 \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>
450 #define LDB_CONTROL_DOMAIN_SCOPE_OID "1.2.840.113556.1.4.1339"
453 OID for specifying an advanced scope for a search
455 \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>
457 #define LDB_CONTROL_SEARCH_OPTIONS_OID "1.2.840.113556.1.4.1340"
462 \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>
464 #define LDB_CONTROL_NOTIFICATION_OID "1.2.840.113556.1.4.528"
467 OID for getting deleted objects
469 \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>
471 #define LDB_CONTROL_SHOW_DELETED_OID "1.2.840.113556.1.4.417"
476 \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>
478 #define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
481 OID for LDAP server sort result extension.
483 This control is included in the searchRequest message as part of
484 the controls field of the LDAPMessage, as defined in Section 4.1.12
485 of LDAP v3. The controlType is set to
486 "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
487 FALSE (where absent is also equivalent to FALSE) at the client's
490 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
492 #define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
495 OID for LDAP server sort result response extension.
497 This control is included in the searchResultDone message as part of
498 the controls field of the LDAPMessage, as defined in Section 4.1.12 of
501 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
503 #define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
506 OID for LDAP Attribute Scoped Query extension.
508 This control is included in SearchRequest or SearchResponse
509 messages as part of the controls field of the LDAPMessage.
511 #define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
514 OID for LDAP Directory Sync extension.
516 This control is included in SearchRequest or SearchResponse
517 messages as part of the controls field of the LDAPMessage.
519 #define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
523 OID for LDAP Virtual List View Request extension.
525 This control is included in SearchRequest messages
526 as part of the controls field of the LDAPMessage.
528 #define LDB_CONTROL_VLV_REQ_OID "2.16.840.1.113730.3.4.9"
531 OID for LDAP Virtual List View Response extension.
533 This control is included in SearchResponse messages
534 as part of the controls field of the LDAPMessage.
536 #define LDB_CONTROL_VLV_RESP_OID "2.16.840.1.113730.3.4.10"
539 OID to let modifies don't give an error when adding an existing
540 attribute with the same value or deleting an nonexisting one attribute
542 \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>
544 #define LDB_CONTROL_PERMISSIVE_MODIFY_OID "1.2.840.113556.1.4.1413"
547 OID for LDAP Extended Operation START_TLS.
549 This Extended operation is used to start a new TLS
550 channel on top of a clear text channel.
552 #define LDB_EXTENDED_START_TLS_OID "1.3.6.1.4.1.1466.20037"
556 #define LDB_EXTENDED_DYNAMIC_OID "1.3.6.1.4.1.1466.101.119.1"
560 #define LDB_EXTENDED_FAST_BIND_OID "1.2.840.113556.1.4.1781"
562 struct ldb_sd_flags_control {
564 * request the owner 0x00000001
565 * request the group 0x00000002
566 * request the DACL 0x00000004
567 * request the SACL 0x00000008
569 unsigned secinfo_flags;
573 * DOMAIN_SCOPE 0x00000001
574 * this limits the search to one partition,
575 * and no referrals will be returned.
576 * (Note this doesn't limit the entries by there
577 * objectSid belonging to a domain! Builtin and Foreign Sids
578 * are still returned)
580 * PHANTOM_ROOT 0x00000002
581 * this search on the whole tree on a domain controller
582 * over multiple partitions without referrals.
583 * (This is the default behavior on the Global Catalog Port)
586 #define LDB_SEARCH_OPTION_DOMAIN_SCOPE 0x00000001
587 #define LDB_SEARCH_OPTION_PHANTOM_ROOT 0x00000002
589 struct ldb_search_options_control {
590 unsigned search_options;
593 struct ldb_paged_control {
599 struct ldb_extended_dn_control {
603 struct ldb_server_sort_control {
609 struct ldb_sort_resp_control {
614 struct ldb_asq_control {
616 char *source_attribute;
621 struct ldb_dirsync_control {
628 struct ldb_vlv_req_control {
646 struct ldb_vlv_resp_control {
660 enum ldb_request_type {
667 LDB_REQ_REGISTER_CONTROL,
668 LDB_REQ_REGISTER_PARTITION
671 enum ldb_reply_type {
688 struct ldb_extended {
690 void *data; /* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
693 #define LDB_EXTENDED_SEQUENCE_NUMBER "1.3.6.1.4.1.7165.4.4.3"
695 enum ldb_sequence_type {
697 LDB_SEQ_HIGHEST_TIMESTAMP,
701 #define LDB_SEQ_GLOBAL_SEQUENCE 0x01
702 #define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
704 struct ldb_seqnum_request {
705 enum ldb_sequence_type type;
708 struct ldb_seqnum_result {
715 struct ldb_message **msgs;
716 struct ldb_extended *extended;
717 struct ldb_control **controls;
723 enum ldb_reply_type type;
724 struct ldb_message *message;
725 struct ldb_extended *response;
726 struct ldb_control **controls;
735 enum ldb_scope scope;
736 struct ldb_parse_tree *tree;
737 const char * const *attrs;
738 struct ldb_result *res;
742 const struct ldb_message *message;
746 const struct ldb_message *message;
754 struct ldb_dn *olddn;
755 struct ldb_dn *newdn;
758 struct ldb_register_control {
762 struct ldb_register_partition {
766 typedef int (*ldb_request_callback_t)(struct ldb_request *, struct ldb_reply *);
770 enum ldb_request_type operation;
773 struct ldb_search search;
775 struct ldb_modify mod;
776 struct ldb_delete del;
777 struct ldb_rename rename;
778 struct ldb_extended extended;
779 struct ldb_register_control reg_control;
780 struct ldb_register_partition reg_partition;
783 struct ldb_control **controls;
786 ldb_request_callback_t callback;
790 struct ldb_handle *handle;
793 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
794 int ldb_request_done(struct ldb_request *req, int status);
795 bool ldb_request_is_done(struct ldb_request *req);
797 int ldb_modules_wait(struct ldb_handle *handle);
798 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
800 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
801 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
802 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
803 void ldb_set_modules_dir(struct ldb_context *ldb, const char *path);
804 struct tevent_context;
805 void ldb_set_event_context(struct ldb_context *ldb, struct tevent_context *ev);
806 struct tevent_context * ldb_get_event_context(struct ldb_context *ldb);
809 Initialise ldbs' global information
811 This is required before any other LDB call
813 \return 0 if initialisation succeeded, -1 otherwise
815 int ldb_global_init(void);
818 Initialise an ldb context
820 This is required before any other LDB call.
822 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
823 no suitable context available.
825 \return pointer to ldb_context that should be free'd (using talloc_free())
826 at the end of the program.
828 struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev_ctx);
831 Connect to a database.
833 This is typically called soon after ldb_init(), and is required prior to
834 any search or database modification operations.
836 The URL can be one of the following forms:
842 \param ldb the context associated with the database (from ldb_init())
843 \param url the URL of the database to connect to, as noted above
844 \param flags a combination of LDB_FLG_* to modify the connection behaviour
845 \param options backend specific options - passed uninterpreted to the backend
847 \return result code (LDB_SUCCESS on success, or a failure code)
849 \note It is an error to connect to a database that does not exist in readonly mode
850 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
851 created if it does not exist.
854 typedef void (*ldb_async_timeout_fn) (void *);
855 typedef bool (*ldb_async_callback_fn) (void *);
856 typedef int (*ldb_async_ctx_add_op_fn)(void *, time_t, void *, ldb_async_timeout_fn, ldb_async_callback_fn);
857 typedef int (*ldb_async_ctx_wait_op_fn)(void *);
859 void ldb_async_ctx_set_private_data(struct ldb_context *ldb,
861 void ldb_async_ctx_set_add_op(struct ldb_context *ldb,
862 ldb_async_ctx_add_op_fn add_op);
863 void ldb_async_ctx_set_wait_op(struct ldb_context *ldb,
864 ldb_async_ctx_wait_op_fn wait_op);
866 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
869 return an automatic basedn from the rootDomainNamingContext of the rootDSE
870 This value have been set in an opaque pointer at connection time
872 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
875 return an automatic basedn from the configurationNamingContext of the rootDSE
876 This value have been set in an opaque pointer at connection time
878 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
881 return an automatic basedn from the schemaNamingContext of the rootDSE
882 This value have been set in an opaque pointer at connection time
884 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
887 return an automatic baseDN from the defaultNamingContext of the rootDSE
888 This value have been set in an opaque pointer at connection time
890 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
893 The default async search callback function
895 \param req the request we are callback of
896 \param ares a single reply from the async core
898 \return result code (LDB_SUCCESS on success, or a failure code)
900 \note this function expects req->context to always be an struct ldb_result pointer
901 AND a talloc context, this function will steal on the context each message
902 from the ares reply passed on by the async core so that in the end all the
903 messages will be in the context (ldb_result) memory tree.
904 Freeing the passed context (ldb_result tree) will free all the resources
905 (the request need to be freed separately and the result doe not depend on the
906 request that can be freed as sson as the search request is finished)
909 int ldb_search_default_callback(struct ldb_request *req, struct ldb_reply *ares);
912 The default async extended operation callback function
914 \param req the request we are callback of
915 \param ares a single reply from the async core
917 \return result code (LDB_SUCCESS on success, or a failure code)
919 int ldb_op_default_callback(struct ldb_request *req, struct ldb_reply *ares);
923 Helper function to build a search request
925 \param ret_req the request structure is returned here (talloced on mem_ctx)
926 \param ldb the context associated with the database (from ldb_init())
927 \param mem_ctx a talloc memory context (used as parent of ret_req)
928 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
929 \param scope the search scope for the query
930 \param expression the search expression to use for this query
931 \param attrs the search attributes for the query (pass NULL if none required)
932 \param controls an array of controls
933 \param context the callback function context
934 \param the callback function to handle the async replies
935 \param the parent request if any
937 \return result code (LDB_SUCCESS on success, or a failure code)
940 int ldb_build_search_req(struct ldb_request **ret_req,
941 struct ldb_context *ldb,
944 enum ldb_scope scope,
945 const char *expression,
946 const char * const *attrs,
947 struct ldb_control **controls,
949 ldb_request_callback_t callback,
950 struct ldb_request *parent);
952 int ldb_build_search_req_ex(struct ldb_request **ret_req,
953 struct ldb_context *ldb,
956 enum ldb_scope scope,
957 struct ldb_parse_tree *tree,
958 const char * const *attrs,
959 struct ldb_control **controls,
961 ldb_request_callback_t callback,
962 struct ldb_request *parent);
965 Helper function to build an add request
967 \param ret_req the request structure is returned here (talloced on mem_ctx)
968 \param ldb the context associated with the database (from ldb_init())
969 \param mem_ctx a talloc memory context (used as parent of ret_req)
970 \param message contains the entry to be added
971 \param controls an array of controls
972 \param context the callback function context
973 \param the callback function to handle the async replies
974 \param the parent request if any
976 \return result code (LDB_SUCCESS on success, or a failure code)
979 int ldb_build_add_req(struct ldb_request **ret_req,
980 struct ldb_context *ldb,
982 const struct ldb_message *message,
983 struct ldb_control **controls,
985 ldb_request_callback_t callback,
986 struct ldb_request *parent);
989 Helper function to build a modify request
991 \param ret_req the request structure is returned here (talloced on mem_ctx)
992 \param ldb the context associated with the database (from ldb_init())
993 \param mem_ctx a talloc memory context (used as parent of ret_req)
994 \param message contains the entry to be modified
995 \param controls an array of controls
996 \param context the callback function context
997 \param the callback function to handle the async replies
998 \param the parent request if any
1000 \return result code (LDB_SUCCESS on success, or a failure code)
1003 int ldb_build_mod_req(struct ldb_request **ret_req,
1004 struct ldb_context *ldb,
1005 TALLOC_CTX *mem_ctx,
1006 const struct ldb_message *message,
1007 struct ldb_control **controls,
1009 ldb_request_callback_t callback,
1010 struct ldb_request *parent);
1013 Helper function to build a delete request
1015 \param ret_req the request structure is returned here (talloced on mem_ctx)
1016 \param ldb the context associated with the database (from ldb_init())
1017 \param mem_ctx a talloc memory context (used as parent of ret_req)
1018 \param dn the DN to be deleted
1019 \param controls an array of controls
1020 \param context the callback function context
1021 \param the callback function to handle the async replies
1022 \param the parent request if any
1024 \return result code (LDB_SUCCESS on success, or a failure code)
1027 int ldb_build_del_req(struct ldb_request **ret_req,
1028 struct ldb_context *ldb,
1029 TALLOC_CTX *mem_ctx,
1031 struct ldb_control **controls,
1033 ldb_request_callback_t callback,
1034 struct ldb_request *parent);
1037 Helper function to build a rename request
1039 \param ret_req the request structure is returned here (talloced on mem_ctx)
1040 \param ldb the context associated with the database (from ldb_init())
1041 \param mem_ctx a talloc memory context (used as parent of ret_req)
1042 \param olddn the old DN
1043 \param newdn the new DN
1044 \param controls an array of controls
1045 \param context the callback function context
1046 \param the callback function to handle the async replies
1047 \param the parent request if any
1049 \return result code (LDB_SUCCESS on success, or a failure code)
1052 int ldb_build_rename_req(struct ldb_request **ret_req,
1053 struct ldb_context *ldb,
1054 TALLOC_CTX *mem_ctx,
1055 struct ldb_dn *olddn,
1056 struct ldb_dn *newdn,
1057 struct ldb_control **controls,
1059 ldb_request_callback_t callback,
1060 struct ldb_request *parent);
1063 Add a ldb_control to a ldb_request
1065 \param req the request struct where to add the control
1066 \param oid the object identifier of the control as string
1067 \param critical whether the control should be critical or not
1068 \param data a talloc pointer to the control specific data
1070 \return result code (LDB_SUCCESS on success, or a failure code)
1072 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1075 check if a control with the specified "oid" exist and return it
1076 \param req the request struct where to add the control
1077 \param oid the object identifier of the control as string
1079 \return the control, NULL if not found
1081 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid);
1084 check if a control with the specified "oid" exist and return it
1085 \param rep the reply struct where to add the control
1086 \param oid the object identifier of the control as string
1088 \return the control, NULL if not found
1090 struct ldb_control *ldb_reply_get_control(struct ldb_reply *rep, const char *oid);
1095 This function searches the database, and returns
1096 records that match an LDAP-like search expression
1098 \param ldb the context associated with the database (from ldb_init())
1099 \param mem_ctx the memory context to use for the request and the results
1100 \param result the return result
1101 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1102 \param scope the search scope for the query
1103 \param attrs the search attributes for the query (pass NULL if none required)
1104 \param exp_fmt the search expression to use for this query (printf like)
1106 \return result code (LDB_SUCCESS on success, or a failure code)
1108 \note use talloc_free() to free the ldb_result returned
1110 int ldb_search(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1111 struct ldb_result **result, struct ldb_dn *base,
1112 enum ldb_scope scope, const char * const *attrs,
1113 const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1116 Add a record to the database.
1118 This function adds a record to the database. This function will fail
1119 if a record with the specified class and key already exists in the
1122 \param ldb the context associated with the database (from
1124 \param message the message containing the record to add.
1126 \return result code (LDB_SUCCESS if the record was added, otherwise
1129 int ldb_add(struct ldb_context *ldb,
1130 const struct ldb_message *message);
1133 Modify the specified attributes of a record
1135 This function modifies a record that is in the database.
1137 \param ldb the context associated with the database (from
1139 \param message the message containing the changes required.
1141 \return result code (LDB_SUCCESS if the record was modified as
1142 requested, otherwise a failure code)
1144 int ldb_modify(struct ldb_context *ldb,
1145 const struct ldb_message *message);
1148 Rename a record in the database
1150 This function renames a record in the database.
1152 \param ldb the context associated with the database (from
1154 \param olddn the DN for the record to be renamed.
1155 \param newdn the new DN
1157 \return result code (LDB_SUCCESS if the record was renamed as
1158 requested, otherwise a failure code)
1160 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1163 Delete a record from the database
1165 This function deletes a record from the database.
1167 \param ldb the context associated with the database (from
1169 \param dn the DN for the record to be deleted.
1171 \return result code (LDB_SUCCESS if the record was deleted,
1172 otherwise a failure code)
1174 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1177 The default async extended operation callback function
1179 \param req the request we are callback of
1180 \param ares a single reply from the async core
1182 \return result code (LDB_SUCCESS on success, or a failure code)
1184 \note this function expects req->context to always be an struct ldb_result pointer
1185 AND a talloc context, this function will steal on the context each message
1186 from the ares reply passed on by the async core so that in the end all the
1187 messages will be in the context (ldb_result) memory tree.
1188 Freeing the passed context (ldb_result tree) will free all the resources
1189 (the request need to be freed separately and the result doe not depend on the
1190 request that can be freed as sson as the search request is finished)
1193 int ldb_extended_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1197 Helper function to build a extended request
1199 \param ret_req the request structure is returned here (talloced on mem_ctx)
1200 \param ldb the context associated with the database (from ldb_init())
1201 \param mem_ctx a talloc memory context (used as parent of ret_req)
1202 \param oid the OID of the extended operation.
1203 \param data a void pointer a the extended operation specific parameters,
1204 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1205 \param controls an array of controls
1206 \param context the callback function context
1207 \param the callback function to handle the async replies
1208 \param the parent request if any
1210 \return result code (LDB_SUCCESS on success, or a failure code)
1212 int ldb_build_extended_req(struct ldb_request **ret_req,
1213 struct ldb_context *ldb,
1214 TALLOC_CTX *mem_ctx,
1216 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1217 struct ldb_control **controls,
1219 ldb_request_callback_t callback,
1220 struct ldb_request *parent);
1223 call an extended operation
1225 This function deletes a record from the database.
1227 \param ldb the context associated with the database (from ldb_init())
1228 \param oid the OID of the extended operation.
1229 \param data a void pointer a the extended operation specific parameters,
1230 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1231 \param res the result of the extended operation
1233 \return result code (LDB_SUCCESS if the extended operation returned fine,
1234 otherwise a failure code)
1236 int ldb_extended(struct ldb_context *ldb,
1238 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1239 struct ldb_result **res);
1242 Obtain current/next database sequence number
1244 int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num);
1249 int ldb_transaction_start(struct ldb_context *ldb);
1252 commit a transaction
1254 int ldb_transaction_commit(struct ldb_context *ldb);
1257 cancel a transaction
1259 int ldb_transaction_cancel(struct ldb_context *ldb);
1263 return extended error information from the last call
1265 const char *ldb_errstring(struct ldb_context *ldb);
1268 return a string explaining what a ldb error constant meancs
1270 const char *ldb_strerror(int ldb_err);
1273 setup the default utf8 functions
1274 FIXME: these functions do not yet handle utf8
1276 void ldb_set_utf8_default(struct ldb_context *ldb);
1281 \param ldb the ldb context
1282 \param mem_ctx the memory context to allocate the result string
1284 \param s the string that is to be folded
1285 \return a copy of the string, converted to upper case
1287 \note The default function is not yet UTF8 aware. Provide your own
1288 set of functions through ldb_set_utf8_fns()
1290 char *ldb_casefold(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s, size_t n);
1293 Check the attribute name is valid according to rfc2251
1294 \param s the string to check
1296 \return 1 if the name is ok
1298 int ldb_valid_attr_name(const char *s);
1301 ldif manipulation functions
1305 Write an LDIF message
1307 This function writes an LDIF message using a caller supplied write
1310 \param ldb the ldb context (from ldb_init())
1311 \param fprintf_fn a function pointer for the write function. This must take
1312 a private data pointer, followed by a format string, and then a variable argument
1314 \param private_data pointer that will be provided back to the write
1315 function. This is useful for maintaining state or context.
1316 \param ldif the message to write out
1318 \return the total number of bytes written, or an error code as returned
1319 from the write function.
1321 \sa ldb_ldif_write_file for a more convenient way to write to a
1324 \sa ldb_ldif_read for the reader equivalent to this function.
1326 int ldb_ldif_write(struct ldb_context *ldb,
1327 int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1329 const struct ldb_ldif *ldif);
1332 Clean up an LDIF message
1334 This function cleans up a LDIF message read using ldb_ldif_read()
1335 or related functions (such as ldb_ldif_read_string() and
1336 ldb_ldif_read_file().
1338 \param ldb the ldb context (from ldb_init())
1339 \param msg the message to clean up and free
1342 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1345 Read an LDIF message
1347 This function creates an LDIF message using a caller supplied read
1350 \param ldb the ldb context (from ldb_init())
1351 \param fgetc_fn a function pointer for the read function. This must
1352 take a private data pointer, and must return a pointer to an
1353 integer corresponding to the next byte read (or EOF if there is no
1354 more data to be read).
1355 \param private_data pointer that will be provided back to the read
1356 function. This is udeful for maintaining state or context.
1358 \return the LDIF message that has been read in
1360 \note You must free the LDIF message when no longer required, using
1361 ldb_ldif_read_free().
1363 \sa ldb_ldif_read_file for a more convenient way to read from a
1366 \sa ldb_ldif_read_string for a more convenient way to read from a
1367 string (char array).
1369 \sa ldb_ldif_write for the writer equivalent to this function.
1371 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1372 int (*fgetc_fn)(void *), void *private_data);
1375 Read an LDIF message from a file
1377 This function reads the next LDIF message from the contents of a
1378 file stream. If you want to get all of the LDIF messages, you will
1379 need to repeatedly call this function, until it returns NULL.
1381 \param ldb the ldb context (from ldb_init())
1382 \param f the file stream to read from (typically from fdopen())
1384 \sa ldb_ldif_read_string for an equivalent function that will read
1385 from a string (char array).
1387 \sa ldb_ldif_write_file for the writer equivalent to this function.
1390 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1393 Read an LDIF message from a string
1395 This function reads the next LDIF message from the contents of a char
1396 array. If you want to get all of the LDIF messages, you will need
1397 to repeatedly call this function, until it returns NULL.
1399 \param ldb the ldb context (from ldb_init())
1400 \param s pointer to the char array to read from
1402 \sa ldb_ldif_read_file for an equivalent function that will read
1405 \sa ldb_ldif_write for a more general (arbitrary read function)
1406 version of this function.
1408 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1411 Write an LDIF message to a file
1413 \param ldb the ldb context (from ldb_init())
1414 \param f the file stream to write to (typically from fdopen())
1415 \param msg the message to write out
1417 \return the total number of bytes written, or a negative error code
1419 \sa ldb_ldif_read_file for the reader equivalent to this function.
1421 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1424 Base64 encode a buffer
1426 \param mem_ctx the memory context that the result is allocated
1428 \param buf pointer to the array that is to be encoded
1429 \param len the number of elements in the array to be encoded
1431 \return pointer to an array containing the encoded data
1433 \note The caller is responsible for freeing the result
1435 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len);
1438 Base64 decode a buffer
1440 This function decodes a base64 encoded string in place.
1442 \param s the string to decode.
1444 \return the length of the returned (decoded) string.
1446 \note the string is null terminated, but the null terminator is not
1447 included in the length.
1449 int ldb_base64_decode(char *s);
1451 /* The following definitions come from lib/ldb/common/ldb_dn.c */
1454 Get the linear form of a DN (without any extended components)
1456 \param dn The DN to linearize
1459 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1462 Allocate a copy of the linear form of a DN (without any extended components) onto the supplied memory context
1464 \param dn The DN to linearize
1465 \param mem_ctx TALLOC context to return result on
1468 char *ldb_dn_alloc_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1471 Get the linear form of a DN (with any extended components)
1473 \param mem_ctx TALLOC context to return result on
1474 \param dn The DN to linearize
1475 \param mode Style of extended DN to return (0 is HEX representation of binary form, 1 is a string form)
1477 char *ldb_dn_get_extended_linearized(void *mem_ctx, struct ldb_dn *dn, int mode);
1478 const struct ldb_val *ldb_dn_get_extended_component(struct ldb_dn *dn, const char *name);
1479 int ldb_dn_set_extended_component(struct ldb_dn *dn, const char *name, const struct ldb_val *val);
1481 void ldb_dn_remove_extended_components(struct ldb_dn *dn);
1482 bool ldb_dn_has_extended(struct ldb_dn *dn);
1484 int ldb_dn_extended_add_syntax(struct ldb_context *ldb,
1486 const struct ldb_dn_extended_syntax *syntax);
1489 Allocate a new DN from a string
1491 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1492 \param dn The new DN
1494 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1497 struct ldb_dn *ldb_dn_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn);
1499 Allocate a new DN from a printf style format string and arguments
1501 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1502 \param new_fms The new DN as a format string (plus arguments)
1504 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1507 struct ldb_dn *ldb_dn_new_fmt(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1509 Allocate a new DN from a struct ldb_val (useful to avoid buffer overrun)
1511 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1512 \param dn The new DN
1514 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1517 struct ldb_dn *ldb_dn_from_ldb_val(void *mem_ctx, struct ldb_context *ldb, const struct ldb_val *strdn);
1520 Determine if this DN is syntactically valid
1522 \param dn The DN to validate
1525 bool ldb_dn_validate(struct ldb_dn *dn);
1527 char *ldb_dn_escape_value(TALLOC_CTX *mem_ctx, struct ldb_val value);
1528 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1529 char *ldb_dn_alloc_casefold(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1531 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1532 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1534 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1535 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1536 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1537 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1538 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1539 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1541 struct ldb_dn *ldb_dn_copy(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1542 struct ldb_dn *ldb_dn_get_parent(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1543 char *ldb_dn_canonical_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1544 char *ldb_dn_canonical_ex_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1545 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1546 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1547 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1548 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1549 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1550 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1552 bool ldb_dn_is_valid(struct ldb_dn *dn);
1553 bool ldb_dn_is_special(struct ldb_dn *dn);
1554 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1555 bool ldb_dn_is_null(struct ldb_dn *dn);
1559 Compare two attributes
1561 This function compares to attribute names. Note that this is a
1562 case-insensitive comparison.
1564 \param a the first attribute name to compare
1565 \param b the second attribute name to compare
1567 \return 0 if the attribute names are the same, or only differ in
1568 case; non-zero if there are any differences
1570 attribute names are restricted by rfc2251 so using
1571 strcasecmp and toupper here is ok.
1574 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1575 char *ldb_attr_casefold(TALLOC_CTX *mem_ctx, const char *s);
1576 int ldb_attr_dn(const char *attr);
1579 Create an empty message
1581 \param mem_ctx the memory context to create in. You can pass NULL
1582 to get the top level context, however the ldb context (from
1583 ldb_init()) may be a better choice
1585 struct ldb_message *ldb_msg_new(TALLOC_CTX *mem_ctx);
1588 Find an element within an message
1590 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1591 const char *attr_name);
1594 Compare two ldb_val values
1596 \param v1 first ldb_val structure to be tested
1597 \param v2 second ldb_val structure to be tested
1599 \return 1 for a match, 0 if there is any difference
1601 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1604 find a value within an ldb_message_element
1606 \param el the element to search
1607 \param val the value to search for
1609 \note This search is case sensitive
1611 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1612 struct ldb_val *val);
1615 add a new empty element to a ldb_message
1617 int ldb_msg_add_empty(struct ldb_message *msg,
1618 const char *attr_name,
1620 struct ldb_message_element **return_el);
1623 add a element to a ldb_message
1625 int ldb_msg_add(struct ldb_message *msg,
1626 const struct ldb_message_element *el,
1628 int ldb_msg_add_value(struct ldb_message *msg,
1629 const char *attr_name,
1630 const struct ldb_val *val,
1631 struct ldb_message_element **return_el);
1632 int ldb_msg_add_steal_value(struct ldb_message *msg,
1633 const char *attr_name,
1634 struct ldb_val *val);
1635 int ldb_msg_add_steal_string(struct ldb_message *msg,
1636 const char *attr_name, char *str);
1637 int ldb_msg_add_string(struct ldb_message *msg,
1638 const char *attr_name, const char *str);
1639 int ldb_msg_add_fmt(struct ldb_message *msg,
1640 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1643 compare two message elements - return 0 on match
1645 int ldb_msg_element_compare(struct ldb_message_element *el1,
1646 struct ldb_message_element *el2);
1647 int ldb_msg_element_compare_name(struct ldb_message_element *el1,
1648 struct ldb_message_element *el2);
1651 Find elements in a message.
1653 This function finds elements and converts to a specific type, with
1654 a give default value if not found. Assumes that elements are
1657 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1658 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1659 const char *attr_name,
1661 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1662 const char *attr_name,
1663 unsigned int default_value);
1664 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1665 const char *attr_name,
1666 int64_t default_value);
1667 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1668 const char *attr_name,
1669 uint64_t default_value);
1670 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1671 const char *attr_name,
1672 double default_value);
1673 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1674 const char *attr_name,
1676 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1677 const char *attr_name,
1678 const char *default_value);
1680 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1681 TALLOC_CTX *mem_ctx,
1682 const struct ldb_message *msg,
1683 const char *attr_name);
1685 void ldb_msg_sort_elements(struct ldb_message *msg);
1687 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx,
1688 const struct ldb_message *msg);
1689 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx,
1690 const struct ldb_message *msg);
1692 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1693 const struct ldb_message *msg);
1696 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1697 struct ldb_message *msg1,
1698 struct ldb_message *msg2);
1700 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1705 Integrity check an ldb_message
1707 This function performs basic sanity / integrity checks on an
1710 \param ldb context in which to perform the checks
1711 \param msg the message to check
1713 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1714 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1715 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1718 int ldb_msg_sanity_check(struct ldb_context *ldb,
1719 const struct ldb_message *msg);
1722 Duplicate an ldb_val structure
1724 This function copies an ldb value structure.
1726 \param mem_ctx the memory context that the duplicated value will be
1728 \param v the ldb_val to be duplicated.
1730 \return the duplicated ldb_val structure.
1732 struct ldb_val ldb_val_dup(TALLOC_CTX *mem_ctx, const struct ldb_val *v);
1735 this allows the user to set a debug function for error reporting
1737 int ldb_set_debug(struct ldb_context *ldb,
1738 void (*debug)(void *context, enum ldb_debug_level level,
1739 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1743 this allows the user to set custom utf8 function for error reporting
1745 void ldb_set_utf8_fns(struct ldb_context *ldb,
1747 char *(*casefold)(void *, void *, const char *, size_t n));
1750 this sets up debug to print messages on stderr
1752 int ldb_set_debug_stderr(struct ldb_context *ldb);
1754 /* control backend specific opaque values */
1755 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1756 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1758 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs);
1759 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr);
1760 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1762 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1763 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1764 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1765 void ldb_msg_remove_element(struct ldb_message *msg, struct ldb_message_element *el);
1768 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1770 const char *replace);
1774 Convert a time structure to a string
1776 This function converts a time_t structure to an LDAP formatted
1777 GeneralizedTime string.
1779 \param mem_ctx the memory context to allocate the return string in
1780 \param t the time structure to convert
1782 \return the formatted string, or NULL if the time structure could
1785 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t);
1788 Convert a string to a time structure
1790 This function converts an LDAP formatted GeneralizedTime string
1791 to a time_t structure.
1793 \param s the string to convert
1795 \return the time structure, or 0 if the string cannot be converted
1797 time_t ldb_string_to_time(const char *s);
1800 Convert a time structure to a string
1802 This function converts a time_t structure to an LDAP formatted
1805 \param mem_ctx the memory context to allocate the return string in
1806 \param t the time structure to convert
1808 \return the formatted string, or NULL if the time structure could
1811 char *ldb_timestring_utc(TALLOC_CTX *mem_ctx, time_t t);
1814 Convert a string to a time structure
1816 This function converts an LDAP formatted UTCTime string
1817 to a time_t structure.
1819 \param s the string to convert
1821 \return the time structure, or 0 if the string cannot be converted
1823 time_t ldb_string_utc_to_time(const char *s);
1826 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1830 Convert an array of string represention of a control into an array of ldb_control structures
1832 \param ldb LDB context
1833 \param mem_ctx TALLOC context to return result on, and to allocate error_string on
1834 \param control_strings Array of string-formatted controls
1836 \return array of ldb_control elements
1838 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings);