source4/lib/ldb/include/ldb.h

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