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