s4-dsdb: use the reveal control to hide/show extended DN components
[Samba/eduardoll.git] / source4 / dsdb / samdb / ldb_modules / extended_dn_out.c
blob987a3b3cfb4d83fa1fabd9c021fce33f1e52dc29
1 /*
2 ldb database library
4 Copyright (C) Simo Sorce 2005-2008
5 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2007-2009
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.
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.
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/>.
22 * Name: ldb
24 * Component: ldb extended dn control module
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.
30 * Authors: Simo Sorce
31 * Andrew Bartlett
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"
44 struct extended_dn_out_private {
45 bool dereference;
46 bool normalise;
47 struct dsdb_openldap_dereference_control *dereference_control;
50 static bool is_attr_in_list(const char * const * attrs, const char *attr)
52 int i;
54 for (i = 0; attrs[i]; i++) {
55 if (ldb_attr_cmp(attrs[i], attr) == 0)
56 return true;
59 return false;
62 static char **copy_attrs(void *mem_ctx, const char * const * attrs)
64 char **nattrs;
65 int i, num;
67 for (num = 0; attrs[num]; num++);
69 nattrs = talloc_array(mem_ctx, char *, num + 1);
70 if (!nattrs) return NULL;
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;
79 nattrs[i] = NULL;
81 return nattrs;
84 static bool add_attrs(void *mem_ctx, char ***attrs, const char *attr)
86 char **nattrs;
87 int num;
89 for (num = 0; (*attrs)[num]; num++);
91 nattrs = talloc_realloc(mem_ctx, *attrs, char *, num + 2);
92 if (!nattrs) return false;
94 *attrs = nattrs;
96 nattrs[num] = talloc_strdup(nattrs, attr);
97 if (!nattrs[num]) return false;
99 nattrs[num + 1] = NULL;
101 return true;
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
110 static int fix_dn(struct ldb_dn *dn)
112 int i, ret;
113 char *upper_rdn_attr;
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;
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;
131 return LDB_SUCCESS;
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 */
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)
143 int ret;
144 const DATA_BLOB *guid_blob;
145 const DATA_BLOB *sid_blob;
147 guid_blob = ldb_msg_find_ldb_val(ares->message, "objectGUID");
148 sid_blob = ldb_msg_find_ldb_val(ares->message, "objectSID");
150 if (!guid_blob) {
151 ldb_set_errstring(ldb, "Did not find objectGUID to inject into extended DN");
152 return LDB_ERR_OPERATIONS_ERROR;
155 ret = ldb_dn_set_extended_component(ares->message->dn, "GUID", guid_blob);
156 if (ret != LDB_SUCCESS) {
157 return ret;
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;
166 if (remove_guid) {
167 ldb_msg_remove_attr(ares->message, "objectGUID");
170 if (sid_blob && remove_sid) {
171 ldb_msg_remove_attr(ares->message, "objectSID");
174 return LDB_SUCCESS;
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)
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;
185 fake_msg.num_elements = 0;
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;
197 if (!fake_msg.num_elements) {
198 return LDB_SUCCESS;
200 /* Look for an OpenLDAP entryUUID */
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;
208 status = GUID_from_data_blob(entryUUIDblob, &guid);
210 if (!NT_STATUS_IS_OK(status)) {
211 return LDB_ERR_INVALID_DN_SYNTAX;
213 status = GUID_to_ndr_blob(&guid, dn, &guid_blob);
214 if (!NT_STATUS_IS_OK(status)) {
215 return LDB_ERR_INVALID_DN_SYNTAX;
218 ldb_dn_set_extended_component(dn, "GUID", &guid_blob);
221 sid_blob = ldb_msg_find_ldb_val(&fake_msg, "objectSID");
223 /* Look for the objectSID */
224 if (sid_blob) {
225 ldb_dn_set_extended_component(dn, "SID", sid_blob);
227 return LDB_SUCCESS;
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)
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;
238 fake_msg.num_elements = 0;
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;
250 if (!fake_msg.num_elements) {
251 return LDB_SUCCESS;
254 /* Look for the nsUniqueId */
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;
262 status = NS_GUID_from_string((char *)nsUniqueIdBlob->data, &guid);
264 if (!NT_STATUS_IS_OK(status)) {
265 return LDB_ERR_INVALID_DN_SYNTAX;
267 status = GUID_to_ndr_blob(&guid, dn, &guid_blob);
268 if (!NT_STATUS_IS_OK(status)) {
269 return LDB_ERR_INVALID_DN_SYNTAX;
272 ldb_dn_set_extended_component(dn, "GUID", &guid_blob);
275 /* Look for the objectSID */
277 sidBlob = ldb_msg_find_ldb_val(&fake_msg, "sambaSID");
278 if (sidBlob) {
279 enum ndr_err_code ndr_err;
281 struct ldb_val sid_blob;
282 struct dom_sid *sid;
284 sid = dom_sid_parse_length(NULL, sidBlob);
286 if (sid == NULL) {
287 return LDB_ERR_INVALID_DN_SYNTAX;
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;
297 ldb_dn_set_extended_component(dn, "SID", &sid_blob);
299 return LDB_SUCCESS;
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;
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))
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 bool have_reveal_control, checked_reveal_control=false;
327 ac = talloc_get_type(req->context, struct extended_search_context);
328 p = talloc_get_type(ldb_module_get_private(ac->module), struct extended_dn_out_private);
329 ldb = ldb_module_get_ctx(ac->module);
330 if (!ares) {
331 return ldb_module_done(ac->req, NULL, NULL,
332 LDB_ERR_OPERATIONS_ERROR);
334 if (ares->error != LDB_SUCCESS) {
335 return ldb_module_done(ac->req, ares->controls,
336 ares->response, ares->error);
339 switch (ares->type) {
340 case LDB_REPLY_REFERRAL:
341 return ldb_module_send_referral(ac->req, ares->referral);
343 case LDB_REPLY_DONE:
344 return ldb_module_done(ac->req, ares->controls,
345 ares->response, LDB_SUCCESS);
346 case LDB_REPLY_ENTRY:
347 break;
350 if (p && p->normalise) {
351 ret = fix_dn(ares->message->dn);
352 if (ret != LDB_SUCCESS) {
353 return ldb_module_done(ac->req, NULL, NULL, ret);
357 if (ac->inject) {
358 /* for each record returned post-process to add any derived
359 attributes that have been asked for */
360 ret = inject_extended_dn_out(ares, ldb,
361 ac->extended_type, ac->remove_guid,
362 ac->remove_sid);
363 if (ret != LDB_SUCCESS) {
364 return ldb_module_done(ac->req, NULL, NULL, ret);
368 if ((p && p->normalise) || ac->inject) {
369 const struct ldb_val *val = ldb_msg_find_ldb_val(ares->message, "distinguishedName");
370 if (val) {
371 ldb_msg_remove_attr(ares->message, "distinguishedName");
372 if (ac->inject) {
373 ret = ldb_msg_add_steal_string(ares->message, "distinguishedName",
374 ldb_dn_get_extended_linearized(ares->message, ares->message->dn, ac->extended_type));
375 } else {
376 ret = ldb_msg_add_linearized_dn(ares->message,
377 "distinguishedName",
378 ares->message->dn);
380 if (ret != LDB_SUCCESS) {
381 ldb_oom(ldb);
382 return LDB_ERR_OPERATIONS_ERROR;
387 if (p && p->dereference) {
388 control = ldb_reply_get_control(ares, DSDB_OPENLDAP_DEREFERENCE_CONTROL);
390 if (control && control->data) {
391 dereference_control = talloc_get_type(control->data, struct dsdb_openldap_dereference_result_control);
395 /* Walk the retruned elements (but only if we have a schema to interpret the list with) */
396 for (i = 0; ac->schema && i < msg->num_elements; i++) {
397 bool make_extended_dn;
398 const struct dsdb_attribute *attribute;
399 attribute = dsdb_attribute_by_lDAPDisplayName(ac->schema, msg->elements[i].name);
400 if (!attribute) {
401 continue;
404 if (p->normalise) {
405 /* If we are also in 'normalise' mode, then
406 * fix the attribute names to be in the
407 * correct case */
408 msg->elements[i].name = talloc_strdup(msg->elements, attribute->lDAPDisplayName);
409 if (!msg->elements[i].name) {
410 ldb_oom(ldb);
411 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_OPERATIONS_ERROR);
415 /* distinguishedName has been dealt with above */
416 if (ldb_attr_cmp(msg->elements[i].name, "distinguishedName") == 0) {
417 continue;
420 /* Look to see if this attributeSyntax is a DN */
421 if (dsdb_dn_oid_to_format(attribute->syntax->ldap_oid) == DSDB_INVALID_DN) {
422 continue;
425 make_extended_dn = ac->inject;
427 /* Always show plain DN in case of Object(OR-Name) syntax */
428 if (make_extended_dn) {
429 make_extended_dn = (strcmp(attribute->syntax->ldap_oid, DSDB_SYNTAX_OR_NAME) != 0);
432 for (j = 0; j < msg->elements[i].num_values; j++) {
433 const char *dn_str;
434 struct ldb_dn *dn;
435 struct dsdb_dn *dsdb_dn = NULL;
436 struct ldb_val *plain_dn = &msg->elements[i].values[j];
437 dsdb_dn = dsdb_dn_parse(msg, ldb, plain_dn, attribute->syntax->ldap_oid);
439 if (!dsdb_dn || !ldb_dn_validate(dsdb_dn->dn)) {
440 ldb_asprintf_errstring(ldb,
441 "could not parse %.*s in %s on %s as a %s DN",
442 (int)plain_dn->length, plain_dn->data,
443 msg->elements[i].name, ldb_dn_get_linearized(msg->dn),
444 attribute->syntax->ldap_oid);
445 talloc_free(dsdb_dn);
446 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_INVALID_DN_SYNTAX);
448 dn = dsdb_dn->dn;
450 if (!checked_reveal_control) {
451 have_reveal_control =
452 ldb_request_get_control(req, LDB_CONTROL_REVEAL_INTERNALS) != NULL;
453 checked_reveal_control = true;
456 /* this is a fast method for detecting deleted
457 linked attributes. It relies on the
458 linearization of extended DNs sorting by name,
459 and "DELETED" being the first name */
460 if (plain_dn->length >= 12 &&
461 strncmp((const char *)plain_dn->data, "<DELETED=1>;", 12) == 0) {
462 if (!have_reveal_control) {
463 /* it's a deleted linked
464 * attribute, and we don't
465 * have the reveal control */
466 memmove(&msg->elements[i].values[j],
467 &msg->elements[i].values[j+1],
468 (msg->elements[i].num_values-(j+1))*sizeof(struct ldb_val));
469 msg->elements[i].num_values--;
470 j--;
471 continue;
475 /* don't let users see the internal extended
476 GUID components */
477 if (!have_reveal_control) {
478 const char *accept[] = { "GUID", "SID", "WKGUID", NULL };
479 ldb_dn_extended_filter(dn, accept);
482 if (p->normalise) {
483 ret = fix_dn(dn);
484 if (ret != LDB_SUCCESS) {
485 talloc_free(dsdb_dn);
486 return ldb_module_done(ac->req, NULL, NULL, ret);
490 /* If we are running in dereference mode (such
491 * as against OpenLDAP) then the DN in the msg
492 * above does not contain the extended values,
493 * and we need to look in the dereference
494 * result */
496 /* Look for this value in the attribute */
498 if (dereference_control) {
499 ret = handle_dereference(dn,
500 dereference_control->attributes,
501 msg->elements[i].name,
502 &msg->elements[i].values[j]);
503 if (ret != LDB_SUCCESS) {
504 talloc_free(dsdb_dn);
505 return ldb_module_done(ac->req, NULL, NULL, ret);
509 if (make_extended_dn) {
510 dn_str = dsdb_dn_get_extended_linearized(msg->elements[i].values,
511 dsdb_dn, ac->extended_type);
512 } else {
513 dn_str = dsdb_dn_get_linearized(msg->elements[i].values,
514 dsdb_dn);
517 if (!dn_str) {
518 ldb_oom(ldb);
519 talloc_free(dsdb_dn);
520 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_OPERATIONS_ERROR);
522 msg->elements[i].values[j] = data_blob_string_const(dn_str);
523 talloc_free(dsdb_dn);
525 if (msg->elements[i].num_values == 0) {
526 /* we've deleted all of the values from this
527 * element - remove the element */
528 memmove(&msg->elements[i],
529 &msg->elements[i+1],
530 (msg->num_elements-(i+1))*sizeof(struct ldb_message_element));
531 msg->num_elements--;
532 i--;
535 return ldb_module_send_entry(ac->req, msg, ares->controls);
538 static int extended_callback_ldb(struct ldb_request *req, struct ldb_reply *ares)
540 return extended_callback(req, ares, NULL);
543 static int extended_callback_openldap(struct ldb_request *req, struct ldb_reply *ares)
545 return extended_callback(req, ares, handle_dereference_openldap);
548 static int extended_callback_fds(struct ldb_request *req, struct ldb_reply *ares)
550 return extended_callback(req, ares, handle_dereference_fds);
553 static int extended_dn_out_search(struct ldb_module *module, struct ldb_request *req,
554 int (*callback)(struct ldb_request *req, struct ldb_reply *ares))
556 struct ldb_control *control;
557 struct ldb_control *storage_format_control;
558 struct ldb_extended_dn_control *extended_ctrl = NULL;
559 struct ldb_control **saved_controls;
560 struct extended_search_context *ac;
561 struct ldb_request *down_req;
562 char **new_attrs;
563 const char * const *const_attrs;
564 struct ldb_context *ldb = ldb_module_get_ctx(module);
565 int ret;
567 struct extended_dn_out_private *p = talloc_get_type(ldb_module_get_private(module), struct extended_dn_out_private);
569 /* check if there's an extended dn control */
570 control = ldb_request_get_control(req, LDB_CONTROL_EXTENDED_DN_OID);
571 if (control && control->data) {
572 extended_ctrl = talloc_get_type(control->data, struct ldb_extended_dn_control);
573 if (!extended_ctrl) {
574 return LDB_ERR_PROTOCOL_ERROR;
578 /* Look to see if, as we are in 'store DN+GUID+SID' mode, the
579 * client is after the storage format (to fill in linked
580 * attributes) */
581 storage_format_control = ldb_request_get_control(req, DSDB_CONTROL_DN_STORAGE_FORMAT_OID);
582 if (!control && storage_format_control && storage_format_control->data) {
583 extended_ctrl = talloc_get_type(storage_format_control->data, struct ldb_extended_dn_control);
584 if (!extended_ctrl) {
585 ldb_set_errstring(ldb, "extended_dn_out: extended_ctrl was of the wrong data type");
586 return LDB_ERR_PROTOCOL_ERROR;
590 ac = talloc_zero(req, struct extended_search_context);
591 if (ac == NULL) {
592 ldb_oom(ldb);
593 return LDB_ERR_OPERATIONS_ERROR;
596 ac->module = module;
597 ac->schema = dsdb_get_schema(ldb);
598 ac->req = req;
599 ac->inject = false;
600 ac->remove_guid = false;
601 ac->remove_sid = false;
603 const_attrs = req->op.search.attrs;
605 /* We only need to do special processing if we were asked for
606 * the extended DN, or we are 'store DN+GUID+SID'
607 * (!dereference) mode. (This is the normal mode for LDB on
608 * tdb). */
609 if (control || (storage_format_control && p && !p->dereference)) {
610 ac->inject = true;
611 if (extended_ctrl) {
612 ac->extended_type = extended_ctrl->type;
613 } else {
614 ac->extended_type = 0;
617 /* check if attrs only is specified, in that case check wether we need to modify them */
618 if (req->op.search.attrs && !is_attr_in_list(req->op.search.attrs, "*")) {
619 if (! is_attr_in_list(req->op.search.attrs, "objectGUID")) {
620 ac->remove_guid = true;
622 if (! is_attr_in_list(req->op.search.attrs, "objectSID")) {
623 ac->remove_sid = true;
625 if (ac->remove_guid || ac->remove_sid) {
626 new_attrs = copy_attrs(ac, req->op.search.attrs);
627 if (new_attrs == NULL) {
628 ldb_oom(ldb);
629 return LDB_ERR_OPERATIONS_ERROR;
632 if (ac->remove_guid) {
633 if (!add_attrs(ac, &new_attrs, "objectGUID"))
634 return LDB_ERR_OPERATIONS_ERROR;
636 if (ac->remove_sid) {
637 if (!add_attrs(ac, &new_attrs, "objectSID"))
638 return LDB_ERR_OPERATIONS_ERROR;
640 const_attrs = (const char * const *)new_attrs;
645 ret = ldb_build_search_req_ex(&down_req,
646 ldb, ac,
647 req->op.search.base,
648 req->op.search.scope,
649 req->op.search.tree,
650 const_attrs,
651 req->controls,
652 ac, callback,
653 req);
654 if (ret != LDB_SUCCESS) {
655 return ret;
658 /* Remove extended DN and storage format controls */
660 if (control) {
661 /* save it locally and remove it from the list */
662 /* we do not need to replace them later as we
663 * are keeping the original req intact */
664 if (!save_controls(control, down_req, &saved_controls)) {
665 return LDB_ERR_OPERATIONS_ERROR;
669 if (storage_format_control) {
670 /* save it locally and remove it from the list */
671 /* we do not need to replace them later as we
672 * are keeping the original req intact */
673 if (!save_controls(storage_format_control, down_req, &saved_controls)) {
674 return LDB_ERR_OPERATIONS_ERROR;
678 /* Add in dereference control, if we were asked to, we are
679 * using the 'dereference' mode (such as with an OpenLDAP
680 * backend) and have the control prepared */
681 if (control && p && p->dereference && p->dereference_control) {
682 ret = ldb_request_add_control(down_req,
683 DSDB_OPENLDAP_DEREFERENCE_CONTROL,
684 false, p->dereference_control);
685 if (ret != LDB_SUCCESS) {
686 return ret;
690 /* perform the search */
691 return ldb_next_request(module, down_req);
694 static int extended_dn_out_ldb_search(struct ldb_module *module, struct ldb_request *req)
696 return extended_dn_out_search(module, req, extended_callback_ldb);
699 static int extended_dn_out_openldap_search(struct ldb_module *module, struct ldb_request *req)
701 return extended_dn_out_search(module, req, extended_callback_openldap);
704 static int extended_dn_out_fds_search(struct ldb_module *module, struct ldb_request *req)
706 return extended_dn_out_search(module, req, extended_callback_fds);
709 static int extended_dn_out_ldb_init(struct ldb_module *module)
711 int ret;
713 struct extended_dn_out_private *p = talloc(module, struct extended_dn_out_private);
714 struct dsdb_extended_dn_store_format *dn_format;
716 ldb_module_set_private(module, p);
718 if (!p) {
719 ldb_oom(ldb_module_get_ctx(module));
720 return LDB_ERR_OPERATIONS_ERROR;
723 dn_format = talloc(p, struct dsdb_extended_dn_store_format);
724 if (!dn_format) {
725 talloc_free(p);
726 ldb_oom(ldb_module_get_ctx(module));
727 return LDB_ERR_OPERATIONS_ERROR;
730 dn_format->store_extended_dn_in_ldb = true;
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;
737 p->dereference = false;
738 p->normalise = false;
740 ret = ldb_mod_register_control(module, LDB_CONTROL_EXTENDED_DN_OID);
741 if (ret != LDB_SUCCESS) {
742 ldb_debug(ldb_module_get_ctx(module), LDB_DEBUG_ERROR,
743 "extended_dn_out: Unable to register control with rootdse!\n");
744 return LDB_ERR_OPERATIONS_ERROR;
747 return ldb_next_init(module);
750 static int extended_dn_out_dereference_init(struct ldb_module *module, const char *attrs[])
752 int ret, i = 0;
753 struct extended_dn_out_private *p = talloc_zero(module, struct extended_dn_out_private);
754 struct dsdb_extended_dn_store_format *dn_format;
755 struct dsdb_openldap_dereference_control *dereference_control;
756 struct dsdb_attribute *cur;
757 struct ldb_context *ldb = ldb_module_get_ctx(module);
758 struct dsdb_schema *schema;
760 ldb_module_set_private(module, p);
762 if (!p) {
763 ldb_oom(ldb);
764 return LDB_ERR_OPERATIONS_ERROR;
767 dn_format = talloc(p, struct dsdb_extended_dn_store_format);
768 if (!dn_format) {
769 talloc_free(p);
770 ldb_oom(ldb_module_get_ctx(module));
771 return LDB_ERR_OPERATIONS_ERROR;
774 dn_format->store_extended_dn_in_ldb = false;
776 ret = ldb_set_opaque(ldb_module_get_ctx(module), DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME, dn_format);
777 if (ret != LDB_SUCCESS) {
778 talloc_free(p);
779 return ret;
782 p->dereference = true;
784 /* At the moment, servers that need dereference also need the
785 * DN and attribute names to be normalised */
786 p->normalise = true;
788 ret = ldb_mod_register_control(module, LDB_CONTROL_EXTENDED_DN_OID);
789 if (ret != LDB_SUCCESS) {
790 ldb_debug(ldb, LDB_DEBUG_ERROR,
791 "extended_dn_out: Unable to register control with rootdse!\n");
792 return LDB_ERR_OPERATIONS_ERROR;
795 ret = ldb_next_init(module);
797 if (ret != LDB_SUCCESS) {
798 return ret;
801 schema = dsdb_get_schema(ldb);
802 if (!schema) {
803 /* No schema on this DB (yet) */
804 return LDB_SUCCESS;
807 p->dereference_control = dereference_control
808 = talloc_zero(p, struct dsdb_openldap_dereference_control);
810 if (!p->dereference_control) {
811 ldb_oom(ldb);
812 return LDB_ERR_OPERATIONS_ERROR;
815 for (cur = schema->attributes; cur; cur = cur->next) {
816 if (dsdb_dn_oid_to_format(cur->syntax->ldap_oid) == DSDB_INVALID_DN) {
817 continue;
819 dereference_control->dereference
820 = talloc_realloc(p, dereference_control->dereference,
821 struct dsdb_openldap_dereference *, i + 2);
822 if (!dereference_control) {
823 ldb_oom(ldb);
824 return LDB_ERR_OPERATIONS_ERROR;
826 dereference_control->dereference[i] = talloc(dereference_control->dereference,
827 struct dsdb_openldap_dereference);
828 if (!dereference_control->dereference[i]) {
829 ldb_oom(ldb);
830 return LDB_ERR_OPERATIONS_ERROR;
832 dereference_control->dereference[i]->source_attribute = cur->lDAPDisplayName;
833 dereference_control->dereference[i]->dereference_attribute = attrs;
834 i++;
835 dereference_control->dereference[i] = NULL;
837 return LDB_SUCCESS;
840 static int extended_dn_out_openldap_init(struct ldb_module *module)
842 static const char *attrs[] = {
843 "entryUUID",
844 "objectSID",
845 NULL
848 return extended_dn_out_dereference_init(module, attrs);
851 static int extended_dn_out_fds_init(struct ldb_module *module)
853 static const char *attrs[] = {
854 "nsUniqueId",
855 "objectSID",
856 NULL
859 return extended_dn_out_dereference_init(module, attrs);
862 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_ldb_module_ops = {
863 .name = "extended_dn_out_ldb",
864 .search = extended_dn_out_ldb_search,
865 .init_context = extended_dn_out_ldb_init,
868 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_openldap_module_ops = {
869 .name = "extended_dn_out_openldap",
870 .search = extended_dn_out_openldap_search,
871 .init_context = extended_dn_out_openldap_init,
874 _PUBLIC_ const struct ldb_module_ops ldb_extended_dn_out_fds_module_ops = {
875 .name = "extended_dn_out_fds",
876 .search = extended_dn_out_fds_search,
877 .init_context = extended_dn_out_fds_init,