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    Flag value for database connection mode.
 213
 214    If LDB_FLG_RDONLY is used in ldb_connect, then the database will be
 215    opened read-only, if possible.
 216 */
 217 #define LDB_FLG_RDONLY 1
 218
 219 /**
 220    Flag value for database connection mode.
 221
 222    If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be
 223    opened without synchronous operations, if possible.
 224 */
 225 #define LDB_FLG_NOSYNC 2
 226
 227 /*! \cond DOXYGEN_IGNORE */
 228 #ifndef PRINTF_ATTRIBUTE
 229 #define PRINTF_ATTRIBUTE(a,b)
 230 #endif
 231 /*! \endcond */
 232
 233 /*
 234    structures for ldb_parse_tree handling code
 235 */
 236 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
 237                     LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
 238                     LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
 239                     LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
 240
 241 struct ldb_parse_tree {
 242         enum ldb_parse_op operation;
 243         union {
 244                 struct {
 245                         struct ldb_parse_tree *child;
 246                 } isnot;
 247                 struct {
 248                         const char *attr;
 249                         struct ldb_val value;
 250                 } equality;
 251                 struct {
 252                         const char *attr;
 253                         int start_with_wildcard;
 254                         int end_with_wildcard;
 255                         struct ldb_val **chunks;
 256                 } substring;
 257                 struct {
 258                         const char *attr;
 259                 } present;
 260                 struct {
 261                         const char *attr;
 262                         struct ldb_val value;
 263                 } comparison;
 264                 struct {
 265                         const char *attr;
 266                         int dnAttributes;
 267                         char *rule_id;
 268                         struct ldb_val value;
 269                 } extended;
 270                 struct {
 271                         unsigned int num_elements;
 272                         struct ldb_parse_tree **elements;
 273                 } list;
 274         } u;
 275 };
 276
 277 struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
 278 char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
 279 char *ldb_binary_encode(void *ctx, struct ldb_val val);
 280 char *ldb_binary_encode_string(void *mem_ctx, const char *string);
 281
 282 /*
 283   functions for controlling attribute handling
 284 */
 285 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
 286 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
 287
 288 struct ldb_attrib_handler {
 289         const char *attr;
 290
 291         /* LDB_ATTR_FLAG_* */
 292         unsigned flags;
 293
 294         /* convert from ldif to binary format */
 295         ldb_attr_handler_t ldif_read_fn;
 296
 297         /* convert from binary to ldif format */
 298         ldb_attr_handler_t ldif_write_fn;
 299
 300         /* canonicalise a value, for use by indexing and dn construction */
 301         ldb_attr_handler_t canonicalise_fn;
 302
 303         /* compare two values */
 304         ldb_attr_comparison_t comparison_fn;
 305 };
 306
 307 /**
 308    The attribute is not returned by default
 309 */
 310 #define LDB_ATTR_FLAG_HIDDEN       (1<<0)
 311
 312 /**
 313    The attribute is constructed from other attributes
 314 */
 315 #define LDB_ATTR_FLAG_CONSTRUCTED  (1<<1)
 316
 317 /**
 318   LDAP attribute syntax for a DN
 319
 320   This is the well-known LDAP attribute syntax for a DN.
 321
 322   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 323 */
 324 #define LDB_SYNTAX_DN                   "1.3.6.1.4.1.1466.115.121.1.12"
 325
 326 /**
 327   LDAP attribute syntax for a Directory String
 328
 329   This is the well-known LDAP attribute syntax for a Directory String.
 330
 331   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 332 */
 333 #define LDB_SYNTAX_DIRECTORY_STRING     "1.3.6.1.4.1.1466.115.121.1.15"
 334
 335 /**
 336   LDAP attribute syntax for an integer
 337
 338   This is the well-known LDAP attribute syntax for an integer.
 339
 340   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 341 */
 342 #define LDB_SYNTAX_INTEGER              "1.3.6.1.4.1.1466.115.121.1.27"
 343
 344 /**
 345   LDAP attribute syntax for an octet string
 346
 347   This is the well-known LDAP attribute syntax for an octet string.
 348
 349   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 350 */
 351 #define LDB_SYNTAX_OCTET_STRING         "1.3.6.1.4.1.1466.115.121.1.40"
 352
 353 /**
 354   LDAP attribute syntax for UTC time.
 355
 356   This is the well-known LDAP attribute syntax for a UTC time.
 357
 358   See <a href="http://www.ietf.org/rfc/rfc2252.txt">RFC 2252</a>, Section 4.3.2
 359 */
 360 #define LDB_SYNTAX_UTC_TIME             "1.3.6.1.4.1.1466.115.121.1.53"
 361
 362 #define LDB_SYNTAX_OBJECTCLASS          "LDB_SYNTAX_OBJECTCLASS"
 363
 364 /* sorting helpers */
 365 typedef int (*ldb_qsort_cmp_fn_t) (const void *, const void *, const void *);
 366
 367 /**
 368    OID for the paged results control. This control is included in the
 369    searchRequest and searchResultDone messages as part of the controls
 370    field of the LDAPMessage, as defined in Section 4.1.12 of
 371    LDAP v3.
 372
 373    \sa <a href="http://www.ietf.org/rfc/rfc2696.txt">RFC 2696</a>.
 374 */
 375 #define LDB_CONTROL_PAGED_RESULTS_OID   "1.2.840.113556.1.4.319"
 376
 377 /**
 378    OID for extended DN
 379
 380    \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>
 381 */
 382 #define LDB_CONTROL_EXTENDED_DN_OID     "1.2.840.113556.1.4.529"
 383
 384 /**
 385    OID for LDAP server sort result extension.
 386
 387    This control is included in the searchRequest message as part of
 388    the controls field of the LDAPMessage, as defined in Section 4.1.12
 389    of LDAP v3. The controlType is set to
 390    "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or
 391    FALSE (where absent is also equivalent to FALSE) at the client's
 392    option.
 393
 394    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
 395 */
 396 #define LDB_CONTROL_SERVER_SORT_OID     "1.2.840.113556.1.4.473"
 397
 398 /**
 399    OID for LDAP server sort result response extension.
 400
 401    This control is included in the searchResultDone message as part of
 402    the controls field of the LDAPMessage, as defined in Section 4.1.12 of
 403    LDAP v3.
 404
 405    \sa <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
 406 */
 407 #define LDB_CONTROL_SORT_RESP_OID       "1.2.840.113556.1.4.474"
 408
 409 /**
 410    OID for LDAP Attribute Scoped Query extension.
 411
 412    This control is include in SearchRequest or SearchResponse
 413    messages as part of the controls field of the LDAPMessage.
 414 */
 415 #define LDB_CONTROL_ASQ_OID             "1.2.840.113556.1.4.1504"
 416
 417
 418 struct ldb_paged_control {
 419         int size;
 420         int cookie_len;
 421         char *cookie;
 422 };
 423
 424 struct ldb_extended_dn_control {
 425         int type;
 426 };
 427
 428 struct ldb_server_sort_control {
 429         char *attributeName;
 430         char *orderingRule;
 431         int reverse;
 432 };
 433
 434 struct ldb_sort_resp_control {
 435         int result;
 436         char *attr_desc;
 437 };
 438
 439 struct ldb_asq_control {
 440         int request;
 441         char *source_attribute;
 442         int src_attr_len;
 443         int result;
 444 };
 445
 446 struct ldb_control {
 447         const char *oid;
 448         int critical;
 449         void *data;
 450 };
 451
 452 struct ldb_credentials;
 453
 454 enum ldb_request_type {
 455         LDB_REQ_SEARCH,
 456         LDB_REQ_ADD,
 457         LDB_REQ_MODIFY,
 458         LDB_REQ_DELETE,
 459         LDB_REQ_RENAME,
 460         LDB_REQ_REGISTER
 461 };
 462
 463 struct ldb_result {
 464         unsigned int count;
 465         struct ldb_message **msgs;
 466         struct ldb_control **controls;
 467 };
 468
 469 struct ldb_search {
 470         const struct ldb_dn *base;
 471         enum ldb_scope scope;
 472         struct ldb_parse_tree *tree;
 473         const char * const *attrs;
 474         struct ldb_result *res;
 475 };
 476
 477 struct ldb_add {
 478         const struct ldb_message *message;
 479 };
 480
 481 struct  ldb_modify {
 482         const struct ldb_message *message;
 483 };
 484
 485 struct ldb_delete {
 486         const struct ldb_dn *dn;
 487 };
 488
 489 struct ldb_rename {
 490         const struct ldb_dn *olddn;
 491         const struct ldb_dn *newdn;
 492 };
 493
 494 struct ldb_register_control {
 495         const char *oid;
 496 };
 497
 498 struct ldb_request {
 499
 500         int operation;
 501
 502         union {
 503                 struct ldb_search search;
 504                 struct ldb_add    add;
 505                 struct ldb_modify mod;
 506                 struct ldb_delete del;
 507                 struct ldb_rename rename;
 508                 struct ldb_register_control reg;
 509         } op;
 510
 511         struct ldb_control **controls;
 512         struct ldb_credentials *creds;
 513 };
 514
 515 int ldb_request(struct ldb_context *ldb, struct ldb_request *request);
 516
 517 /**
 518   Initialise an ldb context
 519
 520   This is required before any other LDB call.
 521
 522   \param mem_ctx pointer to a talloc memory context. Pass NULL if there is
 523   no suitable context available.
 524
 525   \return pointer to ldb_context that should be free'd (using talloc_free())
 526   at the end of the program.
 527 */
 528 struct ldb_context *ldb_init(void *mem_ctx);
 529
 530 /**
 531    Connect to a database.
 532
 533    This is typically called soon after ldb_init(), and is required prior to
 534    any search or database modification operations.
 535
 536    The URL can be one of the following forms:
 537     - tdb://path
 538     - ldapi://path
 539     - ldap://host
 540     - sqlite3://path
 541
 542    \param ldb the context associated with the database (from ldb_init())
 543    \param url the URL of the database to connect to, as noted above
 544    \param flags a combination of LDB_FLG_* to modify the connection behaviour
 545    \param options backend specific options - passed uninterpreted to the backend
 546
 547    \return result code (LDB_SUCCESS on success, or a failure code)
 548
 549    \note It is an error to connect to a database that does not exist in readonly mode
 550    (that is, with LDB_FLG_RDONLY). However in read-write mode, the database will be
 551    created if it does not exist.
 552 */
 553 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
 554
 555 /**
 556   Search the database
 557
 558   This function searches the database, and returns
 559   records that match an LDAP-like search expression
 560
 561   \param ldb the context associated with the database (from ldb_init())
 562   \param base the Base Distinguished Name for the query (pass NULL for root DN)
 563   \param scope the search scope for the query
 564   \param expression the search expression to use for this query
 565   \param attrs the search attributes for the query (pass NULL if none required)
 566   \param res the return result
 567
 568   \return result code (LDB_SUCCESS on success, or a failure code)
 569
 570   \note use talloc_free() to free the ldb_result returned
 571 */
 572 int ldb_search(struct ldb_context *ldb,
 573                const struct ldb_dn *base,
 574                enum ldb_scope scope,
 575                const char *expression,
 576                const char * const *attrs, struct ldb_result **res);
 577
 578 /*
 579   like ldb_search() but takes a parse tree
 580 */
 581 int ldb_search_bytree(struct ldb_context *ldb,
 582                       const struct ldb_dn *base,
 583                       enum ldb_scope scope,
 584                       struct ldb_parse_tree *tree,
 585                       const char * const *attrs, struct ldb_result **res);
 586
 587 /**
 588   Add a record to the database.
 589
 590   This function adds a record to the database. This function will fail
 591   if a record with the specified class and key already exists in the
 592   database.
 593
 594   \param ldb the context associated with the database (from
 595   ldb_init())
 596   \param message the message containing the record to add.
 597
 598   \return result code (LDB_SUCCESS if the record was added, otherwise
 599   a failure code)
 600 */
 601 int ldb_add(struct ldb_context *ldb,
 602             const struct ldb_message *message);
 603
 604 /**
 605   Modify the specified attributes of a record
 606
 607   This function modifies a record that is in the database.
 608
 609   \param ldb the context associated with the database (from
 610   ldb_init())
 611   \param message the message containing the changes required.
 612
 613   \return result code (LDB_SUCCESS if the record was modified as
 614   requested, otherwise a failure code)
 615 */
 616 int ldb_modify(struct ldb_context *ldb,
 617                const struct ldb_message *message);
 618
 619 /**
 620   Rename a record in the database
 621
 622   This function renames a record in the database.
 623
 624   \param ldb the context associated with the database (from
 625   ldb_init())
 626   \param olddn the DN for the record to be renamed.
 627   \param newdn the new DN
 628
 629   \return result code (LDB_SUCCESS if the record was renamed as
 630   requested, otherwise a failure code)
 631 */
 632 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);
 633
 634 /**
 635   Delete a record from the database
 636
 637   This function deletes a record from the database.
 638
 639   \param ldb the context associated with the database (from
 640   ldb_init())
 641   \param dn the DN for the record to be deleted.
 642
 643   \return result code (LDB_SUCCESS if the record was deleted,
 644   otherwise a failure code)
 645 */
 646 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);
 647
 648 /**
 649   start a transaction
 650 */
 651 int ldb_transaction_start(struct ldb_context *ldb);
 652
 653 /**
 654   commit a transaction
 655 */
 656 int ldb_transaction_commit(struct ldb_context *ldb);
 657
 658 /**
 659   cancel a transaction
 660 */
 661 int ldb_transaction_cancel(struct ldb_context *ldb);
 662
 663
 664 /**
 665   return extended error information from the last call
 666 */
 667 const char *ldb_errstring(struct ldb_context *ldb);
 668
 669 /**
 670    Casefold a string
 671
 672    \param mem_ctx the memory context to allocate the result string
 673    memory from.
 674    \param s the string that is to be folded
 675    \return a copy of the string, converted to upper case
 676
 677    \todo This function should be UTF8 aware, but currently is not.
 678 */
 679 char *ldb_casefold(void *mem_ctx, const char *s);
 680
 681 /**
 682    Compare two strings, without regard to case.
 683
 684    \param s1 the first string to compare
 685    \param s2 the second string to compare
 686
 687    \return 0 if the strings are the same, non-zero if there are any
 688    differences except for case.
 689
 690    \note This function is not UTF8 aware.
 691 */
 692 int ldb_caseless_cmp(const char *s1, const char *s2);
 693
 694 /*
 695   ldif manipulation functions
 696 */
 697 /**
 698    Write an LDIF message
 699
 700    This function writes an LDIF message using a caller supplied  write
 701    function.
 702
 703    \param ldb the ldb context (from ldb_init())
 704    \param fprintf_fn a function pointer for the write function. This must take
 705    a private data pointer, followed by a format string, and then a variable argument
 706    list.
 707    \param private_data pointer that will be provided back to the write
 708    function. This is useful for maintaining state or context.
 709    \param ldif the message to write out
 710
 711    \return the total number of bytes written, or an error code as returned
 712    from the write function.
 713
 714    \sa ldb_ldif_write_file for a more convenient way to write to a
 715    file stream.
 716
 717    \sa ldb_ldif_read for the reader equivalent to this function.
 718 */
 719 int ldb_ldif_write(struct ldb_context *ldb,
 720                    int (*fprintf_fn)(void *, const char *, ...),
 721                    void *private_data,
 722                    const struct ldb_ldif *ldif);
 723
 724 /**
 725    Clean up an LDIF message
 726
 727    This function cleans up a LDIF message read using ldb_ldif_read()
 728    or related functions (such as ldb_ldif_read_string() and
 729    ldb_ldif_read_file().
 730
 731    \param ldb the ldb context (from ldb_init())
 732    \param msg the message to clean up and free
 733
 734 */
 735 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *msg);
 736
 737 /**
 738    Read an LDIF message
 739
 740    This function creates an LDIF message using a caller supplied read
 741    function.
 742
 743    \param ldb the ldb context (from ldb_init())
 744    \param fgetc_fn a function pointer for the read function. This must
 745    take a private data pointer, and must return a pointer to an
 746    integer corresponding to the next byte read (or EOF if there is no
 747    more data to be read).
 748    \param private_data pointer that will be provided back to the read
 749    function. This is udeful for maintaining state or context.
 750
 751    \return the LDIF message that has been read in
 752
 753    \note You must free the LDIF message when no longer required, using
 754    ldb_ldif_read_free().
 755
 756    \sa ldb_ldif_read_file for a more convenient way to read from a
 757    file stream.
 758
 759    \sa ldb_ldif_read_string for a more convenient way to read from a
 760    string (char array).
 761
 762    \sa ldb_ldif_write for the writer equivalent to this function.
 763 */
 764 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
 765                                int (*fgetc_fn)(void *), void *private_data);
 766
 767 /**
 768    Read an LDIF message from a file
 769
 770    This function reads the next LDIF message from the contents of a
 771    file stream. If you want to get all of the LDIF messages, you will
 772    need to repeatedly call this function, until it returns NULL.
 773
 774    \param ldb the ldb context (from ldb_init())
 775    \param f the file stream to read from (typically from fdopen())
 776
 777    \sa ldb_ldif_read_string for an equivalent function that will read
 778    from a string (char array).
 779
 780    \sa ldb_ldif_write_file for the writer equivalent to this function.
 781
 782 */
 783 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
 784
 785 /**
 786    Read an LDIF message from a string
 787
 788    This function reads the next LDIF message from the contents of a char
 789    array. If you want to get all of the LDIF messages, you will need
 790    to repeatedly call this function, until it returns NULL.
 791
 792    \param ldb the ldb context (from ldb_init())
 793    \param s pointer to the char array to read from
 794
 795    \sa ldb_ldif_read_file for an equivalent function that will read
 796    from a file stream.
 797
 798    \sa ldb_ldif_write for a more general (arbitrary read function)
 799    version of this function.
 800 */
 801 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
 802
 803 /**
 804    Write an LDIF message to a file
 805
 806    \param ldb the ldb context (from ldb_init())
 807    \param f the file stream to write to (typically from fdopen())
 808    \param msg the message to write out
 809
 810    \return the total number of bytes written, or a negative error code
 811
 812    \sa ldb_ldif_read_file for the reader equivalent to this function.
 813 */
 814 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
 815
 816 /**
 817    Base64 encode a buffer
 818
 819    \param mem_ctx the memory context that the result is allocated
 820    from.
 821    \param buf pointer to the array that is to be encoded
 822    \param len the number of elements in the array to be encoded
 823
 824    \return pointer to an array containing the encoded data
 825
 826    \note The caller is responsible for freeing the result
 827 */
 828 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
 829
 830 /**
 831    Base64 decode a buffer
 832
 833    This function decodes a base64 encoded string in place.
 834
 835    \param s the string to decode.
 836
 837    \return the length of the returned (decoded) string.
 838
 839    \note the string is null terminated, but the null terminator is not
 840    included in the length.
 841 */
 842 int ldb_base64_decode(char *s);
 843
 844 int ldb_attrib_add_handlers(struct ldb_context *ldb,
 845                             const struct ldb_attrib_handler *handlers,
 846                             unsigned num_handlers);
 847
 848 /* The following definitions come from lib/ldb/common/ldb_dn.c  */
 849
 850 int ldb_dn_is_special(const struct ldb_dn *dn);
 851 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check);
 852 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
 853 struct ldb_dn *ldb_dn_new(void *mem_ctx);
 854 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);
 855 struct ldb_dn *ldb_dn_explode_or_special(void *mem_ctx, const char *dn);
 856 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn);
 857 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
 858 int ldb_dn_compare_base(struct ldb_context *ldb, const struct ldb_dn *base, const struct ldb_dn *dn);
 859 int ldb_dn_compare(struct ldb_context *ldb, const struct ldb_dn *edn0, const struct ldb_dn *edn1);
 860 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
 861 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, const char *dn);
 862 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el);
 863 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn);
 864 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn);
 865 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
 866                                                                const char *val);
 867 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
 868                                                  const char * value,
 869                                                  const struct ldb_dn *base);
 870 struct ldb_dn *ldb_dn_make_child(void *mem_ctx,
 871                                  const struct ldb_dn_component *component,
 872                                  const struct ldb_dn *base);
 873 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2);
 874 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...) PRINTF_ATTRIBUTE(3,4);
 875 struct ldb_dn_component *ldb_dn_get_rdn(void *mem_ctx, const struct ldb_dn *dn);
 876
 877 /* useful functions for ldb_message structure manipulation */
 878 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
 879
 880 /**
 881    Compare two attributes
 882
 883    This function compares to attribute names. Note that this is a
 884    case-insensitive comparison.
 885
 886    \param attr1 the first attribute name to compare
 887    \param attr2 the second attribute name to compare
 888
 889    \return 0 if the attribute names are the same, or only differ in
 890    case; non-zero if there are any differences
 891 */
 892 int ldb_attr_cmp(const char *attr1, const char *attr2);
 893 int ldb_attr_dn(const char *attr);
 894 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
 895
 896 /**
 897    Create an empty message
 898
 899    \param mem_ctx the memory context to create in. You can pass NULL
 900    to get the top level context, however the ldb context (from
 901    ldb_init()) may be a better choice
 902 */
 903 struct ldb_message *ldb_msg_new(void *mem_ctx);
 904
 905 /**
 906    Find an element within an message
 907 */
 908 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
 909                                                  const char *attr_name);
 910
 911 /**
 912    Compare two ldb_val values
 913
 914    \param v1 first ldb_val structure to be tested
 915    \param v2 second ldb_val structure to be tested
 916
 917    \return 1 for a match, 0 if there is any difference
 918 */
 919 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
 920
 921 /**
 922    find a value within an ldb_message_element
 923
 924    \param el the element to search
 925    \param val the value to search for
 926
 927    \note This search is case sensitive
 928 */
 929 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
 930                                  struct ldb_val *val);
 931
 932 /**
 933    add a new empty element to a ldb_message
 934 */
 935 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags);
 936
 937 /**
 938    add a element to a ldb_message
 939 */
 940 int ldb_msg_add(struct ldb_message *msg,
 941                 const struct ldb_message_element *el,
 942                 int flags);
 943 int ldb_msg_add_value(struct ldb_message *msg,
 944                       const char *attr_name,
 945                       const struct ldb_val *val);
 946 int ldb_msg_add_string(struct ldb_message *msg,
 947                        const char *attr_name, const char *str);
 948 int ldb_msg_add_fmt(struct ldb_message *msg,
 949                     const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
 950
 951 /**
 952    compare two message elements - return 0 on match
 953 */
 954 int ldb_msg_element_compare(struct ldb_message_element *el1,
 955                             struct ldb_message_element *el2);
 956
 957 /**
 958    Find elements in a message.
 959
 960    This function finds elements and converts to a specific type, with
 961    a give default value if not found. Assumes that elements are
 962    single valued.
 963 */
 964 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
 965 int ldb_msg_find_int(const struct ldb_message *msg,
 966                      const char *attr_name,
 967                      int default_value);
 968 unsigned int ldb_msg_find_uint(const struct ldb_message *msg,
 969                                const char *attr_name,
 970                                unsigned int default_value);
 971 int64_t ldb_msg_find_int64(const struct ldb_message *msg,
 972                            const char *attr_name,
 973                            int64_t default_value);
 974 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg,
 975                              const char *attr_name,
 976                              uint64_t default_value);
 977 double ldb_msg_find_double(const struct ldb_message *msg,
 978                            const char *attr_name,
 979                            double default_value);
 980 const char *ldb_msg_find_string(const struct ldb_message *msg,
 981                                 const char *attr_name,
 982                                 const char *default_value);
 983
 984 void ldb_msg_sort_elements(struct ldb_message *msg);
 985
 986 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
 987                                          const struct ldb_message *msg);
 988 struct ldb_message *ldb_msg_copy(void *mem_ctx,
 989                                  const struct ldb_message *msg);
 990
 991 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
 992                                          const struct ldb_message *msg);
 993
 994
 995 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
 996                                  struct ldb_message *msg1,
 997                                  struct ldb_message *msg2);
 998
 999 /**
1000    Integrity check an ldb_message
1001
1002    This function performs basic sanity / integrity checks on an
1003    ldb_message.
1004
1005    \param msg the message to check
1006
1007    \return LDB_SUCCESS if the message is OK, or a non-zero error code
1008    (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or
1009    LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a
1010    message.
1011 */
1012 int ldb_msg_sanity_check(const struct ldb_message *msg);
1013
1014 /**
1015    Duplicate an ldb_val structure
1016
1017    This function copies an ldb value structure.
1018
1019    \param mem_ctx the memory context that the duplicated value will be
1020    allocated from
1021    \param v the ldb_val to be duplicated.
1022
1023    \return the duplicated ldb_val structure.
1024 */
1025 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
1026
1027 /**
1028   this allows the user to set a debug function for error reporting
1029 */
1030 int ldb_set_debug(struct ldb_context *ldb,
1031                   void (*debug)(void *context, enum ldb_debug_level level,
1032                                 const char *fmt, va_list ap),
1033                   void *context);
1034
1035 /**
1036    this sets up debug to print messages on stderr
1037 */
1038 int ldb_set_debug_stderr(struct ldb_context *ldb);
1039
1040 /* control backend specific opaque values */
1041 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
1042 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
1043
1044 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
1045                                                     const char *attrib);
1046
1047
1048 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
1049 int ldb_attr_in_list(const char * const *attrs, const char *attr);
1050
1051
1052 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
1053                                  const char *attr,
1054                                  const char *replace);
1055
1056 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
1057 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
1058 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
1059
1060 /**
1061    Convert a time structure to a string
1062
1063    This function converts a time_t structure to an LDAP formatted time
1064    string.
1065
1066    \param mem_ctx the memory context to allocate the return string in
1067    \param t the time structure to convert
1068
1069    \return the formatted string, or NULL if the time structure could
1070    not be converted
1071 */
1072 char *ldb_timestring(void *mem_ctx, time_t t);
1073
1074 /**
1075    Convert a string to a time structure
1076
1077    This function converts an LDAP formatted time string to a time_t
1078    structure.
1079
1080    \param s the string to convert
1081
1082    \return the time structure, or 0 if the string cannot be converted
1083 */
1084 time_t ldb_string_to_time(const char *s);
1085
1086 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn);
1087 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn);
1088
1089
1090 void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp);
1091 #endif