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