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