4 Copyright (C) Andrew Tridgell 2004
5 Copyright (C) Stefan Metzmacher 2004
6 Copyright (C) Simo Sorce 2005-2006
8 ** NOTE! The following LGPL license applies to the ldb
9 ** library. This does NOT imply that all of Samba is released
12 This library is free software; you can redistribute it and/or
13 modify it under the terms of the GNU Lesser General Public
14 License as published by the Free Software Foundation; either
15 version 3 of the License, or (at your option) any later version.
17 This library is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 Lesser General Public License for more details.
22 You should have received a copy of the GNU Lesser General Public
23 License along with this library; if not, see <http://www.gnu.org/licenses/>.
29 * Component: ldb header
31 * Description: defines for base ldb API
33 * Author: Andrew Tridgell
34 * Author: Stefan Metzmacher
38 \file ldb.h Samba's ldb database
40 This header file provides the main API for ldb.
45 /*! \cond DOXYGEN_IGNORE */
52 #include "ldb_errors.h"
55 major restrictions as compared to normal LDAP:
57 - each record must have a unique key field
58 - the key must be representable as a NULL terminated C string and may not
59 contain a comma or braces
61 major restrictions as compared to tdb:
63 - no explicit locking calls, but we have transactions when using ldb_tdb
71 An individual lump of data in a result comes in this format. The
72 pointer will usually be to a UTF-8 string if the application is
73 sensible, but it can be to anything you like, including binary data
74 blobs of arbitrary size.
76 \note the data is null (0x00) terminated, but the length does not
77 include the terminator.
80 uint8_t *data; /*!< result data */
81 size_t length; /*!< length of data */
85 /*! \cond DOXYGEN_IGNORE */
86 #ifndef PRINTF_ATTRIBUTE
87 #define PRINTF_ATTRIBUTE(a,b)
91 /* opaque ldb_dn structures, see ldb_dn.c for internals */
92 struct ldb_dn_component;
96 There are a number of flags that are used with ldap_modify() in
97 ldb_message_element.flags fields. The LDB_FLAGS_MOD_ADD,
98 LDB_FLAGS_MOD_DELETE and LDB_FLAGS_MOD_REPLACE flags are used in
99 ldap_modify() calls to specify whether attributes are being added,
100 deleted or modified respectively.
102 #define LDB_FLAG_MOD_MASK 0x3
105 Flag value used in ldap_modify() to indicate that attributes are
108 \sa LDB_FLAG_MOD_MASK
110 #define LDB_FLAG_MOD_ADD 1
113 Flag value used in ldap_modify() to indicate that attributes are
116 \sa LDB_FLAG_MOD_MASK
118 #define LDB_FLAG_MOD_REPLACE 2
121 Flag value used in ldap_modify() to indicate that attributes are
124 \sa LDB_FLAG_MOD_MASK
126 #define LDB_FLAG_MOD_DELETE 3
129 OID for logic AND comaprison.
131 This is the well known object ID for a logical AND comparitor.
133 #define LDB_OID_COMPARATOR_AND "1.2.840.113556.1.4.803"
136 OID for logic OR comparison.
138 This is the well known object ID for a logical OR comparitor.
140 #define LDB_OID_COMPARATOR_OR "1.2.840.113556.1.4.804"
143 results are given back as arrays of ldb_message_element
145 struct ldb_message_element {
148 unsigned int num_values;
149 struct ldb_val *values;
154 a ldb_message represents all or part of a record. It can contain an arbitrary
159 unsigned int num_elements;
160 struct ldb_message_element *elements;
163 enum ldb_changetype {
164 LDB_CHANGETYPE_NONE=0,
166 LDB_CHANGETYPE_DELETE,
167 LDB_CHANGETYPE_MODIFY
173 This structure contains a LDIF record, as returned from ldif_read()
174 and equivalent functions.
177 enum ldb_changetype changetype; /*!< The type of change */
178 struct ldb_message *msg; /*!< The changes */
181 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
183 LDB_SCOPE_ONELEVEL=1,
184 LDB_SCOPE_SUBTREE=2};
187 struct tevent_context;
189 /* debugging uses one of the following levels */
190 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
191 LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
194 the user can optionally supply a debug function. The function
195 is based on the vfprintf() style of interface, but with the addition
198 struct ldb_debug_ops {
199 void (*debug)(void *context, enum ldb_debug_level level,
200 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
205 The user can optionally supply a custom utf8 functions,
206 to handle comparisons and casefolding.
208 struct ldb_utf8_fns {
210 char *(*casefold)(void *context, TALLOC_CTX *mem_ctx, const char *s, size_t n);
214 Flag value for database connection mode.
216 If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
217 opened read-only, if possible.
219 #define LDB_FLG_RDONLY 1
222 Flag value for database connection mode.
224 If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
225 opened without synchronous operations, if possible.
227 #define LDB_FLG_NOSYNC 2
230 Flag value to specify autoreconnect mode.
232 If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
233 be opened in a way that makes it try to auto reconnect if the
234 connection is dropped (actually make sense only with ldap).
236 #define LDB_FLG_RECONNECT 4
239 Flag to tell backends not to use mmap
241 #define LDB_FLG_NOMMAP 8
244 Flag to tell ldif handlers not to force encoding of binary
247 #define LDB_FLG_SHOW_BINARY 16
250 Flags to enable ldb tracing
252 #define LDB_FLG_ENABLE_TRACING 32
255 structures for ldb_parse_tree handling code
257 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
258 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
259 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
260 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
262 struct ldb_parse_tree {
263 enum ldb_parse_op operation;
266 struct ldb_parse_tree *child;
270 struct ldb_val value;
274 int start_with_wildcard;
275 int end_with_wildcard;
276 struct ldb_val **chunks;
283 struct ldb_val value;
289 struct ldb_val value;
292 unsigned int num_elements;
293 struct ldb_parse_tree **elements;
298 struct ldb_parse_tree *ldb_parse_tree(TALLOC_CTX *mem_ctx, const char *s);
299 char *ldb_filter_from_tree(TALLOC_CTX *mem_ctx, struct ldb_parse_tree *tree);
304 This function encodes a binary blob using the encoding rules in RFC
305 2254 (Section 4). This function also escapes any non-printable
308 \param mem_ctx the memory context to allocate the return string in.
309 \param val the (potentially) binary data to be encoded
311 \return the encoded data as a null terminated string
313 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
315 char *ldb_binary_encode(TALLOC_CTX *mem_ctx, struct ldb_val val);
320 This function encodes a string using the encoding rules in RFC 2254
321 (Section 4). This function also escapes any non-printable
324 \param mem_ctx the memory context to allocate the return string in.
325 \param string the string to be encoded
327 \return the encoded data as a null terminated string
329 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
331 char *ldb_binary_encode_string(TALLOC_CTX *mem_ctx, const char *string);
334 functions for controlling attribute handling
336 typedef int (*ldb_attr_handler_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, struct ldb_val *);
337 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, const struct ldb_val *);
340 attribute handler structure
342 attr -> The attribute name
343 ldif_read_fn -> convert from ldif to binary format
344 ldif_write_fn -> convert from binary to ldif format
345 canonicalise_fn -> canonicalise a value, for use by indexing and dn construction
346 comparison_fn -> compare two values
349 struct ldb_schema_syntax {
351 ldb_attr_handler_t ldif_read_fn;
352 ldb_attr_handler_t ldif_write_fn;
353 ldb_attr_handler_t canonicalise_fn;
354 ldb_attr_comparison_t comparison_fn;
357 struct ldb_schema_attribute {
360 const struct ldb_schema_syntax *syntax;
363 const struct ldb_schema_attribute *ldb_schema_attribute_by_name(struct ldb_context *ldb,
366 struct ldb_dn_extended_syntax {
368 ldb_attr_handler_t read_fn;
369 ldb_attr_handler_t write_clear_fn;
370 ldb_attr_handler_t write_hex_fn;
373 const struct ldb_dn_extended_syntax *ldb_dn_extended_syntax_by_name(struct ldb_context *ldb,
377 The attribute is not returned by default
379 #define LDB_ATTR_FLAG_HIDDEN (1<<0)
381 /* the attribute handler name should be freed when released */
382 #define LDB_ATTR_FLAG_ALLOCATED (1<<1)
385 The attribute is supplied by the application and should not be removed
387 #define LDB_ATTR_FLAG_FIXED (1<<2)
390 when this is set, attempts to create two records which have the same
391 value for this attribute will return LDB_ERR_ENTRY_ALREADY_EXISTS
393 #define LDB_ATTR_FLAG_UNIQUE_INDEX (1<<3)
396 when this is set, attempts to create two attribute values for this attribute on a single DN will return LDB_ERR_CONSTRAINT_VIOLATION
398 #define LDB_ATTR_FLAG_SINGLE_VALUE (1<<4)
401 LDAP attribute syntax for a DN
403 This is the well-known LDAP attribute syntax for a DN.
405 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
407 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
410 LDAP attribute syntax for a Directory String
412 This is the well-known LDAP attribute syntax for a Directory String.
414 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
416 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
419 LDAP attribute syntax for an integer
421 This is the well-known LDAP attribute syntax for an integer.
423 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
425 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
428 LDAP attribute syntax for a boolean
430 This is the well-known LDAP attribute syntax for a boolean.
432 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
434 #define LDB_SYNTAX_BOOLEAN "1.3.6.1.4.1.1466.115.121.1.7"
437 LDAP attribute syntax for an octet string
439 This is the well-known LDAP attribute syntax for an octet string.
441 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
443 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
446 LDAP attribute syntax for UTC time.
448 This is the well-known LDAP attribute syntax for a UTC time.
450 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
452 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
454 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
456 /* sorting helpers */
457 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
460 OID for the allowing client to request temporary relaxed
461 enforcement of constraints of the x.500 model.
463 \sa <a href="http://opends.dev.java.net/public/standards/draft-zeilenga-ldap-managedit.txt">draft managedit</a>.
465 #define LDB_CONTROL_RELAX_OID "1.3.6.1.4.1.4203.666.5.12"
468 OID for the paged results control. This control is included in the
469 searchRequest and searchResultDone messages as part of the controls
470 field of the LDAPMessage, as defined in Section 4.1.12 of
473 \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
475 #define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
478 OID for specifying the returned elements of the ntSecurityDescriptor
480 \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>
482 #define LDB_CONTROL_SD_FLAGS_OID "1.2.840.113556.1.4.801"
485 OID for specifying an advanced scope for the search (one partition)
487 \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>
489 #define LDB_CONTROL_DOMAIN_SCOPE_OID "1.2.840.113556.1.4.1339"
492 OID for specifying an advanced scope for a search
494 \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>
496 #define LDB_CONTROL_SEARCH_OPTIONS_OID "1.2.840.113556.1.4.1340"
501 \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>
503 #define LDB_CONTROL_NOTIFICATION_OID "1.2.840.113556.1.4.528"
506 OID for getting deleted objects
508 \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>
510 #define LDB_CONTROL_SHOW_DELETED_OID "1.2.840.113556.1.4.417"
513 OID for getting recycled objects
515 \sa <a href="http://msdn.microsoft.com/en-us/library/dd304621(PROT.13).aspx">Microsoft documentation of this OID</a>
517 #define LDB_CONTROL_SHOW_RECYCLED_OID "1.2.840.113556.1.4.2064"
520 OID for getting deactivated linked attributes
522 \sa <a href="http://msdn.microsoft.com/en-us/library/dd302781(PROT.13).aspx">Microsoft documentation of this OID</a>
524 #define LDB_CONTROL_SHOW_DEACTIVATED_LINK_OID "1.2.840.113556.1.4.2065"
529 \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>
531 #define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
534 OID for LDAP server sort result extension.
536 This control is included in the searchRequest message as part of
537 the controls field of the LDAPMessage, as defined in Section 4.1.12
538 of LDAP v3. The controlType is set to
539 "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
540 FALSE (where absent is also equivalent to FALSE) at the client's
543 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
545 #define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
548 OID for LDAP server sort result response extension.
550 This control is included in the searchResultDone message as part of
551 the controls field of the LDAPMessage, as defined in Section 4.1.12 of
554 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
556 #define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
559 OID for LDAP Attribute Scoped Query extension.
561 This control is included in SearchRequest or SearchResponse
562 messages as part of the controls field of the LDAPMessage.
564 #define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
567 OID for LDAP Directory Sync extension.
569 This control is included in SearchRequest or SearchResponse
570 messages as part of the controls field of the LDAPMessage.
572 #define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
576 OID for LDAP Virtual List View Request extension.
578 This control is included in SearchRequest messages
579 as part of the controls field of the LDAPMessage.
581 #define LDB_CONTROL_VLV_REQ_OID "2.16.840.1.113730.3.4.9"
584 OID for LDAP Virtual List View Response extension.
586 This control is included in SearchResponse messages
587 as part of the controls field of the LDAPMessage.
589 #define LDB_CONTROL_VLV_RESP_OID "2.16.840.1.113730.3.4.10"
592 OID to let modifies don't give an error when adding an existing
593 attribute with the same value or deleting an nonexisting one attribute
595 \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>
597 #define LDB_CONTROL_PERMISSIVE_MODIFY_OID "1.2.840.113556.1.4.1413"
600 OID to allow the server to be more 'fast and loose' with the data being added.
605 #define LDB_CONTROL_SERVER_LAZY_COMMIT "1.2.840.113556.1.4.619"
608 OID for LDAP Extended Operation FAST_BIND
610 This Extended operations is used to perform a fast bind.
612 #define LDB_EXTENDED_FAST_BIND_OID "1.2.840.113556.1.4.1781"
615 OID for LDAP Extended Operation START_TLS.
617 This Extended operation is used to start a new TLS channel on top of a clear
620 #define LDB_EXTENDED_START_TLS_OID "1.3.6.1.4.1.1466.20037"
623 OID for LDAP Extended Operation DYNAMIC_REFRESH.
625 This Extended operation is used to create and maintain objects which exist
626 only a specific time, e.g. when a certain client or a certain person is
627 logged in. Data refreshes have to be periodically sent in a specific
628 interval. Otherwise the entry is going to be removed.
630 #define LDB_EXTENDED_DYNAMIC_OID "1.3.6.1.4.1.1466.101.119.1"
633 OID for LDAP Extended Operation PASSWORD_CHANGE.
635 This Extended operation is used to allow user password changes by the user
638 #define LDB_EXTENDED_PASSWORD_CHANGE_OID "1.3.6.1.4.1.4203.1.11.1"
641 struct ldb_sd_flags_control {
643 * request the owner 0x00000001
644 * request the group 0x00000002
645 * request the DACL 0x00000004
646 * request the SACL 0x00000008
648 unsigned secinfo_flags;
652 * DOMAIN_SCOPE 0x00000001
653 * this limits the search to one partition,
654 * and no referrals will be returned.
655 * (Note this doesn't limit the entries by there
656 * objectSid belonging to a domain! Builtin and Foreign Sids
657 * are still returned)
659 * PHANTOM_ROOT 0x00000002
660 * this search on the whole tree on a domain controller
661 * over multiple partitions without referrals.
662 * (This is the default behavior on the Global Catalog Port)
665 #define LDB_SEARCH_OPTION_DOMAIN_SCOPE 0x00000001
666 #define LDB_SEARCH_OPTION_PHANTOM_ROOT 0x00000002
668 struct ldb_search_options_control {
669 unsigned search_options;
672 struct ldb_paged_control {
678 struct ldb_extended_dn_control {
682 struct ldb_server_sort_control {
683 const char *attributeName;
684 const char *orderingRule;
688 struct ldb_sort_resp_control {
693 struct ldb_asq_control {
695 char *source_attribute;
700 struct ldb_dirsync_control {
707 struct ldb_vlv_req_control {
725 struct ldb_vlv_resp_control {
739 enum ldb_request_type {
746 LDB_REQ_REGISTER_CONTROL,
747 LDB_REQ_REGISTER_PARTITION
750 enum ldb_reply_type {
767 struct ldb_extended {
769 void *data; /* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
772 #define LDB_EXTENDED_SEQUENCE_NUMBER "1.3.6.1.4.1.7165.4.4.3"
774 enum ldb_sequence_type {
776 LDB_SEQ_HIGHEST_TIMESTAMP,
780 #define LDB_SEQ_GLOBAL_SEQUENCE 0x01
781 #define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
783 struct ldb_seqnum_request {
784 enum ldb_sequence_type type;
787 struct ldb_seqnum_result {
794 struct ldb_message **msgs;
795 struct ldb_extended *extended;
796 struct ldb_control **controls;
802 enum ldb_reply_type type;
803 struct ldb_message *message;
804 struct ldb_extended *response;
805 struct ldb_control **controls;
814 enum ldb_scope scope;
815 struct ldb_parse_tree *tree;
816 const char * const *attrs;
817 struct ldb_result *res;
821 const struct ldb_message *message;
825 const struct ldb_message *message;
833 struct ldb_dn *olddn;
834 struct ldb_dn *newdn;
837 struct ldb_register_control {
841 struct ldb_register_partition {
845 typedef int (*ldb_request_callback_t)(struct ldb_request *, struct ldb_reply *);
849 enum ldb_request_type operation;
852 struct ldb_search search;
854 struct ldb_modify mod;
855 struct ldb_delete del;
856 struct ldb_rename rename;
857 struct ldb_extended extended;
858 struct ldb_register_control reg_control;
859 struct ldb_register_partition reg_partition;
862 struct ldb_control **controls;
865 ldb_request_callback_t callback;
869 struct ldb_handle *handle;
872 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
873 int ldb_request_done(struct ldb_request *req, int status);
874 bool ldb_request_is_done(struct ldb_request *req);
876 int ldb_modules_wait(struct ldb_handle *handle);
877 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
879 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
880 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
881 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
882 void ldb_set_modules_dir(struct ldb_context *ldb, const char *path);
883 struct tevent_context;
884 void ldb_set_event_context(struct ldb_context *ldb, struct tevent_context *ev);
885 struct tevent_context * ldb_get_event_context(struct ldb_context *ldb);
888 Initialise ldbs' global information
890 This is required before any other LDB call
892 \return 0 if initialisation succeeded, -1 otherwise
894 int ldb_global_init(void);
897 Initialise an ldb context
899 This is required before any other LDB call.
901 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
902 no suitable context available.
904 \return pointer to ldb_context that should be free'd (using talloc_free())
905 at the end of the program.
907 struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev_ctx);
910 Connect to a database.
912 This is typically called soon after ldb_init(), and is required prior to
913 any search or database modification operations.
915 The URL can be one of the following forms:
921 \param ldb the context associated with the database (from ldb_init())
922 \param url the URL of the database to connect to, as noted above
923 \param flags a combination of LDB_FLG_* to modify the connection behaviour
924 \param options backend specific options - passed uninterpreted to the backend
926 \return result code (LDB_SUCCESS on success, or a failure code)
928 \note It is an error to connect to a database that does not exist in readonly mode
929 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
930 created if it does not exist.
933 typedef void (*ldb_async_timeout_fn) (void *);
934 typedef bool (*ldb_async_callback_fn) (void *);
935 typedef int (*ldb_async_ctx_add_op_fn)(void *, time_t, void *, ldb_async_timeout_fn, ldb_async_callback_fn);
936 typedef int (*ldb_async_ctx_wait_op_fn)(void *);
938 void ldb_async_ctx_set_private_data(struct ldb_context *ldb,
940 void ldb_async_ctx_set_add_op(struct ldb_context *ldb,
941 ldb_async_ctx_add_op_fn add_op);
942 void ldb_async_ctx_set_wait_op(struct ldb_context *ldb,
943 ldb_async_ctx_wait_op_fn wait_op);
945 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
948 return an automatic basedn from the rootDomainNamingContext of the rootDSE
949 This value have been set in an opaque pointer at connection time
951 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
954 return an automatic basedn from the configurationNamingContext of the rootDSE
955 This value have been set in an opaque pointer at connection time
957 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
960 return an automatic basedn from the schemaNamingContext of the rootDSE
961 This value have been set in an opaque pointer at connection time
963 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
966 return an automatic baseDN from the defaultNamingContext of the rootDSE
967 This value have been set in an opaque pointer at connection time
969 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
972 The default async search callback function
974 \param req the request we are callback of
975 \param ares a single reply from the async core
977 \return result code (LDB_SUCCESS on success, or a failure code)
979 \note this function expects req->context to always be an struct ldb_result pointer
980 AND a talloc context, this function will steal on the context each message
981 from the ares reply passed on by the async core so that in the end all the
982 messages will be in the context (ldb_result) memory tree.
983 Freeing the passed context (ldb_result tree) will free all the resources
984 (the request need to be freed separately and the result doe not depend on the
985 request that can be freed as sson as the search request is finished)
988 int ldb_search_default_callback(struct ldb_request *req, struct ldb_reply *ares);
991 The default async extended operation callback function
993 \param req the request we are callback of
994 \param ares a single reply from the async core
996 \return result code (LDB_SUCCESS on success, or a failure code)
998 int ldb_op_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1002 Helper function to build a search request
1004 \param ret_req the request structure is returned here (talloced on mem_ctx)
1005 \param ldb the context associated with the database (from ldb_init())
1006 \param mem_ctx a talloc memory context (used as parent of ret_req)
1007 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1008 \param scope the search scope for the query
1009 \param expression the search expression to use for this query
1010 \param attrs the search attributes for the query (pass NULL if none required)
1011 \param controls an array of controls
1012 \param context the callback function context
1013 \param the callback function to handle the async replies
1014 \param the parent request if any
1016 \return result code (LDB_SUCCESS on success, or a failure code)
1019 int ldb_build_search_req(struct ldb_request **ret_req,
1020 struct ldb_context *ldb,
1021 TALLOC_CTX *mem_ctx,
1022 struct ldb_dn *base,
1023 enum ldb_scope scope,
1024 const char *expression,
1025 const char * const *attrs,
1026 struct ldb_control **controls,
1028 ldb_request_callback_t callback,
1029 struct ldb_request *parent);
1031 int ldb_build_search_req_ex(struct ldb_request **ret_req,
1032 struct ldb_context *ldb,
1033 TALLOC_CTX *mem_ctx,
1034 struct ldb_dn *base,
1035 enum ldb_scope scope,
1036 struct ldb_parse_tree *tree,
1037 const char * const *attrs,
1038 struct ldb_control **controls,
1040 ldb_request_callback_t callback,
1041 struct ldb_request *parent);
1044 Helper function to build an add request
1046 \param ret_req the request structure is returned here (talloced on mem_ctx)
1047 \param ldb the context associated with the database (from ldb_init())
1048 \param mem_ctx a talloc memory context (used as parent of ret_req)
1049 \param message contains the entry to be added
1050 \param controls an array of controls
1051 \param context the callback function context
1052 \param the callback function to handle the async replies
1053 \param the parent request if any
1055 \return result code (LDB_SUCCESS on success, or a failure code)
1058 int ldb_build_add_req(struct ldb_request **ret_req,
1059 struct ldb_context *ldb,
1060 TALLOC_CTX *mem_ctx,
1061 const struct ldb_message *message,
1062 struct ldb_control **controls,
1064 ldb_request_callback_t callback,
1065 struct ldb_request *parent);
1068 Helper function to build a modify request
1070 \param ret_req the request structure is returned here (talloced on mem_ctx)
1071 \param ldb the context associated with the database (from ldb_init())
1072 \param mem_ctx a talloc memory context (used as parent of ret_req)
1073 \param message contains the entry to be modified
1074 \param controls an array of controls
1075 \param context the callback function context
1076 \param the callback function to handle the async replies
1077 \param the parent request if any
1079 \return result code (LDB_SUCCESS on success, or a failure code)
1082 int ldb_build_mod_req(struct ldb_request **ret_req,
1083 struct ldb_context *ldb,
1084 TALLOC_CTX *mem_ctx,
1085 const struct ldb_message *message,
1086 struct ldb_control **controls,
1088 ldb_request_callback_t callback,
1089 struct ldb_request *parent);
1092 Helper function to build a delete request
1094 \param ret_req the request structure is returned here (talloced on mem_ctx)
1095 \param ldb the context associated with the database (from ldb_init())
1096 \param mem_ctx a talloc memory context (used as parent of ret_req)
1097 \param dn the DN to be deleted
1098 \param controls an array of controls
1099 \param context the callback function context
1100 \param the callback function to handle the async replies
1101 \param the parent request if any
1103 \return result code (LDB_SUCCESS on success, or a failure code)
1106 int ldb_build_del_req(struct ldb_request **ret_req,
1107 struct ldb_context *ldb,
1108 TALLOC_CTX *mem_ctx,
1110 struct ldb_control **controls,
1112 ldb_request_callback_t callback,
1113 struct ldb_request *parent);
1116 Helper function to build a rename request
1118 \param ret_req the request structure is returned here (talloced on mem_ctx)
1119 \param ldb the context associated with the database (from ldb_init())
1120 \param mem_ctx a talloc memory context (used as parent of ret_req)
1121 \param olddn the old DN
1122 \param newdn the new DN
1123 \param controls an array of controls
1124 \param context the callback function context
1125 \param the callback function to handle the async replies
1126 \param the parent request if any
1128 \return result code (LDB_SUCCESS on success, or a failure code)
1131 int ldb_build_rename_req(struct ldb_request **ret_req,
1132 struct ldb_context *ldb,
1133 TALLOC_CTX *mem_ctx,
1134 struct ldb_dn *olddn,
1135 struct ldb_dn *newdn,
1136 struct ldb_control **controls,
1138 ldb_request_callback_t callback,
1139 struct ldb_request *parent);
1142 Add a ldb_control to a ldb_request
1144 \param req the request struct where to add the control
1145 \param oid the object identifier of the control as string
1146 \param critical whether the control should be critical or not
1147 \param data a talloc pointer to the control specific data
1149 \return result code (LDB_SUCCESS on success, or a failure code)
1151 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1154 check if a control with the specified "oid" exist and return it
1155 \param req the request struct where to add the control
1156 \param oid the object identifier of the control as string
1158 \return the control, NULL if not found
1160 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid);
1163 check if a control with the specified "oid" exist and return it
1164 \param rep the reply struct where to add the control
1165 \param oid the object identifier of the control as string
1167 \return the control, NULL if not found
1169 struct ldb_control *ldb_reply_get_control(struct ldb_reply *rep, const char *oid);
1174 This function searches the database, and returns
1175 records that match an LDAP-like search expression
1177 \param ldb the context associated with the database (from ldb_init())
1178 \param mem_ctx the memory context to use for the request and the results
1179 \param result the return result
1180 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1181 \param scope the search scope for the query
1182 \param attrs the search attributes for the query (pass NULL if none required)
1183 \param exp_fmt the search expression to use for this query (printf like)
1185 \return result code (LDB_SUCCESS on success, or a failure code)
1187 \note use talloc_free() to free the ldb_result returned
1189 int ldb_search(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1190 struct ldb_result **result, struct ldb_dn *base,
1191 enum ldb_scope scope, const char * const *attrs,
1192 const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1195 Add a record to the database.
1197 This function adds a record to the database. This function will fail
1198 if a record with the specified class and key already exists in the
1201 \param ldb the context associated with the database (from
1203 \param message the message containing the record to add.
1205 \return result code (LDB_SUCCESS if the record was added, otherwise
1208 int ldb_add(struct ldb_context *ldb,
1209 const struct ldb_message *message);
1212 Modify the specified attributes of a record
1214 This function modifies a record that is in the database.
1216 \param ldb the context associated with the database (from
1218 \param message the message containing the changes required.
1220 \return result code (LDB_SUCCESS if the record was modified as
1221 requested, otherwise a failure code)
1223 int ldb_modify(struct ldb_context *ldb,
1224 const struct ldb_message *message);
1227 Rename a record in the database
1229 This function renames a record in the database.
1231 \param ldb the context associated with the database (from
1233 \param olddn the DN for the record to be renamed.
1234 \param newdn the new DN
1236 \return result code (LDB_SUCCESS if the record was renamed as
1237 requested, otherwise a failure code)
1239 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1242 Delete a record from the database
1244 This function deletes a record from the database.
1246 \param ldb the context associated with the database (from
1248 \param dn the DN for the record to be deleted.
1250 \return result code (LDB_SUCCESS if the record was deleted,
1251 otherwise a failure code)
1253 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1256 The default async extended operation callback function
1258 \param req the request we are callback of
1259 \param ares a single reply from the async core
1261 \return result code (LDB_SUCCESS on success, or a failure code)
1263 \note this function expects req->context to always be an struct ldb_result pointer
1264 AND a talloc context, this function will steal on the context each message
1265 from the ares reply passed on by the async core so that in the end all the
1266 messages will be in the context (ldb_result) memory tree.
1267 Freeing the passed context (ldb_result tree) will free all the resources
1268 (the request need to be freed separately and the result doe not depend on the
1269 request that can be freed as sson as the search request is finished)
1272 int ldb_extended_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1276 Helper function to build a extended request
1278 \param ret_req the request structure is returned here (talloced on mem_ctx)
1279 \param ldb the context associated with the database (from ldb_init())
1280 \param mem_ctx a talloc memory context (used as parent of ret_req)
1281 \param oid the OID of the extended operation.
1282 \param data a void pointer a the extended operation specific parameters,
1283 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1284 \param controls an array of controls
1285 \param context the callback function context
1286 \param the callback function to handle the async replies
1287 \param the parent request if any
1289 \return result code (LDB_SUCCESS on success, or a failure code)
1291 int ldb_build_extended_req(struct ldb_request **ret_req,
1292 struct ldb_context *ldb,
1293 TALLOC_CTX *mem_ctx,
1295 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1296 struct ldb_control **controls,
1298 ldb_request_callback_t callback,
1299 struct ldb_request *parent);
1302 call an extended operation
1304 This function deletes a record from the database.
1306 \param ldb the context associated with the database (from ldb_init())
1307 \param oid the OID of the extended operation.
1308 \param data a void pointer a the extended operation specific parameters,
1309 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1310 \param res the result of the extended operation
1312 \return result code (LDB_SUCCESS if the extended operation returned fine,
1313 otherwise a failure code)
1315 int ldb_extended(struct ldb_context *ldb,
1317 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1318 struct ldb_result **res);
1321 Obtain current/next database sequence number
1323 int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num);
1328 int ldb_transaction_start(struct ldb_context *ldb);
1331 first phase of two phase commit
1333 int ldb_transaction_prepare_commit(struct ldb_context *ldb);
1336 commit a transaction
1338 int ldb_transaction_commit(struct ldb_context *ldb);
1341 cancel a transaction
1343 int ldb_transaction_cancel(struct ldb_context *ldb);
1346 cancel a transaction with no error if no transaction is pending
1347 used when we fork() to clear any parent transactions
1349 int ldb_transaction_cancel_noerr(struct ldb_context *ldb);
1353 return extended error information from the last call
1355 const char *ldb_errstring(struct ldb_context *ldb);
1358 return a string explaining what a ldb error constant meancs
1360 const char *ldb_strerror(int ldb_err);
1363 setup the default utf8 functions
1364 FIXME: these functions do not yet handle utf8
1366 void ldb_set_utf8_default(struct ldb_context *ldb);
1371 \param ldb the ldb context
1372 \param mem_ctx the memory context to allocate the result string
1374 \param s the string that is to be folded
1375 \return a copy of the string, converted to upper case
1377 \note The default function is not yet UTF8 aware. Provide your own
1378 set of functions through ldb_set_utf8_fns()
1380 char *ldb_casefold(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s, size_t n);
1383 Check the attribute name is valid according to rfc2251
1384 \param s the string to check
1386 \return 1 if the name is ok
1388 int ldb_valid_attr_name(const char *s);
1391 ldif manipulation functions
1395 Write an LDIF message
1397 This function writes an LDIF message using a caller supplied write
1400 \param ldb the ldb context (from ldb_init())
1401 \param fprintf_fn a function pointer for the write function. This must take
1402 a private data pointer, followed by a format string, and then a variable argument
1404 \param private_data pointer that will be provided back to the write
1405 function. This is useful for maintaining state or context.
1406 \param ldif the message to write out
1408 \return the total number of bytes written, or an error code as returned
1409 from the write function.
1411 \sa ldb_ldif_write_file for a more convenient way to write to a
1414 \sa ldb_ldif_read for the reader equivalent to this function.
1416 int ldb_ldif_write(struct ldb_context *ldb,
1417 int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1419 const struct ldb_ldif *ldif);
1422 Clean up an LDIF message
1424 This function cleans up a LDIF message read using ldb_ldif_read()
1425 or related functions (such as ldb_ldif_read_string() and
1426 ldb_ldif_read_file().
1428 \param ldb the ldb context (from ldb_init())
1429 \param msg the message to clean up and free
1432 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1435 Read an LDIF message
1437 This function creates an LDIF message using a caller supplied read
1440 \param ldb the ldb context (from ldb_init())
1441 \param fgetc_fn a function pointer for the read function. This must
1442 take a private data pointer, and must return a pointer to an
1443 integer corresponding to the next byte read (or EOF if there is no
1444 more data to be read).
1445 \param private_data pointer that will be provided back to the read
1446 function. This is udeful for maintaining state or context.
1448 \return the LDIF message that has been read in
1450 \note You must free the LDIF message when no longer required, using
1451 ldb_ldif_read_free().
1453 \sa ldb_ldif_read_file for a more convenient way to read from a
1456 \sa ldb_ldif_read_string for a more convenient way to read from a
1457 string (char array).
1459 \sa ldb_ldif_write for the writer equivalent to this function.
1461 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1462 int (*fgetc_fn)(void *), void *private_data);
1465 Read an LDIF message from a file
1467 This function reads the next LDIF message from the contents of a
1468 file stream. If you want to get all of the LDIF messages, you will
1469 need to repeatedly call this function, until it returns NULL.
1471 \param ldb the ldb context (from ldb_init())
1472 \param f the file stream to read from (typically from fdopen())
1474 \sa ldb_ldif_read_string for an equivalent function that will read
1475 from a string (char array).
1477 \sa ldb_ldif_write_file for the writer equivalent to this function.
1480 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1483 Read an LDIF message from a string
1485 This function reads the next LDIF message from the contents of a char
1486 array. If you want to get all of the LDIF messages, you will need
1487 to repeatedly call this function, until it returns NULL.
1489 \param ldb the ldb context (from ldb_init())
1490 \param s pointer to the char array to read from
1492 \sa ldb_ldif_read_file for an equivalent function that will read
1495 \sa ldb_ldif_write for a more general (arbitrary read function)
1496 version of this function.
1498 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1501 Write an LDIF message to a file
1503 \param ldb the ldb context (from ldb_init())
1504 \param f the file stream to write to (typically from fdopen())
1505 \param msg the message to write out
1507 \return the total number of bytes written, or a negative error code
1509 \sa ldb_ldif_read_file for the reader equivalent to this function.
1511 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1514 Write an LDIF message to a string
1516 \param ldb the ldb context (from ldb_init())
1517 \param mem_ctx the talloc context on which to attach the string)
1518 \param msg the message to write out
1520 \return the string containing the LDIF, or NULL on error
1522 \sa ldb_ldif_read_string for the reader equivalent to this function.
1524 char * ldb_ldif_write_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1525 const struct ldb_ldif *msg);
1529 Produce a string form of an ldb message
1531 convenient function to turn a ldb_message into a string. Useful for
1534 char *ldb_ldif_message_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1535 enum ldb_changetype changetype,
1536 const struct ldb_message *msg);
1540 Base64 encode a buffer
1542 \param mem_ctx the memory context that the result is allocated
1544 \param buf pointer to the array that is to be encoded
1545 \param len the number of elements in the array to be encoded
1547 \return pointer to an array containing the encoded data
1549 \note The caller is responsible for freeing the result
1551 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len);
1554 Base64 decode a buffer
1556 This function decodes a base64 encoded string in place.
1558 \param s the string to decode.
1560 \return the length of the returned (decoded) string.
1562 \note the string is null terminated, but the null terminator is not
1563 included in the length.
1565 int ldb_base64_decode(char *s);
1567 /* The following definitions come from lib/ldb/common/ldb_dn.c */
1570 Get the linear form of a DN (without any extended components)
1572 \param dn The DN to linearize
1575 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1578 Allocate a copy of the linear form of a DN (without any extended components) onto the supplied memory context
1580 \param dn The DN to linearize
1581 \param mem_ctx TALLOC context to return result on
1584 char *ldb_dn_alloc_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1587 Get the linear form of a DN (with any extended components)
1589 \param mem_ctx TALLOC context to return result on
1590 \param dn The DN to linearize
1591 \param mode Style of extended DN to return (0 is HEX representation of binary form, 1 is a string form)
1593 char *ldb_dn_get_extended_linearized(void *mem_ctx, struct ldb_dn *dn, int mode);
1594 const struct ldb_val *ldb_dn_get_extended_component(struct ldb_dn *dn, const char *name);
1595 int ldb_dn_set_extended_component(struct ldb_dn *dn, const char *name, const struct ldb_val *val);
1597 void ldb_dn_remove_extended_components(struct ldb_dn *dn);
1598 bool ldb_dn_has_extended(struct ldb_dn *dn);
1600 int ldb_dn_extended_add_syntax(struct ldb_context *ldb,
1602 const struct ldb_dn_extended_syntax *syntax);
1605 Allocate a new DN from a string
1607 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1608 \param dn The new DN
1610 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1613 struct ldb_dn *ldb_dn_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn);
1615 Allocate a new DN from a printf style format string and arguments
1617 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1618 \param new_fms The new DN as a format string (plus arguments)
1620 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1623 struct ldb_dn *ldb_dn_new_fmt(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1625 Allocate a new DN from a struct ldb_val (useful to avoid buffer overrun)
1627 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1628 \param dn The new DN
1630 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1633 struct ldb_dn *ldb_dn_from_ldb_val(void *mem_ctx, struct ldb_context *ldb, const struct ldb_val *strdn);
1636 Determine if this DN is syntactically valid
1638 \param dn The DN to validate
1641 bool ldb_dn_validate(struct ldb_dn *dn);
1643 char *ldb_dn_escape_value(TALLOC_CTX *mem_ctx, struct ldb_val value);
1644 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1645 char *ldb_dn_alloc_casefold(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1647 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1648 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1650 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1651 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1652 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1653 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1654 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1655 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1657 struct ldb_dn *ldb_dn_copy(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1658 struct ldb_dn *ldb_dn_get_parent(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1659 char *ldb_dn_canonical_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1660 char *ldb_dn_canonical_ex_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1661 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1662 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1663 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1664 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1665 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1666 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1668 bool ldb_dn_is_valid(struct ldb_dn *dn);
1669 bool ldb_dn_is_special(struct ldb_dn *dn);
1670 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1671 bool ldb_dn_is_null(struct ldb_dn *dn);
1675 Compare two attributes
1677 This function compares to attribute names. Note that this is a
1678 case-insensitive comparison.
1680 \param a the first attribute name to compare
1681 \param b the second attribute name to compare
1683 \return 0 if the attribute names are the same, or only differ in
1684 case; non-zero if there are any differences
1686 attribute names are restricted by rfc2251 so using
1687 strcasecmp and toupper here is ok.
1690 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1691 char *ldb_attr_casefold(TALLOC_CTX *mem_ctx, const char *s);
1692 int ldb_attr_dn(const char *attr);
1695 Create an empty message
1697 \param mem_ctx the memory context to create in. You can pass NULL
1698 to get the top level context, however the ldb context (from
1699 ldb_init()) may be a better choice
1701 struct ldb_message *ldb_msg_new(TALLOC_CTX *mem_ctx);
1704 Find an element within an message
1706 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1707 const char *attr_name);
1710 Compare two ldb_val values
1712 \param v1 first ldb_val structure to be tested
1713 \param v2 second ldb_val structure to be tested
1715 \return 1 for a match, 0 if there is any difference
1717 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1720 find a value within an ldb_message_element
1722 \param el the element to search
1723 \param val the value to search for
1725 \note This search is case sensitive
1727 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1728 struct ldb_val *val);
1731 add a new empty element to a ldb_message
1733 int ldb_msg_add_empty(struct ldb_message *msg,
1734 const char *attr_name,
1736 struct ldb_message_element **return_el);
1739 add a element to a ldb_message
1741 int ldb_msg_add(struct ldb_message *msg,
1742 const struct ldb_message_element *el,
1744 int ldb_msg_add_value(struct ldb_message *msg,
1745 const char *attr_name,
1746 const struct ldb_val *val,
1747 struct ldb_message_element **return_el);
1748 int ldb_msg_add_steal_value(struct ldb_message *msg,
1749 const char *attr_name,
1750 struct ldb_val *val);
1751 int ldb_msg_add_steal_string(struct ldb_message *msg,
1752 const char *attr_name, char *str);
1753 int ldb_msg_add_string(struct ldb_message *msg,
1754 const char *attr_name, const char *str);
1755 int ldb_msg_add_fmt(struct ldb_message *msg,
1756 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1759 compare two message elements - return 0 on match
1761 int ldb_msg_element_compare(struct ldb_message_element *el1,
1762 struct ldb_message_element *el2);
1763 int ldb_msg_element_compare_name(struct ldb_message_element *el1,
1764 struct ldb_message_element *el2);
1767 Find elements in a message.
1769 This function finds elements and converts to a specific type, with
1770 a give default value if not found. Assumes that elements are
1773 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1774 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1775 const char *attr_name,
1777 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1778 const char *attr_name,
1779 unsigned int default_value);
1780 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1781 const char *attr_name,
1782 int64_t default_value);
1783 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1784 const char *attr_name,
1785 uint64_t default_value);
1786 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1787 const char *attr_name,
1788 double default_value);
1789 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1790 const char *attr_name,
1792 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1793 const char *attr_name,
1794 const char *default_value);
1796 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1797 TALLOC_CTX *mem_ctx,
1798 const struct ldb_message *msg,
1799 const char *attr_name);
1801 void ldb_msg_sort_elements(struct ldb_message *msg);
1803 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx,
1804 const struct ldb_message *msg);
1805 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx,
1806 const struct ldb_message *msg);
1808 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1809 const struct ldb_message *msg);
1812 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1813 struct ldb_message *msg1,
1814 struct ldb_message *msg2);
1817 Tries to find a certain string attribute in a message
1819 \param msg the message to check
1820 \param name attribute name
1821 \param value attribute value
1823 \return 1 on match and 0 otherwise.
1825 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1830 Integrity check an ldb_message
1832 This function performs basic sanity / integrity checks on an
1835 \param ldb context in which to perform the checks
1836 \param msg the message to check
1838 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1839 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1840 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1843 int ldb_msg_sanity_check(struct ldb_context *ldb,
1844 const struct ldb_message *msg);
1847 Duplicate an ldb_val structure
1849 This function copies an ldb value structure.
1851 \param mem_ctx the memory context that the duplicated value will be
1853 \param v the ldb_val to be duplicated.
1855 \return the duplicated ldb_val structure.
1857 struct ldb_val ldb_val_dup(TALLOC_CTX *mem_ctx, const struct ldb_val *v);
1860 this allows the user to set a debug function for error reporting
1862 int ldb_set_debug(struct ldb_context *ldb,
1863 void (*debug)(void *context, enum ldb_debug_level level,
1864 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1868 this allows the user to set custom utf8 function for error reporting
1870 void ldb_set_utf8_fns(struct ldb_context *ldb,
1872 char *(*casefold)(void *, void *, const char *, size_t n));
1875 this sets up debug to print messages on stderr
1877 int ldb_set_debug_stderr(struct ldb_context *ldb);
1879 /* control backend specific opaque values */
1880 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1881 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1883 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs);
1884 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr);
1885 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1887 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1888 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1889 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1890 void ldb_msg_remove_element(struct ldb_message *msg, struct ldb_message_element *el);
1893 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1895 const char *replace);
1898 shallow copy a tree - copying only the elements array so that the caller
1899 can safely add new elements without changing the message
1901 struct ldb_parse_tree *ldb_parse_tree_copy_shallow(TALLOC_CTX *mem_ctx,
1902 const struct ldb_parse_tree *ot);
1905 Convert a time structure to a string
1907 This function converts a time_t structure to an LDAP formatted
1908 GeneralizedTime string.
1910 \param mem_ctx the memory context to allocate the return string in
1911 \param t the time structure to convert
1913 \return the formatted string, or NULL if the time structure could
1916 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t);
1919 Convert a string to a time structure
1921 This function converts an LDAP formatted GeneralizedTime string
1922 to a time_t structure.
1924 \param s the string to convert
1926 \return the time structure, or 0 if the string cannot be converted
1928 time_t ldb_string_to_time(const char *s);
1931 Convert a time structure to a string
1933 This function converts a time_t structure to an LDAP formatted
1936 \param mem_ctx the memory context to allocate the return string in
1937 \param t the time structure to convert
1939 \return the formatted string, or NULL if the time structure could
1942 char *ldb_timestring_utc(TALLOC_CTX *mem_ctx, time_t t);
1945 Convert a string to a time structure
1947 This function converts an LDAP formatted UTCTime string
1948 to a time_t structure.
1950 \param s the string to convert
1952 \return the time structure, or 0 if the string cannot be converted
1954 time_t ldb_string_utc_to_time(const char *s);
1957 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1961 Convert an array of string represention of a control into an array of ldb_control structures
1963 \param ldb LDB context
1964 \param mem_ctx TALLOC context to return result on, and to allocate error_string on
1965 \param control_strings Array of string-formatted controls
1967 \return array of ldb_control elements
1969 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings);
1972 return the ldb flags
1974 unsigned int ldb_get_flags(struct ldb_context *ldb);
1976 /* set the ldb flags */
1977 void ldb_set_flags(struct ldb_context *ldb, unsigned flags);
1980 struct ldb_dn *ldb_dn_binary_from_ldb_val(void *mem_ctx,
1981 struct ldb_context *ldb,
1982 const struct ldb_val *strdn);
1984 int ldb_dn_get_binary(struct ldb_dn *dn, struct ldb_val *val);
1985 int ldb_dn_set_binary(struct ldb_dn *dn, struct ldb_val *val);