winbindd: queryuser - only get group name if needed
[Samba.git] / source3 / auth / auth.c
blob54e9433c2d3b579469b19dd54fb305e91296623e
1 /*
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/>.
20 #include "includes.h"
21 #include "auth.h"
22 #include "../lib/tsocket/tsocket.h"
24 #undef DBGC_CLASS
25 #define DBGC_CLASS DBGC_AUTH
27 static_decl_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;
44 if (!name || !init) {
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);
57 entry->init = init;
59 DLIST_ADD(auth_backends, entry);
60 DEBUG(5,("Successfully added auth method '%s'\n", name));
61 return NT_STATUS_OK;
64 static struct auth_init_function_entry *auth_find_backend_entry(const char *name)
66 struct auth_init_function_entry *entry = auth_backends;
68 while(entry) {
69 if (strcmp(entry->name, name)==0) return entry;
70 entry = entry->next;
73 return NULL;
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,
82 uint8_t chal[8])
84 uchar tmp[8];
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);
91 return NT_STATUS_OK;
94 generate_random_buffer(tmp, sizeof(tmp));
95 auth_context->challenge = data_blob_talloc(auth_context,
96 tmp, sizeof(tmp));
98 auth_context->challenge_set_by = "random";
100 memcpy(chal, auth_context->challenge.data, 8);
101 return NT_STATUS_OK;
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,
113 * False otherwise.
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));
129 return False;
130 } else {
131 return True;
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
160 * result.
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)
171 TALLOC_CTX *frame;
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();
186 *pauthoritative = 1;
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;
197 goto fail;
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);
214 #endif
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;
220 goto fail;
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,
229 talloc_tos(),
230 user_info,
231 &server_info);
233 if (!NT_STATUS_EQUAL(nt_status, NT_STATUS_NOT_IMPLEMENTED)) {
234 break;
237 DBG_DEBUG("%s had nothing to say\n", auth_method->name);
240 if (NT_STATUS_EQUAL(nt_status, NT_STATUS_NOT_IMPLEMENTED)) {
241 *pauthoritative = 0;
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",
248 auth_method_name,
249 user_info->client.account_name,
250 nt_errstr(nt_status),
251 *pauthoritative);
252 goto fail;
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)) {
263 const char *rhost;
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());
268 if (rhost == NULL) {
269 nt_status = NT_STATUS_NO_MEMORY;
270 goto fail;
272 } else {
273 rhost = "127.0.0.1";
276 /* We might not be root if we are an RPC call */
277 become_root();
278 nt_status = smb_pam_accountcheck(unix_username, rhost);
279 unbecome_root();
281 if (NT_STATUS_IS_OK(nt_status)) {
282 DEBUG(5, ("check_ntlm_password: PAM Account for user [%s] "
283 "succeeded\n", unix_username));
284 } else {
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)) {
292 goto fail;
295 nt_status = get_user_sid_info3_and_extra(server_info->info3,
296 &server_info->extra,
297 &sid);
298 if (!NT_STATUS_IS_OK(nt_status)) {
299 sid = (struct dom_sid) {0};
302 log_authentication_event(NULL, NULL,
303 user_info, nt_status,
304 server_info->info3->base.logon_domain.string,
305 server_info->info3->base.account_name.string,
306 unix_username, &sid);
308 DEBUG(server_info->guest ? 5 : 2,
309 ("check_ntlm_password: %sauthentication for user "
310 "[%s] -> [%s] -> [%s] succeeded\n",
311 server_info->guest ? "guest " : "",
312 user_info->client.account_name,
313 user_info->mapped.account_name,
314 unix_username));
316 *pserver_info = talloc_move(mem_ctx, &server_info);
318 TALLOC_FREE(frame);
319 return NT_STATUS_OK;
321 fail:
323 /* failed authentication; check for guest lapping */
326 * Please try not to change this string, it is probably in use
327 * in audit logging tools
329 DEBUG(2, ("check_ntlm_password: Authentication for user "
330 "[%s] -> [%s] FAILED with error %s, authoritative=%u\n",
331 user_info->client.account_name, user_info->mapped.account_name,
332 nt_errstr(nt_status), *pauthoritative));
334 log_authentication_event(NULL, NULL, user_info, nt_status, NULL, NULL, NULL, NULL);
336 ZERO_STRUCTP(pserver_info);
338 TALLOC_FREE(frame);
340 return nt_status;
343 /***************************************************************************
344 Clear out a auth_context, and destroy the attached TALLOC_CTX
345 ***************************************************************************/
347 static int auth_context_destructor(void *ptr)
349 struct auth_context *ctx = talloc_get_type(ptr, struct auth_context);
350 struct auth_methods *am;
353 /* Free private data of context's authentication methods */
354 for (am = ctx->auth_method_list; am; am = am->next) {
355 TALLOC_FREE(am->private_data);
358 return 0;
361 /***************************************************************************
362 Make a auth_info struct
363 ***************************************************************************/
365 static NTSTATUS make_auth_context(TALLOC_CTX *mem_ctx,
366 struct auth_context **auth_context)
368 struct auth_context *ctx;
370 ctx = talloc_zero(mem_ctx, struct auth_context);
371 if (!ctx) {
372 DEBUG(0,("make_auth_context: talloc failed!\n"));
373 return NT_STATUS_NO_MEMORY;
376 talloc_set_destructor((TALLOC_CTX *)ctx, auth_context_destructor);
378 *auth_context = ctx;
379 return NT_STATUS_OK;
382 bool load_auth_module(struct auth_context *auth_context,
383 const char *module, auth_methods **ret)
385 static bool initialised_static_modules = False;
387 struct auth_init_function_entry *entry;
388 char *module_name = smb_xstrdup(module);
389 char *module_params = NULL;
390 char *p;
391 bool good = False;
393 /* Initialise static modules if not done so yet */
394 if(!initialised_static_modules) {
395 static_init_auth(NULL);
396 initialised_static_modules = True;
399 DEBUG(5,("load_auth_module: Attempting to find an auth method to match %s\n",
400 module));
402 p = strchr(module_name, ':');
403 if (p) {
404 *p = 0;
405 module_params = p+1;
406 trim_char(module_params, ' ', ' ');
409 trim_char(module_name, ' ', ' ');
411 entry = auth_find_backend_entry(module_name);
413 if (entry == NULL) {
414 if (NT_STATUS_IS_OK(smb_probe_module("auth", module_name))) {
415 entry = auth_find_backend_entry(module_name);
419 if (entry != NULL) {
420 if (!NT_STATUS_IS_OK(entry->init(auth_context, module_params, ret))) {
421 DEBUG(0,("load_auth_module: auth method %s did not correctly init\n",
422 module_name));
423 } else {
424 DEBUG(5,("load_auth_module: auth method %s has a valid init\n",
425 module_name));
426 good = True;
428 } else {
429 DEBUG(0,("load_auth_module: can't find auth method %s!\n", module_name));
432 SAFE_FREE(module_name);
433 return good;
436 /***************************************************************************
437 Make a auth_info struct for the auth subsystem
438 ***************************************************************************/
440 static NTSTATUS make_auth_context_text_list(TALLOC_CTX *mem_ctx,
441 struct auth_context **auth_context,
442 char **text_list)
444 auth_methods *list = NULL;
445 auth_methods *t, *method = NULL;
446 NTSTATUS nt_status;
448 if (!text_list) {
449 DEBUG(2,("make_auth_context_text_list: No auth method list!?\n"));
450 return NT_STATUS_UNSUCCESSFUL;
453 nt_status = make_auth_context(mem_ctx, auth_context);
455 if (!NT_STATUS_IS_OK(nt_status)) {
456 return nt_status;
459 for (;*text_list; text_list++) {
460 if (load_auth_module(*auth_context, *text_list, &t)) {
461 DLIST_ADD_END(list, t);
465 (*auth_context)->auth_method_list = list;
467 /* Look for the first module to provide a prepare_gensec and
468 * make_auth4_context hook, and set that if provided */
469 for (method = (*auth_context)->auth_method_list; method; method = method->next) {
470 if (method->prepare_gensec && method->make_auth4_context) {
471 (*auth_context)->prepare_gensec = method->prepare_gensec;
472 (*auth_context)->make_auth4_context = method->make_auth4_context;
473 break;
476 return NT_STATUS_OK;
479 static NTSTATUS make_auth_context_specific(TALLOC_CTX *mem_ctx,
480 struct auth_context **auth_context,
481 const char *methods)
483 char **method_list;
484 NTSTATUS status;
486 method_list = str_list_make_v3(talloc_tos(), methods, NULL);
487 if (method_list == NULL) {
488 return NT_STATUS_NO_MEMORY;
491 status = make_auth_context_text_list(
492 mem_ctx, auth_context, method_list);
494 TALLOC_FREE(method_list);
496 return status;
499 /***************************************************************************
500 Make a auth_context struct for the auth subsystem
501 ***************************************************************************/
503 NTSTATUS make_auth3_context_for_ntlm(TALLOC_CTX *mem_ctx,
504 struct auth_context **auth_context)
506 const char *methods = NULL;
507 NTSTATUS nt_status;
509 switch (lp_server_role()) {
510 case ROLE_ACTIVE_DIRECTORY_DC:
511 DEBUG(5,("Making default auth method list for server role = "
512 "'active directory domain controller'\n"));
513 return make_auth_context_specific(mem_ctx, auth_context, "samba4");
514 default:
515 break;
518 if (lp_auth_methods()) {
519 DEBUG(5,("Using specified auth order\n"));
520 nt_status = make_auth_context_text_list(
521 mem_ctx, auth_context,
522 discard_const_p(char *, lp_auth_methods()));
523 return nt_status;
526 switch (lp_server_role()) {
527 case ROLE_DOMAIN_MEMBER:
528 DEBUG(5,("Making default auth method list for server role = 'domain member'\n"));
529 methods = "guest sam winbind:ntdomain sam_ignoredomain";
530 break;
531 case ROLE_DOMAIN_BDC:
532 case ROLE_DOMAIN_PDC:
533 DEBUG(5,("Making default auth method list for DC\n"));
534 methods = "guest sam winbind:trustdomain sam_ignoredomain";
535 break;
536 case ROLE_STANDALONE:
537 DEBUG(5,("Making default auth method list for server role = 'standalone server', encrypt passwords = yes\n"));
538 if (lp_encrypt_passwords()) {
539 methods = "guest sam_ignoredomain";
540 } else {
541 DEBUG(5,("Making default auth method list for server role = 'standalone server', encrypt passwords = no\n"));
542 methods = "guest unix";
544 break;
545 default:
546 DEBUG(5,("Unknown auth method!\n"));
547 return NT_STATUS_UNSUCCESSFUL;
550 return make_auth_context_specific(mem_ctx, auth_context, methods);
553 NTSTATUS make_auth3_context_for_netlogon(TALLOC_CTX *mem_ctx,
554 struct auth_context **auth_context)
556 const char *methods = NULL;
557 NTSTATUS nt_status;
560 * We do the lp_auth_methods check before
561 * the lp_server_role check in order to
562 * backward compatible. The "auth methods" option
563 * is deprecated now, so this will go away in a future
564 * release.
566 if (lp_auth_methods()) {
567 DBG_INFO("Using specified auth order for netlogon\n");
568 nt_status = make_auth_context_text_list(
569 mem_ctx, auth_context,
570 discard_const_p(char *, lp_auth_methods()));
571 return nt_status;
574 switch (lp_server_role()) {
575 case ROLE_DOMAIN_BDC:
576 case ROLE_DOMAIN_PDC:
577 methods = "sam_netlogon3 winbind:trustdomain";
578 break;
580 default:
581 DBG_ERR("Invalid server role!\n");
582 return NT_STATUS_INVALID_SERVER_STATE;
585 return make_auth_context_specific(mem_ctx, auth_context, methods);
588 NTSTATUS make_auth3_context_for_winbind(TALLOC_CTX *mem_ctx,
589 struct auth_context **auth_context)
591 const char *methods = NULL;
593 switch (lp_server_role()) {
594 case ROLE_STANDALONE:
595 case ROLE_DOMAIN_MEMBER:
596 case ROLE_DOMAIN_BDC:
597 case ROLE_DOMAIN_PDC:
598 methods = "sam";
599 break;
600 case ROLE_ACTIVE_DIRECTORY_DC:
601 methods = "samba4:sam";
602 break;
603 default:
604 DEBUG(5,("Unknown auth method!\n"));
605 return NT_STATUS_UNSUCCESSFUL;
608 return make_auth_context_specific(mem_ctx, auth_context, methods);
611 bool auth3_context_set_challenge(struct auth_context *ctx, uint8_t chal[8],
612 const char *challenge_set_by)
614 ctx->challenge = data_blob_talloc(ctx, chal, 8);
615 if (ctx->challenge.data == NULL) {
616 return false;
618 ctx->challenge_set_by = talloc_strdup(ctx, challenge_set_by);
619 if (ctx->challenge_set_by == NULL) {
620 return false;
622 return true;