source/lib/ldb/modules/asq.c

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Simo Sorce  2005
   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 2 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, write to the Free Software
  22    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23 */
  24
  25 /*
  26  *  Name: ldb
  27  *
  28  *  Component: ldb attribute scoped query control module
  29  *
  30  *  Description: this module searches all the the objects pointed
  31  *               by the DNs contained in the references attribute
  32  *
  33  *  Author: Simo Sorce
  34  */
  35
  36 #include "includes.h"
  37 #include "ldb/include/includes.h"
  38
  39 struct asq_context {
  40
  41         enum {ASQ_SEARCH_BASE, ASQ_SEARCH_MULTI} step;
  42
  43         struct ldb_module *module;
  44         void *up_context;
  45         int (*up_callback)(struct ldb_context *, void *, struct ldb_reply *);
  46
  47         const char * const *req_attrs;
  48         char *req_attribute;
  49         enum {
  50                 ASQ_CTRL_SUCCESS                        = 0,
  51                 ASQ_CTRL_INVALID_ATTRIBUTE_SYNTAX       = 21,
  52                 ASQ_CTRL_UNWILLING_TO_PERFORM           = 53,
  53                 ASQ_CTRL_AFFECTS_MULTIPLE_DSA           = 71
  54         } asq_ret;
  55
  56         struct ldb_request *base_req;
  57         struct ldb_reply *base_res;
  58
  59         struct ldb_request **reqs;
  60         int num_reqs;
  61         int cur_req;
  62
  63         struct ldb_control **controls;
  64 };
  65
  66 static struct ldb_handle *init_handle(void *mem_ctx, struct ldb_module *module,
  67                                             void *context,
  68                                             int (*callback)(struct ldb_context *, void *, struct ldb_reply *))
  69 {
  70         struct asq_context *ac;
  71         struct ldb_handle *h;
  72
  73         h = talloc_zero(mem_ctx, struct ldb_handle);
  74         if (h == NULL) {
  75                 ldb_set_errstring(module->ldb, "Out of Memory");
  76                 return NULL;
  77         }
  78
  79         h->module = module;
  80
  81         ac = talloc_zero(h, struct asq_context);
  82         if (ac == NULL) {
  83                 ldb_set_errstring(module->ldb, "Out of Memory");
  84                 talloc_free(h);
  85                 return NULL;
  86         }
  87
  88         h->private_data = (void *)ac;
  89
  90         h->state = LDB_ASYNC_INIT;
  91         h->status = LDB_SUCCESS;
  92
  93         ac->module = module;
  94         ac->up_context = context;
  95         ac->up_callback = callback;
  96
  97         return h;
  98 }
  99
 100 static int asq_terminate(struct ldb_handle *handle)
 101 {
 102         struct asq_context *ac;
 103         struct ldb_reply *ares;
 104         struct ldb_asq_control *asq;
 105         int i;
 106
 107         ac = talloc_get_type(handle->private_data, struct asq_context);
 108         if (ac == NULL) {
 109                 return LDB_ERR_OPERATIONS_ERROR;
 110         }
 111
 112         handle->status = LDB_SUCCESS;
 113         handle->state = LDB_ASYNC_DONE;
 114
 115         ares = talloc_zero(ac, struct ldb_reply);
 116         if (ares == NULL)
 117                 return LDB_ERR_OPERATIONS_ERROR;
 118
 119         ares->type = LDB_REPLY_DONE;
 120
 121         if (ac->controls) {
 122                 for (i = 0; ac->controls[i]; i++);
 123                 ares->controls = talloc_move(ares, &ac->controls);
 124         } else {
 125                 i = 0;
 126         }
 127
 128         ares->controls = talloc_realloc(ares, ares->controls, struct ldb_control *, i + 2);
 129
 130         if (ares->controls == NULL)
 131                 return LDB_ERR_OPERATIONS_ERROR;
 132
 133         ares->controls[i] = talloc(ares->controls, struct ldb_control);
 134         if (ares->controls[i] == NULL)
 135                 return LDB_ERR_OPERATIONS_ERROR;
 136
 137         ares->controls[i]->oid = LDB_CONTROL_ASQ_OID;
 138         ares->controls[i]->critical = 0;
 139
 140         asq = talloc_zero(ares->controls[i], struct ldb_asq_control);
 141         if (asq == NULL)
 142                 return LDB_ERR_OPERATIONS_ERROR;
 143
 144         asq->result = ac->asq_ret;
 145
 146         ares->controls[i]->data = asq;
 147
 148         ares->controls[i + 1] = NULL;
 149
 150         ac->up_callback(ac->module->ldb, ac->up_context, ares);
 151
 152         return LDB_SUCCESS;
 153 }
 154
 155 static int asq_base_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
 156 {
 157         struct asq_context *ac;
 158
 159         if (!context || !ares) {
 160                 ldb_set_errstring(ldb, "NULL Context or Result in callback");
 161                 goto error;
 162         }
 163
 164         ac = talloc_get_type(context, struct asq_context);
 165         if (ac == NULL) {
 166                 goto error;
 167         }
 168
 169         /* we are interested only in the single reply (base search) we receive here */
 170         if (ares->type == LDB_REPLY_ENTRY) {
 171                 ac->base_res = talloc_move(ac, &ares);
 172         } else {
 173                 talloc_free(ares);
 174         }
 175
 176         return LDB_SUCCESS;
 177 error:
 178         talloc_free(ares);
 179         return LDB_ERR_OPERATIONS_ERROR;
 180 }
 181
 182 static int asq_reqs_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
 183 {
 184         struct asq_context *ac;
 185
 186         if (!context || !ares) {
 187                 ldb_set_errstring(ldb, "NULL Context or Result in callback");
 188                 goto error;
 189         }
 190
 191         ac = talloc_get_type(context, struct asq_context);
 192         if (ac == NULL) {
 193                 goto error;
 194         }
 195
 196         /* we are interested only in the single reply (base search) we receive here */
 197         if (ares->type == LDB_REPLY_ENTRY) {
 198
 199                 /* pass the message up to the original callback as we
 200                  * do not have to elaborate on it any further */
 201                 return ac->up_callback(ac->module->ldb, ac->up_context, ares);
 202
 203         } else { /* ignore any REFERRAL or DONE reply */
 204                 talloc_free(ares);
 205         }
 206
 207         return LDB_SUCCESS;
 208 error:
 209         talloc_free(ares);
 210         return LDB_ERR_OPERATIONS_ERROR;
 211 }
 212
 213 static int asq_search(struct ldb_module *module, struct ldb_request *req)
 214 {
 215         struct ldb_control *control;
 216         struct ldb_asq_control *asq_ctrl;
 217         struct asq_context *ac;
 218         struct ldb_handle *h;
 219         char **base_attrs;
 220         int ret;
 221
 222         /* check if there's a paged request control */
 223         control = get_control_from_list(req->controls, LDB_CONTROL_ASQ_OID);
 224         if (control == NULL) {
 225                 /* not found go on */
 226                 return ldb_next_request(module, req);
 227         }
 228
 229         req->handle = NULL;
 230
 231         if (!req->callback || !req->context) {
 232                 ldb_set_errstring(module->ldb,
 233                                   "Async interface called with NULL callback function or NULL context");
 234                 return LDB_ERR_OPERATIONS_ERROR;
 235         }
 236
 237         asq_ctrl = talloc_get_type(control->data, struct ldb_asq_control);
 238         if (!asq_ctrl) {
 239                 return LDB_ERR_PROTOCOL_ERROR;
 240         }
 241
 242         h = init_handle(req, module, req->context, req->callback);
 243         if (!h) {
 244                 return LDB_ERR_OPERATIONS_ERROR;
 245         }
 246         ac = talloc_get_type(h->private_data, struct asq_context);
 247
 248         req->handle = h;
 249
 250         /* check the search is well formed */
 251         if (req->op.search.scope != LDB_SCOPE_BASE) {
 252                 ac->asq_ret = ASQ_CTRL_UNWILLING_TO_PERFORM;
 253                 return asq_terminate(h);
 254         }
 255
 256         ac->req_attrs = req->op.search.attrs;
 257         ac->req_attribute = talloc_strdup(ac, asq_ctrl->source_attribute);
 258         if (ac->req_attribute == NULL)
 259                 return LDB_ERR_OPERATIONS_ERROR;
 260
 261         /* get the object to retrieve the DNs to search */
 262         ac->base_req = talloc_zero(req, struct ldb_request);
 263         if (ac->base_req == NULL)
 264                 return LDB_ERR_OPERATIONS_ERROR;
 265         ac->base_req->operation = req->operation;
 266         ac->base_req->op.search.base = req->op.search.base;
 267         ac->base_req->op.search.scope = LDB_SCOPE_BASE;
 268         ac->base_req->op.search.tree = req->op.search.tree;
 269         base_attrs = talloc_array(ac->base_req, char *, 2);
 270         if (base_attrs == NULL)
 271                 return LDB_ERR_OPERATIONS_ERROR;
 272         base_attrs[0] = talloc_strdup(base_attrs, asq_ctrl->source_attribute);
 273         if (base_attrs[0] == NULL)
 274                 return LDB_ERR_OPERATIONS_ERROR;
 275         base_attrs[1] = NULL;
 276         ac->base_req->op.search.attrs = (const char * const *)base_attrs;
 277
 278         ac->base_req->context = ac;
 279         ac->base_req->callback = asq_base_callback;
 280         ldb_set_timeout_from_prev_req(module->ldb, req, ac->base_req);
 281
 282         ac->step = ASQ_SEARCH_BASE;
 283
 284         ret = ldb_request(module->ldb, ac->base_req);
 285
 286         if (ret != LDB_SUCCESS) {
 287                 return ret;
 288         }
 289
 290         return LDB_SUCCESS;
 291 }
 292
 293 static int asq_requests(struct ldb_handle *handle) {
 294         struct asq_context *ac;
 295         struct ldb_message_element *el;
 296         int i;
 297
 298         ac = talloc_get_type(handle->private_data, struct asq_context);
 299         if (ac == NULL) {
 300                 return LDB_ERR_OPERATIONS_ERROR;
 301         }
 302
 303         /* look up the DNs */
 304         if (ac->base_res == NULL) {
 305                 return LDB_ERR_NO_SUCH_OBJECT;
 306         }
 307         el = ldb_msg_find_element(ac->base_res->message, ac->req_attribute);
 308         /* no values found */
 309         if (el == NULL) {
 310                 ac->asq_ret = ASQ_CTRL_SUCCESS;
 311                 return asq_terminate(handle);
 312         }
 313
 314         /* build up the requests call chain */
 315         ac->num_reqs = el->num_values;
 316         ac->cur_req = 0;
 317         ac->reqs = talloc_array(ac, struct ldb_request *, ac->num_reqs);
 318         if (ac->reqs == NULL) {
 319                 return LDB_ERR_OPERATIONS_ERROR;
 320         }
 321
 322         for (i = 0; i < el->num_values; i++) {
 323
 324                 ac->reqs[i] = talloc_zero(ac->reqs, struct ldb_request);
 325                 if (ac->reqs[i] == NULL)
 326                         return LDB_ERR_OPERATIONS_ERROR;
 327                 ac->reqs[i]->operation = LDB_SEARCH;
 328                 ac->reqs[i]->op.search.base = ldb_dn_new(ac->reqs[i], ac->module->ldb, (const char *)el->values[i].data);
 329                 if ( ! ldb_dn_validate(ac->reqs[i]->op.search.base)) {
 330                         ac->asq_ret = ASQ_CTRL_INVALID_ATTRIBUTE_SYNTAX;
 331                         return asq_terminate(handle);
 332                 }
 333                 ac->reqs[i]->op.search.scope = LDB_SCOPE_BASE;
 334                 ac->reqs[i]->op.search.tree = ac->base_req->op.search.tree;
 335                 ac->reqs[i]->op.search.attrs = ac->req_attrs;
 336
 337                 ac->reqs[i]->context = ac;
 338                 ac->reqs[i]->callback = asq_reqs_callback;
 339                 ldb_set_timeout_from_prev_req(ac->module->ldb, ac->base_req, ac->reqs[i]);
 340         }
 341
 342         ac->step = ASQ_SEARCH_MULTI;
 343
 344         return LDB_SUCCESS;
 345 }
 346
 347 static int asq_wait_none(struct ldb_handle *handle)
 348 {
 349         struct asq_context *ac;
 350         int ret;
 351
 352         if (!handle || !handle->private_data) {
 353                 return LDB_ERR_OPERATIONS_ERROR;
 354         }
 355
 356         if (handle->state == LDB_ASYNC_DONE) {
 357                 return handle->status;
 358         }
 359
 360         handle->state = LDB_ASYNC_PENDING;
 361         handle->status = LDB_SUCCESS;
 362
 363         ac = talloc_get_type(handle->private_data, struct asq_context);
 364         if (ac == NULL) {
 365                 return LDB_ERR_OPERATIONS_ERROR;
 366         }
 367
 368         switch (ac->step) {
 369         case ASQ_SEARCH_BASE:
 370                 ret = ldb_wait(ac->base_req->handle, LDB_WAIT_NONE);
 371
 372                 if (ret != LDB_SUCCESS) {
 373                         handle->status = ret;
 374                         goto done;
 375                 }
 376
 377                 if (ac->base_req->handle->status != LDB_SUCCESS) {
 378                         handle->status = ac->base_req->handle->status;
 379                         goto done;
 380                 }
 381                 if (ac->base_req->handle->state != LDB_ASYNC_DONE) {
 382                         return LDB_SUCCESS;
 383                 }
 384
 385                 ret = asq_requests(handle);
 386
 387                 /* no break nor return,
 388                  * the set of requests is performed in ASQ_SEARCH_MULTI
 389                  */
 390
 391         case ASQ_SEARCH_MULTI:
 392
 393                 if (ac->reqs[ac->cur_req]->handle == NULL) {
 394                         ret = ldb_request(ac->module->ldb, ac->reqs[ac->cur_req]);
 395                         if (ret != LDB_SUCCESS) {
 396                                 return ret;
 397                         }
 398                 }
 399
 400                 ret = ldb_wait(ac->reqs[ac->cur_req]->handle, LDB_WAIT_NONE);
 401
 402                 if (ret != LDB_SUCCESS) {
 403                         handle->status = ret;
 404                         goto done;
 405                 }
 406                 if (ac->reqs[ac->cur_req]->handle->status != LDB_SUCCESS) {
 407                         handle->status = ac->reqs[ac->cur_req]->handle->status;
 408                 }
 409
 410                 if (ac->reqs[ac->cur_req]->handle->state == LDB_ASYNC_DONE) {
 411                         ac->cur_req++;
 412                 }
 413
 414                 if (ac->cur_req < ac->num_reqs) {
 415                         return LDB_SUCCESS;
 416                 }
 417
 418                 return asq_terminate(handle);
 419
 420         default:
 421                 ret = LDB_ERR_OPERATIONS_ERROR;
 422                 goto done;
 423         }
 424
 425         ret = LDB_SUCCESS;
 426
 427 done:
 428         handle->state = LDB_ASYNC_DONE;
 429         return ret;
 430 }
 431
 432 static int asq_wait_all(struct ldb_handle *handle)
 433 {
 434         int ret;
 435
 436         while (handle->state != LDB_ASYNC_DONE) {
 437                 ret = asq_wait_none(handle);
 438                 if (ret != LDB_SUCCESS) {
 439                         return ret;
 440                 }
 441         }
 442
 443         return handle->status;
 444 }
 445
 446 static int asq_wait(struct ldb_handle *handle, enum ldb_wait_type type)
 447 {
 448         if (type == LDB_WAIT_ALL) {
 449                 return asq_wait_all(handle);
 450         } else {
 451                 return asq_wait_none(handle);
 452         }
 453 }
 454
 455 static int asq_init(struct ldb_module *module)
 456 {
 457         struct ldb_request *req;
 458         int ret;
 459
 460         req = talloc_zero(module, struct ldb_request);
 461         if (req == NULL) {
 462                 ldb_debug(module->ldb, LDB_DEBUG_ERROR, "asq: Out of memory!\n");
 463                 return LDB_ERR_OPERATIONS_ERROR;
 464         }
 465
 466         req->operation = LDB_REQ_REGISTER_CONTROL;
 467         req->op.reg_control.oid = LDB_CONTROL_ASQ_OID;
 468
 469         ret = ldb_request(module->ldb, req);
 470         if (ret != LDB_SUCCESS) {
 471                 ldb_debug(module->ldb, LDB_DEBUG_WARNING, "asq: Unable to register control with rootdse!\n");
 472         }
 473
 474         return ldb_next_init(module);
 475 }
 476
 477
 478 static const struct ldb_module_ops asq_ops = {
 479         .name              = "asq",
 480         .search            = asq_search,
 481         .wait              = asq_wait,
 482         .init_context      = asq_init
 483 };
 484
 485 int ldb_asq_init(void)
 486 {
 487         return ldb_register_module(&asq_ops);
 488 }