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