4 Copyright (C) Andrew Tridgell 2004
5 Copyright (C) Stefan Metzmacher 2004
6 Copyright (C) Simo Sorce 2005-2006
8 ** NOTE! The following LGPL license applies to the ldb
9 ** library. This does NOT imply that all of Samba is released
12 This library is free software; you can redistribute it and/or
13 modify it under the terms of the GNU Lesser General Public
14 License as published by the Free Software Foundation; either
15 version 3 of the License, or (at your option) any later version.
17 This library is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 Lesser General Public License for more details.
22 You should have received a copy of the GNU Lesser General Public
23 License along with this library; if not, see <http://www.gnu.org/licenses/>.
29 * Component: ldb header
31 * Description: defines for base ldb API
33 * Author: Andrew Tridgell
34 * Author: Stefan Metzmacher
38 \file ldb.h Samba's ldb database
40 This header file provides the main API for ldb.
45 /*! \cond DOXYGEN_IGNORE */
50 major restrictions as compared to normal LDAP:
53 - each record must have a unique key field
54 - the key must be representable as a NULL terminated C string and may not
55 contain a comma or braces
57 major restrictions as compared to tdb:
59 - no explicit locking calls
60 UPDATE: we have transactions now, better than locking --SSS.
68 An individual lump of data in a result comes in this format. The
69 pointer will usually be to a UTF-8 string if the application is
70 sensible, but it can be to anything you like, including binary data
71 blobs of arbitrary size.
73 \note the data is null (0x00) terminated, but the length does not
74 include the terminator.
77 uint8_t *data; /*!< result data */
78 size_t length; /*!< length of data */
82 /*! \cond DOXYGEN_IGNORE */
83 #ifndef PRINTF_ATTRIBUTE
84 #define PRINTF_ATTRIBUTE(a,b)
88 /* opaque ldb_dn structures, see ldb_dn.c for internals */
89 struct ldb_dn_component;
93 There are a number of flags that are used with ldap_modify() in
94 ldb_message_element.flags fields. The LDA_FLAGS_MOD_ADD,
95 LDA_FLAGS_MOD_DELETE and LDA_FLAGS_MOD_REPLACE flags are used in
96 ldap_modify() calls to specify whether attributes are being added,
97 deleted or modified respectively.
99 #define LDB_FLAG_MOD_MASK 0x3
102 Flag value used in ldap_modify() to indicate that attributes are
105 \sa LDB_FLAG_MOD_MASK
107 #define LDB_FLAG_MOD_ADD 1
110 Flag value used in ldap_modify() to indicate that attributes are
113 \sa LDB_FLAG_MOD_MASK
115 #define LDB_FLAG_MOD_REPLACE 2
118 Flag value used in ldap_modify() to indicate that attributes are
121 \sa LDB_FLAG_MOD_MASK
123 #define LDB_FLAG_MOD_DELETE 3
126 OID for logic AND comaprison.
128 This is the well known object ID for a logical AND comparitor.
130 #define LDB_OID_COMPARATOR_AND "1.2.840.113556.1.4.803"
133 OID for logic OR comparison.
135 This is the well known object ID for a logical OR comparitor.
137 #define LDB_OID_COMPARATOR_OR "1.2.840.113556.1.4.804"
140 results are given back as arrays of ldb_message_element
142 struct ldb_message_element {
145 unsigned int num_values;
146 struct ldb_val *values;
151 a ldb_message represents all or part of a record. It can contain an arbitrary
156 unsigned int num_elements;
157 struct ldb_message_element *elements;
160 enum ldb_changetype {
161 LDB_CHANGETYPE_NONE=0,
163 LDB_CHANGETYPE_DELETE,
164 LDB_CHANGETYPE_MODIFY
170 This structure contains a LDIF record, as returned from ldif_read()
171 and equivalent functions.
174 enum ldb_changetype changetype; /*!< The type of change */
175 struct ldb_message *msg; /*!< The changes */
178 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
180 LDB_SCOPE_ONELEVEL=1,
181 LDB_SCOPE_SUBTREE=2};
185 /* debugging uses one of the following levels */
186 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
187 LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
190 the user can optionally supply a debug function. The function
191 is based on the vfprintf() style of interface, but with the addition
194 struct ldb_debug_ops {
195 void (*debug)(void *context, enum ldb_debug_level level,
196 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
201 The user can optionally supply a custom utf8 functions,
202 to handle comparisons and casefolding.
204 struct ldb_utf8_fns {
206 char *(*casefold)(void *context, void *mem_ctx, const char *s);
210 Flag value for database connection mode.
212 If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
213 opened read-only, if possible.
215 #define LDB_FLG_RDONLY 1
218 Flag value for database connection mode.
220 If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
221 opened without synchronous operations, if possible.
223 #define LDB_FLG_NOSYNC 2
226 Flag value to specify autoreconnect mode.
228 If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
229 be opened in a way that makes it try to auto reconnect if the
230 connection is dropped (actually make sense only with ldap).
232 #define LDB_FLG_RECONNECT 4
235 Flag to tell backends not to use mmap
237 #define LDB_FLG_NOMMAP 8
240 structures for ldb_parse_tree handling code
242 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
243 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
244 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
245 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
247 struct ldb_parse_tree {
248 enum ldb_parse_op operation;
251 struct ldb_parse_tree *child;
255 struct ldb_val value;
259 int start_with_wildcard;
260 int end_with_wildcard;
261 struct ldb_val **chunks;
268 struct ldb_val value;
274 struct ldb_val value;
277 unsigned int num_elements;
278 struct ldb_parse_tree **elements;
283 struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
284 char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
289 This function encodes a binary blob using the encoding rules in RFC
290 2254 (Section 4). This function also escapes any non-printable
293 \param ctx the memory context to allocate the return string in.
294 \param val the (potentially) binary data to be encoded
296 \return the encoded data as a null terminated string
298 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
300 char *ldb_binary_encode(void *ctx, struct ldb_val val);
305 This function encodes a string using the encoding rules in RFC 2254
306 (Section 4). This function also escapes any non-printable
309 \param mem_ctx the memory context to allocate the return string in.
310 \param string the string to be encoded
312 \return the encoded data as a null terminated string
314 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
316 char *ldb_binary_encode_string(void *mem_ctx, const char *string);
319 functions for controlling attribute handling
321 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
322 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
325 attribute handler structure
327 attr -> The attribute name
328 flags -> LDB_ATTR_FLAG_*
329 ldif_read_fn -> convert from ldif to binary format
330 ldif_write_fn -> convert from binary to ldif format
331 canonicalise_fn -> canonicalise a value, for use by indexing and dn construction
332 comparison_fn -> compare two values
335 struct ldb_schema_syntax {
337 ldb_attr_handler_t ldif_read_fn;
338 ldb_attr_handler_t ldif_write_fn;
339 ldb_attr_handler_t canonicalise_fn;
340 ldb_attr_comparison_t comparison_fn;
343 struct ldb_schema_attribute {
346 const struct ldb_schema_syntax *syntax;
349 const struct ldb_schema_attribute *ldb_schema_attribute_by_name(struct ldb_context *ldb,
353 The attribute is not returned by default
355 #define LDB_ATTR_FLAG_HIDDEN (1<<0)
357 /* the attribute handler name should be freed when released */
358 #define LDB_ATTR_FLAG_ALLOCATED (1<<1)
361 The attribute is constructed from other attributes
363 #define LDB_ATTR_FLAG_CONSTRUCTED (1<<1)
366 LDAP attribute syntax for a DN
368 This is the well-known LDAP attribute syntax for a DN.
370 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
372 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
375 LDAP attribute syntax for a Directory String
377 This is the well-known LDAP attribute syntax for a Directory String.
379 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
381 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
384 LDAP attribute syntax for an integer
386 This is the well-known LDAP attribute syntax for an integer.
388 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
390 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
393 LDAP attribute syntax for an octet string
395 This is the well-known LDAP attribute syntax for an octet string.
397 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
399 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
402 LDAP attribute syntax for UTC time.
404 This is the well-known LDAP attribute syntax for a UTC time.
406 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
408 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
410 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
412 /* sorting helpers */
413 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
416 OID for the paged results control. This control is included in the
417 searchRequest and searchResultDone messages as part of the controls
418 field of the LDAPMessage, as defined in Section 4.1.12 of
421 \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
423 #define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
426 OID for specifying the returned elements of the ntSecurityDescriptor
428 \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>
430 #define LDB_CONTROL_SD_FLAGS_OID "1.2.840.113556.1.4.801"
433 OID for specifying an advanced scope for the search (one partition)
435 \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>
437 #define LDB_CONTROL_DOMAIN_SCOPE_OID "1.2.840.113556.1.4.1339"
440 OID for specifying an advanced scope for a search
442 \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>
444 #define LDB_CONTROL_SEARCH_OPTIONS_OID "1.2.840.113556.1.4.1340"
449 \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>
451 #define LDB_CONTROL_NOTIFICATION_OID "1.2.840.113556.1.4.528"
454 OID for getting deleted objects
456 \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>
458 #define LDB_CONTROL_SHOW_DELETED_OID "1.2.840.113556.1.4.417"
463 \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>
465 #define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
468 OID for LDAP server sort result extension.
470 This control is included in the searchRequest message as part of
471 the controls field of the LDAPMessage, as defined in Section 4.1.12
472 of LDAP v3. The controlType is set to
473 "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
474 FALSE (where absent is also equivalent to FALSE) at the client's
477 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
479 #define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
482 OID for LDAP server sort result response extension.
484 This control is included in the searchResultDone message as part of
485 the controls field of the LDAPMessage, as defined in Section 4.1.12 of
488 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
490 #define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
493 OID for LDAP Attribute Scoped Query extension.
495 This control is included in SearchRequest or SearchResponse
496 messages as part of the controls field of the LDAPMessage.
498 #define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
501 OID for LDAP Directory Sync extension.
503 This control is included in SearchRequest or SearchResponse
504 messages as part of the controls field of the LDAPMessage.
506 #define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
510 OID for LDAP Virtual List View Request extension.
512 This control is included in SearchRequest messages
513 as part of the controls field of the LDAPMessage.
515 #define LDB_CONTROL_VLV_REQ_OID "2.16.840.1.113730.3.4.9"
518 OID for LDAP Virtual List View Response extension.
520 This control is included in SearchResponse messages
521 as part of the controls field of the LDAPMessage.
523 #define LDB_CONTROL_VLV_RESP_OID "2.16.840.1.113730.3.4.10"
526 OID to let modifies don't give an error when adding an existing
527 attribute with the same value or deleting an nonexisting one attribute
529 \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>
531 #define LDB_CONTROL_PERMISSIVE_MODIFY_OID "1.2.840.113556.1.4.1413"
534 OID for LDAP Extended Operation START_TLS.
536 This Extended operation is used to start a new TLS
537 channel on top of a clear text channel.
539 #define LDB_EXTENDED_START_TLS_OID "1.3.6.1.4.1.1466.20037"
543 #define LDB_EXTENDED_DYNAMIC_OID "1.3.6.1.4.1.1466.101.119.1"
547 #define LDB_EXTENDED_FAST_BIND_OID "1.2.840.113556.1.4.1781"
549 struct ldb_sd_flags_control {
551 * request the owner 0x00000001
552 * request the group 0x00000002
553 * request the DACL 0x00000004
554 * request the SACL 0x00000008
556 unsigned secinfo_flags;
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)
573 #define LDB_SEARCH_OPTION_DOMAIN_SCOPE 0x00000001
574 #define LDB_SEARCH_OPTION_PHANTOM_ROOT 0x00000002
576 struct ldb_search_options_control {
577 unsigned search_options;
580 struct ldb_paged_control {
586 struct ldb_extended_dn_control {
590 struct ldb_server_sort_control {
596 struct ldb_sort_resp_control {
601 struct ldb_asq_control {
603 char *source_attribute;
608 struct ldb_dirsync_control {
615 struct ldb_vlv_req_control {
633 struct ldb_vlv_resp_control {
647 enum ldb_request_type {
655 LDB_REQ_REGISTER_CONTROL,
656 LDB_REQ_REGISTER_PARTITION
659 enum ldb_reply_type {
677 struct ldb_extended {
679 void *data; /* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
684 struct ldb_message **msgs;
686 struct ldb_extended *extended;
687 struct ldb_control **controls;
691 enum ldb_reply_type type;
692 struct ldb_message *message;
693 struct ldb_extended *response;
695 struct ldb_control **controls;
700 enum ldb_state state;
702 struct ldb_module *module;
707 enum ldb_scope scope;
708 const struct ldb_parse_tree *tree;
709 const char * const *attrs;
710 struct ldb_result *res;
714 const struct ldb_message *message;
718 const struct ldb_message *message;
726 struct ldb_dn *olddn;
727 struct ldb_dn *newdn;
730 struct ldb_register_control {
734 struct ldb_register_partition {
738 struct ldb_sequence_number {
739 enum ldb_sequence_type {
741 LDB_SEQ_HIGHEST_TIMESTAMP,
748 typedef int (*ldb_request_callback_t)(struct ldb_context *, void *, struct ldb_reply *);
751 enum ldb_request_type operation;
754 struct ldb_search search;
756 struct ldb_modify mod;
757 struct ldb_delete del;
758 struct ldb_rename rename;
759 struct ldb_extended extended;
760 struct ldb_sequence_number seq_num;
761 struct ldb_register_control reg_control;
762 struct ldb_register_partition reg_partition;
765 struct ldb_control **controls;
768 ldb_request_callback_t callback;
772 struct ldb_handle *handle;
775 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
777 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
779 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
780 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
781 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
782 void ldb_set_modules_dir(struct ldb_context *ldb, const char *path);
785 Initialise ldbs' global information
787 This is required before any other LDB call
789 \return 0 if initialisation succeeded, -1 otherwise
791 int ldb_global_init(void);
794 Initialise an ldb context
796 This is required before any other LDB call.
798 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
799 no suitable context available.
801 \return pointer to ldb_context that should be free'd (using talloc_free())
802 at the end of the program.
804 struct ldb_context *ldb_init(void *mem_ctx);
807 Connect to a database.
809 This is typically called soon after ldb_init(), and is required prior to
810 any search or database modification operations.
812 The URL can be one of the following forms:
818 \param ldb the context associated with the database (from ldb_init())
819 \param url the URL of the database to connect to, as noted above
820 \param flags a combination of LDB_FLG_* to modify the connection behaviour
821 \param options backend specific options - passed uninterpreted to the backend
823 \return result code (LDB_SUCCESS on success, or a failure code)
825 \note It is an error to connect to a database that does not exist in readonly mode
826 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
827 created if it does not exist.
829 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
832 return an automatic basedn from the rootDomainNamingContext of the rootDSE
833 This value have been set in an opaque pointer at connection time
835 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
838 return an automatic basedn from the configurationNamingContext of the rootDSE
839 This value have been set in an opaque pointer at connection time
841 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
844 return an automatic basedn from the schemaNamingContext of the rootDSE
845 This value have been set in an opaque pointer at connection time
847 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
850 return an automatic baseDN from the defaultNamingContext of the rootDSE
851 This value have been set in an opaque pointer at connection time
853 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
856 The default async search callback function
858 \param ldb the context associated with the database (from ldb_init())
859 \param context the callback context (struct ldb_result *)
860 \param ares a single reply from the async core
862 \return result code (LDB_SUCCESS on success, or a failure code)
864 \note this function expects the context to always be an struct ldb_result pointer
865 AND a talloc context, this function will steal on the context each message
866 from the ares reply passed on by the async core so that in the end all the
867 messages will be in the context (ldb_result) memory tree.
868 Freeing the passed context (ldb_result tree) will free all the resources
869 (the request need to be freed separately and the result doe not depend on the
870 request that can be freed as sson as the search request is finished)
873 int ldb_search_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares);
876 Helper function to build a search request
878 \param ret_req the request structure is returned here (talloced on mem_ctx)
879 \param ldb the context associated with the database (from ldb_init())
880 \param mem_ctx a talloc memory context (used as parent of ret_req)
881 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
882 \param scope the search scope for the query
883 \param expression the search expression to use for this query
884 \param attrs the search attributes for the query (pass NULL if none required)
885 \param controls an array of controls
886 \param context the callback function context
887 \param the callback function to handle the async replies
889 \return result code (LDB_SUCCESS on success, or a failure code)
892 int ldb_build_search_req(struct ldb_request **ret_req,
893 struct ldb_context *ldb,
896 enum ldb_scope scope,
897 const char *expression,
898 const char * const *attrs,
899 struct ldb_control **controls,
901 ldb_request_callback_t callback);
904 Helper function to build an add request
906 \param ret_req the request structure is returned here (talloced on mem_ctx)
907 \param ldb the context associated with the database (from ldb_init())
908 \param mem_ctx a talloc memory context (used as parent of ret_req)
909 \param message contains the entry to be added
910 \param controls an array of controls
911 \param context the callback function context
912 \param the callback function to handle the async replies
914 \return result code (LDB_SUCCESS on success, or a failure code)
917 int ldb_build_add_req(struct ldb_request **ret_req,
918 struct ldb_context *ldb,
920 const struct ldb_message *message,
921 struct ldb_control **controls,
923 ldb_request_callback_t callback);
926 Helper function to build a modify request
928 \param ret_req the request structure is returned here (talloced on mem_ctx)
929 \param ldb the context associated with the database (from ldb_init())
930 \param mem_ctx a talloc memory context (used as parent of ret_req)
931 \param message contains the entry to be modified
932 \param controls an array of controls
933 \param context the callback function context
934 \param the callback function to handle the async replies
936 \return result code (LDB_SUCCESS on success, or a failure code)
939 int ldb_build_mod_req(struct ldb_request **ret_req,
940 struct ldb_context *ldb,
942 const struct ldb_message *message,
943 struct ldb_control **controls,
945 ldb_request_callback_t callback);
948 Helper function to build a delete request
950 \param ret_req the request structure is returned here (talloced on mem_ctx)
951 \param ldb the context associated with the database (from ldb_init())
952 \param mem_ctx a talloc memory context (used as parent of ret_req)
953 \param dn the DN to be deleted
954 \param controls an array of controls
955 \param context the callback function context
956 \param the callback function to handle the async replies
958 \return result code (LDB_SUCCESS on success, or a failure code)
961 int ldb_build_del_req(struct ldb_request **ret_req,
962 struct ldb_context *ldb,
965 struct ldb_control **controls,
967 ldb_request_callback_t callback);
970 Helper function to build a rename request
972 \param ret_req the request structure is returned here (talloced on mem_ctx)
973 \param ldb the context associated with the database (from ldb_init())
974 \param mem_ctx a talloc memory context (used as parent of ret_req)
975 \param olddn the old DN
976 \param newdn the new DN
977 \param controls an array of controls
978 \param context the callback function context
979 \param the callback function to handle the async replies
981 \return result code (LDB_SUCCESS on success, or a failure code)
984 int ldb_build_rename_req(struct ldb_request **ret_req,
985 struct ldb_context *ldb,
987 struct ldb_dn *olddn,
988 struct ldb_dn *newdn,
989 struct ldb_control **controls,
991 ldb_request_callback_t callback);
994 Add a ldb_control to a ldb_request
996 \param req the request struct where to add the control
997 \param oid the object identifier of the control as string
998 \param ciritical whether the control should be critical or not
999 \param data a talloc pointer to the control specific data
1001 \return result code (LDB_SUCCESS on success, or a failure code)
1003 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1006 check if a control with the specified "oid" exist and return it
1007 \param req the request struct where to add the control
1008 \param oid the object identifier of the control as string
1010 \return the control, NULL if not found
1012 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid);
1017 This function searches the database, and returns
1018 records that match an LDAP-like search expression
1020 \param ldb the context associated with the database (from ldb_init())
1021 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1022 \param scope the search scope for the query
1023 \param expression the search expression to use for this query
1024 \param attrs the search attributes for the query (pass NULL if none required)
1025 \param res the return result
1027 \return result code (LDB_SUCCESS on success, or a failure code)
1029 \note use talloc_free() to free the ldb_result returned
1031 int ldb_search(struct ldb_context *ldb,
1032 struct ldb_dn *base,
1033 enum ldb_scope scope,
1034 const char *expression,
1035 const char * const *attrs, struct ldb_result **res);
1038 * a useful search function where you can easily define the expression and
1039 * that takes a memory context where results are allocated
1042 int ldb_search_exp_fmt(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1043 struct ldb_result **result, struct ldb_dn *base,
1044 enum ldb_scope scope, const char * const *attrs,
1045 const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1048 like ldb_search() but takes a parse tree
1050 int ldb_search_bytree(struct ldb_context *ldb,
1051 struct ldb_dn *base,
1052 enum ldb_scope scope,
1053 struct ldb_parse_tree *tree,
1054 const char * const *attrs, struct ldb_result **res);
1057 Add a record to the database.
1059 This function adds a record to the database. This function will fail
1060 if a record with the specified class and key already exists in the
1063 \param ldb the context associated with the database (from
1065 \param message the message containing the record to add.
1067 \return result code (LDB_SUCCESS if the record was added, otherwise
1070 int ldb_add(struct ldb_context *ldb,
1071 const struct ldb_message *message);
1074 Modify the specified attributes of a record
1076 This function modifies a record that is in the database.
1078 \param ldb the context associated with the database (from
1080 \param message the message containing the changes required.
1082 \return result code (LDB_SUCCESS if the record was modified as
1083 requested, otherwise a failure code)
1085 int ldb_modify(struct ldb_context *ldb,
1086 const struct ldb_message *message);
1089 Rename a record in the database
1091 This function renames a record in the database.
1093 \param ldb the context associated with the database (from
1095 \param olddn the DN for the record to be renamed.
1096 \param newdn the new DN
1098 \return result code (LDB_SUCCESS if the record was renamed as
1099 requested, otherwise a failure code)
1101 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1104 Delete a record from the database
1106 This function deletes a record from the database.
1108 \param ldb the context associated with the database (from
1110 \param dn the DN for the record to be deleted.
1112 \return result code (LDB_SUCCESS if the record was deleted,
1113 otherwise a failure code)
1115 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1118 The default async extended operation callback function
1120 \param ldb the context associated with the database (from ldb_init())
1121 \param context the callback context (struct ldb_result *)
1122 \param ares a single reply from the async core
1124 \return result code (LDB_SUCCESS on success, or a failure code)
1126 \note this function expects the context to always be an struct ldb_result pointer
1127 AND a talloc context, this function will steal on the context each message
1128 from the ares reply passed on by the async core so that in the end all the
1129 messages will be in the context (ldb_result) memory tree.
1130 Freeing the passed context (ldb_result tree) will free all the resources
1131 (the request need to be freed separately and the result doe not depend on the
1132 request that can be freed as sson as the search request is finished)
1134 int ldb_extended_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares);
1137 Helper function to build a extended request
1139 \param ret_req the request structure is returned here (talloced on mem_ctx)
1140 \param ldb the context associated with the database (from ldb_init())
1141 \param mem_ctx a talloc memory context (used as parent of ret_req)
1142 \param oid the OID of the extended operation.
1143 \param data a void pointer a the extended operation specific parameters,
1144 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1145 \param controls an array of controls
1146 \param context the callback function context
1147 \param the callback function to handle the async replies
1149 \return result code (LDB_SUCCESS on success, or a failure code)
1151 int ldb_build_extended_req(struct ldb_request **ret_req,
1152 struct ldb_context *ldb,
1155 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1156 struct ldb_control **controls,
1158 ldb_request_callback_t callback);
1161 call an extended operation
1163 This function deletes a record from the database.
1165 \param ldb the context associated with the database (from ldb_init())
1166 \param oid the OID of the extended operation.
1167 \param data a void pointer a the extended operation specific parameters,
1168 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1169 \param res the result of the extended operation
1171 \return result code (LDB_SUCCESS if the extended operation returned fine,
1172 otherwise a failure code)
1174 int ldb_extended(struct ldb_context *ldb,
1176 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1177 struct ldb_result **res);
1182 int ldb_transaction_start(struct ldb_context *ldb);
1185 commit a transaction
1187 int ldb_transaction_commit(struct ldb_context *ldb);
1190 cancel a transaction
1192 int ldb_transaction_cancel(struct ldb_context *ldb);
1196 return extended error information from the last call
1198 const char *ldb_errstring(struct ldb_context *ldb);
1201 return a string explaining what a ldb error constant meancs
1203 const char *ldb_strerror(int ldb_err);
1206 setup the default utf8 functions
1207 FIXME: these functions do not yet handle utf8
1209 void ldb_set_utf8_default(struct ldb_context *ldb);
1214 \param ldb the ldb context
1215 \param mem_ctx the memory context to allocate the result string
1217 \param s the string that is to be folded
1218 \return a copy of the string, converted to upper case
1220 \note The default function is not yet UTF8 aware. Provide your own
1221 set of functions through ldb_set_utf8_fns()
1223 char *ldb_casefold(struct ldb_context *ldb, void *mem_ctx, const char *s);
1226 Check the attribute name is valid according to rfc2251
1227 \param s tthe string to check
1229 \return 1 if the name is ok
1231 int ldb_valid_attr_name(const char *s);
1234 ldif manipulation functions
1237 Write an LDIF message
1239 This function writes an LDIF message using a caller supplied write
1242 \param ldb the ldb context (from ldb_init())
1243 \param fprintf_fn a function pointer for the write function. This must take
1244 a private data pointer, followed by a format string, and then a variable argument
1246 \param private_data pointer that will be provided back to the write
1247 function. This is useful for maintaining state or context.
1248 \param ldif the message to write out
1250 \return the total number of bytes written, or an error code as returned
1251 from the write function.
1253 \sa ldb_ldif_write_file for a more convenient way to write to a
1256 \sa ldb_ldif_read for the reader equivalent to this function.
1258 int ldb_ldif_write(struct ldb_context *ldb,
1259 int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1261 const struct ldb_ldif *ldif);
1264 Clean up an LDIF message
1266 This function cleans up a LDIF message read using ldb_ldif_read()
1267 or related functions (such as ldb_ldif_read_string() and
1268 ldb_ldif_read_file().
1270 \param ldb the ldb context (from ldb_init())
1271 \param msg the message to clean up and free
1274 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1277 Read an LDIF message
1279 This function creates an LDIF message using a caller supplied read
1282 \param ldb the ldb context (from ldb_init())
1283 \param fgetc_fn a function pointer for the read function. This must
1284 take a private data pointer, and must return a pointer to an
1285 integer corresponding to the next byte read (or EOF if there is no
1286 more data to be read).
1287 \param private_data pointer that will be provided back to the read
1288 function. This is udeful for maintaining state or context.
1290 \return the LDIF message that has been read in
1292 \note You must free the LDIF message when no longer required, using
1293 ldb_ldif_read_free().
1295 \sa ldb_ldif_read_file for a more convenient way to read from a
1298 \sa ldb_ldif_read_string for a more convenient way to read from a
1299 string (char array).
1301 \sa ldb_ldif_write for the writer equivalent to this function.
1303 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1304 int (*fgetc_fn)(void *), void *private_data);
1307 Read an LDIF message from a file
1309 This function reads the next LDIF message from the contents of a
1310 file stream. If you want to get all of the LDIF messages, you will
1311 need to repeatedly call this function, until it returns NULL.
1313 \param ldb the ldb context (from ldb_init())
1314 \param f the file stream to read from (typically from fdopen())
1316 \sa ldb_ldif_read_string for an equivalent function that will read
1317 from a string (char array).
1319 \sa ldb_ldif_write_file for the writer equivalent to this function.
1322 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1325 Read an LDIF message from a string
1327 This function reads the next LDIF message from the contents of a char
1328 array. If you want to get all of the LDIF messages, you will need
1329 to repeatedly call this function, until it returns NULL.
1331 \param ldb the ldb context (from ldb_init())
1332 \param s pointer to the char array to read from
1334 \sa ldb_ldif_read_file for an equivalent function that will read
1337 \sa ldb_ldif_write for a more general (arbitrary read function)
1338 version of this function.
1340 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1343 Write an LDIF message to a file
1345 \param ldb the ldb context (from ldb_init())
1346 \param f the file stream to write to (typically from fdopen())
1347 \param msg the message to write out
1349 \return the total number of bytes written, or a negative error code
1351 \sa ldb_ldif_read_file for the reader equivalent to this function.
1353 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1356 Base64 encode a buffer
1358 \param mem_ctx the memory context that the result is allocated
1360 \param buf pointer to the array that is to be encoded
1361 \param len the number of elements in the array to be encoded
1363 \return pointer to an array containing the encoded data
1365 \note The caller is responsible for freeing the result
1367 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
1370 Base64 decode a buffer
1372 This function decodes a base64 encoded string in place.
1374 \param s the string to decode.
1376 \return the length of the returned (decoded) string.
1378 \note the string is null terminated, but the null terminator is not
1379 included in the length.
1381 int ldb_base64_decode(char *s);
1383 /* The following definitions come from lib/ldb/common/ldb_dn.c */
1385 struct ldb_dn *ldb_dn_new(void *mem_ctx, struct ldb_context *ldb, const char *dn);
1386 struct ldb_dn *ldb_dn_new_fmt(void *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1387 bool ldb_dn_validate(struct ldb_dn *dn);
1389 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
1390 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1391 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1392 char *ldb_dn_alloc_linearized(void *mem_ctx, struct ldb_dn *dn);
1393 char *ldb_dn_alloc_casefold(void *mem_ctx, struct ldb_dn *dn);
1395 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1396 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1398 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1399 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1400 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1401 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1402 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1403 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1405 struct ldb_dn *ldb_dn_copy(void *mem_ctx, struct ldb_dn *dn);
1406 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, struct ldb_dn *dn);
1407 char *ldb_dn_canonical_string(void *mem_ctx, struct ldb_dn *dn);
1408 char *ldb_dn_canonical_ex_string(void *mem_ctx, struct ldb_dn *dn);
1409 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1410 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1411 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1412 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1413 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1414 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1416 bool ldb_dn_is_valid(struct ldb_dn *dn);
1417 bool ldb_dn_is_special(struct ldb_dn *dn);
1418 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1419 bool ldb_dn_is_null(struct ldb_dn *dn);
1422 /* useful functions for ldb_message structure manipulation */
1423 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
1426 Compare two attributes
1428 This function compares to attribute names. Note that this is a
1429 case-insensitive comparison.
1431 \param attr1 the first attribute name to compare
1432 \param attr2 the second attribute name to compare
1434 \return 0 if the attribute names are the same, or only differ in
1435 case; non-zero if there are any differences
1437 attribute names are restricted by rfc2251 so using
1438 strcasecmp and toupper here is ok.
1441 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1442 char *ldb_attr_casefold(void *mem_ctx, const char *s);
1443 int ldb_attr_dn(const char *attr);
1446 Create an empty message
1448 \param mem_ctx the memory context to create in. You can pass NULL
1449 to get the top level context, however the ldb context (from
1450 ldb_init()) may be a better choice
1452 struct ldb_message *ldb_msg_new(void *mem_ctx);
1455 Find an element within an message
1457 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1458 const char *attr_name);
1461 Compare two ldb_val values
1463 \param v1 first ldb_val structure to be tested
1464 \param v2 second ldb_val structure to be tested
1466 \return 1 for a match, 0 if there is any difference
1468 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1471 find a value within an ldb_message_element
1473 \param el the element to search
1474 \param val the value to search for
1476 \note This search is case sensitive
1478 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1479 struct ldb_val *val);
1482 add a new empty element to a ldb_message
1484 int ldb_msg_add_empty(struct ldb_message *msg,
1485 const char *attr_name,
1487 struct ldb_message_element **return_el);
1490 add a element to a ldb_message
1492 int ldb_msg_add(struct ldb_message *msg,
1493 const struct ldb_message_element *el,
1495 int ldb_msg_add_value(struct ldb_message *msg,
1496 const char *attr_name,
1497 const struct ldb_val *val,
1498 struct ldb_message_element **return_el);
1499 int ldb_msg_add_steal_value(struct ldb_message *msg,
1500 const char *attr_name,
1501 struct ldb_val *val);
1502 int ldb_msg_add_steal_string(struct ldb_message *msg,
1503 const char *attr_name, char *str);
1504 int ldb_msg_add_string(struct ldb_message *msg,
1505 const char *attr_name, const char *str);
1506 int ldb_msg_add_fmt(struct ldb_message *msg,
1507 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1510 compare two message elements - return 0 on match
1512 int ldb_msg_element_compare(struct ldb_message_element *el1,
1513 struct ldb_message_element *el2);
1516 Find elements in a message.
1518 This function finds elements and converts to a specific type, with
1519 a give default value if not found. Assumes that elements are
1522 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1523 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1524 const char *attr_name,
1526 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1527 const char *attr_name,
1528 unsigned int default_value);
1529 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1530 const char *attr_name,
1531 int64_t default_value);
1532 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1533 const char *attr_name,
1534 uint64_t default_value);
1535 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1536 const char *attr_name,
1537 double default_value);
1538 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1539 const char *attr_name,
1541 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1542 const char *attr_name,
1543 const char *default_value);
1545 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1547 const struct ldb_message *msg,
1548 const char *attr_name);
1550 void ldb_msg_sort_elements(struct ldb_message *msg);
1552 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
1553 const struct ldb_message *msg);
1554 struct ldb_message *ldb_msg_copy(void *mem_ctx,
1555 const struct ldb_message *msg);
1557 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1558 const struct ldb_message *msg);
1561 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1562 struct ldb_message *msg1,
1563 struct ldb_message *msg2);
1565 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1570 Integrity check an ldb_message
1572 This function performs basic sanity / integrity checks on an
1575 \param msg the message to check
1577 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1578 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1579 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1582 int ldb_msg_sanity_check(struct ldb_context *ldb,
1583 const struct ldb_message *msg);
1586 Duplicate an ldb_val structure
1588 This function copies an ldb value structure.
1590 \param mem_ctx the memory context that the duplicated value will be
1592 \param v the ldb_val to be duplicated.
1594 \return the duplicated ldb_val structure.
1596 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
1599 this allows the user to set a debug function for error reporting
1601 int ldb_set_debug(struct ldb_context *ldb,
1602 void (*debug)(void *context, enum ldb_debug_level level,
1603 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1607 this allows the user to set custom utf8 function for error reporting
1609 void ldb_set_utf8_fns(struct ldb_context *ldb,
1611 char *(*casefold)(void *, void *, const char *));
1614 this sets up debug to print messages on stderr
1616 int ldb_set_debug_stderr(struct ldb_context *ldb);
1618 /* control backend specific opaque values */
1619 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1620 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1622 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
1623 const char **ldb_attr_list_copy_add(void *mem_ctx, const char * const *attrs, const char *new_attr);
1624 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1627 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1629 const char *replace);
1631 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1632 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1633 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1636 Convert a time structure to a string
1638 This function converts a time_t structure to an LDAP formatted
1639 GeneralizedTime string.
1641 \param mem_ctx the memory context to allocate the return string in
1642 \param t the time structure to convert
1644 \return the formatted string, or NULL if the time structure could
1647 char *ldb_timestring(void *mem_ctx, time_t t);
1650 Convert a string to a time structure
1652 This function converts an LDAP formatted GeneralizedTime string
1653 to a time_t structure.
1655 \param s the string to convert
1657 \return the time structure, or 0 if the string cannot be converted
1659 time_t ldb_string_to_time(const char *s);
1662 Convert a time structure to a string
1664 This function converts a time_t structure to an LDAP formatted
1667 \param mem_ctx the memory context to allocate the return string in
1668 \param t the time structure to convert
1670 \return the formatted string, or NULL if the time structure could
1673 char *ldb_timestring_utc(void *mem_ctx, time_t t);
1676 Convert a string to a time structure
1678 This function converts an LDAP formatted UTCTime string
1679 to a time_t structure.
1681 \param s the string to convert
1683 \return the time structure, or 0 if the string cannot be converted
1685 time_t ldb_string_utc_to_time(const char *s);
1688 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1692 Convert an array of string represention of a control into an array of ldb_control structures
1694 \param ldb LDB context
1695 \param mem_ctx TALLOC context to return result on, and to allocate error_string on
1696 \param control_strings Array of string-formatted controls
1698 \return array of ldb_control elements
1700 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, void *mem_ctx, const char **control_strings);