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