test3: Fix usage check for test_sharesec.sh
[Samba.git] / source3 / winbindd / idmap.c
blobbfac7f86432d3bc16f2517fbc01d3fc7c7419d3f
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
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.
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.
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/>.
24 #include "includes.h"
25 #include "winbindd.h"
26 #include "idmap.h"
27 #include "lib/util_sid_passdb.h"
28 #include "libcli/security/dom_sid.h"
29 #include "passdb.h"
31 #undef DBGC_CLASS
32 #define DBGC_CLASS DBGC_IDMAP
34 static_decl_idmap;
36 /**
37 * Pointer to the backend methods. Modules register themselves here via
38 * smb_register_idmap.
41 struct idmap_backend {
42 const char *name;
43 struct idmap_methods *methods;
44 struct idmap_backend *prev, *next;
46 static struct idmap_backend *backends = NULL;
48 /**
49 * Default idmap domain configured via "idmap backend".
51 static struct idmap_domain *default_idmap_domain;
53 /**
54 * Passdb idmap domain, not configurable. winbind must always give passdb a
55 * chance to map ids.
57 static struct idmap_domain *passdb_idmap_domain;
59 /**
60 * List of specially configured idmap domains. This list is filled on demand
61 * in the winbind idmap child when the parent winbind figures out via the
62 * special range parameter or via the domain SID that a special "idmap config
63 * domain" configuration is present.
65 static struct idmap_domain **idmap_domains = NULL;
66 static int num_domains = 0;
68 static struct idmap_domain *idmap_init_named_domain(TALLOC_CTX *mem_ctx,
69 const char *domname);
70 static struct idmap_domain *idmap_init_domain(TALLOC_CTX *mem_ctx,
71 const char *domainname,
72 const char *modulename,
73 bool check_range);
75 struct lp_scan_idmap_domains_state {
76 bool (*fn)(const char *domname, void *private_data);
77 void *private_data;
80 static bool lp_scan_idmap_found_domain(
81 const char *string, regmatch_t matches[], void *private_data);
83 bool lp_scan_idmap_domains(bool (*fn)(const char *domname,
84 void *private_data),
85 void *private_data)
87 struct lp_scan_idmap_domains_state state = {
88 .fn = fn, .private_data = private_data };
89 int ret;
91 ret = lp_wi_scan_global_parametrics(
92 "idmapconfig\\(.*\\):backend", 2,
93 lp_scan_idmap_found_domain, &state);
94 if (ret != 0) {
95 DBG_WARNING("wi_scan_global_parametrics returned %d\n", ret);
96 return false;
99 return true;
102 static bool lp_scan_idmap_found_domain(
103 const char *string, regmatch_t matches[], void *private_data)
105 bool ok;
107 if (matches[1].rm_so == -1) {
108 DBG_WARNING("Found match, but no name??\n");
109 return false;
111 if (matches[1].rm_eo <= matches[1].rm_so) {
112 DBG_WARNING("Invalid match\n");
113 return false;
117 struct lp_scan_idmap_domains_state *state = private_data;
118 regoff_t len = matches[1].rm_eo - matches[1].rm_so;
119 char domname[len+1];
121 memcpy(domname, string + matches[1].rm_so, len);
122 domname[len] = '\0';
124 DBG_DEBUG("Found idmap domain \"%s\"\n", domname);
126 ok = state->fn(domname, state->private_data);
129 return ok;
132 static bool idmap_found_domain_backend(const char *domname,
133 void *private_data);
135 static bool idmap_init(void)
137 static bool initialized;
138 bool ok;
140 if (initialized) {
141 return true;
144 DEBUG(10, ("idmap_init(): calling static_init_idmap\n"));
146 static_init_idmap(NULL);
148 initialized = true;
150 if (!pdb_is_responsible_for_everything_else()) {
151 default_idmap_domain = idmap_init_named_domain(NULL, "*");
152 if (default_idmap_domain == NULL) {
153 return false;
157 passdb_idmap_domain = idmap_init_domain(
158 NULL, get_global_sam_name(), "passdb", false);
159 if (passdb_idmap_domain == NULL) {
160 TALLOC_FREE(default_idmap_domain);
161 return false;
164 idmap_domains = talloc_array(NULL, struct idmap_domain *, 0);
165 if (idmap_domains == NULL) {
166 TALLOC_FREE(passdb_idmap_domain);
167 TALLOC_FREE(default_idmap_domain);
168 return false;
171 ok = lp_scan_idmap_domains(idmap_found_domain_backend, NULL);
172 if (!ok) {
173 DBG_WARNING("lp_scan_idmap_domains failed\n");
174 return false;
177 return true;
180 const char *idmap_config_const_string(const char *domname, const char *option,
181 const char *def)
183 int len = snprintf(NULL, 0, "idmap config %s", domname);
185 if (len == -1) {
186 return NULL;
189 char config_option[len+1];
190 snprintf(config_option, sizeof(config_option),
191 "idmap config %s", domname);
192 return lp_parm_const_string(-1, config_option, option, def);
196 bool idmap_config_bool(const char *domname, const char *option, bool def)
198 int len = snprintf(NULL, 0, "idmap config %s", domname);
200 if (len == -1) {
201 return def;
204 char config_option[len+1];
205 snprintf(config_option, sizeof(config_option),
206 "idmap config %s", domname);
207 return lp_parm_bool(-1, config_option, option, def);
211 int idmap_config_int(const char *domname, const char *option, int def)
213 int len = snprintf(NULL, 0, "idmap config %s", domname);
215 if (len == -1) {
216 return def;
219 char config_option[len+1];
220 snprintf(config_option, sizeof(config_option),
221 "idmap config %s", domname);
222 return lp_parm_int(-1, config_option, option, def);
226 bool domain_has_idmap_config(const char *domname)
228 int i;
229 const char *range = NULL;
230 const char *backend = NULL;
231 bool ok;
233 ok = idmap_init();
234 if (!ok) {
235 return false;
238 for (i=0; i<num_domains; i++) {
239 if (strequal(idmap_domains[i]->name, domname)) {
240 return true;
244 /* fallback: also check loadparm */
246 range = idmap_config_const_string(domname, "range", NULL);
247 backend = idmap_config_const_string(domname, "backend", NULL);
248 if (range != NULL && backend != NULL) {
249 DEBUG(5, ("idmap configuration specified for domain '%s'\n",
250 domname));
251 return true;
254 return false;
257 static bool idmap_found_domain_backend(const char *domname,
258 void *private_data)
260 struct idmap_domain *dom, **tmp;
262 DBG_DEBUG("Found idmap domain \"%s\"\n", domname);
264 if (strcmp(domname, "*") == 0) {
265 return false;
268 dom = idmap_init_named_domain(idmap_domains, domname);
269 if (dom == NULL) {
270 DBG_NOTICE("Could not init idmap domain %s\n", domname);
271 return false;
274 tmp = talloc_realloc(idmap_domains, idmap_domains,
275 struct idmap_domain *, num_domains + 1);
276 if (tmp == NULL) {
277 DBG_WARNING("talloc_realloc failed\n");
278 TALLOC_FREE(dom);
279 return false;
281 idmap_domains = tmp;
282 idmap_domains[num_domains] = dom;
283 num_domains += 1;
285 return false;
288 static struct idmap_methods *get_methods(const char *name)
290 struct idmap_backend *b;
292 for (b = backends; b; b = b->next) {
293 if (strequal(b->name, name)) {
294 return b->methods;
298 return NULL;
301 bool idmap_is_offline(void)
303 return ( lp_winbind_offline_logon() &&
304 get_global_winbindd_state_offline() );
307 /**********************************************************************
308 Allow a module to register itself as a method.
309 **********************************************************************/
311 NTSTATUS smb_register_idmap(int version, const char *name,
312 struct idmap_methods *methods)
314 struct idmap_backend *entry;
316 if ((version != SMB_IDMAP_INTERFACE_VERSION)) {
317 DEBUG(0, ("Failed to register idmap module.\n"
318 "The module was compiled against "
319 "SMB_IDMAP_INTERFACE_VERSION %d,\n"
320 "current SMB_IDMAP_INTERFACE_VERSION is %d.\n"
321 "Please recompile against the current version "
322 "of samba!\n",
323 version, SMB_IDMAP_INTERFACE_VERSION));
324 return NT_STATUS_OBJECT_TYPE_MISMATCH;
327 if (!name || !name[0] || !methods) {
328 DEBUG(0,("Called with NULL pointer or empty name!\n"));
329 return NT_STATUS_INVALID_PARAMETER;
332 for (entry = backends; entry != NULL; entry = entry->next) {
333 if (strequal(entry->name, name)) {
334 DEBUG(5,("Idmap module %s already registered!\n",
335 name));
336 return NT_STATUS_OBJECT_NAME_COLLISION;
340 entry = talloc(NULL, struct idmap_backend);
341 if ( ! entry) {
342 DEBUG(0,("Out of memory!\n"));
343 TALLOC_FREE(entry);
344 return NT_STATUS_NO_MEMORY;
346 entry->name = talloc_strdup(entry, name);
347 if ( ! entry->name) {
348 DEBUG(0,("Out of memory!\n"));
349 TALLOC_FREE(entry);
350 return NT_STATUS_NO_MEMORY;
352 entry->methods = methods;
354 DLIST_ADD(backends, entry);
355 DEBUG(5, ("Successfully added idmap backend '%s'\n", name));
356 return NT_STATUS_OK;
360 * Initialize a domain structure
361 * @param[in] mem_ctx memory context for the result
362 * @param[in] domainname which domain is this for
363 * @param[in] modulename which backend module
364 * @param[in] check_range whether range checking should be done
365 * @result The initialized structure
367 static struct idmap_domain *idmap_init_domain(TALLOC_CTX *mem_ctx,
368 const char *domainname,
369 const char *modulename,
370 bool check_range)
372 struct idmap_domain *result;
373 NTSTATUS status;
374 const char *range;
375 unsigned low_id = 0;
376 unsigned high_id = 0;
378 result = talloc_zero(mem_ctx, struct idmap_domain);
379 if (result == NULL) {
380 DEBUG(0, ("talloc failed\n"));
381 return NULL;
384 result->name = talloc_strdup(result, domainname);
385 if (result->name == NULL) {
386 DEBUG(0, ("talloc failed\n"));
387 goto fail;
391 * Check whether the requested backend module exists and
392 * load the methods.
395 result->methods = get_methods(modulename);
396 if (result->methods == NULL) {
397 DEBUG(3, ("idmap backend %s not found\n", modulename));
399 status = smb_probe_module("idmap", modulename);
400 if (!NT_STATUS_IS_OK(status)) {
401 DEBUG(3, ("Could not probe idmap module %s\n",
402 modulename));
403 goto fail;
406 result->methods = get_methods(modulename);
408 if (result->methods == NULL) {
409 DEBUG(1, ("idmap backend %s not found\n", modulename));
410 goto fail;
414 * load ranges and read only information from the config
417 result->read_only = idmap_config_bool(result->name, "read only", false);
418 range = idmap_config_const_string(result->name, "range", NULL);
420 if (range == NULL) {
421 if (check_range) {
422 DEBUG(1, ("idmap range not specified for domain %s\n",
423 result->name));
424 goto fail;
426 } else if (sscanf(range, "%u - %u", &low_id, &high_id) != 2)
428 DEBUG(1, ("invalid range '%s' specified for domain "
429 "'%s'\n", range, result->name));
430 if (check_range) {
431 goto fail;
433 } else if (low_id > high_id) {
434 DEBUG(1, ("Error: invalid idmap range detected: %u - %u\n",
435 low_id, high_id));
436 if (check_range) {
437 goto fail;
441 result->low_id = low_id;
442 result->high_id = high_id;
444 status = result->methods->init(result);
445 if (!NT_STATUS_IS_OK(status)) {
446 DEBUG(1, ("idmap initialization returned %s\n",
447 nt_errstr(status)));
448 goto fail;
451 return result;
453 fail:
454 TALLOC_FREE(result);
455 return NULL;
459 * Initialize a named domain structure
460 * @param[in] mem_ctx memory context for the result
461 * @param[in] domname the domain name
462 * @result The default domain structure
464 * This routine looks at the "idmap config <domname>" parameters to figure out
465 * the configuration.
468 static struct idmap_domain *idmap_init_named_domain(TALLOC_CTX *mem_ctx,
469 const char *domname)
471 struct idmap_domain *result = NULL;
472 const char *backend;
473 bool ok;
475 ok = idmap_init();
476 if (!ok) {
477 return NULL;
480 backend = idmap_config_const_string(domname, "backend", NULL);
481 if (backend == NULL) {
482 DEBUG(10, ("no idmap backend configured for domain '%s'\n",
483 domname));
484 goto fail;
487 result = idmap_init_domain(mem_ctx, domname, backend, true);
488 if (result == NULL) {
489 goto fail;
492 return result;
494 fail:
495 TALLOC_FREE(result);
496 return NULL;
500 * Find a domain struct according to a domain name
501 * @param[in] domname Domain name to get the config for
502 * @result The default domain structure that fits
504 * This is the central routine in the winbindd-idmap child to pick the correct
505 * domain for looking up IDs. If domname is NULL or empty, we use the default
506 * domain. If it contains something, we try to use idmap_init_named_domain()
507 * to fetch the correct backend.
509 * The choice about "domname" is being made by the winbind parent, look at the
510 * "have_idmap_config" of "struct winbindd_domain" which is set in
511 * add_trusted_domain.
514 struct idmap_domain *idmap_find_domain(const char *domname)
516 bool ok;
517 int i;
519 DEBUG(10, ("idmap_find_domain called for domain '%s'\n",
520 domname?domname:"NULL"));
522 ok = idmap_init();
523 if (!ok) {
524 return NULL;
527 if ((domname == NULL) || (domname[0] == '\0')) {
528 return default_idmap_domain;
531 for (i=0; i<num_domains; i++) {
532 if (strequal(idmap_domains[i]->name, domname)) {
533 return idmap_domains[i];
537 return default_idmap_domain;
540 struct idmap_domain *idmap_find_domain_with_sid(const char *domname,
541 const struct dom_sid *sid)
543 bool ok;
545 ok = idmap_init();
546 if (!ok) {
547 return NULL;
550 if (sid_check_is_for_passdb(sid)) {
551 return passdb_idmap_domain;
554 return idmap_find_domain(domname);
557 void idmap_close(void)
559 TALLOC_FREE(default_idmap_domain);
560 TALLOC_FREE(passdb_idmap_domain);
561 TALLOC_FREE(idmap_domains);
562 num_domains = 0;
565 /**************************************************************************
566 idmap allocator interface functions
567 **************************************************************************/
569 static NTSTATUS idmap_allocate_unixid(struct unixid *id)
571 struct idmap_domain *dom;
572 NTSTATUS ret;
574 dom = idmap_find_domain(NULL);
576 if (dom == NULL) {
577 return NT_STATUS_UNSUCCESSFUL;
580 if (dom->methods->allocate_id == NULL) {
581 return NT_STATUS_NOT_IMPLEMENTED;
584 ret = dom->methods->allocate_id(dom, id);
586 return ret;
590 NTSTATUS idmap_allocate_uid(struct unixid *id)
592 id->type = ID_TYPE_UID;
593 return idmap_allocate_unixid(id);
596 NTSTATUS idmap_allocate_gid(struct unixid *id)
598 id->type = ID_TYPE_GID;
599 return idmap_allocate_unixid(id);
602 NTSTATUS idmap_backend_unixids_to_sids(struct id_map **maps,
603 const char *domain_name,
604 struct dom_sid domain_sid)
606 struct idmap_domain *dom = NULL;
607 NTSTATUS status;
608 bool ok;
610 ok = idmap_init();
611 if (!ok) {
612 return NT_STATUS_NONE_MAPPED;
615 if (strequal(domain_name, get_global_sam_name())) {
616 dom = passdb_idmap_domain;
618 if (dom == NULL) {
619 dom = idmap_find_domain(domain_name);
621 if (dom == NULL) {
622 return NT_STATUS_NONE_MAPPED;
625 dom->dom_sid = domain_sid;
626 status = dom->methods->unixids_to_sids(dom, maps);
628 DBG_DEBUG("unixid_to_sids for domain %s returned %s\n",
629 domain_name, nt_errstr(status));
631 return status;