4 Copyright (C) Andrew Tridgell 2004
5 Copyright (C) Stefan Metzmacher 2004
6 Copyright (C) Simo Sorce 2005
8 ** NOTE! The following LGPL license applies to the ldb
9 ** library. This does NOT imply that all of Samba is released
12 This library is free software; you can redistribute it and/or
13 modify it under the terms of the GNU Lesser General Public
14 License as published by the Free Software Foundation; either
15 version 2 of the License, or (at your option) any later version.
17 This library is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 Lesser General Public License for more details.
22 You should have received a copy of the GNU Lesser General Public
23 License along with this library; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * Component: ldb header
32 * Description: defines for base ldb API
34 * Author: Andrew Tridgell
35 * Author: Stefan Metzmacher
39 \file ldb.h Samba's ldb database
41 This header file provides the main API for ldb.
46 /*! \cond DOXYGEN_IGNORE */
51 major restrictions as compared to normal LDAP:
54 - each record must have a unique key field
55 - the key must be representable as a NULL terminated C string and may not
56 contain a comma or braces
58 major restrictions as compared to tdb:
60 - no explicit locking calls
61 UPDATE: we have transactions now, better than locking --SSS.
69 An individual lump of data in a result comes in this format. The
70 pointer will usually be to a UTF-8 string if the application is
71 sensible, but it can be to anything you like, including binary data
72 blobs of arbitrary size.
74 \note the data is null (0x00) terminated, but the length does not
75 include the terminator.
78 uint8_t *data; /*!< result data */
79 size_t length; /*!< length of data */
84 internal ldb exploded dn structures
86 struct ldb_dn_component {
93 struct ldb_dn_component *components;
97 There are a number of flags that are used with ldap_modify() in
98 ldb_message_element.flags fields. The LDA_FLAGS_MOD_ADD,
99 LDA_FLAGS_MOD_DELETE and LDA_FLAGS_MOD_REPLACE flags are used in
100 ldap_modify() calls to specify whether attributes are being added,
101 deleted or modified respectively.
103 #define LDB_FLAG_MOD_MASK 0x3
106 Flag value used in ldap_modify() to indicate that attributes are
109 \sa LDB_FLAG_MOD_MASK
111 #define LDB_FLAG_MOD_ADD 1
114 Flag value used in ldap_modify() to indicate that attributes are
117 \sa LDB_FLAG_MOD_MASK
119 #define LDB_FLAG_MOD_REPLACE 2
122 Flag value used in ldap_modify() to indicate that attributes are
125 \sa LDB_FLAG_MOD_MASK
127 #define LDB_FLAG_MOD_DELETE 3
130 OID for logic AND comaprison.
132 This is the well known object ID for a logical AND comparitor.
134 #define LDB_OID_COMPARATOR_AND "1.2.840.113556.1.4.803"
137 OID for logic OR comparison.
139 This is the well known object ID for a logical OR comparitor.
141 #define LDB_OID_COMPARATOR_OR "1.2.840.113556.1.4.804"
144 results are given back as arrays of ldb_message_element
146 struct ldb_message_element {
149 unsigned int num_values;
150 struct ldb_val *values;
155 a ldb_message represents all or part of a record. It can contain an arbitrary
160 unsigned int num_elements;
161 struct ldb_message_element *elements;
162 void *private_data; /* private to the backend */
165 enum ldb_changetype {
166 LDB_CHANGETYPE_NONE=0,
168 LDB_CHANGETYPE_DELETE,
169 LDB_CHANGETYPE_MODIFY
175 This structure contains a LDIF record, as returned from ldif_read()
176 and equivalent functions.
179 enum ldb_changetype changetype; /*!< The type of change */
180 struct ldb_message *msg; /*!< The changes */
183 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
185 LDB_SCOPE_ONELEVEL=1,
186 LDB_SCOPE_SUBTREE=2};
191 the fuction type for the callback used in traversing the database
193 typedef int (*ldb_traverse_fn)(struct ldb_context *, const struct ldb_message *);
196 /* debugging uses one of the following levels */
197 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
198 LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
201 the user can optionally supply a debug function. The function
202 is based on the vfprintf() style of interface, but with the addition
205 struct ldb_debug_ops {
206 void (*debug)(void *context, enum ldb_debug_level level,
207 const char *fmt, va_list ap);
212 The user can optionally supply a custom utf8 functions,
213 to handle comparisons and casefolding.
215 struct ldb_utf8_fns {
217 char *(*casefold)(void *context, void *mem_ctx, const char *s);
221 Flag value for database connection mode.
223 If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
224 opened read-only, if possible.
226 #define LDB_FLG_RDONLY 1
229 Flag value for database connection mode.
231 If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
232 opened without synchronous operations, if possible.
234 #define LDB_FLG_NOSYNC 2
236 /*! \cond DOXYGEN_IGNORE */
237 #ifndef PRINTF_ATTRIBUTE
238 #define PRINTF_ATTRIBUTE(a,b)
243 structures for ldb_parse_tree handling code
245 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
246 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
247 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
248 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
250 struct ldb_parse_tree {
251 enum ldb_parse_op operation;
254 struct ldb_parse_tree *child;
258 struct ldb_val value;
262 int start_with_wildcard;
263 int end_with_wildcard;
264 struct ldb_val **chunks;
271 struct ldb_val value;
277 struct ldb_val value;
280 unsigned int num_elements;
281 struct ldb_parse_tree **elements;
286 struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
287 char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
292 This function encodes a binary blob using the encoding rules in RFC
293 2254 (Section 4). This function also escapes any non-printable
296 \param ctx the memory context to allocate the return string in.
297 \param val the (potentially) binary data to be encoded
299 \return the encoded data as a null terminated string
301 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
303 char *ldb_binary_encode(void *ctx, struct ldb_val val);
308 This function encodes a string using the encoding rules in RFC 2254
309 (Section 4). This function also escapes any non-printable
312 \param mem_ctx the memory context to allocate the return string in.
313 \param string the string to be encoded
315 \return the encoded data as a null terminated string
317 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
319 char *ldb_binary_encode_string(void *mem_ctx, const char *string);
322 functions for controlling attribute handling
324 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
325 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
327 struct ldb_attrib_handler {
330 /* LDB_ATTR_FLAG_* */
333 /* convert from ldif to binary format */
334 ldb_attr_handler_t ldif_read_fn;
336 /* convert from binary to ldif format */
337 ldb_attr_handler_t ldif_write_fn;
339 /* canonicalise a value, for use by indexing and dn construction */
340 ldb_attr_handler_t canonicalise_fn;
342 /* compare two values */
343 ldb_attr_comparison_t comparison_fn;
347 The attribute is not returned by default
349 #define LDB_ATTR_FLAG_HIDDEN (1<<0)
352 The attribute is constructed from other attributes
354 #define LDB_ATTR_FLAG_CONSTRUCTED (1<<1)
357 LDAP attribute syntax for a DN
359 This is the well-known LDAP attribute syntax for a DN.
361 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
363 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
366 LDAP attribute syntax for a Directory String
368 This is the well-known LDAP attribute syntax for a Directory String.
370 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
372 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
375 LDAP attribute syntax for an integer
377 This is the well-known LDAP attribute syntax for an integer.
379 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
381 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
384 LDAP attribute syntax for an octet string
386 This is the well-known LDAP attribute syntax for an octet string.
388 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
390 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
393 LDAP attribute syntax for UTC time.
395 This is the well-known LDAP attribute syntax for a UTC time.
397 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
399 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
401 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
403 /* sorting helpers */
404 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
407 OID for the paged results control. This control is included in the
408 searchRequest and searchResultDone messages as part of the controls
409 field of the LDAPMessage, as defined in Section 4.1.12 of
412 \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
414 #define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
419 \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>
421 #define LDB_CONTROL_NOTIFICATION_OID "1.2.840.113556.1.4.528"
426 \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>
428 #define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
431 OID for LDAP server sort result extension.
433 This control is included in the searchRequest message as part of
434 the controls field of the LDAPMessage, as defined in Section 4.1.12
435 of LDAP v3. The controlType is set to
436 "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
437 FALSE (where absent is also equivalent to FALSE) at the client's
440 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
442 #define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
445 OID for LDAP server sort result response extension.
447 This control is included in the searchResultDone message as part of
448 the controls field of the LDAPMessage, as defined in Section 4.1.12 of
451 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
453 #define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
456 OID for LDAP Attribute Scoped Query extension.
458 This control is include in SearchRequest or SearchResponse
459 messages as part of the controls field of the LDAPMessage.
461 #define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
464 OID for LDAPrectory Sync extension.
466 This control is include in SearchRequest or SearchResponse
467 messages as part of the controls field of the LDAPMessage.
469 #define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
472 struct ldb_paged_control {
478 struct ldb_extended_dn_control {
482 struct ldb_server_sort_control {
488 struct ldb_sort_resp_control {
493 struct ldb_asq_control {
495 char *source_attribute;
500 struct ldb_dirsync_control {
513 struct ldb_credentials;
515 enum ldb_request_type {
526 struct ldb_message **msgs;
527 struct ldb_control **controls;
531 const struct ldb_dn *base;
532 enum ldb_scope scope;
533 struct ldb_parse_tree *tree;
534 const char * const *attrs;
535 struct ldb_result *res;
539 const struct ldb_message *message;
543 const struct ldb_message *message;
547 const struct ldb_dn *dn;
551 const struct ldb_dn *olddn;
552 const struct ldb_dn *newdn;
555 struct ldb_register_control {
564 struct ldb_search search;
566 struct ldb_modify mod;
567 struct ldb_delete del;
568 struct ldb_rename rename;
569 struct ldb_register_control reg;
572 struct ldb_control **controls;
573 struct ldb_credentials *creds;
576 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
579 Initialise an ldb context
581 This is required before any other LDB call.
583 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
584 no suitable context available.
586 \return pointer to ldb_context that should be free'd (using talloc_free())
587 at the end of the program.
589 struct ldb_context *ldb_init(void *mem_ctx);
592 Connect to a database.
594 This is typically called soon after ldb_init(), and is required prior to
595 any search or database modification operations.
597 The URL can be one of the following forms:
603 \param ldb the context associated with the database (from ldb_init())
604 \param url the URL of the database to connect to, as noted above
605 \param flags a combination of LDB_FLG_* to modify the connection behaviour
606 \param options backend specific options - passed uninterpreted to the backend
608 \return result code (LDB_SUCCESS on success, or a failure code)
610 \note It is an error to connect to a database that does not exist in readonly mode
611 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
612 created if it does not exist.
614 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
619 This function searches the database, and returns
620 records that match an LDAP-like search expression
622 \param ldb the context associated with the database (from ldb_init())
623 \param base the Base Distinguished Name for the query (pass NULL for root DN)
624 \param scope the search scope for the query
625 \param expression the search expression to use for this query
626 \param attrs the search attributes for the query (pass NULL if none required)
627 \param res the return result
629 \return result code (LDB_SUCCESS on success, or a failure code)
631 \note use talloc_free() to free the ldb_result returned
633 int ldb_search(struct ldb_context *ldb,
634 const struct ldb_dn *base,
635 enum ldb_scope scope,
636 const char *expression,
637 const char * const *attrs, struct ldb_result **res);
640 like ldb_search() but takes a parse tree
642 int ldb_search_bytree(struct ldb_context *ldb,
643 const struct ldb_dn *base,
644 enum ldb_scope scope,
645 struct ldb_parse_tree *tree,
646 const char * const *attrs, struct ldb_result **res);
649 Add a record to the database.
651 This function adds a record to the database. This function will fail
652 if a record with the specified class and key already exists in the
655 \param ldb the context associated with the database (from
657 \param message the message containing the record to add.
659 \return result code (LDB_SUCCESS if the record was added, otherwise
662 int ldb_add(struct ldb_context *ldb,
663 const struct ldb_message *message);
666 Modify the specified attributes of a record
668 This function modifies a record that is in the database.
670 \param ldb the context associated with the database (from
672 \param message the message containing the changes required.
674 \return result code (LDB_SUCCESS if the record was modified as
675 requested, otherwise a failure code)
677 int ldb_modify(struct ldb_context *ldb,
678 const struct ldb_message *message);
681 Rename a record in the database
683 This function renames a record in the database.
685 \param ldb the context associated with the database (from
687 \param olddn the DN for the record to be renamed.
688 \param newdn the new DN
690 \return result code (LDB_SUCCESS if the record was renamed as
691 requested, otherwise a failure code)
693 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);
696 Delete a record from the database
698 This function deletes a record from the database.
700 \param ldb the context associated with the database (from
702 \param dn the DN for the record to be deleted.
704 \return result code (LDB_SUCCESS if the record was deleted,
705 otherwise a failure code)
707 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);
712 int ldb_transaction_start(struct ldb_context *ldb);
717 int ldb_transaction_commit(struct ldb_context *ldb);
722 int ldb_transaction_cancel(struct ldb_context *ldb);
726 return extended error information from the last call
728 const char *ldb_errstring(struct ldb_context *ldb);
731 setup the default utf8 functions
732 FIXME: these functions do not yet handle utf8
734 void ldb_set_utf8_default(struct ldb_context *ldb);
739 \param ldb the ldb context
740 \param mem_ctx the memory context to allocate the result string
742 \param s the string that is to be folded
743 \return a copy of the string, converted to upper case
745 \note The default function is not yet UTF8 aware. Provide your own
746 set of functions through ldb_set_utf8_fns()
748 char *ldb_casefold(struct ldb_context *ldb, void *mem_ctx, const char *s);
751 Check the attribute name is valid according to rfc2251
752 \param s tthe string to check
754 \return 1 if the name is ok
756 int ldb_valid_attr_name(const char *s);
759 ldif manipulation functions
762 Write an LDIF message
764 This function writes an LDIF message using a caller supplied write
767 \param ldb the ldb context (from ldb_init())
768 \param fprintf_fn a function pointer for the write function. This must take
769 a private data pointer, followed by a format string, and then a variable argument
771 \param private_data pointer that will be provided back to the write
772 function. This is useful for maintaining state or context.
773 \param ldif the message to write out
775 \return the total number of bytes written, or an error code as returned
776 from the write function.
778 \sa ldb_ldif_write_file for a more convenient way to write to a
781 \sa ldb_ldif_read for the reader equivalent to this function.
783 int ldb_ldif_write(struct ldb_context *ldb,
784 int (*fprintf_fn)(void *, const char *, ...),
786 const struct ldb_ldif *ldif);
789 Clean up an LDIF message
791 This function cleans up a LDIF message read using ldb_ldif_read()
792 or related functions (such as ldb_ldif_read_string() and
793 ldb_ldif_read_file().
795 \param ldb the ldb context (from ldb_init())
796 \param msg the message to clean up and free
799 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
804 This function creates an LDIF message using a caller supplied read
807 \param ldb the ldb context (from ldb_init())
808 \param fgetc_fn a function pointer for the read function. This must
809 take a private data pointer, and must return a pointer to an
810 integer corresponding to the next byte read (or EOF if there is no
811 more data to be read).
812 \param private_data pointer that will be provided back to the read
813 function. This is udeful for maintaining state or context.
815 \return the LDIF message that has been read in
817 \note You must free the LDIF message when no longer required, using
818 ldb_ldif_read_free().
820 \sa ldb_ldif_read_file for a more convenient way to read from a
823 \sa ldb_ldif_read_string for a more convenient way to read from a
826 \sa ldb_ldif_write for the writer equivalent to this function.
828 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
829 int (*fgetc_fn)(void *), void *private_data);
832 Read an LDIF message from a file
834 This function reads the next LDIF message from the contents of a
835 file stream. If you want to get all of the LDIF messages, you will
836 need to repeatedly call this function, until it returns NULL.
838 \param ldb the ldb context (from ldb_init())
839 \param f the file stream to read from (typically from fdopen())
841 \sa ldb_ldif_read_string for an equivalent function that will read
842 from a string (char array).
844 \sa ldb_ldif_write_file for the writer equivalent to this function.
847 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
850 Read an LDIF message from a string
852 This function reads the next LDIF message from the contents of a char
853 array. If you want to get all of the LDIF messages, you will need
854 to repeatedly call this function, until it returns NULL.
856 \param ldb the ldb context (from ldb_init())
857 \param s pointer to the char array to read from
859 \sa ldb_ldif_read_file for an equivalent function that will read
862 \sa ldb_ldif_write for a more general (arbitrary read function)
863 version of this function.
865 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
868 Write an LDIF message to a file
870 \param ldb the ldb context (from ldb_init())
871 \param f the file stream to write to (typically from fdopen())
872 \param msg the message to write out
874 \return the total number of bytes written, or a negative error code
876 \sa ldb_ldif_read_file for the reader equivalent to this function.
878 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
881 Base64 encode a buffer
883 \param mem_ctx the memory context that the result is allocated
885 \param buf pointer to the array that is to be encoded
886 \param len the number of elements in the array to be encoded
888 \return pointer to an array containing the encoded data
890 \note The caller is responsible for freeing the result
892 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
895 Base64 decode a buffer
897 This function decodes a base64 encoded string in place.
899 \param s the string to decode.
901 \return the length of the returned (decoded) string.
903 \note the string is null terminated, but the null terminator is not
904 included in the length.
906 int ldb_base64_decode(char *s);
908 int ldb_attrib_add_handlers(struct ldb_context *ldb,
909 const struct ldb_attrib_handler *handlers,
910 unsigned num_handlers);
912 /* The following definitions come from lib/ldb/common/ldb_dn.c */
914 int ldb_dn_is_special(const struct ldb_dn *dn);
915 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check);
916 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
917 struct ldb_dn *ldb_dn_new(void *mem_ctx);
918 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);
919 struct ldb_dn *ldb_dn_explode_or_special(void *mem_ctx, const char *dn);
920 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn);
921 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
922 int ldb_dn_compare_base(struct ldb_context *ldb, const struct ldb_dn *base, const struct ldb_dn *dn);
923 int ldb_dn_compare(struct ldb_context *ldb, const struct ldb_dn *edn0, const struct ldb_dn *edn1);
924 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
925 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, const char *dn);
926 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el);
927 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn);
928 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn);
929 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
931 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
933 const struct ldb_dn *base);
934 struct ldb_dn *ldb_dn_make_child(void *mem_ctx,
935 const struct ldb_dn_component *component,
936 const struct ldb_dn *base);
937 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2);
938 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...) PRINTF_ATTRIBUTE(3,4);
939 struct ldb_dn_component *ldb_dn_get_rdn(void *mem_ctx, const struct ldb_dn *dn);
941 /* useful functions for ldb_message structure manipulation */
942 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
945 Compare two attributes
947 This function compares to attribute names. Note that this is a
948 case-insensitive comparison.
950 \param attr1 the first attribute name to compare
951 \param attr2 the second attribute name to compare
953 \return 0 if the attribute names are the same, or only differ in
954 case; non-zero if there are any differences
956 int ldb_attr_cmp(const char *attr1, const char *attr2);
957 int ldb_attr_dn(const char *attr);
958 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
961 Create an empty message
963 \param mem_ctx the memory context to create in. You can pass NULL
964 to get the top level context, however the ldb context (from
965 ldb_init()) may be a better choice
967 struct ldb_message *ldb_msg_new(void *mem_ctx);
970 Find an element within an message
972 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
973 const char *attr_name);
976 Compare two ldb_val values
978 \param v1 first ldb_val structure to be tested
979 \param v2 second ldb_val structure to be tested
981 \return 1 for a match, 0 if there is any difference
983 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
986 find a value within an ldb_message_element
988 \param el the element to search
989 \param val the value to search for
991 \note This search is case sensitive
993 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
994 struct ldb_val *val);
997 add a new empty element to a ldb_message
999 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags);
1002 add a element to a ldb_message
1004 int ldb_msg_add(struct ldb_message *msg,
1005 const struct ldb_message_element *el,
1007 int ldb_msg_add_value(struct ldb_message *msg,
1008 const char *attr_name,
1009 const struct ldb_val *val);
1010 int ldb_msg_add_string(struct ldb_message *msg,
1011 const char *attr_name, const char *str);
1012 int ldb_msg_add_fmt(struct ldb_message *msg,
1013 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1016 compare two message elements - return 0 on match
1018 int ldb_msg_element_compare(struct ldb_message_element *el1,
1019 struct ldb_message_element *el2);
1022 Find elements in a message.
1024 This function finds elements and converts to a specific type, with
1025 a give default value if not found. Assumes that elements are
1028 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1029 int ldb_msg_find_int(const struct ldb_message *msg,
1030 const char *attr_name,
1032 unsigned int ldb_msg_find_uint(const struct ldb_message *msg,
1033 const char *attr_name,
1034 unsigned int default_value);
1035 int64_t ldb_msg_find_int64(const struct ldb_message *msg,
1036 const char *attr_name,
1037 int64_t default_value);
1038 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg,
1039 const char *attr_name,
1040 uint64_t default_value);
1041 double ldb_msg_find_double(const struct ldb_message *msg,
1042 const char *attr_name,
1043 double default_value);
1044 const char *ldb_msg_find_string(const struct ldb_message *msg,
1045 const char *attr_name,
1046 const char *default_value);
1048 void ldb_msg_sort_elements(struct ldb_message *msg);
1050 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
1051 const struct ldb_message *msg);
1052 struct ldb_message *ldb_msg_copy(void *mem_ctx,
1053 const struct ldb_message *msg);
1055 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1056 const struct ldb_message *msg);
1059 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1060 struct ldb_message *msg1,
1061 struct ldb_message *msg2);
1064 Integrity check an ldb_message
1066 This function performs basic sanity / integrity checks on an
1069 \param msg the message to check
1071 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1072 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1073 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1076 int ldb_msg_sanity_check(const struct ldb_message *msg);
1079 Duplicate an ldb_val structure
1081 This function copies an ldb value structure.
1083 \param mem_ctx the memory context that the duplicated value will be
1085 \param v the ldb_val to be duplicated.
1087 \return the duplicated ldb_val structure.
1089 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
1092 this allows the user to set a debug function for error reporting
1094 int ldb_set_debug(struct ldb_context *ldb,
1095 void (*debug)(void *context, enum ldb_debug_level level,
1096 const char *fmt, va_list ap),
1100 this allows the user to set custom utf8 function for error reporting
1102 void ldb_set_utf8_fns(struct ldb_context *ldb,
1104 char *(*casefold)(void *, void *, const char *));
1107 this sets up debug to print messages on stderr
1109 int ldb_set_debug_stderr(struct ldb_context *ldb);
1111 /* control backend specific opaque values */
1112 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1113 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1115 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
1116 const char *attrib);
1119 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
1120 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1123 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1125 const char *replace);
1127 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1128 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1129 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1132 Convert a time structure to a string
1134 This function converts a time_t structure to an LDAP formatted time
1137 \param mem_ctx the memory context to allocate the return string in
1138 \param t the time structure to convert
1140 \return the formatted string, or NULL if the time structure could
1143 char *ldb_timestring(void *mem_ctx, time_t t);
1146 Convert a string to a time structure
1148 This function converts an LDAP formatted time string to a time_t
1151 \param s the string to convert
1153 \return the time structure, or 0 if the string cannot be converted
1155 time_t ldb_string_to_time(const char *s);
1157 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn);
1158 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn);
1161 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);