source3/winbindd/idmap_autorid.c

   1 /*
   2  *  idmap_autorid: static map between Active Directory/NT RIDs
   3  *  and RFC 2307 accounts
   4  *
   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
   7  *
   8  *  Copyright (C) Christian Ambach, 2010-2011
   9  *
  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.
  14  *
  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.
  19  *
  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/>.
  22  *
  23  */
  24
  25 #include "includes.h"
  26 #include "winbindd.h"
  27 #include "dbwrap.h"
  28 #include "idmap.h"
  29 #include "../libcli/security/dom_sid.h"
  30
  31 #undef DBGC_CLASS
  32 #define DBGC_CLASS DBGC_IDMAP
  33
  34 #define HWM "NEXT RANGE"
  35 #define CONFIGKEY "CONFIG"
  36
  37 struct autorid_global_config {
  38         uint32_t minvalue;
  39         uint32_t rangesize;
  40         uint32_t maxranges;
  41 };
  42
  43 struct autorid_domain_config {
  44         struct dom_sid sid;
  45         uint32_t domainnum;
  46         struct autorid_global_config *globalcfg;
  47 };
  48
  49 /* handle to the tdb storing domain <-> range assignments */
  50 static struct db_context *autorid_db;
  51
  52 static NTSTATUS idmap_autorid_get_domainrange(struct db_context *db,
  53                                               void *private_data)
  54 {
  55         NTSTATUS ret;
  56         uint32_t domainnum, hwm;
  57         char *sidstr, *numstr;
  58         struct autorid_domain_config *cfg;
  59
  60         cfg = (struct autorid_domain_config *)private_data;
  61         sidstr = dom_sid_string(talloc_tos(), &(cfg->sid));
  62
  63         if (!sidstr) {
  64                 return NT_STATUS_NO_MEMORY;
  65         }
  66
  67         if (!dbwrap_fetch_uint32(db, sidstr, &domainnum)) {
  68                 DEBUG(10, ("Acquiring new range for domain %s\n", sidstr));
  69
  70                 /* fetch the current HWM */
  71                 if (!dbwrap_fetch_uint32(db, HWM, &hwm)) {
  72                         DEBUG(1, ("Fatal error while fetching current "
  73                                   "HWM value!\n"));
  74                         ret = NT_STATUS_INTERNAL_ERROR;
  75                         goto error;
  76                 }
  77
  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;
  82                         goto error;
  83                 }
  84
  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"));
  90                         goto error;
  91                 }
  92
  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"));
  98                         goto error;
  99                 }
 100
 101                 numstr = talloc_asprintf(db, "%u", domainnum);
 102                 if (!numstr) {
 103                         ret = NT_STATUS_NO_MEMORY;
 104                         goto error;
 105                 }
 106
 107                 ret = dbwrap_trans_store_bystring(db, numstr,
 108                                                   string_term_tdb_data(sidstr),
 109                                                   TDB_INSERT);
 110                 if (!NT_STATUS_IS_OK(ret)) {
 111                         talloc_free(numstr);
 112                         DEBUG(1, ("Fatal error while storing "
 113                                   "new domain->range assignment!\n"));
 114                         goto error;
 115                 }
 116                 talloc_free(numstr);
 117                 DEBUG(5, ("Acquired new range #%d for domain %s\n",
 118                           domainnum, sidstr));
 119         }
 120
 121         DEBUG(10, ("Using range #%d for domain %s\n", domainnum, sidstr));
 122         cfg->domainnum = domainnum;
 123
 124         talloc_free(sidstr);
 125         return NT_STATUS_OK;
 126
 127       error:
 128         talloc_free(sidstr);
 129         return ret;
 130
 131 }
 132
 133 static NTSTATUS idmap_autorid_id_to_sid(struct autorid_global_config *cfg,
 134                                         struct id_map *map)
 135 {
 136         uint32_t range;
 137         TDB_DATA data;
 138         char *keystr;
 139         struct dom_sid sid;
 140
 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;
 146                 return NT_STATUS_OK;
 147         }
 148
 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;
 153                 return NT_STATUS_OK;
 154         }
 155
 156         /* determine the range of this uid */
 157         range = ((map->xid.id - cfg->minvalue) / cfg->rangesize);
 158
 159         keystr = talloc_asprintf(talloc_tos(), "%u", range);
 160         if (!keystr) {
 161                 return NT_STATUS_NO_MEMORY;
 162         }
 163
 164         data = dbwrap_fetch_bystring(autorid_db, talloc_tos(), keystr);
 165         TALLOC_FREE(keystr);
 166
 167         if (!data.dptr) {
 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                 return NT_STATUS_OK;
 172         }
 173
 174         string_to_sid(&sid, (const char *)data.dptr);
 175         TALLOC_FREE(data.dptr);
 176
 177         sid_compose(map->sid, &sid,
 178                     (map->xid.id - cfg->minvalue -
 179                      range * cfg->rangesize));
 180
 181         /* We **really** should have some way of validating
 182            the SID exists and is the correct type here.  But
 183            that is a deficiency in the idmap_rid design. */
 184
 185         map->status = ID_MAPPED;
 186         return NT_STATUS_OK;
 187 }
 188
 189 /**********************************
 190  Single sid to id lookup function.
 191 **********************************/
 192
 193 static NTSTATUS idmap_autorid_sid_to_id(struct autorid_global_config *global,
 194                                         struct autorid_domain_config *domain,
 195                                         struct id_map *map)
 196 {
 197         uint32_t rid;
 198
 199         sid_peek_rid(map->sid, &rid);
 200
 201         /* if the rid is higher than the size of the range, we cannot map it */
 202         if (rid >= global->rangesize) {
 203                 map->status = ID_UNKNOWN;
 204                 DEBUG(2, ("RID %d is larger then size of range (%d), "
 205                           "user cannot be mapped\n", rid, global->rangesize));
 206                 return NT_STATUS_UNSUCCESSFUL;
 207         }
 208         map->xid.id = global->minvalue +
 209             (global->rangesize * domain->domainnum)+rid;
 210
 211         /* We **really** should have some way of validating
 212            the SID exists and is the correct type here.  But
 213            that is a deficiency in the idmap_rid design. */
 214
 215         map->status = ID_MAPPED;
 216
 217         return NT_STATUS_OK;
 218 }
 219
 220 /**********************************
 221  lookup a set of unix ids.
 222 **********************************/
 223
 224 static NTSTATUS idmap_autorid_unixids_to_sids(struct idmap_domain *dom,
 225                                               struct id_map **ids)
 226 {
 227         struct autorid_global_config *globalcfg;
 228         NTSTATUS ret;
 229         int i;
 230
 231         /* initialize the status to avoid surprise */
 232         for (i = 0; ids[i]; i++) {
 233                 ids[i]->status = ID_UNKNOWN;
 234         }
 235
 236         globalcfg = talloc_get_type(dom->private_data,
 237                                     struct autorid_global_config);
 238
 239         for (i = 0; ids[i]; i++) {
 240
 241                 ret = idmap_autorid_id_to_sid(globalcfg, ids[i]);
 242
 243                 if ((!NT_STATUS_IS_OK(ret)) &&
 244                     (!NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED))) {
 245                         /* some fatal error occurred, log it */
 246                         DEBUG(3, ("Unexpected error resolving an ID "
 247                                   " (%d)\n", ids[i]->xid.id));
 248                         goto failure;
 249                 }
 250         }
 251         return NT_STATUS_OK;
 252
 253       failure:
 254         return ret;
 255 }
 256
 257 /**********************************
 258  lookup a set of sids.
 259 **********************************/
 260
 261 static NTSTATUS idmap_autorid_sids_to_unixids(struct idmap_domain *dom,
 262                                               struct id_map **ids)
 263 {
 264         struct autorid_global_config *global;
 265         NTSTATUS ret;
 266         int i;
 267
 268         /* initialize the status to avoid surprise */
 269         for (i = 0; ids[i]; i++) {
 270                 ids[i]->status = ID_UNKNOWN;
 271         }
 272
 273         global = talloc_get_type(dom->private_data,
 274                                  struct autorid_global_config);
 275
 276         for (i = 0; ids[i]; i++) {
 277                 struct winbindd_tdc_domain *domain;
 278                 struct autorid_domain_config domaincfg;
 279                 uint32_t rid;
 280
 281                 ZERO_STRUCT(domaincfg);
 282
 283                 sid_copy(&domaincfg.sid, ids[i]->sid);
 284                 if (!sid_split_rid(&domaincfg.sid, &rid)) {
 285                         DEBUG(4, ("Could not determine domain SID from %s, "
 286                                   "ignoring mapping request\n",
 287                                   sid_string_dbg(ids[i]->sid)));
 288                         continue;
 289                 }
 290
 291                 /*
 292                  * Check if the domain is around
 293                  */
 294                 domain = wcache_tdc_fetch_domainbysid(talloc_tos(),
 295                                                       &domaincfg.sid);
 296                 if (domain == NULL) {
 297                         DEBUG(10, ("Ignoring unknown domain sid %s\n",
 298                                    sid_string_dbg(&domaincfg.sid)));
 299                         continue;
 300                 }
 301                 TALLOC_FREE(domain);
 302
 303                 domaincfg.globalcfg = global;
 304
 305                 ret = dbwrap_trans_do(autorid_db,
 306                                       idmap_autorid_get_domainrange,
 307                                       &domaincfg);
 308
 309                 if (!NT_STATUS_IS_OK(ret)) {
 310                         DEBUG(3, ("Could not determine range for domain, "
 311                                   "check previous messages for reason\n"));
 312                         goto failure;
 313                 }
 314
 315                 ret = idmap_autorid_sid_to_id(global, &domaincfg, ids[i]);
 316
 317                 if ((!NT_STATUS_IS_OK(ret)) &&
 318                     (!NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED))) {
 319                         /* some fatal error occurred, log it */
 320                         DEBUG(3, ("Unexpected error resolving a SID (%s)\n",
 321                                   sid_string_dbg(ids[i]->sid)));
 322                         goto failure;
 323                 }
 324         }
 325         return NT_STATUS_OK;
 326
 327       failure:
 328         return ret;
 329
 330 }
 331
 332 /*
 333  * open and initialize the database which stores the ranges for the domains
 334  */
 335 static NTSTATUS idmap_autorid_db_init(void)
 336 {
 337         int32_t hwm;
 338
 339         if (autorid_db) {
 340                 /* its already open */
 341                 return NT_STATUS_OK;
 342         }
 343
 344         /* Open idmap repository */
 345         autorid_db = db_open(NULL, state_path("autorid.tdb"), 0,
 346                              TDB_DEFAULT, O_RDWR | O_CREAT, 0644);
 347
 348         if (!autorid_db) {
 349                 DEBUG(0, ("Unable to open idmap_autorid database '%s'\n",
 350                           state_path("autorid.tdb")));
 351                 return NT_STATUS_UNSUCCESSFUL;
 352         }
 353
 354         /* Initialize high water mark for the currently used range to 0 */
 355         hwm = dbwrap_fetch_int32(autorid_db, HWM);
 356         if ((hwm < 0)) {
 357                 if (!NT_STATUS_IS_OK
 358                     (dbwrap_trans_store_int32(autorid_db, HWM, 0))) {
 359                         DEBUG(0,
 360                               ("Unable to initialise HWM in autorid "
 361                                "database\n"));
 362                         return NT_STATUS_INTERNAL_DB_ERROR;
 363                 }
 364         }
 365
 366         return NT_STATUS_OK;
 367 }
 368
 369 static struct autorid_global_config *idmap_autorid_loadconfig(TALLOC_CTX * ctx)
 370 {
 371
 372         TDB_DATA data;
 373         struct autorid_global_config *cfg;
 374         unsigned long minvalue, rangesize, maxranges;
 375
 376         data = dbwrap_fetch_bystring(autorid_db, ctx, CONFIGKEY);
 377
 378         if (!data.dptr) {
 379                 DEBUG(10, ("No saved config found\n"));
 380                 return NULL;
 381         }
 382
 383         cfg = TALLOC_ZERO_P(ctx, struct autorid_global_config);
 384         if (!cfg) {
 385                 return NULL;
 386         }
 387
 388         if (sscanf((char *)data.dptr,
 389                    "minvalue:%lu rangesize:%lu maxranges:%lu",
 390                    &minvalue, &rangesize, &maxranges) != 3) {
 391                 DEBUG(1,
 392                       ("Found invalid configuration data"
 393                        "creating new config\n"));
 394                 return NULL;
 395         }
 396
 397         cfg->minvalue = minvalue;
 398         cfg->rangesize = rangesize;
 399         cfg->maxranges = maxranges;
 400
 401         DEBUG(10, ("Loaded previously stored configuration "
 402                    "minvalue:%d rangesize:%d\n",
 403                    cfg->minvalue, cfg->rangesize));
 404
 405         return cfg;
 406
 407 }
 408
 409 static NTSTATUS idmap_autorid_saveconfig(struct autorid_global_config *cfg)
 410 {
 411
 412         NTSTATUS status;
 413         TDB_DATA data;
 414         char *cfgstr;
 415
 416         cfgstr =
 417             talloc_asprintf(talloc_tos(),
 418                             "minvalue:%u rangesize:%u maxranges:%u",
 419                             cfg->minvalue, cfg->rangesize, cfg->maxranges);
 420
 421         if (!cfgstr) {
 422                 return NT_STATUS_NO_MEMORY;
 423         }
 424
 425         data = string_tdb_data(cfgstr);
 426
 427         status = dbwrap_trans_store_bystring(autorid_db, CONFIGKEY,
 428                                              data, TDB_REPLACE);
 429
 430         talloc_free(cfgstr);
 431
 432         return status;
 433 }
 434
 435 static NTSTATUS idmap_autorid_initialize(struct idmap_domain *dom,
 436                                          const char *params)
 437 {
 438         struct autorid_global_config *config;
 439         struct autorid_global_config *storedconfig = NULL;
 440         NTSTATUS status;
 441         uint32_t hwm;
 442
 443         config = TALLOC_ZERO_P(dom, struct autorid_global_config);
 444         if (!config) {
 445                 DEBUG(0, ("Out of memory!\n"));
 446                 return NT_STATUS_NO_MEMORY;
 447         }
 448
 449         status = idmap_autorid_db_init();
 450         if (!NT_STATUS_IS_OK(status)) {
 451                 goto error;
 452         }
 453
 454         config->minvalue = dom->low_id;
 455         config->rangesize = lp_parm_int(-1, "autorid", "rangesize", 100000);
 456
 457         if (config->rangesize < 2000) {
 458                 DEBUG(1, ("autorid rangesize must be at least 2000\n"));
 459                 status = NT_STATUS_INVALID_PARAMETER;
 460                 goto error;
 461         }
 462
 463         config->maxranges = (dom->high_id - dom->low_id + 1) /
 464             config->rangesize;
 465
 466         if (config->maxranges == 0) {
 467                 DEBUG(1, ("allowed uid range is smaller then rangesize, "
 468                           "increase uid range or decrease rangesize\n"));
 469                 status = NT_STATUS_INVALID_PARAMETER;
 470                 goto error;
 471         }
 472
 473         /* check if the high-low limit is a multiple of the rangesize */
 474         if ((dom->high_id - dom->low_id + 1) % config->rangesize != 0) {
 475                 DEBUG(5, ("High uid-low uid difference of %d "
 476                           "is not a multiple of the rangesize %d, "
 477                           "limiting ranges to lower boundary number of %d\n",
 478                           (dom->high_id - dom->low_id + 1), config->rangesize,
 479                           config->maxranges));
 480         }
 481
 482         DEBUG(10, ("Current configuration in config is "
 483                    "minvalue:%d rangesize:%d maxranges:%d\n",
 484                    config->minvalue, config->rangesize, config->maxranges));
 485
 486         /* read previously stored config and current HWM */
 487         storedconfig = idmap_autorid_loadconfig(talloc_tos());
 488
 489         if (!dbwrap_fetch_uint32(autorid_db, HWM, &hwm)) {
 490                 DEBUG(1, ("Fatal error while fetching current "
 491                           "HWM value!\n"));
 492                 status = NT_STATUS_INTERNAL_ERROR;
 493                 goto error;
 494         }
 495
 496         /* did the minimum value or rangesize change? */
 497         if (storedconfig &&
 498             ((storedconfig->minvalue != config->minvalue) ||
 499              (storedconfig->rangesize != config->rangesize))) {
 500                 DEBUG(1, ("New configuration values for rangesize or "
 501                           "minimum uid value conflict with previously "
 502                           "used values! Aborting initialization\n"));
 503                 status = NT_STATUS_INVALID_PARAMETER;
 504                 goto error;
 505         }
 506
 507         /*
 508          * has the highest uid value been reduced to setting that is not
 509          * sufficient any more for already existing ranges?
 510          */
 511         if (hwm > config->maxranges) {
 512                 DEBUG(1, ("New upper uid limit is too low to cover "
 513                           "existing mappings! Aborting initialization\n"));
 514                 status = NT_STATUS_INVALID_PARAMETER;
 515                 goto error;
 516         }
 517
 518         status = idmap_autorid_saveconfig(config);
 519
 520         if (!NT_STATUS_IS_OK(status)) {
 521                 DEBUG(1, ("Failed to store configuration data!\n"));
 522                 goto error;
 523         }
 524
 525         DEBUG(5, ("%d domain ranges with a size of %d are available\n",
 526                   config->maxranges, config->rangesize));
 527
 528         dom->private_data = config;
 529
 530         if (!NT_STATUS_IS_OK(status)) {
 531                 goto error;
 532         }
 533
 534         return NT_STATUS_OK;
 535
 536       error:
 537         talloc_free(config);
 538         talloc_free(storedconfig);
 539
 540         return status;
 541 }
 542
 543 /*
 544   Close the idmap tdb instance
 545 */
 546 static struct idmap_methods autorid_methods = {
 547         .init = idmap_autorid_initialize,
 548         .unixids_to_sids = idmap_autorid_unixids_to_sids,
 549         .sids_to_unixids = idmap_autorid_sids_to_unixids,
 550 };
 551
 552 NTSTATUS idmap_autorid_init(void)
 553 {
 554         return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION,
 555                                   "autorid", &autorid_methods);
 556 }