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 */
50 major restrictions as compared to normal LDAP:
53 - each record must have a unique key field
54 - the key must be representable as a NULL terminated C string and may not
55 contain a comma or braces
57 major restrictions as compared to tdb:
59 - no explicit locking calls
60 UPDATE: we have transactions now, better than locking --SSS.
68 An individual lump of data in a result comes in this format. The
69 pointer will usually be to a UTF-8 string if the application is
70 sensible, but it can be to anything you like, including binary data
71 blobs of arbitrary size.
73 \note the data is null (0x00) terminated, but the length does not
74 include the terminator.
77 uint8_t *data; /*!< result data */
78 size_t length; /*!< length of data */
82 /*! \cond DOXYGEN_IGNORE */
83 #ifndef PRINTF_ATTRIBUTE
84 #define PRINTF_ATTRIBUTE(a,b)
88 /* opaque ldb_dn structures, see ldb_dn.c for internals */
89 struct ldb_dn_component;
93 There are a number of flags that are used with ldap_modify() in
94 ldb_message_element.flags fields. The LDA_FLAGS_MOD_ADD,
95 LDA_FLAGS_MOD_DELETE and LDA_FLAGS_MOD_REPLACE flags are used in
96 ldap_modify() calls to specify whether attributes are being added,
97 deleted or modified respectively.
99 #define LDB_FLAG_MOD_MASK 0x3
102 Flag value used in ldap_modify() to indicate that attributes are
105 \sa LDB_FLAG_MOD_MASK
107 #define LDB_FLAG_MOD_ADD 1
110 Flag value used in ldap_modify() to indicate that attributes are
113 \sa LDB_FLAG_MOD_MASK
115 #define LDB_FLAG_MOD_REPLACE 2
118 Flag value used in ldap_modify() to indicate that attributes are
121 \sa LDB_FLAG_MOD_MASK
123 #define LDB_FLAG_MOD_DELETE 3
126 OID for logic AND comaprison.
128 This is the well known object ID for a logical AND comparitor.
130 #define LDB_OID_COMPARATOR_AND "1.2.840.113556.1.4.803"
133 OID for logic OR comparison.
135 This is the well known object ID for a logical OR comparitor.
137 #define LDB_OID_COMPARATOR_OR "1.2.840.113556.1.4.804"
140 results are given back as arrays of ldb_message_element
142 struct ldb_message_element {
145 unsigned int num_values;
146 struct ldb_val *values;
151 a ldb_message represents all or part of a record. It can contain an arbitrary
156 unsigned int num_elements;
157 struct ldb_message_element *elements;
160 enum ldb_changetype {
161 LDB_CHANGETYPE_NONE=0,
163 LDB_CHANGETYPE_DELETE,
164 LDB_CHANGETYPE_MODIFY
170 This structure contains a LDIF record, as returned from ldif_read()
171 and equivalent functions.
174 enum ldb_changetype changetype; /*!< The type of change */
175 struct ldb_message *msg; /*!< The changes */
178 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
180 LDB_SCOPE_ONELEVEL=1,
181 LDB_SCOPE_SUBTREE=2};
184 struct tevent_context;
186 /* debugging uses one of the following levels */
187 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
188 LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
191 the user can optionally supply a debug function. The function
192 is based on the vfprintf() style of interface, but with the addition
195 struct ldb_debug_ops {
196 void (*debug)(void *context, enum ldb_debug_level level,
197 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
202 The user can optionally supply a custom utf8 functions,
203 to handle comparisons and casefolding.
205 struct ldb_utf8_fns {
207 char *(*casefold)(void *context, TALLOC_CTX *mem_ctx, const char *s, size_t n);
211 Flag value for database connection mode.
213 If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
214 opened read-only, if possible.
216 #define LDB_FLG_RDONLY 1
219 Flag value for database connection mode.
221 If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
222 opened without synchronous operations, if possible.
224 #define LDB_FLG_NOSYNC 2
227 Flag value to specify autoreconnect mode.
229 If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
230 be opened in a way that makes it try to auto reconnect if the
231 connection is dropped (actually make sense only with ldap).
233 #define LDB_FLG_RECONNECT 4
236 Flag to tell backends not to use mmap
238 #define LDB_FLG_NOMMAP 8
241 structures for ldb_parse_tree handling code
243 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
244 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
245 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
246 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
248 struct ldb_parse_tree {
249 enum ldb_parse_op operation;
252 struct ldb_parse_tree *child;
256 struct ldb_val value;
260 int start_with_wildcard;
261 int end_with_wildcard;
262 struct ldb_val **chunks;
269 struct ldb_val value;
275 struct ldb_val value;
278 unsigned int num_elements;
279 struct ldb_parse_tree **elements;
284 struct ldb_parse_tree *ldb_parse_tree(TALLOC_CTX *mem_ctx, const char *s);
285 char *ldb_filter_from_tree(TALLOC_CTX *mem_ctx, struct ldb_parse_tree *tree);
290 This function encodes a binary blob using the encoding rules in RFC
291 2254 (Section 4). This function also escapes any non-printable
294 \param mem_ctx the memory context to allocate the return string in.
295 \param val the (potentially) binary data to be encoded
297 \return the encoded data as a null terminated string
299 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
301 char *ldb_binary_encode(TALLOC_CTX *mem_ctx, struct ldb_val val);
306 This function encodes a string using the encoding rules in RFC 2254
307 (Section 4). This function also escapes any non-printable
310 \param mem_ctx the memory context to allocate the return string in.
311 \param string the string to be encoded
313 \return the encoded data as a null terminated string
315 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
317 char *ldb_binary_encode_string(TALLOC_CTX *mem_ctx, const char *string);
320 functions for controlling attribute handling
322 typedef int (*ldb_attr_handler_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, struct ldb_val *);
323 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, const struct ldb_val *);
326 attribute handler structure
328 attr -> The attribute name
329 ldif_read_fn -> convert from ldif to binary format
330 ldif_write_fn -> convert from binary to ldif format
331 canonicalise_fn -> canonicalise a value, for use by indexing and dn construction
332 comparison_fn -> compare two values
335 struct ldb_schema_syntax {
337 ldb_attr_handler_t ldif_read_fn;
338 ldb_attr_handler_t ldif_write_fn;
339 ldb_attr_handler_t canonicalise_fn;
340 ldb_attr_comparison_t comparison_fn;
343 struct ldb_schema_attribute {
346 const struct ldb_schema_syntax *syntax;
349 const struct ldb_schema_attribute *ldb_schema_attribute_by_name(struct ldb_context *ldb,
352 struct ldb_dn_extended_syntax {
354 ldb_attr_handler_t read_fn;
355 ldb_attr_handler_t write_clear_fn;
356 ldb_attr_handler_t write_hex_fn;
359 const struct ldb_dn_extended_syntax *ldb_dn_extended_syntax_by_name(struct ldb_context *ldb,
363 The attribute is not returned by default
365 #define LDB_ATTR_FLAG_HIDDEN (1<<0)
367 /* the attribute handler name should be freed when released */
368 #define LDB_ATTR_FLAG_ALLOCATED (1<<1)
371 The attribute is supplied by the application and should not be removed
373 #define LDB_ATTR_FLAG_FIXED (1<<2)
376 LDAP attribute syntax for a DN
378 This is the well-known LDAP attribute syntax for a DN.
380 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
382 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
385 LDAP attribute syntax for a Directory String
387 This is the well-known LDAP attribute syntax for a Directory String.
389 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
391 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
394 LDAP attribute syntax for an integer
396 This is the well-known LDAP attribute syntax for an integer.
398 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
400 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
403 LDAP attribute syntax for an octet string
405 This is the well-known LDAP attribute syntax for an octet string.
407 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
409 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
412 LDAP attribute syntax for UTC time.
414 This is the well-known LDAP attribute syntax for a UTC time.
416 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
418 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
420 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
422 /* sorting helpers */
423 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
426 OID for the paged results control. This control is included in the
427 searchRequest and searchResultDone messages as part of the controls
428 field of the LDAPMessage, as defined in Section 4.1.12 of
431 \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
433 #define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
436 OID for specifying the returned elements of the ntSecurityDescriptor
438 \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>
440 #define LDB_CONTROL_SD_FLAGS_OID "1.2.840.113556.1.4.801"
443 OID for specifying an advanced scope for the search (one partition)
445 \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>
447 #define LDB_CONTROL_DOMAIN_SCOPE_OID "1.2.840.113556.1.4.1339"
450 OID for specifying an advanced scope for a search
452 \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>
454 #define LDB_CONTROL_SEARCH_OPTIONS_OID "1.2.840.113556.1.4.1340"
459 \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>
461 #define LDB_CONTROL_NOTIFICATION_OID "1.2.840.113556.1.4.528"
464 OID for getting deleted objects
466 \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>
468 #define LDB_CONTROL_SHOW_DELETED_OID "1.2.840.113556.1.4.417"
473 \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>
475 #define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
478 OID for LDAP server sort result extension.
480 This control is included in the searchRequest message as part of
481 the controls field of the LDAPMessage, as defined in Section 4.1.12
482 of LDAP v3. The controlType is set to
483 "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
484 FALSE (where absent is also equivalent to FALSE) at the client's
487 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
489 #define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
492 OID for LDAP server sort result response extension.
494 This control is included in the searchResultDone message as part of
495 the controls field of the LDAPMessage, as defined in Section 4.1.12 of
498 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
500 #define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
503 OID for LDAP Attribute Scoped Query extension.
505 This control is included in SearchRequest or SearchResponse
506 messages as part of the controls field of the LDAPMessage.
508 #define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
511 OID for LDAP Directory Sync extension.
513 This control is included in SearchRequest or SearchResponse
514 messages as part of the controls field of the LDAPMessage.
516 #define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
520 OID for LDAP Virtual List View Request extension.
522 This control is included in SearchRequest messages
523 as part of the controls field of the LDAPMessage.
525 #define LDB_CONTROL_VLV_REQ_OID "2.16.840.1.113730.3.4.9"
528 OID for LDAP Virtual List View Response extension.
530 This control is included in SearchResponse messages
531 as part of the controls field of the LDAPMessage.
533 #define LDB_CONTROL_VLV_RESP_OID "2.16.840.1.113730.3.4.10"
536 OID to let modifies don't give an error when adding an existing
537 attribute with the same value or deleting an nonexisting one attribute
539 \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>
541 #define LDB_CONTROL_PERMISSIVE_MODIFY_OID "1.2.840.113556.1.4.1413"
544 OID for LDAP Extended Operation START_TLS.
546 This Extended operation is used to start a new TLS
547 channel on top of a clear text channel.
549 #define LDB_EXTENDED_START_TLS_OID "1.3.6.1.4.1.1466.20037"
553 #define LDB_EXTENDED_DYNAMIC_OID "1.3.6.1.4.1.1466.101.119.1"
557 #define LDB_EXTENDED_FAST_BIND_OID "1.2.840.113556.1.4.1781"
559 struct ldb_sd_flags_control {
561 * request the owner 0x00000001
562 * request the group 0x00000002
563 * request the DACL 0x00000004
564 * request the SACL 0x00000008
566 unsigned secinfo_flags;
570 * DOMAIN_SCOPE 0x00000001
571 * this limits the search to one partition,
572 * and no referrals will be returned.
573 * (Note this doesn't limit the entries by there
574 * objectSid belonging to a domain! Builtin and Foreign Sids
575 * are still returned)
577 * PHANTOM_ROOT 0x00000002
578 * this search on the whole tree on a domain controller
579 * over multiple partitions without referrals.
580 * (This is the default behavior on the Global Catalog Port)
583 #define LDB_SEARCH_OPTION_DOMAIN_SCOPE 0x00000001
584 #define LDB_SEARCH_OPTION_PHANTOM_ROOT 0x00000002
586 struct ldb_search_options_control {
587 unsigned search_options;
590 struct ldb_paged_control {
596 struct ldb_extended_dn_control {
600 struct ldb_server_sort_control {
606 struct ldb_sort_resp_control {
611 struct ldb_asq_control {
613 char *source_attribute;
618 struct ldb_dirsync_control {
625 struct ldb_vlv_req_control {
643 struct ldb_vlv_resp_control {
657 enum ldb_request_type {
664 LDB_REQ_REGISTER_CONTROL,
665 LDB_REQ_REGISTER_PARTITION
668 enum ldb_reply_type {
685 struct ldb_extended {
687 void *data; /* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
690 #define LDB_EXTENDED_SEQUENCE_NUMBER "1.3.6.1.4.1.7165.4.4.3"
692 enum ldb_sequence_type {
694 LDB_SEQ_HIGHEST_TIMESTAMP,
698 struct ldb_seqnum_request {
699 enum ldb_sequence_type type;
702 struct ldb_seqnum_result {
709 struct ldb_message **msgs;
710 struct ldb_extended *extended;
711 struct ldb_control **controls;
717 enum ldb_reply_type type;
718 struct ldb_message *message;
719 struct ldb_extended *response;
720 struct ldb_control **controls;
729 enum ldb_scope scope;
730 struct ldb_parse_tree *tree;
731 const char * const *attrs;
732 struct ldb_result *res;
736 const struct ldb_message *message;
740 const struct ldb_message *message;
748 struct ldb_dn *olddn;
749 struct ldb_dn *newdn;
752 struct ldb_register_control {
756 struct ldb_register_partition {
760 typedef int (*ldb_request_callback_t)(struct ldb_request *, struct ldb_reply *);
764 enum ldb_request_type operation;
767 struct ldb_search search;
769 struct ldb_modify mod;
770 struct ldb_delete del;
771 struct ldb_rename rename;
772 struct ldb_extended extended;
773 struct ldb_register_control reg_control;
774 struct ldb_register_partition reg_partition;
777 struct ldb_control **controls;
780 ldb_request_callback_t callback;
784 struct ldb_handle *handle;
787 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
788 int ldb_request_done(struct ldb_request *req, int status);
789 bool ldb_request_is_done(struct ldb_request *req);
791 int ldb_modules_wait(struct ldb_handle *handle);
792 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
794 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
795 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
796 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
797 void ldb_set_modules_dir(struct ldb_context *ldb, const char *path);
798 struct tevent_context;
799 void ldb_set_event_context(struct ldb_context *ldb, struct tevent_context *ev);
800 struct tevent_context * ldb_get_event_context(struct ldb_context *ldb);
803 Initialise ldbs' global information
805 This is required before any other LDB call
807 \return 0 if initialisation succeeded, -1 otherwise
809 int ldb_global_init(void);
812 Initialise an ldb context
814 This is required before any other LDB call.
816 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
817 no suitable context available.
819 \return pointer to ldb_context that should be free'd (using talloc_free())
820 at the end of the program.
822 struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev_ctx);
825 Connect to a database.
827 This is typically called soon after ldb_init(), and is required prior to
828 any search or database modification operations.
830 The URL can be one of the following forms:
836 \param ldb the context associated with the database (from ldb_init())
837 \param url the URL of the database to connect to, as noted above
838 \param flags a combination of LDB_FLG_* to modify the connection behaviour
839 \param options backend specific options - passed uninterpreted to the backend
841 \return result code (LDB_SUCCESS on success, or a failure code)
843 \note It is an error to connect to a database that does not exist in readonly mode
844 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
845 created if it does not exist.
848 typedef void (*ldb_async_timeout_fn) (void *);
849 typedef bool (*ldb_async_callback_fn) (void *);
850 typedef int (*ldb_async_ctx_add_op_fn)(void *, time_t, void *, ldb_async_timeout_fn, ldb_async_callback_fn);
851 typedef int (*ldb_async_ctx_wait_op_fn)(void *);
853 void ldb_async_ctx_set_private_data(struct ldb_context *ldb,
855 void ldb_async_ctx_set_add_op(struct ldb_context *ldb,
856 ldb_async_ctx_add_op_fn add_op);
857 void ldb_async_ctx_set_wait_op(struct ldb_context *ldb,
858 ldb_async_ctx_wait_op_fn wait_op);
860 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
863 return an automatic basedn from the rootDomainNamingContext of the rootDSE
864 This value have been set in an opaque pointer at connection time
866 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
869 return an automatic basedn from the configurationNamingContext of the rootDSE
870 This value have been set in an opaque pointer at connection time
872 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
875 return an automatic basedn from the schemaNamingContext of the rootDSE
876 This value have been set in an opaque pointer at connection time
878 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
881 return an automatic baseDN from the defaultNamingContext of the rootDSE
882 This value have been set in an opaque pointer at connection time
884 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
887 The default async search callback function
889 \param req the request we are callback of
890 \param ares a single reply from the async core
892 \return result code (LDB_SUCCESS on success, or a failure code)
894 \note this function expects req->context to always be an struct ldb_result pointer
895 AND a talloc context, this function will steal on the context each message
896 from the ares reply passed on by the async core so that in the end all the
897 messages will be in the context (ldb_result) memory tree.
898 Freeing the passed context (ldb_result tree) will free all the resources
899 (the request need to be freed separately and the result doe not depend on the
900 request that can be freed as sson as the search request is finished)
903 int ldb_search_default_callback(struct ldb_request *req, struct ldb_reply *ares);
906 The default async extended operation callback function
908 \param req the request we are callback of
909 \param ares a single reply from the async core
911 \return result code (LDB_SUCCESS on success, or a failure code)
913 int ldb_op_default_callback(struct ldb_request *req, struct ldb_reply *ares);
917 Helper function to build a search request
919 \param ret_req the request structure is returned here (talloced on mem_ctx)
920 \param ldb the context associated with the database (from ldb_init())
921 \param mem_ctx a talloc memory context (used as parent of ret_req)
922 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
923 \param scope the search scope for the query
924 \param expression the search expression to use for this query
925 \param attrs the search attributes for the query (pass NULL if none required)
926 \param controls an array of controls
927 \param context the callback function context
928 \param the callback function to handle the async replies
929 \param the parent request if any
931 \return result code (LDB_SUCCESS on success, or a failure code)
934 int ldb_build_search_req(struct ldb_request **ret_req,
935 struct ldb_context *ldb,
938 enum ldb_scope scope,
939 const char *expression,
940 const char * const *attrs,
941 struct ldb_control **controls,
943 ldb_request_callback_t callback,
944 struct ldb_request *parent);
946 int ldb_build_search_req_ex(struct ldb_request **ret_req,
947 struct ldb_context *ldb,
950 enum ldb_scope scope,
951 struct ldb_parse_tree *tree,
952 const char * const *attrs,
953 struct ldb_control **controls,
955 ldb_request_callback_t callback,
956 struct ldb_request *parent);
959 Helper function to build an add request
961 \param ret_req the request structure is returned here (talloced on mem_ctx)
962 \param ldb the context associated with the database (from ldb_init())
963 \param mem_ctx a talloc memory context (used as parent of ret_req)
964 \param message contains the entry to be added
965 \param controls an array of controls
966 \param context the callback function context
967 \param the callback function to handle the async replies
968 \param the parent request if any
970 \return result code (LDB_SUCCESS on success, or a failure code)
973 int ldb_build_add_req(struct ldb_request **ret_req,
974 struct ldb_context *ldb,
976 const struct ldb_message *message,
977 struct ldb_control **controls,
979 ldb_request_callback_t callback,
980 struct ldb_request *parent);
983 Helper function to build a modify request
985 \param ret_req the request structure is returned here (talloced on mem_ctx)
986 \param ldb the context associated with the database (from ldb_init())
987 \param mem_ctx a talloc memory context (used as parent of ret_req)
988 \param message contains the entry to be modified
989 \param controls an array of controls
990 \param context the callback function context
991 \param the callback function to handle the async replies
992 \param the parent request if any
994 \return result code (LDB_SUCCESS on success, or a failure code)
997 int ldb_build_mod_req(struct ldb_request **ret_req,
998 struct ldb_context *ldb,
1000 const struct ldb_message *message,
1001 struct ldb_control **controls,
1003 ldb_request_callback_t callback,
1004 struct ldb_request *parent);
1007 Helper function to build a delete request
1009 \param ret_req the request structure is returned here (talloced on mem_ctx)
1010 \param ldb the context associated with the database (from ldb_init())
1011 \param mem_ctx a talloc memory context (used as parent of ret_req)
1012 \param dn the DN to be deleted
1013 \param controls an array of controls
1014 \param context the callback function context
1015 \param the callback function to handle the async replies
1016 \param the parent request if any
1018 \return result code (LDB_SUCCESS on success, or a failure code)
1021 int ldb_build_del_req(struct ldb_request **ret_req,
1022 struct ldb_context *ldb,
1023 TALLOC_CTX *mem_ctx,
1025 struct ldb_control **controls,
1027 ldb_request_callback_t callback,
1028 struct ldb_request *parent);
1031 Helper function to build a rename request
1033 \param ret_req the request structure is returned here (talloced on mem_ctx)
1034 \param ldb the context associated with the database (from ldb_init())
1035 \param mem_ctx a talloc memory context (used as parent of ret_req)
1036 \param olddn the old DN
1037 \param newdn the new DN
1038 \param controls an array of controls
1039 \param context the callback function context
1040 \param the callback function to handle the async replies
1041 \param the parent request if any
1043 \return result code (LDB_SUCCESS on success, or a failure code)
1046 int ldb_build_rename_req(struct ldb_request **ret_req,
1047 struct ldb_context *ldb,
1048 TALLOC_CTX *mem_ctx,
1049 struct ldb_dn *olddn,
1050 struct ldb_dn *newdn,
1051 struct ldb_control **controls,
1053 ldb_request_callback_t callback,
1054 struct ldb_request *parent);
1057 Add a ldb_control to a ldb_request
1059 \param req the request struct where to add the control
1060 \param oid the object identifier of the control as string
1061 \param critical whether the control should be critical or not
1062 \param data a talloc pointer to the control specific data
1064 \return result code (LDB_SUCCESS on success, or a failure code)
1066 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1069 check if a control with the specified "oid" exist and return it
1070 \param req the request struct where to add the control
1071 \param oid the object identifier of the control as string
1073 \return the control, NULL if not found
1075 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid);
1078 check if a control with the specified "oid" exist and return it
1079 \param rep the reply struct where to add the control
1080 \param oid the object identifier of the control as string
1082 \return the control, NULL if not found
1084 struct ldb_control *ldb_reply_get_control(struct ldb_reply *rep, const char *oid);
1089 This function searches the database, and returns
1090 records that match an LDAP-like search expression
1092 \param ldb the context associated with the database (from ldb_init())
1093 \param mem_ctx the memory context to use for the request and the results
1094 \param result the return result
1095 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1096 \param scope the search scope for the query
1097 \param attrs the search attributes for the query (pass NULL if none required)
1098 \param exp_fmt the search expression to use for this query (printf like)
1100 \return result code (LDB_SUCCESS on success, or a failure code)
1102 \note use talloc_free() to free the ldb_result returned
1104 int ldb_search(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1105 struct ldb_result **result, struct ldb_dn *base,
1106 enum ldb_scope scope, const char * const *attrs,
1107 const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1110 Add a record to the database.
1112 This function adds a record to the database. This function will fail
1113 if a record with the specified class and key already exists in the
1116 \param ldb the context associated with the database (from
1118 \param message the message containing the record to add.
1120 \return result code (LDB_SUCCESS if the record was added, otherwise
1123 int ldb_add(struct ldb_context *ldb,
1124 const struct ldb_message *message);
1127 Modify the specified attributes of a record
1129 This function modifies a record that is in the database.
1131 \param ldb the context associated with the database (from
1133 \param message the message containing the changes required.
1135 \return result code (LDB_SUCCESS if the record was modified as
1136 requested, otherwise a failure code)
1138 int ldb_modify(struct ldb_context *ldb,
1139 const struct ldb_message *message);
1142 Rename a record in the database
1144 This function renames a record in the database.
1146 \param ldb the context associated with the database (from
1148 \param olddn the DN for the record to be renamed.
1149 \param newdn the new DN
1151 \return result code (LDB_SUCCESS if the record was renamed as
1152 requested, otherwise a failure code)
1154 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1157 Delete a record from the database
1159 This function deletes a record from the database.
1161 \param ldb the context associated with the database (from
1163 \param dn the DN for the record to be deleted.
1165 \return result code (LDB_SUCCESS if the record was deleted,
1166 otherwise a failure code)
1168 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1171 The default async extended operation callback function
1173 \param req the request we are callback of
1174 \param ares a single reply from the async core
1176 \return result code (LDB_SUCCESS on success, or a failure code)
1178 \note this function expects req->context to always be an struct ldb_result pointer
1179 AND a talloc context, this function will steal on the context each message
1180 from the ares reply passed on by the async core so that in the end all the
1181 messages will be in the context (ldb_result) memory tree.
1182 Freeing the passed context (ldb_result tree) will free all the resources
1183 (the request need to be freed separately and the result doe not depend on the
1184 request that can be freed as sson as the search request is finished)
1187 int ldb_extended_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1191 Helper function to build a extended request
1193 \param ret_req the request structure is returned here (talloced on mem_ctx)
1194 \param ldb the context associated with the database (from ldb_init())
1195 \param mem_ctx a talloc memory context (used as parent of ret_req)
1196 \param oid the OID of the extended operation.
1197 \param data a void pointer a the extended operation specific parameters,
1198 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1199 \param controls an array of controls
1200 \param context the callback function context
1201 \param the callback function to handle the async replies
1202 \param the parent request if any
1204 \return result code (LDB_SUCCESS on success, or a failure code)
1206 int ldb_build_extended_req(struct ldb_request **ret_req,
1207 struct ldb_context *ldb,
1208 TALLOC_CTX *mem_ctx,
1210 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1211 struct ldb_control **controls,
1213 ldb_request_callback_t callback,
1214 struct ldb_request *parent);
1217 call an extended operation
1219 This function deletes a record from the database.
1221 \param ldb the context associated with the database (from ldb_init())
1222 \param oid the OID of the extended operation.
1223 \param data a void pointer a the extended operation specific parameters,
1224 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1225 \param res the result of the extended operation
1227 \return result code (LDB_SUCCESS if the extended operation returned fine,
1228 otherwise a failure code)
1230 int ldb_extended(struct ldb_context *ldb,
1232 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1233 struct ldb_result **res);
1238 int ldb_transaction_start(struct ldb_context *ldb);
1241 commit a transaction
1243 int ldb_transaction_commit(struct ldb_context *ldb);
1246 cancel a transaction
1248 int ldb_transaction_cancel(struct ldb_context *ldb);
1252 return extended error information from the last call
1254 const char *ldb_errstring(struct ldb_context *ldb);
1257 return a string explaining what a ldb error constant meancs
1259 const char *ldb_strerror(int ldb_err);
1262 setup the default utf8 functions
1263 FIXME: these functions do not yet handle utf8
1265 void ldb_set_utf8_default(struct ldb_context *ldb);
1270 \param ldb the ldb context
1271 \param mem_ctx the memory context to allocate the result string
1273 \param s the string that is to be folded
1274 \return a copy of the string, converted to upper case
1276 \note The default function is not yet UTF8 aware. Provide your own
1277 set of functions through ldb_set_utf8_fns()
1279 char *ldb_casefold(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s, size_t n);
1282 Check the attribute name is valid according to rfc2251
1283 \param s the string to check
1285 \return 1 if the name is ok
1287 int ldb_valid_attr_name(const char *s);
1290 ldif manipulation functions
1294 Write an LDIF message
1296 This function writes an LDIF message using a caller supplied write
1299 \param ldb the ldb context (from ldb_init())
1300 \param fprintf_fn a function pointer for the write function. This must take
1301 a private data pointer, followed by a format string, and then a variable argument
1303 \param private_data pointer that will be provided back to the write
1304 function. This is useful for maintaining state or context.
1305 \param ldif the message to write out
1307 \return the total number of bytes written, or an error code as returned
1308 from the write function.
1310 \sa ldb_ldif_write_file for a more convenient way to write to a
1313 \sa ldb_ldif_read for the reader equivalent to this function.
1315 int ldb_ldif_write(struct ldb_context *ldb,
1316 int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1318 const struct ldb_ldif *ldif);
1321 Clean up an LDIF message
1323 This function cleans up a LDIF message read using ldb_ldif_read()
1324 or related functions (such as ldb_ldif_read_string() and
1325 ldb_ldif_read_file().
1327 \param ldb the ldb context (from ldb_init())
1328 \param msg the message to clean up and free
1331 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1334 Read an LDIF message
1336 This function creates an LDIF message using a caller supplied read
1339 \param ldb the ldb context (from ldb_init())
1340 \param fgetc_fn a function pointer for the read function. This must
1341 take a private data pointer, and must return a pointer to an
1342 integer corresponding to the next byte read (or EOF if there is no
1343 more data to be read).
1344 \param private_data pointer that will be provided back to the read
1345 function. This is udeful for maintaining state or context.
1347 \return the LDIF message that has been read in
1349 \note You must free the LDIF message when no longer required, using
1350 ldb_ldif_read_free().
1352 \sa ldb_ldif_read_file for a more convenient way to read from a
1355 \sa ldb_ldif_read_string for a more convenient way to read from a
1356 string (char array).
1358 \sa ldb_ldif_write for the writer equivalent to this function.
1360 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1361 int (*fgetc_fn)(void *), void *private_data);
1364 Read an LDIF message from a file
1366 This function reads the next LDIF message from the contents of a
1367 file stream. If you want to get all of the LDIF messages, you will
1368 need to repeatedly call this function, until it returns NULL.
1370 \param ldb the ldb context (from ldb_init())
1371 \param f the file stream to read from (typically from fdopen())
1373 \sa ldb_ldif_read_string for an equivalent function that will read
1374 from a string (char array).
1376 \sa ldb_ldif_write_file for the writer equivalent to this function.
1379 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1382 Read an LDIF message from a string
1384 This function reads the next LDIF message from the contents of a char
1385 array. If you want to get all of the LDIF messages, you will need
1386 to repeatedly call this function, until it returns NULL.
1388 \param ldb the ldb context (from ldb_init())
1389 \param s pointer to the char array to read from
1391 \sa ldb_ldif_read_file for an equivalent function that will read
1394 \sa ldb_ldif_write for a more general (arbitrary read function)
1395 version of this function.
1397 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1400 Write an LDIF message to a file
1402 \param ldb the ldb context (from ldb_init())
1403 \param f the file stream to write to (typically from fdopen())
1404 \param msg the message to write out
1406 \return the total number of bytes written, or a negative error code
1408 \sa ldb_ldif_read_file for the reader equivalent to this function.
1410 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1413 Base64 encode a buffer
1415 \param mem_ctx the memory context that the result is allocated
1417 \param buf pointer to the array that is to be encoded
1418 \param len the number of elements in the array to be encoded
1420 \return pointer to an array containing the encoded data
1422 \note The caller is responsible for freeing the result
1424 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len);
1427 Base64 decode a buffer
1429 This function decodes a base64 encoded string in place.
1431 \param s the string to decode.
1433 \return the length of the returned (decoded) string.
1435 \note the string is null terminated, but the null terminator is not
1436 included in the length.
1438 int ldb_base64_decode(char *s);
1440 /* The following definitions come from lib/ldb/common/ldb_dn.c */
1443 Get the linear form of a DN (without any extended components)
1445 \param dn The DN to linearize
1448 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1451 Allocate a copy of the linear form of a DN (without any extended components) onto the supplied memory context
1453 \param dn The DN to linearize
1454 \param mem_ctx TALLOC context to return result on
1457 char *ldb_dn_alloc_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1460 Get the linear form of a DN (with any extended components)
1462 \param mem_ctx TALLOC context to return result on
1463 \param dn The DN to linearize
1464 \param mode Style of extended DN to return (0 is HEX representation of binary form, 1 is a string form)
1466 char *ldb_dn_get_extended_linearized(void *mem_ctx, struct ldb_dn *dn, int mode);
1467 const struct ldb_val *ldb_dn_get_extended_component(struct ldb_dn *dn, const char *name);
1468 int ldb_dn_set_extended_component(struct ldb_dn *dn, const char *name, const struct ldb_val *val);
1470 void ldb_dn_remove_extended_components(struct ldb_dn *dn);
1471 bool ldb_dn_has_extended(struct ldb_dn *dn);
1473 int ldb_dn_extended_add_syntax(struct ldb_context *ldb,
1475 const struct ldb_dn_extended_syntax *syntax);
1478 Allocate a new DN from a string
1480 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1481 \param dn The new DN
1483 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1486 struct ldb_dn *ldb_dn_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn);
1488 Allocate a new DN from a printf style format string and arguments
1490 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1491 \param new_fms The new DN as a format string (plus arguments)
1493 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1496 struct ldb_dn *ldb_dn_new_fmt(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1498 Allocate a new DN from a struct ldb_val (useful to avoid buffer overrun)
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_from_ldb_val(void *mem_ctx, struct ldb_context *ldb, const struct ldb_val *strdn);
1509 Determine if this DN is syntactically valid
1511 \param dn The DN to validate
1514 bool ldb_dn_validate(struct ldb_dn *dn);
1516 char *ldb_dn_escape_value(TALLOC_CTX *mem_ctx, struct ldb_val value);
1517 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1518 char *ldb_dn_alloc_casefold(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1520 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1521 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1523 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1524 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1525 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1526 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1527 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1528 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1530 struct ldb_dn *ldb_dn_copy(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1531 struct ldb_dn *ldb_dn_get_parent(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1532 char *ldb_dn_canonical_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1533 char *ldb_dn_canonical_ex_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1534 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1535 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1536 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1537 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1538 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1539 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1541 bool ldb_dn_is_valid(struct ldb_dn *dn);
1542 bool ldb_dn_is_special(struct ldb_dn *dn);
1543 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1544 bool ldb_dn_is_null(struct ldb_dn *dn);
1548 Compare two attributes
1550 This function compares to attribute names. Note that this is a
1551 case-insensitive comparison.
1553 \param a the first attribute name to compare
1554 \param b the second attribute name to compare
1556 \return 0 if the attribute names are the same, or only differ in
1557 case; non-zero if there are any differences
1559 attribute names are restricted by rfc2251 so using
1560 strcasecmp and toupper here is ok.
1563 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1564 char *ldb_attr_casefold(TALLOC_CTX *mem_ctx, const char *s);
1565 int ldb_attr_dn(const char *attr);
1568 Create an empty message
1570 \param mem_ctx the memory context to create in. You can pass NULL
1571 to get the top level context, however the ldb context (from
1572 ldb_init()) may be a better choice
1574 struct ldb_message *ldb_msg_new(TALLOC_CTX *mem_ctx);
1577 Find an element within an message
1579 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1580 const char *attr_name);
1583 Compare two ldb_val values
1585 \param v1 first ldb_val structure to be tested
1586 \param v2 second ldb_val structure to be tested
1588 \return 1 for a match, 0 if there is any difference
1590 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1593 find a value within an ldb_message_element
1595 \param el the element to search
1596 \param val the value to search for
1598 \note This search is case sensitive
1600 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1601 struct ldb_val *val);
1604 add a new empty element to a ldb_message
1606 int ldb_msg_add_empty(struct ldb_message *msg,
1607 const char *attr_name,
1609 struct ldb_message_element **return_el);
1612 add a element to a ldb_message
1614 int ldb_msg_add(struct ldb_message *msg,
1615 const struct ldb_message_element *el,
1617 int ldb_msg_add_value(struct ldb_message *msg,
1618 const char *attr_name,
1619 const struct ldb_val *val,
1620 struct ldb_message_element **return_el);
1621 int ldb_msg_add_steal_value(struct ldb_message *msg,
1622 const char *attr_name,
1623 struct ldb_val *val);
1624 int ldb_msg_add_steal_string(struct ldb_message *msg,
1625 const char *attr_name, char *str);
1626 int ldb_msg_add_string(struct ldb_message *msg,
1627 const char *attr_name, const char *str);
1628 int ldb_msg_add_fmt(struct ldb_message *msg,
1629 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1632 compare two message elements - return 0 on match
1634 int ldb_msg_element_compare(struct ldb_message_element *el1,
1635 struct ldb_message_element *el2);
1638 Find elements in a message.
1640 This function finds elements and converts to a specific type, with
1641 a give default value if not found. Assumes that elements are
1644 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1645 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1646 const char *attr_name,
1648 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1649 const char *attr_name,
1650 unsigned int default_value);
1651 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1652 const char *attr_name,
1653 int64_t default_value);
1654 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1655 const char *attr_name,
1656 uint64_t default_value);
1657 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1658 const char *attr_name,
1659 double default_value);
1660 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1661 const char *attr_name,
1663 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1664 const char *attr_name,
1665 const char *default_value);
1667 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1668 TALLOC_CTX *mem_ctx,
1669 const struct ldb_message *msg,
1670 const char *attr_name);
1672 void ldb_msg_sort_elements(struct ldb_message *msg);
1674 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx,
1675 const struct ldb_message *msg);
1676 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx,
1677 const struct ldb_message *msg);
1679 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1680 const struct ldb_message *msg);
1683 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1684 struct ldb_message *msg1,
1685 struct ldb_message *msg2);
1687 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1692 Integrity check an ldb_message
1694 This function performs basic sanity / integrity checks on an
1697 \param ldb context in which to perform the checks
1698 \param msg the message to check
1700 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1701 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1702 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1705 int ldb_msg_sanity_check(struct ldb_context *ldb,
1706 const struct ldb_message *msg);
1709 Duplicate an ldb_val structure
1711 This function copies an ldb value structure.
1713 \param mem_ctx the memory context that the duplicated value will be
1715 \param v the ldb_val to be duplicated.
1717 \return the duplicated ldb_val structure.
1719 struct ldb_val ldb_val_dup(TALLOC_CTX *mem_ctx, const struct ldb_val *v);
1722 this allows the user to set a debug function for error reporting
1724 int ldb_set_debug(struct ldb_context *ldb,
1725 void (*debug)(void *context, enum ldb_debug_level level,
1726 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1730 this allows the user to set custom utf8 function for error reporting
1732 void ldb_set_utf8_fns(struct ldb_context *ldb,
1734 char *(*casefold)(void *, void *, const char *, size_t n));
1737 this sets up debug to print messages on stderr
1739 int ldb_set_debug_stderr(struct ldb_context *ldb);
1741 /* control backend specific opaque values */
1742 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1743 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1745 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs);
1746 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr);
1747 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1750 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1752 const char *replace);
1754 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1755 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1756 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1759 Convert a time structure to a string
1761 This function converts a time_t structure to an LDAP formatted
1762 GeneralizedTime string.
1764 \param mem_ctx the memory context to allocate the return string in
1765 \param t the time structure to convert
1767 \return the formatted string, or NULL if the time structure could
1770 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t);
1773 Convert a string to a time structure
1775 This function converts an LDAP formatted GeneralizedTime string
1776 to a time_t structure.
1778 \param s the string to convert
1780 \return the time structure, or 0 if the string cannot be converted
1782 time_t ldb_string_to_time(const char *s);
1785 Convert a time structure to a string
1787 This function converts a time_t structure to an LDAP formatted
1790 \param mem_ctx the memory context to allocate the return string in
1791 \param t the time structure to convert
1793 \return the formatted string, or NULL if the time structure could
1796 char *ldb_timestring_utc(TALLOC_CTX *mem_ctx, time_t t);
1799 Convert a string to a time structure
1801 This function converts an LDAP formatted UTCTime string
1802 to a time_t structure.
1804 \param s the string to convert
1806 \return the time structure, or 0 if the string cannot be converted
1808 time_t ldb_string_utc_to_time(const char *s);
1811 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1815 Convert an array of string represention of a control into an array of ldb_control structures
1817 \param ldb LDB context
1818 \param mem_ctx TALLOC context to return result on, and to allocate error_string on
1819 \param control_strings Array of string-formatted controls
1821 \return array of ldb_control elements
1823 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings);