s3:printing: Allow to run samba-bgqd as a standalone systemd service
[Samba.git] / source4 / dsdb / samdb / ldb_modules / extended_dn_out.c
bloba949bfbd907e8521b6f550a5a030745be9132036
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.h>
36 #include <ldb_errors.h>
37 #include <ldb_module.h>
38 #include "libcli/security/security.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 #include "dsdb/samdb/ldb_modules/util.h"
45 #undef strcasecmp
46 #undef strncasecmp
48 struct extended_dn_out_private {
49 bool dereference;
50 bool normalise;
51 const char **attrs;
54 static char **copy_attrs(void *mem_ctx, const char * const * attrs)
56 char **nattrs;
57 unsigned int i, num;
59 for (num = 0; attrs[num]; num++);
61 nattrs = talloc_array(mem_ctx, char *, num + 1);
62 if (!nattrs) return NULL;
64 for(i = 0; i < num; i++) {
65 nattrs[i] = talloc_strdup(nattrs, attrs[i]);
66 if (!nattrs[i]) {
67 talloc_free(nattrs);
68 return NULL;
71 nattrs[i] = NULL;
73 return nattrs;
76 static bool add_attrs(void *mem_ctx, char ***attrs, const char *attr)
78 char **nattrs;
79 unsigned int num;
81 for (num = 0; (*attrs)[num]; num++);
83 nattrs = talloc_realloc(mem_ctx, *attrs, char *, num + 2);
84 if (!nattrs) return false;
86 *attrs = nattrs;
88 nattrs[num] = talloc_strdup(nattrs, attr);
89 if (!nattrs[num]) return false;
91 nattrs[num + 1] = NULL;
93 return true;
96 /* Inject the extended DN components, so the DN cn=Administrator,cn=users,dc=samba,dc=example,dc=com becomes
97 <GUID=541203ae-f7d6-47ef-8390-bfcf019f9583>;<SID=S-1-5-21-4177067393-1453636373-93818737-500>;cn=Administrator,cn=users,dc=samba,dc=example,dc=com */
99 static int inject_extended_dn_out(struct ldb_reply *ares,
100 struct ldb_context *ldb,
101 int type,
102 bool remove_guid,
103 bool remove_sid)
105 int ret;
106 const DATA_BLOB *guid_blob;
107 const DATA_BLOB *sid_blob;
109 guid_blob = ldb_msg_find_ldb_val(ares->message, "objectGUID");
110 sid_blob = ldb_msg_find_ldb_val(ares->message, "objectSid");
112 if (!guid_blob) {
113 ldb_set_errstring(ldb, "Did not find objectGUID to inject into extended DN");
114 return LDB_ERR_OPERATIONS_ERROR;
117 ret = ldb_dn_set_extended_component(ares->message->dn, "GUID", guid_blob);
118 if (ret != LDB_SUCCESS) {
119 return ret;
121 if (sid_blob) {
122 ret = ldb_dn_set_extended_component(ares->message->dn, "SID", sid_blob);
123 if (ret != LDB_SUCCESS) {
124 return ret;
128 if (remove_guid) {
129 ldb_msg_remove_attr(ares->message, "objectGUID");
132 if (sid_blob && remove_sid) {
133 ldb_msg_remove_attr(ares->message, "objectSid");
136 return LDB_SUCCESS;
139 /* search */
140 struct extended_search_context {
141 struct ldb_module *module;
142 const struct dsdb_schema *schema;
143 struct ldb_request *req;
144 bool inject;
145 bool remove_guid;
146 bool remove_sid;
147 int extended_type;
152 fix one-way links to have the right string DN, to cope with
153 renames of the target
155 static int fix_one_way_link(struct extended_search_context *ac, struct ldb_dn *dn,
156 bool is_deleted_objects, bool *remove_value,
157 uint32_t linkID)
159 struct GUID guid;
160 NTSTATUS status;
161 int ret;
162 struct ldb_dn *real_dn;
163 uint32_t search_flags;
164 TALLOC_CTX *tmp_ctx = talloc_new(ac);
165 const char *attrs[] = { NULL };
166 struct ldb_result *res;
168 (*remove_value) = false;
170 status = dsdb_get_extended_dn_guid(dn, &guid, "GUID");
171 if (!NT_STATUS_IS_OK(status)) {
172 /* this is a strange DN that doesn't have a GUID! just
173 return the current DN string?? */
174 talloc_free(tmp_ctx);
175 return LDB_SUCCESS;
178 search_flags = DSDB_FLAG_NEXT_MODULE | DSDB_SEARCH_SEARCH_ALL_PARTITIONS | DSDB_SEARCH_ONE_ONLY;
180 if (linkID == 0) {
181 /* You must ALWAYS show one-way links regardless of the state of the target */
182 search_flags |= (DSDB_SEARCH_SHOW_DELETED | DSDB_SEARCH_SHOW_RECYCLED);
185 ret = dsdb_module_search(ac->module, tmp_ctx, &res, NULL, LDB_SCOPE_SUBTREE, attrs,
186 search_flags, ac->req, "objectguid=%s", GUID_string(tmp_ctx, &guid));
187 if (ret != LDB_SUCCESS || res->count != 1) {
188 /* if we can't resolve this GUID, then we don't
189 display the link. This could be a link to a NC that we don't
190 have, or it could be a link to a deleted object
192 (*remove_value) = true;
193 talloc_free(tmp_ctx);
194 return LDB_SUCCESS;
196 real_dn = res->msgs[0]->dn;
198 if (strcmp(ldb_dn_get_linearized(dn), ldb_dn_get_linearized(real_dn)) == 0) {
199 /* its already correct */
200 talloc_free(tmp_ctx);
201 return LDB_SUCCESS;
204 /* fix the DN by replacing its components with those from the
205 * real DN
207 if (!ldb_dn_replace_components(dn, real_dn)) {
208 talloc_free(tmp_ctx);
209 return ldb_operr(ldb_module_get_ctx(ac->module));
211 talloc_free(tmp_ctx);
213 return LDB_SUCCESS;
218 this is called to post-process the results from the search
220 static int extended_callback(struct ldb_request *req, struct ldb_reply *ares)
222 struct extended_search_context *ac;
223 int ret;
224 unsigned int i, j, k;
225 struct ldb_message *msg;
226 struct extended_dn_out_private *p;
227 struct ldb_context *ldb;
228 bool have_reveal_control=false;
230 ac = talloc_get_type(req->context, struct extended_search_context);
231 p = talloc_get_type(ldb_module_get_private(ac->module), struct extended_dn_out_private);
232 ldb = ldb_module_get_ctx(ac->module);
233 if (!ares) {
234 return ldb_module_done(ac->req, NULL, NULL,
235 LDB_ERR_OPERATIONS_ERROR);
237 if (ares->error != LDB_SUCCESS) {
238 return ldb_module_done(ac->req, ares->controls,
239 ares->response, ares->error);
242 msg = ares->message;
244 switch (ares->type) {
245 case LDB_REPLY_REFERRAL:
246 return ldb_module_send_referral(ac->req, ares->referral);
248 case LDB_REPLY_DONE:
249 return ldb_module_done(ac->req, ares->controls,
250 ares->response, LDB_SUCCESS);
251 case LDB_REPLY_ENTRY:
252 break;
255 if (p && p->normalise) {
256 ret = dsdb_fix_dn_rdncase(ldb, ares->message->dn);
257 if (ret != LDB_SUCCESS) {
258 return ldb_module_done(ac->req, NULL, NULL, ret);
262 if (ac->inject) {
263 /* for each record returned post-process to add any derived
264 attributes that have been asked for */
265 ret = inject_extended_dn_out(ares, ldb,
266 ac->extended_type, ac->remove_guid,
267 ac->remove_sid);
268 if (ret != LDB_SUCCESS) {
269 return ldb_module_done(ac->req, NULL, NULL, ret);
273 if ((p && p->normalise) || ac->inject) {
274 const struct ldb_val *val = ldb_msg_find_ldb_val(ares->message, "distinguishedName");
275 if (val) {
276 ldb_msg_remove_attr(ares->message, "distinguishedName");
277 if (ac->inject) {
278 ret = ldb_msg_add_steal_string(ares->message, "distinguishedName",
279 ldb_dn_get_extended_linearized(ares->message, ares->message->dn, ac->extended_type));
280 } else {
281 ret = ldb_msg_add_linearized_dn(ares->message,
282 "distinguishedName",
283 ares->message->dn);
285 if (ret != LDB_SUCCESS) {
286 return ldb_oom(ldb);
291 have_reveal_control =
292 dsdb_request_has_control(req, LDB_CONTROL_REVEAL_INTERNALS);
295 * Shortcut for repl_meta_data. We asked for the data
296 * 'as-is', so stop processing here!
298 if (have_reveal_control && (p == NULL || !p->normalise) && ac->inject) {
299 return ldb_module_send_entry(ac->req, msg, ares->controls);
302 /* Walk the returned elements (but only if we have a schema to
303 * interpret the list with) */
304 for (i = 0; ac->schema && i < msg->num_elements; i++) {
305 bool make_extended_dn;
306 bool bl_requested = true;
307 const struct dsdb_attribute *attribute;
309 attribute = dsdb_attribute_by_lDAPDisplayName(ac->schema, msg->elements[i].name);
310 if (!attribute) {
311 continue;
314 if (p && p->normalise) {
315 /* If we are also in 'normalise' mode, then
316 * fix the attribute names to be in the
317 * correct case */
318 msg->elements[i].name = talloc_strdup(msg->elements, attribute->lDAPDisplayName);
319 if (!msg->elements[i].name) {
320 ldb_oom(ldb);
321 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_OPERATIONS_ERROR);
325 /* distinguishedName has been dealt with above */
326 if (ldb_attr_cmp(msg->elements[i].name, "distinguishedName") == 0) {
327 continue;
330 /* Look to see if this attributeSyntax is a DN */
331 if (attribute->dn_format == DSDB_INVALID_DN) {
332 continue;
335 make_extended_dn = ac->inject;
337 /* Always show plain DN in case of Object(OR-Name) syntax */
338 if (make_extended_dn) {
339 make_extended_dn = (strcmp(attribute->syntax->ldap_oid, DSDB_SYNTAX_OR_NAME) != 0);
342 if (attribute->linkID & 1 &&
343 attribute->bl_maybe_invisible &&
344 !have_reveal_control)
346 const char * const *attrs = ac->req->op.search.attrs;
348 if (attrs != NULL) {
349 bl_requested = ldb_attr_in_list(attrs,
350 attribute->lDAPDisplayName);
351 } else {
352 bl_requested = false;
356 for (k = 0, j = 0; j < msg->elements[i].num_values; j++) {
357 const char *dn_str;
358 struct ldb_dn *dn;
359 struct dsdb_dn *dsdb_dn = NULL;
360 struct ldb_val *plain_dn = &msg->elements[i].values[j];
361 bool is_deleted_objects = false;
362 uint32_t rmd_flags;
364 /* this is a fast method for detecting deleted
365 linked attributes, working on the unparsed
366 ldb_val */
367 rmd_flags = dsdb_dn_val_rmd_flags(plain_dn);
368 if (rmd_flags & DSDB_RMD_FLAG_DELETED && !have_reveal_control) {
369 /* it's a deleted linked attribute,
370 and we don't have the reveal control */
371 /* we won't keep this one, so not incrementing k */
372 continue;
374 if (rmd_flags & DSDB_RMD_FLAG_HIDDEN_BL && !bl_requested) {
376 * Hidden backlinks are not revealed unless
377 * requested.
379 * we won't keep this one, so not incrementing k
381 continue;
384 dsdb_dn = dsdb_dn_parse_trusted(msg, ldb, plain_dn, attribute->syntax->ldap_oid);
386 if (!dsdb_dn) {
387 ldb_asprintf_errstring(ldb,
388 "could not parse %.*s in %s on %s as a %s DN",
389 (int)plain_dn->length, plain_dn->data,
390 msg->elements[i].name, ldb_dn_get_linearized(msg->dn),
391 attribute->syntax->ldap_oid);
392 talloc_free(dsdb_dn);
393 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_INVALID_DN_SYNTAX);
395 dn = dsdb_dn->dn;
397 /* we need to know if this is a link to the
398 deleted objects container for fixing one way
399 links */
400 if (dsdb_dn->extra_part.length == 16) {
401 char *hex_string = data_blob_hex_string_upper(req, &dsdb_dn->extra_part);
402 if (hex_string && strcmp(hex_string, DS_GUID_DELETED_OBJECTS_CONTAINER) == 0) {
403 is_deleted_objects = true;
405 talloc_free(hex_string);
408 if (p != NULL && p->normalise) {
409 ret = dsdb_fix_dn_rdncase(ldb, dn);
410 if (ret != LDB_SUCCESS) {
411 talloc_free(dsdb_dn);
412 return ldb_module_done(ac->req, NULL, NULL, ret);
416 /* Look for this value in the attribute */
418 /* note that we don't fixup objectCategory as
419 it should not be possible to move
420 objectCategory elements in the schema */
421 if (attribute->one_way_link &&
422 strcasecmp(attribute->lDAPDisplayName, "objectCategory") != 0) {
423 bool remove_value;
424 ret = fix_one_way_link(ac, dn, is_deleted_objects, &remove_value,
425 attribute->linkID);
426 if (ret != LDB_SUCCESS) {
427 talloc_free(dsdb_dn);
428 return ldb_module_done(ac->req, NULL, NULL, ret);
430 if (remove_value && !have_reveal_control) {
431 /* we show these with REVEAL
432 to allow dbcheck to find and
433 cleanup these orphaned links */
434 /* we won't keep this one, so not incrementing k */
435 continue;
439 if (make_extended_dn) {
440 if (!ldb_dn_validate(dsdb_dn->dn)) {
441 ldb_asprintf_errstring(ldb,
442 "could not parse %.*s in %s on %s as a %s DN",
443 (int)plain_dn->length, plain_dn->data,
444 msg->elements[i].name, ldb_dn_get_linearized(msg->dn),
445 attribute->syntax->ldap_oid);
446 talloc_free(dsdb_dn);
447 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_INVALID_DN_SYNTAX);
449 /* don't let users see the internal extended
450 GUID components */
451 if (!have_reveal_control) {
452 const char *accept[] = { "GUID", "SID", NULL };
453 ldb_dn_extended_filter(dn, accept);
455 dn_str = dsdb_dn_get_extended_linearized(msg->elements[i].values,
456 dsdb_dn, ac->extended_type);
457 } else {
458 dn_str = dsdb_dn_get_linearized(msg->elements[i].values,
459 dsdb_dn);
462 if (!dn_str) {
463 ldb_oom(ldb);
464 talloc_free(dsdb_dn);
465 return ldb_module_done(ac->req, NULL, NULL, LDB_ERR_OPERATIONS_ERROR);
467 msg->elements[i].values[k] = data_blob_string_const(dn_str);
468 talloc_free(dsdb_dn);
469 k++;
472 if (k == 0) {
473 /* we've deleted all of the values from this
474 * element - remove the element */
475 ldb_msg_remove_element(msg, &msg->elements[i]);
476 i--;
477 } else {
478 msg->elements[i].num_values = k;
481 return ldb_module_send_entry(ac->req, msg, ares->controls);
484 static int extended_callback_ldb(struct ldb_request *req, struct ldb_reply *ares)
486 return extended_callback(req, ares);
489 static int extended_dn_out_search(struct ldb_module *module, struct ldb_request *req,
490 int (*callback)(struct ldb_request *req, struct ldb_reply *ares))
492 struct ldb_control *control;
493 struct ldb_control *storage_format_control;
494 struct ldb_extended_dn_control *extended_ctrl = NULL;
495 struct extended_search_context *ac;
496 struct ldb_request *down_req;
497 char **new_attrs;
498 const char * const *const_attrs;
499 struct ldb_context *ldb = ldb_module_get_ctx(module);
500 int ret;
502 struct extended_dn_out_private *p = talloc_get_type(ldb_module_get_private(module), struct extended_dn_out_private);
504 /* The schema manipulation does not apply to special DNs */
505 if (ldb_dn_is_special(req->op.search.base)) {
506 return ldb_next_request(module, req);
509 /* check if there's an extended dn control */
510 control = ldb_request_get_control(req, LDB_CONTROL_EXTENDED_DN_OID);
511 if (control && control->data) {
512 extended_ctrl = talloc_get_type(control->data, struct ldb_extended_dn_control);
513 if (!extended_ctrl) {
514 return LDB_ERR_PROTOCOL_ERROR;
518 /* Look to see if, as we are in 'store DN+GUID+SID' mode, the
519 * client is after the storage format (to fill in linked
520 * attributes) */
521 storage_format_control = ldb_request_get_control(req, DSDB_CONTROL_DN_STORAGE_FORMAT_OID);
522 if (!control && storage_format_control && storage_format_control->data) {
523 extended_ctrl = talloc_get_type(storage_format_control->data, struct ldb_extended_dn_control);
524 if (!extended_ctrl) {
525 ldb_set_errstring(ldb, "extended_dn_out: extended_ctrl was of the wrong data type");
526 return LDB_ERR_PROTOCOL_ERROR;
530 ac = talloc_zero(req, struct extended_search_context);
531 if (ac == NULL) {
532 return ldb_oom(ldb);
535 ac->module = module;
536 ac->schema = dsdb_get_schema(ldb, ac);
537 ac->req = req;
538 ac->inject = false;
539 ac->remove_guid = false;
540 ac->remove_sid = false;
542 const_attrs = req->op.search.attrs;
544 /* We only need to do special processing if we were asked for
545 * the extended DN, or we are 'store DN+GUID+SID'
546 * (!dereference) mode. (This is the normal mode for LDB on
547 * tdb). */
548 if (control || (storage_format_control && p)) {
549 ac->inject = true;
550 if (extended_ctrl) {
551 ac->extended_type = extended_ctrl->type;
552 } else {
553 ac->extended_type = 0;
556 /* check if attrs only is specified, in that case check whether we need to modify them */
557 if (req->op.search.attrs && !ldb_attr_in_list(req->op.search.attrs, "*")) {
558 if (! ldb_attr_in_list(req->op.search.attrs, "objectGUID")) {
559 ac->remove_guid = true;
561 if (! ldb_attr_in_list(req->op.search.attrs, "objectSid")) {
562 ac->remove_sid = true;
564 if (ac->remove_guid || ac->remove_sid) {
565 new_attrs = copy_attrs(ac, req->op.search.attrs);
566 if (new_attrs == NULL) {
567 return ldb_oom(ldb);
570 if (ac->remove_guid) {
571 if (!add_attrs(ac, &new_attrs, "objectGUID"))
572 return ldb_operr(ldb);
574 if (ac->remove_sid) {
575 if (!add_attrs(ac, &new_attrs, "objectSid"))
576 return ldb_operr(ldb);
578 const_attrs = (const char * const *)new_attrs;
583 ret = ldb_build_search_req_ex(&down_req,
584 ldb, ac,
585 req->op.search.base,
586 req->op.search.scope,
587 req->op.search.tree,
588 const_attrs,
589 req->controls,
590 ac, callback,
591 req);
592 LDB_REQ_SET_LOCATION(down_req);
593 if (ret != LDB_SUCCESS) {
594 return ret;
597 /* mark extended DN and storage format controls as done */
598 if (control) {
599 control->critical = 0;
602 if (storage_format_control) {
603 storage_format_control->critical = 0;
606 /* perform the search */
607 return ldb_next_request(module, down_req);
610 static int extended_dn_out_ldb_search(struct ldb_module *module, struct ldb_request *req)
612 return extended_dn_out_search(module, req, extended_callback_ldb);
615 static int extended_dn_out_ldb_init(struct ldb_module *module)
617 int ret;
619 struct extended_dn_out_private *p = talloc(module, struct extended_dn_out_private);
620 struct dsdb_extended_dn_store_format *dn_format;
622 ldb_module_set_private(module, p);
624 if (!p) {
625 return ldb_oom(ldb_module_get_ctx(module));
628 dn_format = talloc(p, struct dsdb_extended_dn_store_format);
629 if (!dn_format) {
630 talloc_free(p);
631 return ldb_oom(ldb_module_get_ctx(module));
634 dn_format->store_extended_dn_in_ldb = true;
635 ret = ldb_set_opaque(ldb_module_get_ctx(module), DSDB_EXTENDED_DN_STORE_FORMAT_OPAQUE_NAME, dn_format);
636 if (ret != LDB_SUCCESS) {
637 talloc_free(p);
638 return ret;
641 p->dereference = false;
642 p->normalise = false;
644 ret = ldb_mod_register_control(module, LDB_CONTROL_EXTENDED_DN_OID);
645 if (ret != LDB_SUCCESS) {
646 ldb_debug(ldb_module_get_ctx(module), LDB_DEBUG_ERROR,
647 "extended_dn_out: Unable to register control with rootdse!\n");
648 return ldb_operr(ldb_module_get_ctx(module));
651 return ldb_next_init(module);
654 static const struct ldb_module_ops ldb_extended_dn_out_ldb_module_ops = {
655 .name = "extended_dn_out_ldb",
656 .search = extended_dn_out_ldb_search,
657 .init_context = extended_dn_out_ldb_init,
661 initialise the module
663 _PUBLIC_ int ldb_extended_dn_out_module_init(const char *version)
665 int ret;
666 LDB_MODULE_CHECK_VERSION(version);
667 ret = ldb_register_module(&ldb_extended_dn_out_ldb_module_ops);
668 if (ret != LDB_SUCCESS) {
669 return ret;
671 return LDB_SUCCESS;