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