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;
179 if (user_info == NULL || auth_context == NULL || pserver_info == NULL) {
180 return NT_STATUS_LOGON_FAILURE;
183 frame = talloc_stackframe();
187 DEBUG(3, ("check_ntlm_password: Checking password for unmapped user [%s]\\[%s]@[%s] with the new password interface\n",
188 user_info->client.domain_name, user_info->client.account_name, user_info->workstation_name));
190 DEBUG(3, ("check_ntlm_password: mapped user is: [%s]\\[%s]@[%s]\n",
191 user_info->mapped.domain_name, user_info->mapped.account_name, user_info->workstation_name));
193 if (auth_context->challenge.length != 8) {
194 DEBUG(0, ("check_ntlm_password: Invalid challenge stored for this auth context - cannot continue\n"));
195 nt_status = NT_STATUS_LOGON_FAILURE;
199 if (auth_context->challenge_set_by)
200 DEBUG(10, ("check_ntlm_password: auth_context challenge created by %s\n",
201 auth_context->challenge_set_by));
203 DEBUG(10, ("challenge is: \n"));
204 dump_data(5, auth_context->challenge.data, auth_context->challenge.length);
206 #ifdef DEBUG_PASSWORD
207 DEBUG(100, ("user_info has passwords of length %d and %d\n",
208 (int)user_info->password.response.lanman.length, (int)user_info->password.response.nt.length));
209 DEBUG(100, ("lm:\n"));
210 dump_data(100, user_info->password.response.lanman.data, user_info->password.response.lanman.length);
211 DEBUG(100, ("nt:\n"));
212 dump_data(100, user_info->password.response.nt.data, user_info->password.response.nt.length);
215 /* This needs to be sorted: If it doesn't match, what should we do? */
216 if (!check_domain_match(user_info->client.account_name,
217 user_info->mapped.domain_name)) {
218 nt_status = NT_STATUS_LOGON_FAILURE;
222 for (auth_method = auth_context->auth_method_list;auth_method; auth_method = auth_method->next) {
224 auth_method_name = auth_method->name;
226 if (user_info->flags & USER_INFO_LOCAL_SAM_ONLY
227 && !(auth_method->flags & AUTH_METHOD_LOCAL_SAM)) {
231 nt_status = auth_method->auth(auth_context,
232 auth_method->private_data,
237 if (!NT_STATUS_EQUAL(nt_status, NT_STATUS_NOT_IMPLEMENTED)) {
241 DBG_DEBUG("%s had nothing to say\n", auth_method->name);
244 if (NT_STATUS_EQUAL(nt_status, NT_STATUS_NOT_IMPLEMENTED)) {
246 nt_status = NT_STATUS_NO_SUCH_USER;
249 if (!NT_STATUS_IS_OK(nt_status)) {
250 DBG_INFO("%s authentication for user [%s] FAILED with "
251 "error %s, authoritative=%u\n",
253 user_info->client.account_name,
254 nt_errstr(nt_status),
259 DBG_NOTICE("%s authentication for user [%s] succeeded\n",
260 auth_method_name, user_info->client.account_name);
262 unix_username = server_info->unix_name;
264 /* We skip doing this step if the caller asked us not to */
265 if (!(user_info->flags & USER_INFO_INFO3_AND_NO_AUTHZ)
266 && !(server_info->guest)) {
269 if (tsocket_address_is_inet(user_info->remote_host, "ip")) {
270 rhost = tsocket_address_inet_addr_string(
271 user_info->remote_host, talloc_tos());
273 nt_status = NT_STATUS_NO_MEMORY;
280 /* We might not be root if we are an RPC call */
282 nt_status = smb_pam_accountcheck(unix_username, rhost);
285 if (NT_STATUS_IS_OK(nt_status)) {
286 DEBUG(5, ("check_ntlm_password: PAM Account for user [%s] "
287 "succeeded\n", unix_username));
289 DEBUG(3, ("check_ntlm_password: PAM Account for user [%s] "
290 "FAILED with error %s\n",
291 unix_username, nt_errstr(nt_status)));
295 if (!NT_STATUS_IS_OK(nt_status)) {
299 DEBUG(server_info->guest ? 5 : 2,
300 ("check_ntlm_password: %sauthentication for user "
301 "[%s] -> [%s] -> [%s] succeeded\n",
302 server_info->guest ? "guest " : "",
303 user_info->client.account_name,
304 user_info->mapped.account_name,
307 *pserver_info = talloc_move(mem_ctx, &server_info);
314 /* failed authentication; check for guest lapping */
316 DEBUG(2, ("check_ntlm_password: Authentication for user "
317 "[%s] -> [%s] FAILED with error %s, authoritative=%u\n",
318 user_info->client.account_name, user_info->mapped.account_name,
319 nt_errstr(nt_status), *pauthoritative));
320 ZERO_STRUCTP(pserver_info);
327 /***************************************************************************
328 Clear out a auth_context, and destroy the attached TALLOC_CTX
329 ***************************************************************************/
331 static int auth_context_destructor(void *ptr)
333 struct auth_context *ctx = talloc_get_type(ptr, struct auth_context);
334 struct auth_methods *am;
337 /* Free private data of context's authentication methods */
338 for (am = ctx->auth_method_list; am; am = am->next) {
339 TALLOC_FREE(am->private_data);
345 /***************************************************************************
346 Make a auth_info struct
347 ***************************************************************************/
349 static NTSTATUS make_auth_context(TALLOC_CTX *mem_ctx,
350 struct auth_context **auth_context)
352 struct auth_context *ctx;
354 ctx = talloc_zero(mem_ctx, struct auth_context);
356 DEBUG(0,("make_auth_context: talloc failed!\n"));
357 return NT_STATUS_NO_MEMORY;
360 talloc_set_destructor((TALLOC_CTX *)ctx, auth_context_destructor);
366 bool load_auth_module(struct auth_context *auth_context,
367 const char *module, auth_methods **ret)
369 static bool initialised_static_modules = False;
371 struct auth_init_function_entry *entry;
372 char *module_name = smb_xstrdup(module);
373 char *module_params = NULL;
377 /* Initialise static modules if not done so yet */
378 if(!initialised_static_modules) {
380 initialised_static_modules = True;
383 DEBUG(5,("load_auth_module: Attempting to find an auth method to match %s\n",
386 p = strchr(module_name, ':');
390 trim_char(module_params, ' ', ' ');
393 trim_char(module_name, ' ', ' ');
395 entry = auth_find_backend_entry(module_name);
398 if (NT_STATUS_IS_OK(smb_probe_module("auth", module_name))) {
399 entry = auth_find_backend_entry(module_name);
404 if (!NT_STATUS_IS_OK(entry->init(auth_context, module_params, ret))) {
405 DEBUG(0,("load_auth_module: auth method %s did not correctly init\n",
408 DEBUG(5,("load_auth_module: auth method %s has a valid init\n",
413 DEBUG(0,("load_auth_module: can't find auth method %s!\n", module_name));
416 SAFE_FREE(module_name);
420 /***************************************************************************
421 Make a auth_info struct for the auth subsystem
422 ***************************************************************************/
424 static NTSTATUS make_auth_context_text_list(TALLOC_CTX *mem_ctx,
425 struct auth_context **auth_context,
428 auth_methods *list = NULL;
429 auth_methods *t, *method = NULL;
433 DEBUG(2,("make_auth_context_text_list: No auth method list!?\n"));
434 return NT_STATUS_UNSUCCESSFUL;
437 nt_status = make_auth_context(mem_ctx, auth_context);
439 if (!NT_STATUS_IS_OK(nt_status)) {
443 for (;*text_list; text_list++) {
444 if (load_auth_module(*auth_context, *text_list, &t)) {
445 DLIST_ADD_END(list, t);
449 (*auth_context)->auth_method_list = list;
451 /* Look for the first module to provide a prepare_gensec and
452 * make_auth4_context hook, and set that if provided */
453 for (method = (*auth_context)->auth_method_list; method; method = method->next) {
454 if (method->prepare_gensec && method->make_auth4_context) {
455 (*auth_context)->prepare_gensec = method->prepare_gensec;
456 (*auth_context)->make_auth4_context = method->make_auth4_context;
463 static NTSTATUS make_auth_context_specific(TALLOC_CTX *mem_ctx,
464 struct auth_context **auth_context,
470 method_list = str_list_make_v3(talloc_tos(), methods, NULL);
471 if (method_list == NULL) {
472 return NT_STATUS_NO_MEMORY;
475 status = make_auth_context_text_list(
476 mem_ctx, auth_context, method_list);
478 TALLOC_FREE(method_list);
483 /***************************************************************************
484 Make a auth_context struct for the auth subsystem
485 ***************************************************************************/
487 static NTSTATUS make_auth_context_subsystem(TALLOC_CTX *mem_ctx,
488 struct auth_context **auth_context)
490 const char *methods = NULL;
493 if (lp_auth_methods()) {
494 DEBUG(5,("Using specified auth order\n"));
495 nt_status = make_auth_context_text_list(
496 mem_ctx, auth_context,
497 discard_const_p(char *, lp_auth_methods()));
501 switch (lp_server_role()) {
502 case ROLE_DOMAIN_MEMBER:
503 DEBUG(5,("Making default auth method list for server role = 'domain member'\n"));
504 methods = "guest sam winbind:ntdomain";
506 case ROLE_DOMAIN_BDC:
507 case ROLE_DOMAIN_PDC:
508 DEBUG(5,("Making default auth method list for DC\n"));
509 methods = "guest sam winbind:trustdomain";
511 case ROLE_STANDALONE:
512 DEBUG(5,("Making default auth method list for server role = 'standalone server', encrypt passwords = yes\n"));
513 if (lp_encrypt_passwords()) {
514 methods = "guest sam";
516 DEBUG(5,("Making default auth method list for server role = 'standalone server', encrypt passwords = no\n"));
517 methods = "guest unix";
520 case ROLE_ACTIVE_DIRECTORY_DC:
521 DEBUG(5,("Making default auth method list for server role = 'active directory domain controller'\n"));
525 DEBUG(5,("Unknown auth method!\n"));
526 return NT_STATUS_UNSUCCESSFUL;
529 return make_auth_context_specific(mem_ctx, auth_context, methods);
532 NTSTATUS make_auth3_context_for_ntlm(TALLOC_CTX *mem_ctx,
533 struct auth_context **auth_context)
535 return make_auth_context_subsystem(mem_ctx, auth_context);
538 NTSTATUS make_auth3_context_for_netlogon(TALLOC_CTX *mem_ctx,
539 struct auth_context **auth_context)
541 return make_auth_context_subsystem(mem_ctx, auth_context);
544 NTSTATUS make_auth3_context_for_winbind(TALLOC_CTX *mem_ctx,
545 struct auth_context **auth_context)
547 const char *methods = NULL;
549 switch (lp_server_role()) {
550 case ROLE_STANDALONE:
551 case ROLE_DOMAIN_MEMBER:
552 case ROLE_DOMAIN_BDC:
553 case ROLE_DOMAIN_PDC:
556 case ROLE_ACTIVE_DIRECTORY_DC:
557 methods = "samba4:sam";
560 DEBUG(5,("Unknown auth method!\n"));
561 return NT_STATUS_UNSUCCESSFUL;
564 return make_auth_context_specific(mem_ctx, auth_context, methods);
567 bool auth3_context_set_challenge(struct auth_context *ctx, uint8_t chal[8],
568 const char *challenge_set_by)
570 ctx->challenge = data_blob_talloc(ctx, chal, 8);
571 if (ctx->challenge.data == NULL) {
574 ctx->challenge_set_by = talloc_strdup(ctx, challenge_set_by);
575 if (ctx->challenge_set_by == NULL) {