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