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