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