Merge branch 'master' of git://git.samba.org/samba
[sfrench/samba-autobuild/.git] / source4 / 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 #include <stdbool.h>
50 #include "talloc.h"
51 #include "tevent.h"
52 #include "ldb_errors.h"
53
54 /*
55   major restrictions as compared to normal LDAP:
56
57      - each record must have a unique key field
58      - the key must be representable as a NULL terminated C string and may not 
59        contain a comma or braces
60
61   major restrictions as compared to tdb:
62
63      - no explicit locking calls, but we have transactions when using ldb_tdb
64
65 */
66
67 #ifndef ldb_val
68 /**
69    Result value
70
71    An individual lump of data in a result comes in this format. The
72    pointer will usually be to a UTF-8 string if the application is
73    sensible, but it can be to anything you like, including binary data
74    blobs of arbitrary size.
75
76    \note the data is null (0x00) terminated, but the length does not
77    include the terminator. 
78 */
79 struct ldb_val {
80         uint8_t *data; /*!< result data */
81         size_t length; /*!< length of data */
82 };
83 #endif
84
85 /*! \cond DOXYGEN_IGNORE */
86 #ifndef PRINTF_ATTRIBUTE
87 #define PRINTF_ATTRIBUTE(a,b)
88 #endif
89 /*! \endcond */
90
91 /* opaque ldb_dn structures, see ldb_dn.c for internals */
92 struct ldb_dn_component;
93 struct ldb_dn;
94
95 /**
96  There are a number of flags that are used with ldap_modify() in
97  ldb_message_element.flags fields. The LDB_FLAGS_MOD_ADD,
98  LDB_FLAGS_MOD_DELETE and LDB_FLAGS_MOD_REPLACE flags are used in
99  ldap_modify() calls to specify whether attributes are being added,
100  deleted or modified respectively.
101 */
102 #define LDB_FLAG_MOD_MASK  0x3
103
104 /**
105    Flag value used in ldap_modify() to indicate that attributes are
106    being added.
107
108    \sa LDB_FLAG_MOD_MASK
109 */
110 #define LDB_FLAG_MOD_ADD     1
111
112 /**
113    Flag value used in ldap_modify() to indicate that attributes are
114    being replaced.
115
116    \sa LDB_FLAG_MOD_MASK
117 */
118 #define LDB_FLAG_MOD_REPLACE 2
119
120 /**
121    Flag value used in ldap_modify() to indicate that attributes are
122    being deleted.
123
124    \sa LDB_FLAG_MOD_MASK
125 */
126 #define LDB_FLAG_MOD_DELETE  3
127
128 /**
129   OID for logic AND comaprison.
130
131   This is the well known object ID for a logical AND comparitor.
132 */
133 #define LDB_OID_COMPARATOR_AND  "1.2.840.113556.1.4.803"
134
135 /**
136   OID for logic OR comparison.
137
138   This is the well known object ID for a logical OR comparitor.
139 */
140 #define LDB_OID_COMPARATOR_OR   "1.2.840.113556.1.4.804"
141
142 /**
143   results are given back as arrays of ldb_message_element
144 */
145 struct ldb_message_element {
146         unsigned int flags;
147         const char *name;
148         unsigned int num_values;
149         struct ldb_val *values;
150 };
151
152
153 /**
154   a ldb_message represents all or part of a record. It can contain an arbitrary
155   number of elements. 
156 */
157 struct ldb_message {
158         struct ldb_dn *dn;
159         unsigned int num_elements;
160         struct ldb_message_element *elements;
161 };
162
163 enum ldb_changetype {
164         LDB_CHANGETYPE_NONE=0,
165         LDB_CHANGETYPE_ADD,
166         LDB_CHANGETYPE_DELETE,
167         LDB_CHANGETYPE_MODIFY
168 };
169
170 /**
171   LDIF record
172
173   This structure contains a LDIF record, as returned from ldif_read()
174   and equivalent functions.
175 */
176 struct ldb_ldif {
177         enum ldb_changetype changetype; /*!< The type of change */
178         struct ldb_message *msg;  /*!< The changes */
179 };
180
181 enum ldb_scope {LDB_SCOPE_DEFAULT=-1, 
182                 LDB_SCOPE_BASE=0, 
183                 LDB_SCOPE_ONELEVEL=1,
184                 LDB_SCOPE_SUBTREE=2};
185
186 struct ldb_context;
187 struct tevent_context;
188
189 /* debugging uses one of the following levels */
190 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR, 
191                       LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
192
193 /**
194   the user can optionally supply a debug function. The function
195   is based on the vfprintf() style of interface, but with the addition
196   of a severity level
197 */
198 struct ldb_debug_ops {
199         void (*debug)(void *context, enum ldb_debug_level level, 
200                       const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
201         void *context;
202 };
203
204 /**
205   The user can optionally supply a custom utf8 functions,
206   to handle comparisons and casefolding.
207 */
208 struct ldb_utf8_fns {
209         void *context;
210         char *(*casefold)(void *context, TALLOC_CTX *mem_ctx, const char *s, size_t n);
211 };
212
213 /**
214    Flag value for database connection mode.
215
216    If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
217    opened read-only, if possible.
218 */
219 #define LDB_FLG_RDONLY 1
220
221 /**
222    Flag value for database connection mode.
223
224    If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
225    opened without synchronous operations, if possible.
226 */
227 #define LDB_FLG_NOSYNC 2
228
229 /**
230    Flag value to specify autoreconnect mode.
231
232    If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
233    be opened in a way that makes it try to auto reconnect if the
234    connection is dropped (actually make sense only with ldap).
235 */
236 #define LDB_FLG_RECONNECT 4
237
238 /**
239    Flag to tell backends not to use mmap
240 */
241 #define LDB_FLG_NOMMAP 8
242
243 /**
244    Flag to tell ldif handlers not to force encoding of binary
245    structures in base64   
246 */
247 #define LDB_FLG_SHOW_BINARY 16
248
249 /**
250    Flags to enable ldb tracing
251 */
252 #define LDB_FLG_ENABLE_TRACING 32
253
254 /*
255    structures for ldb_parse_tree handling code
256 */
257 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
258                     LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
259                     LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
260                     LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
261
262 struct ldb_parse_tree {
263         enum ldb_parse_op operation;
264         union {
265                 struct {
266                         struct ldb_parse_tree *child;
267                 } isnot;
268                 struct {
269                         const char *attr;
270                         struct ldb_val value;
271                 } equality;
272                 struct {
273                         const char *attr;
274                         int start_with_wildcard;
275                         int end_with_wildcard;
276                         struct ldb_val **chunks;
277                 } substring;
278                 struct {
279                         const char *attr;
280                 } present;
281                 struct {
282                         const char *attr;
283                         struct ldb_val value;
284                 } comparison;
285                 struct {
286                         const char *attr;
287                         int dnAttributes;
288                         char *rule_id;
289                         struct ldb_val value;
290                 } extended;
291                 struct {
292                         unsigned int num_elements;
293                         struct ldb_parse_tree **elements;
294                 } list;
295         } u;
296 };
297
298 struct ldb_parse_tree *ldb_parse_tree(TALLOC_CTX *mem_ctx, const char *s);
299 char *ldb_filter_from_tree(TALLOC_CTX *mem_ctx, struct ldb_parse_tree *tree);
300
301 /**
302    Encode a binary blob
303
304    This function encodes a binary blob using the encoding rules in RFC
305    2254 (Section 4). This function also escapes any non-printable
306    characters.
307
308    \param mem_ctx the memory context to allocate the return string in.
309    \param val the (potentially) binary data to be encoded
310
311    \return the encoded data as a null terminated string
312
313    \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
314 */
315 char *ldb_binary_encode(TALLOC_CTX *mem_ctx, struct ldb_val val);
316
317 /**
318    Encode a string
319
320    This function encodes a string using the encoding rules in RFC 2254
321    (Section 4). This function also escapes any non-printable
322    characters.
323
324    \param mem_ctx the memory context to allocate the return string in.
325    \param string the string to be encoded
326
327    \return the encoded data as a null terminated string
328
329    \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
330 */
331 char *ldb_binary_encode_string(TALLOC_CTX *mem_ctx, const char *string);
332
333 /*
334   functions for controlling attribute handling
335 */
336 typedef int (*ldb_attr_handler_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, struct ldb_val *);
337 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, const struct ldb_val *);
338
339 /*
340   attribute handler structure
341
342   attr                  -> The attribute name
343   ldif_read_fn          -> convert from ldif to binary format
344   ldif_write_fn         -> convert from binary to ldif format
345   canonicalise_fn       -> canonicalise a value, for use by indexing and dn construction
346   comparison_fn         -> compare two values
347 */
348
349 struct ldb_schema_syntax {
350         const char *name;
351         ldb_attr_handler_t ldif_read_fn;
352         ldb_attr_handler_t ldif_write_fn;
353         ldb_attr_handler_t canonicalise_fn;
354         ldb_attr_comparison_t comparison_fn;
355 };
356
357 struct ldb_schema_attribute {
358         const char *name;
359         unsigned flags;
360         const struct ldb_schema_syntax *syntax;
361 };
362
363 const struct ldb_schema_attribute *ldb_schema_attribute_by_name(struct ldb_context *ldb,
364                                                                 const char *name);
365
366 struct ldb_dn_extended_syntax {
367         const char *name;
368         ldb_attr_handler_t read_fn;
369         ldb_attr_handler_t write_clear_fn;
370         ldb_attr_handler_t write_hex_fn;
371 };
372
373 const struct ldb_dn_extended_syntax *ldb_dn_extended_syntax_by_name(struct ldb_context *ldb,
374                                                                     const char *name);
375
376 /**
377    The attribute is not returned by default
378 */
379 #define LDB_ATTR_FLAG_HIDDEN       (1<<0) 
380
381 /* the attribute handler name should be freed when released */
382 #define LDB_ATTR_FLAG_ALLOCATED    (1<<1) 
383
384 /**
385    The attribute is supplied by the application and should not be removed
386 */
387 #define LDB_ATTR_FLAG_FIXED        (1<<2) 
388
389 /*
390   when this is set, attempts to create two records which have the same
391   value for this attribute will return LDB_ERR_ENTRY_ALREADY_EXISTS
392  */
393 #define LDB_ATTR_FLAG_UNIQUE_INDEX (1<<3)
394
395 /**
396   LDAP attribute syntax for a DN
397
398   This is the well-known LDAP attribute syntax for a DN.
399
400   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
401 */
402 #define LDB_SYNTAX_DN                   "1.3.6.1.4.1.1466.115.121.1.12"
403
404 /**
405   LDAP attribute syntax for a Directory String
406
407   This is the well-known LDAP attribute syntax for a Directory String.
408
409   \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
410 */
411 #define LDB_SYNTAX_DIRECTORY_STRING     "1.3.6.1.4.1.1466.115.121.1.15"
412
413 /**
414   LDAP attribute syntax for an integer
415
416   This is the well-known LDAP attribute syntax for an integer.
417
418   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
419 */
420 #define LDB_SYNTAX_INTEGER              "1.3.6.1.4.1.1466.115.121.1.27"
421
422 /**
423   LDAP attribute syntax for a boolean
424
425   This is the well-known LDAP attribute syntax for a boolean.
426
427   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
428 */
429 #define LDB_SYNTAX_BOOLEAN              "1.3.6.1.4.1.1466.115.121.1.7"
430
431 /**
432   LDAP attribute syntax for an octet string
433
434   This is the well-known LDAP attribute syntax for an octet string.
435
436   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
437 */
438 #define LDB_SYNTAX_OCTET_STRING         "1.3.6.1.4.1.1466.115.121.1.40"
439
440 /**
441   LDAP attribute syntax for UTC time.
442
443   This is the well-known LDAP attribute syntax for a UTC time.
444
445   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2 
446 */
447 #define LDB_SYNTAX_UTC_TIME             "1.3.6.1.4.1.1466.115.121.1.53"
448
449 #define LDB_SYNTAX_OBJECTCLASS          "LDB_SYNTAX_OBJECTCLASS"
450
451 /* sorting helpers */
452 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
453
454 /**
455    OID for the paged results control. This control is included in the
456    searchRequest and searchResultDone messages as part of the controls
457    field of the LDAPMessage, as defined in Section 4.1.12 of
458    LDAP v3. 
459
460    \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
461 */
462 #define LDB_CONTROL_PAGED_RESULTS_OID   "1.2.840.113556.1.4.319"
463
464 /**
465    OID for specifying the returned elements of the ntSecurityDescriptor
466
467    \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>
468 */
469 #define LDB_CONTROL_SD_FLAGS_OID        "1.2.840.113556.1.4.801"
470
471 /**
472    OID for specifying an advanced scope for the search (one partition)
473
474    \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>
475 */
476 #define LDB_CONTROL_DOMAIN_SCOPE_OID    "1.2.840.113556.1.4.1339"
477
478 /**
479    OID for specifying an advanced scope for a search
480
481    \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>
482 */
483 #define LDB_CONTROL_SEARCH_OPTIONS_OID  "1.2.840.113556.1.4.1340"
484
485 /**
486    OID for notification
487
488    \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>
489 */
490 #define LDB_CONTROL_NOTIFICATION_OID    "1.2.840.113556.1.4.528"
491
492 /**
493    OID for getting deleted objects
494
495    \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>
496 */
497 #define LDB_CONTROL_SHOW_DELETED_OID    "1.2.840.113556.1.4.417"
498
499 /**
500    OID for getting recycled objects
501
502    \sa <a href="http://msdn.microsoft.com/en-us/library/dd304621(PROT.13).aspx">Microsoft documentation of this OID</a>
503 */
504 #define LDB_CONTROL_SHOW_RECYCLED_OID         "1.2.840.113556.1.4.2064"
505
506 /**
507    OID for getting deactivated linked attributes
508
509    \sa <a href="http://msdn.microsoft.com/en-us/library/dd302781(PROT.13).aspx">Microsoft documentation of this OID</a>
510 */
511 #define LDB_CONTROL_SHOW_DEACTIVATED_LINK_OID "1.2.840.113556.1.4.2065"
512
513 /**
514    OID for extended DN
515
516    \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>
517 */
518 #define LDB_CONTROL_EXTENDED_DN_OID     "1.2.840.113556.1.4.529"
519
520 /**
521    OID for LDAP server sort result extension.
522
523    This control is included in the searchRequest message as part of
524    the controls field of the LDAPMessage, as defined in Section 4.1.12
525    of LDAP v3. The controlType is set to
526    "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
527    FALSE (where absent is also equivalent to FALSE) at the client's
528    option.
529
530    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
531 */
532 #define LDB_CONTROL_SERVER_SORT_OID     "1.2.840.113556.1.4.473"
533
534 /**
535    OID for LDAP server sort result response extension.
536
537    This control is included in the searchResultDone message as part of
538    the controls field of the LDAPMessage, as defined in Section 4.1.12 of
539    LDAP v3.
540
541    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
542 */
543 #define LDB_CONTROL_SORT_RESP_OID       "1.2.840.113556.1.4.474"
544
545 /**
546    OID for LDAP Attribute Scoped Query extension.
547
548    This control is included in SearchRequest or SearchResponse
549    messages as part of the controls field of the LDAPMessage.
550 */
551 #define LDB_CONTROL_ASQ_OID             "1.2.840.113556.1.4.1504"
552
553 /**
554    OID for LDAP Directory Sync extension. 
555
556    This control is included in SearchRequest or SearchResponse
557    messages as part of the controls field of the LDAPMessage.
558 */
559 #define LDB_CONTROL_DIRSYNC_OID         "1.2.840.113556.1.4.841"
560
561
562 /**
563    OID for LDAP Virtual List View Request extension.
564
565    This control is included in SearchRequest messages
566    as part of the controls field of the LDAPMessage.
567 */
568 #define LDB_CONTROL_VLV_REQ_OID         "2.16.840.1.113730.3.4.9"
569
570 /**
571    OID for LDAP Virtual List View Response extension.
572
573    This control is included in SearchResponse messages
574    as part of the controls field of the LDAPMessage.
575 */
576 #define LDB_CONTROL_VLV_RESP_OID        "2.16.840.1.113730.3.4.10"
577
578 /**
579    OID to let modifies don't give an error when adding an existing
580    attribute with the same value or deleting an nonexisting one attribute
581
582    \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>
583 */
584 #define LDB_CONTROL_PERMISSIVE_MODIFY_OID       "1.2.840.113556.1.4.1413"
585
586 /**
587    OID for LDAP Extended Operation START_TLS.
588
589    This Extended operation is used to start a new TLS
590    channel on top of a clear text channel.
591 */
592 #define LDB_EXTENDED_START_TLS_OID      "1.3.6.1.4.1.1466.20037"
593
594 /**
595 */
596 #define LDB_EXTENDED_DYNAMIC_OID        "1.3.6.1.4.1.1466.101.119.1"
597
598 /**
599 */
600 #define LDB_EXTENDED_FAST_BIND_OID      "1.2.840.113556.1.4.1781"
601
602 struct ldb_sd_flags_control {
603         /*
604          * request the owner    0x00000001
605          * request the group    0x00000002
606          * request the DACL     0x00000004
607          * request the SACL     0x00000008
608          */
609         unsigned secinfo_flags;
610 };
611
612 /*
613  * DOMAIN_SCOPE         0x00000001
614  * this limits the search to one partition,
615  * and no referrals will be returned.
616  * (Note this doesn't limit the entries by there
617  *  objectSid belonging to a domain! Builtin and Foreign Sids
618  *  are still returned)
619  *
620  * PHANTOM_ROOT         0x00000002
621  * this search on the whole tree on a domain controller
622  * over multiple partitions without referrals.
623  * (This is the default behavior on the Global Catalog Port)
624  */
625
626 #define LDB_SEARCH_OPTION_DOMAIN_SCOPE 0x00000001
627 #define LDB_SEARCH_OPTION_PHANTOM_ROOT 0x00000002
628
629 struct ldb_search_options_control {
630         unsigned search_options;
631 };
632
633 struct ldb_paged_control {
634         int size;
635         int cookie_len;
636         char *cookie;
637 };
638
639 struct ldb_extended_dn_control {
640         int type;
641 };
642
643 struct ldb_server_sort_control {
644         char *attributeName;
645         char *orderingRule;
646         int reverse;
647 };
648
649 struct ldb_sort_resp_control {
650         int result;
651         char *attr_desc;
652 };
653
654 struct ldb_asq_control {
655         int request;
656         char *source_attribute;
657         int src_attr_len;
658         int result;
659 };
660
661 struct ldb_dirsync_control {
662         int flags;
663         int max_attributes;
664         int cookie_len;
665         char *cookie;
666 };
667
668 struct ldb_vlv_req_control {
669         int beforeCount;
670         int afterCount;
671         int type;
672         union {
673                 struct {
674                         int offset;
675                         int contentCount;
676                 } byOffset;
677                 struct {
678                         int value_len;
679                         char *value;
680                 } gtOrEq;
681         } match;
682         int ctxid_len;
683         char *contextId;
684 };
685
686 struct ldb_vlv_resp_control {
687         int targetPosition;
688         int contentCount;
689         int vlv_result;
690         int ctxid_len;
691         char *contextId;
692 };
693
694 struct ldb_control {
695         const char *oid;
696         int critical;
697         void *data;
698 };
699
700 enum ldb_request_type {
701         LDB_SEARCH,
702         LDB_ADD,
703         LDB_MODIFY,
704         LDB_DELETE,
705         LDB_RENAME,
706         LDB_EXTENDED,
707         LDB_REQ_REGISTER_CONTROL,
708         LDB_REQ_REGISTER_PARTITION
709 };
710
711 enum ldb_reply_type {
712         LDB_REPLY_ENTRY,
713         LDB_REPLY_REFERRAL,
714         LDB_REPLY_DONE
715 };
716
717 enum ldb_wait_type {
718         LDB_WAIT_ALL,
719         LDB_WAIT_NONE
720 };
721
722 enum ldb_state {
723         LDB_ASYNC_INIT,
724         LDB_ASYNC_PENDING,
725         LDB_ASYNC_DONE
726 };
727
728 struct ldb_extended {
729         const char *oid;
730         void *data; /* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
731 };
732
733 #define LDB_EXTENDED_SEQUENCE_NUMBER    "1.3.6.1.4.1.7165.4.4.3"
734
735 enum ldb_sequence_type {
736         LDB_SEQ_HIGHEST_SEQ,
737         LDB_SEQ_HIGHEST_TIMESTAMP,
738         LDB_SEQ_NEXT
739 };
740
741 #define LDB_SEQ_GLOBAL_SEQUENCE    0x01
742 #define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
743
744 struct ldb_seqnum_request {
745         enum ldb_sequence_type type;
746 };
747
748 struct ldb_seqnum_result {
749         uint64_t seq_num;
750         uint32_t flags;
751 };
752
753 struct ldb_result {
754         unsigned int count;
755         struct ldb_message **msgs;
756         struct ldb_extended *extended;
757         struct ldb_control **controls;
758         char **refs;
759 };
760
761 struct ldb_reply {
762         int error;
763         enum ldb_reply_type type;
764         struct ldb_message *message;
765         struct ldb_extended *response;
766         struct ldb_control **controls;
767         char *referral;
768 };
769
770 struct ldb_request;
771 struct ldb_handle;
772
773 struct ldb_search {
774         struct ldb_dn *base;
775         enum ldb_scope scope;
776         struct ldb_parse_tree *tree;
777         const char * const *attrs;
778         struct ldb_result *res;
779 };
780
781 struct ldb_add {
782         const struct ldb_message *message;
783 };
784
785 struct ldb_modify {
786         const struct ldb_message *message;
787 };
788
789 struct ldb_delete {
790         struct ldb_dn *dn;
791 };
792
793 struct ldb_rename {
794         struct ldb_dn *olddn;
795         struct ldb_dn *newdn;
796 };
797
798 struct ldb_register_control {
799         const char *oid;
800 };
801
802 struct ldb_register_partition {
803         struct ldb_dn *dn;
804 };
805
806 typedef int (*ldb_request_callback_t)(struct ldb_request *, struct ldb_reply *);
807
808 struct ldb_request {
809
810         enum ldb_request_type operation;
811
812         union {
813                 struct ldb_search search;
814                 struct ldb_add    add;
815                 struct ldb_modify mod;
816                 struct ldb_delete del;
817                 struct ldb_rename rename;
818                 struct ldb_extended extended;
819                 struct ldb_register_control reg_control;
820                 struct ldb_register_partition reg_partition;
821         } op;
822
823         struct ldb_control **controls;
824
825         void *context;
826         ldb_request_callback_t callback;
827
828         int timeout;
829         time_t starttime;
830         struct ldb_handle *handle;
831 };
832
833 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
834 int ldb_request_done(struct ldb_request *req, int status);
835 bool ldb_request_is_done(struct ldb_request *req);
836
837 int ldb_modules_wait(struct ldb_handle *handle);
838 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
839
840 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
841 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
842 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
843 void ldb_set_modules_dir(struct ldb_context *ldb, const char *path);
844 struct tevent_context;
845 void ldb_set_event_context(struct ldb_context *ldb, struct tevent_context *ev);
846 struct tevent_context * ldb_get_event_context(struct ldb_context *ldb);
847
848 /**
849   Initialise ldbs' global information
850
851   This is required before any other LDB call
852
853   \return 0 if initialisation succeeded, -1 otherwise
854 */
855 int ldb_global_init(void);
856
857 /**
858   Initialise an ldb context
859
860   This is required before any other LDB call.
861
862   \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
863   no suitable context available.
864
865   \return pointer to ldb_context that should be free'd (using talloc_free())
866   at the end of the program.
867 */
868 struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev_ctx);
869
870 /**
871    Connect to a database.
872
873    This is typically called soon after ldb_init(), and is required prior to
874    any search or database modification operations.
875
876    The URL can be one of the following forms:
877     - tdb://path
878     - ldapi://path
879     - ldap://host
880     - sqlite://path
881
882    \param ldb the context associated with the database (from ldb_init())
883    \param url the URL of the database to connect to, as noted above
884    \param flags a combination of LDB_FLG_* to modify the connection behaviour
885    \param options backend specific options - passed uninterpreted to the backend
886
887    \return result code (LDB_SUCCESS on success, or a failure code)
888
889    \note It is an error to connect to a database that does not exist in readonly mode
890    (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
891    created if it does not exist.
892 */
893
894 typedef void (*ldb_async_timeout_fn) (void *);
895 typedef bool (*ldb_async_callback_fn) (void *);
896 typedef int (*ldb_async_ctx_add_op_fn)(void *, time_t, void *, ldb_async_timeout_fn, ldb_async_callback_fn);
897 typedef int (*ldb_async_ctx_wait_op_fn)(void *);
898
899 void ldb_async_ctx_set_private_data(struct ldb_context *ldb,
900                                         void *private_data);
901 void ldb_async_ctx_set_add_op(struct ldb_context *ldb,
902                                 ldb_async_ctx_add_op_fn add_op);
903 void ldb_async_ctx_set_wait_op(struct ldb_context *ldb,
904                                 ldb_async_ctx_wait_op_fn wait_op);
905
906 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
907
908 /*
909   return an automatic basedn from the rootDomainNamingContext of the rootDSE
910   This value have been set in an opaque pointer at connection time
911 */
912 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
913
914 /*
915   return an automatic basedn from the configurationNamingContext of the rootDSE
916   This value have been set in an opaque pointer at connection time
917 */
918 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
919
920 /*
921   return an automatic basedn from the schemaNamingContext of the rootDSE
922   This value have been set in an opaque pointer at connection time
923 */
924 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
925
926 /*
927   return an automatic baseDN from the defaultNamingContext of the rootDSE
928   This value have been set in an opaque pointer at connection time
929 */
930 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
931
932 /**
933   The default async search callback function 
934
935   \param req the request we are callback of
936   \param ares a single reply from the async core
937
938   \return result code (LDB_SUCCESS on success, or a failure code)
939
940   \note this function expects req->context to always be an struct ldb_result pointer
941   AND a talloc context, this function will steal on the context each message
942   from the ares reply passed on by the async core so that in the end all the
943   messages will be in the context (ldb_result)  memory tree.
944   Freeing the passed context (ldb_result tree) will free all the resources
945   (the request need to be freed separately and the result doe not depend on the
946   request that can be freed as sson as the search request is finished)
947 */
948
949 int ldb_search_default_callback(struct ldb_request *req, struct ldb_reply *ares);
950
951 /**
952   The default async extended operation callback function
953
954   \param req the request we are callback of
955   \param ares a single reply from the async core
956
957   \return result code (LDB_SUCCESS on success, or a failure code)
958 */
959 int ldb_op_default_callback(struct ldb_request *req, struct ldb_reply *ares);
960
961
962 /**
963   Helper function to build a search request
964
965   \param ret_req the request structure is returned here (talloced on mem_ctx)
966   \param ldb the context associated with the database (from ldb_init())
967   \param mem_ctx a talloc memory context (used as parent of ret_req)
968   \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
969   \param scope the search scope for the query
970   \param expression the search expression to use for this query
971   \param attrs the search attributes for the query (pass NULL if none required)
972   \param controls an array of controls
973   \param context the callback function context
974   \param the callback function to handle the async replies
975   \param the parent request if any
976
977   \return result code (LDB_SUCCESS on success, or a failure code)
978 */
979
980 int ldb_build_search_req(struct ldb_request **ret_req,
981                         struct ldb_context *ldb,
982                         TALLOC_CTX *mem_ctx,
983                         struct ldb_dn *base,
984                         enum ldb_scope scope,
985                         const char *expression,
986                         const char * const *attrs,
987                         struct ldb_control **controls,
988                         void *context,
989                         ldb_request_callback_t callback,
990                         struct ldb_request *parent);
991
992 int ldb_build_search_req_ex(struct ldb_request **ret_req,
993                         struct ldb_context *ldb,
994                         TALLOC_CTX *mem_ctx,
995                         struct ldb_dn *base,
996                         enum ldb_scope scope,
997                         struct ldb_parse_tree *tree,
998                         const char * const *attrs,
999                         struct ldb_control **controls,
1000                         void *context,
1001                         ldb_request_callback_t callback,
1002                         struct ldb_request *parent);
1003
1004 /**
1005   Helper function to build an add request
1006
1007   \param ret_req the request structure is returned here (talloced on mem_ctx)
1008   \param ldb the context associated with the database (from ldb_init())
1009   \param mem_ctx a talloc memory context (used as parent of ret_req)
1010   \param message contains the entry to be added 
1011   \param controls an array of controls
1012   \param context the callback function context
1013   \param the callback function to handle the async replies
1014   \param the parent request if any
1015
1016   \return result code (LDB_SUCCESS on success, or a failure code)
1017 */
1018
1019 int ldb_build_add_req(struct ldb_request **ret_req,
1020                         struct ldb_context *ldb,
1021                         TALLOC_CTX *mem_ctx,
1022                         const struct ldb_message *message,
1023                         struct ldb_control **controls,
1024                         void *context,
1025                         ldb_request_callback_t callback,
1026                         struct ldb_request *parent);
1027
1028 /**
1029   Helper function to build a modify request
1030
1031   \param ret_req the request structure is returned here (talloced on mem_ctx)
1032   \param ldb the context associated with the database (from ldb_init())
1033   \param mem_ctx a talloc memory context (used as parent of ret_req)
1034   \param message contains the entry to be modified
1035   \param controls an array of controls
1036   \param context the callback function context
1037   \param the callback function to handle the async replies
1038   \param the parent request if any
1039
1040   \return result code (LDB_SUCCESS on success, or a failure code)
1041 */
1042
1043 int ldb_build_mod_req(struct ldb_request **ret_req,
1044                         struct ldb_context *ldb,
1045                         TALLOC_CTX *mem_ctx,
1046                         const struct ldb_message *message,
1047                         struct ldb_control **controls,
1048                         void *context,
1049                         ldb_request_callback_t callback,
1050                         struct ldb_request *parent);
1051
1052 /**
1053   Helper function to build a delete request
1054
1055   \param ret_req the request structure is returned here (talloced on mem_ctx)
1056   \param ldb the context associated with the database (from ldb_init())
1057   \param mem_ctx a talloc memory context (used as parent of ret_req)
1058   \param dn the DN to be deleted
1059   \param controls an array of controls
1060   \param context the callback function context
1061   \param the callback function to handle the async replies
1062   \param the parent request if any
1063
1064   \return result code (LDB_SUCCESS on success, or a failure code)
1065 */
1066
1067 int ldb_build_del_req(struct ldb_request **ret_req,
1068                         struct ldb_context *ldb,
1069                         TALLOC_CTX *mem_ctx,
1070                         struct ldb_dn *dn,
1071                         struct ldb_control **controls,
1072                         void *context,
1073                         ldb_request_callback_t callback,
1074                         struct ldb_request *parent);
1075
1076 /**
1077   Helper function to build a rename request
1078
1079   \param ret_req the request structure is returned here (talloced on mem_ctx)
1080   \param ldb the context associated with the database (from ldb_init())
1081   \param mem_ctx a talloc memory context (used as parent of ret_req)
1082   \param olddn the old DN
1083   \param newdn the new DN
1084   \param controls an array of controls
1085   \param context the callback function context
1086   \param the callback function to handle the async replies
1087   \param the parent request if any
1088
1089   \return result code (LDB_SUCCESS on success, or a failure code)
1090 */
1091
1092 int ldb_build_rename_req(struct ldb_request **ret_req,
1093                         struct ldb_context *ldb,
1094                         TALLOC_CTX *mem_ctx,
1095                         struct ldb_dn *olddn,
1096                         struct ldb_dn *newdn,
1097                         struct ldb_control **controls,
1098                         void *context,
1099                         ldb_request_callback_t callback,
1100                         struct ldb_request *parent);
1101
1102 /**
1103   Add a ldb_control to a ldb_request
1104
1105   \param req the request struct where to add the control
1106   \param oid the object identifier of the control as string
1107   \param critical whether the control should be critical or not
1108   \param data a talloc pointer to the control specific data
1109
1110   \return result code (LDB_SUCCESS on success, or a failure code)
1111 */
1112 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1113
1114 /**
1115    check if a control with the specified "oid" exist and return it 
1116   \param req the request struct where to add the control
1117   \param oid the object identifier of the control as string
1118
1119   \return the control, NULL if not found 
1120 */
1121 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid);
1122
1123 /**
1124    check if a control with the specified "oid" exist and return it 
1125   \param rep the reply struct where to add the control
1126   \param oid the object identifier of the control as string
1127
1128   \return the control, NULL if not found 
1129 */
1130 struct ldb_control *ldb_reply_get_control(struct ldb_reply *rep, const char *oid);
1131
1132 /**
1133   Search the database
1134
1135   This function searches the database, and returns 
1136   records that match an LDAP-like search expression
1137
1138   \param ldb the context associated with the database (from ldb_init())
1139   \param mem_ctx the memory context to use for the request and the results
1140   \param result the return result
1141   \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1142   \param scope the search scope for the query
1143   \param attrs the search attributes for the query (pass NULL if none required)
1144   \param exp_fmt the search expression to use for this query (printf like)
1145
1146   \return result code (LDB_SUCCESS on success, or a failure code)
1147
1148   \note use talloc_free() to free the ldb_result returned
1149 */
1150 int ldb_search(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1151                struct ldb_result **result, struct ldb_dn *base,
1152                enum ldb_scope scope, const char * const *attrs,
1153                const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1154
1155 /**
1156   Add a record to the database.
1157
1158   This function adds a record to the database. This function will fail
1159   if a record with the specified class and key already exists in the
1160   database. 
1161
1162   \param ldb the context associated with the database (from
1163   ldb_init())
1164   \param message the message containing the record to add.
1165
1166   \return result code (LDB_SUCCESS if the record was added, otherwise
1167   a failure code)
1168 */
1169 int ldb_add(struct ldb_context *ldb, 
1170             const struct ldb_message *message);
1171
1172 /**
1173   Modify the specified attributes of a record
1174
1175   This function modifies a record that is in the database.
1176
1177   \param ldb the context associated with the database (from
1178   ldb_init())
1179   \param message the message containing the changes required.
1180
1181   \return result code (LDB_SUCCESS if the record was modified as
1182   requested, otherwise a failure code)
1183 */
1184 int ldb_modify(struct ldb_context *ldb, 
1185                const struct ldb_message *message);
1186
1187 /**
1188   Rename a record in the database
1189
1190   This function renames a record in the database.
1191
1192   \param ldb the context associated with the database (from
1193   ldb_init())
1194   \param olddn the DN for the record to be renamed.
1195   \param newdn the new DN 
1196
1197   \return result code (LDB_SUCCESS if the record was renamed as
1198   requested, otherwise a failure code)
1199 */
1200 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1201
1202 /**
1203   Delete a record from the database
1204
1205   This function deletes a record from the database.
1206
1207   \param ldb the context associated with the database (from
1208   ldb_init())
1209   \param dn the DN for the record to be deleted.
1210
1211   \return result code (LDB_SUCCESS if the record was deleted,
1212   otherwise a failure code)
1213 */
1214 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1215
1216 /**
1217   The default async extended operation callback function 
1218
1219   \param req the request we are callback of
1220   \param ares a single reply from the async core
1221
1222   \return result code (LDB_SUCCESS on success, or a failure code)
1223
1224   \note this function expects req->context to always be an struct ldb_result pointer
1225   AND a talloc context, this function will steal on the context each message
1226   from the ares reply passed on by the async core so that in the end all the
1227   messages will be in the context (ldb_result)  memory tree.
1228   Freeing the passed context (ldb_result tree) will free all the resources
1229   (the request need to be freed separately and the result doe not depend on the
1230   request that can be freed as sson as the search request is finished)
1231 */
1232
1233 int ldb_extended_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1234
1235
1236 /**
1237   Helper function to build a extended request
1238
1239   \param ret_req the request structure is returned here (talloced on mem_ctx)
1240   \param ldb the context associated with the database (from ldb_init())
1241   \param mem_ctx a talloc memory context (used as parent of ret_req)
1242   \param oid the OID of the extended operation.
1243   \param data a void pointer a the extended operation specific parameters,
1244   it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it  
1245   \param controls an array of controls
1246   \param context the callback function context
1247   \param the callback function to handle the async replies
1248   \param the parent request if any
1249
1250   \return result code (LDB_SUCCESS on success, or a failure code)
1251 */
1252 int ldb_build_extended_req(struct ldb_request **ret_req,
1253                            struct ldb_context *ldb,
1254                            TALLOC_CTX *mem_ctx,
1255                            const char *oid,
1256                            void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1257                            struct ldb_control **controls,
1258                            void *context,
1259                            ldb_request_callback_t callback,
1260                            struct ldb_request *parent);
1261
1262 /**
1263   call an extended operation
1264
1265   This function deletes a record from the database.
1266
1267   \param ldb the context associated with the database (from ldb_init())
1268   \param oid the OID of the extended operation.
1269   \param data a void pointer a the extended operation specific parameters,
1270   it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it  
1271   \param res the result of the extended operation
1272
1273   \return result code (LDB_SUCCESS if the extended operation returned fine,
1274   otherwise a failure code)
1275 */
1276 int ldb_extended(struct ldb_context *ldb, 
1277                  const char *oid,
1278                  void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1279                  struct ldb_result **res);
1280
1281 /**
1282   Obtain current/next database sequence number
1283 */
1284 int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num);
1285
1286 /**
1287   start a transaction
1288 */
1289 int ldb_transaction_start(struct ldb_context *ldb);
1290
1291 /**
1292    first phase of two phase commit
1293  */
1294 int ldb_transaction_prepare_commit(struct ldb_context *ldb);
1295
1296 /**
1297   commit a transaction
1298 */
1299 int ldb_transaction_commit(struct ldb_context *ldb);
1300
1301 /**
1302   cancel a transaction
1303 */
1304 int ldb_transaction_cancel(struct ldb_context *ldb);
1305
1306
1307 /**
1308   return extended error information from the last call
1309 */
1310 const char *ldb_errstring(struct ldb_context *ldb);
1311
1312 /**
1313   return a string explaining what a ldb error constant meancs
1314 */
1315 const char *ldb_strerror(int ldb_err);
1316
1317 /**
1318   setup the default utf8 functions
1319   FIXME: these functions do not yet handle utf8
1320 */
1321 void ldb_set_utf8_default(struct ldb_context *ldb);
1322
1323 /**
1324    Casefold a string
1325
1326    \param ldb the ldb context
1327    \param mem_ctx the memory context to allocate the result string
1328    memory from. 
1329    \param s the string that is to be folded
1330    \return a copy of the string, converted to upper case
1331
1332    \note The default function is not yet UTF8 aware. Provide your own
1333          set of functions through ldb_set_utf8_fns()
1334 */
1335 char *ldb_casefold(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s, size_t n);
1336
1337 /**
1338    Check the attribute name is valid according to rfc2251
1339    \param s the string to check
1340
1341    \return 1 if the name is ok
1342 */
1343 int ldb_valid_attr_name(const char *s);
1344
1345 /*
1346   ldif manipulation functions
1347 */
1348
1349 /**
1350    Write an LDIF message
1351
1352    This function writes an LDIF message using a caller supplied  write
1353    function.
1354
1355    \param ldb the ldb context (from ldb_init())
1356    \param fprintf_fn a function pointer for the write function. This must take
1357    a private data pointer, followed by a format string, and then a variable argument
1358    list. 
1359    \param private_data pointer that will be provided back to the write
1360    function. This is useful for maintaining state or context.
1361    \param ldif the message to write out
1362
1363    \return the total number of bytes written, or an error code as returned
1364    from the write function.
1365
1366    \sa ldb_ldif_write_file for a more convenient way to write to a
1367    file stream.
1368
1369    \sa ldb_ldif_read for the reader equivalent to this function.
1370 */
1371 int ldb_ldif_write(struct ldb_context *ldb,
1372                    int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3), 
1373                    void *private_data,
1374                    const struct ldb_ldif *ldif);
1375
1376 /**
1377    Clean up an LDIF message
1378
1379    This function cleans up a LDIF message read using ldb_ldif_read()
1380    or related functions (such as ldb_ldif_read_string() and
1381    ldb_ldif_read_file().
1382
1383    \param ldb the ldb context (from ldb_init())
1384    \param msg the message to clean up and free
1385
1386 */
1387 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1388
1389 /**
1390    Read an LDIF message
1391
1392    This function creates an LDIF message using a caller supplied read
1393    function. 
1394
1395    \param ldb the ldb context (from ldb_init())
1396    \param fgetc_fn a function pointer for the read function. This must
1397    take a private data pointer, and must return a pointer to an
1398    integer corresponding to the next byte read (or EOF if there is no
1399    more data to be read).
1400    \param private_data pointer that will be provided back to the read
1401    function. This is udeful for maintaining state or context.
1402
1403    \return the LDIF message that has been read in
1404
1405    \note You must free the LDIF message when no longer required, using
1406    ldb_ldif_read_free().
1407
1408    \sa ldb_ldif_read_file for a more convenient way to read from a
1409    file stream.
1410
1411    \sa ldb_ldif_read_string for a more convenient way to read from a
1412    string (char array).
1413
1414    \sa ldb_ldif_write for the writer equivalent to this function.
1415 */
1416 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb, 
1417                                int (*fgetc_fn)(void *), void *private_data);
1418
1419 /**
1420    Read an LDIF message from a file
1421
1422    This function reads the next LDIF message from the contents of a
1423    file stream. If you want to get all of the LDIF messages, you will
1424    need to repeatedly call this function, until it returns NULL.
1425
1426    \param ldb the ldb context (from ldb_init())
1427    \param f the file stream to read from (typically from fdopen())
1428
1429    \sa ldb_ldif_read_string for an equivalent function that will read
1430    from a string (char array).
1431
1432    \sa ldb_ldif_write_file for the writer equivalent to this function.
1433
1434 */
1435 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1436
1437 /**
1438    Read an LDIF message from a string
1439
1440    This function reads the next LDIF message from the contents of a char
1441    array. If you want to get all of the LDIF messages, you will need
1442    to repeatedly call this function, until it returns NULL.
1443
1444    \param ldb the ldb context (from ldb_init())
1445    \param s pointer to the char array to read from
1446
1447    \sa ldb_ldif_read_file for an equivalent function that will read
1448    from a file stream.
1449
1450    \sa ldb_ldif_write for a more general (arbitrary read function)
1451    version of this function.
1452 */
1453 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1454
1455 /**
1456    Write an LDIF message to a file
1457
1458    \param ldb the ldb context (from ldb_init())
1459    \param f the file stream to write to (typically from fdopen())
1460    \param msg the message to write out
1461
1462    \return the total number of bytes written, or a negative error code
1463
1464    \sa ldb_ldif_read_file for the reader equivalent to this function.
1465 */
1466 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1467
1468 /**
1469    Write an LDIF message to a string
1470
1471    \param ldb the ldb context (from ldb_init())
1472    \param mem_ctx the talloc context on which to attach the string)
1473    \param msg the message to write out
1474
1475    \return the string containing the LDIF, or NULL on error
1476
1477    \sa ldb_ldif_read_string for the reader equivalent to this function.
1478 */
1479 char * ldb_ldif_write_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, 
1480                           const struct ldb_ldif *msg);
1481
1482
1483 /*
1484    Produce a string form of an ldb message
1485
1486    convenient function to turn a ldb_message into a string. Useful for
1487    debugging
1488  */
1489 char *ldb_ldif_message_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, 
1490                               enum ldb_changetype changetype,
1491                               const struct ldb_message *msg);
1492
1493
1494 /**
1495    Base64 encode a buffer
1496
1497    \param mem_ctx the memory context that the result is allocated
1498    from. 
1499    \param buf pointer to the array that is to be encoded
1500    \param len the number of elements in the array to be encoded
1501
1502    \return pointer to an array containing the encoded data
1503
1504    \note The caller is responsible for freeing the result
1505 */
1506 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len);
1507
1508 /**
1509    Base64 decode a buffer
1510
1511    This function decodes a base64 encoded string in place.
1512
1513    \param s the string to decode.
1514
1515    \return the length of the returned (decoded) string.
1516
1517    \note the string is null terminated, but the null terminator is not
1518    included in the length.
1519 */
1520 int ldb_base64_decode(char *s);
1521
1522 /* The following definitions come from lib/ldb/common/ldb_dn.c  */
1523
1524 /**
1525   Get the linear form of a DN (without any extended components)
1526   
1527   \param dn The DN to linearize
1528 */
1529
1530 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1531
1532 /**
1533   Allocate a copy of the linear form of a DN (without any extended components) onto the supplied memory context 
1534   
1535   \param dn The DN to linearize
1536   \param mem_ctx TALLOC context to return result on
1537 */
1538
1539 char *ldb_dn_alloc_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1540
1541 /**
1542   Get the linear form of a DN (with any extended components)
1543   
1544   \param mem_ctx TALLOC context to return result on
1545   \param dn The DN to linearize
1546   \param mode Style of extended DN to return (0 is HEX representation of binary form, 1 is a string form)
1547 */
1548 char *ldb_dn_get_extended_linearized(void *mem_ctx, struct ldb_dn *dn, int mode);
1549 const struct ldb_val *ldb_dn_get_extended_component(struct ldb_dn *dn, const char *name);
1550 int ldb_dn_set_extended_component(struct ldb_dn *dn, const char *name, const struct ldb_val *val);
1551
1552 void ldb_dn_remove_extended_components(struct ldb_dn *dn);
1553 bool ldb_dn_has_extended(struct ldb_dn *dn);
1554
1555 int ldb_dn_extended_add_syntax(struct ldb_context *ldb, 
1556                                unsigned flags,
1557                                const struct ldb_dn_extended_syntax *syntax);
1558
1559 /** 
1560   Allocate a new DN from a string
1561
1562   \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1563   \param dn The new DN 
1564
1565   \note The DN will not be parsed at this time.  Use ldb_dn_validate to tell if the DN is syntacticly correct
1566 */
1567
1568 struct ldb_dn *ldb_dn_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn);
1569 /** 
1570   Allocate a new DN from a printf style format string and arguments
1571
1572   \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1573   \param new_fms The new DN as a format string (plus arguments)
1574
1575   \note The DN will not be parsed at this time.  Use ldb_dn_validate to tell if the DN is syntacticly correct
1576 */
1577
1578 struct ldb_dn *ldb_dn_new_fmt(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1579 /** 
1580   Allocate a new DN from a struct ldb_val (useful to avoid buffer overrun)
1581
1582   \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1583   \param dn The new DN 
1584
1585   \note The DN will not be parsed at this time.  Use ldb_dn_validate to tell if the DN is syntacticly correct
1586 */
1587
1588 struct ldb_dn *ldb_dn_from_ldb_val(void *mem_ctx, struct ldb_context *ldb, const struct ldb_val *strdn);
1589
1590 /**
1591   Determine if this DN is syntactically valid 
1592
1593   \param dn The DN to validate
1594 */
1595
1596 bool ldb_dn_validate(struct ldb_dn *dn);
1597
1598 char *ldb_dn_escape_value(TALLOC_CTX *mem_ctx, struct ldb_val value);
1599 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1600 char *ldb_dn_alloc_casefold(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1601
1602 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1603 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1604
1605 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1606 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1607 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1608 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1609 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1610 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1611
1612 struct ldb_dn *ldb_dn_copy(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1613 struct ldb_dn *ldb_dn_get_parent(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1614 char *ldb_dn_canonical_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1615 char *ldb_dn_canonical_ex_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1616 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1617 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1618 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1619 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1620 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1621 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1622
1623 bool ldb_dn_is_valid(struct ldb_dn *dn);
1624 bool ldb_dn_is_special(struct ldb_dn *dn);
1625 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1626 bool ldb_dn_is_null(struct ldb_dn *dn);
1627
1628
1629 /**
1630    Compare two attributes
1631
1632    This function compares to attribute names. Note that this is a
1633    case-insensitive comparison.
1634
1635    \param a the first attribute name to compare
1636    \param b the second attribute name to compare
1637
1638    \return 0 if the attribute names are the same, or only differ in
1639    case; non-zero if there are any differences
1640
1641   attribute names are restricted by rfc2251 so using
1642   strcasecmp and toupper here is ok.
1643   return 0 for match
1644 */
1645 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1646 char *ldb_attr_casefold(TALLOC_CTX *mem_ctx, const char *s);
1647 int ldb_attr_dn(const char *attr);
1648
1649 /**
1650    Create an empty message
1651
1652    \param mem_ctx the memory context to create in. You can pass NULL
1653    to get the top level context, however the ldb context (from
1654    ldb_init()) may be a better choice
1655 */
1656 struct ldb_message *ldb_msg_new(TALLOC_CTX *mem_ctx);
1657
1658 /**
1659    Find an element within an message
1660 */
1661 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg, 
1662                                                  const char *attr_name);
1663
1664 /**
1665    Compare two ldb_val values
1666
1667    \param v1 first ldb_val structure to be tested
1668    \param v2 second ldb_val structure to be tested
1669
1670    \return 1 for a match, 0 if there is any difference
1671 */
1672 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1673
1674 /**
1675    find a value within an ldb_message_element
1676
1677    \param el the element to search
1678    \param val the value to search for
1679
1680    \note This search is case sensitive
1681 */
1682 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el, 
1683                                  struct ldb_val *val);
1684
1685 /**
1686    add a new empty element to a ldb_message
1687 */
1688 int ldb_msg_add_empty(struct ldb_message *msg,
1689                 const char *attr_name,
1690                 int flags,
1691                 struct ldb_message_element **return_el);
1692
1693 /**
1694    add a element to a ldb_message
1695 */
1696 int ldb_msg_add(struct ldb_message *msg, 
1697                 const struct ldb_message_element *el, 
1698                 int flags);
1699 int ldb_msg_add_value(struct ldb_message *msg, 
1700                 const char *attr_name,
1701                 const struct ldb_val *val,
1702                 struct ldb_message_element **return_el);
1703 int ldb_msg_add_steal_value(struct ldb_message *msg, 
1704                       const char *attr_name,
1705                       struct ldb_val *val);
1706 int ldb_msg_add_steal_string(struct ldb_message *msg, 
1707                              const char *attr_name, char *str);
1708 int ldb_msg_add_string(struct ldb_message *msg, 
1709                        const char *attr_name, const char *str);
1710 int ldb_msg_add_fmt(struct ldb_message *msg, 
1711                     const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1712
1713 /**
1714    compare two message elements - return 0 on match
1715 */
1716 int ldb_msg_element_compare(struct ldb_message_element *el1, 
1717                             struct ldb_message_element *el2);
1718 int ldb_msg_element_compare_name(struct ldb_message_element *el1, 
1719                                  struct ldb_message_element *el2);
1720
1721 /**
1722    Find elements in a message.
1723
1724    This function finds elements and converts to a specific type, with
1725    a give default value if not found. Assumes that elements are
1726    single valued.
1727 */
1728 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1729 int ldb_msg_find_attr_as_int(const struct ldb_message *msg, 
1730                              const char *attr_name,
1731                              int default_value);
1732 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg, 
1733                                        const char *attr_name,
1734                                        unsigned int default_value);
1735 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg, 
1736                                    const char *attr_name,
1737                                    int64_t default_value);
1738 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg, 
1739                                      const char *attr_name,
1740                                      uint64_t default_value);
1741 double ldb_msg_find_attr_as_double(const struct ldb_message *msg, 
1742                                    const char *attr_name,
1743                                    double default_value);
1744 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg, 
1745                               const char *attr_name,
1746                               int default_value);
1747 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg, 
1748                                         const char *attr_name,
1749                                         const char *default_value);
1750
1751 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1752                                        TALLOC_CTX *mem_ctx,
1753                                        const struct ldb_message *msg,
1754                                        const char *attr_name);
1755
1756 void ldb_msg_sort_elements(struct ldb_message *msg);
1757
1758 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx, 
1759                                          const struct ldb_message *msg);
1760 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx, 
1761                                  const struct ldb_message *msg);
1762
1763 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb, 
1764                                          const struct ldb_message *msg);
1765
1766
1767 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb, 
1768                                  struct ldb_message *msg1,
1769                                  struct ldb_message *msg2);
1770
1771 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1772                                    const char *name,
1773                                    const char *value);
1774
1775 /**
1776    Integrity check an ldb_message
1777
1778    This function performs basic sanity / integrity checks on an
1779    ldb_message.
1780
1781    \param ldb context in which to perform the checks
1782    \param msg the message to check
1783
1784    \return LDB_SUCCESS if the message is OK, or a non-zero error code
1785    (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1786    LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1787    message.
1788 */
1789 int ldb_msg_sanity_check(struct ldb_context *ldb,
1790                          const struct ldb_message *msg);
1791
1792 /**
1793    Duplicate an ldb_val structure
1794
1795    This function copies an ldb value structure. 
1796
1797    \param mem_ctx the memory context that the duplicated value will be
1798    allocated from
1799    \param v the ldb_val to be duplicated.
1800
1801    \return the duplicated ldb_val structure.
1802 */
1803 struct ldb_val ldb_val_dup(TALLOC_CTX *mem_ctx, const struct ldb_val *v);
1804
1805 /**
1806   this allows the user to set a debug function for error reporting
1807 */
1808 int ldb_set_debug(struct ldb_context *ldb,
1809                   void (*debug)(void *context, enum ldb_debug_level level, 
1810                                 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1811                   void *context);
1812
1813 /**
1814   this allows the user to set custom utf8 function for error reporting
1815 */
1816 void ldb_set_utf8_fns(struct ldb_context *ldb,
1817                       void *context,
1818                       char *(*casefold)(void *, void *, const char *, size_t n));
1819
1820 /**
1821    this sets up debug to print messages on stderr
1822 */
1823 int ldb_set_debug_stderr(struct ldb_context *ldb);
1824
1825 /* control backend specific opaque values */
1826 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1827 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1828
1829 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs);
1830 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr);
1831 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1832
1833 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1834 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1835 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1836 void ldb_msg_remove_element(struct ldb_message *msg, struct ldb_message_element *el);
1837
1838
1839 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree, 
1840                                  const char *attr, 
1841                                  const char *replace);
1842
1843 /*
1844   shallow copy a tree - copying only the elements array so that the caller
1845   can safely add new elements without changing the message
1846 */
1847 struct ldb_parse_tree *ldb_parse_tree_copy_shallow(TALLOC_CTX *mem_ctx,
1848                                                    const struct ldb_parse_tree *ot);
1849
1850 /**
1851    Convert a time structure to a string
1852
1853    This function converts a time_t structure to an LDAP formatted
1854    GeneralizedTime string.
1855                 
1856    \param mem_ctx the memory context to allocate the return string in
1857    \param t the time structure to convert
1858
1859    \return the formatted string, or NULL if the time structure could
1860    not be converted
1861 */
1862 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t);
1863
1864 /**
1865    Convert a string to a time structure
1866
1867    This function converts an LDAP formatted GeneralizedTime string
1868    to a time_t structure.
1869
1870    \param s the string to convert
1871
1872    \return the time structure, or 0 if the string cannot be converted
1873 */
1874 time_t ldb_string_to_time(const char *s);
1875
1876 /**
1877    Convert a time structure to a string
1878
1879    This function converts a time_t structure to an LDAP formatted
1880    UTCTime string.
1881                 
1882    \param mem_ctx the memory context to allocate the return string in
1883    \param t the time structure to convert
1884
1885    \return the formatted string, or NULL if the time structure could
1886    not be converted
1887 */
1888 char *ldb_timestring_utc(TALLOC_CTX *mem_ctx, time_t t);
1889
1890 /**
1891    Convert a string to a time structure
1892
1893    This function converts an LDAP formatted UTCTime string
1894    to a time_t structure.
1895
1896    \param s the string to convert
1897
1898    \return the time structure, or 0 if the string cannot be converted
1899 */
1900 time_t ldb_string_utc_to_time(const char *s);
1901
1902
1903 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1904
1905
1906 /**
1907    Convert an array of string represention of a control into an array of ldb_control structures 
1908    
1909    \param ldb LDB context
1910    \param mem_ctx TALLOC context to return result on, and to allocate error_string on
1911    \param control_strings Array of string-formatted controls
1912
1913    \return array of ldb_control elements
1914 */
1915 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings);
1916
1917 /**
1918    return the ldb flags 
1919 */
1920 unsigned int ldb_get_flags(struct ldb_context *ldb);
1921
1922 /* set the ldb flags */
1923 void ldb_set_flags(struct ldb_context *ldb, unsigned flags);
1924
1925
1926 #endif