source4/lib/ldb/include/ldb.h

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Andrew Tridgell  2004
   5    Copyright (C) Stefan Metzmacher  2004
   6    Copyright (C) Simo Sorce  2005-2006
   7
   8      ** NOTE! The following LGPL license applies to the ldb
   9      ** library. This does NOT imply that all of Samba is released
  10      ** under the LGPL
  11
  12    This library is free software; you can redistribute it and/or
  13    modify it under the terms of the GNU Lesser General Public
  14    License as published by the Free Software Foundation; either
  15    version 3 of the License, or (at your option) any later version.
  16
  17    This library is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20    Lesser General Public License for more details.
  21
  22    You should have received a copy of the GNU Lesser General Public
  23    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  24 */
  25
  26 /*
  27  *  Name: ldb
  28  *
  29  *  Component: ldb header
  30  *
  31  *  Description: defines for base ldb API
  32  *
  33  *  Author: Andrew Tridgell
  34  *  Author: Stefan Metzmacher
  35  */
  36
  37 /**
  38    \file ldb.h Samba's ldb database
  39
  40    This header file provides the main API for ldb.
  41 */
  42
  43 #ifndef _LDB_H_
  44
  45 /*! \cond DOXYGEN_IGNORE */
  46 #define _LDB_H_ 1
  47 /*! \endcond */
  48
  49 /*
  50   major restrictions as compared to normal LDAP:
  51
  52      - no async calls.
  53      - each record must have a unique key field
  54      - the key must be representable as a NULL terminated C string and may not
  55        contain a comma or braces
  56
  57   major restrictions as compared to tdb:
  58
  59      - no explicit locking calls
  60      UPDATE: we have transactions now, better than locking --SSS.
  61
  62 */
  63
  64 #ifndef ldb_val
  65 /**
  66    Result value
  67
  68    An individual lump of data in a result comes in this format. The
  69    pointer will usually be to a UTF-8 string if the application is
  70    sensible, but it can be to anything you like, including binary data
  71    blobs of arbitrary size.
  72
  73    \note the data is null (0x00) terminated, but the length does not
  74    include the terminator.
  75 */
  76 struct ldb_val {
  77         uint8_t *data; /*!< result data */
  78         size_t length; /*!< length of data */
  79 };
  80 #endif
  81
  82 /*! \cond DOXYGEN_IGNORE */
  83 #ifndef PRINTF_ATTRIBUTE
  84 #define PRINTF_ATTRIBUTE(a,b)
  85 #endif
  86 /*! \endcond */
  87
  88 /* opaque ldb_dn structures, see ldb_dn.c for internals */
  89 struct ldb_dn_component;
  90 struct ldb_dn;
  91
  92 /**
  93  There are a number of flags that are used with ldap_modify() in
  94  ldb_message_element.flags fields. The LDA_FLAGS_MOD_ADD,
  95  LDA_FLAGS_MOD_DELETE and LDA_FLAGS_MOD_REPLACE flags are used in
  96  ldap_modify() calls to specify whether attributes are being added,
  97  deleted or modified respectively.
  98 */
  99 #define LDB_FLAG_MOD_MASK  0x3
 100
 101 /**
 102    Flag value used in ldap_modify() to indicate that attributes are
 103    being added.
 104
 105    \sa LDB_FLAG_MOD_MASK
 106 */
 107 #define LDB_FLAG_MOD_ADD     1
 108
 109 /**
 110    Flag value used in ldap_modify() to indicate that attributes are
 111    being replaced.
 112
 113    \sa LDB_FLAG_MOD_MASK
 114 */
 115 #define LDB_FLAG_MOD_REPLACE 2
 116
 117 /**
 118    Flag value used in ldap_modify() to indicate that attributes are
 119    being deleted.
 120
 121    \sa LDB_FLAG_MOD_MASK
 122 */
 123 #define LDB_FLAG_MOD_DELETE  3
 124
 125 /**
 126   OID for logic AND comaprison.
 127
 128   This is the well known object ID for a logical AND comparitor.
 129 */
 130 #define LDB_OID_COMPARATOR_AND  "1.2.840.113556.1.4.803"
 131
 132 /**
 133   OID for logic OR comparison.
 134
 135   This is the well known object ID for a logical OR comparitor.
 136 */
 137 #define LDB_OID_COMPARATOR_OR   "1.2.840.113556.1.4.804"
 138
 139 /**
 140   results are given back as arrays of ldb_message_element
 141 */
 142 struct ldb_message_element {
 143         unsigned int flags;
 144         const char *name;
 145         unsigned int num_values;
 146         struct ldb_val *values;
 147 };
 148
 149
 150 /**
 151   a ldb_message represents all or part of a record. It can contain an arbitrary
 152   number of elements.
 153 */
 154 struct ldb_message {
 155         struct ldb_dn *dn;
 156         unsigned int num_elements;
 157         struct ldb_message_element *elements;
 158 };
 159
 160 enum ldb_changetype {
 161         LDB_CHANGETYPE_NONE=0,
 162         LDB_CHANGETYPE_ADD,
 163         LDB_CHANGETYPE_DELETE,
 164         LDB_CHANGETYPE_MODIFY
 165 };
 166
 167 /**
 168   LDIF record
 169
 170   This structure contains a LDIF record, as returned from ldif_read()
 171   and equivalent functions.
 172 */
 173 struct ldb_ldif {
 174         enum ldb_changetype changetype; /*!< The type of change */
 175         struct ldb_message *msg;  /*!< The changes */
 176 };
 177
 178 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
 179                 LDB_SCOPE_BASE=0,
 180                 LDB_SCOPE_ONELEVEL=1,
 181                 LDB_SCOPE_SUBTREE=2};
 182
 183 struct ldb_context;
 184 struct event_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, TALLOC_CTX *mem_ctx, const char *s, size_t n);
 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(TALLOC_CTX *mem_ctx, const char *s);
 285 char *ldb_filter_from_tree(TALLOC_CTX *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 mem_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(TALLOC_CTX *mem_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(TALLOC_CTX *mem_ctx, const char *string);
 318
 319 /*
 320   functions for controlling attribute handling
 321 */
 322 typedef int (*ldb_attr_handler_t)(struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, struct ldb_val *);
 323 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, TALLOC_CTX *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 supplied by the application and should not be removed
 363 */
 364 #define LDB_ATTR_FLAG_FIXED        (1<<2)
 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_DONE
 664 };
 665
 666 enum ldb_wait_type {
 667         LDB_WAIT_ALL,
 668         LDB_WAIT_NONE
 669 };
 670
 671 enum ldb_state {
 672         LDB_ASYNC_INIT,
 673         LDB_ASYNC_PENDING,
 674         LDB_ASYNC_DONE
 675 };
 676
 677 struct ldb_extended {
 678         const char *oid;
 679         void *data; /* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
 680 };
 681
 682 struct ldb_result {
 683         unsigned int count;
 684         struct ldb_message **msgs;
 685         char **refs;
 686         struct ldb_extended *extended;
 687         struct ldb_control **controls;
 688 };
 689
 690 struct ldb_reply {
 691         enum ldb_reply_type type;
 692         struct ldb_message *message;
 693         struct ldb_extended *response;
 694         char *referral;
 695         struct ldb_control **controls;
 696         int error;
 697 };
 698
 699 struct ldb_request;
 700 struct ldb_handle;
 701
 702 struct ldb_search {
 703         struct ldb_dn *base;
 704         enum ldb_scope scope;
 705         struct ldb_parse_tree *tree;
 706         const char * const *attrs;
 707         struct ldb_result *res;
 708 };
 709
 710 struct ldb_add {
 711         const struct ldb_message *message;
 712 };
 713
 714 struct ldb_modify {
 715         const struct ldb_message *message;
 716 };
 717
 718 struct ldb_delete {
 719         struct ldb_dn *dn;
 720 };
 721
 722 struct ldb_rename {
 723         struct ldb_dn *olddn;
 724         struct ldb_dn *newdn;
 725 };
 726
 727 struct ldb_register_control {
 728         const char *oid;
 729 };
 730
 731 struct ldb_register_partition {
 732         struct ldb_dn *dn;
 733 };
 734
 735 enum ldb_sequence_type {
 736         LDB_SEQ_HIGHEST_SEQ,
 737         LDB_SEQ_HIGHEST_TIMESTAMP,
 738         LDB_SEQ_NEXT
 739 };
 740
 741 struct ldb_sequence_number {
 742         enum ldb_sequence_type type;
 743         uint64_t seq_num;
 744         uint32_t flags;
 745 };
 746
 747 typedef int (*ldb_request_callback_t)(struct ldb_request *, struct ldb_reply *);
 748
 749 struct ldb_request {
 750
 751         enum ldb_request_type operation;
 752
 753         union {
 754                 struct ldb_search search;
 755                 struct ldb_add    add;
 756                 struct ldb_modify mod;
 757                 struct ldb_delete del;
 758                 struct ldb_rename rename;
 759                 struct ldb_extended extended;
 760                 struct ldb_sequence_number seq_num;
 761                 struct ldb_register_control reg_control;
 762                 struct ldb_register_partition reg_partition;
 763         } op;
 764
 765         struct ldb_control **controls;
 766
 767         void *context;
 768         ldb_request_callback_t callback;
 769
 770         int timeout;
 771         time_t starttime;
 772         struct ldb_handle *handle;
 773 };
 774
 775 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
 776 int ldb_request_done(struct ldb_request *req, int status);
 777 bool ldb_request_is_done(struct ldb_request *req);
 778
 779 int ldb_modules_wait(struct ldb_handle *handle);
 780 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
 781
 782 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
 783 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
 784 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms);
 785 void ldb_set_modules_dir(struct ldb_context *ldb, const char *path);
 786 struct event_context;
 787 void ldb_set_event_context(struct ldb_context *ldb, struct event_context *ev);
 788 struct event_context * ldb_get_event_context(struct ldb_context *ldb);
 789
 790 /**
 791   Initialise ldbs' global information
 792
 793   This is required before any other LDB call
 794
 795   \return 0 if initialisation succeeded, -1 otherwise
 796 */
 797 int ldb_global_init(void);
 798
 799 /**
 800   Initialise an ldb context
 801
 802   This is required before any other LDB call.
 803
 804   \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
 805   no suitable context available.
 806
 807   \return pointer to ldb_context that should be free'd (using talloc_free())
 808   at the end of the program.
 809 */
 810 struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx, struct event_context *ev_ctx);
 811
 812 /**
 813    Connect to a database.
 814
 815    This is typically called soon after ldb_init(), and is required prior to
 816    any search or database modification operations.
 817
 818    The URL can be one of the following forms:
 819     - tdb://path
 820     - ldapi://path
 821     - ldap://host
 822     - sqlite://path
 823
 824    \param ldb the context associated with the database (from ldb_init())
 825    \param url the URL of the database to connect to, as noted above
 826    \param flags a combination of LDB_FLG_* to modify the connection behaviour
 827    \param options backend specific options - passed uninterpreted to the backend
 828
 829    \return result code (LDB_SUCCESS on success, or a failure code)
 830
 831    \note It is an error to connect to a database that does not exist in readonly mode
 832    (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
 833    created if it does not exist.
 834 */
 835
 836 typedef void (*ldb_async_timeout_fn) (void *);
 837 typedef bool (*ldb_async_callback_fn) (void *);
 838 typedef int (*ldb_async_ctx_add_op_fn)(void *, time_t, void *, ldb_async_timeout_fn, ldb_async_callback_fn);
 839 typedef int (*ldb_async_ctx_wait_op_fn)(void *);
 840
 841 void ldb_async_ctx_set_private_data(struct ldb_context *ldb,
 842                                         void *private_data);
 843 void ldb_async_ctx_set_add_op(struct ldb_context *ldb,
 844                                 ldb_async_ctx_add_op_fn add_op);
 845 void ldb_async_ctx_set_wait_op(struct ldb_context *ldb,
 846                                 ldb_async_ctx_wait_op_fn wait_op);
 847
 848 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
 849
 850 /*
 851   return an automatic basedn from the rootDomainNamingContext of the rootDSE
 852   This value have been set in an opaque pointer at connection time
 853 */
 854 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb);
 855
 856 /*
 857   return an automatic basedn from the configurationNamingContext of the rootDSE
 858   This value have been set in an opaque pointer at connection time
 859 */
 860 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb);
 861
 862 /*
 863   return an automatic basedn from the schemaNamingContext of the rootDSE
 864   This value have been set in an opaque pointer at connection time
 865 */
 866 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb);
 867
 868 /*
 869   return an automatic baseDN from the defaultNamingContext of the rootDSE
 870   This value have been set in an opaque pointer at connection time
 871 */
 872 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb);
 873
 874 /**
 875   The default async search callback function
 876
 877   \param req the request we are callback of
 878   \param ares a single reply from the async core
 879
 880   \return result code (LDB_SUCCESS on success, or a failure code)
 881
 882   \note this function expects req->context to always be an struct ldb_result pointer
 883   AND a talloc context, this function will steal on the context each message
 884   from the ares reply passed on by the async core so that in the end all the
 885   messages will be in the context (ldb_result)  memory tree.
 886   Freeing the passed context (ldb_result tree) will free all the resources
 887   (the request need to be freed separately and the result doe not depend on the
 888   request that can be freed as sson as the search request is finished)
 889 */
 890
 891 int ldb_search_default_callback(struct ldb_request *req, struct ldb_reply *ares);
 892
 893 /**
 894   The default async extended operation callback function
 895
 896   \param req the request we are callback of
 897   \param ares a single reply from the async core
 898
 899   \return result code (LDB_SUCCESS on success, or a failure code)
 900 */
 901 int ldb_op_default_callback(struct ldb_request *req, struct ldb_reply *ares);
 902
 903
 904 /**
 905   Helper function to build a search request
 906
 907   \param ret_req the request structure is returned here (talloced on mem_ctx)
 908   \param ldb the context associated with the database (from ldb_init())
 909   \param mem_ctx a talloc memory context (used as parent of ret_req)
 910   \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
 911   \param scope the search scope for the query
 912   \param expression the search expression to use for this query
 913   \param attrs the search attributes for the query (pass NULL if none required)
 914   \param controls an array of controls
 915   \param context the callback function context
 916   \param the callback function to handle the async replies
 917   \param the parent request if any
 918
 919   \return result code (LDB_SUCCESS on success, or a failure code)
 920 */
 921
 922 int ldb_build_search_req(struct ldb_request **ret_req,
 923                         struct ldb_context *ldb,
 924                         TALLOC_CTX *mem_ctx,
 925                         struct ldb_dn *base,
 926                         enum ldb_scope scope,
 927                         const char *expression,
 928                         const char * const *attrs,
 929                         struct ldb_control **controls,
 930                         void *context,
 931                         ldb_request_callback_t callback,
 932                         struct ldb_request *parent);
 933
 934 int ldb_build_search_req_ex(struct ldb_request **ret_req,
 935                         struct ldb_context *ldb,
 936                         TALLOC_CTX *mem_ctx,
 937                         struct ldb_dn *base,
 938                         enum ldb_scope scope,
 939                         struct ldb_parse_tree *tree,
 940                         const char * const *attrs,
 941                         struct ldb_control **controls,
 942                         void *context,
 943                         ldb_request_callback_t callback,
 944                         struct ldb_request *parent);
 945
 946 /**
 947   Helper function to build an add request
 948
 949   \param ret_req the request structure is returned here (talloced on mem_ctx)
 950   \param ldb the context associated with the database (from ldb_init())
 951   \param mem_ctx a talloc memory context (used as parent of ret_req)
 952   \param message contains the entry to be added
 953   \param controls an array of controls
 954   \param context the callback function context
 955   \param the callback function to handle the async replies
 956   \param the parent request if any
 957
 958   \return result code (LDB_SUCCESS on success, or a failure code)
 959 */
 960
 961 int ldb_build_add_req(struct ldb_request **ret_req,
 962                         struct ldb_context *ldb,
 963                         TALLOC_CTX *mem_ctx,
 964                         const struct ldb_message *message,
 965                         struct ldb_control **controls,
 966                         void *context,
 967                         ldb_request_callback_t callback,
 968                         struct ldb_request *parent);
 969
 970 /**
 971   Helper function to build a modify request
 972
 973   \param ret_req the request structure is returned here (talloced on mem_ctx)
 974   \param ldb the context associated with the database (from ldb_init())
 975   \param mem_ctx a talloc memory context (used as parent of ret_req)
 976   \param message contains the entry to be modified
 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   \param the parent request if any
 981
 982   \return result code (LDB_SUCCESS on success, or a failure code)
 983 */
 984
 985 int ldb_build_mod_req(struct ldb_request **ret_req,
 986                         struct ldb_context *ldb,
 987                         TALLOC_CTX *mem_ctx,
 988                         const struct ldb_message *message,
 989                         struct ldb_control **controls,
 990                         void *context,
 991                         ldb_request_callback_t callback,
 992                         struct ldb_request *parent);
 993
 994 /**
 995   Helper function to build a delete request
 996
 997   \param ret_req the request structure is returned here (talloced on mem_ctx)
 998   \param ldb the context associated with the database (from ldb_init())
 999   \param mem_ctx a talloc memory context (used as parent of ret_req)
1000   \param dn the DN to be deleted
1001   \param controls an array of controls
1002   \param context the callback function context
1003   \param the callback function to handle the async replies
1004   \param the parent request if any
1005
1006   \return result code (LDB_SUCCESS on success, or a failure code)
1007 */
1008
1009 int ldb_build_del_req(struct ldb_request **ret_req,
1010                         struct ldb_context *ldb,
1011                         TALLOC_CTX *mem_ctx,
1012                         struct ldb_dn *dn,
1013                         struct ldb_control **controls,
1014                         void *context,
1015                         ldb_request_callback_t callback,
1016                         struct ldb_request *parent);
1017
1018 /**
1019   Helper function to build a rename request
1020
1021   \param ret_req the request structure is returned here (talloced on mem_ctx)
1022   \param ldb the context associated with the database (from ldb_init())
1023   \param mem_ctx a talloc memory context (used as parent of ret_req)
1024   \param olddn the old DN
1025   \param newdn the new DN
1026   \param controls an array of controls
1027   \param context the callback function context
1028   \param the callback function to handle the async replies
1029   \param the parent request if any
1030
1031   \return result code (LDB_SUCCESS on success, or a failure code)
1032 */
1033
1034 int ldb_build_rename_req(struct ldb_request **ret_req,
1035                         struct ldb_context *ldb,
1036                         TALLOC_CTX *mem_ctx,
1037                         struct ldb_dn *olddn,
1038                         struct ldb_dn *newdn,
1039                         struct ldb_control **controls,
1040                         void *context,
1041                         ldb_request_callback_t callback,
1042                         struct ldb_request *parent);
1043
1044 /**
1045   Add a ldb_control to a ldb_request
1046
1047   \param req the request struct where to add the control
1048   \param oid the object identifier of the control as string
1049   \param critical whether the control should be critical or not
1050   \param data a talloc pointer to the control specific data
1051
1052   \return result code (LDB_SUCCESS on success, or a failure code)
1053 */
1054 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data);
1055
1056 /**
1057    check if a control with the specified "oid" exist and return it
1058   \param req the request struct where to add the control
1059   \param oid the object identifier of the control as string
1060
1061   \return the control, NULL if not found
1062 */
1063 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid);
1064
1065 /**
1066   Search the database
1067
1068   This function searches the database, and returns
1069   records that match an LDAP-like search expression
1070
1071   \param ldb the context associated with the database (from ldb_init())
1072   \param mem_ctx the memory context to use for the request and the results
1073   \param result the return result
1074   \param base the Base Distinguished Name for the query (use ldb_dn_new() for an empty one)
1075   \param scope the search scope for the query
1076   \param attrs the search attributes for the query (pass NULL if none required)
1077   \param exp_fmt the search expression to use for this query (printf like)
1078
1079   \return result code (LDB_SUCCESS on success, or a failure code)
1080
1081   \note use talloc_free() to free the ldb_result returned
1082 */
1083 int ldb_search(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1084                struct ldb_result **result, struct ldb_dn *base,
1085                enum ldb_scope scope, const char * const *attrs,
1086                const char *exp_fmt, ...) PRINTF_ATTRIBUTE(7,8);
1087
1088 /**
1089   Add a record to the database.
1090
1091   This function adds a record to the database. This function will fail
1092   if a record with the specified class and key already exists in the
1093   database.
1094
1095   \param ldb the context associated with the database (from
1096   ldb_init())
1097   \param message the message containing the record to add.
1098
1099   \return result code (LDB_SUCCESS if the record was added, otherwise
1100   a failure code)
1101 */
1102 int ldb_add(struct ldb_context *ldb,
1103             const struct ldb_message *message);
1104
1105 /**
1106   Modify the specified attributes of a record
1107
1108   This function modifies a record that is in the database.
1109
1110   \param ldb the context associated with the database (from
1111   ldb_init())
1112   \param message the message containing the changes required.
1113
1114   \return result code (LDB_SUCCESS if the record was modified as
1115   requested, otherwise a failure code)
1116 */
1117 int ldb_modify(struct ldb_context *ldb,
1118                const struct ldb_message *message);
1119
1120 /**
1121   Rename a record in the database
1122
1123   This function renames a record in the database.
1124
1125   \param ldb the context associated with the database (from
1126   ldb_init())
1127   \param olddn the DN for the record to be renamed.
1128   \param newdn the new DN
1129
1130   \return result code (LDB_SUCCESS if the record was renamed as
1131   requested, otherwise a failure code)
1132 */
1133 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn);
1134
1135 /**
1136   Delete a record from the database
1137
1138   This function deletes a record from the database.
1139
1140   \param ldb the context associated with the database (from
1141   ldb_init())
1142   \param dn the DN for the record to be deleted.
1143
1144   \return result code (LDB_SUCCESS if the record was deleted,
1145   otherwise a failure code)
1146 */
1147 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn);
1148
1149 /**
1150   The default async extended operation callback function
1151
1152   \param req the request we are callback of
1153   \param ares a single reply from the async core
1154
1155   \return result code (LDB_SUCCESS on success, or a failure code)
1156
1157   \note this function expects req->context to always be an struct ldb_result pointer
1158   AND a talloc context, this function will steal on the context each message
1159   from the ares reply passed on by the async core so that in the end all the
1160   messages will be in the context (ldb_result)  memory tree.
1161   Freeing the passed context (ldb_result tree) will free all the resources
1162   (the request need to be freed separately and the result doe not depend on the
1163   request that can be freed as sson as the search request is finished)
1164 */
1165
1166 int ldb_extended_default_callback(struct ldb_request *req, struct ldb_reply *ares);
1167
1168
1169 /**
1170   Helper function to build a extended request
1171
1172   \param ret_req the request structure is returned here (talloced on mem_ctx)
1173   \param ldb the context associated with the database (from ldb_init())
1174   \param mem_ctx a talloc memory context (used as parent of ret_req)
1175   \param oid the OID of the extended operation.
1176   \param data a void pointer a the extended operation specific parameters,
1177   it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1178   \param controls an array of controls
1179   \param context the callback function context
1180   \param the callback function to handle the async replies
1181   \param the parent request if any
1182
1183   \return result code (LDB_SUCCESS on success, or a failure code)
1184 */
1185 int ldb_build_extended_req(struct ldb_request **ret_req,
1186                            struct ldb_context *ldb,
1187                            TALLOC_CTX *mem_ctx,
1188                            const char *oid,
1189                            void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1190                            struct ldb_control **controls,
1191                            void *context,
1192                            ldb_request_callback_t callback,
1193                            struct ldb_request *parent);
1194
1195 /**
1196   call an extended operation
1197
1198   This function deletes a record from the database.
1199
1200   \param ldb the context associated with the database (from ldb_init())
1201   \param oid the OID of the extended operation.
1202   \param data a void pointer a the extended operation specific parameters,
1203   it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
1204   \param res the result of the extended operation
1205
1206   \return result code (LDB_SUCCESS if the extended operation returned fine,
1207   otherwise a failure code)
1208 */
1209 int ldb_extended(struct ldb_context *ldb,
1210                  const char *oid,
1211                  void *data,/* NULL or a valid talloc pointer! talloc_get_type() will be used on it */
1212                  struct ldb_result **res);
1213
1214 /**
1215   start a transaction
1216 */
1217 int ldb_transaction_start(struct ldb_context *ldb);
1218
1219 /**
1220   commit a transaction
1221 */
1222 int ldb_transaction_commit(struct ldb_context *ldb);
1223
1224 /**
1225   cancel a transaction
1226 */
1227 int ldb_transaction_cancel(struct ldb_context *ldb);
1228
1229
1230 /**
1231   return extended error information from the last call
1232 */
1233 const char *ldb_errstring(struct ldb_context *ldb);
1234
1235 /**
1236   return a string explaining what a ldb error constant meancs
1237 */
1238 const char *ldb_strerror(int ldb_err);
1239
1240 /**
1241   setup the default utf8 functions
1242   FIXME: these functions do not yet handle utf8
1243 */
1244 void ldb_set_utf8_default(struct ldb_context *ldb);
1245
1246 /**
1247    Casefold a string
1248
1249    \param ldb the ldb context
1250    \param mem_ctx the memory context to allocate the result string
1251    memory from.
1252    \param s the string that is to be folded
1253    \return a copy of the string, converted to upper case
1254
1255    \note The default function is not yet UTF8 aware. Provide your own
1256          set of functions through ldb_set_utf8_fns()
1257 */
1258 char *ldb_casefold(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s, size_t n);
1259
1260 /**
1261    Check the attribute name is valid according to rfc2251
1262    \param s the string to check
1263
1264    \return 1 if the name is ok
1265 */
1266 int ldb_valid_attr_name(const char *s);
1267
1268 /*
1269   ldif manipulation functions
1270 */
1271
1272 /**
1273    Write an LDIF message
1274
1275    This function writes an LDIF message using a caller supplied  write
1276    function.
1277
1278    \param ldb the ldb context (from ldb_init())
1279    \param fprintf_fn a function pointer for the write function. This must take
1280    a private data pointer, followed by a format string, and then a variable argument
1281    list.
1282    \param private_data pointer that will be provided back to the write
1283    function. This is useful for maintaining state or context.
1284    \param ldif the message to write out
1285
1286    \return the total number of bytes written, or an error code as returned
1287    from the write function.
1288
1289    \sa ldb_ldif_write_file for a more convenient way to write to a
1290    file stream.
1291
1292    \sa ldb_ldif_read for the reader equivalent to this function.
1293 */
1294 int ldb_ldif_write(struct ldb_context *ldb,
1295                    int (*fprintf_fn)(void *, const char *, ...) PRINTF_ATTRIBUTE(2,3),
1296                    void *private_data,
1297                    const struct ldb_ldif *ldif);
1298
1299 /**
1300    Clean up an LDIF message
1301
1302    This function cleans up a LDIF message read using ldb_ldif_read()
1303    or related functions (such as ldb_ldif_read_string() and
1304    ldb_ldif_read_file().
1305
1306    \param ldb the ldb context (from ldb_init())
1307    \param msg the message to clean up and free
1308
1309 */
1310 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
1311
1312 /**
1313    Read an LDIF message
1314
1315    This function creates an LDIF message using a caller supplied read
1316    function.
1317
1318    \param ldb the ldb context (from ldb_init())
1319    \param fgetc_fn a function pointer for the read function. This must
1320    take a private data pointer, and must return a pointer to an
1321    integer corresponding to the next byte read (or EOF if there is no
1322    more data to be read).
1323    \param private_data pointer that will be provided back to the read
1324    function. This is udeful for maintaining state or context.
1325
1326    \return the LDIF message that has been read in
1327
1328    \note You must free the LDIF message when no longer required, using
1329    ldb_ldif_read_free().
1330
1331    \sa ldb_ldif_read_file for a more convenient way to read from a
1332    file stream.
1333
1334    \sa ldb_ldif_read_string for a more convenient way to read from a
1335    string (char array).
1336
1337    \sa ldb_ldif_write for the writer equivalent to this function.
1338 */
1339 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1340                                int (*fgetc_fn)(void *), void *private_data);
1341
1342 /**
1343    Read an LDIF message from a file
1344
1345    This function reads the next LDIF message from the contents of a
1346    file stream. If you want to get all of the LDIF messages, you will
1347    need to repeatedly call this function, until it returns NULL.
1348
1349    \param ldb the ldb context (from ldb_init())
1350    \param f the file stream to read from (typically from fdopen())
1351
1352    \sa ldb_ldif_read_string for an equivalent function that will read
1353    from a string (char array).
1354
1355    \sa ldb_ldif_write_file for the writer equivalent to this function.
1356
1357 */
1358 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1359
1360 /**
1361    Read an LDIF message from a string
1362
1363    This function reads the next LDIF message from the contents of a char
1364    array. If you want to get all of the LDIF messages, you will need
1365    to repeatedly call this function, until it returns NULL.
1366
1367    \param ldb the ldb context (from ldb_init())
1368    \param s pointer to the char array to read from
1369
1370    \sa ldb_ldif_read_file for an equivalent function that will read
1371    from a file stream.
1372
1373    \sa ldb_ldif_write for a more general (arbitrary read function)
1374    version of this function.
1375 */
1376 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1377
1378 /**
1379    Write an LDIF message to a file
1380
1381    \param ldb the ldb context (from ldb_init())
1382    \param f the file stream to write to (typically from fdopen())
1383    \param msg the message to write out
1384
1385    \return the total number of bytes written, or a negative error code
1386
1387    \sa ldb_ldif_read_file for the reader equivalent to this function.
1388 */
1389 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1390
1391 /**
1392    Base64 encode a buffer
1393
1394    \param mem_ctx the memory context that the result is allocated
1395    from.
1396    \param buf pointer to the array that is to be encoded
1397    \param len the number of elements in the array to be encoded
1398
1399    \return pointer to an array containing the encoded data
1400
1401    \note The caller is responsible for freeing the result
1402 */
1403 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len);
1404
1405 /**
1406    Base64 decode a buffer
1407
1408    This function decodes a base64 encoded string in place.
1409
1410    \param s the string to decode.
1411
1412    \return the length of the returned (decoded) string.
1413
1414    \note the string is null terminated, but the null terminator is not
1415    included in the length.
1416 */
1417 int ldb_base64_decode(char *s);
1418
1419 /* The following definitions come from lib/ldb/common/ldb_dn.c  */
1420
1421 struct ldb_dn *ldb_dn_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn);
1422 struct ldb_dn *ldb_dn_new_fmt(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1423 struct ldb_dn *ldb_dn_from_ldb_val(void *mem_ctx, struct ldb_context *ldb, const struct ldb_val *strdn);
1424 bool ldb_dn_validate(struct ldb_dn *dn);
1425
1426 char *ldb_dn_escape_value(TALLOC_CTX *mem_ctx, struct ldb_val value);
1427 const char *ldb_dn_get_linearized(struct ldb_dn *dn);
1428 const char *ldb_dn_get_casefold(struct ldb_dn *dn);
1429 char *ldb_dn_alloc_linearized(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1430 char *ldb_dn_alloc_casefold(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1431
1432 int ldb_dn_compare_base(struct ldb_dn *base, struct ldb_dn *dn);
1433 int ldb_dn_compare(struct ldb_dn *edn0, struct ldb_dn *edn1);
1434
1435 bool ldb_dn_add_base(struct ldb_dn *dn, struct ldb_dn *base);
1436 bool ldb_dn_add_base_fmt(struct ldb_dn *dn, const char *base_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1437 bool ldb_dn_add_child(struct ldb_dn *dn, struct ldb_dn *child);
1438 bool ldb_dn_add_child_fmt(struct ldb_dn *dn, const char *child_fmt, ...) PRINTF_ATTRIBUTE(2,3);
1439 bool ldb_dn_remove_base_components(struct ldb_dn *dn, unsigned int num);
1440 bool ldb_dn_remove_child_components(struct ldb_dn *dn, unsigned int num);
1441
1442 struct ldb_dn *ldb_dn_copy(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1443 struct ldb_dn *ldb_dn_get_parent(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1444 char *ldb_dn_canonical_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1445 char *ldb_dn_canonical_ex_string(TALLOC_CTX *mem_ctx, struct ldb_dn *dn);
1446 int ldb_dn_get_comp_num(struct ldb_dn *dn);
1447 const char *ldb_dn_get_component_name(struct ldb_dn *dn, unsigned int num);
1448 const struct ldb_val *ldb_dn_get_component_val(struct ldb_dn *dn, unsigned int num);
1449 const char *ldb_dn_get_rdn_name(struct ldb_dn *dn);
1450 const struct ldb_val *ldb_dn_get_rdn_val(struct ldb_dn *dn);
1451 int ldb_dn_set_component(struct ldb_dn *dn, int num, const char *name, const struct ldb_val val);
1452
1453 bool ldb_dn_is_valid(struct ldb_dn *dn);
1454 bool ldb_dn_is_special(struct ldb_dn *dn);
1455 bool ldb_dn_check_special(struct ldb_dn *dn, const char *check);
1456 bool ldb_dn_is_null(struct ldb_dn *dn);
1457
1458
1459 /**
1460    Compare two attributes
1461
1462    This function compares to attribute names. Note that this is a
1463    case-insensitive comparison.
1464
1465    \param a the first attribute name to compare
1466    \param b the second attribute name to compare
1467
1468    \return 0 if the attribute names are the same, or only differ in
1469    case; non-zero if there are any differences
1470
1471   attribute names are restricted by rfc2251 so using
1472   strcasecmp and toupper here is ok.
1473   return 0 for match
1474 */
1475 #define ldb_attr_cmp(a, b) strcasecmp(a, b)
1476 char *ldb_attr_casefold(TALLOC_CTX *mem_ctx, const char *s);
1477 int ldb_attr_dn(const char *attr);
1478
1479 /**
1480    Create an empty message
1481
1482    \param mem_ctx the memory context to create in. You can pass NULL
1483    to get the top level context, however the ldb context (from
1484    ldb_init()) may be a better choice
1485 */
1486 struct ldb_message *ldb_msg_new(TALLOC_CTX *mem_ctx);
1487
1488 /**
1489    Find an element within an message
1490 */
1491 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1492                                                  const char *attr_name);
1493
1494 /**
1495    Compare two ldb_val values
1496
1497    \param v1 first ldb_val structure to be tested
1498    \param v2 second ldb_val structure to be tested
1499
1500    \return 1 for a match, 0 if there is any difference
1501 */
1502 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1503
1504 /**
1505    find a value within an ldb_message_element
1506
1507    \param el the element to search
1508    \param val the value to search for
1509
1510    \note This search is case sensitive
1511 */
1512 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1513                                  struct ldb_val *val);
1514
1515 /**
1516    add a new empty element to a ldb_message
1517 */
1518 int ldb_msg_add_empty(struct ldb_message *msg,
1519                 const char *attr_name,
1520                 int flags,
1521                 struct ldb_message_element **return_el);
1522
1523 /**
1524    add a element to a ldb_message
1525 */
1526 int ldb_msg_add(struct ldb_message *msg,
1527                 const struct ldb_message_element *el,
1528                 int flags);
1529 int ldb_msg_add_value(struct ldb_message *msg,
1530                 const char *attr_name,
1531                 const struct ldb_val *val,
1532                 struct ldb_message_element **return_el);
1533 int ldb_msg_add_steal_value(struct ldb_message *msg,
1534                       const char *attr_name,
1535                       struct ldb_val *val);
1536 int ldb_msg_add_steal_string(struct ldb_message *msg,
1537                              const char *attr_name, char *str);
1538 int ldb_msg_add_string(struct ldb_message *msg,
1539                        const char *attr_name, const char *str);
1540 int ldb_msg_add_fmt(struct ldb_message *msg,
1541                     const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1542
1543 /**
1544    compare two message elements - return 0 on match
1545 */
1546 int ldb_msg_element_compare(struct ldb_message_element *el1,
1547                             struct ldb_message_element *el2);
1548
1549 /**
1550    Find elements in a message.
1551
1552    This function finds elements and converts to a specific type, with
1553    a give default value if not found. Assumes that elements are
1554    single valued.
1555 */
1556 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1557 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
1558                              const char *attr_name,
1559                              int default_value);
1560 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
1561                                        const char *attr_name,
1562                                        unsigned int default_value);
1563 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
1564                                    const char *attr_name,
1565                                    int64_t default_value);
1566 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
1567                                      const char *attr_name,
1568                                      uint64_t default_value);
1569 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
1570                                    const char *attr_name,
1571                                    double default_value);
1572 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
1573                               const char *attr_name,
1574                               int default_value);
1575 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
1576                                         const char *attr_name,
1577                                         const char *default_value);
1578
1579 struct ldb_dn *ldb_msg_find_attr_as_dn(struct ldb_context *ldb,
1580                                        TALLOC_CTX *mem_ctx,
1581                                        const struct ldb_message *msg,
1582                                        const char *attr_name);
1583
1584 void ldb_msg_sort_elements(struct ldb_message *msg);
1585
1586 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx,
1587                                          const struct ldb_message *msg);
1588 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx,
1589                                  const struct ldb_message *msg);
1590
1591 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1592                                          const struct ldb_message *msg);
1593
1594
1595 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1596                                  struct ldb_message *msg1,
1597                                  struct ldb_message *msg2);
1598
1599 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1600                                    const char *name,
1601                                    const char *value);
1602
1603 /**
1604    Integrity check an ldb_message
1605
1606    This function performs basic sanity / integrity checks on an
1607    ldb_message.
1608
1609    \param ldb context in which to perform the checks
1610    \param msg the message to check
1611
1612    \return LDB_SUCCESS if the message is OK, or a non-zero error code
1613    (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1614    LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1615    message.
1616 */
1617 int ldb_msg_sanity_check(struct ldb_context *ldb,
1618                          const struct ldb_message *msg);
1619
1620 /**
1621    Duplicate an ldb_val structure
1622
1623    This function copies an ldb value structure.
1624
1625    \param mem_ctx the memory context that the duplicated value will be
1626    allocated from
1627    \param v the ldb_val to be duplicated.
1628
1629    \return the duplicated ldb_val structure.
1630 */
1631 struct ldb_val ldb_val_dup(TALLOC_CTX *mem_ctx, const struct ldb_val *v);
1632
1633 /**
1634   this allows the user to set a debug function for error reporting
1635 */
1636 int ldb_set_debug(struct ldb_context *ldb,
1637                   void (*debug)(void *context, enum ldb_debug_level level,
1638                                 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0),
1639                   void *context);
1640
1641 /**
1642   this allows the user to set custom utf8 function for error reporting
1643 */
1644 void ldb_set_utf8_fns(struct ldb_context *ldb,
1645                       void *context,
1646                       char *(*casefold)(void *, void *, const char *, size_t n));
1647
1648 /**
1649    this sets up debug to print messages on stderr
1650 */
1651 int ldb_set_debug_stderr(struct ldb_context *ldb);
1652
1653 /* control backend specific opaque values */
1654 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1655 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1656
1657 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs);
1658 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr);
1659 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1660
1661
1662 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1663                                  const char *attr,
1664                                  const char *replace);
1665
1666 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1667 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1668 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1669
1670 /**
1671    Convert a time structure to a string
1672
1673    This function converts a time_t structure to an LDAP formatted
1674    GeneralizedTime string.
1675
1676    \param mem_ctx the memory context to allocate the return string in
1677    \param t the time structure to convert
1678
1679    \return the formatted string, or NULL if the time structure could
1680    not be converted
1681 */
1682 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t);
1683
1684 /**
1685    Convert a string to a time structure
1686
1687    This function converts an LDAP formatted GeneralizedTime string
1688    to a time_t structure.
1689
1690    \param s the string to convert
1691
1692    \return the time structure, or 0 if the string cannot be converted
1693 */
1694 time_t ldb_string_to_time(const char *s);
1695
1696 /**
1697    Convert a time structure to a string
1698
1699    This function converts a time_t structure to an LDAP formatted
1700    UTCTime string.
1701
1702    \param mem_ctx the memory context to allocate the return string in
1703    \param t the time structure to convert
1704
1705    \return the formatted string, or NULL if the time structure could
1706    not be converted
1707 */
1708 char *ldb_timestring_utc(TALLOC_CTX *mem_ctx, time_t t);
1709
1710 /**
1711    Convert a string to a time structure
1712
1713    This function converts an LDAP formatted UTCTime string
1714    to a time_t structure.
1715
1716    \param s the string to convert
1717
1718    \return the time structure, or 0 if the string cannot be converted
1719 */
1720 time_t ldb_string_utc_to_time(const char *s);
1721
1722
1723 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1724
1725
1726 /**
1727    Convert an array of string represention of a control into an array of ldb_control structures
1728
1729    \param ldb LDB context
1730    \param mem_ctx TALLOC context to return result on, and to allocate error_string on
1731    \param control_strings Array of string-formatted controls
1732
1733    \return array of ldb_control elements
1734 */
1735 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings);
1736
1737 #endif