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 */
61 #include "ldb_errors.h"
64 major restrictions as compared to normal LDAP:
66 - each record must have a unique key field
67 - the key must be representable as a NULL terminated C string and may not
68 contain a comma or braces
70 major restrictions as compared to tdb:
72 - no explicit locking calls, but we have transactions when using ldb_tdb
80 An individual lump of data in a result comes in this format. The
81 pointer will usually be to a UTF-8 string if the application is
82 sensible, but it can be to anything you like, including binary data
83 blobs of arbitrary size.
85 \note the data is null (0x00) terminated, but the length does not
86 include the terminator.
89 uint8_t *data; /*!< result data */
90 size_t length; /*!< length of data */
94 /*! \cond DOXYGEN_IGNORE */
95 #ifndef PRINTF_ATTRIBUTE
96 #define PRINTF_ATTRIBUTE(a,b)
100 /* opaque ldb_dn structures, see ldb_dn.c for internals */
101 struct ldb_dn_component;
105 There are a number of flags that are used with ldap_modify() in
106 ldb_message_element.flags fields. The LDA_FLAGS_MOD_ADD,
107 LDA_FLAGS_MOD_DELETE and LDA_FLAGS_MOD_REPLACE flags are used in
108 ldap_modify() calls to specify whether attributes are being added,
109 deleted or modified respectively.
111 #define LDB_FLAG_MOD_MASK 0x3
114 Flag value used in ldap_modify() to indicate that attributes are
117 \sa LDB_FLAG_MOD_MASK
119 #define LDB_FLAG_MOD_ADD 1
122 Flag value used in ldap_modify() to indicate that attributes are
125 \sa LDB_FLAG_MOD_MASK
127 #define LDB_FLAG_MOD_REPLACE 2
130 Flag value used in ldap_modify() to indicate that attributes are
133 \sa LDB_FLAG_MOD_MASK
135 #define LDB_FLAG_MOD_DELETE 3
138 OID for logic AND comaprison.
140 This is the well known object ID for a logical AND comparitor.
142 #define LDB_OID_COMPARATOR_AND "1.2.840.113556.1.4.803"
145 OID for logic OR comparison.
147 This is the well known object ID for a logical OR comparitor.
149 #define LDB_OID_COMPARATOR_OR "1.2.840.113556.1.4.804"
152 results are given back as arrays of ldb_message_element
154 struct ldb_message_element {
157 unsigned int num_values;
158 struct ldb_val *values;
163 a ldb_message represents all or part of a record. It can contain an arbitrary
168 unsigned int num_elements;
169 struct ldb_message_element *elements;
172 enum ldb_changetype {
173 LDB_CHANGETYPE_NONE=0,
175 LDB_CHANGETYPE_DELETE,
176 LDB_CHANGETYPE_MODIFY
182 This structure contains a LDIF record, as returned from ldif_read()
183 and equivalent functions.
186 enum ldb_changetype changetype; /*!< The type of change */
187 struct ldb_message *msg; /*!< The changes */
190 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
192 LDB_SCOPE_ONELEVEL=1,
193 LDB_SCOPE_SUBTREE=2};
196 struct tevent_context;
198 /* debugging uses one of the following levels */
199 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
200 LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
203 the user can optionally supply a debug function. The function
204 is based on the vfprintf() style of interface, but with the addition
207 struct ldb_debug_ops {
208 void (*debug)(void *context, enum ldb_debug_level level,
209 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
214 The user can optionally supply a custom utf8 functions,
215 to handle comparisons and casefolding.
217 struct ldb_utf8_fns {
219 char *(*casefold)(void *context, TALLOC_CTX *mem_ctx, const char *s, size_t n);
223 Flag value for database connection mode.
225 If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
226 opened read-only, if possible.
228 #define LDB_FLG_RDONLY 1
231 Flag value for database connection mode.
233 If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
234 opened without synchronous operations, if possible.
236 #define LDB_FLG_NOSYNC 2
239 Flag value to specify autoreconnect mode.
241 If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
242 be opened in a way that makes it try to auto reconnect if the
243 connection is dropped (actually make sense only with ldap).
245 #define LDB_FLG_RECONNECT 4
248 Flag to tell backends not to use mmap
250 #define LDB_FLG_NOMMAP 8
253 structures for ldb_parse_tree handling code
255 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
256 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
257 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
258 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
260 struct ldb_parse_tree {
261 enum ldb_parse_op operation;
264 struct ldb_parse_tree *child;
268 struct ldb_val value;
272 int start_with_wildcard;
273 int end_with_wildcard;
274 struct ldb_val **chunks;
281 struct ldb_val value;
287 struct ldb_val value;
290 unsigned int num_elements;
291 struct ldb_parse_tree **elements;
296 struct ldb_parse_tree *ldb_parse_tree(TALLOC_CTX *mem_ctx, const char *s);
297 char *ldb_filter_from_tree(TALLOC_CTX *mem_ctx, struct ldb_parse_tree *tree);
302 This function encodes a binary blob using the encoding rules in RFC
303 2254 (Section 4). This function also escapes any non-printable
306 \param mem_ctx the memory context to allocate the return string in.
307 \param val the (potentially) binary data to be encoded
309 \return the encoded data as a null terminated string
311 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
313 char *ldb_binary_encode(TALLOC_CTX *mem_ctx, struct ldb_val val);
318 This function encodes a string using the encoding rules in RFC 2254
319 (Section 4). This function also escapes any non-printable
322 \param mem_ctx the memory context to allocate the return string in.
323 \param string the string to be encoded
325 \return the encoded data as a null terminated string
327 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
329 char *ldb_binary_encode_string(TALLOC_CTX *mem_ctx, const char *string);
332 functions for controlling attribute handling
334 typedef int (*ldb_attr_handler_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, struct ldb_val *);
335 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, const struct ldb_val *);
338 attribute handler structure
340 attr -> The attribute name
341 ldif_read_fn -> convert from ldif to binary format
342 ldif_write_fn -> convert from binary to ldif format
343 canonicalise_fn -> canonicalise a value, for use by indexing and dn construction
344 comparison_fn -> compare two values
347 struct ldb_schema_syntax {
349 ldb_attr_handler_t ldif_read_fn;
350 ldb_attr_handler_t ldif_write_fn;
351 ldb_attr_handler_t canonicalise_fn;
352 ldb_attr_comparison_t comparison_fn;
355 struct ldb_schema_attribute {
358 const struct ldb_schema_syntax *syntax;
361 const struct ldb_schema_attribute *ldb_schema_attribute_by_name(struct ldb_context *ldb,
364 struct ldb_dn_extended_syntax {
366 ldb_attr_handler_t read_fn;
367 ldb_attr_handler_t write_clear_fn;
368 ldb_attr_handler_t write_hex_fn;
371 const struct ldb_dn_extended_syntax *ldb_dn_extended_syntax_by_name(struct ldb_context *ldb,
375 The attribute is not returned by default
377 #define LDB_ATTR_FLAG_HIDDEN (1<<0)
379 /* the attribute handler name should be freed when released */
380 #define LDB_ATTR_FLAG_ALLOCATED (1<<1)
383 The attribute is supplied by the application and should not be removed
385 #define LDB_ATTR_FLAG_FIXED (1<<2)
388 LDAP attribute syntax for a DN
390 This is the well-known LDAP attribute syntax for a DN.
392 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
394 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
397 LDAP attribute syntax for a Directory String
399 This is the well-known LDAP attribute syntax for a Directory String.
401 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
403 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
406 LDAP attribute syntax for an integer
408 This is the well-known LDAP attribute syntax for an integer.
410 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
412 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
415 LDAP attribute syntax for an octet string
417 This is the well-known LDAP attribute syntax for an octet string.
419 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
421 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
424 LDAP attribute syntax for UTC time.
426 This is the well-known LDAP attribute syntax for a UTC time.
428 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
430 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
432 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
434 /* sorting helpers */
435 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
438 OID for the paged results control. This control is included in the
439 searchRequest and searchResultDone messages as part of the controls
440 field of the LDAPMessage, as defined in Section 4.1.12 of
443 \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
445 #define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
448 OID for specifying the returned elements of the ntSecurityDescriptor
450 \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>
452 #define LDB_CONTROL_SD_FLAGS_OID "1.2.840.113556.1.4.801"
455 OID for specifying an advanced scope for the search (one partition)
457 \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>
459 #define LDB_CONTROL_DOMAIN_SCOPE_OID "1.2.840.113556.1.4.1339"
462 OID for specifying an advanced scope for a search
464 \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>
466 #define LDB_CONTROL_SEARCH_OPTIONS_OID "1.2.840.113556.1.4.1340"
471 \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>
473 #define LDB_CONTROL_NOTIFICATION_OID "1.2.840.113556.1.4.528"
476 OID for getting deleted objects
478 \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>
480 #define LDB_CONTROL_SHOW_DELETED_OID "1.2.840.113556.1.4.417"
485 \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>
487 #define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
490 OID for LDAP server sort result extension.
492 This control is included in the searchRequest message as part of
493 the controls field of the LDAPMessage, as defined in Section 4.1.12
494 of LDAP v3. The controlType is set to
495 "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
496 FALSE (where absent is also equivalent to FALSE) at the client's
499 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
501 #define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
504 OID for LDAP server sort result response extension.
506 This control is included in the searchResultDone message as part of
507 the controls field of the LDAPMessage, as defined in Section 4.1.12 of
510 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
512 #define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
515 OID for LDAP Attribute Scoped Query extension.
517 This control is included in SearchRequest or SearchResponse
518 messages as part of the controls field of the LDAPMessage.
520 #define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
523 OID for LDAP Directory Sync extension.
525 This control is included in SearchRequest or SearchResponse
526 messages as part of the controls field of the LDAPMessage.
528 #define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
532 OID for LDAP Virtual List View Request extension.
534 This control is included in SearchRequest messages
535 as part of the controls field of the LDAPMessage.
537 #define LDB_CONTROL_VLV_REQ_OID "2.16.840.1.113730.3.4.9"
540 OID for LDAP Virtual List View Response extension.
542 This control is included in SearchResponse messages
543 as part of the controls field of the LDAPMessage.
545 #define LDB_CONTROL_VLV_RESP_OID "2.16.840.1.113730.3.4.10"
548 OID to let modifies don't give an error when adding an existing
549 attribute with the same value or deleting an nonexisting one attribute
551 \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>
553 #define LDB_CONTROL_PERMISSIVE_MODIFY_OID "1.2.840.113556.1.4.1413"
556 OID for LDAP Extended Operation START_TLS.
558 This Extended operation is used to start a new TLS
559 channel on top of a clear text channel.
561 #define LDB_EXTENDED_START_TLS_OID "1.3.6.1.4.1.1466.20037"
565 #define LDB_EXTENDED_DYNAMIC_OID "1.3.6.1.4.1.1466.101.119.1"
569 #define LDB_EXTENDED_FAST_BIND_OID "1.2.840.113556.1.4.1781"
571 struct ldb_sd_flags_control {
573 * request the owner 0x00000001
574 * request the group 0x00000002
575 * request the DACL 0x00000004
576 * request the SACL 0x00000008
578 unsigned secinfo_flags;
582 * DOMAIN_SCOPE 0x00000001
583 * this limits the search to one partition,
584 * and no referrals will be returned.
585 * (Note this doesn't limit the entries by there
586 * objectSid belonging to a domain! Builtin and Foreign Sids
587 * are still returned)
589 * PHANTOM_ROOT 0x00000002
590 * this search on the whole tree on a domain controller
591 * over multiple partitions without referrals.
592 * (This is the default behavior on the Global Catalog Port)
595 #define LDB_SEARCH_OPTION_DOMAIN_SCOPE 0x00000001
596 #define LDB_SEARCH_OPTION_PHANTOM_ROOT 0x00000002
598 struct ldb_search_options_control {
599 unsigned search_options;
602 struct ldb_paged_control {
608 struct ldb_extended_dn_control {
612 struct ldb_server_sort_control {
618 struct ldb_sort_resp_control {
623 struct ldb_asq_control {
625 char *source_attribute;
630 struct ldb_dirsync_control {
637 struct ldb_vlv_req_control {
655 struct ldb_vlv_resp_control {
669 enum ldb_request_type {
676 LDB_REQ_REGISTER_CONTROL,
677 LDB_REQ_REGISTER_PARTITION
680 enum ldb_reply_type {
697 struct ldb_extended {
699 void *data; /* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
702 #define LDB_EXTENDED_SEQUENCE_NUMBER "1.3.6.1.4.1.7165.4.4.3"
704 enum ldb_sequence_type {
706 LDB_SEQ_HIGHEST_TIMESTAMP,
710 #define LDB_SEQ_GLOBAL_SEQUENCE 0x01
711 #define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
713 struct ldb_seqnum_request {
714 enum ldb_sequence_type type;
717 struct ldb_seqnum_result {
724 struct ldb_message **msgs;
725 struct ldb_extended *extended;
726 struct ldb_control **controls;
732 enum ldb_reply_type type;
733 struct ldb_message *message;
734 struct ldb_extended *response;
735 struct ldb_control **controls;
744 enum ldb_scope scope;
745 struct ldb_parse_tree *tree;
746 const char * const *attrs;
747 struct ldb_result *res;
751 const struct ldb_message *message;
755 const struct ldb_message *message;
763 struct ldb_dn *olddn;
764 struct ldb_dn *newdn;
767 struct ldb_register_control {
771 struct ldb_register_partition {
775 typedef int (*ldb_request_callback_t)(struct ldb_request *, struct ldb_reply *);
779 enum ldb_request_type operation;
782 struct ldb_search search;
784 struct ldb_modify mod;
785 struct ldb_delete del;
786 struct ldb_rename rename;
787 struct ldb_extended extended;
788 struct ldb_register_control reg_control;
789 struct ldb_register_partition reg_partition;
792 struct ldb_control **controls;
795 ldb_request_callback_t callback;
799 struct ldb_handle *handle;
802 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
803 int ldb_request_done(struct ldb_request *req, int status);
804 bool ldb_request_is_done(struct ldb_request *req);
806 int ldb_modules_wait(struct ldb_handle *handle);
807 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
809 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
810 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
811 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
812 void ldb_set_modules_dir(struct ldb_context *ldb, const char *path);
813 struct tevent_context;
814 void ldb_set_event_context(struct ldb_context *ldb, struct tevent_context *ev);
815 struct tevent_context * ldb_get_event_context(struct ldb_context *ldb);
818 Initialise ldbs' global information
820 This is required before any other LDB call
822 \return 0 if initialisation succeeded, -1 otherwise
824 int ldb_global_init(void);
827 Initialise an ldb context
829 This is required before any other LDB call.
831 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
832 no suitable context available.
834 \return pointer to ldb_context that should be free'd (using talloc_free())
835 at the end of the program.
837 struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev_ctx);
840 Connect to a database.
842 This is typically called soon after ldb_init(), and is required prior to
843 any search or database modification operations.
845 The URL can be one of the following forms:
851 \param ldb the context associated with the database (from ldb_init())
852 \param url the URL of the database to connect to, as noted above
853 \param flags a combination of LDB_FLG_* to modify the connection behaviour
854 \param options backend specific options - passed uninterpreted to the backend
856 \return result code (LDB_SUCCESS on success, or a failure code)
858 \note It is an error to connect to a database that does not exist in readonly mode
859 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
860 created if it does not exist.
863 typedef void (*ldb_async_timeout_fn) (void *);
864 typedef bool (*ldb_async_callback_fn) (void *);
865 typedef int (*ldb_async_ctx_add_op_fn)(void *, time_t, void *, ldb_async_timeout_fn, ldb_async_callback_fn);
866 typedef int (*ldb_async_ctx_wait_op_fn)(void *);
868 void ldb_async_ctx_set_private_data(struct ldb_context *ldb,
870 void ldb_async_ctx_set_add_op(struct ldb_context *ldb,
871 ldb_async_ctx_add_op_fn add_op);
872 void ldb_async_ctx_set_wait_op(struct ldb_context *ldb,
873 ldb_async_ctx_wait_op_fn wait_op);
875 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
878 return an automatic basedn from the rootDomainNamingContext of the rootDSE
879 This value have been set in an opaque pointer at connection time
881 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
884 return an automatic basedn from the configurationNamingContext of the rootDSE
885 This value have been set in an opaque pointer at connection time
887 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
890 return an automatic basedn from the schemaNamingContext of the rootDSE
891 This value have been set in an opaque pointer at connection time
893 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
896 return an automatic baseDN from the defaultNamingContext of the rootDSE
897 This value have been set in an opaque pointer at connection time
899 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
902 The default async search callback function
904 \param req the request we are callback of
905 \param ares a single reply from the async core
907 \return result code (LDB_SUCCESS on success, or a failure code)
909 \note this function expects req->context to always be an struct ldb_result pointer
910 AND a talloc context, this function will steal on the context each message
911 from the ares reply passed on by the async core so that in the end all the
912 messages will be in the context (ldb_result) memory tree.
913 Freeing the passed context (ldb_result tree) will free all the resources
914 (the request need to be freed separately and the result doe not depend on the
915 request that can be freed as sson as the search request is finished)
918 int ldb_search_default_callback(struct ldb_request *req, struct ldb_reply *ares);
921 The default async extended operation callback function
923 \param req the request we are callback of
924 \param ares a single reply from the async core
926 \return result code (LDB_SUCCESS on success, or a failure code)
928 int ldb_op_default_callback(struct ldb_request *req, struct ldb_reply *ares);
932 Helper function to build a search request
934 \param ret_req the request structure is returned here (talloced on mem_ctx)
935 \param ldb the context associated with the database (from ldb_init())
936 \param mem_ctx a talloc memory context (used as parent of ret_req)
937 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
938 \param scope the search scope for the query
939 \param expression the search expression to use for this query
940 \param attrs the search attributes for the query (pass NULL if none required)
941 \param controls an array of controls
942 \param context the callback function context
943 \param the callback function to handle the async replies
944 \param the parent request if any
946 \return result code (LDB_SUCCESS on success, or a failure code)
949 int ldb_build_search_req(struct ldb_request **ret_req,
950 struct ldb_context *ldb,
953 enum ldb_scope scope,
954 const char *expression,
955 const char * const *attrs,
956 struct ldb_control **controls,
958 ldb_request_callback_t callback,
959 struct ldb_request *parent);
961 int ldb_build_search_req_ex(struct ldb_request **ret_req,
962 struct ldb_context *ldb,
965 enum ldb_scope scope,
966 struct ldb_parse_tree *tree,
967 const char * const *attrs,
968 struct ldb_control **controls,
970 ldb_request_callback_t callback,
971 struct ldb_request *parent);
974 Helper function to build an add request
976 \param ret_req the request structure is returned here (talloced on mem_ctx)
977 \param ldb the context associated with the database (from ldb_init())
978 \param mem_ctx a talloc memory context (used as parent of ret_req)
979 \param message contains the entry to be added
980 \param controls an array of controls
981 \param context the callback function context
982 \param the callback function to handle the async replies
983 \param the parent request if any
985 \return result code (LDB_SUCCESS on success, or a failure code)
988 int ldb_build_add_req(struct ldb_request **ret_req,
989 struct ldb_context *ldb,
991 const struct ldb_message *message,
992 struct ldb_control **controls,
994 ldb_request_callback_t callback,
995 struct ldb_request *parent);
998 Helper function to build a modify request
1000 \param ret_req the request structure is returned here (talloced on mem_ctx)
1001 \param ldb the context associated with the database (from ldb_init())
1002 \param mem_ctx a talloc memory context (used as parent of ret_req)
1003 \param message contains the entry to be modified
1004 \param controls an array of controls
1005 \param context the callback function context
1006 \param the callback function to handle the async replies
1007 \param the parent request if any
1009 \return result code (LDB_SUCCESS on success, or a failure code)
1012 int ldb_build_mod_req(struct ldb_request **ret_req,
1013 struct ldb_context *ldb,
1014 TALLOC_CTX *mem_ctx,
1015 const struct ldb_message *message,
1016 struct ldb_control **controls,
1018 ldb_request_callback_t callback,
1019 struct ldb_request *parent);
1022 Helper function to build a delete request
1024 \param ret_req the request structure is returned here (talloced on mem_ctx)
1025 \param ldb the context associated with the database (from ldb_init())
1026 \param mem_ctx a talloc memory context (used as parent of ret_req)
1027 \param dn the DN to be deleted
1028 \param controls an array of controls
1029 \param context the callback function context
1030 \param the callback function to handle the async replies
1031 \param the parent request if any
1033 \return result code (LDB_SUCCESS on success, or a failure code)
1036 int ldb_build_del_req(struct ldb_request **ret_req,
1037 struct ldb_context *ldb,
1038 TALLOC_CTX *mem_ctx,
1040 struct ldb_control **controls,
1042 ldb_request_callback_t callback,
1043 struct ldb_request *parent);
1046 Helper function to build a rename request
1048 \param ret_req the request structure is returned here (talloced on mem_ctx)
1049 \param ldb the context associated with the database (from ldb_init())
1050 \param mem_ctx a talloc memory context (used as parent of ret_req)
1051 \param olddn the old DN
1052 \param newdn the new DN
1053 \param controls an array of controls
1054 \param context the callback function context
1055 \param the callback function to handle the async replies
1056 \param the parent request if any
1058 \return result code (LDB_SUCCESS on success, or a failure code)
1061 int ldb_build_rename_req(struct ldb_request **ret_req,
1062 struct ldb_context *ldb,
1063 TALLOC_CTX *mem_ctx,
1064 struct ldb_dn *olddn,
1065 struct ldb_dn *newdn,
1066 struct ldb_control **controls,
1068 ldb_request_callback_t callback,
1069 struct ldb_request *parent);
1072 Add a ldb_control to a ldb_request
1074 \param req the request struct where to add the control
1075 \param oid the object identifier of the control as string
1076 \param critical whether the control should be critical or not
1077 \param data a talloc pointer to the control specific data
1079 \return result code (LDB_SUCCESS on success, or a failure code)
1081 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1084 check if a control with the specified "oid" exist and return it
1085 \param req the request 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_request_get_control(struct ldb_request *req, const char *oid);
1093 check if a control with the specified "oid" exist and return it
1094 \param rep the reply struct where to add the control
1095 \param oid the object identifier of the control as string
1097 \return the control, NULL if not found
1099 struct ldb_control *ldb_reply_get_control(struct ldb_reply *rep, const char *oid);
1104 This function searches the database, and returns
1105 records that match an LDAP-like search expression
1107 \param ldb the context associated with the database (from ldb_init())
1108 \param mem_ctx the memory context to use for the request and the results
1109 \param result the return result
1110 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1111 \param scope the search scope for the query
1112 \param attrs the search attributes for the query (pass NULL if none required)
1113 \param exp_fmt the search expression to use for this query (printf like)
1115 \return result code (LDB_SUCCESS on success, or a failure code)
1117 \note use talloc_free() to free the ldb_result returned
1119 int ldb_search(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1120 struct ldb_result **result, struct ldb_dn *base,
1121 enum ldb_scope scope, const char * const *attrs,
1122 const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1125 Add a record to the database.
1127 This function adds a record to the database. This function will fail
1128 if a record with the specified class and key already exists in the
1131 \param ldb the context associated with the database (from
1133 \param message the message containing the record to add.
1135 \return result code (LDB_SUCCESS if the record was added, otherwise
1138 int ldb_add(struct ldb_context *ldb,
1139 const struct ldb_message *message);
1142 Modify the specified attributes of a record
1144 This function modifies a record that is in the database.
1146 \param ldb the context associated with the database (from
1148 \param message the message containing the changes required.
1150 \return result code (LDB_SUCCESS if the record was modified as
1151 requested, otherwise a failure code)
1153 int ldb_modify(struct ldb_context *ldb,
1154 const struct ldb_message *message);
1157 Rename a record in the database
1159 This function renames a record in the database.
1161 \param ldb the context associated with the database (from
1163 \param olddn the DN for the record to be renamed.
1164 \param newdn the new DN
1166 \return result code (LDB_SUCCESS if the record was renamed as
1167 requested, otherwise a failure code)
1169 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1172 Delete a record from the database
1174 This function deletes a record from the database.
1176 \param ldb the context associated with the database (from
1178 \param dn the DN for the record to be deleted.
1180 \return result code (LDB_SUCCESS if the record was deleted,
1181 otherwise a failure code)
1183 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1186 The default async extended operation callback function
1188 \param req the request we are callback of
1189 \param ares a single reply from the async core
1191 \return result code (LDB_SUCCESS on success, or a failure code)
1193 \note this function expects req->context to always be an struct ldb_result pointer
1194 AND a talloc context, this function will steal on the context each message
1195 from the ares reply passed on by the async core so that in the end all the
1196 messages will be in the context (ldb_result) memory tree.
1197 Freeing the passed context (ldb_result tree) will free all the resources
1198 (the request need to be freed separately and the result doe not depend on the
1199 request that can be freed as sson as the search request is finished)
1202 int ldb_extended_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1206 Helper function to build a extended request
1208 \param ret_req the request structure is returned here (talloced on mem_ctx)
1209 \param ldb the context associated with the database (from ldb_init())
1210 \param mem_ctx a talloc memory context (used as parent of ret_req)
1211 \param oid the OID of the extended operation.
1212 \param data a void pointer a the extended operation specific parameters,
1213 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1214 \param controls an array of controls
1215 \param context the callback function context
1216 \param the callback function to handle the async replies
1217 \param the parent request if any
1219 \return result code (LDB_SUCCESS on success, or a failure code)
1221 int ldb_build_extended_req(struct ldb_request **ret_req,
1222 struct ldb_context *ldb,
1223 TALLOC_CTX *mem_ctx,
1225 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1226 struct ldb_control **controls,
1228 ldb_request_callback_t callback,
1229 struct ldb_request *parent);
1232 call an extended operation
1234 This function deletes a record from the database.
1236 \param ldb the context associated with the database (from ldb_init())
1237 \param oid the OID of the extended operation.
1238 \param data a void pointer a the extended operation specific parameters,
1239 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1240 \param res the result of the extended operation
1242 \return result code (LDB_SUCCESS if the extended operation returned fine,
1243 otherwise a failure code)
1245 int ldb_extended(struct ldb_context *ldb,
1247 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1248 struct ldb_result **res);
1251 Obtain current/next database sequence number
1253 int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num);
1258 int ldb_transaction_start(struct ldb_context *ldb);
1261 commit a transaction
1263 int ldb_transaction_commit(struct ldb_context *ldb);
1266 cancel a transaction
1268 int ldb_transaction_cancel(struct ldb_context *ldb);
1272 return extended error information from the last call
1274 const char *ldb_errstring(struct ldb_context *ldb);
1277 return a string explaining what a ldb error constant meancs
1279 const char *ldb_strerror(int ldb_err);
1282 setup the default utf8 functions
1283 FIXME: these functions do not yet handle utf8
1285 void ldb_set_utf8_default(struct ldb_context *ldb);
1290 \param ldb the ldb context
1291 \param mem_ctx the memory context to allocate the result string
1293 \param s the string that is to be folded
1294 \return a copy of the string, converted to upper case
1296 \note The default function is not yet UTF8 aware. Provide your own
1297 set of functions through ldb_set_utf8_fns()
1299 char *ldb_casefold(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s, size_t n);
1302 Check the attribute name is valid according to rfc2251
1303 \param s the string to check
1305 \return 1 if the name is ok
1307 int ldb_valid_attr_name(const char *s);
1310 ldif manipulation functions
1314 Write an LDIF message
1316 This function writes an LDIF message using a caller supplied write
1319 \param ldb the ldb context (from ldb_init())
1320 \param fprintf_fn a function pointer for the write function. This must take
1321 a private data pointer, followed by a format string, and then a variable argument
1323 \param private_data pointer that will be provided back to the write
1324 function. This is useful for maintaining state or context.
1325 \param ldif the message to write out
1327 \return the total number of bytes written, or an error code as returned
1328 from the write function.
1330 \sa ldb_ldif_write_file for a more convenient way to write to a
1333 \sa ldb_ldif_read for the reader equivalent to this function.
1335 int ldb_ldif_write(struct ldb_context *ldb,
1336 int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1338 const struct ldb_ldif *ldif);
1341 Clean up an LDIF message
1343 This function cleans up a LDIF message read using ldb_ldif_read()
1344 or related functions (such as ldb_ldif_read_string() and
1345 ldb_ldif_read_file().
1347 \param ldb the ldb context (from ldb_init())
1348 \param msg the message to clean up and free
1351 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1354 Read an LDIF message
1356 This function creates an LDIF message using a caller supplied read
1359 \param ldb the ldb context (from ldb_init())
1360 \param fgetc_fn a function pointer for the read function. This must
1361 take a private data pointer, and must return a pointer to an
1362 integer corresponding to the next byte read (or EOF if there is no
1363 more data to be read).
1364 \param private_data pointer that will be provided back to the read
1365 function. This is udeful for maintaining state or context.
1367 \return the LDIF message that has been read in
1369 \note You must free the LDIF message when no longer required, using
1370 ldb_ldif_read_free().
1372 \sa ldb_ldif_read_file for a more convenient way to read from a
1375 \sa ldb_ldif_read_string for a more convenient way to read from a
1376 string (char array).
1378 \sa ldb_ldif_write for the writer equivalent to this function.
1380 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1381 int (*fgetc_fn)(void *), void *private_data);
1384 Read an LDIF message from a file
1386 This function reads the next LDIF message from the contents of a
1387 file stream. If you want to get all of the LDIF messages, you will
1388 need to repeatedly call this function, until it returns NULL.
1390 \param ldb the ldb context (from ldb_init())
1391 \param f the file stream to read from (typically from fdopen())
1393 \sa ldb_ldif_read_string for an equivalent function that will read
1394 from a string (char array).
1396 \sa ldb_ldif_write_file for the writer equivalent to this function.
1399 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1402 Read an LDIF message from a string
1404 This function reads the next LDIF message from the contents of a char
1405 array. If you want to get all of the LDIF messages, you will need
1406 to repeatedly call this function, until it returns NULL.
1408 \param ldb the ldb context (from ldb_init())
1409 \param s pointer to the char array to read from
1411 \sa ldb_ldif_read_file for an equivalent function that will read
1414 \sa ldb_ldif_write for a more general (arbitrary read function)
1415 version of this function.
1417 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1420 Write an LDIF message to a file
1422 \param ldb the ldb context (from ldb_init())
1423 \param f the file stream to write to (typically from fdopen())
1424 \param msg the message to write out
1426 \return the total number of bytes written, or a negative error code
1428 \sa ldb_ldif_read_file for the reader equivalent to this function.
1430 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1433 Base64 encode a buffer
1435 \param mem_ctx the memory context that the result is allocated
1437 \param buf pointer to the array that is to be encoded
1438 \param len the number of elements in the array to be encoded
1440 \return pointer to an array containing the encoded data
1442 \note The caller is responsible for freeing the result
1444 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len);
1447 Base64 decode a buffer
1449 This function decodes a base64 encoded string in place.
1451 \param s the string to decode.
1453 \return the length of the returned (decoded) string.
1455 \note the string is null terminated, but the null terminator is not
1456 included in the length.
1458 int ldb_base64_decode(char *s);
1460 /* The following definitions come from lib/ldb/common/ldb_dn.c */
1463 Get the linear form of a DN (without any extended components)
1465 \param dn The DN to linearize
1468 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1471 Allocate a copy of the linear form of a DN (without any extended components) onto the supplied memory context
1473 \param dn The DN to linearize
1474 \param mem_ctx TALLOC context to return result on
1477 char *ldb_dn_alloc_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1480 Get the linear form of a DN (with any extended components)
1482 \param mem_ctx TALLOC context to return result on
1483 \param dn The DN to linearize
1484 \param mode Style of extended DN to return (0 is HEX representation of binary form, 1 is a string form)
1486 char *ldb_dn_get_extended_linearized(void *mem_ctx, struct ldb_dn *dn, int mode);
1487 const struct ldb_val *ldb_dn_get_extended_component(struct ldb_dn *dn, const char *name);
1488 int ldb_dn_set_extended_component(struct ldb_dn *dn, const char *name, const struct ldb_val *val);
1490 void ldb_dn_remove_extended_components(struct ldb_dn *dn);
1491 bool ldb_dn_has_extended(struct ldb_dn *dn);
1493 int ldb_dn_extended_add_syntax(struct ldb_context *ldb,
1495 const struct ldb_dn_extended_syntax *syntax);
1498 Allocate a new DN from a string
1500 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1501 \param dn The new DN
1503 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1506 struct ldb_dn *ldb_dn_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn);
1508 Allocate a new DN from a printf style format string and arguments
1510 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1511 \param new_fms The new DN as a format string (plus arguments)
1513 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1516 struct ldb_dn *ldb_dn_new_fmt(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1518 Allocate a new DN from a struct ldb_val (useful to avoid buffer overrun)
1520 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1521 \param dn The new DN
1523 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1526 struct ldb_dn *ldb_dn_from_ldb_val(void *mem_ctx, struct ldb_context *ldb, const struct ldb_val *strdn);
1529 Determine if this DN is syntactically valid
1531 \param dn The DN to validate
1534 bool ldb_dn_validate(struct ldb_dn *dn);
1536 char *ldb_dn_escape_value(TALLOC_CTX *mem_ctx, struct ldb_val value);
1537 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1538 char *ldb_dn_alloc_casefold(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1540 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1541 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1543 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1544 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1545 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1546 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1547 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1548 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1550 struct ldb_dn *ldb_dn_copy(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1551 struct ldb_dn *ldb_dn_get_parent(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1552 char *ldb_dn_canonical_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1553 char *ldb_dn_canonical_ex_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1554 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1555 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1556 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1557 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1558 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1559 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1561 bool ldb_dn_is_valid(struct ldb_dn *dn);
1562 bool ldb_dn_is_special(struct ldb_dn *dn);
1563 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1564 bool ldb_dn_is_null(struct ldb_dn *dn);
1568 Compare two attributes
1570 This function compares to attribute names. Note that this is a
1571 case-insensitive comparison.
1573 \param a the first attribute name to compare
1574 \param b the second attribute name to compare
1576 \return 0 if the attribute names are the same, or only differ in
1577 case; non-zero if there are any differences
1579 attribute names are restricted by rfc2251 so using
1580 strcasecmp and toupper here is ok.
1583 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1584 char *ldb_attr_casefold(TALLOC_CTX *mem_ctx, const char *s);
1585 int ldb_attr_dn(const char *attr);
1588 Create an empty message
1590 \param mem_ctx the memory context to create in. You can pass NULL
1591 to get the top level context, however the ldb context (from
1592 ldb_init()) may be a better choice
1594 struct ldb_message *ldb_msg_new(TALLOC_CTX *mem_ctx);
1597 Find an element within an message
1599 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1600 const char *attr_name);
1603 Compare two ldb_val values
1605 \param v1 first ldb_val structure to be tested
1606 \param v2 second ldb_val structure to be tested
1608 \return 1 for a match, 0 if there is any difference
1610 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1613 find a value within an ldb_message_element
1615 \param el the element to search
1616 \param val the value to search for
1618 \note This search is case sensitive
1620 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1621 struct ldb_val *val);
1624 add a new empty element to a ldb_message
1626 int ldb_msg_add_empty(struct ldb_message *msg,
1627 const char *attr_name,
1629 struct ldb_message_element **return_el);
1632 add a element to a ldb_message
1634 int ldb_msg_add(struct ldb_message *msg,
1635 const struct ldb_message_element *el,
1637 int ldb_msg_add_value(struct ldb_message *msg,
1638 const char *attr_name,
1639 const struct ldb_val *val,
1640 struct ldb_message_element **return_el);
1641 int ldb_msg_add_steal_value(struct ldb_message *msg,
1642 const char *attr_name,
1643 struct ldb_val *val);
1644 int ldb_msg_add_steal_string(struct ldb_message *msg,
1645 const char *attr_name, char *str);
1646 int ldb_msg_add_string(struct ldb_message *msg,
1647 const char *attr_name, const char *str);
1648 int ldb_msg_add_fmt(struct ldb_message *msg,
1649 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1652 compare two message elements - return 0 on match
1654 int ldb_msg_element_compare(struct ldb_message_element *el1,
1655 struct ldb_message_element *el2);
1656 int ldb_msg_element_compare_name(struct ldb_message_element *el1,
1657 struct ldb_message_element *el2);
1660 Find elements in a message.
1662 This function finds elements and converts to a specific type, with
1663 a give default value if not found. Assumes that elements are
1666 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1667 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1668 const char *attr_name,
1670 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1671 const char *attr_name,
1672 unsigned int default_value);
1673 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1674 const char *attr_name,
1675 int64_t default_value);
1676 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1677 const char *attr_name,
1678 uint64_t default_value);
1679 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1680 const char *attr_name,
1681 double default_value);
1682 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1683 const char *attr_name,
1685 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1686 const char *attr_name,
1687 const char *default_value);
1689 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1690 TALLOC_CTX *mem_ctx,
1691 const struct ldb_message *msg,
1692 const char *attr_name);
1694 void ldb_msg_sort_elements(struct ldb_message *msg);
1696 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx,
1697 const struct ldb_message *msg);
1698 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx,
1699 const struct ldb_message *msg);
1701 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1702 const struct ldb_message *msg);
1705 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1706 struct ldb_message *msg1,
1707 struct ldb_message *msg2);
1709 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1714 Integrity check an ldb_message
1716 This function performs basic sanity / integrity checks on an
1719 \param ldb context in which to perform the checks
1720 \param msg the message to check
1722 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1723 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1724 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1727 int ldb_msg_sanity_check(struct ldb_context *ldb,
1728 const struct ldb_message *msg);
1731 Duplicate an ldb_val structure
1733 This function copies an ldb value structure.
1735 \param mem_ctx the memory context that the duplicated value will be
1737 \param v the ldb_val to be duplicated.
1739 \return the duplicated ldb_val structure.
1741 struct ldb_val ldb_val_dup(TALLOC_CTX *mem_ctx, const struct ldb_val *v);
1744 this allows the user to set a debug function for error reporting
1746 int ldb_set_debug(struct ldb_context *ldb,
1747 void (*debug)(void *context, enum ldb_debug_level level,
1748 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1752 this allows the user to set custom utf8 function for error reporting
1754 void ldb_set_utf8_fns(struct ldb_context *ldb,
1756 char *(*casefold)(void *, void *, const char *, size_t n));
1759 this sets up debug to print messages on stderr
1761 int ldb_set_debug_stderr(struct ldb_context *ldb);
1763 /* control backend specific opaque values */
1764 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1765 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1767 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs);
1768 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr);
1769 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1771 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1772 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1773 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1774 void ldb_msg_remove_element(struct ldb_message *msg, struct ldb_message_element *el);
1777 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1779 const char *replace);
1783 Convert a time structure to a string
1785 This function converts a time_t structure to an LDAP formatted
1786 GeneralizedTime string.
1788 \param mem_ctx the memory context to allocate the return string in
1789 \param t the time structure to convert
1791 \return the formatted string, or NULL if the time structure could
1794 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t);
1797 Convert a string to a time structure
1799 This function converts an LDAP formatted GeneralizedTime string
1800 to a time_t structure.
1802 \param s the string to convert
1804 \return the time structure, or 0 if the string cannot be converted
1806 time_t ldb_string_to_time(const char *s);
1809 Convert a time structure to a string
1811 This function converts a time_t structure to an LDAP formatted
1814 \param mem_ctx the memory context to allocate the return string in
1815 \param t the time structure to convert
1817 \return the formatted string, or NULL if the time structure could
1820 char *ldb_timestring_utc(TALLOC_CTX *mem_ctx, time_t t);
1823 Convert a string to a time structure
1825 This function converts an LDAP formatted UTCTime string
1826 to a time_t structure.
1828 \param s the string to convert
1830 \return the time structure, or 0 if the string cannot be converted
1832 time_t ldb_string_utc_to_time(const char *s);
1835 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1839 Convert an array of string represention of a control into an array of ldb_control structures
1841 \param ldb LDB context
1842 \param mem_ctx TALLOC context to return result on, and to allocate error_string on
1843 \param control_strings Array of string-formatted controls
1845 \return array of ldb_control elements
1847 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings);