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