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