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