2 Unix SMB/CIFS implementation.
4 User credentials handling (as regards on-disk files)
6 Copyright (C) Jelmer Vernooij 2005
7 Copyright (C) Tim Potter 2001
8 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "lib/events/events.h"
27 #include "librpc/gen_ndr/samr.h" /* for struct samrPassword */
28 #include "param/secrets.h"
29 #include "system/filesys.h"
30 #include "auth/credentials/credentials.h"
31 #include "auth/credentials/credentials_internal.h"
32 #include "auth/credentials/credentials_proto.h"
33 #include "auth/credentials/credentials_krb5.h"
34 #include "auth/kerberos/kerberos_util.h"
35 #include "param/param.h"
36 #include "lib/events/events.h"
37 #include "dsdb/samdb/samdb.h"
38 #include "source3/include/secrets.h"
39 #include "dbwrap/dbwrap.h"
40 #include "dbwrap/dbwrap_open.h"
41 #include "lib/util/util_tdb.h"
42 #include "libds/common/roles.h"
45 * Fill in credentials for the machine trust account, from the secrets database.
47 * @param cred Credentials structure to fill in
48 * @retval NTSTATUS error detailing any failure
50 static NTSTATUS cli_credentials_set_secrets_lct(struct cli_credentials *cred,
51 struct loadparm_context *lp_ctx,
52 struct ldb_context *ldb,
55 time_t secrets_tdb_last_change_time,
56 const char *secrets_tdb_password,
62 struct ldb_message *msg;
64 const char *machine_account;
68 enum netr_SchannelType sct;
69 const char *salt_principal;
71 const struct ldb_val *whenChanged;
74 /* ok, we are going to get it now, don't recurse back here */
75 cred->machine_account_pending = false;
77 /* some other parts of the system will key off this */
78 cred->machine_account = true;
80 mem_ctx = talloc_named(cred, 0, "cli_credentials_set_secrets from ldb");
83 /* Local secrets are stored in secrets.ldb */
84 ldb = secrets_db_connect(mem_ctx, lp_ctx);
86 *error_string = talloc_strdup(cred, "Could not open secrets.ldb");
88 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
92 ldb_ret = dsdb_search_one(ldb, mem_ctx, &msg,
93 ldb_dn_new(mem_ctx, ldb, base),
95 NULL, 0, "%s", filter);
97 if (ldb_ret != LDB_SUCCESS) {
98 *error_string = talloc_asprintf(cred, "Could not find entry to match filter: '%s' base: '%s': %s: %s",
99 filter, base ? base : "",
100 ldb_strerror(ldb_ret), ldb_errstring(ldb));
101 talloc_free(mem_ctx);
102 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
105 password = ldb_msg_find_attr_as_string(msg, "secret", NULL);
107 whenChanged = ldb_msg_find_ldb_val(msg, "whenChanged");
108 if (!whenChanged || ldb_val_to_time(whenChanged, &lct) != LDB_SUCCESS) {
109 /* This attribute is mandetory */
110 talloc_free(mem_ctx);
111 return NT_STATUS_NOT_FOUND;
114 /* Don't set secrets.ldb info if the secrets.tdb entry was more recent */
115 if (lct < secrets_tdb_last_change_time) {
116 talloc_free(mem_ctx);
117 return NT_STATUS_NOT_FOUND;
120 if (lct == secrets_tdb_last_change_time && secrets_tdb_password && strcmp(password, secrets_tdb_password) != 0) {
121 talloc_free(mem_ctx);
122 return NT_STATUS_NOT_FOUND;
125 cli_credentials_set_password_last_changed_time(cred, lct);
127 machine_account = ldb_msg_find_attr_as_string(msg, "samAccountName", NULL);
129 if (!machine_account) {
130 machine_account = ldb_msg_find_attr_as_string(msg, "servicePrincipalName", NULL);
132 if (!machine_account) {
133 const char *ldap_bind_dn = ldb_msg_find_attr_as_string(msg, "ldapBindDn", NULL);
135 *error_string = talloc_asprintf(cred,
136 "Could not find 'samAccountName', "
137 "'servicePrincipalName' or "
138 "'ldapBindDn' in secrets record: %s",
139 ldb_dn_get_linearized(msg->dn));
140 talloc_free(mem_ctx);
141 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
143 /* store bind dn in credentials */
144 cli_credentials_set_bind_dn(cred, ldap_bind_dn);
149 salt_principal = ldb_msg_find_attr_as_string(msg, "saltPrincipal", NULL);
150 cli_credentials_set_salt_principal(cred, salt_principal);
152 sct = ldb_msg_find_attr_as_int(msg, "secureChannelType", 0);
154 cli_credentials_set_secure_channel_type(cred, sct);
158 const struct ldb_val *nt_password_hash = ldb_msg_find_ldb_val(msg, "unicodePwd");
159 struct samr_Password hash;
161 if (nt_password_hash) {
162 memcpy(hash.hash, nt_password_hash->data,
163 MIN(nt_password_hash->length, sizeof(hash.hash)));
165 cli_credentials_set_nt_hash(cred, &hash, CRED_SPECIFIED);
167 cli_credentials_set_password(cred, NULL, CRED_SPECIFIED);
170 cli_credentials_set_password(cred, password, CRED_SPECIFIED);
173 domain = ldb_msg_find_attr_as_string(msg, "flatname", NULL);
175 cli_credentials_set_domain(cred, domain, CRED_SPECIFIED);
178 realm = ldb_msg_find_attr_as_string(msg, "realm", NULL);
180 cli_credentials_set_realm(cred, realm, CRED_SPECIFIED);
183 if (machine_account) {
184 cli_credentials_set_username(cred, machine_account, CRED_SPECIFIED);
187 cli_credentials_set_kvno(cred, ldb_msg_find_attr_as_int(msg, "msDS-KeyVersionNumber", 0));
189 /* If there was an external keytab specified by reference in
190 * the LDB, then use this. Otherwise we will make one up
191 * (chewing CPU time) from the password */
192 keytab = keytab_name_from_msg(cred, ldb, msg);
194 cli_credentials_set_keytab_name(cred, lp_ctx, keytab, CRED_SPECIFIED);
197 talloc_free(mem_ctx);
204 * Fill in credentials for the machine trust account, from the secrets database.
206 * @param cred Credentials structure to fill in
207 * @retval NTSTATUS error detailing any failure
209 _PUBLIC_ NTSTATUS cli_credentials_set_secrets(struct cli_credentials *cred,
210 struct loadparm_context *lp_ctx,
211 struct ldb_context *ldb,
216 NTSTATUS status = cli_credentials_set_secrets_lct(cred, lp_ctx, ldb, base, filter, 0, NULL, error_string);
217 if (!NT_STATUS_IS_OK(status)) {
218 /* set anonymous as the fallback, if the machine account won't work */
219 cli_credentials_set_anonymous(cred);
225 * Fill in credentials for the machine trust account, from the secrets database.
227 * @param cred Credentials structure to fill in
228 * @retval NTSTATUS error detailing any failure
230 _PUBLIC_ NTSTATUS cli_credentials_set_machine_account(struct cli_credentials *cred,
231 struct loadparm_context *lp_ctx)
233 struct db_context *db_ctx;
234 char *secrets_tdb_path;
236 secrets_tdb_path = lpcfg_private_db_path(cred, lp_ctx, "secrets");
237 if (secrets_tdb_path == NULL) {
238 return NT_STATUS_NO_MEMORY;
241 db_ctx = dbwrap_local_open(cred, lp_ctx, secrets_tdb_path, 0,
242 TDB_DEFAULT, O_RDWR, 0600,
245 TALLOC_FREE(secrets_tdb_path);
248 * We do not check for errors here, we might not have a
249 * secrets.tdb at all, and so we just need to check the
252 return cli_credentials_set_machine_account_db_ctx(cred, lp_ctx, db_ctx);
256 * Fill in credentials for the machine trust account, from the
257 * secrets.ldb or passed in handle to secrets.tdb (perhaps in CTDB).
259 * This version is used in parts of the code that can link in the
260 * CTDB dbwrap backend, by passing down the already open handle.
262 * @param cred Credentials structure to fill in
263 * @param db_ctx dbwrap context for secrets.tdb
264 * @retval NTSTATUS error detailing any failure
266 _PUBLIC_ NTSTATUS cli_credentials_set_machine_account_db_ctx(struct cli_credentials *cred,
267 struct loadparm_context *lp_ctx,
268 struct db_context *db_ctx)
272 char *error_string = NULL;
274 bool secrets_tdb_password_more_recent;
275 time_t secrets_tdb_lct = 0;
276 char *secrets_tdb_password = NULL;
277 char *secrets_tdb_old_password = NULL;
278 uint32_t secrets_tdb_secure_channel_type = SEC_CHAN_NULL;
279 int server_role = lpcfg_server_role(lp_ctx);
280 int security = lpcfg_security(lp_ctx);
282 char *keystr_upper = NULL;
283 TALLOC_CTX *tmp_ctx = talloc_named(cred, 0, "cli_credentials_set_secrets from ldb");
285 return NT_STATUS_NO_MEMORY;
288 /* Bleh, nasty recursion issues: We are setting a machine
289 * account here, so we don't want the 'pending' flag around
291 cred->machine_account_pending = false;
293 /* We have to do this, as the fallback in
294 * cli_credentials_set_secrets is to run as anonymous, so the domain is wiped */
295 domain = cli_credentials_get_domain(cred);
299 keystr = talloc_asprintf(tmp_ctx, "%s/%s",
300 SECRETS_MACHINE_LAST_CHANGE_TIME,
302 keystr_upper = strupper_talloc(tmp_ctx, keystr);
303 status = dbwrap_fetch(db_ctx, tmp_ctx, string_tdb_data(keystr_upper),
305 if (NT_STATUS_IS_OK(status) && dbuf.dsize == 4) {
306 secrets_tdb_lct = IVAL(dbuf.dptr,0);
309 keystr = talloc_asprintf(tmp_ctx, "%s/%s",
310 SECRETS_MACHINE_PASSWORD,
312 keystr_upper = strupper_talloc(tmp_ctx, keystr);
313 status = dbwrap_fetch(db_ctx, tmp_ctx, string_tdb_data(keystr_upper),
315 if (NT_STATUS_IS_OK(status)) {
316 secrets_tdb_password = (char *)dbuf.dptr;
319 keystr = talloc_asprintf(tmp_ctx, "%s/%s",
320 SECRETS_MACHINE_PASSWORD_PREV,
322 keystr_upper = strupper_talloc(tmp_ctx, keystr);
323 status = dbwrap_fetch(db_ctx, tmp_ctx, string_tdb_data(keystr_upper),
325 if (NT_STATUS_IS_OK(status)) {
326 secrets_tdb_old_password = (char *)dbuf.dptr;
329 keystr = talloc_asprintf(tmp_ctx, "%s/%s",
330 SECRETS_MACHINE_SEC_CHANNEL_TYPE,
332 keystr_upper = strupper_talloc(tmp_ctx, keystr);
333 status = dbwrap_fetch(db_ctx, tmp_ctx, string_tdb_data(keystr_upper),
335 if (NT_STATUS_IS_OK(status) && dbuf.dsize == 4) {
336 secrets_tdb_secure_channel_type = IVAL(dbuf.dptr,0);
340 filter = talloc_asprintf(cred, SECRETS_PRIMARY_DOMAIN_FILTER,
342 status = cli_credentials_set_secrets_lct(cred, lp_ctx, NULL,
343 SECRETS_PRIMARY_DOMAIN_DN,
344 filter, secrets_tdb_lct, secrets_tdb_password, &error_string);
345 if (secrets_tdb_password == NULL) {
346 secrets_tdb_password_more_recent = false;
347 } else if (NT_STATUS_EQUAL(NT_STATUS_CANT_ACCESS_DOMAIN_INFO, status)
348 || NT_STATUS_EQUAL(NT_STATUS_NOT_FOUND, status)) {
349 secrets_tdb_password_more_recent = true;
350 } else if (secrets_tdb_lct > cli_credentials_get_password_last_changed_time(cred)) {
351 secrets_tdb_password_more_recent = true;
352 } else if (secrets_tdb_lct == cli_credentials_get_password_last_changed_time(cred)) {
353 secrets_tdb_password_more_recent = strcmp(secrets_tdb_password, cli_credentials_get_password(cred)) != 0;
355 secrets_tdb_password_more_recent = false;
358 if (secrets_tdb_password_more_recent) {
359 enum credentials_use_kerberos use_kerberos = CRED_DONT_USE_KERBEROS;
360 char *machine_account = talloc_asprintf(tmp_ctx, "%s$", lpcfg_netbios_name(lp_ctx));
361 cli_credentials_set_password(cred, secrets_tdb_password, CRED_SPECIFIED);
362 cli_credentials_set_old_password(cred, secrets_tdb_old_password, CRED_SPECIFIED);
363 cli_credentials_set_domain(cred, domain, CRED_SPECIFIED);
364 if (strequal(domain, lpcfg_workgroup(lp_ctx))) {
365 cli_credentials_set_realm(cred, lpcfg_realm(lp_ctx), CRED_SPECIFIED);
367 switch (server_role) {
368 case ROLE_DOMAIN_MEMBER:
369 if (security != SEC_ADS) {
373 case ROLE_ACTIVE_DIRECTORY_DC:
374 use_kerberos = CRED_AUTO_USE_KERBEROS;
378 cli_credentials_set_kerberos_state(cred, use_kerberos);
379 cli_credentials_set_username(cred, machine_account, CRED_SPECIFIED);
380 cli_credentials_set_password_last_changed_time(cred, secrets_tdb_lct);
381 cli_credentials_set_secure_channel_type(cred, secrets_tdb_secure_channel_type);
382 status = NT_STATUS_OK;
383 } else if (!NT_STATUS_IS_OK(status)) {
386 = talloc_asprintf(cred,
387 "Failed to fetch machine account password for %s from both "
388 "secrets.ldb (%s) and from %s",
390 error_string == NULL ? "error" : error_string,
391 dbwrap_name(db_ctx));
393 char *secrets_tdb_path;
395 secrets_tdb_path = lpcfg_private_db_path(tmp_ctx,
398 if (secrets_tdb_path == NULL) {
399 return NT_STATUS_NO_MEMORY;
402 error_string = talloc_asprintf(cred,
403 "Failed to fetch machine account password from "
404 "secrets.ldb: %s and failed to open %s",
405 error_string == NULL ? "error" : error_string,
408 DEBUG(1, ("Could not find machine account in secrets database: %s: %s\n",
409 error_string == NULL ? "error" : error_string,
411 /* set anonymous as the fallback, if the machine account won't work */
412 cli_credentials_set_anonymous(cred);
415 TALLOC_FREE(tmp_ctx);
420 * Fill in credentials for a particular principal, from the secrets database.
422 * @param cred Credentials structure to fill in
423 * @retval NTSTATUS error detailing any failure
425 _PUBLIC_ NTSTATUS cli_credentials_set_stored_principal(struct cli_credentials *cred,
426 struct loadparm_context *lp_ctx,
427 const char *serviceprincipal)
431 char *error_string = NULL;
432 /* Bleh, nasty recursion issues: We are setting a machine
433 * account here, so we don't want the 'pending' flag around
435 cred->machine_account_pending = false;
436 filter = talloc_asprintf(cred, SECRETS_PRINCIPAL_SEARCH,
437 cli_credentials_get_realm(cred),
438 cli_credentials_get_domain(cred),
440 status = cli_credentials_set_secrets_lct(cred, lp_ctx, NULL,
441 SECRETS_PRINCIPALS_DN, filter,
442 0, NULL, &error_string);
443 if (!NT_STATUS_IS_OK(status)) {
444 DEBUG(1, ("Could not find %s principal in secrets database: %s: %s\n",
445 serviceprincipal, nt_errstr(status),
446 error_string ? error_string : "<no error>"));
452 * Ask that when required, the credentials system will be filled with
453 * machine trust account, from the secrets database.
455 * @param cred Credentials structure to fill in
456 * @note This function is used to call the above function after, rather
457 * than during, popt processing.
460 _PUBLIC_ void cli_credentials_set_machine_account_pending(struct cli_credentials *cred,
461 struct loadparm_context *lp_ctx)
463 cred->machine_account_pending = true;
464 cred->machine_account_pending_lp_ctx = lp_ctx;