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
 395     if (rock->as_key->length == 0) {
 396         ret = (*rock->gak_fct)(context, rock->client, *rock->etype,
 397                                rock->prompter, rock->prompter_data, rock->salt,
 398                                rock->s2kparams, rock->as_key, *rock->gak_data);
 399         if (ret)
 400             return ret;
 401     }
 402     *keyblock = rock->as_key;
 403     return 0;
 404 }
 405
 406 static krb5_error_code
 407 set_as_key(krb5_context context, krb5_clpreauth_rock rock,
 408            const krb5_keyblock *keyblock)
 409 {
 410     krb5_free_keyblock_contents(context, rock->as_key);
 411     return krb5_copy_keyblock_contents(context, keyblock, rock->as_key);
 412 }
 413
 414 static krb5_error_code
 415 get_preauth_time(krb5_context context, krb5_clpreauth_rock rock,
 416                  krb5_boolean allow_unauth_time, krb5_timestamp *time_out,
 417                  krb5_int32 *usec_out)
 418 {
 419     if (rock->pa_offset_state != NO_OFFSET &&
 420         (allow_unauth_time || rock->pa_offset_state == AUTH_OFFSET) &&
 421         (context->library_options & KRB5_LIBOPT_SYNC_KDCTIME)) {
 422         /* Use the offset we got from the preauth-required error. */
 423         return k5_time_with_offset(rock->pa_offset, rock->pa_offset_usec,
 424                                    time_out, usec_out);
 425
 426     } else {
 427         /* Use the time offset from the context, or no offset. */
 428         return krb5_us_timeofday(context, time_out, usec_out);
 429     }
 430 }
 431
 432 static struct krb5_clpreauth_callbacks_st callbacks = {
 433     2,
 434     get_etype,
 435     fast_armor,
 436     get_as_key,
 437     set_as_key,
 438     get_preauth_time
 439 };
 440
 441 /* Tweak the request body, for now adding any enctypes which the module claims
 442  * to add support for to the list, but in the future perhaps doing more
 443  * involved things. */
 444 void KRB5_CALLCONV
 445 krb5_preauth_prepare_request(krb5_context kcontext,
 446                              krb5_gic_opt_ext *opte,
 447                              krb5_kdc_req *request)
 448 {
 449     int i, j;
 450
 451     if (kcontext->preauth_context == NULL) {
 452         return;
 453     }
 454     /* Add the module-specific enctype list to the request, but only if
 455      * it's something we can safely modify. */
 456     if (!(opte && (opte->flags & KRB5_GET_INIT_CREDS_OPT_ETYPE_LIST))) {
 457         for (i = 0; i < kcontext->preauth_context->n_modules; i++) {
 458             if (kcontext->preauth_context->modules[i].enctypes == NULL)
 459                 continue;
 460             for (j = 0; kcontext->preauth_context->modules[i].enctypes[j] != 0; j++) {
 461                 grow_ktypes(&request->ktype, &request->nktypes,
 462                             kcontext->preauth_context->modules[i].enctypes[j]);
 463             }
 464         }
 465     }
 466 }
 467
 468 /* Find the first module which provides for the named preauth type which also
 469  * hasn't had a chance to run yet (INFO modules don't count, because as a rule
 470  * they don't generate preauth data), and run it. */
 471 static krb5_error_code
 472 run_preauth_plugins(krb5_context kcontext,
 473                     int module_required_flags,
 474                     krb5_kdc_req *request,
 475                     krb5_data *encoded_request_body,
 476                     krb5_data *encoded_previous_request,
 477                     krb5_pa_data *in_padata,
 478                     krb5_prompter_fct prompter,
 479                     void *prompter_data,
 480                     krb5_clpreauth_rock preauth_rock,
 481                     krb5_pa_data ***out_pa_list,
 482                     int *out_pa_list_size,
 483                     int *module_ret,
 484                     int *module_flags,
 485                     krb5_gic_opt_ext *opte)
 486 {
 487     int i;
 488     krb5_pa_data **out_pa_data;
 489     krb5_error_code ret;
 490     struct krb5_preauth_context_module_st *module;
 491
 492     if (kcontext->preauth_context == NULL) {
 493         return ENOENT;
 494     }
 495     /* iterate over all loaded modules */
 496     for (i = 0; i < kcontext->preauth_context->n_modules; i++) {
 497         module = &kcontext->preauth_context->modules[i];
 498         /* skip over those which don't match the preauth type */
 499         if (module->pa_type != in_padata->pa_type)
 500             continue;
 501         /* skip over those which don't match the flags (INFO vs REAL, mainly) */
 502         if ((module->flags & module_required_flags) == 0)
 503             continue;
 504         /* if it's a REAL module, try to call it only once per library call */
 505         if (module_required_flags & PA_REAL) {
 506             if (module->use_count > 0) {
 507                 TRACE_PREAUTH_SKIP(kcontext, module->name, module->pa_type);
 508                 continue;
 509             }
 510             module->use_count++;
 511         }
 512         /* run the module's callback function */
 513         out_pa_data = NULL;
 514 #ifdef DEBUG
 515         fprintf(stderr, "using module \"%s\" (%d), flags = %d\n",
 516                 module->name, module->pa_type, module->flags);
 517 #endif
 518         ret = module->client_process(kcontext, module->moddata,
 519                                      *module->modreq_p,
 520                                      (krb5_get_init_creds_opt *)opte,
 521                                      &callbacks, preauth_rock,
 522                                      request, encoded_request_body,
 523                                      encoded_previous_request, in_padata,
 524                                      prompter, prompter_data, &out_pa_data);
 525         TRACE_PREAUTH_PROCESS(kcontext, module->name, module->pa_type,
 526                               module->flags, ret);
 527         /* Make note of the module's flags and status. */
 528         *module_flags = module->flags;
 529         *module_ret = ret;
 530         /* Save the new preauth data item. */
 531         if (out_pa_data != NULL) {
 532             int j;
 533             for (j = 0; out_pa_data[j] != NULL; j++);
 534             ret = grow_pa_list(out_pa_list, out_pa_list_size, out_pa_data, j);
 535             free(out_pa_data);
 536             if (ret != 0)
 537                 return ret;
 538         }
 539         break;
 540     }
 541     if (i >= kcontext->preauth_context->n_modules) {
 542         return ENOENT;
 543     }
 544     return 0;
 545 }
 546
 547 static inline krb5_data
 548 padata2data(krb5_pa_data p)
 549 {
 550     krb5_data d;
 551     d.magic = KV5M_DATA;
 552     d.length = p.length;
 553     d.data = (char *) p.contents;
 554     return d;
 555 }
 556
 557 /* Set etype info parameters in rock based on padata. */
 558 static krb5_error_code
 559 get_etype_info(krb5_context context, krb5_pa_data **padata,
 560                krb5_kdc_req *request, krb5_clpreauth_rock rock)
 561 {
 562     krb5_error_code ret = 0;
 563     krb5_pa_data *pa;
 564     krb5_data d;
 565     krb5_etype_info etype_info = NULL, e;
 566     krb5_etype_info_entry *entry;
 567     krb5_boolean valid_found;
 568     int i;
 569
 570     /* Find an etype-info2 or etype-info element in padata. */
 571     pa = krb5int_find_pa_data(context, padata, KRB5_PADATA_ETYPE_INFO2);
 572     if (pa != NULL) {
 573         d = padata2data(*pa);
 574         ret = decode_krb5_etype_info2(&d, &etype_info);
 575     } else {
 576         pa = krb5int_find_pa_data(context, padata, KRB5_PADATA_ETYPE_INFO2);
 577         if (pa != NULL) {
 578             d = padata2data(*pa);
 579             ret = decode_krb5_etype_info2(&d, &etype_info);
 580         }
 581     }
 582
 583     if (etype_info != NULL) {
 584         /* Search entries in order of the requests's enctype preference. */
 585         entry = NULL;
 586         valid_found = FALSE;
 587         for (i = 0; i < request->nktypes && entry == NULL; i++) {
 588             for (e = etype_info; *e != NULL && entry == NULL; e++) {
 589                 if ((*e)->etype == request->ktype[i])
 590                     entry = *e;
 591                 if (krb5_c_valid_enctype((*e)->etype))
 592                     valid_found = TRUE;
 593             }
 594         }
 595         if (entry == NULL) {
 596             ret = (valid_found) ? KRB5_CONFIG_ETYPE_NOSUPP :
 597                 KRB5_PROG_ETYPE_NOSUPP;
 598             goto cleanup;
 599         }
 600
 601         /* Set rock fields based on the entry we selected. */
 602         *rock->etype = entry->etype;
 603         krb5_free_data_contents(context, rock->salt);
 604         if (entry->length != KRB5_ETYPE_NO_SALT) {
 605             *rock->salt = make_data(entry->salt, entry->length);
 606             entry->salt = NULL;
 607         }
 608         krb5_free_data_contents(context, rock->s2kparams);
 609         *rock->s2kparams = entry->s2kparams;
 610         entry->s2kparams = empty_data();
 611         TRACE_PREAUTH_ETYPE_INFO(context, *rock->etype, rock->salt,
 612                                  rock->s2kparams);
 613     } else {
 614         /* Look for a pw-salt or afs3-salt element. */
 615         pa = krb5int_find_pa_data(context, padata, KRB5_PADATA_PW_SALT);
 616         if (pa == NULL)
 617             pa = krb5int_find_pa_data(context, padata, KRB5_PADATA_AFS3_SALT);
 618         if (pa != NULL) {
 619             /* Set rock->salt based on the element we found. */
 620             krb5_free_data_contents(context, rock->salt);
 621             d = padata2data(*pa);
 622             ret = krb5int_copy_data_contents_add0(context, &d, rock->salt);
 623             if (ret)
 624                 goto cleanup;
 625             TRACE_PREAUTH_SALT(context, rock->salt, pa->pa_type);
 626             if (pa->pa_type == KRB5_PADATA_AFS3_SALT)
 627                 rock->salt->length = SALT_TYPE_AFS_LENGTH;
 628         }
 629     }
 630
 631 cleanup:
 632     krb5_free_etype_info(context, etype_info);
 633     return ret;
 634 }
 635
 636 static krb5_error_code
 637 pa_fx_cookie(krb5_context context, krb5_kdc_req *request,
 638              krb5_pa_data *in_padata, krb5_pa_data **out_padata,
 639              krb5_data *salt, krb5_data *s2kparams, krb5_enctype *etype,
 640              krb5_keyblock *as_key, krb5_prompter_fct prompter,
 641              void *prompter_data, krb5_gic_get_as_key_fct gak_fct,
 642              void *gak_data)
 643 {
 644     krb5_pa_data *pa = calloc(1, sizeof(krb5_pa_data));
 645     krb5_octet *contents;
 646
 647     TRACE_PREAUTH_COOKIE(context, in_padata->length, in_padata->contents);
 648     if (pa == NULL)
 649         return ENOMEM;
 650     contents = malloc(in_padata->length);
 651     if (contents == NULL) {
 652         free(pa);
 653         return ENOMEM;
 654     }
 655     *pa = *in_padata;
 656     pa->contents = contents;
 657     memcpy(contents, in_padata->contents, pa->length);
 658     *out_padata = pa;
 659     return 0;
 660 }
 661
 662 static krb5_error_code
 663 pa_s4u_x509_user(krb5_context context, krb5_kdc_req *request,
 664                  krb5_pa_data *in_padata, krb5_pa_data **out_padata,
 665                  krb5_data *salt, krb5_data *s2kparams, krb5_enctype *etype,
 666                  krb5_keyblock *as_key, krb5_prompter_fct prompter,
 667                  void *prompter_data, krb5_gic_get_as_key_fct gak_fct,
 668                  void *gak_data)
 669 {
 670     krb5_s4u_userid *userid = (krb5_s4u_userid *)gak_data; /* XXX private contract */
 671     krb5_pa_data *s4u_padata;
 672     krb5_error_code code;
 673     krb5_principal client;
 674
 675     *out_padata = NULL;
 676
 677     if (userid == NULL)
 678         return EINVAL;
 679
 680     code = krb5_copy_principal(context, request->client, &client);
 681     if (code != 0)
 682         return code;
 683
 684     if (userid->user != NULL)
 685         krb5_free_principal(context, userid->user);
 686     userid->user = client;
 687
 688     if (userid->subject_cert.length != 0) {
 689         s4u_padata = malloc(sizeof(*s4u_padata));
 690         if (s4u_padata == NULL)
 691             return ENOMEM;
 692
 693         s4u_padata->magic = KV5M_PA_DATA;
 694         s4u_padata->pa_type = KRB5_PADATA_S4U_X509_USER;
 695         s4u_padata->contents = malloc(userid->subject_cert.length);
 696         if (s4u_padata->contents == NULL) {
 697             free(s4u_padata);
 698             return ENOMEM;
 699         }
 700         memcpy(s4u_padata->contents, userid->subject_cert.data, userid->subject_cert.length);
 701         s4u_padata->length = userid->subject_cert.length;
 702
 703         *out_padata = s4u_padata;
 704     }
 705
 706     return 0;
 707 }
 708
 709 /* FIXME - order significant? */
 710 static const pa_types_t pa_types[] = {
 711     {
 712         KRB5_PADATA_FX_COOKIE,
 713         pa_fx_cookie,
 714         PA_INFO,
 715     },
 716     {
 717         KRB5_PADATA_S4U_X509_USER,
 718         pa_s4u_x509_user,
 719         PA_INFO,
 720     },
 721     {
 722         -1,
 723         NULL,
 724         0,
 725     },
 726 };
 727
 728 /*
 729  * If one of the modules can adjust its AS_REQ data using the contents of the
 730  * err_reply, return 0.  If it's the sort of correction which requires that we
 731  * ask the user another question, we let the calling application deal with it.
 732  */
 733 krb5_error_code KRB5_CALLCONV
 734 krb5_do_preauth_tryagain(krb5_context kcontext,
 735                          krb5_kdc_req *request,
 736                          krb5_data *encoded_request_body,
 737                          krb5_data *encoded_previous_request,
 738                          krb5_pa_data **padata,
 739                          krb5_pa_data ***return_padata,
 740                          krb5_error *err_reply,
 741                          krb5_pa_data **err_padata,
 742                          krb5_prompter_fct prompter, void *prompter_data,
 743                          krb5_clpreauth_rock preauth_rock,
 744                          krb5_gic_opt_ext *opte)
 745 {
 746     krb5_error_code ret;
 747     krb5_pa_data **out_padata;
 748     krb5_preauth_context *context;
 749     struct krb5_preauth_context_module_st *module;
 750     int i, j;
 751     int out_pa_list_size = 0;
 752
 753     ret = KRB5KRB_ERR_GENERIC;
 754     if (kcontext->preauth_context == NULL) {
 755         return KRB5KRB_ERR_GENERIC;
 756     }
 757     context = kcontext->preauth_context;
 758     if (context == NULL) {
 759         return KRB5KRB_ERR_GENERIC;
 760     }
 761
 762     TRACE_PREAUTH_TRYAGAIN_INPUT(kcontext, padata);
 763
 764     for (i = 0; padata[i] != NULL && padata[i]->pa_type != 0; i++) {
 765         out_padata = NULL;
 766         for (j = 0; j < context->n_modules; j++) {
 767             module = &context->modules[j];
 768             if (module->pa_type != padata[i]->pa_type) {
 769                 continue;
 770             }
 771             if (module->client_tryagain == NULL) {
 772                 continue;
 773             }
 774             if ((*module->client_tryagain)(kcontext, module->moddata,
 775                                            *module->modreq_p,
 776                                            (krb5_get_init_creds_opt *)opte,
 777                                            &callbacks, preauth_rock,
 778                                            request,
 779                                            encoded_request_body,
 780                                            encoded_previous_request,
 781                                            padata[i]->pa_type,
 782                                            err_reply, err_padata,
 783                                            prompter, prompter_data,
 784                                            &out_padata) == 0) {
 785                 if (out_padata != NULL) {
 786                     int k;
 787                     for (k = 0; out_padata[k] != NULL; k++);
 788                     grow_pa_list(return_padata, &out_pa_list_size,
 789                                  out_padata, k);
 790                     free(out_padata);
 791                     TRACE_PREAUTH_TRYAGAIN_OUTPUT(kcontext, *return_padata);
 792                     return 0;
 793                 }
 794             }
 795         }
 796     }
 797     return ret;
 798 }
 799
 800 krb5_error_code KRB5_CALLCONV
 801 krb5_do_preauth(krb5_context context, krb5_kdc_req *request,
 802                 krb5_data *encoded_request_body,
 803                 krb5_data *encoded_previous_request,
 804                 krb5_pa_data **in_padata, krb5_pa_data ***out_padata,
 805                 krb5_prompter_fct prompter, void *prompter_data,
 806                 krb5_clpreauth_rock rock, krb5_gic_opt_ext *opte,
 807                 krb5_boolean *got_real_out)
 808 {
 809     unsigned int h;
 810     int i, j, out_pa_list_size;
 811     krb5_pa_data *out_pa = NULL, **out_pa_list = NULL;
 812     krb5_error_code ret;
 813     static const int paorder[] = { PA_INFO, PA_REAL };
 814     int realdone;
 815
 816     *got_real_out = FALSE;
 817
 818     if (in_padata == NULL) {
 819         *out_padata = NULL;
 820         return(0);
 821     }
 822
 823     TRACE_PREAUTH_INPUT(context, in_padata);
 824
 825     /* Scan the padata list and process etype-info or salt elements. */
 826     ret = get_etype_info(context, in_padata, request, rock);
 827     if (ret)
 828         return ret;
 829
 830     out_pa_list = NULL;
 831     out_pa_list_size = 0;
 832
 833     /* first do all the informational preauths, then the first real one */
 834
 835     for (h=0; h<(sizeof(paorder)/sizeof(paorder[0])); h++) {
 836         realdone = 0;
 837         for (i=0; in_padata[i] && !realdone; i++) {
 838             /* Try the internally-provided preauth type list. */
 839             if (!realdone) for (j=0; pa_types[j].type >= 0; j++) {
 840                     if ((in_padata[i]->pa_type == pa_types[j].type) &&
 841                         (pa_types[j].flags & paorder[h])) {
 842 #ifdef DEBUG
 843                         fprintf (stderr, "calling internal function for pa_type "
 844                                  "%d, flag %d\n", pa_types[j].type, paorder[h]);
 845 #endif
 846                         out_pa = NULL;
 847
 848                         ret = pa_types[j].fct(context, request, in_padata[i],
 849                                               &out_pa, rock->salt,
 850                                               rock->s2kparams, rock->etype,
 851                                               rock->as_key, prompter,
 852                                               prompter_data, *rock->gak_fct,
 853                                               *rock->gak_data);
 854                         if (ret) {
 855                             if (paorder[h] == PA_INFO) {
 856                                 TRACE_PREAUTH_INFO_FAIL(context,
 857                                                         in_padata[i]->pa_type,
 858                                                         ret);
 859                                 ret = 0;
 860                                 continue; /* PA_INFO type failed, ignore */
 861                             }
 862
 863                             goto cleanup;
 864                         }
 865
 866                         ret = grow_pa_list(&out_pa_list, &out_pa_list_size,
 867                                            &out_pa, 1);
 868                         if (ret != 0) {
 869                             goto cleanup;
 870                         }
 871                         if (paorder[h] == PA_REAL)
 872                             realdone = 1;
 873                     }
 874                 }
 875
 876             /* Try to use plugins now. */
 877             if (!realdone) {
 878                 krb5_init_preauth_context(context);
 879                 if (context->preauth_context != NULL) {
 880                     int module_ret = 0, module_flags;
 881 #ifdef DEBUG
 882                     fprintf (stderr, "trying modules for pa_type %d, flag %d\n",
 883                              in_padata[i]->pa_type, paorder[h]);
 884 #endif
 885                     ret = run_preauth_plugins(context,
 886                                               paorder[h],
 887                                               request,
 888                                               encoded_request_body,
 889                                               encoded_previous_request,
 890                                               in_padata[i],
 891                                               prompter,
 892                                               prompter_data,
 893                                               rock,
 894                                               &out_pa_list,
 895                                               &out_pa_list_size,
 896                                               &module_ret,
 897                                               &module_flags,
 898                                               opte);
 899                     if (ret == 0) {
 900                         if (module_ret == 0) {
 901                             if (paorder[h] == PA_REAL) {
 902                                 realdone = 1;
 903                             }
 904                         }
 905                     }
 906                 }
 907             }
 908         }
 909     }
 910
 911     TRACE_PREAUTH_OUTPUT(context, out_pa_list);
 912     *out_padata = out_pa_list;
 913
 914     *got_real_out = realdone;
 915     return(0);
 916 cleanup:
 917     if (out_pa_list) {
 918         out_pa_list[out_pa_list_size++] = NULL;
 919         krb5_free_pa_data(context, out_pa_list);
 920     }
 921     return (ret);
 922 }
 923
 924 /*
 925  * Give all the preauth plugins a look at the preauth option which
 926  * has just been set
 927  */
 928 krb5_error_code
 929 krb5_preauth_supply_preauth_data(krb5_context context, krb5_gic_opt_ext *opte,
 930                                  const char *attr, const char *value)
 931 {
 932     krb5_error_code retval = 0;
 933     int i;
 934     struct krb5_preauth_context_module_st *mod;
 935     const char *emsg = NULL;
 936
 937     if (context->preauth_context == NULL)
 938         krb5_init_preauth_context(context);
 939     if (context->preauth_context == NULL) {
 940         retval = EINVAL;
 941         krb5_set_error_message(context, retval,
 942                                _("Unable to initialize preauth context"));
 943         return retval;
 944     }
 945
 946     /*
 947      * Go down the list of preauth modules, and supply them with the
 948      * attribute/value pair.
 949      */
 950     for (i = 0; i < context->preauth_context->n_modules; i++) {
 951         mod = &context->preauth_context->modules[i];
 952         if (mod->client_supply_gic_opts == NULL)
 953             continue;
 954         retval = mod->client_supply_gic_opts(context, mod->moddata,
 955                                              (krb5_get_init_creds_opt *)opte,
 956                                              attr, value);
 957         if (retval) {
 958             emsg = krb5_get_error_message(context, retval);
 959             krb5_set_error_message(context, retval, _("Preauth plugin %s: %s"),
 960                                    mod->name, emsg);
 961             krb5_free_error_message(context, emsg);
 962             break;
 963         }
 964     }
 965     return retval;
 966 }