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