source3/winbindd/idmap_tdb_common.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    common functions for TDB based idmapping backends
   5
   6    Copyright (C) Christian Ambach 2012
   7
   8    These functions were initially copied over from idmap_tdb.c and idmap_tdb2.c
   9    which are:
  10
  11    Copyright (C) Tim Potter 2000
  12    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
  13    Copyright (C) Jeremy Allison 2006
  14    Copyright (C) Simo Sorce 2003-2006
  15    Copyright (C) Michael Adam 2009-2010
  16    Copyright (C) Andrew Tridgell 2007
  17
  18    This program is free software; you can redistribute it and/or modify
  19    it under the terms of the GNU General Public License as published by
  20    the Free Software Foundation; either version 2 of the License, or
  21    (at your option) any later version.
  22
  23    This program is distributed in the hope that it will be useful,
  24    but WITHOUT ANY WARRANTY; without even the implied warranty of
  25    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26    GNU General Public License for more details.
  27
  28    You should have received a copy of the GNU General Public License
  29    along with this program; if not, write to the Free Software
  30    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  31 */
  32
  33 #include "includes.h"
  34 #include "idmap_tdb_common.h"
  35 #include "dbwrap/dbwrap.h"
  36 #include "util_tdb.h"
  37 #include "idmap_rw.h"
  38 #include "../libcli/security/dom_sid.h"
  39
  40 #undef DBGC_CLASS
  41 #define DBGC_CLASS DBGC_IDMAP
  42
  43 struct idmap_tdb_common_allocate_id_context {
  44         const char *hwmkey;
  45         const char *hwmtype;
  46         uint32_t high_hwm;
  47         uint32_t hwm;
  48 };
  49
  50 static NTSTATUS idmap_tdb_common_allocate_id_action(struct db_context *db,
  51                                                     void *private_data)
  52 {
  53         NTSTATUS ret;
  54         struct idmap_tdb_common_allocate_id_context *state;
  55         uint32_t hwm;
  56
  57         state = (struct idmap_tdb_common_allocate_id_context *)private_data;
  58
  59         ret = dbwrap_fetch_uint32_bystring(db, state->hwmkey, &hwm);
  60         if (!NT_STATUS_IS_OK(ret)) {
  61                 ret = NT_STATUS_INTERNAL_DB_ERROR;
  62                 goto done;
  63         }
  64
  65         /* check it is in the range */
  66         if (hwm > state->high_hwm) {
  67                 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
  68                           state->hwmtype, (unsigned long)state->high_hwm));
  69                 ret = NT_STATUS_UNSUCCESSFUL;
  70                 goto done;
  71         }
  72
  73         /* fetch a new id and increment it */
  74         ret = dbwrap_change_uint32_atomic_bystring(db, state->hwmkey, &hwm, 1);
  75         if (!NT_STATUS_IS_OK(ret)) {
  76                 DEBUG(1, ("Fatal error while fetching a new %s value\n!",
  77                           state->hwmtype));
  78                 goto done;
  79         }
  80
  81         /* recheck it is in the range */
  82         if (hwm > state->high_hwm) {
  83                 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
  84                           state->hwmtype, (unsigned long)state->high_hwm));
  85                 ret = NT_STATUS_UNSUCCESSFUL;
  86                 goto done;
  87         }
  88
  89         ret = NT_STATUS_OK;
  90         state->hwm = hwm;
  91
  92       done:
  93         return ret;
  94 }
  95
  96 static NTSTATUS idmap_tdb_common_allocate_id(struct idmap_domain *dom,
  97                                              struct unixid *xid)
  98 {
  99         const char *hwmkey;
 100         const char *hwmtype;
 101         uint32_t hwm = 0;
 102         NTSTATUS status;
 103         struct idmap_tdb_common_allocate_id_context state;
 104         struct idmap_tdb_common_context *ctx;
 105
 106         ctx =
 107             talloc_get_type_abort(dom->private_data,
 108                                   struct idmap_tdb_common_context);
 109
 110         /* Get current high water mark */
 111         switch (xid->type) {
 112
 113         case ID_TYPE_UID:
 114                 hwmkey = ctx->hwmkey_uid;
 115                 hwmtype = "UID";
 116                 break;
 117
 118         case ID_TYPE_GID:
 119                 hwmkey = ctx->hwmkey_gid;
 120                 hwmtype = "GID";
 121                 break;
 122
 123         default:
 124                 DEBUG(2, ("Invalid ID type (0x%x)\n", xid->type));
 125                 return NT_STATUS_INVALID_PARAMETER;
 126         }
 127
 128         state.hwm = hwm;
 129         state.high_hwm = ctx->max_id;
 130         state.hwmtype = hwmtype;
 131         state.hwmkey = hwmkey;
 132
 133         status = dbwrap_trans_do(ctx->db, idmap_tdb_common_allocate_id_action,
 134                                  &state);
 135
 136         if (NT_STATUS_IS_OK(status)) {
 137                 xid->id = state.hwm;
 138                 DEBUG(10, ("New %s = %d\n", hwmtype, state.hwm));
 139         } else {
 140                 DEBUG(1, ("Error allocating a new %s\n", hwmtype));
 141         }
 142
 143         return status;
 144 }
 145
 146 /**
 147  * Allocate a new unix-ID.
 148  * For now this is for the default idmap domain only.
 149  * Should be extended later on.
 150  */
 151 NTSTATUS idmap_tdb_common_get_new_id(struct idmap_domain * dom,
 152                                      struct unixid * id)
 153 {
 154         NTSTATUS ret;
 155
 156         if (!strequal(dom->name, "*")) {
 157                 DEBUG(3, ("idmap_tdb_common_get_new_id: "
 158                           "Refusing allocation of a new unixid for domain'%s'. "
 159                           "Currently only supported for the default "
 160                           "domain \"*\".\n", dom->name));
 161                 return NT_STATUS_NOT_IMPLEMENTED;
 162         }
 163
 164         ret = idmap_tdb_common_allocate_id(dom, id);
 165
 166         return ret;
 167 }
 168
 169 /**
 170  * store a mapping in the database.
 171  */
 172
 173 struct idmap_tdb_common_set_mapping_context {
 174         const char *ksidstr;
 175         const char *kidstr;
 176 };
 177
 178 static NTSTATUS idmap_tdb_common_set_mapping_action(struct db_context *db,
 179                                                     void *private_data)
 180 {
 181         TDB_DATA data;
 182         NTSTATUS ret;
 183         struct idmap_tdb_common_set_mapping_context *state;
 184         TALLOC_CTX *tmp_ctx = talloc_stackframe();
 185
 186         state = (struct idmap_tdb_common_set_mapping_context *)private_data;
 187
 188         DEBUG(10, ("Storing %s <-> %s map\n", state->ksidstr, state->kidstr));
 189
 190         /* check whether sid mapping is already present in db */
 191         ret = dbwrap_fetch_bystring(db, tmp_ctx, state->ksidstr, &data);
 192         if (NT_STATUS_IS_OK(ret)) {
 193                 ret = NT_STATUS_OBJECT_NAME_COLLISION;
 194                 goto done;
 195         }
 196
 197         ret = dbwrap_store_bystring(db, state->ksidstr,
 198                                     string_term_tdb_data(state->kidstr),
 199                                     TDB_INSERT);
 200         if (!NT_STATUS_IS_OK(ret)) {
 201                 DEBUG(0, ("Error storing SID -> ID: %s\n", nt_errstr(ret)));
 202                 goto done;
 203         }
 204
 205         ret = dbwrap_store_bystring(db, state->kidstr,
 206                                     string_term_tdb_data(state->ksidstr),
 207                                     TDB_INSERT);
 208         if (!NT_STATUS_IS_OK(ret)) {
 209                 DEBUG(0, ("Error storing ID -> SID: %s\n", nt_errstr(ret)));
 210                 /* try to remove the previous stored SID -> ID map */
 211                 dbwrap_delete_bystring(db, state->ksidstr);
 212                 goto done;
 213         }
 214
 215         DEBUG(10, ("Stored %s <-> %s\n", state->ksidstr, state->kidstr));
 216
 217       done:
 218         talloc_free(tmp_ctx);
 219         return ret;
 220 }
 221
 222 NTSTATUS idmap_tdb_common_set_mapping(struct idmap_domain * dom,
 223                                       const struct id_map * map)
 224 {
 225         struct idmap_tdb_common_context *ctx;
 226         struct idmap_tdb_common_set_mapping_context state;
 227         NTSTATUS ret;
 228         char *ksidstr, *kidstr;
 229
 230         if (!map || !map->sid) {
 231                 return NT_STATUS_INVALID_PARAMETER;
 232         }
 233
 234         ksidstr = kidstr = NULL;
 235
 236         /* TODO: should we filter a set_mapping using low/high filters ? */
 237
 238         ctx =
 239             talloc_get_type_abort(dom->private_data,
 240                                   struct idmap_tdb_common_context);
 241
 242         switch (map->xid.type) {
 243
 244         case ID_TYPE_UID:
 245                 kidstr =
 246                     talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
 247                 break;
 248
 249         case ID_TYPE_GID:
 250                 kidstr =
 251                     talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
 252                 break;
 253
 254         default:
 255                 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
 256                 return NT_STATUS_INVALID_PARAMETER;
 257         }
 258
 259         if (kidstr == NULL) {
 260                 DEBUG(0, ("ERROR: Out of memory!\n"));
 261                 ret = NT_STATUS_NO_MEMORY;
 262                 goto done;
 263         }
 264
 265         ksidstr = sid_string_talloc(ctx, map->sid);
 266         if (ksidstr == NULL) {
 267                 DEBUG(0, ("Out of memory!\n"));
 268                 ret = NT_STATUS_NO_MEMORY;
 269                 goto done;
 270         }
 271
 272         state.ksidstr = ksidstr;
 273         state.kidstr = kidstr;
 274
 275         ret = dbwrap_trans_do(ctx->db, idmap_tdb_common_set_mapping_action,
 276                               &state);
 277
 278       done:
 279         talloc_free(ksidstr);
 280         talloc_free(kidstr);
 281         return ret;
 282 }
 283
 284 /*
 285  * Create a new mapping for an unmapped SID, also allocating a new ID.
 286  * This should be run inside a transaction.
 287  *
 288  * TODO:
 289  *  Properly integrate this with multi domain idmap config:
 290  *  Currently, the allocator is default-config only.
 291  */
 292 NTSTATUS idmap_tdb_common_new_mapping(struct idmap_domain * dom,
 293                                       struct id_map * map)
 294 {
 295         NTSTATUS ret;
 296         struct idmap_tdb_common_context *ctx;
 297
 298         ctx =
 299             talloc_get_type_abort(dom->private_data,
 300                                   struct idmap_tdb_common_context);
 301
 302         ret = idmap_rw_new_mapping(dom, ctx->rw_ops, map);
 303
 304         return ret;
 305 }
 306
 307 /*
 308   lookup a set of unix ids
 309 */
 310 NTSTATUS idmap_tdb_common_unixids_to_sids(struct idmap_domain * dom,
 311                                           struct id_map ** ids)
 312 {
 313         NTSTATUS ret;
 314         int i, num_mapped = 0;
 315         struct idmap_tdb_common_context *ctx;
 316
 317         NTSTATUS(*unixid_to_sid_fn) (struct idmap_domain * dom,
 318                                      struct id_map * map);
 319         ctx =
 320             talloc_get_type_abort(dom->private_data,
 321                                   struct idmap_tdb_common_context);
 322
 323         unixid_to_sid_fn =
 324             (ctx->unixid_to_sid_fn ==
 325              NULL) ? idmap_tdb_common_unixid_to_sid : ctx->unixid_to_sid_fn;
 326
 327         /* initialize the status to avoid surprise */
 328         for (i = 0; ids[i]; i++) {
 329                 ids[i]->status = ID_UNKNOWN;
 330         }
 331
 332         for (i = 0; ids[i]; i++) {
 333                 ret = unixid_to_sid_fn(dom, ids[i]);
 334                 if (!NT_STATUS_IS_OK(ret)) {
 335
 336                         /* if it is just a failed mapping continue */
 337                         if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
 338
 339                                 /* make sure it is marked as unmapped */
 340                                 ids[i]->status = ID_UNMAPPED;
 341                                 continue;
 342                         }
 343
 344                         /* some fatal error occurred, return immediately */
 345                         goto done;
 346                 }
 347
 348                 /* all ok, id is mapped */
 349                 ids[i]->status = ID_MAPPED;
 350                 num_mapped += 1;
 351         }
 352
 353         ret = NT_STATUS_OK;
 354
 355 done:
 356
 357         if (NT_STATUS_IS_OK(ret)) {
 358                 if (i == 0 || num_mapped == 0) {
 359                         ret = NT_STATUS_NONE_MAPPED;
 360                 } else if (num_mapped < i) {
 361                         ret = STATUS_SOME_UNMAPPED;
 362                 } else {
 363                         ret = NT_STATUS_OK;
 364                 }
 365         }
 366
 367         return ret;
 368 }
 369
 370 /*
 371   default single id to sid lookup function
 372 */
 373 NTSTATUS idmap_tdb_common_unixid_to_sid(struct idmap_domain * dom,
 374                                         struct id_map * map)
 375 {
 376         NTSTATUS ret;
 377         TDB_DATA data;
 378         char *keystr;
 379         struct idmap_tdb_common_context *ctx;
 380
 381         if (!dom || !map) {
 382                 return NT_STATUS_INVALID_PARAMETER;
 383         }
 384 /* TODO: do we really make sure the database is open again? should have been
 385  * done while initing the module
 386         status = idmap_tdb2_open_db(dom);
 387         NT_STATUS_NOT_OK_RETURN(status);
 388 */
 389         ctx =
 390             talloc_get_type_abort(dom->private_data,
 391                                   struct idmap_tdb_common_context);
 392
 393         /* apply filters before checking */
 394         if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
 395                 DEBUG(5,
 396                       ("Requested id (%u) out of range (%u - %u). Filtered!\n",
 397                        map->xid.id, dom->low_id, dom->high_id));
 398                 return NT_STATUS_NONE_MAPPED;
 399         }
 400
 401         switch (map->xid.type) {
 402
 403         case ID_TYPE_UID:
 404                 keystr =
 405                     talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
 406                 break;
 407
 408         case ID_TYPE_GID:
 409                 keystr =
 410                     talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
 411                 break;
 412
 413         default:
 414                 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
 415                 return NT_STATUS_INVALID_PARAMETER;
 416         }
 417
 418         if (keystr == NULL) {
 419                 DEBUG(0, ("Out of memory!\n"));
 420                 ret = NT_STATUS_NO_MEMORY;
 421                 goto done;
 422         }
 423
 424         DEBUG(10, ("Fetching record %s\n", keystr));
 425
 426         /* Check if the mapping exists */
 427         ret = dbwrap_fetch_bystring(ctx->db, keystr, keystr, &data);
 428
 429         if (!NT_STATUS_IS_OK(ret)) {
 430                 DEBUG(10, ("Record %s not found\n", keystr));
 431                 ret = NT_STATUS_NONE_MAPPED;
 432                 goto done;
 433         }
 434
 435         if (!string_to_sid(map->sid, (const char *)data.dptr)) {
 436                 DEBUG(10, ("INVALID SID (%s) in record %s\n",
 437                            (const char *)data.dptr, keystr));
 438                 ret = NT_STATUS_INTERNAL_DB_ERROR;
 439                 goto done;
 440         }
 441
 442         DEBUG(10, ("Found record %s -> %s\n", keystr, (const char *)data.dptr));
 443         ret = NT_STATUS_OK;
 444
 445       done:
 446         talloc_free(keystr);
 447         return ret;
 448 }
 449
 450 /**********************************
 451  Single sid to id lookup function.
 452 **********************************/
 453
 454 NTSTATUS idmap_tdb_common_sid_to_unixid(struct idmap_domain * dom,
 455                                         struct id_map * map)
 456 {
 457         NTSTATUS ret;
 458         TDB_DATA data;
 459         char *keystr;
 460         unsigned long rec_id = 0;
 461         struct idmap_tdb_common_context *ctx;
 462         TALLOC_CTX *tmp_ctx = talloc_stackframe();
 463
 464         if (!dom || !map) {
 465                 talloc_free(tmp_ctx);
 466                 return NT_STATUS_INVALID_PARAMETER;
 467         }
 468
 469         ctx =
 470             talloc_get_type_abort(dom->private_data,
 471                                   struct idmap_tdb_common_context);
 472
 473         keystr = sid_string_talloc(tmp_ctx, map->sid);
 474         if (keystr == NULL) {
 475                 DEBUG(0, ("Out of memory!\n"));
 476                 ret = NT_STATUS_NO_MEMORY;
 477                 goto done;
 478         }
 479
 480         DEBUG(10, ("Fetching record %s\n", keystr));
 481
 482         /* Check if sid is present in database */
 483         ret = dbwrap_fetch_bystring(ctx->db, tmp_ctx, keystr, &data);
 484         if (!NT_STATUS_IS_OK(ret)) {
 485                 DEBUG(10, ("Record %s not found\n", keystr));
 486                 ret = NT_STATUS_NONE_MAPPED;
 487                 goto done;
 488         }
 489
 490         /* What type of record is this ? */
 491         if (sscanf((const char *)data.dptr, "UID %lu", &rec_id) == 1) {
 492                 /* Try a UID record. */
 493                 map->xid.id = rec_id;
 494                 map->xid.type = ID_TYPE_UID;
 495                 DEBUG(10,
 496                       ("Found uid record %s -> %s \n", keystr,
 497                        (const char *)data.dptr));
 498                 ret = NT_STATUS_OK;
 499
 500         } else if (sscanf((const char *)data.dptr, "GID %lu", &rec_id) == 1) {
 501                 /* Try a GID record. */
 502                 map->xid.id = rec_id;
 503                 map->xid.type = ID_TYPE_GID;
 504                 DEBUG(10,
 505                       ("Found gid record %s -> %s \n", keystr,
 506                        (const char *)data.dptr));
 507                 ret = NT_STATUS_OK;
 508
 509         } else {                /* Unknown record type ! */
 510                 DEBUG(2,
 511                       ("Found INVALID record %s -> %s\n", keystr,
 512                        (const char *)data.dptr));
 513                 ret = NT_STATUS_INTERNAL_DB_ERROR;
 514                 goto done;
 515         }
 516
 517         /* apply filters before returning result */
 518         if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
 519                 DEBUG(5,
 520                       ("Requested id (%u) out of range (%u - %u). Filtered!\n",
 521                        map->xid.id, dom->low_id, dom->high_id));
 522                 ret = NT_STATUS_NONE_MAPPED;
 523         }
 524
 525       done:
 526         talloc_free(tmp_ctx);
 527         return ret;
 528 }
 529
 530 /**********************************
 531  lookup a set of sids
 532 **********************************/
 533
 534 struct idmap_tdb_common_sids_to_unixids_context {
 535         struct idmap_domain *dom;
 536         struct id_map **ids;
 537         bool allocate_unmapped;
 538          NTSTATUS(*sid_to_unixid_fn) (struct idmap_domain * dom,
 539                                       struct id_map * map);
 540 };
 541
 542 static NTSTATUS idmap_tdb_common_sids_to_unixids_action(struct db_context *db,
 543                                                         void *private_data)
 544 {
 545         struct idmap_tdb_common_sids_to_unixids_context *state;
 546         int i, num_mapped = 0;
 547         NTSTATUS ret = NT_STATUS_OK;
 548
 549         state = (struct idmap_tdb_common_sids_to_unixids_context *)private_data;
 550
 551         DEBUG(10, ("idmap_tdb_common_sids_to_unixids: "
 552                    " domain: [%s], allocate: %s\n",
 553                    state->dom->name, state->allocate_unmapped ? "yes" : "no"));
 554
 555         for (i = 0; state->ids[i]; i++) {
 556                 if ((state->ids[i]->status == ID_UNKNOWN) ||
 557                     /* retry if we could not map in previous run: */
 558                     (state->ids[i]->status == ID_UNMAPPED)) {
 559                         NTSTATUS ret2;
 560
 561                         ret2 = state->sid_to_unixid_fn(state->dom,
 562                                         state->ids[i]);
 563
 564                         if (!NT_STATUS_IS_OK(ret2)) {
 565
 566                                 /* if it is just a failed mapping, continue */
 567                                 if (NT_STATUS_EQUAL
 568                                     (ret2, NT_STATUS_NONE_MAPPED)) {
 569
 570                                         /* make sure it is marked as unmapped */
 571                                         state->ids[i]->status = ID_UNMAPPED;
 572                                         ret = STATUS_SOME_UNMAPPED;
 573                                 } else {
 574                                         /*
 575                                          * some fatal error occurred,
 576                                          * return immediately
 577                                          */
 578                                         ret = ret2;
 579                                         goto done;
 580                                 }
 581                         } else {
 582                                 /* all ok, id is mapped */
 583                                 state->ids[i]->status = ID_MAPPED;
 584                         }
 585                 }
 586
 587                 if (state->ids[i]->status == ID_MAPPED) {
 588                         num_mapped += 1;
 589                 }
 590
 591                 if ((state->ids[i]->status == ID_UNMAPPED) &&
 592                     state->allocate_unmapped) {
 593                         ret =
 594                             idmap_tdb_common_new_mapping(state->dom,
 595                                                          state->ids[i]);
 596                         if (!NT_STATUS_IS_OK(ret)) {
 597                                 goto done;
 598                         }
 599                         num_mapped += 1;
 600                 }
 601         }
 602
 603 done:
 604
 605         if (NT_STATUS_IS_OK(ret) ||
 606             NT_STATUS_EQUAL(ret, STATUS_SOME_UNMAPPED)) {
 607                 if (i == 0 || num_mapped == 0) {
 608                         ret = NT_STATUS_NONE_MAPPED;
 609                 } else if (num_mapped < i) {
 610                         ret = STATUS_SOME_UNMAPPED;
 611                 } else {
 612                         ret = NT_STATUS_OK;
 613                 }
 614         }
 615
 616         return ret;
 617 }
 618
 619 NTSTATUS idmap_tdb_common_sids_to_unixids(struct idmap_domain * dom,
 620                                           struct id_map ** ids)
 621 {
 622         NTSTATUS ret;
 623         int i;
 624         struct idmap_tdb_common_sids_to_unixids_context state;
 625         struct idmap_tdb_common_context *ctx;
 626
 627         ctx =
 628             talloc_get_type_abort(dom->private_data,
 629                                   struct idmap_tdb_common_context);
 630
 631         /* initialize the status to avoid surprise */
 632         for (i = 0; ids[i]; i++) {
 633                 ids[i]->status = ID_UNKNOWN;
 634         }
 635
 636         state.dom = dom;
 637         state.ids = ids;
 638         state.allocate_unmapped = false;
 639         state.sid_to_unixid_fn =
 640             (ctx->sid_to_unixid_fn ==
 641              NULL) ? idmap_tdb_common_sid_to_unixid : ctx->sid_to_unixid_fn;
 642
 643         ret = idmap_tdb_common_sids_to_unixids_action(ctx->db, &state);
 644
 645         if ( (NT_STATUS_EQUAL(ret, STATUS_SOME_UNMAPPED) ||
 646               NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) &&
 647              !dom->read_only) {
 648                 state.allocate_unmapped = true;
 649                 ret = dbwrap_trans_do(ctx->db,
 650                                       idmap_tdb_common_sids_to_unixids_action,
 651                                       &state);
 652         }
 653
 654         return ret;
 655 }