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 2 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, write to the Free Software
24 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * Component: ldb header
32 * Description: defines for base ldb API
34 * Author: Andrew Tridgell
35 * Author: Stefan Metzmacher
39 \file ldb.h Samba's ldb database
41 This header file provides the main API for ldb.
46 /*! \cond DOXYGEN_IGNORE */
51 major restrictions as compared to normal LDAP:
54 - each record must have a unique key field
55 - the key must be representable as a NULL terminated C string and may not
56 contain a comma or braces
58 major restrictions as compared to tdb:
60 - no explicit locking calls
61 UPDATE: we have transactions now, better than locking --SSS.
69 An individual lump of data in a result comes in this format. The
70 pointer will usually be to a UTF-8 string if the application is
71 sensible, but it can be to anything you like, including binary data
72 blobs of arbitrary size.
74 \note the data is null (0x00) terminated, but the length does not
75 include the terminator.
78 uint8_t *data; /*!< result data */
79 size_t length; /*!< length of data */
83 /*! \cond DOXYGEN_IGNORE */
84 #ifndef PRINTF_ATTRIBUTE
85 #define PRINTF_ATTRIBUTE(a,b)
89 /* opaque ldb_dn structures, see ldb_dn.c for internals */
90 struct ldb_dn_component;
94 There are a number of flags that are used with ldap_modify() in
95 ldb_message_element.flags fields. The LDA_FLAGS_MOD_ADD,
96 LDA_FLAGS_MOD_DELETE and LDA_FLAGS_MOD_REPLACE flags are used in
97 ldap_modify() calls to specify whether attributes are being added,
98 deleted or modified respectively.
100 #define LDB_FLAG_MOD_MASK 0x3
103 Flag value used in ldap_modify() to indicate that attributes are
106 \sa LDB_FLAG_MOD_MASK
108 #define LDB_FLAG_MOD_ADD 1
111 Flag value used in ldap_modify() to indicate that attributes are
114 \sa LDB_FLAG_MOD_MASK
116 #define LDB_FLAG_MOD_REPLACE 2
119 Flag value used in ldap_modify() to indicate that attributes are
122 \sa LDB_FLAG_MOD_MASK
124 #define LDB_FLAG_MOD_DELETE 3
127 OID for logic AND comaprison.
129 This is the well known object ID for a logical AND comparitor.
131 #define LDB_OID_COMPARATOR_AND "1.2.840.113556.1.4.803"
134 OID for logic OR comparison.
136 This is the well known object ID for a logical OR comparitor.
138 #define LDB_OID_COMPARATOR_OR "1.2.840.113556.1.4.804"
141 results are given back as arrays of ldb_message_element
143 struct ldb_message_element {
146 unsigned int num_values;
147 struct ldb_val *values;
152 a ldb_message represents all or part of a record. It can contain an arbitrary
157 unsigned int num_elements;
158 struct ldb_message_element *elements;
159 void *private_data; /* private to the backend */
162 enum ldb_changetype {
163 LDB_CHANGETYPE_NONE=0,
165 LDB_CHANGETYPE_DELETE,
166 LDB_CHANGETYPE_MODIFY
172 This structure contains a LDIF record, as returned from ldif_read()
173 and equivalent functions.
176 enum ldb_changetype changetype; /*!< The type of change */
177 struct ldb_message *msg; /*!< The changes */
180 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
182 LDB_SCOPE_ONELEVEL=1,
183 LDB_SCOPE_SUBTREE=2};
187 /* debugging uses one of the following levels */
188 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
189 LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
192 the user can optionally supply a debug function. The function
193 is based on the vfprintf() style of interface, but with the addition
196 struct ldb_debug_ops {
197 void (*debug)(void *context, enum ldb_debug_level level,
198 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
203 The user can optionally supply a custom utf8 functions,
204 to handle comparisons and casefolding.
206 struct ldb_utf8_fns {
208 char *(*casefold)(void *context, void *mem_ctx, const char *s);
212 Flag value for database connection mode.
214 If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
215 opened read-only, if possible.
217 #define LDB_FLG_RDONLY 1
220 Flag value for database connection mode.
222 If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
223 opened without synchronous operations, if possible.
225 #define LDB_FLG_NOSYNC 2
228 Flag value to specify autoreconnect mode.
230 If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
231 be opened in a way that makes it try to auto reconnect if the
232 connection is dropped (actually make sense only with ldap).
234 #define LDB_FLG_RECONNECT 4
237 structures for ldb_parse_tree handling code
239 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
240 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
241 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
242 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
244 struct ldb_parse_tree {
245 enum ldb_parse_op operation;
248 struct ldb_parse_tree *child;
252 struct ldb_val value;
256 int start_with_wildcard;
257 int end_with_wildcard;
258 struct ldb_val **chunks;
265 struct ldb_val value;
271 struct ldb_val value;
274 unsigned int num_elements;
275 struct ldb_parse_tree **elements;
280 struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
281 char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
286 This function encodes a binary blob using the encoding rules in RFC
287 2254 (Section 4). This function also escapes any non-printable
290 \param ctx the memory context to allocate the return string in.
291 \param val the (potentially) binary data to be encoded
293 \return the encoded data as a null terminated string
295 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
297 char *ldb_binary_encode(void *ctx, struct ldb_val val);
302 This function encodes a string using the encoding rules in RFC 2254
303 (Section 4). This function also escapes any non-printable
306 \param mem_ctx the memory context to allocate the return string in.
307 \param string the string to be encoded
309 \return the encoded data as a null terminated string
311 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
313 char *ldb_binary_encode_string(void *mem_ctx, const char *string);
316 functions for controlling attribute handling
318 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
319 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
322 attribute handler structure
324 attr -> The attribute name
325 flags -> LDB_ATTR_FLAG_*
326 ldif_read_fn -> convert from ldif to binary format
327 ldif_write_fn -> convert from binary to ldif format
328 canonicalise_fn -> canonicalise a value, for use by indexing and dn construction
329 comparison_fn -> compare two values
332 struct ldb_attrib_handler {
337 ldb_attr_handler_t ldif_read_fn;
338 ldb_attr_handler_t ldif_write_fn;
339 ldb_attr_handler_t canonicalise_fn;
340 ldb_attr_comparison_t comparison_fn;
344 The attribute is not returned by default
346 #define LDB_ATTR_FLAG_HIDDEN (1<<0)
348 /* the attribute handler name should be freed when released */
349 #define LDB_ATTR_FLAG_ALLOCATED (1<<1)
352 The attribute is constructed from other attributes
354 #define LDB_ATTR_FLAG_CONSTRUCTED (1<<1)
357 LDAP attribute syntax for a DN
359 This is the well-known LDAP attribute syntax for a DN.
361 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
363 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
366 LDAP attribute syntax for a Directory String
368 This is the well-known LDAP attribute syntax for a Directory String.
370 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
372 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
375 LDAP attribute syntax for an integer
377 This is the well-known LDAP attribute syntax for an integer.
379 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
381 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
384 LDAP attribute syntax for an octet string
386 This is the well-known LDAP attribute syntax for an octet string.
388 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
390 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
393 LDAP attribute syntax for UTC time.
395 This is the well-known LDAP attribute syntax for a UTC time.
397 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
399 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
401 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
403 /* sorting helpers */
404 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
407 OID for the paged results control. This control is included in the
408 searchRequest and searchResultDone messages as part of the controls
409 field of the LDAPMessage, as defined in Section 4.1.12 of
412 \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
414 #define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
417 OID for specifying the returned elements of the ntSecurityDescriptor
419 \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>
421 #define LDB_CONTROL_SD_FLAGS_OID "1.2.840.113556.1.4.801"
424 OID for specifying an advanced scope for the search (one partition)
426 \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>
428 #define LDB_CONTROL_DOMAIN_SCOPE_OID "1.2.840.113556.1.4.1339"
431 OID for specifying an advanced scope for a search
433 \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>
435 #define LDB_CONTROL_SEARCH_OPTIONS_OID "1.2.840.113556.1.4.1340"
440 \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>
442 #define LDB_CONTROL_NOTIFICATION_OID "1.2.840.113556.1.4.528"
445 OID for getting deleted objects
447 \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>
449 #define LDB_CONTROL_SHOW_DELETED_OID "1.2.840.113556.1.4.417"
454 \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>
456 #define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
459 OID for LDAP server sort result extension.
461 This control is included in the searchRequest message as part of
462 the controls field of the LDAPMessage, as defined in Section 4.1.12
463 of LDAP v3. The controlType is set to
464 "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
465 FALSE (where absent is also equivalent to FALSE) at the client's
468 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
470 #define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
473 OID for LDAP server sort result response extension.
475 This control is included in the searchResultDone message as part of
476 the controls field of the LDAPMessage, as defined in Section 4.1.12 of
479 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
481 #define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
484 OID for LDAP Attribute Scoped Query extension.
486 This control is included in SearchRequest or SearchResponse
487 messages as part of the controls field of the LDAPMessage.
489 #define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
492 OID for LDAP Directory Sync extension.
494 This control is included in SearchRequest or SearchResponse
495 messages as part of the controls field of the LDAPMessage.
497 #define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
501 OID for LDAP Virtual List View Request extension.
503 This control is included in SearchRequest messages
504 as part of the controls field of the LDAPMessage.
506 #define LDB_CONTROL_VLV_REQ_OID "2.16.840.1.113730.3.4.9"
509 OID for LDAP Virtual List View Response extension.
511 This control is included in SearchResponse messages
512 as part of the controls field of the LDAPMessage.
514 #define LDB_CONTROL_VLV_RESP_OID "2.16.840.1.113730.3.4.10"
517 OID to let modifies don't give an error when adding an existing
518 attribute with the same value or deleting an nonexisting one attribute
520 \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>
522 #define LDB_CONTROL_PERMISSIVE_MODIFY_OID "1.2.840.113556.1.4.1413"
525 OID for LDAP Extended Operation START_TLS.
527 This Extended operation is used to start a new TLS
528 channel on top of a clear text channel.
530 #define LDB_EXTENDED_START_TLS_OID "1.3.6.1.4.1.1466.20037"
533 OID for LDAP Extended Operation START_TLS.
535 This Extended operation is used to start a new TLS
536 channel on top of a clear text channel.
538 #define LDB_EXTENDED_DYNAMIC_OID "1.3.6.1.4.1.1466.101.119.1"
541 OID for LDAP Extended Operation START_TLS.
543 This Extended operation is used to start a new TLS
544 channel on top of a clear text channel.
546 #define LDB_EXTENDED_FAST_BIND_OID "1.2.840.113556.1.4.1781"
548 struct ldb_sd_flags_control {
550 * request the owner 0x00000001
551 * request the group 0x00000002
552 * request the DACL 0x00000004
553 * request the SACL 0x00000008
555 unsigned secinfo_flags;
558 struct ldb_search_options_control {
560 * DOMAIN_SCOPE 0x00000001
561 * this limits the search to one partition,
562 * and no referrals will be returned.
563 * (Note this doesn't limit the entries by there
564 * objectSid belonging to a domain! Builtin and Foreign Sids
565 * are still returned)
567 * PHANTOM_ROOT 0x00000002
568 * this search on the whole tree on a domain controller
569 * over multiple partitions without referrals.
570 * (This is the default behavior on the Global Catalog Port)
572 unsigned search_options;
575 struct ldb_paged_control {
581 struct ldb_extended_dn_control {
585 struct ldb_server_sort_control {
591 struct ldb_sort_resp_control {
596 struct ldb_asq_control {
598 char *source_attribute;
603 struct ldb_dirsync_control {
610 struct ldb_vlv_req_control {
628 struct ldb_vlv_resp_control {
642 enum ldb_request_type {
649 LDB_REQ_REGISTER_CONTROL,
650 LDB_REQ_REGISTER_PARTITION,
654 enum ldb_reply_type {
674 struct ldb_message **msgs;
676 struct ldb_control **controls;
679 struct ldb_extended {
686 enum ldb_reply_type type;
687 struct ldb_message *message;
688 struct ldb_extended *response;
690 struct ldb_control **controls;
695 enum ldb_state state;
697 struct ldb_module *module;
702 enum ldb_scope scope;
703 const struct ldb_parse_tree *tree;
704 const char * const *attrs;
705 struct ldb_result *res;
709 const struct ldb_message *message;
713 const struct ldb_message *message;
721 struct ldb_dn *olddn;
722 struct ldb_dn *newdn;
725 struct ldb_register_control {
729 struct ldb_register_partition {
733 struct ldb_sequence_number {
734 enum ldb_sequence_type {
736 LDB_SEQ_HIGHEST_TIMESTAMP,
743 typedef int (*ldb_request_callback_t)(struct ldb_context *, void *, struct ldb_reply *);
746 enum ldb_request_type operation;
749 struct ldb_search search;
751 struct ldb_modify mod;
752 struct ldb_delete del;
753 struct ldb_rename rename;
754 struct ldb_register_control reg_control;
755 struct ldb_register_partition reg_partition;
756 struct ldb_sequence_number seq_num;
759 struct ldb_control **controls;
762 ldb_request_callback_t callback;
766 struct ldb_handle *handle;
769 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
771 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
773 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
774 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
775 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
778 Initialise ldbs' global information
780 This is required before any other LDB call
782 \return 0 if initialisation succeeded, -1 otherwise
784 int ldb_global_init(void);
787 Initialise an ldb context
789 This is required before any other LDB call.
791 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
792 no suitable context available.
794 \return pointer to ldb_context that should be free'd (using talloc_free())
795 at the end of the program.
797 struct ldb_context *ldb_init(void *mem_ctx);
800 Connect to a database.
802 This is typically called soon after ldb_init(), and is required prior to
803 any search or database modification operations.
805 The URL can be one of the following forms:
811 \param ldb the context associated with the database (from ldb_init())
812 \param url the URL of the database to connect to, as noted above
813 \param flags a combination of LDB_FLG_* to modify the connection behaviour
814 \param options backend specific options - passed uninterpreted to the backend
816 \return result code (LDB_SUCCESS on success, or a failure code)
818 \note It is an error to connect to a database that does not exist in readonly mode
819 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
820 created if it does not exist.
822 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
825 return an automatic baseDN from the defaultNamingContext of the rootDSE
826 This value have been set in an opaque pointer at connection time
828 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
832 The Default iasync search callback function
834 \param ldb the context associated with the database (from ldb_init())
835 \param context the callback context
836 \param ares a single reply from the async core
838 \return result code (LDB_SUCCESS on success, or a failure code)
840 \note this function expects the context to always be an struct ldb_result pointer
841 AND a talloc context, this function will steal on the context each message
842 from the ares reply passed on by the async core so that in the end all the
843 messages will be in the context (ldb_result) memory tree.
844 Freeing the passed context (ldb_result tree) will free all the resources
845 (the request need to be freed separately and the result doe not depend on the
846 request that can be freed as sson as the search request is finished)
849 int ldb_search_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares);
852 Helper function to build a search request
854 \param ret_req the request structure is returned here (talloced on mem_ctx)
855 \param ldb the context associated with the database (from ldb_init())
856 \param mem_ctx a talloc emmory context (used as parent of ret_req)
857 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
858 \param scope the search scope for the query
859 \param expression the search expression to use for this query
860 \param attrs the search attributes for the query (pass NULL if none required)
861 \param controls an array of controls
862 \param context the callback function context
863 \param the callback function to handle the async replies
865 \return result code (LDB_SUCCESS on success, or a failure code)
868 int ldb_build_search_req(struct ldb_request **ret_req,
869 struct ldb_context *ldb,
872 enum ldb_scope scope,
873 const char *expression,
874 const char * const *attrs,
875 struct ldb_control **controls,
877 ldb_request_callback_t callback);
880 Helper function to build an add request
882 \param ret_req the request structure is returned here (talloced on mem_ctx)
883 \param ldb the context associated with the database (from ldb_init())
884 \param mem_ctx a talloc emmory context (used as parent of ret_req)
885 \param message contains the entry to be added
886 \param controls an array of controls
887 \param context the callback function context
888 \param the callback function to handle the async replies
890 \return result code (LDB_SUCCESS on success, or a failure code)
893 int ldb_build_add_req(struct ldb_request **ret_req,
894 struct ldb_context *ldb,
896 const struct ldb_message *message,
897 struct ldb_control **controls,
899 ldb_request_callback_t callback);
902 Helper function to build a modify request
904 \param ret_req the request structure is returned here (talloced on mem_ctx)
905 \param ldb the context associated with the database (from ldb_init())
906 \param mem_ctx a talloc emmory context (used as parent of ret_req)
907 \param message contains the entry to be modified
908 \param controls an array of controls
909 \param context the callback function context
910 \param the callback function to handle the async replies
912 \return result code (LDB_SUCCESS on success, or a failure code)
915 int ldb_build_mod_req(struct ldb_request **ret_req,
916 struct ldb_context *ldb,
918 const struct ldb_message *message,
919 struct ldb_control **controls,
921 ldb_request_callback_t callback);
924 Helper function to build a delete request
926 \param ret_req the request structure is returned here (talloced on mem_ctx)
927 \param ldb the context associated with the database (from ldb_init())
928 \param mem_ctx a talloc emmory context (used as parent of ret_req)
929 \param dn the DN to be deleted
930 \param controls an array of controls
931 \param context the callback function context
932 \param the callback function to handle the async replies
934 \return result code (LDB_SUCCESS on success, or a failure code)
937 int ldb_build_del_req(struct ldb_request **ret_req,
938 struct ldb_context *ldb,
941 struct ldb_control **controls,
943 ldb_request_callback_t callback);
946 Helper function to build a rename request
948 \param ret_req the request structure is returned here (talloced on mem_ctx)
949 \param ldb the context associated with the database (from ldb_init())
950 \param mem_ctx a talloc emmory context (used as parent of ret_req)
951 \param olddn the old DN
952 \param newdn the new DN
953 \param controls an array of controls
954 \param context the callback function context
955 \param the callback function to handle the async replies
957 \return result code (LDB_SUCCESS on success, or a failure code)
960 int ldb_build_rename_req(struct ldb_request **ret_req,
961 struct ldb_context *ldb,
963 struct ldb_dn *olddn,
964 struct ldb_dn *newdn,
965 struct ldb_control **controls,
967 ldb_request_callback_t callback);
972 This function searches the database, and returns
973 records that match an LDAP-like search expression
975 \param ldb the context associated with the database (from ldb_init())
976 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
977 \param scope the search scope for the query
978 \param expression the search expression to use for this query
979 \param attrs the search attributes for the query (pass NULL if none required)
980 \param res the return result
982 \return result code (LDB_SUCCESS on success, or a failure code)
984 \note use talloc_free() to free the ldb_result returned
986 int ldb_search(struct ldb_context *ldb,
988 enum ldb_scope scope,
989 const char *expression,
990 const char * const *attrs, struct ldb_result **res);
993 like ldb_search() but takes a parse tree
995 int ldb_search_bytree(struct ldb_context *ldb,
997 enum ldb_scope scope,
998 struct ldb_parse_tree *tree,
999 const char * const *attrs, struct ldb_result **res);
1002 Add a record to the database.
1004 This function adds a record to the database. This function will fail
1005 if a record with the specified class and key already exists in the
1008 \param ldb the context associated with the database (from
1010 \param message the message containing the record to add.
1012 \return result code (LDB_SUCCESS if the record was added, otherwise
1015 int ldb_add(struct ldb_context *ldb,
1016 const struct ldb_message *message);
1019 Modify the specified attributes of a record
1021 This function modifies a record that is in the database.
1023 \param ldb the context associated with the database (from
1025 \param message the message containing the changes required.
1027 \return result code (LDB_SUCCESS if the record was modified as
1028 requested, otherwise a failure code)
1030 int ldb_modify(struct ldb_context *ldb,
1031 const struct ldb_message *message);
1034 Rename a record in the database
1036 This function renames a record in the database.
1038 \param ldb the context associated with the database (from
1040 \param olddn the DN for the record to be renamed.
1041 \param newdn the new DN
1043 \return result code (LDB_SUCCESS if the record was renamed as
1044 requested, otherwise a failure code)
1046 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1049 Delete a record from the database
1051 This function deletes a record from the database.
1053 \param ldb the context associated with the database (from
1055 \param dn the DN for the record to be deleted.
1057 \return result code (LDB_SUCCESS if the record was deleted,
1058 otherwise a failure code)
1060 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1065 int ldb_transaction_start(struct ldb_context *ldb);
1068 commit a transaction
1070 int ldb_transaction_commit(struct ldb_context *ldb);
1073 cancel a transaction
1075 int ldb_transaction_cancel(struct ldb_context *ldb);
1079 return extended error information from the last call
1081 const char *ldb_errstring(struct ldb_context *ldb);
1084 return a string explaining what a ldb error constant meancs
1086 const char *ldb_strerror(int ldb_err);
1089 setup the default utf8 functions
1090 FIXME: these functions do not yet handle utf8
1092 void ldb_set_utf8_default(struct ldb_context *ldb);
1097 \param ldb the ldb context
1098 \param mem_ctx the memory context to allocate the result string
1100 \param s the string that is to be folded
1101 \return a copy of the string, converted to upper case
1103 \note The default function is not yet UTF8 aware. Provide your own
1104 set of functions through ldb_set_utf8_fns()
1106 char *ldb_casefold(struct ldb_context *ldb, void *mem_ctx, const char *s);
1109 Check the attribute name is valid according to rfc2251
1110 \param s tthe string to check
1112 \return 1 if the name is ok
1114 int ldb_valid_attr_name(const char *s);
1117 ldif manipulation functions
1120 Write an LDIF message
1122 This function writes an LDIF message using a caller supplied write
1125 \param ldb the ldb context (from ldb_init())
1126 \param fprintf_fn a function pointer for the write function. This must take
1127 a private data pointer, followed by a format string, and then a variable argument
1129 \param private_data pointer that will be provided back to the write
1130 function. This is useful for maintaining state or context.
1131 \param ldif the message to write out
1133 \return the total number of bytes written, or an error code as returned
1134 from the write function.
1136 \sa ldb_ldif_write_file for a more convenient way to write to a
1139 \sa ldb_ldif_read for the reader equivalent to this function.
1141 int ldb_ldif_write(struct ldb_context *ldb,
1142 int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1144 const struct ldb_ldif *ldif);
1147 Clean up an LDIF message
1149 This function cleans up a LDIF message read using ldb_ldif_read()
1150 or related functions (such as ldb_ldif_read_string() and
1151 ldb_ldif_read_file().
1153 \param ldb the ldb context (from ldb_init())
1154 \param msg the message to clean up and free
1157 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1160 Read an LDIF message
1162 This function creates an LDIF message using a caller supplied read
1165 \param ldb the ldb context (from ldb_init())
1166 \param fgetc_fn a function pointer for the read function. This must
1167 take a private data pointer, and must return a pointer to an
1168 integer corresponding to the next byte read (or EOF if there is no
1169 more data to be read).
1170 \param private_data pointer that will be provided back to the read
1171 function. This is udeful for maintaining state or context.
1173 \return the LDIF message that has been read in
1175 \note You must free the LDIF message when no longer required, using
1176 ldb_ldif_read_free().
1178 \sa ldb_ldif_read_file for a more convenient way to read from a
1181 \sa ldb_ldif_read_string for a more convenient way to read from a
1182 string (char array).
1184 \sa ldb_ldif_write for the writer equivalent to this function.
1186 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1187 int (*fgetc_fn)(void *), void *private_data);
1190 Read an LDIF message from a file
1192 This function reads the next LDIF message from the contents of a
1193 file stream. If you want to get all of the LDIF messages, you will
1194 need to repeatedly call this function, until it returns NULL.
1196 \param ldb the ldb context (from ldb_init())
1197 \param f the file stream to read from (typically from fdopen())
1199 \sa ldb_ldif_read_string for an equivalent function that will read
1200 from a string (char array).
1202 \sa ldb_ldif_write_file for the writer equivalent to this function.
1205 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1208 Read an LDIF message from a string
1210 This function reads the next LDIF message from the contents of a char
1211 array. If you want to get all of the LDIF messages, you will need
1212 to repeatedly call this function, until it returns NULL.
1214 \param ldb the ldb context (from ldb_init())
1215 \param s pointer to the char array to read from
1217 \sa ldb_ldif_read_file for an equivalent function that will read
1220 \sa ldb_ldif_write for a more general (arbitrary read function)
1221 version of this function.
1223 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1226 Write an LDIF message to a file
1228 \param ldb the ldb context (from ldb_init())
1229 \param f the file stream to write to (typically from fdopen())
1230 \param msg the message to write out
1232 \return the total number of bytes written, or a negative error code
1234 \sa ldb_ldif_read_file for the reader equivalent to this function.
1236 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1239 Base64 encode a buffer
1241 \param mem_ctx the memory context that the result is allocated
1243 \param buf pointer to the array that is to be encoded
1244 \param len the number of elements in the array to be encoded
1246 \return pointer to an array containing the encoded data
1248 \note The caller is responsible for freeing the result
1250 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
1253 Base64 decode a buffer
1255 This function decodes a base64 encoded string in place.
1257 \param s the string to decode.
1259 \return the length of the returned (decoded) string.
1261 \note the string is null terminated, but the null terminator is not
1262 included in the length.
1264 int ldb_base64_decode(char *s);
1266 int ldb_attrib_add_handlers(struct ldb_context *ldb,
1267 const struct ldb_attrib_handler *handlers,
1268 unsigned num_handlers);
1270 /* The following definitions come from lib/ldb/common/ldb_dn.c */
1272 struct ldb_dn *ldb_dn_new(void *mem_ctx, struct ldb_context *ldb, const char *dn);
1273 struct ldb_dn *ldb_dn_new_fmt(void *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...);
1274 bool ldb_dn_validate(struct ldb_dn *dn);
1276 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
1277 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1278 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1279 char *ldb_dn_alloc_linearized(void *mem_ctx, struct ldb_dn *dn);
1280 char *ldb_dn_alloc_casefold(void *mem_ctx, struct ldb_dn *dn);
1282 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1283 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1285 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1286 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...);
1287 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1288 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...);
1289 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1290 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1292 struct ldb_dn *ldb_dn_copy(void *mem_ctx, struct ldb_dn *dn);
1293 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, struct ldb_dn *dn);
1294 char *ldb_dn_canonical_string(void *mem_ctx, struct ldb_dn *dn);
1295 char *ldb_dn_canonical_ex_string(void *mem_ctx, struct ldb_dn *dn);
1296 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1297 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1298 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1299 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1300 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1301 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1303 bool ldb_dn_is_valid(struct ldb_dn *dn);
1304 bool ldb_dn_is_special(struct ldb_dn *dn);
1305 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1306 bool ldb_dn_is_null(struct ldb_dn *dn);
1309 /* useful functions for ldb_message structure manipulation */
1310 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
1313 Compare two attributes
1315 This function compares to attribute names. Note that this is a
1316 case-insensitive comparison.
1318 \param attr1 the first attribute name to compare
1319 \param attr2 the second attribute name to compare
1321 \return 0 if the attribute names are the same, or only differ in
1322 case; non-zero if there are any differences
1324 int ldb_attr_cmp(const char *attr1, const char *attr2);
1325 char *ldb_attr_casefold(void *mem_ctx, const char *s);
1326 int ldb_attr_dn(const char *attr);
1329 Create an empty message
1331 \param mem_ctx the memory context to create in. You can pass NULL
1332 to get the top level context, however the ldb context (from
1333 ldb_init()) may be a better choice
1335 struct ldb_message *ldb_msg_new(void *mem_ctx);
1338 Find an element within an message
1340 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1341 const char *attr_name);
1344 Compare two ldb_val values
1346 \param v1 first ldb_val structure to be tested
1347 \param v2 second ldb_val structure to be tested
1349 \return 1 for a match, 0 if there is any difference
1351 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1354 find a value within an ldb_message_element
1356 \param el the element to search
1357 \param val the value to search for
1359 \note This search is case sensitive
1361 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1362 struct ldb_val *val);
1365 add a new empty element to a ldb_message
1367 int ldb_msg_add_empty(struct ldb_message *msg,
1368 const char *attr_name,
1370 struct ldb_message_element **return_el);
1373 add a element to a ldb_message
1375 int ldb_msg_add(struct ldb_message *msg,
1376 const struct ldb_message_element *el,
1378 int ldb_msg_add_value(struct ldb_message *msg,
1379 const char *attr_name,
1380 const struct ldb_val *val,
1381 struct ldb_message_element **return_el);
1382 int ldb_msg_add_steal_value(struct ldb_message *msg,
1383 const char *attr_name,
1384 struct ldb_val *val);
1385 int ldb_msg_add_steal_string(struct ldb_message *msg,
1386 const char *attr_name, char *str);
1387 int ldb_msg_add_string(struct ldb_message *msg,
1388 const char *attr_name, const char *str);
1389 int ldb_msg_add_fmt(struct ldb_message *msg,
1390 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1393 compare two message elements - return 0 on match
1395 int ldb_msg_element_compare(struct ldb_message_element *el1,
1396 struct ldb_message_element *el2);
1399 Find elements in a message.
1401 This function finds elements and converts to a specific type, with
1402 a give default value if not found. Assumes that elements are
1405 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1406 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1407 const char *attr_name,
1409 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1410 const char *attr_name,
1411 unsigned int default_value);
1412 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1413 const char *attr_name,
1414 int64_t default_value);
1415 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1416 const char *attr_name,
1417 uint64_t default_value);
1418 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1419 const char *attr_name,
1420 double default_value);
1421 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1422 const char *attr_name,
1424 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1425 const char *attr_name,
1426 const char *default_value);
1428 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1430 const struct ldb_message *msg,
1431 const char *attr_name);
1433 void ldb_msg_sort_elements(struct ldb_message *msg);
1435 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
1436 const struct ldb_message *msg);
1437 struct ldb_message *ldb_msg_copy(void *mem_ctx,
1438 const struct ldb_message *msg);
1440 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1441 const struct ldb_message *msg);
1444 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1445 struct ldb_message *msg1,
1446 struct ldb_message *msg2);
1448 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1453 Integrity check an ldb_message
1455 This function performs basic sanity / integrity checks on an
1458 \param msg the message to check
1460 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1461 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1462 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1465 int ldb_msg_sanity_check(struct ldb_context *ldb,
1466 const struct ldb_message *msg);
1469 Duplicate an ldb_val structure
1471 This function copies an ldb value structure.
1473 \param mem_ctx the memory context that the duplicated value will be
1475 \param v the ldb_val to be duplicated.
1477 \return the duplicated ldb_val structure.
1479 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
1482 this allows the user to set a debug function for error reporting
1484 int ldb_set_debug(struct ldb_context *ldb,
1485 void (*debug)(void *context, enum ldb_debug_level level,
1486 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1490 this allows the user to set custom utf8 function for error reporting
1492 void ldb_set_utf8_fns(struct ldb_context *ldb,
1494 char *(*casefold)(void *, void *, const char *));
1497 this sets up debug to print messages on stderr
1499 int ldb_set_debug_stderr(struct ldb_context *ldb);
1501 /* control backend specific opaque values */
1502 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1503 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1505 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
1506 const char *attrib);
1509 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
1510 const char **ldb_attr_list_copy_add(void *mem_ctx, const char * const *attrs, const char *new_attr);
1511 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1514 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1516 const char *replace);
1518 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1519 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1520 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1523 Convert a time structure to a string
1525 This function converts a time_t structure to an LDAP formatted time
1528 \param mem_ctx the memory context to allocate the return string in
1529 \param t the time structure to convert
1531 \return the formatted string, or NULL if the time structure could
1534 char *ldb_timestring(void *mem_ctx, time_t t);
1537 Convert a string to a time structure
1539 This function converts an LDAP formatted time string to a time_t
1542 \param s the string to convert
1544 \return the time structure, or 0 if the string cannot be converted
1546 time_t ldb_string_to_time(const char *s);
1549 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);