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 server_info If successful, contains information about the authentication,
157 * including a struct samu struct describing the user.
159 * @return An NTSTATUS with NT_STATUS_OK or an appropriate error.
163 NTSTATUS auth_check_ntlm_password(TALLOC_CTX *mem_ctx,
164 const struct auth_context *auth_context,
165 const struct auth_usersupplied_info *user_info,
166 struct auth_serversupplied_info **pserver_info)
169 /* if all the modules say 'not for me' this is reasonable */
170 NTSTATUS nt_status = NT_STATUS_NO_SUCH_USER;
171 const char *unix_username;
172 auth_methods *auth_method;
173 struct auth_serversupplied_info *server_info;
175 if (user_info == NULL || auth_context == NULL || pserver_info == NULL) {
176 return NT_STATUS_LOGON_FAILURE;
179 frame = talloc_stackframe();
181 DEBUG(3, ("check_ntlm_password: Checking password for unmapped user [%s]\\[%s]@[%s] with the new password interface\n",
182 user_info->client.domain_name, user_info->client.account_name, user_info->workstation_name));
184 DEBUG(3, ("check_ntlm_password: mapped user is: [%s]\\[%s]@[%s]\n",
185 user_info->mapped.domain_name, user_info->mapped.account_name, user_info->workstation_name));
187 if (auth_context->challenge.length != 8) {
188 DEBUG(0, ("check_ntlm_password: Invalid challenge stored for this auth context - cannot continue\n"));
189 nt_status = NT_STATUS_LOGON_FAILURE;
193 if (auth_context->challenge_set_by)
194 DEBUG(10, ("check_ntlm_password: auth_context challenge created by %s\n",
195 auth_context->challenge_set_by));
197 DEBUG(10, ("challenge is: \n"));
198 dump_data(5, auth_context->challenge.data, auth_context->challenge.length);
200 #ifdef DEBUG_PASSWORD
201 DEBUG(100, ("user_info has passwords of length %d and %d\n",
202 (int)user_info->password.response.lanman.length, (int)user_info->password.response.nt.length));
203 DEBUG(100, ("lm:\n"));
204 dump_data(100, user_info->password.response.lanman.data, user_info->password.response.lanman.length);
205 DEBUG(100, ("nt:\n"));
206 dump_data(100, user_info->password.response.nt.data, user_info->password.response.nt.length);
209 /* This needs to be sorted: If it doesn't match, what should we do? */
210 if (!check_domain_match(user_info->client.account_name,
211 user_info->mapped.domain_name)) {
212 nt_status = NT_STATUS_LOGON_FAILURE;
216 for (auth_method = auth_context->auth_method_list;auth_method; auth_method = auth_method->next) {
219 if (user_info->flags & USER_INFO_LOCAL_SAM_ONLY
220 && !(auth_method->flags & AUTH_METHOD_LOCAL_SAM)) {
224 result = auth_method->auth(auth_context,
225 auth_method->private_data,
230 /* check if the module did anything */
231 if (NT_STATUS_EQUAL(result, NT_STATUS_NOT_IMPLEMENTED)) {
232 DEBUG(10,("check_ntlm_password: %s had nothing to say\n", auth_method->name));
233 if (user_info->flags & USER_INFO_LOCAL_SAM_ONLY) {
234 /* we don't expose the NT_STATUS_NOT_IMPLEMENTED
235 * internals, except when the caller is only probing
236 * one method, as they may do the fallback
245 if (NT_STATUS_IS_OK(nt_status)) {
246 DEBUG(3, ("check_ntlm_password: %s authentication for user [%s] succeeded\n",
247 auth_method->name, user_info->client.account_name));
249 DEBUG(5, ("check_ntlm_password: %s authentication for user [%s] FAILED with error %s\n",
250 auth_method->name, user_info->client.account_name, nt_errstr(nt_status)));
253 if (NT_STATUS_IS_OK(nt_status)) {
258 /* successful authentication */
260 if (!NT_STATUS_IS_OK(nt_status)) {
264 unix_username = server_info->unix_name;
266 /* We skip doing this step if the caller asked us not to */
267 if (!(user_info->flags & USER_INFO_INFO3_AND_NO_AUTHZ)
268 && !(server_info->guest)) {
271 if (tsocket_address_is_inet(user_info->remote_host, "ip")) {
272 rhost = tsocket_address_inet_addr_string(
273 user_info->remote_host, talloc_tos());
275 nt_status = NT_STATUS_NO_MEMORY;
282 /* We might not be root if we are an RPC call */
284 nt_status = smb_pam_accountcheck(unix_username, rhost);
287 if (NT_STATUS_IS_OK(nt_status)) {
288 DEBUG(5, ("check_ntlm_password: PAM Account for user [%s] "
289 "succeeded\n", unix_username));
291 DEBUG(3, ("check_ntlm_password: PAM Account for user [%s] "
292 "FAILED with error %s\n",
293 unix_username, nt_errstr(nt_status)));
297 if (!NT_STATUS_IS_OK(nt_status)) {
301 DEBUG(server_info->guest ? 5 : 2,
302 ("check_ntlm_password: %sauthentication for user "
303 "[%s] -> [%s] -> [%s] succeeded\n",
304 server_info->guest ? "guest " : "",
305 user_info->client.account_name,
306 user_info->mapped.account_name,
309 *pserver_info = talloc_move(mem_ctx, &server_info);
316 /* failed authentication; check for guest lapping */
318 DEBUG(2, ("check_ntlm_password: Authentication for user [%s] -> [%s] FAILED with error %s\n",
319 user_info->client.account_name, user_info->mapped.account_name,
320 nt_errstr(nt_status)));
321 ZERO_STRUCTP(pserver_info);
328 /***************************************************************************
329 Clear out a auth_context, and destroy the attached TALLOC_CTX
330 ***************************************************************************/
332 static int auth_context_destructor(void *ptr)
334 struct auth_context *ctx = talloc_get_type(ptr, struct auth_context);
335 struct auth_methods *am;
338 /* Free private data of context's authentication methods */
339 for (am = ctx->auth_method_list; am; am = am->next) {
340 TALLOC_FREE(am->private_data);
346 /***************************************************************************
347 Make a auth_info struct
348 ***************************************************************************/
350 static NTSTATUS make_auth_context(TALLOC_CTX *mem_ctx,
351 struct auth_context **auth_context)
353 struct auth_context *ctx;
355 ctx = talloc_zero(mem_ctx, struct auth_context);
357 DEBUG(0,("make_auth_context: talloc failed!\n"));
358 return NT_STATUS_NO_MEMORY;
361 talloc_set_destructor((TALLOC_CTX *)ctx, auth_context_destructor);
367 bool load_auth_module(struct auth_context *auth_context,
368 const char *module, auth_methods **ret)
370 static bool initialised_static_modules = False;
372 struct auth_init_function_entry *entry;
373 char *module_name = smb_xstrdup(module);
374 char *module_params = NULL;
378 /* Initialise static modules if not done so yet */
379 if(!initialised_static_modules) {
381 initialised_static_modules = True;
384 DEBUG(5,("load_auth_module: Attempting to find an auth method to match %s\n",
387 p = strchr(module_name, ':');
391 trim_char(module_params, ' ', ' ');
394 trim_char(module_name, ' ', ' ');
396 entry = auth_find_backend_entry(module_name);
399 if (NT_STATUS_IS_OK(smb_probe_module("auth", module_name))) {
400 entry = auth_find_backend_entry(module_name);
405 if (!NT_STATUS_IS_OK(entry->init(auth_context, module_params, ret))) {
406 DEBUG(0,("load_auth_module: auth method %s did not correctly init\n",
409 DEBUG(5,("load_auth_module: auth method %s has a valid init\n",
414 DEBUG(0,("load_auth_module: can't find auth method %s!\n", module_name));
417 SAFE_FREE(module_name);
421 /***************************************************************************
422 Make a auth_info struct for the auth subsystem
423 ***************************************************************************/
425 static NTSTATUS make_auth_context_text_list(TALLOC_CTX *mem_ctx,
426 struct auth_context **auth_context,
429 auth_methods *list = NULL;
430 auth_methods *t, *method = NULL;
434 DEBUG(2,("make_auth_context_text_list: No auth method list!?\n"));
435 return NT_STATUS_UNSUCCESSFUL;
438 nt_status = make_auth_context(mem_ctx, auth_context);
440 if (!NT_STATUS_IS_OK(nt_status)) {
444 for (;*text_list; text_list++) {
445 if (load_auth_module(*auth_context, *text_list, &t)) {
446 DLIST_ADD_END(list, t);
450 (*auth_context)->auth_method_list = list;
452 /* Look for the first module to provide a prepare_gensec and
453 * make_auth4_context hook, and set that if provided */
454 for (method = (*auth_context)->auth_method_list; method; method = method->next) {
455 if (method->prepare_gensec && method->make_auth4_context) {
456 (*auth_context)->prepare_gensec = method->prepare_gensec;
457 (*auth_context)->make_auth4_context = method->make_auth4_context;
464 static NTSTATUS make_auth_context_specific(TALLOC_CTX *mem_ctx,
465 struct auth_context **auth_context,
471 method_list = str_list_make_v3(talloc_tos(), methods, NULL);
472 if (method_list == NULL) {
473 return NT_STATUS_NO_MEMORY;
476 status = make_auth_context_text_list(
477 mem_ctx, auth_context, method_list);
479 TALLOC_FREE(method_list);
484 /***************************************************************************
485 Make a auth_context struct for the auth subsystem
486 ***************************************************************************/
488 NTSTATUS make_auth_context_subsystem(TALLOC_CTX *mem_ctx,
489 struct auth_context **auth_context)
491 const char *methods = NULL;
494 if (lp_auth_methods()) {
495 DEBUG(5,("Using specified auth order\n"));
496 nt_status = make_auth_context_text_list(
497 mem_ctx, auth_context,
498 discard_const_p(char *, lp_auth_methods()));
502 switch (lp_server_role()) {
503 case ROLE_DOMAIN_MEMBER:
504 DEBUG(5,("Making default auth method list for server role = 'domain member'\n"));
505 methods = "guest sam winbind:ntdomain";
507 case ROLE_DOMAIN_BDC:
508 case ROLE_DOMAIN_PDC:
509 DEBUG(5,("Making default auth method list for DC\n"));
510 methods = "guest sam winbind:trustdomain";
512 case ROLE_STANDALONE:
513 DEBUG(5,("Making default auth method list for server role = 'standalone server', encrypt passwords = yes\n"));
514 if (lp_encrypt_passwords()) {
515 methods = "guest sam";
517 DEBUG(5,("Making default auth method list for server role = 'standalone server', encrypt passwords = no\n"));
518 methods = "guest unix";
521 case ROLE_ACTIVE_DIRECTORY_DC:
522 DEBUG(5,("Making default auth method list for server role = 'active directory domain controller'\n"));
526 DEBUG(5,("Unknown auth method!\n"));
527 return NT_STATUS_UNSUCCESSFUL;
530 return make_auth_context_specific(mem_ctx, auth_context, methods);
533 /***************************************************************************
534 Make a auth_info struct with a fixed challenge
535 ***************************************************************************/
537 NTSTATUS make_auth_context_fixed(TALLOC_CTX *mem_ctx,
538 struct auth_context **auth_context,
542 nt_status = make_auth_context_subsystem(mem_ctx, auth_context);
543 if (!NT_STATUS_IS_OK(nt_status)) {
547 (*auth_context)->challenge = data_blob_talloc(*auth_context, chal, 8);
548 (*auth_context)->challenge_set_by = "fixed";