9139e6d2f5abe9ec4c590aed8fb85282cd1d659d
[samba.git] / source / lib / ldb / include / ldb.h
1 /* 
2    ldb database library
3
4    Copyright (C) Andrew Tridgell  2004
5    Copyright (C) Stefan Metzmacher  2004
6    Copyright (C) Simo Sorce  2005
7
8      ** NOTE! The following LGPL license applies to the ldb
9      ** library. This does NOT imply that all of Samba is released
10      ** under the LGPL
11    
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.
16
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.
21
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
25 */
26
27 /*
28  *  Name: ldb
29  *
30  *  Component: ldb header
31  *
32  *  Description: defines for base ldb API
33  *
34  *  Author: Andrew Tridgell
35  *  Author: Stefan Metzmacher
36  */
37
38 /**
39    \file ldb.h Samba's ldb database
40
41    This header file provides the main API for ldb.
42 */
43
44 #ifndef _LDB_H_
45
46 /*! \cond DOXYGEN_IGNORE */
47 #define _LDB_H_ 1
48 /*! \endcond */
49
50 /*
51   major restrictions as compared to normal LDAP:
52
53      - no async calls.
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
57
58   major restrictions as compared to tdb:
59
60      - no explicit locking calls
61      UPDATE: we have transactions now, better than locking --SSS.
62
63 */
64
65 #ifndef ldb_val
66 /**
67    Result value
68
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.
73
74    \note the data is null (0x00) terminated, but the length does not
75    include the terminator. 
76 */
77 struct ldb_val {
78         uint8_t *data; /*!< result data */
79         size_t length; /*!< length of data */
80 };
81 #endif
82
83 /**
84    internal ldb exploded dn structures
85 */
86 struct ldb_dn_component {
87         char *name;  
88         struct ldb_val value;
89 };
90
91 struct ldb_dn {
92         int comp_num;
93         struct ldb_dn_component *components;
94 };
95
96 /**
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.
102 */
103 #define LDB_FLAG_MOD_MASK  0x3
104
105 /**
106    Flag value used in ldap_modify() to indicate that attributes are
107    being added.
108
109    \sa LDB_FLAG_MOD_MASK
110 */
111 #define LDB_FLAG_MOD_ADD     1
112
113 /**
114    Flag value used in ldap_modify() to indicate that attributes are
115    being replaced.
116
117    \sa LDB_FLAG_MOD_MASK
118 */
119 #define LDB_FLAG_MOD_REPLACE 2
120
121 /**
122    Flag value used in ldap_modify() to indicate that attributes are
123    being deleted.
124
125    \sa LDB_FLAG_MOD_MASK
126 */
127 #define LDB_FLAG_MOD_DELETE  3
128
129 /**
130   OID for logic AND comaprison.
131
132   This is the well known object ID for a logical AND comparitor.
133 */
134 #define LDB_OID_COMPARATOR_AND  "1.2.840.113556.1.4.803"
135
136 /**
137   OID for logic OR comparison.
138
139   This is the well known object ID for a logical OR comparitor.
140 */
141 #define LDB_OID_COMPARATOR_OR   "1.2.840.113556.1.4.804"
142
143 /**
144   results are given back as arrays of ldb_message_element
145 */
146 struct ldb_message_element {
147         unsigned int flags;
148         const char *name;
149         unsigned int num_values;
150         struct ldb_val *values;
151 };
152
153
154 /**
155   a ldb_message represents all or part of a record. It can contain an arbitrary
156   number of elements. 
157 */
158 struct ldb_message {
159         struct ldb_dn *dn;
160         unsigned int num_elements;
161         struct ldb_message_element *elements;
162         void *private_data; /* private to the backend */
163 };
164
165 enum ldb_changetype {
166         LDB_CHANGETYPE_NONE=0,
167         LDB_CHANGETYPE_ADD,
168         LDB_CHANGETYPE_DELETE,
169         LDB_CHANGETYPE_MODIFY
170 };
171
172 /**
173   LDIF record
174
175   This structure contains a LDIF record, as returned from ldif_read()
176   and equivalent functions.
177 */
178 struct ldb_ldif {
179         enum ldb_changetype changetype; /*!< The type of change */
180         struct ldb_message *msg;  /*!< The changes */
181 };
182
183 enum ldb_scope {LDB_SCOPE_DEFAULT=-1, 
184                 LDB_SCOPE_BASE=0, 
185                 LDB_SCOPE_ONELEVEL=1,
186                 LDB_SCOPE_SUBTREE=2};
187
188 struct ldb_context;
189
190 /*
191   the fuction type for the callback used in traversing the database
192 */
193 typedef int (*ldb_traverse_fn)(struct ldb_context *, const struct ldb_message *);
194
195
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};
199
200 /**
201   the user can optionally supply a debug function. The function
202   is based on the vfprintf() style of interface, but with the addition
203   of a severity level
204 */
205 struct ldb_debug_ops {
206         void (*debug)(void *context, enum ldb_debug_level level, 
207                       const char *fmt, va_list ap);
208         void *context;
209 };
210
211 /**
212    Flag value for database connection mode.
213
214    If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
215    opened read-only, if possible.
216 */
217 #define LDB_FLG_RDONLY 1
218
219 /**
220    Flag value for database connection mode.
221
222    If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
223    opened without synchronous operations, if possible.
224 */
225 #define LDB_FLG_NOSYNC 2
226
227 /*! \cond DOXYGEN_IGNORE */
228 #ifndef PRINTF_ATTRIBUTE
229 #define PRINTF_ATTRIBUTE(a,b)
230 #endif
231 /*! \endcond */
232
233 /*
234    structures for ldb_parse_tree handling code
235 */
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 };
240
241 struct ldb_parse_tree {
242         enum ldb_parse_op operation;
243         union {
244                 struct {
245                         struct ldb_parse_tree *child;
246                 } isnot;
247                 struct {
248                         const char *attr;
249                         struct ldb_val value;
250                 } equality;
251                 struct {
252                         const char *attr;
253                         int start_with_wildcard;
254                         int end_with_wildcard;
255                         struct ldb_val **chunks;
256                 } substring;
257                 struct {
258                         const char *attr;
259                 } present;
260                 struct {
261                         const char *attr;
262                         struct ldb_val value;
263                 } comparison;
264                 struct {
265                         const char *attr;
266                         int dnAttributes;
267                         char *rule_id;
268                         struct ldb_val value;
269                 } extended;
270                 struct {
271                         unsigned int num_elements;
272                         struct ldb_parse_tree **elements;
273                 } list;
274         } u;
275 };
276
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
280 /**
281    Encode a binary blob
282
283    This function encodes a binary blob using the encoding rules in RFC
284    2254 (Section 4). This function also escapes any non-printable
285    characters.
286
287    \param ctx the memory context to allocate the return string in.
288    \param val the (potentially) binary data to be encoded
289
290    \return the encoded data as a null terminated string
291
292    \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
293 */
294 char *ldb_binary_encode(void *ctx, struct ldb_val val);
295
296 /**
297    Encode a string
298
299    This function encodes a string using the encoding rules in RFC 2254
300    (Section 4). This function also escapes any non-printable
301    characters.
302
303    \param mem_ctx the memory context to allocate the return string in.
304    \param string the string to be encoded
305
306    \return the encoded data as a null terminated string
307
308    \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
309 */
310 char *ldb_binary_encode_string(void *mem_ctx, const char *string);
311
312 /*
313   functions for controlling attribute handling
314 */
315 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
316 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
317
318 struct ldb_attrib_handler {
319         const char *attr;
320
321         /* LDB_ATTR_FLAG_* */
322         unsigned flags;
323
324         /* convert from ldif to binary format */
325         ldb_attr_handler_t ldif_read_fn;
326
327         /* convert from binary to ldif format */
328         ldb_attr_handler_t ldif_write_fn;
329         
330         /* canonicalise a value, for use by indexing and dn construction */
331         ldb_attr_handler_t canonicalise_fn;
332
333         /* compare two values */
334         ldb_attr_comparison_t comparison_fn;
335 };
336
337 /**
338    The attribute is not returned by default
339 */
340 #define LDB_ATTR_FLAG_HIDDEN       (1<<0) 
341
342 /**
343    The attribute is constructed from other attributes
344 */
345 #define LDB_ATTR_FLAG_CONSTRUCTED  (1<<1) 
346
347 /**
348   LDAP attribute syntax for a DN
349
350   This is the well-known LDAP attribute syntax for a DN.
351
352   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
353 */
354 #define LDB_SYNTAX_DN                   "1.3.6.1.4.1.1466.115.121.1.12"
355
356 /**
357   LDAP attribute syntax for a Directory String
358
359   This is the well-known LDAP attribute syntax for a Directory String.
360
361   \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
362 */
363 #define LDB_SYNTAX_DIRECTORY_STRING     "1.3.6.1.4.1.1466.115.121.1.15"
364
365 /**
366   LDAP attribute syntax for an integer
367
368   This is the well-known LDAP attribute syntax for an integer.
369
370   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
371 */
372 #define LDB_SYNTAX_INTEGER              "1.3.6.1.4.1.1466.115.121.1.27"
373
374 /**
375   LDAP attribute syntax for an octet string
376
377   This is the well-known LDAP attribute syntax for an octet string.
378
379   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
380 */
381 #define LDB_SYNTAX_OCTET_STRING         "1.3.6.1.4.1.1466.115.121.1.40"
382
383 /**
384   LDAP attribute syntax for UTC time.
385
386   This is the well-known LDAP attribute syntax for a UTC time.
387
388   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
389 */
390 #define LDB_SYNTAX_UTC_TIME             "1.3.6.1.4.1.1466.115.121.1.53"
391
392 #define LDB_SYNTAX_OBJECTCLASS          "LDB_SYNTAX_OBJECTCLASS"
393
394 /* sorting helpers */
395 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
396
397 /**
398    OID for the paged results control. This control is included in the
399    searchRequest and searchResultDone messages as part of the controls
400    field of the LDAPMessage, as defined in Section 4.1.12 of
401    LDAP v3. 
402
403    \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
404 */
405 #define LDB_CONTROL_PAGED_RESULTS_OID   "1.2.840.113556.1.4.319"
406
407 /**
408    OID for notification
409
410    \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>
411 */
412 #define LDB_CONTROL_NOTIFICATION_OID    "1.2.840.113556.1.4.528"
413
414 /**
415    OID for extended DN
416
417    \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>
418 */
419 #define LDB_CONTROL_EXTENDED_DN_OID     "1.2.840.113556.1.4.529"
420
421 /**
422    OID for LDAP server sort result extension.
423
424    This control is included in the searchRequest message as part of
425    the controls field of the LDAPMessage, as defined in Section 4.1.12
426    of LDAP v3. The controlType is set to
427    "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
428    FALSE (where absent is also equivalent to FALSE) at the client's
429    option.
430
431    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
432 */
433 #define LDB_CONTROL_SERVER_SORT_OID     "1.2.840.113556.1.4.473"
434
435 /**
436    OID for LDAP server sort result response extension.
437
438    This control is included in the searchResultDone message as part of
439    the controls field of the LDAPMessage, as defined in Section 4.1.12 of
440    LDAP v3.
441
442    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
443 */
444 #define LDB_CONTROL_SORT_RESP_OID       "1.2.840.113556.1.4.474"
445
446 /**
447    OID for LDAP Attribute Scoped Query extension.
448
449    This control is include in SearchRequest or SearchResponse
450    messages as part of the controls field of the LDAPMessage.
451 */
452 #define LDB_CONTROL_ASQ_OID             "1.2.840.113556.1.4.1504"
453
454 /**
455    OID for LDAPrectory Sync extension. 
456
457    This control is include in SearchRequest or SearchResponse
458    messages as part of the controls field of the LDAPMessage.
459 */
460 #define LDB_CONTROL_DIRSYNC_OID         "1.2.840.113556.1.4.841"
461
462
463 struct ldb_paged_control {
464         int size;
465         int cookie_len;
466         char *cookie;
467 };
468
469 struct ldb_extended_dn_control {
470         int type;
471 };
472
473 struct ldb_server_sort_control {
474         char *attributeName;
475         char *orderingRule;
476         int reverse;
477 };
478
479 struct ldb_sort_resp_control {
480         int result;
481         char *attr_desc;
482 };
483
484 struct ldb_asq_control {
485         int request;
486         char *source_attribute;
487         int src_attr_len;
488         int result;
489 };
490
491 struct ldb_dirsync_control {
492         int flags;
493         int max_attributes;
494         int cookie_len;
495         char *cookie;
496 };
497
498 struct ldb_control {
499         const char *oid;
500         int critical;
501         void *data;
502 };
503
504 struct ldb_credentials;
505
506 enum ldb_request_type {
507         LDB_REQ_SEARCH,
508         LDB_REQ_ADD,
509         LDB_REQ_MODIFY,
510         LDB_REQ_DELETE,
511         LDB_REQ_RENAME,
512         LDB_REQ_REGISTER
513 };
514
515 struct ldb_result {
516         unsigned int count;
517         struct ldb_message **msgs;
518         struct ldb_control **controls;
519 };
520
521 struct ldb_search {
522         const struct ldb_dn *base;
523         enum ldb_scope scope;
524         struct ldb_parse_tree *tree;
525         const char * const *attrs;
526         struct ldb_result *res;
527 };
528
529 struct ldb_add {
530         const struct ldb_message *message;
531 };
532
533 struct  ldb_modify {
534         const struct ldb_message *message;
535 };
536
537 struct ldb_delete {
538         const struct ldb_dn *dn;
539 };
540
541 struct ldb_rename {
542         const struct ldb_dn *olddn;
543         const struct ldb_dn *newdn;
544 };
545
546 struct ldb_register_control {
547         const char *oid;
548 };
549
550 struct ldb_request {
551
552         int operation;
553
554         union {
555                 struct ldb_search search;
556                 struct ldb_add    add;
557                 struct ldb_modify mod;
558                 struct ldb_delete del;
559                 struct ldb_rename rename;
560                 struct ldb_register_control reg;
561         } op;
562
563         struct ldb_control **controls;
564         struct ldb_credentials *creds;
565 };
566
567 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
568
569 /**
570   Initialise an ldb context
571
572   This is required before any other LDB call.
573
574   \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
575   no suitable context available.
576
577   \return pointer to ldb_context that should be free'd (using talloc_free())
578   at the end of the program.
579 */
580 struct ldb_context *ldb_init(void *mem_ctx);
581
582 /**
583    Connect to a database.
584
585    This is typically called soon after ldb_init(), and is required prior to
586    any search or database modification operations.
587
588    The URL can be one of the following forms:
589     - tdb://path
590     - ldapi://path
591     - ldap://host
592     - sqlite://path
593
594    \param ldb the context associated with the database (from ldb_init())
595    \param url the URL of the database to connect to, as noted above
596    \param flags a combination of LDB_FLG_* to modify the connection behaviour
597    \param options backend specific options - passed uninterpreted to the backend
598
599    \return result code (LDB_SUCCESS on success, or a failure code)
600
601    \note It is an error to connect to a database that does not exist in readonly mode
602    (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
603    created if it does not exist.
604 */
605 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
606
607 /**
608   Search the database
609
610   This function searches the database, and returns 
611   records that match an LDAP-like search expression
612
613   \param ldb the context associated with the database (from ldb_init())
614   \param base the Base Distinguished Name for the query (pass NULL for root DN)
615   \param scope the search scope for the query
616   \param expression the search expression to use for this query
617   \param attrs the search attributes for the query (pass NULL if none required)
618   \param res the return result
619
620   \return result code (LDB_SUCCESS on success, or a failure code)
621
622   \note use talloc_free() to free the ldb_result returned
623 */
624 int ldb_search(struct ldb_context *ldb, 
625                const struct ldb_dn *base,
626                enum ldb_scope scope,
627                const char *expression,
628                const char * const *attrs, struct ldb_result **res);
629
630 /*
631   like ldb_search() but takes a parse tree
632 */
633 int ldb_search_bytree(struct ldb_context *ldb, 
634                       const struct ldb_dn *base,
635                       enum ldb_scope scope,
636                       struct ldb_parse_tree *tree,
637                       const char * const *attrs, struct ldb_result **res);
638
639 /**
640   Add a record to the database.
641
642   This function adds a record to the database. This function will fail
643   if a record with the specified class and key already exists in the
644   database. 
645
646   \param ldb the context associated with the database (from
647   ldb_init())
648   \param message the message containing the record to add.
649
650   \return result code (LDB_SUCCESS if the record was added, otherwise
651   a failure code)
652 */
653 int ldb_add(struct ldb_context *ldb, 
654             const struct ldb_message *message);
655
656 /**
657   Modify the specified attributes of a record
658
659   This function modifies a record that is in the database.
660
661   \param ldb the context associated with the database (from
662   ldb_init())
663   \param message the message containing the changes required.
664
665   \return result code (LDB_SUCCESS if the record was modified as
666   requested, otherwise a failure code)
667 */
668 int ldb_modify(struct ldb_context *ldb, 
669                const struct ldb_message *message);
670
671 /**
672   Rename a record in the database
673
674   This function renames a record in the database.
675
676   \param ldb the context associated with the database (from
677   ldb_init())
678   \param olddn the DN for the record to be renamed.
679   \param newdn the new DN 
680
681   \return result code (LDB_SUCCESS if the record was renamed as
682   requested, otherwise a failure code)
683 */
684 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);
685
686 /**
687   Delete a record from the database
688
689   This function deletes a record from the database.
690
691   \param ldb the context associated with the database (from
692   ldb_init())
693   \param dn the DN for the record to be deleted.
694
695   \return result code (LDB_SUCCESS if the record was deleted,
696   otherwise a failure code)
697 */
698 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);
699
700 /**
701   start a transaction
702 */
703 int ldb_transaction_start(struct ldb_context *ldb);
704
705 /**
706   commit a transaction
707 */
708 int ldb_transaction_commit(struct ldb_context *ldb);
709
710 /**
711   cancel a transaction
712 */
713 int ldb_transaction_cancel(struct ldb_context *ldb);
714
715
716 /**
717   return extended error information from the last call
718 */
719 const char *ldb_errstring(struct ldb_context *ldb);
720
721 /**
722    Casefold a string
723
724    \param mem_ctx the memory context to allocate the result string
725    memory from. 
726    \param s the string that is to be folded
727    \return a copy of the string, converted to upper case
728
729    \todo This function should be UTF8 aware, but currently is not.
730 */
731 char *ldb_casefold(void *mem_ctx, const char *s);
732
733 /**
734    Compare two strings, without regard to case. 
735
736    \param s1 the first string to compare
737    \param s2 the second string to compare
738
739    \return 0 if the strings are the same, non-zero if there are any
740    differences except for case.
741
742    \note This function is not UTF8 aware.
743 */
744 int ldb_caseless_cmp(const char *s1, const char *s2);
745
746 /*
747   ldif manipulation functions
748 */
749 /**
750    Write an LDIF message
751
752    This function writes an LDIF message using a caller supplied  write
753    function.
754
755    \param ldb the ldb context (from ldb_init())
756    \param fprintf_fn a function pointer for the write function. This must take
757    a private data pointer, followed by a format string, and then a variable argument
758    list. 
759    \param private_data pointer that will be provided back to the write
760    function. This is useful for maintaining state or context.
761    \param ldif the message to write out
762
763    \return the total number of bytes written, or an error code as returned
764    from the write function.
765
766    \sa ldb_ldif_write_file for a more convenient way to write to a
767    file stream.
768
769    \sa ldb_ldif_read for the reader equivalent to this function.
770 */
771 int ldb_ldif_write(struct ldb_context *ldb,
772                    int (*fprintf_fn)(void *, const char *, ...), 
773                    void *private_data,
774                    const struct ldb_ldif *ldif);
775
776 /**
777    Clean up an LDIF message
778
779    This function cleans up a LDIF message read using ldb_ldif_read()
780    or related functions (such as ldb_ldif_read_string() and
781    ldb_ldif_read_file().
782
783    \param ldb the ldb context (from ldb_init())
784    \param msg the message to clean up and free
785
786 */
787 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
788
789 /**
790    Read an LDIF message
791
792    This function creates an LDIF message using a caller supplied read
793    function. 
794
795    \param ldb the ldb context (from ldb_init())
796    \param fgetc_fn a function pointer for the read function. This must
797    take a private data pointer, and must return a pointer to an
798    integer corresponding to the next byte read (or EOF if there is no
799    more data to be read).
800    \param private_data pointer that will be provided back to the read
801    function. This is udeful for maintaining state or context.
802
803    \return the LDIF message that has been read in
804
805    \note You must free the LDIF message when no longer required, using
806    ldb_ldif_read_free().
807
808    \sa ldb_ldif_read_file for a more convenient way to read from a
809    file stream.
810
811    \sa ldb_ldif_read_string for a more convenient way to read from a
812    string (char array).
813
814    \sa ldb_ldif_write for the writer equivalent to this function.
815 */
816 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb, 
817                                int (*fgetc_fn)(void *), void *private_data);
818
819 /**
820    Read an LDIF message from a file
821
822    This function reads the next LDIF message from the contents of a
823    file stream. If you want to get all of the LDIF messages, you will
824    need to repeatedly call this function, until it returns NULL.
825
826    \param ldb the ldb context (from ldb_init())
827    \param f the file stream to read from (typically from fdopen())
828
829    \sa ldb_ldif_read_string for an equivalent function that will read
830    from a string (char array).
831
832    \sa ldb_ldif_write_file for the writer equivalent to this function.
833
834 */
835 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
836
837 /**
838    Read an LDIF message from a string
839
840    This function reads the next LDIF message from the contents of a char
841    array. If you want to get all of the LDIF messages, you will need
842    to repeatedly call this function, until it returns NULL.
843
844    \param ldb the ldb context (from ldb_init())
845    \param s pointer to the char array to read from
846
847    \sa ldb_ldif_read_file for an equivalent function that will read
848    from a file stream.
849
850    \sa ldb_ldif_write for a more general (arbitrary read function)
851    version of this function.
852 */
853 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
854
855 /**
856    Write an LDIF message to a file
857
858    \param ldb the ldb context (from ldb_init())
859    \param f the file stream to write to (typically from fdopen())
860    \param msg the message to write out
861
862    \return the total number of bytes written, or a negative error code
863
864    \sa ldb_ldif_read_file for the reader equivalent to this function.
865 */
866 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
867
868 /**
869    Base64 encode a buffer
870
871    \param mem_ctx the memory context that the result is allocated
872    from. 
873    \param buf pointer to the array that is to be encoded
874    \param len the number of elements in the array to be encoded
875
876    \return pointer to an array containing the encoded data
877
878    \note The caller is responsible for freeing the result
879 */
880 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
881
882 /**
883    Base64 decode a buffer
884
885    This function decodes a base64 encoded string in place.
886
887    \param s the string to decode.
888
889    \return the length of the returned (decoded) string.
890
891    \note the string is null terminated, but the null terminator is not
892    included in the length.
893 */
894 int ldb_base64_decode(char *s);
895
896 int ldb_attrib_add_handlers(struct ldb_context *ldb, 
897                             const struct ldb_attrib_handler *handlers, 
898                             unsigned num_handlers);
899
900 /* The following definitions come from lib/ldb/common/ldb_dn.c  */
901
902 int ldb_dn_is_special(const struct ldb_dn *dn);
903 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check);
904 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
905 struct ldb_dn *ldb_dn_new(void *mem_ctx);
906 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);
907 struct ldb_dn *ldb_dn_explode_or_special(void *mem_ctx, const char *dn);
908 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn);
909 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
910 int ldb_dn_compare_base(struct ldb_context *ldb, const struct ldb_dn *base, const struct ldb_dn *dn);
911 int ldb_dn_compare(struct ldb_context *ldb, const struct ldb_dn *edn0, const struct ldb_dn *edn1);
912 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
913 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, const char *dn);
914 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el);
915 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn);
916 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn);
917 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
918                                                                const char *val);
919 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
920                                                  const char * value,
921                                                  const struct ldb_dn *base);
922 struct ldb_dn *ldb_dn_make_child(void *mem_ctx,
923                                  const struct ldb_dn_component *component,
924                                  const struct ldb_dn *base);
925 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2);
926 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...) PRINTF_ATTRIBUTE(3,4);
927 struct ldb_dn_component *ldb_dn_get_rdn(void *mem_ctx, const struct ldb_dn *dn);
928
929 /* useful functions for ldb_message structure manipulation */
930 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
931
932 /**
933    Compare two attributes
934
935    This function compares to attribute names. Note that this is a
936    case-insensitive comparison.
937
938    \param attr1 the first attribute name to compare
939    \param attr2 the second attribute name to compare
940
941    \return 0 if the attribute names are the same, or only differ in
942    case; non-zero if there are any differences
943 */
944 int ldb_attr_cmp(const char *attr1, const char *attr2);
945 int ldb_attr_dn(const char *attr);
946 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
947
948 /**
949    Create an empty message
950
951    \param mem_ctx the memory context to create in. You can pass NULL
952    to get the top level context, however the ldb context (from
953    ldb_init()) may be a better choice
954 */
955 struct ldb_message *ldb_msg_new(void *mem_ctx);
956
957 /**
958    Find an element within an message
959 */
960 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg, 
961                                                  const char *attr_name);
962
963 /**
964    Compare two ldb_val values
965
966    \param v1 first ldb_val structure to be tested
967    \param v2 second ldb_val structure to be tested
968
969    \return 1 for a match, 0 if there is any difference
970 */
971 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
972
973 /**
974    find a value within an ldb_message_element
975
976    \param el the element to search
977    \param val the value to search for
978
979    \note This search is case sensitive
980 */
981 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el, 
982                                  struct ldb_val *val);
983
984 /**
985    add a new empty element to a ldb_message
986 */
987 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags);
988
989 /**
990    add a element to a ldb_message
991 */
992 int ldb_msg_add(struct ldb_message *msg, 
993                 const struct ldb_message_element *el, 
994                 int flags);
995 int ldb_msg_add_value(struct ldb_message *msg, 
996                       const char *attr_name,
997                       const struct ldb_val *val);
998 int ldb_msg_add_string(struct ldb_message *msg, 
999                        const char *attr_name, const char *str);
1000 int ldb_msg_add_fmt(struct ldb_message *msg, 
1001                     const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1002
1003 /**
1004    compare two message elements - return 0 on match
1005 */
1006 int ldb_msg_element_compare(struct ldb_message_element *el1, 
1007                             struct ldb_message_element *el2);
1008
1009 /**
1010    Find elements in a message.
1011
1012    This function finds elements and converts to a specific type, with
1013    a give default value if not found. Assumes that elements are
1014    single valued.
1015 */
1016 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1017 int ldb_msg_find_int(const struct ldb_message *msg, 
1018                      const char *attr_name,
1019                      int default_value);
1020 unsigned int ldb_msg_find_uint(const struct ldb_message *msg, 
1021                                const char *attr_name,
1022                                unsigned int default_value);
1023 int64_t ldb_msg_find_int64(const struct ldb_message *msg, 
1024                            const char *attr_name,
1025                            int64_t default_value);
1026 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg, 
1027                              const char *attr_name,
1028                              uint64_t default_value);
1029 double ldb_msg_find_double(const struct ldb_message *msg, 
1030                            const char *attr_name,
1031                            double default_value);
1032 const char *ldb_msg_find_string(const struct ldb_message *msg, 
1033                                 const char *attr_name,
1034                                 const char *default_value);
1035
1036 void ldb_msg_sort_elements(struct ldb_message *msg);
1037
1038 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx, 
1039                                          const struct ldb_message *msg);
1040 struct ldb_message *ldb_msg_copy(void *mem_ctx, 
1041                                  const struct ldb_message *msg);
1042
1043 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb, 
1044                                          const struct ldb_message *msg);
1045
1046
1047 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb, 
1048                                  struct ldb_message *msg1,
1049                                  struct ldb_message *msg2);
1050
1051 /**
1052    Integrity check an ldb_message
1053
1054    This function performs basic sanity / integrity checks on an
1055    ldb_message.
1056
1057    \param msg the message to check
1058
1059    \return LDB_SUCCESS if the message is OK, or a non-zero error code
1060    (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1061    LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1062    message.
1063 */
1064 int ldb_msg_sanity_check(const struct ldb_message *msg);
1065
1066 /**
1067    Duplicate an ldb_val structure
1068
1069    This function copies an ldb value structure. 
1070
1071    \param mem_ctx the memory context that the duplicated value will be
1072    allocated from
1073    \param v the ldb_val to be duplicated.
1074
1075    \return the duplicated ldb_val structure.
1076 */
1077 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
1078
1079 /**
1080   this allows the user to set a debug function for error reporting
1081 */
1082 int ldb_set_debug(struct ldb_context *ldb,
1083                   void (*debug)(void *context, enum ldb_debug_level level, 
1084                                 const char *fmt, va_list ap),
1085                   void *context);
1086
1087 /**
1088    this sets up debug to print messages on stderr
1089 */
1090 int ldb_set_debug_stderr(struct ldb_context *ldb);
1091
1092 /* control backend specific opaque values */
1093 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1094 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1095
1096 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
1097                                                     const char *attrib);
1098
1099
1100 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
1101 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1102
1103
1104 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree, 
1105                                  const char *attr, 
1106                                  const char *replace);
1107
1108 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1109 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1110 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1111
1112 /**
1113    Convert a time structure to a string
1114
1115    This function converts a time_t structure to an LDAP formatted time
1116    string.
1117
1118    \param mem_ctx the memory context to allocate the return string in
1119    \param t the time structure to convert
1120
1121    \return the formatted string, or NULL if the time structure could
1122    not be converted
1123 */
1124 char *ldb_timestring(void *mem_ctx, time_t t);
1125
1126 /**
1127    Convert a string to a time structure
1128
1129    This function converts an LDAP formatted time string to a time_t
1130    structure.
1131
1132    \param s the string to convert
1133
1134    \return the time structure, or 0 if the string cannot be converted
1135 */
1136 time_t ldb_string_to_time(const char *s);
1137
1138 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn);
1139 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn);
1140
1141
1142 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1143 #endif