]> git.decadent.org.uk Git - nfs-utils.git/blob - utils/gssd/krb5_util.c
Allow any credential to be used for machine credentials
[nfs-utils.git] / utils / gssd / krb5_util.c
1 /*
2  *  Adapted in part from MIT Kerberos 5-1.2.1 slave/kprop.c and from
3  *  http://docs.sun.com/?p=/doc/816-1331/6m7oo9sms&a=view
4  *
5  *  Copyright (c) 2002-2004 The Regents of the University of Michigan.
6  *  All rights reserved.
7  *
8  *  Andy Adamson <andros@umich.edu>
9  *  J. Bruce Fields <bfields@umich.edu>
10  *  Marius Aamodt Eriksen <marius@umich.edu>
11  *  Kevin Coffman <kwc@umich.edu>
12  */
13
14 /*
15  * slave/kprop.c
16  *
17  * Copyright 1990,1991 by the Massachusetts Institute of Technology.
18  * All Rights Reserved.
19  *
20  * Export of this software from the United States of America may
21  *   require a specific license from the United States Government.
22  *   It is the responsibility of any person or organization contemplating
23  *   export to obtain such a license before exporting.
24  *
25  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
26  * distribute this software and its documentation for any purpose and
27  * without fee is hereby granted, provided that the above copyright
28  * notice appear in all copies and that both that copyright notice and
29  * this permission notice appear in supporting documentation, and that
30  * the name of M.I.T. not be used in advertising or publicity pertaining
31  * to distribution of the software without specific, written prior
32  * permission.  Furthermore if you modify this software you must label
33  * your software as modified software and not distribute it in such a
34  * fashion that it might be confused with the original M.I.T. software.
35  * M.I.T. makes no representations about the suitability of
36  * this software for any purpose.  It is provided "as is" without express
37  * or implied warranty.
38  */
39
40 /*
41  * Copyright 1994 by OpenVision Technologies, Inc.
42  *
43  * Permission to use, copy, modify, distribute, and sell this software
44  * and its documentation for any purpose is hereby granted without fee,
45  * provided that the above copyright notice appears in all copies and
46  * that both that copyright notice and this permission notice appear in
47  * supporting documentation, and that the name of OpenVision not be used
48  * in advertising or publicity pertaining to distribution of the software
49  * without specific, written prior permission. OpenVision makes no
50  * representations about the suitability of this software for any
51  * purpose.  It is provided "as is" without express or implied warranty.
52  *
53  * OPENVISION DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
54  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
55  * EVENT SHALL OPENVISION BE LIABLE FOR ANY SPECIAL, INDIRECT OR
56  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
57  * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
58  * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
59  * PERFORMANCE OF THIS SOFTWARE.
60  */
61 /*
62   krb5_util.c
63
64   Copyright (c) 2004 The Regents of the University of Michigan.
65   All rights reserved.
66
67   Redistribution and use in source and binary forms, with or without
68   modification, are permitted provided that the following conditions
69   are met:
70
71   1. Redistributions of source code must retain the above copyright
72      notice, this list of conditions and the following disclaimer.
73   2. Redistributions in binary form must reproduce the above copyright
74      notice, this list of conditions and the following disclaimer in the
75      documentation and/or other materials provided with the distribution.
76   3. Neither the name of the University nor the names of its
77      contributors may be used to endorse or promote products derived
78      from this software without specific prior written permission.
79
80   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
81   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
82   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
83   DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
84   FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
85   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
86   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
87   BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
88   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
89   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
90   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
91
92 */
93
94 #ifndef _GNU_SOURCE
95 #define _GNU_SOURCE
96 #endif
97 #include "config.h"
98 #include <sys/param.h>
99 #include <rpc/rpc.h>
100 #include <sys/stat.h>
101 #include <sys/socket.h>
102 #include <arpa/inet.h>
103
104 #include <stdio.h>
105 #include <stdlib.h>
106 #include <string.h>
107 #include <dirent.h>
108 #include <errno.h>
109 #include <time.h>
110 #include <gssapi/gssapi.h>
111 #ifdef USE_PRIVATE_KRB5_FUNCTIONS
112 #include <gssapi/gssapi_krb5.h>
113 #endif
114 #include <krb5.h>
115 #include <rpc/auth_gss.h>
116
117 #include "gssd.h"
118 #include "err_util.h"
119 #include "gss_util.h"
120 #include "gss_oids.h"
121 #include "krb5_util.h"
122
123 /* Global list of principals/cache file names for machine credentials */
124 struct gssd_k5_kt_princ *gssd_k5_kt_princ_list = NULL;
125
126 /*==========================*/
127 /*===  Internal routines ===*/
128 /*==========================*/
129
130 static int select_krb5_ccache(const struct dirent *d);
131 static int gssd_find_existing_krb5_ccache(uid_t uid, struct dirent **d);
132 static int gssd_get_single_krb5_cred(krb5_context context,
133                 krb5_keytab kt, struct gssd_k5_kt_princ *ple);
134 static int gssd_have_realm_ple(void *realm);
135 static int gssd_process_krb5_keytab(krb5_context context, krb5_keytab kt,
136                 char *kt_name);
137
138 /*
139  * Called from the scandir function to weed out potential krb5
140  * credentials cache files
141  *
142  * Returns:
143  *      0 => don't select this one
144  *      1 => select this one
145  */
146 static int
147 select_krb5_ccache(const struct dirent *d)
148 {
149         /*
150          * Note: We used to check d->d_type for DT_REG here,
151          * but apparenlty reiser4 always has DT_UNKNOWN.
152          * Check for IS_REG after stat() call instead.
153          */
154         if (strstr(d->d_name, GSSD_DEFAULT_CRED_PREFIX))
155                 return 1;
156         else
157                 return 0;
158 }
159
160 /*
161  * Look in the ccachedir for files that look like they
162  * are Kerberos Credential Cache files for a given UID.  Return
163  * non-zero and the dirent pointer for the entry most likely to be
164  * what we want. Otherwise, return zero and no dirent pointer.
165  * The caller is responsible for freeing the dirent if one is returned.
166  *
167  * Returns:
168  *      0 => could not find an existing entry
169  *      1 => found an existing entry
170  */
171 static int
172 gssd_find_existing_krb5_ccache(uid_t uid, struct dirent **d)
173 {
174         struct dirent **namelist;
175         int n;
176         int i;
177         int found = 0;
178         struct dirent *best_match_dir = NULL;
179         struct stat best_match_stat, tmp_stat;
180
181         memset(&best_match_stat, 0, sizeof(best_match_stat));
182         *d = NULL;
183         n = scandir(ccachedir, &namelist, select_krb5_ccache, 0);
184         if (n < 0) {
185                 perror("scandir looking for krb5 credentials caches");
186         }
187         else if (n > 0) {
188                 char statname[1024];
189                 for (i = 0; i < n; i++) {
190                         printerr(3, "CC file '%s' being considered\n",
191                                  namelist[i]->d_name);
192                         snprintf(statname, sizeof(statname),
193                                  "%s/%s", ccachedir, namelist[i]->d_name);
194                         if (lstat(statname, &tmp_stat)) {
195                                 printerr(0, "Error doing stat on file '%s'\n",
196                                          statname);
197                                 free(namelist[i]);
198                                 continue;
199                         }
200                         /* Only pick caches owned by the user (uid) */
201                         if (tmp_stat.st_uid != uid) {
202                                 printerr(3, "'%s' owned by %u, not %u\n",
203                                          statname, tmp_stat.st_uid, uid);
204                                 free(namelist[i]);
205                                 continue;
206                         }
207                         if (!S_ISREG(tmp_stat.st_mode)) {
208                                 printerr(3, "'%s' is not a regular file\n",
209                                          statname);
210                                 free(namelist[i]);
211                                 continue;
212                         }
213                         printerr(3, "CC file '%s' matches owner check and has "
214                                  "mtime of %u\n",
215                                  namelist[i]->d_name, tmp_stat.st_mtime);
216                         /*
217                          * if more than one match is found, return the most
218                          * recent (the one with the latest mtime), and
219                          * don't free the dirent
220                          */
221                         if (!found) {
222                                 best_match_dir = namelist[i];
223                                 best_match_stat = tmp_stat;
224                                 found++;
225                         }
226                         else {
227                                 /*
228                                  * If the current match has an mtime later
229                                  * than the one we are looking at, then use
230                                  * the current match.  Otherwise, we still
231                                  * have the best match.
232                                  */
233                                 if (tmp_stat.st_mtime >
234                                             best_match_stat.st_mtime) {
235                                         free(best_match_dir);
236                                         best_match_dir = namelist[i];
237                                         best_match_stat = tmp_stat;
238                                 }
239                                 else {
240                                         free(namelist[i]);
241                                 }
242                                 printerr(3, "CC file '%s' is our "
243                                             "current best match "
244                                             "with mtime of %u\n",
245                                          best_match_dir->d_name,
246                                          best_match_stat.st_mtime);
247                         }
248                 }
249                 free(namelist);
250         }
251         if (found)
252         {
253                 *d = best_match_dir;
254         }
255         return found;
256 }
257
258
259 #ifdef HAVE_SET_ALLOWABLE_ENCTYPES
260 /*
261  * this routine obtains a credentials handle via gss_acquire_cred()
262  * then calls gss_krb5_set_allowable_enctypes() to limit the encryption
263  * types negotiated.
264  *
265  * XXX Should call some function to determine the enctypes supported
266  * by the kernel. (Only need to do that once!)
267  *
268  * Returns:
269  *      0 => all went well
270  *     -1 => there was an error
271  */
272
273 int
274 limit_krb5_enctypes(struct rpc_gss_sec *sec, uid_t uid)
275 {
276         u_int maj_stat, min_stat;
277         gss_cred_id_t credh;
278         gss_OID_set_desc  desired_mechs;
279         krb5_enctype enctypes[] = { ENCTYPE_DES_CBC_CRC };
280         int num_enctypes = sizeof(enctypes) / sizeof(enctypes[0]);
281
282         /* We only care about getting a krb5 cred */
283         desired_mechs.count = 1;
284         desired_mechs.elements = &krb5oid;
285
286         maj_stat = gss_acquire_cred(&min_stat, NULL, 0,
287                                     &desired_mechs, GSS_C_INITIATE,
288                                     &credh, NULL, NULL);
289
290         if (maj_stat != GSS_S_COMPLETE) {
291                 pgsserr("gss_acquire_cred",
292                         maj_stat, min_stat, &krb5oid);
293                 return -1;
294         }
295
296         maj_stat = gss_set_allowable_enctypes(&min_stat, credh, &krb5oid,
297                                              num_enctypes, &enctypes);
298         if (maj_stat != GSS_S_COMPLETE) {
299                 pgsserr("gss_set_allowable_enctypes",
300                         maj_stat, min_stat, &krb5oid);
301                 return -1;
302         }
303         sec->cred = credh;
304
305         return 0;
306 }
307 #endif  /* HAVE_SET_ALLOWABLE_ENCTYPES */
308
309 /*
310  * Obtain credentials via a key in the keytab given
311  * a keytab handle and a gssd_k5_kt_princ structure.
312  * Checks to see if current credentials are expired,
313  * if not, uses the keytab to obtain new credentials.
314  *
315  * Returns:
316  *      0 => success (or credentials have not expired)
317  *      nonzero => error
318  */
319 static int
320 gssd_get_single_krb5_cred(krb5_context context,
321                           krb5_keytab kt,
322                           struct gssd_k5_kt_princ *ple)
323 {
324         krb5_get_init_creds_opt options;
325         krb5_creds my_creds;
326         krb5_ccache ccache = NULL;
327         char kt_name[BUFSIZ];
328         char cc_name[BUFSIZ];
329         int code;
330         time_t now = time(0);
331         char *cache_type;
332
333         memset(&my_creds, 0, sizeof(my_creds));
334
335         if (ple->ccname && ple->endtime > now) {
336                 printerr(2, "INFO: Credentials in CC '%s' are good until %d\n",
337                          ple->ccname, ple->endtime);
338                 code = 0;
339                 goto out;
340         }
341
342         if ((code = krb5_kt_get_name(context, kt, kt_name, BUFSIZ))) {
343                 printerr(0, "ERROR: Unable to get keytab name in "
344                             "gssd_get_single_krb5_cred\n");
345                 goto out;
346         }
347
348         krb5_get_init_creds_opt_init(&options);
349         krb5_get_init_creds_opt_set_address_list(&options, NULL);
350
351 #ifdef TEST_SHORT_LIFETIME
352         /* set a short lifetime (for debugging only!) */
353         printerr(0, "WARNING: Using (debug) short machine cred lifetime!\n");
354         krb5_get_init_creds_opt_set_tkt_life(&options, 5*60);
355 #endif
356         if ((code = krb5_get_init_creds_keytab(context, &my_creds, ple->princ,
357                                           kt, 0, NULL, &options))) {
358                 char *pname;
359                 if ((krb5_unparse_name(context, ple->princ, &pname))) {
360                         pname = NULL;
361                 }
362                 printerr(0, "WARNING: %s while getting initial ticket for "
363                             "principal '%s' from keytab '%s'\n",
364                          error_message(code),
365                          pname ? pname : "<unparsable>", kt_name);
366 #ifdef HAVE_KRB5
367                 if (pname) krb5_free_unparsed_name(context, pname);
368 #else
369                 if (pname) free(pname);
370 #endif
371                 goto out;
372         }
373
374         /*
375          * Initialize cache file which we're going to be using
376          */
377
378         if (use_memcache)
379             cache_type = "MEMORY";
380         else
381             cache_type = "FILE";
382         snprintf(cc_name, sizeof(cc_name), "%s:%s/%s%s_%s",
383                 cache_type,
384                 GSSD_DEFAULT_CRED_DIR, GSSD_DEFAULT_CRED_PREFIX,
385                 GSSD_DEFAULT_MACHINE_CRED_SUFFIX, ple->realm);
386         ple->endtime = my_creds.times.endtime;
387         ple->ccname = strdup(cc_name);
388         if (ple->ccname == NULL) {
389                 printerr(0, "ERROR: no storage to duplicate credentials "
390                             "cache name\n");
391                 code = ENOMEM;
392                 goto out;
393         }
394         if ((code = krb5_cc_resolve(context, cc_name, &ccache))) {
395                 printerr(0, "ERROR: %s while opening credential cache '%s'\n",
396                          error_message(code), cc_name);
397                 goto out;
398         }
399         if ((code = krb5_cc_initialize(context, ccache, ple->princ))) {
400                 printerr(0, "ERROR: %s while initializing credential "
401                          "cache '%s'\n", error_message(code), cc_name);
402                 goto out;
403         }
404         if ((code = krb5_cc_store_cred(context, ccache, &my_creds))) {
405                 printerr(0, "ERROR: %s while storing credentials in '%s'\n",
406                          error_message(code), cc_name);
407                 goto out;
408         }
409
410         code = 0;
411         printerr(1, "Using (machine) credentials cache: '%s'\n", cc_name);
412   out:
413         if (ccache)
414                 krb5_cc_close(context, ccache);
415         krb5_free_cred_contents(context, &my_creds);
416         return (code);
417 }
418
419 /*
420  * Determine if we already have a ple for the given realm
421  *
422  * Returns:
423  *      0 => no ple found for given realm
424  *      1 => found ple for given realm
425  */
426 static int
427 gssd_have_realm_ple(void *r)
428 {
429         struct gssd_k5_kt_princ *ple;
430 #ifdef HAVE_KRB5
431         krb5_data *realm = (krb5_data *)r;
432 #else
433         char *realm = (char *)r;
434 #endif
435
436         for (ple = gssd_k5_kt_princ_list; ple; ple = ple->next) {
437 #ifdef HAVE_KRB5
438                 if ((realm->length == strlen(ple->realm)) &&
439                     (strncmp(realm->data, ple->realm, realm->length) == 0)) {
440 #else
441                 if (strcmp(realm, ple->realm) == 0) {
442 #endif
443                     return 1;
444                 }
445         }
446         return 0;
447 }
448
449 /*
450  * Process the given keytab file and create a list of principals we
451  * might use as machine credentials.
452  *
453  * Returns:
454  *      0 => Sucess
455  *      nonzero => Error
456  */
457 static int
458 gssd_process_krb5_keytab(krb5_context context, krb5_keytab kt, char *kt_name)
459 {
460         krb5_kt_cursor cursor;
461         krb5_keytab_entry kte;
462         krb5_error_code code;
463         struct gssd_k5_kt_princ *ple;
464         int retval = -1;
465
466         /*
467          * Look through each entry in the keytab file and determine
468          * if we might want to use it as machine credentials.  If so,
469          * save info in the global principal list (gssd_k5_kt_princ_list).
470          * Note: (ple == principal list entry)
471          */
472         if ((code = krb5_kt_start_seq_get(context, kt, &cursor))) {
473                 printerr(0, "ERROR: %s while beginning keytab scan "
474                             "for keytab '%s'\n",
475                         error_message(code), kt_name);
476                 retval = code;
477                 goto out;
478         }
479
480         while ((code = krb5_kt_next_entry(context, kt, &kte, &cursor)) == 0) {
481                 char *pname;
482                 if ((code = krb5_unparse_name(context, kte.principal,
483                                               &pname))) {
484                         printerr(0, "WARNING: Skipping keytab entry because "
485                                     "we failed to unparse principal name: %s\n",
486                                  error_message(code));
487                         krb5_kt_free_entry(context, &kte);
488                         continue;
489                 }
490                 printerr(2, "Processing keytab entry for principal '%s'\n",
491                          pname);
492                 /* Just use the first keytab entry found for each realm */
493                 if ((!gssd_have_realm_ple((void *)&kte.principal->realm)) ) {
494                         printerr(2, "We WILL use this entry (%s)\n", pname);
495                         ple = malloc(sizeof(struct gssd_k5_kt_princ));
496                         if (ple == NULL) {
497                                 printerr(0, "ERROR: could not allocate storage "
498                                             "for principal list entry\n");
499 #ifdef HAVE_KRB5
500                                 krb5_free_unparsed_name(context, pname);
501 #else
502                                 free(pname);
503 #endif
504                                 krb5_kt_free_entry(context, &kte);
505                                 retval = ENOMEM;
506                                 goto out;
507                         }
508                         /* These will be filled in later */
509                         ple->next = NULL;
510                         ple->ccname = NULL;
511                         ple->endtime = 0;
512                         if ((ple->realm =
513 #ifdef HAVE_KRB5
514                                 strndup(kte.principal->realm.data,
515                                         kte.principal->realm.length))
516 #else
517                                 strdup(kte.principal->realm))
518 #endif
519                                         == NULL) {
520                                 printerr(0, "ERROR: %s while copying realm to "
521                                             "principal list entry\n",
522                                          "not enough memory");
523 #ifdef HAVE_KRB5
524                                 krb5_free_unparsed_name(context, pname);
525 #else
526                                 free(pname);
527 #endif
528                                 krb5_kt_free_entry(context, &kte);
529                                 retval = ENOMEM;
530                                 goto out;
531                         }
532                         if ((code = krb5_copy_principal(context,
533                                         kte.principal, &ple->princ))) {
534                                 printerr(0, "ERROR: %s while copying principal "
535                                             "to principal list entry\n",
536                                         error_message(code));
537 #ifdef HAVE_KRB5
538                                 krb5_free_unparsed_name(context, pname);
539 #else
540                                 free(pname);
541 #endif
542                                 krb5_kt_free_entry(context, &kte);
543                                 retval = code;
544                                 goto out;
545                         }
546                         if (gssd_k5_kt_princ_list == NULL)
547                                 gssd_k5_kt_princ_list = ple;
548                         else {
549                                 ple->next = gssd_k5_kt_princ_list;
550                                 gssd_k5_kt_princ_list = ple;
551                         }
552                 }
553                 else {
554                         printerr(2, "We will NOT use this entry (%s)\n",
555                                 pname);
556                 }
557 #ifdef HAVE_KRB5
558                 krb5_free_unparsed_name(context, pname);
559 #else
560                 free(pname);
561 #endif
562                 krb5_kt_free_entry(context, &kte);
563         }
564
565         if ((code = krb5_kt_end_seq_get(context, kt, &cursor))) {
566                 printerr(0, "WARNING: %s while ending keytab scan for "
567                             "keytab '%s'\n",
568                          error_message(code), kt_name);
569         }
570
571         retval = 0;
572   out:
573         return retval;
574 }
575
576 /*
577  * Depending on the version of Kerberos, we either need to use
578  * a private function, or simply set the environment variable.
579  */
580 static void
581 gssd_set_krb5_ccache_name(char *ccname)
582 {
583 #ifdef USE_GSS_KRB5_CCACHE_NAME
584         u_int   maj_stat, min_stat;
585
586         printerr(2, "using gss_krb5_ccache_name to select krb5 ccache %s\n",
587                  ccname);
588         maj_stat = gss_krb5_ccache_name(&min_stat, ccname, NULL);
589         if (maj_stat != GSS_S_COMPLETE) {
590                 printerr(0, "WARNING: gss_krb5_ccache_name with "
591                         "name '%s' failed (%s)\n",
592                         ccname, error_message(min_stat));
593         }
594 #else
595         /*
596          * Set the KRB5CCNAME environment variable to tell the krb5 code
597          * which credentials cache to use.  (Instead of using the private
598          * function above for which there is no generic gssapi
599          * equivalent.)
600          */
601         printerr(2, "using environment variable to select krb5 ccache %s\n",
602                  ccname);
603         setenv("KRB5CCNAME", ccname, 1);
604 #endif
605 }
606
607 /*==========================*/
608 /*===  External routines ===*/
609 /*==========================*/
610
611 /*
612  * Attempt to find the best match for a credentials cache file
613  * given only a UID.  We really need more information, but we
614  * do the best we can.
615  *
616  * Returns:
617  *      void
618  */
619 void
620 gssd_setup_krb5_user_gss_ccache(uid_t uid, char *servername)
621 {
622         char                    buf[MAX_NETOBJ_SZ];
623         struct dirent           *d;
624
625         printerr(2, "getting credentials for client with uid %u for "
626                     "server %s\n", uid, servername);
627         memset(buf, 0, sizeof(buf));
628         if (gssd_find_existing_krb5_ccache(uid, &d)) {
629                 snprintf(buf, sizeof(buf), "FILE:%s/%s",
630                         ccachedir, d->d_name);
631                 free(d);
632         }
633         else
634                 snprintf(buf, sizeof(buf), "FILE:%s/%s%u",
635                         ccachedir, GSSD_DEFAULT_CRED_PREFIX, uid);
636         printerr(2, "using %s as credentials cache for client with "
637                     "uid %u for server %s\n", buf, uid, servername);
638         gssd_set_krb5_ccache_name(buf);
639 }
640
641 /*
642  * Let the gss code know where to find the machine credentials ccache.
643  *
644  * Returns:
645  *      void
646  */
647 void
648 gssd_setup_krb5_machine_gss_ccache(char *ccname)
649 {
650         printerr(2, "using %s as credentials cache for machine creds\n",
651                  ccname);
652         gssd_set_krb5_ccache_name(ccname);
653 }
654
655 /*
656  * The first time through this routine, go through the keytab and
657  * determine which keys we will try to use as machine credentials.
658  * Every time through this routine, try to obtain credentials using
659  * the keytab entries selected the first time through.
660  *
661  * Returns:
662  *      0 => obtained one or more credentials
663  *      nonzero => error
664  *
665  */
666
667 int
668 gssd_refresh_krb5_machine_creds(void)
669 {
670         krb5_context context = NULL;
671         krb5_keytab kt = NULL;;
672         krb5_error_code code;
673         int retval = -1;
674         struct gssd_k5_kt_princ *ple;
675         int gotone = 0;
676         static int processed_keytab = 0;
677
678
679         code = krb5_init_context(&context);
680         if (code) {
681                 printerr(0, "ERROR: %s while initializing krb5 in "
682                             "gssd_refresh_krb5_machine_creds\n",
683                          error_message(code));
684                 retval = code;
685                 goto out;
686         }
687
688         printerr(1, "Using keytab file '%s'\n", keytabfile);
689
690         if ((code = krb5_kt_resolve(context, keytabfile, &kt))) {
691                 printerr(0, "ERROR: %s while resolving keytab '%s'\n",
692                          error_message(code), keytabfile);
693                 goto out;
694         }
695
696         /* Only go through the keytab file once.  Only print messages once. */
697         if (gssd_k5_kt_princ_list == NULL && !processed_keytab) {
698                 processed_keytab = 1;
699                 gssd_process_krb5_keytab(context, kt, keytabfile);
700                 if (gssd_k5_kt_princ_list == NULL) {
701                         printerr(0, "ERROR: No usable keytab entries found in "
702                                     "keytab '%s'\n", keytabfile);
703                         printerr(0, "Do you have a valid keytab entry for "
704                                     "%s/<your.host>@<YOUR.REALM> in "
705                                     "keytab file %s ?\n",
706                                     GSSD_SERVICE_NAME, keytabfile);
707                         printerr(0, "Continuing without (machine) credentials "
708                                     "- nfs4 mounts with Kerberos will fail\n");
709                 }
710         }
711
712         /*
713          * If we don't have any keytab entries we liked, then we have a problem
714          */
715         if (gssd_k5_kt_princ_list == NULL) {
716                 retval = ENOENT;
717                 goto out;
718         }
719
720         /*
721          * Now go through the list of saved entries and get initial
722          * credentials for them (We can't do this while making the
723          * list because it messes up the keytab iteration cursor
724          * when we use the keytab to get credentials.)
725          */
726         for (ple = gssd_k5_kt_princ_list; ple; ple = ple->next) {
727                 if ((gssd_get_single_krb5_cred(context, kt, ple)) == 0) {
728                         gotone++;
729                 }
730         }
731         if (!gotone) {
732                 printerr(0, "ERROR: No usable machine credentials obtained\n");
733                 goto out;
734         }
735
736         retval = 0;
737   out:
738         if (kt) krb5_kt_close(context, kt);
739         krb5_free_context(context);
740
741         return retval;
742 }
743
744
745 /*
746  * Return an array of pointers to names of credential cache files
747  * which can be used to try to create gss contexts with a server.
748  *
749  * Returns:
750  *      0 => list is attached
751  *      nonzero => error
752  */
753 int
754 gssd_get_krb5_machine_cred_list(char ***list)
755 {
756         char **l;
757         int listinc = 10;
758         int listsize = listinc;
759         int i = 0;
760         int retval;
761         struct gssd_k5_kt_princ *ple;
762
763         /* Assume failure */
764         retval = -1;
765         *list = (char **) NULL;
766
767         /* Refresh machine credentials */
768         if ((retval = gssd_refresh_krb5_machine_creds())) {
769                 goto out;
770         }
771
772         if ((l = (char **) malloc(listsize * sizeof(char *))) == NULL) {
773                 retval = ENOMEM;
774                 goto out;
775         }
776
777         for (ple = gssd_k5_kt_princ_list; ple; ple = ple->next) {
778                 if (ple->ccname) {
779                         if (i + 1 > listsize) {
780                                 listsize += listinc;
781                                 l = (char **)
782                                         realloc(l, listsize * sizeof(char *));
783                                 if (l == NULL) {
784                                         retval = ENOMEM;
785                                         goto out;
786                                 }
787                         }
788                         if ((l[i++] = strdup(ple->ccname)) == NULL) {
789                                 retval = ENOMEM;
790                                 goto out;
791                         }
792                 }
793         }
794         if (i > 0) {
795                 l[i] = NULL;
796                 *list = l;
797                 retval = 0;
798                 goto out;
799         }
800   out:
801         return retval;
802 }
803
804 /*
805  * Frees the list of names returned in get_krb5_machine_cred_list()
806  */
807 void
808 gssd_free_krb5_machine_cred_list(char **list)
809 {
810         char **n;
811
812         if (list == NULL)
813                 return;
814         for (n = list; n && *n; n++) {
815                 free(*n);
816         }
817         free(list);
818 }
819
820 /*
821  * Called upon exit.  Destroys machine credentials.
822  */
823 void
824 gssd_destroy_krb5_machine_creds(void)
825 {
826         krb5_context context;
827         krb5_error_code code = 0;
828         krb5_ccache ccache;
829         struct gssd_k5_kt_princ *ple;
830
831         code = krb5_init_context(&context);
832         if (code) {
833                 printerr(0, "ERROR: %s while initializing krb5\n",
834                          error_message(code));
835                 goto out;
836         }
837
838         for (ple = gssd_k5_kt_princ_list; ple; ple = ple->next) {
839                 if (!ple->ccname)
840                         continue;
841                 if ((code = krb5_cc_resolve(context, ple->ccname, &ccache))) {
842                         printerr(0, "WARNING: %s while resolving credential "
843                                     "cache '%s' for destruction\n",
844                                  error_message(code), ple->ccname);
845                         continue;
846                 }
847
848                 if ((code = krb5_cc_destroy(context, ccache))) {
849                         printerr(0, "WARNING: %s while destroying credential "
850                                     "cache '%s'\n",
851                                  error_message(code), ple->ccname);
852                 }
853         }
854   out:
855         krb5_free_context(context);
856 }
857