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