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 Flag value for database connection mode.
214 If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
215 opened read-only, if possible.
217 #define LDB_FLG_RDONLY 1
220 Flag value for database connection mode.
222 If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
223 opened without synchronous operations, if possible.
225 #define LDB_FLG_NOSYNC 2
227 /*! \cond DOXYGEN_IGNORE */
228 #ifndef PRINTF_ATTRIBUTE
229 #define PRINTF_ATTRIBUTE(a,b)
234 structures for ldb_parse_tree handling code
236 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
237 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
238 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
239 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
241 struct ldb_parse_tree {
242 enum ldb_parse_op operation;
245 struct ldb_parse_tree *child;
249 struct ldb_val value;
253 int start_with_wildcard;
254 int end_with_wildcard;
255 struct ldb_val **chunks;
262 struct ldb_val value;
268 struct ldb_val value;
271 unsigned int num_elements;
272 struct ldb_parse_tree **elements;
277 struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
278 char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
279 char *ldb_binary_encode(void *ctx, struct ldb_val val);
280 char *ldb_binary_encode_string(void *mem_ctx, const char *string);
283 functions for controlling attribute handling
285 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
286 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
288 struct ldb_attrib_handler {
291 /* LDB_ATTR_FLAG_* */
294 /* convert from ldif to binary format */
295 ldb_attr_handler_t ldif_read_fn;
297 /* convert from binary to ldif format */
298 ldb_attr_handler_t ldif_write_fn;
300 /* canonicalise a value, for use by indexing and dn construction */
301 ldb_attr_handler_t canonicalise_fn;
303 /* compare two values */
304 ldb_attr_comparison_t comparison_fn;
308 The attribute is not returned by default
310 #define LDB_ATTR_FLAG_HIDDEN (1<<0)
313 The attribute is constructed from other attributes
315 #define LDB_ATTR_FLAG_CONSTRUCTED (1<<1)
318 LDAP attribute syntax for a DN
320 This is the well-known LDAP attribute syntax for a DN.
322 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
324 #define LDB_SYNTAX_DN "1.3.6.1.4.1.1466.115.121.1.12"
327 LDAP attribute syntax for a Directory String
329 This is the well-known LDAP attribute syntax for a Directory String.
331 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
333 #define LDB_SYNTAX_DIRECTORY_STRING "1.3.6.1.4.1.1466.115.121.1.15"
336 LDAP attribute syntax for an integer
338 This is the well-known LDAP attribute syntax for an integer.
340 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
342 #define LDB_SYNTAX_INTEGER "1.3.6.1.4.1.1466.115.121.1.27"
345 LDAP attribute syntax for an octet string
347 This is the well-known LDAP attribute syntax for an octet string.
349 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
351 #define LDB_SYNTAX_OCTET_STRING "1.3.6.1.4.1.1466.115.121.1.40"
354 LDAP attribute syntax for UTC time.
356 This is the well-known LDAP attribute syntax for a UTC time.
358 See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
360 #define LDB_SYNTAX_UTC_TIME "1.3.6.1.4.1.1466.115.121.1.53"
362 #define LDB_SYNTAX_OBJECTCLASS "LDB_SYNTAX_OBJECTCLASS"
364 /* sorting helpers */
365 typedef int (*ldb_qsort_cmp_fn_t) (const void *, const void *, const void *);
368 OID for the paged results control. This control is included in the
369 searchRequest and searchResultDone messages as part of the controls
370 field of the LDAPMessage, as defined in Section 4.1.12 of
373 \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
375 #define LDB_CONTROL_PAGED_RESULTS_OID "1.2.840.113556.1.4.319"
380 \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>
382 #define LDB_CONTROL_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
385 OID for LDAP server sort result extension.
387 This control is included in the searchRequest message as part of
388 the controls field of the LDAPMessage, as defined in Section 4.1.12
389 of LDAP v3. The controlType is set to
390 "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
391 FALSE (where absent is also equivalent to FALSE) at the client's
394 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
396 #define LDB_CONTROL_SERVER_SORT_OID "1.2.840.113556.1.4.473"
399 OID for LDAP server sort result response extension.
401 This control is included in the searchResultDone message as part of
402 the controls field of the LDAPMessage, as defined in Section 4.1.12 of
405 \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
407 #define LDB_CONTROL_SORT_RESP_OID "1.2.840.113556.1.4.474"
410 OID for LDAP Attribute Scoped Query extension.
412 This control is include in SearchRequest or SearchResponse
413 messages as part of the controls field of the LDAPMessage.
415 #define LDB_CONTROL_ASQ_OID "1.2.840.113556.1.4.1504"
418 OID for LDAPrectory Sync extension.
420 This control is include in SearchRequest or SearchResponse
421 messages as part of the controls field of the LDAPMessage.
423 #define LDB_CONTROL_DIRSYNC_OID "1.2.840.113556.1.4.841"
426 struct ldb_paged_control {
432 struct ldb_extended_dn_control {
436 struct ldb_server_sort_control {
442 struct ldb_sort_resp_control {
447 struct ldb_asq_control {
449 char *source_attribute;
454 struct ldb_dirsync_control {
467 struct ldb_credentials;
469 enum ldb_request_type {
480 struct ldb_message **msgs;
481 struct ldb_control **controls;
485 const struct ldb_dn *base;
486 enum ldb_scope scope;
487 struct ldb_parse_tree *tree;
488 const char * const *attrs;
489 struct ldb_result *res;
493 const struct ldb_message *message;
497 const struct ldb_message *message;
501 const struct ldb_dn *dn;
505 const struct ldb_dn *olddn;
506 const struct ldb_dn *newdn;
509 struct ldb_register_control {
518 struct ldb_search search;
520 struct ldb_modify mod;
521 struct ldb_delete del;
522 struct ldb_rename rename;
523 struct ldb_register_control reg;
526 struct ldb_control **controls;
527 struct ldb_credentials *creds;
530 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
533 Initialise an ldb context
535 This is required before any other LDB call.
537 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
538 no suitable context available.
540 \return pointer to ldb_context that should be free'd (using talloc_free())
541 at the end of the program.
543 struct ldb_context *ldb_init(void *mem_ctx);
546 Connect to a database.
548 This is typically called soon after ldb_init(), and is required prior to
549 any search or database modification operations.
551 The URL can be one of the following forms:
557 \param ldb the context associated with the database (from ldb_init())
558 \param url the URL of the database to connect to, as noted above
559 \param flags a combination of LDB_FLG_* to modify the connection behaviour
560 \param options backend specific options - passed uninterpreted to the backend
562 \return result code (LDB_SUCCESS on success, or a failure code)
564 \note It is an error to connect to a database that does not exist in readonly mode
565 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
566 created if it does not exist.
568 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
573 This function searches the database, and returns
574 records that match an LDAP-like search expression
576 \param ldb the context associated with the database (from ldb_init())
577 \param base the Base Distinguished Name for the query (pass NULL for root DN)
578 \param scope the search scope for the query
579 \param expression the search expression to use for this query
580 \param attrs the search attributes for the query (pass NULL if none required)
581 \param res the return result
583 \return result code (LDB_SUCCESS on success, or a failure code)
585 \note use talloc_free() to free the ldb_result returned
587 int ldb_search(struct ldb_context *ldb,
588 const struct ldb_dn *base,
589 enum ldb_scope scope,
590 const char *expression,
591 const char * const *attrs, struct ldb_result **res);
594 like ldb_search() but takes a parse tree
596 int ldb_search_bytree(struct ldb_context *ldb,
597 const struct ldb_dn *base,
598 enum ldb_scope scope,
599 struct ldb_parse_tree *tree,
600 const char * const *attrs, struct ldb_result **res);
603 Add a record to the database.
605 This function adds a record to the database. This function will fail
606 if a record with the specified class and key already exists in the
609 \param ldb the context associated with the database (from
611 \param message the message containing the record to add.
613 \return result code (LDB_SUCCESS if the record was added, otherwise
616 int ldb_add(struct ldb_context *ldb,
617 const struct ldb_message *message);
620 Modify the specified attributes of a record
622 This function modifies a record that is in the database.
624 \param ldb the context associated with the database (from
626 \param message the message containing the changes required.
628 \return result code (LDB_SUCCESS if the record was modified as
629 requested, otherwise a failure code)
631 int ldb_modify(struct ldb_context *ldb,
632 const struct ldb_message *message);
635 Rename a record in the database
637 This function renames a record in the database.
639 \param ldb the context associated with the database (from
641 \param olddn the DN for the record to be renamed.
642 \param newdn the new DN
644 \return result code (LDB_SUCCESS if the record was renamed as
645 requested, otherwise a failure code)
647 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);
650 Delete a record from the database
652 This function deletes a record from the database.
654 \param ldb the context associated with the database (from
656 \param dn the DN for the record to be deleted.
658 \return result code (LDB_SUCCESS if the record was deleted,
659 otherwise a failure code)
661 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);
666 int ldb_transaction_start(struct ldb_context *ldb);
671 int ldb_transaction_commit(struct ldb_context *ldb);
676 int ldb_transaction_cancel(struct ldb_context *ldb);
680 return extended error information from the last call
682 const char *ldb_errstring(struct ldb_context *ldb);
687 \param mem_ctx the memory context to allocate the result string
689 \param s the string that is to be folded
690 \return a copy of the string, converted to upper case
692 \todo This function should be UTF8 aware, but currently is not.
694 char *ldb_casefold(void *mem_ctx, const char *s);
697 Compare two strings, without regard to case.
699 \param s1 the first string to compare
700 \param s2 the second string to compare
702 \return 0 if the strings are the same, non-zero if there are any
703 differences except for case.
705 \note This function is not UTF8 aware.
707 int ldb_caseless_cmp(const char *s1, const char *s2);
710 ldif manipulation functions
713 Write an LDIF message
715 This function writes an LDIF message using a caller supplied write
718 \param ldb the ldb context (from ldb_init())
719 \param fprintf_fn a function pointer for the write function. This must take
720 a private data pointer, followed by a format string, and then a variable argument
722 \param private_data pointer that will be provided back to the write
723 function. This is useful for maintaining state or context.
724 \param ldif the message to write out
726 \return the total number of bytes written, or an error code as returned
727 from the write function.
729 \sa ldb_ldif_write_file for a more convenient way to write to a
732 \sa ldb_ldif_read for the reader equivalent to this function.
734 int ldb_ldif_write(struct ldb_context *ldb,
735 int (*fprintf_fn)(void *, const char *, ...),
737 const struct ldb_ldif *ldif);
740 Clean up an LDIF message
742 This function cleans up a LDIF message read using ldb_ldif_read()
743 or related functions (such as ldb_ldif_read_string() and
744 ldb_ldif_read_file().
746 \param ldb the ldb context (from ldb_init())
747 \param msg the message to clean up and free
750 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
755 This function creates an LDIF message using a caller supplied read
758 \param ldb the ldb context (from ldb_init())
759 \param fgetc_fn a function pointer for the read function. This must
760 take a private data pointer, and must return a pointer to an
761 integer corresponding to the next byte read (or EOF if there is no
762 more data to be read).
763 \param private_data pointer that will be provided back to the read
764 function. This is udeful for maintaining state or context.
766 \return the LDIF message that has been read in
768 \note You must free the LDIF message when no longer required, using
769 ldb_ldif_read_free().
771 \sa ldb_ldif_read_file for a more convenient way to read from a
774 \sa ldb_ldif_read_string for a more convenient way to read from a
777 \sa ldb_ldif_write for the writer equivalent to this function.
779 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
780 int (*fgetc_fn)(void *), void *private_data);
783 Read an LDIF message from a file
785 This function reads the next LDIF message from the contents of a
786 file stream. If you want to get all of the LDIF messages, you will
787 need to repeatedly call this function, until it returns NULL.
789 \param ldb the ldb context (from ldb_init())
790 \param f the file stream to read from (typically from fdopen())
792 \sa ldb_ldif_read_string for an equivalent function that will read
793 from a string (char array).
795 \sa ldb_ldif_write_file for the writer equivalent to this function.
798 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
801 Read an LDIF message from a string
803 This function reads the next LDIF message from the contents of a char
804 array. If you want to get all of the LDIF messages, you will need
805 to repeatedly call this function, until it returns NULL.
807 \param ldb the ldb context (from ldb_init())
808 \param s pointer to the char array to read from
810 \sa ldb_ldif_read_file for an equivalent function that will read
813 \sa ldb_ldif_write for a more general (arbitrary read function)
814 version of this function.
816 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
819 Write an LDIF message to a file
821 \param ldb the ldb context (from ldb_init())
822 \param f the file stream to write to (typically from fdopen())
823 \param msg the message to write out
825 \return the total number of bytes written, or a negative error code
827 \sa ldb_ldif_read_file for the reader equivalent to this function.
829 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
832 Base64 encode a buffer
834 \param mem_ctx the memory context that the result is allocated
836 \param buf pointer to the array that is to be encoded
837 \param len the number of elements in the array to be encoded
839 \return pointer to an array containing the encoded data
841 \note The caller is responsible for freeing the result
843 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
846 Base64 decode a buffer
848 This function decodes a base64 encoded string in place.
850 \param s the string to decode.
852 \return the length of the returned (decoded) string.
854 \note the string is null terminated, but the null terminator is not
855 included in the length.
857 int ldb_base64_decode(char *s);
859 int ldb_attrib_add_handlers(struct ldb_context *ldb,
860 const struct ldb_attrib_handler *handlers,
861 unsigned num_handlers);
863 /* The following definitions come from lib/ldb/common/ldb_dn.c */
865 int ldb_dn_is_special(const struct ldb_dn *dn);
866 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check);
867 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
868 struct ldb_dn *ldb_dn_new(void *mem_ctx);
869 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);
870 struct ldb_dn *ldb_dn_explode_or_special(void *mem_ctx, const char *dn);
871 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn);
872 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
873 int ldb_dn_compare_base(struct ldb_context *ldb, const struct ldb_dn *base, const struct ldb_dn *dn);
874 int ldb_dn_compare(struct ldb_context *ldb, const struct ldb_dn *edn0, const struct ldb_dn *edn1);
875 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
876 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, const char *dn);
877 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el);
878 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn);
879 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn);
880 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
882 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
884 const struct ldb_dn *base);
885 struct ldb_dn *ldb_dn_make_child(void *mem_ctx,
886 const struct ldb_dn_component *component,
887 const struct ldb_dn *base);
888 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2);
889 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...) PRINTF_ATTRIBUTE(3,4);
890 struct ldb_dn_component *ldb_dn_get_rdn(void *mem_ctx, const struct ldb_dn *dn);
892 /* useful functions for ldb_message structure manipulation */
893 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
896 Compare two attributes
898 This function compares to attribute names. Note that this is a
899 case-insensitive comparison.
901 \param attr1 the first attribute name to compare
902 \param attr2 the second attribute name to compare
904 \return 0 if the attribute names are the same, or only differ in
905 case; non-zero if there are any differences
907 int ldb_attr_cmp(const char *attr1, const char *attr2);
908 int ldb_attr_dn(const char *attr);
909 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
912 Create an empty message
914 \param mem_ctx the memory context to create in. You can pass NULL
915 to get the top level context, however the ldb context (from
916 ldb_init()) may be a better choice
918 struct ldb_message *ldb_msg_new(void *mem_ctx);
921 Find an element within an message
923 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
924 const char *attr_name);
927 Compare two ldb_val values
929 \param v1 first ldb_val structure to be tested
930 \param v2 second ldb_val structure to be tested
932 \return 1 for a match, 0 if there is any difference
934 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
937 find a value within an ldb_message_element
939 \param el the element to search
940 \param val the value to search for
942 \note This search is case sensitive
944 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
945 struct ldb_val *val);
948 add a new empty element to a ldb_message
950 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags);
953 add a element to a ldb_message
955 int ldb_msg_add(struct ldb_message *msg,
956 const struct ldb_message_element *el,
958 int ldb_msg_add_value(struct ldb_message *msg,
959 const char *attr_name,
960 const struct ldb_val *val);
961 int ldb_msg_add_string(struct ldb_message *msg,
962 const char *attr_name, const char *str);
963 int ldb_msg_add_fmt(struct ldb_message *msg,
964 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
967 compare two message elements - return 0 on match
969 int ldb_msg_element_compare(struct ldb_message_element *el1,
970 struct ldb_message_element *el2);
973 Find elements in a message.
975 This function finds elements and converts to a specific type, with
976 a give default value if not found. Assumes that elements are
979 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
980 int ldb_msg_find_int(const struct ldb_message *msg,
981 const char *attr_name,
983 unsigned int ldb_msg_find_uint(const struct ldb_message *msg,
984 const char *attr_name,
985 unsigned int default_value);
986 int64_t ldb_msg_find_int64(const struct ldb_message *msg,
987 const char *attr_name,
988 int64_t default_value);
989 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg,
990 const char *attr_name,
991 uint64_t default_value);
992 double ldb_msg_find_double(const struct ldb_message *msg,
993 const char *attr_name,
994 double default_value);
995 const char *ldb_msg_find_string(const struct ldb_message *msg,
996 const char *attr_name,
997 const char *default_value);
999 void ldb_msg_sort_elements(struct ldb_message *msg);
1001 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
1002 const struct ldb_message *msg);
1003 struct ldb_message *ldb_msg_copy(void *mem_ctx,
1004 const struct ldb_message *msg);
1006 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1007 const struct ldb_message *msg);
1010 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1011 struct ldb_message *msg1,
1012 struct ldb_message *msg2);
1015 Integrity check an ldb_message
1017 This function performs basic sanity / integrity checks on an
1020 \param msg the message to check
1022 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1023 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1024 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1027 int ldb_msg_sanity_check(const struct ldb_message *msg);
1030 Duplicate an ldb_val structure
1032 This function copies an ldb value structure.
1034 \param mem_ctx the memory context that the duplicated value will be
1036 \param v the ldb_val to be duplicated.
1038 \return the duplicated ldb_val structure.
1040 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
1043 this allows the user to set a debug function for error reporting
1045 int ldb_set_debug(struct ldb_context *ldb,
1046 void (*debug)(void *context, enum ldb_debug_level level,
1047 const char *fmt, va_list ap),
1051 this sets up debug to print messages on stderr
1053 int ldb_set_debug_stderr(struct ldb_context *ldb);
1055 /* control backend specific opaque values */
1056 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1057 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1059 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
1060 const char *attrib);
1063 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
1064 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1067 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1069 const char *replace);
1071 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1072 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1073 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1076 Convert a time structure to a string
1078 This function converts a time_t structure to an LDAP formatted time
1081 \param mem_ctx the memory context to allocate the return string in
1082 \param t the time structure to convert
1084 \return the formatted string, or NULL if the time structure could
1087 char *ldb_timestring(void *mem_ctx, time_t t);
1090 Convert a string to a time structure
1092 This function converts an LDAP formatted time string to a time_t
1095 \param s the string to convert
1097 \return the time structure, or 0 if the string cannot be converted
1099 time_t ldb_string_to_time(const char *s);
1101 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn);
1102 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn);
1105 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);