3891c1c6a3124614e7fa8bb91b7ea5e731a5ae05
[kai/samba-autobuild/.git] / source3 / 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-2006
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 3 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, see <http://www.gnu.org/licenses/>.
24 */
25
26 /*
27  *  Name: ldb
28  *
29  *  Component: ldb header
30  *
31  *  Description: defines for base ldb API
32  *
33  *  Author: Andrew Tridgell
34  *  Author: Stefan Metzmacher
35  */
36
37 /**
38    \file ldb.h Samba's ldb database
39
40    This header file provides the main API for ldb.
41 */
42
43 #ifndef _LDB_H_
44
45 /*! \cond DOXYGEN_IGNORE */
46 #define _LDB_H_ 1
47 /*! \endcond */
48
49 /*
50   major restrictions as compared to normal LDAP:
51
52      - no async calls.
53      - each record must have a unique key field
54      - the key must be representable as a NULL terminated C string and may not 
55        contain a comma or braces
56
57   major restrictions as compared to tdb:
58
59      - no explicit locking calls
60      UPDATE: we have transactions now, better than locking --SSS.
61
62 */
63
64 #ifndef ldb_val
65 /**
66    Result value
67
68    An individual lump of data in a result comes in this format. The
69    pointer will usually be to a UTF-8 string if the application is
70    sensible, but it can be to anything you like, including binary data
71    blobs of arbitrary size.
72
73    \note the data is null (0x00) terminated, but the length does not
74    include the terminator. 
75 */
76 struct ldb_val {
77         uint8_t *data; /*!< result data */
78         size_t length; /*!< length of data */
79 };
80 #endif
81
82 /*! \cond DOXYGEN_IGNORE */
83 #ifndef PRINTF_ATTRIBUTE
84 #define PRINTF_ATTRIBUTE(a,b)
85 #endif
86 /*! \endcond */
87
88 /* opaque ldb_dn structures, see ldb_dn.c for internals */
89 struct ldb_dn_component;
90 struct ldb_dn;
91
92 /**
93  There are a number of flags that are used with ldap_modify() in
94  ldb_message_element.flags fields. The LDA_FLAGS_MOD_ADD,
95  LDA_FLAGS_MOD_DELETE and LDA_FLAGS_MOD_REPLACE flags are used in
96  ldap_modify() calls to specify whether attributes are being added,
97  deleted or modified respectively.
98 */
99 #define LDB_FLAG_MOD_MASK  0x3
100
101 /**
102    Flag value used in ldap_modify() to indicate that attributes are
103    being added.
104
105    \sa LDB_FLAG_MOD_MASK
106 */
107 #define LDB_FLAG_MOD_ADD     1
108
109 /**
110    Flag value used in ldap_modify() to indicate that attributes are
111    being replaced.
112
113    \sa LDB_FLAG_MOD_MASK
114 */
115 #define LDB_FLAG_MOD_REPLACE 2
116
117 /**
118    Flag value used in ldap_modify() to indicate that attributes are
119    being deleted.
120
121    \sa LDB_FLAG_MOD_MASK
122 */
123 #define LDB_FLAG_MOD_DELETE  3
124
125 /**
126   OID for logic AND comaprison.
127
128   This is the well known object ID for a logical AND comparitor.
129 */
130 #define LDB_OID_COMPARATOR_AND  "1.2.840.113556.1.4.803"
131
132 /**
133   OID for logic OR comparison.
134
135   This is the well known object ID for a logical OR comparitor.
136 */
137 #define LDB_OID_COMPARATOR_OR   "1.2.840.113556.1.4.804"
138
139 /**
140   results are given back as arrays of ldb_message_element
141 */
142 struct ldb_message_element {
143         unsigned int flags;
144         const char *name;
145         unsigned int num_values;
146         struct ldb_val *values;
147 };
148
149
150 /**
151   a ldb_message represents all or part of a record. It can contain an arbitrary
152   number of elements. 
153 */
154 struct ldb_message {
155         struct ldb_dn *dn;
156         unsigned int num_elements;
157         struct ldb_message_element *elements;
158         void *private_data; /* private to the backend */
159 };
160
161 enum ldb_changetype {
162         LDB_CHANGETYPE_NONE=0,
163         LDB_CHANGETYPE_ADD,
164         LDB_CHANGETYPE_DELETE,
165         LDB_CHANGETYPE_MODIFY
166 };
167
168 /**
169   LDIF record
170
171   This structure contains a LDIF record, as returned from ldif_read()
172   and equivalent functions.
173 */
174 struct ldb_ldif {
175         enum ldb_changetype changetype; /*!< The type of change */
176         struct ldb_message *msg;  /*!< The changes */
177 };
178
179 enum ldb_scope {LDB_SCOPE_DEFAULT=-1, 
180                 LDB_SCOPE_BASE=0, 
181                 LDB_SCOPE_ONELEVEL=1,
182                 LDB_SCOPE_SUBTREE=2};
183
184 struct ldb_context;
185
186 /* debugging uses one of the following levels */
187 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR, 
188                       LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
189
190 /**
191   the user can optionally supply a debug function. The function
192   is based on the vfprintf() style of interface, but with the addition
193   of a severity level
194 */
195 struct ldb_debug_ops {
196         void (*debug)(void *context, enum ldb_debug_level level, 
197                       const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
198         void *context;
199 };
200
201 /**
202   The user can optionally supply a custom utf8 functions,
203   to handle comparisons and casefolding.
204 */
205 struct ldb_utf8_fns {
206         void *context;
207         char *(*casefold)(void *context, void *mem_ctx, const char *s);
208 };
209
210 /**
211    Flag value for database connection mode.
212
213    If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
214    opened read-only, if possible.
215 */
216 #define LDB_FLG_RDONLY 1
217
218 /**
219    Flag value for database connection mode.
220
221    If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
222    opened without synchronous operations, if possible.
223 */
224 #define LDB_FLG_NOSYNC 2
225
226 /**
227    Flag value to specify autoreconnect mode.
228
229    If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
230    be opened in a way that makes it try to auto reconnect if the
231    connection is dropped (actually make sense only with ldap).
232 */
233 #define LDB_FLG_RECONNECT 4
234
235 /**
236    Flag to tell backends not to use mmap
237 */
238 #define LDB_FLG_NOMMAP 8
239
240 /*
241    structures for ldb_parse_tree handling code
242 */
243 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
244                     LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
245                     LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
246                     LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
247
248 struct ldb_parse_tree {
249         enum ldb_parse_op operation;
250         union {
251                 struct {
252                         struct ldb_parse_tree *child;
253                 } isnot;
254                 struct {
255                         const char *attr;
256                         struct ldb_val value;
257                 } equality;
258                 struct {
259                         const char *attr;
260                         int start_with_wildcard;
261                         int end_with_wildcard;
262                         struct ldb_val **chunks;
263                 } substring;
264                 struct {
265                         const char *attr;
266                 } present;
267                 struct {
268                         const char *attr;
269                         struct ldb_val value;
270                 } comparison;
271                 struct {
272                         const char *attr;
273                         int dnAttributes;
274                         char *rule_id;
275                         struct ldb_val value;
276                 } extended;
277                 struct {
278                         unsigned int num_elements;
279                         struct ldb_parse_tree **elements;
280                 } list;
281         } u;
282 };
283
284 struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
285 char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
286
287 /**
288    Encode a binary blob
289
290    This function encodes a binary blob using the encoding rules in RFC
291    2254 (Section 4). This function also escapes any non-printable
292    characters.
293
294    \param ctx the memory context to allocate the return string in.
295    \param val the (potentially) binary data to be encoded
296
297    \return the encoded data as a null terminated string
298
299    \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
300 */
301 char *ldb_binary_encode(void *ctx, struct ldb_val val);
302
303 /**
304    Encode a string
305
306    This function encodes a string using the encoding rules in RFC 2254
307    (Section 4). This function also escapes any non-printable
308    characters.
309
310    \param mem_ctx the memory context to allocate the return string in.
311    \param string the string to be encoded
312
313    \return the encoded data as a null terminated string
314
315    \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
316 */
317 char *ldb_binary_encode_string(void *mem_ctx, const char *string);
318
319 /*
320   functions for controlling attribute handling
321 */
322 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
323 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
324
325 /*
326   attribute handler structure
327
328   attr                  -> The attribute name
329   flags                 -> LDB_ATTR_FLAG_*
330   ldif_read_fn          -> convert from ldif to binary format
331   ldif_write_fn         -> convert from binary to ldif format
332   canonicalise_fn       -> canonicalise a value, for use by indexing and dn construction
333   comparison_fn         -> compare two values
334 */
335
336 struct ldb_attrib_handler {
337
338         const char *attr;
339         unsigned flags;
340
341         ldb_attr_handler_t ldif_read_fn;
342         ldb_attr_handler_t ldif_write_fn;
343         ldb_attr_handler_t canonicalise_fn;
344         ldb_attr_comparison_t comparison_fn;
345 };
346
347 /**
348    The attribute is not returned by default
349 */
350 #define LDB_ATTR_FLAG_HIDDEN       (1<<0) 
351
352 /* the attribute handler name should be freed when released */
353 #define LDB_ATTR_FLAG_ALLOCATED    (1<<1) 
354
355 /**
356    The attribute is constructed from other attributes
357 */
358 #define LDB_ATTR_FLAG_CONSTRUCTED  (1<<1) 
359
360 /**
361   LDAP attribute syntax for a DN
362
363   This is the well-known LDAP attribute syntax for a DN.
364
365   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
366 */
367 #define LDB_SYNTAX_DN                   "1.3.6.1.4.1.1466.115.121.1.12"
368
369 /**
370   LDAP attribute syntax for a Directory String
371
372   This is the well-known LDAP attribute syntax for a Directory String.
373
374   \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
375 */
376 #define LDB_SYNTAX_DIRECTORY_STRING     "1.3.6.1.4.1.1466.115.121.1.15"
377
378 /**
379   LDAP attribute syntax for an integer
380
381   This is the well-known LDAP attribute syntax for an integer.
382
383   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
384 */
385 #define LDB_SYNTAX_INTEGER              "1.3.6.1.4.1.1466.115.121.1.27"
386
387 /**
388   LDAP attribute syntax for an octet string
389
390   This is the well-known LDAP attribute syntax for an octet string.
391
392   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
393 */
394 #define LDB_SYNTAX_OCTET_STRING         "1.3.6.1.4.1.1466.115.121.1.40"
395
396 /**
397   LDAP attribute syntax for UTC time.
398
399   This is the well-known LDAP attribute syntax for a UTC time.
400
401   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
402 */
403 #define LDB_SYNTAX_UTC_TIME             "1.3.6.1.4.1.1466.115.121.1.53"
404
405 #define LDB_SYNTAX_OBJECTCLASS          "LDB_SYNTAX_OBJECTCLASS"
406
407 /* sorting helpers */
408 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
409
410 /**
411    OID for the paged results control. This control is included in the
412    searchRequest and searchResultDone messages as part of the controls
413    field of the LDAPMessage, as defined in Section 4.1.12 of
414    LDAP v3. 
415
416    \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
417 */
418 #define LDB_CONTROL_PAGED_RESULTS_OID   "1.2.840.113556.1.4.319"
419
420 /**
421    OID for specifying the returned elements of the ntSecurityDescriptor
422
423    \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>
424 */
425 #define LDB_CONTROL_SD_FLAGS_OID        "1.2.840.113556.1.4.801"
426
427 /**
428    OID for specifying an advanced scope for the search (one partition)
429
430    \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>
431 */
432 #define LDB_CONTROL_DOMAIN_SCOPE_OID    "1.2.840.113556.1.4.1339"
433
434 /**
435    OID for specifying an advanced scope for a search
436
437    \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>
438 */
439 #define LDB_CONTROL_SEARCH_OPTIONS_OID  "1.2.840.113556.1.4.1340"
440
441 /**
442    OID for notification
443
444    \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>
445 */
446 #define LDB_CONTROL_NOTIFICATION_OID    "1.2.840.113556.1.4.528"
447
448 /**
449    OID for getting deleted objects
450
451    \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>
452 */
453 #define LDB_CONTROL_SHOW_DELETED_OID    "1.2.840.113556.1.4.417"
454
455 /**
456    OID for extended DN
457
458    \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>
459 */
460 #define LDB_CONTROL_EXTENDED_DN_OID     "1.2.840.113556.1.4.529"
461
462 /**
463    OID for LDAP server sort result extension.
464
465    This control is included in the searchRequest message as part of
466    the controls field of the LDAPMessage, as defined in Section 4.1.12
467    of LDAP v3. The controlType is set to
468    "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
469    FALSE (where absent is also equivalent to FALSE) at the client's
470    option.
471
472    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
473 */
474 #define LDB_CONTROL_SERVER_SORT_OID     "1.2.840.113556.1.4.473"
475
476 /**
477    OID for LDAP server sort result response extension.
478
479    This control is included in the searchResultDone message as part of
480    the controls field of the LDAPMessage, as defined in Section 4.1.12 of
481    LDAP v3.
482
483    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
484 */
485 #define LDB_CONTROL_SORT_RESP_OID       "1.2.840.113556.1.4.474"
486
487 /**
488    OID for LDAP Attribute Scoped Query extension.
489
490    This control is included in SearchRequest or SearchResponse
491    messages as part of the controls field of the LDAPMessage.
492 */
493 #define LDB_CONTROL_ASQ_OID             "1.2.840.113556.1.4.1504"
494
495 /**
496    OID for LDAP Directory Sync extension. 
497
498    This control is included in SearchRequest or SearchResponse
499    messages as part of the controls field of the LDAPMessage.
500 */
501 #define LDB_CONTROL_DIRSYNC_OID         "1.2.840.113556.1.4.841"
502
503
504 /**
505    OID for LDAP Virtual List View Request extension.
506
507    This control is included in SearchRequest messages
508    as part of the controls field of the LDAPMessage.
509 */
510 #define LDB_CONTROL_VLV_REQ_OID         "2.16.840.1.113730.3.4.9"
511
512 /**
513    OID for LDAP Virtual List View Response extension.
514
515    This control is included in SearchResponse messages
516    as part of the controls field of the LDAPMessage.
517 */
518 #define LDB_CONTROL_VLV_RESP_OID        "2.16.840.1.113730.3.4.10"
519
520 /**
521    OID to let modifies don't give an error when adding an existing
522    attribute with the same value or deleting an nonexisting one attribute
523
524    \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>
525 */
526 #define LDB_CONTROL_PERMISSIVE_MODIFY_OID       "1.2.840.113556.1.4.1413"
527
528 /**
529    OID for LDAP Extended Operation START_TLS.
530
531    This Extended operation is used to start a new TLS
532    channel on top of a clear text channel.
533 */
534 #define LDB_EXTENDED_START_TLS_OID      "1.3.6.1.4.1.1466.20037"
535
536 /**
537    OID for LDAP Extended Operation START_TLS.
538
539    This Extended operation is used to start a new TLS
540    channel on top of a clear text channel.
541 */
542 #define LDB_EXTENDED_DYNAMIC_OID        "1.3.6.1.4.1.1466.101.119.1"
543
544 /**
545    OID for LDAP Extended Operation START_TLS.
546
547    This Extended operation is used to start a new TLS
548    channel on top of a clear text channel.
549 */
550 #define LDB_EXTENDED_FAST_BIND_OID      "1.2.840.113556.1.4.1781"
551
552 struct ldb_sd_flags_control {
553         /*
554          * request the owner    0x00000001
555          * request the group    0x00000002
556          * request the DACL     0x00000004
557          * request the SACL     0x00000008
558          */
559         unsigned secinfo_flags;
560 };
561
562 struct ldb_search_options_control {
563         /*
564          * DOMAIN_SCOPE         0x00000001
565          * this limits the search to one partition,
566          * and no referrals will be returned.
567          * (Note this doesn't limit the entries by there
568          *  objectSid belonging to a domain! Builtin and Foreign Sids
569          *  are still returned)
570          *
571          * PHANTOM_ROOT         0x00000002
572          * this search on the whole tree on a domain controller
573          * over multiple partitions without referrals.
574          * (This is the default behavior on the Global Catalog Port)
575          */
576         unsigned search_options;
577 };
578
579 struct ldb_paged_control {
580         int size;
581         int cookie_len;
582         char *cookie;
583 };
584
585 struct ldb_extended_dn_control {
586         int type;
587 };
588
589 struct ldb_server_sort_control {
590         char *attributeName;
591         char *orderingRule;
592         int reverse;
593 };
594
595 struct ldb_sort_resp_control {
596         int result;
597         char *attr_desc;
598 };
599
600 struct ldb_asq_control {
601         int request;
602         char *source_attribute;
603         int src_attr_len;
604         int result;
605 };
606
607 struct ldb_dirsync_control {
608         int flags;
609         int max_attributes;
610         int cookie_len;
611         char *cookie;
612 };
613
614 struct ldb_vlv_req_control {
615         int beforeCount;
616         int afterCount;
617         int type;
618         union {
619                 struct {
620                         int offset;
621                         int contentCount;
622                 } byOffset;
623                 struct {
624                         int value_len;
625                         char *value;
626                 } gtOrEq;
627         } match;
628         int ctxid_len;
629         char *contextId;
630 };
631
632 struct ldb_vlv_resp_control {
633         int targetPosition;
634         int contentCount;
635         int vlv_result;
636         int ctxid_len;
637         char *contextId;
638 };
639
640 struct ldb_control {
641         const char *oid;
642         int critical;
643         void *data;
644 };
645
646 enum ldb_request_type {
647         LDB_SEARCH,
648         LDB_ADD,
649         LDB_MODIFY,
650         LDB_DELETE,
651         LDB_RENAME,
652         LDB_EXTENDED,
653         LDB_REQ_REGISTER_CONTROL,
654         LDB_REQ_REGISTER_PARTITION,
655         LDB_SEQUENCE_NUMBER
656 };
657
658 enum ldb_reply_type {
659         LDB_REPLY_ENTRY,
660         LDB_REPLY_REFERRAL,
661         LDB_REPLY_EXTENDED,
662         LDB_REPLY_DONE
663 };
664
665 enum ldb_wait_type {
666         LDB_WAIT_ALL,
667         LDB_WAIT_NONE
668 };
669
670 enum ldb_state {
671         LDB_ASYNC_INIT,
672         LDB_ASYNC_PENDING,
673         LDB_ASYNC_DONE
674 };
675
676 struct ldb_result {
677         unsigned int count;
678         struct ldb_message **msgs;
679         char **refs;
680         struct ldb_control **controls;
681 };
682
683 struct ldb_extended {
684         const char *oid;
685         const char *value;
686         int value_len;
687 };
688
689 struct ldb_reply {
690         enum ldb_reply_type type;
691         struct ldb_message *message;
692         struct ldb_extended *response;
693         char *referral;
694         struct ldb_control **controls;
695 };
696
697 struct ldb_handle {
698         int status;
699         enum ldb_state state;
700         void *private_data;
701         struct ldb_module *module;
702 };
703
704 struct ldb_search {
705         const struct ldb_dn *base;
706         enum ldb_scope scope;
707         const struct ldb_parse_tree *tree;
708         const char * const *attrs;
709         struct ldb_result *res;
710 };
711
712 struct ldb_add {
713         const struct ldb_message *message;
714 };
715
716 struct  ldb_modify {
717         const struct ldb_message *message;
718 };
719
720 struct ldb_delete {
721         const struct ldb_dn *dn;
722 };
723
724 struct ldb_rename {
725         const struct ldb_dn *olddn;
726         const struct ldb_dn *newdn;
727 };
728
729 struct ldb_register_control {
730         const char *oid;
731 };
732
733 struct ldb_register_partition {
734         const struct ldb_dn *dn;
735 };
736
737 struct ldb_sequence_number {
738         enum ldb_sequence_type {
739                 LDB_SEQ_HIGHEST_SEQ,
740                 LDB_SEQ_HIGHEST_TIMESTAMP,
741                 LDB_SEQ_NEXT
742         } type;
743         uint64_t seq_num;
744         uint32_t flags;
745 };
746
747 typedef int (*ldb_request_callback_t)(struct ldb_context *, void *, struct ldb_reply *);
748 struct ldb_request {
749
750         enum ldb_request_type operation;
751
752         union {
753                 struct ldb_search search;
754                 struct ldb_add    add;
755                 struct ldb_modify mod;
756                 struct ldb_delete del;
757                 struct ldb_rename rename;
758                 struct ldb_register_control reg_control;
759                 struct ldb_register_partition reg_partition;
760                 struct ldb_sequence_number seq_num;
761         } op;
762
763         struct ldb_control **controls;
764
765         void *context;
766         ldb_request_callback_t callback;
767
768         int timeout;
769         time_t starttime;
770         struct ldb_handle *handle;
771 };
772
773 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
774
775 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
776
777 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
778 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
779 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
780
781 /**
782   Initialise ldbs' global information
783
784   This is required before any other LDB call
785
786   \return 0 if initialisation succeeded, -1 otherwise
787 */
788 int ldb_global_init(void);
789
790 /**
791   Initialise an ldb context
792
793   This is required before any other LDB call.
794
795   \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
796   no suitable context available.
797
798   \return pointer to ldb_context that should be free'd (using talloc_free())
799   at the end of the program.
800 */
801 struct ldb_context *ldb_init(void *mem_ctx);
802
803 /**
804    Connect to a database.
805
806    This is typically called soon after ldb_init(), and is required prior to
807    any search or database modification operations.
808
809    The URL can be one of the following forms:
810     - tdb://path
811     - ldapi://path
812     - ldap://host
813     - sqlite://path
814
815    \param ldb the context associated with the database (from ldb_init())
816    \param url the URL of the database to connect to, as noted above
817    \param flags a combination of LDB_FLG_* to modify the connection behaviour
818    \param options backend specific options - passed uninterpreted to the backend
819
820    \return result code (LDB_SUCCESS on success, or a failure code)
821
822    \note It is an error to connect to a database that does not exist in readonly mode
823    (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
824    created if it does not exist.
825 */
826 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
827
828 /*
829   return an automatic baseDN from the defaultNamingContext of the rootDSE
830   This value have been set in an opaque pointer at connection time
831 */
832 const struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
833
834
835 /**
836   The Default iasync search callback function 
837
838   \param ldb the context associated with the database (from ldb_init())
839   \param context the callback context
840   \param ares a single reply from the async core
841
842   \return result code (LDB_SUCCESS on success, or a failure code)
843
844   \note this function expects the context to always be an struct ldb_result pointer
845   AND a talloc context, this function will steal on the context each message
846   from the ares reply passed on by the async core so that in the end all the
847   messages will be in the context (ldb_result)  memory tree.
848   Freeing the passed context (ldb_result tree) will free all the resources
849   (the request need to be freed separately and the result doe not depend on the
850   request that can be freed as sson as the search request is finished)
851 */
852
853 int ldb_search_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares);
854
855 /**
856   Helper function to build a search request
857
858   \param ret_req the request structure is returned here (talloced on mem_ctx)
859   \param ldb the context associated with the database (from ldb_init())
860   \param mem_ctx a talloc emmory context (used as parent of ret_req)
861   \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
862   \param scope the search scope for the query
863   \param expression the search expression to use for this query
864   \param attrs the search attributes for the query (pass NULL if none required)
865   \param controls an array of controls
866   \param context the callback function context
867   \param the callback function to handle the async replies
868
869   \return result code (LDB_SUCCESS on success, or a failure code)
870 */
871
872 int ldb_build_search_req(struct ldb_request **ret_req,
873                         struct ldb_context *ldb,
874                         void *mem_ctx,
875                         const struct ldb_dn *base,
876                         enum ldb_scope scope,
877                         const char *expression,
878                         const char * const *attrs,
879                         struct ldb_control **controls,
880                         void *context,
881                         ldb_request_callback_t callback);
882
883 /**
884   Helper function to build an add request
885
886   \param ret_req the request structure is returned here (talloced on mem_ctx)
887   \param ldb the context associated with the database (from ldb_init())
888   \param mem_ctx a talloc emmory context (used as parent of ret_req)
889   \param message contains the entry to be added 
890   \param controls an array of controls
891   \param context the callback function context
892   \param the callback function to handle the async replies
893
894   \return result code (LDB_SUCCESS on success, or a failure code)
895 */
896
897 int ldb_build_add_req(struct ldb_request **ret_req,
898                         struct ldb_context *ldb,
899                         void *mem_ctx,
900                         const struct ldb_message *message,
901                         struct ldb_control **controls,
902                         void *context,
903                         ldb_request_callback_t callback);
904
905 /**
906   Helper function to build a modify request
907
908   \param ret_req the request structure is returned here (talloced on mem_ctx)
909   \param ldb the context associated with the database (from ldb_init())
910   \param mem_ctx a talloc emmory context (used as parent of ret_req)
911   \param message contains the entry to be modified
912   \param controls an array of controls
913   \param context the callback function context
914   \param the callback function to handle the async replies
915
916   \return result code (LDB_SUCCESS on success, or a failure code)
917 */
918
919 int ldb_build_mod_req(struct ldb_request **ret_req,
920                         struct ldb_context *ldb,
921                         void *mem_ctx,
922                         const struct ldb_message *message,
923                         struct ldb_control **controls,
924                         void *context,
925                         ldb_request_callback_t callback);
926
927 /**
928   Helper function to build a delete request
929
930   \param ret_req the request structure is returned here (talloced on mem_ctx)
931   \param ldb the context associated with the database (from ldb_init())
932   \param mem_ctx a talloc emmory context (used as parent of ret_req)
933   \param dn the DN to be deleted
934   \param controls an array of controls
935   \param context the callback function context
936   \param the callback function to handle the async replies
937
938   \return result code (LDB_SUCCESS on success, or a failure code)
939 */
940
941 int ldb_build_del_req(struct ldb_request **ret_req,
942                         struct ldb_context *ldb,
943                         void *mem_ctx,
944                         const struct ldb_dn *dn,
945                         struct ldb_control **controls,
946                         void *context,
947                         ldb_request_callback_t callback);
948
949 /**
950   Helper function to build a rename request
951
952   \param ret_req the request structure is returned here (talloced on mem_ctx)
953   \param ldb the context associated with the database (from ldb_init())
954   \param mem_ctx a talloc emmory context (used as parent of ret_req)
955   \param olddn the old DN
956   \param newdn the new DN
957   \param controls an array of controls
958   \param context the callback function context
959   \param the callback function to handle the async replies
960
961   \return result code (LDB_SUCCESS on success, or a failure code)
962 */
963
964 int ldb_build_rename_req(struct ldb_request **ret_req,
965                         struct ldb_context *ldb,
966                         void *mem_ctx,
967                         const struct ldb_dn *olddn,
968                         const struct ldb_dn *newdn,
969                         struct ldb_control **controls,
970                         void *context,
971                         ldb_request_callback_t callback);
972
973 /**
974   Search the database
975
976   This function searches the database, and returns 
977   records that match an LDAP-like search expression
978
979   \param ldb the context associated with the database (from ldb_init())
980   \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
981   \param scope the search scope for the query
982   \param expression the search expression to use for this query
983   \param attrs the search attributes for the query (pass NULL if none required)
984   \param res the return result
985
986   \return result code (LDB_SUCCESS on success, or a failure code)
987
988   \note use talloc_free() to free the ldb_result returned
989 */
990 int ldb_search(struct ldb_context *ldb, 
991                const struct ldb_dn *base,
992                enum ldb_scope scope,
993                const char *expression,
994                const char * const *attrs, struct ldb_result **_res);
995
996 /*
997  * a useful search function where you can easily define the expression and
998  * that takes a memory context where results are allocated
999 */
1000
1001 int ldb_search_exp_fmt(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1002                        struct ldb_result **result, struct ldb_dn *base,
1003                        enum ldb_scope scope, const char * const *attrs,
1004                        const char *exp_fmt, ...);
1005
1006 /*
1007   like ldb_search() but takes a parse tree
1008 */
1009 int ldb_search_bytree(struct ldb_context *ldb, 
1010                       const struct ldb_dn *base,
1011                       enum ldb_scope scope,
1012                       struct ldb_parse_tree *tree,
1013                       const char * const *attrs, struct ldb_result **res);
1014
1015 /**
1016   Add a record to the database.
1017
1018   This function adds a record to the database. This function will fail
1019   if a record with the specified class and key already exists in the
1020   database. 
1021
1022   \param ldb the context associated with the database (from
1023   ldb_init())
1024   \param message the message containing the record to add.
1025
1026   \return result code (LDB_SUCCESS if the record was added, otherwise
1027   a failure code)
1028 */
1029 int ldb_add(struct ldb_context *ldb, 
1030             const struct ldb_message *message);
1031
1032 /**
1033   Modify the specified attributes of a record
1034
1035   This function modifies a record that is in the database.
1036
1037   \param ldb the context associated with the database (from
1038   ldb_init())
1039   \param message the message containing the changes required.
1040
1041   \return result code (LDB_SUCCESS if the record was modified as
1042   requested, otherwise a failure code)
1043 */
1044 int ldb_modify(struct ldb_context *ldb, 
1045                const struct ldb_message *message);
1046
1047 /**
1048   Rename a record in the database
1049
1050   This function renames a record in the database.
1051
1052   \param ldb the context associated with the database (from
1053   ldb_init())
1054   \param olddn the DN for the record to be renamed.
1055   \param newdn the new DN 
1056
1057   \return result code (LDB_SUCCESS if the record was renamed as
1058   requested, otherwise a failure code)
1059 */
1060 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);
1061
1062 /**
1063   Delete a record from the database
1064
1065   This function deletes a record from the database.
1066
1067   \param ldb the context associated with the database (from
1068   ldb_init())
1069   \param dn the DN for the record to be deleted.
1070
1071   \return result code (LDB_SUCCESS if the record was deleted,
1072   otherwise a failure code)
1073 */
1074 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);
1075
1076 /**
1077   start a transaction
1078 */
1079 int ldb_transaction_start(struct ldb_context *ldb);
1080
1081 /**
1082   commit a transaction
1083 */
1084 int ldb_transaction_commit(struct ldb_context *ldb);
1085
1086 /**
1087   cancel a transaction
1088 */
1089 int ldb_transaction_cancel(struct ldb_context *ldb);
1090
1091
1092 /**
1093   return extended error information from the last call
1094 */
1095 const char *ldb_errstring(struct ldb_context *ldb);
1096
1097 /**
1098   return a string explaining what a ldb error constant meancs
1099 */
1100 const char *ldb_strerror(int ldb_err);
1101
1102 /**
1103   setup the default utf8 functions
1104   FIXME: these functions do not yet handle utf8
1105 */
1106 void ldb_set_utf8_default(struct ldb_context *ldb);
1107
1108 /**
1109    Casefold a string
1110
1111    \param ldb the ldb context
1112    \param mem_ctx the memory context to allocate the result string
1113    memory from. 
1114    \param s the string that is to be folded
1115    \return a copy of the string, converted to upper case
1116
1117    \note The default function is not yet UTF8 aware. Provide your own
1118          set of functions through ldb_set_utf8_fns()
1119 */
1120 char *ldb_casefold(struct ldb_context *ldb, void *mem_ctx, const char *s);
1121
1122 /**
1123    Check the attribute name is valid according to rfc2251
1124    \param s tthe string to check
1125
1126    \return 1 if the name is ok
1127 */
1128 int ldb_valid_attr_name(const char *s);
1129
1130 /*
1131   ldif manipulation functions
1132 */
1133 /**
1134    Write an LDIF message
1135
1136    This function writes an LDIF message using a caller supplied  write
1137    function.
1138
1139    \param ldb the ldb context (from ldb_init())
1140    \param fprintf_fn a function pointer for the write function. This must take
1141    a private data pointer, followed by a format string, and then a variable argument
1142    list. 
1143    \param private_data pointer that will be provided back to the write
1144    function. This is useful for maintaining state or context.
1145    \param ldif the message to write out
1146
1147    \return the total number of bytes written, or an error code as returned
1148    from the write function.
1149
1150    \sa ldb_ldif_write_file for a more convenient way to write to a
1151    file stream.
1152
1153    \sa ldb_ldif_read for the reader equivalent to this function.
1154 */
1155 int ldb_ldif_write(struct ldb_context *ldb,
1156                    int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3), 
1157                    void *private_data,
1158                    const struct ldb_ldif *ldif);
1159
1160 /**
1161    Clean up an LDIF message
1162
1163    This function cleans up a LDIF message read using ldb_ldif_read()
1164    or related functions (such as ldb_ldif_read_string() and
1165    ldb_ldif_read_file().
1166
1167    \param ldb the ldb context (from ldb_init())
1168    \param msg the message to clean up and free
1169
1170 */
1171 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1172
1173 /**
1174    Read an LDIF message
1175
1176    This function creates an LDIF message using a caller supplied read
1177    function. 
1178
1179    \param ldb the ldb context (from ldb_init())
1180    \param fgetc_fn a function pointer for the read function. This must
1181    take a private data pointer, and must return a pointer to an
1182    integer corresponding to the next byte read (or EOF if there is no
1183    more data to be read).
1184    \param private_data pointer that will be provided back to the read
1185    function. This is udeful for maintaining state or context.
1186
1187    \return the LDIF message that has been read in
1188
1189    \note You must free the LDIF message when no longer required, using
1190    ldb_ldif_read_free().
1191
1192    \sa ldb_ldif_read_file for a more convenient way to read from a
1193    file stream.
1194
1195    \sa ldb_ldif_read_string for a more convenient way to read from a
1196    string (char array).
1197
1198    \sa ldb_ldif_write for the writer equivalent to this function.
1199 */
1200 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb, 
1201                                int (*fgetc_fn)(void *), void *private_data);
1202
1203 /**
1204    Read an LDIF message from a file
1205
1206    This function reads the next LDIF message from the contents of a
1207    file stream. If you want to get all of the LDIF messages, you will
1208    need to repeatedly call this function, until it returns NULL.
1209
1210    \param ldb the ldb context (from ldb_init())
1211    \param f the file stream to read from (typically from fdopen())
1212
1213    \sa ldb_ldif_read_string for an equivalent function that will read
1214    from a string (char array).
1215
1216    \sa ldb_ldif_write_file for the writer equivalent to this function.
1217
1218 */
1219 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1220
1221 /**
1222    Read an LDIF message from a string
1223
1224    This function reads the next LDIF message from the contents of a char
1225    array. If you want to get all of the LDIF messages, you will need
1226    to repeatedly call this function, until it returns NULL.
1227
1228    \param ldb the ldb context (from ldb_init())
1229    \param s pointer to the char array to read from
1230
1231    \sa ldb_ldif_read_file for an equivalent function that will read
1232    from a file stream.
1233
1234    \sa ldb_ldif_write for a more general (arbitrary read function)
1235    version of this function.
1236 */
1237 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1238
1239 /**
1240    Write an LDIF message to a file
1241
1242    \param ldb the ldb context (from ldb_init())
1243    \param f the file stream to write to (typically from fdopen())
1244    \param msg the message to write out
1245
1246    \return the total number of bytes written, or a negative error code
1247
1248    \sa ldb_ldif_read_file for the reader equivalent to this function.
1249 */
1250 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1251
1252 /**
1253    Base64 encode a buffer
1254
1255    \param mem_ctx the memory context that the result is allocated
1256    from. 
1257    \param buf pointer to the array that is to be encoded
1258    \param len the number of elements in the array to be encoded
1259
1260    \return pointer to an array containing the encoded data
1261
1262    \note The caller is responsible for freeing the result
1263 */
1264 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
1265
1266 /**
1267    Base64 decode a buffer
1268
1269    This function decodes a base64 encoded string in place.
1270
1271    \param s the string to decode.
1272
1273    \return the length of the returned (decoded) string.
1274
1275    \note the string is null terminated, but the null terminator is not
1276    included in the length.
1277 */
1278 int ldb_base64_decode(char *s);
1279
1280 int ldb_attrib_add_handlers(struct ldb_context *ldb, 
1281                             const struct ldb_attrib_handler *handlers, 
1282                             unsigned num_handlers);
1283
1284 /* The following definitions come from lib/ldb/common/ldb_dn.c  */
1285
1286 int ldb_dn_is_special(const struct ldb_dn *dn);
1287 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check);
1288 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
1289 struct ldb_dn *ldb_dn_new(void *mem_ctx);
1290 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);
1291 struct ldb_dn *ldb_dn_explode_or_special(void *mem_ctx, const char *dn);
1292 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn);
1293 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, void *mem_ctx, const struct ldb_dn *edn);
1294 int ldb_dn_compare_base(struct ldb_context *ldb, const struct ldb_dn *base, const struct ldb_dn *dn);
1295 int ldb_dn_compare(struct ldb_context *ldb, const struct ldb_dn *edn0, const struct ldb_dn *edn1);
1296 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, void *mem_ctx, const struct ldb_dn *edn);
1297 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, void *mem_ctx, const char *dn);
1298 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el);
1299 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn);
1300 struct ldb_dn *ldb_dn_copy_rebase(void *mem_ctx, const struct ldb_dn *old, const struct ldb_dn *old_base, const struct ldb_dn *new_base);
1301 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn);
1302 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
1303                                                                const char *val);
1304 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
1305                                                  const char * value,
1306                                                  const struct ldb_dn *base);
1307 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2);
1308 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1309 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn);
1310 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn);
1311 int ldb_dn_get_comp_num(const struct ldb_dn *dn);
1312 const char *ldb_dn_get_component_name(const struct ldb_dn *dn, unsigned int num);
1313 const struct ldb_val *ldb_dn_get_component_val(const struct ldb_dn *dn, unsigned int num);
1314 const char *ldb_dn_get_rdn_name(const struct ldb_dn *dn);
1315 const struct ldb_val *ldb_dn_get_rdn_val(const struct ldb_dn *dn);
1316 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1317
1318
1319
1320 /* useful functions for ldb_message structure manipulation */
1321 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
1322
1323 /**
1324    Compare two attributes
1325
1326    This function compares to attribute names. Note that this is a
1327    case-insensitive comparison.
1328
1329    \param attr1 the first attribute name to compare
1330    \param attr2 the second attribute name to compare
1331
1332    \return 0 if the attribute names are the same, or only differ in
1333    case; non-zero if there are any differences
1334 */
1335 int ldb_attr_cmp(const char *attr1, const char *attr2);
1336 char *ldb_attr_casefold(void *mem_ctx, const char *s);
1337 int ldb_attr_dn(const char *attr);
1338
1339 /**
1340    Create an empty message
1341
1342    \param mem_ctx the memory context to create in. You can pass NULL
1343    to get the top level context, however the ldb context (from
1344    ldb_init()) may be a better choice
1345 */
1346 struct ldb_message *ldb_msg_new(void *mem_ctx);
1347
1348 /**
1349    Find an element within an message
1350 */
1351 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg, 
1352                                                  const char *attr_name);
1353
1354 /**
1355    Compare two ldb_val values
1356
1357    \param v1 first ldb_val structure to be tested
1358    \param v2 second ldb_val structure to be tested
1359
1360    \return 1 for a match, 0 if there is any difference
1361 */
1362 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1363
1364 /**
1365    find a value within an ldb_message_element
1366
1367    \param el the element to search
1368    \param val the value to search for
1369
1370    \note This search is case sensitive
1371 */
1372 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el, 
1373                                  struct ldb_val *val);
1374
1375 /**
1376    add a new empty element to a ldb_message
1377 */
1378 int ldb_msg_add_empty(struct ldb_message *msg,
1379                 const char *attr_name,
1380                 int flags,
1381                 struct ldb_message_element **return_el);
1382
1383 /**
1384    add a element to a ldb_message
1385 */
1386 int ldb_msg_add(struct ldb_message *msg, 
1387                 const struct ldb_message_element *el, 
1388                 int flags);
1389 int ldb_msg_add_value(struct ldb_message *msg, 
1390                 const char *attr_name,
1391                 const struct ldb_val *val,
1392                 struct ldb_message_element **return_el);
1393 int ldb_msg_add_steal_value(struct ldb_message *msg, 
1394                       const char *attr_name,
1395                       struct ldb_val *val);
1396 int ldb_msg_add_steal_string(struct ldb_message *msg, 
1397                              const char *attr_name, char *str);
1398 int ldb_msg_add_string(struct ldb_message *msg, 
1399                        const char *attr_name, const char *str);
1400 int ldb_msg_add_fmt(struct ldb_message *msg, 
1401                     const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1402
1403 /**
1404    compare two message elements - return 0 on match
1405 */
1406 int ldb_msg_element_compare(struct ldb_message_element *el1, 
1407                             struct ldb_message_element *el2);
1408
1409 /**
1410    Find elements in a message.
1411
1412    This function finds elements and converts to a specific type, with
1413    a give default value if not found. Assumes that elements are
1414    single valued.
1415 */
1416 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1417 int ldb_msg_find_attr_as_int(const struct ldb_message *msg, 
1418                              const char *attr_name,
1419                              int default_value);
1420 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg, 
1421                                        const char *attr_name,
1422                                        unsigned int default_value);
1423 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg, 
1424                                    const char *attr_name,
1425                                    int64_t default_value);
1426 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg, 
1427                                      const char *attr_name,
1428                                      uint64_t default_value);
1429 double ldb_msg_find_attr_as_double(const struct ldb_message *msg, 
1430                                    const char *attr_name,
1431                                    double default_value);
1432 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg, 
1433                               const char *attr_name,
1434                               int default_value);
1435 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg, 
1436                                         const char *attr_name,
1437                                         const char *default_value);
1438
1439 struct ldb_dn *ldb_msg_find_attr_as_dn(void *mem_ctx,
1440                                        const struct ldb_message *msg,
1441                                         const char *attr_name);
1442
1443 void ldb_msg_sort_elements(struct ldb_message *msg);
1444
1445 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx, 
1446                                          const struct ldb_message *msg);
1447 struct ldb_message *ldb_msg_copy(void *mem_ctx, 
1448                                  const struct ldb_message *msg);
1449
1450 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb, 
1451                                          const struct ldb_message *msg);
1452
1453
1454 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb, 
1455                                  struct ldb_message *msg1,
1456                                  struct ldb_message *msg2);
1457
1458 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1459                                    const char *name,
1460                                    const char *value);
1461
1462 /**
1463    Integrity check an ldb_message
1464
1465    This function performs basic sanity / integrity checks on an
1466    ldb_message.
1467
1468    \param msg the message to check
1469
1470    \return LDB_SUCCESS if the message is OK, or a non-zero error code
1471    (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1472    LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1473    message.
1474 */
1475 int ldb_msg_sanity_check(struct ldb_context *ldb,
1476                          const struct ldb_message *msg);
1477
1478 /**
1479    Duplicate an ldb_val structure
1480
1481    This function copies an ldb value structure. 
1482
1483    \param mem_ctx the memory context that the duplicated value will be
1484    allocated from
1485    \param v the ldb_val to be duplicated.
1486
1487    \return the duplicated ldb_val structure.
1488 */
1489 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
1490
1491 /**
1492   this allows the user to set a debug function for error reporting
1493 */
1494 int ldb_set_debug(struct ldb_context *ldb,
1495                   void (*debug)(void *context, enum ldb_debug_level level, 
1496                                 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1497                   void *context);
1498
1499 /**
1500   this allows the user to set custom utf8 function for error reporting
1501 */
1502 void ldb_set_utf8_fns(struct ldb_context *ldb,
1503                         void *context,
1504                         char *(*casefold)(void *, void *, const char *));
1505
1506 /**
1507    this sets up debug to print messages on stderr
1508 */
1509 int ldb_set_debug_stderr(struct ldb_context *ldb);
1510
1511 /* control backend specific opaque values */
1512 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1513 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1514
1515 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
1516                                                     const char *attrib);
1517
1518
1519 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
1520 const char **ldb_attr_list_copy_add(void *mem_ctx, const char * const *attrs, const char *new_attr);
1521 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1522
1523
1524 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree, 
1525                                  const char *attr, 
1526                                  const char *replace);
1527
1528 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1529 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1530 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1531
1532 /**
1533    Convert a time structure to a string
1534
1535    This function converts a time_t structure to an LDAP formatted time
1536    string.
1537
1538    \param mem_ctx the memory context to allocate the return string in
1539    \param t the time structure to convert
1540
1541    \return the formatted string, or NULL if the time structure could
1542    not be converted
1543 */
1544 char *ldb_timestring(void *mem_ctx, time_t t);
1545
1546 /**
1547    Convert a string to a time structure
1548
1549    This function converts an LDAP formatted time string to a time_t
1550    structure.
1551
1552    \param s the string to convert
1553
1554    \return the time structure, or 0 if the string cannot be converted
1555 */
1556 time_t ldb_string_to_time(const char *s);
1557
1558
1559 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1560 #endif