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