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 #ifndef _LDB_H_
  39 #define _LDB_H_ 1
  40
  41 /*
  42   major restrictions as compared to normal LDAP:
  43
  44      - no async calls.
  45      - each record must have a unique key field
  46      - the key must be representable as a NULL terminated C string and may not
  47        contain a comma or braces
  48
  49   major restrictions as compared to tdb:
  50
  51      - no explicit locking calls
  52      UPDATE: we have transactions now, better than locking --SSS.
  53
  54 */
  55
  56 /*
  57   an individual lump of data in a result comes in this format. The
  58   pointer will usually be to a UTF-8 string if the application is
  59   sensible, but it can be to anything you like, including binary data
  60   blobs of arbitrary size.
  61 */
  62 #ifndef ldb_val
  63 struct ldb_val {
  64         uint8_t *data;
  65         size_t length;
  66 };
  67 #endif
  68
  69 /* internal ldb exploded dn structures */
  70 struct ldb_dn_component {
  71         char *name;
  72         struct ldb_val value;
  73 };
  74 struct ldb_dn {
  75         int comp_num;
  76         struct ldb_dn_component *components;
  77 };
  78
  79 /* these flags are used in ldd_message_element.flags fields. The
  80    LDA_FLAGS_MOD_* flags are used in ldap_modify() calls to specify
  81    whether attributes are being added, deleted or modified */
  82 #define LDB_FLAG_MOD_MASK  0x3
  83 #define LDB_FLAG_MOD_ADD     1
  84 #define LDB_FLAG_MOD_REPLACE 2
  85 #define LDB_FLAG_MOD_DELETE  3
  86
  87
  88 /*
  89   well known object IDs
  90 */
  91 #define LDB_OID_COMPARATOR_AND  "1.2.840.113556.1.4.803"
  92 #define LDB_OID_COMPARATOR_OR   "1.2.840.113556.1.4.804"
  93
  94 /*
  95   results are given back as arrays of ldb_message_element
  96 */
  97 struct ldb_message_element {
  98         unsigned int flags;
  99         const char *name;
 100         unsigned int num_values;
 101         struct ldb_val *values;
 102 };
 103
 104
 105 /*
 106   a ldb_message represents all or part of a record. It can contain an arbitrary
 107   number of elements.
 108 */
 109 struct ldb_message {
 110         struct ldb_dn *dn;
 111         unsigned int num_elements;
 112         struct ldb_message_element *elements;
 113         void *private_data; /* private to the backend */
 114 };
 115
 116 enum ldb_changetype {
 117         LDB_CHANGETYPE_NONE=0,
 118         LDB_CHANGETYPE_ADD,
 119         LDB_CHANGETYPE_DELETE,
 120         LDB_CHANGETYPE_MODIFY
 121 };
 122
 123 /*
 124   a ldif record - from ldif_read
 125 */
 126 struct ldb_ldif {
 127         enum ldb_changetype changetype;
 128         struct ldb_message *msg;
 129 };
 130
 131 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
 132                 LDB_SCOPE_BASE=0,
 133                 LDB_SCOPE_ONELEVEL=1,
 134                 LDB_SCOPE_SUBTREE=2};
 135
 136 struct ldb_context;
 137
 138 /*
 139   the fuction type for the callback used in traversing the database
 140 */
 141 typedef int (*ldb_traverse_fn)(struct ldb_context *, const struct ldb_message *);
 142
 143
 144 struct ldb_module;
 145
 146 /* module initialisation function */
 147 typedef struct ldb_module *(*ldb_module_init_t)(struct ldb_context *, const char **);
 148
 149
 150 /* debugging uses one of the following levels */
 151 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
 152                       LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
 153
 154 /*
 155   the user can optionally supply a debug function. The function
 156   is based on the vfprintf() style of interface, but with the addition
 157   of a severity level
 158 */
 159 struct ldb_debug_ops {
 160         void (*debug)(void *context, enum ldb_debug_level level,
 161                       const char *fmt, va_list ap);
 162         void *context;
 163 };
 164
 165 #define LDB_FLG_RDONLY 1
 166 #define LDB_FLG_NOSYNC 2
 167
 168 #ifndef PRINTF_ATTRIBUTE
 169 #define PRINTF_ATTRIBUTE(a,b)
 170 #endif
 171
 172 /* structures for ldb_parse_tree handling code */
 173 enum ldb_parse_op { LDB_OP_AND=1, LDB_OP_OR=2, LDB_OP_NOT=3,
 174                     LDB_OP_EQUALITY=4, LDB_OP_SUBSTRING=5,
 175                     LDB_OP_GREATER=6, LDB_OP_LESS=7, LDB_OP_PRESENT=8,
 176                     LDB_OP_APPROX=9, LDB_OP_EXTENDED=10 };
 177
 178 struct ldb_parse_tree {
 179         enum ldb_parse_op operation;
 180         union {
 181                 struct {
 182                         struct ldb_parse_tree *child;
 183                 } isnot;
 184                 struct {
 185                         const char *attr;
 186                         struct ldb_val value;
 187                 } equality;
 188                 struct {
 189                         const char *attr;
 190                         int start_with_wildcard;
 191                         int end_with_wildcard;
 192                         struct ldb_val **chunks;
 193                 } substring;
 194                 struct {
 195                         const char *attr;
 196                 } present;
 197                 struct {
 198                         const char *attr;
 199                         struct ldb_val value;
 200                 } comparison;
 201                 struct {
 202                         const char *attr;
 203                         int dnAttributes;
 204                         char *rule_id;
 205                         struct ldb_val value;
 206                 } extended;
 207                 struct {
 208                         unsigned int num_elements;
 209                         struct ldb_parse_tree **elements;
 210                 } list;
 211         } u;
 212 };
 213
 214 struct ldb_parse_tree *ldb_parse_tree(void *mem_ctx, const char *s);
 215 char *ldb_filter_from_tree(void *mem_ctx, struct ldb_parse_tree *tree);
 216 char *ldb_binary_encode(void *ctx, struct ldb_val val);
 217
 218
 219 /*
 220   functions for controlling attribute handling
 221 */
 222 typedef int (*ldb_attr_handler_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, struct ldb_val *);
 223 typedef int (*ldb_attr_comparison_t)(struct ldb_context *, void *mem_ctx, const struct ldb_val *, const struct ldb_val *);
 224
 225 struct ldb_attrib_handler {
 226         const char *attr;
 227
 228         /* LDB_ATTR_FLAG_* */
 229         unsigned flags;
 230
 231         /* convert from ldif to binary format */
 232         ldb_attr_handler_t ldif_read_fn;
 233
 234         /* convert from binary to ldif format */
 235         ldb_attr_handler_t ldif_write_fn;
 236
 237         /* canonicalise a value, for use by indexing and dn construction */
 238         ldb_attr_handler_t canonicalise_fn;
 239
 240         /* compare two values */
 241         ldb_attr_comparison_t comparison_fn;
 242 };
 243
 244 #define LDB_ATTR_FLAG_HIDDEN       (1<<0) /* the attribute is not returned by default */
 245 #define LDB_ATTR_FLAG_CONSTRUCTED  (1<<1) /* the attribute is constructed from other attributes */
 246
 247
 248 /* well-known ldap attribute syntaxes - see rfc2252 section 4.3.2 */
 249 #define LDB_SYNTAX_DN                   "1.3.6.1.4.1.1466.115.121.1.12"
 250 #define LDB_SYNTAX_DIRECTORY_STRING     "1.3.6.1.4.1.1466.115.121.1.15"
 251 #define LDB_SYNTAX_INTEGER              "1.3.6.1.4.1.1466.115.121.1.27"
 252 #define LDB_SYNTAX_OCTET_STRING         "1.3.6.1.4.1.1466.115.121.1.40"
 253 #define LDB_SYNTAX_UTC_TIME             "1.3.6.1.4.1.1466.115.121.1.53"
 254 #define LDB_SYNTAX_OBJECTCLASS          "LDB_SYNTAX_OBJECTCLASS"
 255
 256 /*
 257   initialise a ldb context
 258 */
 259 struct ldb_context *ldb_init(void *mem_ctx);
 260
 261 /*
 262  connect to a database. The URL can either be one of the following forms
 263    ldb://path
 264    ldapi://path
 265
 266    flags is made up of LDB_FLG_*
 267
 268    the options are passed uninterpreted to the backend, and are
 269    backend specific
 270 */
 271 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);
 272
 273 /*
 274   search the database given a LDAP-like search expression
 275
 276   return the number of records found, or -1 on error
 277
 278   use talloc_free to free the ldb_message returned
 279 */
 280 int ldb_search(struct ldb_context *ldb,
 281                const struct ldb_dn *base,
 282                enum ldb_scope scope,
 283                const char *expression,
 284                const char * const *attrs, struct ldb_message ***res);
 285
 286 /*
 287   like ldb_search() but takes a parse tree
 288 */
 289 int ldb_search_bytree(struct ldb_context *ldb,
 290                       const struct ldb_dn *base,
 291                       enum ldb_scope scope,
 292                       struct ldb_parse_tree *tree,
 293                       const char * const *attrs, struct ldb_message ***res);
 294
 295 /*
 296   add a record to the database. Will fail if a record with the given class and key
 297   already exists
 298 */
 299 int ldb_add(struct ldb_context *ldb,
 300             const struct ldb_message *message);
 301
 302 /*
 303   modify the specified attributes of a record
 304 */
 305 int ldb_modify(struct ldb_context *ldb,
 306                const struct ldb_message *message);
 307
 308 /*
 309   rename a record in the database
 310 */
 311 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);
 312
 313 /*
 314   delete a record from the database
 315 */
 316 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);
 317
 318 /*
 319   start a transaction
 320 */
 321 int ldb_transaction_start(struct ldb_context *ldb);
 322
 323 /*
 324   commit a transaction
 325 */
 326 int ldb_transaction_commit(struct ldb_context *ldb);
 327
 328 /*
 329   cancel a transaction
 330 */
 331 int ldb_transaction_cancel(struct ldb_context *ldb);
 332
 333
 334 /*
 335   return extended error information from the last call
 336 */
 337 const char *ldb_errstring(struct ldb_context *ldb);
 338
 339 /*
 340   casefold a string (should be UTF8, but at the moment it isn't)
 341 */
 342 char *ldb_casefold(void *mem_ctx, const char *s);
 343 int ldb_caseless_cmp(const char *s1, const char *s2);
 344
 345 /*
 346   ldif manipulation functions
 347 */
 348 int ldb_ldif_write(struct ldb_context *ldb,
 349                    int (*fprintf_fn)(void *, const char *, ...),
 350                    void *private_data,
 351                    const struct ldb_ldif *ldif);
 352 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *);
 353 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
 354                                int (*fgetc_fn)(void *), void *private_data);
 355 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
 356 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s);
 357 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
 358 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len);
 359 int ldb_base64_decode(char *s);
 360 int ldb_attrib_add_handlers(struct ldb_context *ldb,
 361                             const struct ldb_attrib_handler *handlers,
 362                             unsigned num_handlers);
 363
 364 /* The following definitions come from lib/ldb/common/ldb_dn.c  */
 365
 366 int ldb_dn_is_special(const struct ldb_dn *dn);
 367 int ldb_dn_check_special(const struct ldb_dn *dn, const char *check);
 368 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
 369 struct ldb_dn *ldb_dn_new(void *mem_ctx);
 370 struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);
 371 char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *edn);
 372 char *ldb_dn_linearize_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
 373 int ldb_dn_compare_base(struct ldb_context *ldb, const struct ldb_dn *base, const struct ldb_dn *dn);
 374 int ldb_dn_compare(struct ldb_context *ldb, const struct ldb_dn *edn0, const struct ldb_dn *edn1);
 375 struct ldb_dn *ldb_dn_casefold(struct ldb_context *ldb, const struct ldb_dn *edn);
 376 struct ldb_dn *ldb_dn_explode_casefold(struct ldb_context *ldb, const char *dn);
 377 struct ldb_dn *ldb_dn_copy_partial(void *mem_ctx, const struct ldb_dn *dn, int num_el);
 378 struct ldb_dn *ldb_dn_copy(void *mem_ctx, const struct ldb_dn *dn);
 379 struct ldb_dn *ldb_dn_get_parent(void *mem_ctx, const struct ldb_dn *dn);
 380 struct ldb_dn_component *ldb_dn_build_component(void *mem_ctx, const char *attr,
 381                                                                const char *val);
 382 struct ldb_dn *ldb_dn_build_child(void *mem_ctx, const char *attr,
 383                                                  const char * value,
 384                                                  const struct ldb_dn *base);
 385 struct ldb_dn *ldb_dn_make_child(void *mem_ctx,
 386                                  const struct ldb_dn_component *component,
 387                                  const struct ldb_dn *base);
 388 struct ldb_dn *ldb_dn_compose(void *mem_ctx, const struct ldb_dn *dn1, const struct ldb_dn *dn2);
 389 struct ldb_dn *ldb_dn_string_compose(void *mem_ctx, const struct ldb_dn *base, const char *child_fmt, ...) PRINTF_ATTRIBUTE(3,4);
 390 struct ldb_dn_component *ldb_dn_get_rdn(void *mem_ctx, const struct ldb_dn *dn);
 391
 392 /* useful functions for ldb_message structure manipulation */
 393 int ldb_dn_cmp(struct ldb_context *ldb, const char *dn1, const char *dn2);
 394 int ldb_attr_cmp(const char *dn1, const char *dn2);
 395 char *ldb_dn_escape_value(void *mem_ctx, struct ldb_val value);
 396
 397 /* create an empty message */
 398 struct ldb_message *ldb_msg_new(void *mem_ctx);
 399
 400 /* find an element within an message */
 401 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
 402                                                  const char *attr_name);
 403
 404 /* compare two ldb_val values - return 0 on match */
 405 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
 406
 407 /* find a value within an ldb_message_element */
 408 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
 409                                  struct ldb_val *val);
 410
 411 /* add a new empty element to a ldb_message */
 412 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags);
 413
 414 /* add a element to a ldb_message */
 415 int ldb_msg_add(struct ldb_message *msg,
 416                 const struct ldb_message_element *el,
 417                 int flags);
 418 int ldb_msg_add_value(struct ldb_message *msg,
 419                       const char *attr_name,
 420                       const struct ldb_val *val);
 421 int ldb_msg_add_string(struct ldb_message *msg,
 422                        const char *attr_name, const char *str);
 423 int ldb_msg_add_fmt(struct ldb_message *msg,
 424                     const char *attr_name, const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
 425
 426 /* compare two message elements - return 0 on match */
 427 int ldb_msg_element_compare(struct ldb_message_element *el1,
 428                             struct ldb_message_element *el2);
 429
 430 /* find elements in a message and convert to a specific type, with
 431    a give default value if not found. Assumes that elements are
 432    single valued */
 433 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
 434 int ldb_msg_find_int(const struct ldb_message *msg,
 435                      const char *attr_name,
 436                      int default_value);
 437 unsigned int ldb_msg_find_uint(const struct ldb_message *msg,
 438                                const char *attr_name,
 439                                unsigned int default_value);
 440 int64_t ldb_msg_find_int64(const struct ldb_message *msg,
 441                            const char *attr_name,
 442                            int64_t default_value);
 443 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg,
 444                              const char *attr_name,
 445                              uint64_t default_value);
 446 double ldb_msg_find_double(const struct ldb_message *msg,
 447                            const char *attr_name,
 448                            double default_value);
 449 const char *ldb_msg_find_string(const struct ldb_message *msg,
 450                                 const char *attr_name,
 451                                 const char *default_value);
 452
 453 void ldb_msg_sort_elements(struct ldb_message *msg);
 454
 455 struct ldb_message *ldb_msg_copy_shallow(void *mem_ctx,
 456                                          const struct ldb_message *msg);
 457 struct ldb_message *ldb_msg_copy(void *mem_ctx,
 458                                  const struct ldb_message *msg);
 459
 460 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
 461                                          const struct ldb_message *msg);
 462
 463
 464 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
 465                                  struct ldb_message *msg1,
 466                                  struct ldb_message *msg2);
 467
 468 int ldb_msg_sanity_check(const struct ldb_message *msg);
 469
 470 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
 471
 472 /*
 473   this allows the user to set a debug function for error reporting
 474 */
 475 int ldb_set_debug(struct ldb_context *ldb,
 476                   void (*debug)(void *context, enum ldb_debug_level level,
 477                                 const char *fmt, va_list ap),
 478                   void *context);
 479
 480 /* this sets up debug to print messages on stderr */
 481 int ldb_set_debug_stderr(struct ldb_context *ldb);
 482
 483 /* control backend specific opaque values */
 484 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value);
 485 void *ldb_get_opaque(struct ldb_context *ldb, const char *name);
 486
 487 const struct ldb_attrib_handler *ldb_attrib_handler(struct ldb_context *ldb,
 488                                                     const char *attrib);
 489
 490
 491 const char **ldb_attr_list_copy(void *mem_ctx, const char * const *attrs);
 492 int ldb_attr_in_list(const char * const *attrs, const char *attr);
 493
 494
 495 void ldb_parse_tree_attr_replace(struct ldb_parse_tree *tree,
 496                                  const char *attr,
 497                                  const char *replace);
 498
 499 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace);
 500 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace);
 501 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);
 502
 503 char *ldb_timestring(void *mem_ctx, time_t t);
 504 time_t ldb_string_to_time(const char *s);
 505
 506 char *ldb_dn_canonical_string(void *mem_ctx, const struct ldb_dn *dn);
 507 char *ldb_dn_canonical_ex_string(void *mem_ctx, const struct ldb_dn *dn);
 508 #endif