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/>.
37 /* This MAX_NAME_LEN is a constant defined in krb5.h */
38 #ifndef MAX_KEYTAB_NAME_LEN
39 #define MAX_KEYTAB_NAME_LEN 1100
42 static krb5_error_code ads_keytab_open(krb5_context context,
45 char keytab_str[MAX_KEYTAB_NAME_LEN] = {0};
46 const char *keytab_name = NULL;
47 krb5_error_code ret = 0;
49 switch (lp_kerberos_method()) {
50 case KERBEROS_VERIFY_SYSTEM_KEYTAB:
51 case KERBEROS_VERIFY_SECRETS_AND_KEYTAB:
52 ret = krb5_kt_default_name(context,
54 sizeof(keytab_str) - 2);
56 DBG_WARNING("Failed to get default keytab name");
59 keytab_name = keytab_str;
61 case KERBEROS_VERIFY_DEDICATED_KEYTAB:
62 keytab_name = lp_dedicated_keytab_file();
65 DBG_ERR("Invalid kerberos method set (%d)\n",
66 lp_kerberos_method());
67 ret = KRB5_KT_BADNAME;
71 if (keytab_name == NULL || keytab_name[0] == '\0') {
72 DBG_ERR("Invalid keytab name\n");
73 ret = KRB5_KT_BADNAME;
77 ret = smb_krb5_kt_open(context, keytab_name, true, keytab);
79 DBG_WARNING("smb_krb5_kt_open failed (%s)\n",
88 static bool fill_default_spns(TALLOC_CTX *ctx, const char *machine_name,
89 const char *my_fqdn, const char *spn,
95 *spns = talloc_zero_array(ctx, const char*, 3);
101 psp1 = talloc_asprintf(ctx,
109 if (!strlower_m(&psp1[strlen(spn) + 1])) {
114 psp2 = talloc_asprintf(ctx,
122 if (!strlower_m(&psp2[strlen(spn) + 1])) {
131 static bool ads_set_machine_account_spns(TALLOC_CTX *ctx,
133 const char *service_or_spn,
136 const char **spn_names = NULL;
140 DBG_INFO("Attempting to add/update '%s'\n", service_or_spn);
142 ok = fill_default_spns(ctx,
151 aderr = ads_add_service_principal_names(ads,
154 if (!ADS_ERR_OK(aderr)) {
155 DBG_WARNING("Failed to add service principal name.\n");
162 /**********************************************************************
163 Adds a single service principal, i.e. 'host' to the system keytab
164 ***********************************************************************/
166 int ads_keytab_add_entry(ADS_STRUCT *ads, const char *srvPrinc)
168 krb5_error_code ret = 0;
169 krb5_context context = NULL;
170 krb5_keytab keytab = NULL;
173 krb5_enctype enctypes[6] = {
176 #ifdef HAVE_ENCTYPE_AES128_CTS_HMAC_SHA1_96
177 ENCTYPE_AES128_CTS_HMAC_SHA1_96,
179 #ifdef HAVE_ENCTYPE_AES256_CTS_HMAC_SHA1_96
180 ENCTYPE_AES256_CTS_HMAC_SHA1_96,
182 ENCTYPE_ARCFOUR_HMAC,
185 char *princ_s = NULL;
186 char *short_princ_s = NULL;
187 char *salt_princ_s = NULL;
188 char *password_s = NULL;
190 TALLOC_CTX *tmpctx = NULL;
193 initialize_krb5_error_table();
194 ret = krb5_init_context(&context);
196 DEBUG(1, (__location__ ": could not krb5_init_context: %s\n",
197 error_message(ret)));
201 ret = ads_keytab_open(context, &keytab);
206 /* retrieve the password */
207 if (!secrets_init()) {
208 DEBUG(1, (__location__ ": secrets_init failed\n"));
212 password_s = secrets_fetch_machine_password(lp_workgroup(), NULL, NULL);
214 DEBUG(1, (__location__ ": failed to fetch machine password\n"));
218 ZERO_STRUCT(password);
219 password.data = password_s;
220 password.length = strlen(password_s);
222 /* we need the dNSHostName value here */
223 tmpctx = talloc_init(__location__);
225 DEBUG(0, (__location__ ": talloc_init() failed!\n"));
230 my_fqdn = ads_get_dnshostname(ads, tmpctx, lp_netbios_name());
232 DEBUG(0, (__location__ ": unable to determine machine "
233 "account's dns name in AD!\n"));
238 /* make sure we have a single instance of a the computer account */
239 if (!ads_has_samaccountname(ads, tmpctx, lp_netbios_name())) {
240 DEBUG(0, (__location__ ": unable to determine machine "
241 "account's short name in AD!\n"));
246 /* Construct our principal */
247 if (strchr_m(srvPrinc, '@')) {
248 /* It's a fully-named principal. */
249 princ_s = talloc_asprintf(tmpctx, "%s", srvPrinc);
254 } else if (srvPrinc[strlen(srvPrinc)-1] == '$') {
255 /* It's the machine account, as used by smbclient clients. */
256 princ_s = talloc_asprintf(tmpctx, "%s@%s",
257 srvPrinc, lp_realm());
263 /* It's a normal service principal. Add the SPN now so that we
264 * can obtain credentials for it and double-check the salt value
265 * used to generate the service's keys. */
267 princ_s = talloc_asprintf(tmpctx, "%s/%s@%s",
268 srvPrinc, my_fqdn, lp_realm());
273 short_princ_s = talloc_asprintf(tmpctx, "%s/%s@%s",
274 srvPrinc, lp_netbios_name(),
276 if (short_princ_s == NULL) {
281 /* According to http://support.microsoft.com/kb/326985/en-us,
282 certain principal names are automatically mapped to the
283 host/... principal in the AD account.
284 So only create these in the keytab, not in AD. --jerry */
286 if (!strequal(srvPrinc, "cifs") &&
287 !strequal(srvPrinc, "host")) {
288 if (!ads_set_machine_account_spns(tmpctx,
298 kvno = (krb5_kvno)ads_get_machine_kvno(ads, lp_netbios_name());
300 /* -1 indicates failure, everything else is OK */
301 DEBUG(1, (__location__ ": ads_get_machine_kvno failed to "
302 "determine the system's kvno.\n"));
307 salt_princ_s = kerberos_secrets_fetch_salt_princ();
308 if (salt_princ_s == NULL) {
309 DBG_WARNING("kerberos_secrets_fetch_salt_princ() failed\n");
314 for (i = 0; enctypes[i]; i++) {
316 /* add the fqdn principal to the keytab */
317 ret = smb_krb5_kt_add_entry(context,
327 DEBUG(1, (__location__ ": Failed to add entry to keytab\n"));
331 /* add the short principal name if we have one */
333 ret = smb_krb5_kt_add_entry(context,
343 DEBUG(1, (__location__
344 ": Failed to add short entry to keytab\n"));
351 SAFE_FREE(salt_princ_s);
355 krb5_kt_close(context, keytab);
358 krb5_free_context(context);
363 /**********************************************************************
364 Flushes all entries from the system keytab.
365 ***********************************************************************/
367 int ads_keytab_flush(ADS_STRUCT *ads)
369 krb5_error_code ret = 0;
370 krb5_context context = NULL;
371 krb5_keytab keytab = NULL;
375 initialize_krb5_error_table();
376 ret = krb5_init_context(&context);
378 DEBUG(1, (__location__ ": could not krb5_init_context: %s\n",
379 error_message(ret)));
383 ret = ads_keytab_open(context, &keytab);
388 kvno = (krb5_kvno)ads_get_machine_kvno(ads, lp_netbios_name());
390 /* -1 indicates a failure */
391 DEBUG(1, (__location__ ": Error determining the kvno.\n"));
395 /* Seek and delete old keytab entries */
396 ret = smb_krb5_kt_seek_and_delete_old_entries(context,
408 aderr = ads_clear_service_principal_names(ads, lp_netbios_name());
409 if (!ADS_ERR_OK(aderr)) {
410 DEBUG(1, (__location__ ": Error while clearing service "
411 "principal listings in LDAP.\n"));
417 krb5_kt_close(context, keytab);
420 krb5_free_context(context);
425 /**********************************************************************
426 Adds all the required service principals to the system keytab.
427 ***********************************************************************/
429 int ads_keytab_create_default(ADS_STRUCT *ads)
431 krb5_error_code ret = 0;
432 krb5_context context = NULL;
433 krb5_keytab keytab = NULL;
434 krb5_kt_cursor cursor = {0};
435 krb5_keytab_entry kt_entry = {0};
438 char *sam_account_name, *upn;
439 char **oldEntries = NULL, *princ_s[26];
448 ZERO_STRUCT(kt_entry);
451 frame = talloc_stackframe();
457 status = ads_get_service_principal_names(frame,
462 if (!ADS_ERR_OK(status)) {
467 for (i = 0; i < num_spns; i++) {
471 srv_princ = strlower_talloc(frame, spn_array[i]);
472 if (srv_princ == NULL) {
477 p = strchr_m(srv_princ, '/');
483 /* Add the SPNs found on the DC */
484 ret = ads_keytab_add_entry(ads, srv_princ);
486 DEBUG(1, ("ads_keytab_add_entry failed while "
487 "adding '%s' principal.\n",
493 #if 0 /* don't create the CIFS/... keytab entries since no one except smbd
494 really needs them and we will fall back to verifying against
497 ret = ads_keytab_add_entry(ads, "cifs"));
499 DEBUG(1, (__location__ ": ads_keytab_add_entry failed while "
500 "adding 'cifs'.\n"));
505 memset(princ_s, '\0', sizeof(princ_s));
507 initialize_krb5_error_table();
508 ret = krb5_init_context(&context);
510 DEBUG(1, (__location__ ": could not krb5_init_context: %s\n",
511 error_message(ret)));
515 machine_name = talloc_strdup(frame, lp_netbios_name());
521 /* now add the userPrincipalName and sAMAccountName entries */
522 ok = ads_has_samaccountname(ads, frame, machine_name);
524 DEBUG(0, (__location__ ": unable to determine machine "
525 "account's name in AD!\n"));
531 * append '$' to netbios name so 'ads_keytab_add_entry' recognises
532 * it as a machine account rather than a service or Windows SPN.
534 sam_account_name = talloc_asprintf(frame, "%s$",machine_name);
535 if (sam_account_name == NULL) {
539 /* upper case the sAMAccountName to make it easier for apps to
540 know what case to use in the keytab file */
541 if (!strupper_m(sam_account_name)) {
546 ret = ads_keytab_add_entry(ads, sam_account_name);
548 DEBUG(1, (__location__ ": ads_keytab_add_entry() failed "
549 "while adding sAMAccountName (%s)\n",
554 /* remember that not every machine account will have a upn */
555 upn = ads_get_upn(ads, frame, machine_name);
557 ret = ads_keytab_add_entry(ads, upn);
559 DEBUG(1, (__location__ ": ads_keytab_add_entry() "
560 "failed while adding UPN (%s)\n", upn));
565 /* Now loop through the keytab and update any other existing entries */
566 kvno = (krb5_kvno)ads_get_machine_kvno(ads, machine_name);
567 if (kvno == (krb5_kvno)-1) {
568 DEBUG(1, (__location__ ": ads_get_machine_kvno() failed to "
569 "determine the system's kvno.\n"));
573 DEBUG(3, (__location__ ": Searching for keytab entries to preserve "
576 ret = ads_keytab_open(context, &keytab);
581 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
582 if (ret != KRB5_KT_END && ret != ENOENT ) {
583 while ((ret = krb5_kt_next_entry(context, keytab,
584 &kt_entry, &cursor)) == 0) {
585 smb_krb5_kt_free_entry(context, &kt_entry);
586 ZERO_STRUCT(kt_entry);
590 krb5_kt_end_seq_get(context, keytab, &cursor);
594 * Hmmm. There is no "rewind" function for the keytab. This means we
595 * have a race condition where someone else could add entries after
596 * we've counted them. Re-open asap to minimise the race. JRA.
598 DEBUG(3, (__location__ ": Found %zd entries in the keytab.\n", found));
603 oldEntries = talloc_zero_array(frame, char *, found + 1);
605 DEBUG(1, (__location__ ": Failed to allocate space to store "
606 "the old keytab entries (talloc failed?).\n"));
611 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
612 if (ret == KRB5_KT_END || ret == ENOENT) {
613 krb5_kt_end_seq_get(context, keytab, &cursor);
618 while (krb5_kt_next_entry(context, keytab, &kt_entry, &cursor) == 0) {
619 if (kt_entry.vno != kvno) {
620 char *ktprinc = NULL;
623 /* This returns a malloc'ed string in ktprinc. */
624 ret = smb_krb5_unparse_name(oldEntries, context,
628 DEBUG(1, (__location__
629 ": smb_krb5_unparse_name failed "
630 "(%s)\n", error_message(ret)));
634 * From looking at the krb5 source they don't seem to
635 * take locale or mb strings into account.
636 * Maybe this is because they assume utf8 ?
637 * In this case we may need to convert from utf8 to
638 * mb charset here ? JRA.
640 p = strchr_m(ktprinc, '@');
645 p = strchr_m(ktprinc, '/');
649 for (i = 0; i < found; i++) {
650 if (!oldEntries[i]) {
651 oldEntries[i] = ktprinc;
654 if (!strcmp(oldEntries[i], ktprinc)) {
655 TALLOC_FREE(ktprinc);
660 TALLOC_FREE(ktprinc);
663 smb_krb5_kt_free_entry(context, &kt_entry);
664 ZERO_STRUCT(kt_entry);
666 krb5_kt_end_seq_get(context, keytab, &cursor);
670 for (i = 0; oldEntries[i]; i++) {
671 ret |= ads_keytab_add_entry(ads, oldEntries[i]);
672 TALLOC_FREE(oldEntries[i]);
676 TALLOC_FREE(oldEntries);
680 if (!all_zero((uint8_t *)&kt_entry, sizeof(kt_entry))) {
681 smb_krb5_kt_free_entry(context, &kt_entry);
683 if (!all_zero((uint8_t *)&cursor, sizeof(cursor)) && keytab) {
684 krb5_kt_end_seq_get(context, keytab, &cursor);
687 krb5_kt_close(context, keytab);
689 krb5_free_context(context);
694 #endif /* HAVE_ADS */
696 /**********************************************************************
698 ***********************************************************************/
700 int ads_keytab_list(const char *keytab_name)
702 krb5_error_code ret = 0;
703 krb5_context context = NULL;
704 krb5_keytab keytab = NULL;
705 krb5_kt_cursor cursor;
706 krb5_keytab_entry kt_entry;
708 ZERO_STRUCT(kt_entry);
711 initialize_krb5_error_table();
712 ret = krb5_init_context(&context);
714 DEBUG(1, (__location__ ": could not krb5_init_context: %s\n",
715 error_message(ret)));
719 if (keytab_name == NULL) {
721 ret = ads_keytab_open(context, &keytab);
726 ret = smb_krb5_kt_open(context, keytab_name, False, &keytab);
729 DEBUG(1, ("smb_krb5_kt_open failed (%s)\n",
730 error_message(ret)));
734 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
740 printf("Vno Type Principal\n");
742 while (krb5_kt_next_entry(context, keytab, &kt_entry, &cursor) == 0) {
744 char *princ_s = NULL;
745 char *etype_s = NULL;
746 krb5_enctype enctype = 0;
748 ret = smb_krb5_unparse_name(talloc_tos(), context,
749 kt_entry.principal, &princ_s);
754 enctype = smb_krb5_kt_get_enctype_from_entry(&kt_entry);
756 ret = smb_krb5_enctype_to_string(context, enctype, &etype_s);
758 (asprintf(&etype_s, "UNKNOWN: %d\n", enctype) == -1)) {
759 TALLOC_FREE(princ_s);
763 printf("%3d %-43s %s\n", kt_entry.vno, etype_s, princ_s);
765 TALLOC_FREE(princ_s);
768 ret = smb_krb5_kt_free_entry(context, &kt_entry);
774 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
779 /* Ensure we don't double free. */
780 ZERO_STRUCT(kt_entry);
784 if (!all_zero((uint8_t *)&kt_entry, sizeof(kt_entry))) {
785 smb_krb5_kt_free_entry(context, &kt_entry);
787 if (!all_zero((uint8_t *)&cursor, sizeof(cursor)) && keytab) {
788 krb5_kt_end_seq_get(context, keytab, &cursor);
792 krb5_kt_close(context, keytab);
795 krb5_free_context(context);
800 #endif /* HAVE_KRB5 */