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