s4-dsdb: use GUID_to_ndr_blob()
[kai/samba-autobuild/.git] / 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-2009
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                 struct ldb_val guid_blob;
206                 struct GUID guid;
207                 
208                 status = GUID_from_data_blob(entryUUIDblob, &guid);
209                 
210                 if (!NT_STATUS_IS_OK(status)) {
211                         return LDB_ERR_INVALID_DN_SYNTAX;
212                 }
213                 status = GUID_to_ndr_blob(&guid, dn, &guid_blob);
214                 if (!NT_STATUS_IS_OK(status)) {
215                         return LDB_ERR_INVALID_DN_SYNTAX;
216                 }
217                 
218                 ldb_dn_set_extended_component(dn, "GUID", &guid_blob);
219         }
220         
221         sid_blob = ldb_msg_find_ldb_val(&fake_msg, "objectSID");
222         
223         /* Look for the objectSID */
224         if (sid_blob) {
225                 ldb_dn_set_extended_component(dn, "SID", sid_blob);
226         }
227         return LDB_SUCCESS;
228 }
229
230 static int handle_dereference_fds(struct ldb_dn *dn,
231                               struct dsdb_openldap_dereference_result **dereference_attrs, 
232                               const char *attr, const DATA_BLOB *val)
233 {
234         const struct ldb_val *nsUniqueIdBlob, *sidBlob;
235         struct ldb_message fake_msg; /* easier to use routines that expect an ldb_message */
236         int j;
237         
238         fake_msg.num_elements = 0;
239                         
240         /* Look for this attribute in the returned control */
241         for (j = 0; dereference_attrs && dereference_attrs[j]; j++) {
242                 struct ldb_val source_dn = data_blob_string_const(dereference_attrs[j]->dereferenced_dn);
243                 if (ldb_attr_cmp(dereference_attrs[j]->source_attribute, attr) == 0
244                     && data_blob_cmp(&source_dn, val) == 0) {
245                         fake_msg.num_elements = dereference_attrs[j]->num_attributes;
246                         fake_msg.elements = dereference_attrs[j]->attributes;
247                         break;
248                 }
249         }
250         if (!fake_msg.num_elements) {
251                 return LDB_SUCCESS;
252         }
253
254         /* Look for the nsUniqueId */
255         
256         nsUniqueIdBlob = ldb_msg_find_ldb_val(&fake_msg, "nsUniqueId");
257         if (nsUniqueIdBlob) {
258                 NTSTATUS status;
259                 struct ldb_val guid_blob;
260                 struct GUID guid;
261                 
262                 status = NS_GUID_from_string((char *)nsUniqueIdBlob->data, &guid);
263                 
264                 if (!NT_STATUS_IS_OK(status)) {
265                         return LDB_ERR_INVALID_DN_SYNTAX;
266                 }
267                 status = GUID_to_ndr_blob(&guid, dn, &guid_blob);
268                 if (!NT_STATUS_IS_OK(status)) {
269                         return LDB_ERR_INVALID_DN_SYNTAX;
270                 }
271                 
272                 ldb_dn_set_extended_component(dn, "GUID", &guid_blob);
273         }
274         
275         /* Look for the objectSID */
276
277         sidBlob = ldb_msg_find_ldb_val(&fake_msg, "sambaSID");
278         if (sidBlob) {
279                 enum ndr_err_code ndr_err;
280
281                 struct ldb_val sid_blob;
282                 struct dom_sid *sid;
283
284                 sid = dom_sid_parse_length(NULL, sidBlob);
285
286                 if (sid == NULL) {
287                         return LDB_ERR_INVALID_DN_SYNTAX;
288                 }
289
290                 ndr_err = ndr_push_struct_blob(&sid_blob, NULL, NULL, sid,
291                                                 (ndr_push_flags_fn_t)ndr_push_dom_sid);
292                 talloc_free(sid);
293                 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
294                         return LDB_ERR_INVALID_DN_SYNTAX;
295                 }
296
297                 ldb_dn_set_extended_component(dn, "SID", &sid_blob);
298         }
299         return LDB_SUCCESS;
300 }
301
302 /* search */
303 struct extended_search_context {
304         struct ldb_module *module;
305         const struct dsdb_schema *schema;
306         struct ldb_request *req;
307         bool inject;
308         bool remove_guid;
309         bool remove_sid;
310         int extended_type;
311 };
312
313 static int extended_callback(struct ldb_request *req, struct ldb_reply *ares,
314                 int (*handle_dereference)(struct ldb_dn *dn,
315                                 struct dsdb_openldap_dereference_result **dereference_attrs, 
316                                 const char *attr, const DATA_BLOB *val))
317 {
318         struct extended_search_context *ac;
319         struct ldb_control *control;
320         struct dsdb_openldap_dereference_result_control *dereference_control = NULL;
321         int ret, i, j;
322         struct ldb_message *msg = ares->message;
323         struct extended_dn_out_private *p;
324         struct ldb_context *ldb;
325         ac = talloc_get_type(req->context, struct extended_search_context);
326         p = talloc_get_type(ldb_module_get_private(ac->module), struct extended_dn_out_private);
327         ldb = ldb_module_get_ctx(ac->module);
328         if (!ares) {
329                 return ldb_module_done(ac->req, NULL, NULL,
330                                         LDB_ERR_OPERATIONS_ERROR);
331         }
332         if (ares->error != LDB_SUCCESS) {
333                 return ldb_module_done(ac->req, ares->controls,
334                                         ares->response, ares->error);
335         }
336
337         switch (ares->type) {
338         case LDB_REPLY_REFERRAL:
339                 return ldb_module_send_referral(ac->req, ares->referral);
340
341         case LDB_REPLY_DONE:
342                 return ldb_module_done(ac->req, ares->controls,
343                                         ares->response, LDB_SUCCESS);
344         case LDB_REPLY_ENTRY:
345                 break;
346         }
347
348         if (p && p->normalise) {
349                 ret = fix_dn(ares->message->dn);
350                 if (ret != LDB_SUCCESS) {
351                         return ldb_module_done(ac->req, NULL, NULL, ret);
352                 }
353         }
354                         
355         if (ac->inject) {
356                 /* for each record returned post-process to add any derived
357                    attributes that have been asked for */
358                 ret = inject_extended_dn_out(ares, ldb,
359                                              ac->extended_type, ac->remove_guid,
360                                              ac->remove_sid);
361                 if (ret != LDB_SUCCESS) {
362                         return ldb_module_done(ac->req, NULL, NULL, ret);
363                 }
364         }
365
366         if ((p && p->normalise) || ac->inject) {
367                 const struct ldb_val *val = ldb_msg_find_ldb_val(ares->message, "distinguishedName");
368                 if (val) {
369                         ldb_msg_remove_attr(ares->message, "distinguishedName");
370                         if (ac->inject) {
371                                 ret = ldb_msg_add_steal_string(ares->message, "distinguishedName", 
372                                                                ldb_dn_get_extended_linearized(ares->message, ares->message->dn, ac->extended_type));
373                         } else {
374                                 ret = ldb_msg_add_linearized_dn(ares->message,
375                                                                 "distinguishedName",
376                                                                 ares->message->dn);
377                         }
378                         if (ret != LDB_SUCCESS) {
379                                 ldb_oom(ldb);
380                                 return LDB_ERR_OPERATIONS_ERROR;
381                         }
382                 }
383         }
384
385         if (p && p->dereference) {
386                 control = ldb_reply_get_control(ares, DSDB_OPENLDAP_DEREFERENCE_CONTROL);
387         
388                 if (control && control->data) {
389                         dereference_control = talloc_get_type(control->data, struct dsdb_openldap_dereference_result_control);
390                 }
391         }
392
393         /* Walk the retruned elements (but only if we have a schema to interpret the list with) */
394         for (i = 0; ac->schema && i < msg->num_elements; i++) {
395                 bool make_extended_dn;
396                 const struct dsdb_attribute *attribute;
397                 attribute = dsdb_attribute_by_lDAPDisplayName(ac->schema, msg->elements[i].name);
398                 if (!attribute) {
399                         continue;
400                 }
401
402                 if (p->normalise) {
403                         /* If we are also in 'normalise' mode, then
404                          * fix the attribute names to be in the
405                          * correct case */
406                         msg->elements[i].name = talloc_strdup(msg->elements, attribute->lDAPDisplayName);
407                         if (!msg->elements[i].name) {
408                                 ldb_oom(ldb);
409                                 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_OPERATIONS_ERROR);
410                         }
411                 }
412
413                 /* distinguishedName has been dealt with above */
414                 if (ldb_attr_cmp(msg->elements[i].name, "distinguishedName") == 0) {
415                         continue;
416                 }
417
418                 /* Look to see if this attributeSyntax is a DN */
419                 if (dsdb_dn_oid_to_format(attribute->syntax->ldap_oid) == DSDB_INVALID_DN) {
420                         continue;
421                 }
422
423                 make_extended_dn = ac->inject;
424
425                 /* Always show plain DN in case of Object(OR-Name) syntax */
426                 if (make_extended_dn) {
427                         make_extended_dn = (strcmp(attribute->syntax->ldap_oid, DSDB_SYNTAX_OR_NAME) != 0);
428                 }
429
430                 for (j = 0; j < msg->elements[i].num_values; j++) {
431                         const char *dn_str;
432                         struct ldb_dn *dn;
433                         struct dsdb_dn *dsdb_dn = NULL;
434                         struct ldb_val *plain_dn = &msg->elements[i].values[j];         
435                         dsdb_dn = dsdb_dn_parse(msg, ldb, plain_dn, attribute->syntax->ldap_oid);
436                         
437                         if (!dsdb_dn || !ldb_dn_validate(dsdb_dn->dn)) {
438                                 ldb_asprintf_errstring(ldb, 
439                                                        "could not parse %.*s in %s on %s as a %s DN", 
440                                                        (int)plain_dn->length, plain_dn->data,
441                                                        msg->elements[i].name, ldb_dn_get_linearized(msg->dn),
442                                                        attribute->syntax->ldap_oid);
443                                 talloc_free(dsdb_dn);
444                                 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_INVALID_DN_SYNTAX);
445                         }
446                         dn = dsdb_dn->dn;
447
448                         if (p->normalise) {
449                                 ret = fix_dn(dn);
450                                 if (ret != LDB_SUCCESS) {
451                                         talloc_free(dsdb_dn);
452                                         return ldb_module_done(ac->req, NULL, NULL, ret);
453                                 }
454                         }
455                         
456                         /* If we are running in dereference mode (such
457                          * as against OpenLDAP) then the DN in the msg
458                          * above does not contain the extended values,
459                          * and we need to look in the dereference
460                          * result */
461
462                         /* Look for this value in the attribute */
463
464                         if (dereference_control) {
465                                 ret = handle_dereference(dn, 
466                                                          dereference_control->attributes,
467                                                          msg->elements[i].name,
468                                                          &msg->elements[i].values[j]);
469                                 if (ret != LDB_SUCCESS) {
470                                         talloc_free(dsdb_dn);
471                                         return ldb_module_done(ac->req, NULL, NULL, ret);
472                                 }
473                         }
474                         
475                         if (make_extended_dn) {
476                                 dn_str = dsdb_dn_get_extended_linearized(msg->elements[i].values,
477                                                                          dsdb_dn, ac->extended_type);
478                         } else {
479                                 dn_str = dsdb_dn_get_linearized(msg->elements[i].values, 
480                                                                 dsdb_dn);
481                         }
482                         
483                         if (!dn_str) {
484                                 ldb_oom(ldb);
485                                 talloc_free(dsdb_dn);
486                                 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_OPERATIONS_ERROR);
487                         }
488                         msg->elements[i].values[j] = data_blob_string_const(dn_str);
489                         talloc_free(dsdb_dn);
490                 }
491         }
492         return ldb_module_send_entry(ac->req, msg, ares->controls);
493 }
494
495 static int extended_callback_ldb(struct ldb_request *req, struct ldb_reply *ares)
496 {
497         return extended_callback(req, ares, NULL);
498 }
499
500 static int extended_callback_openldap(struct ldb_request *req, struct ldb_reply *ares)
501 {
502         return extended_callback(req, ares, handle_dereference_openldap);
503 }
504
505 static int extended_callback_fds(struct ldb_request *req, struct ldb_reply *ares)
506 {
507         return extended_callback(req, ares, handle_dereference_fds);
508 }
509
510 static int extended_dn_out_search(struct ldb_module *module, struct ldb_request *req,
511                 int (*callback)(struct ldb_request *req, struct ldb_reply *ares))
512 {
513         struct ldb_control *control;
514         struct ldb_control *storage_format_control;
515         struct ldb_extended_dn_control *extended_ctrl = NULL;
516         struct ldb_control **saved_controls;
517         struct extended_search_context *ac;
518         struct ldb_request *down_req;
519         char **new_attrs;
520         const char * const *const_attrs;
521         struct ldb_context *ldb = ldb_module_get_ctx(module);
522         int ret;
523
524         struct extended_dn_out_private *p = talloc_get_type(ldb_module_get_private(module), struct extended_dn_out_private);
525
526         /* check if there's an extended dn control */
527         control = ldb_request_get_control(req, LDB_CONTROL_EXTENDED_DN_OID);
528         if (control && control->data) {
529                 extended_ctrl = talloc_get_type(control->data, struct ldb_extended_dn_control);
530                 if (!extended_ctrl) {
531                         return LDB_ERR_PROTOCOL_ERROR;
532                 }
533         }
534
535         /* Look to see if, as we are in 'store DN+GUID+SID' mode, the
536          * client is after the storage format (to fill in linked
537          * attributes) */
538         storage_format_control = ldb_request_get_control(req, DSDB_CONTROL_DN_STORAGE_FORMAT_OID);
539         if (!control && storage_format_control && storage_format_control->data) {
540                 extended_ctrl = talloc_get_type(storage_format_control->data, struct ldb_extended_dn_control);
541                 if (!extended_ctrl) {
542                         ldb_set_errstring(ldb, "extended_dn_out: extended_ctrl was of the wrong data type");
543                         return LDB_ERR_PROTOCOL_ERROR;
544                 }
545         }
546
547         ac = talloc_zero(req, struct extended_search_context);
548         if (ac == NULL) {
549                 ldb_oom(ldb);
550                 return LDB_ERR_OPERATIONS_ERROR;
551         }
552
553         ac->module = module;
554         ac->schema = dsdb_get_schema(ldb);
555         ac->req = req;
556         ac->inject = false;
557         ac->remove_guid = false;
558         ac->remove_sid = false;
559         
560         const_attrs = req->op.search.attrs;
561
562         /* We only need to do special processing if we were asked for
563          * the extended DN, or we are 'store DN+GUID+SID'
564          * (!dereference) mode.  (This is the normal mode for LDB on
565          * tdb). */
566         if (control || (storage_format_control && p && !p->dereference)) {
567                 ac->inject = true;
568                 if (extended_ctrl) {
569                         ac->extended_type = extended_ctrl->type;
570                 } else {
571                         ac->extended_type = 0;
572                 }
573
574                 /* check if attrs only is specified, in that case check wether we need to modify them */
575                 if (req->op.search.attrs && !is_attr_in_list(req->op.search.attrs, "*")) {
576                         if (! is_attr_in_list(req->op.search.attrs, "objectGUID")) {
577                                 ac->remove_guid = true;
578                         }
579                         if (! is_attr_in_list(req->op.search.attrs, "objectSID")) {
580                                 ac->remove_sid = true;
581                         }
582                         if (ac->remove_guid || ac->remove_sid) {
583                                 new_attrs = copy_attrs(ac, req->op.search.attrs);
584                                 if (new_attrs == NULL) {
585                                         ldb_oom(ldb);
586                                         return LDB_ERR_OPERATIONS_ERROR;
587                                 }
588
589                                 if (ac->remove_guid) {
590                                         if (!add_attrs(ac, &new_attrs, "objectGUID"))
591                                                 return LDB_ERR_OPERATIONS_ERROR;
592                                 }
593                                 if (ac->remove_sid) {
594                                         if (!add_attrs(ac, &new_attrs, "objectSID"))
595                                                 return LDB_ERR_OPERATIONS_ERROR;
596                                 }
597                                 const_attrs = (const char * const *)new_attrs;
598                         }
599                 }
600         }
601
602         ret = ldb_build_search_req_ex(&down_req,
603                                       ldb, ac,
604                                       req->op.search.base,
605                                       req->op.search.scope,
606                                       req->op.search.tree,
607                                       const_attrs,
608                                       req->controls,
609                                       ac, callback,
610                                       req);
611         if (ret != LDB_SUCCESS) {
612                 return ret;
613         }
614
615         /* Remove extended DN and storage format controls */
616
617         if (control) {
618                 /* save it locally and remove it from the list */
619                 /* we do not need to replace them later as we
620                  * are keeping the original req intact */
621                 if (!save_controls(control, down_req, &saved_controls)) {
622                         return LDB_ERR_OPERATIONS_ERROR;
623                 }
624         }
625
626         if (storage_format_control) {
627                 /* save it locally and remove it from the list */
628                 /* we do not need to replace them later as we
629                  * are keeping the original req intact */
630                 if (!save_controls(storage_format_control, down_req, &saved_controls)) {
631                         return LDB_ERR_OPERATIONS_ERROR;
632                 }
633         }
634
635         /* Add in dereference control, if we were asked to, we are
636          * using the 'dereference' mode (such as with an OpenLDAP
637          * backend) and have the control prepared */
638         if (control && p && p->dereference && p->dereference_control) {
639                 ret = ldb_request_add_control(down_req,
640                                               DSDB_OPENLDAP_DEREFERENCE_CONTROL,
641                                               false, p->dereference_control);
642                 if (ret != LDB_SUCCESS) {
643                         return ret;
644                 }
645         }
646
647         /* perform the search */
648         return ldb_next_request(module, down_req);
649 }
650
651 static int extended_dn_out_ldb_search(struct ldb_module *module, struct ldb_request *req)
652 {
653         return extended_dn_out_search(module, req, extended_callback_ldb);
654 }
655
656 static int extended_dn_out_openldap_search(struct ldb_module *module, struct ldb_request *req)
657 {
658         return extended_dn_out_search(module, req, extended_callback_openldap);
659 }
660
661 static int extended_dn_out_fds_search(struct ldb_module *module, struct ldb_request *req)
662 {
663         return extended_dn_out_search(module, req, extended_callback_fds);
664 }
665
666 static int extended_dn_out_ldb_init(struct ldb_module *module)
667 {
668         int ret;
669
670         struct extended_dn_out_private *p = talloc(module, struct extended_dn_out_private);
671         struct dsdb_extended_dn_store_format *dn_format;
672
673         ldb_module_set_private(module, p);
674
675         if (!p) {
676                 ldb_oom(ldb_module_get_ctx(module));
677                 return LDB_ERR_OPERATIONS_ERROR;
678         }
679
680         dn_format = talloc(p, struct dsdb_extended_dn_store_format);
681         if (!dn_format) {
682                 talloc_free(p);
683                 ldb_oom(ldb_module_get_ctx(module));
684                 return LDB_ERR_OPERATIONS_ERROR;
685         }
686
687         dn_format->store_extended_dn_in_ldb = true;
688         ret = ldb_set_opaque(ldb_module_get_ctx(module), DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME, dn_format);
689         if (ret != LDB_SUCCESS) {
690                 talloc_free(p);
691                 return ret;
692         }
693
694         p->dereference = false;
695         p->normalise = false;
696
697         ret = ldb_mod_register_control(module, LDB_CONTROL_EXTENDED_DN_OID);
698         if (ret != LDB_SUCCESS) {
699                 ldb_debug(ldb_module_get_ctx(module), LDB_DEBUG_ERROR,
700                         "extended_dn_out: Unable to register control with rootdse!\n");
701                 return LDB_ERR_OPERATIONS_ERROR;
702         }
703
704         return ldb_next_init(module);
705 }
706
707 static int extended_dn_out_dereference_init(struct ldb_module *module, const char *attrs[])
708 {
709         int ret, i = 0;
710         struct extended_dn_out_private *p = talloc_zero(module, struct extended_dn_out_private);
711         struct dsdb_extended_dn_store_format *dn_format;
712         struct dsdb_openldap_dereference_control *dereference_control;
713         struct dsdb_attribute *cur;
714         struct ldb_context *ldb = ldb_module_get_ctx(module);
715         struct dsdb_schema *schema;
716
717         ldb_module_set_private(module, p);
718
719         if (!p) {
720                 ldb_oom(ldb);
721                 return LDB_ERR_OPERATIONS_ERROR;
722         }
723
724         dn_format = talloc(p, struct dsdb_extended_dn_store_format);
725         if (!dn_format) {
726                 talloc_free(p);
727                 ldb_oom(ldb_module_get_ctx(module));
728                 return LDB_ERR_OPERATIONS_ERROR;
729         }
730
731         dn_format->store_extended_dn_in_ldb = false;
732
733         ret = ldb_set_opaque(ldb_module_get_ctx(module), DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME, dn_format);
734         if (ret != LDB_SUCCESS) {
735                 talloc_free(p);
736                 return ret;
737         }
738
739         p->dereference = true;
740
741         /* At the moment, servers that need dereference also need the
742          * DN and attribute names to be normalised */
743         p->normalise = true;
744
745         ret = ldb_mod_register_control(module, LDB_CONTROL_EXTENDED_DN_OID);
746         if (ret != LDB_SUCCESS) {
747                 ldb_debug(ldb, LDB_DEBUG_ERROR,
748                         "extended_dn_out: Unable to register control with rootdse!\n");
749                 return LDB_ERR_OPERATIONS_ERROR;
750         }
751
752         ret = ldb_next_init(module);
753
754         if (ret != LDB_SUCCESS) {
755                 return ret;
756         }
757
758         schema = dsdb_get_schema(ldb);
759         if (!schema) {
760                 /* No schema on this DB (yet) */
761                 return LDB_SUCCESS;
762         }
763
764         p->dereference_control = dereference_control
765                 = talloc_zero(p, struct dsdb_openldap_dereference_control);
766
767         if (!p->dereference_control) {
768                 ldb_oom(ldb);
769                 return LDB_ERR_OPERATIONS_ERROR;
770         }
771         
772         for (cur = schema->attributes; cur; cur = cur->next) {
773                 if (dsdb_dn_oid_to_format(cur->syntax->ldap_oid) == DSDB_INVALID_DN) {
774                         continue;
775                 }
776                 dereference_control->dereference
777                         = talloc_realloc(p, dereference_control->dereference,
778                                          struct dsdb_openldap_dereference *, i + 2);
779                 if (!dereference_control) {
780                         ldb_oom(ldb);
781                         return LDB_ERR_OPERATIONS_ERROR;
782                 }
783                 dereference_control->dereference[i] = talloc(dereference_control->dereference,  
784                                          struct dsdb_openldap_dereference);
785                 if (!dereference_control->dereference[i]) {
786                         ldb_oom(ldb);
787                         return LDB_ERR_OPERATIONS_ERROR;
788                 }
789                 dereference_control->dereference[i]->source_attribute = cur->lDAPDisplayName;
790                 dereference_control->dereference[i]->dereference_attribute = attrs;
791                 i++;
792                 dereference_control->dereference[i] = NULL;
793         }
794         return LDB_SUCCESS;
795 }
796
797 static int extended_dn_out_openldap_init(struct ldb_module *module)
798 {
799         static const char *attrs[] = {
800                 "entryUUID",
801                 "objectSID",
802                 NULL
803         };
804
805         return extended_dn_out_dereference_init(module, attrs);
806 }
807
808 static int extended_dn_out_fds_init(struct ldb_module *module)
809 {
810         static const char *attrs[] = {
811                 "nsUniqueId",
812                 "objectSID",
813                 NULL
814         };
815
816         return extended_dn_out_dereference_init(module, attrs);
817 }
818
819 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_ldb_module_ops = {
820         .name              = "extended_dn_out_ldb",
821         .search            = extended_dn_out_ldb_search,
822         .init_context      = extended_dn_out_ldb_init,
823 };
824
825 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_openldap_module_ops = {
826         .name              = "extended_dn_out_openldap",
827         .search            = extended_dn_out_openldap_search,
828         .init_context      = extended_dn_out_openldap_init,
829 };
830
831 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_fds_module_ops = {
832         .name              = "extended_dn_out_fds",
833         .search            = extended_dn_out_fds_search,
834         .init_context      = extended_dn_out_fds_init,
835 };