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