2 Unix SMB/CIFS implementation.
3 kerberos keytab utility library
4 Copyright (C) Andrew Tridgell 2001
5 Copyright (C) Remus Koos 2001
6 Copyright (C) Luke Howard 2003
7 Copyright (C) Jim McDonough (jmcd@us.ibm.com) 2003
8 Copyright (C) Guenther Deschner 2003
9 Copyright (C) Rakesh Patel 2004
10 Copyright (C) Dan Perry 2004
11 Copyright (C) Jeremy Allison 2004
12 Copyright (C) Gerald Carter 2006
14 This program is free software; you can redistribute it and/or modify
15 it under the terms of the GNU General Public License as published by
16 the Free Software Foundation; either version 3 of the License, or
17 (at your option) any later version.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 GNU General Public License for more details.
24 You should have received a copy of the GNU General Public License
25 along with this program. If not, see <http://www.gnu.org/licenses/>.
35 /**********************************************************************
36 **********************************************************************/
38 static krb5_error_code seek_and_delete_old_entries(krb5_context context,
44 bool keep_old_entries)
47 krb5_kt_cursor cursor;
48 krb5_kt_cursor zero_csr;
49 krb5_keytab_entry kt_entry;
50 krb5_keytab_entry zero_kt_entry;
54 ZERO_STRUCT(zero_csr);
55 ZERO_STRUCT(kt_entry);
56 ZERO_STRUCT(zero_kt_entry);
58 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
59 if (ret == KRB5_KT_END && ret == ENOENT ) {
64 DEBUG(3, (__location__ ": Will try to delete old keytab entries\n"));
65 while (!krb5_kt_next_entry(context, keytab, &kt_entry, &cursor)) {
68 if (!flush && (princ_s != NULL)) {
69 ret = smb_krb5_unparse_name(talloc_tos(), context,
73 DEBUG(1, (__location__
74 ": smb_krb5_unparse_name failed "
75 "(%s)\n", error_message(ret)));
79 #ifdef HAVE_KRB5_KT_COMPARE
80 name_ok = krb5_kt_compare(context, &kt_entry,
83 name_ok = (strcmp(ktprinc, princ_s) == 0);
87 DEBUG(10, (__location__ ": ignoring keytab "
88 "entry principal %s, kvno = %d\n",
89 ktprinc, kt_entry.vno));
92 * just free this entry and continue. */
93 ret = smb_krb5_kt_free_entry(context,
95 ZERO_STRUCT(kt_entry);
97 DEBUG(1, (__location__
98 ": smb_krb5_kt_free_entry "
100 error_message(ret)));
104 TALLOC_FREE(ktprinc);
108 TALLOC_FREE(ktprinc);
111 /*------------------------------------------------------------
112 * Save the entries with kvno - 1. This is what microsoft does
113 * to allow people with existing sessions that have kvno - 1
114 * to still work. Otherwise, when the password for the machine
115 * changes, all kerberizied sessions will 'break' until either
116 * the client reboots or the client's session key expires and
117 * they get a new session ticket with the new kvno.
120 if (!flush && (kt_entry.vno == kvno - 1)) {
121 DEBUG(5, (__location__ ": Saving previous (kvno %d) "
122 "entry for principal: %s.\n",
127 if (keep_old_entries) {
128 DEBUG(5, (__location__ ": Saving old (kvno %d) "
129 "entry for principal: %s.\n",
134 DEBUG(5, (__location__ ": Found old entry for principal: %s "
135 "(kvno %d) - trying to remove it.\n",
136 princ_s, kt_entry.vno));
138 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
141 DEBUG(1, (__location__ ": krb5_kt_end_seq_get() "
142 "failed (%s)\n", error_message(ret)));
145 ret = krb5_kt_remove_entry(context, keytab, &kt_entry);
147 DEBUG(1, (__location__ ": krb5_kt_remove_entry() "
148 "failed (%s)\n", error_message(ret)));
152 DEBUG(5, (__location__ ": removed old entry for principal: "
153 "%s (kvno %d).\n", princ_s, kt_entry.vno));
155 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
157 DEBUG(1, (__location__ ": krb5_kt_start_seq() failed "
158 "(%s)\n", error_message(ret)));
161 ret = smb_krb5_kt_free_entry(context, &kt_entry);
162 ZERO_STRUCT(kt_entry);
164 DEBUG(1, (__location__ ": krb5_kt_remove_entry() "
165 "failed (%s)\n", error_message(ret)));
171 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
172 smb_krb5_kt_free_entry(context, &kt_entry);
175 if (memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) {
176 krb5_kt_end_seq_get(context, keytab, &cursor);
183 int smb_krb5_kt_add_entry_ext(krb5_context context,
187 krb5_enctype *enctypes,
190 bool keep_old_entries)
193 krb5_keytab_entry kt_entry;
194 krb5_principal princ = NULL;
197 ZERO_STRUCT(kt_entry);
199 ret = smb_krb5_parse_name(context, princ_s, &princ);
201 DEBUG(1, (__location__ ": smb_krb5_parse_name(%s) "
202 "failed (%s)\n", princ_s, error_message(ret)));
206 /* Seek and delete old keytab entries */
207 ret = seek_and_delete_old_entries(context, keytab, kvno,
208 princ_s, princ, false,
214 /* If we get here, we have deleted all the old entries with kvno's
215 * not equal to the current kvno-1. */
217 /* Now add keytab entries for all encryption types */
218 for (i = 0; enctypes[i]; i++) {
221 keyp = KRB5_KT_KEY(&kt_entry);
223 if (create_kerberos_key_from_string(context, princ,
225 enctypes[i], no_salt)) {
229 kt_entry.principal = princ;
232 DEBUG(3, (__location__ ": adding keytab entry for (%s) with "
233 "encryption type (%d) and version (%d)\n",
234 princ_s, enctypes[i], kt_entry.vno));
235 ret = krb5_kt_add_entry(context, keytab, &kt_entry);
236 krb5_free_keyblock_contents(context, keyp);
237 ZERO_STRUCT(kt_entry);
239 DEBUG(1, (__location__ ": adding entry to keytab "
240 "failed (%s)\n", error_message(ret)));
247 krb5_free_principal(context, princ);
253 static int smb_krb5_kt_add_entry(krb5_context context,
257 krb5_enctype *enctypes,
260 return smb_krb5_kt_add_entry_ext(context,
270 /**********************************************************************
271 Adds a single service principal, i.e. 'host' to the system keytab
272 ***********************************************************************/
274 int ads_keytab_add_entry(ADS_STRUCT *ads, const char *srvPrinc)
276 krb5_error_code ret = 0;
277 krb5_context context = NULL;
278 krb5_keytab keytab = NULL;
281 krb5_enctype enctypes[4] = {
284 ENCTYPE_ARCFOUR_HMAC,
287 char *princ_s = NULL;
288 char *short_princ_s = NULL;
289 char *password_s = NULL;
291 TALLOC_CTX *tmpctx = NULL;
295 initialize_krb5_error_table();
296 ret = krb5_init_context(&context);
298 DEBUG(1, (__location__ ": could not krb5_init_context: %s\n",
299 error_message(ret)));
303 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
305 DEBUG(1, (__location__ ": smb_krb5_open_keytab failed (%s)\n",
306 error_message(ret)));
310 /* retrieve the password */
311 if (!secrets_init()) {
312 DEBUG(1, (__location__ ": secrets_init failed\n"));
316 password_s = secrets_fetch_machine_password(lp_workgroup(), NULL, NULL);
318 DEBUG(1, (__location__ ": failed to fetch machine password\n"));
322 ZERO_STRUCT(password);
323 password.data = password_s;
324 password.length = strlen(password_s);
326 /* we need the dNSHostName value here */
327 tmpctx = talloc_init(__location__);
329 DEBUG(0, (__location__ ": talloc_init() failed!\n"));
334 my_fqdn = ads_get_dnshostname(ads, tmpctx, global_myname());
336 DEBUG(0, (__location__ ": unable to determine machine "
337 "account's dns name in AD!\n"));
342 machine_name = ads_get_samaccountname(ads, tmpctx, global_myname());
344 DEBUG(0, (__location__ ": unable to determine machine "
345 "account's short name in AD!\n"));
349 /*strip the trailing '$' */
350 machine_name[strlen(machine_name)-1] = '\0';
352 /* Construct our principal */
353 if (strchr_m(srvPrinc, '@')) {
354 /* It's a fully-named principal. */
355 princ_s = talloc_asprintf(tmpctx, "%s", srvPrinc);
360 } else if (srvPrinc[strlen(srvPrinc)-1] == '$') {
361 /* It's the machine account, as used by smbclient clients. */
362 princ_s = talloc_asprintf(tmpctx, "%s@%s",
363 srvPrinc, lp_realm());
369 /* It's a normal service principal. Add the SPN now so that we
370 * can obtain credentials for it and double-check the salt value
371 * used to generate the service's keys. */
373 princ_s = talloc_asprintf(tmpctx, "%s/%s@%s",
374 srvPrinc, my_fqdn, lp_realm());
379 short_princ_s = talloc_asprintf(tmpctx, "%s/%s@%s",
380 srvPrinc, machine_name,
387 /* According to http://support.microsoft.com/kb/326985/en-us,
388 certain principal names are automatically mapped to the
389 host/... principal in the AD account.
390 So only create these in the keytab, not in AD. --jerry */
392 if (!strequal(srvPrinc, "cifs") &&
393 !strequal(srvPrinc, "host")) {
394 DEBUG(3, (__location__ ": Attempting to add/update "
397 aderr = ads_add_service_principal_name(ads,
398 global_myname(), my_fqdn, srvPrinc);
399 if (!ADS_ERR_OK(aderr)) {
400 DEBUG(1, (__location__ ": failed to "
401 "ads_add_service_principal_name.\n"));
407 kvno = (krb5_kvno)ads_get_machine_kvno(ads, global_myname());
409 /* -1 indicates failure, everything else is OK */
410 DEBUG(1, (__location__ ": ads_get_machine_kvno failed to "
411 "determine the system's kvno.\n"));
416 /* add the fqdn principal to the keytab */
417 ret = smb_krb5_kt_add_entry(context, keytab, kvno,
418 princ_s, enctypes, password);
420 DEBUG(1, (__location__ ": Failed to add entry to keytab\n"));
424 /* add the short principal name if we have one */
426 ret = smb_krb5_kt_add_entry(context, keytab, kvno,
427 short_princ_s, enctypes, password);
429 DEBUG(1, (__location__
430 ": Failed to add short entry to keytab\n"));
439 krb5_kt_close(context, keytab);
442 krb5_free_context(context);
447 /**********************************************************************
448 Flushes all entries from the system keytab.
449 ***********************************************************************/
451 int ads_keytab_flush(ADS_STRUCT *ads)
453 krb5_error_code ret = 0;
454 krb5_context context = NULL;
455 krb5_keytab keytab = NULL;
459 initialize_krb5_error_table();
460 ret = krb5_init_context(&context);
462 DEBUG(1, (__location__ ": could not krb5_init_context: %s\n",
463 error_message(ret)));
467 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
469 DEBUG(1, (__location__ ": smb_krb5_open_keytab failed (%s)\n",
470 error_message(ret)));
474 kvno = (krb5_kvno)ads_get_machine_kvno(ads, global_myname());
476 /* -1 indicates a failure */
477 DEBUG(1, (__location__ ": Error determining the kvno.\n"));
481 /* Seek and delete old keytab entries */
482 ret = seek_and_delete_old_entries(context, keytab, kvno,
483 NULL, NULL, true, false);
488 aderr = ads_clear_service_principal_names(ads, global_myname());
489 if (!ADS_ERR_OK(aderr)) {
490 DEBUG(1, (__location__ ": Error while clearing service "
491 "principal listings in LDAP.\n"));
497 krb5_kt_close(context, keytab);
500 krb5_free_context(context);
505 /**********************************************************************
506 Adds all the required service principals to the system keytab.
507 ***********************************************************************/
509 int ads_keytab_create_default(ADS_STRUCT *ads)
511 krb5_error_code ret = 0;
512 krb5_context context = NULL;
513 krb5_keytab keytab = NULL;
514 krb5_kt_cursor cursor;
515 krb5_keytab_entry kt_entry;
518 char *sam_account_name, *upn;
519 char **oldEntries = NULL, *princ_s[26];
520 TALLOC_CTX *tmpctx = NULL;
523 /* these are the main ones we need */
524 ret = ads_keytab_add_entry(ads, "host");
526 DEBUG(1, (__location__ ": ads_keytab_add_entry failed while "
527 "adding 'host' principal.\n"));
532 #if 0 /* don't create the CIFS/... keytab entries since no one except smbd
533 really needs them and we will fall back to verifying against
536 ret = ads_keytab_add_entry(ads, "cifs"));
538 DEBUG(1, (__location__ ": ads_keytab_add_entry failed while "
539 "adding 'cifs'.\n"));
544 memset(princ_s, '\0', sizeof(princ_s));
545 ZERO_STRUCT(kt_entry);
548 initialize_krb5_error_table();
549 ret = krb5_init_context(&context);
551 DEBUG(1, (__location__ ": could not krb5_init_context: %s\n",
552 error_message(ret)));
556 tmpctx = talloc_init(__location__);
558 DEBUG(0, (__location__ ": talloc_init() failed!\n"));
563 machine_name = talloc_strdup(tmpctx, global_myname());
569 /* now add the userPrincipalName and sAMAccountName entries */
570 sam_account_name = ads_get_samaccountname(ads, tmpctx, machine_name);
571 if (!sam_account_name) {
572 DEBUG(0, (__location__ ": unable to determine machine "
573 "account's name in AD!\n"));
578 /* upper case the sAMAccountName to make it easier for apps to
579 know what case to use in the keytab file */
580 strupper_m(sam_account_name);
582 ret = ads_keytab_add_entry(ads, sam_account_name);
584 DEBUG(1, (__location__ ": ads_keytab_add_entry() failed "
585 "while adding sAMAccountName (%s)\n",
590 /* remember that not every machine account will have a upn */
591 upn = ads_get_upn(ads, tmpctx, machine_name);
593 ret = ads_keytab_add_entry(ads, upn);
595 DEBUG(1, (__location__ ": ads_keytab_add_entry() "
596 "failed while adding UPN (%s)\n", upn));
601 /* Now loop through the keytab and update any other existing entries */
602 kvno = (krb5_kvno)ads_get_machine_kvno(ads, machine_name);
604 DEBUG(1, (__location__ ": ads_get_machine_kvno() failed to "
605 "determine the system's kvno.\n"));
609 DEBUG(3, (__location__ ": Searching for keytab entries to preserve "
612 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
614 DEBUG(1, (__location__ ": smb_krb5_open_keytab failed (%s)\n",
615 error_message(ret)));
619 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
620 if (ret != KRB5_KT_END && ret != ENOENT ) {
621 while ((ret = krb5_kt_next_entry(context, keytab,
622 &kt_entry, &cursor)) == 0) {
623 smb_krb5_kt_free_entry(context, &kt_entry);
624 ZERO_STRUCT(kt_entry);
628 krb5_kt_end_seq_get(context, keytab, &cursor);
632 * Hmmm. There is no "rewind" function for the keytab. This means we
633 * have a race condition where someone else could add entries after
634 * we've counted them. Re-open asap to minimise the race. JRA.
636 DEBUG(3, (__location__ ": Found %d entries in the keytab.\n", found));
641 oldEntries = talloc_array(tmpctx, char *, found);
643 DEBUG(1, (__location__ ": Failed to allocate space to store "
644 "the old keytab entries (talloc failed?).\n"));
648 memset(oldEntries, '\0', found * sizeof(char *));
650 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
651 if (ret == KRB5_KT_END || ret == ENOENT) {
652 krb5_kt_end_seq_get(context, keytab, &cursor);
657 while (krb5_kt_next_entry(context, keytab, &kt_entry, &cursor) == 0) {
658 if (kt_entry.vno != kvno) {
659 char *ktprinc = NULL;
662 /* This returns a malloc'ed string in ktprinc. */
663 ret = smb_krb5_unparse_name(oldEntries, context,
667 DEBUG(1, (__location__
668 ": smb_krb5_unparse_name failed "
669 "(%s)\n", error_message(ret)));
673 * From looking at the krb5 source they don't seem to
674 * take locale or mb strings into account.
675 * Maybe this is because they assume utf8 ?
676 * In this case we may need to convert from utf8 to
677 * mb charset here ? JRA.
679 p = strchr_m(ktprinc, '@');
684 p = strchr_m(ktprinc, '/');
688 for (i = 0; i < found; i++) {
689 if (!oldEntries[i]) {
690 oldEntries[i] = ktprinc;
693 if (!strcmp(oldEntries[i], ktprinc)) {
694 TALLOC_FREE(ktprinc);
699 TALLOC_FREE(ktprinc);
702 smb_krb5_kt_free_entry(context, &kt_entry);
703 ZERO_STRUCT(kt_entry);
706 for (i = 0; oldEntries[i]; i++) {
707 ret |= ads_keytab_add_entry(ads, oldEntries[i]);
708 TALLOC_FREE(oldEntries[i]);
710 krb5_kt_end_seq_get(context, keytab, &cursor);
714 TALLOC_FREE(oldEntries);
718 krb5_keytab_entry zero_kt_entry;
719 ZERO_STRUCT(zero_kt_entry);
720 if (memcmp(&zero_kt_entry, &kt_entry,
721 sizeof(krb5_keytab_entry))) {
722 smb_krb5_kt_free_entry(context, &kt_entry);
726 krb5_kt_cursor zero_csr;
727 ZERO_STRUCT(zero_csr);
728 if ((memcmp(&cursor, &zero_csr,
729 sizeof(krb5_kt_cursor)) != 0) && keytab) {
730 krb5_kt_end_seq_get(context, keytab, &cursor);
734 krb5_kt_close(context, keytab);
737 krb5_free_context(context);
742 /**********************************************************************
744 ***********************************************************************/
746 int ads_keytab_list(const char *keytab_name)
748 krb5_error_code ret = 0;
749 krb5_context context = NULL;
750 krb5_keytab keytab = NULL;
751 krb5_kt_cursor cursor;
752 krb5_keytab_entry kt_entry;
754 ZERO_STRUCT(kt_entry);
757 initialize_krb5_error_table();
758 ret = krb5_init_context(&context);
760 DEBUG(1, (__location__ ": could not krb5_init_context: %s\n",
761 error_message(ret)));
765 ret = smb_krb5_open_keytab(context, keytab_name, False, &keytab);
767 DEBUG(1, (__location__ ": smb_krb5_open_keytab failed (%s)\n",
768 error_message(ret)));
772 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
777 printf("Vno Type Principal\n");
779 while (krb5_kt_next_entry(context, keytab, &kt_entry, &cursor) == 0) {
781 char *princ_s = NULL;
782 char *etype_s = NULL;
783 krb5_enctype enctype = 0;
785 ret = smb_krb5_unparse_name(talloc_tos(), context,
786 kt_entry.principal, &princ_s);
791 enctype = smb_get_enctype_from_kt_entry(&kt_entry);
793 ret = smb_krb5_enctype_to_string(context, enctype, &etype_s);
795 (asprintf(&etype_s, "UNKNOWN: %d\n", enctype) == -1)) {
796 TALLOC_FREE(princ_s);
800 printf("%3d %s\t\t %s\n", kt_entry.vno, etype_s, princ_s);
802 TALLOC_FREE(princ_s);
805 ret = smb_krb5_kt_free_entry(context, &kt_entry);
811 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
816 /* Ensure we don't double free. */
817 ZERO_STRUCT(kt_entry);
822 krb5_keytab_entry zero_kt_entry;
823 ZERO_STRUCT(zero_kt_entry);
824 if (memcmp(&zero_kt_entry, &kt_entry,
825 sizeof(krb5_keytab_entry))) {
826 smb_krb5_kt_free_entry(context, &kt_entry);
830 krb5_kt_cursor zero_csr;
831 ZERO_STRUCT(zero_csr);
832 if ((memcmp(&cursor, &zero_csr,
833 sizeof(krb5_kt_cursor)) != 0) && keytab) {
834 krb5_kt_end_seq_get(context, keytab, &cursor);
839 krb5_kt_close(context, keytab);
842 krb5_free_context(context);
847 #endif /* HAVE_KRB5 */