added new function "ldb_msg_add_dn"
[samba.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                 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         struct ldb_context *ldb;
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         ldb = ldb_module_get_ctx(ac->module);
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,
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_dn(ares->message,
381                                                      "distinguishedName",
382                                                      ares->message->dn);
383                         }
384                         if (ret != LDB_SUCCESS) {
385                                 ldb_oom(ldb);
386                                 return LDB_ERR_OPERATIONS_ERROR;
387                         }
388                 }
389         }
390
391         if (p && p->dereference) {
392                 control = ldb_reply_get_control(ares, DSDB_OPENLDAP_DEREFERENCE_CONTROL);
393         
394                 if (control && control->data) {
395                         dereference_control = talloc_get_type(control->data, struct dsdb_openldap_dereference_result_control);
396                 }
397         }
398
399         /* Walk the retruned elements (but only if we have a schema to interpret the list with) */
400         for (i = 0; ac->schema && i < msg->num_elements; i++) {
401                 const struct dsdb_attribute *attribute;
402                 attribute = dsdb_attribute_by_lDAPDisplayName(ac->schema, msg->elements[i].name);
403                 if (!attribute) {
404                         continue;
405                 }
406
407                 if (p->normalise) {
408                         /* If we are also in 'normalise' mode, then
409                          * fix the attribute names to be in the
410                          * correct case */
411                         msg->elements[i].name = talloc_strdup(msg->elements, attribute->lDAPDisplayName);
412                         if (!msg->elements[i].name) {
413                                 ldb_oom(ldb);
414                                 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_OPERATIONS_ERROR);
415                         }
416                 }
417
418                 /* distinguishedName has been dealt with above */
419                 if (ldb_attr_cmp(msg->elements[i].name, "distinguishedName") == 0) {
420                         continue;
421                 }
422
423                 /* Look to see if this attributeSyntax is a DN */
424                 if (dsdb_dn_oid_to_format(attribute->syntax->ldap_oid) == DSDB_INVALID_DN) {
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;
431                         struct dsdb_dn *dsdb_dn = NULL;
432                         struct ldb_val *plain_dn = &msg->elements[i].values[j];         
433                         dsdb_dn = dsdb_dn_parse(msg, ldb, plain_dn, attribute->syntax->ldap_oid);
434                         
435                         if (!dsdb_dn || !ldb_dn_validate(dsdb_dn->dn)) {
436                                 ldb_asprintf_errstring(ldb, 
437                                                        "could not parse %.*s in %s on %s as a %s DN", 
438                                                        (int)plain_dn->length, plain_dn->data,
439                                                        msg->elements[i].name, ldb_dn_get_linearized(msg->dn),
440                                                        attribute->syntax->ldap_oid);
441                                 talloc_free(dsdb_dn);
442                                 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_INVALID_DN_SYNTAX);
443                         }
444                         dn = dsdb_dn->dn;
445
446                         if (p->normalise) {
447                                 ret = fix_dn(dn);
448                                 if (ret != LDB_SUCCESS) {
449                                         talloc_free(dsdb_dn);
450                                         return ldb_module_done(ac->req, NULL, NULL, ret);
451                                 }
452                         }
453                         
454                         /* If we are running in dereference mode (such
455                          * as against OpenLDAP) then the DN in the msg
456                          * above does not contain the extended values,
457                          * and we need to look in the dereference
458                          * result */
459
460                         /* Look for this value in the attribute */
461
462                         if (dereference_control) {
463                                 ret = handle_dereference(dn, 
464                                                          dereference_control->attributes,
465                                                          msg->elements[i].name,
466                                                          &msg->elements[i].values[j]);
467                                 if (ret != LDB_SUCCESS) {
468                                         talloc_free(dsdb_dn);
469                                         return ldb_module_done(ac->req, NULL, NULL, ret);
470                                 }
471                         }
472                         
473                         if (!ac->inject) {
474                                 dn_str = dsdb_dn_get_linearized(msg->elements[i].values, 
475                                                                 dsdb_dn);
476                         } else {
477                                 dn_str = dsdb_dn_get_extended_linearized(msg->elements[i].values, 
478                                                                          dsdb_dn, ac->extended_type);
479                         }
480                         
481                         if (!dn_str) {
482                                 ldb_oom(ldb);
483                                 talloc_free(dsdb_dn);
484                                 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_OPERATIONS_ERROR);
485                         }
486                         msg->elements[i].values[j] = data_blob_string_const(dn_str);
487                         talloc_free(dsdb_dn);
488                 }
489         }
490         return ldb_module_send_entry(ac->req, msg, ares->controls);
491 }
492
493 static int extended_callback_ldb(struct ldb_request *req, struct ldb_reply *ares)
494 {
495         return extended_callback(req, ares, NULL);
496 }
497
498 static int extended_callback_openldap(struct ldb_request *req, struct ldb_reply *ares)
499 {
500         return extended_callback(req, ares, handle_dereference_openldap);
501 }
502
503 static int extended_callback_fds(struct ldb_request *req, struct ldb_reply *ares)
504 {
505         return extended_callback(req, ares, handle_dereference_fds);
506 }
507
508 static int extended_dn_out_search(struct ldb_module *module, struct ldb_request *req,
509                 int (*callback)(struct ldb_request *req, struct ldb_reply *ares))
510 {
511         struct ldb_control *control;
512         struct ldb_control *storage_format_control;
513         struct ldb_extended_dn_control *extended_ctrl = NULL;
514         struct ldb_control **saved_controls;
515         struct extended_search_context *ac;
516         struct ldb_request *down_req;
517         char **new_attrs;
518         const char * const *const_attrs;
519         struct ldb_context *ldb = ldb_module_get_ctx(module);
520         int ret;
521
522         struct extended_dn_out_private *p = talloc_get_type(ldb_module_get_private(module), struct extended_dn_out_private);
523
524         /* check if there's an extended dn control */
525         control = ldb_request_get_control(req, LDB_CONTROL_EXTENDED_DN_OID);
526         if (control && control->data) {
527                 extended_ctrl = talloc_get_type(control->data, struct ldb_extended_dn_control);
528                 if (!extended_ctrl) {
529                         return LDB_ERR_PROTOCOL_ERROR;
530                 }
531         }
532
533         /* Look to see if, as we are in 'store DN+GUID+SID' mode, the
534          * client is after the storage format (to fill in linked
535          * attributes) */
536         storage_format_control = ldb_request_get_control(req, DSDB_CONTROL_DN_STORAGE_FORMAT_OID);
537         if (!control && storage_format_control && storage_format_control->data) {
538                 extended_ctrl = talloc_get_type(storage_format_control->data, struct ldb_extended_dn_control);
539                 if (!extended_ctrl) {
540                         ldb_set_errstring(ldb, "extended_dn_out: extended_ctrl was of the wrong data type");
541                         return LDB_ERR_PROTOCOL_ERROR;
542                 }
543         }
544
545         ac = talloc_zero(req, struct extended_search_context);
546         if (ac == NULL) {
547                 ldb_oom(ldb);
548                 return LDB_ERR_OPERATIONS_ERROR;
549         }
550
551         ac->module = module;
552         ac->schema = dsdb_get_schema(ldb);
553         ac->req = req;
554         ac->inject = false;
555         ac->remove_guid = false;
556         ac->remove_sid = false;
557         
558         const_attrs = req->op.search.attrs;
559
560         /* We only need to do special processing if we were asked for
561          * the extended DN, or we are 'store DN+GUID+SID'
562          * (!dereference) mode.  (This is the normal mode for LDB on
563          * tdb). */
564         if (control || (storage_format_control && p && !p->dereference)) {
565                 ac->inject = true;
566                 if (extended_ctrl) {
567                         ac->extended_type = extended_ctrl->type;
568                 } else {
569                         ac->extended_type = 0;
570                 }
571
572                 /* check if attrs only is specified, in that case check wether we need to modify them */
573                 if (req->op.search.attrs && !is_attr_in_list(req->op.search.attrs, "*")) {
574                         if (! is_attr_in_list(req->op.search.attrs, "objectGUID")) {
575                                 ac->remove_guid = true;
576                         }
577                         if (! is_attr_in_list(req->op.search.attrs, "objectSID")) {
578                                 ac->remove_sid = true;
579                         }
580                         if (ac->remove_guid || ac->remove_sid) {
581                                 new_attrs = copy_attrs(ac, req->op.search.attrs);
582                                 if (new_attrs == NULL) {
583                                         ldb_oom(ldb);
584                                         return LDB_ERR_OPERATIONS_ERROR;
585                                 }
586
587                                 if (ac->remove_guid) {
588                                         if (!add_attrs(ac, &new_attrs, "objectGUID"))
589                                                 return LDB_ERR_OPERATIONS_ERROR;
590                                 }
591                                 if (ac->remove_sid) {
592                                         if (!add_attrs(ac, &new_attrs, "objectSID"))
593                                                 return LDB_ERR_OPERATIONS_ERROR;
594                                 }
595                                 const_attrs = (const char * const *)new_attrs;
596                         }
597                 }
598         }
599
600         ret = ldb_build_search_req_ex(&down_req,
601                                       ldb, ac,
602                                       req->op.search.base,
603                                       req->op.search.scope,
604                                       req->op.search.tree,
605                                       const_attrs,
606                                       req->controls,
607                                       ac, callback,
608                                       req);
609         if (ret != LDB_SUCCESS) {
610                 return ret;
611         }
612
613         /* Remove extended DN and storage format controls */
614
615         if (control) {
616                 /* save it locally and remove it from the list */
617                 /* we do not need to replace them later as we
618                  * are keeping the original req intact */
619                 if (!save_controls(control, down_req, &saved_controls)) {
620                         return LDB_ERR_OPERATIONS_ERROR;
621                 }
622         }
623
624         if (storage_format_control) {
625                 /* save it locally and remove it from the list */
626                 /* we do not need to replace them later as we
627                  * are keeping the original req intact */
628                 if (!save_controls(storage_format_control, down_req, &saved_controls)) {
629                         return LDB_ERR_OPERATIONS_ERROR;
630                 }
631         }
632
633         /* Add in dereference control, if we were asked to, we are
634          * using the 'dereference' mode (such as with an OpenLDAP
635          * backend) and have the control prepared */
636         if (control && p && p->dereference && p->dereference_control) {
637                 ret = ldb_request_add_control(down_req,
638                                               DSDB_OPENLDAP_DEREFERENCE_CONTROL,
639                                               false, p->dereference_control);
640                 if (ret != LDB_SUCCESS) {
641                         return ret;
642                 }
643         }
644
645         /* perform the search */
646         return ldb_next_request(module, down_req);
647 }
648
649 static int extended_dn_out_ldb_search(struct ldb_module *module, struct ldb_request *req)
650 {
651         return extended_dn_out_search(module, req, extended_callback_ldb);
652 }
653
654 static int extended_dn_out_openldap_search(struct ldb_module *module, struct ldb_request *req)
655 {
656         return extended_dn_out_search(module, req, extended_callback_openldap);
657 }
658
659 static int extended_dn_out_fds_search(struct ldb_module *module, struct ldb_request *req)
660 {
661         return extended_dn_out_search(module, req, extended_callback_fds);
662 }
663
664 static int extended_dn_out_ldb_init(struct ldb_module *module)
665 {
666         int ret;
667
668         struct extended_dn_out_private *p = talloc(module, struct extended_dn_out_private);
669         struct dsdb_extended_dn_store_format *dn_format;
670
671         ldb_module_set_private(module, p);
672
673         if (!p) {
674                 ldb_oom(ldb_module_get_ctx(module));
675                 return LDB_ERR_OPERATIONS_ERROR;
676         }
677
678         dn_format = talloc(p, struct dsdb_extended_dn_store_format);
679         if (!dn_format) {
680                 talloc_free(p);
681                 ldb_oom(ldb_module_get_ctx(module));
682                 return LDB_ERR_OPERATIONS_ERROR;
683         }
684
685         dn_format->store_extended_dn_in_ldb = true;
686         ret = ldb_set_opaque(ldb_module_get_ctx(module), DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME, dn_format);
687         if (ret != LDB_SUCCESS) {
688                 talloc_free(p);
689                 return ret;
690         }
691
692         p->dereference = false;
693         p->normalise = false;
694
695         ret = ldb_mod_register_control(module, LDB_CONTROL_EXTENDED_DN_OID);
696         if (ret != LDB_SUCCESS) {
697                 ldb_debug(ldb_module_get_ctx(module), LDB_DEBUG_ERROR,
698                         "extended_dn_out: Unable to register control with rootdse!\n");
699                 return LDB_ERR_OPERATIONS_ERROR;
700         }
701
702         return ldb_next_init(module);
703 }
704
705 static int extended_dn_out_dereference_init(struct ldb_module *module, const char *attrs[])
706 {
707         int ret, i = 0;
708         struct extended_dn_out_private *p = talloc_zero(module, struct extended_dn_out_private);
709         struct dsdb_extended_dn_store_format *dn_format;
710         struct dsdb_openldap_dereference_control *dereference_control;
711         struct dsdb_attribute *cur;
712         struct ldb_context *ldb = ldb_module_get_ctx(module);
713         struct dsdb_schema *schema;
714
715         ldb_module_set_private(module, p);
716
717         if (!p) {
718                 ldb_oom(ldb);
719                 return LDB_ERR_OPERATIONS_ERROR;
720         }
721
722         dn_format = talloc(p, struct dsdb_extended_dn_store_format);
723         if (!dn_format) {
724                 talloc_free(p);
725                 ldb_oom(ldb_module_get_ctx(module));
726                 return LDB_ERR_OPERATIONS_ERROR;
727         }
728
729         dn_format->store_extended_dn_in_ldb = false;
730
731         ret = ldb_set_opaque(ldb_module_get_ctx(module), DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME, dn_format);
732         if (ret != LDB_SUCCESS) {
733                 talloc_free(p);
734                 return ret;
735         }
736
737         p->dereference = true;
738
739         /* At the moment, servers that need dereference also need the
740          * DN and attribute names to be normalised */
741         p->normalise = true;
742
743         ret = ldb_mod_register_control(module, LDB_CONTROL_EXTENDED_DN_OID);
744         if (ret != LDB_SUCCESS) {
745                 ldb_debug(ldb, LDB_DEBUG_ERROR,
746                         "extended_dn_out: Unable to register control with rootdse!\n");
747                 return LDB_ERR_OPERATIONS_ERROR;
748         }
749
750         ret = ldb_next_init(module);
751
752         if (ret != LDB_SUCCESS) {
753                 return ret;
754         }
755
756         schema = dsdb_get_schema(ldb);
757         if (!schema) {
758                 /* No schema on this DB (yet) */
759                 return LDB_SUCCESS;
760         }
761
762         p->dereference_control = dereference_control
763                 = talloc_zero(p, struct dsdb_openldap_dereference_control);
764
765         if (!p->dereference_control) {
766                 ldb_oom(ldb);
767                 return LDB_ERR_OPERATIONS_ERROR;
768         }
769         
770         for (cur = schema->attributes; cur; cur = cur->next) {
771                 if (dsdb_dn_oid_to_format(cur->syntax->ldap_oid) == DSDB_INVALID_DN) {
772                         continue;
773                 }
774                 dereference_control->dereference
775                         = talloc_realloc(p, dereference_control->dereference,
776                                          struct dsdb_openldap_dereference *, i + 2);
777                 if (!dereference_control) {
778                         ldb_oom(ldb);
779                         return LDB_ERR_OPERATIONS_ERROR;
780                 }
781                 dereference_control->dereference[i] = talloc(dereference_control->dereference,  
782                                          struct dsdb_openldap_dereference);
783                 if (!dereference_control->dereference[i]) {
784                         ldb_oom(ldb);
785                         return LDB_ERR_OPERATIONS_ERROR;
786                 }
787                 dereference_control->dereference[i]->source_attribute = cur->lDAPDisplayName;
788                 dereference_control->dereference[i]->dereference_attribute = attrs;
789                 i++;
790                 dereference_control->dereference[i] = NULL;
791         }
792         return LDB_SUCCESS;
793 }
794
795 static int extended_dn_out_openldap_init(struct ldb_module *module)
796 {
797         static const char *attrs[] = {
798                 "entryUUID",
799                 "objectSID",
800                 NULL
801         };
802
803         return extended_dn_out_dereference_init(module, attrs);
804 }
805
806 static int extended_dn_out_fds_init(struct ldb_module *module)
807 {
808         static const char *attrs[] = {
809                 "nsUniqueId",
810                 "objectSID",
811                 NULL
812         };
813
814         return extended_dn_out_dereference_init(module, attrs);
815 }
816
817 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_ldb_module_ops = {
818         .name              = "extended_dn_out_ldb",
819         .search            = extended_dn_out_ldb_search,
820         .init_context      = extended_dn_out_ldb_init,
821 };
822
823 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_openldap_module_ops = {
824         .name              = "extended_dn_out_openldap",
825         .search            = extended_dn_out_openldap_search,
826         .init_context      = extended_dn_out_openldap_init,
827 };
828
829 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_fds_module_ops = {
830         .name              = "extended_dn_out_fds",
831         .search            = extended_dn_out_fds_search,
832         .init_context      = extended_dn_out_fds_init,
833 };