source4/lib/ldb/include/ldb.h

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