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 2 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, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include "system/kerberos.h"
26 #include "auth/kerberos/kerberos.h"
27 #include "auth/credentials/credentials.h"
28 #include "auth/credentials/credentials_krb5.h"
30 struct principal_container {
31 struct smb_krb5_context *smb_krb5_context;
32 krb5_principal principal;
35 static int free_principal(struct principal_container *pc)
37 /* current heimdal - 0.6.3, which we need anyway, fixes segfaults here */
38 krb5_free_principal(pc->smb_krb5_context->krb5_context, pc->principal);
43 static krb5_error_code salt_principal_from_credentials(TALLOC_CTX *parent_ctx,
44 struct cli_credentials *machine_account,
45 struct smb_krb5_context *smb_krb5_context,
46 krb5_principal *salt_princ)
49 char *machine_username;
52 const char *salt_principal;
53 struct principal_container *mem_ctx = talloc(parent_ctx, struct principal_container);
58 salt_principal = cli_credentials_get_salt_principal(machine_account);
60 ret = krb5_parse_name(smb_krb5_context->krb5_context, salt_principal, salt_princ);
62 machine_username = talloc_strdup(mem_ctx, cli_credentials_get_username(machine_account));
64 if (!machine_username) {
69 if (machine_username[strlen(machine_username)-1] == '$') {
70 machine_username[strlen(machine_username)-1] = '\0';
72 lower_realm = strlower_talloc(mem_ctx, cli_credentials_get_realm(machine_account));
78 salt_body = talloc_asprintf(mem_ctx, "%s.%s", machine_username,
85 ret = krb5_make_principal(smb_krb5_context->krb5_context, salt_princ,
86 cli_credentials_get_realm(machine_account),
87 "host", salt_body, NULL);
91 /* This song-and-dance effectivly puts the principal
92 * into talloc, so we can't loose it. */
93 mem_ctx->smb_krb5_context = talloc_reference(mem_ctx, smb_krb5_context);
94 mem_ctx->principal = *salt_princ;
95 talloc_set_destructor(mem_ctx, free_principal);
100 /* Obtain the principal set on this context. Requires a
101 * smb_krb5_context because we are doing krb5 principal parsing with
102 * the library routines. The returned princ is placed in the talloc
103 * system by means of a destructor (do *not* free). */
105 krb5_error_code principal_from_credentials(TALLOC_CTX *parent_ctx,
106 struct cli_credentials *credentials,
107 struct smb_krb5_context *smb_krb5_context,
108 krb5_principal *princ)
111 const char *princ_string;
112 struct principal_container *mem_ctx = talloc(parent_ctx, struct principal_container);
117 princ_string = cli_credentials_get_principal(credentials, mem_ctx);
119 /* A NULL here has meaning, as the gssapi server case will
120 * then use the principal from the client */
122 talloc_free(mem_ctx);
127 ret = krb5_parse_name(smb_krb5_context->krb5_context,
128 princ_string, princ);
131 /* This song-and-dance effectivly puts the principal
132 * into talloc, so we can't loose it. */
133 mem_ctx->smb_krb5_context = talloc_reference(mem_ctx, smb_krb5_context);
134 mem_ctx->principal = *princ;
135 talloc_set_destructor(mem_ctx, free_principal);
141 * Return a freshly allocated ccache (destroyed by destructor on child
142 * of parent_ctx), for a given set of client credentials
145 krb5_error_code kinit_to_ccache(TALLOC_CTX *parent_ctx,
146 struct cli_credentials *credentials,
147 struct smb_krb5_context *smb_krb5_context,
151 const char *password;
153 krb5_principal princ;
155 TALLOC_CTX *mem_ctx = talloc_new(parent_ctx);
161 ret = principal_from_credentials(mem_ctx, credentials, smb_krb5_context, &princ);
163 talloc_free(mem_ctx);
167 password = cli_credentials_get_password(credentials);
172 ret = kerberos_kinit_password_cc(smb_krb5_context->krb5_context, ccache,
174 password, NULL, &kdc_time);
176 /* No password available, try to use a keyblock instead */
178 krb5_keyblock keyblock;
179 const struct samr_Password *mach_pwd;
180 mach_pwd = cli_credentials_get_nt_hash(credentials, mem_ctx);
182 talloc_free(mem_ctx);
183 DEBUG(1, ("kinit_to_ccache: No password available for kinit\n"));
186 ret = krb5_keyblock_init(smb_krb5_context->krb5_context,
187 ETYPE_ARCFOUR_HMAC_MD5,
188 mach_pwd->hash, sizeof(mach_pwd->hash),
192 ret = kerberos_kinit_keyblock_cc(smb_krb5_context->krb5_context, ccache,
194 &keyblock, NULL, &kdc_time);
195 krb5_free_keyblock_contents(smb_krb5_context->krb5_context, &keyblock);
199 if (ret == KRB5KRB_AP_ERR_SKEW || ret == KRB5_KDCREP_SKEW) {
200 /* Perhaps we have been given an invalid skew, so try again without it */
201 time_t t = time(NULL);
202 krb5_set_real_time(smb_krb5_context->krb5_context, t, 0);
204 /* not a skew problem */
209 if (ret == KRB5KRB_AP_ERR_SKEW || ret == KRB5_KDCREP_SKEW) {
210 DEBUG(1,("kinit for %s failed (%s)\n",
211 cli_credentials_get_principal(credentials, mem_ctx),
212 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
214 talloc_free(mem_ctx);
218 /* cope with ticket being in the future due to clock skew */
219 if ((unsigned)kdc_time > time(NULL)) {
220 time_t t = time(NULL);
221 int time_offset =(unsigned)kdc_time-t;
222 DEBUG(4,("Advancing clock by %d seconds to cope with clock skew\n", time_offset));
223 krb5_set_real_time(smb_krb5_context->krb5_context, t + time_offset + 1, 0);
226 if (ret == KRB5KDC_ERR_PREAUTH_FAILED && cli_credentials_wrong_password(credentials)) {
227 ret = kinit_to_ccache(parent_ctx,
233 DEBUG(1,("kinit for %s failed (%s)\n",
234 cli_credentials_get_principal(credentials, mem_ctx),
235 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
237 talloc_free(mem_ctx);
243 static int free_keytab(struct keytab_container *ktc)
245 krb5_kt_close(ktc->smb_krb5_context->krb5_context, ktc->keytab);
250 int smb_krb5_open_keytab(TALLOC_CTX *mem_ctx,
251 struct smb_krb5_context *smb_krb5_context,
252 const char *keytab_name, struct keytab_container **ktc)
256 ret = krb5_kt_resolve(smb_krb5_context->krb5_context, keytab_name, &keytab);
258 DEBUG(1,("failed to open krb5 keytab: %s\n",
259 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
264 *ktc = talloc(mem_ctx, struct keytab_container);
269 (*ktc)->smb_krb5_context = talloc_reference(*ktc, smb_krb5_context);
270 (*ktc)->keytab = keytab;
271 talloc_set_destructor(*ktc, free_keytab);
276 struct enctypes_container {
277 struct smb_krb5_context *smb_krb5_context;
278 krb5_enctype *enctypes;
281 static int free_enctypes(struct enctypes_container *etc)
283 free_kerberos_etypes(etc->smb_krb5_context->krb5_context, etc->enctypes);
287 static krb5_error_code keytab_add_keys(TALLOC_CTX *parent_ctx,
288 const char *princ_string,
289 krb5_principal princ,
290 krb5_principal salt_princ,
292 const char *password_s,
293 struct smb_krb5_context *smb_krb5_context,
298 krb5_enctype *enctypes;
299 char *enctype_string;
300 struct enctypes_container *etc;
302 TALLOC_CTX *mem_ctx = talloc_new(parent_ctx);
307 etc = talloc(mem_ctx, struct enctypes_container);
309 talloc_free(mem_ctx);
312 ret = get_kerberos_allowed_etypes(smb_krb5_context->krb5_context,
315 DEBUG(1,("keytab_add_keys: getting encrption types failed (%s)\n",
316 error_message(ret)));
317 talloc_free(mem_ctx);
321 etc->smb_krb5_context = talloc_reference(etc, smb_krb5_context);
322 etc->enctypes = enctypes;
324 talloc_set_destructor(etc, free_enctypes);
326 password.data = discard_const_p(char *, password_s);
327 password.length = strlen(password_s);
329 for (i=0; enctypes[i]; i++) {
330 krb5_keytab_entry entry;
331 ret = create_kerberos_key_from_string(smb_krb5_context->krb5_context,
332 salt_princ, &password, &entry.keyblock, enctypes[i]);
334 talloc_free(mem_ctx);
338 entry.principal = princ;
340 ret = krb5_kt_add_entry(smb_krb5_context->krb5_context, keytab, &entry);
341 enctype_string = NULL;
342 krb5_enctype_to_string(smb_krb5_context->krb5_context, enctypes[i], &enctype_string);
344 DEBUG(1, ("Failed to add %s entry for %s(kvno %d) to keytab: %s\n",
348 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
350 talloc_free(mem_ctx);
351 free(enctype_string);
352 krb5_free_keyblock_contents(smb_krb5_context->krb5_context, &entry.keyblock);
356 DEBUG(5, ("Added %s(kvno %d) to keytab (%s)\n",
359 free(enctype_string);
361 krb5_free_keyblock_contents(smb_krb5_context->krb5_context, &entry.keyblock);
363 talloc_free(mem_ctx);
367 static int create_keytab(TALLOC_CTX *parent_ctx,
368 struct cli_credentials *machine_account,
369 struct smb_krb5_context *smb_krb5_context,
374 const char *password_s;
375 char *enctype_string;
376 const char *old_secret;
378 krb5_principal salt_princ;
379 krb5_principal princ;
380 const char *princ_string;
382 TALLOC_CTX *mem_ctx = talloc_new(parent_ctx);
387 princ_string = cli_credentials_get_principal(machine_account, mem_ctx);
388 /* Get the principal we will store the new keytab entries under */
389 ret = principal_from_credentials(mem_ctx, machine_account, smb_krb5_context, &princ);
391 DEBUG(1,("create_keytab: makeing krb5 principal failed (%s)\n",
392 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
394 talloc_free(mem_ctx);
398 /* The salt used to generate these entries may be different however, fetch that */
399 ret = salt_principal_from_credentials(mem_ctx, machine_account,
403 DEBUG(1,("create_keytab: makeing salt principal failed (%s)\n",
404 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
406 talloc_free(mem_ctx);
410 /* Finally, do the dance to get the password to put in the entry */
411 password_s = cli_credentials_get_password(machine_account);
413 /* If we don't have the plaintext password, try for
414 * the MD4 password hash */
416 krb5_keytab_entry entry;
417 const struct samr_Password *mach_pwd;
418 mach_pwd = cli_credentials_get_nt_hash(machine_account, mem_ctx);
420 /* OK, nothing to do here */
421 talloc_free(mem_ctx);
424 ret = krb5_keyblock_init(smb_krb5_context->krb5_context,
425 ETYPE_ARCFOUR_HMAC_MD5,
426 mach_pwd->hash, sizeof(mach_pwd->hash),
429 DEBUG(1, ("create_keytab: krb5_keyblock_init failed: %s\n",
430 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
432 talloc_free(mem_ctx);
436 entry.principal = princ;
437 entry.vno = cli_credentials_get_kvno(machine_account);
438 ret = krb5_kt_add_entry(smb_krb5_context->krb5_context, keytab, &entry);
440 DEBUG(1, ("Failed to add ARCFOUR_HMAC (only) entry for %s to keytab: %s",
441 cli_credentials_get_principal(machine_account, mem_ctx),
442 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
444 talloc_free(mem_ctx);
445 krb5_free_keyblock_contents(smb_krb5_context->krb5_context, &entry.keyblock);
449 krb5_enctype_to_string(smb_krb5_context->krb5_context,
450 ETYPE_ARCFOUR_HMAC_MD5,
452 DEBUG(5, ("Added %s(kvno %d) to keytab (%s)\n",
453 cli_credentials_get_principal(machine_account, mem_ctx),
454 cli_credentials_get_kvno(machine_account),
456 free(enctype_string);
458 krb5_free_keyblock_contents(smb_krb5_context->krb5_context, &entry.keyblock);
460 /* Can't go any further, we only have this one key */
461 talloc_free(mem_ctx);
465 kvno = cli_credentials_get_kvno(machine_account);
466 /* good, we actually have the real plaintext */
467 ret = keytab_add_keys(mem_ctx, princ_string, princ, salt_princ,
468 kvno, password_s, smb_krb5_context, keytab);
470 talloc_free(mem_ctx);
474 if (!add_old || kvno == 0) {
475 talloc_free(mem_ctx);
479 old_secret = cli_credentials_get_old_password(machine_account);
481 talloc_free(mem_ctx);
485 ret = keytab_add_keys(mem_ctx, princ_string, princ, salt_princ,
486 kvno - 1, old_secret, smb_krb5_context, keytab);
488 talloc_free(mem_ctx);
492 talloc_free(mem_ctx);
498 * Walk the keytab, looking for entries of this principal name, with KVNO other than current kvno -1.
500 * These entries are now stale, we only keep the current, and previous entries around.
502 * Inspired by the code in Samba3 for 'use kerberos keytab'.
506 static krb5_error_code remove_old_entries(TALLOC_CTX *parent_ctx,
507 struct cli_credentials *machine_account,
508 struct smb_krb5_context *smb_krb5_context,
509 krb5_keytab keytab, BOOL *found_previous)
511 krb5_error_code ret, ret2;
512 krb5_kt_cursor cursor;
513 krb5_principal princ;
515 TALLOC_CTX *mem_ctx = talloc_new(parent_ctx);
516 const char *princ_string;
521 *found_previous = False;
522 princ_string = cli_credentials_get_principal(machine_account, mem_ctx);
524 /* Get the principal we will store the new keytab entries under */
525 ret = principal_from_credentials(mem_ctx, machine_account, smb_krb5_context, &princ);
527 DEBUG(1,("update_keytab: makeing krb5 principal failed (%s)\n",
528 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
530 talloc_free(mem_ctx);
534 kvno = cli_credentials_get_kvno(machine_account);
536 /* for each entry in the keytab */
537 ret = krb5_kt_start_seq_get(smb_krb5_context->krb5_context, keytab, &cursor);
541 case HEIM_ERR_OPNOTSUPP:
544 /* no point enumerating if there isn't anything here */
545 talloc_free(mem_ctx);
548 DEBUG(1,("failed to open keytab for read of old entries: %s\n",
549 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
551 talloc_free(mem_ctx);
556 krb5_keytab_entry entry;
557 ret = krb5_kt_next_entry(smb_krb5_context->krb5_context, keytab, &entry, &cursor);
561 /* if it matches our principal */
562 if (!krb5_kt_compare(smb_krb5_context->krb5_context, &entry, princ, 0, 0)) {
563 /* Free the entry, it wasn't the one we were looking for anyway */
564 krb5_kt_free_entry(smb_krb5_context->krb5_context, &entry);
568 /* delete it, if it is not kvno -1 */
569 if (entry.vno != (kvno - 1 )) {
570 /* Release the enumeration. We are going to
571 * have to start this from the top again,
572 * because deletes during enumeration may not
573 * always be consistant.
575 * Also, the enumeration locks a FILE: keytab
578 krb5_kt_end_seq_get(smb_krb5_context->krb5_context, keytab, &cursor);
580 ret = krb5_kt_remove_entry(smb_krb5_context->krb5_context, keytab, &entry);
581 krb5_kt_free_entry(smb_krb5_context->krb5_context, &entry);
583 /* Deleted: Restart from the top */
584 ret2 = krb5_kt_start_seq_get(smb_krb5_context->krb5_context, keytab, &cursor);
586 krb5_kt_free_entry(smb_krb5_context->krb5_context, &entry);
587 DEBUG(1,("failed to restart enumeration of keytab: %s\n",
588 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
591 talloc_free(mem_ctx);
600 *found_previous = True;
603 /* Free the entry, we don't need it any more */
604 krb5_kt_free_entry(smb_krb5_context->krb5_context, &entry);
608 krb5_kt_end_seq_get(smb_krb5_context->krb5_context, keytab, &cursor);
618 DEBUG(1,("failed in deleting old entries for principal: %s: %s\n",
620 smb_get_krb5_error_message(smb_krb5_context->krb5_context,
623 talloc_free(mem_ctx);
627 int smb_krb5_update_keytab(TALLOC_CTX *parent_ctx,
628 struct cli_credentials *machine_account,
629 struct smb_krb5_context *smb_krb5_context,
630 struct keytab_container *keytab_container)
634 TALLOC_CTX *mem_ctx = talloc_new(parent_ctx);
639 ret = remove_old_entries(mem_ctx, machine_account,
640 smb_krb5_context, keytab_container->keytab, &found_previous);
642 talloc_free(mem_ctx);
646 /* Create a new keytab. If during the cleanout we found
647 * entires for kvno -1, then don't try and duplicate them.
648 * Otherwise, add kvno, and kvno -1 */
650 ret = create_keytab(mem_ctx, machine_account, smb_krb5_context,
651 keytab_container->keytab,
652 found_previous ? False : True);
653 talloc_free(mem_ctx);
657 _PUBLIC_ int smb_krb5_create_memory_keytab(TALLOC_CTX *parent_ctx,
658 struct cli_credentials *machine_account,
659 struct smb_krb5_context *smb_krb5_context,
660 struct keytab_container **keytab_container)
663 TALLOC_CTX *mem_ctx = talloc_new(parent_ctx);
664 const char *rand_string;
665 const char *keytab_name;
670 *keytab_container = talloc(mem_ctx, struct keytab_container);
672 rand_string = generate_random_str(mem_ctx, 16);
674 talloc_free(mem_ctx);
678 keytab_name = talloc_asprintf(mem_ctx, "MEMORY:%s",
681 talloc_free(mem_ctx);
685 ret = smb_krb5_open_keytab(mem_ctx, smb_krb5_context, keytab_name, keytab_container);
690 ret = smb_krb5_update_keytab(mem_ctx, machine_account, smb_krb5_context, *keytab_container);
692 talloc_steal(parent_ctx, *keytab_container);
694 *keytab_container = NULL;
696 talloc_free(mem_ctx);