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/>.
22 #include "../lib/tsocket/tsocket.h"
25 #define DBGC_CLASS DBGC_AUTH
29 static struct auth_init_function_entry
*auth_backends
= NULL
;
31 static struct auth_init_function_entry
*auth_find_backend_entry(const char *name
);
33 NTSTATUS
smb_register_auth(int version
, const char *name
, auth_init_function init
)
35 struct auth_init_function_entry
*entry
= auth_backends
;
37 if (version
!= AUTH_INTERFACE_VERSION
) {
38 DEBUG(0,("Can't register auth_method!\n"
39 "You tried to register an auth module with AUTH_INTERFACE_VERSION %d, while this version of samba uses %d\n",
40 version
,AUTH_INTERFACE_VERSION
));
41 return NT_STATUS_OBJECT_TYPE_MISMATCH
;
45 return NT_STATUS_INVALID_PARAMETER
;
48 DEBUG(5,("Attempting to register auth backend %s\n", name
));
50 if (auth_find_backend_entry(name
)) {
51 DEBUG(0,("There already is an auth method registered with the name %s!\n", name
));
52 return NT_STATUS_OBJECT_NAME_COLLISION
;
55 entry
= SMB_XMALLOC_P(struct auth_init_function_entry
);
56 entry
->name
= smb_xstrdup(name
);
59 DLIST_ADD(auth_backends
, entry
);
60 DEBUG(5,("Successfully added auth method '%s'\n", name
));
64 static struct auth_init_function_entry
*auth_find_backend_entry(const char *name
)
66 struct auth_init_function_entry
*entry
= auth_backends
;
69 if (strcmp(entry
->name
, name
)==0) return entry
;
76 /****************************************************************************
77 Try to get a challenge out of the various authentication modules.
78 Returns a const char of length 8 bytes.
79 ****************************************************************************/
81 NTSTATUS
auth_get_ntlm_challenge(struct auth_context
*auth_context
,
84 DATA_BLOB challenge
= data_blob_null
;
85 const char *challenge_set_by
= NULL
;
86 auth_methods
*auth_method
;
88 if (auth_context
->challenge
.length
) {
89 DEBUG(5, ("get_ntlm_challenge (auth subsystem): returning previous challenge by module %s (normal)\n",
90 auth_context
->challenge_set_by
));
91 memcpy(chal
, auth_context
->challenge
.data
, 8);
95 auth_context
->challenge_may_be_modified
= False
;
97 for (auth_method
= auth_context
->auth_method_list
; auth_method
; auth_method
= auth_method
->next
) {
98 if (auth_method
->get_chal
== NULL
) {
99 DEBUG(5, ("auth_get_challenge: module %s did not want to specify a challenge\n", auth_method
->name
));
103 DEBUG(5, ("auth_get_challenge: getting challenge from module %s\n", auth_method
->name
));
104 if (challenge_set_by
!= NULL
) {
105 DEBUG(1, ("auth_get_challenge: CONFIGURATION ERROR: authentication method %s has already specified a challenge. Challenge by %s ignored.\n",
106 challenge_set_by
, auth_method
->name
));
110 challenge
= auth_method
->get_chal(auth_context
, &auth_method
->private_data
,
112 if (!challenge
.length
) {
113 DEBUG(3, ("auth_get_challenge: getting challenge from authentication method %s FAILED.\n",
116 DEBUG(5, ("auth_get_challenge: successfully got challenge from module %s\n", auth_method
->name
));
117 auth_context
->challenge
= challenge
;
118 challenge_set_by
= auth_method
->name
;
119 auth_context
->challenge_set_method
= auth_method
;
123 if (!challenge_set_by
) {
126 generate_random_buffer(tmp
, sizeof(tmp
));
127 auth_context
->challenge
= data_blob_talloc(auth_context
,
130 challenge_set_by
= "random";
131 auth_context
->challenge_may_be_modified
= True
;
134 DEBUG(5, ("auth_context challenge created by %s\n", challenge_set_by
));
135 DEBUG(5, ("challenge is: \n"));
136 dump_data(5, auth_context
->challenge
.data
, auth_context
->challenge
.length
);
138 SMB_ASSERT(auth_context
->challenge
.length
== 8);
140 auth_context
->challenge_set_by
=challenge_set_by
;
142 memcpy(chal
, auth_context
->challenge
.data
, 8);
148 * Check user is in correct domain (if required)
150 * @param user Only used to fill in the debug message
152 * @param domain The domain to be verified
154 * @return True if the user can connect with that domain,
158 static bool check_domain_match(const char *user
, const char *domain
)
161 * If we aren't serving to trusted domains, we must make sure that
162 * the validation request comes from an account in the same domain
163 * as the Samba server
166 if (!lp_allow_trusted_domains() &&
167 !(strequal("", domain
) ||
168 strequal(lp_workgroup(), domain
) ||
169 is_myname(domain
))) {
170 DEBUG(1, ("check_domain_match: Attempt to connect as user %s from domain %s denied.\n", user
, domain
));
178 * Check a user's Plaintext, LM or NTLM password.
180 * Check a user's password, as given in the user_info struct and return various
181 * interesting details in the server_info struct.
183 * This function does NOT need to be in a become_root()/unbecome_root() pair
184 * as it makes the calls itself when needed.
186 * The return value takes precedence over the contents of the server_info
187 * struct. When the return is other than NT_STATUS_OK the contents
188 * of that structure is undefined.
190 * @param user_info Contains the user supplied components, including the passwords.
191 * Must be created with make_user_info() or one of its wrappers.
193 * @param auth_context Supplies the challenges and some other data.
194 * Must be created with make_auth_context(), and the challenges should be
195 * filled in, either at creation or by calling the challenge geneation
196 * function auth_get_challenge().
198 * @param server_info If successful, contains information about the authentication,
199 * including a struct samu struct describing the user.
201 * @return An NTSTATUS with NT_STATUS_OK or an appropriate error.
205 NTSTATUS
auth_check_ntlm_password(const struct auth_context
*auth_context
,
206 const struct auth_usersupplied_info
*user_info
,
207 struct auth_serversupplied_info
**server_info
)
209 /* if all the modules say 'not for me' this is reasonable */
210 NTSTATUS nt_status
= NT_STATUS_NO_SUCH_USER
;
211 const char *unix_username
;
212 auth_methods
*auth_method
;
215 if (!user_info
|| !auth_context
|| !server_info
)
216 return NT_STATUS_LOGON_FAILURE
;
218 DEBUG(3, ("check_ntlm_password: Checking password for unmapped user [%s]\\[%s]@[%s] with the new password interface\n",
219 user_info
->client
.domain_name
, user_info
->client
.account_name
, user_info
->workstation_name
));
221 DEBUG(3, ("check_ntlm_password: mapped user is: [%s]\\[%s]@[%s]\n",
222 user_info
->mapped
.domain_name
, user_info
->mapped
.account_name
, user_info
->workstation_name
));
224 if (auth_context
->challenge
.length
!= 8) {
225 DEBUG(0, ("check_ntlm_password: Invalid challenge stored for this auth context - cannot continue\n"));
226 return NT_STATUS_LOGON_FAILURE
;
229 if (auth_context
->challenge_set_by
)
230 DEBUG(10, ("check_ntlm_password: auth_context challenge created by %s\n",
231 auth_context
->challenge_set_by
));
233 DEBUG(10, ("challenge is: \n"));
234 dump_data(5, auth_context
->challenge
.data
, auth_context
->challenge
.length
);
236 #ifdef DEBUG_PASSWORD
237 DEBUG(100, ("user_info has passwords of length %d and %d\n",
238 (int)user_info
->password
.response
.lanman
.length
, (int)user_info
->password
.response
.nt
.length
));
239 DEBUG(100, ("lm:\n"));
240 dump_data(100, user_info
->password
.response
.lanman
.data
, user_info
->password
.response
.lanman
.length
);
241 DEBUG(100, ("nt:\n"));
242 dump_data(100, user_info
->password
.response
.nt
.data
, user_info
->password
.response
.nt
.length
);
245 /* This needs to be sorted: If it doesn't match, what should we do? */
246 if (!check_domain_match(user_info
->client
.account_name
, user_info
->mapped
.domain_name
))
247 return NT_STATUS_LOGON_FAILURE
;
249 for (auth_method
= auth_context
->auth_method_list
;auth_method
; auth_method
= auth_method
->next
) {
252 mem_ctx
= talloc_init("%s authentication for user %s\\%s", auth_method
->name
,
253 user_info
->mapped
.domain_name
, user_info
->client
.account_name
);
255 result
= auth_method
->auth(auth_context
, auth_method
->private_data
, mem_ctx
, user_info
, server_info
);
257 /* check if the module did anything */
258 if ( NT_STATUS_V(result
) == NT_STATUS_V(NT_STATUS_NOT_IMPLEMENTED
) ) {
259 DEBUG(10,("check_ntlm_password: %s had nothing to say\n", auth_method
->name
));
260 talloc_destroy(mem_ctx
);
266 if (NT_STATUS_IS_OK(nt_status
)) {
267 DEBUG(3, ("check_ntlm_password: %s authentication for user [%s] succeeded\n",
268 auth_method
->name
, user_info
->client
.account_name
));
270 DEBUG(5, ("check_ntlm_password: %s authentication for user [%s] FAILED with error %s\n",
271 auth_method
->name
, user_info
->client
.account_name
, nt_errstr(nt_status
)));
274 talloc_destroy(mem_ctx
);
276 if ( NT_STATUS_IS_OK(nt_status
))
282 /* successful authentication */
284 if (NT_STATUS_IS_OK(nt_status
)) {
285 unix_username
= (*server_info
)->unix_name
;
286 if (!(*server_info
)->guest
) {
289 if (tsocket_address_is_inet(user_info
->remote_host
, "ip")) {
290 rhost
= tsocket_address_inet_addr_string(user_info
->remote_host
,
293 return NT_STATUS_NO_MEMORY
;
299 /* We might not be root if we are an RPC call */
301 nt_status
= smb_pam_accountcheck(unix_username
,
305 if (NT_STATUS_IS_OK(nt_status
)) {
306 DEBUG(5, ("check_ntlm_password: PAM Account for user [%s] succeeded\n",
309 DEBUG(3, ("check_ntlm_password: PAM Account for user [%s] FAILED with error %s\n",
310 unix_username
, nt_errstr(nt_status
)));
314 if (NT_STATUS_IS_OK(nt_status
)) {
315 DEBUG((*server_info
)->guest
? 5 : 2,
316 ("check_ntlm_password: %sauthentication for user [%s] -> [%s] -> [%s] succeeded\n",
317 (*server_info
)->guest
? "guest " : "",
318 user_info
->client
.account_name
,
319 user_info
->mapped
.account_name
,
326 /* failed authentication; check for guest lapping */
328 DEBUG(2, ("check_ntlm_password: Authentication for user [%s] -> [%s] FAILED with error %s\n",
329 user_info
->client
.account_name
, user_info
->mapped
.account_name
,
330 nt_errstr(nt_status
)));
331 ZERO_STRUCTP(server_info
);
336 /***************************************************************************
337 Clear out a auth_context, and destroy the attached TALLOC_CTX
338 ***************************************************************************/
340 static int auth_context_destructor(void *ptr
)
342 struct auth_context
*ctx
= talloc_get_type(ptr
, struct auth_context
);
343 struct auth_methods
*am
;
346 /* Free private data of context's authentication methods */
347 for (am
= ctx
->auth_method_list
; am
; am
= am
->next
) {
348 TALLOC_FREE(am
->private_data
);
354 /***************************************************************************
355 Make a auth_info struct
356 ***************************************************************************/
358 static NTSTATUS
make_auth_context(TALLOC_CTX
*mem_ctx
,
359 struct auth_context
**auth_context
)
361 struct auth_context
*ctx
;
363 ctx
= talloc_zero(mem_ctx
, struct auth_context
);
365 DEBUG(0,("make_auth_context: talloc failed!\n"));
366 return NT_STATUS_NO_MEMORY
;
369 talloc_set_destructor((TALLOC_CTX
*)ctx
, auth_context_destructor
);
375 bool load_auth_module(struct auth_context
*auth_context
,
376 const char *module
, auth_methods
**ret
)
378 static bool initialised_static_modules
= False
;
380 struct auth_init_function_entry
*entry
;
381 char *module_name
= smb_xstrdup(module
);
382 char *module_params
= NULL
;
386 /* Initialise static modules if not done so yet */
387 if(!initialised_static_modules
) {
389 initialised_static_modules
= True
;
392 DEBUG(5,("load_auth_module: Attempting to find an auth method to match %s\n",
395 p
= strchr(module_name
, ':');
399 trim_char(module_params
, ' ', ' ');
402 trim_char(module_name
, ' ', ' ');
404 entry
= auth_find_backend_entry(module_name
);
407 if (NT_STATUS_IS_OK(smb_probe_module("auth", module_name
))) {
408 entry
= auth_find_backend_entry(module_name
);
413 if (!NT_STATUS_IS_OK(entry
->init(auth_context
, module_params
, ret
))) {
414 DEBUG(0,("load_auth_module: auth method %s did not correctly init\n",
417 DEBUG(5,("load_auth_module: auth method %s has a valid init\n",
422 DEBUG(0,("load_auth_module: can't find auth method %s!\n", module_name
));
425 SAFE_FREE(module_name
);
429 /***************************************************************************
430 Make a auth_info struct for the auth subsystem
431 ***************************************************************************/
433 static NTSTATUS
make_auth_context_text_list(TALLOC_CTX
*mem_ctx
,
434 struct auth_context
**auth_context
,
437 auth_methods
*list
= NULL
;
438 auth_methods
*t
, *method
= NULL
;
442 DEBUG(2,("make_auth_context_text_list: No auth method list!?\n"));
443 return NT_STATUS_UNSUCCESSFUL
;
446 nt_status
= make_auth_context(mem_ctx
, auth_context
);
448 if (!NT_STATUS_IS_OK(nt_status
)) {
452 for (;*text_list
; text_list
++) {
453 if (load_auth_module(*auth_context
, *text_list
, &t
)) {
454 DLIST_ADD_END(list
, t
, auth_methods
*);
458 (*auth_context
)->auth_method_list
= list
;
460 /* Look for the first module to provide a prepare_gensec and
461 * make_auth4_context hook, and set that if provided */
462 for (method
= (*auth_context
)->auth_method_list
; method
; method
= method
->next
) {
463 if (method
->prepare_gensec
&& method
->make_auth4_context
) {
464 (*auth_context
)->prepare_gensec
= method
->prepare_gensec
;
465 (*auth_context
)->make_auth4_context
= method
->make_auth4_context
;
472 /***************************************************************************
473 Make a auth_context struct for the auth subsystem
474 ***************************************************************************/
476 NTSTATUS
make_auth_context_subsystem(TALLOC_CTX
*mem_ctx
,
477 struct auth_context
**auth_context
)
479 char **auth_method_list
= NULL
;
482 if (lp_auth_methods()
483 && !(auth_method_list
= str_list_copy(talloc_tos(),
484 lp_auth_methods()))) {
485 return NT_STATUS_NO_MEMORY
;
488 if (auth_method_list
== NULL
) {
489 switch (lp_server_role())
491 case ROLE_DOMAIN_MEMBER
:
492 DEBUG(5,("Making default auth method list for server role = 'domain member'\n"));
493 auth_method_list
= str_list_make_v3(
494 talloc_tos(), "guest sam winbind:ntdomain",
497 case ROLE_DOMAIN_BDC
:
498 case ROLE_DOMAIN_PDC
:
499 DEBUG(5,("Making default auth method list for DC\n"));
500 auth_method_list
= str_list_make_v3(
502 "guest sam winbind:trustdomain",
505 case ROLE_STANDALONE
:
506 DEBUG(5,("Making default auth method list for server role = 'standalone server', encrypt passwords = yes\n"));
507 if (lp_encrypted_passwords()) {
508 auth_method_list
= str_list_make_v3(
509 talloc_tos(), "guest sam",
512 DEBUG(5,("Making default auth method list for server role = 'standalone server', encrypt passwords = no\n"));
513 auth_method_list
= str_list_make_v3(
514 talloc_tos(), "guest unix", NULL
);
517 case ROLE_ACTIVE_DIRECTORY_DC
:
518 DEBUG(5,("Making default auth method list for server role = 'active directory domain controller'\n"));
519 auth_method_list
= str_list_make_v3(
525 DEBUG(5,("Unknown auth method!\n"));
526 return NT_STATUS_UNSUCCESSFUL
;
529 DEBUG(5,("Using specified auth order\n"));
532 nt_status
= make_auth_context_text_list(mem_ctx
, auth_context
,
535 TALLOC_FREE(auth_method_list
);
539 /***************************************************************************
540 Make a auth_info struct with a fixed challenge
541 ***************************************************************************/
543 NTSTATUS
make_auth_context_fixed(TALLOC_CTX
*mem_ctx
,
544 struct auth_context
**auth_context
,
548 nt_status
= make_auth_context_subsystem(mem_ctx
, auth_context
);
549 if (!NT_STATUS_IS_OK(nt_status
)) {
553 (*auth_context
)->challenge
= data_blob_talloc(*auth_context
, chal
, 8);
554 (*auth_context
)->challenge_set_by
= "fixed";