s4:sam.c - make "authsam_expand_nested_groups" public
[Samba/nascimento.git] / source4 / auth / sam.c
blob20efc3684ab512d01698b8e97dee9fe2d7076344
1 /*
2 Unix SMB/CIFS implementation.
3 Password and authentication handling
4 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2001-2004
5 Copyright (C) Gerald Carter 2003
6 Copyright (C) Stefan Metzmacher 2005
7 Copyright (C) Matthias Dieter Wallnöfer 2009
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "includes.h"
24 #include "system/time.h"
25 #include "auth/auth.h"
26 #include <ldb.h>
27 #include "../lib/util/util_ldb.h"
28 #include "dsdb/samdb/samdb.h"
29 #include "libcli/security/security.h"
30 #include "libcli/ldap/ldap.h"
31 #include "../libcli/ldap/ldap_ndr.h"
32 #include "librpc/gen_ndr/ndr_netlogon.h"
33 #include "librpc/gen_ndr/ndr_security.h"
34 #include "param/param.h"
35 #include "auth/auth_sam.h"
36 #include "dsdb/common/util.h"
38 #define KRBTGT_ATTRS \
39 /* required for the krb5 kdc */ \
40 "objectClass", \
41 "sAMAccountName", \
42 "userPrincipalName", \
43 "servicePrincipalName", \
44 "msDS-KeyVersionNumber", \
45 "supplementalCredentials", \
47 /* passwords */ \
48 "dBCSPwd", \
49 "unicodePwd", \
51 "userAccountControl", \
52 "objectSid", \
54 "pwdLastSet", \
55 "accountExpires"
57 const char *krbtgt_attrs[] = {
58 KRBTGT_ATTRS
61 const char *server_attrs[] = {
62 KRBTGT_ATTRS
65 const char *user_attrs[] = {
66 KRBTGT_ATTRS,
68 "logonHours",
70 /* check 'allowed workstations' */
71 "userWorkstations",
73 /* required for server_info, not access control: */
74 "displayName",
75 "scriptPath",
76 "profilePath",
77 "homeDirectory",
78 "homeDrive",
79 "lastLogon",
80 "lastLogoff",
81 "accountExpires",
82 "badPwdCount",
83 "logonCount",
84 "primaryGroupID",
85 "memberOf",
86 NULL,
89 /****************************************************************************
90 Check if a user is allowed to logon at this time. Note this is the
91 servers local time, as logon hours are just specified as a weekly
92 bitmask.
93 ****************************************************************************/
95 static bool logon_hours_ok(struct ldb_message *msg, const char *name_for_logs)
97 /* In logon hours first bit is Sunday from 12AM to 1AM */
98 const struct ldb_val *hours;
99 struct tm *utctime;
100 time_t lasttime;
101 const char *asct;
102 uint8_t bitmask, bitpos;
104 hours = ldb_msg_find_ldb_val(msg, "logonHours");
105 if (!hours) {
106 DEBUG(5,("logon_hours_ok: No hours restrictions for user %s\n", name_for_logs));
107 return true;
110 if (hours->length != 168/8) {
111 DEBUG(5,("logon_hours_ok: malformed logon hours restrictions for user %s\n", name_for_logs));
112 return true;
115 lasttime = time(NULL);
116 utctime = gmtime(&lasttime);
117 if (!utctime) {
118 DEBUG(1, ("logon_hours_ok: failed to get gmtime. Failing logon for user %s\n",
119 name_for_logs));
120 return false;
123 /* find the corresponding byte and bit */
124 bitpos = (utctime->tm_wday * 24 + utctime->tm_hour) % 168;
125 bitmask = 1 << (bitpos % 8);
127 if (! (hours->data[bitpos/8] & bitmask)) {
128 struct tm *t = localtime(&lasttime);
129 if (!t) {
130 asct = "INVALID TIME";
131 } else {
132 asct = asctime(t);
133 if (!asct) {
134 asct = "INVALID TIME";
138 DEBUG(1, ("logon_hours_ok: Account for user %s not allowed to "
139 "logon at this time (%s).\n",
140 name_for_logs, asct ));
141 return false;
144 asct = asctime(utctime);
145 DEBUG(5,("logon_hours_ok: user %s allowed to logon at this time (%s)\n",
146 name_for_logs, asct ? asct : "UNKNOWN TIME" ));
148 return true;
151 /****************************************************************************
152 Do a specific test for a SAM_ACCOUNT being valid for this connection
153 (ie not disabled, expired and the like).
154 ****************************************************************************/
155 _PUBLIC_ NTSTATUS authsam_account_ok(TALLOC_CTX *mem_ctx,
156 struct ldb_context *sam_ctx,
157 uint32_t logon_parameters,
158 struct ldb_dn *domain_dn,
159 struct ldb_message *msg,
160 const char *logon_workstation,
161 const char *name_for_logs,
162 bool allow_domain_trust,
163 bool password_change)
165 uint16_t acct_flags;
166 const char *workstation_list;
167 NTTIME acct_expiry;
168 NTTIME must_change_time;
170 NTTIME now;
171 DEBUG(4,("authsam_account_ok: Checking SMB password for user %s\n", name_for_logs));
173 acct_flags = samdb_result_acct_flags(sam_ctx, mem_ctx, msg, domain_dn);
175 acct_expiry = samdb_result_account_expires(msg);
177 /* Check for when we must change this password, taking the
178 * userAccountControl flags into account */
179 must_change_time = samdb_result_force_password_change(sam_ctx, mem_ctx,
180 domain_dn, msg);
182 workstation_list = samdb_result_string(msg, "userWorkstations", NULL);
184 /* Quit if the account was disabled. */
185 if (acct_flags & ACB_DISABLED) {
186 DEBUG(1,("authsam_account_ok: Account for user '%s' was disabled.\n", name_for_logs));
187 return NT_STATUS_ACCOUNT_DISABLED;
190 /* Quit if the account was locked out. */
191 if (acct_flags & ACB_AUTOLOCK) {
192 DEBUG(1,("authsam_account_ok: Account for user %s was locked out.\n", name_for_logs));
193 return NT_STATUS_ACCOUNT_LOCKED_OUT;
196 /* Test account expire time */
197 unix_to_nt_time(&now, time(NULL));
198 if (now > acct_expiry) {
199 DEBUG(1,("authsam_account_ok: Account for user '%s' has expired.\n", name_for_logs));
200 DEBUG(3,("authsam_account_ok: Account expired at '%s'.\n",
201 nt_time_string(mem_ctx, acct_expiry)));
202 return NT_STATUS_ACCOUNT_EXPIRED;
205 /* check for immediate expiry "must change at next logon" (but not if this is a password change request) */
206 if ((must_change_time == 0) && !password_change) {
207 DEBUG(1,("sam_account_ok: Account for user '%s' password must change!.\n",
208 name_for_logs));
209 return NT_STATUS_PASSWORD_MUST_CHANGE;
212 /* check for expired password (but not if this is a password change request) */
213 if ((must_change_time < now) && !password_change) {
214 DEBUG(1,("sam_account_ok: Account for user '%s' password expired!.\n",
215 name_for_logs));
216 DEBUG(1,("sam_account_ok: Password expired at '%s' unix time.\n",
217 nt_time_string(mem_ctx, must_change_time)));
218 return NT_STATUS_PASSWORD_EXPIRED;
221 /* Test workstation. Workstation list is comma separated. */
222 if (logon_workstation && workstation_list && *workstation_list) {
223 bool invalid_ws = true;
224 int i;
225 const char **workstations = (const char **)str_list_make(mem_ctx, workstation_list, ",");
227 for (i = 0; workstations && workstations[i]; i++) {
228 DEBUG(10,("sam_account_ok: checking for workstation match '%s' and '%s'\n",
229 workstations[i], logon_workstation));
231 if (strequal(workstations[i], logon_workstation)) {
232 invalid_ws = false;
233 break;
237 talloc_free(workstations);
239 if (invalid_ws) {
240 return NT_STATUS_INVALID_WORKSTATION;
244 if (!logon_hours_ok(msg, name_for_logs)) {
245 return NT_STATUS_INVALID_LOGON_HOURS;
248 if (!allow_domain_trust) {
249 if (acct_flags & ACB_DOMTRUST) {
250 DEBUG(2,("sam_account_ok: Domain trust account %s denied by server\n", name_for_logs));
251 return NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT;
254 if (!(logon_parameters & MSV1_0_ALLOW_SERVER_TRUST_ACCOUNT)) {
255 if (acct_flags & ACB_SVRTRUST) {
256 DEBUG(2,("sam_account_ok: Server trust account %s denied by server\n", name_for_logs));
257 return NT_STATUS_NOLOGON_SERVER_TRUST_ACCOUNT;
260 if (!(logon_parameters & MSV1_0_ALLOW_WORKSTATION_TRUST_ACCOUNT)) {
261 /* TODO: this fails with current solaris client. We
262 need to work with Gordon to work out why */
263 if (acct_flags & ACB_WSTRUST) {
264 DEBUG(4,("sam_account_ok: Wksta trust account %s denied by server\n", name_for_logs));
265 return NT_STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT;
269 return NT_STATUS_OK;
272 /* This function tests if a SID structure "sids" contains the SID "sid" */
273 static bool sids_contains_sid(const struct dom_sid **sids,
274 const unsigned int num_sids,
275 const struct dom_sid *sid)
277 unsigned int i;
279 for (i = 0; i < num_sids; i++) {
280 if (dom_sid_equal(sids[i], sid))
281 return true;
283 return false;
287 * This function generates the transitive closure of a given SID "sid" (it
288 * basically expands nested groups of a SID).
289 * If the SID isn't located in the "res_sids" structure yet and the
290 * "only_childs" flag is negative, we add it to "res_sids".
291 * Then we've always to consider the "memberOf" attributes. We invoke the
292 * function recursively on each item of it with the "only_childs" flag set to
293 * "false".
294 * The "only_childs" flag is particularly useful if you have a user SID and
295 * want to include all his groups (referenced with "memberOf") without his SID
296 * itself.
298 * At the beginning "res_sids" should reference to a NULL pointer.
300 _PUBLIC_ NTSTATUS authsam_expand_nested_groups(struct ldb_context *sam_ctx,
301 const struct dom_sid *sid, const bool only_childs,
302 TALLOC_CTX *res_sids_ctx, struct dom_sid ***res_sids,
303 unsigned int *num_res_sids)
305 const char * const attrs[] = { "memberOf", NULL };
306 unsigned int i;
307 int ret;
308 bool already_there;
309 struct ldb_dn *tmp_dn;
310 struct dom_sid *tmp_sid;
311 TALLOC_CTX *tmp_ctx;
312 struct ldb_message **res;
313 NTSTATUS status;
315 if (*res_sids == NULL) {
316 *num_res_sids = 0;
319 if (sid == NULL) {
320 return NT_STATUS_OK;
323 already_there = sids_contains_sid((const struct dom_sid**) *res_sids,
324 *num_res_sids, sid);
325 if (already_there) {
326 return NT_STATUS_OK;
329 if (!only_childs) {
330 tmp_sid = dom_sid_dup(res_sids_ctx, sid);
331 NT_STATUS_HAVE_NO_MEMORY(tmp_sid);
332 *res_sids = talloc_realloc(res_sids_ctx, *res_sids,
333 struct dom_sid *, *num_res_sids + 1);
334 NT_STATUS_HAVE_NO_MEMORY(*res_sids);
335 (*res_sids)[*num_res_sids] = tmp_sid;
336 ++(*num_res_sids);
339 tmp_ctx = talloc_new(sam_ctx);
341 ret = gendb_search(sam_ctx, tmp_ctx, NULL, &res, attrs,
342 "objectSid=%s", ldap_encode_ndr_dom_sid(tmp_ctx, sid));
343 if (ret != 1) {
344 talloc_free(tmp_ctx);
345 return NT_STATUS_INTERNAL_DB_CORRUPTION;
348 if (res[0]->num_elements == 0) {
349 talloc_free(res);
350 talloc_free(tmp_ctx);
351 return NT_STATUS_OK;
354 for (i = 0; i < res[0]->elements[0].num_values; i++) {
355 tmp_dn = ldb_dn_from_ldb_val(tmp_ctx, sam_ctx,
356 &res[0]->elements[0].values[i]);
357 tmp_sid = samdb_search_dom_sid(sam_ctx, tmp_ctx, tmp_dn,
358 "objectSid", NULL);
360 status = authsam_expand_nested_groups(sam_ctx, tmp_sid,
361 false, res_sids_ctx, res_sids, num_res_sids);
362 if (!NT_STATUS_IS_OK(status)) {
363 talloc_free(res);
364 talloc_free(tmp_ctx);
365 return status;
369 talloc_free(res);
370 talloc_free(tmp_ctx);
372 return NT_STATUS_OK;
375 _PUBLIC_ NTSTATUS authsam_make_server_info(TALLOC_CTX *mem_ctx,
376 struct ldb_context *sam_ctx,
377 const char *netbios_name,
378 const char *domain_name,
379 struct ldb_dn *domain_dn,
380 struct ldb_message *msg,
381 DATA_BLOB user_sess_key,
382 DATA_BLOB lm_sess_key,
383 struct auth_serversupplied_info **_server_info)
385 NTSTATUS status;
386 struct auth_serversupplied_info *server_info;
387 const char *str;
388 struct dom_sid *tmp_sid;
389 /* SIDs for the account and his primary group */
390 struct dom_sid *account_sid;
391 struct dom_sid *primary_group_sid;
392 /* SID structures for the expanded group memberships */
393 struct dom_sid **groupSIDs = NULL, **groupSIDs_2 = NULL;
394 unsigned int num_groupSIDs = 0, num_groupSIDs_2 = 0, i;
395 uint32_t userAccountControl;
397 server_info = talloc(mem_ctx, struct auth_serversupplied_info);
398 NT_STATUS_HAVE_NO_MEMORY(server_info);
400 account_sid = samdb_result_dom_sid(server_info, msg, "objectSid");
401 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(account_sid, server_info);
403 primary_group_sid = dom_sid_add_rid(server_info,
404 samdb_domain_sid(sam_ctx),
405 samdb_result_uint(msg, "primaryGroupID", ~0));
406 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(primary_group_sid, server_info);
408 /* Expands the primary group */
409 status = authsam_expand_nested_groups(sam_ctx, primary_group_sid, false,
410 server_info, &groupSIDs, &num_groupSIDs);
411 if (!NT_STATUS_IS_OK(status)) {
412 talloc_free(server_info);
413 return status;
416 /* Expands the additional groups */
417 status = authsam_expand_nested_groups(sam_ctx, account_sid, true,
418 server_info, &groupSIDs_2, &num_groupSIDs_2);
419 if (!NT_STATUS_IS_OK(status)) {
420 talloc_free(server_info);
421 return status;
424 /* Merge the two expanded structures (groupSIDs, groupSIDs_2) */
425 for (i = 0; i < num_groupSIDs_2; i++)
426 if (!sids_contains_sid((const struct dom_sid **) groupSIDs,
427 num_groupSIDs, groupSIDs_2[i])) {
428 tmp_sid = dom_sid_dup(server_info, groupSIDs_2[i]);
429 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(tmp_sid, server_info);
430 groupSIDs = talloc_realloc(server_info, groupSIDs,
431 struct dom_sid *, num_groupSIDs + 1);
432 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(groupSIDs,
433 server_info);
434 groupSIDs[num_groupSIDs] = tmp_sid;
435 ++num_groupSIDs;
437 talloc_free(groupSIDs_2);
439 server_info->account_sid = account_sid;
440 server_info->primary_group_sid = primary_group_sid;
442 /* DCs also get SID_NT_ENTERPRISE_DCS */
443 userAccountControl = ldb_msg_find_attr_as_uint(msg, "userAccountControl", 0);
444 if (userAccountControl & UF_SERVER_TRUST_ACCOUNT) {
445 groupSIDs = talloc_realloc(server_info, groupSIDs, struct dom_sid *,
446 num_groupSIDs+1);
447 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(groupSIDs, server_info);
448 groupSIDs[num_groupSIDs] = dom_sid_parse_talloc(groupSIDs, SID_NT_ENTERPRISE_DCS);
449 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(groupSIDs[num_groupSIDs], server_info);
450 num_groupSIDs++;
453 server_info->domain_groups = groupSIDs;
454 server_info->n_domain_groups = num_groupSIDs;
456 server_info->account_name = talloc_steal(server_info,
457 samdb_result_string(msg, "sAMAccountName", NULL));
459 server_info->domain_name = talloc_strdup(server_info, domain_name);
460 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(server_info->domain_name,
461 server_info);
463 str = samdb_result_string(msg, "displayName", "");
464 server_info->full_name = talloc_strdup(server_info, str);
465 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(server_info->full_name, server_info);
467 str = samdb_result_string(msg, "scriptPath", "");
468 server_info->logon_script = talloc_strdup(server_info, str);
469 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(server_info->logon_script,
470 server_info);
472 str = samdb_result_string(msg, "profilePath", "");
473 server_info->profile_path = talloc_strdup(server_info, str);
474 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(server_info->profile_path,
475 server_info);
477 str = samdb_result_string(msg, "homeDirectory", "");
478 server_info->home_directory = talloc_strdup(server_info, str);
479 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(server_info->home_directory,
480 server_info);
482 str = samdb_result_string(msg, "homeDrive", "");
483 server_info->home_drive = talloc_strdup(server_info, str);
484 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(server_info->home_drive, server_info);
486 server_info->logon_server = talloc_strdup(server_info, netbios_name);
487 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(server_info->logon_server,
488 server_info);
490 server_info->last_logon = samdb_result_nttime(msg, "lastLogon", 0);
491 server_info->last_logoff = samdb_result_last_logoff(msg);
492 server_info->acct_expiry = samdb_result_account_expires(msg);
493 server_info->last_password_change = samdb_result_nttime(msg,
494 "pwdLastSet", 0);
495 server_info->allow_password_change
496 = samdb_result_allow_password_change(sam_ctx, mem_ctx,
497 domain_dn, msg, "pwdLastSet");
498 server_info->force_password_change
499 = samdb_result_force_password_change(sam_ctx, mem_ctx,
500 domain_dn, msg);
501 server_info->logon_count = samdb_result_uint(msg, "logonCount", 0);
502 server_info->bad_password_count = samdb_result_uint(msg, "badPwdCount",
505 server_info->acct_flags = samdb_result_acct_flags(sam_ctx, mem_ctx,
506 msg, domain_dn);
508 server_info->user_session_key = data_blob_talloc(server_info,
509 user_sess_key.data,
510 user_sess_key.length);
511 if (user_sess_key.data) {
512 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(server_info->user_session_key.data,
513 server_info);
515 server_info->lm_session_key = data_blob_talloc(server_info,
516 lm_sess_key.data,
517 lm_sess_key.length);
518 if (lm_sess_key.data) {
519 NT_STATUS_HAVE_NO_MEMORY_AND_FREE(server_info->lm_session_key.data,
520 server_info);
523 server_info->authenticated = true;
525 *_server_info = server_info;
527 return NT_STATUS_OK;
530 NTSTATUS sam_get_results_principal(struct ldb_context *sam_ctx,
531 TALLOC_CTX *mem_ctx, const char *principal,
532 const char **attrs,
533 struct ldb_dn **domain_dn,
534 struct ldb_message **msg)
536 struct ldb_dn *user_dn;
537 NTSTATUS nt_status;
538 TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
539 int ret;
541 if (!tmp_ctx) {
542 return NT_STATUS_NO_MEMORY;
545 nt_status = crack_user_principal_name(sam_ctx, tmp_ctx, principal,
546 &user_dn, domain_dn);
547 if (!NT_STATUS_IS_OK(nt_status)) {
548 talloc_free(tmp_ctx);
549 return nt_status;
552 /* pull the user attributes */
553 ret = dsdb_search_one(sam_ctx, tmp_ctx, msg, user_dn,
554 LDB_SCOPE_BASE, attrs, DSDB_SEARCH_SHOW_EXTENDED_DN, "(objectClass=*)");
555 if (ret != LDB_SUCCESS) {
556 talloc_free(tmp_ctx);
557 return NT_STATUS_INTERNAL_DB_CORRUPTION;
559 talloc_steal(mem_ctx, *msg);
560 talloc_steal(mem_ctx, *domain_dn);
561 talloc_free(tmp_ctx);
563 return NT_STATUS_OK;