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 2 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, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include "lib/ldb/include/ldb.h"
27 #include "librpc/gen_ndr/samr.h" /* for struct samrPassword */
28 #include "passdb/secrets.h"
29 #include "system/filesys.h"
31 #include "auth/credentials/credentials.h"
34 * Read a file descriptor, and parse it for a password (eg from a file or stdin)
36 * @param credentials Credentials structure on which to set the password
37 * @param fd open file descriptor to read the password from
38 * @param obtained This enum describes how 'specified' this password is
41 BOOL cli_credentials_parse_password_fd(struct cli_credentials *credentials,
42 int fd, enum credentials_obtained obtained)
47 for(p = pass, *p = '\0'; /* ensure that pass is null-terminated */
48 p && p - pass < sizeof(pass);) {
49 switch (read(fd, p, 1)) {
51 if (*p != '\n' && *p != '\0') {
52 *++p = '\0'; /* advance p, and null-terminate pass */
58 *p = '\0'; /* null-terminate it, just in case... */
59 p = NULL; /* then force the loop condition to become false */
62 fprintf(stderr, "Error reading password from file descriptor %d: %s\n", fd, "empty password\n");
67 fprintf(stderr, "Error reading password from file descriptor %d: %s\n",
73 cli_credentials_set_password(credentials, pass, obtained);
78 * Read a named file, and parse it for a password
80 * @param credentials Credentials structure on which to set the password
81 * @param file a named file to read the password from
82 * @param obtained This enum describes how 'specified' this password is
85 BOOL cli_credentials_parse_password_file(struct cli_credentials *credentials, const char *file, enum credentials_obtained obtained)
87 int fd = open(file, O_RDONLY, 0);
91 fprintf(stderr, "Error opening PASSWD_FILE %s: %s\n",
92 file, strerror(errno));
96 ret = cli_credentials_parse_password_fd(credentials, fd, obtained);
104 * Read a named file, and parse it for username, domain, realm and password
106 * @param credentials Credentials structure on which to set the password
107 * @param file a named file to read the details from
108 * @param obtained This enum describes how 'specified' this password is
111 BOOL cli_credentials_parse_file(struct cli_credentials *cred, const char *file, enum credentials_obtained obtained)
114 char *ptr, *val, *param;
118 lines = file_lines_load(file, &numlines, NULL);
122 /* fail if we can't open the credentials file */
123 d_printf("ERROR: Unable to open credentials file!\n");
127 for (i = 0; i < numlines; i++) {
128 len = strlen(lines[i]);
133 /* break up the line into parameter & value.
134 * will need to eat a little whitespace possibly */
136 if (!(ptr = strchr_m (lines[i], '=')))
142 /* eat leading white space */
143 while ((*val!='\0') && ((*val==' ') || (*val=='\t')))
146 if (strwicmp("password", param) == 0) {
147 cli_credentials_set_password(cred, val, obtained);
148 } else if (strwicmp("username", param) == 0) {
149 cli_credentials_set_username(cred, val, obtained);
150 } else if (strwicmp("domain", param) == 0) {
151 cli_credentials_set_domain(cred, val, obtained);
152 } else if (strwicmp("realm", param) == 0) {
153 cli_credentials_set_realm(cred, val, obtained);
155 memset(lines[i], 0, len);
165 * Fill in credentials for the machine trust account, from the secrets database.
167 * @param cred Credentials structure to fill in
168 * @retval NTSTATUS error detailing any failure
170 NTSTATUS cli_credentials_set_secrets(struct cli_credentials *cred,
176 struct ldb_context *ldb;
178 struct ldb_message **msgs;
179 const char *attrs[] = {
187 "msDS-KeyVersionNumber",
194 const char *machine_account;
195 const char *password;
196 const char *old_password;
199 enum netr_SchannelType sct;
200 const char *salt_principal;
203 /* ok, we are going to get it now, don't recurse back here */
204 cred->machine_account_pending = False;
206 /* some other parts of the system will key off this */
207 cred->machine_account = True;
209 mem_ctx = talloc_named(cred, 0, "cli_credentials fetch machine password");
211 /* Local secrets are stored in secrets.ldb */
212 ldb = secrets_db_connect(mem_ctx);
214 /* set anonymous as the fallback, if the machine account won't work */
215 cli_credentials_set_anonymous(cred);
216 DEBUG(1, ("Could not open secrets.ldb\n"));
217 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
220 /* search for the secret record */
221 ldb_ret = gendb_search(ldb,
222 mem_ctx, ldb_dn_explode(mem_ctx, base),
226 DEBUG(1, ("Could not find entry to match filter: %s\n",
228 /* set anonymous as the fallback, if the machine account won't work */
229 cli_credentials_set_anonymous(cred);
230 talloc_free(mem_ctx);
231 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
232 } else if (ldb_ret != 1) {
233 DEBUG(1, ("Found more than one (%d) entry to match filter: %s\n",
235 /* set anonymous as the fallback, if the machine account won't work */
236 cli_credentials_set_anonymous(cred);
237 talloc_free(mem_ctx);
238 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
241 password = ldb_msg_find_string(msgs[0], "secret", NULL);
242 old_password = ldb_msg_find_string(msgs[0], "priorSecret", NULL);
244 machine_account = ldb_msg_find_string(msgs[0], "samAccountName", NULL);
246 if (!machine_account) {
247 DEBUG(1, ("Could not find 'samAccountName' in join record to domain: %s\n",
248 cli_credentials_get_domain(cred)));
249 /* set anonymous as the fallback, if the machine account won't work */
250 cli_credentials_set_anonymous(cred);
251 talloc_free(mem_ctx);
252 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
255 salt_principal = ldb_msg_find_string(msgs[0], "saltPrincipal", NULL);
256 cli_credentials_set_salt_principal(cred, salt_principal);
258 sct = ldb_msg_find_int(msgs[0], "secureChannelType", 0);
260 cli_credentials_set_secure_channel_type(cred, sct);
264 const struct ldb_val *nt_password_hash = ldb_msg_find_ldb_val(msgs[0], "ntPwdHash");
265 struct samr_Password hash;
267 if (nt_password_hash) {
268 memcpy(hash.hash, nt_password_hash->data,
269 MIN(nt_password_hash->length, sizeof(hash.hash)));
271 cli_credentials_set_nt_hash(cred, &hash, CRED_SPECIFIED);
273 cli_credentials_set_password(cred, NULL, CRED_SPECIFIED);
276 cli_credentials_set_password(cred, password, CRED_SPECIFIED);
280 domain = ldb_msg_find_string(msgs[0], "flatname", NULL);
282 cli_credentials_set_domain(cred, domain, CRED_SPECIFIED);
285 realm = ldb_msg_find_string(msgs[0], "realm", NULL);
287 cli_credentials_set_realm(cred, realm, CRED_SPECIFIED);
290 cli_credentials_set_username(cred, machine_account, CRED_SPECIFIED);
292 cli_credentials_set_kvno(cred, ldb_msg_find_int(msgs[0], "msDS-KeyVersionNumber", 0));
294 /* If there was an external keytab specified by reference in
295 * the LDB, then use this. Otherwise we will make one up
296 * (chewing CPU time) from the password */
297 keytab = ldb_msg_find_string(msgs[0], "krb5Keytab", NULL);
299 cli_credentials_set_keytab_name(cred, keytab, CRED_SPECIFIED);
301 keytab = ldb_msg_find_string(msgs[0], "privateKeytab", NULL);
303 keytab = talloc_asprintf(mem_ctx, "FILE:%s", private_path(mem_ctx, keytab));
305 cli_credentials_set_keytab_name(cred, keytab, CRED_SPECIFIED);
309 talloc_free(mem_ctx);
315 * Fill in credentials for the machine trust account, from the secrets database.
317 * @param cred Credentials structure to fill in
318 * @retval NTSTATUS error detailing any failure
320 NTSTATUS cli_credentials_set_machine_account(struct cli_credentials *cred)
323 /* Bleh, nasty recursion issues: We are setting a machine
324 * account here, so we don't want the 'pending' flag around
326 cred->machine_account_pending = False;
327 filter = talloc_asprintf(cred, SECRETS_PRIMARY_DOMAIN_FILTER,
328 cli_credentials_get_domain(cred));
329 return cli_credentials_set_secrets(cred, SECRETS_PRIMARY_DOMAIN_DN,
334 * Fill in credentials for the machine trust account, from the secrets database.
336 * @param cred Credentials structure to fill in
337 * @retval NTSTATUS error detailing any failure
339 NTSTATUS cli_credentials_set_krbtgt(struct cli_credentials *cred)
342 /* Bleh, nasty recursion issues: We are setting a machine
343 * account here, so we don't want the 'pending' flag around
345 cred->machine_account_pending = False;
346 filter = talloc_asprintf(cred, SECRETS_KRBTGT_SEARCH,
347 cli_credentials_get_realm(cred),
348 cli_credentials_get_domain(cred));
349 return cli_credentials_set_secrets(cred, SECRETS_PRINCIPALS_DN,
354 * Fill in credentials for the machine trust account, from the secrets database.
356 * @param cred Credentials structure to fill in
357 * @retval NTSTATUS error detailing any failure
359 NTSTATUS cli_credentials_set_stored_principal(struct cli_credentials *cred,
360 const char *serviceprincipal)
363 /* Bleh, nasty recursion issues: We are setting a machine
364 * account here, so we don't want the 'pending' flag around
366 cred->machine_account_pending = False;
367 filter = talloc_asprintf(cred, SECRETS_PRINCIPAL_SEARCH,
368 cli_credentials_get_realm(cred),
369 cli_credentials_get_domain(cred),
371 return cli_credentials_set_secrets(cred, SECRETS_PRINCIPALS_DN,
376 * Ask that when required, the credentials system will be filled with
377 * machine trust account, from the secrets database.
379 * @param cred Credentials structure to fill in
380 * @note This function is used to call the above function after, rather
381 * than during, popt processing.
384 void cli_credentials_set_machine_account_pending(struct cli_credentials *cred)
386 cred->machine_account_pending = True;
390 NTSTATUS cli_credentials_update_all_keytabs(TALLOC_CTX *parent_ctx)
394 struct ldb_context *ldb;
395 struct ldb_message **msgs;
396 const char *attrs[] = { NULL };
397 struct cli_credentials *creds;
402 mem_ctx = talloc_new(parent_ctx);
404 return NT_STATUS_NO_MEMORY;
407 /* Local secrets are stored in secrets.ldb */
408 ldb = secrets_db_connect(mem_ctx);
410 DEBUG(1, ("Could not open secrets.ldb\n"));
411 talloc_free(mem_ctx);
412 return NT_STATUS_ACCESS_DENIED;
415 /* search for the secret record, but only of things we can
417 ldb_ret = gendb_search(ldb,
420 "(&(objectClass=kerberosSecret)(|(secret=*)(ntPwdHash=*)))");
422 DEBUG(1, ("Error looking for kerberos type secrets to push into a keytab:: %s", ldb_errstring(ldb)));
423 talloc_free(mem_ctx);
424 return NT_STATUS_INTERNAL_DB_CORRUPTION;
427 for (i=0; i < ldb_ret; i++) {
428 /* Make a credentials structure from it */
429 creds = cli_credentials_init(mem_ctx);
431 DEBUG(1, ("cli_credentials_init failed!"));
432 talloc_free(mem_ctx);
433 return NT_STATUS_NO_MEMORY;
435 cli_credentials_set_conf(creds);
436 filter = talloc_asprintf(mem_ctx, "dn=%s", ldb_dn_linearize(mem_ctx, msgs[i]->dn));
437 status = cli_credentials_set_secrets(creds, NULL, filter);
438 if (!NT_STATUS_IS_OK(status)) {
439 DEBUG(1, ("Failed to read secrets for keytab update for %s\n",
443 ret = cli_credentials_update_keytab(creds);
445 DEBUG(1, ("Failed to update keytab for %s\n",