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
 176         result = talloc_zero(mem_ctx, struct idmap_domain);
 177         if (result == NULL) {
 178                 DEBUG(0, ("talloc failed\n"));
 179                 return NULL;
 180         }
 181
 182         result->name = talloc_strdup(result, domainname);
 183         if (result->name == NULL) {
 184                 DEBUG(0, ("talloc failed\n"));
 185                 goto fail;
 186         }
 187
 188         /*
 189          * load ranges and read only information from the config
 190          */
 191
 192         config_option = talloc_asprintf(result, "idmap config %s",
 193                                         result->name);
 194         if (config_option == NULL) {
 195                 DEBUG(0, ("Out of memory!\n"));
 196                 goto fail;
 197         }
 198
 199         range = lp_parm_const_string(-1, config_option, "range", NULL);
 200         if (range == NULL) {
 201                 DEBUG(1, ("idmap range not specified for domain %s\n",
 202                           result->name));
 203                 if (check_range) {
 204                         goto fail;
 205                 }
 206         } else if (sscanf(range, "%u - %u", &result->low_id,
 207                           &result->high_id) != 2)
 208         {
 209                 DEBUG(1, ("invalid range '%s' specified for domain "
 210                           "'%s'\n", range, result->name));
 211                 if (check_range) {
 212                         goto fail;
 213                 }
 214         }
 215
 216         result->read_only = lp_parm_bool(-1, config_option, "read only", false);
 217
 218         talloc_free(config_option);
 219
 220         if (result->low_id > result->high_id) {
 221                 DEBUG(1, ("Error: invalid idmap range detected: %lu - %lu\n",
 222                           (unsigned long)result->low_id,
 223                           (unsigned long)result->high_id));
 224                 if (check_range) {
 225                         goto fail;
 226                 }
 227         }
 228
 229         result->methods = get_methods(modulename);
 230         if (result->methods == NULL) {
 231                 DEBUG(3, ("idmap backend %s not found\n", modulename));
 232
 233                 status = smb_probe_module("idmap", modulename);
 234                 if (!NT_STATUS_IS_OK(status)) {
 235                         DEBUG(3, ("Could not probe idmap module %s\n",
 236                                   modulename));
 237                         goto fail;
 238                 }
 239
 240                 result->methods = get_methods(modulename);
 241         }
 242         if (result->methods == NULL) {
 243                 DEBUG(1, ("idmap backend %s not found\n", modulename));
 244                 goto fail;
 245         }
 246
 247         status = result->methods->init(result);
 248         if (!NT_STATUS_IS_OK(status)) {
 249                 DEBUG(1, ("idmap initialization returned %s\n",
 250                           nt_errstr(status)));
 251                 goto fail;
 252         }
 253
 254         return result;
 255
 256 fail:
 257         TALLOC_FREE(result);
 258         return NULL;
 259 }
 260
 261 /**
 262  * Initialize a named domain structure
 263  * @param[in] mem_ctx           memory context for the result
 264  * @param[in] domname           the domain name
 265  * @result The default domain structure
 266  *
 267  * This routine looks at the "idmap config <domname>" parameters to figure out
 268  * the configuration.
 269  */
 270
 271 static struct idmap_domain *idmap_init_named_domain(TALLOC_CTX *mem_ctx,
 272                                                     const char *domname)
 273 {
 274         struct idmap_domain *result = NULL;
 275         char *config_option;
 276         const char *backend;
 277
 278         idmap_init();
 279
 280         config_option = talloc_asprintf(talloc_tos(), "idmap config %s",
 281                                         domname);
 282         if (config_option == NULL) {
 283                 DEBUG(0, ("talloc failed\n"));
 284                 goto fail;
 285         }
 286
 287         backend = lp_parm_const_string(-1, config_option, "backend", NULL);
 288         if (backend == NULL) {
 289                 DEBUG(10, ("no idmap backend configured for domain '%s'\n",
 290                            domname));
 291                 goto fail;
 292         }
 293
 294         result = idmap_init_domain(mem_ctx, domname, backend, true);
 295         if (result == NULL) {
 296                 goto fail;
 297         }
 298
 299         TALLOC_FREE(config_option);
 300         return result;
 301
 302 fail:
 303         TALLOC_FREE(config_option);
 304         TALLOC_FREE(result);
 305         return NULL;
 306 }
 307
 308 /**
 309  * Initialize the default domain structure
 310  * @param[in] mem_ctx           memory context for the result
 311  * @result The default domain structure
 312  *
 313  * This routine takes the module name from the "idmap backend" parameter,
 314  * passing a possible parameter like ldap:ldap://ldap-url/ to the module.
 315  */
 316
 317 static struct idmap_domain *idmap_init_default_domain(TALLOC_CTX *mem_ctx)
 318 {
 319         return idmap_init_named_domain(mem_ctx, "*");
 320 }
 321
 322 /**
 323  * Initialize the passdb domain structure
 324  * @param[in] mem_ctx           memory context for the result
 325  * @result The default domain structure
 326  *
 327  * No config, passdb has its own configuration.
 328  */
 329
 330 static struct idmap_domain *idmap_passdb_domain(TALLOC_CTX *mem_ctx)
 331 {
 332         idmap_init();
 333
 334         if (!pdb_is_responsible_for_everything_else()) {
 335                 /*
 336                  * Always init the default domain, we can't go without one
 337                  */
 338                 if (default_idmap_domain == NULL) {
 339                         default_idmap_domain = idmap_init_default_domain(NULL);
 340                 }
 341                 if (default_idmap_domain == NULL) {
 342                         return NULL;
 343                 }
 344         }
 345
 346         if (passdb_idmap_domain != NULL) {
 347                 return passdb_idmap_domain;
 348         }
 349
 350         passdb_idmap_domain = idmap_init_domain(NULL, get_global_sam_name(),
 351                                                 "passdb", false);
 352         if (passdb_idmap_domain == NULL) {
 353                 DEBUG(1, ("Could not init passdb idmap domain\n"));
 354         }
 355
 356         return passdb_idmap_domain;
 357 }
 358
 359 /**
 360  * Find a domain struct according to a domain name
 361  * @param[in] domname           Domain name to get the config for
 362  * @result The default domain structure that fits
 363  *
 364  * This is the central routine in the winbindd-idmap child to pick the correct
 365  * domain for looking up IDs. If domname is NULL or empty, we use the default
 366  * domain. If it contains something, we try to use idmap_init_named_domain()
 367  * to fetch the correct backend.
 368  *
 369  * The choice about "domname" is being made by the winbind parent, look at the
 370  * "have_idmap_config" of "struct winbindd_domain" which is set in
 371  * add_trusted_domain.
 372  */
 373
 374 static struct idmap_domain *idmap_find_domain(const char *domname)
 375 {
 376         struct idmap_domain *result;
 377         int i;
 378
 379         DEBUG(10, ("idmap_find_domain called for domain '%s'\n",
 380                    domname?domname:"NULL"));
 381
 382         idmap_init();
 383
 384         /*
 385          * Always init the default domain, we can't go without one
 386          */
 387         if (default_idmap_domain == NULL) {
 388                 default_idmap_domain = idmap_init_default_domain(NULL);
 389         }
 390         if (default_idmap_domain == NULL) {
 391                 return NULL;
 392         }
 393
 394         if ((domname == NULL) || (domname[0] == '\0')) {
 395                 return default_idmap_domain;
 396         }
 397
 398         for (i=0; i<num_domains; i++) {
 399                 if (strequal(idmap_domains[i]->name, domname)) {
 400                         return idmap_domains[i];
 401                 }
 402         }
 403
 404         if (idmap_domains == NULL) {
 405                 /*
 406                  * talloc context for all idmap domains
 407                  */
 408                 idmap_domains = talloc_array(NULL, struct idmap_domain *, 1);
 409         }
 410
 411         if (idmap_domains == NULL) {
 412                 DEBUG(0, ("talloc failed\n"));
 413                 return NULL;
 414         }
 415
 416         result = idmap_init_named_domain(idmap_domains, domname);
 417         if (result == NULL) {
 418                 /*
 419                  * Could not init that domain -- try the default one
 420                  */
 421                 return default_idmap_domain;
 422         }
 423
 424         ADD_TO_ARRAY(idmap_domains, struct idmap_domain *, result,
 425                      &idmap_domains, &num_domains);
 426         return result;
 427 }
 428
 429 struct idmap_domain *idmap_find_domain_with_sid(const char *domname,
 430                                                 const struct dom_sid *sid)
 431 {
 432         idmap_init();
 433
 434         if (sid_check_is_for_passdb(sid)) {
 435                 return idmap_passdb_domain(NULL);
 436         }
 437
 438         return idmap_find_domain(domname);
 439 }
 440
 441 void idmap_close(void)
 442 {
 443         TALLOC_FREE(default_idmap_domain);
 444         TALLOC_FREE(passdb_idmap_domain);
 445         TALLOC_FREE(idmap_domains);
 446         num_domains = 0;
 447 }
 448
 449 /**************************************************************************
 450  idmap allocator interface functions
 451 **************************************************************************/
 452
 453 static NTSTATUS idmap_allocate_unixid(struct unixid *id)
 454 {
 455         struct idmap_domain *dom;
 456         NTSTATUS ret;
 457
 458         dom = idmap_find_domain(NULL);
 459
 460         if (dom == NULL) {
 461                 return NT_STATUS_UNSUCCESSFUL;
 462         }
 463
 464         if (dom->methods->allocate_id == NULL) {
 465                 return NT_STATUS_NOT_IMPLEMENTED;
 466         }
 467
 468         ret = dom->methods->allocate_id(dom, id);
 469
 470         return ret;
 471 }
 472
 473
 474 NTSTATUS idmap_allocate_uid(struct unixid *id)
 475 {
 476         id->type = ID_TYPE_UID;
 477         return idmap_allocate_unixid(id);
 478 }
 479
 480 NTSTATUS idmap_allocate_gid(struct unixid *id)
 481 {
 482         id->type = ID_TYPE_GID;
 483         return idmap_allocate_unixid(id);
 484 }
 485
 486 NTSTATUS idmap_backends_unixid_to_sid(const char *domname, struct id_map *id)
 487 {
 488         struct idmap_domain *dom;
 489         struct id_map *maps[2];
 490
 491          DEBUG(10, ("idmap_backend_unixid_to_sid: domain = '%s', xid = %d "
 492                     "(type %d)\n",
 493                     domname?domname:"NULL", id->xid.id, id->xid.type));
 494
 495         maps[0] = id;
 496         maps[1] = NULL;
 497
 498         /*
 499          * Always give passdb a chance first
 500          */
 501
 502         dom = idmap_passdb_domain(NULL);
 503         if ((dom != NULL)
 504             && NT_STATUS_IS_OK(dom->methods->unixids_to_sids(dom, maps))
 505             && id->status == ID_MAPPED) {
 506                 return NT_STATUS_OK;
 507         }
 508
 509         dom = idmap_find_domain(domname);
 510         if (dom == NULL) {
 511                 return NT_STATUS_NONE_MAPPED;
 512         }
 513
 514         return dom->methods->unixids_to_sids(dom, maps);
 515 }