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 int smb_krb5_kt_add_entry_ext(krb5_context context,
42 krb5_enctype *enctypes,
45 bool keep_old_entries)
47 krb5_error_code ret = 0;
48 krb5_kt_cursor cursor;
49 krb5_keytab_entry kt_entry;
50 krb5_principal princ = NULL;
54 ZERO_STRUCT(kt_entry);
57 ret = smb_krb5_parse_name(context, princ_s, &princ);
59 DEBUG(1,("smb_krb5_kt_add_entry_ext: smb_krb5_parse_name(%s) failed (%s)\n", princ_s, error_message(ret)));
63 /* Seek and delete old keytab entries */
64 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
65 if (ret != KRB5_KT_END && ret != ENOENT ) {
66 DEBUG(3,("smb_krb5_kt_add_entry_ext: Will try to delete old keytab entries\n"));
67 while(!krb5_kt_next_entry(context, keytab, &kt_entry, &cursor)) {
68 bool compare_name_ok = False;
70 ret = smb_krb5_unparse_name(talloc_tos(), context, kt_entry.principal, &ktprinc);
72 DEBUG(1,("smb_krb5_kt_add_entry_ext: smb_krb5_unparse_name failed (%s)\n",
77 /*---------------------------------------------------------------------------
78 * Save the entries with kvno - 1. This is what microsoft does
79 * to allow people with existing sessions that have kvno - 1 to still
80 * work. Otherwise, when the password for the machine changes, all
81 * kerberizied sessions will 'break' until either the client reboots or
82 * the client's session key expires and they get a new session ticket
86 #ifdef HAVE_KRB5_KT_COMPARE
87 compare_name_ok = (krb5_kt_compare(context, &kt_entry, princ, 0, 0) == True);
89 compare_name_ok = (strcmp(ktprinc, princ_s) == 0);
92 if (!compare_name_ok) {
93 DEBUG(10,("smb_krb5_kt_add_entry_ext: ignoring keytab entry principal %s, kvno = %d\n",
94 ktprinc, kt_entry.vno));
99 if (compare_name_ok) {
100 if (kt_entry.vno == kvno - 1) {
101 DEBUG(5,("smb_krb5_kt_add_entry_ext: Saving previous (kvno %d) entry for principal: %s.\n",
103 } else if (!keep_old_entries) {
104 DEBUG(5,("smb_krb5_kt_add_entry_ext: Found old entry for principal: %s (kvno %d) - trying to remove it.\n",
105 princ_s, kt_entry.vno));
106 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
109 DEBUG(1,("smb_krb5_kt_add_entry_ext: krb5_kt_end_seq_get() failed (%s)\n",
110 error_message(ret)));
113 ret = krb5_kt_remove_entry(context, keytab, &kt_entry);
115 DEBUG(1,("smb_krb5_kt_add_entry_ext: krb5_kt_remove_entry failed (%s)\n",
116 error_message(ret)));
120 DEBUG(5,("smb_krb5_kt_add_entry_ext: removed old entry for principal: %s (kvno %d).\n",
121 princ_s, kt_entry.vno));
123 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
125 DEBUG(1,("smb_krb5_kt_add_entry_ext: krb5_kt_start_seq failed (%s)\n",
126 error_message(ret)));
129 ret = smb_krb5_kt_free_entry(context, &kt_entry);
130 ZERO_STRUCT(kt_entry);
132 DEBUG(1,("smb_krb5_kt_add_entry_ext: krb5_kt_remove_entry failed (%s)\n",
133 error_message(ret)));
140 /* Not a match, just free this entry and continue. */
141 ret = smb_krb5_kt_free_entry(context, &kt_entry);
142 ZERO_STRUCT(kt_entry);
144 DEBUG(1,("smb_krb5_kt_add_entry_ext: smb_krb5_kt_free_entry failed (%s)\n", error_message(ret)));
149 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
152 DEBUG(1,("smb_krb5_kt_add_entry_ext: krb5_kt_end_seq_get failed (%s)\n",error_message(ret)));
157 /* Ensure we don't double free. */
158 ZERO_STRUCT(kt_entry);
161 /* If we get here, we have deleted all the old entries with kvno's not equal to the current kvno-1. */
163 /* Now add keytab entries for all encryption types */
164 for (i = 0; enctypes[i]; i++) {
167 keyp = KRB5_KT_KEY(&kt_entry);
169 if (create_kerberos_key_from_string(context, princ, &password, keyp, enctypes[i], no_salt)) {
173 kt_entry.principal = princ;
176 DEBUG(3,("smb_krb5_kt_add_entry_ext: adding keytab entry for (%s) with encryption type (%d) and version (%d)\n",
177 princ_s, enctypes[i], kt_entry.vno));
178 ret = krb5_kt_add_entry(context, keytab, &kt_entry);
179 krb5_free_keyblock_contents(context, keyp);
180 ZERO_STRUCT(kt_entry);
182 DEBUG(1,("smb_krb5_kt_add_entry_ext: adding entry to keytab failed (%s)\n", error_message(ret)));
190 krb5_keytab_entry zero_kt_entry;
191 ZERO_STRUCT(zero_kt_entry);
192 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
193 smb_krb5_kt_free_entry(context, &kt_entry);
197 krb5_free_principal(context, princ);
201 krb5_kt_cursor zero_csr;
202 ZERO_STRUCT(zero_csr);
203 if ((memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) && keytab) {
204 krb5_kt_end_seq_get(context, keytab, &cursor);
211 static int smb_krb5_kt_add_entry(krb5_context context,
215 krb5_enctype *enctypes,
218 return smb_krb5_kt_add_entry_ext(context,
228 /**********************************************************************
229 Adds a single service principal, i.e. 'host' to the system keytab
230 ***********************************************************************/
232 int ads_keytab_add_entry(ADS_STRUCT *ads, const char *srvPrinc)
234 krb5_error_code ret = 0;
235 krb5_context context = NULL;
236 krb5_keytab keytab = NULL;
239 krb5_enctype enctypes[4] = { ENCTYPE_DES_CBC_CRC, ENCTYPE_DES_CBC_MD5, 0, 0 };
240 char *princ_s = NULL, *short_princ_s = NULL;
241 char *password_s = NULL;
243 TALLOC_CTX *ctx = NULL;
246 #if defined(ENCTYPE_ARCFOUR_HMAC)
247 enctypes[2] = ENCTYPE_ARCFOUR_HMAC;
250 initialize_krb5_error_table();
251 ret = krb5_init_context(&context);
253 DEBUG(1,("ads_keytab_add_entry: could not krb5_init_context: %s\n",error_message(ret)));
257 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
259 DEBUG(1,("ads_keytab_add_entry: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
263 /* retrieve the password */
264 if (!secrets_init()) {
265 DEBUG(1,("ads_keytab_add_entry: secrets_init failed\n"));
269 password_s = secrets_fetch_machine_password(lp_workgroup(), NULL, NULL);
271 DEBUG(1,("ads_keytab_add_entry: failed to fetch machine password\n"));
275 ZERO_STRUCT(password);
276 password.data = password_s;
277 password.length = strlen(password_s);
279 /* we need the dNSHostName value here */
281 if ( (ctx = talloc_init("ads_keytab_add_entry")) == NULL ) {
282 DEBUG(0,("ads_keytab_add_entry: talloc() failed!\n"));
287 if ( (my_fqdn = ads_get_dnshostname( ads, ctx, global_myname())) == NULL ) {
288 DEBUG(0,("ads_keytab_add_entry: unable to determine machine account's dns name in AD!\n"));
293 if ( (machine_name = ads_get_samaccountname( ads, ctx, global_myname())) == NULL ) {
294 DEBUG(0,("ads_keytab_add_entry: unable to determine machine account's short name in AD!\n"));
298 /*strip the trailing '$' */
299 machine_name[strlen(machine_name)-1] = '\0';
301 /* Construct our principal */
303 if (strchr_m(srvPrinc, '@')) {
304 /* It's a fully-named principal. */
305 if (asprintf(&princ_s, "%s", srvPrinc) == -1) {
309 } else if (srvPrinc[strlen(srvPrinc)-1] == '$') {
310 /* It's the machine account, as used by smbclient clients. */
311 if (asprintf(&princ_s, "%s@%s", srvPrinc, lp_realm()) == -1) {
316 /* It's a normal service principal. Add the SPN now so that we
317 * can obtain credentials for it and double-check the salt value
318 * used to generate the service's keys. */
320 if (asprintf(&princ_s, "%s/%s@%s", srvPrinc, my_fqdn, lp_realm()) == -1) {
324 if (asprintf(&short_princ_s, "%s/%s@%s", srvPrinc, machine_name, lp_realm()) == -1) {
329 /* According to http://support.microsoft.com/kb/326985/en-us,
330 certain principal names are automatically mapped to the host/...
331 principal in the AD account. So only create these in the
332 keytab, not in AD. --jerry */
334 if ( !strequal( srvPrinc, "cifs" ) && !strequal(srvPrinc, "host" ) ) {
335 DEBUG(3,("ads_keytab_add_entry: Attempting to add/update '%s'\n", princ_s));
337 if (!ADS_ERR_OK(ads_add_service_principal_name(ads, global_myname(), my_fqdn, srvPrinc))) {
338 DEBUG(1,("ads_keytab_add_entry: ads_add_service_principal_name failed.\n"));
344 kvno = (krb5_kvno) ads_get_machine_kvno(ads, global_myname());
345 if (kvno == -1) { /* -1 indicates failure, everything else is OK */
346 DEBUG(1,("ads_keytab_add_entry: ads_get_machine_kvno failed to determine the system's kvno.\n"));
351 /* add the fqdn principal to the keytab */
353 ret = smb_krb5_kt_add_entry( context, keytab, kvno, princ_s, enctypes, password );
355 DEBUG(1,("ads_keytab_add_entry: Failed to add entry to keytab file\n"));
359 /* add the short principal name if we have one */
361 if ( short_princ_s ) {
362 ret = smb_krb5_kt_add_entry( context, keytab, kvno, short_princ_s, enctypes, password );
364 DEBUG(1,("ads_keytab_add_entry: Failed to add short entry to keytab file\n"));
370 SAFE_FREE( princ_s );
371 SAFE_FREE( short_princ_s );
375 krb5_kt_close(context, keytab);
378 krb5_free_context(context);
383 /**********************************************************************
384 Flushes all entries from the system keytab.
385 ***********************************************************************/
387 int ads_keytab_flush(ADS_STRUCT *ads)
389 krb5_error_code ret = 0;
390 krb5_context context = NULL;
391 krb5_keytab keytab = NULL;
392 krb5_kt_cursor cursor;
393 krb5_keytab_entry kt_entry;
396 ZERO_STRUCT(kt_entry);
399 initialize_krb5_error_table();
400 ret = krb5_init_context(&context);
402 DEBUG(1,("ads_keytab_flush: could not krb5_init_context: %s\n",error_message(ret)));
406 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
408 DEBUG(1,("ads_keytab_flush: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
412 kvno = (krb5_kvno) ads_get_machine_kvno(ads, global_myname());
413 if (kvno == -1) { /* -1 indicates a failure */
414 DEBUG(1,("ads_keytab_flush: Error determining the system's kvno.\n"));
418 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
419 if (ret != KRB5_KT_END && ret != ENOENT) {
420 while (!krb5_kt_next_entry(context, keytab, &kt_entry, &cursor)) {
421 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
424 DEBUG(1,("ads_keytab_flush: krb5_kt_end_seq_get() failed (%s)\n",error_message(ret)));
427 ret = krb5_kt_remove_entry(context, keytab, &kt_entry);
429 DEBUG(1,("ads_keytab_flush: krb5_kt_remove_entry failed (%s)\n",error_message(ret)));
432 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
434 DEBUG(1,("ads_keytab_flush: krb5_kt_start_seq failed (%s)\n",error_message(ret)));
437 ret = smb_krb5_kt_free_entry(context, &kt_entry);
438 ZERO_STRUCT(kt_entry);
440 DEBUG(1,("ads_keytab_flush: krb5_kt_remove_entry failed (%s)\n",error_message(ret)));
446 /* Ensure we don't double free. */
447 ZERO_STRUCT(kt_entry);
450 if (!ADS_ERR_OK(ads_clear_service_principal_names(ads, global_myname()))) {
451 DEBUG(1,("ads_keytab_flush: Error while clearing service principal listings in LDAP.\n"));
458 krb5_keytab_entry zero_kt_entry;
459 ZERO_STRUCT(zero_kt_entry);
460 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
461 smb_krb5_kt_free_entry(context, &kt_entry);
465 krb5_kt_cursor zero_csr;
466 ZERO_STRUCT(zero_csr);
467 if ((memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) && keytab) {
468 krb5_kt_end_seq_get(context, keytab, &cursor);
472 krb5_kt_close(context, keytab);
475 krb5_free_context(context);
480 /**********************************************************************
481 Adds all the required service principals to the system keytab.
482 ***********************************************************************/
484 int ads_keytab_create_default(ADS_STRUCT *ads)
486 krb5_error_code ret = 0;
487 krb5_context context = NULL;
488 krb5_keytab keytab = NULL;
489 krb5_kt_cursor cursor;
490 krb5_keytab_entry kt_entry;
493 char *sam_account_name, *upn;
494 char **oldEntries = NULL, *princ_s[26];
495 TALLOC_CTX *ctx = NULL;
496 fstring machine_name;
498 memset(princ_s, '\0', sizeof(princ_s));
500 fstrcpy( machine_name, global_myname() );
502 /* these are the main ones we need */
504 if ( (ret = ads_keytab_add_entry(ads, "host") ) != 0 ) {
505 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding 'host'.\n"));
510 #if 0 /* don't create the CIFS/... keytab entries since no one except smbd
511 really needs them and we will fall back to verifying against secrets.tdb */
513 if ( (ret = ads_keytab_add_entry(ads, "cifs")) != 0 ) {
514 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding 'cifs'.\n"));
519 if ( (ctx = talloc_init("ads_keytab_create_default")) == NULL ) {
520 DEBUG(0,("ads_keytab_create_default: talloc() failed!\n"));
524 /* now add the userPrincipalName and sAMAccountName entries */
526 if ( (sam_account_name = ads_get_samaccountname( ads, ctx, machine_name)) == NULL ) {
527 DEBUG(0,("ads_keytab_add_entry: unable to determine machine account's name in AD!\n"));
532 /* upper case the sAMAccountName to make it easier for apps to
533 know what case to use in the keytab file */
535 strupper_m( sam_account_name );
537 if ( (ret = ads_keytab_add_entry(ads, sam_account_name )) != 0 ) {
538 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding sAMAccountName (%s)\n",
543 /* remember that not every machine account will have a upn */
545 upn = ads_get_upn( ads, ctx, machine_name);
547 if ( (ret = ads_keytab_add_entry(ads, upn)) != 0 ) {
548 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding UPN (%s)\n",
555 /* Now loop through the keytab and update any other existing entries... */
557 kvno = (krb5_kvno) ads_get_machine_kvno(ads, machine_name);
559 DEBUG(1,("ads_keytab_create_default: ads_get_machine_kvno failed to determine the system's kvno.\n"));
564 DEBUG(3,("ads_keytab_create_default: Searching for keytab entries to "
565 "preserve and update.\n"));
567 ZERO_STRUCT(kt_entry);
570 initialize_krb5_error_table();
571 ret = krb5_init_context(&context);
573 DEBUG(1,("ads_keytab_create_default: could not krb5_init_context: %s\n",error_message(ret)));
578 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
580 DEBUG(1,("ads_keytab_create_default: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
584 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
585 if (ret != KRB5_KT_END && ret != ENOENT ) {
586 while ((ret = krb5_kt_next_entry(context, keytab, &kt_entry, &cursor)) == 0) {
587 smb_krb5_kt_free_entry(context, &kt_entry);
588 ZERO_STRUCT(kt_entry);
592 krb5_kt_end_seq_get(context, keytab, &cursor);
596 * Hmmm. There is no "rewind" function for the keytab. This means we have a race condition
597 * where someone else could add entries after we've counted them. Re-open asap to minimise
601 DEBUG(3, ("ads_keytab_create_default: Found %d entries in the keytab.\n", found));
605 oldEntries = talloc_array(ctx, char *, found );
607 DEBUG(1,("ads_keytab_create_default: Failed to allocate space to store the old keytab entries (malloc failed?).\n"));
611 memset(oldEntries, '\0', found * sizeof(char *));
613 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
614 if (ret != KRB5_KT_END && ret != ENOENT ) {
615 while (krb5_kt_next_entry(context, keytab, &kt_entry, &cursor) == 0) {
616 if (kt_entry.vno != kvno) {
617 char *ktprinc = NULL;
620 /* This returns a malloc'ed string in ktprinc. */
621 ret = smb_krb5_unparse_name(oldEntries, context, kt_entry.principal, &ktprinc);
623 DEBUG(1,("smb_krb5_unparse_name failed (%s)\n", error_message(ret)));
627 * From looking at the krb5 source they don't seem to take locale
628 * or mb strings into account. Maybe this is because they assume utf8 ?
629 * In this case we may need to convert from utf8 to mb charset here ? JRA.
631 p = strchr_m(ktprinc, '@');
636 p = strchr_m(ktprinc, '/');
640 for (i = 0; i < found; i++) {
641 if (!oldEntries[i]) {
642 oldEntries[i] = ktprinc;
645 if (!strcmp(oldEntries[i], ktprinc)) {
646 TALLOC_FREE(ktprinc);
651 TALLOC_FREE(ktprinc);
654 smb_krb5_kt_free_entry(context, &kt_entry);
655 ZERO_STRUCT(kt_entry);
658 for (i = 0; oldEntries[i]; i++) {
659 ret |= ads_keytab_add_entry(ads, oldEntries[i]);
660 TALLOC_FREE(oldEntries[i]);
662 krb5_kt_end_seq_get(context, keytab, &cursor);
668 TALLOC_FREE(oldEntries);
672 krb5_keytab_entry zero_kt_entry;
673 ZERO_STRUCT(zero_kt_entry);
674 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
675 smb_krb5_kt_free_entry(context, &kt_entry);
679 krb5_kt_cursor zero_csr;
680 ZERO_STRUCT(zero_csr);
681 if ((memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) && keytab) {
682 krb5_kt_end_seq_get(context, keytab, &cursor);
686 krb5_kt_close(context, keytab);
689 krb5_free_context(context);
694 /**********************************************************************
696 ***********************************************************************/
698 int ads_keytab_list(const char *keytab_name)
700 krb5_error_code ret = 0;
701 krb5_context context = NULL;
702 krb5_keytab keytab = NULL;
703 krb5_kt_cursor cursor;
704 krb5_keytab_entry kt_entry;
706 ZERO_STRUCT(kt_entry);
709 initialize_krb5_error_table();
710 ret = krb5_init_context(&context);
712 DEBUG(1,("ads_keytab_list: could not krb5_init_context: %s\n",error_message(ret)));
716 ret = smb_krb5_open_keytab(context, keytab_name, False, &keytab);
718 DEBUG(1,("ads_keytab_list: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
722 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
727 printf("Vno Type Principal\n");
729 while (krb5_kt_next_entry(context, keytab, &kt_entry, &cursor) == 0) {
731 char *princ_s = NULL;
732 char *etype_s = NULL;
733 krb5_enctype enctype = 0;
735 ret = smb_krb5_unparse_name(talloc_tos(), context, kt_entry.principal, &princ_s);
740 enctype = smb_get_enctype_from_kt_entry(&kt_entry);
742 ret = smb_krb5_enctype_to_string(context, enctype, &etype_s);
744 if (asprintf(&etype_s, "UNKNOWN: %d\n", enctype) == -1)
746 TALLOC_FREE(princ_s);
751 printf("%3d %s\t\t %s\n", kt_entry.vno, etype_s, princ_s);
753 TALLOC_FREE(princ_s);
756 ret = smb_krb5_kt_free_entry(context, &kt_entry);
762 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
767 /* Ensure we don't double free. */
768 ZERO_STRUCT(kt_entry);
773 krb5_keytab_entry zero_kt_entry;
774 ZERO_STRUCT(zero_kt_entry);
775 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
776 smb_krb5_kt_free_entry(context, &kt_entry);
780 krb5_kt_cursor zero_csr;
781 ZERO_STRUCT(zero_csr);
782 if ((memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) && keytab) {
783 krb5_kt_end_seq_get(context, keytab, &cursor);
788 krb5_kt_close(context, keytab);
791 krb5_free_context(context);
796 #endif /* HAVE_KRB5 */