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"
28 #include "dbwrap/dbwrap.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 ALLOC_HWM "NEXT ALLOC ID"
39 #define ALLOC_POOL_SIZE 500
40 #define CONFIGKEY "CONFIG"
42 struct autorid_global_config {
48 struct autorid_domain_config {
51 struct autorid_global_config *globalcfg;
54 /* handle to the tdb storing domain <-> range assignments */
55 static struct db_context *autorid_db;
57 static NTSTATUS idmap_autorid_get_domainrange(struct db_context *db,
61 uint32_t domainnum, hwm;
64 struct autorid_domain_config *cfg;
66 cfg = (struct autorid_domain_config *)private_data;
67 dom_sid_string_buf(&(cfg->sid), sidstr, sizeof(sidstr));
69 if (!dbwrap_fetch_uint32(db, sidstr, &domainnum)) {
70 DEBUG(10, ("Acquiring new range for domain %s\n", sidstr));
72 /* fetch the current HWM */
73 if (!dbwrap_fetch_uint32(db, HWM, &hwm)) {
74 DEBUG(1, ("Fatal error while fetching current "
76 ret = NT_STATUS_INTERNAL_ERROR;
80 /* do we have a range left? */
81 if (hwm >= cfg->globalcfg->maxranges) {
82 DEBUG(1, ("No more domain ranges available!\n"));
83 ret = NT_STATUS_NO_MEMORY;
87 /* increase the HWM */
88 ret = dbwrap_change_uint32_atomic(db, HWM, &domainnum, 1);
89 if (!NT_STATUS_IS_OK(ret)) {
90 DEBUG(1, ("Fatal error while fetching a new "
91 "domain range value!\n"));
95 /* store away the new mapping in both directions */
96 ret = dbwrap_trans_store_uint32(db, sidstr, domainnum);
97 if (!NT_STATUS_IS_OK(ret)) {
98 DEBUG(1, ("Fatal error while storing new "
99 "domain->range assignment!\n"));
103 numstr = talloc_asprintf(db, "%u", domainnum);
105 ret = NT_STATUS_NO_MEMORY;
109 ret = dbwrap_trans_store_bystring(db, numstr,
110 string_term_tdb_data(sidstr),
113 if (!NT_STATUS_IS_OK(ret)) {
114 DEBUG(1, ("Fatal error while storing "
115 "new domain->range assignment!\n"));
118 DEBUG(5, ("Acquired new range #%d for domain %s\n",
122 DEBUG(10, ("Using range #%d for domain %s\n", domainnum, sidstr));
123 cfg->domainnum = domainnum;
132 static NTSTATUS idmap_autorid_id_to_sid(struct autorid_global_config *cfg,
141 /* can this be one of our ids? */
142 if (map->xid.id < cfg->minvalue) {
143 DEBUG(10, ("id %d is lower than minimum value, "
144 "ignoring mapping request\n", map->xid.id));
145 map->status = ID_UNKNOWN;
149 if (map->xid.id > (cfg->minvalue + cfg->rangesize * cfg->maxranges)) {
150 DEBUG(10, ("id %d is outside of maximum id value, "
151 "ignoring mapping request\n", map->xid.id));
152 map->status = ID_UNKNOWN;
156 /* determine the range of this uid */
157 range = ((map->xid.id - cfg->minvalue) / cfg->rangesize);
159 keystr = talloc_asprintf(talloc_tos(), "%u", range);
161 return NT_STATUS_NO_MEMORY;
164 status = dbwrap_fetch_bystring(autorid_db, talloc_tos(), keystr, &data);
167 if (!NT_STATUS_IS_OK(status)) {
168 DEBUG(4, ("id %d belongs to range %d which does not have "
169 "domain mapping, ignoring mapping request\n",
170 map->xid.id, range));
171 map->status = ID_UNKNOWN;
175 string_to_sid(&sid, (const char *)data.dptr);
176 TALLOC_FREE(data.dptr);
178 sid_compose(map->sid, &sid,
179 (map->xid.id - cfg->minvalue -
180 range * cfg->rangesize));
182 /* We **really** should have some way of validating
183 the SID exists and is the correct type here. But
184 that is a deficiency in the idmap_rid design. */
186 map->status = ID_MAPPED;
190 /**********************************
191 Single sid to id lookup function.
192 **********************************/
194 static NTSTATUS idmap_autorid_sid_to_id(struct autorid_global_config *global,
195 struct autorid_domain_config *domain,
200 sid_peek_rid(map->sid, &rid);
202 /* if the rid is higher than the size of the range, we cannot map it */
203 if (rid >= global->rangesize) {
204 map->status = ID_UNKNOWN;
205 DEBUG(2, ("RID %d is larger then size of range (%d), "
206 "user cannot be mapped\n", rid, global->rangesize));
207 return NT_STATUS_UNSUCCESSFUL;
209 map->xid.id = global->minvalue +
210 (global->rangesize * domain->domainnum)+rid;
212 /* We **really** should have some way of validating
213 the SID exists and is the correct type here. But
214 that is a deficiency in the idmap_rid design. */
216 map->status = ID_MAPPED;
221 /**********************************
222 lookup a set of unix ids.
223 **********************************/
225 static NTSTATUS idmap_autorid_unixids_to_sids(struct idmap_domain *dom,
228 struct autorid_global_config *globalcfg;
232 /* initialize the status to avoid surprise */
233 for (i = 0; ids[i]; i++) {
234 ids[i]->status = ID_UNKNOWN;
237 globalcfg = talloc_get_type(dom->private_data,
238 struct autorid_global_config);
240 for (i = 0; ids[i]; i++) {
242 ret = idmap_autorid_id_to_sid(globalcfg, ids[i]);
244 if ((!NT_STATUS_IS_OK(ret)) &&
245 (!NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED))) {
246 /* some fatal error occurred, log it */
247 DEBUG(3, ("Unexpected error resolving an ID "
248 " (%d)\n", ids[i]->xid.id));
258 /**********************************
259 lookup a set of sids.
260 **********************************/
262 static NTSTATUS idmap_autorid_sids_to_unixids(struct idmap_domain *dom,
265 struct autorid_global_config *global;
269 /* initialize the status to avoid surprise */
270 for (i = 0; ids[i]; i++) {
271 ids[i]->status = ID_UNKNOWN;
274 global = talloc_get_type(dom->private_data,
275 struct autorid_global_config);
277 for (i = 0; ids[i]; i++) {
278 struct winbindd_tdc_domain *domain;
279 struct autorid_domain_config domaincfg;
282 ZERO_STRUCT(domaincfg);
284 sid_copy(&domaincfg.sid, ids[i]->sid);
285 if (!sid_split_rid(&domaincfg.sid, &rid)) {
286 DEBUG(4, ("Could not determine domain SID from %s, "
287 "ignoring mapping request\n",
288 sid_string_dbg(ids[i]->sid)));
293 * Check if the domain is around
295 domain = wcache_tdc_fetch_domainbysid(talloc_tos(),
297 if (domain == NULL) {
298 DEBUG(10, ("Ignoring unknown domain sid %s\n",
299 sid_string_dbg(&domaincfg.sid)));
304 domaincfg.globalcfg = global;
306 ret = dbwrap_trans_do(autorid_db,
307 idmap_autorid_get_domainrange,
310 if (!NT_STATUS_IS_OK(ret)) {
311 DEBUG(3, ("Could not determine range for domain, "
312 "check previous messages for reason\n"));
316 ret = idmap_autorid_sid_to_id(global, &domaincfg, ids[i]);
318 if ((!NT_STATUS_IS_OK(ret)) &&
319 (!NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED))) {
320 /* some fatal error occurred, log it */
321 DEBUG(3, ("Unexpected error resolving a SID (%s)\n",
322 sid_string_dbg(ids[i]->sid)));
334 * open and initialize the database which stores the ranges for the domains
336 static NTSTATUS idmap_autorid_db_init(void)
342 /* its already open */
346 /* Open idmap repository */
347 autorid_db = db_open(NULL, state_path("autorid.tdb"), 0,
348 TDB_DEFAULT, O_RDWR | O_CREAT, 0644);
351 DEBUG(0, ("Unable to open idmap_autorid database '%s'\n",
352 state_path("autorid.tdb")));
353 return NT_STATUS_UNSUCCESSFUL;
356 /* Initialize high water mark for the currently used range to 0 */
357 hwm = dbwrap_fetch_int32(autorid_db, HWM);
359 status = dbwrap_trans_store_int32(autorid_db, HWM, 0);
360 if (!NT_STATUS_IS_OK(status)) {
362 ("Unable to initialise HWM in autorid "
363 "database: %s\n", nt_errstr(status)));
364 return NT_STATUS_INTERNAL_DB_ERROR;
368 /* Initialize high water mark for alloc pool to 0 */
369 hwm = dbwrap_fetch_int32(autorid_db, ALLOC_HWM);
371 status = dbwrap_trans_store_int32(autorid_db, ALLOC_HWM, 0);
372 if (!NT_STATUS_IS_OK(status)) {
374 ("Unable to initialise alloc HWM in autorid "
375 "database: %s\n", nt_errstr(status)));
376 return NT_STATUS_INTERNAL_DB_ERROR;
382 static struct autorid_global_config *idmap_autorid_loadconfig(TALLOC_CTX * ctx)
386 struct autorid_global_config *cfg;
387 unsigned long minvalue, rangesize, maxranges;
390 status = dbwrap_fetch_bystring(autorid_db, ctx, CONFIGKEY, &data);
392 if (!NT_STATUS_IS_OK(status)) {
393 DEBUG(10, ("No saved config found\n"));
397 cfg = talloc_zero(ctx, struct autorid_global_config);
402 if (sscanf((char *)data.dptr,
403 "minvalue:%lu rangesize:%lu maxranges:%lu",
404 &minvalue, &rangesize, &maxranges) != 3) {
406 ("Found invalid configuration data"
407 "creating new config\n"));
411 cfg->minvalue = minvalue;
412 cfg->rangesize = rangesize;
413 cfg->maxranges = maxranges;
415 DEBUG(10, ("Loaded previously stored configuration "
416 "minvalue:%d rangesize:%d\n",
417 cfg->minvalue, cfg->rangesize));
423 static NTSTATUS idmap_autorid_saveconfig(struct autorid_global_config *cfg)
431 talloc_asprintf(talloc_tos(),
432 "minvalue:%u rangesize:%u maxranges:%u",
433 cfg->minvalue, cfg->rangesize, cfg->maxranges);
436 return NT_STATUS_NO_MEMORY;
439 data = string_tdb_data(cfgstr);
441 status = dbwrap_trans_store_bystring(autorid_db, CONFIGKEY,
449 static NTSTATUS idmap_autorid_initialize(struct idmap_domain *dom)
451 struct autorid_global_config *config;
452 struct autorid_global_config *storedconfig = NULL;
456 if (!strequal(dom->name, "*")) {
457 DEBUG(0, ("idmap_autorid_initialize: Error: autorid configured "
458 "for domain '%s'. But autorid can only be used for "
459 "the default idmap configuration.\n", dom->name));
460 return NT_STATUS_INVALID_PARAMETER;
463 config = talloc_zero(dom, struct autorid_global_config);
465 DEBUG(0, ("Out of memory!\n"));
466 return NT_STATUS_NO_MEMORY;
469 status = idmap_autorid_db_init();
470 if (!NT_STATUS_IS_OK(status)) {
474 config->minvalue = dom->low_id;
475 config->rangesize = lp_parm_int(-1, "idmap config *", "rangesize", 100000);
477 if (config->rangesize < 2000) {
478 DEBUG(1, ("autorid rangesize must be at least 2000\n"));
479 status = NT_STATUS_INVALID_PARAMETER;
483 config->maxranges = (dom->high_id - dom->low_id + 1) /
486 if (config->maxranges == 0) {
487 DEBUG(1, ("allowed uid range is smaller then rangesize, "
488 "increase uid range or decrease rangesize\n"));
489 status = NT_STATUS_INVALID_PARAMETER;
493 /* check if the high-low limit is a multiple of the rangesize */
494 if ((dom->high_id - dom->low_id + 1) % config->rangesize != 0) {
495 DEBUG(5, ("High uid-low uid difference of %d "
496 "is not a multiple of the rangesize %d, "
497 "limiting ranges to lower boundary number of %d\n",
498 (dom->high_id - dom->low_id + 1), config->rangesize,
502 DEBUG(10, ("Current configuration in config is "
503 "minvalue:%d rangesize:%d maxranges:%d\n",
504 config->minvalue, config->rangesize, config->maxranges));
506 /* read previously stored config and current HWM */
507 storedconfig = idmap_autorid_loadconfig(talloc_tos());
509 if (!dbwrap_fetch_uint32(autorid_db, HWM, &hwm)) {
510 DEBUG(1, ("Fatal error while fetching current "
512 status = NT_STATUS_INTERNAL_ERROR;
516 /* did the minimum value or rangesize change? */
518 ((storedconfig->minvalue != config->minvalue) ||
519 (storedconfig->rangesize != config->rangesize))) {
520 DEBUG(1, ("New configuration values for rangesize or "
521 "minimum uid value conflict with previously "
522 "used values! Aborting initialization\n"));
523 status = NT_STATUS_INVALID_PARAMETER;
528 * has the highest uid value been reduced to setting that is not
529 * sufficient any more for already existing ranges?
531 if (hwm > config->maxranges) {
532 DEBUG(1, ("New upper uid limit is too low to cover "
533 "existing mappings! Aborting initialization\n"));
534 status = NT_STATUS_INVALID_PARAMETER;
538 status = idmap_autorid_saveconfig(config);
540 if (!NT_STATUS_IS_OK(status)) {
541 DEBUG(1, ("Failed to store configuration data!\n"));
545 DEBUG(5, ("%d domain ranges with a size of %d are available\n",
546 config->maxranges, config->rangesize));
548 dom->private_data = config;
556 talloc_free(storedconfig);
561 static NTSTATUS idmap_autorid_allocate_id(struct idmap_domain *dom,
562 struct unixid *xid) {
564 struct autorid_global_config *globalcfg;
568 if (!strequal(dom->name, "*")) {
569 DEBUG(3, ("idmap_autorid_allocate_id: "
570 "Refusing creation of mapping for domain'%s'. "
571 "Currently only supported for the default "
574 return NT_STATUS_NOT_IMPLEMENTED;
577 globalcfg = talloc_get_type(dom->private_data,
578 struct autorid_global_config);
580 if (!dbwrap_fetch_uint32(autorid_db, ALLOC_HWM, &hwm)) {
581 DEBUG(1, ("Failed to fetch current allocation HWM value!\n"));
582 return NT_STATUS_INTERNAL_ERROR;
585 if (hwm > ALLOC_POOL_SIZE) {
586 DEBUG(1, ("allocation pool is depleted!\n"));
587 return NT_STATUS_NO_MEMORY;
590 ret = dbwrap_change_uint32_atomic(autorid_db, ALLOC_HWM, &(xid->id), 1);
591 if (!NT_STATUS_IS_OK(ret)) {
592 DEBUG(1, ("Fatal error while allocating new ID!\n"));
594 xid->id = (xid->id)+(globalcfg->minvalue);
600 Close the idmap tdb instance
602 static struct idmap_methods autorid_methods = {
603 .init = idmap_autorid_initialize,
604 .unixids_to_sids = idmap_autorid_unixids_to_sids,
605 .sids_to_unixids = idmap_autorid_sids_to_unixids,
606 .allocate_id = idmap_autorid_allocate_id
609 NTSTATUS idmap_autorid_init(void)
611 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION,
612 "autorid", &autorid_methods);