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 2 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, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #define DBGC_CLASS DBGC_AUTH
26 static struct auth_init_function_entry
*backends
= NULL
;
28 static struct auth_init_function_entry
*auth_find_backend_entry(const char *name
);
30 NTSTATUS
smb_register_auth(int version
, const char *name
, auth_init_function init
)
32 struct auth_init_function_entry
*entry
= backends
;
34 if (version
!= AUTH_INTERFACE_VERSION
) {
35 DEBUG(0,("Can't register auth_method!\n"
36 "You tried to register an auth module with AUTH_INTERFACE_VERSION %d, while this version of samba uses %d\n",
37 version
,AUTH_INTERFACE_VERSION
));
38 return NT_STATUS_OBJECT_TYPE_MISMATCH
;
42 return NT_STATUS_INVALID_PARAMETER
;
45 DEBUG(5,("Attempting to register auth backend %s\n", name
));
47 if (auth_find_backend_entry(name
)) {
48 DEBUG(0,("There already is an auth method registered with the name %s!\n", name
));
49 return NT_STATUS_OBJECT_NAME_COLLISION
;
52 entry
= smb_xmalloc(sizeof(struct auth_init_function_entry
));
53 entry
->name
= smb_xstrdup(name
);
56 DLIST_ADD(backends
, entry
);
57 DEBUG(5,("Successfully added auth method '%s'\n", name
));
61 static struct auth_init_function_entry
*auth_find_backend_entry(const char *name
)
63 struct auth_init_function_entry
*entry
= backends
;
66 if (strcmp(entry
->name
, name
)==0) return entry
;
73 /****************************************************************************
74 Try to get a challenge out of the various authentication modules.
75 Returns a const char of length 8 bytes.
76 ****************************************************************************/
78 static const uint8
*get_ntlm_challenge(struct auth_context
*auth_context
)
80 DATA_BLOB challenge
= data_blob(NULL
, 0);
81 const char *challenge_set_by
= NULL
;
82 auth_methods
*auth_method
;
85 if (auth_context
->challenge
.length
) {
86 DEBUG(5, ("get_ntlm_challenge (auth subsystem): returning previous challenge by module %s (normal)\n",
87 auth_context
->challenge_set_by
));
88 return auth_context
->challenge
.data
;
91 for (auth_method
= auth_context
->auth_method_list
; auth_method
; auth_method
= auth_method
->next
) {
92 if (auth_method
->get_chal
== NULL
) {
93 DEBUG(5, ("auth_get_challenge: module %s did not want to specify a challenge\n", auth_method
->name
));
97 DEBUG(5, ("auth_get_challenge: getting challenge from module %s\n", auth_method
->name
));
98 if (challenge_set_by
!= NULL
) {
99 DEBUG(1, ("auth_get_challenge: CONFIGURATION ERROR: authentication method %s has already specified a challenge. Challenge by %s ignored.\n",
100 challenge_set_by
, auth_method
->name
));
104 mem_ctx
= talloc_init("auth_get_challenge for module %s", auth_method
->name
);
106 smb_panic("talloc_init() failed!");
109 challenge
= auth_method
->get_chal(auth_context
, &auth_method
->private_data
, mem_ctx
);
110 if (!challenge
.length
) {
111 DEBUG(3, ("auth_get_challenge: getting challenge from authentication method %s FAILED.\n",
114 DEBUG(5, ("auth_get_challenge: sucessfully 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
;
119 talloc_destroy(mem_ctx
);
122 if (!challenge_set_by
) {
125 generate_random_buffer(chal
, sizeof(chal
), False
);
126 auth_context
->challenge
= data_blob_talloc(auth_context
->mem_ctx
,
129 challenge_set_by
= "random";
132 DEBUG(5, ("auth_context challenge created by %s\n", challenge_set_by
));
133 DEBUG(5, ("challenge is: \n"));
134 dump_data(5, (const char *)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 return auth_context
->challenge
.data
;
145 * Check user is in correct domain (if required)
147 * @param user Only used to fill in the debug message
149 * @param domain The domain to be verified
151 * @return True if the user can connect with that domain,
155 static BOOL
check_domain_match(const char *user
, const char *domain
)
158 * If we aren't serving to trusted domains, we must make sure that
159 * the validation request comes from an account in the same domain
160 * as the Samba server
163 if (!lp_allow_trusted_domains() &&
164 !(strequal("", domain
) ||
165 strequal(lp_workgroup(), domain
) ||
166 is_myname(domain
))) {
167 DEBUG(1, ("check_domain_match: Attempt to connect as user %s from domain %s denied.\n", user
, domain
));
175 * Check a user's Plaintext, LM or NTLM password.
177 * Check a user's password, as given in the user_info struct and return various
178 * interesting details in the server_info struct.
180 * This function does NOT need to be in a become_root()/unbecome_root() pair
181 * as it makes the calls itself when needed.
183 * The return value takes precedence over the contents of the server_info
184 * struct. When the return is other than NT_STATUS_OK the contents
185 * of that structure is undefined.
187 * @param user_info Contains the user supplied components, including the passwords.
188 * Must be created with make_user_info() or one of its wrappers.
190 * @param auth_context Supplies the challenges and some other data.
191 * Must be created with make_auth_context(), and the challenges should be
192 * filled in, either at creation or by calling the challenge geneation
193 * function auth_get_challenge().
195 * @param server_info If successful, contains information about the authentication,
196 * including a SAM_ACCOUNT struct describing the user.
198 * @return An NTSTATUS with NT_STATUS_OK or an appropriate error.
202 static NTSTATUS
check_ntlm_password(const struct auth_context
*auth_context
,
203 const struct auth_usersupplied_info
*user_info
,
204 struct auth_serversupplied_info
**server_info
)
206 /* if all the modules say 'not for me' this is reasonable */
207 NTSTATUS nt_status
= NT_STATUS_NO_SUCH_USER
;
208 const char *unix_username
;
209 auth_methods
*auth_method
;
212 if (!user_info
|| !auth_context
|| !server_info
)
213 return NT_STATUS_LOGON_FAILURE
;
215 DEBUG(3, ("check_ntlm_password: Checking password for unmapped user [%s]\\[%s]@[%s] with the new password interface\n",
216 user_info
->client_domain
.str
, user_info
->smb_name
.str
, user_info
->wksta_name
.str
));
218 DEBUG(3, ("check_ntlm_password: mapped user is: [%s]\\[%s]@[%s]\n",
219 user_info
->domain
.str
, user_info
->internal_username
.str
, user_info
->wksta_name
.str
));
221 if (auth_context
->challenge
.length
!= 8) {
222 DEBUG(0, ("check_ntlm_password: Invalid challenge stored for this auth context - cannot continue\n"));
223 return NT_STATUS_LOGON_FAILURE
;
226 if (auth_context
->challenge_set_by
)
227 DEBUG(10, ("check_ntlm_password: auth_context challenge created by %s\n",
228 auth_context
->challenge_set_by
));
230 DEBUG(10, ("challenge is: \n"));
231 dump_data(5, (const char *)auth_context
->challenge
.data
, auth_context
->challenge
.length
);
233 #ifdef DEBUG_PASSWORD
234 DEBUG(100, ("user_info has passwords of length %d and %d\n",
235 user_info
->lm_resp
.length
, user_info
->nt_resp
.length
));
236 DEBUG(100, ("lm:\n"));
237 dump_data(100, user_info
->lm_resp
.data
, user_info
->lm_resp
.length
);
238 DEBUG(100, ("nt:\n"));
239 dump_data(100, user_info
->nt_resp
.data
, user_info
->nt_resp
.length
);
242 /* This needs to be sorted: If it doesn't match, what should we do? */
243 if (!check_domain_match(user_info
->smb_name
.str
, user_info
->domain
.str
))
244 return NT_STATUS_LOGON_FAILURE
;
246 for (auth_method
= auth_context
->auth_method_list
;auth_method
; auth_method
= auth_method
->next
) {
249 mem_ctx
= talloc_init("%s authentication for user %s\\%s", auth_method
->name
,
250 user_info
->domain
.str
, user_info
->smb_name
.str
);
252 result
= auth_method
->auth(auth_context
, auth_method
->private_data
, mem_ctx
, user_info
, server_info
);
254 /* check if the module did anything */
255 if ( NT_STATUS_V(result
) == NT_STATUS_V(NT_STATUS_NOT_IMPLEMENTED
) ) {
256 DEBUG(10,("check_ntlm_password: %s had nothing to say\n", auth_method
->name
));
257 talloc_destroy(mem_ctx
);
263 if (NT_STATUS_IS_OK(nt_status
)) {
264 DEBUG(3, ("check_ntlm_password: %s authentication for user [%s] succeeded\n",
265 auth_method
->name
, user_info
->smb_name
.str
));
267 DEBUG(5, ("check_ntlm_password: %s authentication for user [%s] FAILED with error %s\n",
268 auth_method
->name
, user_info
->smb_name
.str
, nt_errstr(nt_status
)));
271 talloc_destroy(mem_ctx
);
273 if ( NT_STATUS_IS_OK(nt_status
))
279 if (NT_STATUS_IS_OK(nt_status
)) {
280 unix_username
= (*server_info
)->unix_name
;
281 if (!(*server_info
)->guest
) {
282 /* We might not be root if we are an RPC call */
284 nt_status
= smb_pam_accountcheck(unix_username
);
287 if (NT_STATUS_IS_OK(nt_status
)) {
288 DEBUG(5, ("check_ntlm_password: PAM Account for user [%s] succeeded\n",
291 DEBUG(3, ("check_ntlm_password: PAM Account for user [%s] FAILED with error %s\n",
292 unix_username
, nt_errstr(nt_status
)));
296 if (NT_STATUS_IS_OK(nt_status
)) {
297 DEBUG((*server_info
)->guest
? 5 : 2,
298 ("check_ntlm_password: %sauthentication for user [%s] -> [%s] -> [%s] succeeded\n",
299 (*server_info
)->guest
? "guest " : "",
300 user_info
->smb_name
.str
,
301 user_info
->internal_username
.str
,
306 if (!NT_STATUS_IS_OK(nt_status
)) {
307 DEBUG(2, ("check_ntlm_password: Authentication for user [%s] -> [%s] FAILED with error %s\n",
308 user_info
->smb_name
.str
, user_info
->internal_username
.str
,
309 nt_errstr(nt_status
)));
310 ZERO_STRUCTP(server_info
);
315 /***************************************************************************
316 Clear out a auth_context, and destroy the attached TALLOC_CTX
317 ***************************************************************************/
319 static void free_auth_context(struct auth_context
**auth_context
)
321 if (*auth_context
!= NULL
)
322 talloc_destroy((*auth_context
)->mem_ctx
);
323 *auth_context
= NULL
;
326 /***************************************************************************
327 Make a auth_info struct
328 ***************************************************************************/
330 static NTSTATUS
make_auth_context(struct auth_context
**auth_context
)
334 mem_ctx
= talloc_init("authentication context");
336 *auth_context
= talloc(mem_ctx
, sizeof(**auth_context
));
337 if (!*auth_context
) {
338 DEBUG(0,("make_auth_context: talloc failed!\n"));
339 talloc_destroy(mem_ctx
);
340 return NT_STATUS_NO_MEMORY
;
342 ZERO_STRUCTP(*auth_context
);
344 (*auth_context
)->mem_ctx
= mem_ctx
;
345 (*auth_context
)->check_ntlm_password
= check_ntlm_password
;
346 (*auth_context
)->get_ntlm_challenge
= get_ntlm_challenge
;
347 (*auth_context
)->free
= free_auth_context
;
352 BOOL
load_auth_module(struct auth_context
*auth_context
,
353 const char *module
, auth_methods
**ret
)
355 static BOOL initialised_static_modules
= False
;
357 struct auth_init_function_entry
*entry
;
358 char *module_name
= smb_xstrdup(module
);
359 char *module_params
= NULL
;
363 /* Initialise static modules if not done so yet */
364 if(!initialised_static_modules
) {
366 initialised_static_modules
= True
;
369 DEBUG(5,("load_auth_module: Attempting to find an auth method to match %s\n",
372 p
= strchr(module_name
, ':');
376 trim_char(module_params
, ' ', ' ');
379 trim_char(module_name
, ' ', ' ');
381 entry
= auth_find_backend_entry(module_name
);
384 if (NT_STATUS_IS_OK(smb_probe_module("auth", module_name
))) {
385 entry
= auth_find_backend_entry(module_name
);
390 if (!NT_STATUS_IS_OK(entry
->init(auth_context
, module_params
, ret
))) {
391 DEBUG(0,("load_auth_module: auth method %s did not correctly init\n",
394 DEBUG(5,("load_auth_module: auth method %s has a valid init\n",
399 DEBUG(0,("load_auth_module: can't find auth method %s!\n", module_name
));
402 SAFE_FREE(module_name
);
406 /***************************************************************************
407 Make a auth_info struct for the auth subsystem
408 ***************************************************************************/
410 static NTSTATUS
make_auth_context_text_list(struct auth_context
**auth_context
, char **text_list
)
412 auth_methods
*list
= NULL
;
413 auth_methods
*t
= NULL
;
418 DEBUG(2,("make_auth_context_text_list: No auth method list!?\n"));
419 return NT_STATUS_UNSUCCESSFUL
;
422 if (!NT_STATUS_IS_OK(nt_status
= make_auth_context(auth_context
)))
425 for (;*text_list
; text_list
++) {
426 if (load_auth_module(*auth_context
, *text_list
, &t
)) {
427 DLIST_ADD_END(list
, t
, tmp
);
431 (*auth_context
)->auth_method_list
= list
;
436 /***************************************************************************
437 Make a auth_context struct for the auth subsystem
438 ***************************************************************************/
440 NTSTATUS
make_auth_context_subsystem(struct auth_context
**auth_context
)
442 char **auth_method_list
= NULL
;
445 if (lp_auth_methods() && !str_list_copy(&auth_method_list
, lp_auth_methods())) {
446 return NT_STATUS_NO_MEMORY
;
449 if (auth_method_list
== NULL
) {
450 switch (lp_security())
453 DEBUG(5,("Making default auth method list for security=domain\n"));
454 auth_method_list
= str_list_make("guest sam winbind:ntdomain", NULL
);
457 DEBUG(5,("Making default auth method list for security=server\n"));
458 auth_method_list
= str_list_make("guest sam smbserver", NULL
);
461 if (lp_encrypted_passwords()) {
462 if ((lp_server_role() == ROLE_DOMAIN_PDC
) || (lp_server_role() == ROLE_DOMAIN_BDC
)) {
463 DEBUG(5,("Making default auth method list for DC, security=user, encrypt passwords = yes\n"));
464 auth_method_list
= str_list_make("guest sam winbind:trustdomain", NULL
);
466 DEBUG(5,("Making default auth method list for standalone security=user, encrypt passwords = yes\n"));
467 auth_method_list
= str_list_make("guest sam", NULL
);
470 DEBUG(5,("Making default auth method list for security=user, encrypt passwords = no\n"));
471 auth_method_list
= str_list_make("guest unix", NULL
);
475 if (lp_encrypted_passwords()) {
476 DEBUG(5,("Making default auth method list for security=share, encrypt passwords = yes\n"));
477 auth_method_list
= str_list_make("guest sam", NULL
);
479 DEBUG(5,("Making default auth method list for security=share, encrypt passwords = no\n"));
480 auth_method_list
= str_list_make("guest unix", NULL
);
484 DEBUG(5,("Making default auth method list for security=ADS\n"));
485 auth_method_list
= str_list_make("guest sam winbind:ntdomain", NULL
);
488 DEBUG(5,("Unknown auth method!\n"));
489 return NT_STATUS_UNSUCCESSFUL
;
492 DEBUG(5,("Using specified auth order\n"));
495 if (!NT_STATUS_IS_OK(nt_status
= make_auth_context_text_list(auth_context
, auth_method_list
))) {
496 str_list_free(&auth_method_list
);
500 str_list_free(&auth_method_list
);
504 /***************************************************************************
505 Make a auth_info struct with a fixed challenge
506 ***************************************************************************/
508 NTSTATUS
make_auth_context_fixed(struct auth_context
**auth_context
, uchar chal
[8])
511 if (!NT_STATUS_IS_OK(nt_status
= make_auth_context_subsystem(auth_context
))) {
515 (*auth_context
)->challenge
= data_blob_talloc((*auth_context
)->mem_ctx
, chal
, 8);
516 (*auth_context
)->challenge_set_by
= "fixed";