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 notification
 427
 428    \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>
 429 */
 430 #define LDB_CONTROL_NOTIFICATION_OID    "1.2.840.113556.1.4.528"
 431
 432 /**
 433    OID for extended DN
 434
 435    \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>
 436 */
 437 #define LDB_CONTROL_EXTENDED_DN_OID     "1.2.840.113556.1.4.529"
 438
 439 /**
 440    OID for LDAP server sort result extension.
 441
 442    This control is included in the searchRequest message as part of
 443    the controls field of the LDAPMessage, as defined in Section 4.1.12
 444    of LDAP v3. The controlType is set to
 445    "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
 446    FALSE (where absent is also equivalent to FALSE) at the client's
 447    option.
 448
 449    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
 450 */
 451 #define LDB_CONTROL_SERVER_SORT_OID     "1.2.840.113556.1.4.473"
 452
 453 /**
 454    OID for LDAP server sort result response extension.
 455
 456    This control is included in the searchResultDone message as part of
 457    the controls field of the LDAPMessage, as defined in Section 4.1.12 of
 458    LDAP v3.
 459
 460    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
 461 */
 462 #define LDB_CONTROL_SORT_RESP_OID       "1.2.840.113556.1.4.474"
 463
 464 /**
 465    OID for LDAP Attribute Scoped Query extension.
 466
 467    This control is included in SearchRequest or SearchResponse
 468    messages as part of the controls field of the LDAPMessage.
 469 */
 470 #define LDB_CONTROL_ASQ_OID             "1.2.840.113556.1.4.1504"
 471
 472 /**
 473    OID for LDAP Directory Sync extension.
 474
 475    This control is included in SearchRequest or SearchResponse
 476    messages as part of the controls field of the LDAPMessage.
 477 */
 478 #define LDB_CONTROL_DIRSYNC_OID         "1.2.840.113556.1.4.841"
 479
 480
 481 /**
 482    OID for LDAP Virtual List View Request extension.
 483
 484    This control is included in SearchRequest messages
 485    as part of the controls field of the LDAPMessage.
 486 */
 487 #define LDB_CONTROL_VLV_REQ_OID         "2.16.840.1.113730.3.4.9"
 488
 489 /**
 490    OID for LDAP Virtual List View Response extension.
 491
 492    This control is included in SearchResponse messages
 493    as part of the controls field of the LDAPMessage.
 494 */
 495 #define LDB_CONTROL_VLV_RESP_OID        "2.16.840.1.113730.3.4.10"
 496
 497 /**
 498    OID for LDAP Extended Operation START_TLS.
 499
 500    This Extended operation is used to start a new TLS
 501    channel on top of a clear text channel.
 502 */
 503 #define LDB_EXTENDED_START_TLS_OID      "1.3.6.1.4.1.1466.20037"
 504
 505 struct ldb_paged_control {
 506         int size;
 507         int cookie_len;
 508         char *cookie;
 509 };
 510
 511 struct ldb_extended_dn_control {
 512         int type;
 513 };
 514
 515 struct ldb_server_sort_control {
 516         char *attributeName;
 517         char *orderingRule;
 518         int reverse;
 519 };
 520
 521 struct ldb_sort_resp_control {
 522         int result;
 523         char *attr_desc;
 524 };
 525
 526 struct ldb_asq_control {
 527         int request;
 528         char *source_attribute;
 529         int src_attr_len;
 530         int result;
 531 };
 532
 533 struct ldb_dirsync_control {
 534         int flags;
 535         int max_attributes;
 536         int cookie_len;
 537         char *cookie;
 538 };
 539
 540 struct ldb_vlv_req_control {
 541         int beforeCount;
 542         int afterCount;
 543         int type;
 544         union {
 545                 struct {
 546                         int offset;
 547                         int contentCount;
 548                 } byOffset;
 549                 struct {
 550                         int value_len;
 551                         char *value;
 552                 } gtOrEq;
 553         } match;
 554         int ctxid_len;
 555         char *contextId;
 556 };
 557
 558 struct ldb_vlv_resp_control {
 559         int targetPosition;
 560         int contentCount;
 561         int vlv_result;
 562         int ctxid_len;
 563         char *contextId;
 564 };
 565
 566 struct ldb_control {
 567         const char *oid;
 568         int critical;
 569         void *data;
 570 };
 571
 572 enum ldb_request_type {
 573         LDB_SEARCH,
 574         LDB_ADD,
 575         LDB_MODIFY,
 576         LDB_DELETE,
 577         LDB_RENAME,
 578         LDB_EXTENDED,
 579         LDB_REQ_REGISTER_CONTROL,
 580         LDB_REQ_REGISTER_PARTITION,
 581         LDB_SEQUENCE_NUMBER
 582 };
 583
 584 enum ldb_reply_type {
 585         LDB_REPLY_ENTRY,
 586         LDB_REPLY_REFERRAL,
 587         LDB_REPLY_EXTENDED,
 588         LDB_REPLY_DONE
 589 };
 590
 591 enum ldb_wait_type {
 592         LDB_WAIT_ALL,
 593         LDB_WAIT_NONE
 594 };
 595
 596 enum ldb_state {
 597         LDB_ASYNC_INIT,
 598         LDB_ASYNC_PENDING,
 599         LDB_ASYNC_DONE
 600 };
 601
 602 struct ldb_result {
 603         unsigned int count;
 604         struct ldb_message **msgs;
 605         char **refs;
 606         struct ldb_control **controls;
 607 };
 608
 609 struct ldb_extended {
 610         const char *oid;
 611         const char *value;
 612         int value_len;
 613 };
 614
 615 struct ldb_reply {
 616         enum ldb_reply_type type;
 617         struct ldb_message *message;
 618         struct ldb_extended *response;
 619         char *referral;
 620         struct ldb_control **controls;
 621 };
 622
 623 struct ldb_handle {
 624         int status;
 625         enum ldb_state state;
 626         void *private_data;
 627         struct ldb_module *module;
 628 };
 629
 630 struct ldb_search {
 631         const struct ldb_dn *base;
 632         enum ldb_scope scope;
 633         const struct ldb_parse_tree *tree;
 634         const char * const *attrs;
 635         struct ldb_result *res;
 636 };
 637
 638 struct ldb_add {
 639         const struct ldb_message *message;
 640 };
 641
 642 struct  ldb_modify {
 643         const struct ldb_message *message;
 644 };
 645
 646 struct ldb_delete {
 647         const struct ldb_dn *dn;
 648 };
 649
 650 struct ldb_rename {
 651         const struct ldb_dn *olddn;
 652         const struct ldb_dn *newdn;
 653 };
 654
 655 struct ldb_register_control {
 656         const char *oid;
 657 };
 658
 659 struct ldb_register_partition {
 660         const struct ldb_dn *dn;
 661 };
 662
 663 struct ldb_sequence_number {
 664         uint64_t seq_num;
 665 };
 666
 667 struct ldb_request {
 668
 669         enum ldb_request_type operation;
 670
 671         union {
 672                 struct ldb_search search;
 673                 struct ldb_add    add;
 674                 struct ldb_modify mod;
 675                 struct ldb_delete del;
 676                 struct ldb_rename rename;
 677                 struct ldb_register_control reg_control;
 678                 struct ldb_register_partition reg_partition;
 679                 struct ldb_sequence_number seq_num;
 680         } op;
 681
 682         struct ldb_control **controls;
 683
 684         void *context;
 685         int (*callback)(struct ldb_context *, void *, struct ldb_reply *);
 686
 687         int timeout;
 688         time_t starttime;
 689         struct ldb_handle *handle;
 690 };
 691
 692 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
 693
 694 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type);
 695
 696 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout);
 697 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq);
 698
 699 /**
 700   Initialise ldbs' global information
 701
 702   This is required before any other LDB call
 703
 704   \return 0 if initialisation succeeded, -1 otherwise
 705 */
 706 int ldb_global_init(void);
 707
 708 /**
 709   Initialise an ldb context
 710
 711   This is required before any other LDB call.
 712
 713   \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
 714   no suitable context available.
 715
 716   \return pointer to ldb_context that should be free'd (using talloc_free())
 717   at the end of the program.
 718 */
 719 struct ldb_context *ldb_init(void *mem_ctx);
 720
 721 /**
 722    Connect to a database.
 723
 724    This is typically called soon after ldb_init(), and is required prior to
 725    any search or database modification operations.
 726
 727    The URL can be one of the following forms:
 728     - tdb://path
 729     - ldapi://path
 730     - ldap://host
 731     - sqlite://path
 732
 733    \param ldb the context associated with the database (from ldb_init())
 734    \param url the URL of the database to connect to, as noted above
 735    \param flags a combination of LDB_FLG_* to modify the connection behaviour
 736    \param options backend specific options - passed uninterpreted to the backend
 737
 738    \return result code (LDB_SUCCESS on success, or a failure code)
 739
 740    \note It is an error to connect to a database that does not exist in readonly mode
 741    (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
 742    created if it does not exist.
 743 */
 744 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
 745
 746 /**
 747   Search the database
 748
 749   This function searches the database, and returns
 750   records that match an LDAP-like search expression
 751
 752   \param ldb the context associated with the database (from ldb_init())
 753   \param base the Base Distinguished Name for the query (pass NULL for root DN)
 754   \param scope the search scope for the query
 755   \param expression the search expression to use for this query
 756   \param attrs the search attributes for the query (pass NULL if none required)
 757   \param res the return result
 758
 759   \return result code (LDB_SUCCESS on success, or a failure code)
 760
 761   \note use talloc_free() to free the ldb_result returned
 762 */
 763 int ldb_search(struct ldb_context *ldb,
 764                const struct ldb_dn *base,
 765                enum ldb_scope scope,
 766                const char *expression,
 767                const char * const *attrs, struct ldb_result **res);
 768
 769 /*
 770   like ldb_search() but takes a parse tree
 771 */
 772 int ldb_search_bytree(struct ldb_context *ldb,
 773                       const struct ldb_dn *base,
 774                       enum ldb_scope scope,
 775                       struct ldb_parse_tree *tree,
 776                       const char * const *attrs, struct ldb_result **res);
 777
 778 /**
 779   Add a record to the database.
 780
 781   This function adds a record to the database. This function will fail
 782   if a record with the specified class and key already exists in the
 783   database.
 784
 785   \param ldb the context associated with the database (from
 786   ldb_init())
 787   \param message the message containing the record to add.
 788
 789   \return result code (LDB_SUCCESS if the record was added, otherwise
 790   a failure code)
 791 */
 792 int ldb_add(struct ldb_context *ldb,
 793             const struct ldb_message *message);
 794
 795 /**
 796   Modify the specified attributes of a record
 797
 798   This function modifies a record that is in the database.
 799
 800   \param ldb the context associated with the database (from
 801   ldb_init())
 802   \param message the message containing the changes required.
 803
 804   \return result code (LDB_SUCCESS if the record was modified as
 805   requested, otherwise a failure code)
 806 */
 807 int ldb_modify(struct ldb_context *ldb,
 808                const struct ldb_message *message);
 809
 810 /**
 811   Rename a record in the database
 812
 813   This function renames a record in the database.
 814
 815   \param ldb the context associated with the database (from
 816   ldb_init())
 817   \param olddn the DN for the record to be renamed.
 818   \param newdn the new DN
 819
 820   \return result code (LDB_SUCCESS if the record was renamed as
 821   requested, otherwise a failure code)
 822 */
 823 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);
 824
 825 /**
 826   Delete a record from the database
 827
 828   This function deletes a record from the database.
 829
 830   \param ldb the context associated with the database (from
 831   ldb_init())
 832   \param dn the DN for the record to be deleted.
 833
 834   \return result code (LDB_SUCCESS if the record was deleted,
 835   otherwise a failure code)
 836 */
 837 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);
 838
 839 /**
 840   Obtain current database sequence number
 841 */
 842 int ldb_sequence_number(struct ldb_context *ldb, uint64_t *seq_num);
 843
 844 /**
 845   start a transaction
 846 */
 847 int ldb_transaction_start(struct ldb_context *ldb);
 848
 849 /**
 850   commit a transaction
 851 */
 852 int ldb_transaction_commit(struct ldb_context *ldb);
 853
 854 /**
 855   cancel a transaction
 856 */
 857 int ldb_transaction_cancel(struct ldb_context *ldb);
 858
 859
 860 /**
 861   return extended error information from the last call
 862 */
 863 const char *ldb_errstring(struct ldb_context *ldb);
 864
 865 /**
 866   return a string explaining what a ldb error constant meancs
 867 */
 868 const char *ldb_strerror(int ldb_err);
 869
 870 /**
 871   setup the default utf8 functions
 872   FIXME: these functions do not yet handle utf8
 873 */
 874 void ldb_set_utf8_default(struct ldb_context *ldb);
 875
 876 /**
 877    Casefold a string
 878
 879    \param ldb the ldb context
 880    \param mem_ctx the memory context to allocate the result string
 881    memory from.
 882    \param s the string that is to be folded
 883    \return a copy of the string, converted to upper case
 884
 885    \note The default function is not yet UTF8 aware. Provide your own
 886          set of functions through ldb_set_utf8_fns()
 887 */
 888 char *ldb_casefold(struct ldb_context *ldb, void *mem_ctx, const char *s);
 889
 890 /**
 891    Check the attribute name is valid according to rfc2251
 892    \param s tthe string to check
 893
 894    \return 1 if the name is ok
 895 */
 896 int ldb_valid_attr_name(const char *s);
 897
 898 /*
 899   ldif manipulation functions
 900 */
 901 /**
 902    Write an LDIF message
 903
 904    This function writes an LDIF message using a caller supplied  write
 905    function.
 906
 907    \param ldb the ldb context (from ldb_init())
 908    \param fprintf_fn a function pointer for the write function. This must take
 909    a private data pointer, followed by a format string, and then a variable argument
 910    list.
 911    \param private_data pointer that will be provided back to the write
 912    function. This is useful for maintaining state or context.
 913    \param ldif the message to write out
 914
 915    \return the total number of bytes written, or an error code as returned
 916    from the write function.
 917
 918    \sa ldb_ldif_write_file for a more convenient way to write to a
 919    file stream.
 920
 921    \sa ldb_ldif_read for the reader equivalent to this function.
 922 */
 923 int ldb_ldif_write(struct ldb_context *ldb,
 924                    int (*fprintf_fn)(void *, const char *, ...),
 925                    void *private_data,
 926                    const struct ldb_ldif *ldif);
 927
 928 /**
 929    Clean up an LDIF message
 930
 931    This function cleans up a LDIF message read using ldb_ldif_read()
 932    or related functions (such as ldb_ldif_read_string() and
 933    ldb_ldif_read_file().
 934
 935    \param ldb the ldb context (from ldb_init())
 936    \param msg the message to clean up and free
 937
 938 */
 939 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
 940
 941 /**
 942    Read an LDIF message
 943
 944    This function creates an LDIF message using a caller supplied read
 945    function.
 946
 947    \param ldb the ldb context (from ldb_init())
 948    \param fgetc_fn a function pointer for the read function. This must
 949    take a private data pointer, and must return a pointer to an
 950    integer corresponding to the next byte read (or EOF if there is no
 951    more data to be read).
 952    \param private_data pointer that will be provided back to the read
 953    function. This is udeful for maintaining state or context.
 954
 955    \return the LDIF message that has been read in
 956
 957    \note You must free the LDIF message when no longer required, using
 958    ldb_ldif_read_free().
 959
 960    \sa ldb_ldif_read_file for a more convenient way to read from a
 961    file stream.
 962
 963    \sa ldb_ldif_read_string for a more convenient way to read from a
 964    string (char array).
 965
 966    \sa ldb_ldif_write for the writer equivalent to this function.
 967 */
 968 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
 969                                int (*fgetc_fn)(void *), void *private_data);
 970
 971 /**
 972    Read an LDIF message from a file
 973
 974    This function reads the next LDIF message from the contents of a
 975    file stream. If you want to get all of the LDIF messages, you will
 976    need to repeatedly call this function, until it returns NULL.
 977
 978    \param ldb the ldb context (from ldb_init())
 979    \param f the file stream to read from (typically from fdopen())
 980
 981    \sa ldb_ldif_read_string for an equivalent function that will read
 982    from a string (char array).
 983
 984    \sa ldb_ldif_write_file for the writer equivalent to this function.
 985
 986 */
 987 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
 988
 989 /**
 990    Read an LDIF message from a string
 991
 992    This function reads the next LDIF message from the contents of a char
 993    array. If you want to get all of the LDIF messages, you will need
 994    to repeatedly call this function, until it returns NULL.
 995
 996    \param ldb the ldb context (from ldb_init())
 997    \param s pointer to the char array to read from
 998
 999    \sa ldb_ldif_read_file for an equivalent function that will read
1000    from a file stream.
1001
1002    \sa ldb_ldif_write for a more general (arbitrary read function)
1003    version of this function.
1004 */
1005 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
1006
1007 /**
1008    Write an LDIF message to a file
1009
1010    \param ldb the ldb context (from ldb_init())
1011    \param f the file stream to write to (typically from fdopen())
1012    \param msg the message to write out
1013
1014    \return the total number of bytes written, or a negative error code
1015
1016    \sa ldb_ldif_read_file for the reader equivalent to this function.
1017 */
1018 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
1019
1020 /**
1021    Base64 encode a buffer
1022
1023    \param mem_ctx the memory context that the result is allocated
1024    from.
1025    \param buf pointer to the array that is to be encoded
1026    \param len the number of elements in the array to be encoded
1027
1028    \return pointer to an array containing the encoded data
1029
1030    \note The caller is responsible for freeing the result
1031 */
1032 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
1033
1034 /**
1035    Base64 decode a buffer
1036
1037    This function decodes a base64 encoded string in place.
1038
1039    \param s the string to decode.
1040
1041    \return the length of the returned (decoded) string.
1042
1043    \note the string is null terminated, but the null terminator is not
1044    included in the length.
1045 */
1046 int ldb_base64_decode(char *s);
1047
1048 int ldb_attrib_add_handlers(struct ldb_context *ldb,
1049                             const struct ldb_attrib_handler *handlers,
1050                             unsigned num_handlers);
1051
1052 /* The following definitions come from lib/ldb/common/ldb_dn.c  */
1053
1054 int ldb_dn_is_special(const struct ldb_dn *dn);
1055 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check);
1056 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
1057 struct ldb_dn *ldb_dn_new(void *mem_ctx);
1058 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);
1059 struct ldb_dn *ldb_dn_explode_or_special(void *mem_ctx, const char *dn);
1060 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn);
1061 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
1062 int ldb_dn_compare_base(struct ldb_context *ldb, const struct ldb_dn *base, const struct ldb_dn *dn);
1063 int ldb_dn_compare(struct ldb_context *ldb, const struct ldb_dn *edn0, const struct ldb_dn *edn1);
1064 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
1065 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, const char *dn);
1066 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el);
1067 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn);
1068 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn);
1069 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
1070                                                                const char *val);
1071 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
1072                                                  const char * value,
1073                                                  const struct ldb_dn *base);
1074 struct ldb_dn *ldb_dn_make_child(void *mem_ctx,
1075                                  const struct ldb_dn_component *component,
1076                                  const struct ldb_dn *base);
1077 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2);
1078 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...) PRINTF_ATTRIBUTE(3,4);
1079 struct ldb_dn_component *ldb_dn_get_rdn(void *mem_ctx, const struct ldb_dn *dn);
1080
1081 /* useful functions for ldb_message structure manipulation */
1082 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
1083
1084 /**
1085    Compare two attributes
1086
1087    This function compares to attribute names. Note that this is a
1088    case-insensitive comparison.
1089
1090    \param attr1 the first attribute name to compare
1091    \param attr2 the second attribute name to compare
1092
1093    \return 0 if the attribute names are the same, or only differ in
1094    case; non-zero if there are any differences
1095 */
1096 int ldb_attr_cmp(const char *attr1, const char *attr2);
1097 char *ldb_attr_casefold(void *mem_ctx, const char *s);
1098 int ldb_attr_dn(const char *attr);
1099
1100 /**
1101    Create an empty message
1102
1103    \param mem_ctx the memory context to create in. You can pass NULL
1104    to get the top level context, however the ldb context (from
1105    ldb_init()) may be a better choice
1106 */
1107 struct ldb_message *ldb_msg_new(void *mem_ctx);
1108
1109 /**
1110    Find an element within an message
1111 */
1112 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
1113                                                  const char *attr_name);
1114
1115 /**
1116    Compare two ldb_val values
1117
1118    \param v1 first ldb_val structure to be tested
1119    \param v2 second ldb_val structure to be tested
1120
1121    \return 1 for a match, 0 if there is any difference
1122 */
1123 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
1124
1125 /**
1126    find a value within an ldb_message_element
1127
1128    \param el the element to search
1129    \param val the value to search for
1130
1131    \note This search is case sensitive
1132 */
1133 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
1134                                  struct ldb_val *val);
1135
1136 /**
1137    add a new empty element to a ldb_message
1138 */
1139 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags);
1140
1141 /**
1142    add a element to a ldb_message
1143 */
1144 int ldb_msg_add(struct ldb_message *msg,
1145                 const struct ldb_message_element *el,
1146                 int flags);
1147 int ldb_msg_add_value(struct ldb_message *msg,
1148                       const char *attr_name,
1149                       const struct ldb_val *val);
1150 int ldb_msg_add_steal_value(struct ldb_message *msg,
1151                       const char *attr_name,
1152                       struct ldb_val *val);
1153 int ldb_msg_add_steal_string(struct ldb_message *msg,
1154                              const char *attr_name, char *str);
1155 int ldb_msg_add_string(struct ldb_message *msg,
1156                        const char *attr_name, const char *str);
1157 int ldb_msg_add_fmt(struct ldb_message *msg,
1158                     const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1159
1160 /**
1161    compare two message elements - return 0 on match
1162 */
1163 int ldb_msg_element_compare(struct ldb_message_element *el1,
1164                             struct ldb_message_element *el2);
1165
1166 /**
1167    Find elements in a message.
1168
1169    This function finds elements and converts to a specific type, with
1170    a give default value if not found. Assumes that elements are
1171    single valued.
1172 */
1173 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
1174 int ldb_msg_find_int(const struct ldb_message *msg,
1175                      const char *attr_name,
1176                      int default_value);
1177 unsigned int ldb_msg_find_uint(const struct ldb_message *msg,
1178                                const char *attr_name,
1179                                unsigned int default_value);
1180 int64_t ldb_msg_find_int64(const struct ldb_message *msg,
1181                            const char *attr_name,
1182                            int64_t default_value);
1183 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg,
1184                              const char *attr_name,
1185                              uint64_t default_value);
1186 double ldb_msg_find_double(const struct ldb_message *msg,
1187                            const char *attr_name,
1188                            double default_value);
1189 const char *ldb_msg_find_string(const struct ldb_message *msg,
1190                                 const char *attr_name,
1191                                 const char *default_value);
1192
1193 void ldb_msg_sort_elements(struct ldb_message *msg);
1194
1195 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
1196                                          const struct ldb_message *msg);
1197 struct ldb_message *ldb_msg_copy(void *mem_ctx,
1198                                  const struct ldb_message *msg);
1199
1200 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
1201                                          const struct ldb_message *msg);
1202
1203
1204 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
1205                                  struct ldb_message *msg1,
1206                                  struct ldb_message *msg2);
1207
1208 int ldb_msg_check_string_attribute(const struct ldb_message *msg,
1209                                    const char *name,
1210                                    const char *value);
1211
1212 /**
1213    Integrity check an ldb_message
1214
1215    This function performs basic sanity / integrity checks on an
1216    ldb_message.
1217
1218    \param msg the message to check
1219
1220    \return LDB_SUCCESS if the message is OK, or a non-zero error code
1221    (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1222    LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1223    message.
1224 */
1225 int ldb_msg_sanity_check(struct ldb_context *ldb,
1226                          const struct ldb_message *msg);
1227
1228 /**
1229    Duplicate an ldb_val structure
1230
1231    This function copies an ldb value structure.
1232
1233    \param mem_ctx the memory context that the duplicated value will be
1234    allocated from
1235    \param v the ldb_val to be duplicated.
1236
1237    \return the duplicated ldb_val structure.
1238 */
1239 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
1240
1241 /**
1242   this allows the user to set a debug function for error reporting
1243 */
1244 int ldb_set_debug(struct ldb_context *ldb,
1245                   void (*debug)(void *context, enum ldb_debug_level level,
1246                                 const char *fmt, va_list ap),
1247                   void *context);
1248
1249 /**
1250   this allows the user to set custom utf8 function for error reporting
1251 */
1252 void ldb_set_utf8_fns(struct ldb_context *ldb,
1253                         void *context,
1254                         char *(*casefold)(void *, void *, const char *));
1255
1256 /**
1257    this sets up debug to print messages on stderr
1258 */
1259 int ldb_set_debug_stderr(struct ldb_context *ldb);
1260
1261 /* control backend specific opaque values */
1262 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1263 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1264
1265 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
1266                                                     const char *attrib);
1267
1268
1269 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
1270 const char **ldb_attr_list_copy_add(void *mem_ctx, const char * const *attrs, const char *new_attr);
1271 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1272
1273
1274 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1275                                  const char *attr,
1276                                  const char *replace);
1277
1278 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1279 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1280 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1281
1282 /**
1283    Convert a time structure to a string
1284
1285    This function converts a time_t structure to an LDAP formatted time
1286    string.
1287
1288    \param mem_ctx the memory context to allocate the return string in
1289    \param t the time structure to convert
1290
1291    \return the formatted string, or NULL if the time structure could
1292    not be converted
1293 */
1294 char *ldb_timestring(void *mem_ctx, time_t t);
1295
1296 /**
1297    Convert a string to a time structure
1298
1299    This function converts an LDAP formatted time string to a time_t
1300    structure.
1301
1302    \param s the string to convert
1303
1304    \return the time structure, or 0 if the string cannot be converted
1305 */
1306 time_t ldb_string_to_time(const char *s);
1307
1308 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn);
1309 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn);
1310
1311
1312 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1313 #endif