source3/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         ac = talloc_get_type(h->private_data, struct asq_context);
 245
 246         req->handle = h;
 247
 248         /* check the search is well formed */
 249         if (req->op.search.scope != LDB_SCOPE_BASE) {
 250                 ac->asq_ret = ASQ_CTRL_UNWILLING_TO_PERFORM;
 251                 return asq_terminate(h);
 252         }
 253
 254         ac->req_attrs = req->op.search.attrs;
 255         ac->req_attribute = talloc_strdup(ac, asq_ctrl->source_attribute);
 256         if (ac->req_attribute == NULL)
 257                 return LDB_ERR_OPERATIONS_ERROR;
 258
 259         /* get the object to retrieve the DNs to search */
 260         ac->base_req = talloc_zero(req, struct ldb_request);
 261         if (ac->base_req == NULL)
 262                 return LDB_ERR_OPERATIONS_ERROR;
 263         ac->base_req->operation = req->operation;
 264         ac->base_req->op.search.base = req->op.search.base;
 265         ac->base_req->op.search.scope = LDB_SCOPE_BASE;
 266         ac->base_req->op.search.tree = req->op.search.tree;
 267         base_attrs = talloc_array(ac->base_req, char *, 2);
 268         if (base_attrs == NULL)
 269                 return LDB_ERR_OPERATIONS_ERROR;
 270         base_attrs[0] = talloc_strdup(base_attrs, asq_ctrl->source_attribute);
 271         if (base_attrs[0] == NULL)
 272                 return LDB_ERR_OPERATIONS_ERROR;
 273         base_attrs[1] = NULL;
 274         ac->base_req->op.search.attrs = (const char * const *)base_attrs;
 275
 276         ac->base_req->context = ac;
 277         ac->base_req->callback = asq_base_callback;
 278         ldb_set_timeout_from_prev_req(module->ldb, req, ac->base_req);
 279
 280         ac->step = ASQ_SEARCH_BASE;
 281
 282         ret = ldb_request(module->ldb, ac->base_req);
 283
 284         if (ret != LDB_SUCCESS) {
 285                 return ret;
 286         }
 287
 288         return LDB_SUCCESS;
 289 }
 290
 291 static int asq_requests(struct ldb_handle *handle) {
 292         struct asq_context *ac;
 293         struct ldb_message_element *el;
 294         int i;
 295
 296         ac = talloc_get_type(handle->private_data, struct asq_context);
 297
 298         /* look up the DNs */
 299         if (ac->base_res == NULL) {
 300                 return LDB_ERR_NO_SUCH_OBJECT;
 301         }
 302         el = ldb_msg_find_element(ac->base_res->message, ac->req_attribute);
 303         /* no values found */
 304         if (el == NULL) {
 305                 ac->asq_ret = ASQ_CTRL_SUCCESS;
 306                 return asq_terminate(handle);
 307         }
 308
 309         /* build up the requests call chain */
 310         ac->num_reqs = el->num_values;
 311         ac->cur_req = 0;
 312         ac->reqs = talloc_array(ac, struct ldb_request *, ac->num_reqs);
 313         if (ac->reqs == NULL) {
 314                 return LDB_ERR_OPERATIONS_ERROR;
 315         }
 316
 317         for (i = 0; i < el->num_values; i++) {
 318
 319                 ac->reqs[i] = talloc_zero(ac->reqs, struct ldb_request);
 320                 if (ac->reqs[i] == NULL)
 321                         return LDB_ERR_OPERATIONS_ERROR;
 322                 ac->reqs[i]->operation = LDB_SEARCH;
 323                 ac->reqs[i]->op.search.base = ldb_dn_explode(ac->reqs[i], (const char *)el->values[i].data);
 324                 if (ac->reqs[i]->op.search.base == NULL) {
 325                         ac->asq_ret = ASQ_CTRL_INVALID_ATTRIBUTE_SYNTAX;
 326                         return asq_terminate(handle);
 327                 }
 328                 ac->reqs[i]->op.search.scope = LDB_SCOPE_BASE;
 329                 ac->reqs[i]->op.search.tree = ac->base_req->op.search.tree;
 330                 ac->reqs[i]->op.search.attrs = ac->req_attrs;
 331
 332                 ac->reqs[i]->context = ac;
 333                 ac->reqs[i]->callback = asq_reqs_callback;
 334                 ldb_set_timeout_from_prev_req(ac->module->ldb, ac->base_req, ac->reqs[i]);
 335         }
 336
 337         ac->step = ASQ_SEARCH_MULTI;
 338
 339         return LDB_SUCCESS;
 340 }
 341
 342 static int asq_wait_none(struct ldb_handle *handle)
 343 {
 344         struct asq_context *ac;
 345         int ret;
 346
 347         if (!handle || !handle->private_data) {
 348                 return LDB_ERR_OPERATIONS_ERROR;
 349         }
 350
 351         if (handle->state == LDB_ASYNC_DONE) {
 352                 return handle->status;
 353         }
 354
 355         handle->state = LDB_ASYNC_PENDING;
 356         handle->status = LDB_SUCCESS;
 357
 358         ac = talloc_get_type(handle->private_data, struct asq_context);
 359
 360
 361         switch (ac->step) {
 362         case ASQ_SEARCH_BASE:
 363                 ret = ldb_wait(ac->base_req->handle, LDB_WAIT_NONE);
 364
 365                 if (ret != LDB_SUCCESS) {
 366                         handle->status = ret;
 367                         goto done;
 368                 }
 369
 370                 if (ac->base_req->handle->status != LDB_SUCCESS) {
 371                         handle->status = ac->base_req->handle->status;
 372                         goto done;
 373                 }
 374                 if (ac->base_req->handle->state != LDB_ASYNC_DONE) {
 375                         return LDB_SUCCESS;
 376                 }
 377
 378                 ret = asq_requests(handle);
 379
 380                 /* no break nor return,
 381                  * the set of requests is performed in ASQ_SEARCH_MULTI
 382                  */
 383
 384         case ASQ_SEARCH_MULTI:
 385
 386                 if (ac->reqs[ac->cur_req]->handle == NULL) {
 387                         ret = ldb_request(ac->module->ldb, ac->reqs[ac->cur_req]);
 388                         if (ret != LDB_SUCCESS) {
 389                                 return ret;
 390                         }
 391                 }
 392
 393                 ret = ldb_wait(ac->reqs[ac->cur_req]->handle, LDB_WAIT_NONE);
 394
 395                 if (ret != LDB_SUCCESS) {
 396                         handle->status = ret;
 397                         goto done;
 398                 }
 399                 if (ac->reqs[ac->cur_req]->handle->status != LDB_SUCCESS) {
 400                         handle->status = ac->reqs[ac->cur_req]->handle->status;
 401                 }
 402
 403                 if (ac->reqs[ac->cur_req]->handle->state == LDB_ASYNC_DONE) {
 404                         ac->cur_req++;
 405                 }
 406
 407                 if (ac->cur_req < ac->num_reqs) {
 408                         return LDB_SUCCESS;
 409                 }
 410
 411                 return asq_terminate(handle);
 412
 413         default:
 414                 ret = LDB_ERR_OPERATIONS_ERROR;
 415                 goto done;
 416         }
 417
 418         ret = LDB_SUCCESS;
 419
 420 done:
 421         handle->state = LDB_ASYNC_DONE;
 422         return ret;
 423 }
 424
 425 static int asq_wait_all(struct ldb_handle *handle)
 426 {
 427         int ret;
 428
 429         while (handle->state != LDB_ASYNC_DONE) {
 430                 ret = asq_wait_none(handle);
 431                 if (ret != LDB_SUCCESS) {
 432                         return ret;
 433                 }
 434         }
 435
 436         return handle->status;
 437 }
 438
 439 static int asq_wait(struct ldb_handle *handle, enum ldb_wait_type type)
 440 {
 441         if (type == LDB_WAIT_ALL) {
 442                 return asq_wait_all(handle);
 443         } else {
 444                 return asq_wait_none(handle);
 445         }
 446 }
 447
 448 static int asq_init(struct ldb_module *module)
 449 {
 450         struct ldb_request *req;
 451         int ret;
 452
 453         req = talloc_zero(module, struct ldb_request);
 454         if (req == NULL) {
 455                 ldb_debug(module->ldb, LDB_DEBUG_ERROR, "asq: Out of memory!\n");
 456                 return LDB_ERR_OPERATIONS_ERROR;
 457         }
 458
 459         req->operation = LDB_REQ_REGISTER_CONTROL;
 460         req->op.reg_control.oid = LDB_CONTROL_ASQ_OID;
 461
 462         ret = ldb_request(module->ldb, req);
 463         if (ret != LDB_SUCCESS) {
 464                 ldb_debug(module->ldb, LDB_DEBUG_WARNING, "asq: Unable to register control with rootdse!\n");
 465         }
 466
 467         return ldb_next_init(module);
 468 }
 469
 470
 471 static const struct ldb_module_ops asq_ops = {
 472         .name              = "asq",
 473         .search            = asq_search,
 474         .wait              = asq_wait,
 475         .init_context      = asq_init
 476 };
 477
 478 int ldb_asq_init(void)
 479 {
 480         return ldb_register_module(&asq_ops);
 481 }