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