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         if (!(ac = talloc_get_type(context, struct asq_context))) {
 165                 goto error;
 166         }
 167
 168         /* we are interested only in the single reply (base search) we receive here */
 169         if (ares->type == LDB_REPLY_ENTRY) {
 170                 ac->base_res = talloc_move(ac, &ares);
 171         } else {
 172                 talloc_free(ares);
 173         }
 174
 175         return LDB_SUCCESS;
 176 error:
 177         talloc_free(ares);
 178         return LDB_ERR_OPERATIONS_ERROR;
 179 }
 180
 181 static int asq_reqs_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
 182 {
 183         struct asq_context *ac;
 184
 185         if (!context || !ares) {
 186                 ldb_set_errstring(ldb, "NULL Context or Result in callback");
 187                 goto error;
 188         }
 189
 190         if (!(ac = talloc_get_type(context, struct asq_context))) {
 191                 goto error;
 192         }
 193
 194         /* we are interested only in the single reply (base search) we receive here */
 195         if (ares->type == LDB_REPLY_ENTRY) {
 196
 197                 /* pass the message up to the original callback as we
 198                  * do not have to elaborate on it any further */
 199                 return ac->up_callback(ac->module->ldb, ac->up_context, ares);
 200
 201         } else { /* ignore any REFERRAL or DONE reply */
 202                 talloc_free(ares);
 203         }
 204
 205         return LDB_SUCCESS;
 206 error:
 207         talloc_free(ares);
 208         return LDB_ERR_OPERATIONS_ERROR;
 209 }
 210
 211 static int asq_search(struct ldb_module *module, struct ldb_request *req)
 212 {
 213         struct ldb_control *control;
 214         struct ldb_asq_control *asq_ctrl;
 215         struct asq_context *ac;
 216         struct ldb_handle *h;
 217         char **base_attrs;
 218         int ret;
 219
 220         /* check if there's a paged request control */
 221         control = get_control_from_list(req->controls, LDB_CONTROL_ASQ_OID);
 222         if (control == NULL) {
 223                 /* not found go on */
 224                 return ldb_next_request(module, req);
 225         }
 226
 227         req->handle = NULL;
 228
 229         if (!req->callback || !req->context) {
 230                 ldb_set_errstring(module->ldb,
 231                                   "Async interface called with NULL callback function or NULL context");
 232                 return LDB_ERR_OPERATIONS_ERROR;
 233         }
 234
 235         asq_ctrl = talloc_get_type(control->data, struct ldb_asq_control);
 236         if (!asq_ctrl) {
 237                 return LDB_ERR_PROTOCOL_ERROR;
 238         }
 239
 240         h = init_handle(req, module, req->context, req->callback);
 241         if (!h) {
 242                 return LDB_ERR_OPERATIONS_ERROR;
 243         }
 244         if (!(ac = talloc_get_type(h->private_data, struct asq_context))) {
 245
 246                 return LDB_ERR_OPERATIONS_ERROR;
 247         }
 248
 249         req->handle = h;
 250
 251         /* check the search is well formed */
 252         if (req->op.search.scope != LDB_SCOPE_BASE) {
 253                 ac->asq_ret = ASQ_CTRL_UNWILLING_TO_PERFORM;
 254                 return asq_terminate(h);
 255         }
 256
 257         ac->req_attrs = req->op.search.attrs;
 258         ac->req_attribute = talloc_strdup(ac, asq_ctrl->source_attribute);
 259         if (ac->req_attribute == NULL)
 260                 return LDB_ERR_OPERATIONS_ERROR;
 261
 262         /* get the object to retrieve the DNs to search */
 263         ac->base_req = talloc_zero(req, struct ldb_request);
 264         if (ac->base_req == NULL)
 265                 return LDB_ERR_OPERATIONS_ERROR;
 266         ac->base_req->operation = req->operation;
 267         ac->base_req->op.search.base = req->op.search.base;
 268         ac->base_req->op.search.scope = LDB_SCOPE_BASE;
 269         ac->base_req->op.search.tree = req->op.search.tree;
 270         base_attrs = talloc_array(ac->base_req, char *, 2);
 271         if (base_attrs == NULL)
 272                 return LDB_ERR_OPERATIONS_ERROR;
 273         base_attrs[0] = talloc_strdup(base_attrs, asq_ctrl->source_attribute);
 274         if (base_attrs[0] == NULL)
 275                 return LDB_ERR_OPERATIONS_ERROR;
 276         base_attrs[1] = NULL;
 277         ac->base_req->op.search.attrs = (const char * const *)base_attrs;
 278
 279         ac->base_req->context = ac;
 280         ac->base_req->callback = asq_base_callback;
 281         ldb_set_timeout_from_prev_req(module->ldb, req, ac->base_req);
 282
 283         ac->step = ASQ_SEARCH_BASE;
 284
 285         ret = ldb_request(module->ldb, ac->base_req);
 286
 287         if (ret != LDB_SUCCESS) {
 288                 return ret;
 289         }
 290
 291         return LDB_SUCCESS;
 292 }
 293
 294 static int asq_requests(struct ldb_handle *handle) {
 295         struct asq_context *ac;
 296         struct ldb_message_element *el;
 297         int i;
 298
 299         if (!(ac = talloc_get_type(handle->private_data,
 300                                    struct asq_context))) {
 301                 return LDB_ERR_OPERATIONS_ERROR;
 302         }
 303
 304         /* look up the DNs */
 305         if (ac->base_res == NULL) {
 306                 return LDB_ERR_NO_SUCH_OBJECT;
 307         }
 308         el = ldb_msg_find_element(ac->base_res->message, ac->req_attribute);
 309         /* no values found */
 310         if (el == NULL) {
 311                 ac->asq_ret = ASQ_CTRL_SUCCESS;
 312                 return asq_terminate(handle);
 313         }
 314
 315         /* build up the requests call chain */
 316         ac->num_reqs = el->num_values;
 317         ac->cur_req = 0;
 318         ac->reqs = talloc_array(ac, struct ldb_request *, ac->num_reqs);
 319         if (ac->reqs == NULL) {
 320                 return LDB_ERR_OPERATIONS_ERROR;
 321         }
 322
 323         for (i = 0; i < el->num_values; i++) {
 324
 325                 ac->reqs[i] = talloc_zero(ac->reqs, struct ldb_request);
 326                 if (ac->reqs[i] == NULL)
 327                         return LDB_ERR_OPERATIONS_ERROR;
 328                 ac->reqs[i]->operation = LDB_SEARCH;
 329                 ac->reqs[i]->op.search.base = ldb_dn_explode(ac->reqs[i], (const char *)el->values[i].data);
 330                 if (ac->reqs[i]->op.search.base == NULL) {
 331                         ac->asq_ret = ASQ_CTRL_INVALID_ATTRIBUTE_SYNTAX;
 332                         return asq_terminate(handle);
 333                 }
 334                 ac->reqs[i]->op.search.scope = LDB_SCOPE_BASE;
 335                 ac->reqs[i]->op.search.tree = ac->base_req->op.search.tree;
 336                 ac->reqs[i]->op.search.attrs = ac->req_attrs;
 337
 338                 ac->reqs[i]->context = ac;
 339                 ac->reqs[i]->callback = asq_reqs_callback;
 340                 ldb_set_timeout_from_prev_req(ac->module->ldb, ac->base_req, ac->reqs[i]);
 341         }
 342
 343         ac->step = ASQ_SEARCH_MULTI;
 344
 345         return LDB_SUCCESS;
 346 }
 347
 348 static int asq_wait_none(struct ldb_handle *handle)
 349 {
 350         struct asq_context *ac;
 351         int ret;
 352
 353         if (!handle || !handle->private_data) {
 354                 return LDB_ERR_OPERATIONS_ERROR;
 355         }
 356
 357         if (handle->state == LDB_ASYNC_DONE) {
 358                 return handle->status;
 359         }
 360
 361         handle->state = LDB_ASYNC_PENDING;
 362         handle->status = LDB_SUCCESS;
 363
 364         if (!(ac = talloc_get_type(handle->private_data,
 365                                    struct asq_context))) {
 366                 return LDB_ERR_OPERATIONS_ERROR;
 367         }
 368
 369         switch (ac->step) {
 370         case ASQ_SEARCH_BASE:
 371                 ret = ldb_wait(ac->base_req->handle, LDB_WAIT_NONE);
 372
 373                 if (ret != LDB_SUCCESS) {
 374                         handle->status = ret;
 375                         goto done;
 376                 }
 377
 378                 if (ac->base_req->handle->status != LDB_SUCCESS) {
 379                         handle->status = ac->base_req->handle->status;
 380                         goto done;
 381                 }
 382                 if (ac->base_req->handle->state != LDB_ASYNC_DONE) {
 383                         return LDB_SUCCESS;
 384                 }
 385
 386                 ret = asq_requests(handle);
 387
 388                 /* no break nor return,
 389                  * the set of requests is performed in ASQ_SEARCH_MULTI
 390                  */
 391
 392         case ASQ_SEARCH_MULTI:
 393
 394                 if (ac->reqs[ac->cur_req]->handle == NULL) {
 395                         ret = ldb_request(ac->module->ldb, ac->reqs[ac->cur_req]);
 396                         if (ret != LDB_SUCCESS) {
 397                                 return ret;
 398                         }
 399                 }
 400
 401                 ret = ldb_wait(ac->reqs[ac->cur_req]->handle, LDB_WAIT_NONE);
 402
 403                 if (ret != LDB_SUCCESS) {
 404                         handle->status = ret;
 405                         goto done;
 406                 }
 407                 if (ac->reqs[ac->cur_req]->handle->status != LDB_SUCCESS) {
 408                         handle->status = ac->reqs[ac->cur_req]->handle->status;
 409                 }
 410
 411                 if (ac->reqs[ac->cur_req]->handle->state == LDB_ASYNC_DONE) {
 412                         ac->cur_req++;
 413                 }
 414
 415                 if (ac->cur_req < ac->num_reqs) {
 416                         return LDB_SUCCESS;
 417                 }
 418
 419                 return asq_terminate(handle);
 420
 421         default:
 422                 ret = LDB_ERR_OPERATIONS_ERROR;
 423                 goto done;
 424         }
 425
 426         ret = LDB_SUCCESS;
 427
 428 done:
 429         handle->state = LDB_ASYNC_DONE;
 430         return ret;
 431 }
 432
 433 static int asq_wait_all(struct ldb_handle *handle)
 434 {
 435         int ret;
 436
 437         while (handle->state != LDB_ASYNC_DONE) {
 438                 ret = asq_wait_none(handle);
 439                 if (ret != LDB_SUCCESS) {
 440                         return ret;
 441                 }
 442         }
 443
 444         return handle->status;
 445 }
 446
 447 static int asq_wait(struct ldb_handle *handle, enum ldb_wait_type type)
 448 {
 449         if (type == LDB_WAIT_ALL) {
 450                 return asq_wait_all(handle);
 451         } else {
 452                 return asq_wait_none(handle);
 453         }
 454 }
 455
 456 static int asq_init(struct ldb_module *module)
 457 {
 458         struct ldb_request *req;
 459         int ret;
 460
 461         req = talloc_zero(module, struct ldb_request);
 462         if (req == NULL) {
 463                 ldb_debug(module->ldb, LDB_DEBUG_ERROR, "asq: Out of memory!\n");
 464                 return LDB_ERR_OPERATIONS_ERROR;
 465         }
 466
 467         req->operation = LDB_REQ_REGISTER_CONTROL;
 468         req->op.reg_control.oid = LDB_CONTROL_ASQ_OID;
 469
 470         ret = ldb_request(module->ldb, req);
 471         if (ret != LDB_SUCCESS) {
 472                 ldb_debug(module->ldb, LDB_DEBUG_WARNING, "asq: Unable to register control with rootdse!\n");
 473         }
 474
 475         return ldb_next_init(module);
 476 }
 477
 478
 479 static const struct ldb_module_ops asq_ops = {
 480         .name              = "asq",
 481         .search            = asq_search,
 482         .wait              = asq_wait,
 483         .init_context      = asq_init
 484 };
 485
 486 int ldb_asq_init(void)
 487 {
 488         return ldb_register_module(&asq_ops);
 489 }