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 /**
1037    Connect to a database.
1038
1039    This is typically called soon after ldb_init(), and is required prior to
1040    any search or database modification operations.
1041
1042    The URL can be one of the following forms:
1043     - tdb://path
1044     - ldapi://path
1045     - ldap://host
1046     - sqlite://path
1047
1048    \param ldb the context associated with the database (from ldb_init())
1049    \param url the URL of the database to connect to, as noted above
1050    \param flags a combination of LDB_FLG_* to modify the connection behaviour
1051    \param options backend specific options - passed uninterpreted to the backend
1052
1053    \return result code (LDB_SUCCESS on success, or a failure code)
1054
1055    \note It is an error to connect to a database that does not exist in readonly mode
1056    (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
1057    created if it does not exist.
1058 */
1059
1060 typedef void (*ldb_async_timeout_fn) (void *);
1061 typedef bool (*ldb_async_callback_fn) (void *);
1062 typedef int (*ldb_async_ctx_add_op_fn)(void *, time_t, void *, ldb_async_timeout_fn, ldb_async_callback_fn);
1063 typedef int (*ldb_async_ctx_wait_op_fn)(void *);
1064
1065 void ldb_async_ctx_set_private_data(struct ldb_context *ldb,
1066                                         void *private_data);
1067 void ldb_async_ctx_set_add_op(struct ldb_context *ldb,
1068                                 ldb_async_ctx_add_op_fn add_op);
1069 void ldb_async_ctx_set_wait_op(struct ldb_context *ldb,
1070                                 ldb_async_ctx_wait_op_fn wait_op);
1071
1072 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
1073
1074 /*
1075   return an automatic basedn from the rootDomainNamingContext of the rootDSE
1076   This value have been set in an opaque pointer at connection time
1077 */
1078 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
1079
1080 /*
1081   return an automatic basedn from the configurationNamingContext of the rootDSE
1082   This value have been set in an opaque pointer at connection time
1083 */
1084 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
1085
1086 /*
1087   return an automatic basedn from the schemaNamingContext of the rootDSE
1088   This value have been set in an opaque pointer at connection time
1089 */
1090 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
1091
1092 /*
1093   return an automatic baseDN from the defaultNamingContext of the rootDSE
1094   This value have been set in an opaque pointer at connection time
1095 */
1096 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
1097
1098 /**
1099   The default async search callback function
1100
1101   \param req the request we are callback of
1102   \param ares a single reply from the async core
1103
1104   \return result code (LDB_SUCCESS on success, or a failure code)
1105
1106   \note this function expects req->context to always be an struct ldb_result pointer
1107   AND a talloc context, this function will steal on the context each message
1108   from the ares reply passed on by the async core so that in the end all the
1109   messages will be in the context (ldb_result)  memory tree.
1110   Freeing the passed context (ldb_result tree) will free all the resources
1111   (the request need to be freed separately and the result doe not depend on the
1112   request that can be freed as sson as the search request is finished)
1113 */
1114
1115 int ldb_search_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1116
1117 /**
1118   The default async extended operation callback function
1119
1120   \param req the request we are callback of
1121   \param ares a single reply from the async core
1122
1123   \return result code (LDB_SUCCESS on success, or a failure code)
1124 */
1125 int ldb_op_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1126
1127 int ldb_modify_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1128
1129 /**
1130   Helper function to build a search request
1131
1132   \param ret_req the request structure is returned here (talloced on mem_ctx)
1133   \param ldb the context associated with the database (from ldb_init())
1134   \param mem_ctx a talloc memory context (used as parent of ret_req)
1135   \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1136   \param scope the search scope for the query
1137   \param expression the search expression to use for this query
1138   \param attrs the search attributes for the query (pass NULL if none required)
1139   \param controls an array of controls
1140   \param context the callback function context
1141   \param the callback function to handle the async replies
1142   \param the parent request if any
1143
1144   \return result code (LDB_SUCCESS on success, or a failure code)
1145 */
1146
1147 int ldb_build_search_req(struct ldb_request **ret_req,
1148                         struct ldb_context *ldb,
1149                         TALLOC_CTX *mem_ctx,
1150                         struct ldb_dn *base,
1151                         enum ldb_scope scope,
1152                         const char *expression,
1153                         const char * const *attrs,
1154                         struct ldb_control **controls,
1155                         void *context,
1156                         ldb_request_callback_t callback,
1157                         struct ldb_request *parent);
1158
1159 int ldb_build_search_req_ex(struct ldb_request **ret_req,
1160                         struct ldb_context *ldb,
1161                         TALLOC_CTX *mem_ctx,
1162                         struct ldb_dn *base,
1163                         enum ldb_scope scope,
1164                         struct ldb_parse_tree *tree,
1165                         const char * const *attrs,
1166                         struct ldb_control **controls,
1167                         void *context,
1168                         ldb_request_callback_t callback,
1169                         struct ldb_request *parent);
1170
1171 /**
1172   Helper function to build an add request
1173
1174   \param ret_req the request structure is returned here (talloced on mem_ctx)
1175   \param ldb the context associated with the database (from ldb_init())
1176   \param mem_ctx a talloc memory context (used as parent of ret_req)
1177   \param message contains the entry to be added
1178   \param controls an array of controls
1179   \param context the callback function context
1180   \param the callback function to handle the async replies
1181   \param the parent request if any
1182
1183   \return result code (LDB_SUCCESS on success, or a failure code)
1184 */
1185
1186 int ldb_build_add_req(struct ldb_request **ret_req,
1187                         struct ldb_context *ldb,
1188                         TALLOC_CTX *mem_ctx,
1189                         const struct ldb_message *message,
1190                         struct ldb_control **controls,
1191                         void *context,
1192                         ldb_request_callback_t callback,
1193                         struct ldb_request *parent);
1194
1195 /**
1196   Helper function to build a modify request
1197
1198   \param ret_req the request structure is returned here (talloced on mem_ctx)
1199   \param ldb the context associated with the database (from ldb_init())
1200   \param mem_ctx a talloc memory context (used as parent of ret_req)
1201   \param message contains the entry to be modified
1202   \param controls an array of controls
1203   \param context the callback function context
1204   \param the callback function to handle the async replies
1205   \param the parent request if any
1206
1207   \return result code (LDB_SUCCESS on success, or a failure code)
1208 */
1209
1210 int ldb_build_mod_req(struct ldb_request **ret_req,
1211                         struct ldb_context *ldb,
1212                         TALLOC_CTX *mem_ctx,
1213                         const struct ldb_message *message,
1214                         struct ldb_control **controls,
1215                         void *context,
1216                         ldb_request_callback_t callback,
1217                         struct ldb_request *parent);
1218
1219 /**
1220   Helper function to build a delete request
1221
1222   \param ret_req the request structure is returned here (talloced on mem_ctx)
1223   \param ldb the context associated with the database (from ldb_init())
1224   \param mem_ctx a talloc memory context (used as parent of ret_req)
1225   \param dn the DN to be deleted
1226   \param controls an array of controls
1227   \param context the callback function context
1228   \param the callback function to handle the async replies
1229   \param the parent request if any
1230
1231   \return result code (LDB_SUCCESS on success, or a failure code)
1232 */
1233
1234 int ldb_build_del_req(struct ldb_request **ret_req,
1235                         struct ldb_context *ldb,
1236                         TALLOC_CTX *mem_ctx,
1237                         struct ldb_dn *dn,
1238                         struct ldb_control **controls,
1239                         void *context,
1240                         ldb_request_callback_t callback,
1241                         struct ldb_request *parent);
1242
1243 /**
1244   Helper function to build a rename request
1245
1246   \param ret_req the request structure is returned here (talloced on mem_ctx)
1247   \param ldb the context associated with the database (from ldb_init())
1248   \param mem_ctx a talloc memory context (used as parent of ret_req)
1249   \param olddn the old DN
1250   \param newdn the new DN
1251   \param controls an array of controls
1252   \param context the callback function context
1253   \param the callback function to handle the async replies
1254   \param the parent request if any
1255
1256   \return result code (LDB_SUCCESS on success, or a failure code)
1257 */
1258
1259 int ldb_build_rename_req(struct ldb_request **ret_req,
1260                         struct ldb_context *ldb,
1261                         TALLOC_CTX *mem_ctx,
1262                         struct ldb_dn *olddn,
1263                         struct ldb_dn *newdn,
1264                         struct ldb_control **controls,
1265                         void *context,
1266                         ldb_request_callback_t callback,
1267                         struct ldb_request *parent);
1268
1269 /**
1270   Add a ldb_control to a ldb_request
1271
1272   \param req the request struct where to add the control
1273   \param oid the object identifier of the control as string
1274   \param critical whether the control should be critical or not
1275   \param data a talloc pointer to the control specific data
1276
1277   \return result code (LDB_SUCCESS on success, or a failure code)
1278 */
1279 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1280
1281 /**
1282   replace a ldb_control in a ldb_request
1283
1284   \param req the request struct where to add the control
1285   \param oid the object identifier of the control as string
1286   \param critical whether the control should be critical or not
1287   \param data a talloc pointer to the control specific data
1288
1289   \return result code (LDB_SUCCESS on success, or a failure code)
1290 */
1291 int ldb_request_replace_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1292
1293 /**
1294    check if a control with the specified "oid" exist and return it
1295   \param req the request struct where to add the control
1296   \param oid the object identifier of the control as string
1297
1298   \return the control, NULL if not found
1299 */
1300 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid);
1301
1302 /**
1303    check if a control with the specified "oid" exist and return it
1304   \param rep the reply struct where to add the control
1305   \param oid the object identifier of the control as string
1306
1307   \return the control, NULL if not found
1308 */
1309 struct ldb_control *ldb_reply_get_control(struct ldb_reply *rep, const char *oid);
1310
1311 /**
1312   Search the database
1313
1314   This function searches the database, and returns
1315   records that match an LDAP-like search expression
1316
1317   \param ldb the context associated with the database (from ldb_init())
1318   \param mem_ctx the memory context to use for the request and the results
1319   \param result the return result
1320   \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1321   \param scope the search scope for the query
1322   \param attrs the search attributes for the query (pass NULL if none required)
1323   \param exp_fmt the search expression to use for this query (printf like)
1324
1325   \return result code (LDB_SUCCESS on success, or a failure code)
1326
1327   \note use talloc_free() to free the ldb_result returned
1328 */
1329 int ldb_search(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1330                struct ldb_result **result, struct ldb_dn *base,
1331                enum ldb_scope scope, const char * const *attrs,
1332                const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1333
1334 /**
1335   Add a record to the database.
1336
1337   This function adds a record to the database. This function will fail
1338   if a record with the specified class and key already exists in the
1339   database.
1340
1341   \param ldb the context associated with the database (from
1342   ldb_init())
1343   \param message the message containing the record to add.
1344
1345   \return result code (LDB_SUCCESS if the record was added, otherwise
1346   a failure code)
1347 */
1348 int ldb_add(struct ldb_context *ldb,
1349             const struct ldb_message *message);
1350
1351 /**
1352   Modify the specified attributes of a record
1353
1354   This function modifies a record that is in the database.
1355
1356   \param ldb the context associated with the database (from
1357   ldb_init())
1358   \param message the message containing the changes required.
1359
1360   \return result code (LDB_SUCCESS if the record was modified as
1361   requested, otherwise a failure code)
1362 */
1363 int ldb_modify(struct ldb_context *ldb,
1364                const struct ldb_message *message);
1365
1366 /**
1367   Rename a record in the database
1368
1369   This function renames a record in the database.
1370
1371   \param ldb the context associated with the database (from
1372   ldb_init())
1373   \param olddn the DN for the record to be renamed.
1374   \param newdn the new DN
1375
1376   \return result code (LDB_SUCCESS if the record was renamed as
1377   requested, otherwise a failure code)
1378 */
1379 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1380
1381 /**
1382   Delete a record from the database
1383
1384   This function deletes a record from the database.
1385
1386   \param ldb the context associated with the database (from
1387   ldb_init())
1388   \param dn the DN for the record to be deleted.
1389
1390   \return result code (LDB_SUCCESS if the record was deleted,
1391   otherwise a failure code)
1392 */
1393 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1394
1395 /**
1396   The default async extended operation callback function
1397
1398   \param req the request we are callback of
1399   \param ares a single reply from the async core
1400
1401   \return result code (LDB_SUCCESS on success, or a failure code)
1402
1403   \note this function expects req->context to always be an struct ldb_result pointer
1404   AND a talloc context, this function will steal on the context each message
1405   from the ares reply passed on by the async core so that in the end all the
1406   messages will be in the context (ldb_result)  memory tree.
1407   Freeing the passed context (ldb_result tree) will free all the resources
1408   (the request need to be freed separately and the result doe not depend on the
1409   request that can be freed as sson as the search request is finished)
1410 */
1411
1412 int ldb_extended_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1413
1414
1415 /**
1416   Helper function to build a extended request
1417
1418   \param ret_req the request structure is returned here (talloced on mem_ctx)
1419   \param ldb the context associated with the database (from ldb_init())
1420   \param mem_ctx a talloc memory context (used as parent of ret_req)
1421   \param oid the OID of the extended operation.
1422   \param data a void pointer a the extended operation specific parameters,
1423   it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1424   \param controls an array of controls
1425   \param context the callback function context
1426   \param the callback function to handle the async replies
1427   \param the parent request if any
1428
1429   \return result code (LDB_SUCCESS on success, or a failure code)
1430 */
1431 int ldb_build_extended_req(struct ldb_request **ret_req,
1432                            struct ldb_context *ldb,
1433                            TALLOC_CTX *mem_ctx,
1434                            const char *oid,
1435                            void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1436                            struct ldb_control **controls,
1437                            void *context,
1438                            ldb_request_callback_t callback,
1439                            struct ldb_request *parent);
1440
1441 /**
1442   call an extended operation
1443
1444   \param ldb the context associated with the database (from ldb_init())
1445   \param oid the OID of the extended operation.
1446   \param data a void pointer a the extended operation specific parameters,
1447   it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1448   \param res the result of the extended operation
1449
1450   \return result code (LDB_SUCCESS if the extended operation returned fine,
1451   otherwise a failure code)
1452 */
1453 int ldb_extended(struct ldb_context *ldb,
1454                  const char *oid,
1455                  void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1456                  struct ldb_result **res);
1457
1458 /**
1459   Obtain current/next database sequence number
1460 */
1461 int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num);
1462
1463 /**
1464   start a transaction
1465 */
1466 int ldb_transaction_start(struct ldb_context *ldb);
1467
1468 /**
1469    first phase of two phase commit
1470  */
1471 int ldb_transaction_prepare_commit(struct ldb_context *ldb);
1472
1473 /**
1474   commit a transaction
1475 */
1476 int ldb_transaction_commit(struct ldb_context *ldb);
1477
1478 /**
1479   cancel a transaction
1480 */
1481 int ldb_transaction_cancel(struct ldb_context *ldb);
1482
1483 /*
1484   cancel a transaction with no error if no transaction is pending
1485   used when we fork() to clear any parent transactions
1486 */
1487 int ldb_transaction_cancel_noerr(struct ldb_context *ldb);
1488
1489
1490 /**
1491   return extended error information from the last call
1492 */
1493 const char *ldb_errstring(struct ldb_context *ldb);
1494
1495 /**
1496   return a string explaining what a ldb error constant meancs
1497 */
1498 const char *ldb_strerror(int ldb_err);
1499
1500 /**
1501   setup the default utf8 functions
1502   FIXME: these functions do not yet handle utf8
1503 */
1504 void ldb_set_utf8_default(struct ldb_context *ldb);
1505
1506 /**
1507    Casefold a string
1508
1509    \param ldb the ldb context
1510    \param mem_ctx the memory context to allocate the result string
1511    memory from.
1512    \param s the string that is to be folded
1513    \return a copy of the string, converted to upper case
1514
1515    \note The default function is not yet UTF8 aware. Provide your own
1516          set of functions through ldb_set_utf8_fns()
1517 */
1518 char *ldb_casefold(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s, size_t n);
1519
1520 /**
1521    Check the attribute name is valid according to rfc2251
1522    \param s the string to check
1523
1524    \return 1 if the name is ok
1525 */
1526 int ldb_valid_attr_name(const char *s);
1527
1528 /*
1529   ldif manipulation functions
1530 */
1531
1532 /**
1533    Write an LDIF message
1534
1535    This function writes an LDIF message using a caller supplied  write
1536    function.
1537
1538    \param ldb the ldb context (from ldb_init())
1539    \param fprintf_fn a function pointer for the write function. This must take
1540    a private data pointer, followed by a format string, and then a variable argument
1541    list.
1542    \param private_data pointer that will be provided back to the write
1543    function. This is useful for maintaining state or context.
1544    \param ldif the message to write out
1545
1546    \return the total number of bytes written, or an error code as returned
1547    from the write function.
1548
1549    \sa ldb_ldif_write_file for a more convenient way to write to a
1550    file stream.
1551
1552    \sa ldb_ldif_read for the reader equivalent to this function.
1553 */
1554 int ldb_ldif_write(struct ldb_context *ldb,
1555                    int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1556                    void *private_data,
1557                    const struct ldb_ldif *ldif);
1558
1559 /**
1560    Clean up an LDIF message
1561
1562    This function cleans up a LDIF message read using ldb_ldif_read()
1563    or related functions (such as ldb_ldif_read_string() and
1564    ldb_ldif_read_file().
1565
1566    \param ldb the ldb context (from ldb_init())
1567    \param msg the message to clean up and free
1568
1569 */
1570 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1571
1572 /**
1573    Read an LDIF message
1574
1575    This function creates an LDIF message using a caller supplied read
1576    function.
1577
1578    \param ldb the ldb context (from ldb_init())
1579    \param fgetc_fn a function pointer for the read function. This must
1580    take a private data pointer, and must return a pointer to an
1581    integer corresponding to the next byte read (or EOF if there is no
1582    more data to be read).
1583    \param private_data pointer that will be provided back to the read
1584    function. This is udeful for maintaining state or context.
1585
1586    \return the LDIF message that has been read in
1587
1588    \note You must free the LDIF message when no longer required, using
1589    ldb_ldif_read_free().
1590
1591    \sa ldb_ldif_read_file for a more convenient way to read from a
1592    file stream.
1593
1594    \sa ldb_ldif_read_string for a more convenient way to read from a
1595    string (char array).
1596
1597    \sa ldb_ldif_write for the writer equivalent to this function.
1598 */
1599 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1600                                int (*fgetc_fn)(void *), void *private_data);
1601
1602 /**
1603    Read an LDIF message from a file
1604
1605    This function reads the next LDIF message from the contents of a
1606    file stream. If you want to get all of the LDIF messages, you will
1607    need to repeatedly call this function, until it returns NULL.
1608
1609    \param ldb the ldb context (from ldb_init())
1610    \param f the file stream to read from (typically from fdopen())
1611
1612    \sa ldb_ldif_read_string for an equivalent function that will read
1613    from a string (char array).
1614
1615    \sa ldb_ldif_write_file for the writer equivalent to this function.
1616
1617 */
1618 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1619
1620 /**
1621    Read an LDIF message from a string
1622
1623    This function reads the next LDIF message from the contents of a char
1624    array. If you want to get all of the LDIF messages, you will need
1625    to repeatedly call this function, until it returns NULL.
1626
1627    \param ldb the ldb context (from ldb_init())
1628    \param s pointer to the char array to read from
1629
1630    \sa ldb_ldif_read_file for an equivalent function that will read
1631    from a file stream.
1632
1633    \sa ldb_ldif_write for a more general (arbitrary read function)
1634    version of this function.
1635 */
1636 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1637
1638 /**
1639    Parse a modrdn LDIF message from a struct ldb_message
1640
1641    \param ldb the ldb context (from ldb_init())
1642    \param ldif the preparsed LDIF chunk (from ldb_ldif_read())
1643
1644    \param mem_ctx the memory context that's used for return values
1645
1646    \param olddn the old dn as struct ldb_dn, if not needed pass NULL
1647    \param newrdn the new rdn as struct ldb_dn, if not needed pass NULL
1648    \param deleteoldrdn the deleteoldrdn value as bool, if not needed pass NULL
1649    \param newsuperior the newsuperior dn as struct ldb_dn, if not needed pass NULL
1650                       *newsuperior can be NULL as it is optional in the LDIF
1651    \param newdn the full constructed new dn as struct ldb_dn, if not needed pass NULL
1652
1653 */
1654 int ldb_ldif_parse_modrdn(struct ldb_context *ldb,
1655                           const struct ldb_ldif *ldif,
1656                           TALLOC_CTX *mem_ctx,
1657                           struct ldb_dn **olddn,
1658                           struct ldb_dn **newrdn,
1659                           bool *deleteoldrdn,
1660                           struct ldb_dn **newsuperior,
1661                           struct ldb_dn **newdn);
1662
1663 /**
1664    Write an LDIF message to a file
1665
1666    \param ldb the ldb context (from ldb_init())
1667    \param f the file stream to write to (typically from fdopen())
1668    \param msg the message to write out
1669
1670    \return the total number of bytes written, or a negative error code
1671
1672    \sa ldb_ldif_read_file for the reader equivalent to this function.
1673 */
1674 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1675
1676 /**
1677    Write an LDIF message to a string
1678
1679    \param ldb the ldb context (from ldb_init())
1680    \param mem_ctx the talloc context on which to attach the string)
1681    \param msg the message to write out
1682
1683    \return the string containing the LDIF, or NULL on error
1684
1685    \sa ldb_ldif_read_string for the reader equivalent to this function.
1686 */
1687 char * ldb_ldif_write_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1688                           const struct ldb_ldif *msg);
1689
1690
1691 /*
1692    Produce a string form of an ldb message
1693
1694    convenient function to turn a ldb_message into a string. Useful for
1695    debugging
1696  */
1697 char *ldb_ldif_message_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1698                               enum ldb_changetype changetype,
1699                               const struct ldb_message *msg);
1700
1701
1702 /**
1703    Base64 encode a buffer
1704
1705    \param mem_ctx the memory context that the result is allocated
1706    from.
1707    \param buf pointer to the array that is to be encoded
1708    \param len the number of elements in the array to be encoded
1709
1710    \return pointer to an array containing the encoded data
1711
1712    \note The caller is responsible for freeing the result
1713 */
1714 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len);
1715
1716 /**
1717    Base64 decode a buffer
1718
1719    This function decodes a base64 encoded string in place.
1720
1721    \param s the string to decode.
1722
1723    \return the length of the returned (decoded) string.
1724
1725    \note the string is null terminated, but the null terminator is not
1726    included in the length.
1727 */
1728 int ldb_base64_decode(char *s);
1729
1730 /* The following definitions come from lib/ldb/common/ldb_dn.c  */
1731
1732 /**
1733   Get the linear form of a DN (without any extended components)
1734
1735   \param dn The DN to linearize
1736 */
1737
1738 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1739
1740 /**
1741   Allocate a copy of the linear form of a DN (without any extended components) onto the supplied memory context
1742
1743   \param dn The DN to linearize
1744   \param mem_ctx TALLOC context to return result on
1745 */
1746
1747 char *ldb_dn_alloc_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1748
1749 /**
1750   Get the linear form of a DN (with any extended components)
1751
1752   \param mem_ctx TALLOC context to return result on
1753   \param dn The DN to linearize
1754   \param mode Style of extended DN to return (0 is HEX representation of binary form, 1 is a string form)
1755 */
1756 char *ldb_dn_get_extended_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn, int mode);
1757 const struct ldb_val *ldb_dn_get_extended_component(struct ldb_dn *dn, const char *name);
1758 int ldb_dn_set_extended_component(struct ldb_dn *dn, const char *name, const struct ldb_val *val);
1759 void ldb_dn_extended_filter(struct ldb_dn *dn, const char * const *accept_list);
1760 void ldb_dn_remove_extended_components(struct ldb_dn *dn);
1761 bool ldb_dn_has_extended(struct ldb_dn *dn);
1762
1763 int ldb_dn_extended_add_syntax(struct ldb_context *ldb,
1764                                unsigned flags,
1765                                const struct ldb_dn_extended_syntax *syntax);
1766
1767 /**
1768   Allocate a new DN from a string
1769
1770   \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1771   \param dn The new DN
1772
1773   \note The DN will not be parsed at this time.  Use ldb_dn_validate to tell if the DN is syntacticly correct
1774 */
1775
1776 struct ldb_dn *ldb_dn_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn);
1777 /**
1778   Allocate a new DN from a printf style format string and arguments
1779
1780   \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1781   \param new_fms The new DN as a format string (plus arguments)
1782
1783   \note The DN will not be parsed at this time.  Use ldb_dn_validate to tell if the DN is syntacticly correct
1784 */
1785
1786 struct ldb_dn *ldb_dn_new_fmt(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1787 /**
1788   Allocate a new DN from a struct ldb_val (useful to avoid buffer overrun)
1789
1790   \param mem_ctx TALLOC context to return resulting ldb_dn structure on
1791   \param dn The new DN
1792
1793   \note The DN will not be parsed at this time.  Use ldb_dn_validate to tell if the DN is syntacticly correct
1794 */
1795
1796 struct ldb_dn *ldb_dn_from_ldb_val(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const struct ldb_val *strdn);
1797
1798 /**
1799   Determine if this DN is syntactically valid
1800
1801   \param dn The DN to validate
1802 */
1803
1804 bool ldb_dn_validate(struct ldb_dn *dn);
1805
1806 char *ldb_dn_escape_value(TALLOC_CTX *mem_ctx, struct ldb_val value);
1807 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1808 char *ldb_dn_alloc_casefold(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1809
1810 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1811 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1812
1813 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1814 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1815 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1816 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1817 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1818 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1819
1820 struct ldb_dn *ldb_dn_copy(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1821 struct ldb_dn *ldb_dn_get_parent(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1822 char *ldb_dn_canonical_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1823 char *ldb_dn_canonical_ex_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1824 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1825 int ldb_dn_get_extended_comp_num(struct ldb_dn *dn);
1826 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1827 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1828 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1829 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1830 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1831
1832 bool ldb_dn_is_valid(struct ldb_dn *dn);
1833 bool ldb_dn_is_special(struct ldb_dn *dn);
1834 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1835 bool ldb_dn_is_null(struct ldb_dn *dn);
1836 int ldb_dn_update_components(struct ldb_dn *dn, const struct ldb_dn *ref_dn);
1837
1838
1839 /**
1840    Compare two attributes
1841
1842    This function compares to attribute names. Note that this is a
1843    case-insensitive comparison.
1844
1845    \param a the first attribute name to compare
1846    \param b the second attribute name to compare
1847
1848    \return 0 if the attribute names are the same, or only differ in
1849    case; non-zero if there are any differences
1850
1851   attribute names are restricted by rfc2251 so using
1852   strcasecmp and toupper here is ok.
1853   return 0 for match
1854 */
1855 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1856 char *ldb_attr_casefold(TALLOC_CTX *mem_ctx, const char *s);
1857 int ldb_attr_dn(const char *attr);
1858
1859 /**
1860    Create an empty message
1861
1862    \param mem_ctx the memory context to create in. You can pass NULL
1863    to get the top level context, however the ldb context (from
1864    ldb_init()) may be a better choice
1865 */
1866 struct ldb_message *ldb_msg_new(TALLOC_CTX *mem_ctx);
1867
1868 /**
1869    Find an element within an message
1870 */
1871 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1872                                                  const char *attr_name);
1873
1874 /**
1875    Compare two ldb_val values
1876
1877    \param v1 first ldb_val structure to be tested
1878    \param v2 second ldb_val structure to be tested
1879
1880    \return 1 for a match, 0 if there is any difference
1881 */
1882 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1883
1884 /**
1885    find a value within an ldb_message_element
1886
1887    \param el the element to search
1888    \param val the value to search for
1889
1890    \note This search is case sensitive
1891 */
1892 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1893                                  struct ldb_val *val);
1894
1895 /**
1896    add a new empty element to a ldb_message
1897 */
1898 int ldb_msg_add_empty(struct ldb_message *msg,
1899                 const char *attr_name,
1900                 int flags,
1901                 struct ldb_message_element **return_el);
1902
1903 /**
1904    add a element to a ldb_message
1905 */
1906 int ldb_msg_add(struct ldb_message *msg,
1907                 const struct ldb_message_element *el,
1908                 int flags);
1909 int ldb_msg_add_value(struct ldb_message *msg,
1910                 const char *attr_name,
1911                 const struct ldb_val *val,
1912                 struct ldb_message_element **return_el);
1913 int ldb_msg_add_steal_value(struct ldb_message *msg,
1914                       const char *attr_name,
1915                       struct ldb_val *val);
1916 int ldb_msg_add_steal_string(struct ldb_message *msg,
1917                              const char *attr_name, char *str);
1918 int ldb_msg_add_string(struct ldb_message *msg,
1919                        const char *attr_name, const char *str);
1920 int ldb_msg_add_linearized_dn(struct ldb_message *msg, const char *attr_name,
1921                               struct ldb_dn *dn);
1922 int ldb_msg_add_fmt(struct ldb_message *msg,
1923                     const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1924
1925 /**
1926    compare two message elements - return 0 on match
1927 */
1928 int ldb_msg_element_compare(struct ldb_message_element *el1,
1929                             struct ldb_message_element *el2);
1930 int ldb_msg_element_compare_name(struct ldb_message_element *el1,
1931                                  struct ldb_message_element *el2);
1932
1933 /**
1934    Find elements in a message.
1935
1936    This function finds elements and converts to a specific type, with
1937    a give default value if not found. Assumes that elements are
1938    single valued.
1939 */
1940 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1941 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1942                              const char *attr_name,
1943                              int default_value);
1944 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1945                                        const char *attr_name,
1946                                        unsigned int default_value);
1947 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1948                                    const char *attr_name,
1949                                    int64_t default_value);
1950 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1951                                      const char *attr_name,
1952                                      uint64_t default_value);
1953 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1954                                    const char *attr_name,
1955                                    double default_value);
1956 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1957                               const char *attr_name,
1958                               int default_value);
1959 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1960                                         const char *attr_name,
1961                                         const char *default_value);
1962
1963 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1964                                        TALLOC_CTX *mem_ctx,
1965                                        const struct ldb_message *msg,
1966                                        const char *attr_name);
1967
1968 void ldb_msg_sort_elements(struct ldb_message *msg);
1969
1970 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx,
1971                                          const struct ldb_message *msg);
1972 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx,
1973                                  const struct ldb_message *msg);
1974
1975 /*
1976  * ldb_msg_canonicalize() is now depreciated
1977  * Please use ldb_msg_normalize() instead
1978  *
1979  * NOTE: Returned ldb_message object is allocated
1980  * into *ldb's context. Callers are recommended
1981  * to steal the returned object into a TALLOC_CTX
1982  * with short lifetime.
1983  */
1984 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1985                                          const struct ldb_message *msg) _DEPRECATED_;
1986
1987 int ldb_msg_normalize(struct ldb_context *ldb,
1988                       TALLOC_CTX *mem_ctx,
1989                       const struct ldb_message *msg,
1990                       struct ldb_message **_msg_out);
1991
1992
1993 /*
1994  * ldb_msg_diff() is now depreciated
1995  * Please use ldb_msg_difference() instead
1996  *
1997  * NOTE: Returned ldb_message object is allocated
1998  * into *ldb's context. Callers are recommended
1999  * to steal the returned object into a TALLOC_CTX
2000  * with short lifetime.
2001  */
2002 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
2003                                  struct ldb_message *msg1,
2004                                  struct ldb_message *msg2) _DEPRECATED_;
2005
2006 /**
2007  * return a ldb_message representing the differences between msg1 and msg2.
2008  * If you then use this in a ldb_modify() call,
2009  * it can be used to save edits to a message
2010  *
2011  * Result message is constructed as follows:
2012  * - LDB_FLAG_MOD_ADD     - elements found only in msg2
2013  * - LDB_FLAG_MOD_REPLACE - elements in msg2 that have
2014  *                          different value in msg1
2015  *                          Value for msg2 element is used
2016  * - LDB_FLAG_MOD_DELETE  - elements found only in msg2
2017  *
2018  * @return LDB_SUCCESS or LDB_ERR_OPERATIONS_ERROR
2019  */
2020 int ldb_msg_difference(struct ldb_context *ldb,
2021                        TALLOC_CTX *mem_ctx,
2022                        struct ldb_message *msg1,
2023                        struct ldb_message *msg2,
2024                        struct ldb_message **_msg_out);
2025
2026 /**
2027    Tries to find a certain string attribute in a message
2028
2029    \param msg the message to check
2030    \param name attribute name
2031    \param value attribute value
2032
2033    \return 1 on match and 0 otherwise.
2034 */
2035 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
2036                                    const char *name,
2037                                    const char *value);
2038
2039 /**
2040    Integrity check an ldb_message
2041
2042    This function performs basic sanity / integrity checks on an
2043    ldb_message.
2044
2045    \param ldb context in which to perform the checks
2046    \param msg the message to check
2047
2048    \return LDB_SUCCESS if the message is OK, or a non-zero error code
2049    (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
2050    LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
2051    message.
2052 */
2053 int ldb_msg_sanity_check(struct ldb_context *ldb,
2054                          const struct ldb_message *msg);
2055
2056 /**
2057    Duplicate an ldb_val structure
2058
2059    This function copies an ldb value structure.
2060
2061    \param mem_ctx the memory context that the duplicated value will be
2062    allocated from
2063    \param v the ldb_val to be duplicated.
2064
2065    \return the duplicated ldb_val structure.
2066 */
2067 struct ldb_val ldb_val_dup(TALLOC_CTX *mem_ctx, const struct ldb_val *v);
2068
2069 /**
2070   this allows the user to set a debug function for error reporting
2071 */
2072 int ldb_set_debug(struct ldb_context *ldb,
2073                   void (*debug)(void *context, enum ldb_debug_level level,
2074                                 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
2075                   void *context);
2076
2077 /**
2078   this allows the user to set custom utf8 function for error reporting
2079 */
2080 void ldb_set_utf8_fns(struct ldb_context *ldb,
2081                       void *context,
2082                       char *(*casefold)(void *, void *, const char *, size_t n));
2083
2084 /**
2085    this sets up debug to print messages on stderr
2086 */
2087 int ldb_set_debug_stderr(struct ldb_context *ldb);
2088
2089 /* control backend specific opaque values */
2090 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
2091 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
2092
2093 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs);
2094 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr);
2095 int ldb_attr_in_list(const char * const *attrs, const char *attr);
2096
2097 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
2098 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
2099 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
2100 void ldb_msg_remove_element(struct ldb_message *msg, struct ldb_message_element *el);
2101
2102
2103 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
2104                                  const char *attr,
2105                                  const char *replace);
2106
2107 /*
2108   shallow copy a tree - copying only the elements array so that the caller
2109   can safely add new elements without changing the message
2110 */
2111 struct ldb_parse_tree *ldb_parse_tree_copy_shallow(TALLOC_CTX *mem_ctx,
2112                                                    const struct ldb_parse_tree *ot);
2113
2114 /**
2115    Convert a time structure to a string
2116
2117    This function converts a time_t structure to an LDAP formatted
2118    GeneralizedTime string.
2119
2120    \param mem_ctx the memory context to allocate the return string in
2121    \param t the time structure to convert
2122
2123    \return the formatted string, or NULL if the time structure could
2124    not be converted
2125 */
2126 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t);
2127
2128 /**
2129    Convert a string to a time structure
2130
2131    This function converts an LDAP formatted GeneralizedTime string
2132    to a time_t structure.
2133
2134    \param s the string to convert
2135
2136    \return the time structure, or 0 if the string cannot be converted
2137 */
2138 time_t ldb_string_to_time(const char *s);
2139
2140 /**
2141   convert a LDAP GeneralizedTime string in ldb_val format to a
2142   time_t.
2143 */
2144 int ldb_val_to_time(const struct ldb_val *v, time_t *t);
2145
2146 /**
2147    Convert a time structure to a string
2148
2149    This function converts a time_t structure to an LDAP formatted
2150    UTCTime string.
2151
2152    \param mem_ctx the memory context to allocate the return string in
2153    \param t the time structure to convert
2154
2155    \return the formatted string, or NULL if the time structure could
2156    not be converted
2157 */
2158 char *ldb_timestring_utc(TALLOC_CTX *mem_ctx, time_t t);
2159
2160 /**
2161    Convert a string to a time structure
2162
2163    This function converts an LDAP formatted UTCTime string
2164    to a time_t structure.
2165
2166    \param s the string to convert
2167
2168    \return the time structure, or 0 if the string cannot be converted
2169 */
2170 time_t ldb_string_utc_to_time(const char *s);
2171
2172
2173 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
2174
2175 #ifndef discard_const
2176 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
2177 #endif
2178
2179 /*
2180   a wrapper around ldb_qsort() that ensures the comparison function is
2181   type safe. This will produce a compilation warning if the types
2182   don't match
2183  */
2184 #define LDB_TYPESAFE_QSORT(base, numel, opaque, comparison)     \
2185 do { \
2186         if (numel > 1) { \
2187                 ldb_qsort(base, numel, sizeof((base)[0]), discard_const(opaque), (ldb_qsort_cmp_fn_t)comparison); \
2188                 comparison(&((base)[0]), &((base)[1]), opaque);         \
2189         } \
2190 } while (0)
2191
2192 /* allow ldb to also call TYPESAFE_QSORT() */
2193 #ifndef TYPESAFE_QSORT
2194 #define TYPESAFE_QSORT(base, numel, comparison) \
2195 do { \
2196         if (numel > 1) { \
2197                 qsort(base, numel, sizeof((base)[0]), (int (*)(const void *, const void *))comparison); \
2198                 comparison(&((base)[0]), &((base)[1])); \
2199         } \
2200 } while (0)
2201 #endif
2202
2203
2204
2205 /**
2206    Convert a control into its string representation.
2207
2208    \param mem_ctx TALLOC context to return result on, and to allocate error_string on
2209    \param control A struct ldb_control to convert
2210
2211    \return string representation of the control
2212 */
2213 char* ldb_control_to_string(TALLOC_CTX *mem_ctx, const struct ldb_control *control);
2214 /**
2215    Convert a string representing a control into a ldb_control structure
2216
2217    \param ldb LDB context
2218    \param mem_ctx TALLOC context to return result on, and to allocate error_string on
2219    \param control_strings A string-formatted control
2220
2221    \return a ldb_control element
2222 */
2223 struct ldb_control *ldb_parse_control_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *control_strings);
2224 /**
2225    Convert an array of string represention of a control into an array of ldb_control structures
2226
2227    \param ldb LDB context
2228    \param mem_ctx TALLOC context to return result on, and to allocate error_string on
2229    \param control_strings Array of string-formatted controls
2230
2231    \return array of ldb_control elements
2232 */
2233 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings);
2234
2235 /**
2236    return the ldb flags
2237 */
2238 unsigned int ldb_get_flags(struct ldb_context *ldb);
2239
2240 /* set the ldb flags */
2241 void ldb_set_flags(struct ldb_context *ldb, unsigned flags);
2242
2243
2244 struct ldb_dn *ldb_dn_binary_from_ldb_val(TALLOC_CTX *mem_ctx,
2245                                           struct ldb_context *ldb,
2246                                           const struct ldb_val *strdn);
2247
2248 int ldb_dn_get_binary(struct ldb_dn *dn, struct ldb_val *val);
2249 int ldb_dn_set_binary(struct ldb_dn *dn, struct ldb_val *val);
2250
2251 /* debugging functions for ldb requests */
2252 void ldb_req_set_location(struct ldb_request *req, const char *location);
2253 const char *ldb_req_location(struct ldb_request *req);
2254
2255 /* set the location marker on a request handle - used for debugging */
2256 #define LDB_REQ_SET_LOCATION(req) ldb_req_set_location(req, __location__)
2257
2258 /*
2259   minimise a DN. The caller must pass in a validated DN.
2260
2261   If the DN has an extended component then only the first extended
2262   component is kept, the DN string is stripped.
2263
2264   The existing dn is modified
2265  */
2266 bool ldb_dn_minimise(struct ldb_dn *dn);
2267
2268 /*
2269   compare a ldb_val to a string
2270 */
2271 int ldb_val_string_cmp(const struct ldb_val *v, const char *str);
2272
2273 #endif