lib/ldb/common/ldb_controls.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 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_controls.c
  26  *
  27  *  Component: ldb controls utility functions
  28  *
  29  *  Description: helper functions for control modules
  30  *
  31  *  Author: Simo Sorce
  32  */
  33
  34 #include "ldb_private.h"
  35
  36 /* check if a control with the specified "oid" exist and return it */
  37 /* returns NULL if not found */
  38 struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid)
  39 {
  40         unsigned int i;
  41
  42         if (req->controls != NULL) {
  43                 for (i = 0; req->controls[i]; i++) {
  44                         if (req->controls[i]->oid && strcmp(oid, req->controls[i]->oid) == 0) {
  45                                 break;
  46                         }
  47                 }
  48
  49                 return req->controls[i];
  50         }
  51
  52         return NULL;
  53 }
  54
  55 /* check if a control with the specified "oid" exist and return it */
  56 /* returns NULL if not found */
  57 struct ldb_control *ldb_reply_get_control(struct ldb_reply *rep, const char *oid)
  58 {
  59         unsigned int i;
  60
  61         if (rep->controls != NULL) {
  62                 for (i = 0; rep->controls[i]; i++) {
  63                         if (rep->controls[i]->oid && strcmp(oid, rep->controls[i]->oid) == 0) {
  64                                 break;
  65                         }
  66                 }
  67
  68                 return rep->controls[i];
  69         }
  70
  71         return NULL;
  72 }
  73
  74 /*
  75  * Saves the current controls list into the "saver" (can also be NULL) and
  76  * replace the one in "req" with a new one excluding the "exclude" control
  77  * (if it is NULL then the list remains the same)
  78  *
  79  * Returns 0 on error.
  80  */
  81 int ldb_save_controls(struct ldb_control *exclude, struct ldb_request *req, struct ldb_control ***saver)
  82 {
  83         struct ldb_control **lcs, **lcs_old;
  84         unsigned int i, j;
  85
  86         lcs_old = req->controls;
  87         if (saver != NULL) {
  88                 *saver = lcs_old;
  89         }
  90
  91         for (i = 0; req->controls && req->controls[i]; i++);
  92         if (i == 0) {
  93                 req->controls = NULL;
  94                 return 1;
  95         }
  96
  97         lcs = talloc_array(req, struct ldb_control *, i + 1);
  98         if (!lcs) {
  99                 return 0;
 100         }
 101
 102         for (i = 0, j = 0; lcs_old[i]; i++) {
 103                 if (exclude == lcs_old[i]) continue;
 104                 lcs[j] = lcs_old[i];
 105                 j++;
 106         }
 107         lcs[j] = NULL;
 108
 109         req->controls = talloc_realloc(req, lcs, struct ldb_control *, j + 1);
 110         if (req->controls == NULL) {
 111                 return 0;
 112         }
 113         return 1;
 114 }
 115
 116 /*
 117  * Returns a list of controls, except the one specified with "exclude" (can
 118  * also be NULL).  Included controls become a child of returned list if they
 119  * were children of "controls_in".
 120  *
 121  * Returns NULL on error (OOM) or an empty control list.
 122  */
 123 struct ldb_control **ldb_controls_except_specified(struct ldb_control **controls_in,
 124                                                TALLOC_CTX *mem_ctx,
 125                                                struct ldb_control *exclude)
 126 {
 127         struct ldb_control **lcs = NULL;
 128         unsigned int i, j, n;
 129
 130         for (i = 0; controls_in && controls_in[i]; i++);
 131         if (i == 0) {
 132                 return NULL;
 133         }
 134         n = i;
 135
 136         for (i = 0, j = 0; controls_in && controls_in[i]; i++) {
 137                 if (exclude == controls_in[i]) continue;
 138
 139                 if (!lcs) {
 140                         /* Allocate here so if we remove the only
 141                          * control, or there were no controls, we
 142                          * don't allocate at all, and just return
 143                          * NULL */
 144                         lcs = talloc_array(mem_ctx, struct ldb_control *,
 145                                            n + 1);
 146                         if (!lcs) {
 147                                 return NULL;
 148                         }
 149                 }
 150
 151                 lcs[j] = controls_in[i];
 152                 talloc_reparent(controls_in, lcs, lcs[j]);
 153                 j++;
 154         }
 155         if (lcs) {
 156                 lcs[j] = NULL;
 157
 158                 lcs = talloc_realloc(mem_ctx, lcs, struct ldb_control *, j + 1);
 159         }
 160
 161         return lcs;
 162 }
 163
 164 /* check if there's any control marked as critical in the list */
 165 /* return True if any, False if none */
 166 int ldb_check_critical_controls(struct ldb_control **controls)
 167 {
 168         unsigned int i;
 169
 170         if (controls == NULL) {
 171                 return 0;
 172         }
 173
 174         for (i = 0; controls[i]; i++) {
 175                 if (controls[i]->critical) {
 176                         return 1;
 177                 }
 178         }
 179
 180         return 0;
 181 }
 182
 183 int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data)
 184 {
 185         unsigned int i, n;
 186         struct ldb_control **ctrls;
 187         struct ldb_control *ctrl;
 188
 189         for (n=0; req->controls && req->controls[n];n++) {
 190                 /* having two controls of the same OID makes no sense */
 191                 if (req->controls[n]->oid && strcmp(oid, req->controls[n]->oid) == 0) {
 192                         return LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS;
 193                 }
 194         }
 195
 196         ctrls = talloc_array(req,
 197                                struct ldb_control *,
 198                                n + 2);
 199         if (!ctrls) return LDB_ERR_OPERATIONS_ERROR;
 200
 201         for (i=0; i<n; i++) {
 202                 ctrls[i] = req->controls[i];
 203         }
 204
 205         req->controls = ctrls;
 206         ctrls[n] = NULL;
 207         ctrls[n+1] = NULL;
 208
 209         ctrl = talloc(ctrls, struct ldb_control);
 210         if (!ctrl) return LDB_ERR_OPERATIONS_ERROR;
 211
 212         ctrl->oid       = talloc_strdup(ctrl, oid);
 213         if (!ctrl->oid) return LDB_ERR_OPERATIONS_ERROR;
 214         ctrl->critical  = critical;
 215         ctrl->data      = data;
 216
 217         ctrls[n] = ctrl;
 218         return LDB_SUCCESS;
 219 }
 220
 221 int ldb_reply_add_control(struct ldb_reply *ares, const char *oid, bool critical, void *data)
 222 {
 223         unsigned n;
 224         struct ldb_control **ctrls;
 225         struct ldb_control *ctrl;
 226
 227         for (n=0; ares->controls && ares->controls[n];) {
 228                 /* having two controls of the same OID makes no sense */
 229                 if (ares->controls[n]->oid && strcmp(oid, ares->controls[n]->oid) == 0) {
 230                         return LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS;
 231                 }
 232                 n++;
 233         }
 234
 235         ctrls = talloc_realloc(ares, ares->controls,
 236                                struct ldb_control *,
 237                                n + 2);
 238         if (!ctrls) return LDB_ERR_OPERATIONS_ERROR;
 239         ares->controls = ctrls;
 240         ctrls[n] = NULL;
 241         ctrls[n+1] = NULL;
 242
 243         ctrl = talloc(ctrls, struct ldb_control);
 244         if (!ctrl) return LDB_ERR_OPERATIONS_ERROR;
 245
 246         ctrl->oid       = talloc_strdup(ctrl, oid);
 247         if (!ctrl->oid) return LDB_ERR_OPERATIONS_ERROR;
 248         ctrl->critical  = critical;
 249         ctrl->data      = data;
 250
 251         ctrls[n] = ctrl;
 252         return LDB_SUCCESS;
 253 }
 254
 255 /* Add a control to the request, replacing the old one if it is already in the request */
 256 int ldb_request_replace_control(struct ldb_request *req, const char *oid, bool critical, void *data)
 257 {
 258         unsigned int n;
 259         int ret;
 260
 261         ret = ldb_request_add_control(req, oid, critical, data);
 262         if (ret != LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS) {
 263                 return ret;
 264         }
 265
 266         for (n=0; req->controls[n];n++) {
 267                 if (req->controls[n]->oid && strcmp(oid, req->controls[n]->oid) == 0) {
 268                         req->controls[n]->critical = critical;
 269                         req->controls[n]->data = data;
 270                         return LDB_SUCCESS;
 271                 }
 272         }
 273
 274         return LDB_ERR_OPERATIONS_ERROR;
 275 }
 276
 277 /*
 278  * Return a control as string
 279  * the project (ie. name:value1:value2:...:valuen
 280  * The string didn't include the criticity of the critical flag
 281  */
 282 char *ldb_control_to_string(TALLOC_CTX *mem_ctx, const struct ldb_control *control)
 283 {
 284         char *res = NULL;
 285
 286         if (strcmp(control->oid, LDB_CONTROL_PAGED_RESULTS_OID) == 0) {
 287                 struct ldb_paged_control *rep_control = talloc_get_type(control->data, struct ldb_paged_control);
 288                 char *cookie;
 289
 290                 cookie = ldb_base64_encode(mem_ctx, rep_control->cookie, rep_control->cookie_len);
 291                 if (cookie == NULL) {
 292                         return NULL;
 293                 }
 294                 if (cookie[0] != '\0') {
 295                         res = talloc_asprintf(mem_ctx, "%s:%d:%s",
 296                                                 LDB_CONTROL_PAGED_RESULTS_NAME,
 297                                                 control->critical,
 298                                                 cookie);
 299
 300                         talloc_free(cookie);
 301                 } else {
 302                         res = talloc_asprintf(mem_ctx, "%s:%d",
 303                                                 LDB_CONTROL_PAGED_RESULTS_NAME,
 304                                                 control->critical);
 305                 }
 306                 return res;
 307         }
 308
 309         if (strcmp(control->oid, LDB_CONTROL_VLV_RESP_OID) == 0) {
 310                 struct ldb_vlv_resp_control *rep_control = talloc_get_type(control->data,
 311                                                                 struct ldb_vlv_resp_control);
 312
 313                 res = talloc_asprintf(mem_ctx, "%s:%d:%d:%d:%d:%d:%s",
 314                                                 LDB_CONTROL_VLV_RESP_NAME,
 315                                                 control->critical,
 316                                                 rep_control->targetPosition,
 317                                                 rep_control->contentCount,
 318                                                 rep_control->vlv_result,
 319                                                 rep_control->ctxid_len,
 320                                                 rep_control->contextId);
 321
 322                 return res;
 323         }
 324
 325         if (strcmp(control->oid, LDB_CONTROL_SORT_RESP_OID) == 0) {
 326                 struct ldb_sort_resp_control *rep_control = talloc_get_type(control->data,
 327                                                                 struct ldb_sort_resp_control);
 328
 329                 res = talloc_asprintf(mem_ctx, "%s:%d:%d:%s",
 330                                         LDB_CONTROL_SORT_RESP_NAME,
 331                                         control->critical,
 332                                         rep_control->result,
 333                                         rep_control->attr_desc);
 334
 335                 return res;
 336         }
 337
 338         if (strcmp(control->oid, LDB_CONTROL_ASQ_OID) == 0) {
 339                 struct ldb_asq_control *rep_control = talloc_get_type(control->data,
 340                                                                 struct ldb_asq_control);
 341
 342                 res = talloc_asprintf(mem_ctx, "%s:%d:%d",
 343                                         LDB_CONTROL_SORT_RESP_NAME,
 344                                         control->critical,
 345                                         rep_control->result);
 346
 347                 return res;
 348         }
 349
 350         if (strcmp(control->oid, LDB_CONTROL_DIRSYNC_OID) == 0) {
 351                 char *cookie;
 352                 struct ldb_dirsync_control *rep_control = talloc_get_type(control->data,
 353                                                                 struct ldb_dirsync_control);
 354
 355                 cookie = ldb_base64_encode(mem_ctx, rep_control->cookie,
 356                                 rep_control->cookie_len);
 357                 if (cookie == NULL) {
 358                         return NULL;
 359                 }
 360                 res = talloc_asprintf(mem_ctx, "%s:%d:%d:%d:%s",
 361                                         LDB_CONTROL_DIRSYNC_NAME,
 362                                         control->critical,
 363                                         rep_control->flags,
 364                                         rep_control->max_attributes,
 365                                         cookie);
 366
 367                 talloc_free(cookie);
 368                 return res;
 369         }
 370
 371         /*
 372          * From here we don't know the control
 373          */
 374         if (control->data == NULL) {
 375                 /*
 376                  * We don't know the control but there is no real data attached
 377                  * to it so we can represent it with local_oid:oid:criticity.
 378                  */
 379                 res = talloc_asprintf(mem_ctx, "local_oid:%s:%d",
 380                                         control->oid,
 381                                         control->critical);
 382         } else {
 383                 res = talloc_asprintf(mem_ctx, "unknown oid:%s",
 384                                         control->oid);
 385         }
 386         return res;
 387 }
 388
 389
 390 /*
 391  * A little trick to allow to use constants defined in headers rather than
 392  * hardwritten in the file.
 393  * "sizeof" will return the \0 char as well so it will take the place of ":"
 394  * in the length of the string.
 395  */
 396 #define LDB_CONTROL_CMP(control, NAME) strncmp(control, NAME ":", sizeof(NAME))
 397
 398 /* Parse one string and return associated control if parsing is successful*/
 399 struct ldb_control *ldb_parse_control_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *control_strings)
 400 {
 401         struct ldb_control *ctrl;
 402         char *error_string = NULL;
 403
 404         if (!(ctrl = talloc(mem_ctx, struct ldb_control))) {
 405                 ldb_oom(ldb);
 406                 return NULL;
 407         }
 408
 409         if (LDB_CONTROL_CMP(control_strings,
 410                                 LDB_CONTROL_VLV_REQ_NAME) == 0) {
 411                 struct ldb_vlv_req_control *control;
 412                 const char *p;
 413                 char attr[1024];
 414                 char ctxid[1024];
 415                 int crit, bc, ac, os, cc, ret;
 416
 417                 attr[0] = '\0';
 418                 ctxid[0] = '\0';
 419                 p = &(control_strings[sizeof(LDB_CONTROL_VLV_REQ_NAME)]);
 420                 ret = sscanf(p, "%d:%d:%d:%d:%d:%1023[^$]", &crit, &bc, &ac, &os, &cc, ctxid);
 421                 if (ret < 5) {
 422                         ret = sscanf(p, "%d:%d:%d:%1023[^:]:%1023[^$]", &crit, &bc, &ac, attr, ctxid);
 423                 }
 424
 425                 if ((ret < 4) || (crit < 0) || (crit > 1)) {
 426                         error_string = talloc_asprintf(mem_ctx, "invalid server_sort control syntax\n");
 427                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b):bc(n):ac(n):<os(n):cc(n)|attr(s)>[:ctxid(o)]\n");
 428                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean, n = number, s = string, o = b64 binary blob");
 429                         ldb_set_errstring(ldb, error_string);
 430                         talloc_free(error_string);
 431                         return NULL;
 432                 }
 433                 ctrl->oid = LDB_CONTROL_VLV_REQ_OID;
 434                 ctrl->critical = crit;
 435                 if (!(control = talloc(ctrl,
 436                                         struct ldb_vlv_req_control))) {
 437                         ldb_oom(ldb);
 438                         return NULL;
 439                 }
 440                 control->beforeCount = bc;
 441                 control->afterCount = ac;
 442                 if (attr[0]) {
 443                         control->type = 1;
 444                         control->match.gtOrEq.value = talloc_strdup(control, attr);
 445                         control->match.gtOrEq.value_len = strlen(attr);
 446                 } else {
 447                         control->type = 0;
 448                         control->match.byOffset.offset = os;
 449                         control->match.byOffset.contentCount = cc;
 450                 }
 451                 if (ctxid[0]) {
 452                         control->ctxid_len = ldb_base64_decode(ctxid);
 453                         control->contextId = (char *)talloc_memdup(control, ctxid, control->ctxid_len);
 454                 } else {
 455                         control->ctxid_len = 0;
 456                         control->contextId = NULL;
 457                 }
 458                 ctrl->data = control;
 459
 460                 return ctrl;
 461         }
 462
 463         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_DIRSYNC_NAME) == 0) {
 464                 struct ldb_dirsync_control *control;
 465                 const char *p;
 466                 char cookie[1024];
 467                 int crit, max_attrs, ret;
 468                 uint32_t flags;
 469
 470                 cookie[0] = '\0';
 471                 p = &(control_strings[sizeof(LDB_CONTROL_DIRSYNC_NAME)]);
 472                 ret = sscanf(p, "%d:%u:%d:%1023[^$]", &crit, &flags, &max_attrs, cookie);
 473
 474                 if ((ret < 3) || (crit < 0) || (crit > 1) || (flags < 0) || (max_attrs < 0)) {
 475                         error_string = talloc_asprintf(mem_ctx, "invalid dirsync control syntax\n");
 476                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b):flags(n):max_attrs(n)[:cookie(o)]\n");
 477                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean, n = number, o = b64 binary blob");
 478                         ldb_set_errstring(ldb, error_string);
 479                         talloc_free(error_string);
 480                         return NULL;
 481                 }
 482
 483                 /* w2k3 seems to ignore the parameter,
 484                  * but w2k sends a wrong cookie when this value is to small
 485                  * this would cause looping forever, while getting
 486                  * the same data and same cookie forever
 487                  */
 488                 if (max_attrs == 0) max_attrs = 0x0FFFFFFF;
 489
 490                 ctrl->oid = LDB_CONTROL_DIRSYNC_OID;
 491                 ctrl->critical = crit;
 492                 control = talloc(ctrl, struct ldb_dirsync_control);
 493                 control->flags = flags;
 494                 control->max_attributes = max_attrs;
 495                 if (*cookie) {
 496                         control->cookie_len = ldb_base64_decode(cookie);
 497                         control->cookie = (char *)talloc_memdup(control, cookie, control->cookie_len);
 498                 } else {
 499                         control->cookie = NULL;
 500                         control->cookie_len = 0;
 501                 }
 502                 ctrl->data = control;
 503
 504                 return ctrl;
 505         }
 506
 507         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_ASQ_NAME) == 0) {
 508                 struct ldb_asq_control *control;
 509                 const char *p;
 510                 char attr[256];
 511                 int crit, ret;
 512
 513                 attr[0] = '\0';
 514                 p = &(control_strings[sizeof(LDB_CONTROL_ASQ_NAME)]);
 515                 ret = sscanf(p, "%d:%255[^$]", &crit, attr);
 516                 if ((ret != 2) || (crit < 0) || (crit > 1) || (attr[0] == '\0')) {
 517                         error_string = talloc_asprintf(mem_ctx, "invalid asq control syntax\n");
 518                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b):attr(s)\n");
 519                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean, s = string");
 520                         ldb_set_errstring(ldb, error_string);
 521                         talloc_free(error_string);
 522                         return NULL;
 523                 }
 524
 525                 ctrl->oid = LDB_CONTROL_ASQ_OID;
 526                 ctrl->critical = crit;
 527                 control = talloc(ctrl, struct ldb_asq_control);
 528                 control->request = 1;
 529                 control->source_attribute = talloc_strdup(control, attr);
 530                 control->src_attr_len = strlen(attr);
 531                 ctrl->data = control;
 532
 533                 return ctrl;
 534         }
 535
 536         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_EXTENDED_DN_NAME) == 0) {
 537                 struct ldb_extended_dn_control *control;
 538                 const char *p;
 539                 int crit, type, ret;
 540
 541                 p = &(control_strings[sizeof(LDB_CONTROL_EXTENDED_DN_NAME)]);
 542                 ret = sscanf(p, "%d:%d", &crit, &type);
 543                 if ((ret != 2) || (crit < 0) || (crit > 1) || (type < 0) || (type > 1)) {
 544                         ret = sscanf(p, "%d", &crit);
 545                         if ((ret != 1) || (crit < 0) || (crit > 1)) {
 546                                 error_string = talloc_asprintf(mem_ctx, "invalid extended_dn control syntax\n");
 547                                 error_string = talloc_asprintf_append(error_string, " syntax: crit(b)[:type(i)]\n");
 548                                 error_string = talloc_asprintf_append(error_string, "   note: b = boolean\n");
 549                                 error_string = talloc_asprintf_append(error_string, "         i = integer\n");
 550                                 error_string = talloc_asprintf_append(error_string, "   valid values are: 0 - hexadecimal representation\n");
 551                                 error_string = talloc_asprintf_append(error_string, "                     1 - normal string representation");
 552                                 ldb_set_errstring(ldb, error_string);
 553                                 talloc_free(error_string);
 554                                 return NULL;
 555                         }
 556                         control = NULL;
 557                 } else {
 558                         control = talloc(ctrl, struct ldb_extended_dn_control);
 559                         control->type = type;
 560                 }
 561
 562                 ctrl->oid = LDB_CONTROL_EXTENDED_DN_OID;
 563                 ctrl->critical = crit;
 564                 ctrl->data = talloc_steal(ctrl, control);
 565
 566                 return ctrl;
 567         }
 568
 569         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_SD_FLAGS_NAME) == 0) {
 570                 struct ldb_sd_flags_control *control;
 571                 const char *p;
 572                 int crit, ret;
 573                 unsigned secinfo_flags;
 574
 575                 p = &(control_strings[sizeof(LDB_CONTROL_SD_FLAGS_NAME)]);
 576                 ret = sscanf(p, "%d:%u", &crit, &secinfo_flags);
 577                 if ((ret != 2) || (crit < 0) || (crit > 1) || (secinfo_flags < 0) || (secinfo_flags > 0xF)) {
 578                         error_string = talloc_asprintf(mem_ctx, "invalid sd_flags control syntax\n");
 579                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b):secinfo_flags(n)\n");
 580                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean, n = number");
 581                         ldb_set_errstring(ldb, error_string);
 582                         talloc_free(error_string);
 583                         return NULL;
 584                 }
 585
 586                 ctrl->oid = LDB_CONTROL_SD_FLAGS_OID;
 587                 ctrl->critical = crit;
 588                 control = talloc(ctrl, struct ldb_sd_flags_control);
 589                 control->secinfo_flags = secinfo_flags;
 590                 ctrl->data = control;
 591
 592                 return ctrl;
 593         }
 594
 595         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_SEARCH_OPTIONS_NAME) == 0) {
 596                 struct ldb_search_options_control *control;
 597                 const char *p;
 598                 int crit, ret;
 599                 unsigned search_options;
 600
 601                 p = &(control_strings[sizeof(LDB_CONTROL_SEARCH_OPTIONS_NAME)]);
 602                 ret = sscanf(p, "%d:%u", &crit, &search_options);
 603                 if ((ret != 2) || (crit < 0) || (crit > 1) || (search_options < 0) || (search_options > 0xF)) {
 604                         error_string = talloc_asprintf(mem_ctx, "invalid search_options control syntax\n");
 605                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b):search_options(n)\n");
 606                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean, n = number");
 607                         ldb_set_errstring(ldb, error_string);
 608                         talloc_free(error_string);
 609                         return NULL;
 610                 }
 611
 612                 ctrl->oid = LDB_CONTROL_SEARCH_OPTIONS_OID;
 613                 ctrl->critical = crit;
 614                 control = talloc(ctrl, struct ldb_search_options_control);
 615                 control->search_options = search_options;
 616                 ctrl->data = control;
 617
 618                 return ctrl;
 619         }
 620
 621         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_BYPASS_OPERATIONAL_NAME) == 0) {
 622                 const char *p;
 623                 int crit, ret;
 624
 625                 p = &(control_strings[sizeof(LDB_CONTROL_BYPASS_OPERATIONAL_NAME)]);
 626                 ret = sscanf(p, "%d", &crit);
 627                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 628                         error_string = talloc_asprintf(mem_ctx, "invalid bypassopreational control syntax\n");
 629                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 630                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 631                         ldb_set_errstring(ldb, error_string);
 632                         talloc_free(error_string);
 633                         return NULL;
 634                 }
 635
 636                 ctrl->oid = LDB_CONTROL_BYPASS_OPERATIONAL_OID;
 637                 ctrl->critical = crit;
 638                 ctrl->data = NULL;
 639
 640                 return ctrl;
 641         }
 642
 643         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_RELAX_NAME) == 0) {
 644                 const char *p;
 645                 int crit, ret;
 646
 647                 p = &(control_strings[sizeof(LDB_CONTROL_RELAX_NAME)]);
 648                 ret = sscanf(p, "%d", &crit);
 649                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 650                         error_string = talloc_asprintf(mem_ctx, "invalid relax control syntax\n");
 651                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 652                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 653                         ldb_set_errstring(ldb, error_string);
 654                         talloc_free(error_string);
 655                         return NULL;
 656                 }
 657
 658                 ctrl->oid = LDB_CONTROL_RELAX_OID;
 659                 ctrl->critical = crit;
 660                 ctrl->data = NULL;
 661
 662                 return ctrl;
 663         }
 664
 665         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_RECALCULATE_SD_NAME) == 0) {
 666                 const char *p;
 667                 int crit, ret;
 668
 669                 p = &(control_strings[sizeof(LDB_CONTROL_RECALCULATE_SD_NAME)]);
 670                 ret = sscanf(p, "%d", &crit);
 671                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 672                         error_string = talloc_asprintf(mem_ctx, "invalid recalculate_sd control syntax\n");
 673                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 674                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 675                         ldb_set_errstring(ldb, error_string);
 676                         talloc_free(error_string);
 677                         return NULL;
 678                 }
 679
 680                 ctrl->oid = LDB_CONTROL_RECALCULATE_SD_OID;
 681                 ctrl->critical = crit;
 682                 ctrl->data = NULL;
 683
 684                 return ctrl;
 685         }
 686
 687         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_DOMAIN_SCOPE_NAME) == 0) {
 688                 const char *p;
 689                 int crit, ret;
 690
 691                 p = &(control_strings[sizeof(LDB_CONTROL_DOMAIN_SCOPE_NAME)]);
 692                 ret = sscanf(p, "%d", &crit);
 693                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 694                         error_string = talloc_asprintf(mem_ctx, "invalid domain_scope control syntax\n");
 695                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 696                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 697                         ldb_set_errstring(ldb, error_string);
 698                         talloc_free(error_string);
 699                         return NULL;
 700                 }
 701
 702                 ctrl->oid = LDB_CONTROL_DOMAIN_SCOPE_OID;
 703                 ctrl->critical = crit;
 704                 ctrl->data = NULL;
 705
 706                 return ctrl;
 707         }
 708
 709         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_PAGED_RESULTS_NAME) == 0) {
 710                 struct ldb_paged_control *control;
 711                 const char *p;
 712                 int crit, size, ret;
 713
 714                 p = &(control_strings[sizeof(LDB_CONTROL_PAGED_RESULTS_NAME)]);
 715                 ret = sscanf(p, "%d:%d", &crit, &size);
 716                 if ((ret != 2) || (crit < 0) || (crit > 1) || (size < 0)) {
 717                         error_string = talloc_asprintf(mem_ctx, "invalid paged_results control syntax\n");
 718                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b):size(n)\n");
 719                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean, n = number");
 720                         ldb_set_errstring(ldb, error_string);
 721                         talloc_free(error_string);
 722                         return NULL;
 723                 }
 724
 725                 ctrl->oid = LDB_CONTROL_PAGED_RESULTS_OID;
 726                 ctrl->critical = crit;
 727                 control = talloc(ctrl, struct ldb_paged_control);
 728                 control->size = size;
 729                 control->cookie = NULL;
 730                 control->cookie_len = 0;
 731                 ctrl->data = control;
 732
 733                 return ctrl;
 734         }
 735
 736         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_SERVER_SORT_NAME) == 0) {
 737                 struct ldb_server_sort_control **control;
 738                 const char *p;
 739                 char attr[256];
 740                 char rule[128];
 741                 int crit, rev, ret;
 742
 743                 attr[0] = '\0';
 744                 rule[0] = '\0';
 745                 p = &(control_strings[sizeof(LDB_CONTROL_SERVER_SORT_NAME)]);
 746                 ret = sscanf(p, "%d:%d:%255[^:]:%127[^:]", &crit, &rev, attr, rule);
 747                 if ((ret < 3) || (crit < 0) || (crit > 1) || (rev < 0 ) || (rev > 1) ||attr[0] == '\0') {
 748                         error_string = talloc_asprintf(mem_ctx, "invalid server_sort control syntax\n");
 749                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b):rev(b):attr(s)[:rule(s)]\n");
 750                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean, s = string");
 751                         ldb_set_errstring(ldb, error_string);
 752                         talloc_free(error_string);
 753                         return NULL;
 754                 }
 755                 ctrl->oid = LDB_CONTROL_SERVER_SORT_OID;
 756                 ctrl->critical = crit;
 757                 control = talloc_array(ctrl, struct ldb_server_sort_control *, 2);
 758                 control[0] = talloc(control, struct ldb_server_sort_control);
 759                 control[0]->attributeName = talloc_strdup(control, attr);
 760                 if (rule[0])
 761                         control[0]->orderingRule = talloc_strdup(control, rule);
 762                 else
 763                         control[0]->orderingRule = NULL;
 764                 control[0]->reverse = rev;
 765                 control[1] = NULL;
 766                 ctrl->data = control;
 767
 768                 return ctrl;
 769         }
 770
 771         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_NOTIFICATION_NAME) == 0) {
 772                 const char *p;
 773                 int crit, ret;
 774
 775                 p = &(control_strings[sizeof(LDB_CONTROL_NOTIFICATION_NAME)]);
 776                 ret = sscanf(p, "%d", &crit);
 777                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 778                         error_string = talloc_asprintf(mem_ctx, "invalid notification control syntax\n");
 779                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 780                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 781                         ldb_set_errstring(ldb, error_string);
 782                         talloc_free(error_string);
 783                         return NULL;
 784                 }
 785
 786                 ctrl->oid = LDB_CONTROL_NOTIFICATION_OID;
 787                 ctrl->critical = crit;
 788                 ctrl->data = NULL;
 789
 790                 return ctrl;
 791         }
 792
 793         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_TREE_DELETE_NAME) == 0) {
 794                 const char *p;
 795                 int crit, ret;
 796
 797                 p = &(control_strings[sizeof(LDB_CONTROL_TREE_DELETE_NAME)]);
 798                 ret = sscanf(p, "%d", &crit);
 799                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 800                         error_string = talloc_asprintf(mem_ctx, "invalid tree_delete control syntax\n");
 801                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 802                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 803                         ldb_set_errstring(ldb, error_string);
 804                         talloc_free(error_string);
 805                         return NULL;
 806                 }
 807
 808                 ctrl->oid = LDB_CONTROL_TREE_DELETE_OID;
 809                 ctrl->critical = crit;
 810                 ctrl->data = NULL;
 811
 812                 return ctrl;
 813         }
 814
 815         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_SHOW_DELETED_NAME) == 0) {
 816                 const char *p;
 817                 int crit, ret;
 818
 819                 p = &(control_strings[sizeof(LDB_CONTROL_SHOW_DELETED_NAME)]);
 820                 ret = sscanf(p, "%d", &crit);
 821                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 822                         error_string = talloc_asprintf(mem_ctx, "invalid show_deleted control syntax\n");
 823                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 824                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 825                         ldb_set_errstring(ldb, error_string);
 826                         talloc_free(error_string);
 827                         return NULL;
 828                 }
 829
 830                 ctrl->oid = LDB_CONTROL_SHOW_DELETED_OID;
 831                 ctrl->critical = crit;
 832                 ctrl->data = NULL;
 833
 834                 return ctrl;
 835         }
 836
 837         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_SHOW_DEACTIVATED_LINK_NAME) == 0) {
 838                 const char *p;
 839                 int crit, ret;
 840
 841                 p = &(control_strings[sizeof(LDB_CONTROL_SHOW_DEACTIVATED_LINK_NAME)]);
 842                 ret = sscanf(p, "%d", &crit);
 843                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 844                         error_string = talloc_asprintf(mem_ctx, "invalid show_deactivated_link control syntax\n");
 845                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 846                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 847                         ldb_set_errstring(ldb, error_string);
 848                         talloc_free(error_string);
 849                         return NULL;
 850                 }
 851
 852                 ctrl->oid = LDB_CONTROL_SHOW_DEACTIVATED_LINK_OID;
 853                 ctrl->critical = crit;
 854                 ctrl->data = NULL;
 855
 856                 return ctrl;
 857         }
 858
 859         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_SHOW_RECYCLED_NAME) == 0) {
 860                 const char *p;
 861                 int crit, ret;
 862
 863                 p = &(control_strings[sizeof(LDB_CONTROL_SHOW_RECYCLED_NAME)]);
 864                 ret = sscanf(p, "%d", &crit);
 865                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 866                         error_string = talloc_asprintf(mem_ctx, "invalid show_recycled control syntax\n");
 867                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 868                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 869                         ldb_set_errstring(ldb, error_string);
 870                         talloc_free(error_string);
 871                         return NULL;
 872                 }
 873
 874                 ctrl->oid = LDB_CONTROL_SHOW_RECYCLED_OID;
 875                 ctrl->critical = crit;
 876                 ctrl->data = NULL;
 877
 878                 return ctrl;
 879         }
 880
 881         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_PERMISSIVE_MODIFY_NAME) == 0) {
 882                 const char *p;
 883                 int crit, ret;
 884
 885                 p = &(control_strings[sizeof(LDB_CONTROL_PERMISSIVE_MODIFY_NAME)]);
 886                 ret = sscanf(p, "%d", &crit);
 887                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 888                         error_string = talloc_asprintf(mem_ctx, "invalid permissive_modify control syntax\n");
 889                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 890                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 891                         ldb_set_errstring(ldb, error_string);
 892                         talloc_free(error_string);
 893                         return NULL;
 894                 }
 895
 896                 ctrl->oid = LDB_CONTROL_PERMISSIVE_MODIFY_OID;
 897                 ctrl->critical = crit;
 898                 ctrl->data = NULL;
 899
 900                 return ctrl;
 901         }
 902
 903         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_REVEAL_INTERNALS_NAME) == 0) {
 904                 const char *p;
 905                 int crit, ret;
 906
 907                 p = &(control_strings[sizeof(LDB_CONTROL_REVEAL_INTERNALS_NAME)]);
 908                 ret = sscanf(p, "%d", &crit);
 909                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 910                         error_string = talloc_asprintf(mem_ctx, "invalid reveal_internals control syntax\n");
 911                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 912                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 913                         ldb_set_errstring(ldb, error_string);
 914                         talloc_free(error_string);
 915                         return NULL;
 916                 }
 917
 918                 ctrl->oid = LDB_CONTROL_REVEAL_INTERNALS;
 919                 ctrl->critical = crit;
 920                 ctrl->data = NULL;
 921
 922                 return ctrl;
 923         }
 924
 925         if (strncmp(control_strings, "local_oid:", 10) == 0) {
 926                 const char *p;
 927                 int crit = 0, ret = 0;
 928                 char oid[256];
 929
 930                 oid[0] = '\0';
 931                 p = &(control_strings[10]);
 932                 ret = sscanf(p, "%64[^:]:%d", oid, &crit);
 933
 934                 if ((ret != 2) || strlen(oid) == 0 || (crit < 0) || (crit > 1)) {
 935                         error_string = talloc_asprintf(mem_ctx, "invalid local_oid control syntax\n");
 936                         error_string = talloc_asprintf_append(error_string, " syntax: oid(s):crit(b)\n");
 937                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean, s = string");
 938                         ldb_set_errstring(ldb, error_string);
 939                         talloc_free(error_string);
 940                         return NULL;
 941                 }
 942
 943                 ctrl->oid = talloc_strdup(ctrl, oid);
 944                 if (!ctrl->oid) {
 945                         ldb_oom(ldb);
 946                         return NULL;
 947                 }
 948                 ctrl->critical = crit;
 949                 ctrl->data = NULL;
 950
 951                 return ctrl;
 952         }
 953
 954         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_RODC_DCPROMO_NAME) == 0) {
 955                 const char *p;
 956                 int crit, ret;
 957
 958                 p = &(control_strings[sizeof(LDB_CONTROL_RODC_DCPROMO_NAME)]);
 959                 ret = sscanf(p, "%d", &crit);
 960                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 961                         error_string = talloc_asprintf(mem_ctx, "invalid rodc_join control syntax\n");
 962                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 963                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 964                         ldb_set_errstring(ldb, error_string);
 965                         talloc_free(error_string);
 966                         return NULL;
 967                 }
 968
 969                 ctrl->oid = LDB_CONTROL_RODC_DCPROMO_OID;
 970                 ctrl->critical = crit;
 971                 ctrl->data = NULL;
 972
 973                 return ctrl;
 974         }
 975
 976         if (LDB_CONTROL_CMP(control_strings, LDB_CONTROL_PROVISION_NAME) == 0) {
 977                 const char *p;
 978                 int crit, ret;
 979
 980                 p = &(control_strings[sizeof(LDB_CONTROL_PROVISION_NAME)]);
 981                 ret = sscanf(p, "%d", &crit);
 982                 if ((ret != 1) || (crit < 0) || (crit > 1)) {
 983                         error_string = talloc_asprintf(mem_ctx, "invalid provision control syntax\n");
 984                         error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
 985                         error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
 986                         ldb_set_errstring(ldb, error_string);
 987                         talloc_free(error_string);
 988                         return NULL;
 989                 }
 990
 991                 ctrl->oid = LDB_CONTROL_PROVISION_OID;
 992                 ctrl->critical = crit;
 993                 ctrl->data = NULL;
 994
 995                 return ctrl;
 996         }
 997         /*
 998          * When no matching control has been found.
 999          */
1000         return NULL;
1001 }
1002
1003 /* Parse controls from the format used on the command line and in ejs */
1004 struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings)
1005 {
1006         unsigned int i;
1007         struct ldb_control **ctrl;
1008
1009         if (control_strings == NULL || control_strings[0] == NULL)
1010                 return NULL;
1011
1012         for (i = 0; control_strings[i]; i++);
1013
1014         ctrl = talloc_array(mem_ctx, struct ldb_control *, i + 1);
1015
1016         ldb_reset_err_string(ldb);
1017         for (i = 0; control_strings[i]; i++) {
1018                 ctrl[i] = ldb_parse_control_from_string(ldb, ctrl, control_strings[i]);
1019                 if (ctrl[i] == NULL) {
1020                         if( ldb_errstring == NULL ) {
1021                                 /* no controls matched, throw an error */
1022                                 ldb_asprintf_errstring(ldb, "Invalid control name: '%s'", control_strings[i]);
1023                         }
1024                         talloc_free(ctrl);
1025                         return NULL;
1026                 }
1027         }
1028
1029         ctrl[i] = NULL;
1030
1031         return ctrl;
1032 }
1033
1034