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