source3/winbindd/idmap.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    ID Mapping
   4    Copyright (C) Tim Potter 2000
   5    Copyright (C) Jim McDonough <jmcd@us.ibm.com>        2003
   6    Copyright (C) Simo Sorce 2003-2007
   7    Copyright (C) Jeremy Allison 2006
   8    Copyright (C) Michael Adam 2010
   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 #include "includes.h"
  25 #include "winbindd.h"
  26 #include "idmap.h"
  27 #include "lib/util_sid_passdb.h"
  28 #include "passdb.h"
  29
  30 #undef DBGC_CLASS
  31 #define DBGC_CLASS DBGC_IDMAP
  32
  33 static_decl_idmap;
  34
  35 static void idmap_init(void)
  36 {
  37         static bool initialized;
  38
  39         if (initialized) {
  40                 return;
  41         }
  42
  43         DEBUG(10, ("idmap_init(): calling static_init_idmap\n"));
  44
  45         static_init_idmap;
  46
  47         initialized = true;
  48 }
  49
  50 /**
  51  * Pointer to the backend methods. Modules register themselves here via
  52  * smb_register_idmap.
  53  */
  54
  55 struct idmap_backend {
  56         const char *name;
  57         struct idmap_methods *methods;
  58         struct idmap_backend *prev, *next;
  59 };
  60 static struct idmap_backend *backends = NULL;
  61
  62 /**
  63  * Default idmap domain configured via "idmap backend".
  64  */
  65 static struct idmap_domain *default_idmap_domain;
  66
  67 /**
  68  * Passdb idmap domain, not configurable. winbind must always give passdb a
  69  * chance to map ids.
  70  */
  71 static struct idmap_domain *passdb_idmap_domain;
  72
  73 /**
  74  * List of specially configured idmap domains. This list is filled on demand
  75  * in the winbind idmap child when the parent winbind figures out via the
  76  * special range parameter or via the domain SID that a special "idmap config
  77  * domain" configuration is present.
  78  */
  79 static struct idmap_domain **idmap_domains = NULL;
  80 static int num_domains = 0;
  81
  82 static struct idmap_methods *get_methods(const char *name)
  83 {
  84         struct idmap_backend *b;
  85
  86         for (b = backends; b; b = b->next) {
  87                 if (strequal(b->name, name)) {
  88                         return b->methods;
  89                 }
  90         }
  91
  92         return NULL;
  93 }
  94
  95 bool idmap_is_offline(void)
  96 {
  97         return ( lp_winbind_offline_logon() &&
  98              get_global_winbindd_state_offline() );
  99 }
 100
 101 bool idmap_is_online(void)
 102 {
 103         return !idmap_is_offline();
 104 }
 105
 106 /**********************************************************************
 107  Allow a module to register itself as a method.
 108 **********************************************************************/
 109
 110 NTSTATUS smb_register_idmap(int version, const char *name,
 111                             struct idmap_methods *methods)
 112 {
 113         struct idmap_backend *entry;
 114
 115         if ((version != SMB_IDMAP_INTERFACE_VERSION)) {
 116                 DEBUG(0, ("Failed to register idmap module.\n"
 117                           "The module was compiled against "
 118                           "SMB_IDMAP_INTERFACE_VERSION %d,\n"
 119                           "current SMB_IDMAP_INTERFACE_VERSION is %d.\n"
 120                           "Please recompile against the current version "
 121                           "of samba!\n",
 122                           version, SMB_IDMAP_INTERFACE_VERSION));
 123                 return NT_STATUS_OBJECT_TYPE_MISMATCH;
 124         }
 125
 126         if (!name || !name[0] || !methods) {
 127                 DEBUG(0,("Called with NULL pointer or empty name!\n"));
 128                 return NT_STATUS_INVALID_PARAMETER;
 129         }
 130
 131         for (entry = backends; entry != NULL; entry = entry->next) {
 132                 if (strequal(entry->name, name)) {
 133                         DEBUG(5,("Idmap module %s already registered!\n",
 134                                  name));
 135                         return NT_STATUS_OBJECT_NAME_COLLISION;
 136                 }
 137         }
 138
 139         entry = talloc(NULL, struct idmap_backend);
 140         if ( ! entry) {
 141                 DEBUG(0,("Out of memory!\n"));
 142                 TALLOC_FREE(entry);
 143                 return NT_STATUS_NO_MEMORY;
 144         }
 145         entry->name = talloc_strdup(entry, name);
 146         if ( ! entry->name) {
 147                 DEBUG(0,("Out of memory!\n"));
 148                 TALLOC_FREE(entry);
 149                 return NT_STATUS_NO_MEMORY;
 150         }
 151         entry->methods = methods;
 152
 153         DLIST_ADD(backends, entry);
 154         DEBUG(5, ("Successfully added idmap backend '%s'\n", name));
 155         return NT_STATUS_OK;
 156 }
 157
 158 /**
 159  * Initialize a domain structure
 160  * @param[in] mem_ctx           memory context for the result
 161  * @param[in] domainname        which domain is this for
 162  * @param[in] modulename        which backend module
 163  * @param[in] check_range       whether range checking should be done
 164  * @result The initialized structure
 165  */
 166 static struct idmap_domain *idmap_init_domain(TALLOC_CTX *mem_ctx,
 167                                               const char *domainname,
 168                                               const char *modulename,
 169                                               bool check_range)
 170 {
 171         struct idmap_domain *result;
 172         NTSTATUS status;
 173         char *config_option = NULL;
 174         const char *range;
 175         unsigned low_id = 0;
 176         unsigned high_id = 0;
 177
 178         result = talloc_zero(mem_ctx, struct idmap_domain);
 179         if (result == NULL) {
 180                 DEBUG(0, ("talloc failed\n"));
 181                 return NULL;
 182         }
 183
 184         result->name = talloc_strdup(result, domainname);
 185         if (result->name == NULL) {
 186                 DEBUG(0, ("talloc failed\n"));
 187                 goto fail;
 188         }
 189
 190         /*
 191          * Check whether the requested backend module exists and
 192          * load the methods.
 193          */
 194
 195         result->methods = get_methods(modulename);
 196         if (result->methods == NULL) {
 197                 DEBUG(3, ("idmap backend %s not found\n", modulename));
 198
 199                 status = smb_probe_module("idmap", modulename);
 200                 if (!NT_STATUS_IS_OK(status)) {
 201                         DEBUG(3, ("Could not probe idmap module %s\n",
 202                                   modulename));
 203                         goto fail;
 204                 }
 205
 206                 result->methods = get_methods(modulename);
 207         }
 208         if (result->methods == NULL) {
 209                 DEBUG(1, ("idmap backend %s not found\n", modulename));
 210                 goto fail;
 211         }
 212
 213         /*
 214          * load ranges and read only information from the config
 215          */
 216
 217         config_option = talloc_asprintf(result, "idmap config %s",
 218                                         result->name);
 219         if (config_option == NULL) {
 220                 DEBUG(0, ("Out of memory!\n"));
 221                 goto fail;
 222         }
 223
 224         result->read_only = lp_parm_bool(-1, config_option, "read only", false);
 225         range = lp_parm_const_string(-1, config_option, "range", NULL);
 226
 227         talloc_free(config_option);
 228
 229         if (range == NULL) {
 230                 if (check_range) {
 231                         DEBUG(1, ("idmap range not specified for domain %s\n",
 232                                   result->name));
 233                         goto fail;
 234                 }
 235         } else if (sscanf(range, "%u - %u", &low_id, &high_id) != 2)
 236         {
 237                 DEBUG(1, ("invalid range '%s' specified for domain "
 238                           "'%s'\n", range, result->name));
 239                 if (check_range) {
 240                         goto fail;
 241                 }
 242         } else if (low_id > high_id) {
 243                 DEBUG(1, ("Error: invalid idmap range detected: %u - %u\n",
 244                           low_id, high_id));
 245                 if (check_range) {
 246                         goto fail;
 247                 }
 248         }
 249
 250         result->low_id = low_id;
 251         result->high_id = high_id;
 252
 253         status = result->methods->init(result);
 254         if (!NT_STATUS_IS_OK(status)) {
 255                 DEBUG(1, ("idmap initialization returned %s\n",
 256                           nt_errstr(status)));
 257                 goto fail;
 258         }
 259
 260         return result;
 261
 262 fail:
 263         TALLOC_FREE(result);
 264         return NULL;
 265 }
 266
 267 /**
 268  * Initialize a named domain structure
 269  * @param[in] mem_ctx           memory context for the result
 270  * @param[in] domname           the domain name
 271  * @result The default domain structure
 272  *
 273  * This routine looks at the "idmap config <domname>" parameters to figure out
 274  * the configuration.
 275  */
 276
 277 static struct idmap_domain *idmap_init_named_domain(TALLOC_CTX *mem_ctx,
 278                                                     const char *domname)
 279 {
 280         struct idmap_domain *result = NULL;
 281         char *config_option;
 282         const char *backend;
 283
 284         idmap_init();
 285
 286         config_option = talloc_asprintf(talloc_tos(), "idmap config %s",
 287                                         domname);
 288         if (config_option == NULL) {
 289                 DEBUG(0, ("talloc failed\n"));
 290                 goto fail;
 291         }
 292
 293         backend = lp_parm_const_string(-1, config_option, "backend", NULL);
 294         if (backend == NULL) {
 295                 DEBUG(10, ("no idmap backend configured for domain '%s'\n",
 296                            domname));
 297                 goto fail;
 298         }
 299
 300         result = idmap_init_domain(mem_ctx, domname, backend, true);
 301         if (result == NULL) {
 302                 goto fail;
 303         }
 304
 305         TALLOC_FREE(config_option);
 306         return result;
 307
 308 fail:
 309         TALLOC_FREE(config_option);
 310         TALLOC_FREE(result);
 311         return NULL;
 312 }
 313
 314 /**
 315  * Initialize the default domain structure
 316  * @param[in] mem_ctx           memory context for the result
 317  * @result The default domain structure
 318  *
 319  * This routine takes the module name from the "idmap backend" parameter,
 320  * passing a possible parameter like ldap:ldap://ldap-url/ to the module.
 321  */
 322
 323 static struct idmap_domain *idmap_init_default_domain(TALLOC_CTX *mem_ctx)
 324 {
 325         return idmap_init_named_domain(mem_ctx, "*");
 326 }
 327
 328 /**
 329  * Initialize the passdb domain structure
 330  * @param[in] mem_ctx           memory context for the result
 331  * @result The default domain structure
 332  *
 333  * No config, passdb has its own configuration.
 334  */
 335
 336 static struct idmap_domain *idmap_passdb_domain(TALLOC_CTX *mem_ctx)
 337 {
 338         idmap_init();
 339
 340         if (!pdb_is_responsible_for_everything_else()) {
 341                 /*
 342                  * Always init the default domain, we can't go without one
 343                  */
 344                 if (default_idmap_domain == NULL) {
 345                         default_idmap_domain = idmap_init_default_domain(NULL);
 346                 }
 347                 if (default_idmap_domain == NULL) {
 348                         return NULL;
 349                 }
 350         }
 351
 352         if (passdb_idmap_domain != NULL) {
 353                 return passdb_idmap_domain;
 354         }
 355
 356         passdb_idmap_domain = idmap_init_domain(mem_ctx, get_global_sam_name(),
 357                                                 "passdb", false);
 358         if (passdb_idmap_domain == NULL) {
 359                 DEBUG(1, ("Could not init passdb idmap domain\n"));
 360         }
 361
 362         return passdb_idmap_domain;
 363 }
 364
 365 /**
 366  * Find a domain struct according to a domain name
 367  * @param[in] domname           Domain name to get the config for
 368  * @result The default domain structure that fits
 369  *
 370  * This is the central routine in the winbindd-idmap child to pick the correct
 371  * domain for looking up IDs. If domname is NULL or empty, we use the default
 372  * domain. If it contains something, we try to use idmap_init_named_domain()
 373  * to fetch the correct backend.
 374  *
 375  * The choice about "domname" is being made by the winbind parent, look at the
 376  * "have_idmap_config" of "struct winbindd_domain" which is set in
 377  * add_trusted_domain.
 378  */
 379
 380 static struct idmap_domain *idmap_find_domain(const char *domname)
 381 {
 382         struct idmap_domain *result;
 383         int i;
 384
 385         DEBUG(10, ("idmap_find_domain called for domain '%s'\n",
 386                    domname?domname:"NULL"));
 387
 388         idmap_init();
 389
 390         /*
 391          * Always init the default domain, we can't go without one
 392          */
 393         if (default_idmap_domain == NULL) {
 394                 default_idmap_domain = idmap_init_default_domain(NULL);
 395         }
 396         if (default_idmap_domain == NULL) {
 397                 return NULL;
 398         }
 399
 400         if ((domname == NULL) || (domname[0] == '\0')) {
 401                 return default_idmap_domain;
 402         }
 403
 404         for (i=0; i<num_domains; i++) {
 405                 if (strequal(idmap_domains[i]->name, domname)) {
 406                         return idmap_domains[i];
 407                 }
 408         }
 409
 410         if (idmap_domains == NULL) {
 411                 /*
 412                  * talloc context for all idmap domains
 413                  */
 414                 idmap_domains = talloc_array(NULL, struct idmap_domain *, 1);
 415         }
 416
 417         if (idmap_domains == NULL) {
 418                 DEBUG(0, ("talloc failed\n"));
 419                 return NULL;
 420         }
 421
 422         result = idmap_init_named_domain(idmap_domains, domname);
 423         if (result == NULL) {
 424                 /*
 425                  * Could not init that domain -- try the default one
 426                  */
 427                 return default_idmap_domain;
 428         }
 429
 430         ADD_TO_ARRAY(idmap_domains, struct idmap_domain *, result,
 431                      &idmap_domains, &num_domains);
 432         return result;
 433 }
 434
 435 struct idmap_domain *idmap_find_domain_with_sid(const char *domname,
 436                                                 const struct dom_sid *sid)
 437 {
 438         idmap_init();
 439
 440         if (sid_check_is_for_passdb(sid)) {
 441                 return idmap_passdb_domain(NULL);
 442         }
 443
 444         return idmap_find_domain(domname);
 445 }
 446
 447 void idmap_close(void)
 448 {
 449         TALLOC_FREE(default_idmap_domain);
 450         TALLOC_FREE(passdb_idmap_domain);
 451         TALLOC_FREE(idmap_domains);
 452         num_domains = 0;
 453 }
 454
 455 /**************************************************************************
 456  idmap allocator interface functions
 457 **************************************************************************/
 458
 459 static NTSTATUS idmap_allocate_unixid(struct unixid *id)
 460 {
 461         struct idmap_domain *dom;
 462         NTSTATUS ret;
 463
 464         dom = idmap_find_domain(NULL);
 465
 466         if (dom == NULL) {
 467                 return NT_STATUS_UNSUCCESSFUL;
 468         }
 469
 470         if (dom->methods->allocate_id == NULL) {
 471                 return NT_STATUS_NOT_IMPLEMENTED;
 472         }
 473
 474         ret = dom->methods->allocate_id(dom, id);
 475
 476         return ret;
 477 }
 478
 479
 480 NTSTATUS idmap_allocate_uid(struct unixid *id)
 481 {
 482         id->type = ID_TYPE_UID;
 483         return idmap_allocate_unixid(id);
 484 }
 485
 486 NTSTATUS idmap_allocate_gid(struct unixid *id)
 487 {
 488         id->type = ID_TYPE_GID;
 489         return idmap_allocate_unixid(id);
 490 }
 491
 492 NTSTATUS idmap_backends_unixid_to_sid(const char *domname, struct id_map *id)
 493 {
 494         struct idmap_domain *dom;
 495         struct id_map *maps[2];
 496
 497          DEBUG(10, ("idmap_backend_unixid_to_sid: domain = '%s', xid = %d "
 498                     "(type %d)\n",
 499                     domname?domname:"NULL", id->xid.id, id->xid.type));
 500
 501         maps[0] = id;
 502         maps[1] = NULL;
 503
 504         /*
 505          * Always give passdb a chance first
 506          */
 507
 508         dom = idmap_passdb_domain(NULL);
 509         if ((dom != NULL)
 510             && NT_STATUS_IS_OK(dom->methods->unixids_to_sids(dom, maps))
 511             && id->status == ID_MAPPED) {
 512                 return NT_STATUS_OK;
 513         }
 514
 515         dom = idmap_find_domain(domname);
 516         if (dom == NULL) {
 517                 return NT_STATUS_NONE_MAPPED;
 518         }
 519
 520         return dom->methods->unixids_to_sids(dom, maps);
 521 }