5770dbf05706809a13a3b075fd496edbab144562
[jelmer/samba4-debian.git] / source / auth / credentials / credentials_files.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    User credentials handling (as regards on-disk files)
5
6    Copyright (C) Jelmer Vernooij 2005
7    Copyright (C) Tim Potter 2001
8    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005
9    
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.
14    
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.
19    
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/>.
22 */
23
24 #include "includes.h"
25 #include "lib/ldb/include/ldb.h"
26 #include "librpc/gen_ndr/samr.h" /* for struct samrPassword */
27 #include "param/secrets.h"
28 #include "system/filesys.h"
29 #include "db_wrap.h"
30 #include "auth/credentials/credentials.h"
31 #include "auth/credentials/credentials_krb5.h"
32 #include "param/param.h"
33
34 /**
35  * Read a file descriptor, and parse it for a password (eg from a file or stdin)
36  *
37  * @param credentials Credentials structure on which to set the password
38  * @param fd open file descriptor to read the password from 
39  * @param obtained This enum describes how 'specified' this password is
40  */
41
42 BOOL cli_credentials_parse_password_fd(struct cli_credentials *credentials, 
43                                        int fd, enum credentials_obtained obtained)
44 {
45         char *p;
46         char pass[128];
47
48         for(p = pass, *p = '\0'; /* ensure that pass is null-terminated */
49                 p && p - pass < sizeof(pass);) {
50                 switch (read(fd, p, 1)) {
51                 case 1:
52                         if (*p != '\n' && *p != '\0') {
53                                 *++p = '\0'; /* advance p, and null-terminate pass */
54                                 break;
55                         }
56                         /* fall through */
57                 case 0:
58                         if (p - pass) {
59                                 *p = '\0'; /* null-terminate it, just in case... */
60                                 p = NULL; /* then force the loop condition to become false */
61                                 break;
62                         } else {
63                                 fprintf(stderr, "Error reading password from file descriptor %d: %s\n", fd, "empty password\n");
64                                 return False;
65                         }
66
67                 default:
68                         fprintf(stderr, "Error reading password from file descriptor %d: %s\n",
69                                         fd, strerror(errno));
70                         return False;
71                 }
72         }
73
74         cli_credentials_set_password(credentials, pass, obtained);
75         return True;
76 }
77
78 /**
79  * Read a named file, and parse it for a password
80  *
81  * @param credentials Credentials structure on which to set the password
82  * @param file a named file to read the password from 
83  * @param obtained This enum describes how 'specified' this password is
84  */
85
86 BOOL cli_credentials_parse_password_file(struct cli_credentials *credentials, const char *file, enum credentials_obtained obtained)
87 {
88         int fd = open(file, O_RDONLY, 0);
89         BOOL ret;
90
91         if (fd < 0) {
92                 fprintf(stderr, "Error opening password file %s: %s\n",
93                                 file, strerror(errno));
94                 return False;
95         }
96
97         ret = cli_credentials_parse_password_fd(credentials, fd, obtained);
98
99         close(fd);
100         
101         return ret;
102 }
103
104 /**
105  * Read a named file, and parse it for username, domain, realm and password
106  *
107  * @param credentials Credentials structure on which to set the password
108  * @param file a named file to read the details from 
109  * @param obtained This enum describes how 'specified' this password is
110  */
111
112 BOOL cli_credentials_parse_file(struct cli_credentials *cred, const char *file, enum credentials_obtained obtained) 
113 {
114         uint16_t len = 0;
115         char *ptr, *val, *param;
116         char **lines;
117         int i, numlines;
118
119         lines = file_lines_load(file, &numlines, NULL);
120
121         if (lines == NULL)
122         {
123                 /* fail if we can't open the credentials file */
124                 d_printf("ERROR: Unable to open credentials file!\n");
125                 return False;
126         }
127
128         for (i = 0; i < numlines; i++) {
129                 len = strlen(lines[i]);
130
131                 if (len == 0)
132                         continue;
133
134                 /* break up the line into parameter & value.
135                  * will need to eat a little whitespace possibly */
136                 param = lines[i];
137                 if (!(ptr = strchr_m (lines[i], '=')))
138                         continue;
139
140                 val = ptr+1;
141                 *ptr = '\0';
142
143                 /* eat leading white space */
144                 while ((*val!='\0') && ((*val==' ') || (*val=='\t')))
145                         val++;
146
147                 if (strwicmp("password", param) == 0) {
148                         cli_credentials_set_password(cred, val, obtained);
149                 } else if (strwicmp("username", param) == 0) {
150                         cli_credentials_set_username(cred, val, obtained);
151                 } else if (strwicmp("domain", param) == 0) {
152                         cli_credentials_set_domain(cred, val, obtained);
153                 } else if (strwicmp("realm", param) == 0) {
154                         cli_credentials_set_realm(cred, val, obtained);
155                 }
156                 memset(lines[i], 0, len);
157         }
158
159         talloc_free(lines);
160
161         return True;
162 }
163
164
165 /**
166  * Fill in credentials for the machine trust account, from the secrets database.
167  * 
168  * @param cred Credentials structure to fill in
169  * @retval NTSTATUS error detailing any failure
170  */
171 NTSTATUS cli_credentials_set_secrets(struct cli_credentials *cred, 
172                                      struct ldb_context *ldb,
173                                      const char *base,
174                                      const char *filter)
175 {
176         TALLOC_CTX *mem_ctx;
177         
178         int ldb_ret;
179         struct ldb_message **msgs;
180         const char *attrs[] = {
181                 "secret",
182                 "priorSecret",
183                 "samAccountName",
184                 "flatname",
185                 "realm",
186                 "secureChannelType",
187                 "unicodePwd",
188                 "msDS-KeyVersionNumber",
189                 "saltPrincipal",
190                 "privateKeytab",
191                 "krb5Keytab",
192                 "servicePrincipalName",
193                 NULL
194         };
195         
196         const char *machine_account;
197         const char *password;
198         const char *old_password;
199         const char *domain;
200         const char *realm;
201         enum netr_SchannelType sct;
202         const char *salt_principal;
203         const char *keytab;
204         
205         /* ok, we are going to get it now, don't recurse back here */
206         cred->machine_account_pending = False;
207
208         /* some other parts of the system will key off this */
209         cred->machine_account = True;
210
211         mem_ctx = talloc_named(cred, 0, "cli_credentials fetch machine password");
212
213         if (!ldb) {
214                 /* Local secrets are stored in secrets.ldb */
215                 ldb = secrets_db_connect(mem_ctx);
216                 if (!ldb) {
217                         /* set anonymous as the fallback, if the machine account won't work */
218                         cli_credentials_set_anonymous(cred);
219                         DEBUG(1, ("Could not open secrets.ldb\n"));
220                         return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
221                 }
222         }
223
224         /* search for the secret record */
225         ldb_ret = gendb_search(ldb,
226                                mem_ctx, ldb_dn_new(mem_ctx, ldb, base), 
227                                &msgs, attrs,
228                                "%s", filter);
229         if (ldb_ret == 0) {
230                 DEBUG(1, ("Could not find entry to match filter: '%s' base: '%s'\n",
231                           filter, base));
232                 /* set anonymous as the fallback, if the machine account won't work */
233                 cli_credentials_set_anonymous(cred);
234                 talloc_free(mem_ctx);
235                 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
236         } else if (ldb_ret != 1) {
237                 DEBUG(1, ("Found more than one (%d) entry to match filter: '%s' base: '%s'\n",
238                           ldb_ret, filter, base));
239                 /* set anonymous as the fallback, if the machine account won't work */
240                 cli_credentials_set_anonymous(cred);
241                 talloc_free(mem_ctx);
242                 return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
243         }
244         
245         password = ldb_msg_find_attr_as_string(msgs[0], "secret", NULL);
246         old_password = ldb_msg_find_attr_as_string(msgs[0], "priorSecret", NULL);
247
248         machine_account = ldb_msg_find_attr_as_string(msgs[0], "samAccountName", NULL);
249
250         if (!machine_account) {
251                 machine_account = ldb_msg_find_attr_as_string(msgs[0], "servicePrincipalName", NULL);
252                 
253                 if (!machine_account) {
254                         DEBUG(1, ("Could not find 'samAccountName' in join record to domain: %s: filter: '%s' base: '%s'\n",
255                                   cli_credentials_get_domain(cred), filter, base));
256                         /* set anonymous as the fallback, if the machine account won't work */
257                         cli_credentials_set_anonymous(cred);
258                         talloc_free(mem_ctx);
259                         return NT_STATUS_CANT_ACCESS_DOMAIN_INFO;
260                 }
261         }
262
263         salt_principal = ldb_msg_find_attr_as_string(msgs[0], "saltPrincipal", NULL);
264         cli_credentials_set_salt_principal(cred, salt_principal);
265         
266         sct = ldb_msg_find_attr_as_int(msgs[0], "secureChannelType", 0);
267         if (sct) { 
268                 cli_credentials_set_secure_channel_type(cred, sct);
269         }
270         
271         if (!password) {
272                 const struct ldb_val *nt_password_hash = ldb_msg_find_ldb_val(msgs[0], "unicodePwd");
273                 struct samr_Password hash;
274                 ZERO_STRUCT(hash);
275                 if (nt_password_hash) {
276                         memcpy(hash.hash, nt_password_hash->data, 
277                                MIN(nt_password_hash->length, sizeof(hash.hash)));
278                 
279                         cli_credentials_set_nt_hash(cred, &hash, CRED_SPECIFIED);
280                 } else {
281                         cli_credentials_set_password(cred, NULL, CRED_SPECIFIED);
282                 }
283         } else {
284                 cli_credentials_set_password(cred, password, CRED_SPECIFIED);
285         }
286
287         
288         domain = ldb_msg_find_attr_as_string(msgs[0], "flatname", NULL);
289         if (domain) {
290                 cli_credentials_set_domain(cred, domain, CRED_SPECIFIED);
291         }
292
293         realm = ldb_msg_find_attr_as_string(msgs[0], "realm", NULL);
294         if (realm) {
295                 cli_credentials_set_realm(cred, realm, CRED_SPECIFIED);
296         }
297
298         cli_credentials_set_username(cred, machine_account, CRED_SPECIFIED);
299
300         cli_credentials_set_kvno(cred, ldb_msg_find_attr_as_int(msgs[0], "msDS-KeyVersionNumber", 0));
301
302         /* If there was an external keytab specified by reference in
303          * the LDB, then use this.  Otherwise we will make one up
304          * (chewing CPU time) from the password */
305         keytab = ldb_msg_find_attr_as_string(msgs[0], "krb5Keytab", NULL);
306         if (keytab) {
307                 cli_credentials_set_keytab_name(cred, keytab, CRED_SPECIFIED);
308         } else {
309                 keytab = ldb_msg_find_attr_as_string(msgs[0], "privateKeytab", NULL);
310                 if (keytab) {
311                         keytab = talloc_asprintf(mem_ctx, "FILE:%s", private_path(mem_ctx, keytab));
312                         if (keytab) {
313                                 cli_credentials_set_keytab_name(cred, keytab, CRED_SPECIFIED);
314                         }
315                 }
316         }
317         talloc_free(mem_ctx);
318         
319         return NT_STATUS_OK;
320 }
321
322 /**
323  * Fill in credentials for the machine trust account, from the secrets database.
324  * 
325  * @param cred Credentials structure to fill in
326  * @retval NTSTATUS error detailing any failure
327  */
328 NTSTATUS cli_credentials_set_machine_account(struct cli_credentials *cred)
329 {
330         char *filter;
331         /* Bleh, nasty recursion issues: We are setting a machine
332          * account here, so we don't want the 'pending' flag around
333          * any more */
334         cred->machine_account_pending = False;
335         filter = talloc_asprintf(cred, SECRETS_PRIMARY_DOMAIN_FILTER, 
336                                        cli_credentials_get_domain(cred));
337         return cli_credentials_set_secrets(cred, NULL, SECRETS_PRIMARY_DOMAIN_DN,
338                                            filter);
339 }
340
341 /**
342  * Fill in credentials for the machine trust account, from the secrets database.
343  * 
344  * @param cred Credentials structure to fill in
345  * @retval NTSTATUS error detailing any failure
346  */
347 NTSTATUS cli_credentials_set_krbtgt(struct cli_credentials *cred)
348 {
349         char *filter;
350         /* Bleh, nasty recursion issues: We are setting a machine
351          * account here, so we don't want the 'pending' flag around
352          * any more */
353         cred->machine_account_pending = False;
354         filter = talloc_asprintf(cred, SECRETS_KRBTGT_SEARCH,
355                                        cli_credentials_get_realm(cred),
356                                        cli_credentials_get_domain(cred));
357         return cli_credentials_set_secrets(cred, NULL, SECRETS_PRINCIPALS_DN,
358                                            filter);
359 }
360
361 /**
362  * Fill in credentials for the machine trust account, from the secrets database.
363  * 
364  * @param cred Credentials structure to fill in
365  * @retval NTSTATUS error detailing any failure
366  */
367 NTSTATUS cli_credentials_set_stored_principal(struct cli_credentials *cred,
368                                               const char *serviceprincipal)
369 {
370         char *filter;
371         /* Bleh, nasty recursion issues: We are setting a machine
372          * account here, so we don't want the 'pending' flag around
373          * any more */
374         cred->machine_account_pending = False;
375         filter = talloc_asprintf(cred, SECRETS_PRINCIPAL_SEARCH,
376                                  cli_credentials_get_realm(cred),
377                                  cli_credentials_get_domain(cred),
378                                  serviceprincipal);
379         return cli_credentials_set_secrets(cred, NULL, SECRETS_PRINCIPALS_DN,
380                                            filter);
381 }
382
383 /**
384  * Ask that when required, the credentials system will be filled with
385  * machine trust account, from the secrets database.
386  * 
387  * @param cred Credentials structure to fill in
388  * @note This function is used to call the above function after, rather 
389  *       than during, popt processing.
390  *
391  */
392 void cli_credentials_set_machine_account_pending(struct cli_credentials *cred)
393 {
394         cred->machine_account_pending = True;
395 }
396
397