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/>.
32 /**********************************************************************
33 **********************************************************************/
35 int smb_krb5_kt_add_entry_ext(krb5_context context,
39 krb5_enctype *enctypes,
43 krb5_error_code ret = 0;
44 krb5_kt_cursor cursor;
45 krb5_keytab_entry kt_entry;
46 krb5_principal princ = NULL;
50 ZERO_STRUCT(kt_entry);
53 ret = smb_krb5_parse_name(context, princ_s, &princ);
55 DEBUG(1,("smb_krb5_kt_add_entry_ext: smb_krb5_parse_name(%s) failed (%s)\n", princ_s, error_message(ret)));
59 /* Seek and delete old keytab entries */
60 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
61 if (ret != KRB5_KT_END && ret != ENOENT ) {
62 DEBUG(3,("smb_krb5_kt_add_entry_ext: Will try to delete old keytab entries\n"));
63 while(!krb5_kt_next_entry(context, keytab, &kt_entry, &cursor)) {
64 bool compare_name_ok = False;
66 ret = smb_krb5_unparse_name(context, kt_entry.principal, &ktprinc);
68 DEBUG(1,("smb_krb5_kt_add_entry_ext: smb_krb5_unparse_name failed (%s)\n",
73 /*---------------------------------------------------------------------------
74 * Save the entries with kvno - 1. This is what microsoft does
75 * to allow people with existing sessions that have kvno - 1 to still
76 * work. Otherwise, when the password for the machine changes, all
77 * kerberizied sessions will 'break' until either the client reboots or
78 * the client's session key expires and they get a new session ticket
82 #ifdef HAVE_KRB5_KT_COMPARE
83 compare_name_ok = (krb5_kt_compare(context, &kt_entry, princ, 0, 0) == True);
85 compare_name_ok = (strcmp(ktprinc, princ_s) == 0);
88 if (!compare_name_ok) {
89 DEBUG(10,("smb_krb5_kt_add_entry_ext: ignoring keytab entry principal %s, kvno = %d\n",
90 ktprinc, kt_entry.vno));
95 if (compare_name_ok) {
96 if (kt_entry.vno == kvno - 1) {
97 DEBUG(5,("smb_krb5_kt_add_entry_ext: Saving previous (kvno %d) entry for principal: %s.\n",
100 DEBUG(5,("smb_krb5_kt_add_entry_ext: Found old entry for principal: %s (kvno %d) - trying to remove it.\n",
101 princ_s, kt_entry.vno));
102 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
105 DEBUG(1,("smb_krb5_kt_add_entry_ext: krb5_kt_end_seq_get() failed (%s)\n",
106 error_message(ret)));
109 ret = krb5_kt_remove_entry(context, keytab, &kt_entry);
111 DEBUG(1,("smb_krb5_kt_add_entry_ext: krb5_kt_remove_entry failed (%s)\n",
112 error_message(ret)));
116 DEBUG(5,("smb_krb5_kt_add_entry_ext: removed old entry for principal: %s (kvno %d).\n",
117 princ_s, kt_entry.vno));
119 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
121 DEBUG(1,("smb_krb5_kt_add_entry_ext: krb5_kt_start_seq failed (%s)\n",
122 error_message(ret)));
125 ret = smb_krb5_kt_free_entry(context, &kt_entry);
126 ZERO_STRUCT(kt_entry);
128 DEBUG(1,("smb_krb5_kt_add_entry_ext: krb5_kt_remove_entry failed (%s)\n",
129 error_message(ret)));
136 /* Not a match, just free this entry and continue. */
137 ret = smb_krb5_kt_free_entry(context, &kt_entry);
138 ZERO_STRUCT(kt_entry);
140 DEBUG(1,("smb_krb5_kt_add_entry_ext: smb_krb5_kt_free_entry failed (%s)\n", error_message(ret)));
145 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
148 DEBUG(1,("smb_krb5_kt_add_entry_ext: krb5_kt_end_seq_get failed (%s)\n",error_message(ret)));
153 /* Ensure we don't double free. */
154 ZERO_STRUCT(kt_entry);
157 /* If we get here, we have deleted all the old entries with kvno's not equal to the current kvno-1. */
159 /* Now add keytab entries for all encryption types */
160 for (i = 0; enctypes[i]; i++) {
163 #if !defined(HAVE_KRB5_KEYTAB_ENTRY_KEY) && !defined(HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK)
164 #error krb5_keytab_entry has no key or keyblock member
166 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEY /* MIT */
167 keyp = &kt_entry.key;
169 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK /* Heimdal */
170 keyp = &kt_entry.keyblock;
172 if (create_kerberos_key_from_string(context, princ, &password, keyp, enctypes[i], no_salt)) {
176 kt_entry.principal = princ;
179 DEBUG(3,("smb_krb5_kt_add_entry_ext: adding keytab entry for (%s) with encryption type (%d) and version (%d)\n",
180 princ_s, enctypes[i], kt_entry.vno));
181 ret = krb5_kt_add_entry(context, keytab, &kt_entry);
182 krb5_free_keyblock_contents(context, keyp);
183 ZERO_STRUCT(kt_entry);
185 DEBUG(1,("smb_krb5_kt_add_entry_ext: adding entry to keytab failed (%s)\n", error_message(ret)));
193 krb5_keytab_entry zero_kt_entry;
194 ZERO_STRUCT(zero_kt_entry);
195 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
196 smb_krb5_kt_free_entry(context, &kt_entry);
200 krb5_free_principal(context, princ);
204 krb5_kt_cursor zero_csr;
205 ZERO_STRUCT(zero_csr);
206 if ((memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) && keytab) {
207 krb5_kt_end_seq_get(context, keytab, &cursor);
214 int smb_krb5_kt_add_entry(krb5_context context,
218 krb5_enctype *enctypes,
221 return smb_krb5_kt_add_entry_ext(context,
230 /**********************************************************************
231 Adds a single service principal, i.e. 'host' to the system keytab
232 ***********************************************************************/
234 int ads_keytab_add_entry(ADS_STRUCT *ads, const char *srvPrinc)
236 krb5_error_code ret = 0;
237 krb5_context context = NULL;
238 krb5_keytab keytab = NULL;
241 krb5_enctype enctypes[4] = { ENCTYPE_DES_CBC_CRC, ENCTYPE_DES_CBC_MD5, 0, 0 };
242 char *princ_s = NULL, *short_princ_s = NULL;
243 char *password_s = NULL;
245 TALLOC_CTX *ctx = NULL;
248 #if defined(ENCTYPE_ARCFOUR_HMAC)
249 enctypes[2] = ENCTYPE_ARCFOUR_HMAC;
252 initialize_krb5_error_table();
253 ret = krb5_init_context(&context);
255 DEBUG(1,("ads_keytab_add_entry: could not krb5_init_context: %s\n",error_message(ret)));
259 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
261 DEBUG(1,("ads_keytab_add_entry: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
265 /* retrieve the password */
266 if (!secrets_init()) {
267 DEBUG(1,("ads_keytab_add_entry: secrets_init failed\n"));
271 password_s = secrets_fetch_machine_password(lp_workgroup(), NULL, NULL);
273 DEBUG(1,("ads_keytab_add_entry: failed to fetch machine password\n"));
277 password.data = password_s;
278 password.length = strlen(password_s);
280 /* we need the dNSHostName value here */
282 if ( (ctx = talloc_init("ads_keytab_add_entry")) == NULL ) {
283 DEBUG(0,("ads_keytab_add_entry: talloc() failed!\n"));
288 if ( (my_fqdn = ads_get_dnshostname( ads, ctx, global_myname())) == NULL ) {
289 DEBUG(0,("ads_keytab_add_entry: unable to determine machine account's dns name in AD!\n"));
294 if ( (machine_name = ads_get_samaccountname( ads, ctx, global_myname())) == NULL ) {
295 DEBUG(0,("ads_keytab_add_entry: unable to determine machine account's short name in AD!\n"));
299 /*strip the trailing '$' */
300 machine_name[strlen(machine_name)-1] = '\0';
302 /* Construct our principal */
304 if (strchr_m(srvPrinc, '@')) {
305 /* It's a fully-named principal. */
306 asprintf(&princ_s, "%s", srvPrinc);
307 } else if (srvPrinc[strlen(srvPrinc)-1] == '$') {
308 /* It's the machine account, as used by smbclient clients. */
309 asprintf(&princ_s, "%s@%s", srvPrinc, lp_realm());
311 /* It's a normal service principal. Add the SPN now so that we
312 * can obtain credentials for it and double-check the salt value
313 * used to generate the service's keys. */
315 asprintf(&princ_s, "%s/%s@%s", srvPrinc, my_fqdn, lp_realm());
316 asprintf(&short_princ_s, "%s/%s@%s", srvPrinc, machine_name, lp_realm());
318 /* According to http://support.microsoft.com/kb/326985/en-us,
319 certain principal names are automatically mapped to the host/...
320 principal in the AD account. So only create these in the
321 keytab, not in AD. --jerry */
323 if ( !strequal( srvPrinc, "cifs" ) && !strequal(srvPrinc, "host" ) ) {
324 DEBUG(3,("ads_keytab_add_entry: Attempting to add/update '%s'\n", princ_s));
326 if (!ADS_ERR_OK(ads_add_service_principal_name(ads, global_myname(), my_fqdn, srvPrinc))) {
327 DEBUG(1,("ads_keytab_add_entry: ads_add_service_principal_name failed.\n"));
333 kvno = (krb5_kvno) ads_get_machine_kvno(ads, global_myname());
334 if (kvno == -1) { /* -1 indicates failure, everything else is OK */
335 DEBUG(1,("ads_keytab_add_entry: ads_get_machine_kvno failed to determine the system's kvno.\n"));
340 /* add the fqdn principal to the keytab */
342 ret = smb_krb5_kt_add_entry( context, keytab, kvno, princ_s, enctypes, password );
344 DEBUG(1,("ads_keytab_add_entry: Failed to add entry to keytab file\n"));
348 /* add the short principal name if we have one */
350 if ( short_princ_s ) {
351 ret = smb_krb5_kt_add_entry( context, keytab, kvno, short_princ_s, enctypes, password );
353 DEBUG(1,("ads_keytab_add_entry: Failed to add short entry to keytab file\n"));
359 SAFE_FREE( princ_s );
360 SAFE_FREE( short_princ_s );
364 krb5_kt_close(context, keytab);
367 krb5_free_context(context);
372 /**********************************************************************
373 Flushes all entries from the system keytab.
374 ***********************************************************************/
376 int ads_keytab_flush(ADS_STRUCT *ads)
378 krb5_error_code ret = 0;
379 krb5_context context = NULL;
380 krb5_keytab keytab = NULL;
381 krb5_kt_cursor cursor;
382 krb5_keytab_entry kt_entry;
385 ZERO_STRUCT(kt_entry);
388 initialize_krb5_error_table();
389 ret = krb5_init_context(&context);
391 DEBUG(1,("ads_keytab_flush: could not krb5_init_context: %s\n",error_message(ret)));
395 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
397 DEBUG(1,("ads_keytab_flush: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
401 kvno = (krb5_kvno) ads_get_machine_kvno(ads, global_myname());
402 if (kvno == -1) { /* -1 indicates a failure */
403 DEBUG(1,("ads_keytab_flush: Error determining the system's kvno.\n"));
407 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
408 if (ret != KRB5_KT_END && ret != ENOENT) {
409 while (!krb5_kt_next_entry(context, keytab, &kt_entry, &cursor)) {
410 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
413 DEBUG(1,("ads_keytab_flush: krb5_kt_end_seq_get() failed (%s)\n",error_message(ret)));
416 ret = krb5_kt_remove_entry(context, keytab, &kt_entry);
418 DEBUG(1,("ads_keytab_flush: krb5_kt_remove_entry failed (%s)\n",error_message(ret)));
421 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
423 DEBUG(1,("ads_keytab_flush: krb5_kt_start_seq failed (%s)\n",error_message(ret)));
426 ret = smb_krb5_kt_free_entry(context, &kt_entry);
427 ZERO_STRUCT(kt_entry);
429 DEBUG(1,("ads_keytab_flush: krb5_kt_remove_entry failed (%s)\n",error_message(ret)));
435 /* Ensure we don't double free. */
436 ZERO_STRUCT(kt_entry);
439 if (!ADS_ERR_OK(ads_clear_service_principal_names(ads, global_myname()))) {
440 DEBUG(1,("ads_keytab_flush: Error while clearing service principal listings in LDAP.\n"));
447 krb5_keytab_entry zero_kt_entry;
448 ZERO_STRUCT(zero_kt_entry);
449 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
450 smb_krb5_kt_free_entry(context, &kt_entry);
454 krb5_kt_cursor zero_csr;
455 ZERO_STRUCT(zero_csr);
456 if ((memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) && keytab) {
457 krb5_kt_end_seq_get(context, keytab, &cursor);
461 krb5_kt_close(context, keytab);
464 krb5_free_context(context);
469 /**********************************************************************
470 Adds all the required service principals to the system keytab.
471 ***********************************************************************/
473 int ads_keytab_create_default(ADS_STRUCT *ads)
475 krb5_error_code ret = 0;
476 krb5_context context = NULL;
477 krb5_keytab keytab = NULL;
478 krb5_kt_cursor cursor;
479 krb5_keytab_entry kt_entry;
482 char *sam_account_name, *upn;
483 char **oldEntries = NULL, *princ_s[26];
484 TALLOC_CTX *ctx = NULL;
485 fstring machine_name;
487 memset(princ_s, '\0', sizeof(princ_s));
489 fstrcpy( machine_name, global_myname() );
491 /* these are the main ones we need */
493 if ( (ret = ads_keytab_add_entry(ads, "host") ) != 0 ) {
494 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding 'host'.\n"));
499 #if 0 /* don't create the CIFS/... keytab entries since no one except smbd
500 really needs them and we will fall back to verifying against secrets.tdb */
502 if ( (ret = ads_keytab_add_entry(ads, "cifs")) != 0 ) {
503 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding 'cifs'.\n"));
508 if ( (ctx = talloc_init("ads_keytab_create_default")) == NULL ) {
509 DEBUG(0,("ads_keytab_create_default: talloc() failed!\n"));
513 /* now add the userPrincipalName and sAMAccountName entries */
515 if ( (sam_account_name = ads_get_samaccountname( ads, ctx, machine_name)) == NULL ) {
516 DEBUG(0,("ads_keytab_add_entry: unable to determine machine account's name in AD!\n"));
521 /* upper case the sAMAccountName to make it easier for apps to
522 know what case to use in the keytab file */
524 strupper_m( sam_account_name );
526 if ( (ret = ads_keytab_add_entry(ads, sam_account_name )) != 0 ) {
527 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding sAMAccountName (%s)\n",
532 /* remember that not every machine account will have a upn */
534 upn = ads_get_upn( ads, ctx, machine_name);
536 if ( (ret = ads_keytab_add_entry(ads, upn)) != 0 ) {
537 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding UPN (%s)\n",
546 /* Now loop through the keytab and update any other existing entries... */
548 kvno = (krb5_kvno) ads_get_machine_kvno(ads, machine_name);
550 DEBUG(1,("ads_keytab_create_default: ads_get_machine_kvno failed to determine the system's kvno.\n"));
554 DEBUG(3,("ads_keytab_create_default: Searching for keytab entries to "
555 "preserve and update.\n"));
557 ZERO_STRUCT(kt_entry);
560 initialize_krb5_error_table();
561 ret = krb5_init_context(&context);
563 DEBUG(1,("ads_keytab_create_default: could not krb5_init_context: %s\n",error_message(ret)));
567 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
569 DEBUG(1,("ads_keytab_create_default: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
573 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
574 if (ret != KRB5_KT_END && ret != ENOENT ) {
575 while ((ret = krb5_kt_next_entry(context, keytab, &kt_entry, &cursor)) == 0) {
576 smb_krb5_kt_free_entry(context, &kt_entry);
577 ZERO_STRUCT(kt_entry);
581 krb5_kt_end_seq_get(context, keytab, &cursor);
585 * Hmmm. There is no "rewind" function for the keytab. This means we have a race condition
586 * where someone else could add entries after we've counted them. Re-open asap to minimise
590 DEBUG(3, ("ads_keytab_create_default: Found %d entries in the keytab.\n", found));
594 oldEntries = SMB_MALLOC_ARRAY(char *, found );
596 DEBUG(1,("ads_keytab_create_default: Failed to allocate space to store the old keytab entries (malloc failed?).\n"));
600 memset(oldEntries, '\0', found * sizeof(char *));
602 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
603 if (ret != KRB5_KT_END && ret != ENOENT ) {
604 while (krb5_kt_next_entry(context, keytab, &kt_entry, &cursor) == 0) {
605 if (kt_entry.vno != kvno) {
606 char *ktprinc = NULL;
609 /* This returns a malloc'ed string in ktprinc. */
610 ret = smb_krb5_unparse_name(context, kt_entry.principal, &ktprinc);
612 DEBUG(1,("smb_krb5_unparse_name failed (%s)\n", error_message(ret)));
616 * From looking at the krb5 source they don't seem to take locale
617 * or mb strings into account. Maybe this is because they assume utf8 ?
618 * In this case we may need to convert from utf8 to mb charset here ? JRA.
620 p = strchr_m(ktprinc, '@');
625 p = strchr_m(ktprinc, '/');
629 for (i = 0; i < found; i++) {
630 if (!oldEntries[i]) {
631 oldEntries[i] = ktprinc;
634 if (!strcmp(oldEntries[i], ktprinc)) {
643 smb_krb5_kt_free_entry(context, &kt_entry);
644 ZERO_STRUCT(kt_entry);
647 for (i = 0; oldEntries[i]; i++) {
648 ret |= ads_keytab_add_entry(ads, oldEntries[i]);
649 SAFE_FREE(oldEntries[i]);
651 krb5_kt_end_seq_get(context, keytab, &cursor);
657 SAFE_FREE(oldEntries);
660 krb5_keytab_entry zero_kt_entry;
661 ZERO_STRUCT(zero_kt_entry);
662 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
663 smb_krb5_kt_free_entry(context, &kt_entry);
667 krb5_kt_cursor zero_csr;
668 ZERO_STRUCT(zero_csr);
669 if ((memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) && keytab) {
670 krb5_kt_end_seq_get(context, keytab, &cursor);
674 krb5_kt_close(context, keytab);
677 krb5_free_context(context);
682 /**********************************************************************
684 ***********************************************************************/
686 int ads_keytab_list(const char *keytab_name)
688 krb5_error_code ret = 0;
689 krb5_context context = NULL;
690 krb5_keytab keytab = NULL;
691 krb5_kt_cursor cursor;
692 krb5_keytab_entry kt_entry;
694 ZERO_STRUCT(kt_entry);
697 initialize_krb5_error_table();
698 ret = krb5_init_context(&context);
700 DEBUG(1,("ads_keytab_list: could not krb5_init_context: %s\n",error_message(ret)));
704 ret = smb_krb5_open_keytab(context, keytab_name, False, &keytab);
706 DEBUG(1,("ads_keytab_list: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
710 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
715 printf("Vno Type Principal\n");
717 while (krb5_kt_next_entry(context, keytab, &kt_entry, &cursor) == 0) {
719 char *princ_s = NULL;
720 char *etype_s = NULL;
721 krb5_enctype enctype = 0;
723 ret = smb_krb5_unparse_name(context, kt_entry.principal, &princ_s);
728 enctype = smb_get_enctype_from_kt_entry(&kt_entry);
730 ret = smb_krb5_enctype_to_string(context, enctype, &etype_s);
736 printf("%3d %s\t\t %s\n", kt_entry.vno, etype_s, princ_s);
741 ret = smb_krb5_kt_free_entry(context, &kt_entry);
747 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
752 /* Ensure we don't double free. */
753 ZERO_STRUCT(kt_entry);
758 krb5_keytab_entry zero_kt_entry;
759 ZERO_STRUCT(zero_kt_entry);
760 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
761 smb_krb5_kt_free_entry(context, &kt_entry);
765 krb5_kt_cursor zero_csr;
766 ZERO_STRUCT(zero_csr);
767 if ((memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) && keytab) {
768 krb5_kt_end_seq_get(context, keytab, &cursor);
773 krb5_kt_close(context, keytab);
776 krb5_free_context(context);
781 #endif /* HAVE_KRB5 */