source4/lib/ldb/include/ldb.h

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