2 Unix SMB/CIFS implementation.
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/>.
27 #include "passdb/machine_sid.h"
30 #define DBGC_CLASS DBGC_IDMAP
34 static void idmap_init(void)
36 static bool initialized
;
42 DEBUG(10, ("idmap_init(): calling static_init_idmap\n"));
50 * Pointer to the backend methods. Modules register themselves here via
54 struct idmap_backend
{
56 struct idmap_methods
*methods
;
57 struct idmap_backend
*prev
, *next
;
59 static struct idmap_backend
*backends
= NULL
;
62 * Default idmap domain configured via "idmap backend".
64 static struct idmap_domain
*default_idmap_domain
;
67 * Passdb idmap domain, not configurable. winbind must always give passdb a
70 static struct idmap_domain
*passdb_idmap_domain
;
73 * List of specially configured idmap domains. This list is filled on demand
74 * in the winbind idmap child when the parent winbind figures out via the
75 * special range parameter or via the domain SID that a special "idmap config
76 * domain" configuration is present.
78 static struct idmap_domain
**idmap_domains
= NULL
;
79 static int num_domains
= 0;
81 static struct idmap_methods
*get_methods(const char *name
)
83 struct idmap_backend
*b
;
85 for (b
= backends
; b
; b
= b
->next
) {
86 if (strequal(b
->name
, name
)) {
94 bool idmap_is_offline(void)
96 return ( lp_winbind_offline_logon() &&
97 get_global_winbindd_state_offline() );
100 bool idmap_is_online(void)
102 return !idmap_is_offline();
105 /**********************************************************************
106 Allow a module to register itself as a method.
107 **********************************************************************/
109 NTSTATUS
smb_register_idmap(int version
, const char *name
,
110 struct idmap_methods
*methods
)
112 struct idmap_backend
*entry
;
114 if ((version
!= SMB_IDMAP_INTERFACE_VERSION
)) {
115 DEBUG(0, ("Failed to register idmap module.\n"
116 "The module was compiled against "
117 "SMB_IDMAP_INTERFACE_VERSION %d,\n"
118 "current SMB_IDMAP_INTERFACE_VERSION is %d.\n"
119 "Please recompile against the current version "
121 version
, SMB_IDMAP_INTERFACE_VERSION
));
122 return NT_STATUS_OBJECT_TYPE_MISMATCH
;
125 if (!name
|| !name
[0] || !methods
) {
126 DEBUG(0,("Called with NULL pointer or empty name!\n"));
127 return NT_STATUS_INVALID_PARAMETER
;
130 for (entry
= backends
; entry
!= NULL
; entry
= entry
->next
) {
131 if (strequal(entry
->name
, name
)) {
132 DEBUG(5,("Idmap module %s already registered!\n",
134 return NT_STATUS_OBJECT_NAME_COLLISION
;
138 entry
= talloc(NULL
, struct idmap_backend
);
140 DEBUG(0,("Out of memory!\n"));
142 return NT_STATUS_NO_MEMORY
;
144 entry
->name
= talloc_strdup(entry
, name
);
145 if ( ! entry
->name
) {
146 DEBUG(0,("Out of memory!\n"));
148 return NT_STATUS_NO_MEMORY
;
150 entry
->methods
= methods
;
152 DLIST_ADD(backends
, entry
);
153 DEBUG(5, ("Successfully added idmap backend '%s'\n", name
));
158 * Initialize a domain structure
159 * @param[in] mem_ctx memory context for the result
160 * @param[in] domainname which domain is this for
161 * @param[in] modulename which backend module
162 * @param[in] check_range whether range checking should be done
163 * @result The initialized structure
165 static struct idmap_domain
*idmap_init_domain(TALLOC_CTX
*mem_ctx
,
166 const char *domainname
,
167 const char *modulename
,
170 struct idmap_domain
*result
;
172 char *config_option
= NULL
;
175 result
= talloc_zero(mem_ctx
, struct idmap_domain
);
176 if (result
== NULL
) {
177 DEBUG(0, ("talloc failed\n"));
181 result
->name
= talloc_strdup(result
, domainname
);
182 if (result
->name
== NULL
) {
183 DEBUG(0, ("talloc failed\n"));
188 * load ranges and read only information from the config
191 config_option
= talloc_asprintf(result
, "idmap config %s",
193 if (config_option
== NULL
) {
194 DEBUG(0, ("Out of memory!\n"));
198 range
= lp_parm_const_string(-1, config_option
, "range", NULL
);
200 DEBUG(1, ("idmap range not specified for domain %s\n",
205 } else if (sscanf(range
, "%u - %u", &result
->low_id
,
206 &result
->high_id
) != 2)
208 DEBUG(1, ("invalid range '%s' specified for domain "
209 "'%s'\n", range
, result
->name
));
215 result
->read_only
= lp_parm_bool(-1, config_option
, "read only", false);
217 talloc_free(config_option
);
219 if (result
->low_id
> result
->high_id
) {
220 DEBUG(1, ("Error: invalid idmap range detected: %lu - %lu\n",
221 (unsigned long)result
->low_id
,
222 (unsigned long)result
->high_id
));
228 result
->methods
= get_methods(modulename
);
229 if (result
->methods
== NULL
) {
230 DEBUG(3, ("idmap backend %s not found\n", modulename
));
232 status
= smb_probe_module("idmap", modulename
);
233 if (!NT_STATUS_IS_OK(status
)) {
234 DEBUG(3, ("Could not probe idmap module %s\n",
239 result
->methods
= get_methods(modulename
);
241 if (result
->methods
== NULL
) {
242 DEBUG(1, ("idmap backend %s not found\n", modulename
));
246 status
= result
->methods
->init(result
);
247 if (!NT_STATUS_IS_OK(status
)) {
248 DEBUG(1, ("idmap initialization returned %s\n",
261 * Initialize a named domain structure
262 * @param[in] mem_ctx memory context for the result
263 * @param[in] domname the domain name
264 * @result The default domain structure
266 * This routine looks at the "idmap config <domname>" parameters to figure out
270 static struct idmap_domain
*idmap_init_named_domain(TALLOC_CTX
*mem_ctx
,
273 struct idmap_domain
*result
= NULL
;
279 config_option
= talloc_asprintf(talloc_tos(), "idmap config %s",
281 if (config_option
== NULL
) {
282 DEBUG(0, ("talloc failed\n"));
286 backend
= lp_parm_const_string(-1, config_option
, "backend", NULL
);
287 if (backend
== NULL
) {
288 DEBUG(1, ("no backend defined for %s\n", config_option
));
292 result
= idmap_init_domain(mem_ctx
, domname
, backend
, true);
293 if (result
== NULL
) {
297 TALLOC_FREE(config_option
);
301 TALLOC_FREE(config_option
);
307 * Initialize the default domain structure
308 * @param[in] mem_ctx memory context for the result
309 * @result The default domain structure
311 * This routine takes the module name from the "idmap backend" parameter,
312 * passing a possible parameter like ldap:ldap://ldap-url/ to the module.
315 static struct idmap_domain
*idmap_init_default_domain(TALLOC_CTX
*mem_ctx
)
317 return idmap_init_named_domain(mem_ctx
, "*");
321 * Initialize the passdb domain structure
322 * @param[in] mem_ctx memory context for the result
323 * @result The default domain structure
325 * No config, passdb has its own configuration.
328 static struct idmap_domain
*idmap_passdb_domain(TALLOC_CTX
*mem_ctx
)
333 * Always init the default domain, we can't go without one
335 if (default_idmap_domain
== NULL
) {
336 default_idmap_domain
= idmap_init_default_domain(NULL
);
338 if (default_idmap_domain
== NULL
) {
342 if (passdb_idmap_domain
!= NULL
) {
343 return passdb_idmap_domain
;
346 passdb_idmap_domain
= idmap_init_domain(NULL
, get_global_sam_name(),
348 if (passdb_idmap_domain
== NULL
) {
349 DEBUG(1, ("Could not init passdb idmap domain\n"));
352 return passdb_idmap_domain
;
356 * Find a domain struct according to a domain name
357 * @param[in] domname Domain name to get the config for
358 * @result The default domain structure that fits
360 * This is the central routine in the winbindd-idmap child to pick the correct
361 * domain for looking up IDs. If domname is NULL or empty, we use the default
362 * domain. If it contains something, we try to use idmap_init_named_domain()
363 * to fetch the correct backend.
365 * The choice about "domname" is being made by the winbind parent, look at the
366 * "have_idmap_config" of "struct winbindd_domain" which is set in
367 * add_trusted_domain.
370 struct idmap_domain
*idmap_find_domain(const char *domname
)
372 struct idmap_domain
*result
;
375 DEBUG(10, ("idmap_find_domain called for domain '%s'\n",
376 domname
?domname
:"NULL"));
381 * Always init the default domain, we can't go without one
383 if (default_idmap_domain
== NULL
) {
384 default_idmap_domain
= idmap_init_default_domain(NULL
);
386 if (default_idmap_domain
== NULL
) {
390 if ((domname
== NULL
) || (domname
[0] == '\0')) {
391 return default_idmap_domain
;
394 for (i
=0; i
<num_domains
; i
++) {
395 if (strequal(idmap_domains
[i
]->name
, domname
)) {
396 return idmap_domains
[i
];
400 if (idmap_domains
== NULL
) {
402 * talloc context for all idmap domains
404 idmap_domains
= talloc_array(NULL
, struct idmap_domain
*, 1);
407 if (idmap_domains
== NULL
) {
408 DEBUG(0, ("talloc failed\n"));
412 result
= idmap_init_named_domain(idmap_domains
, domname
);
413 if (result
== NULL
) {
415 * Could not init that domain -- try the default one
417 return default_idmap_domain
;
420 ADD_TO_ARRAY(idmap_domains
, struct idmap_domain
*, result
,
421 &idmap_domains
, &num_domains
);
425 struct idmap_domain
*idmap_find_domain_with_sid(const char *domname
,
426 const struct dom_sid
*sid
)
430 if (sid_check_is_in_builtin(sid
) ||
431 sid_check_is_builtin(sid
) ||
432 sid_check_is_in_our_sam(sid
) ||
433 sid_check_is_our_sam(sid
))
435 return idmap_passdb_domain(NULL
);
438 return idmap_find_domain(domname
);
441 void idmap_close(void)
443 TALLOC_FREE(default_idmap_domain
);
444 TALLOC_FREE(passdb_idmap_domain
);
445 TALLOC_FREE(idmap_domains
);
449 /**************************************************************************
450 idmap allocator interface functions
451 **************************************************************************/
453 static NTSTATUS
idmap_allocate_unixid(struct unixid
*id
)
455 struct idmap_domain
*dom
;
458 dom
= idmap_find_domain(NULL
);
461 return NT_STATUS_UNSUCCESSFUL
;
464 if (dom
->methods
->allocate_id
== NULL
) {
465 return NT_STATUS_NOT_IMPLEMENTED
;
468 ret
= dom
->methods
->allocate_id(dom
, id
);
474 NTSTATUS
idmap_allocate_uid(struct unixid
*id
)
476 id
->type
= ID_TYPE_UID
;
477 return idmap_allocate_unixid(id
);
480 NTSTATUS
idmap_allocate_gid(struct unixid
*id
)
482 id
->type
= ID_TYPE_GID
;
483 return idmap_allocate_unixid(id
);
486 NTSTATUS
idmap_backends_unixid_to_sid(const char *domname
, struct id_map
*id
)
488 struct idmap_domain
*dom
;
489 struct id_map
*maps
[2];
491 DEBUG(10, ("idmap_backend_unixid_to_sid: domain = '%s', xid = %d "
493 domname
?domname
:"NULL", id
->xid
.id
, id
->xid
.type
));
499 * Always give passdb a chance first
502 dom
= idmap_passdb_domain(NULL
);
504 && NT_STATUS_IS_OK(dom
->methods
->unixids_to_sids(dom
, maps
))
505 && id
->status
== ID_MAPPED
) {
509 dom
= idmap_find_domain(domname
);
511 return NT_STATUS_NONE_MAPPED
;
514 return dom
->methods
->unixids_to_sids(dom
, maps
);
517 NTSTATUS
idmap_backends_sid_to_unixid(const char *domain
, struct id_map
*id
)
519 struct idmap_domain
*dom
;
520 struct id_map
*maps
[2];
522 DEBUG(10, ("idmap_backends_sid_to_unixid: domain = '%s', sid = [%s]\n",
523 domain
?domain
:"NULL", sid_string_dbg(id
->sid
)));
528 if (sid_check_is_in_builtin(id
->sid
)
529 || (sid_check_is_in_our_sam(id
->sid
)))
533 DEBUG(10, ("asking passdb...\n"));
535 dom
= idmap_passdb_domain(NULL
);
537 return NT_STATUS_NONE_MAPPED
;
539 status
= dom
->methods
->sids_to_unixids(dom
, maps
);
541 if (NT_STATUS_IS_OK(status
) && id
->status
== ID_MAPPED
) {
545 DEBUG(10, ("passdb could not map.\n"));
547 return NT_STATUS_NONE_MAPPED
;
550 dom
= idmap_find_domain(domain
);
552 return NT_STATUS_NONE_MAPPED
;
555 return dom
->methods
->sids_to_unixids(dom
, maps
);