4 Copyright (C) Simo Sorce 2004
5 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005
7 * NOTICE: this module is NOT released under the GNU LGPL license as
8 * other ldb code. This module is release under the GNU GPL v2 or
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>.
28 * Component: ldb samldb module
30 * Description: add embedded user/group creation functionality
36 #include "libcli/ldap/ldap.h"
37 #include "lib/ldb/include/ldb_errors.h"
38 #include "lib/ldb/include/ldb_private.h"
39 #include "dsdb/samdb/samdb.h"
40 #include "libcli/security/security.h"
41 #include "librpc/gen_ndr/ndr_security.h"
44 int samldb_notice_sid(struct ldb_module *module,
45 TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
47 static BOOL samldb_msg_add_sid(struct ldb_module *module, struct ldb_message *msg, const char *name, const struct dom_sid *sid)
51 status = ndr_push_struct_blob(&v, msg, sid,
52 (ndr_push_flags_fn_t)ndr_push_dom_sid);
53 if (!NT_STATUS_IS_OK(status)) {
56 return (ldb_msg_add_value(msg, name, &v, NULL) == 0);
60 allocate a new id, attempting to do it atomically
61 return 0 on failure, the id on success
63 static int samldb_set_next_rid(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
64 struct ldb_dn *dn, uint32_t old_id, uint32_t new_id)
66 struct ldb_message msg;
68 struct ldb_val vals[2];
69 struct ldb_message_element els[2];
73 ldb_debug(ldb, LDB_DEBUG_FATAL, "Are we out of valid IDs ?\n");
74 return LDB_ERR_OPERATIONS_ERROR;
77 /* we do a delete and add as a single operation. That prevents
78 a race, in case we are not actually on a transaction db */
80 msg.dn = ldb_dn_copy(mem_ctx, dn);
82 return LDB_ERR_OPERATIONS_ERROR;
87 els[0].num_values = 1;
88 els[0].values = &vals[0];
89 els[0].flags = LDB_FLAG_MOD_DELETE;
90 els[0].name = talloc_strdup(mem_ctx, "nextRid");
92 return LDB_ERR_OPERATIONS_ERROR;
95 els[1].num_values = 1;
96 els[1].values = &vals[1];
97 els[1].flags = LDB_FLAG_MOD_ADD;
98 els[1].name = els[0].name;
100 vals[0].data = (uint8_t *)talloc_asprintf(mem_ctx, "%u", old_id);
102 return LDB_ERR_OPERATIONS_ERROR;
104 vals[0].length = strlen((char *)vals[0].data);
106 vals[1].data = (uint8_t *)talloc_asprintf(mem_ctx, "%u", new_id);
108 return LDB_ERR_OPERATIONS_ERROR;
110 vals[1].length = strlen((char *)vals[1].data);
112 ret = ldb_modify(ldb, &msg);
117 allocate a new id, attempting to do it atomically
118 return 0 on failure, the id on success
120 static int samldb_find_next_rid(struct ldb_module *module, TALLOC_CTX *mem_ctx,
121 struct ldb_dn *dn, uint32_t *old_rid)
123 const char * const attrs[2] = { "nextRid", NULL };
124 struct ldb_result *res = NULL;
128 ret = ldb_search(module->ldb, dn, LDB_SCOPE_BASE, "nextRid=*", attrs, &res);
129 if (ret != LDB_SUCCESS) {
132 if (res->count != 1) {
134 return LDB_ERR_OPERATIONS_ERROR;
137 str = ldb_msg_find_attr_as_string(res->msgs[0], "nextRid", NULL);
139 ldb_asprintf_errstring(module->ldb,
140 "attribute nextRid not found in %s\n",
141 ldb_dn_get_linearized(dn));
143 return LDB_ERR_OPERATIONS_ERROR;
146 *old_rid = strtol(str, NULL, 0);
151 static int samldb_allocate_next_rid(struct ldb_module *module, TALLOC_CTX *mem_ctx,
152 struct ldb_dn *dn, const struct dom_sid *dom_sid,
153 struct dom_sid **new_sid)
155 struct dom_sid *obj_sid;
159 ret = samldb_find_next_rid(module, mem_ctx, dn, &old_rid);
164 /* return the new object sid */
165 obj_sid = dom_sid_add_rid(mem_ctx, dom_sid, old_rid);
167 *new_sid = dom_sid_add_rid(mem_ctx, dom_sid, old_rid + 1);
169 return LDB_ERR_OPERATIONS_ERROR;
172 ret = samldb_notice_sid(module, mem_ctx, *new_sid);
174 /* gah, there are conflicting sids.
175 * This is a critical situation it means that someone messed up with
176 * the DB and nextRid is not returning free RIDs, report an error
177 * and refuse to create any user until the problem is fixed */
178 ldb_asprintf_errstring(module->ldb,
179 "Critical Error: unconsistent DB, unable to retireve an unique RID to generate a new SID: %s",
180 ldb_errstring(module->ldb));
186 /* search the domain related to the provided dn
187 allocate a new RID for the domain
188 return the new sid string
190 static int samldb_get_new_sid(struct ldb_module *module,
191 TALLOC_CTX *mem_ctx, struct ldb_dn *obj_dn,
192 struct dom_sid **sid)
194 const char * const attrs[2] = { "objectSid", NULL };
195 struct ldb_result *res = NULL;
196 struct ldb_dn *dom_dn;
198 struct dom_sid *dom_sid;
200 /* get the domain component part of the provided dn */
202 dom_dn = samdb_search_for_parent_domain(module->ldb, mem_ctx, obj_dn);
203 if (dom_dn == NULL) {
204 ldb_asprintf_errstring(module->ldb,
205 "Invalid dn (%s) not child of a domain object!\n",
206 ldb_dn_get_linearized(obj_dn));
207 return LDB_ERR_CONSTRAINT_VIOLATION;
210 /* find the domain sid */
212 ret = ldb_search(module->ldb, dom_dn, LDB_SCOPE_BASE, "objectSid=*", attrs, &res);
213 if (ret != LDB_SUCCESS) {
214 ldb_asprintf_errstring(module->ldb,
215 "samldb_get_new_sid: error retrieving domain sid from %s: %s!\n",
216 ldb_dn_get_linearized(dom_dn),
217 ldb_errstring(module->ldb));
222 if (res->count != 1) {
223 ldb_asprintf_errstring(module->ldb,
224 "samldb_get_new_sid: error retrieving domain sid from %s: not found!\n",
225 ldb_dn_get_linearized(dom_dn));
227 return LDB_ERR_CONSTRAINT_VIOLATION;
230 dom_sid = samdb_result_dom_sid(res, res->msgs[0], "objectSid");
231 if (dom_sid == NULL) {
232 ldb_set_errstring(module->ldb, "samldb_get_new_sid: error parsing domain sid!\n");
234 return LDB_ERR_CONSTRAINT_VIOLATION;
237 /* allocate a new Rid for the domain */
238 ret = samldb_allocate_next_rid(module, mem_ctx, dom_dn, dom_sid, sid);
240 ldb_debug(module->ldb, LDB_DEBUG_FATAL, "Failed to increment nextRid of %s: %s\n", ldb_dn_get_linearized(dom_dn), ldb_errstring(module->ldb));
250 /* If we are adding new users/groups, we need to update the nextRid
251 * attribute to be 'above' all incoming users RIDs. This tries to
252 * avoid clashes in future */
254 int samldb_notice_sid(struct ldb_module *module,
255 TALLOC_CTX *mem_ctx, const struct dom_sid *sid)
258 struct ldb_dn *dom_dn;
259 struct dom_sid *dom_sid;
260 const char *attrs[] = { NULL };
261 struct ldb_result *dom_res;
262 struct ldb_result *res;
265 /* find if this SID already exists */
266 ret = ldb_search_exp_fmt(module->ldb, mem_ctx, &res,
267 NULL, LDB_SCOPE_SUBTREE, attrs,
268 "(objectSid=%s)", ldap_encode_ndr_dom_sid(mem_ctx, sid));
269 if (ret == LDB_SUCCESS) {
270 if (res->count > 0) {
272 ldb_asprintf_errstring(module->ldb,
273 "Attempt to add record with SID %s rejected,"
274 " because this SID is already in the database",
275 dom_sid_string(mem_ctx, sid));
276 /* We have a duplicate SID, we must reject the add */
277 return LDB_ERR_CONSTRAINT_VIOLATION;
281 ldb_asprintf_errstring(module->ldb,
282 "samldb_notice_sid: error searching to see if sid %s is in use: %s\n",
283 dom_sid_string(mem_ctx, sid),
284 ldb_errstring(module->ldb));
288 dom_sid = dom_sid_dup(mem_ctx, sid);
290 return LDB_ERR_OPERATIONS_ERROR;
292 /* get the domain component part of the provided SID */
293 dom_sid->num_auths--;
295 /* find the domain DN */
296 ret = ldb_search_exp_fmt(module->ldb, mem_ctx, &dom_res,
297 NULL, LDB_SCOPE_SUBTREE, attrs,
298 "(&(objectSid=%s)(objectclass=domain))",
299 ldap_encode_ndr_dom_sid(mem_ctx, dom_sid));
300 if (ret == LDB_SUCCESS) {
301 if (dom_res->count == 0) {
302 talloc_free(dom_res);
303 /* This isn't an operation on a domain we know about, so nothing to update */
307 if (dom_res->count > 1) {
308 talloc_free(dom_res);
309 ldb_asprintf_errstring(module->ldb,
310 "samldb_notice_sid: error retrieving domain from sid: duplicate (found %d) domain: %s!\n",
311 dom_res->count, dom_sid_string(dom_res, dom_sid));
312 return LDB_ERR_OPERATIONS_ERROR;
315 ldb_asprintf_errstring(module->ldb,
316 "samldb_notice_sid: error retrieving domain from sid: %s: %s\n",
317 dom_sid_string(dom_res, dom_sid),
318 ldb_errstring(module->ldb));
322 dom_dn = dom_res->msgs[0]->dn;
324 ret = samldb_find_next_rid(module, mem_ctx,
327 talloc_free(dom_res);
331 if (old_rid <= sid->sub_auths[sid->num_auths - 1]) {
332 ret = samldb_set_next_rid(module->ldb, mem_ctx, dom_dn, old_rid,
333 sid->sub_auths[sid->num_auths - 1] + 1);
335 talloc_free(dom_res);
339 static int samldb_handle_sid(struct ldb_module *module,
340 TALLOC_CTX *mem_ctx, struct ldb_message *msg2)
344 struct dom_sid *sid = samdb_result_dom_sid(mem_ctx, msg2, "objectSid");
346 ret = samldb_get_new_sid(module, msg2, msg2->dn, &sid);
351 if ( ! samldb_msg_add_sid(module, msg2, "objectSid", sid)) {
353 return LDB_ERR_OPERATIONS_ERROR;
358 ret = samldb_notice_sid(module, msg2, sid);
363 static char *samldb_generate_samAccountName(struct ldb_module *module, TALLOC_CTX *mem_ctx)
366 const char *attrs[] = { NULL };
367 struct ldb_message **msgs;
370 /* Format: $000000-000000000000 */
373 name = talloc_asprintf(mem_ctx, "$%.6X-%.6X%.6X", (unsigned int)random(), (unsigned int)random(), (unsigned int)random());
374 /* TODO: Figure out exactly what this is meant to conflict with */
375 ret = gendb_search(module->ldb,
376 mem_ctx, NULL, &msgs, attrs,
378 ldb_binary_encode_string(mem_ctx, name));
380 /* Great. There are no conflicting users/groups/etc */
382 } else if (ret == -1) {
383 /* Bugger, there is a problem, and we don't know what it is until gendb_search improves */
387 /* gah, there are conflicting sids, lets move around the loop again... */
392 static int samldb_fill_group_object(struct ldb_module *module, const struct ldb_message *msg,
393 struct ldb_message **ret_msg)
397 struct ldb_message *msg2;
398 const char *rdn_name;
399 TALLOC_CTX *mem_ctx = talloc_new(msg);
402 return LDB_ERR_OPERATIONS_ERROR;
405 /* build the new msg */
406 msg2 = ldb_msg_copy(mem_ctx, msg);
408 ldb_debug(module->ldb, LDB_DEBUG_FATAL, "samldb_fill_group_object: ldb_msg_copy failed!\n");
409 talloc_free(mem_ctx);
410 return LDB_ERR_OPERATIONS_ERROR;
413 ret = samdb_copy_template(module->ldb, msg2,
414 "(&(CN=TemplateGroup)(objectclass=groupTemplate))",
418 talloc_free(mem_ctx);
422 rdn_name = ldb_dn_get_rdn_name(msg2->dn);
424 if (strcasecmp(rdn_name, "cn") != 0) {
425 ldb_debug(module->ldb, LDB_DEBUG_FATAL, "samldb_fill_group_object: Bad RDN (%s) for group!\n", rdn_name);
426 talloc_free(mem_ctx);
427 return LDB_ERR_CONSTRAINT_VIOLATION;
430 /* Generate a random name, if no samAccountName was supplied */
431 if (ldb_msg_find_element(msg2, "samAccountName") == NULL) {
432 name = samldb_generate_samAccountName(module, mem_ctx);
434 talloc_free(mem_ctx);
435 return LDB_ERR_OPERATIONS_ERROR;
437 ret = samdb_find_or_add_attribute(module->ldb, msg2, "sAMAccountName", name);
439 talloc_free(mem_ctx);
444 /* Manage SID allocation, conflicts etc */
445 ret = samldb_handle_sid(module, mem_ctx, msg2);
447 if (ret == LDB_SUCCESS) {
448 talloc_steal(msg, msg2);
451 talloc_free(mem_ctx);
455 static int samldb_fill_user_or_computer_object(struct ldb_module *module, const struct ldb_message *msg,
456 struct ldb_message **ret_msg)
460 struct ldb_message *msg2;
461 const char *rdn_name;
462 TALLOC_CTX *mem_ctx = talloc_new(msg);
465 return LDB_ERR_OPERATIONS_ERROR;
468 /* build the new msg */
469 msg2 = ldb_msg_copy(mem_ctx, msg);
471 ldb_debug(module->ldb, LDB_DEBUG_FATAL, "samldb_fill_group_object: ldb_msg_copy failed!\n");
472 talloc_free(mem_ctx);
473 return LDB_ERR_OPERATIONS_ERROR;
476 if (samdb_find_attribute(module->ldb, msg, "objectclass", "computer") != NULL) {
478 ret = samdb_copy_template(module->ldb, msg2,
479 "(&(CN=TemplateComputer)(objectclass=userTemplate))",
482 ldb_asprintf_errstring(module->ldb,
483 "samldb_fill_user_or_computer_object: "
484 "Error copying computer template: %s",
486 talloc_free(mem_ctx);
490 /* readd user and then computer objectclasses */
491 ret = samdb_find_or_add_value(module->ldb, msg2, "objectclass", "user");
493 talloc_free(mem_ctx);
496 ret = samdb_find_or_add_value(module->ldb, msg2, "objectclass", "computer");
498 talloc_free(mem_ctx);
503 ret = samdb_copy_template(module->ldb, msg2,
504 "(&(CN=TemplateUser)(objectclass=userTemplate))",
507 ldb_asprintf_errstring(module->ldb,
508 "samldb_fill_user_or_computer_object: Error copying user template: %s\n",
510 talloc_free(mem_ctx);
513 /* readd user objectclass */
514 ret = samdb_find_or_add_value(module->ldb, msg2, "objectclass", "user");
516 talloc_free(mem_ctx);
521 rdn_name = ldb_dn_get_rdn_name(msg2->dn);
523 if (strcasecmp(rdn_name, "cn") != 0) {
524 ldb_asprintf_errstring(module->ldb, "Bad RDN (%s=) for user/computer, should be CN=!\n", rdn_name);
525 talloc_free(mem_ctx);
526 return LDB_ERR_CONSTRAINT_VIOLATION;
529 if (ldb_msg_find_element(msg2, "samAccountName") == NULL) {
530 name = samldb_generate_samAccountName(module, mem_ctx);
532 talloc_free(mem_ctx);
533 return LDB_ERR_OPERATIONS_ERROR;
535 ret = samdb_find_or_add_attribute(module->ldb, msg2, "sAMAccountName", name);
537 talloc_free(mem_ctx);
543 TODO: useraccountcontrol: setting value 0 gives 0x200 for users
546 /* Manage SID allocation, conflicts etc */
547 ret = samldb_handle_sid(module, mem_ctx, msg2);
549 /* TODO: objectCategory, userAccountControl, badPwdCount, codePage, countryCode, badPasswordTime, lastLogoff, lastLogon, pwdLastSet, primaryGroupID, accountExpires, logonCount */
553 talloc_steal(msg, msg2);
555 talloc_free(mem_ctx);
559 static int samldb_fill_foreignSecurityPrincipal_object(struct ldb_module *module, const struct ldb_message *msg,
560 struct ldb_message **ret_msg)
562 struct ldb_message *msg2;
563 const char *rdn_name;
564 struct dom_sid *dom_sid;
566 const char *dom_attrs[] = { "name", NULL };
567 struct ldb_message **dom_msgs;
571 TALLOC_CTX *mem_ctx = talloc_new(msg);
573 return LDB_ERR_OPERATIONS_ERROR;
576 /* build the new msg */
577 msg2 = ldb_msg_copy(mem_ctx, msg);
579 ldb_debug(module->ldb, LDB_DEBUG_FATAL, "samldb_fill_foreignSecurityPrincpal_object: ldb_msg_copy failed!\n");
580 talloc_free(mem_ctx);
581 return LDB_ERR_OPERATIONS_ERROR;
584 ret = samdb_copy_template(module->ldb, msg2,
585 "(&(CN=TemplateForeignSecurityPrincipal)(objectclass=foreignSecurityPrincipalTemplate))",
588 ldb_asprintf_errstring(module->ldb,
589 "samldb_fill_foreignSecurityPrincipal_object: "
590 "Error copying template: %s",
592 talloc_free(mem_ctx);
596 rdn_name = ldb_dn_get_rdn_name(msg2->dn);
598 if (strcasecmp(rdn_name, "cn") != 0) {
599 ldb_asprintf_errstring(module->ldb, "Bad RDN (%s=) for ForeignSecurityPrincipal, should be CN=!", rdn_name);
600 talloc_free(mem_ctx);
601 return LDB_ERR_CONSTRAINT_VIOLATION;
604 /* Slightly different for the foreign sids. We don't want
605 * domain SIDs ending up there, it would cause all sorts of
608 sid = dom_sid_parse_talloc(msg2, (const char *)ldb_dn_get_rdn_val(msg2->dn)->data);
610 ldb_set_errstring(module->ldb, "No valid found SID in ForeignSecurityPrincipal CN!");
611 talloc_free(mem_ctx);
612 return LDB_ERR_CONSTRAINT_VIOLATION;
615 if ( ! samldb_msg_add_sid(module, msg2, "objectSid", sid)) {
617 return LDB_ERR_OPERATIONS_ERROR;
620 dom_sid = dom_sid_dup(mem_ctx, sid);
622 talloc_free(mem_ctx);
623 return LDB_ERR_OPERATIONS_ERROR;
625 /* get the domain component part of the provided SID */
626 dom_sid->num_auths--;
628 /* find the domain DN */
630 ret = gendb_search(module->ldb,
631 mem_ctx, NULL, &dom_msgs, dom_attrs,
632 "(&(objectSid=%s)(objectclass=domain))",
633 ldap_encode_ndr_dom_sid(mem_ctx, dom_sid));
635 /* We don't really like the idea of foreign sids that are not foreign, but it happens */
636 const char *name = samdb_result_string(dom_msgs[0], "name", NULL);
637 ldb_debug(module->ldb, LDB_DEBUG_TRACE, "NOTE (strange but valid): Adding foreign SID record with SID %s, but this domian (%s) is already in the database",
638 dom_sid_string(mem_ctx, sid), name);
639 } else if (ret == -1) {
640 ldb_asprintf_errstring(module->ldb,
641 "samldb_fill_foreignSecurityPrincipal_object: error searching for a domain with this sid: %s\n",
642 dom_sid_string(mem_ctx, dom_sid));
643 talloc_free(dom_msgs);
644 return LDB_ERR_OPERATIONS_ERROR;
647 /* This isn't an operation on a domain we know about, so just
648 * check for the SID, looking for duplicates via the common
650 ret = samldb_notice_sid(module, msg2, sid);
652 talloc_steal(msg, msg2);
664 * Actually this module is not async at all as it does a number of sync searches
665 * in the process. It still to be decided how to deal with it properly so it is
666 * left SYNC for now until we think of a good solution.
669 static int samldb_add(struct ldb_module *module, struct ldb_request *req)
671 const struct ldb_message *msg = req->op.add.message;
672 struct ldb_message *msg2 = NULL;
673 struct ldb_request *down_req;
676 ldb_debug(module->ldb, LDB_DEBUG_TRACE, "samldb_add_record\n");
678 if (ldb_dn_is_special(msg->dn)) { /* do not manipulate our control entries */
679 return ldb_next_request(module, req);
682 /* is user or computer? */
683 if ((samdb_find_attribute(module->ldb, msg, "objectclass", "user") != NULL) ||
684 (samdb_find_attribute(module->ldb, msg, "objectclass", "computer") != NULL)) {
685 /* add all relevant missing objects */
686 ret = samldb_fill_user_or_computer_object(module, msg, &msg2);
692 /* is group? add all relevant missing objects */
694 if (samdb_find_attribute(module->ldb, msg, "objectclass", "group") != NULL) {
695 ret = samldb_fill_group_object(module, msg, &msg2);
702 /* perhaps a foreignSecurityPrincipal? */
704 if (samdb_find_attribute(module->ldb, msg, "objectclass", "foreignSecurityPrincipal") != NULL) {
705 ret = samldb_fill_foreignSecurityPrincipal_object(module, msg, &msg2);
713 return ldb_next_request(module, req);
716 down_req = talloc(req, struct ldb_request);
717 if (down_req == NULL) {
718 return LDB_ERR_OPERATIONS_ERROR;
723 down_req->op.add.message = talloc_steal(down_req, msg2);
725 ldb_set_timeout_from_prev_req(module->ldb, req, down_req);
727 /* go on with the call chain */
728 ret = ldb_next_request(module, down_req);
730 /* do not free down_req as the call results may be linked to it,
731 * it will be freed when the upper level request get freed */
732 if (ret == LDB_SUCCESS) {
733 req->handle = down_req->handle;
739 static int samldb_init(struct ldb_module *module)
741 return ldb_next_init(module);
744 static const struct ldb_module_ops samldb_ops = {
746 .init_context = samldb_init,
751 int samldb_module_init(void)
753 return ldb_register_module(&samldb_ops);