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 static int smb_krb5_kt_add_entry(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
);
255 /**********************************************************************
256 Adds a single service principal, i.e. 'host' to the system keytab
257 ***********************************************************************/
259 int ads_keytab_add_entry(ADS_STRUCT
*ads
, const char *srvPrinc
)
261 krb5_error_code ret
= 0;
262 krb5_context context
= NULL
;
263 krb5_keytab keytab
= NULL
;
266 krb5_enctype enctypes
[6] = {
269 #ifdef HAVE_ENCTYPE_AES128_CTS_HMAC_SHA1_96
270 ENCTYPE_AES128_CTS_HMAC_SHA1_96
,
272 #ifdef HAVE_ENCTYPE_AES256_CTS_HMAC_SHA1_96
273 ENCTYPE_AES256_CTS_HMAC_SHA1_96
,
275 ENCTYPE_ARCFOUR_HMAC
,
278 char *princ_s
= NULL
;
279 char *short_princ_s
= NULL
;
280 char *password_s
= NULL
;
282 TALLOC_CTX
*tmpctx
= NULL
;
286 initialize_krb5_error_table();
287 ret
= krb5_init_context(&context
);
289 DEBUG(1, (__location__
": could not krb5_init_context: %s\n",
290 error_message(ret
)));
294 ret
= smb_krb5_open_keytab(context
, NULL
, True
, &keytab
);
296 DEBUG(1, (__location__
": smb_krb5_open_keytab failed (%s)\n",
297 error_message(ret
)));
301 /* retrieve the password */
302 if (!secrets_init()) {
303 DEBUG(1, (__location__
": secrets_init failed\n"));
307 password_s
= secrets_fetch_machine_password(lp_workgroup(), NULL
, NULL
);
309 DEBUG(1, (__location__
": failed to fetch machine password\n"));
313 ZERO_STRUCT(password
);
314 password
.data
= password_s
;
315 password
.length
= strlen(password_s
);
317 /* we need the dNSHostName value here */
318 tmpctx
= talloc_init(__location__
);
320 DEBUG(0, (__location__
": talloc_init() failed!\n"));
325 my_fqdn
= ads_get_dnshostname(ads
, tmpctx
, lp_netbios_name());
327 DEBUG(0, (__location__
": unable to determine machine "
328 "account's dns name in AD!\n"));
333 machine_name
= ads_get_samaccountname(ads
, tmpctx
, lp_netbios_name());
335 DEBUG(0, (__location__
": unable to determine machine "
336 "account's short name in AD!\n"));
340 /*strip the trailing '$' */
341 machine_name
[strlen(machine_name
)-1] = '\0';
343 /* Construct our principal */
344 if (strchr_m(srvPrinc
, '@')) {
345 /* It's a fully-named principal. */
346 princ_s
= talloc_asprintf(tmpctx
, "%s", srvPrinc
);
351 } else if (srvPrinc
[strlen(srvPrinc
)-1] == '$') {
352 /* It's the machine account, as used by smbclient clients. */
353 princ_s
= talloc_asprintf(tmpctx
, "%s@%s",
354 srvPrinc
, lp_realm());
360 /* It's a normal service principal. Add the SPN now so that we
361 * can obtain credentials for it and double-check the salt value
362 * used to generate the service's keys. */
364 princ_s
= talloc_asprintf(tmpctx
, "%s/%s@%s",
365 srvPrinc
, my_fqdn
, lp_realm());
370 short_princ_s
= talloc_asprintf(tmpctx
, "%s/%s@%s",
371 srvPrinc
, machine_name
,
373 if (short_princ_s
== NULL
) {
378 /* According to http://support.microsoft.com/kb/326985/en-us,
379 certain principal names are automatically mapped to the
380 host/... principal in the AD account.
381 So only create these in the keytab, not in AD. --jerry */
383 if (!strequal(srvPrinc
, "cifs") &&
384 !strequal(srvPrinc
, "host")) {
385 DEBUG(3, (__location__
": Attempting to add/update "
388 aderr
= ads_add_service_principal_name(ads
,
389 lp_netbios_name(), my_fqdn
, srvPrinc
);
390 if (!ADS_ERR_OK(aderr
)) {
391 DEBUG(1, (__location__
": failed to "
392 "ads_add_service_principal_name.\n"));
398 kvno
= (krb5_kvno
)ads_get_machine_kvno(ads
, lp_netbios_name());
400 /* -1 indicates failure, everything else is OK */
401 DEBUG(1, (__location__
": ads_get_machine_kvno failed to "
402 "determine the system's kvno.\n"));
407 /* add the fqdn principal to the keytab */
408 ret
= smb_krb5_kt_add_entry(context
, keytab
, kvno
,
409 princ_s
, enctypes
, password
,
412 DEBUG(1, (__location__
": Failed to add entry to keytab\n"));
416 /* add the short principal name if we have one */
418 ret
= smb_krb5_kt_add_entry(context
, keytab
, kvno
,
419 short_princ_s
, enctypes
, password
,
422 DEBUG(1, (__location__
423 ": Failed to add short entry to keytab\n"));
432 krb5_kt_close(context
, keytab
);
435 krb5_free_context(context
);
440 /**********************************************************************
441 Flushes all entries from the system keytab.
442 ***********************************************************************/
444 int ads_keytab_flush(ADS_STRUCT
*ads
)
446 krb5_error_code ret
= 0;
447 krb5_context context
= NULL
;
448 krb5_keytab keytab
= NULL
;
452 initialize_krb5_error_table();
453 ret
= krb5_init_context(&context
);
455 DEBUG(1, (__location__
": could not krb5_init_context: %s\n",
456 error_message(ret
)));
460 ret
= smb_krb5_open_keytab(context
, NULL
, True
, &keytab
);
462 DEBUG(1, (__location__
": smb_krb5_open_keytab failed (%s)\n",
463 error_message(ret
)));
467 kvno
= (krb5_kvno
)ads_get_machine_kvno(ads
, lp_netbios_name());
469 /* -1 indicates a failure */
470 DEBUG(1, (__location__
": Error determining the kvno.\n"));
474 /* Seek and delete old keytab entries */
475 ret
= seek_and_delete_old_entries(context
, keytab
, kvno
,
476 NULL
, NULL
, true, false);
481 aderr
= ads_clear_service_principal_names(ads
, lp_netbios_name());
482 if (!ADS_ERR_OK(aderr
)) {
483 DEBUG(1, (__location__
": Error while clearing service "
484 "principal listings in LDAP.\n"));
490 krb5_kt_close(context
, keytab
);
493 krb5_free_context(context
);
498 /**********************************************************************
499 Adds all the required service principals to the system keytab.
500 ***********************************************************************/
502 int ads_keytab_create_default(ADS_STRUCT
*ads
)
504 krb5_error_code ret
= 0;
505 krb5_context context
= NULL
;
506 krb5_keytab keytab
= NULL
;
507 krb5_kt_cursor cursor
;
508 krb5_keytab_entry kt_entry
;
511 char *sam_account_name
, *upn
;
512 char **oldEntries
= NULL
, *princ_s
[26];
520 frame
= talloc_stackframe();
526 status
= ads_get_service_principal_names(frame
,
531 if (!ADS_ERR_OK(status
)) {
536 for (i
= 0; i
< num_spns
; i
++) {
540 srv_princ
= strlower_talloc(frame
, spn_array
[i
]);
541 if (srv_princ
== NULL
) {
546 p
= strchr_m(srv_princ
, '/');
552 /* Add the SPNs found on the DC */
553 ret
= ads_keytab_add_entry(ads
, srv_princ
);
555 DEBUG(1, ("ads_keytab_add_entry failed while "
556 "adding '%s' principal.\n",
562 #if 0 /* don't create the CIFS/... keytab entries since no one except smbd
563 really needs them and we will fall back to verifying against
566 ret
= ads_keytab_add_entry(ads
, "cifs"));
568 DEBUG(1, (__location__
": ads_keytab_add_entry failed while "
569 "adding 'cifs'.\n"));
574 memset(princ_s
, '\0', sizeof(princ_s
));
575 ZERO_STRUCT(kt_entry
);
578 initialize_krb5_error_table();
579 ret
= krb5_init_context(&context
);
581 DEBUG(1, (__location__
": could not krb5_init_context: %s\n",
582 error_message(ret
)));
586 machine_name
= talloc_strdup(frame
, lp_netbios_name());
592 /* now add the userPrincipalName and sAMAccountName entries */
593 sam_account_name
= ads_get_samaccountname(ads
, frame
, machine_name
);
594 if (!sam_account_name
) {
595 DEBUG(0, (__location__
": unable to determine machine "
596 "account's name in AD!\n"));
601 /* upper case the sAMAccountName to make it easier for apps to
602 know what case to use in the keytab file */
603 if (!strupper_m(sam_account_name
)) {
608 ret
= ads_keytab_add_entry(ads
, sam_account_name
);
610 DEBUG(1, (__location__
": ads_keytab_add_entry() failed "
611 "while adding sAMAccountName (%s)\n",
616 /* remember that not every machine account will have a upn */
617 upn
= ads_get_upn(ads
, frame
, machine_name
);
619 ret
= ads_keytab_add_entry(ads
, upn
);
621 DEBUG(1, (__location__
": ads_keytab_add_entry() "
622 "failed while adding UPN (%s)\n", upn
));
627 /* Now loop through the keytab and update any other existing entries */
628 kvno
= (krb5_kvno
)ads_get_machine_kvno(ads
, machine_name
);
629 if (kvno
== (krb5_kvno
)-1) {
630 DEBUG(1, (__location__
": ads_get_machine_kvno() failed to "
631 "determine the system's kvno.\n"));
635 DEBUG(3, (__location__
": Searching for keytab entries to preserve "
638 ret
= smb_krb5_open_keytab(context
, NULL
, True
, &keytab
);
640 DEBUG(1, (__location__
": smb_krb5_open_keytab failed (%s)\n",
641 error_message(ret
)));
645 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
646 if (ret
!= KRB5_KT_END
&& ret
!= ENOENT
) {
647 while ((ret
= krb5_kt_next_entry(context
, keytab
,
648 &kt_entry
, &cursor
)) == 0) {
649 smb_krb5_kt_free_entry(context
, &kt_entry
);
650 ZERO_STRUCT(kt_entry
);
654 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
658 * Hmmm. There is no "rewind" function for the keytab. This means we
659 * have a race condition where someone else could add entries after
660 * we've counted them. Re-open asap to minimise the race. JRA.
662 DEBUG(3, (__location__
": Found %zd entries in the keytab.\n", found
));
667 oldEntries
= talloc_zero_array(frame
, char *, found
+ 1);
669 DEBUG(1, (__location__
": Failed to allocate space to store "
670 "the old keytab entries (talloc failed?).\n"));
675 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
676 if (ret
== KRB5_KT_END
|| ret
== ENOENT
) {
677 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
682 while (krb5_kt_next_entry(context
, keytab
, &kt_entry
, &cursor
) == 0) {
683 if (kt_entry
.vno
!= kvno
) {
684 char *ktprinc
= NULL
;
687 /* This returns a malloc'ed string in ktprinc. */
688 ret
= smb_krb5_unparse_name(oldEntries
, context
,
692 DEBUG(1, (__location__
693 ": smb_krb5_unparse_name failed "
694 "(%s)\n", error_message(ret
)));
698 * From looking at the krb5 source they don't seem to
699 * take locale or mb strings into account.
700 * Maybe this is because they assume utf8 ?
701 * In this case we may need to convert from utf8 to
702 * mb charset here ? JRA.
704 p
= strchr_m(ktprinc
, '@');
709 p
= strchr_m(ktprinc
, '/');
713 for (i
= 0; i
< found
; i
++) {
714 if (!oldEntries
[i
]) {
715 oldEntries
[i
] = ktprinc
;
718 if (!strcmp(oldEntries
[i
], ktprinc
)) {
719 TALLOC_FREE(ktprinc
);
724 TALLOC_FREE(ktprinc
);
727 smb_krb5_kt_free_entry(context
, &kt_entry
);
728 ZERO_STRUCT(kt_entry
);
731 for (i
= 0; oldEntries
[i
]; i
++) {
732 ret
|= ads_keytab_add_entry(ads
, oldEntries
[i
]);
733 TALLOC_FREE(oldEntries
[i
]);
735 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
739 TALLOC_FREE(oldEntries
);
743 krb5_keytab_entry zero_kt_entry
;
744 ZERO_STRUCT(zero_kt_entry
);
745 if (memcmp(&zero_kt_entry
, &kt_entry
,
746 sizeof(krb5_keytab_entry
))) {
747 smb_krb5_kt_free_entry(context
, &kt_entry
);
751 krb5_kt_cursor zero_csr
;
752 ZERO_STRUCT(zero_csr
);
753 if ((memcmp(&cursor
, &zero_csr
,
754 sizeof(krb5_kt_cursor
)) != 0) && keytab
) {
755 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
759 krb5_kt_close(context
, keytab
);
762 krb5_free_context(context
);
767 #endif /* HAVE_ADS */
769 /**********************************************************************
771 ***********************************************************************/
773 int ads_keytab_list(const char *keytab_name
)
775 krb5_error_code ret
= 0;
776 krb5_context context
= NULL
;
777 krb5_keytab keytab
= NULL
;
778 krb5_kt_cursor cursor
;
779 krb5_keytab_entry kt_entry
;
781 ZERO_STRUCT(kt_entry
);
784 initialize_krb5_error_table();
785 ret
= krb5_init_context(&context
);
787 DEBUG(1, (__location__
": could not krb5_init_context: %s\n",
788 error_message(ret
)));
792 ret
= smb_krb5_open_keytab(context
, keytab_name
, False
, &keytab
);
794 DEBUG(1, (__location__
": smb_krb5_open_keytab failed (%s)\n",
795 error_message(ret
)));
799 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
805 printf("Vno Type Principal\n");
807 while (krb5_kt_next_entry(context
, keytab
, &kt_entry
, &cursor
) == 0) {
809 char *princ_s
= NULL
;
810 char *etype_s
= NULL
;
811 krb5_enctype enctype
= 0;
813 ret
= smb_krb5_unparse_name(talloc_tos(), context
,
814 kt_entry
.principal
, &princ_s
);
819 enctype
= smb_get_enctype_from_kt_entry(&kt_entry
);
821 ret
= smb_krb5_enctype_to_string(context
, enctype
, &etype_s
);
823 (asprintf(&etype_s
, "UNKNOWN: %d\n", enctype
) == -1)) {
824 TALLOC_FREE(princ_s
);
828 printf("%3d %-43s %s\n", kt_entry
.vno
, etype_s
, princ_s
);
830 TALLOC_FREE(princ_s
);
833 ret
= smb_krb5_kt_free_entry(context
, &kt_entry
);
839 ret
= krb5_kt_end_seq_get(context
, keytab
, &cursor
);
844 /* Ensure we don't double free. */
845 ZERO_STRUCT(kt_entry
);
850 krb5_keytab_entry zero_kt_entry
;
851 ZERO_STRUCT(zero_kt_entry
);
852 if (memcmp(&zero_kt_entry
, &kt_entry
,
853 sizeof(krb5_keytab_entry
))) {
854 smb_krb5_kt_free_entry(context
, &kt_entry
);
858 krb5_kt_cursor zero_csr
;
859 ZERO_STRUCT(zero_csr
);
860 if ((memcmp(&cursor
, &zero_csr
,
861 sizeof(krb5_kt_cursor
)) != 0) && keytab
) {
862 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
867 krb5_kt_close(context
, keytab
);
870 krb5_free_context(context
);
875 #endif /* HAVE_KRB5 */