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 LDAP attribute syntax for a DN
398 This is the well-known LDAP attribute syntax for a DN.
400 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
402 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
405 LDAP attribute syntax for a Directory String
407 This is the well-known LDAP attribute syntax for a Directory String.
409 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
411 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
414 LDAP attribute syntax for an integer
416 This is the well-known LDAP attribute syntax for an integer.
418 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
420 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
423 LDAP attribute syntax for a boolean
425 This is the well-known LDAP attribute syntax for a boolean.
427 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
429 #define LDB_SYNTAX_BOOLEAN "1.3.6.1.4.1.1466.115.121.1.7"
432 LDAP attribute syntax for an octet string
434 This is the well-known LDAP attribute syntax for an octet string.
436 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
438 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
441 LDAP attribute syntax for UTC time.
443 This is the well-known LDAP attribute syntax for a UTC time.
445 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
447 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
449 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
451 /* sorting helpers */
452 typedef int (*ldb_qsort_cmp_fn_t
) (void *v1
, void *v2
, void *opaque
);
455 OID for the paged results control. This control is included in the
456 searchRequest and searchResultDone messages as part of the controls
457 field of the LDAPMessage, as defined in Section 4.1.12 of
460 \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
462 #define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
465 OID for specifying the returned elements of the ntSecurityDescriptor
467 \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>
469 #define LDB_CONTROL_SD_FLAGS_OID "1.2.840.113556.1.4.801"
472 OID for specifying an advanced scope for the search (one partition)
474 \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>
476 #define LDB_CONTROL_DOMAIN_SCOPE_OID "1.2.840.113556.1.4.1339"
479 OID for specifying an advanced scope for a search
481 \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>
483 #define LDB_CONTROL_SEARCH_OPTIONS_OID "1.2.840.113556.1.4.1340"
488 \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>
490 #define LDB_CONTROL_NOTIFICATION_OID "1.2.840.113556.1.4.528"
493 OID for getting deleted objects
495 \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>
497 #define LDB_CONTROL_SHOW_DELETED_OID "1.2.840.113556.1.4.417"
500 OID for getting recycled objects
502 \sa <a href="http://msdn.microsoft.com/en-us/library/dd304621(PROT.13).aspx">Microsoft documentation of this OID</a>
504 #define LDB_CONTROL_SHOW_RECYCLED_OID "1.2.840.113556.1.4.2064"
507 OID for getting deactivated linked attributes
509 \sa <a href="http://msdn.microsoft.com/en-us/library/dd302781(PROT.13).aspx">Microsoft documentation of this OID</a>
511 #define LDB_CONTROL_SHOW_DEACTIVATED_LINK_OID "1.2.840.113556.1.4.2065"
516 \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>
518 #define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
521 OID for LDAP server sort result extension.
523 This control is included in the searchRequest message as part of
524 the controls field of the LDAPMessage, as defined in Section 4.1.12
525 of LDAP v3. The controlType is set to
526 "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
527 FALSE (where absent is also equivalent to FALSE) at the client's
530 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
532 #define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
535 OID for LDAP server sort result response extension.
537 This control is included in the searchResultDone message as part of
538 the controls field of the LDAPMessage, as defined in Section 4.1.12 of
541 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
543 #define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
546 OID for LDAP Attribute Scoped Query extension.
548 This control is included in SearchRequest or SearchResponse
549 messages as part of the controls field of the LDAPMessage.
551 #define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
554 OID for LDAP Directory Sync extension.
556 This control is included in SearchRequest or SearchResponse
557 messages as part of the controls field of the LDAPMessage.
559 #define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
563 OID for LDAP Virtual List View Request extension.
565 This control is included in SearchRequest messages
566 as part of the controls field of the LDAPMessage.
568 #define LDB_CONTROL_VLV_REQ_OID "2.16.840.1.113730.3.4.9"
571 OID for LDAP Virtual List View Response extension.
573 This control is included in SearchResponse messages
574 as part of the controls field of the LDAPMessage.
576 #define LDB_CONTROL_VLV_RESP_OID "2.16.840.1.113730.3.4.10"
579 OID to let modifies don't give an error when adding an existing
580 attribute with the same value or deleting an nonexisting one attribute
582 \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>
584 #define LDB_CONTROL_PERMISSIVE_MODIFY_OID "1.2.840.113556.1.4.1413"
587 OID for LDAP Extended Operation START_TLS.
589 This Extended operation is used to start a new TLS
590 channel on top of a clear text channel.
592 #define LDB_EXTENDED_START_TLS_OID "1.3.6.1.4.1.1466.20037"
596 #define LDB_EXTENDED_DYNAMIC_OID "1.3.6.1.4.1.1466.101.119.1"
600 #define LDB_EXTENDED_FAST_BIND_OID "1.2.840.113556.1.4.1781"
602 struct ldb_sd_flags_control
{
604 * request the owner 0x00000001
605 * request the group 0x00000002
606 * request the DACL 0x00000004
607 * request the SACL 0x00000008
609 unsigned secinfo_flags
;
613 * DOMAIN_SCOPE 0x00000001
614 * this limits the search to one partition,
615 * and no referrals will be returned.
616 * (Note this doesn't limit the entries by there
617 * objectSid belonging to a domain! Builtin and Foreign Sids
618 * are still returned)
620 * PHANTOM_ROOT 0x00000002
621 * this search on the whole tree on a domain controller
622 * over multiple partitions without referrals.
623 * (This is the default behavior on the Global Catalog Port)
626 #define LDB_SEARCH_OPTION_DOMAIN_SCOPE 0x00000001
627 #define LDB_SEARCH_OPTION_PHANTOM_ROOT 0x00000002
629 struct ldb_search_options_control
{
630 unsigned search_options
;
633 struct ldb_paged_control
{
639 struct ldb_extended_dn_control
{
643 struct ldb_server_sort_control
{
649 struct ldb_sort_resp_control
{
654 struct ldb_asq_control
{
656 char *source_attribute
;
661 struct ldb_dirsync_control
{
668 struct ldb_vlv_req_control
{
686 struct ldb_vlv_resp_control
{
700 enum ldb_request_type
{
707 LDB_REQ_REGISTER_CONTROL
,
708 LDB_REQ_REGISTER_PARTITION
711 enum ldb_reply_type
{
728 struct ldb_extended
{
730 void *data
; /* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
733 #define LDB_EXTENDED_SEQUENCE_NUMBER "1.3.6.1.4.1.7165.4.4.3"
735 enum ldb_sequence_type
{
737 LDB_SEQ_HIGHEST_TIMESTAMP
,
741 #define LDB_SEQ_GLOBAL_SEQUENCE 0x01
742 #define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
744 struct ldb_seqnum_request
{
745 enum ldb_sequence_type type
;
748 struct ldb_seqnum_result
{
755 struct ldb_message
**msgs
;
756 struct ldb_extended
*extended
;
757 struct ldb_control
**controls
;
763 enum ldb_reply_type type
;
764 struct ldb_message
*message
;
765 struct ldb_extended
*response
;
766 struct ldb_control
**controls
;
775 enum ldb_scope scope
;
776 struct ldb_parse_tree
*tree
;
777 const char * const *attrs
;
778 struct ldb_result
*res
;
782 const struct ldb_message
*message
;
786 const struct ldb_message
*message
;
794 struct ldb_dn
*olddn
;
795 struct ldb_dn
*newdn
;
798 struct ldb_register_control
{
802 struct ldb_register_partition
{
806 typedef int (*ldb_request_callback_t
)(struct ldb_request
*, struct ldb_reply
*);
810 enum ldb_request_type operation
;
813 struct ldb_search search
;
815 struct ldb_modify mod
;
816 struct ldb_delete del
;
817 struct ldb_rename rename
;
818 struct ldb_extended extended
;
819 struct ldb_register_control reg_control
;
820 struct ldb_register_partition reg_partition
;
823 struct ldb_control
**controls
;
826 ldb_request_callback_t callback
;
830 struct ldb_handle
*handle
;
833 int ldb_request(struct ldb_context
*ldb
, struct ldb_request
*request
);
834 int ldb_request_done(struct ldb_request
*req
, int status
);
835 bool ldb_request_is_done(struct ldb_request
*req
);
837 int ldb_modules_wait(struct ldb_handle
*handle
);
838 int ldb_wait(struct ldb_handle
*handle
, enum ldb_wait_type type
);
840 int ldb_set_timeout(struct ldb_context
*ldb
, struct ldb_request
*req
, int timeout
);
841 int ldb_set_timeout_from_prev_req(struct ldb_context
*ldb
, struct ldb_request
*oldreq
, struct ldb_request
*newreq
);
842 void ldb_set_create_perms(struct ldb_context
*ldb
, unsigned int perms
);
843 void ldb_set_modules_dir(struct ldb_context
*ldb
, const char *path
);
844 struct tevent_context
;
845 void ldb_set_event_context(struct ldb_context
*ldb
, struct tevent_context
*ev
);
846 struct tevent_context
* ldb_get_event_context(struct ldb_context
*ldb
);
849 Initialise ldbs' global information
851 This is required before any other LDB call
853 \return 0 if initialisation succeeded, -1 otherwise
855 int ldb_global_init(void);
858 Initialise an ldb context
860 This is required before any other LDB call.
862 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
863 no suitable context available.
865 \return pointer to ldb_context that should be free'd (using talloc_free())
866 at the end of the program.
868 struct ldb_context
*ldb_init(TALLOC_CTX
*mem_ctx
, struct tevent_context
*ev_ctx
);
871 Connect to a database.
873 This is typically called soon after ldb_init(), and is required prior to
874 any search or database modification operations.
876 The URL can be one of the following forms:
882 \param ldb the context associated with the database (from ldb_init())
883 \param url the URL of the database to connect to, as noted above
884 \param flags a combination of LDB_FLG_* to modify the connection behaviour
885 \param options backend specific options - passed uninterpreted to the backend
887 \return result code (LDB_SUCCESS on success, or a failure code)
889 \note It is an error to connect to a database that does not exist in readonly mode
890 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
891 created if it does not exist.
894 typedef void (*ldb_async_timeout_fn
) (void *);
895 typedef bool (*ldb_async_callback_fn
) (void *);
896 typedef int (*ldb_async_ctx_add_op_fn
)(void *, time_t, void *, ldb_async_timeout_fn
, ldb_async_callback_fn
);
897 typedef int (*ldb_async_ctx_wait_op_fn
)(void *);
899 void ldb_async_ctx_set_private_data(struct ldb_context
*ldb
,
901 void ldb_async_ctx_set_add_op(struct ldb_context
*ldb
,
902 ldb_async_ctx_add_op_fn add_op
);
903 void ldb_async_ctx_set_wait_op(struct ldb_context
*ldb
,
904 ldb_async_ctx_wait_op_fn wait_op
);
906 int ldb_connect(struct ldb_context
*ldb
, const char *url
, unsigned int flags
, const char *options
[]);
909 return an automatic basedn from the rootDomainNamingContext of the rootDSE
910 This value have been set in an opaque pointer at connection time
912 struct ldb_dn
*ldb_get_root_basedn(struct ldb_context
*ldb
);
915 return an automatic basedn from the configurationNamingContext of the rootDSE
916 This value have been set in an opaque pointer at connection time
918 struct ldb_dn
*ldb_get_config_basedn(struct ldb_context
*ldb
);
921 return an automatic basedn from the schemaNamingContext of the rootDSE
922 This value have been set in an opaque pointer at connection time
924 struct ldb_dn
*ldb_get_schema_basedn(struct ldb_context
*ldb
);
927 return an automatic baseDN from the defaultNamingContext of the rootDSE
928 This value have been set in an opaque pointer at connection time
930 struct ldb_dn
*ldb_get_default_basedn(struct ldb_context
*ldb
);
933 The default async search callback function
935 \param req the request we are callback of
936 \param ares a single reply from the async core
938 \return result code (LDB_SUCCESS on success, or a failure code)
940 \note this function expects req->context to always be an struct ldb_result pointer
941 AND a talloc context, this function will steal on the context each message
942 from the ares reply passed on by the async core so that in the end all the
943 messages will be in the context (ldb_result) memory tree.
944 Freeing the passed context (ldb_result tree) will free all the resources
945 (the request need to be freed separately and the result doe not depend on the
946 request that can be freed as sson as the search request is finished)
949 int ldb_search_default_callback(struct ldb_request
*req
, struct ldb_reply
*ares
);
952 The default async extended operation callback function
954 \param req the request we are callback of
955 \param ares a single reply from the async core
957 \return result code (LDB_SUCCESS on success, or a failure code)
959 int ldb_op_default_callback(struct ldb_request
*req
, struct ldb_reply
*ares
);
963 Helper function to build a search request
965 \param ret_req the request structure is returned here (talloced on mem_ctx)
966 \param ldb the context associated with the database (from ldb_init())
967 \param mem_ctx a talloc memory context (used as parent of ret_req)
968 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
969 \param scope the search scope for the query
970 \param expression the search expression to use for this query
971 \param attrs the search attributes for the query (pass NULL if none required)
972 \param controls an array of controls
973 \param context the callback function context
974 \param the callback function to handle the async replies
975 \param the parent request if any
977 \return result code (LDB_SUCCESS on success, or a failure code)
980 int ldb_build_search_req(struct ldb_request
**ret_req
,
981 struct ldb_context
*ldb
,
984 enum ldb_scope scope
,
985 const char *expression
,
986 const char * const *attrs
,
987 struct ldb_control
**controls
,
989 ldb_request_callback_t callback
,
990 struct ldb_request
*parent
);
992 int ldb_build_search_req_ex(struct ldb_request
**ret_req
,
993 struct ldb_context
*ldb
,
996 enum ldb_scope scope
,
997 struct ldb_parse_tree
*tree
,
998 const char * const *attrs
,
999 struct ldb_control
**controls
,
1001 ldb_request_callback_t callback
,
1002 struct ldb_request
*parent
);
1005 Helper function to build an add request
1007 \param ret_req the request structure is returned here (talloced on mem_ctx)
1008 \param ldb the context associated with the database (from ldb_init())
1009 \param mem_ctx a talloc memory context (used as parent of ret_req)
1010 \param message contains the entry to be added
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_add_req(struct ldb_request
**ret_req
,
1020 struct ldb_context
*ldb
,
1021 TALLOC_CTX
*mem_ctx
,
1022 const struct ldb_message
*message
,
1023 struct ldb_control
**controls
,
1025 ldb_request_callback_t callback
,
1026 struct ldb_request
*parent
);
1029 Helper function to build a modify request
1031 \param ret_req the request structure is returned here (talloced on mem_ctx)
1032 \param ldb the context associated with the database (from ldb_init())
1033 \param mem_ctx a talloc memory context (used as parent of ret_req)
1034 \param message contains the entry to be modified
1035 \param controls an array of controls
1036 \param context the callback function context
1037 \param the callback function to handle the async replies
1038 \param the parent request if any
1040 \return result code (LDB_SUCCESS on success, or a failure code)
1043 int ldb_build_mod_req(struct ldb_request
**ret_req
,
1044 struct ldb_context
*ldb
,
1045 TALLOC_CTX
*mem_ctx
,
1046 const struct ldb_message
*message
,
1047 struct ldb_control
**controls
,
1049 ldb_request_callback_t callback
,
1050 struct ldb_request
*parent
);
1053 Helper function to build a delete request
1055 \param ret_req the request structure is returned here (talloced on mem_ctx)
1056 \param ldb the context associated with the database (from ldb_init())
1057 \param mem_ctx a talloc memory context (used as parent of ret_req)
1058 \param dn the DN to be deleted
1059 \param controls an array of controls
1060 \param context the callback function context
1061 \param the callback function to handle the async replies
1062 \param the parent request if any
1064 \return result code (LDB_SUCCESS on success, or a failure code)
1067 int ldb_build_del_req(struct ldb_request
**ret_req
,
1068 struct ldb_context
*ldb
,
1069 TALLOC_CTX
*mem_ctx
,
1071 struct ldb_control
**controls
,
1073 ldb_request_callback_t callback
,
1074 struct ldb_request
*parent
);
1077 Helper function to build a rename request
1079 \param ret_req the request structure is returned here (talloced on mem_ctx)
1080 \param ldb the context associated with the database (from ldb_init())
1081 \param mem_ctx a talloc memory context (used as parent of ret_req)
1082 \param olddn the old DN
1083 \param newdn the new DN
1084 \param controls an array of controls
1085 \param context the callback function context
1086 \param the callback function to handle the async replies
1087 \param the parent request if any
1089 \return result code (LDB_SUCCESS on success, or a failure code)
1092 int ldb_build_rename_req(struct ldb_request
**ret_req
,
1093 struct ldb_context
*ldb
,
1094 TALLOC_CTX
*mem_ctx
,
1095 struct ldb_dn
*olddn
,
1096 struct ldb_dn
*newdn
,
1097 struct ldb_control
**controls
,
1099 ldb_request_callback_t callback
,
1100 struct ldb_request
*parent
);
1103 Add a ldb_control to a ldb_request
1105 \param req the request struct where to add the control
1106 \param oid the object identifier of the control as string
1107 \param critical whether the control should be critical or not
1108 \param data a talloc pointer to the control specific data
1110 \return result code (LDB_SUCCESS on success, or a failure code)
1112 int ldb_request_add_control(struct ldb_request
*req
, const char *oid
, bool critical
, void *data
);
1115 check if a control with the specified "oid" exist and return it
1116 \param req the request struct where to add the control
1117 \param oid the object identifier of the control as string
1119 \return the control, NULL if not found
1121 struct ldb_control
*ldb_request_get_control(struct ldb_request
*req
, const char *oid
);
1124 check if a control with the specified "oid" exist and return it
1125 \param rep the reply struct where to add the control
1126 \param oid the object identifier of the control as string
1128 \return the control, NULL if not found
1130 struct ldb_control
*ldb_reply_get_control(struct ldb_reply
*rep
, const char *oid
);
1135 This function searches the database, and returns
1136 records that match an LDAP-like search expression
1138 \param ldb the context associated with the database (from ldb_init())
1139 \param mem_ctx the memory context to use for the request and the results
1140 \param result the return result
1141 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1142 \param scope the search scope for the query
1143 \param attrs the search attributes for the query (pass NULL if none required)
1144 \param exp_fmt the search expression to use for this query (printf like)
1146 \return result code (LDB_SUCCESS on success, or a failure code)
1148 \note use talloc_free() to free the ldb_result returned
1150 int ldb_search(struct ldb_context
*ldb
, TALLOC_CTX
*mem_ctx
,
1151 struct ldb_result
**result
, struct ldb_dn
*base
,
1152 enum ldb_scope scope
, const char * const *attrs
,
1153 const char *exp_fmt
, ...) PRINTF_ATTRIBUTE(7,8);
1156 Add a record to the database.
1158 This function adds a record to the database. This function will fail
1159 if a record with the specified class and key already exists in the
1162 \param ldb the context associated with the database (from
1164 \param message the message containing the record to add.
1166 \return result code (LDB_SUCCESS if the record was added, otherwise
1169 int ldb_add(struct ldb_context
*ldb
,
1170 const struct ldb_message
*message
);
1173 Modify the specified attributes of a record
1175 This function modifies a record that is in the database.
1177 \param ldb the context associated with the database (from
1179 \param message the message containing the changes required.
1181 \return result code (LDB_SUCCESS if the record was modified as
1182 requested, otherwise a failure code)
1184 int ldb_modify(struct ldb_context
*ldb
,
1185 const struct ldb_message
*message
);
1188 Rename a record in the database
1190 This function renames a record in the database.
1192 \param ldb the context associated with the database (from
1194 \param olddn the DN for the record to be renamed.
1195 \param newdn the new DN
1197 \return result code (LDB_SUCCESS if the record was renamed as
1198 requested, otherwise a failure code)
1200 int ldb_rename(struct ldb_context
*ldb
, struct ldb_dn
*olddn
, struct ldb_dn
*newdn
);
1203 Delete a record from the database
1205 This function deletes a record from the database.
1207 \param ldb the context associated with the database (from
1209 \param dn the DN for the record to be deleted.
1211 \return result code (LDB_SUCCESS if the record was deleted,
1212 otherwise a failure code)
1214 int ldb_delete(struct ldb_context
*ldb
, struct ldb_dn
*dn
);
1217 The default async extended operation callback function
1219 \param req the request we are callback of
1220 \param ares a single reply from the async core
1222 \return result code (LDB_SUCCESS on success, or a failure code)
1224 \note this function expects req->context to always be an struct ldb_result pointer
1225 AND a talloc context, this function will steal on the context each message
1226 from the ares reply passed on by the async core so that in the end all the
1227 messages will be in the context (ldb_result) memory tree.
1228 Freeing the passed context (ldb_result tree) will free all the resources
1229 (the request need to be freed separately and the result doe not depend on the
1230 request that can be freed as sson as the search request is finished)
1233 int ldb_extended_default_callback(struct ldb_request
*req
, struct ldb_reply
*ares
);
1237 Helper function to build a extended request
1239 \param ret_req the request structure is returned here (talloced on mem_ctx)
1240 \param ldb the context associated with the database (from ldb_init())
1241 \param mem_ctx a talloc memory context (used as parent of ret_req)
1242 \param oid the OID of the extended operation.
1243 \param data a void pointer a the extended operation specific parameters,
1244 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1245 \param controls an array of controls
1246 \param context the callback function context
1247 \param the callback function to handle the async replies
1248 \param the parent request if any
1250 \return result code (LDB_SUCCESS on success, or a failure code)
1252 int ldb_build_extended_req(struct ldb_request
**ret_req
,
1253 struct ldb_context
*ldb
,
1254 TALLOC_CTX
*mem_ctx
,
1256 void *data
,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1257 struct ldb_control
**controls
,
1259 ldb_request_callback_t callback
,
1260 struct ldb_request
*parent
);
1263 call an extended operation
1265 This function deletes a record from the database.
1267 \param ldb the context associated with the database (from ldb_init())
1268 \param oid the OID of the extended operation.
1269 \param data a void pointer a the extended operation specific parameters,
1270 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1271 \param res the result of the extended operation
1273 \return result code (LDB_SUCCESS if the extended operation returned fine,
1274 otherwise a failure code)
1276 int ldb_extended(struct ldb_context
*ldb
,
1278 void *data
,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1279 struct ldb_result
**res
);
1282 Obtain current/next database sequence number
1284 int ldb_sequence_number(struct ldb_context
*ldb
, enum ldb_sequence_type type
, uint64_t *seq_num
);
1289 int ldb_transaction_start(struct ldb_context
*ldb
);
1292 first phase of two phase commit
1294 int ldb_transaction_prepare_commit(struct ldb_context
*ldb
);
1297 commit a transaction
1299 int ldb_transaction_commit(struct ldb_context
*ldb
);
1302 cancel a transaction
1304 int ldb_transaction_cancel(struct ldb_context
*ldb
);
1308 return extended error information from the last call
1310 const char *ldb_errstring(struct ldb_context
*ldb
);
1313 return a string explaining what a ldb error constant meancs
1315 const char *ldb_strerror(int ldb_err
);
1318 setup the default utf8 functions
1319 FIXME: these functions do not yet handle utf8
1321 void ldb_set_utf8_default(struct ldb_context
*ldb
);
1326 \param ldb the ldb context
1327 \param mem_ctx the memory context to allocate the result string
1329 \param s the string that is to be folded
1330 \return a copy of the string, converted to upper case
1332 \note The default function is not yet UTF8 aware. Provide your own
1333 set of functions through ldb_set_utf8_fns()
1335 char *ldb_casefold(struct ldb_context
*ldb
, TALLOC_CTX
*mem_ctx
, const char *s
, size_t n
);
1338 Check the attribute name is valid according to rfc2251
1339 \param s the string to check
1341 \return 1 if the name is ok
1343 int ldb_valid_attr_name(const char *s
);
1346 ldif manipulation functions
1350 Write an LDIF message
1352 This function writes an LDIF message using a caller supplied write
1355 \param ldb the ldb context (from ldb_init())
1356 \param fprintf_fn a function pointer for the write function. This must take
1357 a private data pointer, followed by a format string, and then a variable argument
1359 \param private_data pointer that will be provided back to the write
1360 function. This is useful for maintaining state or context.
1361 \param ldif the message to write out
1363 \return the total number of bytes written, or an error code as returned
1364 from the write function.
1366 \sa ldb_ldif_write_file for a more convenient way to write to a
1369 \sa ldb_ldif_read for the reader equivalent to this function.
1371 int ldb_ldif_write(struct ldb_context
*ldb
,
1372 int (*fprintf_fn
)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1374 const struct ldb_ldif
*ldif
);
1377 Clean up an LDIF message
1379 This function cleans up a LDIF message read using ldb_ldif_read()
1380 or related functions (such as ldb_ldif_read_string() and
1381 ldb_ldif_read_file().
1383 \param ldb the ldb context (from ldb_init())
1384 \param msg the message to clean up and free
1387 void ldb_ldif_read_free(struct ldb_context
*ldb
, struct ldb_ldif
*msg
);
1390 Read an LDIF message
1392 This function creates an LDIF message using a caller supplied read
1395 \param ldb the ldb context (from ldb_init())
1396 \param fgetc_fn a function pointer for the read function. This must
1397 take a private data pointer, and must return a pointer to an
1398 integer corresponding to the next byte read (or EOF if there is no
1399 more data to be read).
1400 \param private_data pointer that will be provided back to the read
1401 function. This is udeful for maintaining state or context.
1403 \return the LDIF message that has been read in
1405 \note You must free the LDIF message when no longer required, using
1406 ldb_ldif_read_free().
1408 \sa ldb_ldif_read_file for a more convenient way to read from a
1411 \sa ldb_ldif_read_string for a more convenient way to read from a
1412 string (char array).
1414 \sa ldb_ldif_write for the writer equivalent to this function.
1416 struct ldb_ldif
*ldb_ldif_read(struct ldb_context
*ldb
,
1417 int (*fgetc_fn
)(void *), void *private_data
);
1420 Read an LDIF message from a file
1422 This function reads the next LDIF message from the contents of a
1423 file stream. If you want to get all of the LDIF messages, you will
1424 need to repeatedly call this function, until it returns NULL.
1426 \param ldb the ldb context (from ldb_init())
1427 \param f the file stream to read from (typically from fdopen())
1429 \sa ldb_ldif_read_string for an equivalent function that will read
1430 from a string (char array).
1432 \sa ldb_ldif_write_file for the writer equivalent to this function.
1435 struct ldb_ldif
*ldb_ldif_read_file(struct ldb_context
*ldb
, FILE *f
);
1438 Read an LDIF message from a string
1440 This function reads the next LDIF message from the contents of a char
1441 array. If you want to get all of the LDIF messages, you will need
1442 to repeatedly call this function, until it returns NULL.
1444 \param ldb the ldb context (from ldb_init())
1445 \param s pointer to the char array to read from
1447 \sa ldb_ldif_read_file for an equivalent function that will read
1450 \sa ldb_ldif_write for a more general (arbitrary read function)
1451 version of this function.
1453 struct ldb_ldif
*ldb_ldif_read_string(struct ldb_context
*ldb
, const char **s
);
1456 Write an LDIF message to a file
1458 \param ldb the ldb context (from ldb_init())
1459 \param f the file stream to write to (typically from fdopen())
1460 \param msg the message to write out
1462 \return the total number of bytes written, or a negative error code
1464 \sa ldb_ldif_read_file for the reader equivalent to this function.
1466 int ldb_ldif_write_file(struct ldb_context
*ldb
, FILE *f
, const struct ldb_ldif
*msg
);
1469 Write an LDIF message to a string
1471 \param ldb the ldb context (from ldb_init())
1472 \param mem_ctx the talloc context on which to attach the string)
1473 \param msg the message to write out
1475 \return the string containing the LDIF, or NULL on error
1477 \sa ldb_ldif_read_string for the reader equivalent to this function.
1479 char * ldb_ldif_write_string(struct ldb_context
*ldb
, TALLOC_CTX
*mem_ctx
,
1480 const struct ldb_ldif
*msg
);
1484 Produce a string form of an ldb message
1486 convenient function to turn a ldb_message into a string. Useful for
1489 char *ldb_ldif_message_string(struct ldb_context
*ldb
, TALLOC_CTX
*mem_ctx
,
1490 enum ldb_changetype changetype
,
1491 const struct ldb_message
*msg
);
1495 Base64 encode a buffer
1497 \param mem_ctx the memory context that the result is allocated
1499 \param buf pointer to the array that is to be encoded
1500 \param len the number of elements in the array to be encoded
1502 \return pointer to an array containing the encoded data
1504 \note The caller is responsible for freeing the result
1506 char *ldb_base64_encode(TALLOC_CTX
*mem_ctx
, const char *buf
, int len
);
1509 Base64 decode a buffer
1511 This function decodes a base64 encoded string in place.
1513 \param s the string to decode.
1515 \return the length of the returned (decoded) string.
1517 \note the string is null terminated, but the null terminator is not
1518 included in the length.
1520 int ldb_base64_decode(char *s
);
1522 /* The following definitions come from lib/ldb/common/ldb_dn.c */
1525 Get the linear form of a DN (without any extended components)
1527 \param dn The DN to linearize
1530 const char *ldb_dn_get_linearized(struct ldb_dn
*dn
);
1533 Allocate a copy of the linear form of a DN (without any extended components) onto the supplied memory context
1535 \param dn The DN to linearize
1536 \param mem_ctx TALLOC context to return result on
1539 char *ldb_dn_alloc_linearized(TALLOC_CTX
*mem_ctx
, struct ldb_dn
*dn
);
1542 Get the linear form of a DN (with any extended components)
1544 \param mem_ctx TALLOC context to return result on
1545 \param dn The DN to linearize
1546 \param mode Style of extended DN to return (0 is HEX representation of binary form, 1 is a string form)
1548 char *ldb_dn_get_extended_linearized(void *mem_ctx
, struct ldb_dn
*dn
, int mode
);
1549 const struct ldb_val
*ldb_dn_get_extended_component(struct ldb_dn
*dn
, const char *name
);
1550 int ldb_dn_set_extended_component(struct ldb_dn
*dn
, const char *name
, const struct ldb_val
*val
);
1552 void ldb_dn_remove_extended_components(struct ldb_dn
*dn
);
1553 bool ldb_dn_has_extended(struct ldb_dn
*dn
);
1555 int ldb_dn_extended_add_syntax(struct ldb_context
*ldb
,
1557 const struct ldb_dn_extended_syntax
*syntax
);
1560 Allocate a new DN from a string
1562 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1563 \param dn The new DN
1565 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1568 struct ldb_dn
*ldb_dn_new(TALLOC_CTX
*mem_ctx
, struct ldb_context
*ldb
, const char *dn
);
1570 Allocate a new DN from a printf style format string and arguments
1572 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1573 \param new_fms The new DN as a format string (plus arguments)
1575 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1578 struct ldb_dn
*ldb_dn_new_fmt(TALLOC_CTX
*mem_ctx
, struct ldb_context
*ldb
, const char *new_fmt
, ...) PRINTF_ATTRIBUTE(3,4);
1580 Allocate a new DN from a struct ldb_val (useful to avoid buffer overrun)
1582 \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1583 \param dn The new DN
1585 \note The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntacticly correct
1588 struct ldb_dn
*ldb_dn_from_ldb_val(void *mem_ctx
, struct ldb_context
*ldb
, const struct ldb_val
*strdn
);
1591 Determine if this DN is syntactically valid
1593 \param dn The DN to validate
1596 bool ldb_dn_validate(struct ldb_dn
*dn
);
1598 char *ldb_dn_escape_value(TALLOC_CTX
*mem_ctx
, struct ldb_val value
);
1599 const char *ldb_dn_get_casefold(struct ldb_dn
*dn
);
1600 char *ldb_dn_alloc_casefold(TALLOC_CTX
*mem_ctx
, struct ldb_dn
*dn
);
1602 int ldb_dn_compare_base(struct ldb_dn
*base
, struct ldb_dn
*dn
);
1603 int ldb_dn_compare(struct ldb_dn
*edn0
, struct ldb_dn
*edn1
);
1605 bool ldb_dn_add_base(struct ldb_dn
*dn
, struct ldb_dn
*base
);
1606 bool ldb_dn_add_base_fmt(struct ldb_dn
*dn
, const char *base_fmt
, ...) PRINTF_ATTRIBUTE(2,3);
1607 bool ldb_dn_add_child(struct ldb_dn
*dn
, struct ldb_dn
*child
);
1608 bool ldb_dn_add_child_fmt(struct ldb_dn
*dn
, const char *child_fmt
, ...) PRINTF_ATTRIBUTE(2,3);
1609 bool ldb_dn_remove_base_components(struct ldb_dn
*dn
, unsigned int num
);
1610 bool ldb_dn_remove_child_components(struct ldb_dn
*dn
, unsigned int num
);
1612 struct ldb_dn
*ldb_dn_copy(TALLOC_CTX
*mem_ctx
, struct ldb_dn
*dn
);
1613 struct ldb_dn
*ldb_dn_get_parent(TALLOC_CTX
*mem_ctx
, struct ldb_dn
*dn
);
1614 char *ldb_dn_canonical_string(TALLOC_CTX
*mem_ctx
, struct ldb_dn
*dn
);
1615 char *ldb_dn_canonical_ex_string(TALLOC_CTX
*mem_ctx
, struct ldb_dn
*dn
);
1616 int ldb_dn_get_comp_num(struct ldb_dn
*dn
);
1617 const char *ldb_dn_get_component_name(struct ldb_dn
*dn
, unsigned int num
);
1618 const struct ldb_val
*ldb_dn_get_component_val(struct ldb_dn
*dn
, unsigned int num
);
1619 const char *ldb_dn_get_rdn_name(struct ldb_dn
*dn
);
1620 const struct ldb_val
*ldb_dn_get_rdn_val(struct ldb_dn
*dn
);
1621 int ldb_dn_set_component(struct ldb_dn
*dn
, int num
, const char *name
, const struct ldb_val val
);
1623 bool ldb_dn_is_valid(struct ldb_dn
*dn
);
1624 bool ldb_dn_is_special(struct ldb_dn
*dn
);
1625 bool ldb_dn_check_special(struct ldb_dn
*dn
, const char *check
);
1626 bool ldb_dn_is_null(struct ldb_dn
*dn
);
1630 Compare two attributes
1632 This function compares to attribute names. Note that this is a
1633 case-insensitive comparison.
1635 \param a the first attribute name to compare
1636 \param b the second attribute name to compare
1638 \return 0 if the attribute names are the same, or only differ in
1639 case; non-zero if there are any differences
1641 attribute names are restricted by rfc2251 so using
1642 strcasecmp and toupper here is ok.
1645 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1646 char *ldb_attr_casefold(TALLOC_CTX
*mem_ctx
, const char *s
);
1647 int ldb_attr_dn(const char *attr
);
1650 Create an empty message
1652 \param mem_ctx the memory context to create in. You can pass NULL
1653 to get the top level context, however the ldb context (from
1654 ldb_init()) may be a better choice
1656 struct ldb_message
*ldb_msg_new(TALLOC_CTX
*mem_ctx
);
1659 Find an element within an message
1661 struct ldb_message_element
*ldb_msg_find_element(const struct ldb_message
*msg
,
1662 const char *attr_name
);
1665 Compare two ldb_val values
1667 \param v1 first ldb_val structure to be tested
1668 \param v2 second ldb_val structure to be tested
1670 \return 1 for a match, 0 if there is any difference
1672 int ldb_val_equal_exact(const struct ldb_val
*v1
, const struct ldb_val
*v2
);
1675 find a value within an ldb_message_element
1677 \param el the element to search
1678 \param val the value to search for
1680 \note This search is case sensitive
1682 struct ldb_val
*ldb_msg_find_val(const struct ldb_message_element
*el
,
1683 struct ldb_val
*val
);
1686 add a new empty element to a ldb_message
1688 int ldb_msg_add_empty(struct ldb_message
*msg
,
1689 const char *attr_name
,
1691 struct ldb_message_element
**return_el
);
1694 add a element to a ldb_message
1696 int ldb_msg_add(struct ldb_message
*msg
,
1697 const struct ldb_message_element
*el
,
1699 int ldb_msg_add_value(struct ldb_message
*msg
,
1700 const char *attr_name
,
1701 const struct ldb_val
*val
,
1702 struct ldb_message_element
**return_el
);
1703 int ldb_msg_add_steal_value(struct ldb_message
*msg
,
1704 const char *attr_name
,
1705 struct ldb_val
*val
);
1706 int ldb_msg_add_steal_string(struct ldb_message
*msg
,
1707 const char *attr_name
, char *str
);
1708 int ldb_msg_add_string(struct ldb_message
*msg
,
1709 const char *attr_name
, const char *str
);
1710 int ldb_msg_add_fmt(struct ldb_message
*msg
,
1711 const char *attr_name
, const char *fmt
, ...) PRINTF_ATTRIBUTE(3,4);
1714 compare two message elements - return 0 on match
1716 int ldb_msg_element_compare(struct ldb_message_element
*el1
,
1717 struct ldb_message_element
*el2
);
1718 int ldb_msg_element_compare_name(struct ldb_message_element
*el1
,
1719 struct ldb_message_element
*el2
);
1722 Find elements in a message.
1724 This function finds elements and converts to a specific type, with
1725 a give default value if not found. Assumes that elements are
1728 const struct ldb_val
*ldb_msg_find_ldb_val(const struct ldb_message
*msg
, const char *attr_name
);
1729 int ldb_msg_find_attr_as_int(const struct ldb_message
*msg
,
1730 const char *attr_name
,
1732 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message
*msg
,
1733 const char *attr_name
,
1734 unsigned int default_value
);
1735 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message
*msg
,
1736 const char *attr_name
,
1737 int64_t default_value
);
1738 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message
*msg
,
1739 const char *attr_name
,
1740 uint64_t default_value
);
1741 double ldb_msg_find_attr_as_double(const struct ldb_message
*msg
,
1742 const char *attr_name
,
1743 double default_value
);
1744 int ldb_msg_find_attr_as_bool(const struct ldb_message
*msg
,
1745 const char *attr_name
,
1747 const char *ldb_msg_find_attr_as_string(const struct ldb_message
*msg
,
1748 const char *attr_name
,
1749 const char *default_value
);
1751 struct ldb_dn
*ldb_msg_find_attr_as_dn(struct ldb_context
*ldb
,
1752 TALLOC_CTX
*mem_ctx
,
1753 const struct ldb_message
*msg
,
1754 const char *attr_name
);
1756 void ldb_msg_sort_elements(struct ldb_message
*msg
);
1758 struct ldb_message
*ldb_msg_copy_shallow(TALLOC_CTX
*mem_ctx
,
1759 const struct ldb_message
*msg
);
1760 struct ldb_message
*ldb_msg_copy(TALLOC_CTX
*mem_ctx
,
1761 const struct ldb_message
*msg
);
1763 struct ldb_message
*ldb_msg_canonicalize(struct ldb_context
*ldb
,
1764 const struct ldb_message
*msg
);
1767 struct ldb_message
*ldb_msg_diff(struct ldb_context
*ldb
,
1768 struct ldb_message
*msg1
,
1769 struct ldb_message
*msg2
);
1771 int ldb_msg_check_string_attribute(const struct ldb_message
*msg
,
1776 Integrity check an ldb_message
1778 This function performs basic sanity / integrity checks on an
1781 \param ldb context in which to perform the checks
1782 \param msg the message to check
1784 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1785 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1786 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1789 int ldb_msg_sanity_check(struct ldb_context
*ldb
,
1790 const struct ldb_message
*msg
);
1793 Duplicate an ldb_val structure
1795 This function copies an ldb value structure.
1797 \param mem_ctx the memory context that the duplicated value will be
1799 \param v the ldb_val to be duplicated.
1801 \return the duplicated ldb_val structure.
1803 struct ldb_val
ldb_val_dup(TALLOC_CTX
*mem_ctx
, const struct ldb_val
*v
);
1806 this allows the user to set a debug function for error reporting
1808 int ldb_set_debug(struct ldb_context
*ldb
,
1809 void (*debug
)(void *context
, enum ldb_debug_level level
,
1810 const char *fmt
, va_list ap
) PRINTF_ATTRIBUTE(3,0),
1814 this allows the user to set custom utf8 function for error reporting
1816 void ldb_set_utf8_fns(struct ldb_context
*ldb
,
1818 char *(*casefold
)(void *, void *, const char *, size_t n
));
1821 this sets up debug to print messages on stderr
1823 int ldb_set_debug_stderr(struct ldb_context
*ldb
);
1825 /* control backend specific opaque values */
1826 int ldb_set_opaque(struct ldb_context
*ldb
, const char *name
, void *value
);
1827 void *ldb_get_opaque(struct ldb_context
*ldb
, const char *name
);
1829 const char **ldb_attr_list_copy(TALLOC_CTX
*mem_ctx
, const char * const *attrs
);
1830 const char **ldb_attr_list_copy_add(TALLOC_CTX
*mem_ctx
, const char * const *attrs
, const char *new_attr
);
1831 int ldb_attr_in_list(const char * const *attrs
, const char *attr
);
1833 int ldb_msg_rename_attr(struct ldb_message
*msg
, const char *attr
, const char *replace
);
1834 int ldb_msg_copy_attr(struct ldb_message
*msg
, const char *attr
, const char *replace
);
1835 void ldb_msg_remove_attr(struct ldb_message
*msg
, const char *attr
);
1836 void ldb_msg_remove_element(struct ldb_message
*msg
, struct ldb_message_element
*el
);
1839 void ldb_parse_tree_attr_replace(struct ldb_parse_tree
*tree
,
1841 const char *replace
);
1844 shallow copy a tree - copying only the elements array so that the caller
1845 can safely add new elements without changing the message
1847 struct ldb_parse_tree
*ldb_parse_tree_copy_shallow(TALLOC_CTX
*mem_ctx
,
1848 const struct ldb_parse_tree
*ot
);
1851 Convert a time structure to a string
1853 This function converts a time_t structure to an LDAP formatted
1854 GeneralizedTime string.
1856 \param mem_ctx the memory context to allocate the return string in
1857 \param t the time structure to convert
1859 \return the formatted string, or NULL if the time structure could
1862 char *ldb_timestring(TALLOC_CTX
*mem_ctx
, time_t t
);
1865 Convert a string to a time structure
1867 This function converts an LDAP formatted GeneralizedTime string
1868 to a time_t structure.
1870 \param s the string to convert
1872 \return the time structure, or 0 if the string cannot be converted
1874 time_t ldb_string_to_time(const char *s
);
1877 Convert a time structure to a string
1879 This function converts a time_t structure to an LDAP formatted
1882 \param mem_ctx the memory context to allocate the return string in
1883 \param t the time structure to convert
1885 \return the formatted string, or NULL if the time structure could
1888 char *ldb_timestring_utc(TALLOC_CTX
*mem_ctx
, time_t t
);
1891 Convert a string to a time structure
1893 This function converts an LDAP formatted UTCTime string
1894 to a time_t structure.
1896 \param s the string to convert
1898 \return the time structure, or 0 if the string cannot be converted
1900 time_t ldb_string_utc_to_time(const char *s
);
1903 void ldb_qsort (void *const pbase
, size_t total_elems
, size_t size
, void *opaque
, ldb_qsort_cmp_fn_t cmp
);
1907 Convert an array of string represention of a control into an array of ldb_control structures
1909 \param ldb LDB context
1910 \param mem_ctx TALLOC context to return result on, and to allocate error_string on
1911 \param control_strings Array of string-formatted controls
1913 \return array of ldb_control elements
1915 struct ldb_control
**ldb_parse_control_strings(struct ldb_context
*ldb
, TALLOC_CTX
*mem_ctx
, const char **control_strings
);
1918 return the ldb flags
1920 unsigned int ldb_get_flags(struct ldb_context
*ldb
);
1922 /* set the ldb flags */
1923 void ldb_set_flags(struct ldb_context
*ldb
, unsigned flags
);