source4/lib/ldb/ldb_tdb/ldb_search.c

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Andrew Tridgell  2004
   5
   6      ** NOTE! The following LGPL license applies to the ldb
   7      ** library. This does NOT imply that all of Samba is released
   8      ** under the LGPL
   9
  10    This library is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU Lesser General Public
  12    License as published by the Free Software Foundation; either
  13    version 3 of the License, or (at your option) any later version.
  14
  15    This library is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    Lesser General Public License for more details.
  19
  20    You should have received a copy of the GNU Lesser General Public
  21    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 /*
  25  *  Name: ldb
  26  *
  27  *  Component: ldb search functions
  28  *
  29  *  Description: functions to search ldb+tdb databases
  30  *
  31  *  Author: Andrew Tridgell
  32  */
  33
  34 #include "ldb_includes.h"
  35
  36 #include "ldb_tdb.h"
  37
  38 /*
  39   add one element to a message
  40 */
  41 static int msg_add_element(struct ldb_message *ret,
  42                            const struct ldb_message_element *el,
  43                            int check_duplicates)
  44 {
  45         unsigned int i;
  46         struct ldb_message_element *e2, *elnew;
  47
  48         if (check_duplicates && ldb_msg_find_element(ret, el->name)) {
  49                 /* its already there */
  50                 return 0;
  51         }
  52
  53         e2 = talloc_realloc(ret, ret->elements, struct ldb_message_element, ret->num_elements+1);
  54         if (!e2) {
  55                 return -1;
  56         }
  57         ret->elements = e2;
  58
  59         elnew = &e2[ret->num_elements];
  60
  61         elnew->name = talloc_strdup(ret->elements, el->name);
  62         if (!elnew->name) {
  63                 return -1;
  64         }
  65
  66         if (el->num_values) {
  67                 elnew->values = talloc_array(ret->elements, struct ldb_val, el->num_values);
  68                 if (!elnew->values) {
  69                         return -1;
  70                 }
  71         } else {
  72                 elnew->values = NULL;
  73         }
  74
  75         for (i=0;i<el->num_values;i++) {
  76                 elnew->values[i] = ldb_val_dup(elnew->values, &el->values[i]);
  77                 if (elnew->values[i].length != el->values[i].length) {
  78                         return -1;
  79                 }
  80         }
  81
  82         elnew->num_values = el->num_values;
  83
  84         ret->num_elements++;
  85
  86         return 0;
  87 }
  88
  89 /*
  90   add the special distinguishedName element
  91 */
  92 static int msg_add_distinguished_name(struct ldb_message *msg)
  93 {
  94         struct ldb_message_element el;
  95         struct ldb_val val;
  96         int ret;
  97
  98         el.flags = 0;
  99         el.name = "distinguishedName";
 100         el.num_values = 1;
 101         el.values = &val;
 102         val.data = (uint8_t *)ldb_dn_alloc_linearized(msg, msg->dn);
 103         val.length = strlen((char *)val.data);
 104
 105         ret = msg_add_element(msg, &el, 1);
 106         return ret;
 107 }
 108
 109 /*
 110   add all elements from one message into another
 111  */
 112 static int msg_add_all_elements(struct ldb_module *module, struct ldb_message *ret,
 113                                 const struct ldb_message *msg)
 114 {
 115         struct ldb_context *ldb = module->ldb;
 116         unsigned int i;
 117         int check_duplicates = (ret->num_elements != 0);
 118
 119         if (msg_add_distinguished_name(ret) != 0) {
 120                 return -1;
 121         }
 122
 123         for (i=0;i<msg->num_elements;i++) {
 124                 const struct ldb_schema_attribute *a;
 125                 a = ldb_schema_attribute_by_name(ldb, msg->elements[i].name);
 126                 if (a->flags & LDB_ATTR_FLAG_HIDDEN) {
 127                         continue;
 128                 }
 129                 if (msg_add_element(ret, &msg->elements[i],
 130                                     check_duplicates) != 0) {
 131                         return -1;
 132                 }
 133         }
 134
 135         return 0;
 136 }
 137
 138
 139 /*
 140   pull the specified list of attributes from a message
 141  */
 142 static struct ldb_message *ltdb_pull_attrs(struct ldb_module *module,
 143                                            TALLOC_CTX *mem_ctx,
 144                                            const struct ldb_message *msg,
 145                                            const char * const *attrs)
 146 {
 147         struct ldb_message *ret;
 148         int i;
 149
 150         ret = talloc(mem_ctx, struct ldb_message);
 151         if (!ret) {
 152                 return NULL;
 153         }
 154
 155         ret->dn = ldb_dn_copy(ret, msg->dn);
 156         if (!ret->dn) {
 157                 talloc_free(ret);
 158                 return NULL;
 159         }
 160
 161         ret->num_elements = 0;
 162         ret->elements = NULL;
 163
 164         if (!attrs) {
 165                 if (msg_add_all_elements(module, ret, msg) != 0) {
 166                         talloc_free(ret);
 167                         return NULL;
 168                 }
 169                 return ret;
 170         }
 171
 172         for (i=0;attrs[i];i++) {
 173                 struct ldb_message_element *el;
 174
 175                 if (strcmp(attrs[i], "*") == 0) {
 176                         if (msg_add_all_elements(module, ret, msg) != 0) {
 177                                 talloc_free(ret);
 178                                 return NULL;
 179                         }
 180                         continue;
 181                 }
 182
 183                 if (ldb_attr_cmp(attrs[i], "distinguishedName") == 0) {
 184                         if (msg_add_distinguished_name(ret) != 0) {
 185                                 return NULL;
 186                         }
 187                         continue;
 188                 }
 189
 190                 el = ldb_msg_find_element(msg, attrs[i]);
 191                 if (!el) {
 192                         continue;
 193                 }
 194                 if (msg_add_element(ret, el, 1) != 0) {
 195                         talloc_free(ret);
 196                         return NULL;
 197                 }
 198         }
 199
 200         return ret;
 201 }
 202
 203 /*
 204   search the database for a single simple dn.
 205   return LDB_ERR_NO_SUCH_OBJECT on record-not-found
 206   and LDB_SUCCESS on success
 207 */
 208 int ltdb_search_base(struct ldb_module *module, struct ldb_dn *dn)
 209 {
 210         struct ltdb_private *ltdb = (struct ltdb_private *)module->private_data;
 211         TDB_DATA tdb_key, tdb_data;
 212
 213         if (ldb_dn_is_null(dn)) {
 214                 return LDB_ERR_NO_SUCH_OBJECT;
 215         }
 216
 217         /* form the key */
 218         tdb_key = ltdb_key(module, dn);
 219         if (!tdb_key.dptr) {
 220                 return LDB_ERR_OPERATIONS_ERROR;
 221         }
 222
 223         tdb_data = tdb_fetch(ltdb->tdb, tdb_key);
 224         talloc_free(tdb_key.dptr);
 225         if (!tdb_data.dptr) {
 226                 return LDB_ERR_NO_SUCH_OBJECT;
 227         }
 228
 229         free(tdb_data.dptr);
 230         return LDB_SUCCESS;
 231 }
 232
 233 /*
 234   search the database for a single simple dn, returning all attributes
 235   in a single message
 236
 237   return LDB_ERR_NO_SUCH_OBJECT on record-not-found
 238   and LDB_SUCCESS on success
 239 */
 240 int ltdb_search_dn1(struct ldb_module *module, struct ldb_dn *dn, struct ldb_message *msg)
 241 {
 242         struct ltdb_private *ltdb = (struct ltdb_private *)module->private_data;
 243         int ret;
 244         TDB_DATA tdb_key, tdb_data;
 245
 246         memset(msg, 0, sizeof(*msg));
 247
 248         /* form the key */
 249         tdb_key = ltdb_key(module, dn);
 250         if (!tdb_key.dptr) {
 251                 return LDB_ERR_OPERATIONS_ERROR;
 252         }
 253
 254         tdb_data = tdb_fetch(ltdb->tdb, tdb_key);
 255         talloc_free(tdb_key.dptr);
 256         if (!tdb_data.dptr) {
 257                 return LDB_ERR_NO_SUCH_OBJECT;
 258         }
 259
 260         msg->num_elements = 0;
 261         msg->elements = NULL;
 262
 263         ret = ltdb_unpack_data(module, &tdb_data, msg);
 264         free(tdb_data.dptr);
 265         if (ret == -1) {
 266                 return LDB_ERR_OPERATIONS_ERROR;
 267         }
 268
 269         if (!msg->dn) {
 270                 msg->dn = ldb_dn_copy(msg, dn);
 271         }
 272         if (!msg->dn) {
 273                 return LDB_ERR_OPERATIONS_ERROR;
 274         }
 275
 276         return LDB_SUCCESS;
 277 }
 278
 279 /*
 280   add a set of attributes from a record to a set of results
 281   return 0 on success, -1 on failure
 282 */
 283 int ltdb_add_attr_results(struct ldb_module *module,
 284                           TALLOC_CTX *mem_ctx,
 285                           struct ldb_message *msg,
 286                           const char * const attrs[],
 287                           unsigned int *count,
 288                           struct ldb_message ***res)
 289 {
 290         struct ldb_message *msg2;
 291         struct ldb_message **res2;
 292
 293         /* pull the attributes that the user wants */
 294         msg2 = ltdb_pull_attrs(module, mem_ctx, msg, attrs);
 295         if (!msg2) {
 296                 return -1;
 297         }
 298
 299         /* add to the results list */
 300         res2 = talloc_realloc(mem_ctx, *res, struct ldb_message *, (*count)+2);
 301         if (!res2) {
 302                 talloc_free(msg2);
 303                 return -1;
 304         }
 305
 306         (*res) = res2;
 307
 308         (*res)[*count] = talloc_move(*res, &msg2);
 309         (*res)[(*count)+1] = NULL;
 310         (*count)++;
 311
 312         return 0;
 313 }
 314
 315
 316
 317 /*
 318   filter the specified list of attributes from a message
 319   removing not requested attrs.
 320  */
 321 int ltdb_filter_attrs(struct ldb_message *msg, const char * const *attrs)
 322 {
 323         int i, keep_all = 0;
 324
 325         if (attrs) {
 326                 /* check for special attrs */
 327                 for (i = 0; attrs[i]; i++) {
 328                         if (strcmp(attrs[i], "*") == 0) {
 329                                 keep_all = 1;
 330                                 break;
 331                         }
 332
 333                         if (ldb_attr_cmp(attrs[i], "distinguishedName") == 0) {
 334                                 if (msg_add_distinguished_name(msg) != 0) {
 335                                         return -1;
 336                                 }
 337                         }
 338                 }
 339         } else {
 340                 keep_all = 1;
 341         }
 342
 343         if (keep_all) {
 344                 if (msg_add_distinguished_name(msg) != 0) {
 345                         return -1;
 346                 }
 347                 return 0;
 348         }
 349
 350         for (i = 0; i < msg->num_elements; i++) {
 351                 int j, found;
 352
 353                 for (j = 0, found = 0; attrs[j]; j++) {
 354                         if (ldb_attr_cmp(msg->elements[i].name, attrs[j]) == 0) {
 355                                 found = 1;
 356                                 break;
 357                         }
 358                 }
 359
 360                 if (!found) {
 361                         ldb_msg_remove_attr(msg, msg->elements[i].name);
 362                         i--;
 363                 }
 364         }
 365
 366         return 0;
 367 }
 368
 369 /*
 370   search function for a non-indexed search
 371  */
 372 static int search_func(struct tdb_context *tdb, TDB_DATA key, TDB_DATA data, void *state)
 373 {
 374         struct ltdb_context *ac;
 375         struct ldb_message *msg;
 376         int ret;
 377
 378         ac = talloc_get_type(state, struct ltdb_context);
 379
 380         if (key.dsize < 4 ||
 381             strncmp((char *)key.dptr, "DN=", 3) != 0) {
 382                 return 0;
 383         }
 384
 385         msg = ldb_msg_new(ac);
 386         if (!msg) {
 387                 return -1;
 388         }
 389
 390         /* unpack the record */
 391         ret = ltdb_unpack_data(ac->module, &data, msg);
 392         if (ret == -1) {
 393                 talloc_free(msg);
 394                 return -1;
 395         }
 396
 397         if (!msg->dn) {
 398                 msg->dn = ldb_dn_new(msg, ac->module->ldb,
 399                                      (char *)key.dptr + 3);
 400                 if (msg->dn == NULL) {
 401                         talloc_free(msg);
 402                         return -1;
 403                 }
 404         }
 405
 406         /* see if it matches the given expression */
 407         if (!ldb_match_msg(ac->module->ldb, msg,
 408                            ac->tree, ac->base, ac->scope)) {
 409                 talloc_free(msg);
 410                 return 0;
 411         }
 412
 413         /* filter the attributes that the user wants */
 414         ret = ltdb_filter_attrs(msg, ac->attrs);
 415
 416         if (ret == -1) {
 417                 talloc_free(msg);
 418                 return -1;
 419         }
 420
 421         ret = ldb_module_send_entry(ac->req, msg);
 422         if (ret != LDB_SUCCESS) {
 423                 ac->callback_failed = true;
 424                 /* the callback failed, abort the operation */
 425                 return -1;
 426         }
 427
 428         return 0;
 429 }
 430
 431
 432 /*
 433   search the database with a LDAP-like expression.
 434   this is the "full search" non-indexed variant
 435 */
 436 static int ltdb_search_full(struct ltdb_context *ctx)
 437 {
 438         struct ltdb_private *ltdb = talloc_get_type(ctx->module->private_data, struct ltdb_private);
 439         int ret;
 440
 441         if (ltdb->in_transaction != 0) {
 442                 ret = tdb_traverse(ltdb->tdb, search_func, ctx);
 443         } else {
 444                 ret = tdb_traverse_read(ltdb->tdb, search_func, ctx);
 445         }
 446
 447         if (ret == -1) {
 448                 return LDB_ERR_OPERATIONS_ERROR;
 449         }
 450
 451         return LDB_SUCCESS;
 452 }
 453
 454 /*
 455   search the database with a LDAP-like expression.
 456   choses a search method
 457 */
 458 int ltdb_search(struct ltdb_context *ctx)
 459 {
 460         struct ldb_module *module = ctx->module;
 461         struct ldb_request *req = ctx->req;
 462         struct ltdb_private *ltdb = talloc_get_type(module->private_data, struct ltdb_private);
 463         int ret;
 464
 465         req->handle->state = LDB_ASYNC_PENDING;
 466
 467         if (ltdb_lock_read(module) != 0) {
 468                 return LDB_ERR_OPERATIONS_ERROR;
 469         }
 470
 471         if (ltdb_cache_load(module) != 0) {
 472                 ltdb_unlock_read(module);
 473                 return LDB_ERR_OPERATIONS_ERROR;
 474         }
 475
 476         if (req->op.search.tree == NULL) {
 477                 ltdb_unlock_read(module);
 478                 return LDB_ERR_OPERATIONS_ERROR;
 479         }
 480
 481         if ((req->op.search.base == NULL) || (ldb_dn_is_null(req->op.search.base) == true)) {
 482
 483                 /* Check what we should do with a NULL dn */
 484                 switch (req->op.search.scope) {
 485                 case LDB_SCOPE_BASE:
 486                         ldb_asprintf_errstring(module->ldb,
 487                                                "NULL Base DN invalid for a base search");
 488                         ret = LDB_ERR_INVALID_DN_SYNTAX;
 489                         break;
 490                 case LDB_SCOPE_ONELEVEL:
 491                         ldb_asprintf_errstring(module->ldb,
 492                                                "NULL Base DN invalid for a one-level search");
 493                         ret = LDB_ERR_INVALID_DN_SYNTAX;
 494                         break;
 495                 case LDB_SCOPE_SUBTREE:
 496                 default:
 497                         /* We accept subtree searches from a NULL base DN, ie over the whole DB */
 498                         ret = LDB_SUCCESS;
 499                 }
 500         } else if (ldb_dn_is_valid(req->op.search.base) == false) {
 501
 502                 /* We don't want invalid base DNs here */
 503                 ldb_asprintf_errstring(module->ldb,
 504                                        "Invalid Base DN: %s",
 505                                        ldb_dn_get_linearized(req->op.search.base));
 506                 ret = LDB_ERR_INVALID_DN_SYNTAX;
 507
 508         } else if (ltdb->check_base) {
 509                 /* This database has been marked as 'checkBaseOnSearch', so do a spot check of the base dn */
 510                 ret = ltdb_search_base(module, req->op.search.base);
 511
 512                 if (ret == LDB_ERR_NO_SUCH_OBJECT) {
 513                         ldb_asprintf_errstring(module->ldb,
 514                                                "No such Base DN: %s",
 515                                                ldb_dn_get_linearized(req->op.search.base));
 516                 }
 517
 518         } else {
 519                 /* If we are not checking the base DN life is easy */
 520                 ret = LDB_SUCCESS;
 521         }
 522
 523         ctx->tree = req->op.search.tree;
 524         ctx->scope = req->op.search.scope;
 525         ctx->base = req->op.search.base;
 526         ctx->attrs = req->op.search.attrs;
 527
 528         if (ret == LDB_SUCCESS) {
 529                 ret = ltdb_search_indexed(ctx);
 530                 if (ret == LDB_ERR_NO_SUCH_OBJECT) {
 531                         /* Not in the index, therefore OK! */
 532                         ret = LDB_SUCCESS;
 533
 534                 }
 535                 /* Check if we got just a normal error.
 536                  * In that case proceed to a full search unless we got a
 537                  * callback error */
 538                 if ( ! ctx->callback_failed && ret != LDB_SUCCESS) {
 539                         /* Not indexed, so we need to do a full scan */
 540                         ret = ltdb_search_full(ctx);
 541                         if (ret != LDB_SUCCESS) {
 542                                 ldb_set_errstring(module->ldb, "Indexed and full searches both failed!\n");
 543                         }
 544                 }
 545         }
 546
 547         ltdb_unlock_read(module);
 548
 549         return ret;
 550 }
 551