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, TALLOC_CTX *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(TALLOC_CTX *mem_ctx, const char *s);
284 char *ldb_filter_from_tree(TALLOC_CTX *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 mem_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(TALLOC_CTX *mem_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(TALLOC_CTX *mem_ctx, const char *string);
319 functions for controlling attribute handling
321 typedef int (*ldb_attr_handler_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, struct ldb_val *);
322 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, TALLOC_CTX *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 supplied by the application and should not be removed
363 #define LDB_ATTR_FLAG_FIXED (1<<2)
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 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 enum ldb_sequence_type {
740 LDB_SEQ_HIGHEST_TIMESTAMP,
744 struct ldb_sequence_number {
745 enum ldb_sequence_type type;
750 typedef int (*ldb_request_callback_t)(struct ldb_context *, void *, struct ldb_reply *);
753 enum ldb_request_type operation;
756 struct ldb_search search;
758 struct ldb_modify mod;
759 struct ldb_delete del;
760 struct ldb_rename rename;
761 struct ldb_extended extended;
762 struct ldb_sequence_number seq_num;
763 struct ldb_register_control reg_control;
764 struct ldb_register_partition reg_partition;
767 struct ldb_control **controls;
770 ldb_request_callback_t callback;
774 struct ldb_handle *handle;
777 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
779 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
781 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
782 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
783 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
784 void ldb_set_modules_dir(struct ldb_context *ldb, const char *path);
785 struct event_context;
786 void ldb_set_event_context(struct ldb_context *ldb, struct event_context *ev);
787 struct event_context * ldb_get_event_context(struct ldb_context *ldb);
790 Initialise ldbs' global information
792 This is required before any other LDB call
794 \return 0 if initialisation succeeded, -1 otherwise
796 int ldb_global_init(void);
799 Initialise an ldb context
801 This is required before any other LDB call.
803 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
804 no suitable context available.
806 \return pointer to ldb_context that should be free'd (using talloc_free())
807 at the end of the program.
809 struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx, struct event_context *ev_ctx);
812 Connect to a database.
814 This is typically called soon after ldb_init(), and is required prior to
815 any search or database modification operations.
817 The URL can be one of the following forms:
823 \param ldb the context associated with the database (from ldb_init())
824 \param url the URL of the database to connect to, as noted above
825 \param flags a combination of LDB_FLG_* to modify the connection behaviour
826 \param options backend specific options - passed uninterpreted to the backend
828 \return result code (LDB_SUCCESS on success, or a failure code)
830 \note It is an error to connect to a database that does not exist in readonly mode
831 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
832 created if it does not exist.
834 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
837 return an automatic basedn from the rootDomainNamingContext of the rootDSE
838 This value have been set in an opaque pointer at connection time
840 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
843 return an automatic basedn from the configurationNamingContext of the rootDSE
844 This value have been set in an opaque pointer at connection time
846 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
849 return an automatic basedn from the schemaNamingContext of the rootDSE
850 This value have been set in an opaque pointer at connection time
852 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
855 return an automatic baseDN from the defaultNamingContext of the rootDSE
856 This value have been set in an opaque pointer at connection time
858 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
861 The default async search callback function
863 \param ldb the context associated with the database (from ldb_init())
864 \param context the callback context (struct ldb_result *)
865 \param ares a single reply from the async core
867 \return result code (LDB_SUCCESS on success, or a failure code)
869 \note this function expects the context to always be an struct ldb_result pointer
870 AND a talloc context, this function will steal on the context each message
871 from the ares reply passed on by the async core so that in the end all the
872 messages will be in the context (ldb_result) memory tree.
873 Freeing the passed context (ldb_result tree) will free all the resources
874 (the request need to be freed separately and the result doe not depend on the
875 request that can be freed as sson as the search request is finished)
878 int ldb_search_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares);
881 Helper function to build a search request
883 \param ret_req the request structure is returned here (talloced on mem_ctx)
884 \param ldb the context associated with the database (from ldb_init())
885 \param mem_ctx a talloc memory context (used as parent of ret_req)
886 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
887 \param scope the search scope for the query
888 \param expression the search expression to use for this query
889 \param attrs the search attributes for the query (pass NULL if none required)
890 \param controls an array of controls
891 \param context the callback function context
892 \param callback the callback function to handle the async replies
894 \return result code (LDB_SUCCESS on success, or a failure code)
897 int ldb_build_search_req(struct ldb_request **ret_req,
898 struct ldb_context *ldb,
901 enum ldb_scope scope,
902 const char *expression,
903 const char * const *attrs,
904 struct ldb_control **controls,
906 ldb_request_callback_t callback);
909 Helper function to build an add request
911 \param ret_req the request structure is returned here (talloced on mem_ctx)
912 \param ldb the context associated with the database (from ldb_init())
913 \param mem_ctx a talloc memory context (used as parent of ret_req)
914 \param message contains the entry to be added
915 \param controls an array of controls
916 \param context the callback function context
917 \param callback the callback function to handle the async replies
919 \return result code (LDB_SUCCESS on success, or a failure code)
922 int ldb_build_add_req(struct ldb_request **ret_req,
923 struct ldb_context *ldb,
925 const struct ldb_message *message,
926 struct ldb_control **controls,
928 ldb_request_callback_t callback);
931 Helper function to build a modify request
933 \param ret_req the request structure is returned here (talloced on mem_ctx)
934 \param ldb the context associated with the database (from ldb_init())
935 \param mem_ctx a talloc memory context (used as parent of ret_req)
936 \param message contains the entry to be modified
937 \param controls an array of controls
938 \param context the callback function context
939 \param callback the callback function to handle the async replies
941 \return result code (LDB_SUCCESS on success, or a failure code)
944 int ldb_build_mod_req(struct ldb_request **ret_req,
945 struct ldb_context *ldb,
947 const struct ldb_message *message,
948 struct ldb_control **controls,
950 ldb_request_callback_t callback);
953 Helper function to build a delete request
955 \param ret_req the request structure is returned here (talloced on mem_ctx)
956 \param ldb the context associated with the database (from ldb_init())
957 \param mem_ctx a talloc memory context (used as parent of ret_req)
958 \param dn the DN to be deleted
959 \param controls an array of controls
960 \param context the callback function context
961 \param callback the callback function to handle the async replies
963 \return result code (LDB_SUCCESS on success, or a failure code)
966 int ldb_build_del_req(struct ldb_request **ret_req,
967 struct ldb_context *ldb,
970 struct ldb_control **controls,
972 ldb_request_callback_t callback);
975 Helper function to build a rename request
977 \param ret_req the request structure is returned here (talloced on mem_ctx)
978 \param ldb the context associated with the database (from ldb_init())
979 \param mem_ctx a talloc memory context (used as parent of ret_req)
980 \param olddn the old DN
981 \param newdn the new DN
982 \param controls an array of controls
983 \param context the callback function context
984 \param callback the callback function to handle the async replies
986 \return result code (LDB_SUCCESS on success, or a failure code)
989 int ldb_build_rename_req(struct ldb_request **ret_req,
990 struct ldb_context *ldb,
992 struct ldb_dn *olddn,
993 struct ldb_dn *newdn,
994 struct ldb_control **controls,
996 ldb_request_callback_t callback);
999 Add a ldb_control to a ldb_request
1001 \param req the request struct where to add the control
1002 \param oid the object identifier of the control as string
1003 \param critical whether the control should be critical or not
1004 \param data a talloc pointer to the control specific data
1006 \return result code (LDB_SUCCESS on success, or a failure code)
1008 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1011 check if a control with the specified "oid" exist and return it
1012 \param req the request struct where to add the control
1013 \param oid the object identifier of the control as string
1015 \return the control, NULL if not found
1017 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid);
1022 This function searches the database, and returns
1023 records that match an LDAP-like search expression
1025 \param ldb the context associated with the database (from ldb_init())
1026 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1027 \param scope the search scope for the query
1028 \param expression the search expression to use for this query
1029 \param attrs the search attributes for the query (pass NULL if none required)
1030 \param res the return result
1032 \return result code (LDB_SUCCESS on success, or a failure code)
1034 \note use talloc_free() to free the ldb_result returned
1036 int ldb_search(struct ldb_context *ldb,
1037 struct ldb_dn *base,
1038 enum ldb_scope scope,
1039 const char *expression,
1040 const char * const *attrs, struct ldb_result **res);
1043 * a useful search function where you can easily define the expression and
1044 * that takes a memory context where results are allocated
1047 int ldb_search_exp_fmt(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1048 struct ldb_result **result, struct ldb_dn *base,
1049 enum ldb_scope scope, const char * const *attrs,
1050 const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1053 Add a record to the database.
1055 This function adds a record to the database. This function will fail
1056 if a record with the specified class and key already exists in the
1059 \param ldb the context associated with the database (from
1061 \param message the message containing the record to add.
1063 \return result code (LDB_SUCCESS if the record was added, otherwise
1066 int ldb_add(struct ldb_context *ldb,
1067 const struct ldb_message *message);
1070 Modify the specified attributes of a record
1072 This function modifies a record that is in the database.
1074 \param ldb the context associated with the database (from
1076 \param message the message containing the changes required.
1078 \return result code (LDB_SUCCESS if the record was modified as
1079 requested, otherwise a failure code)
1081 int ldb_modify(struct ldb_context *ldb,
1082 const struct ldb_message *message);
1085 Rename a record in the database
1087 This function renames a record in the database.
1089 \param ldb the context associated with the database (from
1091 \param olddn the DN for the record to be renamed.
1092 \param newdn the new DN
1094 \return result code (LDB_SUCCESS if the record was renamed as
1095 requested, otherwise a failure code)
1097 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1100 Delete a record from the database
1102 This function deletes a record from the database.
1104 \param ldb the context associated with the database (from
1106 \param dn the DN for the record to be deleted.
1108 \return result code (LDB_SUCCESS if the record was deleted,
1109 otherwise a failure code)
1111 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1114 The default async extended operation callback function
1116 \param ldb the context associated with the database (from ldb_init())
1117 \param context the callback context (struct ldb_result *)
1118 \param ares a single reply from the async core
1120 \return result code (LDB_SUCCESS on success, or a failure code)
1122 \note this function expects the context to always be an struct ldb_result pointer
1123 AND a talloc context, this function will steal on the context each message
1124 from the ares reply passed on by the async core so that in the end all the
1125 messages will be in the context (ldb_result) memory tree.
1126 Freeing the passed context (ldb_result tree) will free all the resources
1127 (the request need to be freed separately and the result doe not depend on the
1128 request that can be freed as sson as the search request is finished)
1130 int ldb_extended_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares);
1133 Helper function to build a extended request
1135 \param ret_req the request structure is returned here (talloced on mem_ctx)
1136 \param ldb the context associated with the database (from ldb_init())
1137 \param mem_ctx a talloc memory context (used as parent of ret_req)
1138 \param oid the OID of the extended operation.
1139 \param data a void pointer a the extended operation specific parameters,
1140 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1141 \param controls an array of controls
1142 \param context the callback function context
1143 \param callback the callback function to handle the async replies
1145 \return result code (LDB_SUCCESS on success, or a failure code)
1147 int ldb_build_extended_req(struct ldb_request **ret_req,
1148 struct ldb_context *ldb,
1149 TALLOC_CTX *mem_ctx,
1151 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1152 struct ldb_control **controls,
1154 ldb_request_callback_t callback);
1157 call an extended operation
1159 This function deletes a record from the database.
1161 \param ldb the context associated with the database (from ldb_init())
1162 \param oid the OID of the extended operation.
1163 \param data a void pointer a the extended operation specific parameters,
1164 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1165 \param res the result of the extended operation
1167 \return result code (LDB_SUCCESS if the extended operation returned fine,
1168 otherwise a failure code)
1170 int ldb_extended(struct ldb_context *ldb,
1172 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1173 struct ldb_result **res);
1178 int ldb_transaction_start(struct ldb_context *ldb);
1181 commit a transaction
1183 int ldb_transaction_commit(struct ldb_context *ldb);
1186 cancel a transaction
1188 int ldb_transaction_cancel(struct ldb_context *ldb);
1192 return extended error information from the last call
1194 const char *ldb_errstring(struct ldb_context *ldb);
1197 return a string explaining what a ldb error constant meancs
1199 const char *ldb_strerror(int ldb_err);
1202 setup the default utf8 functions
1203 FIXME: these functions do not yet handle utf8
1205 void ldb_set_utf8_default(struct ldb_context *ldb);
1210 \param ldb the ldb context
1211 \param mem_ctx the memory context to allocate the result string
1213 \param s the string that is to be folded
1214 \return a copy of the string, converted to upper case
1216 \note The default function is not yet UTF8 aware. Provide your own
1217 set of functions through ldb_set_utf8_fns()
1219 char *ldb_casefold(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s);
1222 Check the attribute name is valid according to rfc2251
1223 \param s the string to check
1225 \return 1 if the name is ok
1227 int ldb_valid_attr_name(const char *s);
1230 ldif manipulation functions
1234 Write an LDIF message
1236 This function writes an LDIF message using a caller supplied write
1239 \param ldb the ldb context (from ldb_init())
1240 \param fprintf_fn a function pointer for the write function. This must take
1241 a private data pointer, followed by a format string, and then a variable argument
1243 \param private_data pointer that will be provided back to the write
1244 function. This is useful for maintaining state or context.
1245 \param ldif the message to write out
1247 \return the total number of bytes written, or an error code as returned
1248 from the write function.
1250 \sa ldb_ldif_write_file for a more convenient way to write to a
1253 \sa ldb_ldif_read for the reader equivalent to this function.
1255 int ldb_ldif_write(struct ldb_context *ldb,
1256 int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1258 const struct ldb_ldif *ldif);
1261 Clean up an LDIF message
1263 This function cleans up a LDIF message read using ldb_ldif_read()
1264 or related functions (such as ldb_ldif_read_string() and
1265 ldb_ldif_read_file().
1267 \param ldb the ldb context (from ldb_init())
1268 \param msg the message to clean up and free
1271 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1274 Read an LDIF message
1276 This function creates an LDIF message using a caller supplied read
1279 \param ldb the ldb context (from ldb_init())
1280 \param fgetc_fn a function pointer for the read function. This must
1281 take a private data pointer, and must return a pointer to an
1282 integer corresponding to the next byte read (or EOF if there is no
1283 more data to be read).
1284 \param private_data pointer that will be provided back to the read
1285 function. This is udeful for maintaining state or context.
1287 \return the LDIF message that has been read in
1289 \note You must free the LDIF message when no longer required, using
1290 ldb_ldif_read_free().
1292 \sa ldb_ldif_read_file for a more convenient way to read from a
1295 \sa ldb_ldif_read_string for a more convenient way to read from a
1296 string (char array).
1298 \sa ldb_ldif_write for the writer equivalent to this function.
1300 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1301 int (*fgetc_fn)(void *), void *private_data);
1304 Read an LDIF message from a file
1306 This function reads the next LDIF message from the contents of a
1307 file stream. If you want to get all of the LDIF messages, you will
1308 need to repeatedly call this function, until it returns NULL.
1310 \param ldb the ldb context (from ldb_init())
1311 \param f the file stream to read from (typically from fdopen())
1313 \sa ldb_ldif_read_string for an equivalent function that will read
1314 from a string (char array).
1316 \sa ldb_ldif_write_file for the writer equivalent to this function.
1319 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1322 Read an LDIF message from a string
1324 This function reads the next LDIF message from the contents of a char
1325 array. If you want to get all of the LDIF messages, you will need
1326 to repeatedly call this function, until it returns NULL.
1328 \param ldb the ldb context (from ldb_init())
1329 \param s pointer to the char array to read from
1331 \sa ldb_ldif_read_file for an equivalent function that will read
1334 \sa ldb_ldif_write for a more general (arbitrary read function)
1335 version of this function.
1337 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1340 Write an LDIF message to a file
1342 \param ldb the ldb context (from ldb_init())
1343 \param f the file stream to write to (typically from fdopen())
1344 \param msg the message to write out
1346 \return the total number of bytes written, or a negative error code
1348 \sa ldb_ldif_read_file for the reader equivalent to this function.
1350 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1353 Base64 encode a buffer
1355 \param mem_ctx the memory context that the result is allocated
1357 \param buf pointer to the array that is to be encoded
1358 \param len the number of elements in the array to be encoded
1360 \return pointer to an array containing the encoded data
1362 \note The caller is responsible for freeing the result
1364 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len);
1367 Base64 decode a buffer
1369 This function decodes a base64 encoded string in place.
1371 \param s the string to decode.
1373 \return the length of the returned (decoded) string.
1375 \note the string is null terminated, but the null terminator is not
1376 included in the length.
1378 int ldb_base64_decode(char *s);
1380 /* The following definitions come from lib/ldb/common/ldb_dn.c */
1382 struct ldb_dn *ldb_dn_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn);
1383 struct ldb_dn *ldb_dn_new_fmt(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1384 bool ldb_dn_validate(struct ldb_dn *dn);
1386 char *ldb_dn_escape_value(TALLOC_CTX *mem_ctx, struct ldb_val value);
1387 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1388 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1389 char *ldb_dn_alloc_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1390 char *ldb_dn_alloc_casefold(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1392 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1393 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1395 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1396 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1397 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1398 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1399 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1400 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1402 struct ldb_dn *ldb_dn_copy(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1403 struct ldb_dn *ldb_dn_get_parent(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1404 char *ldb_dn_canonical_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1405 char *ldb_dn_canonical_ex_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1406 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1407 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1408 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1409 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1410 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1411 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1413 bool ldb_dn_is_valid(struct ldb_dn *dn);
1414 bool ldb_dn_is_special(struct ldb_dn *dn);
1415 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1416 bool ldb_dn_is_null(struct ldb_dn *dn);
1420 Compare two attributes
1422 This function compares to attribute names. Note that this is a
1423 case-insensitive comparison.
1425 \param a the first attribute name to compare
1426 \param b the second attribute name to compare
1428 \return 0 if the attribute names are the same, or only differ in
1429 case; non-zero if there are any differences
1431 attribute names are restricted by rfc2251 so using
1432 strcasecmp and toupper here is ok.
1435 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1436 char *ldb_attr_casefold(TALLOC_CTX *mem_ctx, const char *s);
1437 int ldb_attr_dn(const char *attr);
1440 Create an empty message
1442 \param mem_ctx the memory context to create in. You can pass NULL
1443 to get the top level context, however the ldb context (from
1444 ldb_init()) may be a better choice
1446 struct ldb_message *ldb_msg_new(TALLOC_CTX *mem_ctx);
1449 Find an element within an message
1451 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1452 const char *attr_name);
1455 Compare two ldb_val values
1457 \param v1 first ldb_val structure to be tested
1458 \param v2 second ldb_val structure to be tested
1460 \return 1 for a match, 0 if there is any difference
1462 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1465 find a value within an ldb_message_element
1467 \param el the element to search
1468 \param val the value to search for
1470 \note This search is case sensitive
1472 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1473 struct ldb_val *val);
1476 add a new empty element to a ldb_message
1478 int ldb_msg_add_empty(struct ldb_message *msg,
1479 const char *attr_name,
1481 struct ldb_message_element **return_el);
1484 add a element to a ldb_message
1486 int ldb_msg_add(struct ldb_message *msg,
1487 const struct ldb_message_element *el,
1489 int ldb_msg_add_value(struct ldb_message *msg,
1490 const char *attr_name,
1491 const struct ldb_val *val,
1492 struct ldb_message_element **return_el);
1493 int ldb_msg_add_steal_value(struct ldb_message *msg,
1494 const char *attr_name,
1495 struct ldb_val *val);
1496 int ldb_msg_add_steal_string(struct ldb_message *msg,
1497 const char *attr_name, char *str);
1498 int ldb_msg_add_string(struct ldb_message *msg,
1499 const char *attr_name, const char *str);
1500 int ldb_msg_add_fmt(struct ldb_message *msg,
1501 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1504 compare two message elements - return 0 on match
1506 int ldb_msg_element_compare(struct ldb_message_element *el1,
1507 struct ldb_message_element *el2);
1510 Find elements in a message.
1512 This function finds elements and converts to a specific type, with
1513 a give default value if not found. Assumes that elements are
1516 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1517 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1518 const char *attr_name,
1520 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1521 const char *attr_name,
1522 unsigned int default_value);
1523 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1524 const char *attr_name,
1525 int64_t default_value);
1526 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1527 const char *attr_name,
1528 uint64_t default_value);
1529 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1530 const char *attr_name,
1531 double default_value);
1532 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1533 const char *attr_name,
1535 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1536 const char *attr_name,
1537 const char *default_value);
1539 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1540 TALLOC_CTX *mem_ctx,
1541 const struct ldb_message *msg,
1542 const char *attr_name);
1544 void ldb_msg_sort_elements(struct ldb_message *msg);
1546 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx,
1547 const struct ldb_message *msg);
1548 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx,
1549 const struct ldb_message *msg);
1551 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1552 const struct ldb_message *msg);
1555 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1556 struct ldb_message *msg1,
1557 struct ldb_message *msg2);
1559 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1564 Integrity check an ldb_message
1566 This function performs basic sanity / integrity checks on an
1569 \param ldb context in which to perform the checks
1570 \param msg the message to check
1572 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1573 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1574 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1577 int ldb_msg_sanity_check(struct ldb_context *ldb,
1578 const struct ldb_message *msg);
1581 Duplicate an ldb_val structure
1583 This function copies an ldb value structure.
1585 \param mem_ctx the memory context that the duplicated value will be
1587 \param v the ldb_val to be duplicated.
1589 \return the duplicated ldb_val structure.
1591 struct ldb_val ldb_val_dup(TALLOC_CTX *mem_ctx, const struct ldb_val *v);
1594 this allows the user to set a debug function for error reporting
1596 int ldb_set_debug(struct ldb_context *ldb,
1597 void (*debug)(void *context, enum ldb_debug_level level,
1598 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1602 this allows the user to set custom utf8 function for error reporting
1604 void ldb_set_utf8_fns(struct ldb_context *ldb,
1606 char *(*casefold)(void *, void *, const char *));
1609 this sets up debug to print messages on stderr
1611 int ldb_set_debug_stderr(struct ldb_context *ldb);
1613 /* control backend specific opaque values */
1614 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1615 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1617 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs);
1618 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr);
1619 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1622 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1624 const char *replace);
1626 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1627 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1628 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1631 Convert a time structure to a string
1633 This function converts a time_t structure to an LDAP formatted
1634 GeneralizedTime string.
1636 \param mem_ctx the memory context to allocate the return string in
1637 \param t the time structure to convert
1639 \return the formatted string, or NULL if the time structure could
1642 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t);
1645 Convert a string to a time structure
1647 This function converts an LDAP formatted GeneralizedTime string
1648 to a time_t structure.
1650 \param s the string to convert
1652 \return the time structure, or 0 if the string cannot be converted
1654 time_t ldb_string_to_time(const char *s);
1657 Convert a time structure to a string
1659 This function converts a time_t structure to an LDAP formatted
1662 \param mem_ctx the memory context to allocate the return string in
1663 \param t the time structure to convert
1665 \return the formatted string, or NULL if the time structure could
1668 char *ldb_timestring_utc(TALLOC_CTX *mem_ctx, time_t t);
1671 Convert a string to a time structure
1673 This function converts an LDAP formatted UTCTime string
1674 to a time_t structure.
1676 \param s the string to convert
1678 \return the time structure, or 0 if the string cannot be converted
1680 time_t ldb_string_utc_to_time(const char *s);
1683 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1687 Convert an array of string represention of a control into an array of ldb_control structures
1689 \param ldb LDB context
1690 \param mem_ctx TALLOC context to return result on, and to allocate error_string on
1691 \param control_strings Array of string-formatted controls
1693 \return array of ldb_control elements
1695 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings);