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