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 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 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);
787 Initialise ldbs' global information
789 This is required before any other LDB call
791 \return 0 if initialisation succeeded, -1 otherwise
793 int ldb_global_init(void);
796 Initialise an ldb context
798 This is required before any other LDB call.
800 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
801 no suitable context available.
803 \return pointer to ldb_context that should be free'd (using talloc_free())
804 at the end of the program.
806 struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx);
809 Connect to a database.
811 This is typically called soon after ldb_init(), and is required prior to
812 any search or database modification operations.
814 The URL can be one of the following forms:
820 \param ldb the context associated with the database (from ldb_init())
821 \param url the URL of the database to connect to, as noted above
822 \param flags a combination of LDB_FLG_* to modify the connection behaviour
823 \param options backend specific options - passed uninterpreted to the backend
825 \return result code (LDB_SUCCESS on success, or a failure code)
827 \note It is an error to connect to a database that does not exist in readonly mode
828 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
829 created if it does not exist.
831 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
834 return an automatic basedn from the rootDomainNamingContext of the rootDSE
835 This value have been set in an opaque pointer at connection time
837 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
840 return an automatic basedn from the configurationNamingContext of the rootDSE
841 This value have been set in an opaque pointer at connection time
843 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
846 return an automatic basedn from the schemaNamingContext of the rootDSE
847 This value have been set in an opaque pointer at connection time
849 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
852 return an automatic baseDN from the defaultNamingContext of the rootDSE
853 This value have been set in an opaque pointer at connection time
855 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
858 The default async search callback function
860 \param ldb the context associated with the database (from ldb_init())
861 \param context the callback context (struct ldb_result *)
862 \param ares a single reply from the async core
864 \return result code (LDB_SUCCESS on success, or a failure code)
866 \note this function expects the context to always be an struct ldb_result pointer
867 AND a talloc context, this function will steal on the context each message
868 from the ares reply passed on by the async core so that in the end all the
869 messages will be in the context (ldb_result) memory tree.
870 Freeing the passed context (ldb_result tree) will free all the resources
871 (the request need to be freed separately and the result doe not depend on the
872 request that can be freed as sson as the search request is finished)
875 int ldb_search_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares);
878 Helper function to build a search request
880 \param ret_req the request structure is returned here (talloced on mem_ctx)
881 \param ldb the context associated with the database (from ldb_init())
882 \param mem_ctx a talloc memory context (used as parent of ret_req)
883 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
884 \param scope the search scope for the query
885 \param expression the search expression to use for this query
886 \param attrs the search attributes for the query (pass NULL if none required)
887 \param controls an array of controls
888 \param context the callback function context
889 \param callback the callback function to handle the async replies
891 \return result code (LDB_SUCCESS on success, or a failure code)
894 int ldb_build_search_req(struct ldb_request **ret_req,
895 struct ldb_context *ldb,
898 enum ldb_scope scope,
899 const char *expression,
900 const char * const *attrs,
901 struct ldb_control **controls,
903 ldb_request_callback_t callback);
906 Helper function to build an add request
908 \param ret_req the request structure is returned here (talloced on mem_ctx)
909 \param ldb the context associated with the database (from ldb_init())
910 \param mem_ctx a talloc memory context (used as parent of ret_req)
911 \param message contains the entry to be added
912 \param controls an array of controls
913 \param context the callback function context
914 \param callback the callback function to handle the async replies
916 \return result code (LDB_SUCCESS on success, or a failure code)
919 int ldb_build_add_req(struct ldb_request **ret_req,
920 struct ldb_context *ldb,
922 const struct ldb_message *message,
923 struct ldb_control **controls,
925 ldb_request_callback_t callback);
928 Helper function to build a modify request
930 \param ret_req the request structure is returned here (talloced on mem_ctx)
931 \param ldb the context associated with the database (from ldb_init())
932 \param mem_ctx a talloc memory context (used as parent of ret_req)
933 \param message contains the entry to be modified
934 \param controls an array of controls
935 \param context the callback function context
936 \param callback the callback function to handle the async replies
938 \return result code (LDB_SUCCESS on success, or a failure code)
941 int ldb_build_mod_req(struct ldb_request **ret_req,
942 struct ldb_context *ldb,
944 const struct ldb_message *message,
945 struct ldb_control **controls,
947 ldb_request_callback_t callback);
950 Helper function to build a delete request
952 \param ret_req the request structure is returned here (talloced on mem_ctx)
953 \param ldb the context associated with the database (from ldb_init())
954 \param mem_ctx a talloc memory context (used as parent of ret_req)
955 \param dn the DN to be deleted
956 \param controls an array of controls
957 \param context the callback function context
958 \param callback the callback function to handle the async replies
960 \return result code (LDB_SUCCESS on success, or a failure code)
963 int ldb_build_del_req(struct ldb_request **ret_req,
964 struct ldb_context *ldb,
967 struct ldb_control **controls,
969 ldb_request_callback_t callback);
972 Helper function to build a rename request
974 \param ret_req the request structure is returned here (talloced on mem_ctx)
975 \param ldb the context associated with the database (from ldb_init())
976 \param mem_ctx a talloc memory context (used as parent of ret_req)
977 \param olddn the old DN
978 \param newdn the new DN
979 \param controls an array of controls
980 \param context the callback function context
981 \param callback the callback function to handle the async replies
983 \return result code (LDB_SUCCESS on success, or a failure code)
986 int ldb_build_rename_req(struct ldb_request **ret_req,
987 struct ldb_context *ldb,
989 struct ldb_dn *olddn,
990 struct ldb_dn *newdn,
991 struct ldb_control **controls,
993 ldb_request_callback_t callback);
996 Add a ldb_control to a ldb_request
998 \param req the request struct where to add the control
999 \param oid the object identifier of the control as string
1000 \param critical whether the control should be critical or not
1001 \param data a talloc pointer to the control specific data
1003 \return result code (LDB_SUCCESS on success, or a failure code)
1005 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1008 check if a control with the specified "oid" exist and return it
1009 \param req the request struct where to add the control
1010 \param oid the object identifier of the control as string
1012 \return the control, NULL if not found
1014 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid);
1019 This function searches the database, and returns
1020 records that match an LDAP-like search expression
1022 \param ldb the context associated with the database (from ldb_init())
1023 \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1024 \param scope the search scope for the query
1025 \param expression the search expression to use for this query
1026 \param attrs the search attributes for the query (pass NULL if none required)
1027 \param res the return result
1029 \return result code (LDB_SUCCESS on success, or a failure code)
1031 \note use talloc_free() to free the ldb_result returned
1033 int ldb_search(struct ldb_context *ldb,
1034 struct ldb_dn *base,
1035 enum ldb_scope scope,
1036 const char *expression,
1037 const char * const *attrs, struct ldb_result **res);
1040 * a useful search function where you can easily define the expression and
1041 * that takes a memory context where results are allocated
1044 int ldb_search_exp_fmt(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1045 struct ldb_result **result, struct ldb_dn *base,
1046 enum ldb_scope scope, const char * const *attrs,
1047 const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1050 Add a record to the database.
1052 This function adds a record to the database. This function will fail
1053 if a record with the specified class and key already exists in the
1056 \param ldb the context associated with the database (from
1058 \param message the message containing the record to add.
1060 \return result code (LDB_SUCCESS if the record was added, otherwise
1063 int ldb_add(struct ldb_context *ldb,
1064 const struct ldb_message *message);
1067 Modify the specified attributes of a record
1069 This function modifies a record that is in the database.
1071 \param ldb the context associated with the database (from
1073 \param message the message containing the changes required.
1075 \return result code (LDB_SUCCESS if the record was modified as
1076 requested, otherwise a failure code)
1078 int ldb_modify(struct ldb_context *ldb,
1079 const struct ldb_message *message);
1082 Rename a record in the database
1084 This function renames a record in the database.
1086 \param ldb the context associated with the database (from
1088 \param olddn the DN for the record to be renamed.
1089 \param newdn the new DN
1091 \return result code (LDB_SUCCESS if the record was renamed as
1092 requested, otherwise a failure code)
1094 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1097 Delete a record from the database
1099 This function deletes a record from the database.
1101 \param ldb the context associated with the database (from
1103 \param dn the DN for the record to be deleted.
1105 \return result code (LDB_SUCCESS if the record was deleted,
1106 otherwise a failure code)
1108 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1111 The default async extended operation callback function
1113 \param ldb the context associated with the database (from ldb_init())
1114 \param context the callback context (struct ldb_result *)
1115 \param ares a single reply from the async core
1117 \return result code (LDB_SUCCESS on success, or a failure code)
1119 \note this function expects the context to always be an struct ldb_result pointer
1120 AND a talloc context, this function will steal on the context each message
1121 from the ares reply passed on by the async core so that in the end all the
1122 messages will be in the context (ldb_result) memory tree.
1123 Freeing the passed context (ldb_result tree) will free all the resources
1124 (the request need to be freed separately and the result doe not depend on the
1125 request that can be freed as sson as the search request is finished)
1127 int ldb_extended_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares);
1130 Helper function to build a extended request
1132 \param ret_req the request structure is returned here (talloced on mem_ctx)
1133 \param ldb the context associated with the database (from ldb_init())
1134 \param mem_ctx a talloc memory context (used as parent of ret_req)
1135 \param oid the OID of the extended operation.
1136 \param data a void pointer a the extended operation specific parameters,
1137 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1138 \param controls an array of controls
1139 \param context the callback function context
1140 \param callback the callback function to handle the async replies
1142 \return result code (LDB_SUCCESS on success, or a failure code)
1144 int ldb_build_extended_req(struct ldb_request **ret_req,
1145 struct ldb_context *ldb,
1146 TALLOC_CTX *mem_ctx,
1148 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1149 struct ldb_control **controls,
1151 ldb_request_callback_t callback);
1154 call an extended operation
1156 This function deletes a record from the database.
1158 \param ldb the context associated with the database (from ldb_init())
1159 \param oid the OID of the extended operation.
1160 \param data a void pointer a the extended operation specific parameters,
1161 it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1162 \param res the result of the extended operation
1164 \return result code (LDB_SUCCESS if the extended operation returned fine,
1165 otherwise a failure code)
1167 int ldb_extended(struct ldb_context *ldb,
1169 void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1170 struct ldb_result **res);
1175 int ldb_transaction_start(struct ldb_context *ldb);
1178 commit a transaction
1180 int ldb_transaction_commit(struct ldb_context *ldb);
1183 cancel a transaction
1185 int ldb_transaction_cancel(struct ldb_context *ldb);
1189 return extended error information from the last call
1191 const char *ldb_errstring(struct ldb_context *ldb);
1194 return a string explaining what a ldb error constant meancs
1196 const char *ldb_strerror(int ldb_err);
1199 setup the default utf8 functions
1200 FIXME: these functions do not yet handle utf8
1202 void ldb_set_utf8_default(struct ldb_context *ldb);
1207 \param ldb the ldb context
1208 \param mem_ctx the memory context to allocate the result string
1210 \param s the string that is to be folded
1211 \return a copy of the string, converted to upper case
1213 \note The default function is not yet UTF8 aware. Provide your own
1214 set of functions through ldb_set_utf8_fns()
1216 char *ldb_casefold(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s);
1219 Check the attribute name is valid according to rfc2251
1220 \param s the string to check
1222 \return 1 if the name is ok
1224 int ldb_valid_attr_name(const char *s);
1227 ldif manipulation functions
1231 Write an LDIF message
1233 This function writes an LDIF message using a caller supplied write
1236 \param ldb the ldb context (from ldb_init())
1237 \param fprintf_fn a function pointer for the write function. This must take
1238 a private data pointer, followed by a format string, and then a variable argument
1240 \param private_data pointer that will be provided back to the write
1241 function. This is useful for maintaining state or context.
1242 \param ldif the message to write out
1244 \return the total number of bytes written, or an error code as returned
1245 from the write function.
1247 \sa ldb_ldif_write_file for a more convenient way to write to a
1250 \sa ldb_ldif_read for the reader equivalent to this function.
1252 int ldb_ldif_write(struct ldb_context *ldb,
1253 int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1255 const struct ldb_ldif *ldif);
1258 Clean up an LDIF message
1260 This function cleans up a LDIF message read using ldb_ldif_read()
1261 or related functions (such as ldb_ldif_read_string() and
1262 ldb_ldif_read_file().
1264 \param ldb the ldb context (from ldb_init())
1265 \param msg the message to clean up and free
1268 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1271 Read an LDIF message
1273 This function creates an LDIF message using a caller supplied read
1276 \param ldb the ldb context (from ldb_init())
1277 \param fgetc_fn a function pointer for the read function. This must
1278 take a private data pointer, and must return a pointer to an
1279 integer corresponding to the next byte read (or EOF if there is no
1280 more data to be read).
1281 \param private_data pointer that will be provided back to the read
1282 function. This is udeful for maintaining state or context.
1284 \return the LDIF message that has been read in
1286 \note You must free the LDIF message when no longer required, using
1287 ldb_ldif_read_free().
1289 \sa ldb_ldif_read_file for a more convenient way to read from a
1292 \sa ldb_ldif_read_string for a more convenient way to read from a
1293 string (char array).
1295 \sa ldb_ldif_write for the writer equivalent to this function.
1297 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1298 int (*fgetc_fn)(void *), void *private_data);
1301 Read an LDIF message from a file
1303 This function reads the next LDIF message from the contents of a
1304 file stream. If you want to get all of the LDIF messages, you will
1305 need to repeatedly call this function, until it returns NULL.
1307 \param ldb the ldb context (from ldb_init())
1308 \param f the file stream to read from (typically from fdopen())
1310 \sa ldb_ldif_read_string for an equivalent function that will read
1311 from a string (char array).
1313 \sa ldb_ldif_write_file for the writer equivalent to this function.
1316 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1319 Read an LDIF message from a string
1321 This function reads the next LDIF message from the contents of a char
1322 array. If you want to get all of the LDIF messages, you will need
1323 to repeatedly call this function, until it returns NULL.
1325 \param ldb the ldb context (from ldb_init())
1326 \param s pointer to the char array to read from
1328 \sa ldb_ldif_read_file for an equivalent function that will read
1331 \sa ldb_ldif_write for a more general (arbitrary read function)
1332 version of this function.
1334 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1337 Write an LDIF message to a file
1339 \param ldb the ldb context (from ldb_init())
1340 \param f the file stream to write to (typically from fdopen())
1341 \param msg the message to write out
1343 \return the total number of bytes written, or a negative error code
1345 \sa ldb_ldif_read_file for the reader equivalent to this function.
1347 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1350 Base64 encode a buffer
1352 \param mem_ctx the memory context that the result is allocated
1354 \param buf pointer to the array that is to be encoded
1355 \param len the number of elements in the array to be encoded
1357 \return pointer to an array containing the encoded data
1359 \note The caller is responsible for freeing the result
1361 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len);
1364 Base64 decode a buffer
1366 This function decodes a base64 encoded string in place.
1368 \param s the string to decode.
1370 \return the length of the returned (decoded) string.
1372 \note the string is null terminated, but the null terminator is not
1373 included in the length.
1375 int ldb_base64_decode(char *s);
1377 /* The following definitions come from lib/ldb/common/ldb_dn.c */
1379 struct ldb_dn *ldb_dn_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn);
1380 struct ldb_dn *ldb_dn_new_fmt(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1381 bool ldb_dn_validate(struct ldb_dn *dn);
1383 char *ldb_dn_escape_value(TALLOC_CTX *mem_ctx, struct ldb_val value);
1384 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1385 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1386 char *ldb_dn_alloc_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1387 char *ldb_dn_alloc_casefold(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1389 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1390 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1392 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1393 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1394 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1395 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1396 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1397 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1399 struct ldb_dn *ldb_dn_copy(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1400 struct ldb_dn *ldb_dn_get_parent(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1401 char *ldb_dn_canonical_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1402 char *ldb_dn_canonical_ex_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1403 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1404 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1405 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1406 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1407 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1408 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1410 bool ldb_dn_is_valid(struct ldb_dn *dn);
1411 bool ldb_dn_is_special(struct ldb_dn *dn);
1412 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1413 bool ldb_dn_is_null(struct ldb_dn *dn);
1417 Compare two attributes
1419 This function compares to attribute names. Note that this is a
1420 case-insensitive comparison.
1422 \param a the first attribute name to compare
1423 \param b the second attribute name to compare
1425 \return 0 if the attribute names are the same, or only differ in
1426 case; non-zero if there are any differences
1428 attribute names are restricted by rfc2251 so using
1429 strcasecmp and toupper here is ok.
1432 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1433 char *ldb_attr_casefold(TALLOC_CTX *mem_ctx, const char *s);
1434 int ldb_attr_dn(const char *attr);
1437 Create an empty message
1439 \param mem_ctx the memory context to create in. You can pass NULL
1440 to get the top level context, however the ldb context (from
1441 ldb_init()) may be a better choice
1443 struct ldb_message *ldb_msg_new(TALLOC_CTX *mem_ctx);
1446 Find an element within an message
1448 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1449 const char *attr_name);
1452 Compare two ldb_val values
1454 \param v1 first ldb_val structure to be tested
1455 \param v2 second ldb_val structure to be tested
1457 \return 1 for a match, 0 if there is any difference
1459 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1462 find a value within an ldb_message_element
1464 \param el the element to search
1465 \param val the value to search for
1467 \note This search is case sensitive
1469 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1470 struct ldb_val *val);
1473 add a new empty element to a ldb_message
1475 int ldb_msg_add_empty(struct ldb_message *msg,
1476 const char *attr_name,
1478 struct ldb_message_element **return_el);
1481 add a element to a ldb_message
1483 int ldb_msg_add(struct ldb_message *msg,
1484 const struct ldb_message_element *el,
1486 int ldb_msg_add_value(struct ldb_message *msg,
1487 const char *attr_name,
1488 const struct ldb_val *val,
1489 struct ldb_message_element **return_el);
1490 int ldb_msg_add_steal_value(struct ldb_message *msg,
1491 const char *attr_name,
1492 struct ldb_val *val);
1493 int ldb_msg_add_steal_string(struct ldb_message *msg,
1494 const char *attr_name, char *str);
1495 int ldb_msg_add_string(struct ldb_message *msg,
1496 const char *attr_name, const char *str);
1497 int ldb_msg_add_fmt(struct ldb_message *msg,
1498 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1501 compare two message elements - return 0 on match
1503 int ldb_msg_element_compare(struct ldb_message_element *el1,
1504 struct ldb_message_element *el2);
1507 Find elements in a message.
1509 This function finds elements and converts to a specific type, with
1510 a give default value if not found. Assumes that elements are
1513 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1514 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1515 const char *attr_name,
1517 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1518 const char *attr_name,
1519 unsigned int default_value);
1520 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1521 const char *attr_name,
1522 int64_t default_value);
1523 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1524 const char *attr_name,
1525 uint64_t default_value);
1526 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1527 const char *attr_name,
1528 double default_value);
1529 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1530 const char *attr_name,
1532 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1533 const char *attr_name,
1534 const char *default_value);
1536 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1537 TALLOC_CTX *mem_ctx,
1538 const struct ldb_message *msg,
1539 const char *attr_name);
1541 void ldb_msg_sort_elements(struct ldb_message *msg);
1543 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx,
1544 const struct ldb_message *msg);
1545 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx,
1546 const struct ldb_message *msg);
1548 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1549 const struct ldb_message *msg);
1552 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1553 struct ldb_message *msg1,
1554 struct ldb_message *msg2);
1556 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1561 Integrity check an ldb_message
1563 This function performs basic sanity / integrity checks on an
1566 \param ldb context in which to perform the checks
1567 \param msg the message to check
1569 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1570 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1571 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1574 int ldb_msg_sanity_check(struct ldb_context *ldb,
1575 const struct ldb_message *msg);
1578 Duplicate an ldb_val structure
1580 This function copies an ldb value structure.
1582 \param mem_ctx the memory context that the duplicated value will be
1584 \param v the ldb_val to be duplicated.
1586 \return the duplicated ldb_val structure.
1588 struct ldb_val ldb_val_dup(TALLOC_CTX *mem_ctx, const struct ldb_val *v);
1591 this allows the user to set a debug function for error reporting
1593 int ldb_set_debug(struct ldb_context *ldb,
1594 void (*debug)(void *context, enum ldb_debug_level level,
1595 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1599 this allows the user to set custom utf8 function for error reporting
1601 void ldb_set_utf8_fns(struct ldb_context *ldb,
1603 char *(*casefold)(void *, void *, const char *));
1606 this sets up debug to print messages on stderr
1608 int ldb_set_debug_stderr(struct ldb_context *ldb);
1610 /* control backend specific opaque values */
1611 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1612 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1614 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs);
1615 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr);
1616 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1619 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1621 const char *replace);
1623 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1624 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1625 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1628 Convert a time structure to a string
1630 This function converts a time_t structure to an LDAP formatted
1631 GeneralizedTime string.
1633 \param mem_ctx the memory context to allocate the return string in
1634 \param t the time structure to convert
1636 \return the formatted string, or NULL if the time structure could
1639 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t);
1642 Convert a string to a time structure
1644 This function converts an LDAP formatted GeneralizedTime string
1645 to a time_t structure.
1647 \param s the string to convert
1649 \return the time structure, or 0 if the string cannot be converted
1651 time_t ldb_string_to_time(const char *s);
1654 Convert a time structure to a string
1656 This function converts a time_t structure to an LDAP formatted
1659 \param mem_ctx the memory context to allocate the return string in
1660 \param t the time structure to convert
1662 \return the formatted string, or NULL if the time structure could
1665 char *ldb_timestring_utc(TALLOC_CTX *mem_ctx, time_t t);
1668 Convert a string to a time structure
1670 This function converts an LDAP formatted UTCTime string
1671 to a time_t structure.
1673 \param s the string to convert
1675 \return the time structure, or 0 if the string cannot be converted
1677 time_t ldb_string_utc_to_time(const char *s);
1680 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1684 Convert an array of string represention of a control into an array of ldb_control structures
1686 \param ldb LDB context
1687 \param mem_ctx TALLOC context to return result on, and to allocate error_string on
1688 \param control_strings Array of string-formatted controls
1690 \return array of ldb_control elements
1692 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings);