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
   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 /**
  84    internal ldb exploded dn structures
  85 */
  86 struct ldb_dn_component {
  87         char *name;
  88         struct ldb_val value;
  89 };
  90
  91 struct ldb_dn {
  92         int comp_num;
  93         struct ldb_dn_component *components;
  94 };
  95
  96 /**
  97  There are a number of flags that are used with ldap_modify() in
  98  ldb_message_element.flags fields. The LDA_FLAGS_MOD_ADD,
  99  LDA_FLAGS_MOD_DELETE and LDA_FLAGS_MOD_REPLACE flags are used in
 100  ldap_modify() calls to specify whether attributes are being added,
 101  deleted or modified respectively.
 102 */
 103 #define LDB_FLAG_MOD_MASK  0x3
 104
 105 /**
 106    Flag value used in ldap_modify() to indicate that attributes are
 107    being added.
 108
 109    \sa LDB_FLAG_MOD_MASK
 110 */
 111 #define LDB_FLAG_MOD_ADD     1
 112
 113 /**
 114    Flag value used in ldap_modify() to indicate that attributes are
 115    being replaced.
 116
 117    \sa LDB_FLAG_MOD_MASK
 118 */
 119 #define LDB_FLAG_MOD_REPLACE 2
 120
 121 /**
 122    Flag value used in ldap_modify() to indicate that attributes are
 123    being deleted.
 124
 125    \sa LDB_FLAG_MOD_MASK
 126 */
 127 #define LDB_FLAG_MOD_DELETE  3
 128
 129 /**
 130   OID for logic AND comaprison.
 131
 132   This is the well known object ID for a logical AND comparitor.
 133 */
 134 #define LDB_OID_COMPARATOR_AND  "1.2.840.113556.1.4.803"
 135
 136 /**
 137   OID for logic OR comparison.
 138
 139   This is the well known object ID for a logical OR comparitor.
 140 */
 141 #define LDB_OID_COMPARATOR_OR   "1.2.840.113556.1.4.804"
 142
 143 /**
 144   results are given back as arrays of ldb_message_element
 145 */
 146 struct ldb_message_element {
 147         unsigned int flags;
 148         const char *name;
 149         unsigned int num_values;
 150         struct ldb_val *values;
 151 };
 152
 153
 154 /**
 155   a ldb_message represents all or part of a record. It can contain an arbitrary
 156   number of elements.
 157 */
 158 struct ldb_message {
 159         struct ldb_dn *dn;
 160         unsigned int num_elements;
 161         struct ldb_message_element *elements;
 162         void *private_data; /* private to the backend */
 163 };
 164
 165 enum ldb_changetype {
 166         LDB_CHANGETYPE_NONE=0,
 167         LDB_CHANGETYPE_ADD,
 168         LDB_CHANGETYPE_DELETE,
 169         LDB_CHANGETYPE_MODIFY
 170 };
 171
 172 /**
 173   LDIF record
 174
 175   This structure contains a LDIF record, as returned from ldif_read()
 176   and equivalent functions.
 177 */
 178 struct ldb_ldif {
 179         enum ldb_changetype changetype; /*!< The type of change */
 180         struct ldb_message *msg;  /*!< The changes */
 181 };
 182
 183 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
 184                 LDB_SCOPE_BASE=0,
 185                 LDB_SCOPE_ONELEVEL=1,
 186                 LDB_SCOPE_SUBTREE=2};
 187
 188 struct ldb_context;
 189
 190 /*
 191   the fuction type for the callback used in traversing the database
 192 */
 193 typedef int (*ldb_traverse_fn)(struct ldb_context *, const struct ldb_message *);
 194
 195
 196 /* debugging uses one of the following levels */
 197 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
 198                       LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
 199
 200 /**
 201   the user can optionally supply a debug function. The function
 202   is based on the vfprintf() style of interface, but with the addition
 203   of a severity level
 204 */
 205 struct ldb_debug_ops {
 206         void (*debug)(void *context, enum ldb_debug_level level,
 207                       const char *fmt, va_list ap);
 208         void *context;
 209 };
 210
 211 /**
 212   The user can optionally supply a custom utf8 functions,
 213   to handle comparisons and casefolding.
 214 */
 215 struct ldb_utf8_fns {
 216         void *context;
 217         char *(*casefold)(void *context, void *mem_ctx, const char *s);
 218 };
 219
 220 /**
 221    Flag value for database connection mode.
 222
 223    If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
 224    opened read-only, if possible.
 225 */
 226 #define LDB_FLG_RDONLY 1
 227
 228 /**
 229    Flag value for database connection mode.
 230
 231    If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
 232    opened without synchronous operations, if possible.
 233 */
 234 #define LDB_FLG_NOSYNC 2
 235
 236 /**
 237    Flag value to specify autoreconnect mode.
 238
 239    If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will
 240    be opened in a way that makes it try to auto reconnect if the
 241    connection is dropped (actually make sense only with ldap).
 242 */
 243 #define LDB_FLG_RECONNECT 4
 244
 245 /*! \cond DOXYGEN_IGNORE */
 246 #ifndef PRINTF_ATTRIBUTE
 247 #define PRINTF_ATTRIBUTE(a,b)
 248 #endif
 249 /*! \endcond */
 250
 251 /*
 252    structures for ldb_parse_tree handling code
 253 */
 254 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
 255                     LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
 256                     LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
 257                     LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
 258
 259 struct ldb_parse_tree {
 260         enum ldb_parse_op operation;
 261         union {
 262                 struct {
 263                         struct ldb_parse_tree *child;
 264                 } isnot;
 265                 struct {
 266                         const char *attr;
 267                         struct ldb_val value;
 268                 } equality;
 269                 struct {
 270                         const char *attr;
 271                         int start_with_wildcard;
 272                         int end_with_wildcard;
 273                         struct ldb_val **chunks;
 274                 } substring;
 275                 struct {
 276                         const char *attr;
 277                 } present;
 278                 struct {
 279                         const char *attr;
 280                         struct ldb_val value;
 281                 } comparison;
 282                 struct {
 283                         const char *attr;
 284                         int dnAttributes;
 285                         char *rule_id;
 286                         struct ldb_val value;
 287                 } extended;
 288                 struct {
 289                         unsigned int num_elements;
 290                         struct ldb_parse_tree **elements;
 291                 } list;
 292         } u;
 293 };
 294
 295 struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
 296 char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
 297
 298 /**
 299    Encode a binary blob
 300
 301    This function encodes a binary blob using the encoding rules in RFC
 302    2254 (Section 4). This function also escapes any non-printable
 303    characters.
 304
 305    \param ctx the memory context to allocate the return string in.
 306    \param val the (potentially) binary data 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(void *ctx, struct ldb_val val);
 313
 314 /**
 315    Encode a string
 316
 317    This function encodes a string using the encoding rules in RFC 2254
 318    (Section 4). This function also escapes any non-printable
 319    characters.
 320
 321    \param mem_ctx the memory context to allocate the return string in.
 322    \param string the string to be encoded
 323
 324    \return the encoded data as a null terminated string
 325
 326    \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>.
 327 */
 328 char *ldb_binary_encode_string(void *mem_ctx, const char *string);
 329
 330 /*
 331   functions for controlling attribute handling
 332 */
 333 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
 334 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
 335
 336 struct ldb_attrib_handler {
 337         const char *attr;
 338
 339         /* LDB_ATTR_FLAG_* */
 340         unsigned flags;
 341
 342         /* convert from ldif to binary format */
 343         ldb_attr_handler_t ldif_read_fn;
 344
 345         /* convert from binary to ldif format */
 346         ldb_attr_handler_t ldif_write_fn;
 347
 348         /* canonicalise a value, for use by indexing and dn construction */
 349         ldb_attr_handler_t canonicalise_fn;
 350
 351         /* compare two values */
 352         ldb_attr_comparison_t comparison_fn;
 353 };
 354
 355 /**
 356    The attribute is not returned by default
 357 */
 358 #define LDB_ATTR_FLAG_HIDDEN       (1<<0)
 359
 360 /**
 361    The attribute is constructed from other attributes
 362 */
 363 #define LDB_ATTR_FLAG_CONSTRUCTED  (1<<1)
 364
 365 /**
 366   LDAP attribute syntax for a DN
 367
 368   This is the well-known LDAP attribute syntax for a DN.
 369
 370   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 371 */
 372 #define LDB_SYNTAX_DN                   "1.3.6.1.4.1.1466.115.121.1.12"
 373
 374 /**
 375   LDAP attribute syntax for a Directory String
 376
 377   This is the well-known LDAP attribute syntax for a Directory String.
 378
 379   \sa <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 380 */
 381 #define LDB_SYNTAX_DIRECTORY_STRING     "1.3.6.1.4.1.1466.115.121.1.15"
 382
 383 /**
 384   LDAP attribute syntax for an integer
 385
 386   This is the well-known LDAP attribute syntax for an integer.
 387
 388   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 389 */
 390 #define LDB_SYNTAX_INTEGER              "1.3.6.1.4.1.1466.115.121.1.27"
 391
 392 /**
 393   LDAP attribute syntax for an octet string
 394
 395   This is the well-known LDAP attribute syntax for an octet string.
 396
 397   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 398 */
 399 #define LDB_SYNTAX_OCTET_STRING         "1.3.6.1.4.1.1466.115.121.1.40"
 400
 401 /**
 402   LDAP attribute syntax for UTC time.
 403
 404   This is the well-known LDAP attribute syntax for a UTC time.
 405
 406   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 407 */
 408 #define LDB_SYNTAX_UTC_TIME             "1.3.6.1.4.1.1466.115.121.1.53"
 409
 410 #define LDB_SYNTAX_OBJECTCLASS          "LDB_SYNTAX_OBJECTCLASS"
 411
 412 /* sorting helpers */
 413 typedef int (*ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque);
 414
 415 /**
 416    OID for the paged results control. This control is included in the
 417    searchRequest and searchResultDone messages as part of the controls
 418    field of the LDAPMessage, as defined in Section 4.1.12 of
 419    LDAP v3.
 420
 421    \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
 422 */
 423 #define LDB_CONTROL_PAGED_RESULTS_OID   "1.2.840.113556.1.4.319"
 424
 425 /**
 426    OID for specifying the returned elements of the ntSecurityDescriptor
 427
 428    \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>
 429 */
 430 #define LDB_CONTROL_SD_FLAGS_OID        "1.2.840.113556.1.4.801"
 431
 432 /**
 433    OID for specifying an advanced scope for a search
 434
 435    \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>
 436 */
 437 #define LDB_CONTROL_SEARCH_OPTIONS_OID  "1.2.840.113556.1.4.1340"
 438
 439 /**
 440    OID for notification
 441
 442    \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>
 443 */
 444 #define LDB_CONTROL_NOTIFICATION_OID    "1.2.840.113556.1.4.528"
 445
 446 /**
 447    OID for extended DN
 448
 449    \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>
 450 */
 451 #define LDB_CONTROL_EXTENDED_DN_OID     "1.2.840.113556.1.4.529"
 452
 453 /**
 454    OID for LDAP server sort result extension.
 455
 456    This control is included in the searchRequest message as part of
 457    the controls field of the LDAPMessage, as defined in Section 4.1.12
 458    of LDAP v3. The controlType is set to
 459    "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
 460    FALSE (where absent is also equivalent to FALSE) at the client's
 461    option.
 462
 463    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
 464 */
 465 #define LDB_CONTROL_SERVER_SORT_OID     "1.2.840.113556.1.4.473"
 466
 467 /**
 468    OID for LDAP server sort result response extension.
 469
 470    This control is included in the searchResultDone message as part of
 471    the controls field of the LDAPMessage, as defined in Section 4.1.12 of
 472    LDAP v3.
 473
 474    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
 475 */
 476 #define LDB_CONTROL_SORT_RESP_OID       "1.2.840.113556.1.4.474"
 477
 478 /**
 479    OID for LDAP Attribute Scoped Query extension.
 480
 481    This control is included in SearchRequest or SearchResponse
 482    messages as part of the controls field of the LDAPMessage.
 483 */
 484 #define LDB_CONTROL_ASQ_OID             "1.2.840.113556.1.4.1504"
 485
 486 /**
 487    OID for LDAP Directory Sync extension.
 488
 489    This control is included in SearchRequest or SearchResponse
 490    messages as part of the controls field of the LDAPMessage.
 491 */
 492 #define LDB_CONTROL_DIRSYNC_OID         "1.2.840.113556.1.4.841"
 493
 494
 495 /**
 496    OID for LDAP Virtual List View Request extension.
 497
 498    This control is included in SearchRequest messages
 499    as part of the controls field of the LDAPMessage.
 500 */
 501 #define LDB_CONTROL_VLV_REQ_OID         "2.16.840.1.113730.3.4.9"
 502
 503 /**
 504    OID for LDAP Virtual List View Response extension.
 505
 506    This control is included in SearchResponse messages
 507    as part of the controls field of the LDAPMessage.
 508 */
 509 #define LDB_CONTROL_VLV_RESP_OID        "2.16.840.1.113730.3.4.10"
 510
 511 /**
 512    OID for LDAP Extended Operation START_TLS.
 513
 514    This Extended operation is used to start a new TLS
 515    channel on top of a clear text channel.
 516 */
 517 #define LDB_EXTENDED_START_TLS_OID      "1.3.6.1.4.1.1466.20037"
 518
 519 /**
 520    OID for LDAP Extended Operation START_TLS.
 521
 522    This Extended operation is used to start a new TLS
 523    channel on top of a clear text channel.
 524 */
 525 #define LDB_EXTENDED_DYNAMIC_OID        "1.3.6.1.4.1.1466.101.119.1"
 526
 527 /**
 528    OID for LDAP Extended Operation START_TLS.
 529
 530    This Extended operation is used to start a new TLS
 531    channel on top of a clear text channel.
 532 */
 533 #define LDB_EXTENDED_FAST_BIND_OID      "1.2.840.113556.1.4.1781"
 534
 535 struct ldb_sd_flags_control {
 536         /*
 537          * request the owner    0x00000001
 538          * request the group    0x00000002
 539          * request the DACL     0x00000004
 540          * request the SACL     0x00000008
 541          */
 542         unsigned secinfo_flags;
 543 };
 544
 545 struct ldb_search_options_control {
 546         /*
 547          * DOMAIN_SCOPE         0x00000001
 548          * this limits the search to one partition,
 549          * and no referrals will be returned.
 550          * (Note this doesn't limit the entries by there
 551          *  objectSid belonging to a domain! Builtin and Foreign Sids
 552          *  are still returned)
 553          *
 554          * PHANTOM_ROOT         0x00000002
 555          * this search on the whole tree on a domain controller
 556          * over multiple partitions without referrals.
 557          * (This is the default behavior on the Global Catalog Port)
 558          */
 559         unsigned search_options;
 560 };
 561
 562 struct ldb_paged_control {
 563         int size;
 564         int cookie_len;
 565         char *cookie;
 566 };
 567
 568 struct ldb_extended_dn_control {
 569         int type;
 570 };
 571
 572 struct ldb_server_sort_control {
 573         char *attributeName;
 574         char *orderingRule;
 575         int reverse;
 576 };
 577
 578 struct ldb_sort_resp_control {
 579         int result;
 580         char *attr_desc;
 581 };
 582
 583 struct ldb_asq_control {
 584         int request;
 585         char *source_attribute;
 586         int src_attr_len;
 587         int result;
 588 };
 589
 590 struct ldb_dirsync_control {
 591         int flags;
 592         int max_attributes;
 593         int cookie_len;
 594         char *cookie;
 595 };
 596
 597 struct ldb_vlv_req_control {
 598         int beforeCount;
 599         int afterCount;
 600         int type;
 601         union {
 602                 struct {
 603                         int offset;
 604                         int contentCount;
 605                 } byOffset;
 606                 struct {
 607                         int value_len;
 608                         char *value;
 609                 } gtOrEq;
 610         } match;
 611         int ctxid_len;
 612         char *contextId;
 613 };
 614
 615 struct ldb_vlv_resp_control {
 616         int targetPosition;
 617         int contentCount;
 618         int vlv_result;
 619         int ctxid_len;
 620         char *contextId;
 621 };
 622
 623 struct ldb_control {
 624         const char *oid;
 625         int critical;
 626         void *data;
 627 };
 628
 629 enum ldb_request_type {
 630         LDB_SEARCH,
 631         LDB_ADD,
 632         LDB_MODIFY,
 633         LDB_DELETE,
 634         LDB_RENAME,
 635         LDB_EXTENDED,
 636         LDB_REQ_REGISTER_CONTROL,
 637         LDB_REQ_REGISTER_PARTITION,
 638         LDB_SEQUENCE_NUMBER
 639 };
 640
 641 enum ldb_reply_type {
 642         LDB_REPLY_ENTRY,
 643         LDB_REPLY_REFERRAL,
 644         LDB_REPLY_EXTENDED,
 645         LDB_REPLY_DONE
 646 };
 647
 648 enum ldb_wait_type {
 649         LDB_WAIT_ALL,
 650         LDB_WAIT_NONE
 651 };
 652
 653 enum ldb_state {
 654         LDB_ASYNC_INIT,
 655         LDB_ASYNC_PENDING,
 656         LDB_ASYNC_DONE
 657 };
 658
 659 struct ldb_result {
 660         unsigned int count;
 661         struct ldb_message **msgs;
 662         char **refs;
 663         struct ldb_control **controls;
 664 };
 665
 666 struct ldb_extended {
 667         const char *oid;
 668         const char *value;
 669         int value_len;
 670 };
 671
 672 struct ldb_reply {
 673         enum ldb_reply_type type;
 674         struct ldb_message *message;
 675         struct ldb_extended *response;
 676         char *referral;
 677         struct ldb_control **controls;
 678 };
 679
 680 struct ldb_handle {
 681         int status;
 682         enum ldb_state state;
 683         void *private_data;
 684         struct ldb_module *module;
 685 };
 686
 687 struct ldb_search {
 688         const struct ldb_dn *base;
 689         enum ldb_scope scope;
 690         const struct ldb_parse_tree *tree;
 691         const char * const *attrs;
 692         struct ldb_result *res;
 693 };
 694
 695 struct ldb_add {
 696         const struct ldb_message *message;
 697 };
 698
 699 struct  ldb_modify {
 700         const struct ldb_message *message;
 701 };
 702
 703 struct ldb_delete {
 704         const struct ldb_dn *dn;
 705 };
 706
 707 struct ldb_rename {
 708         const struct ldb_dn *olddn;
 709         const struct ldb_dn *newdn;
 710 };
 711
 712 struct ldb_register_control {
 713         const char *oid;
 714 };
 715
 716 struct ldb_register_partition {
 717         const struct ldb_dn *dn;
 718 };
 719
 720 struct ldb_sequence_number {
 721         uint64_t seq_num;
 722 };
 723
 724 struct ldb_request {
 725
 726         enum ldb_request_type operation;
 727
 728         union {
 729                 struct ldb_search search;
 730                 struct ldb_add    add;
 731                 struct ldb_modify mod;
 732                 struct ldb_delete del;
 733                 struct ldb_rename rename;
 734                 struct ldb_register_control reg_control;
 735                 struct ldb_register_partition reg_partition;
 736                 struct ldb_sequence_number seq_num;
 737         } op;
 738
 739         struct ldb_control **controls;
 740
 741         void *context;
 742         int (*callback)(struct ldb_context *, void *, struct ldb_reply *);
 743
 744         int timeout;
 745         time_t starttime;
 746         struct ldb_handle *handle;
 747 };
 748
 749 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
 750
 751 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
 752
 753 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
 754 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
 755
 756 /**
 757   Initialise ldbs' global information
 758
 759   This is required before any other LDB call
 760
 761   \return 0 if initialisation succeeded, -1 otherwise
 762 */
 763 int ldb_global_init(void);
 764
 765 /**
 766   Initialise an ldb context
 767
 768   This is required before any other LDB call.
 769
 770   \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
 771   no suitable context available.
 772
 773   \return pointer to ldb_context that should be free'd (using talloc_free())
 774   at the end of the program.
 775 */
 776 struct ldb_context *ldb_init(void *mem_ctx);
 777
 778 /**
 779    Connect to a database.
 780
 781    This is typically called soon after ldb_init(), and is required prior to
 782    any search or database modification operations.
 783
 784    The URL can be one of the following forms:
 785     - tdb://path
 786     - ldapi://path
 787     - ldap://host
 788     - sqlite://path
 789
 790    \param ldb the context associated with the database (from ldb_init())
 791    \param url the URL of the database to connect to, as noted above
 792    \param flags a combination of LDB_FLG_* to modify the connection behaviour
 793    \param options backend specific options - passed uninterpreted to the backend
 794
 795    \return result code (LDB_SUCCESS on success, or a failure code)
 796
 797    \note It is an error to connect to a database that does not exist in readonly mode
 798    (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
 799    created if it does not exist.
 800 */
 801 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
 802
 803 /**
 804   Search the database
 805
 806   This function searches the database, and returns
 807   records that match an LDAP-like search expression
 808
 809   \param ldb the context associated with the database (from ldb_init())
 810   \param base the Base Distinguished Name for the query (pass NULL for root DN)
 811   \param scope the search scope for the query
 812   \param expression the search expression to use for this query
 813   \param attrs the search attributes for the query (pass NULL if none required)
 814   \param res the return result
 815
 816   \return result code (LDB_SUCCESS on success, or a failure code)
 817
 818   \note use talloc_free() to free the ldb_result returned
 819 */
 820 int ldb_search(struct ldb_context *ldb,
 821                const struct ldb_dn *base,
 822                enum ldb_scope scope,
 823                const char *expression,
 824                const char * const *attrs, struct ldb_result **res);
 825
 826 /*
 827   like ldb_search() but takes a parse tree
 828 */
 829 int ldb_search_bytree(struct ldb_context *ldb,
 830                       const struct ldb_dn *base,
 831                       enum ldb_scope scope,
 832                       struct ldb_parse_tree *tree,
 833                       const char * const *attrs, struct ldb_result **res);
 834
 835 /**
 836   Add a record to the database.
 837
 838   This function adds a record to the database. This function will fail
 839   if a record with the specified class and key already exists in the
 840   database.
 841
 842   \param ldb the context associated with the database (from
 843   ldb_init())
 844   \param message the message containing the record to add.
 845
 846   \return result code (LDB_SUCCESS if the record was added, otherwise
 847   a failure code)
 848 */
 849 int ldb_add(struct ldb_context *ldb,
 850             const struct ldb_message *message);
 851
 852 /**
 853   Modify the specified attributes of a record
 854
 855   This function modifies a record that is in the database.
 856
 857   \param ldb the context associated with the database (from
 858   ldb_init())
 859   \param message the message containing the changes required.
 860
 861   \return result code (LDB_SUCCESS if the record was modified as
 862   requested, otherwise a failure code)
 863 */
 864 int ldb_modify(struct ldb_context *ldb,
 865                const struct ldb_message *message);
 866
 867 /**
 868   Rename a record in the database
 869
 870   This function renames a record in the database.
 871
 872   \param ldb the context associated with the database (from
 873   ldb_init())
 874   \param olddn the DN for the record to be renamed.
 875   \param newdn the new DN
 876
 877   \return result code (LDB_SUCCESS if the record was renamed as
 878   requested, otherwise a failure code)
 879 */
 880 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);
 881
 882 /**
 883   Delete a record from the database
 884
 885   This function deletes a record from the database.
 886
 887   \param ldb the context associated with the database (from
 888   ldb_init())
 889   \param dn the DN for the record to be deleted.
 890
 891   \return result code (LDB_SUCCESS if the record was deleted,
 892   otherwise a failure code)
 893 */
 894 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);
 895
 896 /**
 897   Obtain current database sequence number
 898 */
 899 int ldb_sequence_number(struct ldb_context *ldb, uint64_t *seq_num);
 900
 901 /**
 902   start a transaction
 903 */
 904 int ldb_transaction_start(struct ldb_context *ldb);
 905
 906 /**
 907   commit a transaction
 908 */
 909 int ldb_transaction_commit(struct ldb_context *ldb);
 910
 911 /**
 912   cancel a transaction
 913 */
 914 int ldb_transaction_cancel(struct ldb_context *ldb);
 915
 916
 917 /**
 918   return extended error information from the last call
 919 */
 920 const char *ldb_errstring(struct ldb_context *ldb);
 921
 922 /**
 923   return a string explaining what a ldb error constant meancs
 924 */
 925 const char *ldb_strerror(int ldb_err);
 926
 927 /**
 928   setup the default utf8 functions
 929   FIXME: these functions do not yet handle utf8
 930 */
 931 void ldb_set_utf8_default(struct ldb_context *ldb);
 932
 933 /**
 934    Casefold a string
 935
 936    \param ldb the ldb context
 937    \param mem_ctx the memory context to allocate the result string
 938    memory from.
 939    \param s the string that is to be folded
 940    \return a copy of the string, converted to upper case
 941
 942    \note The default function is not yet UTF8 aware. Provide your own
 943          set of functions through ldb_set_utf8_fns()
 944 */
 945 char *ldb_casefold(struct ldb_context *ldb, void *mem_ctx, const char *s);
 946
 947 /**
 948    Check the attribute name is valid according to rfc2251
 949    \param s tthe string to check
 950
 951    \return 1 if the name is ok
 952 */
 953 int ldb_valid_attr_name(const char *s);
 954
 955 /*
 956   ldif manipulation functions
 957 */
 958 /**
 959    Write an LDIF message
 960
 961    This function writes an LDIF message using a caller supplied  write
 962    function.
 963
 964    \param ldb the ldb context (from ldb_init())
 965    \param fprintf_fn a function pointer for the write function. This must take
 966    a private data pointer, followed by a format string, and then a variable argument
 967    list.
 968    \param private_data pointer that will be provided back to the write
 969    function. This is useful for maintaining state or context.
 970    \param ldif the message to write out
 971
 972    \return the total number of bytes written, or an error code as returned
 973    from the write function.
 974
 975    \sa ldb_ldif_write_file for a more convenient way to write to a
 976    file stream.
 977
 978    \sa ldb_ldif_read for the reader equivalent to this function.
 979 */
 980 int ldb_ldif_write(struct ldb_context *ldb,
 981                    int (*fprintf_fn)(void *, const char *, ...),
 982                    void *private_data,
 983                    const struct ldb_ldif *ldif);
 984
 985 /**
 986    Clean up an LDIF message
 987
 988    This function cleans up a LDIF message read using ldb_ldif_read()
 989    or related functions (such as ldb_ldif_read_string() and
 990    ldb_ldif_read_file().
 991
 992    \param ldb the ldb context (from ldb_init())
 993    \param msg the message to clean up and free
 994
 995 */
 996 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
 997
 998 /**
 999    Read an LDIF message
1000
1001    This function creates an LDIF message using a caller supplied read
1002    function.
1003
1004    \param ldb the ldb context (from ldb_init())
1005    \param fgetc_fn a function pointer for the read function. This must
1006    take a private data pointer, and must return a pointer to an
1007    integer corresponding to the next byte read (or EOF if there is no
1008    more data to be read).
1009    \param private_data pointer that will be provided back to the read
1010    function. This is udeful for maintaining state or context.
1011
1012    \return the LDIF message that has been read in
1013
1014    \note You must free the LDIF message when no longer required, using
1015    ldb_ldif_read_free().
1016
1017    \sa ldb_ldif_read_file for a more convenient way to read from a
1018    file stream.
1019
1020    \sa ldb_ldif_read_string for a more convenient way to read from a
1021    string (char array).
1022
1023    \sa ldb_ldif_write for the writer equivalent to this function.
1024 */
1025 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
1026                                int (*fgetc_fn)(void *), void *private_data);
1027
1028 /**
1029    Read an LDIF message from a file
1030
1031    This function reads the next LDIF message from the contents of a
1032    file stream. If you want to get all of the LDIF messages, you will
1033    need to repeatedly call this function, until it returns NULL.
1034
1035    \param ldb the ldb context (from ldb_init())
1036    \param f the file stream to read from (typically from fdopen())
1037
1038    \sa ldb_ldif_read_string for an equivalent function that will read
1039    from a string (char array).
1040
1041    \sa ldb_ldif_write_file for the writer equivalent to this function.
1042
1043 */
1044 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
1045
1046 /**
1047    Read an LDIF message from a string
1048
1049    This function reads the next LDIF message from the contents of a char
1050    array. If you want to get all of the LDIF messages, you will need
1051    to repeatedly call this function, until it returns NULL.
1052
1053    \param ldb the ldb context (from ldb_init())
1054    \param s pointer to the char array to read from
1055
1056    \sa ldb_ldif_read_file for an equivalent function that will read
1057    from a file stream.
1058
1059    \sa ldb_ldif_write for a more general (arbitrary read function)
1060    version of this function.
1061 */
1062 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1063
1064 /**
1065    Write an LDIF message to a file
1066
1067    \param ldb the ldb context (from ldb_init())
1068    \param f the file stream to write to (typically from fdopen())
1069    \param msg the message to write out
1070
1071    \return the total number of bytes written, or a negative error code
1072
1073    \sa ldb_ldif_read_file for the reader equivalent to this function.
1074 */
1075 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1076
1077 /**
1078    Base64 encode a buffer
1079
1080    \param mem_ctx the memory context that the result is allocated
1081    from.
1082    \param buf pointer to the array that is to be encoded
1083    \param len the number of elements in the array to be encoded
1084
1085    \return pointer to an array containing the encoded data
1086
1087    \note The caller is responsible for freeing the result
1088 */
1089 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
1090
1091 /**
1092    Base64 decode a buffer
1093
1094    This function decodes a base64 encoded string in place.
1095
1096    \param s the string to decode.
1097
1098    \return the length of the returned (decoded) string.
1099
1100    \note the string is null terminated, but the null terminator is not
1101    included in the length.
1102 */
1103 int ldb_base64_decode(char *s);
1104
1105 int ldb_attrib_add_handlers(struct ldb_context *ldb,
1106                             const struct ldb_attrib_handler *handlers,
1107                             unsigned num_handlers);
1108
1109 /* The following definitions come from lib/ldb/common/ldb_dn.c  */
1110
1111 int ldb_dn_is_special(const struct ldb_dn *dn);
1112 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check);
1113 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
1114 struct ldb_dn *ldb_dn_new(void *mem_ctx);
1115 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);
1116 struct ldb_dn *ldb_dn_explode_or_special(void *mem_ctx, const char *dn);
1117 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn);
1118 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
1119 int ldb_dn_compare_base(struct ldb_context *ldb, const struct ldb_dn *base, const struct ldb_dn *dn);
1120 int ldb_dn_compare(struct ldb_context *ldb, const struct ldb_dn *edn0, const struct ldb_dn *edn1);
1121 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
1122 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, const char *dn);
1123 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el);
1124 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn);
1125 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn);
1126 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
1127                                                                const char *val);
1128 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
1129                                                  const char * value,
1130                                                  const struct ldb_dn *base);
1131 struct ldb_dn *ldb_dn_make_child(void *mem_ctx,
1132                                  const struct ldb_dn_component *component,
1133                                  const struct ldb_dn *base);
1134 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2);
1135 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1136 struct ldb_dn_component *ldb_dn_get_rdn(void *mem_ctx, const struct ldb_dn *dn);
1137
1138 /* useful functions for ldb_message structure manipulation */
1139 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
1140
1141 /**
1142    Compare two attributes
1143
1144    This function compares to attribute names. Note that this is a
1145    case-insensitive comparison.
1146
1147    \param attr1 the first attribute name to compare
1148    \param attr2 the second attribute name to compare
1149
1150    \return 0 if the attribute names are the same, or only differ in
1151    case; non-zero if there are any differences
1152 */
1153 int ldb_attr_cmp(const char *attr1, const char *attr2);
1154 char *ldb_attr_casefold(void *mem_ctx, const char *s);
1155 int ldb_attr_dn(const char *attr);
1156
1157 /**
1158    Create an empty message
1159
1160    \param mem_ctx the memory context to create in. You can pass NULL
1161    to get the top level context, however the ldb context (from
1162    ldb_init()) may be a better choice
1163 */
1164 struct ldb_message *ldb_msg_new(void *mem_ctx);
1165
1166 /**
1167    Find an element within an message
1168 */
1169 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1170                                                  const char *attr_name);
1171
1172 /**
1173    Compare two ldb_val values
1174
1175    \param v1 first ldb_val structure to be tested
1176    \param v2 second ldb_val structure to be tested
1177
1178    \return 1 for a match, 0 if there is any difference
1179 */
1180 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1181
1182 /**
1183    find a value within an ldb_message_element
1184
1185    \param el the element to search
1186    \param val the value to search for
1187
1188    \note This search is case sensitive
1189 */
1190 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1191                                  struct ldb_val *val);
1192
1193 /**
1194    add a new empty element to a ldb_message
1195 */
1196 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags);
1197
1198 /**
1199    add a element to a ldb_message
1200 */
1201 int ldb_msg_add(struct ldb_message *msg,
1202                 const struct ldb_message_element *el,
1203                 int flags);
1204 int ldb_msg_add_value(struct ldb_message *msg,
1205                       const char *attr_name,
1206                       const struct ldb_val *val);
1207 int ldb_msg_add_steal_value(struct ldb_message *msg,
1208                       const char *attr_name,
1209                       struct ldb_val *val);
1210 int ldb_msg_add_steal_string(struct ldb_message *msg,
1211                              const char *attr_name, char *str);
1212 int ldb_msg_add_string(struct ldb_message *msg,
1213                        const char *attr_name, const char *str);
1214 int ldb_msg_add_fmt(struct ldb_message *msg,
1215                     const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1216
1217 /**
1218    compare two message elements - return 0 on match
1219 */
1220 int ldb_msg_element_compare(struct ldb_message_element *el1,
1221                             struct ldb_message_element *el2);
1222
1223 /**
1224    Find elements in a message.
1225
1226    This function finds elements and converts to a specific type, with
1227    a give default value if not found. Assumes that elements are
1228    single valued.
1229 */
1230 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1231 int ldb_msg_find_int(const struct ldb_message *msg,
1232                      const char *attr_name,
1233                      int default_value);
1234 unsigned int ldb_msg_find_uint(const struct ldb_message *msg,
1235                                const char *attr_name,
1236                                unsigned int default_value);
1237 int64_t ldb_msg_find_int64(const struct ldb_message *msg,
1238                            const char *attr_name,
1239                            int64_t default_value);
1240 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg,
1241                              const char *attr_name,
1242                              uint64_t default_value);
1243 double ldb_msg_find_double(const struct ldb_message *msg,
1244                            const char *attr_name,
1245                            double default_value);
1246 const char *ldb_msg_find_string(const struct ldb_message *msg,
1247                                 const char *attr_name,
1248                                 const char *default_value);
1249
1250 void ldb_msg_sort_elements(struct ldb_message *msg);
1251
1252 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
1253                                          const struct ldb_message *msg);
1254 struct ldb_message *ldb_msg_copy(void *mem_ctx,
1255                                  const struct ldb_message *msg);
1256
1257 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1258                                          const struct ldb_message *msg);
1259
1260
1261 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1262                                  struct ldb_message *msg1,
1263                                  struct ldb_message *msg2);
1264
1265 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1266                                    const char *name,
1267                                    const char *value);
1268
1269 /**
1270    Integrity check an ldb_message
1271
1272    This function performs basic sanity / integrity checks on an
1273    ldb_message.
1274
1275    \param msg the message to check
1276
1277    \return LDB_SUCCESS if the message is OK, or a non-zero error code
1278    (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1279    LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1280    message.
1281 */
1282 int ldb_msg_sanity_check(struct ldb_context *ldb,
1283                          const struct ldb_message *msg);
1284
1285 /**
1286    Duplicate an ldb_val structure
1287
1288    This function copies an ldb value structure.
1289
1290    \param mem_ctx the memory context that the duplicated value will be
1291    allocated from
1292    \param v the ldb_val to be duplicated.
1293
1294    \return the duplicated ldb_val structure.
1295 */
1296 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
1297
1298 /**
1299   this allows the user to set a debug function for error reporting
1300 */
1301 int ldb_set_debug(struct ldb_context *ldb,
1302                   void (*debug)(void *context, enum ldb_debug_level level,
1303                                 const char *fmt, va_list ap),
1304                   void *context);
1305
1306 /**
1307   this allows the user to set custom utf8 function for error reporting
1308 */
1309 void ldb_set_utf8_fns(struct ldb_context *ldb,
1310                         void *context,
1311                         char *(*casefold)(void *, void *, const char *));
1312
1313 /**
1314    this sets up debug to print messages on stderr
1315 */
1316 int ldb_set_debug_stderr(struct ldb_context *ldb);
1317
1318 /* control backend specific opaque values */
1319 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1320 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1321
1322 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
1323                                                     const char *attrib);
1324
1325
1326 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
1327 const char **ldb_attr_list_copy_add(void *mem_ctx, const char * const *attrs, const char *new_attr);
1328 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1329
1330
1331 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1332                                  const char *attr,
1333                                  const char *replace);
1334
1335 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1336 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1337 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1338
1339 /**
1340    Convert a time structure to a string
1341
1342    This function converts a time_t structure to an LDAP formatted time
1343    string.
1344
1345    \param mem_ctx the memory context to allocate the return string in
1346    \param t the time structure to convert
1347
1348    \return the formatted string, or NULL if the time structure could
1349    not be converted
1350 */
1351 char *ldb_timestring(void *mem_ctx, time_t t);
1352
1353 /**
1354    Convert a string to a time structure
1355
1356    This function converts an LDAP formatted time string to a time_t
1357    structure.
1358
1359    \param s the string to convert
1360
1361    \return the time structure, or 0 if the string cannot be converted
1362 */
1363 time_t ldb_string_to_time(const char *s);
1364
1365 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn);
1366 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn);
1367
1368
1369 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1370 #endif