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