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_ndr.h"
37 #include "lib/ldb/include/ldb_errors.h"
38 #include "lib/ldb/include/ldb.h"
39 #include "lib/ldb/include/ldb_private.h"
40 #include "dsdb/samdb/samdb.h"
41 #include "libcli/security/security.h"
42 #include "librpc/gen_ndr/ndr_security.h"
43 #include "util/util_ldb.h"
45 int samldb_notice_sid(struct ldb_module *module,
46 TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
48 static bool samldb_msg_add_sid(struct ldb_module *module, struct ldb_message *msg, const char *name, const struct dom_sid *sid)
51 enum ndr_err_code ndr_err;
53 ndr_err = ndr_push_struct_blob(&v, msg, NULL, sid,
54 (ndr_push_flags_fn_t)ndr_push_dom_sid);
55 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
58 return (ldb_msg_add_value(msg, name, &v, NULL) == 0);
62 allocate a new id, attempting to do it atomically
63 return 0 on failure, the id on success
65 static int samldb_set_next_rid(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
66 struct ldb_dn *dn, uint32_t old_id, uint32_t new_id)
68 struct ldb_message msg;
70 struct ldb_val vals[2];
71 struct ldb_message_element els[2];
75 ldb_debug(ldb, LDB_DEBUG_FATAL, "Are we out of valid IDs ?\n");
76 return LDB_ERR_OPERATIONS_ERROR;
79 /* we do a delete and add as a single operation. That prevents
80 a race, in case we are not actually on a transaction db */
82 msg.dn = ldb_dn_copy(mem_ctx, dn);
84 return LDB_ERR_OPERATIONS_ERROR;
89 els[0].num_values = 1;
90 els[0].values = &vals[0];
91 els[0].flags = LDB_FLAG_MOD_DELETE;
92 els[0].name = talloc_strdup(mem_ctx, "nextRid");
94 return LDB_ERR_OPERATIONS_ERROR;
97 els[1].num_values = 1;
98 els[1].values = &vals[1];
99 els[1].flags = LDB_FLAG_MOD_ADD;
100 els[1].name = els[0].name;
102 vals[0].data = (uint8_t *)talloc_asprintf(mem_ctx, "%u", old_id);
104 return LDB_ERR_OPERATIONS_ERROR;
106 vals[0].length = strlen((char *)vals[0].data);
108 vals[1].data = (uint8_t *)talloc_asprintf(mem_ctx, "%u", new_id);
110 return LDB_ERR_OPERATIONS_ERROR;
112 vals[1].length = strlen((char *)vals[1].data);
114 ret = ldb_modify(ldb, &msg);
119 allocate a new id, attempting to do it atomically
120 return 0 on failure, the id on success
122 static int samldb_find_next_rid(struct ldb_module *module, TALLOC_CTX *mem_ctx,
123 struct ldb_dn *dn, uint32_t *old_rid)
125 const char * const attrs[2] = { "nextRid", NULL };
126 struct ldb_result *res = NULL;
130 ret = ldb_search(module->ldb, dn, LDB_SCOPE_BASE, "nextRid=*", attrs, &res);
131 if (ret != LDB_SUCCESS) {
134 if (res->count != 1) {
136 return LDB_ERR_OPERATIONS_ERROR;
139 str = ldb_msg_find_attr_as_string(res->msgs[0], "nextRid", NULL);
141 ldb_asprintf_errstring(module->ldb,
142 "attribute nextRid not found in %s\n",
143 ldb_dn_get_linearized(dn));
145 return LDB_ERR_OPERATIONS_ERROR;
148 *old_rid = strtol(str, NULL, 0);
153 static int samldb_allocate_next_rid(struct ldb_module *module, TALLOC_CTX *mem_ctx,
154 struct ldb_dn *dn, const struct dom_sid *dom_sid,
155 struct dom_sid **new_sid)
157 struct dom_sid *obj_sid;
161 ret = samldb_find_next_rid(module, mem_ctx, dn, &old_rid);
166 /* return the new object sid */
167 obj_sid = dom_sid_add_rid(mem_ctx, dom_sid, old_rid);
169 *new_sid = dom_sid_add_rid(mem_ctx, dom_sid, old_rid + 1);
171 return LDB_ERR_OPERATIONS_ERROR;
174 ret = samldb_notice_sid(module, mem_ctx, *new_sid);
176 /* gah, there are conflicting sids.
177 * This is a critical situation it means that someone messed up with
178 * the DB and nextRid is not returning free RIDs, report an error
179 * and refuse to create any user until the problem is fixed */
180 ldb_asprintf_errstring(module->ldb,
181 "Critical Error: unconsistent DB, unable to retireve an unique RID to generate a new SID: %s",
182 ldb_errstring(module->ldb));
188 /* search the domain related to the provided dn
189 allocate a new RID for the domain
190 return the new sid string
192 static int samldb_get_new_sid(struct ldb_module *module,
193 TALLOC_CTX *mem_ctx, struct ldb_dn *obj_dn,
194 struct ldb_dn *dom_dn,
195 struct dom_sid **sid)
197 const char * const attrs[2] = { "objectSid", NULL };
198 struct ldb_result *res = NULL;
200 struct dom_sid *dom_sid;
202 /* get the domain component part of the provided dn */
204 /* find the domain sid */
206 ret = ldb_search(module->ldb, dom_dn, LDB_SCOPE_BASE, "objectSid=*", attrs, &res);
207 if (ret != LDB_SUCCESS) {
208 ldb_asprintf_errstring(module->ldb,
209 "samldb_get_new_sid: error retrieving domain sid from %s: %s!\n",
210 ldb_dn_get_linearized(dom_dn),
211 ldb_errstring(module->ldb));
216 if (res->count != 1) {
217 ldb_asprintf_errstring(module->ldb,
218 "samldb_get_new_sid: error retrieving domain sid from %s: not found!\n",
219 ldb_dn_get_linearized(dom_dn));
221 return LDB_ERR_CONSTRAINT_VIOLATION;
224 dom_sid = samdb_result_dom_sid(res, res->msgs[0], "objectSid");
225 if (dom_sid == NULL) {
226 ldb_set_errstring(module->ldb, "samldb_get_new_sid: error parsing domain sid!\n");
228 return LDB_ERR_CONSTRAINT_VIOLATION;
231 /* allocate a new Rid for the domain */
232 ret = samldb_allocate_next_rid(module, mem_ctx, dom_dn, dom_sid, sid);
234 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));
244 /* If we are adding new users/groups, we need to update the nextRid
245 * attribute to be 'above' all incoming users RIDs. This tries to
246 * avoid clashes in future */
248 int samldb_notice_sid(struct ldb_module *module,
249 TALLOC_CTX *mem_ctx, const struct dom_sid *sid)
252 struct ldb_dn *dom_dn;
253 struct dom_sid *dom_sid;
254 const char *attrs[] = { NULL };
255 struct ldb_result *dom_res;
256 struct ldb_result *res;
259 /* find if this SID already exists */
260 ret = ldb_search_exp_fmt(module->ldb, mem_ctx, &res,
261 NULL, LDB_SCOPE_SUBTREE, attrs,
262 "(objectSid=%s)", ldap_encode_ndr_dom_sid(mem_ctx, sid));
263 if (ret == LDB_SUCCESS) {
264 if (res->count > 0) {
266 ldb_asprintf_errstring(module->ldb,
267 "Attempt to add record with SID %s rejected,"
268 " because this SID is already in the database",
269 dom_sid_string(mem_ctx, sid));
270 /* We have a duplicate SID, we must reject the add */
271 return LDB_ERR_CONSTRAINT_VIOLATION;
275 ldb_asprintf_errstring(module->ldb,
276 "samldb_notice_sid: error searching to see if sid %s is in use: %s\n",
277 dom_sid_string(mem_ctx, sid),
278 ldb_errstring(module->ldb));
282 dom_sid = dom_sid_dup(mem_ctx, sid);
284 return LDB_ERR_OPERATIONS_ERROR;
286 /* get the domain component part of the provided SID */
287 dom_sid->num_auths--;
289 /* find the domain DN */
290 ret = ldb_search_exp_fmt(module->ldb, mem_ctx, &dom_res,
291 NULL, LDB_SCOPE_SUBTREE, attrs,
292 "(&(objectSid=%s)(objectclass=domain))",
293 ldap_encode_ndr_dom_sid(mem_ctx, dom_sid));
294 if (ret == LDB_SUCCESS) {
295 if (dom_res->count == 0) {
296 talloc_free(dom_res);
297 /* This isn't an operation on a domain we know about, so nothing to update */
301 if (dom_res->count > 1) {
302 talloc_free(dom_res);
303 ldb_asprintf_errstring(module->ldb,
304 "samldb_notice_sid: error retrieving domain from sid: duplicate (found %d) domain: %s!\n",
305 dom_res->count, dom_sid_string(dom_res, dom_sid));
306 return LDB_ERR_OPERATIONS_ERROR;
309 ldb_asprintf_errstring(module->ldb,
310 "samldb_notice_sid: error retrieving domain from sid: %s: %s\n",
311 dom_sid_string(dom_res, dom_sid),
312 ldb_errstring(module->ldb));
316 dom_dn = dom_res->msgs[0]->dn;
318 ret = samldb_find_next_rid(module, mem_ctx,
321 talloc_free(dom_res);
325 if (old_rid <= sid->sub_auths[sid->num_auths - 1]) {
326 ret = samldb_set_next_rid(module->ldb, mem_ctx, dom_dn, old_rid,
327 sid->sub_auths[sid->num_auths - 1] + 1);
329 talloc_free(dom_res);
333 static int samldb_handle_sid(struct ldb_module *module,
334 TALLOC_CTX *mem_ctx, struct ldb_message *msg2,
335 struct ldb_dn *parent_dn)
339 struct dom_sid *sid = samdb_result_dom_sid(mem_ctx, msg2, "objectSid");
341 ret = samldb_get_new_sid(module, msg2, msg2->dn, parent_dn, &sid);
346 if ( ! samldb_msg_add_sid(module, msg2, "objectSid", sid)) {
348 return LDB_ERR_OPERATIONS_ERROR;
353 ret = samldb_notice_sid(module, msg2, sid);
358 static int samldb_generate_samAccountName(struct ldb_module *module, TALLOC_CTX *mem_ctx,
359 struct ldb_dn *dom_dn, char **name)
361 const char *attrs[] = { NULL };
362 struct ldb_result *res;
365 /* Format: $000000-000000000000 */
368 *name = talloc_asprintf(mem_ctx, "$%.6X-%.6X%.6X", (unsigned int)random(), (unsigned int)random(), (unsigned int)random());
369 /* TODO: Figure out exactly what this is meant to conflict with */
370 ret = ldb_search_exp_fmt(module->ldb,
371 mem_ctx, &res, dom_dn, LDB_SCOPE_SUBTREE, attrs,
373 ldb_binary_encode_string(mem_ctx, *name));
374 if (ret != LDB_SUCCESS) {
375 ldb_asprintf_errstring(module->ldb, "samldb: Failure searching to determine if samAccountName %s is unique: %s",
376 *name, ldb_errstring(module->ldb));
380 if (res->count == 0) {
382 /* Great. There are no conflicting users/groups/etc */
386 /* gah, there is a conflicting name, lets move around the loop again... */
391 static int samldb_fill_group_object(struct ldb_module *module, const struct ldb_message *msg,
392 struct ldb_message **ret_msg)
396 struct ldb_message *msg2;
397 struct ldb_dn *dom_dn;
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,
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 ret = samdb_search_for_parent_domain(module->ldb, mem_ctx, msg2->dn, &dom_dn, &errstr);
431 if (ret != LDB_SUCCESS) {
432 ldb_asprintf_errstring(module->ldb,
433 "samldb_fill_group_object: %s", errstr);
437 /* Generate a random name, if no samAccountName was supplied */
438 if (ldb_msg_find_element(msg2, "samAccountName") == NULL) {
439 ret = samldb_generate_samAccountName(module, mem_ctx, dom_dn, &name);
440 if (ret != LDB_SUCCESS) {
441 talloc_free(mem_ctx);
444 ret = samdb_find_or_add_attribute(module->ldb, msg2, "sAMAccountName", name);
446 talloc_free(mem_ctx);
451 /* Manage SID allocation, conflicts etc */
452 ret = samldb_handle_sid(module, mem_ctx, msg2, dom_dn);
454 if (ret == LDB_SUCCESS) {
455 talloc_steal(msg, msg2);
458 talloc_free(mem_ctx);
462 static int samldb_fill_user_or_computer_object(struct ldb_module *module, const struct ldb_message *msg,
463 struct ldb_message **ret_msg)
467 struct ldb_message *msg2;
468 struct ldb_dn *dom_dn;
469 const char *rdn_name;
470 TALLOC_CTX *mem_ctx = talloc_new(msg);
473 return LDB_ERR_OPERATIONS_ERROR;
476 /* build the new msg */
477 msg2 = ldb_msg_copy(mem_ctx, msg);
479 ldb_debug(module->ldb, LDB_DEBUG_FATAL, "samldb_fill_user_or_computer_object: ldb_msg_copy failed!\n");
480 talloc_free(mem_ctx);
481 return LDB_ERR_OPERATIONS_ERROR;
484 if (samdb_find_attribute(module->ldb, msg, "objectclass", "computer") != NULL) {
486 ret = samdb_copy_template(module->ldb, msg2,
490 ldb_asprintf_errstring(module->ldb,
491 "samldb_fill_user_or_computer_object: "
492 "Error copying computer template: %s",
494 talloc_free(mem_ctx);
498 ret = samdb_copy_template(module->ldb, msg2,
502 ldb_asprintf_errstring(module->ldb,
503 "samldb_fill_user_or_computer_object: Error copying user template: %s\n",
505 talloc_free(mem_ctx);
508 /* readd user objectclass */
509 ret = samdb_find_or_add_value(module->ldb, msg2, "objectclass", "user");
511 talloc_free(mem_ctx);
516 rdn_name = ldb_dn_get_rdn_name(msg2->dn);
518 if (strcasecmp(rdn_name, "cn") != 0) {
519 ldb_asprintf_errstring(module->ldb, "Bad RDN (%s=) for user/computer, should be CN=!\n", rdn_name);
520 talloc_free(mem_ctx);
521 return LDB_ERR_CONSTRAINT_VIOLATION;
524 ret = samdb_search_for_parent_domain(module->ldb, mem_ctx, msg2->dn, &dom_dn, &errstr);
525 if (ret != LDB_SUCCESS) {
526 ldb_asprintf_errstring(module->ldb,
527 "samldb_fill_user_or_computer_object: %s", errstr);
531 if (ldb_msg_find_element(msg2, "samAccountName") == NULL) {
532 ret = samldb_generate_samAccountName(module, mem_ctx, dom_dn, &name);
533 if (ret != LDB_SUCCESS) {
534 talloc_free(mem_ctx);
537 ret = samdb_find_or_add_attribute(module->ldb, msg2, "sAMAccountName", name);
539 talloc_free(mem_ctx);
545 TODO: useraccountcontrol: setting value 0 gives 0x200 for users
548 /* Manage SID allocation, conflicts etc */
549 ret = samldb_handle_sid(module, mem_ctx, msg2, dom_dn);
551 /* TODO: objectCategory, userAccountControl, badPwdCount, codePage, countryCode, badPasswordTime, lastLogoff, lastLogon, pwdLastSet, primaryGroupID, accountExpires, logonCount */
555 talloc_steal(msg, msg2);
557 talloc_free(mem_ctx);
561 static int samldb_fill_foreignSecurityPrincipal_object(struct ldb_module *module, const struct ldb_message *msg,
562 struct ldb_message **ret_msg)
564 struct ldb_message *msg2;
565 const char *rdn_name;
566 struct dom_sid *dom_sid;
568 const char *dom_attrs[] = { "name", NULL };
569 struct ldb_message **dom_msgs;
573 TALLOC_CTX *mem_ctx = talloc_new(msg);
575 return LDB_ERR_OPERATIONS_ERROR;
578 /* build the new msg */
579 msg2 = ldb_msg_copy(mem_ctx, msg);
581 ldb_debug(module->ldb, LDB_DEBUG_FATAL, "samldb_fill_foreignSecurityPrincipal_object: ldb_msg_copy failed!\n");
582 talloc_free(mem_ctx);
583 return LDB_ERR_OPERATIONS_ERROR;
586 ret = samdb_copy_template(module->ldb, msg2,
587 "ForeignSecurityPrincipal",
590 ldb_asprintf_errstring(module->ldb,
591 "samldb_fill_foreignSecurityPrincipal_object: "
592 "Error copying template: %s",
594 talloc_free(mem_ctx);
598 rdn_name = ldb_dn_get_rdn_name(msg2->dn);
600 if (strcasecmp(rdn_name, "cn") != 0) {
601 ldb_asprintf_errstring(module->ldb, "Bad RDN (%s=) for ForeignSecurityPrincipal, should be CN=!", rdn_name);
602 talloc_free(mem_ctx);
603 return LDB_ERR_CONSTRAINT_VIOLATION;
606 sid = samdb_result_dom_sid(msg2, msg, "objectSid");
608 /* Slightly different for the foreign sids. We don't want
609 * domain SIDs ending up there, it would cause all sorts of
612 sid = dom_sid_parse_talloc(msg2, (const char *)ldb_dn_get_rdn_val(msg2->dn)->data);
614 ldb_set_errstring(module->ldb, "No valid found SID in ForeignSecurityPrincipal CN!");
615 talloc_free(mem_ctx);
616 return LDB_ERR_CONSTRAINT_VIOLATION;
619 if ( ! samldb_msg_add_sid(module, msg2, "objectSid", sid)) {
621 return LDB_ERR_OPERATIONS_ERROR;
624 dom_sid = dom_sid_dup(mem_ctx, sid);
626 talloc_free(mem_ctx);
627 return LDB_ERR_OPERATIONS_ERROR;
629 /* get the domain component part of the provided SID */
630 dom_sid->num_auths--;
632 /* find the domain DN */
634 ret = gendb_search(module->ldb,
635 mem_ctx, NULL, &dom_msgs, dom_attrs,
636 "(&(objectSid=%s)(objectclass=domain))",
637 ldap_encode_ndr_dom_sid(mem_ctx, dom_sid));
639 /* We don't really like the idea of foreign sids that are not foreign, but it happens */
640 const char *name = samdb_result_string(dom_msgs[0], "name", NULL);
641 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",
642 dom_sid_string(mem_ctx, sid), name);
643 } else if (ret == -1) {
644 ldb_asprintf_errstring(module->ldb,
645 "samldb_fill_foreignSecurityPrincipal_object: error searching for a domain with this sid: %s\n",
646 dom_sid_string(mem_ctx, dom_sid));
647 talloc_free(dom_msgs);
648 return LDB_ERR_OPERATIONS_ERROR;
652 /* This isn't an operation on a domain we know about, so just
653 * check for the SID, looking for duplicates via the common
655 ret = samldb_notice_sid(module, msg2, sid);
657 talloc_steal(msg, msg2);
669 * Actually this module is not async at all as it does a number of sync searches
670 * in the process. It still to be decided how to deal with it properly so it is
671 * left SYNC for now until we think of a good solution.
674 static int samldb_add(struct ldb_module *module, struct ldb_request *req)
676 const struct ldb_message *msg = req->op.add.message;
677 struct ldb_message *msg2 = NULL;
678 struct ldb_request *down_req;
681 ldb_debug(module->ldb, LDB_DEBUG_TRACE, "samldb_add_record\n");
683 if (ldb_dn_is_special(msg->dn)) { /* do not manipulate our control entries */
684 return ldb_next_request(module, req);
687 /* is user or computer? */
688 if ((samdb_find_attribute(module->ldb, msg, "objectclass", "user") != NULL) ||
689 (samdb_find_attribute(module->ldb, msg, "objectclass", "computer") != NULL)) {
690 /* add all relevant missing objects */
691 ret = samldb_fill_user_or_computer_object(module, msg, &msg2);
697 /* is group? add all relevant missing objects */
699 if (samdb_find_attribute(module->ldb, msg, "objectclass", "group") != NULL) {
700 ret = samldb_fill_group_object(module, msg, &msg2);
707 /* perhaps a foreignSecurityPrincipal? */
709 if (samdb_find_attribute(module->ldb, msg, "objectclass", "foreignSecurityPrincipal") != NULL) {
710 ret = samldb_fill_foreignSecurityPrincipal_object(module, msg, &msg2);
718 return ldb_next_request(module, req);
721 down_req = talloc(req, struct ldb_request);
722 if (down_req == NULL) {
723 return LDB_ERR_OPERATIONS_ERROR;
728 down_req->op.add.message = talloc_steal(down_req, msg2);
730 ldb_set_timeout_from_prev_req(module->ldb, req, down_req);
732 /* go on with the call chain */
733 ret = ldb_next_request(module, down_req);
735 /* do not free down_req as the call results may be linked to it,
736 * it will be freed when the upper level request get freed */
737 if (ret == LDB_SUCCESS) {
738 req->handle = down_req->handle;
744 static int samldb_init(struct ldb_module *module)
746 return ldb_next_init(module);
749 static const struct ldb_module_ops samldb_ops = {
751 .init_context = samldb_init,
756 int samldb_module_init(void)
758 return ldb_register_module(&samldb_ops);