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-2011
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 #include "system/filesys.h"
29 #include "dbwrap/dbwrap_open.h"
31 #include "../libcli/security/dom_sid.h"
35 #define DBGC_CLASS DBGC_IDMAP
37 #define HWM "NEXT RANGE"
38 #define CONFIGKEY "CONFIG"
40 struct autorid_global_config {
46 struct autorid_domain_config {
49 struct autorid_global_config *globalcfg;
52 /* handle to the tdb storing domain <-> range assignments */
53 static struct db_context *autorid_db;
55 static NTSTATUS idmap_autorid_get_domainrange(struct db_context *db,
59 uint32_t domainnum, hwm;
62 struct autorid_domain_config *cfg;
64 cfg = (struct autorid_domain_config *)private_data;
65 dom_sid_string_buf(&(cfg->sid), sidstr, sizeof(sidstr));
67 if (!dbwrap_fetch_uint32(db, sidstr, &domainnum)) {
68 DEBUG(10, ("Acquiring new range for domain %s\n", sidstr));
70 /* fetch the current HWM */
71 if (!dbwrap_fetch_uint32(db, HWM, &hwm)) {
72 DEBUG(1, ("Fatal error while fetching current "
74 ret = NT_STATUS_INTERNAL_ERROR;
78 /* do we have a range left? */
79 if (hwm >= cfg->globalcfg->maxranges) {
80 DEBUG(1, ("No more domain ranges available!\n"));
81 ret = NT_STATUS_NO_MEMORY;
85 /* increase the HWM */
86 ret = dbwrap_change_uint32_atomic(db, HWM, &domainnum, 1);
87 if (!NT_STATUS_IS_OK(ret)) {
88 DEBUG(1, ("Fatal error while fetching a new "
89 "domain range value!\n"));
93 /* store away the new mapping in both directions */
94 ret = dbwrap_trans_store_uint32(db, sidstr, domainnum);
95 if (!NT_STATUS_IS_OK(ret)) {
96 DEBUG(1, ("Fatal error while storing new "
97 "domain->range assignment!\n"));
101 numstr = talloc_asprintf(db, "%u", domainnum);
103 ret = NT_STATUS_NO_MEMORY;
107 ret = dbwrap_trans_store_bystring(db, numstr,
108 string_term_tdb_data(sidstr),
111 if (!NT_STATUS_IS_OK(ret)) {
112 DEBUG(1, ("Fatal error while storing "
113 "new domain->range assignment!\n"));
116 DEBUG(5, ("Acquired new range #%d for domain %s\n",
120 DEBUG(10, ("Using range #%d for domain %s\n", domainnum, sidstr));
121 cfg->domainnum = domainnum;
130 static NTSTATUS idmap_autorid_id_to_sid(struct autorid_global_config *cfg,
138 /* can this be one of our ids? */
139 if (map->xid.id < cfg->minvalue) {
140 DEBUG(10, ("id %d is lower than minimum value, "
141 "ignoring mapping request\n", map->xid.id));
142 map->status = ID_UNKNOWN;
146 if (map->xid.id > (cfg->minvalue + cfg->rangesize * cfg->maxranges)) {
147 DEBUG(10, ("id %d is outside of maximum id value, "
148 "ignoring mapping request\n", map->xid.id));
149 map->status = ID_UNKNOWN;
153 /* determine the range of this uid */
154 range = ((map->xid.id - cfg->minvalue) / cfg->rangesize);
156 keystr = talloc_asprintf(talloc_tos(), "%u", range);
158 return NT_STATUS_NO_MEMORY;
161 data = dbwrap_fetch_bystring(autorid_db, talloc_tos(), keystr);
165 DEBUG(4, ("id %d belongs to range %d which does not have "
166 "domain mapping, ignoring mapping request\n",
167 map->xid.id, range));
168 map->status = ID_UNKNOWN;
172 string_to_sid(&sid, (const char *)data.dptr);
173 TALLOC_FREE(data.dptr);
175 sid_compose(map->sid, &sid,
176 (map->xid.id - cfg->minvalue -
177 range * cfg->rangesize));
179 /* We **really** should have some way of validating
180 the SID exists and is the correct type here. But
181 that is a deficiency in the idmap_rid design. */
183 map->status = ID_MAPPED;
187 /**********************************
188 Single sid to id lookup function.
189 **********************************/
191 static NTSTATUS idmap_autorid_sid_to_id(struct autorid_global_config *global,
192 struct autorid_domain_config *domain,
197 sid_peek_rid(map->sid, &rid);
199 /* if the rid is higher than the size of the range, we cannot map it */
200 if (rid >= global->rangesize) {
201 map->status = ID_UNKNOWN;
202 DEBUG(2, ("RID %d is larger then size of range (%d), "
203 "user cannot be mapped\n", rid, global->rangesize));
204 return NT_STATUS_UNSUCCESSFUL;
206 map->xid.id = global->minvalue +
207 (global->rangesize * domain->domainnum)+rid;
209 /* We **really** should have some way of validating
210 the SID exists and is the correct type here. But
211 that is a deficiency in the idmap_rid design. */
213 map->status = ID_MAPPED;
218 /**********************************
219 lookup a set of unix ids.
220 **********************************/
222 static NTSTATUS idmap_autorid_unixids_to_sids(struct idmap_domain *dom,
225 struct autorid_global_config *globalcfg;
229 /* initialize the status to avoid surprise */
230 for (i = 0; ids[i]; i++) {
231 ids[i]->status = ID_UNKNOWN;
234 globalcfg = talloc_get_type(dom->private_data,
235 struct autorid_global_config);
237 for (i = 0; ids[i]; i++) {
239 ret = idmap_autorid_id_to_sid(globalcfg, ids[i]);
241 if ((!NT_STATUS_IS_OK(ret)) &&
242 (!NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED))) {
243 /* some fatal error occurred, log it */
244 DEBUG(3, ("Unexpected error resolving an ID "
245 " (%d)\n", ids[i]->xid.id));
255 /**********************************
256 lookup a set of sids.
257 **********************************/
259 static NTSTATUS idmap_autorid_sids_to_unixids(struct idmap_domain *dom,
262 struct autorid_global_config *global;
266 /* initialize the status to avoid surprise */
267 for (i = 0; ids[i]; i++) {
268 ids[i]->status = ID_UNKNOWN;
271 global = talloc_get_type(dom->private_data,
272 struct autorid_global_config);
274 for (i = 0; ids[i]; i++) {
275 struct winbindd_tdc_domain *domain;
276 struct autorid_domain_config domaincfg;
279 ZERO_STRUCT(domaincfg);
281 sid_copy(&domaincfg.sid, ids[i]->sid);
282 if (!sid_split_rid(&domaincfg.sid, &rid)) {
283 DEBUG(4, ("Could not determine domain SID from %s, "
284 "ignoring mapping request\n",
285 sid_string_dbg(ids[i]->sid)));
290 * Check if the domain is around
292 domain = wcache_tdc_fetch_domainbysid(talloc_tos(),
294 if (domain == NULL) {
295 DEBUG(10, ("Ignoring unknown domain sid %s\n",
296 sid_string_dbg(&domaincfg.sid)));
301 domaincfg.globalcfg = global;
303 ret = dbwrap_trans_do(autorid_db,
304 idmap_autorid_get_domainrange,
307 if (!NT_STATUS_IS_OK(ret)) {
308 DEBUG(3, ("Could not determine range for domain, "
309 "check previous messages for reason\n"));
313 ret = idmap_autorid_sid_to_id(global, &domaincfg, ids[i]);
315 if ((!NT_STATUS_IS_OK(ret)) &&
316 (!NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED))) {
317 /* some fatal error occurred, log it */
318 DEBUG(3, ("Unexpected error resolving a SID (%s)\n",
319 sid_string_dbg(ids[i]->sid)));
331 * open and initialize the database which stores the ranges for the domains
333 static NTSTATUS idmap_autorid_db_init(void)
338 /* its already open */
342 /* Open idmap repository */
343 autorid_db = db_open(NULL, state_path("autorid.tdb"), 0,
344 TDB_DEFAULT, O_RDWR | O_CREAT, 0644);
347 DEBUG(0, ("Unable to open idmap_autorid database '%s'\n",
348 state_path("autorid.tdb")));
349 return NT_STATUS_UNSUCCESSFUL;
352 /* Initialize high water mark for the currently used range to 0 */
353 hwm = dbwrap_fetch_int32(autorid_db, HWM);
356 (dbwrap_trans_store_int32(autorid_db, HWM, 0))) {
358 ("Unable to initialise HWM in autorid "
360 return NT_STATUS_INTERNAL_DB_ERROR;
367 static struct autorid_global_config *idmap_autorid_loadconfig(TALLOC_CTX * ctx)
371 struct autorid_global_config *cfg;
372 unsigned long minvalue, rangesize, maxranges;
374 data = dbwrap_fetch_bystring(autorid_db, ctx, CONFIGKEY);
377 DEBUG(10, ("No saved config found\n"));
381 cfg = talloc_zero(ctx, struct autorid_global_config);
386 if (sscanf((char *)data.dptr,
387 "minvalue:%lu rangesize:%lu maxranges:%lu",
388 &minvalue, &rangesize, &maxranges) != 3) {
390 ("Found invalid configuration data"
391 "creating new config\n"));
395 cfg->minvalue = minvalue;
396 cfg->rangesize = rangesize;
397 cfg->maxranges = maxranges;
399 DEBUG(10, ("Loaded previously stored configuration "
400 "minvalue:%d rangesize:%d\n",
401 cfg->minvalue, cfg->rangesize));
407 static NTSTATUS idmap_autorid_saveconfig(struct autorid_global_config *cfg)
415 talloc_asprintf(talloc_tos(),
416 "minvalue:%u rangesize:%u maxranges:%u",
417 cfg->minvalue, cfg->rangesize, cfg->maxranges);
420 return NT_STATUS_NO_MEMORY;
423 data = string_tdb_data(cfgstr);
425 status = dbwrap_trans_store_bystring(autorid_db, CONFIGKEY,
433 static NTSTATUS idmap_autorid_initialize(struct idmap_domain *dom)
435 struct autorid_global_config *config;
436 struct autorid_global_config *storedconfig = NULL;
440 if (!strequal(dom->name, "*")) {
441 DEBUG(0, ("idmap_autorid_initialize: Error: autorid configured "
442 "for domain '%s'. But autorid can only be used for "
443 "the default idmap configuration.\n", dom->name));
444 return NT_STATUS_INVALID_PARAMETER;
447 config = talloc_zero(dom, struct autorid_global_config);
449 DEBUG(0, ("Out of memory!\n"));
450 return NT_STATUS_NO_MEMORY;
453 status = idmap_autorid_db_init();
454 if (!NT_STATUS_IS_OK(status)) {
458 config->minvalue = dom->low_id;
459 config->rangesize = lp_parm_int(-1, "idmap config *", "rangesize", 100000);
461 if (config->rangesize < 2000) {
462 DEBUG(1, ("autorid rangesize must be at least 2000\n"));
463 status = NT_STATUS_INVALID_PARAMETER;
467 config->maxranges = (dom->high_id - dom->low_id + 1) /
470 if (config->maxranges == 0) {
471 DEBUG(1, ("allowed uid range is smaller then rangesize, "
472 "increase uid range or decrease rangesize\n"));
473 status = NT_STATUS_INVALID_PARAMETER;
477 /* check if the high-low limit is a multiple of the rangesize */
478 if ((dom->high_id - dom->low_id + 1) % config->rangesize != 0) {
479 DEBUG(5, ("High uid-low uid difference of %d "
480 "is not a multiple of the rangesize %d, "
481 "limiting ranges to lower boundary number of %d\n",
482 (dom->high_id - dom->low_id + 1), config->rangesize,
486 DEBUG(10, ("Current configuration in config is "
487 "minvalue:%d rangesize:%d maxranges:%d\n",
488 config->minvalue, config->rangesize, config->maxranges));
490 /* read previously stored config and current HWM */
491 storedconfig = idmap_autorid_loadconfig(talloc_tos());
493 if (!dbwrap_fetch_uint32(autorid_db, HWM, &hwm)) {
494 DEBUG(1, ("Fatal error while fetching current "
496 status = NT_STATUS_INTERNAL_ERROR;
500 /* did the minimum value or rangesize change? */
502 ((storedconfig->minvalue != config->minvalue) ||
503 (storedconfig->rangesize != config->rangesize))) {
504 DEBUG(1, ("New configuration values for rangesize or "
505 "minimum uid value conflict with previously "
506 "used values! Aborting initialization\n"));
507 status = NT_STATUS_INVALID_PARAMETER;
512 * has the highest uid value been reduced to setting that is not
513 * sufficient any more for already existing ranges?
515 if (hwm > config->maxranges) {
516 DEBUG(1, ("New upper uid limit is too low to cover "
517 "existing mappings! Aborting initialization\n"));
518 status = NT_STATUS_INVALID_PARAMETER;
522 status = idmap_autorid_saveconfig(config);
524 if (!NT_STATUS_IS_OK(status)) {
525 DEBUG(1, ("Failed to store configuration data!\n"));
529 DEBUG(5, ("%d domain ranges with a size of %d are available\n",
530 config->maxranges, config->rangesize));
532 dom->private_data = config;
540 talloc_free(storedconfig);
546 Close the idmap tdb instance
548 static struct idmap_methods autorid_methods = {
549 .init = idmap_autorid_initialize,
550 .unixids_to_sids = idmap_autorid_unixids_to_sids,
551 .sids_to_unixids = idmap_autorid_sids_to_unixids,
554 NTSTATUS idmap_autorid_init(void)
556 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION,
557 "autorid", &autorid_methods);