source/lib/ldb/common/ldb.c

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Andrew Tridgell  2004
   5    Copyright (C) Simo Sorce  2005-2006
   6
   7      ** NOTE! The following LGPL license applies to the ldb
   8      ** library. This does NOT imply that all of Samba is released
   9      ** under the LGPL
  10
  11    This library is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU Lesser General Public
  13    License as published by the Free Software Foundation; either
  14    version 2 of the License, or (at your option) any later version.
  15
  16    This library is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19    Lesser General Public License for more details.
  20
  21    You should have received a copy of the GNU Lesser General Public
  22    License along with this library; if not, write to the Free Software
  23    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24 */
  25
  26 /*
  27  *  Name: ldb
  28  *
  29  *  Component: ldb core API
  30  *
  31  *  Description: core API routines interfacing to ldb backends
  32  *
  33  *  Author: Andrew Tridgell
  34  */
  35
  36 #include "includes.h"
  37 #include "ldb/include/includes.h"
  38
  39 /*
  40    initialise a ldb context
  41    The mem_ctx is optional
  42 */
  43 struct ldb_context *ldb_init(void *mem_ctx)
  44 {
  45         struct ldb_context *ldb = talloc_zero(mem_ctx, struct ldb_context);
  46         int ret;
  47
  48         ret = ldb_setup_wellknown_attributes(ldb);
  49         if (ret != 0) {
  50                 talloc_free(ldb);
  51                 return NULL;
  52         }
  53
  54         ldb_set_utf8_default(ldb);
  55         ldb_set_create_perms(ldb, 0666);
  56
  57         return ldb;
  58 }
  59
  60 static struct ldb_backend {
  61         const char *name;
  62         ldb_connect_fn connect_fn;
  63         struct ldb_backend *prev, *next;
  64 } *ldb_backends = NULL;
  65
  66
  67 static ldb_connect_fn ldb_find_backend(const char *url)
  68 {
  69         struct ldb_backend *backend;
  70
  71         for (backend = ldb_backends; backend; backend = backend->next) {
  72                 if (strncmp(backend->name, url, strlen(backend->name)) == 0) {
  73                         return backend->connect_fn;
  74                 }
  75         }
  76
  77         return NULL;
  78 }
  79
  80 /*
  81  register a new ldb backend
  82 */
  83 int ldb_register_backend(const char *url_prefix, ldb_connect_fn connectfn)
  84 {
  85         struct ldb_backend *backend = talloc(talloc_autofree_context(), struct ldb_backend);
  86
  87         if (ldb_find_backend(url_prefix)) {
  88                 return LDB_SUCCESS;
  89         }
  90
  91         /* Maybe check for duplicity here later on? */
  92
  93         backend->name = talloc_strdup(backend, url_prefix);
  94         backend->connect_fn = connectfn;
  95         DLIST_ADD(ldb_backends, backend);
  96
  97         return LDB_SUCCESS;
  98 }
  99
 100 /*
 101    Return the ldb module form of a database. The URL can either be one of the following forms
 102    ldb://path
 103    ldapi://path
 104
 105    flags is made up of LDB_FLG_*
 106
 107    the options are passed uninterpreted to the backend, and are
 108    backend specific.
 109
 110   This allows modules to get at only the backend module, for example where a module
 111   may wish to direct certain requests at a particular backend.
 112 */
 113 int ldb_connect_backend(struct ldb_context *ldb, const char *url, const char *options[],
 114                         struct ldb_module **backend_module)
 115 {
 116         int ret;
 117         char *backend;
 118         ldb_connect_fn fn;
 119
 120         if (strchr(url, ':') != NULL) {
 121                 backend = talloc_strndup(ldb, url, strchr(url, ':')-url);
 122         } else {
 123                 /* Default to tdb */
 124                 backend = talloc_strdup(ldb, "tdb");
 125         }
 126
 127         fn = ldb_find_backend(backend);
 128
 129         if (fn == NULL) {
 130                 if (ldb_try_load_dso(ldb, backend) == 0) {
 131                         fn = ldb_find_backend(backend);
 132                 }
 133         }
 134
 135         talloc_free(backend);
 136
 137         if (fn == NULL) {
 138                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Unable to find backend for '%s'\n", url);
 139                 return LDB_ERR_OTHER;
 140         }
 141
 142         ret = fn(ldb, url, ldb->flags, options, backend_module);
 143
 144         if (ret != LDB_SUCCESS) {
 145                 ldb_debug(ldb, LDB_DEBUG_ERROR, "Failed to connect to '%s'\n", url);
 146                 return ret;
 147         }
 148         return ret;
 149 }
 150
 151 /*
 152   try to autodetect a basedn if none specified. This fixes one of my
 153   pet hates about ldapsearch, which is that you have to get a long,
 154   complex basedn right to make any use of it.
 155 */
 156 static const struct ldb_dn *ldb_set_default_basedn(struct ldb_context *ldb)
 157 {
 158         TALLOC_CTX *tmp_ctx;
 159         int ret;
 160         static const char *attrs[] = { "defaultNamingContext", NULL };
 161         struct ldb_result *res;
 162         struct ldb_dn *basedn=NULL;
 163
 164         basedn = (struct ldb_dn *)ldb_get_opaque(ldb, "default_baseDN");
 165         if (basedn) {
 166                 return basedn;
 167         }
 168
 169         tmp_ctx = talloc_new(ldb);
 170         ret = ldb_search(ldb, ldb_dn_new(tmp_ctx), LDB_SCOPE_BASE,
 171                          "(objectClass=*)", attrs, &res);
 172         if (ret == LDB_SUCCESS) {
 173                 if (res->count == 1) {
 174                         basedn = ldb_msg_find_attr_as_dn(ldb, res->msgs[0], "defaultNamingContext");
 175                         ldb_set_opaque(ldb, "default_baseDN", basedn);
 176                 }
 177                 talloc_free(res);
 178         }
 179
 180         talloc_free(tmp_ctx);
 181         return basedn;
 182 }
 183
 184 const struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb)
 185 {
 186         return (const struct ldb_dn *)ldb_get_opaque(ldb, "default_baseDN");
 187 }
 188
 189 /*
 190  connect to a database. The URL can either be one of the following forms
 191    ldb://path
 192    ldapi://path
 193
 194    flags is made up of LDB_FLG_*
 195
 196    the options are passed uninterpreted to the backend, and are
 197    backend specific
 198 */
 199 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[])
 200 {
 201         int ret;
 202
 203         ldb->flags = flags;
 204
 205         ret = ldb_connect_backend(ldb, url, options, &ldb->modules);
 206         if (ret != LDB_SUCCESS) {
 207                 return ret;
 208         }
 209
 210         if (ldb_load_modules(ldb, options) != LDB_SUCCESS) {
 211                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Unable to load modules for %s: %s\n",
 212                           url, ldb_errstring(ldb));
 213                 return LDB_ERR_OTHER;
 214         }
 215
 216         /* TODO: get timeout from options if available there */
 217         ldb->default_timeout = 300; /* set default to 5 minutes */
 218
 219         /* set the default base dn */
 220         ldb_set_default_basedn(ldb);
 221
 222         return LDB_SUCCESS;
 223 }
 224
 225 void ldb_set_errstring(struct ldb_context *ldb, const char *err_string)
 226 {
 227         if (ldb->err_string) {
 228                 talloc_free(ldb->err_string);
 229         }
 230         ldb->err_string = talloc_strdup(ldb, err_string);
 231 }
 232
 233 void ldb_asprintf_errstring(struct ldb_context *ldb, const char *format, ...)
 234 {
 235         va_list ap;
 236
 237         if (ldb->err_string) {
 238                 talloc_free(ldb->err_string);
 239         }
 240
 241         va_start(ap, format);
 242         ldb->err_string = talloc_vasprintf(ldb, format, ap);
 243         va_end(ap);
 244 }
 245
 246 void ldb_reset_err_string(struct ldb_context *ldb)
 247 {
 248         if (ldb->err_string) {
 249                 talloc_free(ldb->err_string);
 250                 ldb->err_string = NULL;
 251         }
 252 }
 253
 254 #define FIRST_OP(ldb, op) do { \
 255         module = ldb->modules;                                  \
 256         while (module && module->ops->op == NULL) module = module->next; \
 257         if (module == NULL) {                                           \
 258                 ldb_asprintf_errstring(ldb, "unable to find module or backend to handle operation: " #op); \
 259                 return LDB_ERR_OPERATIONS_ERROR;                        \
 260         } \
 261 } while (0)
 262
 263 /*
 264   start a transaction
 265 */
 266 static int ldb_transaction_start_internal(struct ldb_context *ldb)
 267 {
 268         struct ldb_module *module;
 269         int status;
 270         FIRST_OP(ldb, start_transaction);
 271
 272         ldb_reset_err_string(ldb);
 273
 274         status = module->ops->start_transaction(module);
 275         if (status != LDB_SUCCESS) {
 276                 if (ldb->err_string == NULL) {
 277                         /* no error string was setup by the backend */
 278                         ldb_asprintf_errstring(ldb,
 279                                                 "ldb transaction start: %s (%d)",
 280                                                 ldb_strerror(status),
 281                                                 status);
 282                 }
 283         }
 284         return status;
 285 }
 286
 287 /*
 288   commit a transaction
 289 */
 290 static int ldb_transaction_commit_internal(struct ldb_context *ldb)
 291 {
 292         struct ldb_module *module;
 293         int status;
 294         FIRST_OP(ldb, end_transaction);
 295
 296         ldb_reset_err_string(ldb);
 297
 298         status = module->ops->end_transaction(module);
 299         if (status != LDB_SUCCESS) {
 300                 if (ldb->err_string == NULL) {
 301                         /* no error string was setup by the backend */
 302                         ldb_asprintf_errstring(ldb,
 303                                                 "ldb transaction commit: %s (%d)",
 304                                                 ldb_strerror(status),
 305                                                 status);
 306                 }
 307         }
 308         return status;
 309 }
 310
 311 /*
 312   cancel a transaction
 313 */
 314 static int ldb_transaction_cancel_internal(struct ldb_context *ldb)
 315 {
 316         struct ldb_module *module;
 317         int status;
 318         FIRST_OP(ldb, del_transaction);
 319
 320         status = module->ops->del_transaction(module);
 321         if (status != LDB_SUCCESS) {
 322                 if (ldb->err_string == NULL) {
 323                         /* no error string was setup by the backend */
 324                         ldb_asprintf_errstring(ldb,
 325                                                 "ldb transaction cancel: %s (%d)",
 326                                                 ldb_strerror(status),
 327                                                 status);
 328                 }
 329         }
 330         return status;
 331 }
 332
 333 int ldb_transaction_start(struct ldb_context *ldb)
 334 {
 335         /* disable autotransactions */
 336         ldb->transaction_active++;
 337
 338         return ldb_transaction_start_internal(ldb);
 339 }
 340
 341 int ldb_transaction_commit(struct ldb_context *ldb)
 342 {
 343         /* renable autotransactions (when we reach 0) */
 344         if (ldb->transaction_active > 0)
 345                 ldb->transaction_active--;
 346
 347         return ldb_transaction_commit_internal(ldb);
 348 }
 349
 350 int ldb_transaction_cancel(struct ldb_context *ldb)
 351 {
 352         /* renable autotransactions (when we reach 0) */
 353         if (ldb->transaction_active > 0)
 354                 ldb->transaction_active--;
 355
 356         return ldb_transaction_cancel_internal(ldb);
 357 }
 358
 359 static int ldb_autotransaction_start(struct ldb_context *ldb)
 360 {
 361         /* explicit transaction active, ignore autotransaction request */
 362         if (ldb->transaction_active)
 363                 return LDB_SUCCESS;
 364
 365         return ldb_transaction_start_internal(ldb);
 366 }
 367
 368 static int ldb_autotransaction_commit(struct ldb_context *ldb)
 369 {
 370         /* explicit transaction active, ignore autotransaction request */
 371         if (ldb->transaction_active)
 372                 return LDB_SUCCESS;
 373
 374         return ldb_transaction_commit_internal(ldb);
 375 }
 376
 377 static int ldb_autotransaction_cancel(struct ldb_context *ldb)
 378 {
 379         /* explicit transaction active, ignore autotransaction request */
 380         if (ldb->transaction_active)
 381                 return LDB_SUCCESS;
 382
 383         return ldb_transaction_cancel_internal(ldb);
 384 }
 385
 386 /* autostarts a transacion if none active */
 387 static int ldb_autotransaction_request(struct ldb_context *ldb, struct ldb_request *req)
 388 {
 389         int ret;
 390
 391         ret = ldb_autotransaction_start(ldb);
 392         if (ret != LDB_SUCCESS) {
 393                 return ret;
 394         }
 395
 396         ret = ldb_request(ldb, req);
 397         if (ret == LDB_SUCCESS) {
 398                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
 399         }
 400
 401         if (ret == LDB_SUCCESS) {
 402                 return ldb_autotransaction_commit(ldb);
 403         }
 404         ldb_autotransaction_cancel(ldb);
 405
 406         if (ldb->err_string == NULL) {
 407                 /* no error string was setup by the backend */
 408                 ldb_asprintf_errstring(ldb, "%s (%d)", ldb_strerror(ret), ret);
 409         }
 410
 411         return ret;
 412 }
 413
 414 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type)
 415 {
 416         if (!handle) {
 417                 return LDB_SUCCESS;
 418         }
 419
 420         return handle->module->ops->wait(handle, type);
 421 }
 422
 423 /* set the specified timeout or, if timeout is 0 set the default timeout */
 424 /* timeout == -1 means no timeout */
 425 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout)
 426 {
 427         if (req == NULL) return LDB_ERR_OPERATIONS_ERROR;
 428
 429         if (timeout != 0) {
 430                 req->timeout = timeout;
 431         } else {
 432                 req->timeout = ldb->default_timeout;
 433         }
 434         req->starttime = time(NULL);
 435
 436         return LDB_SUCCESS;
 437 }
 438
 439 /* calculates the new timeout based on the previous starttime and timeout */
 440 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq)
 441 {
 442         time_t now;
 443
 444         if (newreq == NULL) return LDB_ERR_OPERATIONS_ERROR;
 445
 446         now = time(NULL);
 447
 448         if (oldreq == NULL)
 449                 return ldb_set_timeout(ldb, newreq, 0);
 450
 451         if ((now - oldreq->starttime) > oldreq->timeout) {
 452                 return LDB_ERR_TIME_LIMIT_EXCEEDED;
 453         }
 454         newreq->starttime = oldreq->starttime;
 455         newreq->timeout = oldreq->timeout - (now - oldreq->starttime);
 456
 457         return LDB_SUCCESS;
 458 }
 459
 460
 461 /*
 462    set the permissions for new files to be passed to open() in
 463    backends that use local files
 464  */
 465 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms)
 466 {
 467         ldb->create_perms = perms;
 468 }
 469
 470 /*
 471   start an ldb request
 472   NOTE: the request must be a talloc context.
 473   returns LDB_ERR_* on errors.
 474 */
 475 int ldb_request(struct ldb_context *ldb, struct ldb_request *req)
 476 {
 477         struct ldb_module *module;
 478         int ret;
 479
 480         ldb_reset_err_string(ldb);
 481
 482         /* call the first module in the chain */
 483         switch (req->operation) {
 484         case LDB_SEARCH:
 485                 FIRST_OP(ldb, search);
 486                 ret = module->ops->search(module, req);
 487                 break;
 488         case LDB_ADD:
 489                 FIRST_OP(ldb, add);
 490                 ret = module->ops->add(module, req);
 491                 break;
 492         case LDB_MODIFY:
 493                 FIRST_OP(ldb, modify);
 494                 ret = module->ops->modify(module, req);
 495                 break;
 496         case LDB_DELETE:
 497                 FIRST_OP(ldb, del);
 498                 ret = module->ops->del(module, req);
 499                 break;
 500         case LDB_RENAME:
 501                 FIRST_OP(ldb, rename);
 502                 ret = module->ops->rename(module, req);
 503                 break;
 504         case LDB_SEQUENCE_NUMBER:
 505                 FIRST_OP(ldb, sequence_number);
 506                 ret = module->ops->sequence_number(module, req);
 507                 break;
 508         default:
 509                 FIRST_OP(ldb, request);
 510                 ret = module->ops->request(module, req);
 511                 break;
 512         }
 513
 514         return ret;
 515 }
 516
 517 /*
 518   search the database given a LDAP-like search expression
 519
 520   returns an LDB error code
 521
 522   Use talloc_free to free the ldb_message returned in 'res', if successful
 523
 524 */
 525 static int ldb_search_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
 526 {
 527         struct ldb_result *res;
 528         int n;
 529
 530         if (!context) {
 531                 ldb_set_errstring(ldb, "NULL Context in callback");
 532                 return LDB_ERR_OPERATIONS_ERROR;
 533         }
 534
 535         res = *((struct ldb_result **)context);
 536
 537         if (!res || !ares) {
 538                 goto error;
 539         }
 540
 541         switch (ares->type) {
 542         case LDB_REPLY_ENTRY:
 543                 res->msgs = talloc_realloc(res, res->msgs, struct ldb_message *, res->count + 2);
 544                 if (! res->msgs) {
 545                         goto error;
 546                 }
 547
 548                 res->msgs[res->count + 1] = NULL;
 549
 550                 res->msgs[res->count] = talloc_move(res->msgs, &ares->message);
 551                 res->count++;
 552                 break;
 553         case LDB_REPLY_REFERRAL:
 554                 if (res->refs) {
 555                         for (n = 0; res->refs[n]; n++) /*noop*/ ;
 556                 } else {
 557                         n = 0;
 558                 }
 559
 560                 res->refs = talloc_realloc(res, res->refs, char *, n + 2);
 561                 if (! res->refs) {
 562                         goto error;
 563                 }
 564
 565                 res->refs[n] = talloc_move(res->refs, &ares->referral);
 566                 res->refs[n + 1] = NULL;
 567         case LDB_REPLY_DONE:
 568                 /* Should do something here to detect if this never
 569                  * happens */
 570                 break;
 571         }
 572         talloc_steal(res, ares->controls);
 573         talloc_free(ares);
 574         return LDB_SUCCESS;
 575
 576 error:
 577         talloc_free(ares);
 578         talloc_free(res);
 579         *((struct ldb_result **)context) = NULL;
 580         return LDB_ERR_OPERATIONS_ERROR;
 581 }
 582
 583 int ldb_build_search_req(struct ldb_request **ret_req,
 584                         struct ldb_context *ldb,
 585                         void *mem_ctx,
 586                         const struct ldb_dn *base,
 587                         enum ldb_scope scope,
 588                         const char *expression,
 589                         const char * const *attrs,
 590                         struct ldb_control **controls,
 591                         void *context,
 592                         ldb_request_callback_t callback)
 593 {
 594         struct ldb_request *req;
 595
 596         *ret_req = NULL;
 597
 598         req = talloc(mem_ctx, struct ldb_request);
 599         if (req == NULL) {
 600                 ldb_set_errstring(ldb, "Out of Memory");
 601                 return LDB_ERR_OPERATIONS_ERROR;
 602         }
 603
 604         req->operation = LDB_SEARCH;
 605         if (base == NULL) {
 606                 req->op.search.base = ldb_dn_new(req);
 607         } else {
 608                 req->op.search.base = base;
 609         }
 610         req->op.search.scope = scope;
 611
 612         req->op.search.tree = ldb_parse_tree(req, expression);
 613         if (req->op.search.tree == NULL) {
 614                 ldb_set_errstring(ldb, "Unable to parse search expression");
 615                 talloc_free(req);
 616                 return LDB_ERR_OPERATIONS_ERROR;
 617         }
 618
 619         req->op.search.attrs = attrs;
 620         req->controls = controls;
 621         req->context = context;
 622         req->callback = callback;
 623
 624         *ret_req = req;
 625         return LDB_SUCCESS;
 626 }
 627
 628 int ldb_build_add_req(struct ldb_request **ret_req,
 629                         struct ldb_context *ldb,
 630                         void *mem_ctx,
 631                         const struct ldb_message *message,
 632                         struct ldb_control **controls,
 633                         void *context,
 634                         ldb_request_callback_t callback)
 635 {
 636         struct ldb_request *req;
 637
 638         *ret_req = NULL;
 639
 640         req = talloc(mem_ctx, struct ldb_request);
 641         if (req == NULL) {
 642                 ldb_set_errstring(ldb, "Out of Memory");
 643                 return LDB_ERR_OPERATIONS_ERROR;
 644         }
 645
 646         req->operation = LDB_ADD;
 647         req->op.add.message = message;
 648         req->controls = controls;
 649         req->context = context;
 650         req->callback = callback;
 651
 652         *ret_req = req;
 653
 654         return LDB_SUCCESS;
 655 }
 656
 657 int ldb_build_mod_req(struct ldb_request **ret_req,
 658                         struct ldb_context *ldb,
 659                         void *mem_ctx,
 660                         const struct ldb_message *message,
 661                         struct ldb_control **controls,
 662                         void *context,
 663                         ldb_request_callback_t callback)
 664 {
 665         struct ldb_request *req;
 666
 667         *ret_req = NULL;
 668
 669         req = talloc(mem_ctx, struct ldb_request);
 670         if (req == NULL) {
 671                 ldb_set_errstring(ldb, "Out of Memory");
 672                 return LDB_ERR_OPERATIONS_ERROR;
 673         }
 674
 675         req->operation = LDB_MODIFY;
 676         req->op.mod.message = message;
 677         req->controls = controls;
 678         req->context = context;
 679         req->callback = callback;
 680
 681         *ret_req = req;
 682
 683         return LDB_SUCCESS;
 684 }
 685
 686 int ldb_build_del_req(struct ldb_request **ret_req,
 687                         struct ldb_context *ldb,
 688                         void *mem_ctx,
 689                         const struct ldb_dn *dn,
 690                         struct ldb_control **controls,
 691                         void *context,
 692                         ldb_request_callback_t callback)
 693 {
 694         struct ldb_request *req;
 695
 696         *ret_req = NULL;
 697
 698         req = talloc(mem_ctx, struct ldb_request);
 699         if (req == NULL) {
 700                 ldb_set_errstring(ldb, "Out of Memory");
 701                 return LDB_ERR_OPERATIONS_ERROR;
 702         }
 703
 704         req->operation = LDB_DELETE;
 705         req->op.del.dn = dn;
 706         req->controls = controls;
 707         req->context = context;
 708         req->callback = callback;
 709
 710         *ret_req = req;
 711
 712         return LDB_SUCCESS;
 713 }
 714
 715 int ldb_build_rename_req(struct ldb_request **ret_req,
 716                         struct ldb_context *ldb,
 717                         void *mem_ctx,
 718                         const struct ldb_dn *olddn,
 719                         const struct ldb_dn *newdn,
 720                         struct ldb_control **controls,
 721                         void *context,
 722                         ldb_request_callback_t callback)
 723 {
 724         struct ldb_request *req;
 725
 726         *ret_req = NULL;
 727
 728         req = talloc(mem_ctx, struct ldb_request);
 729         if (req == NULL) {
 730                 ldb_set_errstring(ldb, "Out of Memory");
 731                 return LDB_ERR_OPERATIONS_ERROR;
 732         }
 733
 734         req->operation = LDB_RENAME;
 735         req->op.rename.olddn = olddn;
 736         req->op.rename.newdn = newdn;
 737         req->controls = controls;
 738         req->context = context;
 739         req->callback = callback;
 740
 741         *ret_req = req;
 742
 743         return LDB_SUCCESS;
 744 }
 745
 746 /*
 747   note that ldb_search() will automatically replace a NULL 'base' value with the
 748   defaultNamingContext from the rootDSE if available.
 749 */
 750 int ldb_search(struct ldb_context *ldb,
 751                const struct ldb_dn *base,
 752                enum ldb_scope scope,
 753                const char *expression,
 754                const char * const *attrs,
 755                struct ldb_result **res)
 756 {
 757         struct ldb_request *req;
 758         int ret;
 759
 760         *res = talloc_zero(ldb, struct ldb_result);
 761         if (! *res) {
 762                 return LDB_ERR_OPERATIONS_ERROR;
 763         }
 764
 765         ret = ldb_build_search_req(&req, ldb, ldb,
 766                                         base?base:ldb_get_default_basedn(ldb),
 767                                         scope,
 768                                         expression,
 769                                         attrs,
 770                                         NULL,
 771                                         res,
 772                                         ldb_search_callback);
 773
 774         if (ret != LDB_SUCCESS) goto done;
 775
 776         ldb_set_timeout(ldb, req, 0); /* use default timeout */
 777
 778         ret = ldb_request(ldb, req);
 779
 780         if (ret == LDB_SUCCESS) {
 781                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
 782         }
 783
 784         talloc_free(req);
 785
 786 done:
 787         if (ret != LDB_SUCCESS) {
 788                 talloc_free(*res);
 789                 *res = NULL;
 790         }
 791
 792         return ret;
 793 }
 794
 795 /*
 796   add a record to the database. Will fail if a record with the given class and key
 797   already exists
 798 */
 799 int ldb_add(struct ldb_context *ldb,
 800             const struct ldb_message *message)
 801 {
 802         struct ldb_request *req;
 803         int ret;
 804
 805         ret = ldb_msg_sanity_check(ldb, message);
 806         if (ret != LDB_SUCCESS) {
 807                 return ret;
 808         }
 809
 810         ret = ldb_build_add_req(&req, ldb, ldb,
 811                                         message,
 812                                         NULL,
 813                                         NULL,
 814                                         NULL);
 815
 816         if (ret != LDB_SUCCESS) return ret;
 817
 818         ldb_set_timeout(ldb, req, 0); /* use default timeout */
 819
 820         /* do request and autostart a transaction */
 821         ret = ldb_autotransaction_request(ldb, req);
 822
 823         talloc_free(req);
 824         return ret;
 825 }
 826
 827 /*
 828   modify the specified attributes of a record
 829 */
 830 int ldb_modify(struct ldb_context *ldb,
 831                const struct ldb_message *message)
 832 {
 833         struct ldb_request *req;
 834         int ret;
 835
 836         ret = ldb_msg_sanity_check(ldb, message);
 837         if (ret != LDB_SUCCESS) {
 838                 return ret;
 839         }
 840
 841         ret = ldb_build_mod_req(&req, ldb, ldb,
 842                                         message,
 843                                         NULL,
 844                                         NULL,
 845                                         NULL);
 846
 847         if (ret != LDB_SUCCESS) return ret;
 848
 849         ldb_set_timeout(ldb, req, 0); /* use default timeout */
 850
 851         /* do request and autostart a transaction */
 852         ret = ldb_autotransaction_request(ldb, req);
 853
 854         talloc_free(req);
 855         return ret;
 856 }
 857
 858
 859 /*
 860   delete a record from the database
 861 */
 862 int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn)
 863 {
 864         struct ldb_request *req;
 865         int ret;
 866
 867         ret = ldb_build_del_req(&req, ldb, ldb,
 868                                         dn,
 869                                         NULL,
 870                                         NULL,
 871                                         NULL);
 872
 873         if (ret != LDB_SUCCESS) return ret;
 874
 875         ldb_set_timeout(ldb, req, 0); /* use default timeout */
 876
 877         /* do request and autostart a transaction */
 878         ret = ldb_autotransaction_request(ldb, req);
 879
 880         talloc_free(req);
 881         return ret;
 882 }
 883
 884 /*
 885   rename a record in the database
 886 */
 887 int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn)
 888 {
 889         struct ldb_request *req;
 890         int ret;
 891
 892         ret = ldb_build_rename_req(&req, ldb, ldb,
 893                                         olddn,
 894                                         newdn,
 895                                         NULL,
 896                                         NULL,
 897                                         NULL);
 898
 899         if (ret != LDB_SUCCESS) return ret;
 900
 901         ldb_set_timeout(ldb, req, 0); /* use default timeout */
 902
 903         /* do request and autostart a transaction */
 904         ret = ldb_autotransaction_request(ldb, req);
 905
 906         talloc_free(req);
 907         return ret;
 908 }
 909
 910
 911 /*
 912   return the global sequence number
 913 */
 914 int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num)
 915 {
 916         struct ldb_request *req;
 917         int ret;
 918
 919         req = talloc(ldb, struct ldb_request);
 920         if (req == NULL) {
 921                 ldb_set_errstring(ldb, "Out of Memory");
 922                 return LDB_ERR_OPERATIONS_ERROR;
 923         }
 924
 925         req->operation = LDB_SEQUENCE_NUMBER;
 926         req->controls = NULL;
 927         req->context = NULL;
 928         req->callback = NULL;
 929         ldb_set_timeout(ldb, req, 0); /* use default timeout */
 930
 931         req->op.seq_num.type = type;
 932         /* do request and autostart a transaction */
 933         ret = ldb_request(ldb, req);
 934
 935         if (ret == LDB_SUCCESS) {
 936                 *seq_num = req->op.seq_num.seq_num;
 937         }
 938
 939         talloc_free(req);
 940         return ret;
 941 }
 942
 943
 944
 945 /*
 946   return extended error information
 947 */
 948 const char *ldb_errstring(struct ldb_context *ldb)
 949 {
 950         if (ldb->err_string) {
 951                 return ldb->err_string;
 952         }
 953
 954         return NULL;
 955 }
 956
 957 /*
 958   return a string explaining what a ldb error constant meancs
 959 */
 960 const char *ldb_strerror(int ldb_err)
 961 {
 962         switch (ldb_err) {
 963         case LDB_SUCCESS:
 964                 return "Success";
 965         case LDB_ERR_OPERATIONS_ERROR:
 966                 return "Operations error";
 967         case LDB_ERR_PROTOCOL_ERROR:
 968                 return "Protocol error";
 969         case LDB_ERR_TIME_LIMIT_EXCEEDED:
 970                 return "Time limit exceeded";
 971         case LDB_ERR_SIZE_LIMIT_EXCEEDED:
 972                 return "Size limit exceeded";
 973         case LDB_ERR_COMPARE_FALSE:
 974                 return "Compare false";
 975         case LDB_ERR_COMPARE_TRUE:
 976                 return "Compare true";
 977         case LDB_ERR_AUTH_METHOD_NOT_SUPPORTED:
 978                 return "Auth method not supported";
 979         case LDB_ERR_STRONG_AUTH_REQUIRED:
 980                 return "Strong auth required";
 981 /* 9 RESERVED */
 982         case LDB_ERR_REFERRAL:
 983                 return "Referral error";
 984         case LDB_ERR_ADMIN_LIMIT_EXCEEDED:
 985                 return "Admin limit exceeded";
 986         case LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION:
 987                 return "Unsupported critical extension";
 988         case LDB_ERR_CONFIDENTIALITY_REQUIRED:
 989                 return "Confidentiality required";
 990         case LDB_ERR_SASL_BIND_IN_PROGRESS:
 991                 return "SASL bind in progress";
 992         case LDB_ERR_NO_SUCH_ATTRIBUTE:
 993                 return "No such attribute";
 994         case LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE:
 995                 return "Undefined attribute type";
 996         case LDB_ERR_INAPPROPRIATE_MATCHING:
 997                 return "Inappropriate matching";
 998         case LDB_ERR_CONSTRAINT_VIOLATION:
 999                 return "Constraint violation";
1000         case LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS:
1001                 return "Attribute or value exists";
1002         case LDB_ERR_INVALID_ATTRIBUTE_SYNTAX:
1003                 return "Invalid attribute syntax";
1004 /* 22-31 unused */
1005         case LDB_ERR_NO_SUCH_OBJECT:
1006                 return "No such object";
1007         case LDB_ERR_ALIAS_PROBLEM:
1008                 return "Alias problem";
1009         case LDB_ERR_INVALID_DN_SYNTAX:
1010                 return "Invalid DN syntax";
1011 /* 35 RESERVED */
1012         case LDB_ERR_ALIAS_DEREFERENCING_PROBLEM:
1013                 return "Alias dereferencing problem";
1014 /* 37-47 unused */
1015         case LDB_ERR_INAPPROPRIATE_AUTHENTICATION:
1016                 return "Inappropriate authentication";
1017         case LDB_ERR_INVALID_CREDENTIALS:
1018                 return "Invalid credentials";
1019         case LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS:
1020                 return "insufficient access rights";
1021         case LDB_ERR_BUSY:
1022                 return "Busy";
1023         case LDB_ERR_UNAVAILABLE:
1024                 return "Unavailable";
1025         case LDB_ERR_UNWILLING_TO_PERFORM:
1026                 return "Unwilling to perform";
1027         case LDB_ERR_LOOP_DETECT:
1028                 return "Loop detect";
1029 /* 55-63 unused */
1030         case LDB_ERR_NAMING_VIOLATION:
1031                 return "Naming violation";
1032         case LDB_ERR_OBJECT_CLASS_VIOLATION:
1033                 return "Object class violation";
1034         case LDB_ERR_NOT_ALLOWED_ON_NON_LEAF:
1035                 return "Not allowed on non-leaf";
1036         case LDB_ERR_NOT_ALLOWED_ON_RDN:
1037                 return "Not allowed on RDN";
1038         case LDB_ERR_ENTRY_ALREADY_EXISTS:
1039                 return "Entry already exists";
1040         case LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED:
1041                 return "Object class mods prohibited";
1042 /* 70 RESERVED FOR CLDAP */
1043         case LDB_ERR_AFFECTS_MULTIPLE_DSAS:
1044                 return "Affects multiple DSAs";
1045 /* 72-79 unused */
1046         case LDB_ERR_OTHER:
1047                 return "Other";
1048         }
1049
1050         return "Unknown error";
1051 }
1052
1053 /*
1054   set backend specific opaque parameters
1055 */
1056 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value)
1057 {
1058         struct ldb_opaque *o;
1059
1060         /* allow updating an existing value */
1061         for (o=ldb->opaque;o;o=o->next) {
1062                 if (strcmp(o->name, name) == 0) {
1063                         o->value = value;
1064                         return LDB_SUCCESS;
1065                 }
1066         }
1067
1068         o = talloc(ldb, struct ldb_opaque);
1069         if (o == NULL) {
1070                 ldb_oom(ldb);
1071                 return LDB_ERR_OTHER;
1072         }
1073         o->next = ldb->opaque;
1074         o->name = name;
1075         o->value = value;
1076         ldb->opaque = o;
1077         return LDB_SUCCESS;
1078 }
1079
1080 /*
1081   get a previously set opaque value
1082 */
1083 void *ldb_get_opaque(struct ldb_context *ldb, const char *name)
1084 {
1085         struct ldb_opaque *o;
1086         for (o=ldb->opaque;o;o=o->next) {
1087                 if (strcmp(o->name, name) == 0) {
1088                         return o->value;
1089                 }
1090         }
1091         return NULL;
1092 }