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
);
253 /**********************************************************************
254 Adds a single service principal, i.e. 'host' to the system keytab
255 ***********************************************************************/
257 int ads_keytab_add_entry(ADS_STRUCT
*ads
, const char *srvPrinc
)
259 krb5_error_code ret
= 0;
260 krb5_context context
= NULL
;
261 krb5_keytab keytab
= NULL
;
264 krb5_enctype enctypes
[4] = {
267 ENCTYPE_ARCFOUR_HMAC
,
270 char *princ_s
= NULL
;
271 char *short_princ_s
= NULL
;
272 char *password_s
= NULL
;
274 TALLOC_CTX
*tmpctx
= NULL
;
278 initialize_krb5_error_table();
279 ret
= krb5_init_context(&context
);
281 DEBUG(1, (__location__
": could not krb5_init_context: %s\n",
282 error_message(ret
)));
286 ret
= smb_krb5_open_keytab(context
, NULL
, True
, &keytab
);
288 DEBUG(1, (__location__
": smb_krb5_open_keytab failed (%s)\n",
289 error_message(ret
)));
293 /* retrieve the password */
294 if (!secrets_init()) {
295 DEBUG(1, (__location__
": secrets_init failed\n"));
299 password_s
= secrets_fetch_machine_password(lp_workgroup(), NULL
, NULL
);
301 DEBUG(1, (__location__
": failed to fetch machine password\n"));
305 ZERO_STRUCT(password
);
306 password
.data
= password_s
;
307 password
.length
= strlen(password_s
);
309 /* we need the dNSHostName value here */
310 tmpctx
= talloc_init(__location__
);
312 DEBUG(0, (__location__
": talloc_init() failed!\n"));
317 my_fqdn
= ads_get_dnshostname(ads
, tmpctx
, global_myname());
319 DEBUG(0, (__location__
": unable to determine machine "
320 "account's dns name in AD!\n"));
325 machine_name
= ads_get_samaccountname(ads
, tmpctx
, global_myname());
327 DEBUG(0, (__location__
": unable to determine machine "
328 "account's short name in AD!\n"));
332 /*strip the trailing '$' */
333 machine_name
[strlen(machine_name
)-1] = '\0';
335 /* Construct our principal */
336 if (strchr_m(srvPrinc
, '@')) {
337 /* It's a fully-named principal. */
338 princ_s
= talloc_asprintf(tmpctx
, "%s", srvPrinc
);
343 } else if (srvPrinc
[strlen(srvPrinc
)-1] == '$') {
344 /* It's the machine account, as used by smbclient clients. */
345 princ_s
= talloc_asprintf(tmpctx
, "%s@%s",
346 srvPrinc
, lp_realm());
352 /* It's a normal service principal. Add the SPN now so that we
353 * can obtain credentials for it and double-check the salt value
354 * used to generate the service's keys. */
356 princ_s
= talloc_asprintf(tmpctx
, "%s/%s@%s",
357 srvPrinc
, my_fqdn
, lp_realm());
362 short_princ_s
= talloc_asprintf(tmpctx
, "%s/%s@%s",
363 srvPrinc
, machine_name
,
370 /* According to http://support.microsoft.com/kb/326985/en-us,
371 certain principal names are automatically mapped to the
372 host/... principal in the AD account.
373 So only create these in the keytab, not in AD. --jerry */
375 if (!strequal(srvPrinc
, "cifs") &&
376 !strequal(srvPrinc
, "host")) {
377 DEBUG(3, (__location__
": Attempting to add/update "
380 aderr
= ads_add_service_principal_name(ads
,
381 global_myname(), my_fqdn
, srvPrinc
);
382 if (!ADS_ERR_OK(aderr
)) {
383 DEBUG(1, (__location__
": failed to "
384 "ads_add_service_principal_name.\n"));
390 kvno
= (krb5_kvno
)ads_get_machine_kvno(ads
, global_myname());
392 /* -1 indicates failure, everything else is OK */
393 DEBUG(1, (__location__
": ads_get_machine_kvno failed to "
394 "determine the system's kvno.\n"));
399 /* add the fqdn principal to the keytab */
400 ret
= smb_krb5_kt_add_entry(context
, keytab
, kvno
,
401 princ_s
, enctypes
, password
,
404 DEBUG(1, (__location__
": Failed to add entry to keytab\n"));
408 /* add the short principal name if we have one */
410 ret
= smb_krb5_kt_add_entry(context
, keytab
, kvno
,
411 short_princ_s
, enctypes
, password
,
414 DEBUG(1, (__location__
415 ": Failed to add short entry to keytab\n"));
424 krb5_kt_close(context
, keytab
);
427 krb5_free_context(context
);
432 /**********************************************************************
433 Flushes all entries from the system keytab.
434 ***********************************************************************/
436 int ads_keytab_flush(ADS_STRUCT
*ads
)
438 krb5_error_code ret
= 0;
439 krb5_context context
= NULL
;
440 krb5_keytab keytab
= NULL
;
444 initialize_krb5_error_table();
445 ret
= krb5_init_context(&context
);
447 DEBUG(1, (__location__
": could not krb5_init_context: %s\n",
448 error_message(ret
)));
452 ret
= smb_krb5_open_keytab(context
, NULL
, True
, &keytab
);
454 DEBUG(1, (__location__
": smb_krb5_open_keytab failed (%s)\n",
455 error_message(ret
)));
459 kvno
= (krb5_kvno
)ads_get_machine_kvno(ads
, global_myname());
461 /* -1 indicates a failure */
462 DEBUG(1, (__location__
": Error determining the kvno.\n"));
466 /* Seek and delete old keytab entries */
467 ret
= seek_and_delete_old_entries(context
, keytab
, kvno
,
468 NULL
, NULL
, true, false);
473 aderr
= ads_clear_service_principal_names(ads
, global_myname());
474 if (!ADS_ERR_OK(aderr
)) {
475 DEBUG(1, (__location__
": Error while clearing service "
476 "principal listings in LDAP.\n"));
482 krb5_kt_close(context
, keytab
);
485 krb5_free_context(context
);
490 /**********************************************************************
491 Adds all the required service principals to the system keytab.
492 ***********************************************************************/
494 int ads_keytab_create_default(ADS_STRUCT
*ads
)
496 krb5_error_code ret
= 0;
497 krb5_context context
= NULL
;
498 krb5_keytab keytab
= NULL
;
499 krb5_kt_cursor cursor
;
500 krb5_keytab_entry kt_entry
;
503 char *sam_account_name
, *upn
;
504 char **oldEntries
= NULL
, *princ_s
[26];
505 TALLOC_CTX
*tmpctx
= NULL
;
508 /* these are the main ones we need */
509 ret
= ads_keytab_add_entry(ads
, "host");
511 DEBUG(1, (__location__
": ads_keytab_add_entry failed while "
512 "adding 'host' principal.\n"));
517 #if 0 /* don't create the CIFS/... keytab entries since no one except smbd
518 really needs them and we will fall back to verifying against
521 ret
= ads_keytab_add_entry(ads
, "cifs"));
523 DEBUG(1, (__location__
": ads_keytab_add_entry failed while "
524 "adding 'cifs'.\n"));
529 memset(princ_s
, '\0', sizeof(princ_s
));
530 ZERO_STRUCT(kt_entry
);
533 initialize_krb5_error_table();
534 ret
= krb5_init_context(&context
);
536 DEBUG(1, (__location__
": could not krb5_init_context: %s\n",
537 error_message(ret
)));
541 tmpctx
= talloc_init(__location__
);
543 DEBUG(0, (__location__
": talloc_init() failed!\n"));
548 machine_name
= talloc_strdup(tmpctx
, global_myname());
554 /* now add the userPrincipalName and sAMAccountName entries */
555 sam_account_name
= ads_get_samaccountname(ads
, tmpctx
, machine_name
);
556 if (!sam_account_name
) {
557 DEBUG(0, (__location__
": unable to determine machine "
558 "account's name in AD!\n"));
563 /* upper case the sAMAccountName to make it easier for apps to
564 know what case to use in the keytab file */
565 strupper_m(sam_account_name
);
567 ret
= ads_keytab_add_entry(ads
, sam_account_name
);
569 DEBUG(1, (__location__
": ads_keytab_add_entry() failed "
570 "while adding sAMAccountName (%s)\n",
575 /* remember that not every machine account will have a upn */
576 upn
= ads_get_upn(ads
, tmpctx
, machine_name
);
578 ret
= ads_keytab_add_entry(ads
, upn
);
580 DEBUG(1, (__location__
": ads_keytab_add_entry() "
581 "failed while adding UPN (%s)\n", upn
));
586 /* Now loop through the keytab and update any other existing entries */
587 kvno
= (krb5_kvno
)ads_get_machine_kvno(ads
, machine_name
);
589 DEBUG(1, (__location__
": ads_get_machine_kvno() failed to "
590 "determine the system's kvno.\n"));
594 DEBUG(3, (__location__
": Searching for keytab entries to preserve "
597 ret
= smb_krb5_open_keytab(context
, NULL
, True
, &keytab
);
599 DEBUG(1, (__location__
": smb_krb5_open_keytab failed (%s)\n",
600 error_message(ret
)));
604 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
605 if (ret
!= KRB5_KT_END
&& ret
!= ENOENT
) {
606 while ((ret
= krb5_kt_next_entry(context
, keytab
,
607 &kt_entry
, &cursor
)) == 0) {
608 smb_krb5_kt_free_entry(context
, &kt_entry
);
609 ZERO_STRUCT(kt_entry
);
613 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
617 * Hmmm. There is no "rewind" function for the keytab. This means we
618 * have a race condition where someone else could add entries after
619 * we've counted them. Re-open asap to minimise the race. JRA.
621 DEBUG(3, (__location__
": Found %d entries in the keytab.\n", found
));
626 oldEntries
= talloc_array(tmpctx
, char *, found
);
628 DEBUG(1, (__location__
": Failed to allocate space to store "
629 "the old keytab entries (talloc failed?).\n"));
633 memset(oldEntries
, '\0', found
* sizeof(char *));
635 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
636 if (ret
== KRB5_KT_END
|| ret
== ENOENT
) {
637 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
642 while (krb5_kt_next_entry(context
, keytab
, &kt_entry
, &cursor
) == 0) {
643 if (kt_entry
.vno
!= kvno
) {
644 char *ktprinc
= NULL
;
647 /* This returns a malloc'ed string in ktprinc. */
648 ret
= smb_krb5_unparse_name(oldEntries
, context
,
652 DEBUG(1, (__location__
653 ": smb_krb5_unparse_name failed "
654 "(%s)\n", error_message(ret
)));
658 * From looking at the krb5 source they don't seem to
659 * take locale or mb strings into account.
660 * Maybe this is because they assume utf8 ?
661 * In this case we may need to convert from utf8 to
662 * mb charset here ? JRA.
664 p
= strchr_m(ktprinc
, '@');
669 p
= strchr_m(ktprinc
, '/');
673 for (i
= 0; i
< found
; i
++) {
674 if (!oldEntries
[i
]) {
675 oldEntries
[i
] = ktprinc
;
678 if (!strcmp(oldEntries
[i
], ktprinc
)) {
679 TALLOC_FREE(ktprinc
);
684 TALLOC_FREE(ktprinc
);
687 smb_krb5_kt_free_entry(context
, &kt_entry
);
688 ZERO_STRUCT(kt_entry
);
691 for (i
= 0; oldEntries
[i
]; i
++) {
692 ret
|= ads_keytab_add_entry(ads
, oldEntries
[i
]);
693 TALLOC_FREE(oldEntries
[i
]);
695 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
699 TALLOC_FREE(oldEntries
);
703 krb5_keytab_entry zero_kt_entry
;
704 ZERO_STRUCT(zero_kt_entry
);
705 if (memcmp(&zero_kt_entry
, &kt_entry
,
706 sizeof(krb5_keytab_entry
))) {
707 smb_krb5_kt_free_entry(context
, &kt_entry
);
711 krb5_kt_cursor zero_csr
;
712 ZERO_STRUCT(zero_csr
);
713 if ((memcmp(&cursor
, &zero_csr
,
714 sizeof(krb5_kt_cursor
)) != 0) && keytab
) {
715 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
719 krb5_kt_close(context
, keytab
);
722 krb5_free_context(context
);
727 /**********************************************************************
729 ***********************************************************************/
731 int ads_keytab_list(const char *keytab_name
)
733 krb5_error_code ret
= 0;
734 krb5_context context
= NULL
;
735 krb5_keytab keytab
= NULL
;
736 krb5_kt_cursor cursor
;
737 krb5_keytab_entry kt_entry
;
739 ZERO_STRUCT(kt_entry
);
742 initialize_krb5_error_table();
743 ret
= krb5_init_context(&context
);
745 DEBUG(1, (__location__
": could not krb5_init_context: %s\n",
746 error_message(ret
)));
750 ret
= smb_krb5_open_keytab(context
, keytab_name
, False
, &keytab
);
752 DEBUG(1, (__location__
": smb_krb5_open_keytab failed (%s)\n",
753 error_message(ret
)));
757 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
763 printf("Vno Type Principal\n");
765 while (krb5_kt_next_entry(context
, keytab
, &kt_entry
, &cursor
) == 0) {
767 char *princ_s
= NULL
;
768 char *etype_s
= NULL
;
769 krb5_enctype enctype
= 0;
771 ret
= smb_krb5_unparse_name(talloc_tos(), context
,
772 kt_entry
.principal
, &princ_s
);
777 enctype
= smb_get_enctype_from_kt_entry(&kt_entry
);
779 ret
= smb_krb5_enctype_to_string(context
, enctype
, &etype_s
);
781 (asprintf(&etype_s
, "UNKNOWN: %d\n", enctype
) == -1)) {
782 TALLOC_FREE(princ_s
);
786 printf("%3d %s\t\t %s\n", kt_entry
.vno
, etype_s
, princ_s
);
788 TALLOC_FREE(princ_s
);
791 ret
= smb_krb5_kt_free_entry(context
, &kt_entry
);
797 ret
= krb5_kt_end_seq_get(context
, keytab
, &cursor
);
802 /* Ensure we don't double free. */
803 ZERO_STRUCT(kt_entry
);
808 krb5_keytab_entry zero_kt_entry
;
809 ZERO_STRUCT(zero_kt_entry
);
810 if (memcmp(&zero_kt_entry
, &kt_entry
,
811 sizeof(krb5_keytab_entry
))) {
812 smb_krb5_kt_free_entry(context
, &kt_entry
);
816 krb5_kt_cursor zero_csr
;
817 ZERO_STRUCT(zero_csr
);
818 if ((memcmp(&cursor
, &zero_csr
,
819 sizeof(krb5_kt_cursor
)) != 0) && keytab
) {
820 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
825 krb5_kt_close(context
, keytab
);
828 krb5_free_context(context
);
833 #endif /* HAVE_KRB5 */