krb5_wrap: Rename kerberos_kinit_password_cc()
[metze/samba/wip.git] / source4 / auth / kerberos / kerberos_util.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    Kerberos utility functions for GENSEC
5    
6    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2004-2005
7
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.
12    
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.
17
18    
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/>.
21 */
22
23 #include "includes.h"
24 #include "system/kerberos.h"
25 #include "auth/kerberos/kerberos.h"
26 #include "auth/credentials/credentials.h"
27 #include "auth/credentials/credentials_proto.h"
28 #include "auth/credentials/credentials_krb5.h"
29 #include "auth/kerberos/kerberos_credentials.h"
30 #include "auth/kerberos/kerberos_util.h"
31
32 struct principal_container {
33         struct smb_krb5_context *smb_krb5_context;
34         krb5_principal principal;
35         const char *string_form; /* Optional */
36 };
37
38 static krb5_error_code free_principal(struct principal_container *pc)
39 {
40         /* current heimdal - 0.6.3, which we need anyway, fixes segfaults here */
41         krb5_free_principal(pc->smb_krb5_context->krb5_context, pc->principal);
42
43         return 0;
44 }
45
46
47 static krb5_error_code parse_principal(TALLOC_CTX *parent_ctx,
48                                        const char *princ_string,
49                                        struct smb_krb5_context *smb_krb5_context,
50                                        krb5_principal *princ,
51                                        const char **error_string)
52 {
53         int ret;
54         struct principal_container *mem_ctx;
55         if (princ_string == NULL) {
56                  *princ = NULL;
57                  return 0;
58         }
59
60         ret = krb5_parse_name(smb_krb5_context->krb5_context,
61                               princ_string, princ);
62
63         if (ret) {
64                 (*error_string) = smb_get_krb5_error_message(
65                                                 smb_krb5_context->krb5_context,
66                                                 ret, parent_ctx);
67                 return ret;
68         }
69
70         mem_ctx = talloc(parent_ctx, struct principal_container);
71         if (!mem_ctx) {
72                 (*error_string) = error_message(ENOMEM);
73                 return ENOMEM;
74         }
75
76         /* This song-and-dance effectivly puts the principal
77          * into talloc, so we can't loose it. */
78         mem_ctx->smb_krb5_context = talloc_reference(mem_ctx,
79                                                      smb_krb5_context);
80         mem_ctx->principal = *princ;
81         talloc_set_destructor(mem_ctx, free_principal);
82         return 0;
83 }
84
85 /* Obtain the principal set on this context.  Requires a
86  * smb_krb5_context because we are doing krb5 principal parsing with
87  * the library routines.  The returned princ is placed in the talloc
88  * system by means of a destructor (do *not* free). */
89
90 krb5_error_code principal_from_credentials(TALLOC_CTX *parent_ctx,
91                                 struct cli_credentials *credentials,
92                                 struct smb_krb5_context *smb_krb5_context,
93                                 krb5_principal *princ,
94                                 enum credentials_obtained *obtained,
95                                 const char **error_string)
96 {
97         krb5_error_code ret;
98         const char *princ_string;
99         TALLOC_CTX *mem_ctx = talloc_new(parent_ctx);
100         *obtained = CRED_UNINITIALISED;
101
102         if (!mem_ctx) {
103                 (*error_string) = error_message(ENOMEM);
104                 return ENOMEM;
105         }
106         princ_string = cli_credentials_get_principal_and_obtained(credentials,
107                                                                   mem_ctx,
108                                                                   obtained);
109         if (!princ_string) {
110                 *princ = NULL;
111                 return 0;
112         }
113
114         ret = parse_principal(parent_ctx, princ_string,
115                               smb_krb5_context, princ, error_string);
116         talloc_free(mem_ctx);
117         return ret;
118 }
119
120 /* Obtain the principal set on this context.  Requires a
121  * smb_krb5_context because we are doing krb5 principal parsing with
122  * the library routines.  The returned princ is placed in the talloc
123  * system by means of a destructor (do *not* free). */
124
125 static krb5_error_code impersonate_principal_from_credentials(
126                                 TALLOC_CTX *parent_ctx,
127                                 struct cli_credentials *credentials,
128                                 struct smb_krb5_context *smb_krb5_context,
129                                 krb5_principal *princ,
130                                 const char **error_string)
131 {
132         return parse_principal(parent_ctx,
133                         cli_credentials_get_impersonate_principal(credentials),
134                         smb_krb5_context, princ, error_string);
135 }
136
137 krb5_error_code smb_krb5_create_principals_array(TALLOC_CTX *mem_ctx,
138                                                  krb5_context context,
139                                                  const char *account_name,
140                                                  const char *realm,
141                                                  uint32_t num_spns,
142                                                  const char *spns[],
143                                                  uint32_t *pnum_principals,
144                                                  krb5_principal **pprincipals,
145                                                  const char **error_string)
146 {
147         krb5_error_code code;
148         TALLOC_CTX *tmp_ctx;
149         uint32_t num_principals = 0;
150         krb5_principal *principals;
151         uint32_t i;
152
153         tmp_ctx = talloc_new(mem_ctx);
154         if (tmp_ctx == NULL) {
155                 *error_string = "Cannot allocate tmp_ctx";
156                 return ENOMEM;
157         }
158
159         if (realm == NULL) {
160                 *error_string = "Cannot create principal without a realm";
161                 code = EINVAL;
162                 goto done;
163         }
164
165         if (account_name == NULL && (num_spns == 0 || spns == NULL)) {
166                 *error_string = "Cannot create principal without an account or SPN";
167                 code = EINVAL;
168                 goto done;
169         }
170
171         if (account_name != NULL && account_name[0] != '\0') {
172                 num_principals++;
173         }
174         num_principals += num_spns;
175
176         principals = talloc_zero_array(tmp_ctx,
177                                        krb5_principal,
178                                        num_principals);
179         if (principals == NULL) {
180                 *error_string = "Cannot allocate principals";
181                 code = ENOMEM;
182                 goto done;
183         }
184
185         for (i = 0; i < num_spns; i++) {
186                 code = krb5_parse_name(context, spns[i], &(principals[i]));
187                 if (code != 0) {
188                         *error_string = smb_get_krb5_error_message(context,
189                                                                    code,
190                                                                    mem_ctx);
191                         goto done;
192                 }
193         }
194
195         if (account_name != NULL && account_name[0] != '\0') {
196                 code = smb_krb5_make_principal(context,
197                                                &(principals[i]),
198                                                realm,
199                                                account_name,
200                                                NULL);
201                 if (code != 0) {
202                         *error_string = smb_get_krb5_error_message(context,
203                                                                    code,
204                                                                    mem_ctx);
205                         goto done;
206                 }
207         }
208
209         if (pnum_principals != NULL) {
210                 *pnum_principals = num_principals;
211
212                 if (pprincipals != NULL) {
213                         *pprincipals = talloc_steal(mem_ctx, principals);
214                 }
215         }
216
217         code = 0;
218 done:
219         talloc_free(tmp_ctx);
220         return code;
221 }
222
223 /**
224  * Return a freshly allocated ccache (destroyed by destructor on child
225  * of parent_ctx), for a given set of client credentials 
226  */
227
228  krb5_error_code kinit_to_ccache(TALLOC_CTX *parent_ctx,
229                                  struct cli_credentials *credentials,
230                                  struct smb_krb5_context *smb_krb5_context,
231                                  struct tevent_context *event_ctx,
232                                  krb5_ccache ccache,
233                                  enum credentials_obtained *obtained,
234                                  const char **error_string)
235 {
236         krb5_error_code ret;
237         const char *password;
238 #ifdef SAMBA4_USES_HEIMDAL
239         const char *self_service;
240 #endif
241         const char *target_service;
242         time_t kdc_time = 0;
243         krb5_principal princ;
244         krb5_principal impersonate_principal;
245         int tries;
246         TALLOC_CTX *mem_ctx = talloc_new(parent_ctx);
247         krb5_get_init_creds_opt *krb_options;
248
249         if (!mem_ctx) {
250                 (*error_string) = strerror(ENOMEM);
251                 return ENOMEM;
252         }
253
254         ret = principal_from_credentials(mem_ctx, credentials, smb_krb5_context, &princ, obtained, error_string);
255         if (ret) {
256                 talloc_free(mem_ctx);
257                 return ret;
258         }
259
260         if (princ == NULL) {
261                 (*error_string) = talloc_asprintf(credentials, "principal, username or realm was not specified in the credentials");
262                 talloc_free(mem_ctx);
263                 return KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN;
264         }
265
266         ret = impersonate_principal_from_credentials(mem_ctx, credentials, smb_krb5_context, &impersonate_principal, error_string);
267         if (ret) {
268                 talloc_free(mem_ctx);
269                 return ret;
270         }
271
272 #ifdef SAMBA4_USES_HEIMDAL
273         self_service = cli_credentials_get_self_service(credentials);
274 #endif
275         target_service = cli_credentials_get_target_service(credentials);
276
277         password = cli_credentials_get_password(credentials);
278
279         /* setup the krb5 options we want */
280         if ((ret = krb5_get_init_creds_opt_alloc(smb_krb5_context->krb5_context, &krb_options))) {
281                 (*error_string) = talloc_asprintf(credentials, "krb5_get_init_creds_opt_alloc failed (%s)\n",
282                                                   smb_get_krb5_error_message(smb_krb5_context->krb5_context,
283                                                                              ret, mem_ctx));
284                 talloc_free(mem_ctx);
285                 return ret;
286         }
287
288 #ifdef SAMBA4_USES_HEIMDAL /* Disable for now MIT reads defaults when needed */
289         /* get the defaults */
290         krb5_get_init_creds_opt_set_default_flags(smb_krb5_context->krb5_context, NULL, NULL, krb_options);
291 #endif
292         /* set if we want a forwardable ticket */
293         switch (cli_credentials_get_krb_forwardable(credentials)) {
294         case CRED_AUTO_KRB_FORWARDABLE:
295                 break;
296         case CRED_NO_KRB_FORWARDABLE:
297                 krb5_get_init_creds_opt_set_forwardable(krb_options, FALSE);
298                 break;
299         case CRED_FORCE_KRB_FORWARDABLE:
300                 krb5_get_init_creds_opt_set_forwardable(krb_options, TRUE);
301                 break;
302         }
303
304 #ifdef SAMBA4_USES_HEIMDAL /* FIXME: MIT does not have this yet */
305         /*
306          * In order to work against windows KDCs even if we use
307          * the netbios domain name as realm, we need to add the following
308          * flags:
309          * KRB5_INIT_CREDS_NO_C_CANON_CHECK;
310          * KRB5_INIT_CREDS_NO_C_NO_EKU_CHECK;
311          *
312          * On MIT: Set pkinit_eku_checking to none
313          */
314         krb5_get_init_creds_opt_set_win2k(smb_krb5_context->krb5_context,
315                                           krb_options, true);
316 #else /* MIT */
317         krb5_get_init_creds_opt_set_canonicalize(krb_options, true);
318 #endif
319
320         tries = 2;
321         while (tries--) {
322 #ifdef SAMBA4_USES_HEIMDAL
323                 struct tevent_context *previous_ev;
324                 /* Do this every time, in case we have weird recursive issues here */
325                 ret = smb_krb5_context_set_event_ctx(smb_krb5_context, event_ctx, &previous_ev);
326                 if (ret) {
327                         talloc_free(mem_ctx);
328                         return ret;
329                 }
330 #endif
331                 if (password) {
332                         if (impersonate_principal) {
333 #ifdef SAMBA4_USES_HEIMDAL
334                                 ret = kerberos_kinit_s4u2_cc(
335                                                 smb_krb5_context->krb5_context,
336                                                 ccache, princ, password,
337                                                 impersonate_principal,
338                                                 self_service, target_service,
339                                                 krb_options, NULL, &kdc_time);
340 #else
341                                 talloc_free(mem_ctx);
342                                 (*error_string) = "INTERNAL error: s4u2 ops "
343                                         "are not supported with MIT build yet";
344                                 return EINVAL;
345 #endif
346                         } else {
347                                 ret = smb_krb5_kinit_password_ccache(smb_krb5_context->krb5_context,
348                                                                      ccache,
349                                                                      princ,
350                                                                      password,
351                                                                      target_service,
352                                                                      krb_options,
353                                                                      NULL,
354                                                                      &kdc_time);
355                         }
356                 } else if (impersonate_principal) {
357                         talloc_free(mem_ctx);
358                         (*error_string) = "INTERNAL error: Cannot impersonate principal with just a keyblock.  A password must be specified in the credentials";
359                         return EINVAL;
360                 } else {
361                         /* No password available, try to use a keyblock instead */
362                         
363                         krb5_keyblock keyblock;
364                         const struct samr_Password *mach_pwd;
365                         mach_pwd = cli_credentials_get_nt_hash(credentials, mem_ctx);
366                         if (!mach_pwd) {
367                                 talloc_free(mem_ctx);
368                                 (*error_string) = "kinit_to_ccache: No password available for kinit\n";
369                                 krb5_get_init_creds_opt_free(smb_krb5_context->krb5_context, krb_options);
370 #ifdef SAMBA4_USES_HEIMDAL
371                                 smb_krb5_context_remove_event_ctx(smb_krb5_context, previous_ev, event_ctx);
372 #endif
373                                 return EINVAL;
374                         }
375                         ret = smb_krb5_keyblock_init_contents(smb_krb5_context->krb5_context,
376                                                  ENCTYPE_ARCFOUR_HMAC,
377                                                  mach_pwd->hash, sizeof(mach_pwd->hash), 
378                                                  &keyblock);
379                         
380                         if (ret == 0) {
381                                 ret = smb_krb5_kinit_keyblock_ccache(smb_krb5_context->krb5_context,
382                                                                      ccache,
383                                                                      princ,
384                                                                      &keyblock,
385                                                                      target_service,
386                                                                      krb_options,
387                                                                      NULL,
388                                                                      &kdc_time);
389                                 krb5_free_keyblock_contents(smb_krb5_context->krb5_context, &keyblock);
390                         }
391                 }
392
393 #ifdef SAMBA4_USES_HEIMDAL
394                 smb_krb5_context_remove_event_ctx(smb_krb5_context, previous_ev, event_ctx);
395 #endif
396
397                 if (ret == KRB5KRB_AP_ERR_SKEW || ret == KRB5_KDCREP_SKEW) {
398                         /* Perhaps we have been given an invalid skew, so try again without it */
399                         time_t t = time(NULL);
400                         krb5_set_real_time(smb_krb5_context->krb5_context, t, 0);
401                 } else {
402                         /* not a skew problem */
403                         break;
404                 }
405         }
406
407         krb5_get_init_creds_opt_free(smb_krb5_context->krb5_context, krb_options);
408
409         if (ret == KRB5KRB_AP_ERR_SKEW || ret == KRB5_KDCREP_SKEW) {
410                 (*error_string) = talloc_asprintf(credentials, "kinit for %s failed (%s)\n",
411                                                   cli_credentials_get_principal(credentials, mem_ctx),
412                                                   smb_get_krb5_error_message(smb_krb5_context->krb5_context,
413                                                                              ret, mem_ctx));
414                 talloc_free(mem_ctx);
415                 return ret;
416         }
417
418         /* cope with ticket being in the future due to clock skew */
419         if ((unsigned)kdc_time > time(NULL)) {
420                 time_t t = time(NULL);
421                 int time_offset =(unsigned)kdc_time-t;
422                 DEBUG(4,("Advancing clock by %d seconds to cope with clock skew\n", time_offset));
423                 krb5_set_real_time(smb_krb5_context->krb5_context, t + time_offset + 1, 0);
424         }
425         
426         if (ret == KRB5KDC_ERR_PREAUTH_FAILED && cli_credentials_wrong_password(credentials)) {
427                 ret = kinit_to_ccache(parent_ctx,
428                                       credentials,
429                                       smb_krb5_context,
430                                       event_ctx,
431                                       ccache, obtained,
432                                       error_string);
433         }
434
435         if (ret) {
436                 (*error_string) = talloc_asprintf(credentials, "kinit for %s failed (%s)\n",
437                                                   cli_credentials_get_principal(credentials, mem_ctx),
438                                                   smb_get_krb5_error_message(smb_krb5_context->krb5_context,
439                                                                              ret, mem_ctx));
440                 talloc_free(mem_ctx);
441                 return ret;
442         }
443
444         DEBUG(10,("kinit for %s succeeded\n",
445                 cli_credentials_get_principal(credentials, mem_ctx)));
446
447
448         talloc_free(mem_ctx);
449         return 0;
450 }
451
452 static krb5_error_code free_keytab_container(struct keytab_container *ktc)
453 {
454         return krb5_kt_close(ktc->smb_krb5_context->krb5_context, ktc->keytab);
455 }
456
457 krb5_error_code smb_krb5_get_keytab_container(TALLOC_CTX *mem_ctx,
458                                 struct smb_krb5_context *smb_krb5_context,
459                                 krb5_keytab opt_keytab,
460                                 const char *keytab_name,
461                                 struct keytab_container **ktc)
462 {
463         krb5_keytab keytab;
464         krb5_error_code ret;
465
466         if (opt_keytab) {
467                 keytab = opt_keytab;
468         } else {
469                 ret = krb5_kt_resolve(smb_krb5_context->krb5_context,
470                                                 keytab_name, &keytab);
471                 if (ret) {
472                         DEBUG(1,("failed to open krb5 keytab: %s\n",
473                                  smb_get_krb5_error_message(
474                                         smb_krb5_context->krb5_context,
475                                         ret, mem_ctx)));
476                         return ret;
477                 }
478         }
479
480         *ktc = talloc(mem_ctx, struct keytab_container);
481         if (!*ktc) {
482                 return ENOMEM;
483         }
484
485         (*ktc)->smb_krb5_context = talloc_reference(*ktc, smb_krb5_context);
486         (*ktc)->keytab = keytab;
487         (*ktc)->password_based = false;
488         talloc_set_destructor(*ktc, free_keytab_container);
489
490         return 0;
491 }
492
493 /*
494  * Walk the keytab, looking for entries of this principal name,
495  * with KVNO other than current kvno -1.
496  *
497  * These entries are now stale,
498  * we only keep the current and previous entries around.
499  *
500  * Inspired by the code in Samba3 for 'use kerberos keytab'.
501  */
502 krb5_error_code smb_krb5_remove_obsolete_keytab_entries(TALLOC_CTX *mem_ctx,
503                                                         krb5_context context,
504                                                         krb5_keytab keytab,
505                                                         uint32_t num_principals,
506                                                         krb5_principal *principals,
507                                                         krb5_kvno kvno,
508                                                         bool *found_previous,
509                                                         const char **error_string)
510 {
511         TALLOC_CTX *tmp_ctx;
512         krb5_error_code code;
513         krb5_kt_cursor cursor;
514
515         tmp_ctx = talloc_new(mem_ctx);
516         if (tmp_ctx == NULL) {
517                 *error_string = "Cannot allocate tmp_ctx";
518                 return ENOMEM;
519         }
520
521         *found_previous = true;
522
523         code = krb5_kt_start_seq_get(context, keytab, &cursor);
524         switch (code) {
525         case 0:
526                 break;
527 #ifdef HEIM_ERR_OPNOTSUPP
528         case HEIM_ERR_OPNOTSUPP:
529 #endif
530         case ENOENT:
531         case KRB5_KT_END:
532                 /* no point enumerating if there isn't anything here */
533                 code = 0;
534                 goto done;
535         default:
536                 *error_string = talloc_asprintf(mem_ctx,
537                                                 "failed to open keytab for read of old entries: %s\n",
538                                                 smb_get_krb5_error_message(context, code, mem_ctx));
539                 goto done;
540         }
541
542         do {
543                 krb5_kvno old_kvno = kvno - 1;
544                 krb5_keytab_entry entry;
545                 bool matched = false;
546                 uint32_t i;
547
548                 code = krb5_kt_next_entry(context, keytab, &entry, &cursor);
549                 if (code) {
550                         break;
551                 }
552
553                 for (i = 0; i < num_principals; i++) {
554                         krb5_boolean ok;
555
556                         ok = smb_krb5_kt_compare(context,
557                                                 &entry,
558                                                 principals[i],
559                                                 0,
560                                                 0);
561                         if (ok) {
562                                 matched = true;
563                                 break;
564                         }
565                 }
566
567                 if (!matched) {
568                         /*
569                          * Free the entry, it wasn't the one we were looking
570                          * for anyway
571                          */
572                         krb5_kt_free_entry(context, &entry);
573                         /* Make sure we do not double free */
574                         ZERO_STRUCT(entry);
575                         continue;
576                 }
577
578                 /*
579                  * Delete it, if it is not kvno - 1.
580                  *
581                  * Some keytab files store the kvno only in 8bits. Limit the
582                  * compare to 8bits, so that we don't miss old keys and delete
583                  * them.
584                  */
585                 if ((entry.vno & 0xff) != (old_kvno & 0xff)) {
586                         krb5_error_code rc;
587
588                         /* Release the enumeration.  We are going to
589                          * have to start this from the top again,
590                          * because deletes during enumeration may not
591                          * always be consistent.
592                          *
593                          * Also, the enumeration locks a FILE: keytab
594                          */
595                         krb5_kt_end_seq_get(context, keytab, &cursor);
596
597                         code = krb5_kt_remove_entry(context, keytab, &entry);
598                         krb5_kt_free_entry(context, &entry);
599
600                         /* Make sure we do not double free */
601                         ZERO_STRUCT(entry);
602
603                         /* Deleted: Restart from the top */
604                         rc = krb5_kt_start_seq_get(context, keytab, &cursor);
605                         if (rc != 0) {
606                                 krb5_kt_free_entry(context, &entry);
607
608                                 /* Make sure we do not double free */
609                                 ZERO_STRUCT(entry);
610
611                                 DEBUG(1, ("failed to restart enumeration of keytab: %s\n",
612                                           smb_get_krb5_error_message(context,
613                                                                      code,
614                                                                      tmp_ctx)));
615
616                                 talloc_free(tmp_ctx);
617                                 return rc;
618                         }
619
620                         if (code != 0) {
621                                 break;
622                         }
623
624                 } else {
625                         *found_previous = true;
626                 }
627
628                 /* Free the entry, we don't need it any more */
629                 krb5_kt_free_entry(context, &entry);
630                 /* Make sure we do not double free */
631                 ZERO_STRUCT(entry);
632         } while (code != 0);
633
634         krb5_kt_end_seq_get(context, keytab, &cursor);
635
636         switch (code) {
637         case 0:
638                 break;
639         case ENOENT:
640         case KRB5_KT_END:
641                 code = 0;
642                 break;
643         default:
644                 *error_string = talloc_asprintf(mem_ctx,
645                                                 "failed in deleting old entries for principal: %s\n",
646                                                 smb_get_krb5_error_message(context,
647                                                                            code,
648                                                                            mem_ctx));
649         }
650
651         code = 0;
652 done:
653         talloc_free(tmp_ctx);
654         return code;
655 }