s3-spoolss: Create a spoolss_map_to_os2_driver function.
[Samba/gebeck_regimport.git] / source3 / auth / auth.c
blobb4995ce19b5bc510f42956630df1b5f88a758d2e
1 /*
2 Unix SMB/CIFS implementation.
3 Password and authentication handling
4 Copyright (C) Andrew Bartlett 2001-2002
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #include "includes.h"
22 #undef DBGC_CLASS
23 #define DBGC_CLASS DBGC_AUTH
25 static_decl_auth;
27 static struct auth_init_function_entry *backends = NULL;
29 static struct auth_init_function_entry *auth_find_backend_entry(const char *name);
31 NTSTATUS smb_register_auth(int version, const char *name, auth_init_function init)
33 struct auth_init_function_entry *entry = backends;
35 if (version != AUTH_INTERFACE_VERSION) {
36 DEBUG(0,("Can't register auth_method!\n"
37 "You tried to register an auth module with AUTH_INTERFACE_VERSION %d, while this version of samba uses %d\n",
38 version,AUTH_INTERFACE_VERSION));
39 return NT_STATUS_OBJECT_TYPE_MISMATCH;
42 if (!name || !init) {
43 return NT_STATUS_INVALID_PARAMETER;
46 DEBUG(5,("Attempting to register auth backend %s\n", name));
48 if (auth_find_backend_entry(name)) {
49 DEBUG(0,("There already is an auth method registered with the name %s!\n", name));
50 return NT_STATUS_OBJECT_NAME_COLLISION;
53 entry = SMB_XMALLOC_P(struct auth_init_function_entry);
54 entry->name = smb_xstrdup(name);
55 entry->init = init;
57 DLIST_ADD(backends, entry);
58 DEBUG(5,("Successfully added auth method '%s'\n", name));
59 return NT_STATUS_OK;
62 static struct auth_init_function_entry *auth_find_backend_entry(const char *name)
64 struct auth_init_function_entry *entry = backends;
66 while(entry) {
67 if (strcmp(entry->name, name)==0) return entry;
68 entry = entry->next;
71 return NULL;
74 /****************************************************************************
75 Try to get a challenge out of the various authentication modules.
76 Returns a const char of length 8 bytes.
77 ****************************************************************************/
79 static NTSTATUS get_ntlm_challenge(struct auth_context *auth_context,
80 uint8_t chal[8])
82 DATA_BLOB challenge = data_blob_null;
83 const char *challenge_set_by = NULL;
84 auth_methods *auth_method;
86 if (auth_context->challenge.length) {
87 DEBUG(5, ("get_ntlm_challenge (auth subsystem): returning previous challenge by module %s (normal)\n",
88 auth_context->challenge_set_by));
89 memcpy(chal, auth_context->challenge.data, 8);
90 return NT_STATUS_OK;
93 auth_context->challenge_may_be_modified = False;
95 for (auth_method = auth_context->auth_method_list; auth_method; auth_method = auth_method->next) {
96 if (auth_method->get_chal == NULL) {
97 DEBUG(5, ("auth_get_challenge: module %s did not want to specify a challenge\n", auth_method->name));
98 continue;
101 DEBUG(5, ("auth_get_challenge: getting challenge from module %s\n", auth_method->name));
102 if (challenge_set_by != NULL) {
103 DEBUG(1, ("auth_get_challenge: CONFIGURATION ERROR: authentication method %s has already specified a challenge. Challenge by %s ignored.\n",
104 challenge_set_by, auth_method->name));
105 continue;
108 challenge = auth_method->get_chal(auth_context, &auth_method->private_data,
109 auth_context);
110 if (!challenge.length) {
111 DEBUG(3, ("auth_get_challenge: getting challenge from authentication method %s FAILED.\n",
112 auth_method->name));
113 } else {
114 DEBUG(5, ("auth_get_challenge: successfully got challenge from module %s\n", auth_method->name));
115 auth_context->challenge = challenge;
116 challenge_set_by = auth_method->name;
117 auth_context->challenge_set_method = auth_method;
121 if (!challenge_set_by) {
122 uchar tmp[8];
124 generate_random_buffer(tmp, sizeof(tmp));
125 auth_context->challenge = data_blob_talloc(auth_context,
126 tmp, sizeof(tmp));
128 challenge_set_by = "random";
129 auth_context->challenge_may_be_modified = True;
132 DEBUG(5, ("auth_context challenge created by %s\n", challenge_set_by));
133 DEBUG(5, ("challenge is: \n"));
134 dump_data(5, auth_context->challenge.data, auth_context->challenge.length);
136 SMB_ASSERT(auth_context->challenge.length == 8);
138 auth_context->challenge_set_by=challenge_set_by;
140 memcpy(chal, auth_context->challenge.data, 8);
141 return NT_STATUS_OK;
146 * Check user is in correct domain (if required)
148 * @param user Only used to fill in the debug message
150 * @param domain The domain to be verified
152 * @return True if the user can connect with that domain,
153 * False otherwise.
156 static bool check_domain_match(const char *user, const char *domain)
159 * If we aren't serving to trusted domains, we must make sure that
160 * the validation request comes from an account in the same domain
161 * as the Samba server
164 if (!lp_allow_trusted_domains() &&
165 !(strequal("", domain) ||
166 strequal(lp_workgroup(), domain) ||
167 is_myname(domain))) {
168 DEBUG(1, ("check_domain_match: Attempt to connect as user %s from domain %s denied.\n", user, domain));
169 return False;
170 } else {
171 return True;
176 * Check a user's Plaintext, LM or NTLM password.
178 * Check a user's password, as given in the user_info struct and return various
179 * interesting details in the server_info struct.
181 * This function does NOT need to be in a become_root()/unbecome_root() pair
182 * as it makes the calls itself when needed.
184 * The return value takes precedence over the contents of the server_info
185 * struct. When the return is other than NT_STATUS_OK the contents
186 * of that structure is undefined.
188 * @param user_info Contains the user supplied components, including the passwords.
189 * Must be created with make_user_info() or one of its wrappers.
191 * @param auth_context Supplies the challenges and some other data.
192 * Must be created with make_auth_context(), and the challenges should be
193 * filled in, either at creation or by calling the challenge geneation
194 * function auth_get_challenge().
196 * @param server_info If successful, contains information about the authentication,
197 * including a struct samu struct describing the user.
199 * @return An NTSTATUS with NT_STATUS_OK or an appropriate error.
203 static NTSTATUS check_ntlm_password(const struct auth_context *auth_context,
204 const struct auth_usersupplied_info *user_info,
205 struct auth_serversupplied_info **server_info)
207 /* if all the modules say 'not for me' this is reasonable */
208 NTSTATUS nt_status = NT_STATUS_NO_SUCH_USER;
209 const char *unix_username;
210 auth_methods *auth_method;
211 TALLOC_CTX *mem_ctx;
213 if (!user_info || !auth_context || !server_info)
214 return NT_STATUS_LOGON_FAILURE;
216 DEBUG(3, ("check_ntlm_password: Checking password for unmapped user [%s]\\[%s]@[%s] with the new password interface\n",
217 user_info->client_domain, user_info->smb_name, user_info->wksta_name));
219 DEBUG(3, ("check_ntlm_password: mapped user is: [%s]\\[%s]@[%s]\n",
220 user_info->domain, user_info->internal_username, user_info->wksta_name));
222 if (auth_context->challenge.length != 8) {
223 DEBUG(0, ("check_ntlm_password: Invalid challenge stored for this auth context - cannot continue\n"));
224 return NT_STATUS_LOGON_FAILURE;
227 if (auth_context->challenge_set_by)
228 DEBUG(10, ("check_ntlm_password: auth_context challenge created by %s\n",
229 auth_context->challenge_set_by));
231 DEBUG(10, ("challenge is: \n"));
232 dump_data(5, auth_context->challenge.data, auth_context->challenge.length);
234 #ifdef DEBUG_PASSWORD
235 DEBUG(100, ("user_info has passwords of length %d and %d\n",
236 (int)user_info->lm_resp.length, (int)user_info->nt_resp.length));
237 DEBUG(100, ("lm:\n"));
238 dump_data(100, user_info->lm_resp.data, user_info->lm_resp.length);
239 DEBUG(100, ("nt:\n"));
240 dump_data(100, user_info->nt_resp.data, user_info->nt_resp.length);
241 #endif
243 /* This needs to be sorted: If it doesn't match, what should we do? */
244 if (!check_domain_match(user_info->smb_name, user_info->domain))
245 return NT_STATUS_LOGON_FAILURE;
247 for (auth_method = auth_context->auth_method_list;auth_method; auth_method = auth_method->next) {
248 NTSTATUS result;
250 mem_ctx = talloc_init("%s authentication for user %s\\%s", auth_method->name,
251 user_info->domain, user_info->smb_name);
253 result = auth_method->auth(auth_context, auth_method->private_data, mem_ctx, user_info, server_info);
255 /* check if the module did anything */
256 if ( NT_STATUS_V(result) == NT_STATUS_V(NT_STATUS_NOT_IMPLEMENTED) ) {
257 DEBUG(10,("check_ntlm_password: %s had nothing to say\n", auth_method->name));
258 talloc_destroy(mem_ctx);
259 continue;
262 nt_status = result;
264 if (NT_STATUS_IS_OK(nt_status)) {
265 DEBUG(3, ("check_ntlm_password: %s authentication for user [%s] succeeded\n",
266 auth_method->name, user_info->smb_name));
267 } else {
268 DEBUG(5, ("check_ntlm_password: %s authentication for user [%s] FAILED with error %s\n",
269 auth_method->name, user_info->smb_name, nt_errstr(nt_status)));
272 talloc_destroy(mem_ctx);
274 if ( NT_STATUS_IS_OK(nt_status))
276 break;
280 /* successful authentication */
282 if (NT_STATUS_IS_OK(nt_status)) {
283 unix_username = (*server_info)->unix_name;
284 if (!(*server_info)->guest) {
285 /* We might not be root if we are an RPC call */
286 become_root();
287 nt_status = smb_pam_accountcheck(unix_username);
288 unbecome_root();
290 if (NT_STATUS_IS_OK(nt_status)) {
291 DEBUG(5, ("check_ntlm_password: PAM Account for user [%s] succeeded\n",
292 unix_username));
293 } else {
294 DEBUG(3, ("check_ntlm_password: PAM Account for user [%s] FAILED with error %s\n",
295 unix_username, nt_errstr(nt_status)));
299 if (NT_STATUS_IS_OK(nt_status)) {
300 DEBUG((*server_info)->guest ? 5 : 2,
301 ("check_ntlm_password: %sauthentication for user [%s] -> [%s] -> [%s] succeeded\n",
302 (*server_info)->guest ? "guest " : "",
303 user_info->smb_name,
304 user_info->internal_username,
305 unix_username));
308 return nt_status;
311 /* failed authentication; check for guest lapping */
313 DEBUG(2, ("check_ntlm_password: Authentication for user [%s] -> [%s] FAILED with error %s\n",
314 user_info->smb_name, user_info->internal_username,
315 nt_errstr(nt_status)));
316 ZERO_STRUCTP(server_info);
318 return nt_status;
321 /***************************************************************************
322 Clear out a auth_context, and destroy the attached TALLOC_CTX
323 ***************************************************************************/
325 static void free_auth_context(struct auth_context **auth_context)
327 auth_methods *auth_method;
329 if (*auth_context) {
330 /* Free private data of context's authentication methods */
331 for (auth_method = (*auth_context)->auth_method_list; auth_method; auth_method = auth_method->next) {
332 TALLOC_FREE(auth_method->private_data);
335 talloc_destroy(*auth_context);
336 *auth_context = NULL;
340 /***************************************************************************
341 Make a auth_info struct
342 ***************************************************************************/
344 static NTSTATUS make_auth_context(struct auth_context **auth_context)
346 *auth_context = TALLOC_ZERO_P(talloc_autofree_context(),
347 struct auth_context);
348 if (!*auth_context) {
349 DEBUG(0,("make_auth_context: talloc failed!\n"));
350 return NT_STATUS_NO_MEMORY;
353 (*auth_context)->check_ntlm_password = check_ntlm_password;
354 (*auth_context)->get_ntlm_challenge = get_ntlm_challenge;
355 (*auth_context)->free = free_auth_context;
357 return NT_STATUS_OK;
360 bool load_auth_module(struct auth_context *auth_context,
361 const char *module, auth_methods **ret)
363 static bool initialised_static_modules = False;
365 struct auth_init_function_entry *entry;
366 char *module_name = smb_xstrdup(module);
367 char *module_params = NULL;
368 char *p;
369 bool good = False;
371 /* Initialise static modules if not done so yet */
372 if(!initialised_static_modules) {
373 static_init_auth;
374 initialised_static_modules = True;
377 DEBUG(5,("load_auth_module: Attempting to find an auth method to match %s\n",
378 module));
380 p = strchr(module_name, ':');
381 if (p) {
382 *p = 0;
383 module_params = p+1;
384 trim_char(module_params, ' ', ' ');
387 trim_char(module_name, ' ', ' ');
389 entry = auth_find_backend_entry(module_name);
391 if (entry == NULL) {
392 if (NT_STATUS_IS_OK(smb_probe_module("auth", module_name))) {
393 entry = auth_find_backend_entry(module_name);
397 if (entry != NULL) {
398 if (!NT_STATUS_IS_OK(entry->init(auth_context, module_params, ret))) {
399 DEBUG(0,("load_auth_module: auth method %s did not correctly init\n",
400 module_name));
401 } else {
402 DEBUG(5,("load_auth_module: auth method %s has a valid init\n",
403 module_name));
404 good = True;
406 } else {
407 DEBUG(0,("load_auth_module: can't find auth method %s!\n", module_name));
410 SAFE_FREE(module_name);
411 return good;
414 /***************************************************************************
415 Make a auth_info struct for the auth subsystem
416 ***************************************************************************/
418 static NTSTATUS make_auth_context_text_list(struct auth_context **auth_context, char **text_list)
420 auth_methods *list = NULL;
421 auth_methods *t = NULL;
422 NTSTATUS nt_status;
424 if (!text_list) {
425 DEBUG(2,("make_auth_context_text_list: No auth method list!?\n"));
426 return NT_STATUS_UNSUCCESSFUL;
429 if (!NT_STATUS_IS_OK(nt_status = make_auth_context(auth_context)))
430 return nt_status;
432 for (;*text_list; text_list++) {
433 if (load_auth_module(*auth_context, *text_list, &t)) {
434 DLIST_ADD_END(list, t, auth_methods *);
438 (*auth_context)->auth_method_list = list;
440 return nt_status;
443 /***************************************************************************
444 Make a auth_context struct for the auth subsystem
445 ***************************************************************************/
447 NTSTATUS make_auth_context_subsystem(struct auth_context **auth_context)
449 char **auth_method_list = NULL;
450 NTSTATUS nt_status;
452 if (lp_auth_methods()
453 && !(auth_method_list = str_list_copy(talloc_tos(),
454 lp_auth_methods()))) {
455 return NT_STATUS_NO_MEMORY;
458 if (auth_method_list == NULL) {
459 switch (lp_security())
461 case SEC_DOMAIN:
462 DEBUG(5,("Making default auth method list for security=domain\n"));
463 auth_method_list = str_list_make_v3(
464 talloc_tos(), "guest sam winbind:ntdomain",
465 NULL);
466 break;
467 case SEC_SERVER:
468 DEBUG(5,("Making default auth method list for security=server\n"));
469 auth_method_list = str_list_make_v3(
470 talloc_tos(), "guest sam smbserver",
471 NULL);
472 break;
473 case SEC_USER:
474 if (lp_encrypted_passwords()) {
475 if ((lp_server_role() == ROLE_DOMAIN_PDC) || (lp_server_role() == ROLE_DOMAIN_BDC)) {
476 DEBUG(5,("Making default auth method list for DC, security=user, encrypt passwords = yes\n"));
477 auth_method_list = str_list_make_v3(
478 talloc_tos(),
479 "guest sam winbind:trustdomain",
480 NULL);
481 } else {
482 DEBUG(5,("Making default auth method list for standalone security=user, encrypt passwords = yes\n"));
483 auth_method_list = str_list_make_v3(
484 talloc_tos(), "guest sam",
485 NULL);
487 } else {
488 DEBUG(5,("Making default auth method list for security=user, encrypt passwords = no\n"));
489 auth_method_list = str_list_make_v3(
490 talloc_tos(), "guest unix", NULL);
492 break;
493 case SEC_SHARE:
494 if (lp_encrypted_passwords()) {
495 DEBUG(5,("Making default auth method list for security=share, encrypt passwords = yes\n"));
496 auth_method_list = str_list_make_v3(
497 talloc_tos(), "guest sam", NULL);
498 } else {
499 DEBUG(5,("Making default auth method list for security=share, encrypt passwords = no\n"));
500 auth_method_list = str_list_make_v3(
501 talloc_tos(), "guest unix", NULL);
503 break;
504 case SEC_ADS:
505 DEBUG(5,("Making default auth method list for security=ADS\n"));
506 auth_method_list = str_list_make_v3(
507 talloc_tos(), "guest sam winbind:ntdomain",
508 NULL);
509 break;
510 default:
511 DEBUG(5,("Unknown auth method!\n"));
512 return NT_STATUS_UNSUCCESSFUL;
514 } else {
515 DEBUG(5,("Using specified auth order\n"));
518 nt_status = make_auth_context_text_list(auth_context,
519 auth_method_list);
521 TALLOC_FREE(auth_method_list);
522 return nt_status;
525 /***************************************************************************
526 Make a auth_info struct with a fixed challenge
527 ***************************************************************************/
529 NTSTATUS make_auth_context_fixed(struct auth_context **auth_context, uchar chal[8])
531 NTSTATUS nt_status;
532 if (!NT_STATUS_IS_OK(nt_status = make_auth_context_subsystem(auth_context))) {
533 return nt_status;
536 (*auth_context)->challenge = data_blob_talloc(*auth_context, chal, 8);
537 (*auth_context)->challenge_set_by = "fixed";
538 return nt_status;