src/lib/krb5/krb/preauth2.c

   1 /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
   2 /*
   3  * Copyright 1995, 2003, 2008, 2012 by the Massachusetts Institute of Technology.  All
   4  * Rights Reserved.
   5  *
   6  * Export of this software from the United States of America may
   7  *   require a specific license from the United States Government.
   8  *   It is the responsibility of any person or organization contemplating
   9  *   export to obtain such a license before exporting.
  10  *
  11  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
  12  * distribute this software and its documentation for any purpose and
  13  * without fee is hereby granted, provided that the above copyright
  14  * notice appear in all copies and that both that copyright notice and
  15  * this permission notice appear in supporting documentation, and that
  16  * the name of M.I.T. not be used in advertising or publicity pertaining
  17  * to distribution of the software without specific, written prior
  18  * permission.  Furthermore if you modify this software you must label
  19  * your software as modified software and not distribute it in such a
  20  * fashion that it might be confused with the original M.I.T. software.
  21  * M.I.T. makes no representations about the suitability of
  22  * this software for any purpose.  It is provided "as is" without express
  23  * or implied warranty.
  24  *
  25  */
  26
  27 /*
  28  * This file contains routines for establishing, verifying, and any other
  29  * necessary functions, for utilizing the pre-authentication field of the
  30  * kerberos kdc request, with various hardware/software verification devices.
  31  */
  32
  33 #include "k5-int.h"
  34 #include "osconf.h"
  35 #include <krb5/preauth_plugin.h>
  36 #include "int-proto.h"
  37 #include "fast.h"
  38
  39 #if !defined(_WIN32)
  40 #include <unistd.h>
  41 #endif
  42
  43 /* This structure lets us keep track of all of the modules which are loaded,
  44  * turning the list of modules and their lists of implemented preauth types
  45  * into a single list which we can walk easily. */
  46 struct krb5_preauth_context_st {
  47     int n_modules;
  48     struct krb5_preauth_context_module_st {
  49         /* Which of the possibly more than one preauth types which the
  50          * module supports we're using at this point in the list. */
  51         krb5_preauthtype pa_type;
  52         /* Encryption types which the client claims to support -- we
  53          * copy them directly into the krb5_kdc_req structure during
  54          * krb5_preauth_prepare_request(). */
  55         krb5_enctype *enctypes;
  56         /* The plugin's module data and a function to clear it. */
  57         krb5_clpreauth_moddata moddata;
  58         krb5_clpreauth_fini_fn client_fini;
  59         /* The module's table, and some of its members, copied here for
  60          * convenience when we populated the list. */
  61         const char *name;
  62         int flags, use_count;
  63         krb5_clpreauth_process_fn client_process;
  64         krb5_clpreauth_tryagain_fn client_tryagain;
  65         krb5_clpreauth_supply_gic_opts_fn client_supply_gic_opts;
  66         krb5_clpreauth_request_init_fn client_req_init;
  67         krb5_clpreauth_request_fini_fn client_req_fini;
  68         /* The per-request context which the client_req_init() function
  69          * might allocate, which we'll need to clean up later by
  70          * calling the client_req_fini() function. */
  71         krb5_clpreauth_modreq modreq;
  72         /* A pointer to the request_context pointer.  All modules within
  73          * a plugin will point at the request_context of the first
  74          * module within the plugin. */
  75         krb5_clpreauth_modreq *modreq_p;
  76     } *modules;
  77 };
  78
  79 typedef krb5_error_code (*pa_function)(krb5_context,
  80                                        krb5_kdc_req *request,
  81                                        krb5_pa_data *in_padata,
  82                                        krb5_pa_data **out_padata,
  83                                        krb5_data *salt, krb5_data *s2kparams,
  84                                        krb5_enctype *etype,
  85                                        krb5_keyblock *as_key,
  86                                        krb5_prompter_fct prompter_fct,
  87                                        void *prompter_data,
  88                                        krb5_gic_get_as_key_fct gak_fct,
  89                                        void *gak_data);
  90
  91 typedef struct _pa_types_t {
  92     krb5_preauthtype type;
  93     pa_function fct;
  94     int flags;
  95 } pa_types_t;
  96
  97 /* Create the per-krb5_context context. This means loading the modules
  98  * if we haven't done that yet (applications which never obtain initial
  99  * credentials should never hit this routine), breaking up the module's
 100  * list of support pa_types so that we can iterate over the modules more
 101  * easily, and copying over the relevant parts of the module's table. */
 102 void KRB5_CALLCONV
 103 krb5_init_preauth_context(krb5_context kcontext)
 104 {
 105     int n_tables, n_modules, i, count;
 106     krb5_plugin_initvt_fn *plugins = NULL, *pl;
 107     struct krb5_clpreauth_vtable_st *vtables = NULL, *vt;
 108     struct krb5_preauth_context_module_st *mod;
 109     krb5_preauth_context *context = NULL;
 110     krb5_clpreauth_moddata moddata;
 111     krb5_preauthtype pa_type, *pat;
 112     krb5_boolean first;
 113     krb5_clpreauth_modreq *rcpp;
 114
 115     /* Only do this once for each krb5_context */
 116     if (kcontext->preauth_context != NULL)
 117         return;
 118
 119     /* Auto-register built-in modules. */
 120     k5_plugin_register_dyn(kcontext, PLUGIN_INTERFACE_CLPREAUTH, "pkinit",
 121                            "preauth");
 122     k5_plugin_register(kcontext, PLUGIN_INTERFACE_CLPREAUTH,
 123                        "encrypted_challenge",
 124                        clpreauth_encrypted_challenge_initvt);
 125     k5_plugin_register(kcontext, PLUGIN_INTERFACE_CLPREAUTH,
 126                        "encrypted_timestamp",
 127                        clpreauth_encrypted_timestamp_initvt);
 128     k5_plugin_register(kcontext, PLUGIN_INTERFACE_CLPREAUTH, "sam2",
 129                        clpreauth_sam2_initvt);
 130
 131     /* Get all available clpreauth vtables. */
 132     if (k5_plugin_load_all(kcontext, PLUGIN_INTERFACE_CLPREAUTH, &plugins))
 133         return;
 134     for (count = 0; plugins[count] != NULL; count++);
 135     vtables = calloc(count, sizeof(*vtables));
 136     if (vtables == NULL)
 137         goto cleanup;
 138     for (pl = plugins, n_tables = 0; *pl != NULL; pl++) {
 139         if ((*pl)(kcontext, 1, 1, (krb5_plugin_vtable)&vtables[n_tables]) == 0)
 140             n_tables++;
 141     }
 142
 143     /* Count how many modules we ended up loading, and how many preauth
 144      * types we may claim to support as a result. */
 145     n_modules = 0;
 146     for (i = 0; i < n_tables; i++) {
 147         for (count = 0; vtables[i].pa_type_list[count] > 0; count++);
 148         n_modules += count;
 149     }
 150
 151     /* Allocate the space we need. */
 152     context = malloc(sizeof(*context));
 153     if (context == NULL)
 154         goto cleanup;
 155     context->modules = calloc(n_modules, sizeof(*context->modules));
 156     if (context->modules == NULL)
 157         goto cleanup;
 158
 159     /* fill in the structure */
 160     n_modules = 0;
 161     for (i = 0; i < n_tables; i++) {
 162         vt = &vtables[i];
 163         if ((vt->pa_type_list != NULL) && (vt->process != NULL)) {
 164             moddata = NULL;
 165             if (vt->init != NULL && vt->init(kcontext, &moddata) != 0) {
 166 #ifdef DEBUG
 167                 fprintf(stderr, "init err, skipping module \"%s\"\n",
 168                         vt->name);
 169 #endif
 170                 continue;
 171             }
 172
 173             rcpp = NULL;
 174             for (pat = vt->pa_type_list, first = TRUE; *pat > 0;
 175                  pat++, first = FALSE) {
 176                 pa_type = *pat;
 177                 mod = &context->modules[n_modules];
 178                 mod->pa_type = pa_type;
 179                 mod->enctypes = vt->enctype_list;
 180                 mod->moddata = moddata;
 181                 /* Only call client_fini once per plugin */
 182                 if (first)
 183                     mod->client_fini = vt->fini;
 184                 else
 185                     mod->client_fini = NULL;
 186                 mod->name = vt->name;
 187                 mod->flags = (*vt->flags)(kcontext, pa_type);
 188                 mod->use_count = 0;
 189                 mod->client_process = vt->process;
 190                 mod->client_tryagain = vt->tryagain;
 191                 mod->client_supply_gic_opts = first ? vt->gic_opts : NULL;
 192                 mod->modreq = NULL;
 193                 /*
 194                  * Only call request_init and request_fini once per plugin.
 195                  * Only the first module within each plugin will ever
 196                  * have request_context filled in.  Every module within
 197                  * the plugin will have its request_context_pp pointing
 198                  * to that entry's request_context.  That way all the
 199                  * modules within the plugin share the same request_context
 200                  */
 201                 if (first) {
 202                     mod->client_req_init = vt->request_init;
 203                     mod->client_req_fini = vt->request_fini;
 204                     rcpp = &mod->modreq;
 205                 } else {
 206                     mod->client_req_init = NULL;
 207                     mod->client_req_fini = NULL;
 208                 }
 209                 mod->modreq_p = rcpp;
 210 #ifdef DEBUG
 211                 fprintf(stderr, "init module \"%s\", pa_type %d, flag %d\n",
 212                         mod->name, mod->pa_type, mod->flags);
 213 #endif
 214                 n_modules++;
 215             }
 216         }
 217     }
 218     context->n_modules = n_modules;
 219
 220     /* Place the constructed preauth context into the krb5 context. */
 221     kcontext->preauth_context = context;
 222     context = NULL;
 223
 224 cleanup:
 225     if (context)
 226         free(context->modules);
 227     free(context);
 228     k5_plugin_free_modules(kcontext, plugins);
 229     free(vtables);
 230 }
 231
 232 /* Zero the use counts for the modules herein.  Usually used before we
 233  * start processing any data from the server, at which point every module
 234  * will again be able to take a crack at whatever the server sent. */
 235 void KRB5_CALLCONV
 236 krb5_clear_preauth_context_use_counts(krb5_context context)
 237 {
 238     int i;
 239     if (context->preauth_context != NULL) {
 240         for (i = 0; i < context->preauth_context->n_modules; i++) {
 241             context->preauth_context->modules[i].use_count = 0;
 242         }
 243     }
 244 }
 245
 246
 247 /* Free the per-krb5_context preauth_context. This means clearing any
 248  * plugin-specific context which may have been created, and then
 249  * freeing the context itself. */
 250 void KRB5_CALLCONV
 251 krb5_free_preauth_context(krb5_context context)
 252 {
 253     int i;
 254     struct krb5_preauth_context_module_st *mod;
 255
 256     if (context == NULL || context->preauth_context == NULL)
 257         return;
 258     for (i = 0; i < context->preauth_context->n_modules; i++) {
 259         mod = &context->preauth_context->modules[i];
 260         if (mod->client_fini != NULL)
 261             mod->client_fini(context, mod->moddata);
 262         zap(mod, sizeof(*mod));
 263     }
 264     free(context->preauth_context->modules);
 265     free(context->preauth_context);
 266     context->preauth_context = NULL;
 267 }
 268
 269 /* Initialize the per-AS-REQ context. This means calling the client_req_init
 270  * function to give the plugin a chance to allocate a per-request context. */
 271 void KRB5_CALLCONV
 272 krb5_preauth_request_context_init(krb5_context context)
 273 {
 274     int i;
 275     struct krb5_preauth_context_module_st *mod;
 276
 277     if (context->preauth_context == NULL)
 278         krb5_init_preauth_context(context);
 279     if (context->preauth_context == NULL)
 280         return;
 281     for (i = 0; i < context->preauth_context->n_modules; i++) {
 282         context->preauth_context->modules[i].use_count = 0;
 283         mod = &context->preauth_context->modules[i];
 284         if (mod->client_req_init != NULL)
 285             mod->client_req_init(context, mod->moddata, mod->modreq_p);
 286     }
 287 }
 288
 289 /* Free the per-AS-REQ context. This means clearing any request-specific
 290  * context which the plugin may have created. */
 291 void KRB5_CALLCONV
 292 krb5_preauth_request_context_fini(krb5_context context)
 293 {
 294     int i;
 295     struct krb5_preauth_context_module_st *mod;
 296
 297     if (context->preauth_context == NULL)
 298         return;
 299     for (i = 0; i < context->preauth_context->n_modules; i++) {
 300         mod = &context->preauth_context->modules[i];
 301         if (mod->modreq != NULL) {
 302             if (mod->client_req_fini != NULL)
 303                 mod->client_req_fini(context, mod->moddata, mod->modreq);
 304             mod->modreq = NULL;
 305         }
 306     }
 307 }
 308
 309 /* Add the named encryption type to the existing list of ktypes. */
 310 static void
 311 grow_ktypes(krb5_enctype **out_ktypes, int *out_nktypes, krb5_enctype ktype)
 312 {
 313     int i;
 314     krb5_enctype *ktypes;
 315     for (i = 0; i < *out_nktypes; i++) {
 316         if ((*out_ktypes)[i] == ktype)
 317             return;
 318     }
 319     ktypes = malloc((*out_nktypes + 2) * sizeof(ktype));
 320     if (ktypes) {
 321         for (i = 0; i < *out_nktypes; i++)
 322             ktypes[i] = (*out_ktypes)[i];
 323         ktypes[i++] = ktype;
 324         ktypes[i] = 0;
 325         free(*out_ktypes);
 326         *out_ktypes = ktypes;
 327         *out_nktypes = i;
 328     }
 329 }
 330
 331 /*
 332  * Add the given list of pa_data items to the existing list of items.
 333  * Factored out here to make reading the do_preauth logic easier to read.
 334  */
 335 static int
 336 grow_pa_list(krb5_pa_data ***out_pa_list, int *out_pa_list_size,
 337              krb5_pa_data **addition, int num_addition)
 338 {
 339     krb5_pa_data **pa_list;
 340     int i, j;
 341
 342     if (out_pa_list == NULL || addition == NULL) {
 343         return EINVAL;
 344     }
 345
 346     if (*out_pa_list == NULL) {
 347         /* Allocate room for the new additions and a NULL terminator. */
 348         pa_list = malloc((num_addition + 1) * sizeof(krb5_pa_data *));
 349         if (pa_list == NULL)
 350             return ENOMEM;
 351         for (i = 0; i < num_addition; i++)
 352             pa_list[i] = addition[i];
 353         pa_list[i] = NULL;
 354         *out_pa_list = pa_list;
 355         *out_pa_list_size = num_addition;
 356     } else {
 357         /*
 358          * Allocate room for the existing entries plus
 359          * the new additions and a NULL terminator.
 360          */
 361         pa_list = malloc((*out_pa_list_size + num_addition + 1)
 362                          * sizeof(krb5_pa_data *));
 363         if (pa_list == NULL)
 364             return ENOMEM;
 365         for (i = 0; i < *out_pa_list_size; i++)
 366             pa_list[i] = (*out_pa_list)[i];
 367         for (j = 0; j < num_addition;)
 368             pa_list[i++] = addition[j++];
 369         pa_list[i] = NULL;
 370         free(*out_pa_list);
 371         *out_pa_list = pa_list;
 372         *out_pa_list_size = i;
 373     }
 374     return 0;
 375 }
 376
 377 static krb5_enctype
 378 get_etype(krb5_context context, krb5_clpreauth_rock rock)
 379 {
 380     return *rock->etype;
 381 }
 382
 383 static krb5_keyblock *
 384 fast_armor(krb5_context context, krb5_clpreauth_rock rock)
 385 {
 386     return rock->fast_state->armor_key;
 387 }
 388
 389 static krb5_error_code
 390 get_as_key(krb5_context context, krb5_clpreauth_rock rock,
 391            krb5_keyblock **keyblock)
 392 {
 393     krb5_error_code ret;
 394     krb5_data *salt;
 395
 396     if (rock->as_key->length == 0) {
 397         salt = (*rock->default_salt) ? NULL : rock->salt;
 398         ret = (*rock->gak_fct)(context, rock->client, *rock->etype,
 399                                rock->prompter, rock->prompter_data, salt,
 400                                rock->s2kparams, rock->as_key, *rock->gak_data);
 401         if (ret)
 402             return ret;
 403     }
 404     *keyblock = rock->as_key;
 405     return 0;
 406 }
 407
 408 static krb5_error_code
 409 set_as_key(krb5_context context, krb5_clpreauth_rock rock,
 410            const krb5_keyblock *keyblock)
 411 {
 412     krb5_free_keyblock_contents(context, rock->as_key);
 413     return krb5_copy_keyblock_contents(context, keyblock, rock->as_key);
 414 }
 415
 416 static krb5_error_code
 417 get_preauth_time(krb5_context context, krb5_clpreauth_rock rock,
 418                  krb5_boolean allow_unauth_time, krb5_timestamp *time_out,
 419                  krb5_int32 *usec_out)
 420 {
 421     if (rock->pa_offset_state != NO_OFFSET &&
 422         (allow_unauth_time || rock->pa_offset_state == AUTH_OFFSET) &&
 423         (context->library_options & KRB5_LIBOPT_SYNC_KDCTIME)) {
 424         /* Use the offset we got from the preauth-required error. */
 425         return k5_time_with_offset(rock->pa_offset, rock->pa_offset_usec,
 426                                    time_out, usec_out);
 427
 428     } else {
 429         /* Use the time offset from the context, or no offset. */
 430         return krb5_us_timeofday(context, time_out, usec_out);
 431     }
 432 }
 433
 434 static struct krb5_clpreauth_callbacks_st callbacks = {
 435     2,
 436     get_etype,
 437     fast_armor,
 438     get_as_key,
 439     set_as_key,
 440     get_preauth_time
 441 };
 442
 443 /* Tweak the request body, for now adding any enctypes which the module claims
 444  * to add support for to the list, but in the future perhaps doing more
 445  * involved things. */
 446 void KRB5_CALLCONV
 447 krb5_preauth_prepare_request(krb5_context kcontext,
 448                              krb5_gic_opt_ext *opte,
 449                              krb5_kdc_req *request)
 450 {
 451     int i, j;
 452
 453     if (kcontext->preauth_context == NULL) {
 454         return;
 455     }
 456     /* Add the module-specific enctype list to the request, but only if
 457      * it's something we can safely modify. */
 458     if (!(opte && (opte->flags & KRB5_GET_INIT_CREDS_OPT_ETYPE_LIST))) {
 459         for (i = 0; i < kcontext->preauth_context->n_modules; i++) {
 460             if (kcontext->preauth_context->modules[i].enctypes == NULL)
 461                 continue;
 462             for (j = 0; kcontext->preauth_context->modules[i].enctypes[j] != 0; j++) {
 463                 grow_ktypes(&request->ktype, &request->nktypes,
 464                             kcontext->preauth_context->modules[i].enctypes[j]);
 465             }
 466         }
 467     }
 468 }
 469
 470 /* Find the first module which provides for the named preauth type which also
 471  * hasn't had a chance to run yet (INFO modules don't count, because as a rule
 472  * they don't generate preauth data), and run it. */
 473 static krb5_error_code
 474 run_preauth_plugins(krb5_context kcontext,
 475                     int module_required_flags,
 476                     krb5_kdc_req *request,
 477                     krb5_data *encoded_request_body,
 478                     krb5_data *encoded_previous_request,
 479                     krb5_pa_data *in_padata,
 480                     krb5_prompter_fct prompter,
 481                     void *prompter_data,
 482                     krb5_clpreauth_rock preauth_rock,
 483                     krb5_pa_data ***out_pa_list,
 484                     int *out_pa_list_size,
 485                     int *module_ret,
 486                     int *module_flags,
 487                     krb5_gic_opt_ext *opte)
 488 {
 489     int i;
 490     krb5_pa_data **out_pa_data;
 491     krb5_error_code ret;
 492     struct krb5_preauth_context_module_st *module;
 493
 494     if (kcontext->preauth_context == NULL) {
 495         return ENOENT;
 496     }
 497     /* iterate over all loaded modules */
 498     for (i = 0; i < kcontext->preauth_context->n_modules; i++) {
 499         module = &kcontext->preauth_context->modules[i];
 500         /* skip over those which don't match the preauth type */
 501         if (module->pa_type != in_padata->pa_type)
 502             continue;
 503         /* skip over those which don't match the flags (INFO vs REAL, mainly) */
 504         if ((module->flags & module_required_flags) == 0)
 505             continue;
 506         /* if it's a REAL module, try to call it only once per library call */
 507         if (module_required_flags & PA_REAL) {
 508             if (module->use_count > 0) {
 509                 TRACE_PREAUTH_SKIP(kcontext, module->name, module->pa_type);
 510                 continue;
 511             }
 512             module->use_count++;
 513         }
 514         /* run the module's callback function */
 515         out_pa_data = NULL;
 516 #ifdef DEBUG
 517         fprintf(stderr, "using module \"%s\" (%d), flags = %d\n",
 518                 module->name, module->pa_type, module->flags);
 519 #endif
 520         ret = module->client_process(kcontext, module->moddata,
 521                                      *module->modreq_p,
 522                                      (krb5_get_init_creds_opt *)opte,
 523                                      &callbacks, preauth_rock,
 524                                      request, encoded_request_body,
 525                                      encoded_previous_request, in_padata,
 526                                      prompter, prompter_data, &out_pa_data);
 527         TRACE_PREAUTH_PROCESS(kcontext, module->name, module->pa_type,
 528                               module->flags, ret);
 529         /* Make note of the module's flags and status. */
 530         *module_flags = module->flags;
 531         *module_ret = ret;
 532         /* Save the new preauth data item. */
 533         if (out_pa_data != NULL) {
 534             int j;
 535             for (j = 0; out_pa_data[j] != NULL; j++);
 536             ret = grow_pa_list(out_pa_list, out_pa_list_size, out_pa_data, j);
 537             free(out_pa_data);
 538             if (ret != 0)
 539                 return ret;
 540         }
 541         break;
 542     }
 543     if (i >= kcontext->preauth_context->n_modules) {
 544         return ENOENT;
 545     }
 546     return 0;
 547 }
 548
 549 static inline krb5_data
 550 padata2data(krb5_pa_data p)
 551 {
 552     krb5_data d;
 553     d.magic = KV5M_DATA;
 554     d.length = p.length;
 555     d.data = (char *) p.contents;
 556     return d;
 557 }
 558
 559 /* Set salt in rock based on pw-salt or afs3-salt elements in padata. */
 560 static krb5_error_code
 561 get_salt(krb5_context context, krb5_pa_data **padata,
 562          krb5_kdc_req *request, krb5_clpreauth_rock rock)
 563 {
 564     krb5_error_code ret;
 565     krb5_pa_data *pa;
 566     krb5_data d;
 567     const char *p;
 568
 569     /* Look for a pw-salt or afs3-salt element. */
 570     pa = krb5int_find_pa_data(context, padata, KRB5_PADATA_PW_SALT);
 571     if (pa == NULL)
 572         pa = krb5int_find_pa_data(context, padata, KRB5_PADATA_AFS3_SALT);
 573     if (pa == NULL)
 574         return 0;
 575
 576     /* Set rock->salt based on the element we found. */
 577     krb5_free_data_contents(context, rock->salt);
 578     d = padata2data(*pa);
 579     ret = krb5int_copy_data_contents(context, &d, rock->salt);
 580     if (ret)
 581         return ret;
 582
 583     /* Adjust the salt if we got it from an afs3-salt element. */
 584     if (pa->pa_type == KRB5_PADATA_AFS3_SALT) {
 585         /* Work around a (possible) old Heimdal KDC foible. */
 586         p = memchr(rock->salt->data, '@', rock->salt->length);
 587         if (p != NULL)
 588             rock->salt->length = p - rock->salt->data;
 589         /* Tolerate extra null in MIT KDC afs3-salt value. */
 590         if (rock->salt->length > 0 &&
 591             rock->salt->data[rock->salt->length - 1] == '\0')
 592             rock->salt->length--;
 593         /* Set an s2kparams value to indicate AFS string-to-key. */
 594         krb5_free_data_contents(context, rock->s2kparams);
 595         ret = alloc_data(rock->s2kparams, 1);
 596         if (ret)
 597             return ret;
 598         rock->s2kparams->data[0] = '\1';
 599     }
 600
 601     *rock->default_salt = FALSE;
 602     TRACE_PREAUTH_SALT(context, rock->salt, pa->pa_type);
 603     return 0;
 604 }
 605
 606 /* Set etype info parameters in rock based on padata. */
 607 static krb5_error_code
 608 get_etype_info(krb5_context context, krb5_pa_data **padata,
 609                krb5_kdc_req *request, krb5_clpreauth_rock rock)
 610 {
 611     krb5_error_code ret = 0;
 612     krb5_pa_data *pa;
 613     krb5_data d;
 614     krb5_etype_info etype_info = NULL, e;
 615     krb5_etype_info_entry *entry;
 616     krb5_boolean valid_found;
 617     int i;
 618
 619     /* Find an etype-info2 or etype-info element in padata. */
 620     pa = krb5int_find_pa_data(context, padata, KRB5_PADATA_ETYPE_INFO2);
 621     if (pa != NULL) {
 622         d = padata2data(*pa);
 623         (void)decode_krb5_etype_info2(&d, &etype_info);
 624     } else {
 625         pa = krb5int_find_pa_data(context, padata, KRB5_PADATA_ETYPE_INFO);
 626         if (pa != NULL) {
 627             d = padata2data(*pa);
 628             (void)decode_krb5_etype_info(&d, &etype_info);
 629         }
 630     }
 631
 632     /* Fall back to pw-salt/afs3-salt if no etype-info element is present. */
 633     if (etype_info == NULL)
 634         return get_salt(context, padata, request, rock);
 635
 636     /* Search entries in order of the request's enctype preference. */
 637     entry = NULL;
 638     valid_found = FALSE;
 639     for (i = 0; i < request->nktypes && entry == NULL; i++) {
 640         for (e = etype_info; *e != NULL && entry == NULL; e++) {
 641             if ((*e)->etype == request->ktype[i])
 642                 entry = *e;
 643             if (krb5_c_valid_enctype((*e)->etype))
 644                 valid_found = TRUE;
 645         }
 646     }
 647     if (entry == NULL) {
 648         ret = (valid_found) ? KRB5_CONFIG_ETYPE_NOSUPP :
 649             KRB5_PROG_ETYPE_NOSUPP;
 650         goto cleanup;
 651     }
 652
 653     /* Set rock fields based on the entry we selected. */
 654     *rock->etype = entry->etype;
 655     krb5_free_data_contents(context, rock->salt);
 656     if (entry->length != KRB5_ETYPE_NO_SALT) {
 657         *rock->salt = make_data(entry->salt, entry->length);
 658         entry->salt = NULL;
 659         *rock->default_salt = FALSE;
 660     } else {
 661         *rock->salt = empty_data();
 662         *rock->default_salt = TRUE;
 663     }
 664     krb5_free_data_contents(context, rock->s2kparams);
 665     *rock->s2kparams = entry->s2kparams;
 666     entry->s2kparams = empty_data();
 667     TRACE_PREAUTH_ETYPE_INFO(context, *rock->etype, rock->salt,
 668                              rock->s2kparams);
 669
 670 cleanup:
 671     krb5_free_etype_info(context, etype_info);
 672     return ret;
 673 }
 674
 675 static krb5_error_code
 676 pa_fx_cookie(krb5_context context, krb5_kdc_req *request,
 677              krb5_pa_data *in_padata, krb5_pa_data **out_padata,
 678              krb5_data *salt, krb5_data *s2kparams, krb5_enctype *etype,
 679              krb5_keyblock *as_key, krb5_prompter_fct prompter,
 680              void *prompter_data, krb5_gic_get_as_key_fct gak_fct,
 681              void *gak_data)
 682 {
 683     krb5_pa_data *pa = calloc(1, sizeof(krb5_pa_data));
 684     krb5_octet *contents;
 685
 686     TRACE_PREAUTH_COOKIE(context, in_padata->length, in_padata->contents);
 687     if (pa == NULL)
 688         return ENOMEM;
 689     contents = malloc(in_padata->length);
 690     if (contents == NULL) {
 691         free(pa);
 692         return ENOMEM;
 693     }
 694     *pa = *in_padata;
 695     pa->contents = contents;
 696     memcpy(contents, in_padata->contents, pa->length);
 697     *out_padata = pa;
 698     return 0;
 699 }
 700
 701 static krb5_error_code
 702 pa_s4u_x509_user(krb5_context context, krb5_kdc_req *request,
 703                  krb5_pa_data *in_padata, krb5_pa_data **out_padata,
 704                  krb5_data *salt, krb5_data *s2kparams, krb5_enctype *etype,
 705                  krb5_keyblock *as_key, krb5_prompter_fct prompter,
 706                  void *prompter_data, krb5_gic_get_as_key_fct gak_fct,
 707                  void *gak_data)
 708 {
 709     krb5_s4u_userid *userid = (krb5_s4u_userid *)gak_data; /* XXX private contract */
 710     krb5_pa_data *s4u_padata;
 711     krb5_error_code code;
 712     krb5_principal client;
 713
 714     *out_padata = NULL;
 715
 716     if (userid == NULL)
 717         return EINVAL;
 718
 719     code = krb5_copy_principal(context, request->client, &client);
 720     if (code != 0)
 721         return code;
 722
 723     if (userid->user != NULL)
 724         krb5_free_principal(context, userid->user);
 725     userid->user = client;
 726
 727     if (userid->subject_cert.length != 0) {
 728         s4u_padata = malloc(sizeof(*s4u_padata));
 729         if (s4u_padata == NULL)
 730             return ENOMEM;
 731
 732         s4u_padata->magic = KV5M_PA_DATA;
 733         s4u_padata->pa_type = KRB5_PADATA_S4U_X509_USER;
 734         s4u_padata->contents = malloc(userid->subject_cert.length);
 735         if (s4u_padata->contents == NULL) {
 736             free(s4u_padata);
 737             return ENOMEM;
 738         }
 739         memcpy(s4u_padata->contents, userid->subject_cert.data, userid->subject_cert.length);
 740         s4u_padata->length = userid->subject_cert.length;
 741
 742         *out_padata = s4u_padata;
 743     }
 744
 745     return 0;
 746 }
 747
 748 /* FIXME - order significant? */
 749 static const pa_types_t pa_types[] = {
 750     {
 751         KRB5_PADATA_FX_COOKIE,
 752         pa_fx_cookie,
 753         PA_INFO,
 754     },
 755     {
 756         KRB5_PADATA_S4U_X509_USER,
 757         pa_s4u_x509_user,
 758         PA_INFO,
 759     },
 760     {
 761         -1,
 762         NULL,
 763         0,
 764     },
 765 };
 766
 767 /*
 768  * If one of the modules can adjust its AS_REQ data using the contents of the
 769  * err_reply, return 0.  If it's the sort of correction which requires that we
 770  * ask the user another question, we let the calling application deal with it.
 771  */
 772 krb5_error_code KRB5_CALLCONV
 773 krb5_do_preauth_tryagain(krb5_context kcontext,
 774                          krb5_kdc_req *request,
 775                          krb5_data *encoded_request_body,
 776                          krb5_data *encoded_previous_request,
 777                          krb5_pa_data **padata,
 778                          krb5_pa_data ***return_padata,
 779                          krb5_error *err_reply,
 780                          krb5_pa_data **err_padata,
 781                          krb5_prompter_fct prompter, void *prompter_data,
 782                          krb5_clpreauth_rock preauth_rock,
 783                          krb5_gic_opt_ext *opte)
 784 {
 785     krb5_error_code ret;
 786     krb5_pa_data **out_padata;
 787     krb5_preauth_context *context;
 788     struct krb5_preauth_context_module_st *module;
 789     int i, j;
 790     int out_pa_list_size = 0;
 791
 792     ret = KRB5KRB_ERR_GENERIC;
 793     if (kcontext->preauth_context == NULL) {
 794         return KRB5KRB_ERR_GENERIC;
 795     }
 796     context = kcontext->preauth_context;
 797     if (context == NULL) {
 798         return KRB5KRB_ERR_GENERIC;
 799     }
 800
 801     TRACE_PREAUTH_TRYAGAIN_INPUT(kcontext, padata);
 802
 803     for (i = 0; padata[i] != NULL && padata[i]->pa_type != 0; i++) {
 804         out_padata = NULL;
 805         for (j = 0; j < context->n_modules; j++) {
 806             module = &context->modules[j];
 807             if (module->pa_type != padata[i]->pa_type) {
 808                 continue;
 809             }
 810             if (module->client_tryagain == NULL) {
 811                 continue;
 812             }
 813             if ((*module->client_tryagain)(kcontext, module->moddata,
 814                                            *module->modreq_p,
 815                                            (krb5_get_init_creds_opt *)opte,
 816                                            &callbacks, preauth_rock,
 817                                            request,
 818                                            encoded_request_body,
 819                                            encoded_previous_request,
 820                                            padata[i]->pa_type,
 821                                            err_reply, err_padata,
 822                                            prompter, prompter_data,
 823                                            &out_padata) == 0) {
 824                 if (out_padata != NULL) {
 825                     int k;
 826                     for (k = 0; out_padata[k] != NULL; k++);
 827                     grow_pa_list(return_padata, &out_pa_list_size,
 828                                  out_padata, k);
 829                     free(out_padata);
 830                     TRACE_PREAUTH_TRYAGAIN_OUTPUT(kcontext, *return_padata);
 831                     return 0;
 832                 }
 833             }
 834         }
 835     }
 836     return ret;
 837 }
 838
 839 krb5_error_code KRB5_CALLCONV
 840 krb5_do_preauth(krb5_context context, krb5_kdc_req *request,
 841                 krb5_data *encoded_request_body,
 842                 krb5_data *encoded_previous_request,
 843                 krb5_pa_data **in_padata, krb5_pa_data ***out_padata,
 844                 krb5_prompter_fct prompter, void *prompter_data,
 845                 krb5_clpreauth_rock rock, krb5_gic_opt_ext *opte,
 846                 krb5_boolean *got_real_out)
 847 {
 848     unsigned int h;
 849     int i, j, out_pa_list_size;
 850     krb5_pa_data *out_pa = NULL, **out_pa_list = NULL;
 851     krb5_error_code ret;
 852     static const int paorder[] = { PA_INFO, PA_REAL };
 853     int realdone;
 854
 855     *got_real_out = FALSE;
 856
 857     if (in_padata == NULL) {
 858         *out_padata = NULL;
 859         return(0);
 860     }
 861
 862     TRACE_PREAUTH_INPUT(context, in_padata);
 863
 864     /* Scan the padata list and process etype-info or salt elements. */
 865     ret = get_etype_info(context, in_padata, request, rock);
 866     if (ret)
 867         return ret;
 868
 869     out_pa_list = NULL;
 870     out_pa_list_size = 0;
 871
 872     /* first do all the informational preauths, then the first real one */
 873
 874     for (h=0; h<(sizeof(paorder)/sizeof(paorder[0])); h++) {
 875         realdone = 0;
 876         for (i=0; in_padata[i] && !realdone; i++) {
 877             /* Try the internally-provided preauth type list. */
 878             if (!realdone) for (j=0; pa_types[j].type >= 0; j++) {
 879                     if ((in_padata[i]->pa_type == pa_types[j].type) &&
 880                         (pa_types[j].flags & paorder[h])) {
 881 #ifdef DEBUG
 882                         fprintf (stderr, "calling internal function for pa_type "
 883                                  "%d, flag %d\n", pa_types[j].type, paorder[h]);
 884 #endif
 885                         out_pa = NULL;
 886
 887                         ret = pa_types[j].fct(context, request, in_padata[i],
 888                                               &out_pa, rock->salt,
 889                                               rock->s2kparams, rock->etype,
 890                                               rock->as_key, prompter,
 891                                               prompter_data, *rock->gak_fct,
 892                                               *rock->gak_data);
 893                         if (ret) {
 894                             if (paorder[h] == PA_INFO) {
 895                                 TRACE_PREAUTH_INFO_FAIL(context,
 896                                                         in_padata[i]->pa_type,
 897                                                         ret);
 898                                 ret = 0;
 899                                 continue; /* PA_INFO type failed, ignore */
 900                             }
 901
 902                             goto cleanup;
 903                         }
 904
 905                         ret = grow_pa_list(&out_pa_list, &out_pa_list_size,
 906                                            &out_pa, 1);
 907                         if (ret != 0) {
 908                             goto cleanup;
 909                         }
 910                         if (paorder[h] == PA_REAL)
 911                             realdone = 1;
 912                     }
 913                 }
 914
 915             /* Try to use plugins now. */
 916             if (!realdone) {
 917                 krb5_init_preauth_context(context);
 918                 if (context->preauth_context != NULL) {
 919                     int module_ret = 0, module_flags;
 920 #ifdef DEBUG
 921                     fprintf (stderr, "trying modules for pa_type %d, flag %d\n",
 922                              in_padata[i]->pa_type, paorder[h]);
 923 #endif
 924                     ret = run_preauth_plugins(context,
 925                                               paorder[h],
 926                                               request,
 927                                               encoded_request_body,
 928                                               encoded_previous_request,
 929                                               in_padata[i],
 930                                               prompter,
 931                                               prompter_data,
 932                                               rock,
 933                                               &out_pa_list,
 934                                               &out_pa_list_size,
 935                                               &module_ret,
 936                                               &module_flags,
 937                                               opte);
 938                     if (ret == 0) {
 939                         if (module_ret == 0) {
 940                             if (paorder[h] == PA_REAL) {
 941                                 realdone = 1;
 942                             }
 943                         }
 944                     }
 945                 }
 946             }
 947         }
 948     }
 949
 950     TRACE_PREAUTH_OUTPUT(context, out_pa_list);
 951     *out_padata = out_pa_list;
 952
 953     *got_real_out = realdone;
 954     return(0);
 955 cleanup:
 956     if (out_pa_list) {
 957         out_pa_list[out_pa_list_size++] = NULL;
 958         krb5_free_pa_data(context, out_pa_list);
 959     }
 960     return (ret);
 961 }
 962
 963 /*
 964  * Give all the preauth plugins a look at the preauth option which
 965  * has just been set
 966  */
 967 krb5_error_code
 968 krb5_preauth_supply_preauth_data(krb5_context context, krb5_gic_opt_ext *opte,
 969                                  const char *attr, const char *value)
 970 {
 971     krb5_error_code retval = 0;
 972     int i;
 973     struct krb5_preauth_context_module_st *mod;
 974     const char *emsg = NULL;
 975
 976     if (context->preauth_context == NULL)
 977         krb5_init_preauth_context(context);
 978     if (context->preauth_context == NULL) {
 979         retval = EINVAL;
 980         krb5_set_error_message(context, retval,
 981                                _("Unable to initialize preauth context"));
 982         return retval;
 983     }
 984
 985     /*
 986      * Go down the list of preauth modules, and supply them with the
 987      * attribute/value pair.
 988      */
 989     for (i = 0; i < context->preauth_context->n_modules; i++) {
 990         mod = &context->preauth_context->modules[i];
 991         if (mod->client_supply_gic_opts == NULL)
 992             continue;
 993         retval = mod->client_supply_gic_opts(context, mod->moddata,
 994                                              (krb5_get_init_creds_opt *)opte,
 995                                              attr, value);
 996         if (retval) {
 997             emsg = krb5_get_error_message(context, retval);
 998             krb5_set_error_message(context, retval, _("Preauth plugin %s: %s"),
 999                                    mod->name, emsg);
1000             krb5_free_error_message(context, emsg);
1001             break;
1002         }
1003     }
1004     return retval;
1005 }