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