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"
24 #include "param/param.h"
25 #include "../lib/messaging/messaging.h"
26 #include "lib/global_contexts.h"
29 #define DBGC_CLASS DBGC_AUTH
33 static struct auth_init_function_entry
*auth_backends
= NULL
;
35 static struct auth_init_function_entry
*auth_find_backend_entry(const char *name
);
37 NTSTATUS
smb_register_auth(int version
, const char *name
, auth_init_function init
)
39 struct auth_init_function_entry
*entry
= NULL
;
41 if (version
!= AUTH_INTERFACE_VERSION
) {
42 DEBUG(0,("Can't register auth_method!\n"
43 "You tried to register an auth module with AUTH_INTERFACE_VERSION %d, while this version of samba uses %d\n",
44 version
,AUTH_INTERFACE_VERSION
));
45 return NT_STATUS_OBJECT_TYPE_MISMATCH
;
49 return NT_STATUS_INVALID_PARAMETER
;
52 DEBUG(5,("Attempting to register auth backend %s\n", name
));
54 if (auth_find_backend_entry(name
)) {
55 DEBUG(0,("There already is an auth method registered with the name %s!\n", name
));
56 return NT_STATUS_OBJECT_NAME_COLLISION
;
59 entry
= SMB_XMALLOC_P(struct auth_init_function_entry
);
60 entry
->name
= smb_xstrdup(name
);
63 DLIST_ADD(auth_backends
, entry
);
64 DEBUG(5,("Successfully added auth method '%s'\n", name
));
68 static struct auth_init_function_entry
*auth_find_backend_entry(const char *name
)
70 struct auth_init_function_entry
*entry
= auth_backends
;
73 if (strcmp(entry
->name
, name
)==0) return entry
;
80 /****************************************************************************
81 Try to get a challenge out of the various authentication modules.
82 Returns a const char of length 8 bytes.
83 ****************************************************************************/
85 NTSTATUS
auth_get_ntlm_challenge(struct auth_context
*auth_context
,
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
= data_blob_talloc(auth_context
, NULL
, 8);
96 if (auth_context
->challenge
.data
== NULL
) {
97 DBG_WARNING("data_blob_talloc failed\n");
98 return NT_STATUS_NO_MEMORY
;
100 generate_random_buffer(
101 auth_context
->challenge
.data
, auth_context
->challenge
.length
);
103 auth_context
->challenge_set_by
= "random";
105 memcpy(chal
, auth_context
->challenge
.data
, 8);
111 * Check user is in correct domain (if required)
113 * @param user Only used to fill in the debug message
115 * @param domain The domain to be verified
117 * @return True if the user can connect with that domain,
121 static bool check_domain_match(const char *user
, const char *domain
)
124 * If we aren't serving to trusted domains, we must make sure that
125 * the validation request comes from an account in the same domain
126 * as the Samba server
129 if (!lp_allow_trusted_domains() &&
130 !(strequal("", domain
) ||
131 strequal(lp_workgroup(), domain
) ||
132 is_myname(domain
))) {
133 DEBUG(1, ("check_domain_match: Attempt to connect as user %s from domain %s denied.\n", user
, domain
));
141 * Check a user's Plaintext, LM or NTLM password.
143 * Check a user's password, as given in the user_info struct and return various
144 * interesting details in the server_info struct.
146 * This function does NOT need to be in a become_root()/unbecome_root() pair
147 * as it makes the calls itself when needed.
149 * The return value takes precedence over the contents of the server_info
150 * struct. When the return is other than NT_STATUS_OK the contents
151 * of that structure is undefined.
153 * @param user_info Contains the user supplied components, including the passwords.
154 * Must be created with make_user_info() or one of its wrappers.
156 * @param auth_context Supplies the challenges and some other data.
157 * Must be created with make_auth_context(), and the challenges should be
158 * filled in, either at creation or by calling the challenge geneation
159 * function auth_get_challenge().
161 * @param pserver_info If successful, contains information about the authentication,
162 * including a struct samu struct describing the user.
164 * @param pauthoritative Indicates if the result should be treated as final
167 * @return An NTSTATUS with NT_STATUS_OK or an appropriate error.
170 NTSTATUS
auth_check_ntlm_password(TALLOC_CTX
*mem_ctx
,
171 const struct auth_context
*auth_context
,
172 const struct auth_usersupplied_info
*user_info
,
173 struct auth_serversupplied_info
**pserver_info
,
174 uint8_t *pauthoritative
)
177 const char *auth_method_name
= "";
178 /* if all the modules say 'not for me' this is reasonable */
179 NTSTATUS nt_status
= NT_STATUS_NOT_IMPLEMENTED
;
180 const char *unix_username
;
181 struct auth_methods
*auth_method
;
182 struct auth_serversupplied_info
*server_info
= NULL
;
183 struct dom_sid sid
= {0};
184 struct imessaging_context
*msg_ctx
= NULL
;
185 struct loadparm_context
*lp_ctx
= NULL
;
187 if (user_info
== NULL
|| auth_context
== NULL
|| pserver_info
== NULL
) {
188 return NT_STATUS_LOGON_FAILURE
;
191 frame
= talloc_stackframe();
193 if (lp_auth_event_notification()) {
194 lp_ctx
= loadparm_init_s3(frame
, loadparm_s3_helpers());
195 msg_ctx
= imessaging_client_init(
196 frame
, lp_ctx
, global_event_context());
201 DEBUG(3, ("check_ntlm_password: Checking password for unmapped user [%s]\\[%s]@[%s] with the new password interface\n",
202 user_info
->client
.domain_name
, user_info
->client
.account_name
, user_info
->workstation_name
));
204 DEBUG(3, ("check_ntlm_password: mapped user is: [%s]\\[%s]@[%s]\n",
205 user_info
->mapped
.domain_name
, user_info
->mapped
.account_name
, user_info
->workstation_name
));
207 if (auth_context
->challenge
.length
!= 8) {
208 DEBUG(0, ("check_ntlm_password: Invalid challenge stored for this auth context - cannot continue\n"));
209 nt_status
= NT_STATUS_LOGON_FAILURE
;
213 if (auth_context
->challenge_set_by
)
214 DEBUG(10, ("check_ntlm_password: auth_context challenge created by %s\n",
215 auth_context
->challenge_set_by
));
217 DEBUG(10, ("challenge is: \n"));
218 dump_data(5, auth_context
->challenge
.data
, auth_context
->challenge
.length
);
220 #ifdef DEBUG_PASSWORD
221 DEBUG(100, ("user_info has passwords of length %d and %d\n",
222 (int)user_info
->password
.response
.lanman
.length
, (int)user_info
->password
.response
.nt
.length
));
223 DEBUG(100, ("lm:\n"));
224 dump_data(100, user_info
->password
.response
.lanman
.data
, user_info
->password
.response
.lanman
.length
);
225 DEBUG(100, ("nt:\n"));
226 dump_data(100, user_info
->password
.response
.nt
.data
, user_info
->password
.response
.nt
.length
);
229 /* This needs to be sorted: If it doesn't match, what should we do? */
230 if (!check_domain_match(user_info
->client
.account_name
,
231 user_info
->mapped
.domain_name
)) {
232 nt_status
= NT_STATUS_LOGON_FAILURE
;
236 for (auth_method
= auth_context
->auth_method_list
;auth_method
; auth_method
= auth_method
->next
) {
238 auth_method_name
= auth_method
->name
;
240 nt_status
= auth_method
->auth(auth_context
,
241 auth_method
->private_data
,
246 if (!NT_STATUS_EQUAL(nt_status
, NT_STATUS_NOT_IMPLEMENTED
)) {
250 DBG_DEBUG("%s had nothing to say\n", auth_method
->name
);
253 if (NT_STATUS_EQUAL(nt_status
, NT_STATUS_NOT_IMPLEMENTED
)) {
255 nt_status
= NT_STATUS_NO_SUCH_USER
;
258 if (!NT_STATUS_IS_OK(nt_status
)) {
259 DBG_INFO("%s authentication for user [%s] FAILED with "
260 "error %s, authoritative=%u\n",
262 user_info
->client
.account_name
,
263 nt_errstr(nt_status
),
268 DBG_NOTICE("%s authentication for user [%s] succeeded\n",
269 auth_method_name
, user_info
->client
.account_name
);
271 unix_username
= server_info
->unix_name
;
273 /* We skip doing this step if the caller asked us not to */
274 if (!(user_info
->flags
& USER_INFO_INFO3_AND_NO_AUTHZ
)
275 && !(server_info
->guest
)) {
278 if (tsocket_address_is_inet(user_info
->remote_host
, "ip")) {
279 rhost
= tsocket_address_inet_addr_string(
280 user_info
->remote_host
, talloc_tos());
282 nt_status
= NT_STATUS_NO_MEMORY
;
289 /* We might not be root if we are an RPC call */
291 nt_status
= smb_pam_accountcheck(unix_username
, rhost
);
294 if (NT_STATUS_IS_OK(nt_status
)) {
295 DEBUG(5, ("check_ntlm_password: PAM Account for user [%s] "
296 "succeeded\n", unix_username
));
298 DEBUG(3, ("check_ntlm_password: PAM Account for user [%s] "
299 "FAILED with error %s\n",
300 unix_username
, nt_errstr(nt_status
)));
304 if (!NT_STATUS_IS_OK(nt_status
)) {
308 nt_status
= get_user_sid_info3_and_extra(server_info
->info3
,
311 if (!NT_STATUS_IS_OK(nt_status
)) {
312 sid
= (struct dom_sid
) {0};
315 log_authentication_event(msg_ctx
,
317 &auth_context
->start_time
,
320 server_info
->info3
->base
.logon_domain
.string
,
321 server_info
->info3
->base
.account_name
.string
,
324 DEBUG(server_info
->guest
? 5 : 2,
325 ("check_ntlm_password: %sauthentication for user "
326 "[%s] -> [%s] -> [%s] succeeded\n",
327 server_info
->guest
? "guest " : "",
328 user_info
->client
.account_name
,
329 user_info
->mapped
.account_name
,
332 *pserver_info
= talloc_move(mem_ctx
, &server_info
);
339 /* failed authentication; check for guest lapping */
342 * Please try not to change this string, it is probably in use
343 * in audit logging tools
345 DEBUG(2, ("check_ntlm_password: Authentication for user "
346 "[%s] -> [%s] FAILED with error %s, authoritative=%u\n",
347 user_info
->client
.account_name
, user_info
->mapped
.account_name
,
348 nt_errstr(nt_status
), *pauthoritative
));
350 log_authentication_event(msg_ctx
,
352 &auth_context
->start_time
,
359 ZERO_STRUCTP(pserver_info
);
366 /***************************************************************************
367 Clear out a auth_context, and destroy the attached TALLOC_CTX
368 ***************************************************************************/
370 static int auth_context_destructor(void *ptr
)
372 struct auth_context
*ctx
= talloc_get_type(ptr
, struct auth_context
);
373 struct auth_methods
*am
;
376 /* Free private data of context's authentication methods */
377 for (am
= ctx
->auth_method_list
; am
; am
= am
->next
) {
378 TALLOC_FREE(am
->private_data
);
384 /***************************************************************************
385 Make a auth_info struct
386 ***************************************************************************/
388 static NTSTATUS
make_auth_context(TALLOC_CTX
*mem_ctx
,
389 struct auth_context
**auth_context
)
391 struct auth_context
*ctx
;
393 ctx
= talloc_zero(mem_ctx
, struct auth_context
);
395 DEBUG(0,("make_auth_context: talloc failed!\n"));
396 return NT_STATUS_NO_MEMORY
;
399 ctx
->start_time
= timeval_current();
401 talloc_set_destructor((TALLOC_CTX
*)ctx
, auth_context_destructor
);
407 static bool load_auth_module(
408 struct auth_context
*auth_context
,
410 struct auth_methods
**ret
)
412 static bool initialised_static_modules
= False
;
414 struct auth_init_function_entry
*entry
;
415 char *module_name
= smb_xstrdup(module
);
416 char *module_params
= NULL
;
420 /* Initialise static modules if not done so yet */
421 if(!initialised_static_modules
) {
422 static_init_auth(NULL
);
423 initialised_static_modules
= True
;
426 DEBUG(5,("load_auth_module: Attempting to find an auth method to match %s\n",
429 p
= strchr(module_name
, ':');
433 trim_char(module_params
, ' ', ' ');
436 trim_char(module_name
, ' ', ' ');
438 entry
= auth_find_backend_entry(module_name
);
441 if (NT_STATUS_IS_OK(smb_probe_module("auth", module_name
))) {
442 entry
= auth_find_backend_entry(module_name
);
447 if (!NT_STATUS_IS_OK(entry
->init(auth_context
, module_params
, ret
))) {
448 DEBUG(0,("load_auth_module: auth method %s did not correctly init\n",
451 DEBUG(5,("load_auth_module: auth method %s has a valid init\n",
456 DEBUG(0,("load_auth_module: can't find auth method %s!\n", module_name
));
459 SAFE_FREE(module_name
);
463 /***************************************************************************
464 Make a auth_info struct for the auth subsystem
465 ***************************************************************************/
467 static NTSTATUS
make_auth_context_text_list(TALLOC_CTX
*mem_ctx
,
468 struct auth_context
**auth_context
,
471 struct auth_methods
*list
= NULL
;
472 struct auth_methods
*t
, *method
= NULL
;
476 DEBUG(2,("make_auth_context_text_list: No auth method list!?\n"));
477 return NT_STATUS_UNSUCCESSFUL
;
480 nt_status
= make_auth_context(mem_ctx
, auth_context
);
482 if (!NT_STATUS_IS_OK(nt_status
)) {
486 for (;*text_list
; text_list
++) {
487 if (load_auth_module(*auth_context
, *text_list
, &t
)) {
488 DLIST_ADD_END(list
, t
);
492 (*auth_context
)->auth_method_list
= list
;
494 /* Look for the first module to provide a prepare_gensec and
495 * make_auth4_context hook, and set that if provided */
496 for (method
= (*auth_context
)->auth_method_list
; method
; method
= method
->next
) {
497 if (method
->prepare_gensec
&& method
->make_auth4_context
) {
498 (*auth_context
)->prepare_gensec
= method
->prepare_gensec
;
499 (*auth_context
)->make_auth4_context
= method
->make_auth4_context
;
506 static NTSTATUS
make_auth_context_specific(TALLOC_CTX
*mem_ctx
,
507 struct auth_context
**auth_context
,
513 method_list
= str_list_make_v3(talloc_tos(), methods
, NULL
);
514 if (method_list
== NULL
) {
515 return NT_STATUS_NO_MEMORY
;
518 status
= make_auth_context_text_list(
519 mem_ctx
, auth_context
, method_list
);
521 TALLOC_FREE(method_list
);
526 /***************************************************************************
527 Make a auth_context struct for the auth subsystem
528 ***************************************************************************/
530 NTSTATUS
make_auth3_context_for_ntlm(TALLOC_CTX
*mem_ctx
,
531 struct auth_context
**auth_context
)
533 const char *methods
= NULL
;
534 const char *role
= NULL
;
536 switch (lp_server_role()) {
537 case ROLE_ACTIVE_DIRECTORY_DC
:
538 role
= "'active directory domain controller'";
541 case ROLE_DOMAIN_MEMBER
:
542 role
= "'domain member'";
543 methods
= "anonymous sam winbind sam_ignoredomain";
545 case ROLE_DOMAIN_BDC
:
546 case ROLE_DOMAIN_PDC
:
549 methods
= "anonymous sam winbind sam_ignoredomain";
551 case ROLE_STANDALONE
:
552 if (lp_encrypt_passwords()) {
553 role
= "'standalone server', encrypt passwords = yes";
554 methods
= "anonymous sam_ignoredomain";
556 role
= "'standalone server', encrypt passwords = no";
557 methods
= "anonymous unix";
561 DEBUG(5,("Unknown auth method!\n"));
562 return NT_STATUS_UNSUCCESSFUL
;
565 DBG_INFO("Making default auth method list for server role = %s\n",
568 return make_auth_context_specific(mem_ctx
, auth_context
, methods
);
571 NTSTATUS
make_auth3_context_for_netlogon(TALLOC_CTX
*mem_ctx
,
572 struct auth_context
**auth_context
)
574 const char *methods
= NULL
;
576 switch (lp_server_role()) {
577 case ROLE_DOMAIN_BDC
:
578 case ROLE_DOMAIN_PDC
:
580 methods
= "sam_netlogon3 winbind";
584 DBG_ERR("Invalid server role!\n");
585 return NT_STATUS_INVALID_SERVER_STATE
;
588 return make_auth_context_specific(mem_ctx
, auth_context
, methods
);
591 NTSTATUS
make_auth3_context_for_winbind(TALLOC_CTX
*mem_ctx
,
592 struct auth_context
**auth_context
)
594 const char *methods
= NULL
;
596 switch (lp_server_role()) {
597 case ROLE_STANDALONE
:
598 case ROLE_DOMAIN_MEMBER
:
599 case ROLE_DOMAIN_BDC
:
600 case ROLE_DOMAIN_PDC
:
604 case ROLE_ACTIVE_DIRECTORY_DC
:
605 methods
= "samba4:sam";
608 DEBUG(5,("Unknown auth method!\n"));
609 return NT_STATUS_UNSUCCESSFUL
;
612 return make_auth_context_specific(mem_ctx
, auth_context
, methods
);
615 bool auth3_context_set_challenge(
616 struct auth_context
*ctx
,
617 const uint8_t chal
[8],
618 const char *challenge_set_by
)
620 ctx
->challenge
= data_blob_talloc(ctx
, chal
, 8);
621 if (ctx
->challenge
.data
== NULL
) {
624 ctx
->challenge_set_by
= talloc_strdup(ctx
, challenge_set_by
);
625 if (ctx
->challenge_set_by
== NULL
) {