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/ndr_samr.h" /* for struct samrPassword */
28 #include "include/secrets.h"
29 #include "system/filesys.h"
32 * Read a file descriptor, and parse it for a password (eg from a file or stdin)
34 * @param credentials Credentials structure on which to set the password
35 * @param fd open file descriptor to read the password from
36 * @param obtained This enum describes how 'specified' this password is
39 BOOL cli_credentials_parse_password_fd(struct cli_credentials *credentials,
40 int fd, enum credentials_obtained obtained)
45 for(p = pass, *p = '\0'; /* ensure that pass is null-terminated */
46 p && p - pass < sizeof(pass);) {
47 switch (read(fd, p, 1)) {
49 if (*p != '\n' && *p != '\0') {
50 *++p = '\0'; /* advance p, and null-terminate pass */
55 *p = '\0'; /* null-terminate it, just in case... */
56 p = NULL; /* then force the loop condition to become false */
59 fprintf(stderr, "Error reading password from file descriptor %d: %s\n", fd, "empty password\n");
64 fprintf(stderr, "Error reading password from file descriptor %d: %s\n",
70 cli_credentials_set_password(credentials, pass, obtained);
75 * Read a named file, and parse it for a password
77 * @param credentials Credentials structure on which to set the password
78 * @param file a named file to read the password from
79 * @param obtained This enum describes how 'specified' this password is
82 BOOL cli_credentials_parse_password_file(struct cli_credentials *credentials, const char *file, enum credentials_obtained obtained)
84 int fd = open(file, O_RDONLY, 0);
88 fprintf(stderr, "Error opening PASSWD_FILE %s: %s\n",
89 file, strerror(errno));
93 ret = cli_credentials_parse_password_fd(credentials, fd, obtained);
101 * Read a named file, and parse it for username, domain, realm and password
103 * @param credentials Credentials structure on which to set the password
104 * @param file a named file to read the details from
105 * @param obtained This enum describes how 'specified' this password is
108 BOOL cli_credentials_parse_file(struct cli_credentials *cred, const char *file, enum credentials_obtained obtained)
111 char *ptr, *val, *param;
115 lines = file_lines_load(file, &numlines, NULL);
119 /* fail if we can't open the credentials file */
120 d_printf("ERROR: Unable to open credentials file!\n");
124 for (i = 0; i < numlines; i++) {
125 len = strlen(lines[i]);
130 /* break up the line into parameter & value.
131 * will need to eat a little whitespace possibly */
133 if (!(ptr = strchr_m (lines[i], '=')))
139 /* eat leading white space */
140 while ((*val!='\0') && ((*val==' ') || (*val=='\t')))
143 if (strwicmp("password", param) == 0) {
144 cli_credentials_set_password(cred, val, obtained);
145 } else if (strwicmp("username", param) == 0) {
146 cli_credentials_set_username(cred, val, obtained);
147 } else if (strwicmp("domain", param) == 0) {
148 cli_credentials_set_domain(cred, val, obtained);
149 } else if (strwicmp("realm", param) == 0) {
150 cli_credentials_set_realm(cred, val, obtained);
152 memset(lines[i], 0, len);
162 * Fill in credentials for the machine trust account, from the secrets database.
164 * @param cred Credentials structure to fill in
165 * @retval NTSTATUS error detailing any failure
167 NTSTATUS cli_credentials_set_secrets(struct cli_credentials *cred,
173 struct ldb_context *ldb;
175 struct ldb_message **msgs;
176 const char *attrs[] = {
184 "msDS-KeyVersionNumber",
191 const char *machine_account;
192 const char *password;
193 const char *old_password;
196 enum netr_SchannelType sct;
197 const char *salt_principal;
200 /* ok, we are going to get it now, don't recurse back here */
201 cred->machine_account_pending = False;
203 /* some other parts of the system will key off this */
204 cred->machine_account = True;
206 mem_ctx = talloc_named(cred, 0, "cli_credentials fetch machine password");
208 /* Local secrets are stored in secrets.ldb */
209 ldb = secrets_db_connect(mem_ctx);
211 DEBUG(1, ("Could not open secrets.ldb\n"));
212 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
215 /* search for the secret record */
216 ldb_ret = gendb_search(ldb,
217 mem_ctx, ldb_dn_explode(mem_ctx, base),
221 DEBUG(1, ("Could not find entry to match filter: %s\n",
223 talloc_free(mem_ctx);
224 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
225 } else if (ldb_ret != 1) {
226 DEBUG(1, ("Found more than one (%d) entry to match filter: %s\n",
228 talloc_free(mem_ctx);
229 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
232 password = ldb_msg_find_string(msgs[0], "secret", NULL);
233 old_password = ldb_msg_find_string(msgs[0], "priorSecret", NULL);
235 machine_account = ldb_msg_find_string(msgs[0], "samAccountName", NULL);
237 if (!machine_account) {
238 DEBUG(1, ("Could not find 'samAccountName' in join record to domain: %s\n",
239 cli_credentials_get_domain(cred)));
240 talloc_free(mem_ctx);
241 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
244 salt_principal = ldb_msg_find_string(msgs[0], "saltPrincipal", NULL);
245 cli_credentials_set_salt_principal(cred, salt_principal);
247 sct = ldb_msg_find_int(msgs[0], "secureChannelType", 0);
249 cli_credentials_set_secure_channel_type(cred, sct);
253 const struct ldb_val *nt_password_hash = ldb_msg_find_ldb_val(msgs[0], "ntPwdHash");
254 struct samr_Password hash;
256 if (nt_password_hash) {
257 memcpy(hash.hash, nt_password_hash->data,
258 MIN(nt_password_hash->length, sizeof(hash.hash)));
260 cli_credentials_set_nt_hash(cred, &hash, CRED_SPECIFIED);
263 DEBUG(1, ("Could not find 'secret' in join record to domain: %s\n",
264 cli_credentials_get_domain(cred)));
265 talloc_free(mem_ctx);
266 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
270 domain = ldb_msg_find_string(msgs[0], "flatname", NULL);
272 cli_credentials_set_domain(cred, domain, CRED_SPECIFIED);
275 realm = ldb_msg_find_string(msgs[0], "realm", NULL);
277 cli_credentials_set_realm(cred, realm, CRED_SPECIFIED);
280 cli_credentials_set_username(cred, machine_account, CRED_SPECIFIED);
282 cli_credentials_set_password(cred, password, CRED_SPECIFIED);
285 cli_credentials_set_kvno(cred, ldb_msg_find_int(msgs[0], "msDS-KeyVersionNumber", 0));
287 /* If there was an external keytab specified by reference in
288 * the LDB, then use this. Otherwise we will make one up
289 * (chewing CPU time) from the password */
290 keytab = ldb_msg_find_string(msgs[0], "krb5Keytab", NULL);
292 cli_credentials_set_keytab(cred, keytab, CRED_SPECIFIED);
294 keytab = ldb_msg_find_string(msgs[0], "privateKeytab", NULL);
296 keytab = talloc_asprintf(mem_ctx, "FILE:%s", private_path(mem_ctx, keytab));
298 cli_credentials_set_keytab(cred, keytab, CRED_SPECIFIED);
302 talloc_free(mem_ctx);
308 * Fill in credentials for the machine trust account, from the secrets database.
310 * @param cred Credentials structure to fill in
311 * @retval NTSTATUS error detailing any failure
313 NTSTATUS cli_credentials_set_machine_account(struct cli_credentials *cred)
315 char *filter = talloc_asprintf(cred, SECRETS_PRIMARY_DOMAIN_FILTER,
316 cli_credentials_get_domain(cred));
317 return cli_credentials_set_secrets(cred, SECRETS_PRIMARY_DOMAIN_DN,
322 * Fill in credentials for the machine trust account, from the secrets database.
324 * @param cred Credentials structure to fill in
325 * @retval NTSTATUS error detailing any failure
327 NTSTATUS cli_credentials_set_krbtgt(struct cli_credentials *cred)
329 char *filter = talloc_asprintf(cred, SECRETS_KRBTGT_SEARCH,
330 cli_credentials_get_realm(cred),
331 cli_credentials_get_domain(cred));
332 return cli_credentials_set_secrets(cred, SECRETS_PRINCIPALS_DN,
337 * Fill in credentials for the machine trust account, from the secrets database.
339 * @param cred Credentials structure to fill in
340 * @retval NTSTATUS error detailing any failure
342 NTSTATUS cli_credentials_set_stored_principal(struct cli_credentials *cred,
343 const char *serviceprincipal)
345 char *filter = talloc_asprintf(cred, SECRETS_PRINCIPAL_SEARCH,
346 cli_credentials_get_realm(cred),
347 cli_credentials_get_domain(cred),
349 return cli_credentials_set_secrets(cred, SECRETS_PRINCIPALS_DN,
354 * Ask that when required, the credentials system will be filled with
355 * machine trust account, from the secrets database.
357 * @param cred Credentials structure to fill in
358 * @note This function is used to call the above function after, rather
359 * than during, popt processing.
362 void cli_credentials_set_machine_account_pending(struct cli_credentials *cred)
364 cred->machine_account_pending = True;
368 NTSTATUS cli_credentials_update_all_keytabs(TALLOC_CTX *parent_ctx)
372 struct ldb_context *ldb;
373 struct ldb_message **msgs;
374 const char *attrs[] = { NULL };
375 struct cli_credentials *creds;
380 mem_ctx = talloc_new(parent_ctx);
382 return NT_STATUS_NO_MEMORY;
385 /* Local secrets are stored in secrets.ldb */
386 ldb = secrets_db_connect(mem_ctx);
388 DEBUG(1, ("Could not open secrets.ldb\n"));
389 talloc_free(mem_ctx);
390 return NT_STATUS_ACCESS_DENIED;
393 /* search for the secret record */
394 ldb_ret = gendb_search(ldb,
397 "objectClass=kerberosSecret");
399 DEBUG(1, ("Error looking for kerberos type secrets to push into a keytab"));
400 talloc_free(mem_ctx);
401 return NT_STATUS_INTERNAL_DB_CORRUPTION;
404 for (i=0; i < ldb_ret; i++) {
405 /* Make a credentials structure from it */
406 creds = cli_credentials_init(mem_ctx);
408 DEBUG(1, ("cli_credentials_init failed!"));
409 talloc_free(mem_ctx);
410 return NT_STATUS_NO_MEMORY;
412 cli_credentials_set_conf(creds);
413 filter = talloc_asprintf(mem_ctx, "dn=%s", ldb_dn_linearize(mem_ctx, msgs[i]->dn));
414 status = cli_credentials_set_secrets(creds, NULL, filter);
415 if (!NT_STATUS_IS_OK(status)) {
416 DEBUG(1, ("Failed to read secrets for keytab update for %s\n",
418 talloc_free(mem_ctx);
421 ret = cli_credentials_update_keytab(creds);
423 DEBUG(1, ("Failed to update keytab for %s\n",
425 talloc_free(mem_ctx);
426 return NT_STATUS_UNSUCCESSFUL;