2 Unix SMB/CIFS implementation.
4 Kerberos utility functions for GENSEC
6 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2004-2005
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "system/kerberos.h"
25 #include "auth/kerberos/kerberos.h"
26 #include "auth/credentials/credentials.h"
27 #include "auth/credentials/credentials_krb5.h"
28 #include "auth/kerberos/kerberos_credentials.h"
29 #include "auth/kerberos/kerberos_util.h"
31 struct principal_container
{
32 struct smb_krb5_context
*smb_krb5_context
;
33 krb5_principal principal
;
34 const char *string_form
; /* Optional */
37 static krb5_error_code
free_principal(struct principal_container
*pc
)
39 /* current heimdal - 0.6.3, which we need anyway, fixes segfaults here */
40 krb5_free_principal(pc
->smb_krb5_context
->krb5_context
, pc
->principal
);
46 static krb5_error_code
parse_principal(TALLOC_CTX
*parent_ctx
,
47 const char *princ_string
,
48 struct smb_krb5_context
*smb_krb5_context
,
49 krb5_principal
*princ
,
50 const char **error_string
)
53 struct principal_container
*mem_ctx
;
54 if (princ_string
== NULL
) {
60 * Start with talloc(), talloc_reference() and only then call
61 * krb5_parse_name(). If any of them fails, the cleanup code is simpler.
63 mem_ctx
= talloc(parent_ctx
, struct principal_container
);
65 (*error_string
) = error_message(ENOMEM
);
69 mem_ctx
->smb_krb5_context
= talloc_reference(mem_ctx
,
71 if (mem_ctx
->smb_krb5_context
== NULL
) {
72 (*error_string
) = error_message(ENOMEM
);
77 ret
= krb5_parse_name(smb_krb5_context
->krb5_context
,
81 (*error_string
) = smb_get_krb5_error_message(
82 smb_krb5_context
->krb5_context
,
88 /* This song-and-dance effectivly puts the principal
89 * into talloc, so we can't loose it. */
90 mem_ctx
->principal
= *princ
;
91 talloc_set_destructor(mem_ctx
, free_principal
);
95 /* Obtain the principal set on this context. Requires a
96 * smb_krb5_context because we are doing krb5 principal parsing with
97 * the library routines. The returned princ is placed in the talloc
98 * system by means of a destructor (do *not* free). */
100 krb5_error_code
principal_from_credentials(TALLOC_CTX
*parent_ctx
,
101 struct cli_credentials
*credentials
,
102 struct smb_krb5_context
*smb_krb5_context
,
103 krb5_principal
*princ
,
104 enum credentials_obtained
*obtained
,
105 const char **error_string
)
108 const char *princ_string
;
109 TALLOC_CTX
*mem_ctx
= talloc_new(parent_ctx
);
110 *obtained
= CRED_UNINITIALISED
;
113 (*error_string
) = error_message(ENOMEM
);
116 princ_string
= cli_credentials_get_principal_and_obtained(credentials
,
124 ret
= parse_principal(parent_ctx
, princ_string
,
125 smb_krb5_context
, princ
, error_string
);
126 talloc_free(mem_ctx
);
130 /* Obtain the principal set on this context. Requires a
131 * smb_krb5_context because we are doing krb5 principal parsing with
132 * the library routines. The returned princ is placed in the talloc
133 * system by means of a destructor (do *not* free). */
135 static krb5_error_code
impersonate_principal_from_credentials(
136 TALLOC_CTX
*parent_ctx
,
137 struct cli_credentials
*credentials
,
138 struct smb_krb5_context
*smb_krb5_context
,
139 krb5_principal
*princ
,
140 const char **error_string
)
142 return parse_principal(parent_ctx
,
143 cli_credentials_get_impersonate_principal(credentials
),
144 smb_krb5_context
, princ
, error_string
);
147 krb5_error_code
smb_krb5_create_principals_array(TALLOC_CTX
*mem_ctx
,
148 krb5_context context
,
149 const char *account_name
,
153 uint32_t *pnum_principals
,
154 krb5_principal
**pprincipals
,
155 const char **error_string
)
157 krb5_error_code code
;
159 uint32_t num_principals
= 0;
160 krb5_principal
*principals
;
163 tmp_ctx
= talloc_new(mem_ctx
);
164 if (tmp_ctx
== NULL
) {
165 *error_string
= "Cannot allocate tmp_ctx";
170 *error_string
= "Cannot create principal without a realm";
175 if (account_name
== NULL
&& (num_spns
== 0 || spns
== NULL
)) {
176 *error_string
= "Cannot create principal without an account or SPN";
181 if (account_name
!= NULL
&& account_name
[0] != '\0') {
184 num_principals
+= num_spns
;
186 principals
= talloc_zero_array(tmp_ctx
,
189 if (principals
== NULL
) {
190 *error_string
= "Cannot allocate principals";
195 for (i
= 0; i
< num_spns
; i
++) {
196 code
= krb5_parse_name(context
, spns
[i
], &(principals
[i
]));
198 *error_string
= smb_get_krb5_error_message(context
,
205 if (account_name
!= NULL
&& account_name
[0] != '\0') {
206 code
= smb_krb5_make_principal(context
,
212 *error_string
= smb_get_krb5_error_message(context
,
219 if (pnum_principals
!= NULL
) {
220 *pnum_principals
= num_principals
;
222 if (pprincipals
!= NULL
) {
223 *pprincipals
= talloc_steal(mem_ctx
, principals
);
229 talloc_free(tmp_ctx
);
234 * Return a freshly allocated ccache (destroyed by destructor on child
235 * of parent_ctx), for a given set of client credentials
238 krb5_error_code
kinit_to_ccache(TALLOC_CTX
*parent_ctx
,
239 struct cli_credentials
*credentials
,
240 struct smb_krb5_context
*smb_krb5_context
,
241 struct tevent_context
*event_ctx
,
243 enum credentials_obtained
*obtained
,
244 const char **error_string
)
247 const char *password
;
248 const char *self_service
;
249 const char *target_service
;
251 krb5_principal princ
;
252 krb5_principal impersonate_principal
;
254 TALLOC_CTX
*mem_ctx
= talloc_new(parent_ctx
);
255 krb5_get_init_creds_opt
*krb_options
;
258 (*error_string
) = strerror(ENOMEM
);
262 ret
= principal_from_credentials(mem_ctx
, credentials
, smb_krb5_context
, &princ
, obtained
, error_string
);
264 talloc_free(mem_ctx
);
269 (*error_string
) = talloc_asprintf(credentials
, "principal, username or realm was not specified in the credentials");
270 talloc_free(mem_ctx
);
271 return KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN
;
274 ret
= impersonate_principal_from_credentials(mem_ctx
, credentials
, smb_krb5_context
, &impersonate_principal
, error_string
);
276 talloc_free(mem_ctx
);
280 self_service
= cli_credentials_get_self_service(credentials
);
281 target_service
= cli_credentials_get_target_service(credentials
);
283 password
= cli_credentials_get_password(credentials
);
285 /* setup the krb5 options we want */
286 if ((ret
= krb5_get_init_creds_opt_alloc(smb_krb5_context
->krb5_context
, &krb_options
))) {
287 (*error_string
) = talloc_asprintf(credentials
, "krb5_get_init_creds_opt_alloc failed (%s)\n",
288 smb_get_krb5_error_message(smb_krb5_context
->krb5_context
,
290 talloc_free(mem_ctx
);
294 #ifdef SAMBA4_USES_HEIMDAL /* Disable for now MIT reads defaults when needed */
295 /* get the defaults */
296 krb5_get_init_creds_opt_set_default_flags(smb_krb5_context
->krb5_context
, NULL
, NULL
, krb_options
);
298 /* set if we want a forwardable ticket */
299 switch (cli_credentials_get_krb_forwardable(credentials
)) {
300 case CRED_AUTO_KRB_FORWARDABLE
:
302 case CRED_NO_KRB_FORWARDABLE
:
303 krb5_get_init_creds_opt_set_forwardable(krb_options
, FALSE
);
305 case CRED_FORCE_KRB_FORWARDABLE
:
306 krb5_get_init_creds_opt_set_forwardable(krb_options
, TRUE
);
310 #ifdef SAMBA4_USES_HEIMDAL /* FIXME: MIT does not have this yet */
312 * In order to work against windows KDCs even if we use
313 * the netbios domain name as realm, we need to add the following
315 * KRB5_INIT_CREDS_NO_C_CANON_CHECK;
316 * KRB5_INIT_CREDS_NO_C_NO_EKU_CHECK;
318 * On MIT: Set pkinit_eku_checking to none
320 krb5_get_init_creds_opt_set_win2k(smb_krb5_context
->krb5_context
,
322 krb5_get_init_creds_opt_set_canonicalize(smb_krb5_context
->krb5_context
,
325 krb5_get_init_creds_opt_set_canonicalize(krb_options
, true);
330 #ifdef SAMBA4_USES_HEIMDAL
331 struct tevent_context
*previous_ev
;
332 /* Do this every time, in case we have weird recursive issues here */
333 ret
= smb_krb5_context_set_event_ctx(smb_krb5_context
, event_ctx
, &previous_ev
);
335 talloc_free(mem_ctx
);
340 if (impersonate_principal
) {
341 ret
= smb_krb5_kinit_s4u2_ccache(smb_krb5_context
->krb5_context
,
345 impersonate_principal
,
352 ret
= smb_krb5_kinit_password_ccache(smb_krb5_context
->krb5_context
,
361 } else if (impersonate_principal
) {
362 talloc_free(mem_ctx
);
363 (*error_string
) = "INTERNAL error: Cannot impersonate principal with just a keyblock. A password must be specified in the credentials";
366 /* No password available, try to use a keyblock instead */
368 krb5_keyblock keyblock
;
369 const struct samr_Password
*mach_pwd
;
370 mach_pwd
= cli_credentials_get_nt_hash(credentials
, mem_ctx
);
372 talloc_free(mem_ctx
);
373 (*error_string
) = "kinit_to_ccache: No password available for kinit\n";
374 krb5_get_init_creds_opt_free(smb_krb5_context
->krb5_context
, krb_options
);
375 #ifdef SAMBA4_USES_HEIMDAL
376 smb_krb5_context_remove_event_ctx(smb_krb5_context
, previous_ev
, event_ctx
);
380 ret
= smb_krb5_keyblock_init_contents(smb_krb5_context
->krb5_context
,
381 ENCTYPE_ARCFOUR_HMAC
,
382 mach_pwd
->hash
, sizeof(mach_pwd
->hash
),
386 ret
= smb_krb5_kinit_keyblock_ccache(smb_krb5_context
->krb5_context
,
394 krb5_free_keyblock_contents(smb_krb5_context
->krb5_context
, &keyblock
);
398 #ifdef SAMBA4_USES_HEIMDAL
399 smb_krb5_context_remove_event_ctx(smb_krb5_context
, previous_ev
, event_ctx
);
402 if (ret
== KRB5KRB_AP_ERR_SKEW
|| ret
== KRB5_KDCREP_SKEW
) {
403 /* Perhaps we have been given an invalid skew, so try again without it */
404 time_t t
= time(NULL
);
405 krb5_set_real_time(smb_krb5_context
->krb5_context
, t
, 0);
407 /* not a skew problem */
412 krb5_get_init_creds_opt_free(smb_krb5_context
->krb5_context
, krb_options
);
414 if (ret
== KRB5KRB_AP_ERR_SKEW
|| ret
== KRB5_KDCREP_SKEW
) {
415 (*error_string
) = talloc_asprintf(credentials
, "kinit for %s failed (%s)\n",
416 cli_credentials_get_principal(credentials
, mem_ctx
),
417 smb_get_krb5_error_message(smb_krb5_context
->krb5_context
,
419 talloc_free(mem_ctx
);
423 /* cope with ticket being in the future due to clock skew */
424 if ((unsigned)kdc_time
> time(NULL
)) {
425 time_t t
= time(NULL
);
426 int time_offset
=(unsigned)kdc_time
-t
;
427 DEBUG(4,("Advancing clock by %d seconds to cope with clock skew\n", time_offset
));
428 krb5_set_real_time(smb_krb5_context
->krb5_context
, t
+ time_offset
+ 1, 0);
431 if (ret
== KRB5KDC_ERR_PREAUTH_FAILED
&& cli_credentials_wrong_password(credentials
)) {
432 ret
= kinit_to_ccache(parent_ctx
,
441 (*error_string
) = talloc_asprintf(credentials
, "kinit for %s failed (%s)\n",
442 cli_credentials_get_principal(credentials
, mem_ctx
),
443 smb_get_krb5_error_message(smb_krb5_context
->krb5_context
,
445 talloc_free(mem_ctx
);
449 DEBUG(10,("kinit for %s succeeded\n",
450 cli_credentials_get_principal(credentials
, mem_ctx
)));
453 talloc_free(mem_ctx
);
457 static krb5_error_code
free_keytab_container(struct keytab_container
*ktc
)
459 return krb5_kt_close(ktc
->smb_krb5_context
->krb5_context
, ktc
->keytab
);
462 krb5_error_code
smb_krb5_get_keytab_container(TALLOC_CTX
*mem_ctx
,
463 struct smb_krb5_context
*smb_krb5_context
,
464 krb5_keytab opt_keytab
,
465 const char *keytab_name
,
466 struct keytab_container
**ktc
)
474 ret
= krb5_kt_resolve(smb_krb5_context
->krb5_context
,
475 keytab_name
, &keytab
);
477 DEBUG(1,("failed to open krb5 keytab: %s\n",
478 smb_get_krb5_error_message(
479 smb_krb5_context
->krb5_context
,
485 *ktc
= talloc(mem_ctx
, struct keytab_container
);
490 (*ktc
)->smb_krb5_context
= talloc_reference(*ktc
, smb_krb5_context
);
491 (*ktc
)->keytab
= keytab
;
492 (*ktc
)->password_based
= false;
493 talloc_set_destructor(*ktc
, free_keytab_container
);
499 * Walk the keytab, looking for entries of this principal name,
500 * with KVNO other than current kvno -1.
502 * These entries are now stale,
503 * we only keep the current and previous entries around.
505 * Inspired by the code in Samba3 for 'use kerberos keytab'.
507 krb5_error_code
smb_krb5_remove_obsolete_keytab_entries(TALLOC_CTX
*mem_ctx
,
508 krb5_context context
,
510 uint32_t num_principals
,
511 krb5_principal
*principals
,
513 bool *found_previous
,
514 const char **error_string
)
517 krb5_error_code code
;
518 krb5_kt_cursor cursor
;
520 tmp_ctx
= talloc_new(mem_ctx
);
521 if (tmp_ctx
== NULL
) {
522 *error_string
= "Cannot allocate tmp_ctx";
526 *found_previous
= true;
528 code
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
532 #ifdef HEIM_ERR_OPNOTSUPP
533 case HEIM_ERR_OPNOTSUPP
:
537 /* no point enumerating if there isn't anything here */
541 *error_string
= talloc_asprintf(mem_ctx
,
542 "failed to open keytab for read of old entries: %s\n",
543 smb_get_krb5_error_message(context
, code
, mem_ctx
));
548 krb5_kvno old_kvno
= kvno
- 1;
549 krb5_keytab_entry entry
;
550 bool matched
= false;
553 code
= krb5_kt_next_entry(context
, keytab
, &entry
, &cursor
);
558 for (i
= 0; i
< num_principals
; i
++) {
561 ok
= smb_krb5_kt_compare(context
,
574 * Free the entry, it wasn't the one we were looking
577 krb5_kt_free_entry(context
, &entry
);
578 /* Make sure we do not double free */
584 * Delete it, if it is not kvno - 1.
586 * Some keytab files store the kvno only in 8bits. Limit the
587 * compare to 8bits, so that we don't miss old keys and delete
590 if ((entry
.vno
& 0xff) != (old_kvno
& 0xff)) {
593 /* Release the enumeration. We are going to
594 * have to start this from the top again,
595 * because deletes during enumeration may not
596 * always be consistent.
598 * Also, the enumeration locks a FILE: keytab
600 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
602 code
= krb5_kt_remove_entry(context
, keytab
, &entry
);
603 krb5_kt_free_entry(context
, &entry
);
605 /* Make sure we do not double free */
608 /* Deleted: Restart from the top */
609 rc
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
611 krb5_kt_free_entry(context
, &entry
);
613 /* Make sure we do not double free */
616 DEBUG(1, ("failed to restart enumeration of keytab: %s\n",
617 smb_get_krb5_error_message(context
,
621 talloc_free(tmp_ctx
);
630 *found_previous
= true;
633 /* Free the entry, we don't need it any more */
634 krb5_kt_free_entry(context
, &entry
);
635 /* Make sure we do not double free */
639 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
648 *error_string
= talloc_asprintf(mem_ctx
,
649 "failed in deleting old entries for principal: %s\n",
650 smb_get_krb5_error_message(context
,
657 talloc_free(tmp_ctx
);