2 * idmap_autorid: static map between Active Directory/NT RIDs
3 * and RFC 2307 accounts
5 * based on the idmap_rid module, but this module defines the ranges
6 * for the domains by automatically allocating a range for each domain
8 * Copyright (C) Christian Ambach, 2010-2012
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, see <http://www.gnu.org/licenses/>.
26 * This module allocates ranges for domains to be used in a
27 * algorithmic mode like idmap_rid. Multiple ranges are supported
28 * for a single domain: If a rid exceeds the range size, a matching
29 * range is allocated to hold the rid's id.
31 * Here are the formulas applied:
34 * For a sid of the form domain_sid-rid, we have
36 * rid = reduced_rid + domain_range_index * range_size
39 * reduced_rid := rid % range_size
40 * domain_range_index := rid / range_size
42 * And reduced_rid fits into a range.
44 * In the database, we associate a range_number to
45 * the pair domain_sid,domain_range_index.
47 * Now the unix id for the given sid calculates as:
49 * id = reduced_rid + range_low_id
53 * range_low_id = low_id + range_number * range_size
56 * The inverse calculation goes like this:
58 * Given a unix id, let
60 * normalized_id := id - low_id
61 * reduced_rid := normalized_id % range_size
62 * range_number = normalized_id / range_size
66 * id = reduced_rid + low_id + range_number * range_size
68 * From the database, get the domain_sid,domain_range_index pair
69 * belonging to the range_number (if there is already one).
71 * Then the rid for the unix id calculates as:
73 * rid = reduced_rid + domain_range_index * range_size
76 #include "idmap_autorid_tdb.h"
80 #include "../libcli/security/dom_sid.h"
83 #define DBGC_CLASS DBGC_IDMAP
85 /* handle to the tdb storing domain <-> range assignments */
86 static struct db_context *autorid_db;
88 static bool ignore_builtin = false;
90 static NTSTATUS idmap_autorid_get_alloc_range(struct idmap_domain *dom,
91 struct autorid_range_config *range)
97 fstrcpy(range->domsid, ALLOC_RANGE);
99 status = idmap_autorid_get_domainrange(autorid_db,
106 static NTSTATUS idmap_autorid_allocate_id(struct idmap_domain *dom,
107 struct unixid *xid) {
110 struct autorid_range_config range;
112 if (dom->read_only) {
113 DEBUG(3, ("Backend is read-only, refusing "
114 "new allocation request\n"));
115 return NT_STATUS_UNSUCCESSFUL;
118 /* fetch the range for the allocation pool */
120 ret = idmap_autorid_get_alloc_range(dom, &range);
121 if (!NT_STATUS_IS_OK(ret)) {
122 DEBUG(3, ("Could not determine range for allocation pool, "
123 "check previous messages for reason\n"));
127 ret = idmap_tdb_common_get_new_id(dom, xid);
129 if (!NT_STATUS_IS_OK(ret)) {
130 DEBUG(1, ("Fatal error while allocating new ID!\n"));
134 xid->id = xid->id + range.low_id;
136 DEBUG(10, ("Returned new %s %d from allocation range\n",
137 (xid->type==ID_TYPE_UID)?"uid":"gid", xid->id));
143 * map a SID to xid using the idmap_tdb like pool
145 static NTSTATUS idmap_autorid_id_to_sid_alloc(struct idmap_domain *dom,
150 /* look out for the mapping */
151 ret = idmap_tdb_common_unixid_to_sid(dom, map);
153 if (NT_STATUS_IS_OK(ret)) {
154 map->status = ID_MAPPED;
158 map->status = ID_UNKNOWN;
160 DEBUG(10, ("no ID->SID mapping for %d could be found\n", map->xid.id));
165 static NTSTATUS idmap_autorid_id_to_sid(struct autorid_global_config *cfg,
166 struct idmap_domain *dom,
169 uint32_t range_number;
170 uint32_t domain_range_index = 0;
171 uint32_t normalized_id;
172 uint32_t reduced_rid;
174 TDB_DATA data = tdb_null;
176 struct dom_sid domsid;
179 const char *q = NULL;
181 /* can this be one of our ids? */
182 if (map->xid.id < cfg->minvalue) {
183 DEBUG(10, ("id %d is lower than minimum value, "
184 "ignoring mapping request\n", map->xid.id));
185 map->status = ID_UNKNOWN;
189 if (map->xid.id > (cfg->minvalue + cfg->rangesize * cfg->maxranges)) {
190 DEBUG(10, ("id %d is outside of maximum id value, "
191 "ignoring mapping request\n", map->xid.id));
192 map->status = ID_UNKNOWN;
196 /* determine the range of this uid */
198 normalized_id = map->xid.id - cfg->minvalue;
199 range_number = normalized_id / cfg->rangesize;
201 keystr = talloc_asprintf(talloc_tos(), "%u", range_number);
203 return NT_STATUS_NO_MEMORY;
206 status = dbwrap_fetch_bystring(autorid_db, talloc_tos(), keystr, &data);
209 if (!NT_STATUS_IS_OK(status)) {
210 DEBUG(4, ("id %d belongs to range %d which does not have "
211 "domain mapping, ignoring mapping request\n",
212 map->xid.id, range_number));
213 TALLOC_FREE(data.dptr);
214 map->status = ID_UNKNOWN;
218 if (strncmp((const char *)data.dptr,
220 strlen(ALLOC_RANGE)) == 0) {
222 * this is from the alloc range, check if there is a mapping
224 DEBUG(5, ("id %d belongs to allocation range, "
225 "checking for mapping\n",
227 TALLOC_FREE(data.dptr);
228 return idmap_autorid_id_to_sid_alloc(dom, map);
231 ok = dom_sid_parse_endp((const char *)data.dptr, &domsid, &q);
232 TALLOC_FREE(data.dptr);
234 map->status = ID_UNKNOWN;
237 if ((q != NULL) && (*q != '\0'))
238 if (sscanf(q+1, "%"SCNu32, &domain_range_index) != 1) {
239 DEBUG(10, ("Domain range index not found, "
240 "ignoring mapping request\n"));
241 map->status = ID_UNKNOWN;
245 reduced_rid = normalized_id % cfg->rangesize;
246 rid = reduced_rid + domain_range_index * cfg->rangesize;
248 sid_compose(map->sid, &domsid, rid);
250 /* We **really** should have some way of validating
251 the SID exists and is the correct type here. But
252 that is a deficiency in the idmap_rid design. */
254 map->status = ID_MAPPED;
255 map->xid.type = ID_TYPE_BOTH;
260 /**********************************
261 Single sid to id lookup function.
262 **********************************/
264 static NTSTATUS idmap_autorid_sid_to_id_rid(
265 struct autorid_global_config *global,
266 struct autorid_range_config *range,
270 uint32_t reduced_rid;
272 sid_peek_rid(map->sid, &rid);
274 reduced_rid = rid % global->rangesize;
276 map->xid.id = reduced_rid + range->low_id;
277 map->xid.type = ID_TYPE_BOTH;
278 map->status = ID_MAPPED;
283 /**********************************
284 lookup a set of unix ids.
285 **********************************/
287 static NTSTATUS idmap_autorid_unixids_to_sids(struct idmap_domain *dom,
290 struct idmap_tdb_common_context *commoncfg;
291 struct autorid_global_config *globalcfg;
297 /* initialize the status to avoid surprise */
298 for (i = 0; ids[i]; i++) {
299 ids[i]->status = ID_UNKNOWN;
304 talloc_get_type_abort(dom->private_data,
305 struct idmap_tdb_common_context);
307 globalcfg = talloc_get_type(commoncfg->private_data,
308 struct autorid_global_config);
310 for (i = 0; ids[i]; i++) {
312 ret = idmap_autorid_id_to_sid(globalcfg, dom, ids[i]);
314 if ((!NT_STATUS_IS_OK(ret)) &&
315 (!NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED))) {
316 /* some fatal error occurred, log it */
317 DEBUG(3, ("Unexpected error resolving an ID "
318 " (%d)\n", ids[i]->xid.id));
322 if (NT_STATUS_IS_OK(ret) && ids[i]->status == ID_MAPPED) {
328 if (num_tomap == num_mapped) {
330 } else if (num_mapped == 0) {
331 return NT_STATUS_NONE_MAPPED;
334 return STATUS_SOME_UNMAPPED;
342 * map a SID to xid using the idmap_tdb like pool
344 static NTSTATUS idmap_autorid_sid_to_id_alloc(struct idmap_domain *dom,
346 struct idmap_tdb_common_context *ctx)
351 map->status = ID_UNKNOWN;
353 /* see if we already have a mapping */
354 ret = idmap_tdb_common_sid_to_unixid(dom, map);
356 if (NT_STATUS_IS_OK(ret)) {
357 map->status = ID_MAPPED;
361 /* bad things happened */
362 if (!NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
363 DEBUG(1, ("Looking up SID->ID mapping for %s failed: %s\n",
364 sid_string_dbg(map->sid), nt_errstr(ret)));
368 if (dom->read_only) {
369 DEBUG(3, ("Not allocating new mapping for %s, because backend "
370 "is read-only\n", sid_string_dbg(map->sid)));
371 map->status = ID_UNMAPPED;
372 return NT_STATUS_NONE_MAPPED;
375 DEBUG(10, ("Creating new mapping in pool for %s\n",
376 sid_string_dbg(map->sid)));
378 /* create new mapping */
379 res = dbwrap_transaction_start(ctx->db);
381 DEBUG(2, ("transaction_start failed\n"));
382 return NT_STATUS_INTERNAL_DB_CORRUPTION;
385 ret = idmap_tdb_common_new_mapping(dom, map);
386 if (!NT_STATUS_IS_OK(ret)) {
387 if (dbwrap_transaction_cancel(ctx->db) != 0) {
388 smb_panic("Cancelling transaction failed");
390 map->status = ID_UNMAPPED;
394 res = dbwrap_transaction_commit(ctx->db);
396 map->status = ID_MAPPED;
400 DEBUG(2, ("transaction_commit failed\n"));
401 return NT_STATUS_INTERNAL_DB_CORRUPTION;
405 static NTSTATUS idmap_autorid_sid_to_id(struct idmap_tdb_common_context *common,
406 struct idmap_domain *dom,
409 struct autorid_global_config *global =
410 talloc_get_type_abort(common->private_data,
411 struct autorid_global_config);
412 struct winbindd_tdc_domain *domain;
413 struct autorid_range_config range;
415 struct dom_sid domainsid;
419 map->status = ID_UNKNOWN;
421 DEBUG(10, ("Trying to map %s\n", sid_string_dbg(map->sid)));
423 sid_copy(&domainsid, map->sid);
424 if (!sid_split_rid(&domainsid, &rid)) {
425 DEBUG(4, ("Could not determine domain SID from %s, "
426 "ignoring mapping request\n",
427 sid_string_dbg(map->sid)));
428 map->status = ID_UNMAPPED;
429 return NT_STATUS_NONE_MAPPED;
432 if (sid_check_is_wellknown_domain(&domainsid, NULL)) {
433 DEBUG(10, ("SID %s is well-known, using pool\n",
434 sid_string_dbg(map->sid)));
436 return idmap_autorid_sid_to_id_alloc(dom, map, common);
439 if (dom_sid_equal(&domainsid, &global_sid_Builtin) && ignore_builtin) {
440 DEBUG(10, ("Ignoring request for BUILTIN domain\n"));
441 map->status = ID_UNMAPPED;
442 return NT_STATUS_NONE_MAPPED;
446 * Check if the domain is around
448 domain = wcache_tdc_fetch_domainbysid(talloc_tos(),
450 if (domain == NULL) {
451 DEBUG(10, ("Ignoring unknown domain sid %s\n",
452 sid_string_dbg(&domainsid)));
453 map->status = ID_UNMAPPED;
454 return NT_STATUS_NONE_MAPPED;
458 sid_to_fstring(range.domsid, &domainsid);
460 range.domain_range_index = rid / (global->rangesize);
462 ret = idmap_autorid_get_domainrange(autorid_db, &range, dom->read_only);
463 if (NT_STATUS_EQUAL(ret, NT_STATUS_NOT_FOUND) && dom->read_only) {
464 DEBUG(10, ("read-only is enabled, did not allocate "
465 "new range for domain %s\n",
466 sid_string_dbg(&domainsid)));
467 map->status = ID_UNMAPPED;
468 return NT_STATUS_NONE_MAPPED;
470 if (!NT_STATUS_IS_OK(ret)) {
471 DEBUG(3, ("Could not determine range for domain, "
472 "check previous messages for reason\n"));
476 return idmap_autorid_sid_to_id_rid(global, &range, map);
479 /**********************************
480 lookup a set of sids.
481 **********************************/
483 static NTSTATUS idmap_autorid_sids_to_unixids(struct idmap_domain *dom,
486 struct idmap_tdb_common_context *commoncfg;
492 /* initialize the status to avoid surprise */
493 for (i = 0; ids[i]; i++) {
494 ids[i]->status = ID_UNKNOWN;
499 talloc_get_type_abort(dom->private_data,
500 struct idmap_tdb_common_context);
502 for (i = 0; ids[i]; i++) {
503 ret = idmap_autorid_sid_to_id(commoncfg, dom, ids[i]);
504 if ((!NT_STATUS_IS_OK(ret)) &&
505 (!NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED))) {
506 /* some fatal error occurred, log it */
507 DEBUG(3, ("Unexpected error resolving a SID (%s)\n",
508 sid_string_dbg(ids[i]->sid)));
512 if (NT_STATUS_IS_OK(ret) && ids[i]->status == ID_MAPPED) {
517 if (num_tomap == num_mapped) {
519 } else if (num_mapped == 0) {
520 return NT_STATUS_NONE_MAPPED;
523 return STATUS_SOME_UNMAPPED;
526 static NTSTATUS idmap_autorid_preallocate_wellknown(struct idmap_domain *dom)
528 const char *groups[] = { "S-1-1-0", "S-1-2-0", "S-1-2-1",
529 "S-1-3-0", "S-1-3-1", "S-1-3-2", "S-1-3-3", "S-1-3-4",
530 "S-1-5-1", "S-1-5-2", "S-1-5-3", "S-1-5-4", "S-1-5-6",
531 "S-1-5-7", "S-1-5-8", "S-1-5-9", "S-1-5-10", "S-1-5-11",
532 "S-1-5-12", "S-1-5-13", "S-1-5-14", "S-1-5-15",
533 "S-1-5-17", "S-1-5-18", "S-1-5-19", "S-1-5-20"
536 struct id_map **maps;
540 if (dom->read_only) {
544 num = ARRAY_SIZE(groups);
546 maps = talloc_array(talloc_tos(), struct id_map*, num+1);
548 return NT_STATUS_NO_MEMORY;
551 for (i = 0; i < num; i++) {
552 maps[i] = talloc(maps, struct id_map);
553 if (maps[i] == NULL) {
555 return NT_STATUS_NO_MEMORY;
557 maps[i]->xid.type = ID_TYPE_GID;
558 maps[i]->sid = dom_sid_parse_talloc(maps, groups[i]);
563 status = idmap_autorid_sids_to_unixids(dom, maps);
565 DEBUG(10,("Preallocation run finished with status %s\n",
570 return NT_STATUS_IS_OK(status)?NT_STATUS_OK:NT_STATUS_UNSUCCESSFUL;
573 static NTSTATUS idmap_autorid_initialize_action(struct db_context *db,
576 struct idmap_domain *dom;
577 struct idmap_tdb_common_context *common;
578 struct autorid_global_config *config;
581 dom = (struct idmap_domain *)private_data;
582 common = (struct idmap_tdb_common_context *)dom->private_data;
583 config = (struct autorid_global_config *)common->private_data;
585 status = idmap_autorid_init_hwms(db);
586 if (!NT_STATUS_IS_OK(status)) {
590 status = idmap_autorid_saveconfig(db, config);
591 if (!NT_STATUS_IS_OK(status)) {
592 DEBUG(1, ("Failed to store configuration data!\n"));
596 status = idmap_autorid_preallocate_wellknown(dom);
597 if (!NT_STATUS_IS_OK(status)) {
598 DEBUG(1, ("Failed to preallocate wellknown sids: %s\n",
606 static NTSTATUS idmap_autorid_initialize(struct idmap_domain *dom)
608 struct idmap_tdb_common_context *commonconfig;
609 struct autorid_global_config *config;
612 if (!strequal(dom->name, "*")) {
613 DEBUG(0, ("idmap_autorid_initialize: Error: autorid configured "
614 "for domain '%s'. But autorid can only be used for "
615 "the default idmap configuration.\n", dom->name));
616 return NT_STATUS_INVALID_PARAMETER;
619 commonconfig = talloc_zero(dom, struct idmap_tdb_common_context);
621 DEBUG(0, ("Out of memory!\n"));
622 return NT_STATUS_NO_MEMORY;
624 dom->private_data = commonconfig;
626 commonconfig->rw_ops = talloc_zero(commonconfig, struct idmap_rw_ops);
627 if (commonconfig->rw_ops == NULL) {
628 DEBUG(0, ("Out of memory!\n"));
629 return NT_STATUS_NO_MEMORY;
632 config = talloc_zero(commonconfig, struct autorid_global_config);
634 DEBUG(0, ("Out of memory!\n"));
635 return NT_STATUS_NO_MEMORY;
637 commonconfig->private_data = config;
639 config->minvalue = dom->low_id;
640 config->rangesize = lp_parm_int(-1, "idmap config *",
641 "rangesize", 100000);
643 config->maxranges = (dom->high_id - dom->low_id + 1) /
646 if (config->maxranges == 0) {
647 DEBUG(1, ("Allowed uid range is smaller than rangesize. "
648 "Increase uid range or decrease rangesize.\n"));
649 status = NT_STATUS_INVALID_PARAMETER;
653 /* check if the high-low limit is a multiple of the rangesize */
654 if ((dom->high_id - dom->low_id + 1) % config->rangesize != 0) {
655 DEBUG(5, ("High uid-low uid difference of %d "
656 "is not a multiple of the rangesize %d, "
657 "limiting ranges to lower boundary number of %d\n",
658 (dom->high_id - dom->low_id + 1), config->rangesize,
662 DEBUG(5, ("%d domain ranges with a size of %d are available\n",
663 config->maxranges, config->rangesize));
665 ignore_builtin = lp_parm_bool(-1, "idmap config *",
666 "ignore builtin", false);
668 /* fill the TDB common configuration */
670 commonconfig->max_id = config->rangesize -1;
671 commonconfig->hwmkey_uid = ALLOC_HWM_UID;
672 commonconfig->hwmkey_gid = ALLOC_HWM_GID;
673 commonconfig->rw_ops->get_new_id = idmap_autorid_allocate_id;
674 commonconfig->rw_ops->set_mapping = idmap_tdb_common_set_mapping;
676 status = idmap_autorid_db_open(state_path("autorid.tdb"),
677 NULL, /* TALLOC_CTX */
679 if (!NT_STATUS_IS_OK(status)) {
683 commonconfig->db = autorid_db;
685 status = dbwrap_trans_do(autorid_db,
686 idmap_autorid_initialize_action,
688 if (!NT_STATUS_IS_OK(status)) {
689 DEBUG(1, ("Failed to init the idmap database: %s\n",
704 Close the idmap tdb instance
706 static struct idmap_methods autorid_methods = {
707 .init = idmap_autorid_initialize,
708 .unixids_to_sids = idmap_autorid_unixids_to_sids,
709 .sids_to_unixids = idmap_autorid_sids_to_unixids,
710 .allocate_id = idmap_autorid_allocate_id
713 NTSTATUS idmap_autorid_init(void)
715 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION,
716 "autorid", &autorid_methods);