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