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