samba_upgradeprovision: Remove unused checkKeepAttributeOldMtd
[Samba/vl.git] / auth / credentials / credentials_secrets.c
blob730f047672e3169b245163a928d1b21c72f04c7c
1 /*
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/>.
24 #include "includes.h"
25 #include "lib/events/events.h"
26 #include <ldb.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_proto.h"
32 #include "auth/credentials/credentials_krb5.h"
33 #include "auth/kerberos/kerberos_util.h"
34 #include "param/param.h"
35 #include "lib/events/events.h"
36 #include "dsdb/samdb/samdb.h"
37 #include "source3/include/secrets.h"
38 #include "dbwrap/dbwrap.h"
39 #include "dbwrap/dbwrap_open.h"
40 #include "lib/util/util_tdb.h"
43 /**
44 * Fill in credentials for the machine trust account, from the secrets database.
46 * @param cred Credentials structure to fill in
47 * @retval NTSTATUS error detailing any failure
49 static NTSTATUS cli_credentials_set_secrets_lct(struct cli_credentials *cred,
50 struct loadparm_context *lp_ctx,
51 struct ldb_context *ldb,
52 const char *base,
53 const char *filter,
54 time_t secrets_tdb_last_change_time,
55 const char *secrets_tdb_password,
56 char **error_string)
58 TALLOC_CTX *mem_ctx;
60 int ldb_ret;
61 struct ldb_message *msg;
63 const char *machine_account;
64 const char *password;
65 const char *domain;
66 const char *realm;
67 enum netr_SchannelType sct;
68 const char *salt_principal;
69 char *keytab;
70 const struct ldb_val *whenChanged;
71 time_t lct;
73 /* ok, we are going to get it now, don't recurse back here */
74 cred->machine_account_pending = false;
76 /* some other parts of the system will key off this */
77 cred->machine_account = true;
79 mem_ctx = talloc_named(cred, 0, "cli_credentials_set_secrets from ldb");
81 if (!ldb) {
82 /* Local secrets are stored in secrets.ldb */
83 ldb = secrets_db_connect(mem_ctx, lp_ctx);
84 if (!ldb) {
85 *error_string = talloc_strdup(cred, "Could not open secrets.ldb");
86 talloc_free(mem_ctx);
87 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
91 ldb_ret = dsdb_search_one(ldb, mem_ctx, &msg,
92 ldb_dn_new(mem_ctx, ldb, base),
93 LDB_SCOPE_SUBTREE,
94 NULL, 0, "%s", filter);
96 if (ldb_ret != LDB_SUCCESS) {
97 *error_string = talloc_asprintf(cred, "Could not find entry to match filter: '%s' base: '%s': %s: %s",
98 filter, base ? base : "",
99 ldb_strerror(ldb_ret), ldb_errstring(ldb));
100 talloc_free(mem_ctx);
101 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
104 password = ldb_msg_find_attr_as_string(msg, "secret", NULL);
106 whenChanged = ldb_msg_find_ldb_val(msg, "whenChanged");
107 if (!whenChanged || ldb_val_to_time(whenChanged, &lct) != LDB_SUCCESS) {
108 /* This attribute is mandetory */
109 talloc_free(mem_ctx);
110 return NT_STATUS_NOT_FOUND;
113 /* Don't set secrets.ldb info if the secrets.tdb entry was more recent */
114 if (lct < secrets_tdb_last_change_time) {
115 talloc_free(mem_ctx);
116 return NT_STATUS_NOT_FOUND;
119 if (lct == secrets_tdb_last_change_time && secrets_tdb_password && strcmp(password, secrets_tdb_password) != 0) {
120 talloc_free(mem_ctx);
121 return NT_STATUS_NOT_FOUND;
124 cli_credentials_set_password_last_changed_time(cred, lct);
126 machine_account = ldb_msg_find_attr_as_string(msg, "samAccountName", NULL);
128 if (!machine_account) {
129 machine_account = ldb_msg_find_attr_as_string(msg, "servicePrincipalName", NULL);
131 if (!machine_account) {
132 const char *ldap_bind_dn = ldb_msg_find_attr_as_string(msg, "ldapBindDn", NULL);
133 if (!ldap_bind_dn) {
134 *error_string = talloc_asprintf(cred,
135 "Could not find 'samAccountName', "
136 "'servicePrincipalName' or "
137 "'ldapBindDn' in secrets record: %s",
138 ldb_dn_get_linearized(msg->dn));
139 talloc_free(mem_ctx);
140 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
141 } else {
142 /* store bind dn in credentials */
143 cli_credentials_set_bind_dn(cred, ldap_bind_dn);
148 salt_principal = ldb_msg_find_attr_as_string(msg, "saltPrincipal", NULL);
149 cli_credentials_set_salt_principal(cred, salt_principal);
151 sct = ldb_msg_find_attr_as_int(msg, "secureChannelType", 0);
152 if (sct) {
153 cli_credentials_set_secure_channel_type(cred, sct);
156 if (!password) {
157 const struct ldb_val *nt_password_hash = ldb_msg_find_ldb_val(msg, "unicodePwd");
158 struct samr_Password hash;
159 ZERO_STRUCT(hash);
160 if (nt_password_hash) {
161 memcpy(hash.hash, nt_password_hash->data,
162 MIN(nt_password_hash->length, sizeof(hash.hash)));
164 cli_credentials_set_nt_hash(cred, &hash, CRED_SPECIFIED);
165 } else {
166 cli_credentials_set_password(cred, NULL, CRED_SPECIFIED);
168 } else {
169 cli_credentials_set_password(cred, password, CRED_SPECIFIED);
173 domain = ldb_msg_find_attr_as_string(msg, "flatname", NULL);
174 if (domain) {
175 cli_credentials_set_domain(cred, domain, CRED_SPECIFIED);
178 realm = ldb_msg_find_attr_as_string(msg, "realm", NULL);
179 if (realm) {
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);
193 if (keytab) {
194 cli_credentials_set_keytab_name(cred, lp_ctx, keytab, CRED_SPECIFIED);
195 talloc_free(keytab);
197 talloc_free(mem_ctx);
199 return NT_STATUS_OK;
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,
212 const char *base,
213 const char *filter,
214 char **error_string)
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);
221 return status;
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 NTSTATUS status;
234 char *filter;
235 char *error_string;
236 const char *domain;
237 bool secrets_tdb_password_more_recent;
238 time_t secrets_tdb_lct = 0;
239 char *secrets_tdb_password = NULL;
240 char *keystr;
241 char *keystr_upper = NULL;
242 char *secrets_tdb;
243 struct db_context *db_ctx;
244 TALLOC_CTX *tmp_ctx = talloc_named(cred, 0, "cli_credentials_set_secrets from ldb");
245 if (!tmp_ctx) {
246 return NT_STATUS_NO_MEMORY;
248 secrets_tdb = lpcfg_private_path(cred, lp_ctx,
249 lpcfg_use_ntdb(lp_ctx) ?
250 "secrets.ntdb" : "secrets.tdb");
251 if (!secrets_tdb) {
252 TALLOC_FREE(tmp_ctx);
253 return NT_STATUS_NO_MEMORY;
256 db_ctx = dbwrap_local_open(cred, lp_ctx, secrets_tdb, 0,
257 TDB_DEFAULT, O_RDWR, 0600,
258 DBWRAP_LOCK_ORDER_1);
259 /* Bleh, nasty recursion issues: We are setting a machine
260 * account here, so we don't want the 'pending' flag around
261 * any more */
262 cred->machine_account_pending = false;
264 /* We have to do this, as the fallback in
265 * cli_credentials_set_secrets is to run as anonymous, so the domain is wiped */
266 domain = cli_credentials_get_domain(cred);
268 if (db_ctx) {
269 TDB_DATA dbuf;
270 keystr = talloc_asprintf(tmp_ctx, "%s/%s",
271 SECRETS_MACHINE_LAST_CHANGE_TIME,
272 domain);
273 keystr_upper = strupper_talloc(tmp_ctx, keystr);
274 status = dbwrap_fetch(db_ctx, tmp_ctx, string_tdb_data(keystr_upper),
275 &dbuf);
276 if (NT_STATUS_IS_OK(status) && dbuf.dsize == 4) {
277 secrets_tdb_lct = IVAL(dbuf.dptr,0);
280 keystr = talloc_asprintf(tmp_ctx, "%s/%s",
281 SECRETS_MACHINE_PASSWORD,
282 domain);
283 keystr_upper = strupper_talloc(tmp_ctx, keystr);
284 status = dbwrap_fetch(db_ctx, tmp_ctx, string_tdb_data(keystr_upper),
285 &dbuf);
286 if (NT_STATUS_IS_OK(status)) {
287 secrets_tdb_password = (char *)dbuf.dptr;
291 filter = talloc_asprintf(cred, SECRETS_PRIMARY_DOMAIN_FILTER,
292 domain);
293 status = cli_credentials_set_secrets_lct(cred, lp_ctx, NULL,
294 SECRETS_PRIMARY_DOMAIN_DN,
295 filter, secrets_tdb_lct, secrets_tdb_password, &error_string);
296 if (secrets_tdb_password == NULL) {
297 secrets_tdb_password_more_recent = false;
298 } else if (NT_STATUS_EQUAL(NT_STATUS_CANT_ACCESS_DOMAIN_INFO, status)
299 || NT_STATUS_EQUAL(NT_STATUS_NOT_FOUND, status)) {
300 secrets_tdb_password_more_recent = true;
301 } else if (secrets_tdb_lct > cli_credentials_get_password_last_changed_time(cred)) {
302 secrets_tdb_password_more_recent = true;
303 } else if (secrets_tdb_lct == cli_credentials_get_password_last_changed_time(cred)) {
304 secrets_tdb_password_more_recent = strcmp(secrets_tdb_password, cli_credentials_get_password(cred)) != 0;
305 } else {
306 secrets_tdb_password_more_recent = false;
309 if (secrets_tdb_password_more_recent) {
310 char *machine_account = talloc_asprintf(tmp_ctx, "%s$", lpcfg_netbios_name(lp_ctx));
311 cli_credentials_set_password(cred, secrets_tdb_password, CRED_SPECIFIED);
312 cli_credentials_set_domain(cred, domain, CRED_SPECIFIED);
313 cli_credentials_set_username(cred, machine_account, CRED_SPECIFIED);
314 } else if (!NT_STATUS_IS_OK(status)) {
315 if (db_ctx) {
316 error_string = talloc_asprintf(cred,
317 "Failed to fetch machine account password from "
318 "secrets.ldb: %s and failed to fetch %s from %s",
319 error_string, keystr_upper, secrets_tdb);
320 } else {
321 error_string = talloc_asprintf(cred,
322 "Failed to fetch machine account password from "
323 "secrets.ldb: %s and failed to open %s",
324 error_string, secrets_tdb);
326 DEBUG(1, ("Could not find machine account in secrets database: %s: %s\n",
327 error_string, nt_errstr(status)));
328 /* set anonymous as the fallback, if the machine account won't work */
329 cli_credentials_set_anonymous(cred);
332 TALLOC_FREE(tmp_ctx);
333 return status;
337 * Fill in credentials for a particular prinicpal, from the secrets database.
339 * @param cred Credentials structure to fill in
340 * @retval NTSTATUS error detailing any failure
342 _PUBLIC_ NTSTATUS cli_credentials_set_stored_principal(struct cli_credentials *cred,
343 struct loadparm_context *lp_ctx,
344 const char *serviceprincipal)
346 NTSTATUS status;
347 char *filter;
348 char *error_string;
349 /* Bleh, nasty recursion issues: We are setting a machine
350 * account here, so we don't want the 'pending' flag around
351 * any more */
352 cred->machine_account_pending = false;
353 filter = talloc_asprintf(cred, SECRETS_PRINCIPAL_SEARCH,
354 cli_credentials_get_realm(cred),
355 cli_credentials_get_domain(cred),
356 serviceprincipal);
357 status = cli_credentials_set_secrets_lct(cred, lp_ctx, NULL,
358 SECRETS_PRINCIPALS_DN, filter,
359 0, NULL, &error_string);
360 if (!NT_STATUS_IS_OK(status)) {
361 DEBUG(1, ("Could not find %s principal in secrets database: %s: %s\n", serviceprincipal, nt_errstr(status), error_string));
363 return status;
367 * Ask that when required, the credentials system will be filled with
368 * machine trust account, from the secrets database.
370 * @param cred Credentials structure to fill in
371 * @note This function is used to call the above function after, rather
372 * than during, popt processing.
375 _PUBLIC_ void cli_credentials_set_machine_account_pending(struct cli_credentials *cred,
376 struct loadparm_context *lp_ctx)
378 cred->machine_account_pending = true;
379 cred->machine_account_pending_lp_ctx = lp_ctx;