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