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