source4/dsdb/samdb/ldb_modules/extended_dn_out.c

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Simo Sorce 2005-2008
   5    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2007-2008
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 /*
  22  *  Name: ldb
  23  *
  24  *  Component: ldb extended dn control module
  25  *
  26  *  Description: this module builds a special dn for returned search
  27  *  results, and fixes some other aspects of the result (returned case issues)
  28  *  values.
  29  *
  30  *  Authors: Simo Sorce
  31  *           Andrew Bartlett
  32  */
  33
  34 #include "includes.h"
  35 #include "ldb/include/ldb.h"
  36 #include "ldb/include/ldb_errors.h"
  37 #include "ldb/include/ldb_module.h"
  38 #include "libcli/security/dom_sid.h"
  39 #include "librpc/gen_ndr/ndr_misc.h"
  40 #include "librpc/gen_ndr/ndr_security.h"
  41 #include "librpc/ndr/libndr.h"
  42 #include "dsdb/samdb/samdb.h"
  43
  44 struct extended_dn_out_private {
  45         bool dereference;
  46         bool normalise;
  47         struct dsdb_openldap_dereference_control *dereference_control;
  48 };
  49
  50 static bool is_attr_in_list(const char * const * attrs, const char *attr)
  51 {
  52         int i;
  53
  54         for (i = 0; attrs[i]; i++) {
  55                 if (ldb_attr_cmp(attrs[i], attr) == 0)
  56                         return true;
  57         }
  58
  59         return false;
  60 }
  61
  62 static char **copy_attrs(void *mem_ctx, const char * const * attrs)
  63 {
  64         char **nattrs;
  65         int i, num;
  66
  67         for (num = 0; attrs[num]; num++);
  68
  69         nattrs = talloc_array(mem_ctx, char *, num + 1);
  70         if (!nattrs) return NULL;
  71
  72         for(i = 0; i < num; i++) {
  73                 nattrs[i] = talloc_strdup(nattrs, attrs[i]);
  74                 if (!nattrs[i]) {
  75                         talloc_free(nattrs);
  76                         return NULL;
  77                 }
  78         }
  79         nattrs[i] = NULL;
  80
  81         return nattrs;
  82 }
  83
  84 static bool add_attrs(void *mem_ctx, char ***attrs, const char *attr)
  85 {
  86         char **nattrs;
  87         int num;
  88
  89         for (num = 0; (*attrs)[num]; num++);
  90
  91         nattrs = talloc_realloc(mem_ctx, *attrs, char *, num + 2);
  92         if (!nattrs) return false;
  93
  94         *attrs = nattrs;
  95
  96         nattrs[num] = talloc_strdup(nattrs, attr);
  97         if (!nattrs[num]) return false;
  98
  99         nattrs[num + 1] = NULL;
 100
 101         return true;
 102 }
 103
 104 /* Fix the DN so that the relative attribute names are in upper case so that the DN:
 105    cn=Adminstrator,cn=users,dc=samba,dc=example,dc=com becomes
 106    CN=Adminstrator,CN=users,DC=samba,DC=example,DC=com
 107 */
 108
 109
 110 static int fix_dn(struct ldb_dn *dn)
 111 {
 112         int i, ret;
 113         char *upper_rdn_attr;
 114
 115         for (i=0; i < ldb_dn_get_comp_num(dn); i++) {
 116                 /* We need the attribute name in upper case */
 117                 upper_rdn_attr = strupper_talloc(dn,
 118                                                  ldb_dn_get_component_name(dn, i));
 119                 if (!upper_rdn_attr) {
 120                         return LDB_ERR_OPERATIONS_ERROR;
 121                 }
 122
 123                 /* And replace it with CN=foo (we need the attribute in upper case */
 124                 ret = ldb_dn_set_component(dn, i, upper_rdn_attr,
 125                                            *ldb_dn_get_component_val(dn, i));
 126                 talloc_free(upper_rdn_attr);
 127                 if (ret != LDB_SUCCESS) {
 128                         return ret;
 129                 }
 130         }
 131         return LDB_SUCCESS;
 132 }
 133
 134 /* Inject the extended DN components, so the DN cn=Adminstrator,cn=users,dc=samba,dc=example,dc=com becomes
 135    <GUID=541203ae-f7d6-47ef-8390-bfcf019f9583>;<SID=S-1-5-21-4177067393-1453636373-93818737-500>;cn=Adminstrator,cn=users,dc=samba,dc=example,dc=com */
 136
 137 static int inject_extended_dn_out(struct ldb_reply *ares,
 138                                   struct ldb_context *ldb,
 139                                   int type,
 140                                   bool remove_guid,
 141                                   bool remove_sid)
 142 {
 143         int ret;
 144         const DATA_BLOB *guid_blob;
 145         const DATA_BLOB *sid_blob;
 146
 147         guid_blob = ldb_msg_find_ldb_val(ares->message, "objectGUID");
 148         sid_blob = ldb_msg_find_ldb_val(ares->message, "objectSID");
 149
 150         if (!guid_blob) {
 151                 ldb_set_errstring(ldb, "Did not find objectGUID to inject into extended DN");
 152                 return LDB_ERR_OPERATIONS_ERROR;
 153         }
 154
 155         ret = ldb_dn_set_extended_component(ares->message->dn, "GUID", guid_blob);
 156         if (ret != LDB_SUCCESS) {
 157                 return ret;
 158         }
 159         if (sid_blob) {
 160                 ret = ldb_dn_set_extended_component(ares->message->dn, "SID", sid_blob);
 161                 if (ret != LDB_SUCCESS) {
 162                         return ret;
 163                 }
 164         }
 165
 166         if (remove_guid) {
 167                 ldb_msg_remove_attr(ares->message, "objectGUID");
 168         }
 169
 170         if (sid_blob && remove_sid) {
 171                 ldb_msg_remove_attr(ares->message, "objectSID");
 172         }
 173
 174         return LDB_SUCCESS;
 175 }
 176
 177 static int handle_dereference_openldap(struct ldb_dn *dn,
 178                               struct dsdb_openldap_dereference_result **dereference_attrs,
 179                               const char *attr, const DATA_BLOB *val)
 180 {
 181         const struct ldb_val *entryUUIDblob, *sid_blob;
 182         struct ldb_message fake_msg; /* easier to use routines that expect an ldb_message */
 183         int j;
 184
 185         fake_msg.num_elements = 0;
 186
 187         /* Look for this attribute in the returned control */
 188         for (j = 0; dereference_attrs && dereference_attrs[j]; j++) {
 189                 struct ldb_val source_dn = data_blob_string_const(dereference_attrs[j]->dereferenced_dn);
 190                 if (ldb_attr_cmp(dereference_attrs[j]->source_attribute, attr) == 0
 191                     && data_blob_cmp(&source_dn, val) == 0) {
 192                         fake_msg.num_elements = dereference_attrs[j]->num_attributes;
 193                         fake_msg.elements = dereference_attrs[j]->attributes;
 194                         break;
 195                 }
 196         }
 197         if (!fake_msg.num_elements) {
 198                 return LDB_SUCCESS;
 199         }
 200         /* Look for an OpenLDAP entryUUID */
 201
 202         entryUUIDblob = ldb_msg_find_ldb_val(&fake_msg, "entryUUID");
 203         if (entryUUIDblob) {
 204                 NTSTATUS status;
 205                 enum ndr_err_code ndr_err;
 206
 207                 struct ldb_val guid_blob;
 208                 struct GUID guid;
 209
 210                 status = GUID_from_data_blob(entryUUIDblob, &guid);
 211
 212                 if (!NT_STATUS_IS_OK(status)) {
 213                         return LDB_ERR_INVALID_DN_SYNTAX;
 214                 }
 215                 ndr_err = ndr_push_struct_blob(&guid_blob, NULL, NULL, &guid,
 216                                                (ndr_push_flags_fn_t)ndr_push_GUID);
 217                 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 218                         return LDB_ERR_INVALID_DN_SYNTAX;
 219                 }
 220
 221                 ldb_dn_set_extended_component(dn, "GUID", &guid_blob);
 222         }
 223
 224         sid_blob = ldb_msg_find_ldb_val(&fake_msg, "objectSID");
 225
 226         /* Look for the objectSID */
 227         if (sid_blob) {
 228                 ldb_dn_set_extended_component(dn, "SID", sid_blob);
 229         }
 230         return LDB_SUCCESS;
 231 }
 232
 233 static int handle_dereference_fds(struct ldb_dn *dn,
 234                               struct dsdb_openldap_dereference_result **dereference_attrs,
 235                               const char *attr, const DATA_BLOB *val)
 236 {
 237         const struct ldb_val *nsUniqueIdBlob, *sidBlob;
 238         struct ldb_message fake_msg; /* easier to use routines that expect an ldb_message */
 239         int j;
 240
 241         fake_msg.num_elements = 0;
 242
 243         /* Look for this attribute in the returned control */
 244         for (j = 0; dereference_attrs && dereference_attrs[j]; j++) {
 245                 struct ldb_val source_dn = data_blob_string_const(dereference_attrs[j]->dereferenced_dn);
 246                 if (ldb_attr_cmp(dereference_attrs[j]->source_attribute, attr) == 0
 247                     && data_blob_cmp(&source_dn, val) == 0) {
 248                         fake_msg.num_elements = dereference_attrs[j]->num_attributes;
 249                         fake_msg.elements = dereference_attrs[j]->attributes;
 250                         break;
 251                 }
 252         }
 253         if (!fake_msg.num_elements) {
 254                 return LDB_SUCCESS;
 255         }
 256
 257         /* Look for the nsUniqueId */
 258
 259         nsUniqueIdBlob = ldb_msg_find_ldb_val(&fake_msg, "nsUniqueId");
 260         if (nsUniqueIdBlob) {
 261                 NTSTATUS status;
 262                 enum ndr_err_code ndr_err;
 263
 264                 struct ldb_val guid_blob;
 265                 struct GUID guid;
 266
 267                 status = NS_GUID_from_string((char *)nsUniqueIdBlob->data, &guid);
 268
 269                 if (!NT_STATUS_IS_OK(status)) {
 270                         return LDB_ERR_INVALID_DN_SYNTAX;
 271                 }
 272                 ndr_err = ndr_push_struct_blob(&guid_blob, NULL, NULL, &guid,
 273                                                 (ndr_push_flags_fn_t)ndr_push_GUID);
 274                 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 275                         return LDB_ERR_INVALID_DN_SYNTAX;
 276                 }
 277
 278                 ldb_dn_set_extended_component(dn, "GUID", &guid_blob);
 279         }
 280
 281         /* Look for the objectSID */
 282
 283         sidBlob = ldb_msg_find_ldb_val(&fake_msg, "sambaSID");
 284         if (sidBlob) {
 285                 enum ndr_err_code ndr_err;
 286
 287                 struct ldb_val sid_blob;
 288                 struct dom_sid *sid;
 289
 290                 sid = dom_sid_parse_length(NULL, sidBlob);
 291
 292                 if (sid == NULL) {
 293                         return LDB_ERR_INVALID_DN_SYNTAX;
 294                 }
 295
 296                 ndr_err = ndr_push_struct_blob(&sid_blob, NULL, NULL, sid,
 297                                                 (ndr_push_flags_fn_t)ndr_push_dom_sid);
 298                 talloc_free(sid);
 299                 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 300                         return LDB_ERR_INVALID_DN_SYNTAX;
 301                 }
 302
 303                 ldb_dn_set_extended_component(dn, "SID", &sid_blob);
 304         }
 305         return LDB_SUCCESS;
 306 }
 307
 308 /* search */
 309 struct extended_search_context {
 310         struct ldb_module *module;
 311         const struct dsdb_schema *schema;
 312         struct ldb_request *req;
 313         bool inject;
 314         bool remove_guid;
 315         bool remove_sid;
 316         int extended_type;
 317 };
 318
 319 static int extended_callback(struct ldb_request *req, struct ldb_reply *ares,
 320                 int (*handle_dereference)(struct ldb_dn *dn,
 321                                 struct dsdb_openldap_dereference_result **dereference_attrs,
 322                                 const char *attr, const DATA_BLOB *val))
 323 {
 324         struct extended_search_context *ac;
 325         struct ldb_control *control;
 326         struct dsdb_openldap_dereference_result_control *dereference_control = NULL;
 327         int ret, i, j;
 328         struct ldb_message *msg = ares->message;
 329         struct extended_dn_out_private *p;
 330
 331         ac = talloc_get_type(req->context, struct extended_search_context);
 332         p = talloc_get_type(ldb_module_get_private(ac->module), struct extended_dn_out_private);
 333
 334         if (!ares) {
 335                 return ldb_module_done(ac->req, NULL, NULL,
 336                                         LDB_ERR_OPERATIONS_ERROR);
 337         }
 338         if (ares->error != LDB_SUCCESS) {
 339                 return ldb_module_done(ac->req, ares->controls,
 340                                         ares->response, ares->error);
 341         }
 342
 343         switch (ares->type) {
 344         case LDB_REPLY_REFERRAL:
 345                 return ldb_module_send_referral(ac->req, ares->referral);
 346
 347         case LDB_REPLY_DONE:
 348                 return ldb_module_done(ac->req, ares->controls,
 349                                         ares->response, LDB_SUCCESS);
 350         case LDB_REPLY_ENTRY:
 351                 break;
 352         }
 353
 354         if (p && p->normalise) {
 355                 ret = fix_dn(ares->message->dn);
 356                 if (ret != LDB_SUCCESS) {
 357                         return ldb_module_done(ac->req, NULL, NULL, ret);
 358                 }
 359         }
 360
 361         if (ac->inject) {
 362                 /* for each record returned post-process to add any derived
 363                    attributes that have been asked for */
 364                 ret = inject_extended_dn_out(ares, ldb_module_get_ctx(ac->module),
 365                                              ac->extended_type, ac->remove_guid,
 366                                              ac->remove_sid);
 367                 if (ret != LDB_SUCCESS) {
 368                         return ldb_module_done(ac->req, NULL, NULL, ret);
 369                 }
 370         }
 371
 372         if ((p && p->normalise) || ac->inject) {
 373                 const struct ldb_val *val = ldb_msg_find_ldb_val(ares->message, "distinguishedName");
 374                 if (val) {
 375                         ldb_msg_remove_attr(ares->message, "distinguishedName");
 376                         if (ac->inject) {
 377                                 ret = ldb_msg_add_steal_string(ares->message, "distinguishedName",
 378                                                                ldb_dn_get_extended_linearized(ares->message, ares->message->dn, ac->extended_type));
 379                         } else {
 380                                 ret = ldb_msg_add_string(ares->message, "distinguishedName",
 381                                                          ldb_dn_get_linearized(ares->message->dn));
 382                         }
 383                         if (ret != LDB_SUCCESS) {
 384                                 ldb_oom(ldb_module_get_ctx(ac->module));
 385                                 return LDB_ERR_OPERATIONS_ERROR;
 386                         }
 387                 }
 388         }
 389
 390         if (p && p->dereference) {
 391                 control = ldb_reply_get_control(ares, DSDB_OPENLDAP_DEREFERENCE_CONTROL);
 392
 393                 if (control && control->data) {
 394                         dereference_control = talloc_get_type(control->data, struct dsdb_openldap_dereference_result_control);
 395                 }
 396         }
 397
 398         /* Walk the retruned elements (but only if we have a schema to interpret the list with) */
 399         for (i = 0; ac->schema && i < msg->num_elements; i++) {
 400                 const struct dsdb_attribute *attribute;
 401                 attribute = dsdb_attribute_by_lDAPDisplayName(ac->schema, msg->elements[i].name);
 402                 if (!attribute) {
 403                         continue;
 404                 }
 405
 406                 if (p->normalise) {
 407                         /* If we are also in 'normalise' mode, then
 408                          * fix the attribute names to be in the
 409                          * correct case */
 410                         msg->elements[i].name = talloc_strdup(msg->elements, attribute->lDAPDisplayName);
 411                         if (!msg->elements[i].name) {
 412                                 ldb_oom(ldb_module_get_ctx(ac->module));
 413                                 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_OPERATIONS_ERROR);
 414                         }
 415                 }
 416
 417                 /* distinguishedName has been dealt with above */
 418                 if (ldb_attr_cmp(msg->elements[i].name, "distinguishedName") == 0) {
 419                         continue;
 420                 }
 421
 422                 /* Look to see if this attributeSyntax is a DN */
 423                 if (strcmp(attribute->attributeSyntax_oid, "2.5.5.1") != 0 &&
 424                     strcmp(attribute->attributeSyntax_oid, "2.5.5.7") != 0) {
 425                         continue;
 426                 }
 427
 428                 for (j = 0; j < msg->elements[i].num_values; j++) {
 429                         const char *dn_str;
 430                         struct ldb_dn *dn = ldb_dn_from_ldb_val(ac, ldb_module_get_ctx(ac->module), &msg->elements[i].values[j]);
 431                         if (!dn || !ldb_dn_validate(dn)) {
 432                                 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_INVALID_DN_SYNTAX);
 433                         }
 434
 435                         if (p->normalise) {
 436                                 ret = fix_dn(dn);
 437                                 if (ret != LDB_SUCCESS) {
 438                                         return ldb_module_done(ac->req, NULL, NULL, ret);
 439                                 }
 440                         }
 441
 442                         /* If we are running in dereference mode (such
 443                          * as against OpenLDAP) then the DN in the msg
 444                          * above does not contain the extended values,
 445                          * and we need to look in the dereference
 446                          * result */
 447
 448                         /* Look for this value in the attribute */
 449
 450                         if (dereference_control) {
 451                                 ret = handle_dereference(dn,
 452                                                          dereference_control->attributes,
 453                                                          msg->elements[i].name,
 454                                                          &msg->elements[i].values[j]);
 455                                 if (ret != LDB_SUCCESS) {
 456                                         return ldb_module_done(ac->req, NULL, NULL, ret);
 457                                 }
 458                         }
 459
 460                         if (!ac->inject) {
 461                                 dn_str = talloc_steal(msg->elements[i].values,
 462                                                       ldb_dn_get_linearized(dn));
 463                         } else {
 464                                 dn_str = talloc_steal(msg->elements[i].values,
 465                                                       ldb_dn_get_extended_linearized(msg->elements[i].values,
 466                                                                                      dn, ac->extended_type));
 467                         }
 468                         if (!dn_str) {
 469                                 ldb_oom(ldb_module_get_ctx(ac->module));
 470                                 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_OPERATIONS_ERROR);
 471                         }
 472                         msg->elements[i].values[j] = data_blob_string_const(dn_str);
 473                         talloc_free(dn);
 474                 }
 475         }
 476         return ldb_module_send_entry(ac->req, msg, ares->controls);
 477 }
 478
 479 static int extended_callback_openldap(struct ldb_request *req, struct ldb_reply *ares)
 480 {
 481         return extended_callback(req, ares, handle_dereference_openldap);
 482 }
 483
 484 static int extended_callback_fds(struct ldb_request *req, struct ldb_reply *ares)
 485 {
 486         return extended_callback(req, ares, handle_dereference_fds);
 487 }
 488
 489 static int extended_dn_out_search(struct ldb_module *module, struct ldb_request *req,
 490                 int (*callback)(struct ldb_request *req, struct ldb_reply *ares))
 491 {
 492         struct ldb_control *control;
 493         struct ldb_control *storage_format_control;
 494         struct ldb_extended_dn_control *extended_ctrl = NULL;
 495         struct ldb_control **saved_controls;
 496         struct extended_search_context *ac;
 497         struct ldb_request *down_req;
 498         char **new_attrs;
 499         const char * const *const_attrs;
 500         int ret;
 501
 502         struct extended_dn_out_private *p = talloc_get_type(ldb_module_get_private(module), struct extended_dn_out_private);
 503
 504         /* check if there's an extended dn control */
 505         control = ldb_request_get_control(req, LDB_CONTROL_EXTENDED_DN_OID);
 506         if (control && control->data) {
 507                 extended_ctrl = talloc_get_type(control->data, struct ldb_extended_dn_control);
 508                 if (!extended_ctrl) {
 509                         return LDB_ERR_PROTOCOL_ERROR;
 510                 }
 511         }
 512
 513         /* Look to see if, as we are in 'store DN+GUID+SID' mode, the
 514          * client is after the storage format (to fill in linked
 515          * attributes) */
 516         storage_format_control = ldb_request_get_control(req, DSDB_CONTROL_DN_STORAGE_FORMAT_OID);
 517         if (!control && storage_format_control && storage_format_control->data) {
 518                 extended_ctrl = talloc_get_type(storage_format_control->data, struct ldb_extended_dn_control);
 519                 if (!extended_ctrl) {
 520                         ldb_set_errstring(ldb_module_get_ctx(module), "extended_dn_out: extended_ctrl was of the wrong data type");
 521                         return LDB_ERR_PROTOCOL_ERROR;
 522                 }
 523         }
 524
 525         ac = talloc_zero(req, struct extended_search_context);
 526         if (ac == NULL) {
 527                 ldb_oom(ldb_module_get_ctx(module));
 528                 return LDB_ERR_OPERATIONS_ERROR;
 529         }
 530
 531         ac->module = module;
 532         ac->schema = dsdb_get_schema(ldb_module_get_ctx(module));
 533         ac->req = req;
 534         ac->inject = false;
 535         ac->remove_guid = false;
 536         ac->remove_sid = false;
 537
 538         const_attrs = req->op.search.attrs;
 539
 540         /* We only need to do special processing if we were asked for
 541          * the extended DN, or we are 'store DN+GUID+SID'
 542          * (!dereference) mode.  (This is the normal mode for LDB on
 543          * tdb). */
 544         if (control || (storage_format_control && p && !p->dereference)) {
 545                 ac->inject = true;
 546                 if (extended_ctrl) {
 547                         ac->extended_type = extended_ctrl->type;
 548                 } else {
 549                         ac->extended_type = 0;
 550                 }
 551
 552                 /* check if attrs only is specified, in that case check wether we need to modify them */
 553                 if (req->op.search.attrs && !is_attr_in_list(req->op.search.attrs, "*")) {
 554                         if (! is_attr_in_list(req->op.search.attrs, "objectGUID")) {
 555                                 ac->remove_guid = true;
 556                         }
 557                         if (! is_attr_in_list(req->op.search.attrs, "objectSID")) {
 558                                 ac->remove_sid = true;
 559                         }
 560                         if (ac->remove_guid || ac->remove_sid) {
 561                                 new_attrs = copy_attrs(ac, req->op.search.attrs);
 562                                 if (new_attrs == NULL) {
 563                                         ldb_oom(ldb_module_get_ctx(module));
 564                                         return LDB_ERR_OPERATIONS_ERROR;
 565                                 }
 566
 567                                 if (ac->remove_guid) {
 568                                         if (!add_attrs(ac, &new_attrs, "objectGUID"))
 569                                                 return LDB_ERR_OPERATIONS_ERROR;
 570                                 }
 571                                 if (ac->remove_sid) {
 572                                         if (!add_attrs(ac, &new_attrs, "objectSID"))
 573                                                 return LDB_ERR_OPERATIONS_ERROR;
 574                                 }
 575                                 const_attrs = (const char * const *)new_attrs;
 576                         }
 577                 }
 578         }
 579
 580         ret = ldb_build_search_req_ex(&down_req,
 581                                       ldb_module_get_ctx(module), ac,
 582                                       req->op.search.base,
 583                                       req->op.search.scope,
 584                                       req->op.search.tree,
 585                                       const_attrs,
 586                                       req->controls,
 587                                       ac, callback,
 588                                       req);
 589         if (ret != LDB_SUCCESS) {
 590                 return ret;
 591         }
 592
 593         /* Remove extended DN and storage format controls */
 594
 595         if (control) {
 596                 /* save it locally and remove it from the list */
 597                 /* we do not need to replace them later as we
 598                  * are keeping the original req intact */
 599                 if (!save_controls(control, down_req, &saved_controls)) {
 600                         return LDB_ERR_OPERATIONS_ERROR;
 601                 }
 602         }
 603
 604         if (storage_format_control) {
 605                 /* save it locally and remove it from the list */
 606                 /* we do not need to replace them later as we
 607                  * are keeping the original req intact */
 608                 if (!save_controls(storage_format_control, down_req, &saved_controls)) {
 609                         return LDB_ERR_OPERATIONS_ERROR;
 610                 }
 611         }
 612
 613         /* Add in dereference control, if we were asked to, we are
 614          * using the 'dereference' mode (such as with an OpenLDAP
 615          * backend) and have the control prepared */
 616         if (control && p && p->dereference && p->dereference_control) {
 617                 ret = ldb_request_add_control(down_req,
 618                                               DSDB_OPENLDAP_DEREFERENCE_CONTROL,
 619                                               false, p->dereference_control);
 620                 if (ret != LDB_SUCCESS) {
 621                         return ret;
 622                 }
 623         }
 624
 625         /* perform the search */
 626         return ldb_next_request(module, down_req);
 627 }
 628
 629 static int extended_dn_out_ldb_search(struct ldb_module *module, struct ldb_request *req)
 630 {
 631         return extended_dn_out_search(module, req, extended_callback_openldap);
 632 }
 633
 634 static int extended_dn_out_openldap_search(struct ldb_module *module, struct ldb_request *req)
 635 {
 636         return extended_dn_out_search(module, req, extended_callback_openldap);
 637 }
 638
 639 static int extended_dn_out_fds_search(struct ldb_module *module, struct ldb_request *req)
 640 {
 641         return extended_dn_out_search(module, req, extended_callback_fds);
 642 }
 643
 644 static int extended_dn_out_ldb_init(struct ldb_module *module)
 645 {
 646         int ret;
 647
 648         struct extended_dn_out_private *p = talloc(module, struct extended_dn_out_private);
 649
 650         ldb_module_set_private(module, p);
 651
 652         if (!p) {
 653                 ldb_oom(ldb_module_get_ctx(module));
 654                 return LDB_ERR_OPERATIONS_ERROR;
 655         }
 656
 657         p->dereference = false;
 658         p->normalise = false;
 659
 660         ret = ldb_mod_register_control(module, LDB_CONTROL_EXTENDED_DN_OID);
 661         if (ret != LDB_SUCCESS) {
 662                 ldb_debug(ldb_module_get_ctx(module), LDB_DEBUG_ERROR,
 663                         "extended_dn_out: Unable to register control with rootdse!\n");
 664                 return LDB_ERR_OPERATIONS_ERROR;
 665         }
 666
 667         return ldb_next_init(module);
 668 }
 669
 670 static int extended_dn_out_dereference_init(struct ldb_module *module, const char *attrs[])
 671 {
 672         int ret, i = 0;
 673         struct extended_dn_out_private *p = talloc_zero(module, struct extended_dn_out_private);
 674         struct dsdb_openldap_dereference_control *dereference_control;
 675         struct dsdb_attribute *cur;
 676
 677         struct dsdb_schema *schema;
 678
 679         ldb_module_set_private(module, p);
 680
 681         if (!p) {
 682                 ldb_oom(ldb_module_get_ctx(module));
 683                 return LDB_ERR_OPERATIONS_ERROR;
 684         }
 685
 686         p->dereference = true;
 687
 688         /* At the moment, servers that need dereference also need the
 689          * DN and attribute names to be normalised */
 690         p->normalise = true;
 691
 692         ret = ldb_mod_register_control(module, LDB_CONTROL_EXTENDED_DN_OID);
 693         if (ret != LDB_SUCCESS) {
 694                 ldb_debug(ldb_module_get_ctx(module), LDB_DEBUG_ERROR,
 695                         "extended_dn_out: Unable to register control with rootdse!\n");
 696                 return LDB_ERR_OPERATIONS_ERROR;
 697         }
 698
 699         ret = ldb_next_init(module);
 700
 701         if (ret != LDB_SUCCESS) {
 702                 return ret;
 703         }
 704
 705         schema = dsdb_get_schema(ldb_module_get_ctx(module));
 706         if (!schema) {
 707                 /* No schema on this DB (yet) */
 708                 return LDB_SUCCESS;
 709         }
 710
 711         p->dereference_control = dereference_control
 712                 = talloc_zero(p, struct dsdb_openldap_dereference_control);
 713
 714         if (!p->dereference_control) {
 715                 ldb_oom(ldb_module_get_ctx(module));
 716                 return LDB_ERR_OPERATIONS_ERROR;
 717         }
 718
 719         for (cur = schema->attributes; cur; cur = cur->next) {
 720                 if (strcmp(cur->syntax->attributeSyntax_oid, "2.5.5.1") != 0 &&
 721                     strcmp(cur->syntax->attributeSyntax_oid, "2.5.5.7") != 0) {
 722                         continue;
 723                 }
 724                 dereference_control->dereference
 725                         = talloc_realloc(p, dereference_control->dereference,
 726                                          struct dsdb_openldap_dereference *, i + 2);
 727                 if (!dereference_control) {
 728                         ldb_oom(ldb_module_get_ctx(module));
 729                         return LDB_ERR_OPERATIONS_ERROR;
 730                 }
 731                 dereference_control->dereference[i] = talloc(dereference_control->dereference,
 732                                          struct dsdb_openldap_dereference);
 733                 if (!dereference_control->dereference[i]) {
 734                         ldb_oom(ldb_module_get_ctx(module));
 735                         return LDB_ERR_OPERATIONS_ERROR;
 736                 }
 737                 dereference_control->dereference[i]->source_attribute = cur->lDAPDisplayName;
 738                 dereference_control->dereference[i]->dereference_attribute = attrs;
 739                 i++;
 740                 dereference_control->dereference[i] = NULL;
 741         }
 742         return LDB_SUCCESS;
 743 }
 744
 745 static int extended_dn_out_openldap_init(struct ldb_module *module)
 746 {
 747         static const char *attrs[] = {
 748                 "entryUUID",
 749                 "objectSID",
 750                 NULL
 751         };
 752
 753         return extended_dn_out_dereference_init(module, attrs);
 754 }
 755
 756 static int extended_dn_out_fds_init(struct ldb_module *module)
 757 {
 758         static const char *attrs[] = {
 759                 "nsUniqueId",
 760                 "objectSID",
 761                 NULL
 762         };
 763
 764         return extended_dn_out_dereference_init(module, attrs);
 765 }
 766
 767 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_ldb_module_ops = {
 768         .name              = "extended_dn_out_ldb",
 769         .search            = extended_dn_out_ldb_search,
 770         .init_context      = extended_dn_out_ldb_init,
 771 };
 772
 773 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_openldap_module_ops = {
 774         .name              = "extended_dn_out_openldap",
 775         .search            = extended_dn_out_openldap_search,
 776         .init_context      = extended_dn_out_openldap_init,
 777 };
 778
 779 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_fds_module_ops = {
 780         .name              = "extended_dn_out_fds",
 781         .search            = extended_dn_out_fds_search,
 782         .init_context      = extended_dn_out_fds_init,
 783 };