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
237 Flag value to specify autoreconnect mode.
239 If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
240 be opened in a way that makes it try to auto reconnect if the
241 connection is dropped (actually make sense only with ldap).
243 #define LDB_FLG_RECONNECT 4
245 /*! \cond DOXYGEN_IGNORE */
246 #ifndef PRINTF_ATTRIBUTE
247 #define PRINTF_ATTRIBUTE(a,b)
252 structures for ldb_parse_tree handling code
254 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
255 LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
256 LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
257 LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
259 struct ldb_parse_tree {
260 enum ldb_parse_op operation;
263 struct ldb_parse_tree *child;
267 struct ldb_val value;
271 int start_with_wildcard;
272 int end_with_wildcard;
273 struct ldb_val **chunks;
280 struct ldb_val value;
286 struct ldb_val value;
289 unsigned int num_elements;
290 struct ldb_parse_tree **elements;
295 struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
296 char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
301 This function encodes a binary blob using the encoding rules in RFC
302 2254 (Section 4). This function also escapes any non-printable
305 \param ctx the memory context to allocate the return string in.
306 \param val the (potentially) binary data to be encoded
308 \return the encoded data as a null terminated string
310 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
312 char *ldb_binary_encode(void *ctx, struct ldb_val val);
317 This function encodes a string using the encoding rules in RFC 2254
318 (Section 4). This function also escapes any non-printable
321 \param mem_ctx the memory context to allocate the return string in.
322 \param string the string to be encoded
324 \return the encoded data as a null terminated string
326 \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
328 char *ldb_binary_encode_string(void *mem_ctx, const char *string);
331 functions for controlling attribute handling
333 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
334 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
336 struct ldb_attrib_handler {
339 /* LDB_ATTR_FLAG_* */
342 /* convert from ldif to binary format */
343 ldb_attr_handler_t ldif_read_fn;
345 /* convert from binary to ldif format */
346 ldb_attr_handler_t ldif_write_fn;
348 /* canonicalise a value, for use by indexing and dn construction */
349 ldb_attr_handler_t canonicalise_fn;
351 /* compare two values */
352 ldb_attr_comparison_t comparison_fn;
356 The attribute is not returned by default
358 #define LDB_ATTR_FLAG_HIDDEN (1<<0)
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"
542 OID for LDAP Extended Operation START_TLS.
544 This Extended operation is used to start a new TLS
545 channel on top of a clear text channel.
547 #define LDB_EXTENDED_DYNAMIC_OID "1.3.6.1.4.1.1466.101.119.1"
550 OID for LDAP Extended Operation START_TLS.
552 This Extended operation is used to start a new TLS
553 channel on top of a clear text channel.
555 #define LDB_EXTENDED_FAST_BIND_OID "1.2.840.113556.1.4.1781"
557 struct ldb_sd_flags_control {
559 * request the owner 0x00000001
560 * request the group 0x00000002
561 * request the DACL 0x00000004
562 * request the SACL 0x00000008
564 unsigned secinfo_flags;
567 struct ldb_search_options_control {
569 * DOMAIN_SCOPE 0x00000001
570 * this limits the search to one partition,
571 * and no referrals will be returned.
572 * (Note this doesn't limit the entries by there
573 * objectSid belonging to a domain! Builtin and Foreign Sids
574 * are still returned)
576 * PHANTOM_ROOT 0x00000002
577 * this search on the whole tree on a domain controller
578 * over multiple partitions without referrals.
579 * (This is the default behavior on the Global Catalog Port)
581 unsigned search_options;
584 struct ldb_paged_control {
590 struct ldb_extended_dn_control {
594 struct ldb_server_sort_control {
600 struct ldb_sort_resp_control {
605 struct ldb_asq_control {
607 char *source_attribute;
612 struct ldb_dirsync_control {
619 struct ldb_vlv_req_control {
637 struct ldb_vlv_resp_control {
651 enum ldb_request_type {
658 LDB_REQ_REGISTER_CONTROL,
659 LDB_REQ_REGISTER_PARTITION,
663 enum ldb_reply_type {
683 struct ldb_message **msgs;
685 struct ldb_control **controls;
688 struct ldb_extended {
695 enum ldb_reply_type type;
696 struct ldb_message *message;
697 struct ldb_extended *response;
699 struct ldb_control **controls;
704 enum ldb_state state;
706 struct ldb_module *module;
710 const struct ldb_dn *base;
711 enum ldb_scope scope;
712 const struct ldb_parse_tree *tree;
713 const char * const *attrs;
714 struct ldb_result *res;
718 const struct ldb_message *message;
722 const struct ldb_message *message;
726 const struct ldb_dn *dn;
730 const struct ldb_dn *olddn;
731 const struct ldb_dn *newdn;
734 struct ldb_register_control {
738 struct ldb_register_partition {
739 const struct ldb_dn *dn;
742 struct ldb_sequence_number {
748 enum ldb_request_type operation;
751 struct ldb_search search;
753 struct ldb_modify mod;
754 struct ldb_delete del;
755 struct ldb_rename rename;
756 struct ldb_register_control reg_control;
757 struct ldb_register_partition reg_partition;
758 struct ldb_sequence_number seq_num;
761 struct ldb_control **controls;
764 int (*callback)(struct ldb_context *, void *, struct ldb_reply *);
768 struct ldb_handle *handle;
771 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
773 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
775 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
776 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
779 Initialise ldbs' global information
781 This is required before any other LDB call
783 \return 0 if initialisation succeeded, -1 otherwise
785 int ldb_global_init(void);
788 Initialise an ldb context
790 This is required before any other LDB call.
792 \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
793 no suitable context available.
795 \return pointer to ldb_context that should be free'd (using talloc_free())
796 at the end of the program.
798 struct ldb_context *ldb_init(void *mem_ctx);
801 Connect to a database.
803 This is typically called soon after ldb_init(), and is required prior to
804 any search or database modification operations.
806 The URL can be one of the following forms:
812 \param ldb the context associated with the database (from ldb_init())
813 \param url the URL of the database to connect to, as noted above
814 \param flags a combination of LDB_FLG_* to modify the connection behaviour
815 \param options backend specific options - passed uninterpreted to the backend
817 \return result code (LDB_SUCCESS on success, or a failure code)
819 \note It is an error to connect to a database that does not exist in readonly mode
820 (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
821 created if it does not exist.
823 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
828 This function searches the database, and returns
829 records that match an LDAP-like search expression
831 \param ldb the context associated with the database (from ldb_init())
832 \param base the Base Distinguished Name for the query (pass NULL for root DN)
833 \param scope the search scope for the query
834 \param expression the search expression to use for this query
835 \param attrs the search attributes for the query (pass NULL if none required)
836 \param res the return result
838 \return result code (LDB_SUCCESS on success, or a failure code)
840 \note use talloc_free() to free the ldb_result returned
842 int ldb_search(struct ldb_context *ldb,
843 const struct ldb_dn *base,
844 enum ldb_scope scope,
845 const char *expression,
846 const char * const *attrs, struct ldb_result **res);
849 like ldb_search() but takes a parse tree
851 int ldb_search_bytree(struct ldb_context *ldb,
852 const struct ldb_dn *base,
853 enum ldb_scope scope,
854 struct ldb_parse_tree *tree,
855 const char * const *attrs, struct ldb_result **res);
858 Add a record to the database.
860 This function adds a record to the database. This function will fail
861 if a record with the specified class and key already exists in the
864 \param ldb the context associated with the database (from
866 \param message the message containing the record to add.
868 \return result code (LDB_SUCCESS if the record was added, otherwise
871 int ldb_add(struct ldb_context *ldb,
872 const struct ldb_message *message);
875 Modify the specified attributes of a record
877 This function modifies a record that is in the database.
879 \param ldb the context associated with the database (from
881 \param message the message containing the changes required.
883 \return result code (LDB_SUCCESS if the record was modified as
884 requested, otherwise a failure code)
886 int ldb_modify(struct ldb_context *ldb,
887 const struct ldb_message *message);
890 Rename a record in the database
892 This function renames a record in the database.
894 \param ldb the context associated with the database (from
896 \param olddn the DN for the record to be renamed.
897 \param newdn the new DN
899 \return result code (LDB_SUCCESS if the record was renamed as
900 requested, otherwise a failure code)
902 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);
905 Delete a record from the database
907 This function deletes a record from the database.
909 \param ldb the context associated with the database (from
911 \param dn the DN for the record to be deleted.
913 \return result code (LDB_SUCCESS if the record was deleted,
914 otherwise a failure code)
916 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);
919 Obtain current database sequence number
921 int ldb_sequence_number(struct ldb_context *ldb, uint64_t *seq_num);
926 int ldb_transaction_start(struct ldb_context *ldb);
931 int ldb_transaction_commit(struct ldb_context *ldb);
936 int ldb_transaction_cancel(struct ldb_context *ldb);
940 return extended error information from the last call
942 const char *ldb_errstring(struct ldb_context *ldb);
945 return a string explaining what a ldb error constant meancs
947 const char *ldb_strerror(int ldb_err);
950 setup the default utf8 functions
951 FIXME: these functions do not yet handle utf8
953 void ldb_set_utf8_default(struct ldb_context *ldb);
958 \param ldb the ldb context
959 \param mem_ctx the memory context to allocate the result string
961 \param s the string that is to be folded
962 \return a copy of the string, converted to upper case
964 \note The default function is not yet UTF8 aware. Provide your own
965 set of functions through ldb_set_utf8_fns()
967 char *ldb_casefold(struct ldb_context *ldb, void *mem_ctx, const char *s);
970 Check the attribute name is valid according to rfc2251
971 \param s tthe string to check
973 \return 1 if the name is ok
975 int ldb_valid_attr_name(const char *s);
978 ldif manipulation functions
981 Write an LDIF message
983 This function writes an LDIF message using a caller supplied write
986 \param ldb the ldb context (from ldb_init())
987 \param fprintf_fn a function pointer for the write function. This must take
988 a private data pointer, followed by a format string, and then a variable argument
990 \param private_data pointer that will be provided back to the write
991 function. This is useful for maintaining state or context.
992 \param ldif the message to write out
994 \return the total number of bytes written, or an error code as returned
995 from the write function.
997 \sa ldb_ldif_write_file for a more convenient way to write to a
1000 \sa ldb_ldif_read for the reader equivalent to this function.
1002 int ldb_ldif_write(struct ldb_context *ldb,
1003 int (*fprintf_fn)(void *, const char *, ...),
1005 const struct ldb_ldif *ldif);
1008 Clean up an LDIF message
1010 This function cleans up a LDIF message read using ldb_ldif_read()
1011 or related functions (such as ldb_ldif_read_string() and
1012 ldb_ldif_read_file().
1014 \param ldb the ldb context (from ldb_init())
1015 \param msg the message to clean up and free
1018 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1021 Read an LDIF message
1023 This function creates an LDIF message using a caller supplied read
1026 \param ldb the ldb context (from ldb_init())
1027 \param fgetc_fn a function pointer for the read function. This must
1028 take a private data pointer, and must return a pointer to an
1029 integer corresponding to the next byte read (or EOF if there is no
1030 more data to be read).
1031 \param private_data pointer that will be provided back to the read
1032 function. This is udeful for maintaining state or context.
1034 \return the LDIF message that has been read in
1036 \note You must free the LDIF message when no longer required, using
1037 ldb_ldif_read_free().
1039 \sa ldb_ldif_read_file for a more convenient way to read from a
1042 \sa ldb_ldif_read_string for a more convenient way to read from a
1043 string (char array).
1045 \sa ldb_ldif_write for the writer equivalent to this function.
1047 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1048 int (*fgetc_fn)(void *), void *private_data);
1051 Read an LDIF message from a file
1053 This function reads the next LDIF message from the contents of a
1054 file stream. If you want to get all of the LDIF messages, you will
1055 need to repeatedly call this function, until it returns NULL.
1057 \param ldb the ldb context (from ldb_init())
1058 \param f the file stream to read from (typically from fdopen())
1060 \sa ldb_ldif_read_string for an equivalent function that will read
1061 from a string (char array).
1063 \sa ldb_ldif_write_file for the writer equivalent to this function.
1066 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1069 Read an LDIF message from a string
1071 This function reads the next LDIF message from the contents of a char
1072 array. If you want to get all of the LDIF messages, you will need
1073 to repeatedly call this function, until it returns NULL.
1075 \param ldb the ldb context (from ldb_init())
1076 \param s pointer to the char array to read from
1078 \sa ldb_ldif_read_file for an equivalent function that will read
1081 \sa ldb_ldif_write for a more general (arbitrary read function)
1082 version of this function.
1084 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1087 Write an LDIF message to a file
1089 \param ldb the ldb context (from ldb_init())
1090 \param f the file stream to write to (typically from fdopen())
1091 \param msg the message to write out
1093 \return the total number of bytes written, or a negative error code
1095 \sa ldb_ldif_read_file for the reader equivalent to this function.
1097 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1100 Base64 encode a buffer
1102 \param mem_ctx the memory context that the result is allocated
1104 \param buf pointer to the array that is to be encoded
1105 \param len the number of elements in the array to be encoded
1107 \return pointer to an array containing the encoded data
1109 \note The caller is responsible for freeing the result
1111 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
1114 Base64 decode a buffer
1116 This function decodes a base64 encoded string in place.
1118 \param s the string to decode.
1120 \return the length of the returned (decoded) string.
1122 \note the string is null terminated, but the null terminator is not
1123 included in the length.
1125 int ldb_base64_decode(char *s);
1127 int ldb_attrib_add_handlers(struct ldb_context *ldb,
1128 const struct ldb_attrib_handler *handlers,
1129 unsigned num_handlers);
1131 /* The following definitions come from lib/ldb/common/ldb_dn.c */
1133 int ldb_dn_is_special(const struct ldb_dn *dn);
1134 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check);
1135 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
1136 struct ldb_dn *ldb_dn_new(void *mem_ctx);
1137 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);
1138 struct ldb_dn *ldb_dn_explode_or_special(void *mem_ctx, const char *dn);
1139 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn);
1140 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
1141 int ldb_dn_compare_base(struct ldb_context *ldb, const struct ldb_dn *base, const struct ldb_dn *dn);
1142 int ldb_dn_compare(struct ldb_context *ldb, const struct ldb_dn *edn0, const struct ldb_dn *edn1);
1143 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
1144 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, const char *dn);
1145 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el);
1146 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn);
1147 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn);
1148 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
1150 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
1152 const struct ldb_dn *base);
1153 struct ldb_dn *ldb_dn_make_child(void *mem_ctx,
1154 const struct ldb_dn_component *component,
1155 const struct ldb_dn *base);
1156 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2);
1157 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1158 struct ldb_dn_component *ldb_dn_get_rdn(void *mem_ctx, const struct ldb_dn *dn);
1160 /* useful functions for ldb_message structure manipulation */
1161 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
1164 Compare two attributes
1166 This function compares to attribute names. Note that this is a
1167 case-insensitive comparison.
1169 \param attr1 the first attribute name to compare
1170 \param attr2 the second attribute name to compare
1172 \return 0 if the attribute names are the same, or only differ in
1173 case; non-zero if there are any differences
1175 int ldb_attr_cmp(const char *attr1, const char *attr2);
1176 char *ldb_attr_casefold(void *mem_ctx, const char *s);
1177 int ldb_attr_dn(const char *attr);
1180 Create an empty message
1182 \param mem_ctx the memory context to create in. You can pass NULL
1183 to get the top level context, however the ldb context (from
1184 ldb_init()) may be a better choice
1186 struct ldb_message *ldb_msg_new(void *mem_ctx);
1189 Find an element within an message
1191 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1192 const char *attr_name);
1195 Compare two ldb_val values
1197 \param v1 first ldb_val structure to be tested
1198 \param v2 second ldb_val structure to be tested
1200 \return 1 for a match, 0 if there is any difference
1202 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1205 find a value within an ldb_message_element
1207 \param el the element to search
1208 \param val the value to search for
1210 \note This search is case sensitive
1212 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1213 struct ldb_val *val);
1216 add a new empty element to a ldb_message
1218 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags);
1221 add a element to a ldb_message
1223 int ldb_msg_add(struct ldb_message *msg,
1224 const struct ldb_message_element *el,
1226 int ldb_msg_add_value(struct ldb_message *msg,
1227 const char *attr_name,
1228 const struct ldb_val *val);
1229 int ldb_msg_add_steal_value(struct ldb_message *msg,
1230 const char *attr_name,
1231 struct ldb_val *val);
1232 int ldb_msg_add_steal_string(struct ldb_message *msg,
1233 const char *attr_name, char *str);
1234 int ldb_msg_add_string(struct ldb_message *msg,
1235 const char *attr_name, const char *str);
1236 int ldb_msg_add_fmt(struct ldb_message *msg,
1237 const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1240 compare two message elements - return 0 on match
1242 int ldb_msg_element_compare(struct ldb_message_element *el1,
1243 struct ldb_message_element *el2);
1246 Find elements in a message.
1248 This function finds elements and converts to a specific type, with
1249 a give default value if not found. Assumes that elements are
1252 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1253 int ldb_msg_find_int(const struct ldb_message *msg,
1254 const char *attr_name,
1256 unsigned int ldb_msg_find_uint(const struct ldb_message *msg,
1257 const char *attr_name,
1258 unsigned int default_value);
1259 int64_t ldb_msg_find_int64(const struct ldb_message *msg,
1260 const char *attr_name,
1261 int64_t default_value);
1262 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg,
1263 const char *attr_name,
1264 uint64_t default_value);
1265 double ldb_msg_find_double(const struct ldb_message *msg,
1266 const char *attr_name,
1267 double default_value);
1268 const char *ldb_msg_find_string(const struct ldb_message *msg,
1269 const char *attr_name,
1270 const char *default_value);
1272 void ldb_msg_sort_elements(struct ldb_message *msg);
1274 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
1275 const struct ldb_message *msg);
1276 struct ldb_message *ldb_msg_copy(void *mem_ctx,
1277 const struct ldb_message *msg);
1279 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1280 const struct ldb_message *msg);
1283 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1284 struct ldb_message *msg1,
1285 struct ldb_message *msg2);
1287 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1292 Integrity check an ldb_message
1294 This function performs basic sanity / integrity checks on an
1297 \param msg the message to check
1299 \return LDB_SUCCESS if the message is OK, or a non-zero error code
1300 (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1301 LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1304 int ldb_msg_sanity_check(struct ldb_context *ldb,
1305 const struct ldb_message *msg);
1308 Duplicate an ldb_val structure
1310 This function copies an ldb value structure.
1312 \param mem_ctx the memory context that the duplicated value will be
1314 \param v the ldb_val to be duplicated.
1316 \return the duplicated ldb_val structure.
1318 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
1321 this allows the user to set a debug function for error reporting
1323 int ldb_set_debug(struct ldb_context *ldb,
1324 void (*debug)(void *context, enum ldb_debug_level level,
1325 const char *fmt, va_list ap),
1329 this allows the user to set custom utf8 function for error reporting
1331 void ldb_set_utf8_fns(struct ldb_context *ldb,
1333 char *(*casefold)(void *, void *, const char *));
1336 this sets up debug to print messages on stderr
1338 int ldb_set_debug_stderr(struct ldb_context *ldb);
1340 /* control backend specific opaque values */
1341 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1342 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1344 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
1345 const char *attrib);
1348 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
1349 const char **ldb_attr_list_copy_add(void *mem_ctx, const char * const *attrs, const char *new_attr);
1350 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1353 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1355 const char *replace);
1357 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1358 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1359 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1362 Convert a time structure to a string
1364 This function converts a time_t structure to an LDAP formatted time
1367 \param mem_ctx the memory context to allocate the return string in
1368 \param t the time structure to convert
1370 \return the formatted string, or NULL if the time structure could
1373 char *ldb_timestring(void *mem_ctx, time_t t);
1376 Convert a string to a time structure
1378 This function converts an LDAP formatted time string to a time_t
1381 \param s the string to convert
1383 \return the time structure, or 0 if the string cannot be converted
1385 time_t ldb_string_to_time(const char *s);
1387 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn);
1388 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn);
1391 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);