lib/ldb/include/ldb.h

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Andrew Tridgell  2004
   5    Copyright (C) Stefan Metzmacher  2004
   6    Copyright (C) Simo Sorce  2005-2006
   7
   8      ** NOTE! The following LGPL license applies to the ldb
   9      ** library. This does NOT imply that all of Samba is released
  10      ** under the LGPL
  11
  12    This library is free software; you can redistribute it and/or
  13    modify it under the terms of the GNU Lesser General Public
  14    License as published by the Free Software Foundation; either
  15    version 3 of the License, or (at your option) any later version.
  16
  17    This library is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20    Lesser General Public License for more details.
  21
  22    You should have received a copy of the GNU Lesser General Public
  23    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  24 */
  25
  26 /*
  27  *  Name: ldb
  28  *
  29  *  Component: ldb header
  30  *
  31  *  Description: defines for base ldb API
  32  *
  33  *  Author: Andrew Tridgell
  34  *  Author: Stefan Metzmacher
  35  */
  36
  37 /**
  38    \file ldb.h Samba's ldb database
  39
  40    This header file provides the main API for ldb.
  41 */
  42
  43 #ifndef _LDB_H_
  44
  45 /*! \cond DOXYGEN_IGNORE */
  46 #define _LDB_H_ 1
  47 /*! \endcond */
  48
  49 #include <stdbool.h>
  50 #include <talloc.h>
  51 #include <tevent.h>
  52 #include <ldb_version.h>
  53 #include <ldb_errors.h>
  54
  55 /*
  56   major restrictions as compared to normal LDAP:
  57
  58      - each record must have a unique key field
  59      - the key must be representable as a NULL terminated C string and may not
  60        contain a comma or braces
  61
  62   major restrictions as compared to tdb:
  63
  64      - no explicit locking calls, but we have transactions when using ldb_tdb
  65
  66 */
  67
  68 #ifndef ldb_val
  69 /**
  70    Result value
  71
  72    An individual lump of data in a result comes in this format. The
  73    pointer will usually be to a UTF-8 string if the application is
  74    sensible, but it can be to anything you like, including binary data
  75    blobs of arbitrary size.
  76
  77    \note the data is null (0x00) terminated, but the length does not
  78    include the terminator.
  79 */
  80 struct ldb_val {
  81         uint8_t *data; /*!< result data */
  82         size_t length; /*!< length of data */
  83 };
  84 #endif
  85
  86 /*! \cond DOXYGEN_IGNORE */
  87 #ifndef PRINTF_ATTRIBUTE
  88 #define PRINTF_ATTRIBUTE(a,b)
  89 #endif
  90
  91 #ifndef _DEPRECATED_
  92 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
  93 #define _DEPRECATED_ __attribute__ ((deprecated))
  94 #else
  95 #define _DEPRECATED_
  96 #endif
  97 #endif
  98 /*! \endcond */
  99
 100 /* opaque ldb_dn structures, see ldb_dn.c for internals */
 101 struct ldb_dn_component;
 102 struct ldb_dn;
 103
 104 /**
 105  There are a number of flags that are used with ldap_modify() in
 106  ldb_message_element.flags fields. The LDB_FLAG_MOD_ADD,
 107  LDB_FLAG_MOD_DELETE and LDB_FLAG_MOD_REPLACE flags are used in
 108  ldap_modify() calls to specify whether attributes are being added,
 109  deleted or modified respectively.
 110 */
 111 #define LDB_FLAG_MOD_MASK  0x3
 112
 113 /**
 114   use this to extract the mod type from the operation
 115  */
 116 #define LDB_FLAG_MOD_TYPE(flags) ((flags) & LDB_FLAG_MOD_MASK)
 117
 118 /**
 119    Flag value used in ldap_modify() to indicate that attributes are
 120    being added.
 121
 122    \sa LDB_FLAG_MOD_MASK
 123 */
 124 #define LDB_FLAG_MOD_ADD     1
 125
 126 /**
 127    Flag value used in ldap_modify() to indicate that attributes are
 128    being replaced.
 129
 130    \sa LDB_FLAG_MOD_MASK
 131 */
 132 #define LDB_FLAG_MOD_REPLACE 2
 133
 134 /**
 135    Flag value used in ldap_modify() to indicate that attributes are
 136    being deleted.
 137
 138    \sa LDB_FLAG_MOD_MASK
 139 */
 140 #define LDB_FLAG_MOD_DELETE  3
 141
 142 /**
 143     flag bits on an element usable only by the internal implementation
 144 */
 145 #define LDB_FLAG_INTERNAL_MASK 0xFFFFFFF0
 146
 147 /**
 148   OID for logic AND comaprison.
 149
 150   This is the well known object ID for a logical AND comparitor.
 151 */
 152 #define LDB_OID_COMPARATOR_AND  "1.2.840.113556.1.4.803"
 153
 154 /**
 155   OID for logic OR comparison.
 156
 157   This is the well known object ID for a logical OR comparitor.
 158 */
 159 #define LDB_OID_COMPARATOR_OR   "1.2.840.113556.1.4.804"
 160
 161 /**
 162   results are given back as arrays of ldb_message_element
 163 */
 164 struct ldb_message_element {
 165         unsigned int flags;
 166         const char *name;
 167         unsigned int num_values;
 168         struct ldb_val *values;
 169 };
 170
 171
 172 /**
 173   a ldb_message represents all or part of a record. It can contain an arbitrary
 174   number of elements.
 175 */
 176 struct ldb_message {
 177         struct ldb_dn *dn;
 178         unsigned int num_elements;
 179         struct ldb_message_element *elements;
 180 };
 181
 182 enum ldb_changetype {
 183         LDB_CHANGETYPE_NONE=0,
 184         LDB_CHANGETYPE_ADD,
 185         LDB_CHANGETYPE_DELETE,
 186         LDB_CHANGETYPE_MODIFY,
 187         LDB_CHANGETYPE_MODRDN
 188 };
 189
 190 /**
 191   LDIF record
 192
 193   This structure contains a LDIF record, as returned from ldif_read()
 194   and equivalent functions.
 195 */
 196 struct ldb_ldif {
 197         enum ldb_changetype changetype; /*!< The type of change */
 198         struct ldb_message *msg;  /*!< The changes */
 199 };
 200
 201 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
 202                 LDB_SCOPE_BASE=0,
 203                 LDB_SCOPE_ONELEVEL=1,
 204                 LDB_SCOPE_SUBTREE=2};
 205
 206 struct ldb_context;
 207 struct tevent_context;
 208
 209 /* debugging uses one of the following levels */
 210 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
 211                       LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
 212
 213 /**
 214   the user can optionally supply a debug function. The function
 215   is based on the vfprintf() style of interface, but with the addition
 216   of a severity level
 217 */
 218 struct ldb_debug_ops {
 219         void (*debug)(void *context, enum ldb_debug_level level,
 220                       const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
 221         void *context;
 222 };
 223
 224 /**
 225   The user can optionally supply a custom utf8 functions,
 226   to handle comparisons and casefolding.
 227 */
 228 struct ldb_utf8_fns {
 229         void *context;
 230         char *(*casefold)(void *context, TALLOC_CTX *mem_ctx, const char *s, size_t n);
 231 };
 232
 233 /**
 234    Flag value for database connection mode.
 235
 236    If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
 237    opened read-only, if possible.
 238 */
 239 #define LDB_FLG_RDONLY 1
 240
 241 /**
 242    Flag value for database connection mode.
 243
 244    If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
 245    opened without synchronous operations, if possible.
 246 */
 247 #define LDB_FLG_NOSYNC 2
 248
 249 /**
 250    Flag value to specify autoreconnect mode.
 251
 252    If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
 253    be opened in a way that makes it try to auto reconnect if the
 254    connection is dropped (actually make sense only with ldap).
 255 */
 256 #define LDB_FLG_RECONNECT 4
 257
 258 /**
 259    Flag to tell backends not to use mmap
 260 */
 261 #define LDB_FLG_NOMMAP 8
 262
 263 /**
 264    Flag to tell ldif handlers not to force encoding of binary
 265    structures in base64
 266 */
 267 #define LDB_FLG_SHOW_BINARY 16
 268
 269 /**
 270    Flags to enable ldb tracing
 271 */
 272 #define LDB_FLG_ENABLE_TRACING 32
 273
 274 /**
 275    Flags to tell LDB not to create a new database file:
 276
 277    Without this flag ldb_tdb (for example) will create a blank file
 278    during an invocation of ldb_connect(), even when the caller only
 279    wanted read operations, for example in ldbsearch.
 280 */
 281 #define LDB_FLG_DONT_CREATE_DB 64
 282
 283 /*
 284    structures for ldb_parse_tree handling code
 285 */
 286 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
 287                     LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
 288                     LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
 289                     LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
 290
 291 struct ldb_parse_tree {
 292         enum ldb_parse_op operation;
 293         union {
 294                 struct {
 295                         struct ldb_parse_tree *child;
 296                 } isnot;
 297                 struct {
 298                         const char *attr;
 299                         struct ldb_val value;
 300                 } equality;
 301                 struct {
 302                         const char *attr;
 303                         int start_with_wildcard;
 304                         int end_with_wildcard;
 305                         struct ldb_val **chunks;
 306                 } substring;
 307                 struct {
 308                         const char *attr;
 309                 } present;
 310                 struct {
 311                         const char *attr;
 312                         struct ldb_val value;
 313                 } comparison;
 314                 struct {
 315                         const char *attr;
 316                         int dnAttributes;
 317                         const char *rule_id;
 318                         struct ldb_val value;
 319                 } extended;
 320                 struct {
 321                         unsigned int num_elements;
 322                         struct ldb_parse_tree **elements;
 323                 } list;
 324         } u;
 325 };
 326
 327 struct ldb_parse_tree *ldb_parse_tree(TALLOC_CTX *mem_ctx, const char *s);
 328 char *ldb_filter_from_tree(TALLOC_CTX *mem_ctx, const struct ldb_parse_tree *tree);
 329
 330 /**
 331    Encode a binary blob
 332
 333    This function encodes a binary blob using the encoding rules in RFC
 334    2254 (Section 4). This function also escapes any non-printable
 335    characters.
 336
 337    \param mem_ctx the memory context to allocate the return string in.
 338    \param val the (potentially) binary data to be encoded
 339
 340    \return the encoded data as a null terminated string
 341
 342    \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
 343 */
 344 char *ldb_binary_encode(TALLOC_CTX *mem_ctx, struct ldb_val val);
 345
 346 /**
 347    Encode a string
 348
 349    This function encodes a string using the encoding rules in RFC 2254
 350    (Section 4). This function also escapes any non-printable
 351    characters.
 352
 353    \param mem_ctx the memory context to allocate the return string in.
 354    \param string the string to be encoded
 355
 356    \return the encoded data as a null terminated string
 357
 358    \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
 359 */
 360 char *ldb_binary_encode_string(TALLOC_CTX *mem_ctx, const char *string);
 361
 362 /*
 363   functions for controlling attribute handling
 364 */
 365 typedef int (*ldb_attr_handler_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, struct ldb_val *);
 366 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, const struct ldb_val *);
 367 struct ldb_schema_attribute;
 368 typedef int (*ldb_attr_operator_t)(struct ldb_context *, enum ldb_parse_op operation,
 369                                    const struct ldb_schema_attribute *a,
 370                                    const struct ldb_val *, const struct ldb_val *, bool *matched);
 371
 372 /*
 373   attribute handler structure
 374
 375   attr                  -> The attribute name
 376   ldif_read_fn          -> convert from ldif to binary format
 377   ldif_write_fn         -> convert from binary to ldif format
 378   canonicalise_fn       -> canonicalise a value, for use by indexing and dn construction
 379   comparison_fn         -> compare two values
 380 */
 381
 382 struct ldb_schema_syntax {
 383         const char *name;
 384         ldb_attr_handler_t ldif_read_fn;
 385         ldb_attr_handler_t ldif_write_fn;
 386         ldb_attr_handler_t canonicalise_fn;
 387         ldb_attr_comparison_t comparison_fn;
 388         ldb_attr_operator_t operator_fn;
 389 };
 390
 391 struct ldb_schema_attribute {
 392         const char *name;
 393         unsigned flags;
 394         const struct ldb_schema_syntax *syntax;
 395 };
 396
 397 const struct ldb_schema_attribute *ldb_schema_attribute_by_name(struct ldb_context *ldb,
 398                                                                 const char *name);
 399
 400 struct ldb_dn_extended_syntax {
 401         const char *name;
 402         ldb_attr_handler_t read_fn;
 403         ldb_attr_handler_t write_clear_fn;
 404         ldb_attr_handler_t write_hex_fn;
 405 };
 406
 407 const struct ldb_dn_extended_syntax *ldb_dn_extended_syntax_by_name(struct ldb_context *ldb,
 408                                                                     const char *name);
 409
 410 /**
 411    The attribute is not returned by default
 412 */
 413 #define LDB_ATTR_FLAG_HIDDEN       (1<<0)
 414
 415 /* the attribute handler name should be freed when released */
 416 #define LDB_ATTR_FLAG_ALLOCATED    (1<<1)
 417
 418 /**
 419    The attribute is supplied by the application and should not be removed
 420 */
 421 #define LDB_ATTR_FLAG_FIXED        (1<<2)
 422
 423 /*
 424   when this is set, attempts to create two records which have the same
 425   value for this attribute will return LDB_ERR_ENTRY_ALREADY_EXISTS
 426  */
 427 #define LDB_ATTR_FLAG_UNIQUE_INDEX (1<<3)
 428
 429 /*
 430   when this is set, attempts to create two attribute values for this attribute on a single DN will return LDB_ERR_CONSTRAINT_VIOLATION
 431  */
 432 #define LDB_ATTR_FLAG_SINGLE_VALUE (1<<4)
 433
 434 /*
 435  * The values should always be base64 encoded
 436  */
 437 #define LDB_ATTR_FLAG_FORCE_BASE64_LDIF        (1<<5)
 438
 439 /*
 440  * The attribute was loaded from a DB, rather than via the C API
 441  */
 442 #define LDB_ATTR_FLAG_FROM_DB      (1<<6)
 443
 444 /**
 445   LDAP attribute syntax for a DN
 446
 447   This is the well-known LDAP attribute syntax for a DN.
 448
 449   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 450 */
 451 #define LDB_SYNTAX_DN                   "1.3.6.1.4.1.1466.115.121.1.12"
 452
 453 /**
 454   LDAP attribute syntax for a Directory String
 455
 456   This is the well-known LDAP attribute syntax for a Directory String.
 457
 458   \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 459 */
 460 #define LDB_SYNTAX_DIRECTORY_STRING     "1.3.6.1.4.1.1466.115.121.1.15"
 461
 462 /**
 463   LDAP attribute syntax for an integer
 464
 465   This is the well-known LDAP attribute syntax for an integer.
 466
 467   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 468 */
 469 #define LDB_SYNTAX_INTEGER              "1.3.6.1.4.1.1466.115.121.1.27"
 470
 471 /**
 472   LDAP attribute syntax for a boolean
 473
 474   This is the well-known LDAP attribute syntax for a boolean.
 475
 476   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 477 */
 478 #define LDB_SYNTAX_BOOLEAN              "1.3.6.1.4.1.1466.115.121.1.7"
 479
 480 /**
 481   LDAP attribute syntax for an octet string
 482
 483   This is the well-known LDAP attribute syntax for an octet string.
 484
 485   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 486 */
 487 #define LDB_SYNTAX_OCTET_STRING         "1.3.6.1.4.1.1466.115.121.1.40"
 488
 489 /**
 490   LDAP attribute syntax for UTC time.
 491
 492   This is the well-known LDAP attribute syntax for a UTC time.
 493
 494   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 495 */
 496 #define LDB_SYNTAX_UTC_TIME             "1.3.6.1.4.1.1466.115.121.1.53"
 497 #define LDB_SYNTAX_GENERALIZED_TIME     "1.3.6.1.4.1.1466.115.121.1.24"
 498
 499 #define LDB_SYNTAX_OBJECTCLASS          "LDB_SYNTAX_OBJECTCLASS"
 500
 501 /* sorting helpers */
 502 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
 503
 504 /* Individual controls */
 505
 506 /**
 507   OID for getting and manipulating attributes from the ldb
 508   without interception in the operational module.
 509   It can be used to access attribute that used to be stored in the sam
 510   and that are now calculated.
 511 */
 512 #define LDB_CONTROL_BYPASS_OPERATIONAL_OID "1.3.6.1.4.1.7165.4.3.13"
 513 #define LDB_CONTROL_BYPASS_OPERATIONAL_NAME "bypassoperational"
 514
 515 /**
 516   OID for recalculate RDN (rdn attribute and 'name') control. This control forces
 517   the rdn_name module to the recalculate the rdn and name attributes as if the
 518   object was just created.
 519 */
 520 #define LDB_CONTROL_RECALCULATE_RDN_OID "1.3.6.1.4.1.7165.4.3.30"
 521
 522 /**
 523   OID for recalculate SD control. This control force the
 524   dsdb code to recalculate the SD of the object as if the
 525   object was just created.
 526
 527 */
 528 #define LDB_CONTROL_RECALCULATE_SD_OID "1.3.6.1.4.1.7165.4.3.5"
 529 #define LDB_CONTROL_RECALCULATE_SD_NAME "recalculate_sd"
 530
 531 /**
 532    REVEAL_INTERNALS is used to reveal internal attributes and DN
 533    components which are not normally shown to the user
 534 */
 535 #define LDB_CONTROL_REVEAL_INTERNALS "1.3.6.1.4.1.7165.4.3.6"
 536 #define LDB_CONTROL_REVEAL_INTERNALS_NAME       "reveal_internals"
 537
 538 /**
 539    LDB_CONTROL_AS_SYSTEM is used to skip access checks on operations
 540    that are performed by the system, but with a user's credentials, e.g.
 541    updating prefix map
 542 */
 543 #define LDB_CONTROL_AS_SYSTEM_OID "1.3.6.1.4.1.7165.4.3.7"
 544
 545 /**
 546    LDB_CONTROL_PROVISION_OID is used to skip some constraint checks. It's is
 547    mainly thought to be used for the provisioning.
 548 */
 549 #define LDB_CONTROL_PROVISION_OID "1.3.6.1.4.1.7165.4.3.16"
 550 #define LDB_CONTROL_PROVISION_NAME      "provision"
 551
 552 /* AD controls */
 553
 554 /**
 555    OID for the paged results control. This control is included in the
 556    searchRequest and searchResultDone messages as part of the controls
 557    field of the LDAPMessage, as defined in Section 4.1.12 of
 558    LDAP v3.
 559
 560    \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
 561 */
 562 #define LDB_CONTROL_PAGED_RESULTS_OID   "1.2.840.113556.1.4.319"
 563 #define LDB_CONTROL_PAGED_RESULTS_NAME  "paged_results"
 564
 565 /**
 566    OID for specifying the returned elements of the ntSecurityDescriptor
 567
 568    \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>
 569 */
 570 #define LDB_CONTROL_SD_FLAGS_OID        "1.2.840.113556.1.4.801"
 571 #define LDB_CONTROL_SD_FLAGS_NAME       "sd_flags"
 572
 573 /**
 574    OID for specifying an advanced scope for the search (one partition)
 575
 576    \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>
 577 */
 578 #define LDB_CONTROL_DOMAIN_SCOPE_OID    "1.2.840.113556.1.4.1339"
 579 #define LDB_CONTROL_DOMAIN_SCOPE_NAME   "domain_scope"
 580
 581 /**
 582    OID for specifying an advanced scope for a search
 583
 584    \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>
 585 */
 586 #define LDB_CONTROL_SEARCH_OPTIONS_OID  "1.2.840.113556.1.4.1340"
 587 #define LDB_CONTROL_SEARCH_OPTIONS_NAME "search_options"
 588
 589 /**
 590    OID for notification
 591
 592    \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>
 593 */
 594 #define LDB_CONTROL_NOTIFICATION_OID    "1.2.840.113556.1.4.528"
 595 #define LDB_CONTROL_NOTIFICATION_NAME   "notification"
 596
 597 /**
 598    OID for performing subtree deletes
 599
 600    \sa <a href="http://msdn.microsoft.com/en-us/library/aa366991(v=VS.85).aspx">Microsoft documentation of this OID</a>
 601 */
 602 #define LDB_CONTROL_TREE_DELETE_OID     "1.2.840.113556.1.4.805"
 603 #define LDB_CONTROL_TREE_DELETE_NAME    "tree_delete"
 604
 605 /**
 606    OID for getting deleted objects
 607
 608    \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>
 609 */
 610 #define LDB_CONTROL_SHOW_DELETED_OID    "1.2.840.113556.1.4.417"
 611 #define LDB_CONTROL_SHOW_DELETED_NAME   "show_deleted"
 612
 613 /**
 614    OID for getting recycled objects
 615
 616    \sa <a href="http://msdn.microsoft.com/en-us/library/dd304621(PROT.13).aspx">Microsoft documentation of this OID</a>
 617 */
 618 #define LDB_CONTROL_SHOW_RECYCLED_OID         "1.2.840.113556.1.4.2064"
 619 #define LDB_CONTROL_SHOW_RECYCLED_NAME  "show_recycled"
 620
 621 /**
 622    OID for getting deactivated linked attributes
 623
 624    \sa <a href="http://msdn.microsoft.com/en-us/library/dd302781(PROT.13).aspx">Microsoft documentation of this OID</a>
 625 */
 626 #define LDB_CONTROL_SHOW_DEACTIVATED_LINK_OID "1.2.840.113556.1.4.2065"
 627 #define LDB_CONTROL_SHOW_DEACTIVATED_LINK_NAME  "show_deactivated_link"
 628
 629 /**
 630    OID for extended DN
 631
 632    \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>
 633 */
 634 #define LDB_CONTROL_EXTENDED_DN_OID     "1.2.840.113556.1.4.529"
 635 #define LDB_CONTROL_EXTENDED_DN_NAME    "extended_dn"
 636
 637 /**
 638    OID for LDAP server sort result extension.
 639
 640    This control is included in the searchRequest message as part of
 641    the controls field of the LDAPMessage, as defined in Section 4.1.12
 642    of LDAP v3. The controlType is set to
 643    "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
 644    FALSE (where absent is also equivalent to FALSE) at the client's
 645    option.
 646
 647    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
 648 */
 649 #define LDB_CONTROL_SERVER_SORT_OID     "1.2.840.113556.1.4.473"
 650 #define LDB_CONTROL_SERVER_SORT_NAME    "server_sort"
 651
 652 /**
 653    OID for LDAP server sort result response extension.
 654
 655    This control is included in the searchResultDone message as part of
 656    the controls field of the LDAPMessage, as defined in Section 4.1.12 of
 657    LDAP v3.
 658
 659    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
 660 */
 661 #define LDB_CONTROL_SORT_RESP_OID       "1.2.840.113556.1.4.474"
 662 #define LDB_CONTROL_SORT_RESP_NAME      "server_sort_resp"
 663
 664 /**
 665    OID for LDAP Attribute Scoped Query extension.
 666
 667    This control is included in SearchRequest or SearchResponse
 668    messages as part of the controls field of the LDAPMessage.
 669 */
 670 #define LDB_CONTROL_ASQ_OID             "1.2.840.113556.1.4.1504"
 671 #define LDB_CONTROL_ASQ_NAME    "asq"
 672
 673 /**
 674    OID for LDAP Directory Sync extension.
 675
 676    This control is included in SearchRequest or SearchResponse
 677    messages as part of the controls field of the LDAPMessage.
 678 */
 679 #define LDB_CONTROL_DIRSYNC_OID         "1.2.840.113556.1.4.841"
 680 #define LDB_CONTROL_DIRSYNC_NAME        "dirsync"
 681 #define LDB_CONTROL_DIRSYNC_EX_OID      "1.2.840.113556.1.4.2090"
 682 #define LDB_CONTROL_DIRSYNC_EX_NAME     "dirsync_ex"
 683
 684
 685 /**
 686    OID for LDAP Virtual List View Request extension.
 687
 688    This control is included in SearchRequest messages
 689    as part of the controls field of the LDAPMessage.
 690 */
 691 #define LDB_CONTROL_VLV_REQ_OID         "2.16.840.1.113730.3.4.9"
 692 #define LDB_CONTROL_VLV_REQ_NAME        "vlv"
 693
 694 /**
 695    OID for LDAP Virtual List View Response extension.
 696
 697    This control is included in SearchResponse messages
 698    as part of the controls field of the LDAPMessage.
 699 */
 700 #define LDB_CONTROL_VLV_RESP_OID        "2.16.840.1.113730.3.4.10"
 701 #define LDB_CONTROL_VLV_RESP_NAME       "vlv_resp"
 702
 703 /**
 704    OID to let modifies don't give an error when adding an existing
 705    attribute with the same value or deleting an nonexisting one attribute
 706
 707    \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>
 708 */
 709 #define LDB_CONTROL_PERMISSIVE_MODIFY_OID       "1.2.840.113556.1.4.1413"
 710 #define LDB_CONTROL_PERMISSIVE_MODIFY_NAME      "permissive_modify"
 711
 712 /**
 713     OID to allow the server to be more 'fast and loose' with the data being added.
 714
 715     \sa <a href="http://msdn.microsoft.com/en-us/library/aa366982(v=VS.85).aspx">Microsoft documentation of this OID</a>
 716 */
 717 #define LDB_CONTROL_SERVER_LAZY_COMMIT   "1.2.840.113556.1.4.619"
 718
 719 /**
 720    Control for RODC join -see [MS-ADTS] section 3.1.1.3.4.1.23
 721
 722    \sa <a href="">Microsoft documentation of this OID</a>
 723 */
 724 #define LDB_CONTROL_RODC_DCPROMO_OID "1.2.840.113556.1.4.1341"
 725 #define LDB_CONTROL_RODC_DCPROMO_NAME   "rodc_join"
 726
 727 /* Other standardised controls */
 728
 729 /**
 730    OID for the allowing client to request temporary relaxed
 731    enforcement of constraints of the x.500 model.
 732
 733    Mainly used for the OpenLDAP backend.
 734
 735    \sa <a href="http://opends.dev.java.net/public/standards/draft-zeilenga-ldap-managedit.txt">draft managedit</a>.
 736 */
 737 #define LDB_CONTROL_RELAX_OID "1.3.6.1.4.1.4203.666.5.12"
 738 #define LDB_CONTROL_RELAX_NAME  "relax"
 739
 740 /**
 741    OID for the allowing some kind of relax check for attributes with DNs
 742
 743
 744    \sa 3.1.1.3.4.1.16 in [MS-ADTS].pdf
 745 */
 746 #define LDB_CONTROL_VERIFY_NAME_OID "1.2.840.113556.1.4.1338"
 747 #define LDB_CONTROL_VERIFY_NAME_NAME    "verify_name"
 748
 749 /* Extended operations */
 750
 751 /**
 752    OID for LDAP Extended Operation SEQUENCE_NUMBER
 753
 754    This extended operation is used to retrieve the extended sequence number.
 755 */
 756 #define LDB_EXTENDED_SEQUENCE_NUMBER    "1.3.6.1.4.1.7165.4.4.3"
 757
 758 /**
 759    OID for LDAP Extended Operation PASSWORD_CHANGE.
 760
 761    This Extended operation is used to allow user password changes by the user
 762    itself.
 763 */
 764 #define LDB_EXTENDED_PASSWORD_CHANGE_OID        "1.3.6.1.4.1.4203.1.11.1"
 765
 766
 767 /**
 768    OID for LDAP Extended Operation FAST_BIND
 769
 770    This Extended operations is used to perform a fast bind.
 771 */
 772 #define LDB_EXTENDED_FAST_BIND_OID      "1.2.840.113556.1.4.1781"
 773
 774 /**
 775    OID for LDAP Extended Operation START_TLS.
 776
 777    This Extended operation is used to start a new TLS channel on top of a clear
 778    text channel.
 779 */
 780 #define LDB_EXTENDED_START_TLS_OID      "1.3.6.1.4.1.1466.20037"
 781
 782 /**
 783    OID for LDAP Extended Operation DYNAMIC_REFRESH.
 784
 785    This Extended operation is used to create and maintain objects which exist
 786    only a specific time, e.g. when a certain client or a certain person is
 787    logged in. Data refreshes have to be periodically sent in a specific
 788    interval. Otherwise the entry is going to be removed.
 789 */
 790 #define LDB_EXTENDED_DYNAMIC_OID        "1.3.6.1.4.1.1466.101.119.1"
 791
 792 struct ldb_sd_flags_control {
 793         /*
 794          * request the owner    0x00000001
 795          * request the group    0x00000002
 796          * request the DACL     0x00000004
 797          * request the SACL     0x00000008
 798          */
 799         unsigned secinfo_flags;
 800 };
 801
 802 /*
 803  * DOMAIN_SCOPE         0x00000001
 804  * this limits the search to one partition,
 805  * and no referrals will be returned.
 806  * (Note this doesn't limit the entries by there
 807  *  objectSid belonging to a domain! Builtin and Foreign Sids
 808  *  are still returned)
 809  *
 810  * PHANTOM_ROOT         0x00000002
 811  * this search on the whole tree on a domain controller
 812  * over multiple partitions without referrals.
 813  * (This is the default behavior on the Global Catalog Port)
 814  */
 815
 816 #define LDB_SEARCH_OPTION_DOMAIN_SCOPE 0x00000001
 817 #define LDB_SEARCH_OPTION_PHANTOM_ROOT 0x00000002
 818
 819 struct ldb_search_options_control {
 820         unsigned search_options;
 821 };
 822
 823 struct ldb_paged_control {
 824         int size;
 825         int cookie_len;
 826         char *cookie;
 827 };
 828
 829 struct ldb_extended_dn_control {
 830         int type;
 831 };
 832
 833 struct ldb_server_sort_control {
 834         const char *attributeName;
 835         const char *orderingRule;
 836         int reverse;
 837 };
 838
 839 struct ldb_sort_resp_control {
 840         int result;
 841         char *attr_desc;
 842 };
 843
 844 struct ldb_asq_control {
 845         int request;
 846         char *source_attribute;
 847         int src_attr_len;
 848         int result;
 849 };
 850
 851 struct ldb_dirsync_control {
 852         int flags;
 853         int max_attributes;
 854         int cookie_len;
 855         char *cookie;
 856 };
 857
 858 struct ldb_vlv_req_control {
 859         int beforeCount;
 860         int afterCount;
 861         int type;
 862         union {
 863                 struct {
 864                         int offset;
 865                         int contentCount;
 866                 } byOffset;
 867                 struct {
 868                         int value_len;
 869                         char *value;
 870                 } gtOrEq;
 871         } match;
 872         int ctxid_len;
 873         uint8_t *contextId;
 874 };
 875
 876 struct ldb_vlv_resp_control {
 877         int targetPosition;
 878         int contentCount;
 879         int vlv_result;
 880         int ctxid_len;
 881         uint8_t *contextId;
 882 };
 883
 884 struct ldb_verify_name_control {
 885         int flags;
 886         size_t gc_len;
 887         char *gc;
 888 };
 889
 890 struct ldb_control {
 891         const char *oid;
 892         int critical;
 893         void *data;
 894 };
 895
 896 enum ldb_request_type {
 897         LDB_SEARCH,
 898         LDB_ADD,
 899         LDB_MODIFY,
 900         LDB_DELETE,
 901         LDB_RENAME,
 902         LDB_EXTENDED,
 903         LDB_REQ_REGISTER_CONTROL,
 904         LDB_REQ_REGISTER_PARTITION
 905 };
 906
 907 enum ldb_reply_type {
 908         LDB_REPLY_ENTRY,
 909         LDB_REPLY_REFERRAL,
 910         LDB_REPLY_DONE
 911 };
 912
 913 enum ldb_wait_type {
 914         LDB_WAIT_ALL,
 915         LDB_WAIT_NONE
 916 };
 917
 918 enum ldb_state {
 919         LDB_ASYNC_INIT,
 920         LDB_ASYNC_PENDING,
 921         LDB_ASYNC_DONE
 922 };
 923
 924 struct ldb_extended {
 925         const char *oid;
 926         void *data; /* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
 927 };
 928
 929 enum ldb_sequence_type {
 930         LDB_SEQ_HIGHEST_SEQ,
 931         LDB_SEQ_HIGHEST_TIMESTAMP,
 932         LDB_SEQ_NEXT
 933 };
 934
 935 #define LDB_SEQ_GLOBAL_SEQUENCE    0x01
 936 #define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
 937
 938 struct ldb_seqnum_request {
 939         enum ldb_sequence_type type;
 940 };
 941
 942 struct ldb_seqnum_result {
 943         uint64_t seq_num;
 944         uint32_t flags;
 945 };
 946
 947 struct ldb_result {
 948         unsigned int count;
 949         struct ldb_message **msgs;
 950         struct ldb_extended *extended;
 951         struct ldb_control **controls;
 952         char **refs;
 953 };
 954
 955 struct ldb_reply {
 956         int error;
 957         enum ldb_reply_type type;
 958         struct ldb_message *message;
 959         struct ldb_extended *response;
 960         struct ldb_control **controls;
 961         char *referral;
 962 };
 963
 964 struct ldb_request;
 965 struct ldb_handle;
 966
 967 struct ldb_search {
 968         struct ldb_dn *base;
 969         enum ldb_scope scope;
 970         struct ldb_parse_tree *tree;
 971         const char * const *attrs;
 972         struct ldb_result *res;
 973 };
 974
 975 struct ldb_add {
 976         const struct ldb_message *message;
 977 };
 978
 979 struct ldb_modify {
 980         const struct ldb_message *message;
 981 };
 982
 983 struct ldb_delete {
 984         struct ldb_dn *dn;
 985 };
 986
 987 struct ldb_rename {
 988         struct ldb_dn *olddn;
 989         struct ldb_dn *newdn;
 990 };
 991
 992 struct ldb_register_control {
 993         const char *oid;
 994 };
 995
 996 struct ldb_register_partition {
 997         struct ldb_dn *dn;
 998 };
 999
1000 typedef int (*ldb_request_callback_t)(struct ldb_request *, struct ldb_reply *);
1001
1002 struct ldb_request {
1003
1004         enum ldb_request_type operation;
1005
1006         union {
1007                 struct ldb_search search;
1008                 struct ldb_add    add;
1009                 struct ldb_modify mod;
1010                 struct ldb_delete del;
1011                 struct ldb_rename rename;
1012                 struct ldb_extended extended;
1013                 struct ldb_register_control reg_control;
1014                 struct ldb_register_partition reg_partition;
1015         } op;
1016
1017         struct ldb_control **controls;
1018
1019         void *context;
1020         ldb_request_callback_t callback;
1021
1022         int timeout;
1023         time_t starttime;
1024         struct ldb_handle *handle;
1025 };
1026
1027 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
1028 int ldb_request_done(struct ldb_request *req, int status);
1029 bool ldb_request_is_done(struct ldb_request *req);
1030
1031 int ldb_modules_wait(struct ldb_handle *handle);
1032 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
1033
1034 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
1035 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
1036 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
1037 void ldb_set_modules_dir(struct ldb_context *ldb, const char *path);
1038 struct tevent_context;
1039 void ldb_set_event_context(struct ldb_context *ldb, struct tevent_context *ev);
1040 struct tevent_context * ldb_get_event_context(struct ldb_context *ldb);
1041
1042 /**
1043   Initialise ldbs' global information
1044
1045   This is required before any other LDB call
1046
1047   \return 0 if initialisation succeeded, -1 otherwise
1048 */
1049 int ldb_global_init(void);
1050
1051 /**
1052   Initialise an ldb context
1053
1054   This is required before any other LDB call.
1055
1056   \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
1057   no suitable context available.
1058
1059   \note The LDB modules will be loaded from directory specified by the environment
1060   variable LDB_MODULES_PATH. If the variable is not specified, the compiled-in default
1061   is used.
1062
1063   \return pointer to ldb_context that should be free'd (using talloc_free())
1064   at the end of the program.
1065 */
1066 struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev_ctx);
1067
1068 typedef void (*ldb_async_timeout_fn) (void *);
1069 typedef bool (*ldb_async_callback_fn) (void *);
1070 typedef int (*ldb_async_ctx_add_op_fn)(void *, time_t, void *, ldb_async_timeout_fn, ldb_async_callback_fn);
1071 typedef int (*ldb_async_ctx_wait_op_fn)(void *);
1072
1073 void ldb_async_ctx_set_private_data(struct ldb_context *ldb,
1074                                         void *private_data);
1075 void ldb_async_ctx_set_add_op(struct ldb_context *ldb,
1076                                 ldb_async_ctx_add_op_fn add_op);
1077 void ldb_async_ctx_set_wait_op(struct ldb_context *ldb,
1078                                 ldb_async_ctx_wait_op_fn wait_op);
1079
1080 /**
1081    Connect to a database.
1082
1083    This is typically called soon after ldb_init(), and is required prior to
1084    any search or database modification operations.
1085
1086    The URL can be one of the following forms:
1087     - tdb://path
1088     - ldapi://path
1089     - ldap://host
1090     - sqlite://path
1091
1092    \param ldb the context associated with the database (from ldb_init())
1093    \param url the URL of the database to connect to, as noted above
1094    \param flags a combination of LDB_FLG_* to modify the connection behaviour
1095    \param options backend specific options - passed uninterpreted to the backend
1096
1097    \return result code (LDB_SUCCESS on success, or a failure code)
1098
1099    \note It is an error to connect to a database that does not exist in readonly mode
1100    (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
1101    created if it does not exist.
1102 */
1103 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
1104
1105 /*
1106   return an automatic basedn from the rootDomainNamingContext of the rootDSE
1107   This value have been set in an opaque pointer at connection time
1108 */
1109 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
1110
1111 /*
1112   return an automatic basedn from the configurationNamingContext of the rootDSE
1113   This value have been set in an opaque pointer at connection time
1114 */
1115 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
1116
1117 /*
1118   return an automatic basedn from the schemaNamingContext of the rootDSE
1119   This value have been set in an opaque pointer at connection time
1120 */
1121 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
1122
1123 /*
1124   return an automatic baseDN from the defaultNamingContext of the rootDSE
1125   This value have been set in an opaque pointer at connection time
1126 */
1127 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
1128
1129 /**
1130   The default async search callback function
1131
1132   \param req the request we are callback of
1133   \param ares a single reply from the async core
1134
1135   \return result code (LDB_SUCCESS on success, or a failure code)
1136
1137   \note this function expects req->context to always be an struct ldb_result pointer
1138   AND a talloc context, this function will steal on the context each message
1139   from the ares reply passed on by the async core so that in the end all the
1140   messages will be in the context (ldb_result)  memory tree.
1141   Freeing the passed context (ldb_result tree) will free all the resources
1142   (the request need to be freed separately and the result doe not depend on the
1143   request that can be freed as sson as the search request is finished)
1144 */
1145
1146 int ldb_search_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1147
1148 /**
1149   The default async extended operation callback function
1150
1151   \param req the request we are callback of
1152   \param ares a single reply from the async core
1153
1154   \return result code (LDB_SUCCESS on success, or a failure code)
1155 */
1156 int ldb_op_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1157
1158 int ldb_modify_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1159
1160 /**
1161   Helper function to build a search request
1162
1163   \param ret_req the request structure is returned here (talloced on mem_ctx)
1164   \param ldb the context associated with the database (from ldb_init())
1165   \param mem_ctx a talloc memory context (used as parent of ret_req)
1166   \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1167   \param scope the search scope for the query
1168   \param expression the search expression to use for this query
1169   \param attrs the search attributes for the query (pass NULL if none required)
1170   \param controls an array of controls
1171   \param context the callback function context
1172   \param the callback function to handle the async replies
1173   \param the parent request if any
1174
1175   \return result code (LDB_SUCCESS on success, or a failure code)
1176 */
1177
1178 int ldb_build_search_req(struct ldb_request **ret_req,
1179                         struct ldb_context *ldb,
1180                         TALLOC_CTX *mem_ctx,
1181                         struct ldb_dn *base,
1182                         enum ldb_scope scope,
1183                         const char *expression,
1184                         const char * const *attrs,
1185                         struct ldb_control **controls,
1186                         void *context,
1187                         ldb_request_callback_t callback,
1188                         struct ldb_request *parent);
1189
1190 int ldb_build_search_req_ex(struct ldb_request **ret_req,
1191                         struct ldb_context *ldb,
1192                         TALLOC_CTX *mem_ctx,
1193                         struct ldb_dn *base,
1194                         enum ldb_scope scope,
1195                         struct ldb_parse_tree *tree,
1196                         const char * const *attrs,
1197                         struct ldb_control **controls,
1198                         void *context,
1199                         ldb_request_callback_t callback,
1200                         struct ldb_request *parent);
1201
1202 /**
1203   Helper function to build an add request
1204
1205   \param ret_req the request structure is returned here (talloced on mem_ctx)
1206   \param ldb the context associated with the database (from ldb_init())
1207   \param mem_ctx a talloc memory context (used as parent of ret_req)
1208   \param message contains the entry to be added
1209   \param controls an array of controls
1210   \param context the callback function context
1211   \param the callback function to handle the async replies
1212   \param the parent request if any
1213
1214   \return result code (LDB_SUCCESS on success, or a failure code)
1215 */
1216
1217 int ldb_build_add_req(struct ldb_request **ret_req,
1218                         struct ldb_context *ldb,
1219                         TALLOC_CTX *mem_ctx,
1220                         const struct ldb_message *message,
1221                         struct ldb_control **controls,
1222                         void *context,
1223                         ldb_request_callback_t callback,
1224                         struct ldb_request *parent);
1225
1226 /**
1227   Helper function to build a modify request
1228
1229   \param ret_req the request structure is returned here (talloced on mem_ctx)
1230   \param ldb the context associated with the database (from ldb_init())
1231   \param mem_ctx a talloc memory context (used as parent of ret_req)
1232   \param message contains the entry to be modified
1233   \param controls an array of controls
1234   \param context the callback function context
1235   \param the callback function to handle the async replies
1236   \param the parent request if any
1237
1238   \return result code (LDB_SUCCESS on success, or a failure code)
1239 */
1240
1241 int ldb_build_mod_req(struct ldb_request **ret_req,
1242                         struct ldb_context *ldb,
1243                         TALLOC_CTX *mem_ctx,
1244                         const struct ldb_message *message,
1245                         struct ldb_control **controls,
1246                         void *context,
1247                         ldb_request_callback_t callback,
1248                         struct ldb_request *parent);
1249
1250 /**
1251   Helper function to build a delete request
1252
1253   \param ret_req the request structure is returned here (talloced on mem_ctx)
1254   \param ldb the context associated with the database (from ldb_init())
1255   \param mem_ctx a talloc memory context (used as parent of ret_req)
1256   \param dn the DN to be deleted
1257   \param controls an array of controls
1258   \param context the callback function context
1259   \param the callback function to handle the async replies
1260   \param the parent request if any
1261
1262   \return result code (LDB_SUCCESS on success, or a failure code)
1263 */
1264
1265 int ldb_build_del_req(struct ldb_request **ret_req,
1266                         struct ldb_context *ldb,
1267                         TALLOC_CTX *mem_ctx,
1268                         struct ldb_dn *dn,
1269                         struct ldb_control **controls,
1270                         void *context,
1271                         ldb_request_callback_t callback,
1272                         struct ldb_request *parent);
1273
1274 /**
1275   Helper function to build a rename request
1276
1277   \param ret_req the request structure is returned here (talloced on mem_ctx)
1278   \param ldb the context associated with the database (from ldb_init())
1279   \param mem_ctx a talloc memory context (used as parent of ret_req)
1280   \param olddn the old DN
1281   \param newdn the new DN
1282   \param controls an array of controls
1283   \param context the callback function context
1284   \param the callback function to handle the async replies
1285   \param the parent request if any
1286
1287   \return result code (LDB_SUCCESS on success, or a failure code)
1288 */
1289
1290 int ldb_build_rename_req(struct ldb_request **ret_req,
1291                         struct ldb_context *ldb,
1292                         TALLOC_CTX *mem_ctx,
1293                         struct ldb_dn *olddn,
1294                         struct ldb_dn *newdn,
1295                         struct ldb_control **controls,
1296                         void *context,
1297                         ldb_request_callback_t callback,
1298                         struct ldb_request *parent);
1299
1300 /**
1301   Add a ldb_control to a ldb_request
1302
1303   \param req the request struct where to add the control
1304   \param oid the object identifier of the control as string
1305   \param critical whether the control should be critical or not
1306   \param data a talloc pointer to the control specific data
1307
1308   \return result code (LDB_SUCCESS on success, or a failure code)
1309 */
1310 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1311
1312 /**
1313   replace a ldb_control in a ldb_request
1314
1315   \param req the request struct where to add the control
1316   \param oid the object identifier of the control as string
1317   \param critical whether the control should be critical or not
1318   \param data a talloc pointer to the control specific data
1319
1320   \return result code (LDB_SUCCESS on success, or a failure code)
1321 */
1322 int ldb_request_replace_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1323
1324 /**
1325    check if a control with the specified "oid" exist and return it
1326   \param req the request struct where to add the control
1327   \param oid the object identifier of the control as string
1328
1329   \return the control, NULL if not found
1330 */
1331 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid);
1332
1333 /**
1334    check if a control with the specified "oid" exist and return it
1335   \param rep the reply struct where to add the control
1336   \param oid the object identifier of the control as string
1337
1338   \return the control, NULL if not found
1339 */
1340 struct ldb_control *ldb_reply_get_control(struct ldb_reply *rep, const char *oid);
1341
1342 /**
1343   Search the database
1344
1345   This function searches the database, and returns
1346   records that match an LDAP-like search expression
1347
1348   \param ldb the context associated with the database (from ldb_init())
1349   \param mem_ctx the memory context to use for the request and the results
1350   \param result the return result
1351   \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1352   \param scope the search scope for the query
1353   \param attrs the search attributes for the query (pass NULL if none required)
1354   \param exp_fmt the search expression to use for this query (printf like)
1355
1356   \return result code (LDB_SUCCESS on success, or a failure code)
1357
1358   \note use talloc_free() to free the ldb_result returned
1359 */
1360 int ldb_search(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1361                struct ldb_result **result, struct ldb_dn *base,
1362                enum ldb_scope scope, const char * const *attrs,
1363                const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1364
1365 /**
1366   Add a record to the database.
1367
1368   This function adds a record to the database. This function will fail
1369   if a record with the specified class and key already exists in the
1370   database.
1371
1372   \param ldb the context associated with the database (from
1373   ldb_init())
1374   \param message the message containing the record to add.
1375
1376   \return result code (LDB_SUCCESS if the record was added, otherwise
1377   a failure code)
1378 */
1379 int ldb_add(struct ldb_context *ldb,
1380             const struct ldb_message *message);
1381
1382 /**
1383   Modify the specified attributes of a record
1384
1385   This function modifies a record that is in the database.
1386
1387   \param ldb the context associated with the database (from
1388   ldb_init())
1389   \param message the message containing the changes required.
1390
1391   \return result code (LDB_SUCCESS if the record was modified as
1392   requested, otherwise a failure code)
1393 */
1394 int ldb_modify(struct ldb_context *ldb,
1395                const struct ldb_message *message);
1396
1397 /**
1398   Rename a record in the database
1399
1400   This function renames a record in the database.
1401
1402   \param ldb the context associated with the database (from
1403   ldb_init())
1404   \param olddn the DN for the record to be renamed.
1405   \param newdn the new DN
1406
1407   \return result code (LDB_SUCCESS if the record was renamed as
1408   requested, otherwise a failure code)
1409 */
1410 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1411
1412 /**
1413   Delete a record from the database
1414
1415   This function deletes a record from the database.
1416
1417   \param ldb the context associated with the database (from
1418   ldb_init())
1419   \param dn the DN for the record to be deleted.
1420
1421   \return result code (LDB_SUCCESS if the record was deleted,
1422   otherwise a failure code)
1423 */
1424 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1425
1426 /**
1427   The default async extended operation callback function
1428
1429   \param req the request we are callback of
1430   \param ares a single reply from the async core
1431
1432   \return result code (LDB_SUCCESS on success, or a failure code)
1433
1434   \note this function expects req->context to always be an struct ldb_result pointer
1435   AND a talloc context, this function will steal on the context each message
1436   from the ares reply passed on by the async core so that in the end all the
1437   messages will be in the context (ldb_result)  memory tree.
1438   Freeing the passed context (ldb_result tree) will free all the resources
1439   (the request need to be freed separately and the result doe not depend on the
1440   request that can be freed as sson as the search request is finished)
1441 */
1442
1443 int ldb_extended_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1444
1445
1446 /**
1447   Helper function to build a extended request
1448
1449   \param ret_req the request structure is returned here (talloced on mem_ctx)
1450   \param ldb the context associated with the database (from ldb_init())
1451   \param mem_ctx a talloc memory context (used as parent of ret_req)
1452   \param oid the OID of the extended operation.
1453   \param data a void pointer a the extended operation specific parameters,
1454   it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1455   \param controls an array of controls
1456   \param context the callback function context
1457   \param the callback function to handle the async replies
1458   \param the parent request if any
1459
1460   \return result code (LDB_SUCCESS on success, or a failure code)
1461 */
1462 int ldb_build_extended_req(struct ldb_request **ret_req,
1463                            struct ldb_context *ldb,
1464                            TALLOC_CTX *mem_ctx,
1465                            const char *oid,
1466                            void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1467                            struct ldb_control **controls,
1468                            void *context,
1469                            ldb_request_callback_t callback,
1470                            struct ldb_request *parent);
1471
1472 /**
1473   call an extended operation
1474
1475   \param ldb the context associated with the database (from ldb_init())
1476   \param oid the OID of the extended operation.
1477   \param data a void pointer a the extended operation specific parameters,
1478   it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1479   \param res the result of the extended operation
1480
1481   \return result code (LDB_SUCCESS if the extended operation returned fine,
1482   otherwise a failure code)
1483 */
1484 int ldb_extended(struct ldb_context *ldb,
1485                  const char *oid,
1486                  void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1487                  struct ldb_result **res);
1488
1489 /**
1490   Obtain current/next database sequence number
1491 */
1492 int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num);
1493
1494 /**
1495   start a transaction
1496 */
1497 int ldb_transaction_start(struct ldb_context *ldb);
1498
1499 /**
1500    first phase of two phase commit
1501  */
1502 int ldb_transaction_prepare_commit(struct ldb_context *ldb);
1503
1504 /**
1505   commit a transaction
1506 */
1507 int ldb_transaction_commit(struct ldb_context *ldb);
1508
1509 /**
1510   cancel a transaction
1511 */
1512 int ldb_transaction_cancel(struct ldb_context *ldb);
1513
1514 /*
1515   cancel a transaction with no error if no transaction is pending
1516   used when we fork() to clear any parent transactions
1517 */
1518 int ldb_transaction_cancel_noerr(struct ldb_context *ldb);
1519
1520
1521 /**
1522   return extended error information from the last call
1523 */
1524 const char *ldb_errstring(struct ldb_context *ldb);
1525
1526 /**
1527   return a string explaining what a ldb error constant meancs
1528 */
1529 const char *ldb_strerror(int ldb_err);
1530
1531 /**
1532   setup the default utf8 functions
1533   FIXME: these functions do not yet handle utf8
1534 */
1535 void ldb_set_utf8_default(struct ldb_context *ldb);
1536
1537 /**
1538    Casefold a string
1539
1540    \param ldb the ldb context
1541    \param mem_ctx the memory context to allocate the result string
1542    memory from.
1543    \param s the string that is to be folded
1544    \return a copy of the string, converted to upper case
1545
1546    \note The default function is not yet UTF8 aware. Provide your own
1547          set of functions through ldb_set_utf8_fns()
1548 */
1549 char *ldb_casefold(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s, size_t n);
1550
1551 /**
1552    Check the attribute name is valid according to rfc2251
1553    \param s the string to check
1554
1555    \return 1 if the name is ok
1556 */
1557 int ldb_valid_attr_name(const char *s);
1558
1559 /*
1560   ldif manipulation functions
1561 */
1562
1563 /**
1564    Write an LDIF message
1565
1566    This function writes an LDIF message using a caller supplied  write
1567    function.
1568
1569    \param ldb the ldb context (from ldb_init())
1570    \param fprintf_fn a function pointer for the write function. This must take
1571    a private data pointer, followed by a format string, and then a variable argument
1572    list.
1573    \param private_data pointer that will be provided back to the write
1574    function. This is useful for maintaining state or context.
1575    \param ldif the message to write out
1576
1577    \return the total number of bytes written, or an error code as returned
1578    from the write function.
1579
1580    \sa ldb_ldif_write_file for a more convenient way to write to a
1581    file stream.
1582
1583    \sa ldb_ldif_read for the reader equivalent to this function.
1584 */
1585 int ldb_ldif_write(struct ldb_context *ldb,
1586                    int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1587                    void *private_data,
1588                    const struct ldb_ldif *ldif);
1589
1590 /**
1591    Clean up an LDIF message
1592
1593    This function cleans up a LDIF message read using ldb_ldif_read()
1594    or related functions (such as ldb_ldif_read_string() and
1595    ldb_ldif_read_file().
1596
1597    \param ldb the ldb context (from ldb_init())
1598    \param msg the message to clean up and free
1599
1600 */
1601 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1602
1603 /**
1604    Read an LDIF message
1605
1606    This function creates an LDIF message using a caller supplied read
1607    function.
1608
1609    \param ldb the ldb context (from ldb_init())
1610    \param fgetc_fn a function pointer for the read function. This must
1611    take a private data pointer, and must return a pointer to an
1612    integer corresponding to the next byte read (or EOF if there is no
1613    more data to be read).
1614    \param private_data pointer that will be provided back to the read
1615    function. This is udeful for maintaining state or context.
1616
1617    \return the LDIF message that has been read in
1618
1619    \note You must free the LDIF message when no longer required, using
1620    ldb_ldif_read_free().
1621
1622    \sa ldb_ldif_read_file for a more convenient way to read from a
1623    file stream.
1624
1625    \sa ldb_ldif_read_string for a more convenient way to read from a
1626    string (char array).
1627
1628    \sa ldb_ldif_write for the writer equivalent to this function.
1629 */
1630 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1631                                int (*fgetc_fn)(void *), void *private_data);
1632
1633 /**
1634    Read an LDIF message from a file
1635
1636    This function reads the next LDIF message from the contents of a
1637    file stream. If you want to get all of the LDIF messages, you will
1638    need to repeatedly call this function, until it returns NULL.
1639
1640    \param ldb the ldb context (from ldb_init())
1641    \param f the file stream to read from (typically from fdopen())
1642
1643    \sa ldb_ldif_read_string for an equivalent function that will read
1644    from a string (char array).
1645
1646    \sa ldb_ldif_write_file for the writer equivalent to this function.
1647
1648 */
1649 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1650
1651 /**
1652    Read an LDIF message from a string
1653
1654    This function reads the next LDIF message from the contents of a char
1655    array. If you want to get all of the LDIF messages, you will need
1656    to repeatedly call this function, until it returns NULL.
1657
1658    \param ldb the ldb context (from ldb_init())
1659    \param s pointer to the char array to read from
1660
1661    \sa ldb_ldif_read_file for an equivalent function that will read
1662    from a file stream.
1663
1664    \sa ldb_ldif_write for a more general (arbitrary read function)
1665    version of this function.
1666 */
1667 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1668
1669 /**
1670    Parse a modrdn LDIF message from a struct ldb_message
1671
1672    \param ldb the ldb context (from ldb_init())
1673    \param ldif the preparsed LDIF chunk (from ldb_ldif_read())
1674
1675    \param mem_ctx the memory context that's used for return values
1676
1677    \param olddn the old dn as struct ldb_dn, if not needed pass NULL
1678    \param newrdn the new rdn as struct ldb_dn, if not needed pass NULL
1679    \param deleteoldrdn the deleteoldrdn value as bool, if not needed pass NULL
1680    \param newsuperior the newsuperior dn as struct ldb_dn, if not needed pass NULL
1681                       *newsuperior can be NULL as it is optional in the LDIF
1682    \param newdn the full constructed new dn as struct ldb_dn, if not needed pass NULL
1683
1684 */
1685 int ldb_ldif_parse_modrdn(struct ldb_context *ldb,
1686                           const struct ldb_ldif *ldif,
1687                           TALLOC_CTX *mem_ctx,
1688                           struct ldb_dn **olddn,
1689                           struct ldb_dn **newrdn,
1690                           bool *deleteoldrdn,
1691                           struct ldb_dn **newsuperior,
1692                           struct ldb_dn **newdn);
1693
1694 /**
1695    Write an LDIF message to a file
1696
1697    \param ldb the ldb context (from ldb_init())
1698    \param f the file stream to write to (typically from fdopen())
1699    \param msg the message to write out
1700
1701    \return the total number of bytes written, or a negative error code
1702
1703    \sa ldb_ldif_read_file for the reader equivalent to this function.
1704 */
1705 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1706
1707 /**
1708    Write an LDIF message to a string
1709
1710    \param ldb the ldb context (from ldb_init())
1711    \param mem_ctx the talloc context on which to attach the string)
1712    \param msg the message to write out
1713
1714    \return the string containing the LDIF, or NULL on error
1715
1716    \sa ldb_ldif_read_string for the reader equivalent to this function.
1717 */
1718 char * ldb_ldif_write_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1719                           const struct ldb_ldif *msg);
1720
1721
1722 /*
1723    Produce a string form of an ldb message
1724
1725    convenient function to turn a ldb_message into a string. Useful for
1726    debugging
1727  */
1728 char *ldb_ldif_message_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1729                               enum ldb_changetype changetype,
1730                               const struct ldb_message *msg);
1731
1732
1733 /**
1734    Base64 encode a buffer
1735
1736    \param mem_ctx the memory context that the result is allocated
1737    from.
1738    \param buf pointer to the array that is to be encoded
1739    \param len the number of elements in the array to be encoded
1740
1741    \return pointer to an array containing the encoded data
1742
1743    \note The caller is responsible for freeing the result
1744 */
1745 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len);
1746
1747 /**
1748    Base64 decode a buffer
1749
1750    This function decodes a base64 encoded string in place.
1751
1752    \param s the string to decode.
1753
1754    \return the length of the returned (decoded) string.
1755
1756    \note the string is null terminated, but the null terminator is not
1757    included in the length.
1758 */
1759 int ldb_base64_decode(char *s);
1760
1761 /* The following definitions come from lib/ldb/common/ldb_dn.c  */
1762
1763 /**
1764   Get the linear form of a DN (without any extended components)
1765
1766   \param dn The DN to linearize
1767 */
1768
1769 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1770
1771 /**
1772   Allocate a copy of the linear form of a DN (without any extended components) onto the supplied memory context
1773
1774   \param dn The DN to linearize
1775   \param mem_ctx TALLOC context to return result on
1776 */
1777
1778 char *ldb_dn_alloc_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1779
1780 /**
1781   Get the linear form of a DN (with any extended components)
1782
1783   \param mem_ctx TALLOC context to return result on
1784   \param dn The DN to linearize
1785   \param mode Style of extended DN to return (0 is HEX representation of binary form, 1 is a string form)
1786 */
1787 char *ldb_dn_get_extended_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn, int mode);
1788 const struct ldb_val *ldb_dn_get_extended_component(struct ldb_dn *dn, const char *name);
1789 int ldb_dn_set_extended_component(struct ldb_dn *dn, const char *name, const struct ldb_val *val);
1790 void ldb_dn_extended_filter(struct ldb_dn *dn, const char * const *accept_list);
1791 void ldb_dn_remove_extended_components(struct ldb_dn *dn);
1792 bool ldb_dn_has_extended(struct ldb_dn *dn);
1793
1794 int ldb_dn_extended_add_syntax(struct ldb_context *ldb,
1795                                unsigned flags,
1796                                const struct ldb_dn_extended_syntax *syntax);
1797
1798 /**
1799   Allocate a new DN from a string
1800
1801   \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1802   \param dn The new DN
1803
1804   \note The DN will not be parsed at this time.  Use ldb_dn_validate to tell if the DN is syntacticly correct
1805 */
1806
1807 struct ldb_dn *ldb_dn_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn);
1808 /**
1809   Allocate a new DN from a printf style format string and arguments
1810
1811   \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1812   \param new_fms The new DN as a format string (plus arguments)
1813
1814   \note The DN will not be parsed at this time.  Use ldb_dn_validate to tell if the DN is syntacticly correct
1815 */
1816
1817 struct ldb_dn *ldb_dn_new_fmt(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1818 /**
1819   Allocate a new DN from a struct ldb_val (useful to avoid buffer overrun)
1820
1821   \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1822   \param dn The new DN
1823
1824   \note The DN will not be parsed at this time.  Use ldb_dn_validate to tell if the DN is syntacticly correct
1825 */
1826
1827 struct ldb_dn *ldb_dn_from_ldb_val(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const struct ldb_val *strdn);
1828
1829 /**
1830   Determine if this DN is syntactically valid
1831
1832   \param dn The DN to validate
1833 */
1834
1835 bool ldb_dn_validate(struct ldb_dn *dn);
1836
1837 char *ldb_dn_escape_value(TALLOC_CTX *mem_ctx, struct ldb_val value);
1838 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1839 char *ldb_dn_alloc_casefold(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1840
1841 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1842 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1843
1844 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1845 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1846 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1847 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1848 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1849 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1850
1851 struct ldb_dn *ldb_dn_copy(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1852 struct ldb_dn *ldb_dn_get_parent(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1853 char *ldb_dn_canonical_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1854 char *ldb_dn_canonical_ex_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1855 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1856 int ldb_dn_get_extended_comp_num(struct ldb_dn *dn);
1857 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1858 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1859 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1860 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1861 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1862
1863 bool ldb_dn_is_valid(struct ldb_dn *dn);
1864 bool ldb_dn_is_special(struct ldb_dn *dn);
1865 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1866 bool ldb_dn_is_null(struct ldb_dn *dn);
1867 int ldb_dn_update_components(struct ldb_dn *dn, const struct ldb_dn *ref_dn);
1868
1869
1870 /**
1871    Compare two attributes
1872
1873    This function compares to attribute names. Note that this is a
1874    case-insensitive comparison.
1875
1876    \param a the first attribute name to compare
1877    \param b the second attribute name to compare
1878
1879    \return 0 if the attribute names are the same, or only differ in
1880    case; non-zero if there are any differences
1881
1882   attribute names are restricted by rfc2251 so using
1883   strcasecmp and toupper here is ok.
1884   return 0 for match
1885 */
1886 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1887 char *ldb_attr_casefold(TALLOC_CTX *mem_ctx, const char *s);
1888 int ldb_attr_dn(const char *attr);
1889
1890 /**
1891    Create an empty message
1892
1893    \param mem_ctx the memory context to create in. You can pass NULL
1894    to get the top level context, however the ldb context (from
1895    ldb_init()) may be a better choice
1896 */
1897 struct ldb_message *ldb_msg_new(TALLOC_CTX *mem_ctx);
1898
1899 /**
1900    Find an element within an message
1901 */
1902 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1903                                                  const char *attr_name);
1904
1905 /**
1906    Compare two ldb_val values
1907
1908    \param v1 first ldb_val structure to be tested
1909    \param v2 second ldb_val structure to be tested
1910
1911    \return 1 for a match, 0 if there is any difference
1912 */
1913 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1914
1915 /**
1916    find a value within an ldb_message_element
1917
1918    \param el the element to search
1919    \param val the value to search for
1920
1921    \note This search is case sensitive
1922 */
1923 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1924                                  struct ldb_val *val);
1925
1926 /**
1927    add a new empty element to a ldb_message
1928 */
1929 int ldb_msg_add_empty(struct ldb_message *msg,
1930                 const char *attr_name,
1931                 int flags,
1932                 struct ldb_message_element **return_el);
1933
1934 /**
1935    add a element to a ldb_message
1936 */
1937 int ldb_msg_add(struct ldb_message *msg,
1938                 const struct ldb_message_element *el,
1939                 int flags);
1940 int ldb_msg_add_value(struct ldb_message *msg,
1941                 const char *attr_name,
1942                 const struct ldb_val *val,
1943                 struct ldb_message_element **return_el);
1944 int ldb_msg_add_steal_value(struct ldb_message *msg,
1945                       const char *attr_name,
1946                       struct ldb_val *val);
1947 int ldb_msg_add_steal_string(struct ldb_message *msg,
1948                              const char *attr_name, char *str);
1949 int ldb_msg_add_string(struct ldb_message *msg,
1950                        const char *attr_name, const char *str);
1951 int ldb_msg_add_linearized_dn(struct ldb_message *msg, const char *attr_name,
1952                               struct ldb_dn *dn);
1953 int ldb_msg_add_fmt(struct ldb_message *msg,
1954                     const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1955
1956 /**
1957    compare two message elements - return 0 on match
1958 */
1959 int ldb_msg_element_compare(struct ldb_message_element *el1,
1960                             struct ldb_message_element *el2);
1961 int ldb_msg_element_compare_name(struct ldb_message_element *el1,
1962                                  struct ldb_message_element *el2);
1963
1964 /**
1965    Find elements in a message.
1966
1967    This function finds elements and converts to a specific type, with
1968    a give default value if not found. Assumes that elements are
1969    single valued.
1970 */
1971 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1972 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1973                              const char *attr_name,
1974                              int default_value);
1975 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1976                                        const char *attr_name,
1977                                        unsigned int default_value);
1978 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1979                                    const char *attr_name,
1980                                    int64_t default_value);
1981 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1982                                      const char *attr_name,
1983                                      uint64_t default_value);
1984 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1985                                    const char *attr_name,
1986                                    double default_value);
1987 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1988                               const char *attr_name,
1989                               int default_value);
1990 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1991                                         const char *attr_name,
1992                                         const char *default_value);
1993
1994 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1995                                        TALLOC_CTX *mem_ctx,
1996                                        const struct ldb_message *msg,
1997                                        const char *attr_name);
1998
1999 void ldb_msg_sort_elements(struct ldb_message *msg);
2000
2001 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx,
2002                                          const struct ldb_message *msg);
2003 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx,
2004                                  const struct ldb_message *msg);
2005
2006 /*
2007  * ldb_msg_canonicalize() is now depreciated
2008  * Please use ldb_msg_normalize() instead
2009  *
2010  * NOTE: Returned ldb_message object is allocated
2011  * into *ldb's context. Callers are recommended
2012  * to steal the returned object into a TALLOC_CTX
2013  * with short lifetime.
2014  */
2015 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
2016                                          const struct ldb_message *msg) _DEPRECATED_;
2017
2018 int ldb_msg_normalize(struct ldb_context *ldb,
2019                       TALLOC_CTX *mem_ctx,
2020                       const struct ldb_message *msg,
2021                       struct ldb_message **_msg_out);
2022
2023
2024 /*
2025  * ldb_msg_diff() is now depreciated
2026  * Please use ldb_msg_difference() instead
2027  *
2028  * NOTE: Returned ldb_message object is allocated
2029  * into *ldb's context. Callers are recommended
2030  * to steal the returned object into a TALLOC_CTX
2031  * with short lifetime.
2032  */
2033 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
2034                                  struct ldb_message *msg1,
2035                                  struct ldb_message *msg2) _DEPRECATED_;
2036
2037 /**
2038  * return a ldb_message representing the differences between msg1 and msg2.
2039  * If you then use this in a ldb_modify() call,
2040  * it can be used to save edits to a message
2041  *
2042  * Result message is constructed as follows:
2043  * - LDB_FLAG_MOD_ADD     - elements found only in msg2
2044  * - LDB_FLAG_MOD_REPLACE - elements in msg2 that have
2045  *                          different value in msg1
2046  *                          Value for msg2 element is used
2047  * - LDB_FLAG_MOD_DELETE  - elements found only in msg2
2048  *
2049  * @return LDB_SUCCESS or LDB_ERR_OPERATIONS_ERROR
2050  */
2051 int ldb_msg_difference(struct ldb_context *ldb,
2052                        TALLOC_CTX *mem_ctx,
2053                        struct ldb_message *msg1,
2054                        struct ldb_message *msg2,
2055                        struct ldb_message **_msg_out);
2056
2057 /**
2058    Tries to find a certain string attribute in a message
2059
2060    \param msg the message to check
2061    \param name attribute name
2062    \param value attribute value
2063
2064    \return 1 on match and 0 otherwise.
2065 */
2066 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
2067                                    const char *name,
2068                                    const char *value);
2069
2070 /**
2071    Integrity check an ldb_message
2072
2073    This function performs basic sanity / integrity checks on an
2074    ldb_message.
2075
2076    \param ldb context in which to perform the checks
2077    \param msg the message to check
2078
2079    \return LDB_SUCCESS if the message is OK, or a non-zero error code
2080    (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
2081    LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
2082    message.
2083 */
2084 int ldb_msg_sanity_check(struct ldb_context *ldb,
2085                          const struct ldb_message *msg);
2086
2087 /**
2088    Duplicate an ldb_val structure
2089
2090    This function copies an ldb value structure.
2091
2092    \param mem_ctx the memory context that the duplicated value will be
2093    allocated from
2094    \param v the ldb_val to be duplicated.
2095
2096    \return the duplicated ldb_val structure.
2097 */
2098 struct ldb_val ldb_val_dup(TALLOC_CTX *mem_ctx, const struct ldb_val *v);
2099
2100 /**
2101   this allows the user to set a debug function for error reporting
2102 */
2103 int ldb_set_debug(struct ldb_context *ldb,
2104                   void (*debug)(void *context, enum ldb_debug_level level,
2105                                 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
2106                   void *context);
2107
2108 /**
2109   this allows the user to set custom utf8 function for error reporting
2110 */
2111 void ldb_set_utf8_fns(struct ldb_context *ldb,
2112                       void *context,
2113                       char *(*casefold)(void *, void *, const char *, size_t n));
2114
2115 /**
2116    this sets up debug to print messages on stderr
2117 */
2118 int ldb_set_debug_stderr(struct ldb_context *ldb);
2119
2120 /* control backend specific opaque values */
2121 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
2122 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
2123
2124 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs);
2125 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr);
2126 int ldb_attr_in_list(const char * const *attrs, const char *attr);
2127
2128 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
2129 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
2130 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
2131 void ldb_msg_remove_element(struct ldb_message *msg, struct ldb_message_element *el);
2132
2133
2134 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
2135                                  const char *attr,
2136                                  const char *replace);
2137
2138 /*
2139   shallow copy a tree - copying only the elements array so that the caller
2140   can safely add new elements without changing the message
2141 */
2142 struct ldb_parse_tree *ldb_parse_tree_copy_shallow(TALLOC_CTX *mem_ctx,
2143                                                    const struct ldb_parse_tree *ot);
2144
2145 /**
2146    Convert a time structure to a string
2147
2148    This function converts a time_t structure to an LDAP formatted
2149    GeneralizedTime string.
2150
2151    \param mem_ctx the memory context to allocate the return string in
2152    \param t the time structure to convert
2153
2154    \return the formatted string, or NULL if the time structure could
2155    not be converted
2156 */
2157 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t);
2158
2159 /**
2160    Convert a string to a time structure
2161
2162    This function converts an LDAP formatted GeneralizedTime string
2163    to a time_t structure.
2164
2165    \param s the string to convert
2166
2167    \return the time structure, or 0 if the string cannot be converted
2168 */
2169 time_t ldb_string_to_time(const char *s);
2170
2171 /**
2172   convert a LDAP GeneralizedTime string in ldb_val format to a
2173   time_t.
2174 */
2175 int ldb_val_to_time(const struct ldb_val *v, time_t *t);
2176
2177 /**
2178    Convert a time structure to a string
2179
2180    This function converts a time_t structure to an LDAP formatted
2181    UTCTime string.
2182
2183    \param mem_ctx the memory context to allocate the return string in
2184    \param t the time structure to convert
2185
2186    \return the formatted string, or NULL if the time structure could
2187    not be converted
2188 */
2189 char *ldb_timestring_utc(TALLOC_CTX *mem_ctx, time_t t);
2190
2191 /**
2192    Convert a string to a time structure
2193
2194    This function converts an LDAP formatted UTCTime string
2195    to a time_t structure.
2196
2197    \param s the string to convert
2198
2199    \return the time structure, or 0 if the string cannot be converted
2200 */
2201 time_t ldb_string_utc_to_time(const char *s);
2202
2203
2204 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
2205
2206 #ifndef discard_const
2207 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
2208 #endif
2209
2210 /*
2211   a wrapper around ldb_qsort() that ensures the comparison function is
2212   type safe. This will produce a compilation warning if the types
2213   don't match
2214  */
2215 #define LDB_TYPESAFE_QSORT(base, numel, opaque, comparison)     \
2216 do { \
2217         if (numel > 1) { \
2218                 ldb_qsort(base, numel, sizeof((base)[0]), discard_const(opaque), (ldb_qsort_cmp_fn_t)comparison); \
2219                 comparison(&((base)[0]), &((base)[1]), opaque);         \
2220         } \
2221 } while (0)
2222
2223 /* allow ldb to also call TYPESAFE_QSORT() */
2224 #ifndef TYPESAFE_QSORT
2225 #define TYPESAFE_QSORT(base, numel, comparison) \
2226 do { \
2227         if (numel > 1) { \
2228                 qsort(base, numel, sizeof((base)[0]), (int (*)(const void *, const void *))comparison); \
2229                 comparison(&((base)[0]), &((base)[1])); \
2230         } \
2231 } while (0)
2232 #endif
2233
2234
2235
2236 /**
2237    Convert a control into its string representation.
2238
2239    \param mem_ctx TALLOC context to return result on, and to allocate error_string on
2240    \param control A struct ldb_control to convert
2241
2242    \return string representation of the control
2243 */
2244 char* ldb_control_to_string(TALLOC_CTX *mem_ctx, const struct ldb_control *control);
2245 /**
2246    Convert a string representing a control into a ldb_control structure
2247
2248    \param ldb LDB context
2249    \param mem_ctx TALLOC context to return result on, and to allocate error_string on
2250    \param control_strings A string-formatted control
2251
2252    \return a ldb_control element
2253 */
2254 struct ldb_control *ldb_parse_control_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *control_strings);
2255 /**
2256    Convert an array of string represention of a control into an array of ldb_control structures
2257
2258    \param ldb LDB context
2259    \param mem_ctx TALLOC context to return result on, and to allocate error_string on
2260    \param control_strings Array of string-formatted controls
2261
2262    \return array of ldb_control elements
2263 */
2264 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings);
2265
2266 /**
2267    return the ldb flags
2268 */
2269 unsigned int ldb_get_flags(struct ldb_context *ldb);
2270
2271 /* set the ldb flags */
2272 void ldb_set_flags(struct ldb_context *ldb, unsigned flags);
2273
2274
2275 struct ldb_dn *ldb_dn_binary_from_ldb_val(TALLOC_CTX *mem_ctx,
2276                                           struct ldb_context *ldb,
2277                                           const struct ldb_val *strdn);
2278
2279 int ldb_dn_get_binary(struct ldb_dn *dn, struct ldb_val *val);
2280 int ldb_dn_set_binary(struct ldb_dn *dn, struct ldb_val *val);
2281
2282 /* debugging functions for ldb requests */
2283 void ldb_req_set_location(struct ldb_request *req, const char *location);
2284 const char *ldb_req_location(struct ldb_request *req);
2285
2286 /* set the location marker on a request handle - used for debugging */
2287 #define LDB_REQ_SET_LOCATION(req) ldb_req_set_location(req, __location__)
2288
2289 /*
2290   minimise a DN. The caller must pass in a validated DN.
2291
2292   If the DN has an extended component then only the first extended
2293   component is kept, the DN string is stripped.
2294
2295   The existing dn is modified
2296  */
2297 bool ldb_dn_minimise(struct ldb_dn *dn);
2298
2299 /*
2300   compare a ldb_val to a string
2301 */
2302 int ldb_val_string_cmp(const struct ldb_val *v, const char *str);
2303
2304 #endif