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 int (*caseless_cmp)(void *context, const char *s1, const char *s2);
218 char *(*casefold)(void *context, void *mem_ctx, const char *s);
222 Flag value for database connection mode.
224 If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
225 opened read-only, if possible.
227 #define LDB_FLG_RDONLY 1
230 Flag value for database connection mode.
232 If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
233 opened without synchronous operations, if possible.
235 #define LDB_FLG_NOSYNC 2
237 /*! \cond DOXYGEN_IGNORE */
238 #ifndef PRINTF_ATTRIBUTE
239 #define PRINTF_ATTRIBUTE(a,b)
244 structures for ldb_parse_tree handling code
246 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
247 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
248 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
249 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
251 struct ldb_parse_tree {
252 enum ldb_parse_op operation;
255 struct ldb_parse_tree *child;
259 struct ldb_val value;
263 int start_with_wildcard;
264 int end_with_wildcard;
265 struct ldb_val **chunks;
272 struct ldb_val value;
278 struct ldb_val value;
281 unsigned int num_elements;
282 struct ldb_parse_tree **elements;
287 struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
288 char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
293 This function encodes a binary blob using the encoding rules in RFC
294 2254 (Section 4). This function also escapes any non-printable
297 \param ctx the memory context to allocate the return string in.
298 \param val the (potentially) binary data to be encoded
300 \return the encoded data as a null terminated string
302 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
304 char *ldb_binary_encode(void *ctx, struct ldb_val val);
309 This function encodes a string using the encoding rules in RFC 2254
310 (Section 4). This function also escapes any non-printable
313 \param mem_ctx the memory context to allocate the return string in.
314 \param string the string to be encoded
316 \return the encoded data as a null terminated string
318 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
320 char *ldb_binary_encode_string(void *mem_ctx, const char *string);
323 functions for controlling attribute handling
325 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
326 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
328 struct ldb_attrib_handler {
331 /* LDB_ATTR_FLAG_* */
334 /* convert from ldif to binary format */
335 ldb_attr_handler_t ldif_read_fn;
337 /* convert from binary to ldif format */
338 ldb_attr_handler_t ldif_write_fn;
340 /* canonicalise a value, for use by indexing and dn construction */
341 ldb_attr_handler_t canonicalise_fn;
343 /* compare two values */
344 ldb_attr_comparison_t comparison_fn;
348 The attribute is not returned by default
350 #define LDB_ATTR_FLAG_HIDDEN (1<<0)
353 The attribute is constructed from other attributes
355 #define LDB_ATTR_FLAG_CONSTRUCTED (1<<1)
358 LDAP attribute syntax for a DN
360 This is the well-known LDAP attribute syntax for a DN.
362 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
364 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
367 LDAP attribute syntax for a Directory String
369 This is the well-known LDAP attribute syntax for a Directory String.
371 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
373 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
376 LDAP attribute syntax for an integer
378 This is the well-known LDAP attribute syntax for an integer.
380 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
382 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
385 LDAP attribute syntax for an octet string
387 This is the well-known LDAP attribute syntax for an octet string.
389 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
391 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
394 LDAP attribute syntax for UTC time.
396 This is the well-known LDAP attribute syntax for a UTC time.
398 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
400 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
402 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
404 /* sorting helpers */
405 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
408 OID for the paged results control. This control is included in the
409 searchRequest and searchResultDone messages as part of the controls
410 field of the LDAPMessage, as defined in Section 4.1.12 of
413 \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
415 #define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
420 \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>
422 #define LDB_CONTROL_NOTIFICATION_OID "1.2.840.113556.1.4.528"
427 \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>
429 #define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
432 OID for LDAP server sort result extension.
434 This control is included in the searchRequest message as part of
435 the controls field of the LDAPMessage, as defined in Section 4.1.12
436 of LDAP v3. The controlType is set to
437 "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
438 FALSE (where absent is also equivalent to FALSE) at the client's
441 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
443 #define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
446 OID for LDAP server sort result response extension.
448 This control is included in the searchResultDone message as part of
449 the controls field of the LDAPMessage, as defined in Section 4.1.12 of
452 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
454 #define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
457 OID for LDAP Attribute Scoped Query extension.
459 This control is include in SearchRequest or SearchResponse
460 messages as part of the controls field of the LDAPMessage.
462 #define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
465 OID for LDAPrectory Sync extension.
467 This control is include in SearchRequest or SearchResponse
468 messages as part of the controls field of the LDAPMessage.
470 #define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
473 struct ldb_paged_control {
479 struct ldb_extended_dn_control {
483 struct ldb_server_sort_control {
489 struct ldb_sort_resp_control {
494 struct ldb_asq_control {
496 char *source_attribute;
501 struct ldb_dirsync_control {
514 struct ldb_credentials;
516 enum ldb_request_type {
527 struct ldb_message **msgs;
528 struct ldb_control **controls;
532 const struct ldb_dn *base;
533 enum ldb_scope scope;
534 struct ldb_parse_tree *tree;
535 const char * const *attrs;
536 struct ldb_result *res;
540 const struct ldb_message *message;
544 const struct ldb_message *message;
548 const struct ldb_dn *dn;
552 const struct ldb_dn *olddn;
553 const struct ldb_dn *newdn;
556 struct ldb_register_control {
565 struct ldb_search search;
567 struct ldb_modify mod;
568 struct ldb_delete del;
569 struct ldb_rename rename;
570 struct ldb_register_control reg;
573 struct ldb_control **controls;
574 struct ldb_credentials *creds;
577 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
580 Initialise an ldb context
582 This is required before any other LDB call.
584 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
585 no suitable context available.
587 \return pointer to ldb_context that should be free'd (using talloc_free())
588 at the end of the program.
590 struct ldb_context *ldb_init(void *mem_ctx);
593 Connect to a database.
595 This is typically called soon after ldb_init(), and is required prior to
596 any search or database modification operations.
598 The URL can be one of the following forms:
604 \param ldb the context associated with the database (from ldb_init())
605 \param url the URL of the database to connect to, as noted above
606 \param flags a combination of LDB_FLG_* to modify the connection behaviour
607 \param options backend specific options - passed uninterpreted to the backend
609 \return result code (LDB_SUCCESS on success, or a failure code)
611 \note It is an error to connect to a database that does not exist in readonly mode
612 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
613 created if it does not exist.
615 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
620 This function searches the database, and returns
621 records that match an LDAP-like search expression
623 \param ldb the context associated with the database (from ldb_init())
624 \param base the Base Distinguished Name for the query (pass NULL for root DN)
625 \param scope the search scope for the query
626 \param expression the search expression to use for this query
627 \param attrs the search attributes for the query (pass NULL if none required)
628 \param res the return result
630 \return result code (LDB_SUCCESS on success, or a failure code)
632 \note use talloc_free() to free the ldb_result returned
634 int ldb_search(struct ldb_context *ldb,
635 const struct ldb_dn *base,
636 enum ldb_scope scope,
637 const char *expression,
638 const char * const *attrs, struct ldb_result **res);
641 like ldb_search() but takes a parse tree
643 int ldb_search_bytree(struct ldb_context *ldb,
644 const struct ldb_dn *base,
645 enum ldb_scope scope,
646 struct ldb_parse_tree *tree,
647 const char * const *attrs, struct ldb_result **res);
650 Add a record to the database.
652 This function adds a record to the database. This function will fail
653 if a record with the specified class and key already exists in the
656 \param ldb the context associated with the database (from
658 \param message the message containing the record to add.
660 \return result code (LDB_SUCCESS if the record was added, otherwise
663 int ldb_add(struct ldb_context *ldb,
664 const struct ldb_message *message);
667 Modify the specified attributes of a record
669 This function modifies a record that is in the database.
671 \param ldb the context associated with the database (from
673 \param message the message containing the changes required.
675 \return result code (LDB_SUCCESS if the record was modified as
676 requested, otherwise a failure code)
678 int ldb_modify(struct ldb_context *ldb,
679 const struct ldb_message *message);
682 Rename a record in the database
684 This function renames a record in the database.
686 \param ldb the context associated with the database (from
688 \param olddn the DN for the record to be renamed.
689 \param newdn the new DN
691 \return result code (LDB_SUCCESS if the record was renamed as
692 requested, otherwise a failure code)
694 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);
697 Delete a record from the database
699 This function deletes a record from the database.
701 \param ldb the context associated with the database (from
703 \param dn the DN for the record to be deleted.
705 \return result code (LDB_SUCCESS if the record was deleted,
706 otherwise a failure code)
708 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);
713 int ldb_transaction_start(struct ldb_context *ldb);
718 int ldb_transaction_commit(struct ldb_context *ldb);
723 int ldb_transaction_cancel(struct ldb_context *ldb);
727 return extended error information from the last call
729 const char *ldb_errstring(struct ldb_context *ldb);
732 setup the default utf8 functions
733 FIXME: these functions do not yet handle utf8
735 void ldb_set_utf8_default(struct ldb_context *ldb);
740 \param ldb the ldb context
741 \param mem_ctx the memory context to allocate the result string
743 \param s the string that is to be folded
744 \return a copy of the string, converted to upper case
746 \note The default function is not yet UTF8 aware. Provide your own
747 set of functions through ldb_set_utf8_fns()
749 char *ldb_casefold(struct ldb_context *ldb, void *mem_ctx, const char *s);
752 Compare two strings, without regard to case.
754 \param ldb the ldb context
755 \param s1 the first string to compare
756 \param s2 the second string to compare
758 \return 0 if the strings are the same, non-zero if there are any
759 differences except for case.
761 \note The default function is not yet UTF8 aware. Provide your own
762 set of functions through ldb_set_utf8_fns()
764 int ldb_caseless_cmp(struct ldb_context *ldb, const char *s1, const char *s2);
767 Check the attribute name is valid according to rfc2251
768 \param s tthe string to check
770 \return 1 if the name is ok
772 int ldb_valid_attr_name(const char *s);
775 ldif manipulation functions
778 Write an LDIF message
780 This function writes an LDIF message using a caller supplied write
783 \param ldb the ldb context (from ldb_init())
784 \param fprintf_fn a function pointer for the write function. This must take
785 a private data pointer, followed by a format string, and then a variable argument
787 \param private_data pointer that will be provided back to the write
788 function. This is useful for maintaining state or context.
789 \param ldif the message to write out
791 \return the total number of bytes written, or an error code as returned
792 from the write function.
794 \sa ldb_ldif_write_file for a more convenient way to write to a
797 \sa ldb_ldif_read for the reader equivalent to this function.
799 int ldb_ldif_write(struct ldb_context *ldb,
800 int (*fprintf_fn)(void *, const char *, ...),
802 const struct ldb_ldif *ldif);
805 Clean up an LDIF message
807 This function cleans up a LDIF message read using ldb_ldif_read()
808 or related functions (such as ldb_ldif_read_string() and
809 ldb_ldif_read_file().
811 \param ldb the ldb context (from ldb_init())
812 \param msg the message to clean up and free
815 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
820 This function creates an LDIF message using a caller supplied read
823 \param ldb the ldb context (from ldb_init())
824 \param fgetc_fn a function pointer for the read function. This must
825 take a private data pointer, and must return a pointer to an
826 integer corresponding to the next byte read (or EOF if there is no
827 more data to be read).
828 \param private_data pointer that will be provided back to the read
829 function. This is udeful for maintaining state or context.
831 \return the LDIF message that has been read in
833 \note You must free the LDIF message when no longer required, using
834 ldb_ldif_read_free().
836 \sa ldb_ldif_read_file for a more convenient way to read from a
839 \sa ldb_ldif_read_string for a more convenient way to read from a
842 \sa ldb_ldif_write for the writer equivalent to this function.
844 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
845 int (*fgetc_fn)(void *), void *private_data);
848 Read an LDIF message from a file
850 This function reads the next LDIF message from the contents of a
851 file stream. If you want to get all of the LDIF messages, you will
852 need to repeatedly call this function, until it returns NULL.
854 \param ldb the ldb context (from ldb_init())
855 \param f the file stream to read from (typically from fdopen())
857 \sa ldb_ldif_read_string for an equivalent function that will read
858 from a string (char array).
860 \sa ldb_ldif_write_file for the writer equivalent to this function.
863 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
866 Read an LDIF message from a string
868 This function reads the next LDIF message from the contents of a char
869 array. If you want to get all of the LDIF messages, you will need
870 to repeatedly call this function, until it returns NULL.
872 \param ldb the ldb context (from ldb_init())
873 \param s pointer to the char array to read from
875 \sa ldb_ldif_read_file for an equivalent function that will read
878 \sa ldb_ldif_write for a more general (arbitrary read function)
879 version of this function.
881 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
884 Write an LDIF message to a file
886 \param ldb the ldb context (from ldb_init())
887 \param f the file stream to write to (typically from fdopen())
888 \param msg the message to write out
890 \return the total number of bytes written, or a negative error code
892 \sa ldb_ldif_read_file for the reader equivalent to this function.
894 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
897 Base64 encode a buffer
899 \param mem_ctx the memory context that the result is allocated
901 \param buf pointer to the array that is to be encoded
902 \param len the number of elements in the array to be encoded
904 \return pointer to an array containing the encoded data
906 \note The caller is responsible for freeing the result
908 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
911 Base64 decode a buffer
913 This function decodes a base64 encoded string in place.
915 \param s the string to decode.
917 \return the length of the returned (decoded) string.
919 \note the string is null terminated, but the null terminator is not
920 included in the length.
922 int ldb_base64_decode(char *s);
924 int ldb_attrib_add_handlers(struct ldb_context *ldb,
925 const struct ldb_attrib_handler *handlers,
926 unsigned num_handlers);
928 /* The following definitions come from lib/ldb/common/ldb_dn.c */
930 int ldb_dn_is_special(const struct ldb_dn *dn);
931 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check);
932 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
933 struct ldb_dn *ldb_dn_new(void *mem_ctx);
934 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);
935 struct ldb_dn *ldb_dn_explode_or_special(void *mem_ctx, const char *dn);
936 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn);
937 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
938 int ldb_dn_compare_base(struct ldb_context *ldb, const struct ldb_dn *base, const struct ldb_dn *dn);
939 int ldb_dn_compare(struct ldb_context *ldb, const struct ldb_dn *edn0, const struct ldb_dn *edn1);
940 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
941 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, const char *dn);
942 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el);
943 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn);
944 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn);
945 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
947 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
949 const struct ldb_dn *base);
950 struct ldb_dn *ldb_dn_make_child(void *mem_ctx,
951 const struct ldb_dn_component *component,
952 const struct ldb_dn *base);
953 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2);
954 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...) PRINTF_ATTRIBUTE(3,4);
955 struct ldb_dn_component *ldb_dn_get_rdn(void *mem_ctx, const struct ldb_dn *dn);
957 /* useful functions for ldb_message structure manipulation */
958 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
961 Compare two attributes
963 This function compares to attribute names. Note that this is a
964 case-insensitive comparison.
966 \param attr1 the first attribute name to compare
967 \param attr2 the second attribute name to compare
969 \return 0 if the attribute names are the same, or only differ in
970 case; non-zero if there are any differences
972 int ldb_attr_cmp(const char *attr1, const char *attr2);
973 int ldb_attr_dn(const char *attr);
974 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
977 Create an empty message
979 \param mem_ctx the memory context to create in. You can pass NULL
980 to get the top level context, however the ldb context (from
981 ldb_init()) may be a better choice
983 struct ldb_message *ldb_msg_new(void *mem_ctx);
986 Find an element within an message
988 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
989 const char *attr_name);
992 Compare two ldb_val values
994 \param v1 first ldb_val structure to be tested
995 \param v2 second ldb_val structure to be tested
997 \return 1 for a match, 0 if there is any difference
999 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1002 find a value within an ldb_message_element
1004 \param el the element to search
1005 \param val the value to search for
1007 \note This search is case sensitive
1009 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1010 struct ldb_val *val);
1013 add a new empty element to a ldb_message
1015 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags);
1018 add a element to a ldb_message
1020 int ldb_msg_add(struct ldb_message *msg,
1021 const struct ldb_message_element *el,
1023 int ldb_msg_add_value(struct ldb_message *msg,
1024 const char *attr_name,
1025 const struct ldb_val *val);
1026 int ldb_msg_add_string(struct ldb_message *msg,
1027 const char *attr_name, const char *str);
1028 int ldb_msg_add_fmt(struct ldb_message *msg,
1029 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1032 compare two message elements - return 0 on match
1034 int ldb_msg_element_compare(struct ldb_message_element *el1,
1035 struct ldb_message_element *el2);
1038 Find elements in a message.
1040 This function finds elements and converts to a specific type, with
1041 a give default value if not found. Assumes that elements are
1044 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1045 int ldb_msg_find_int(const struct ldb_message *msg,
1046 const char *attr_name,
1048 unsigned int ldb_msg_find_uint(const struct ldb_message *msg,
1049 const char *attr_name,
1050 unsigned int default_value);
1051 int64_t ldb_msg_find_int64(const struct ldb_message *msg,
1052 const char *attr_name,
1053 int64_t default_value);
1054 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg,
1055 const char *attr_name,
1056 uint64_t default_value);
1057 double ldb_msg_find_double(const struct ldb_message *msg,
1058 const char *attr_name,
1059 double default_value);
1060 const char *ldb_msg_find_string(const struct ldb_message *msg,
1061 const char *attr_name,
1062 const char *default_value);
1064 void ldb_msg_sort_elements(struct ldb_message *msg);
1066 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
1067 const struct ldb_message *msg);
1068 struct ldb_message *ldb_msg_copy(void *mem_ctx,
1069 const struct ldb_message *msg);
1071 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1072 const struct ldb_message *msg);
1075 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1076 struct ldb_message *msg1,
1077 struct ldb_message *msg2);
1080 Integrity check an ldb_message
1082 This function performs basic sanity / integrity checks on an
1085 \param msg the message to check
1087 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1088 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1089 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1092 int ldb_msg_sanity_check(const struct ldb_message *msg);
1095 Duplicate an ldb_val structure
1097 This function copies an ldb value structure.
1099 \param mem_ctx the memory context that the duplicated value will be
1101 \param v the ldb_val to be duplicated.
1103 \return the duplicated ldb_val structure.
1105 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
1108 this allows the user to set a debug function for error reporting
1110 int ldb_set_debug(struct ldb_context *ldb,
1111 void (*debug)(void *context, enum ldb_debug_level level,
1112 const char *fmt, va_list ap),
1116 this allows the user to set custom utf8 function for error reporting
1118 void ldb_set_utf8_fns(struct ldb_context *ldb,
1120 int (*cmp)(void *, const char *, const char *),
1121 char *(*casefold)(void *, void *, const char *));
1124 this sets up debug to print messages on stderr
1126 int ldb_set_debug_stderr(struct ldb_context *ldb);
1128 /* control backend specific opaque values */
1129 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1130 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1132 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
1133 const char *attrib);
1136 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
1137 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1140 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1142 const char *replace);
1144 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1145 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1146 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1149 Convert a time structure to a string
1151 This function converts a time_t structure to an LDAP formatted time
1154 \param mem_ctx the memory context to allocate the return string in
1155 \param t the time structure to convert
1157 \return the formatted string, or NULL if the time structure could
1160 char *ldb_timestring(void *mem_ctx, time_t t);
1163 Convert a string to a time structure
1165 This function converts an LDAP formatted time string to a time_t
1168 \param s the string to convert
1170 \return the time structure, or 0 if the string cannot be converted
1172 time_t ldb_string_to_time(const char *s);
1174 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn);
1175 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn);
1178 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);