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
13 This program is free software; you can redistribute it and/or modify
14 it under the terms of the GNU General Public License as published by
15 the Free Software Foundation; either version 2 of the License, or
16 (at your option) any later version.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License for more details.
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, write to the Free Software
25 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
32 /**********************************************************************
33 Adds a single service principal, i.e. 'host' to the system keytab
34 ***********************************************************************/
36 int ads_keytab_add_entry(ADS_STRUCT
*ads
, const char *srvPrinc
)
38 krb5_error_code ret
= 0;
39 krb5_context context
= NULL
;
40 krb5_keytab keytab
= NULL
;
41 krb5_kt_cursor cursor
;
42 krb5_keytab_entry kt_entry
;
43 krb5_principal princ
= NULL
;
45 krb5_enctype
*enctypes
= NULL
;
48 char *principal
= NULL
;
50 char *password_s
= NULL
;
51 #ifndef MAX_KEYTAB_NAME_LEN
52 #define MAX_KEYTAB_NAME_LEN 1100
54 char keytab_name
[MAX_KEYTAB_NAME_LEN
]; /* This MAX_NAME_LEN is a constant defined in krb5.h */
59 ZERO_STRUCT(kt_entry
);
62 initialize_krb5_error_table();
63 ret
= krb5_init_context(&context
);
65 DEBUG(1,("ads_keytab_add_entry: could not krb5_init_context: %s\n",error_message(ret
)));
68 #ifdef HAVE_WRFILE_KEYTAB /* MIT */
71 ret
= krb5_kt_default_name(context
, (char *) &keytab_name
[2], MAX_KEYTAB_NAME_LEN
- 4);
73 ret
= krb5_kt_default_name(context
, (char *) &keytab_name
[0], MAX_KEYTAB_NAME_LEN
- 2);
76 DEBUG(1,("ads_keytab_add_entry: krb5_kt_default_name failed (%s)\n", error_message(ret
)));
79 DEBUG(2,("ads_keytab_add_entry: Using default system keytab: %s\n", (char *) &keytab_name
));
80 ret
= krb5_kt_resolve(context
, (char *) &keytab_name
, &keytab
);
82 DEBUG(1,("ads_keytab_add_entry: krb5_kt_resolve failed (%s)\n", error_message(ret
)));
86 /* retrieve the password */
87 if (!secrets_init()) {
88 DEBUG(1,("ads_keytab_add_entry: secrets_init failed\n"));
92 password_s
= secrets_fetch_machine_password(lp_workgroup(), NULL
, NULL
);
94 DEBUG(1,("ads_keytab_add_entry: failed to fetch machine password\n"));
98 password
.data
= password_s
;
99 password
.length
= strlen(password_s
);
101 /* Construct our principal */
102 name_to_fqdn(my_fqdn
, global_myname());
104 asprintf(&princ_s
, "%s/%s@%s", srvPrinc
, my_fqdn
, lp_realm());
106 ret
= krb5_parse_name(context
, princ_s
, &princ
);
108 DEBUG(1,("ads_keytab_add_entry: krb5_parse_name(%s) failed (%s)\n", princ_s
, error_message(ret
)));
112 kvno
= (krb5_kvno
) ads_get_kvno(ads
, global_myname());
113 if (kvno
== -1) { /* -1 indicates failure, everything else is OK */
114 DEBUG(1,("ads_keytab_add_entry: ads_get_kvno failed to determine the system's kvno.\n"));
119 /* Seek and delete old keytab entries */
120 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
121 if (ret
!= KRB5_KT_END
&& ret
!= ENOENT
) {
122 DEBUG(3,("ads_keytab_add_entry: Will try to delete old keytab entries\n"));
123 while(!krb5_kt_next_entry(context
, keytab
, &kt_entry
, &cursor
)) {
124 BOOL compare_ok
= False
;
126 ret
= krb5_unparse_name(context
, kt_entry
.principal
, &ktprinc
);
128 DEBUG(1,("ads_keytab_add_entry: krb5_unparse_name failed (%s)\n", error_message(ret
)));
132 /*---------------------------------------------------------------------------
133 * Save the entries with kvno - 1. This is what microsoft does
134 * to allow people with existing sessions that have kvno - 1 to still
135 * work. Otherwise, when the password for the machine changes, all
136 * kerberizied sessions will 'break' until either the client reboots or
137 * the client's session key expires and they get a new session ticket
141 #ifdef HAVE_KRB5_KT_COMPARE
142 compare_ok
= ((krb5_kt_compare(context
, &kt_entry
, princ
, 0, 0) == True
) && (kt_entry
.vno
!= kvno
- 1));
144 compare_ok
= ((strcmp(ktprinc
, princ_s
) == 0) && (kt_entry
.vno
!= kvno
- 1));
146 krb5_free_unparsed_name(context
, ktprinc
);
150 DEBUG(3,("ads_keytab_add_entry: Found old entry for principal: %s (kvno %d) - trying to remove it.\n",
151 princ_s
, kt_entry
.vno
));
152 ret
= krb5_kt_end_seq_get(context
, keytab
, &cursor
);
155 DEBUG(1,("ads_keytab_add_entry: krb5_kt_end_seq_get() failed (%s)\n",
156 error_message(ret
)));
159 ret
= krb5_kt_remove_entry(context
, keytab
, &kt_entry
);
161 DEBUG(1,("ads_keytab_add_entry: krb5_kt_remove_entry failed (%s)\n",
162 error_message(ret
)));
165 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
167 DEBUG(1,("ads_keytab_add_entry: krb5_kt_start_seq failed (%s)\n",
168 error_message(ret
)));
171 ret
= smb_krb5_kt_free_entry(context
, &kt_entry
);
172 ZERO_STRUCT(kt_entry
);
174 DEBUG(1,("ads_keytab_add_entry: krb5_kt_remove_entry failed (%s)\n",
175 error_message(ret
)));
181 /* Not a match, just free this entry and continue. */
182 ret
= smb_krb5_kt_free_entry(context
, &kt_entry
);
183 ZERO_STRUCT(kt_entry
);
185 DEBUG(1,("ads_keytab_add_entry: smb_krb5_kt_free_entry failed (%s)\n", error_message(ret
)));
190 ret
= krb5_kt_end_seq_get(context
, keytab
, &cursor
);
193 DEBUG(1,("ads_keytab_add_entry: krb5_kt_end_seq_get failed (%s)\n",error_message(ret
)));
198 /* Ensure we don't double free. */
199 ZERO_STRUCT(kt_entry
);
202 /* If we get here, we have deleted all the old entries with kvno's not equal to the current kvno-1. */
204 ret
= get_kerberos_allowed_etypes(context
,&enctypes
);
206 DEBUG(1,("ads_keytab_add_entry: get_kerberos_allowed_etypes failed (%s)\n",error_message(ret
)));
210 /* Now add keytab entries for all encryption types */
211 for (i
= 0; enctypes
[i
]; i
++) {
214 #if !defined(HAVE_KRB5_KEYTAB_ENTRY_KEY) && !defined(HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK)
215 #error krb5_keytab_entry has no key or keyblock member
217 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEY /* MIT */
218 keyp
= &kt_entry
.key
;
220 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK /* Heimdal */
221 keyp
= &kt_entry
.keyblock
;
223 if (create_kerberos_key_from_string(context
, princ
, &password
, keyp
, enctypes
[i
])) {
227 kt_entry
.principal
= princ
;
230 DEBUG(3,("ads_keytab_add_entry: adding keytab entry for (%s) with encryption type (%d) and version (%d)\n",
231 princ_s
, enctypes
[i
], kt_entry
.vno
));
232 ret
= krb5_kt_add_entry(context
, keytab
, &kt_entry
);
233 krb5_free_keyblock_contents(context
, keyp
);
234 ZERO_STRUCT(kt_entry
);
236 DEBUG(1,("ads_keytab_add_entry: adding entry to keytab failed (%s)\n", error_message(ret
)));
241 krb5_kt_close(context
, keytab
);
242 keytab
= NULL
; /* Done with keytab now. No double free. */
244 /* Update the LDAP with the SPN */
245 DEBUG(3,("ads_keytab_add_entry: Attempting to add/update '%s'\n", princ_s
));
246 if (!ADS_ERR_OK(ads_add_service_principal_name(ads
, global_myname(), srvPrinc
))) {
247 DEBUG(1,("ads_keytab_add_entry: ads_add_service_principcal_name failed.\n"));
253 SAFE_FREE(principal
);
254 SAFE_FREE(password_s
);
258 krb5_keytab_entry zero_kt_entry
;
259 ZERO_STRUCT(zero_kt_entry
);
260 if (memcmp(&zero_kt_entry
, &kt_entry
, sizeof(krb5_keytab_entry
))) {
261 smb_krb5_kt_free_entry(context
, &kt_entry
);
265 krb5_free_principal(context
, princ
);
268 free_kerberos_etypes(context
, enctypes
);
272 krb5_kt_cursor zero_csr
;
273 ZERO_STRUCT(zero_csr
);
274 if ((memcmp(&cursor
, &zero_csr
, sizeof(krb5_kt_cursor
)) != 0) && keytab
) {
275 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
279 krb5_kt_close(context
, keytab
);
282 krb5_free_context(context
);
287 /**********************************************************************
288 Flushes all entries from the system keytab.
289 ***********************************************************************/
291 int ads_keytab_flush(ADS_STRUCT
*ads
)
293 krb5_error_code ret
= 0;
294 krb5_context context
= NULL
;
295 krb5_keytab keytab
= NULL
;
296 krb5_kt_cursor cursor
;
297 krb5_keytab_entry kt_entry
;
299 char keytab_name
[MAX_KEYTAB_NAME_LEN
];
301 ZERO_STRUCT(kt_entry
);
304 initialize_krb5_error_table();
305 ret
= krb5_init_context(&context
);
307 DEBUG(1,("ads_keytab_flush: could not krb5_init_context: %s\n",error_message(ret
)));
310 #ifdef HAVE_WRFILE_KEYTAB
311 keytab_name
[0] = 'W';
312 keytab_name
[1] = 'R';
313 ret
= krb5_kt_default_name(context
, (char *) &keytab_name
[2], MAX_KEYTAB_NAME_LEN
- 4);
315 ret
= krb5_kt_default_name(context
, (char *) &keytab_name
[0], MAX_KEYTAB_NAME_LEN
- 2);
318 DEBUG(1,("ads_keytab_flush: krb5_kt_default failed (%s)\n", error_message(ret
)));
321 DEBUG(3,("ads_keytab_flush: Using default keytab: %s\n", (char *) &keytab_name
));
322 ret
= krb5_kt_resolve(context
, (char *) &keytab_name
, &keytab
);
324 DEBUG(1,("ads_keytab_flush: krb5_kt_default failed (%s)\n", error_message(ret
)));
327 ret
= krb5_kt_resolve(context
, (char *) &keytab_name
, &keytab
);
329 DEBUG(1,("ads_keytab_flush: krb5_kt_default failed (%s)\n", error_message(ret
)));
333 kvno
= (krb5_kvno
) ads_get_kvno(ads
, global_myname());
334 if (kvno
== -1) { /* -1 indicates a failure */
335 DEBUG(1,("ads_keytab_flush: Error determining the system's kvno.\n"));
339 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
340 if (ret
!= KRB5_KT_END
&& ret
!= ENOENT
) {
341 while (!krb5_kt_next_entry(context
, keytab
, &kt_entry
, &cursor
)) {
342 ret
= krb5_kt_end_seq_get(context
, keytab
, &cursor
);
345 DEBUG(1,("ads_keytab_flush: krb5_kt_end_seq_get() failed (%s)\n",error_message(ret
)));
348 ret
= krb5_kt_remove_entry(context
, keytab
, &kt_entry
);
350 DEBUG(1,("ads_keytab_flush: krb5_kt_remove_entry failed (%s)\n",error_message(ret
)));
353 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
355 DEBUG(1,("ads_keytab_flush: krb5_kt_start_seq failed (%s)\n",error_message(ret
)));
358 ret
= smb_krb5_kt_free_entry(context
, &kt_entry
);
359 ZERO_STRUCT(kt_entry
);
361 DEBUG(1,("ads_keytab_flush: krb5_kt_remove_entry failed (%s)\n",error_message(ret
)));
367 /* Ensure we don't double free. */
368 ZERO_STRUCT(kt_entry
);
371 if (!ADS_ERR_OK(ads_clear_service_principal_names(ads
, global_myname()))) {
372 DEBUG(1,("ads_keytab_flush: Error while clearing service principal listings in LDAP.\n"));
379 krb5_keytab_entry zero_kt_entry
;
380 ZERO_STRUCT(zero_kt_entry
);
381 if (memcmp(&zero_kt_entry
, &kt_entry
, sizeof(krb5_keytab_entry
))) {
382 smb_krb5_kt_free_entry(context
, &kt_entry
);
386 krb5_kt_cursor zero_csr
;
387 ZERO_STRUCT(zero_csr
);
388 if ((memcmp(&cursor
, &zero_csr
, sizeof(krb5_kt_cursor
)) != 0) && keytab
) {
389 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
393 krb5_kt_close(context
, keytab
);
396 krb5_free_context(context
);
401 /**********************************************************************
402 Adds all the required service principals to the system keytab.
403 ***********************************************************************/
405 int ads_keytab_create_default(ADS_STRUCT
*ads
)
407 krb5_error_code ret
= 0;
408 krb5_context context
= NULL
;
409 krb5_keytab keytab
= NULL
;
410 krb5_kt_cursor cursor
;
411 krb5_keytab_entry kt_entry
;
414 char **oldEntries
= NULL
;
416 ret
= ads_keytab_add_entry(ads
, "host");
418 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding 'host'.\n"));
421 ret
= ads_keytab_add_entry(ads
, "cifs");
423 DEBUG(1,("ads_keytab_create_default: ads_keytab_add_entry failed while adding 'cifs'.\n"));
427 kvno
= (krb5_kvno
) ads_get_kvno(ads
, global_myname());
429 DEBUG(1,("ads_keytab_create_default: ads_get_kvno failed to determine the system's kvno.\n"));
433 DEBUG(3,("ads_keytab_create_default: Searching for keytab entries to preserve and update.\n"));
434 /* Now loop through the keytab and update any other existing entries... */
436 ZERO_STRUCT(kt_entry
);
439 initialize_krb5_error_table();
440 ret
= krb5_init_context(&context
);
442 DEBUG(1,("ads_keytab_create_default: could not krb5_init_context: %s\n",error_message(ret
)));
445 ret
= krb5_kt_default(context
, &keytab
);
447 DEBUG(1,("ads_keytab_create_default: krb5_kt_default failed (%s)\n",error_message(ret
)));
451 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
452 if (ret
!= KRB5_KT_END
&& ret
!= ENOENT
) {
453 while ((ret
= krb5_kt_next_entry(context
, keytab
, &kt_entry
, &cursor
)) == 0) {
454 smb_krb5_kt_free_entry(context
, &kt_entry
);
455 ZERO_STRUCT(kt_entry
);
459 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
463 * Hmmm. There is no "rewind" function for the keytab. This means we have a race condition
464 * where someone else could add entries after we've counted them. Re-open asap to minimise
468 DEBUG(3, ("ads_keytab_create_default: Found %d entries in the keytab.\n", found
));
472 oldEntries
= (char **) malloc(found
* sizeof(char *));
474 DEBUG(1,("ads_keytab_create_default: Failed to allocate space to store the old keytab entries (malloc failed?).\n"));
478 memset(oldEntries
, '\0', found
* sizeof(char *));
480 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
481 if (ret
!= KRB5_KT_END
&& ret
!= ENOENT
) {
482 while ((ret
= krb5_kt_next_entry(context
, keytab
, &kt_entry
, &cursor
)) == 0) {
483 if (kt_entry
.vno
!= kvno
) {
484 char *ktprinc
= NULL
;
487 /* This returns a malloc'ed string in ktprinc. */
488 ret
= krb5_unparse_name(context
, kt_entry
.principal
, &ktprinc
);
490 DEBUG(1,("krb5_unparse_name failed (%s)\n", error_message(ret
)));
494 * From looking at the krb5 source they don't seem to take locale
495 * or mb strings into account. Maybe this is because they assume utf8 ?
496 * In this case we may need to convert from utf8 to mb charset here ? JRA.
498 p
= strchr_m(ktprinc
, '/');
502 for (i
= 0; i
< found
; i
++) {
503 if (!oldEntries
[i
]) {
504 oldEntries
[i
] = ktprinc
;
507 if (!strcmp(oldEntries
[i
], ktprinc
)) {
508 krb5_free_unparsed_name(context
, ktprinc
);
513 krb5_free_unparsed_name(context
, ktprinc
);
516 smb_krb5_kt_free_entry(context
, &kt_entry
);
517 ZERO_STRUCT(kt_entry
);
519 for (i
= 0; oldEntries
[i
]; i
++) {
520 ret
|= ads_keytab_add_entry(ads
, oldEntries
[i
]);
521 krb5_free_unparsed_name(context
, oldEntries
[i
]);
523 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
529 SAFE_FREE(oldEntries
);
532 krb5_keytab_entry zero_kt_entry
;
533 ZERO_STRUCT(zero_kt_entry
);
534 if (memcmp(&zero_kt_entry
, &kt_entry
, sizeof(krb5_keytab_entry
))) {
535 smb_krb5_kt_free_entry(context
, &kt_entry
);
539 krb5_kt_cursor zero_csr
;
540 ZERO_STRUCT(zero_csr
);
541 if ((memcmp(&cursor
, &zero_csr
, sizeof(krb5_kt_cursor
)) != 0) && keytab
) {
542 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
546 krb5_kt_close(context
, keytab
);
549 krb5_free_context(context
);
553 #endif /* HAVE_KRB5 */