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
,
87 if (auth_context
->challenge
.length
) {
88 DEBUG(5, ("get_ntlm_challenge (auth subsystem): returning previous challenge by module %s (normal)\n",
89 auth_context
->challenge_set_by
));
90 memcpy(chal
, auth_context
->challenge
.data
, 8);
94 generate_random_buffer(tmp
, sizeof(tmp
));
95 auth_context
->challenge
= data_blob_talloc(auth_context
,
98 auth_context
->challenge_set_by
= "random";
100 memcpy(chal
, auth_context
->challenge
.data
, 8);
106 * Check user is in correct domain (if required)
108 * @param user Only used to fill in the debug message
110 * @param domain The domain to be verified
112 * @return True if the user can connect with that domain,
116 static bool check_domain_match(const char *user
, const char *domain
)
119 * If we aren't serving to trusted domains, we must make sure that
120 * the validation request comes from an account in the same domain
121 * as the Samba server
124 if (!lp_allow_trusted_domains() &&
125 !(strequal("", domain
) ||
126 strequal(lp_workgroup(), domain
) ||
127 is_myname(domain
))) {
128 DEBUG(1, ("check_domain_match: Attempt to connect as user %s from domain %s denied.\n", user
, domain
));
136 * Check a user's Plaintext, LM or NTLM password.
138 * Check a user's password, as given in the user_info struct and return various
139 * interesting details in the server_info struct.
141 * This function does NOT need to be in a become_root()/unbecome_root() pair
142 * as it makes the calls itself when needed.
144 * The return value takes precedence over the contents of the server_info
145 * struct. When the return is other than NT_STATUS_OK the contents
146 * of that structure is undefined.
148 * @param user_info Contains the user supplied components, including the passwords.
149 * Must be created with make_user_info() or one of its wrappers.
151 * @param auth_context Supplies the challenges and some other data.
152 * Must be created with make_auth_context(), and the challenges should be
153 * filled in, either at creation or by calling the challenge geneation
154 * function auth_get_challenge().
156 * @param pserver_info If successful, contains information about the authentication,
157 * including a struct samu struct describing the user.
159 * @param pauthoritative Indicates if the result should be treated as final
162 * @return An NTSTATUS with NT_STATUS_OK or an appropriate error.
165 NTSTATUS
auth_check_ntlm_password(TALLOC_CTX
*mem_ctx
,
166 const struct auth_context
*auth_context
,
167 const struct auth_usersupplied_info
*user_info
,
168 struct auth_serversupplied_info
**pserver_info
,
169 uint8_t *pauthoritative
)
172 const char *auth_method_name
= "";
173 /* if all the modules say 'not for me' this is reasonable */
174 NTSTATUS nt_status
= NT_STATUS_NOT_IMPLEMENTED
;
175 const char *unix_username
;
176 auth_methods
*auth_method
;
177 struct auth_serversupplied_info
*server_info
= NULL
;
178 struct dom_sid sid
= {0};
180 if (user_info
== NULL
|| auth_context
== NULL
|| pserver_info
== NULL
) {
181 return NT_STATUS_LOGON_FAILURE
;
184 frame
= talloc_stackframe();
188 DEBUG(3, ("check_ntlm_password: Checking password for unmapped user [%s]\\[%s]@[%s] with the new password interface\n",
189 user_info
->client
.domain_name
, user_info
->client
.account_name
, user_info
->workstation_name
));
191 DEBUG(3, ("check_ntlm_password: mapped user is: [%s]\\[%s]@[%s]\n",
192 user_info
->mapped
.domain_name
, user_info
->mapped
.account_name
, user_info
->workstation_name
));
194 if (auth_context
->challenge
.length
!= 8) {
195 DEBUG(0, ("check_ntlm_password: Invalid challenge stored for this auth context - cannot continue\n"));
196 nt_status
= NT_STATUS_LOGON_FAILURE
;
200 if (auth_context
->challenge_set_by
)
201 DEBUG(10, ("check_ntlm_password: auth_context challenge created by %s\n",
202 auth_context
->challenge_set_by
));
204 DEBUG(10, ("challenge is: \n"));
205 dump_data(5, auth_context
->challenge
.data
, auth_context
->challenge
.length
);
207 #ifdef DEBUG_PASSWORD
208 DEBUG(100, ("user_info has passwords of length %d and %d\n",
209 (int)user_info
->password
.response
.lanman
.length
, (int)user_info
->password
.response
.nt
.length
));
210 DEBUG(100, ("lm:\n"));
211 dump_data(100, user_info
->password
.response
.lanman
.data
, user_info
->password
.response
.lanman
.length
);
212 DEBUG(100, ("nt:\n"));
213 dump_data(100, user_info
->password
.response
.nt
.data
, user_info
->password
.response
.nt
.length
);
216 /* This needs to be sorted: If it doesn't match, what should we do? */
217 if (!check_domain_match(user_info
->client
.account_name
,
218 user_info
->mapped
.domain_name
)) {
219 nt_status
= NT_STATUS_LOGON_FAILURE
;
223 for (auth_method
= auth_context
->auth_method_list
;auth_method
; auth_method
= auth_method
->next
) {
225 auth_method_name
= auth_method
->name
;
227 nt_status
= auth_method
->auth(auth_context
,
228 auth_method
->private_data
,
233 if (!NT_STATUS_EQUAL(nt_status
, NT_STATUS_NOT_IMPLEMENTED
)) {
237 DBG_DEBUG("%s had nothing to say\n", auth_method
->name
);
240 if (NT_STATUS_EQUAL(nt_status
, NT_STATUS_NOT_IMPLEMENTED
)) {
242 nt_status
= NT_STATUS_NO_SUCH_USER
;
245 if (!NT_STATUS_IS_OK(nt_status
)) {
246 DBG_INFO("%s authentication for user [%s] FAILED with "
247 "error %s, authoritative=%u\n",
249 user_info
->client
.account_name
,
250 nt_errstr(nt_status
),
255 DBG_NOTICE("%s authentication for user [%s] succeeded\n",
256 auth_method_name
, user_info
->client
.account_name
);
258 unix_username
= server_info
->unix_name
;
260 /* We skip doing this step if the caller asked us not to */
261 if (!(user_info
->flags
& USER_INFO_INFO3_AND_NO_AUTHZ
)
262 && !(server_info
->guest
)) {
265 if (tsocket_address_is_inet(user_info
->remote_host
, "ip")) {
266 rhost
= tsocket_address_inet_addr_string(
267 user_info
->remote_host
, talloc_tos());
269 nt_status
= NT_STATUS_NO_MEMORY
;
276 /* We might not be root if we are an RPC call */
278 nt_status
= smb_pam_accountcheck(unix_username
, rhost
);
281 if (NT_STATUS_IS_OK(nt_status
)) {
282 DEBUG(5, ("check_ntlm_password: PAM Account for user [%s] "
283 "succeeded\n", unix_username
));
285 DEBUG(3, ("check_ntlm_password: PAM Account for user [%s] "
286 "FAILED with error %s\n",
287 unix_username
, nt_errstr(nt_status
)));
291 if (!NT_STATUS_IS_OK(nt_status
)) {
295 nt_status
= get_user_sid_info3_and_extra(server_info
->info3
,
298 if (!NT_STATUS_IS_OK(nt_status
)) {
299 sid
= (struct dom_sid
) {0};
302 log_authentication_event(NULL
, NULL
,
303 &auth_context
->start_time
,
306 server_info
->info3
->base
.logon_domain
.string
,
307 server_info
->info3
->base
.account_name
.string
,
308 unix_username
, &sid
);
310 DEBUG(server_info
->guest
? 5 : 2,
311 ("check_ntlm_password: %sauthentication for user "
312 "[%s] -> [%s] -> [%s] succeeded\n",
313 server_info
->guest
? "guest " : "",
314 user_info
->client
.account_name
,
315 user_info
->mapped
.account_name
,
318 *pserver_info
= talloc_move(mem_ctx
, &server_info
);
325 /* failed authentication; check for guest lapping */
328 * Please try not to change this string, it is probably in use
329 * in audit logging tools
331 DEBUG(2, ("check_ntlm_password: Authentication for user "
332 "[%s] -> [%s] FAILED with error %s, authoritative=%u\n",
333 user_info
->client
.account_name
, user_info
->mapped
.account_name
,
334 nt_errstr(nt_status
), *pauthoritative
));
336 log_authentication_event(NULL
,
338 &auth_context
->start_time
,
346 ZERO_STRUCTP(pserver_info
);
353 /***************************************************************************
354 Clear out a auth_context, and destroy the attached TALLOC_CTX
355 ***************************************************************************/
357 static int auth_context_destructor(void *ptr
)
359 struct auth_context
*ctx
= talloc_get_type(ptr
, struct auth_context
);
360 struct auth_methods
*am
;
363 /* Free private data of context's authentication methods */
364 for (am
= ctx
->auth_method_list
; am
; am
= am
->next
) {
365 TALLOC_FREE(am
->private_data
);
371 /***************************************************************************
372 Make a auth_info struct
373 ***************************************************************************/
375 static NTSTATUS
make_auth_context(TALLOC_CTX
*mem_ctx
,
376 struct auth_context
**auth_context
)
378 struct auth_context
*ctx
;
380 ctx
= talloc_zero(mem_ctx
, struct auth_context
);
382 DEBUG(0,("make_auth_context: talloc failed!\n"));
383 return NT_STATUS_NO_MEMORY
;
386 ctx
->start_time
= timeval_current();
388 talloc_set_destructor((TALLOC_CTX
*)ctx
, auth_context_destructor
);
394 bool load_auth_module(struct auth_context
*auth_context
,
395 const char *module
, auth_methods
**ret
)
397 static bool initialised_static_modules
= False
;
399 struct auth_init_function_entry
*entry
;
400 char *module_name
= smb_xstrdup(module
);
401 char *module_params
= NULL
;
405 /* Initialise static modules if not done so yet */
406 if(!initialised_static_modules
) {
407 static_init_auth(NULL
);
408 initialised_static_modules
= True
;
411 DEBUG(5,("load_auth_module: Attempting to find an auth method to match %s\n",
414 p
= strchr(module_name
, ':');
418 trim_char(module_params
, ' ', ' ');
421 trim_char(module_name
, ' ', ' ');
423 entry
= auth_find_backend_entry(module_name
);
426 if (NT_STATUS_IS_OK(smb_probe_module("auth", module_name
))) {
427 entry
= auth_find_backend_entry(module_name
);
432 if (!NT_STATUS_IS_OK(entry
->init(auth_context
, module_params
, ret
))) {
433 DEBUG(0,("load_auth_module: auth method %s did not correctly init\n",
436 DEBUG(5,("load_auth_module: auth method %s has a valid init\n",
441 DEBUG(0,("load_auth_module: can't find auth method %s!\n", module_name
));
444 SAFE_FREE(module_name
);
448 /***************************************************************************
449 Make a auth_info struct for the auth subsystem
450 ***************************************************************************/
452 static NTSTATUS
make_auth_context_text_list(TALLOC_CTX
*mem_ctx
,
453 struct auth_context
**auth_context
,
456 auth_methods
*list
= NULL
;
457 auth_methods
*t
, *method
= NULL
;
461 DEBUG(2,("make_auth_context_text_list: No auth method list!?\n"));
462 return NT_STATUS_UNSUCCESSFUL
;
465 nt_status
= make_auth_context(mem_ctx
, auth_context
);
467 if (!NT_STATUS_IS_OK(nt_status
)) {
471 for (;*text_list
; text_list
++) {
472 if (load_auth_module(*auth_context
, *text_list
, &t
)) {
473 DLIST_ADD_END(list
, t
);
477 (*auth_context
)->auth_method_list
= list
;
479 /* Look for the first module to provide a prepare_gensec and
480 * make_auth4_context hook, and set that if provided */
481 for (method
= (*auth_context
)->auth_method_list
; method
; method
= method
->next
) {
482 if (method
->prepare_gensec
&& method
->make_auth4_context
) {
483 (*auth_context
)->prepare_gensec
= method
->prepare_gensec
;
484 (*auth_context
)->make_auth4_context
= method
->make_auth4_context
;
491 static NTSTATUS
make_auth_context_specific(TALLOC_CTX
*mem_ctx
,
492 struct auth_context
**auth_context
,
498 method_list
= str_list_make_v3(talloc_tos(), methods
, NULL
);
499 if (method_list
== NULL
) {
500 return NT_STATUS_NO_MEMORY
;
503 status
= make_auth_context_text_list(
504 mem_ctx
, auth_context
, method_list
);
506 TALLOC_FREE(method_list
);
511 /***************************************************************************
512 Make a auth_context struct for the auth subsystem
513 ***************************************************************************/
515 NTSTATUS
make_auth3_context_for_ntlm(TALLOC_CTX
*mem_ctx
,
516 struct auth_context
**auth_context
)
518 const char *methods
= NULL
;
520 switch (lp_server_role()) {
521 case ROLE_ACTIVE_DIRECTORY_DC
:
522 DEBUG(5,("Making default auth method list for server role = "
523 "'active directory domain controller'\n"));
526 case ROLE_DOMAIN_MEMBER
:
527 DEBUG(5,("Making default auth method list for server role = 'domain member'\n"));
528 methods
= "anonymous sam winbind sam_ignoredomain";
530 case ROLE_DOMAIN_BDC
:
531 case ROLE_DOMAIN_PDC
:
532 DEBUG(5,("Making default auth method list for DC\n"));
533 methods
= "anonymous sam winbind sam_ignoredomain";
535 case ROLE_STANDALONE
:
536 DEBUG(5,("Making default auth method list for server role = 'standalone server', encrypt passwords = yes\n"));
537 if (lp_encrypt_passwords()) {
538 methods
= "anonymous sam_ignoredomain";
540 DEBUG(5,("Making default auth method list for server role = 'standalone server', encrypt passwords = no\n"));
541 methods
= "anonymous unix";
545 DEBUG(5,("Unknown auth method!\n"));
546 return NT_STATUS_UNSUCCESSFUL
;
549 return make_auth_context_specific(mem_ctx
, auth_context
, methods
);
552 NTSTATUS
make_auth3_context_for_netlogon(TALLOC_CTX
*mem_ctx
,
553 struct auth_context
**auth_context
)
555 const char *methods
= NULL
;
557 switch (lp_server_role()) {
558 case ROLE_DOMAIN_BDC
:
559 case ROLE_DOMAIN_PDC
:
560 methods
= "sam_netlogon3 winbind:trustdomain";
564 DBG_ERR("Invalid server role!\n");
565 return NT_STATUS_INVALID_SERVER_STATE
;
568 return make_auth_context_specific(mem_ctx
, auth_context
, methods
);
571 NTSTATUS
make_auth3_context_for_winbind(TALLOC_CTX
*mem_ctx
,
572 struct auth_context
**auth_context
)
574 const char *methods
= NULL
;
576 switch (lp_server_role()) {
577 case ROLE_STANDALONE
:
578 case ROLE_DOMAIN_MEMBER
:
579 case ROLE_DOMAIN_BDC
:
580 case ROLE_DOMAIN_PDC
:
583 case ROLE_ACTIVE_DIRECTORY_DC
:
584 methods
= "samba4:sam";
587 DEBUG(5,("Unknown auth method!\n"));
588 return NT_STATUS_UNSUCCESSFUL
;
591 return make_auth_context_specific(mem_ctx
, auth_context
, methods
);
594 bool auth3_context_set_challenge(struct auth_context
*ctx
, uint8_t chal
[8],
595 const char *challenge_set_by
)
597 ctx
->challenge
= data_blob_talloc(ctx
, chal
, 8);
598 if (ctx
->challenge
.data
== NULL
) {
601 ctx
->challenge_set_by
= talloc_strdup(ctx
, challenge_set_by
);
602 if (ctx
->challenge_set_by
== NULL
) {