lib/client.c

   1 /* SASL client API implementation
   2  * Rob Siemborski
   3  * Tim Martin
   4  * $Id: client.c,v 1.67 2006/04/26 15:33:41 mel Exp $
   5  */
   6 /*
   7  * Copyright (c) 1998-2003 Carnegie Mellon University.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. The name "Carnegie Mellon University" must not be used to
  22  *    endorse or promote products derived from this software without
  23  *    prior written permission. For permission or any other legal
  24  *    details, please contact
  25  *      Office of Technology Transfer
  26  *      Carnegie Mellon University
  27  *      5000 Forbes Avenue
  28  *      Pittsburgh, PA  15213-3890
  29  *      (412) 268-4387, fax: (412) 268-7395
  30  *      tech-transfer@andrew.cmu.edu
  31  *
  32  * 4. Redistributions of any form whatsoever must retain the following
  33  *    acknowledgment:
  34  *    "This product includes software developed by Computing Services
  35  *     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
  36  *
  37  * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  38  * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  39  * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  40  * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  41  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  42  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  43  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  44  */
  45
  46 #include <config.h>
  47 #include <stdio.h>
  48 #include <stdlib.h>
  49 #include <limits.h>
  50 #include <ctype.h>
  51 #include <string.h>
  52 #ifdef HAVE_UNISTD_H
  53 #include <unistd.h>
  54 #endif
  55
  56 /* SASL Headers */
  57 #include "sasl.h"
  58 #include "saslplug.h"
  59 #include "saslutil.h"
  60 #include "saslint.h"
  61
  62 static cmech_list_t *cmechlist; /* global var which holds the list */
  63 sasl_global_callbacks_t global_callbacks_client;
  64 static int _sasl_client_active = 0;
  65
  66 static int init_mechlist()
  67 {
  68   cmechlist->mutex = sasl_MUTEX_ALLOC();
  69   if(!cmechlist->mutex) return SASL_FAIL;
  70
  71   cmechlist->utils=_sasl_alloc_utils(NULL, &global_callbacks_client);
  72   if (cmechlist->utils==NULL)
  73     return SASL_NOMEM;
  74
  75   cmechlist->mech_list=NULL;
  76   cmechlist->mech_length=0;
  77
  78   return SASL_OK;
  79 }
  80
  81 static int client_done(void) {
  82   cmechanism_t *cm;
  83   cmechanism_t *cprevm;
  84
  85   if(!_sasl_client_active)
  86       return SASL_NOTINIT;
  87   else
  88       _sasl_client_active--;
  89
  90   if(_sasl_client_active) {
  91       /* Don't de-init yet! Our refcount is nonzero. */
  92       return SASL_CONTINUE;
  93   }
  94
  95   cm=cmechlist->mech_list; /* m point to begging of the list */
  96   while (cm!=NULL)
  97   {
  98     cprevm=cm;
  99     cm=cm->next;
 100
 101     if (cprevm->m.plug->mech_free) {
 102         cprevm->m.plug->mech_free(cprevm->m.plug->glob_context,
 103                                 cmechlist->utils);
 104     }
 105
 106     sasl_FREE(cprevm->m.plugname);
 107     sasl_FREE(cprevm);
 108   }
 109   sasl_MUTEX_FREE(cmechlist->mutex);
 110   _sasl_free_utils(&cmechlist->utils);
 111   sasl_FREE(cmechlist);
 112
 113   cmechlist = NULL;
 114
 115   return SASL_OK;
 116 }
 117
 118 int sasl_client_add_plugin(const char *plugname,
 119                            sasl_client_plug_init_t *entry_point)
 120 {
 121   int plugcount;
 122   sasl_client_plug_t *pluglist;
 123   cmechanism_t *mech;
 124   int result;
 125   int version;
 126   int lupe;
 127
 128   if(!plugname || !entry_point) return SASL_BADPARAM;
 129
 130   result = entry_point(cmechlist->utils, SASL_CLIENT_PLUG_VERSION, &version,
 131                        &pluglist, &plugcount);
 132
 133   if (result != SASL_OK)
 134   {
 135     _sasl_log(NULL, SASL_LOG_WARN,
 136               "entry_point failed in sasl_client_add_plugin for %s",
 137               plugname);
 138     return result;
 139   }
 140
 141   if (version != SASL_CLIENT_PLUG_VERSION)
 142   {
 143     _sasl_log(NULL, SASL_LOG_WARN,
 144               "version conflict in sasl_client_add_plugin for %s", plugname);
 145     return SASL_BADVERS;
 146   }
 147
 148   for (lupe=0;lupe< plugcount ;lupe++)
 149     {
 150       mech = sasl_ALLOC(sizeof(cmechanism_t));
 151       if (! mech) return SASL_NOMEM;
 152
 153       mech->m.plug=pluglist++;
 154       if(_sasl_strdup(plugname, &mech->m.plugname, NULL) != SASL_OK) {
 155         sasl_FREE(mech);
 156         return SASL_NOMEM;
 157       }
 158       mech->m.version = version;
 159       mech->next = cmechlist->mech_list;
 160       cmechlist->mech_list = mech;
 161       cmechlist->mech_length++;
 162     }
 163
 164   return SASL_OK;
 165 }
 166
 167 static int
 168 client_idle(sasl_conn_t *conn)
 169 {
 170   cmechanism_t *m;
 171   if (! cmechlist)
 172     return 0;
 173
 174   for (m = cmechlist->mech_list;
 175        m;
 176        m = m->next)
 177     if (m->m.plug->idle
 178         &&  m->m.plug->idle(m->m.plug->glob_context,
 179                           conn,
 180                           conn ? ((sasl_client_conn_t *)conn)->cparams : NULL))
 181       return 1;
 182   return 0;
 183 }
 184
 185 /* initialize the SASL client drivers
 186  *  callbacks      -- base callbacks for all client connections
 187  * returns:
 188  *  SASL_OK        -- Success
 189  *  SASL_NOMEM     -- Not enough memory
 190  *  SASL_BADVERS   -- Mechanism version mismatch
 191  *  SASL_BADPARAM  -- error in config file
 192  *  SASL_NOMECH    -- No mechanisms available
 193  *  ...
 194  */
 195
 196 int sasl_client_init(const sasl_callback_t *callbacks)
 197 {
 198   int ret;
 199   const add_plugin_list_t ep_list[] = {
 200       { "sasl_client_plug_init", (add_plugin_t *)sasl_client_add_plugin },
 201       { "sasl_canonuser_init", (add_plugin_t *)sasl_canonuser_add_plugin },
 202       { NULL, NULL }
 203   };
 204
 205   if(_sasl_client_active) {
 206       /* We're already active, just increase our refcount */
 207       /* xxx do something with the callback structure? */
 208       _sasl_client_active++;
 209       return SASL_OK;
 210   }
 211
 212   global_callbacks_client.callbacks = callbacks;
 213   global_callbacks_client.appname = NULL;
 214
 215   cmechlist=sasl_ALLOC(sizeof(cmech_list_t));
 216   if (cmechlist==NULL) return SASL_NOMEM;
 217
 218   /* We need to call client_done if we fail now */
 219   _sasl_client_active = 1;
 220
 221   /* load plugins */
 222   ret=init_mechlist();
 223   if (ret!=SASL_OK) {
 224       client_done();
 225       return ret;
 226   }
 227
 228   sasl_client_add_plugin("EXTERNAL", &external_client_plug_init);
 229
 230   ret = _sasl_common_init(&global_callbacks_client);
 231
 232   if (ret == SASL_OK)
 233       ret = _sasl_load_plugins(ep_list,
 234                                _sasl_find_getpath_callback(callbacks),
 235                                _sasl_find_verifyfile_callback(callbacks));
 236
 237   if (ret == SASL_OK) {
 238       _sasl_client_cleanup_hook = &client_done;
 239       _sasl_client_idle_hook = &client_idle;
 240
 241       ret = _sasl_build_mechlist();
 242   } else {
 243       client_done();
 244   }
 245
 246   return ret;
 247 }
 248
 249 static void client_dispose(sasl_conn_t *pconn)
 250 {
 251   sasl_client_conn_t *c_conn=(sasl_client_conn_t *) pconn;
 252
 253   if (c_conn->mech && c_conn->mech->m.plug->mech_dispose) {
 254     c_conn->mech->m.plug->mech_dispose(pconn->context,
 255                                      c_conn->cparams->utils);
 256   }
 257
 258   pconn->context = NULL;
 259
 260   if (c_conn->clientFQDN)
 261       sasl_FREE(c_conn->clientFQDN);
 262
 263   if (c_conn->cparams) {
 264       _sasl_free_utils(&(c_conn->cparams->utils));
 265       sasl_FREE(c_conn->cparams);
 266   }
 267
 268   _sasl_conn_dispose(pconn);
 269 }
 270
 271 /* initialize a client exchange based on the specified mechanism
 272  *  service       -- registered name of the service using SASL (e.g. "imap")
 273  *  serverFQDN    -- the fully qualified domain name of the server
 274  *  iplocalport   -- client IPv4/IPv6 domain literal string with port
 275  *                    (if NULL, then mechanisms requiring IPaddr are disabled)
 276  *  ipremoteport  -- server IPv4/IPv6 domain literal string with port
 277  *                    (if NULL, then mechanisms requiring IPaddr are disabled)
 278  *  prompt_supp   -- list of client interactions supported
 279  *                   may also include sasl_getopt_t context & call
 280  *                   NULL prompt_supp = user/pass via SASL_INTERACT only
 281  *                   NULL proc = interaction supported via SASL_INTERACT
 282  *  secflags      -- security flags (see above)
 283  * in/out:
 284  *  pconn         -- connection negotiation structure
 285  *                   pointer to NULL => allocate new
 286  *                   non-NULL => recycle storage and go for next available mech
 287  *
 288  * Returns:
 289  *  SASL_OK       -- success
 290  *  SASL_NOMECH   -- no mechanism meets requested properties
 291  *  SASL_NOMEM    -- not enough memory
 292  */
 293 int sasl_client_new(const char *service,
 294                     const char *serverFQDN,
 295                     const char *iplocalport,
 296                     const char *ipremoteport,
 297                     const sasl_callback_t *prompt_supp,
 298                     unsigned flags,
 299                     sasl_conn_t **pconn)
 300 {
 301   int result;
 302   char name[MAXHOSTNAMELEN];
 303   sasl_client_conn_t *conn;
 304   sasl_utils_t *utils;
 305
 306   if(_sasl_client_active==0) return SASL_NOTINIT;
 307
 308   /* Remember, serverFQDN, iplocalport and ipremoteport can be NULL and be valid! */
 309   if (!pconn || !service)
 310     return SASL_BADPARAM;
 311
 312   *pconn=sasl_ALLOC(sizeof(sasl_client_conn_t));
 313   if (*pconn==NULL) {
 314       _sasl_log(NULL, SASL_LOG_ERR,
 315                 "Out of memory allocating connection context");
 316       return SASL_NOMEM;
 317   }
 318   memset(*pconn, 0, sizeof(sasl_client_conn_t));
 319
 320   (*pconn)->destroy_conn = &client_dispose;
 321
 322   conn = (sasl_client_conn_t *)*pconn;
 323
 324   conn->mech = NULL;
 325
 326   conn->cparams=sasl_ALLOC(sizeof(sasl_client_params_t));
 327   if (conn->cparams==NULL)
 328       MEMERROR(*pconn);
 329   memset(conn->cparams,0,sizeof(sasl_client_params_t));
 330
 331   result = _sasl_conn_init(*pconn, service, flags, SASL_CONN_CLIENT,
 332                            &client_idle, serverFQDN,
 333                            iplocalport, ipremoteport,
 334                            prompt_supp, &global_callbacks_client);
 335   if (result != SASL_OK) RETURN(*pconn, result);
 336
 337   utils=_sasl_alloc_utils(*pconn, &global_callbacks_client);
 338   if (utils==NULL)
 339       MEMERROR(*pconn);
 340
 341   utils->conn= *pconn;
 342
 343   /* Setup the non-lazy parts of cparams, the rest is done in
 344    * sasl_client_start */
 345   conn->cparams->utils = utils;
 346   conn->cparams->canon_user = &_sasl_canon_user;
 347   conn->cparams->flags = flags;
 348   conn->cparams->prompt_supp = (*pconn)->callbacks;
 349
 350   /* get the clientFQDN (serverFQDN was set in _sasl_conn_init) */
 351   memset(name, 0, sizeof(name));
 352   gethostname(name, MAXHOSTNAMELEN);
 353
 354   result = _sasl_strdup(name, &conn->clientFQDN, NULL);
 355
 356   if(result == SASL_OK) return SASL_OK;
 357
 358   /* result isn't SASL_OK */
 359   _sasl_conn_dispose(*pconn);
 360   sasl_FREE(*pconn);
 361   *pconn = NULL;
 362   _sasl_log(NULL, SASL_LOG_ERR, "Out of memory in sasl_client_new");
 363   return result;
 364 }
 365
 366 static int have_prompts(sasl_conn_t *conn,
 367                         const sasl_client_plug_t *mech)
 368 {
 369   static const unsigned long default_prompts[] = {
 370     SASL_CB_AUTHNAME,
 371     SASL_CB_PASS,
 372     SASL_CB_LIST_END
 373   };
 374
 375   const unsigned long *prompt;
 376   int (*pproc)();
 377   void *pcontext;
 378   int result;
 379
 380   for (prompt = (mech->required_prompts
 381                  ? mech->required_prompts :
 382                  default_prompts);
 383        *prompt != SASL_CB_LIST_END;
 384        prompt++) {
 385     result = _sasl_getcallback(conn, *prompt, &pproc, &pcontext);
 386     if (result != SASL_OK && result != SASL_INTERACT)
 387       return 0;                 /* we don't have this required prompt */
 388   }
 389
 390   return 1; /* we have all the prompts */
 391 }
 392
 393 static int
 394 _mech_plus_p(const char *mech, size_t len)
 395 {
 396     return (len > 5 && strncasecmp(&mech[len - 5], "-PLUS", 5) == 0);
 397 }
 398
 399 /*
 400  * Order PLUS mechanisms first. Returns NUL separated list of
 401  * *count items.
 402  */
 403 static int
 404 _sasl_client_order_mechs(const sasl_utils_t *utils,
 405                          const char *mechs,
 406                          int has_cb_data,
 407                          char **ordered_mechs,
 408                          size_t *count,
 409                          int *server_can_cb)
 410 {
 411     char *list, *listp;
 412     size_t i, mechslen, start;
 413
 414     *count = 0;
 415     *server_can_cb = 0;
 416
 417     if (mechs == NULL || mechs[0] == '\0')
 418         return SASL_NOMECH;
 419
 420     mechslen = strlen(mechs);
 421
 422     listp = list = utils->malloc(mechslen + 1);
 423     if (list == NULL)
 424         return SASL_NOMEM;
 425
 426     /* xxx confirm this with rfc 2222
 427      * SASL mechanism allowable characters are "AZaz-_"
 428      * seperators can be any other characters and of any length
 429      * even variable lengths between
 430      *
 431      * Apps should be encouraged to simply use space or comma space
 432      * though
 433      */
 434 #define ismechchar(c)   (isalnum((c)) || (c) == '_' || (c) == '-')
 435     do {
 436         for (i = start = 0; i <= mechslen; i++) {
 437             if (!ismechchar(mechs[i])) {
 438                 const char *mechp = &mechs[start];
 439                 size_t len = i - start;
 440
 441                 if (len != 0 &&
 442                     _mech_plus_p(mechp, len) == has_cb_data) {
 443                     memcpy(listp, mechp, len);
 444                     listp[len] = '\0';
 445                     listp += len + 1;
 446                     (*count)++;
 447                     if (*server_can_cb == 0 && has_cb_data)
 448                         *server_can_cb = 1;
 449                 }
 450                 start = ++i;
 451             }
 452         }
 453         if (has_cb_data)
 454             has_cb_data = 0;
 455         else
 456             break;
 457     } while (1);
 458
 459     if (*count == 0) {
 460         utils->free(list);
 461         return SASL_NOMECH;
 462     }
 463
 464     *ordered_mechs = list;
 465
 466     return SASL_OK;
 467 }
 468
 469 static inline int
 470 _sasl_cbinding_disp(sasl_client_params_t *cparams,
 471                     int mech_nego,
 472                     int server_can_cb,
 473                     sasl_cbinding_disp_t *cbindingdisp)
 474 {
 475     /*
 476      * If negotiating mechanisms, then we fail immediately if the
 477      * client requires channel binding and the server does not
 478      * advertise support. Otherwise we send "y" (which later will
 479      * become "p" if we select a supporting mechanism).
 480      *
 481      * If the client explicitly selected a mechanism, then we only
 482      * send channel bindings if they're marked critical.
 483      */
 484
 485     *cbindingdisp = SASL_CB_DISP_NONE;
 486
 487     if (SASL_CB_PRESENT(cparams)) {
 488         if (mech_nego) {
 489             if (!server_can_cb && SASL_CB_CRITICAL(cparams))
 490                 return SASL_NOMECH;
 491             else
 492                 *cbindingdisp = SASL_CB_DISP_WANT;
 493         } else if (SASL_CB_CRITICAL(cparams)) {
 494             *cbindingdisp = SASL_CB_DISP_USED;
 495         }
 496     }
 497
 498     return SASL_OK;
 499 }
 500
 501 /* select a mechanism for a connection
 502  *  mechlist      -- mechanisms server has available (punctuation ignored)
 503  *  secret        -- optional secret from previous session
 504  * output:
 505  *  prompt_need   -- on SASL_INTERACT, list of prompts needed to continue
 506  *  clientout     -- the initial client response to send to the server
 507  *  mech          -- set to mechanism name
 508  *
 509  * Returns:
 510  *  SASL_OK       -- success
 511  *  SASL_NOMEM    -- not enough memory
 512  *  SASL_NOMECH   -- no mechanism meets requested properties
 513  *  SASL_INTERACT -- user interaction needed to fill in prompt_need list
 514  */
 515
 516 int sasl_client_start(sasl_conn_t *conn,
 517                       const char *mechlist,
 518                       sasl_interact_t **prompt_need,
 519                       const char **clientout,
 520                       unsigned *clientoutlen,
 521                       const char **mech)
 522 {
 523     sasl_client_conn_t *c_conn= (sasl_client_conn_t *) conn;
 524     char *ordered_mechs = NULL, *name;
 525     cmechanism_t *m=NULL,*bestm=NULL;
 526     size_t i, list_len;
 527     sasl_ssf_t bestssf = 0, minssf = 0;
 528     int result, server_can_cb = 0;
 529     sasl_cbinding_disp_t cbindingdisp;
 530
 531     if(_sasl_client_active==0) return SASL_NOTINIT;
 532
 533     if (!conn) return SASL_BADPARAM;
 534
 535     /* verify parameters */
 536     if (mechlist == NULL)
 537         PARAMERROR(conn);
 538
 539     /* if prompt_need != NULL we've already been here
 540        and just need to do the continue step again */
 541
 542     /* do a step */
 543     /* FIXME: Hopefully they only give us our own prompt_need back */
 544     if (prompt_need && *prompt_need != NULL) {
 545         goto dostep;
 546     }
 547
 548     if(conn->props.min_ssf < conn->external.ssf) {
 549         minssf = 0;
 550     } else {
 551         minssf = conn->props.min_ssf - conn->external.ssf;
 552     }
 553
 554     /* Order mechanisms so -PLUS are preferred */
 555     result = _sasl_client_order_mechs(c_conn->cparams->utils,
 556                                       mechlist,
 557                                       SASL_CB_PRESENT(c_conn->cparams),
 558                                       &ordered_mechs,
 559                                       &list_len,
 560                                       &server_can_cb);
 561     if (result != 0)
 562         goto done;
 563
 564     /*
 565      * Determine channel binding disposition based on whether we
 566      * are doing mechanism negotiation and whether server supports
 567      * channel bindings.
 568      */
 569     result = _sasl_cbinding_disp(c_conn->cparams, (list_len > 1),
 570                                  server_can_cb, &cbindingdisp);
 571     if (result != 0)
 572         goto done;
 573
 574     for (i = 0, name = ordered_mechs; i < list_len; i++) {
 575         /* foreach in client list */
 576         for (m = cmechlist->mech_list; m != NULL; m = m->next) {
 577             int myflags, plus;
 578
 579             if (!_sasl_is_equal_mech(name, m->m.plug->mech_name, &plus))
 580                 continue;
 581
 582             /* Do we have the prompts for it? */
 583             if (!have_prompts(conn, m->m.plug))
 584                 break;
 585
 586             /* Is it strong enough? */
 587             if (minssf > m->m.plug->max_ssf)
 588                 break;
 589
 590             /* Does it meet our security properties? */
 591             myflags = conn->props.security_flags;
 592
 593             /* if there's an external layer this is no longer plaintext */
 594             if ((conn->props.min_ssf <= conn->external.ssf) &&
 595                 (conn->external.ssf > 1)) {
 596                 myflags &= ~SASL_SEC_NOPLAINTEXT;
 597             }
 598
 599             if (((myflags ^ m->m.plug->security_flags) & myflags) != 0) {
 600                 break;
 601             }
 602
 603             /* Can we meet it's features? */
 604             if (cbindingdisp != SASL_CB_DISP_NONE &&
 605                 !(m->m.plug->features & SASL_FEAT_CHANNEL_BINDING)) {
 606                 break;
 607             }
 608
 609             if ((m->m.plug->features & SASL_FEAT_NEEDSERVERFQDN)
 610                 && !conn->serverFQDN) {
 611                 break;
 612             }
 613
 614             /* Can it meet our features? */
 615             if ((conn->flags & SASL_NEED_PROXY) &&
 616                 !(m->m.plug->features & SASL_FEAT_ALLOWS_PROXY)) {
 617                 break;
 618             }
 619
 620 #ifdef PREFER_MECH
 621             if (strcasecmp(m->m.plug->mech_name, PREFER_MECH) &&
 622                 bestm && m->m.plug->max_ssf <= bestssf) {
 623                 /* this mechanism isn't our favorite, and it's no better
 624                    than what we already have! */
 625                 break;
 626             }
 627 #else
 628             if (bestm && m->m.plug->max_ssf <= bestssf) {
 629                 /* this mechanism is no better than what we already have! */
 630                 break;
 631             }
 632 #endif
 633
 634             /* compare security flags, only take new mechanism if it has
 635              * all the security flags of the previous one.
 636              *
 637              * From the mechanisms we ship with, this yields the order:
 638              *
 639              * SRP
 640              * GSSAPI + KERBEROS_V4
 641              * DIGEST + OTP
 642              * CRAM + EXTERNAL
 643              * PLAIN + LOGIN + ANONYMOUS
 644              *
 645              * This might be improved on by comparing the numeric value of
 646              * the bitwise-or'd security flags, which splits DIGEST/OTP,
 647              * CRAM/EXTERNAL, and PLAIN/LOGIN from ANONYMOUS, but then we
 648              * are depending on the numeric values of the flags (which may
 649              * change, and their ordering could be considered dumb luck.
 650              */
 651
 652             if (bestm &&
 653                 ((m->m.plug->security_flags ^ bestm->m.plug->security_flags) &
 654                  bestm->m.plug->security_flags)) {
 655                 break;
 656             }
 657
 658             if (SASL_CB_PRESENT(c_conn->cparams) && plus) {
 659                 cbindingdisp = SASL_CB_DISP_USED;
 660             }
 661
 662             if (mech) {
 663                 *mech = m->m.plug->mech_name;
 664             }
 665             bestssf = m->m.plug->max_ssf;
 666             bestm = m;
 667             break;
 668         }
 669         name += strlen(name) + 1;
 670     }
 671
 672     if (bestm == NULL) {
 673         sasl_seterror(conn, 0, "No worthy mechs found");
 674         result = SASL_NOMECH;
 675         goto done;
 676     }
 677
 678     /* make (the rest of) cparams */
 679     c_conn->cparams->service = conn->service;
 680     c_conn->cparams->servicelen = (unsigned) strlen(conn->service);
 681
 682     if (conn->serverFQDN) {
 683         c_conn->cparams->serverFQDN = conn->serverFQDN;
 684         c_conn->cparams->slen = (unsigned) strlen(conn->serverFQDN);
 685     }
 686
 687     c_conn->cparams->clientFQDN = c_conn->clientFQDN;
 688     c_conn->cparams->clen = (unsigned) strlen(c_conn->clientFQDN);
 689
 690     c_conn->cparams->external_ssf = conn->external.ssf;
 691     c_conn->cparams->props = conn->props;
 692     c_conn->cparams->cbindingdisp = cbindingdisp;
 693     c_conn->mech = bestm;
 694
 695     /* init that plugin */
 696     result = c_conn->mech->m.plug->mech_new(c_conn->mech->m.plug->glob_context,
 697                                           c_conn->cparams,
 698                                           &(conn->context));
 699     if(result != SASL_OK) goto done;
 700
 701     /* do a step -- but only if we can do a client-send-first */
 702  dostep:
 703     if(clientout) {
 704         if(c_conn->mech->m.plug->features & SASL_FEAT_SERVER_FIRST) {
 705             *clientout = NULL;
 706             *clientoutlen = 0;
 707             result = SASL_CONTINUE;
 708         } else {
 709             result = sasl_client_step(conn, NULL, 0, prompt_need,
 710                                       clientout, clientoutlen);
 711         }
 712     }
 713     else
 714         result = SASL_CONTINUE;
 715
 716  done:
 717     if (ordered_mechs != NULL)
 718         c_conn->cparams->utils->free(ordered_mechs);
 719     RETURN(conn, result);
 720 }
 721
 722 /* do a single authentication step.
 723  *  serverin    -- the server message received by the client, MUST have a NUL
 724  *                 sentinel, not counted by serverinlen
 725  * output:
 726  *  prompt_need -- on SASL_INTERACT, list of prompts needed to continue
 727  *  clientout   -- the client response to send to the server
 728  *
 729  * returns:
 730  *  SASL_OK        -- success
 731  *  SASL_INTERACT  -- user interaction needed to fill in prompt_need list
 732  *  SASL_BADPROT   -- server protocol incorrect/cancelled
 733  *  SASL_BADSERV   -- server failed mutual auth
 734  */
 735
 736 int sasl_client_step(sasl_conn_t *conn,
 737                      const char *serverin,
 738                      unsigned serverinlen,
 739                      sasl_interact_t **prompt_need,
 740                      const char **clientout,
 741                      unsigned *clientoutlen)
 742 {
 743   sasl_client_conn_t *c_conn= (sasl_client_conn_t *) conn;
 744   int result;
 745
 746   if(_sasl_client_active==0) return SASL_NOTINIT;
 747   if(!conn) return SASL_BADPARAM;
 748
 749   /* check parameters */
 750   if ((serverin==NULL) && (serverinlen>0))
 751       PARAMERROR(conn);
 752
 753   /* Don't do another step if the plugin told us that we're done */
 754   if (conn->oparams.doneflag) {
 755       _sasl_log(conn, SASL_LOG_ERR, "attempting client step after doneflag");
 756       return SASL_FAIL;
 757   }
 758
 759   if(clientout) *clientout = NULL;
 760   if(clientoutlen) *clientoutlen = 0;
 761
 762   /* do a step */
 763   result = c_conn->mech->m.plug->mech_step(conn->context,
 764                                          c_conn->cparams,
 765                                          serverin,
 766                                          serverinlen,
 767                                          prompt_need,
 768                                          clientout, clientoutlen,
 769                                          &conn->oparams);
 770
 771   if (result == SASL_OK) {
 772       /* So we're done on this end, but if both
 773        * 1. the mech does server-send-last
 774        * 2. the protocol does not
 775        * we need to return no data */
 776       if(!*clientout && !(conn->flags & SASL_SUCCESS_DATA)) {
 777           *clientout = "";
 778           *clientoutlen = 0;
 779       }
 780
 781       if(!conn->oparams.maxoutbuf) {
 782           conn->oparams.maxoutbuf = conn->props.maxbufsize;
 783       }
 784
 785       if(conn->oparams.user == NULL || conn->oparams.authid == NULL) {
 786           sasl_seterror(conn, 0,
 787                         "mech did not call canon_user for both authzid and authid");
 788           result = SASL_BADPROT;
 789       }
 790   }
 791
 792   RETURN(conn,result);
 793 }
 794
 795 /* returns the length of all the mechanisms
 796  * added up
 797  */
 798
 799 static unsigned mech_names_len()
 800 {
 801   cmechanism_t *listptr;
 802   unsigned result = 0;
 803
 804   for (listptr = cmechlist->mech_list;
 805        listptr;
 806        listptr = listptr->next)
 807     result += (unsigned) strlen(listptr->m.plug->mech_name);
 808
 809   return result;
 810 }
 811
 812
 813 int _sasl_client_listmech(sasl_conn_t *conn,
 814                           const char *prefix,
 815                           const char *sep,
 816                           const char *suffix,
 817                           const char **result,
 818                           unsigned *plen,
 819                           int *pcount)
 820 {
 821     cmechanism_t *m=NULL;
 822     sasl_ssf_t minssf = 0;
 823     int ret;
 824     size_t resultlen;
 825     int flag;
 826     const char *mysep;
 827
 828     if(_sasl_client_active == 0) return SASL_NOTINIT;
 829     if (!conn) return SASL_BADPARAM;
 830     if(conn->type != SASL_CONN_CLIENT) PARAMERROR(conn);
 831
 832     if (! result)
 833         PARAMERROR(conn);
 834
 835     if (plen != NULL)
 836         *plen = 0;
 837     if (pcount != NULL)
 838         *pcount = 0;
 839
 840     if (sep) {
 841         mysep = sep;
 842     } else {
 843         mysep = " ";
 844     }
 845
 846     if(conn->props.min_ssf < conn->external.ssf) {
 847         minssf = 0;
 848     } else {
 849         minssf = conn->props.min_ssf - conn->external.ssf;
 850     }
 851
 852     if (! cmechlist || cmechlist->mech_length <= 0)
 853         INTERROR(conn, SASL_NOMECH);
 854
 855     resultlen = (prefix ? strlen(prefix) : 0)
 856         + (strlen(mysep) * (cmechlist->mech_length - 1))
 857         + mech_names_len()
 858         + (suffix ? strlen(suffix) : 0)
 859         + 1;
 860     ret = _buf_alloc(&conn->mechlist_buf,
 861                      &conn->mechlist_buf_len, resultlen);
 862     if(ret != SASL_OK) MEMERROR(conn);
 863
 864     if (prefix)
 865         strcpy (conn->mechlist_buf,prefix);
 866     else
 867         *(conn->mechlist_buf) = '\0';
 868
 869     flag = 0;
 870     for (m = cmechlist->mech_list; m != NULL; m = m->next) {
 871             /* do we have the prompts for it? */
 872             if (!have_prompts(conn, m->m.plug))
 873                 continue;
 874
 875             /* is it strong enough? */
 876             if (minssf > m->m.plug->max_ssf)
 877                 continue;
 878
 879             /* does it meet our security properties? */
 880             if (((conn->props.security_flags ^ m->m.plug->security_flags)
 881                  & conn->props.security_flags) != 0) {
 882                 continue;
 883             }
 884
 885             /* Can we meet it's features? */
 886             if ((m->m.plug->features & SASL_FEAT_NEEDSERVERFQDN)
 887                 && !conn->serverFQDN) {
 888                 continue;
 889             }
 890
 891             /* Can it meet our features? */
 892             if ((conn->flags & SASL_NEED_PROXY) &&
 893                 !(m->m.plug->features & SASL_FEAT_ALLOWS_PROXY)) {
 894                 continue;
 895             }
 896
 897             /* Okay, we like it, add it to the list! */
 898
 899             if (pcount != NULL)
 900                 (*pcount)++;
 901
 902             /* print seperator */
 903             if (flag) {
 904                 strcat(conn->mechlist_buf, mysep);
 905             } else {
 906                 flag = 1;
 907             }
 908
 909             /* now print the mechanism name */
 910             strcat(conn->mechlist_buf, m->m.plug->mech_name);
 911     }
 912
 913   if (suffix)
 914       strcat(conn->mechlist_buf,suffix);
 915
 916   if (plen!=NULL)
 917       *plen = (unsigned) strlen(conn->mechlist_buf);
 918
 919   *result = conn->mechlist_buf;
 920
 921   return SASL_OK;
 922 }
 923
 924 sasl_string_list_t *_sasl_client_mechs(void)
 925 {
 926   cmechanism_t *listptr;
 927   sasl_string_list_t *retval = NULL, *next=NULL;
 928
 929   if(!_sasl_client_active) return NULL;
 930
 931   /* make list */
 932   for (listptr = cmechlist->mech_list; listptr; listptr = listptr->next) {
 933       next = sasl_ALLOC(sizeof(sasl_string_list_t));
 934
 935       if(!next && !retval) return NULL;
 936       else if(!next) {
 937           next = retval->next;
 938           do {
 939               sasl_FREE(retval);
 940               retval = next;
 941               next = retval->next;
 942           } while(next);
 943           return NULL;
 944       }
 945
 946       next->d = listptr->m.plug->mech_name;
 947
 948       if(!retval) {
 949           next->next = NULL;
 950           retval = next;
 951       } else {
 952           next->next = retval;
 953           retval = next;
 954       }
 955   }
 956
 957   return retval;
 958 }
 959
 960
 961
 962
 963 /* It would be nice if we can show other information like Author, Company, Year, plugin version */
 964 static void
 965 _sasl_print_mechanism (
 966   client_sasl_mechanism_t *m,
 967   sasl_info_callback_stage_t stage,
 968   void *rock
 969 )
 970 {
 971     char delimiter;
 972
 973     if (stage == SASL_INFO_LIST_START) {
 974         printf ("List of client plugins follows\n");
 975         return;
 976     } else if (stage == SASL_INFO_LIST_END) {
 977         return;
 978     }
 979
 980     /* Process the mechanism */
 981     printf ("Plugin \"%s\" ", m->plugname);
 982
 983     /* There is no delay loading for client side plugins */
 984     printf ("[loaded]");
 985
 986     printf (", \tAPI version: %d\n", m->version);
 987
 988     if (m->plug != NULL) {
 989         printf ("\tSASL mechanism: %s, best SSF: %d\n",
 990                 m->plug->mech_name,
 991                 m->plug->max_ssf);
 992
 993         printf ("\tsecurity flags:");
 994
 995         delimiter = ' ';
 996         if (m->plug->security_flags & SASL_SEC_NOANONYMOUS) {
 997             printf ("%cNO_ANONYMOUS", delimiter);
 998             delimiter = '|';
 999         }
1000
1001         if (m->plug->security_flags & SASL_SEC_NOPLAINTEXT) {
1002             printf ("%cNO_PLAINTEXT", delimiter);
1003             delimiter = '|';
1004         }
1005
1006         if (m->plug->security_flags & SASL_SEC_NOACTIVE) {
1007             printf ("%cNO_ACTIVE", delimiter);
1008             delimiter = '|';
1009         }
1010
1011         if (m->plug->security_flags & SASL_SEC_NODICTIONARY) {
1012             printf ("%cNO_DICTIONARY", delimiter);
1013             delimiter = '|';
1014         }
1015
1016         if (m->plug->security_flags & SASL_SEC_FORWARD_SECRECY) {
1017             printf ("%cFORWARD_SECRECY", delimiter);
1018             delimiter = '|';
1019         }
1020
1021         if (m->plug->security_flags & SASL_SEC_PASS_CREDENTIALS) {
1022             printf ("%cPASS_CREDENTIALS", delimiter);
1023             delimiter = '|';
1024         }
1025
1026         if (m->plug->security_flags & SASL_SEC_MUTUAL_AUTH) {
1027             printf ("%cMUTUAL_AUTH", delimiter);
1028             delimiter = '|';
1029         }
1030
1031
1032
1033         printf ("\n\tfeatures:");
1034
1035         delimiter = ' ';
1036         if (m->plug->features & SASL_FEAT_WANT_CLIENT_FIRST) {
1037             printf ("%cWANT_CLIENT_FIRST", delimiter);
1038             delimiter = '|';
1039         }
1040
1041         if (m->plug->features & SASL_FEAT_SERVER_FIRST) {
1042             printf ("%cSERVER_FIRST", delimiter);
1043             delimiter = '|';
1044         }
1045
1046         if (m->plug->features & SASL_FEAT_ALLOWS_PROXY) {
1047             printf ("%cPROXY_AUTHENTICATION", delimiter);
1048             delimiter = '|';
1049         }
1050
1051         if (m->plug->features & SASL_FEAT_NEEDSERVERFQDN) {
1052             printf ("%cNEED_SERVER_FQDN", delimiter);
1053             delimiter = '|';
1054         }
1055
1056         if (m->plug->features & SASL_FEAT_GSS_FRAMING) {
1057             printf ("%cGSS_FRAMING", delimiter);
1058             delimiter = '|';
1059         }
1060
1061         if (m->plug->features & SASL_FEAT_CHANNEL_BINDING) {
1062             printf ("%cCHANNEL_BINDING", delimiter);
1063             delimiter = '|';
1064         }
1065     }
1066
1067 /* Delay loading is not supported for the client side plugins:
1068     if (m->f) {
1069         printf ("\n\twill be loaded from \"%s\"", m->f);
1070     }
1071  */
1072
1073     printf ("\n");
1074 }
1075
1076
1077 /* Dump information about available client plugins */
1078 int sasl_client_plugin_info (
1079   const char *c_mech_list,              /* space separated mechanism list or NULL for ALL */
1080   sasl_client_info_callback_t *info_cb,
1081   void *info_cb_rock
1082 )
1083 {
1084     cmechanism_t *m;
1085     client_sasl_mechanism_t plug_data;
1086     char * cur_mech;
1087     char * mech_list = NULL;
1088     char * p;
1089
1090     if (info_cb == NULL) {
1091         info_cb = _sasl_print_mechanism;
1092     }
1093
1094     if (cmechlist != NULL) {
1095         info_cb (NULL, SASL_INFO_LIST_START, info_cb_rock);
1096
1097         if (c_mech_list == NULL) {
1098             m = cmechlist->mech_list; /* m point to beginning of the list */
1099
1100             while (m != NULL) {
1101                 memcpy (&plug_data, &m->m, sizeof(plug_data));
1102
1103                 info_cb (&plug_data, SASL_INFO_LIST_MECH, info_cb_rock);
1104
1105                 m = m->next;
1106             }
1107         } else {
1108             mech_list = strdup (c_mech_list);
1109
1110             cur_mech = mech_list;
1111
1112             while (cur_mech != NULL) {
1113                 p = strchr (cur_mech, ' ');
1114                 if (p != NULL) {
1115                     *p = '\0';
1116                     p++;
1117                 }
1118
1119                 m = cmechlist->mech_list; /* m point to beginning of the list */
1120
1121                 while (m != NULL) {
1122                     if (strcasecmp (cur_mech, m->m.plug->mech_name) == 0) {
1123                         memcpy (&plug_data, &m->m, sizeof(plug_data));
1124
1125                         info_cb (&plug_data, SASL_INFO_LIST_MECH, info_cb_rock);
1126                     }
1127
1128                     m = m->next;
1129                 }
1130
1131                 cur_mech = p;
1132             }
1133
1134             free (mech_list);
1135         }
1136
1137         info_cb (NULL, SASL_INFO_LIST_END, info_cb_rock);
1138
1139         return (SASL_OK);
1140     }
1141
1142     return (SASL_NOTINIT);
1143 }