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(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: 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: 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: 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: 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: Saving previous (kvno %d) entry for principal: %s.\n",
101 DEBUG(5,("smb_krb5_kt_add_entry: Found old entry for principal: %s (kvno %d) - trying to remove it.\n",
102 princ_s, kt_entry.vno));
103 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
106 DEBUG(1,("smb_krb5_kt_add_entry: krb5_kt_end_seq_get() failed (%s)\n",
107 error_message(ret)));
110 ret = krb5_kt_remove_entry(context, keytab, &kt_entry);
112 DEBUG(1,("smb_krb5_kt_add_entry: krb5_kt_remove_entry failed (%s)\n",
113 error_message(ret)));
117 DEBUG(5,("smb_krb5_kt_add_entry: removed old entry for principal: %s (kvno %d).\n",
118 princ_s, kt_entry.vno));
120 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
122 DEBUG(1,("smb_krb5_kt_add_entry: krb5_kt_start_seq failed (%s)\n",
123 error_message(ret)));
126 ret = smb_krb5_kt_free_entry(context, &kt_entry);
127 ZERO_STRUCT(kt_entry);
129 DEBUG(1,("smb_krb5_kt_add_entry: krb5_kt_remove_entry failed (%s)\n",
130 error_message(ret)));
137 /* Not a match, just free this entry and continue. */
138 ret = smb_krb5_kt_free_entry(context, &kt_entry);
139 ZERO_STRUCT(kt_entry);
141 DEBUG(1,("smb_krb5_kt_add_entry: smb_krb5_kt_free_entry failed (%s)\n", error_message(ret)));
146 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
149 DEBUG(1,("smb_krb5_kt_add_entry: krb5_kt_end_seq_get failed (%s)\n",error_message(ret)));
154 /* Ensure we don't double free. */
155 ZERO_STRUCT(kt_entry);
158 /* If we get here, we have deleted all the old entries with kvno's not equal to the current kvno-1. */
160 /* Now add keytab entries for all encryption types */
161 for (i = 0; enctypes[i]; i++) {
164 #if !defined(HAVE_KRB5_KEYTAB_ENTRY_KEY) && !defined(HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK)
165 #error krb5_keytab_entry has no key or keyblock member
167 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEY /* MIT */
168 keyp = &kt_entry.key;
170 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK /* Heimdal */
171 keyp = &kt_entry.keyblock;
173 if (create_kerberos_key_from_string(context, princ, &password, keyp, enctypes[i], no_salt)) {
177 kt_entry.principal = princ;
180 DEBUG(3,("smb_krb5_kt_add_entry: adding keytab entry for (%s) with encryption type (%d) and version (%d)\n",
181 princ_s, enctypes[i], kt_entry.vno));
182 ret = krb5_kt_add_entry(context, keytab, &kt_entry);
183 krb5_free_keyblock_contents(context, keyp);
184 ZERO_STRUCT(kt_entry);
186 DEBUG(1,("smb_krb5_kt_add_entry: adding entry to keytab failed (%s)\n", error_message(ret)));
194 krb5_keytab_entry zero_kt_entry;
195 ZERO_STRUCT(zero_kt_entry);
196 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
197 smb_krb5_kt_free_entry(context, &kt_entry);
201 krb5_free_principal(context, princ);
205 krb5_kt_cursor zero_csr;
206 ZERO_STRUCT(zero_csr);
207 if ((memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) && keytab) {
208 krb5_kt_end_seq_get(context, keytab, &cursor);
216 /**********************************************************************
217 Adds a single service principal, i.e. 'host' to the system keytab
218 ***********************************************************************/
220 int ads_keytab_add_entry(ADS_STRUCT *ads, const char *srvPrinc)
222 krb5_error_code ret = 0;
223 krb5_context context = NULL;
224 krb5_keytab keytab = NULL;
227 krb5_enctype enctypes[4] = { ENCTYPE_DES_CBC_CRC, ENCTYPE_DES_CBC_MD5, 0, 0 };
228 char *princ_s = NULL, *short_princ_s = NULL;
229 char *password_s = NULL;
231 TALLOC_CTX *ctx = NULL;
234 #if defined(ENCTYPE_ARCFOUR_HMAC)
235 enctypes[2] = ENCTYPE_ARCFOUR_HMAC;
238 initialize_krb5_error_table();
239 ret = krb5_init_context(&context);
241 DEBUG(1,("ads_keytab_add_entry: could not krb5_init_context: %s\n",error_message(ret)));
245 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
247 DEBUG(1,("ads_keytab_add_entry: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
251 /* retrieve the password */
252 if (!secrets_init()) {
253 DEBUG(1,("ads_keytab_add_entry: secrets_init failed\n"));
257 password_s = secrets_fetch_machine_password(lp_workgroup(), NULL, NULL);
259 DEBUG(1,("ads_keytab_add_entry: failed to fetch machine password\n"));
263 password.data = password_s;
264 password.length = strlen(password_s);
266 /* we need the dNSHostName value here */
268 if ( (ctx = talloc_init("ads_keytab_add_entry")) == NULL ) {
269 DEBUG(0,("ads_keytab_add_entry: talloc() failed!\n"));
274 if ( (my_fqdn = ads_get_dnshostname( ads, ctx, global_myname())) == NULL ) {
275 DEBUG(0,("ads_keytab_add_entry: unable to determine machine account's dns name in AD!\n"));
280 if ( (machine_name = ads_get_samaccountname( ads, ctx, global_myname())) == NULL ) {
281 DEBUG(0,("ads_keytab_add_entry: unable to determine machine account's short name in AD!\n"));
285 /*strip the trailing '$' */
286 machine_name[strlen(machine_name)-1] = '\0';
288 /* Construct our principal */
290 if (strchr_m(srvPrinc, '@')) {
291 /* It's a fully-named principal. */
292 asprintf(&princ_s, "%s", srvPrinc);
293 } else if (srvPrinc[strlen(srvPrinc)-1] == '$') {
294 /* It's the machine account, as used by smbclient clients. */
295 asprintf(&princ_s, "%s@%s", srvPrinc, lp_realm());
297 /* It's a normal service principal. Add the SPN now so that we
298 * can obtain credentials for it and double-check the salt value
299 * used to generate the service's keys. */
301 asprintf(&princ_s, "%s/%s@%s", srvPrinc, my_fqdn, lp_realm());
302 asprintf(&short_princ_s, "%s/%s@%s", srvPrinc, machine_name, lp_realm());
304 /* According to http://support.microsoft.com/kb/326985/en-us,
305 certain principal names are automatically mapped to the host/...
306 principal in the AD account. So only create these in the
307 keytab, not in AD. --jerry */
309 if ( !strequal( srvPrinc, "cifs" ) && !strequal(srvPrinc, "host" ) ) {
310 DEBUG(3,("ads_keytab_add_entry: Attempting to add/update '%s'\n", princ_s));
312 if (!ADS_ERR_OK(ads_add_service_principal_name(ads, global_myname(), my_fqdn, srvPrinc))) {
313 DEBUG(1,("ads_keytab_add_entry: ads_add_service_principal_name failed.\n"));
319 kvno = (krb5_kvno) ads_get_machine_kvno(ads, global_myname());
320 if (kvno == -1) { /* -1 indicates failure, everything else is OK */
321 DEBUG(1,("ads_keytab_add_entry: ads_get_machine_kvno failed to determine the system's kvno.\n"));
326 /* add the fqdn principal to the keytab */
328 ret = smb_krb5_kt_add_entry( context, keytab, kvno, princ_s, enctypes, password, false );
330 DEBUG(1,("ads_keytab_add_entry: Failed to add entry to keytab file\n"));
334 /* add the short principal name if we have one */
336 if ( short_princ_s ) {
337 ret = smb_krb5_kt_add_entry( context, keytab, kvno, short_princ_s, enctypes, password, false );
339 DEBUG(1,("ads_keytab_add_entry: Failed to add short entry to keytab file\n"));
345 SAFE_FREE( princ_s );
346 SAFE_FREE( short_princ_s );
350 krb5_kt_close(context, keytab);
353 krb5_free_context(context);
358 /**********************************************************************
359 Flushes all entries from the system keytab.
360 ***********************************************************************/
362 int ads_keytab_flush(ADS_STRUCT *ads)
364 krb5_error_code ret = 0;
365 krb5_context context = NULL;
366 krb5_keytab keytab = NULL;
367 krb5_kt_cursor cursor;
368 krb5_keytab_entry kt_entry;
371 ZERO_STRUCT(kt_entry);
374 initialize_krb5_error_table();
375 ret = krb5_init_context(&context);
377 DEBUG(1,("ads_keytab_flush: could not krb5_init_context: %s\n",error_message(ret)));
381 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
383 DEBUG(1,("ads_keytab_flush: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
387 kvno = (krb5_kvno) ads_get_machine_kvno(ads, global_myname());
388 if (kvno == -1) { /* -1 indicates a failure */
389 DEBUG(1,("ads_keytab_flush: Error determining the system's kvno.\n"));
393 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
394 if (ret != KRB5_KT_END && ret != ENOENT) {
395 while (!krb5_kt_next_entry(context, keytab, &kt_entry, &cursor)) {
396 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
399 DEBUG(1,("ads_keytab_flush: krb5_kt_end_seq_get() failed (%s)\n",error_message(ret)));
402 ret = krb5_kt_remove_entry(context, keytab, &kt_entry);
404 DEBUG(1,("ads_keytab_flush: krb5_kt_remove_entry failed (%s)\n",error_message(ret)));
407 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
409 DEBUG(1,("ads_keytab_flush: krb5_kt_start_seq failed (%s)\n",error_message(ret)));
412 ret = smb_krb5_kt_free_entry(context, &kt_entry);
413 ZERO_STRUCT(kt_entry);
415 DEBUG(1,("ads_keytab_flush: krb5_kt_remove_entry failed (%s)\n",error_message(ret)));
421 /* Ensure we don't double free. */
422 ZERO_STRUCT(kt_entry);
425 if (!ADS_ERR_OK(ads_clear_service_principal_names(ads, global_myname()))) {
426 DEBUG(1,("ads_keytab_flush: Error while clearing service principal listings in LDAP.\n"));
433 krb5_keytab_entry zero_kt_entry;
434 ZERO_STRUCT(zero_kt_entry);
435 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
436 smb_krb5_kt_free_entry(context, &kt_entry);
440 krb5_kt_cursor zero_csr;
441 ZERO_STRUCT(zero_csr);
442 if ((memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) && keytab) {
443 krb5_kt_end_seq_get(context, keytab, &cursor);
447 krb5_kt_close(context, keytab);
450 krb5_free_context(context);
455 /**********************************************************************
456 Adds all the required service principals to the system keytab.
457 ***********************************************************************/
459 int ads_keytab_create_default(ADS_STRUCT *ads)
461 krb5_error_code ret = 0;
462 krb5_context context = NULL;
463 krb5_keytab keytab = NULL;
464 krb5_kt_cursor cursor;
465 krb5_keytab_entry kt_entry;
468 char *sam_account_name, *upn;
469 char **oldEntries = NULL, *princ_s[26];
470 TALLOC_CTX *ctx = NULL;
471 fstring machine_name;
473 memset(princ_s, '\0', sizeof(princ_s));
475 fstrcpy( machine_name, global_myname() );
477 /* these are the main ones we need */
479 if ( (ret = ads_keytab_add_entry(ads, "host") ) != 0 ) {
480 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding 'host'.\n"));
485 #if 0 /* don't create the CIFS/... keytab entries since no one except smbd
486 really needs them and we will fall back to verifying against secrets.tdb */
488 if ( (ret = ads_keytab_add_entry(ads, "cifs")) != 0 ) {
489 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding 'cifs'.\n"));
494 if ( (ctx = talloc_init("ads_keytab_create_default")) == NULL ) {
495 DEBUG(0,("ads_keytab_create_default: talloc() failed!\n"));
499 /* now add the userPrincipalName and sAMAccountName entries */
501 if ( (sam_account_name = ads_get_samaccountname( ads, ctx, machine_name)) == NULL ) {
502 DEBUG(0,("ads_keytab_add_entry: unable to determine machine account's name in AD!\n"));
507 /* upper case the sAMAccountName to make it easier for apps to
508 know what case to use in the keytab file */
510 strupper_m( sam_account_name );
512 if ( (ret = ads_keytab_add_entry(ads, sam_account_name )) != 0 ) {
513 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding sAMAccountName (%s)\n",
518 /* remember that not every machine account will have a upn */
520 upn = ads_get_upn( ads, ctx, machine_name);
522 if ( (ret = ads_keytab_add_entry(ads, upn)) != 0 ) {
523 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding UPN (%s)\n",
532 /* Now loop through the keytab and update any other existing entries... */
534 kvno = (krb5_kvno) ads_get_machine_kvno(ads, machine_name);
536 DEBUG(1,("ads_keytab_create_default: ads_get_machine_kvno failed to determine the system's kvno.\n"));
540 DEBUG(3,("ads_keytab_create_default: Searching for keytab entries to "
541 "preserve and update.\n"));
543 ZERO_STRUCT(kt_entry);
546 initialize_krb5_error_table();
547 ret = krb5_init_context(&context);
549 DEBUG(1,("ads_keytab_create_default: could not krb5_init_context: %s\n",error_message(ret)));
553 ret = smb_krb5_open_keytab(context, NULL, True, &keytab);
555 DEBUG(1,("ads_keytab_create_default: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
559 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
560 if (ret != KRB5_KT_END && ret != ENOENT ) {
561 while ((ret = krb5_kt_next_entry(context, keytab, &kt_entry, &cursor)) == 0) {
562 smb_krb5_kt_free_entry(context, &kt_entry);
563 ZERO_STRUCT(kt_entry);
567 krb5_kt_end_seq_get(context, keytab, &cursor);
571 * Hmmm. There is no "rewind" function for the keytab. This means we have a race condition
572 * where someone else could add entries after we've counted them. Re-open asap to minimise
576 DEBUG(3, ("ads_keytab_create_default: Found %d entries in the keytab.\n", found));
580 oldEntries = SMB_MALLOC_ARRAY(char *, found );
582 DEBUG(1,("ads_keytab_create_default: Failed to allocate space to store the old keytab entries (malloc failed?).\n"));
586 memset(oldEntries, '\0', found * sizeof(char *));
588 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
589 if (ret != KRB5_KT_END && ret != ENOENT ) {
590 while (krb5_kt_next_entry(context, keytab, &kt_entry, &cursor) == 0) {
591 if (kt_entry.vno != kvno) {
592 char *ktprinc = NULL;
595 /* This returns a malloc'ed string in ktprinc. */
596 ret = smb_krb5_unparse_name(context, kt_entry.principal, &ktprinc);
598 DEBUG(1,("smb_krb5_unparse_name failed (%s)\n", error_message(ret)));
602 * From looking at the krb5 source they don't seem to take locale
603 * or mb strings into account. Maybe this is because they assume utf8 ?
604 * In this case we may need to convert from utf8 to mb charset here ? JRA.
606 p = strchr_m(ktprinc, '@');
611 p = strchr_m(ktprinc, '/');
615 for (i = 0; i < found; i++) {
616 if (!oldEntries[i]) {
617 oldEntries[i] = ktprinc;
620 if (!strcmp(oldEntries[i], ktprinc)) {
629 smb_krb5_kt_free_entry(context, &kt_entry);
630 ZERO_STRUCT(kt_entry);
633 for (i = 0; oldEntries[i]; i++) {
634 ret |= ads_keytab_add_entry(ads, oldEntries[i]);
635 SAFE_FREE(oldEntries[i]);
637 krb5_kt_end_seq_get(context, keytab, &cursor);
643 SAFE_FREE(oldEntries);
646 krb5_keytab_entry zero_kt_entry;
647 ZERO_STRUCT(zero_kt_entry);
648 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
649 smb_krb5_kt_free_entry(context, &kt_entry);
653 krb5_kt_cursor zero_csr;
654 ZERO_STRUCT(zero_csr);
655 if ((memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) && keytab) {
656 krb5_kt_end_seq_get(context, keytab, &cursor);
660 krb5_kt_close(context, keytab);
663 krb5_free_context(context);
668 /**********************************************************************
670 ***********************************************************************/
672 int ads_keytab_list(const char *keytab_name)
674 krb5_error_code ret = 0;
675 krb5_context context = NULL;
676 krb5_keytab keytab = NULL;
677 krb5_kt_cursor cursor;
678 krb5_keytab_entry kt_entry;
680 ZERO_STRUCT(kt_entry);
683 initialize_krb5_error_table();
684 ret = krb5_init_context(&context);
686 DEBUG(1,("ads_keytab_list: could not krb5_init_context: %s\n",error_message(ret)));
690 ret = smb_krb5_open_keytab(context, keytab_name, False, &keytab);
692 DEBUG(1,("ads_keytab_list: smb_krb5_open_keytab failed (%s)\n", error_message(ret)));
696 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
701 printf("Vno Type Principal\n");
703 while (krb5_kt_next_entry(context, keytab, &kt_entry, &cursor) == 0) {
705 char *princ_s = NULL;
706 char *etype_s = NULL;
707 krb5_enctype enctype = 0;
709 ret = smb_krb5_unparse_name(context, kt_entry.principal, &princ_s);
714 enctype = smb_get_enctype_from_kt_entry(&kt_entry);
716 ret = smb_krb5_enctype_to_string(context, enctype, &etype_s);
722 printf("%3d %s\t\t %s\n", kt_entry.vno, etype_s, princ_s);
727 ret = smb_krb5_kt_free_entry(context, &kt_entry);
733 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
738 /* Ensure we don't double free. */
739 ZERO_STRUCT(kt_entry);
744 krb5_keytab_entry zero_kt_entry;
745 ZERO_STRUCT(zero_kt_entry);
746 if (memcmp(&zero_kt_entry, &kt_entry, 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, sizeof(krb5_kt_cursor)) != 0) && keytab) {
754 krb5_kt_end_seq_get(context, keytab, &cursor);
759 krb5_kt_close(context, keytab);
762 krb5_free_context(context);
767 #endif /* HAVE_KRB5 */