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     *ordered_mechs = list;
 460
 461     return SASL_OK;
 462 }
 463
 464 /* select a mechanism for a connection
 465  *  mechlist      -- mechanisms server has available (punctuation ignored)
 466  *  secret        -- optional secret from previous session
 467  * output:
 468  *  prompt_need   -- on SASL_INTERACT, list of prompts needed to continue
 469  *  clientout     -- the initial client response to send to the server
 470  *  mech          -- set to mechanism name
 471  *
 472  * Returns:
 473  *  SASL_OK       -- success
 474  *  SASL_NOMEM    -- not enough memory
 475  *  SASL_NOMECH   -- no mechanism meets requested properties
 476  *  SASL_INTERACT -- user interaction needed to fill in prompt_need list
 477  */
 478
 479 int sasl_client_start(sasl_conn_t *conn,
 480                       const char *mechlist,
 481                       sasl_interact_t **prompt_need,
 482                       const char **clientout,
 483                       unsigned *clientoutlen,
 484                       const char **mech)
 485 {
 486     sasl_client_conn_t *c_conn= (sasl_client_conn_t *) conn;
 487     char *ordered_mechs = NULL, *name;
 488     cmechanism_t *m=NULL,*bestm=NULL;
 489     size_t i, list_len;
 490     sasl_ssf_t bestssf = 0, minssf = 0;
 491     int result, server_can_cb = 0;
 492     unsigned int cbindingdisp;
 493
 494     if(_sasl_client_active==0) return SASL_NOTINIT;
 495
 496     if (!conn) return SASL_BADPARAM;
 497
 498     /* verify parameters */
 499     if (mechlist == NULL)
 500         PARAMERROR(conn);
 501
 502     /* if prompt_need != NULL we've already been here
 503        and just need to do the continue step again */
 504
 505     /* do a step */
 506     /* FIXME: Hopefully they only give us our own prompt_need back */
 507     if (prompt_need && *prompt_need != NULL) {
 508         goto dostep;
 509     }
 510
 511     if(conn->props.min_ssf < conn->external.ssf) {
 512         minssf = 0;
 513     } else {
 514         minssf = conn->props.min_ssf - conn->external.ssf;
 515     }
 516
 517     result = _sasl_client_order_mechs(c_conn->cparams->utils,
 518                                       mechlist,
 519                                       SASL_CB_PRESENT(c_conn->cparams),
 520                                       &ordered_mechs,
 521                                       &list_len,
 522                                       &server_can_cb);
 523     if (result != 0)
 524         goto done;
 525
 526     if (SASL_CB_PRESENT(c_conn->cparams)) {
 527         if (server_can_cb == 0 && SASL_CB_CRITICAL(c_conn->cparams)) {
 528             result = SASL_BADBINDING;
 529             goto done;
 530         } else {
 531             cbindingdisp = SASL_CB_DISP_WANT;
 532         }
 533     } else {
 534         cbindingdisp = SASL_CB_DISP_NONE;
 535     }
 536
 537     for (i = 0, name = ordered_mechs; i < list_len; i++) {
 538         /* foreach in client list */
 539         for (m = cmechlist->mech_list; m != NULL; m = m->next) {
 540             int myflags, plus;
 541
 542             if (!_sasl_is_equal_mech(name, m->m.plug->mech_name, &plus))
 543                 continue;
 544
 545             /* Do we have the prompts for it? */
 546             if (!have_prompts(conn, m->m.plug))
 547                 break;
 548
 549             /* Is it strong enough? */
 550             if (minssf > m->m.plug->max_ssf)
 551                 break;
 552
 553             /* Does it meet our security properties? */
 554             myflags = conn->props.security_flags;
 555
 556             /* if there's an external layer this is no longer plaintext */
 557             if ((conn->props.min_ssf <= conn->external.ssf) &&
 558                 (conn->external.ssf > 1)) {
 559                 myflags &= ~SASL_SEC_NOPLAINTEXT;
 560             }
 561
 562             if (((myflags ^ m->m.plug->security_flags) & myflags) != 0) {
 563                 break;
 564             }
 565
 566             /* Can we meet it's features? */
 567            if (SASL_CB_PRESENT(c_conn->cparams) &&
 568                 !(m->m.plug->features & SASL_FEAT_CHANNEL_BINDING)) {
 569                 break;
 570             }
 571
 572             if ((m->m.plug->features & SASL_FEAT_NEEDSERVERFQDN)
 573                 && !conn->serverFQDN) {
 574                 break;
 575             }
 576
 577             /* Can it meet our features? */
 578             if ((conn->flags & SASL_NEED_PROXY) &&
 579                 !(m->m.plug->features & SASL_FEAT_ALLOWS_PROXY)) {
 580                 break;
 581             }
 582
 583 #ifdef PREFER_MECH
 584             if (strcasecmp(m->m.plug->mech_name, PREFER_MECH) &&
 585                 bestm && m->m.plug->max_ssf <= bestssf) {
 586                 /* this mechanism isn't our favorite, and it's no better
 587                    than what we already have! */
 588                 break;
 589             }
 590 #else
 591             if (bestm && m->m.plug->max_ssf <= bestssf) {
 592                 /* this mechanism is no better than what we already have! */
 593                 break;
 594             }
 595 #endif
 596
 597             /* compare security flags, only take new mechanism if it has
 598              * all the security flags of the previous one.
 599              *
 600              * From the mechanisms we ship with, this yields the order:
 601              *
 602              * SRP
 603              * GSSAPI + KERBEROS_V4
 604              * DIGEST + OTP
 605              * CRAM + EXTERNAL
 606              * PLAIN + LOGIN + ANONYMOUS
 607              *
 608              * This might be improved on by comparing the numeric value of
 609              * the bitwise-or'd security flags, which splits DIGEST/OTP,
 610              * CRAM/EXTERNAL, and PLAIN/LOGIN from ANONYMOUS, but then we
 611              * are depending on the numeric values of the flags (which may
 612              * change, and their ordering could be considered dumb luck.
 613              */
 614
 615             if (bestm &&
 616                 ((m->m.plug->security_flags ^ bestm->m.plug->security_flags) &
 617                  bestm->m.plug->security_flags)) {
 618                 break;
 619             }
 620
 621             /* Prefer server advertised CB mechanisms */
 622             if (SASL_CB_PRESENT(c_conn->cparams) && plus) {
 623                 cbindingdisp = SASL_CB_DISP_USED;
 624             }
 625
 626             if (mech) {
 627                 *mech = m->m.plug->mech_name;
 628             }
 629             bestssf = m->m.plug->max_ssf;
 630             bestm = m;
 631             break;
 632         }
 633         name += strlen(name) + 1;
 634     }
 635
 636     if (bestm == NULL) {
 637         sasl_seterror(conn, 0, "No worthy mechs found");
 638         result = SASL_NOMECH;
 639         goto done;
 640     }
 641
 642     /* make (the rest of) cparams */
 643     c_conn->cparams->service = conn->service;
 644     c_conn->cparams->servicelen = (unsigned) strlen(conn->service);
 645
 646     if (conn->serverFQDN) {
 647         c_conn->cparams->serverFQDN = conn->serverFQDN;
 648         c_conn->cparams->slen = (unsigned) strlen(conn->serverFQDN);
 649     }
 650
 651     c_conn->cparams->clientFQDN = c_conn->clientFQDN;
 652     c_conn->cparams->clen = (unsigned) strlen(c_conn->clientFQDN);
 653
 654     c_conn->cparams->external_ssf = conn->external.ssf;
 655     c_conn->cparams->props = conn->props;
 656     c_conn->cparams->cbindingdisp = cbindingdisp;
 657     c_conn->mech = bestm;
 658
 659     /* init that plugin */
 660     result = c_conn->mech->m.plug->mech_new(c_conn->mech->m.plug->glob_context,
 661                                           c_conn->cparams,
 662                                           &(conn->context));
 663     if(result != SASL_OK) goto done;
 664
 665     /* do a step -- but only if we can do a client-send-first */
 666  dostep:
 667     if(clientout) {
 668         if(c_conn->mech->m.plug->features & SASL_FEAT_SERVER_FIRST) {
 669             *clientout = NULL;
 670             *clientoutlen = 0;
 671             result = SASL_CONTINUE;
 672         } else {
 673             result = sasl_client_step(conn, NULL, 0, prompt_need,
 674                                       clientout, clientoutlen);
 675         }
 676     }
 677     else
 678         result = SASL_CONTINUE;
 679
 680  done:
 681     if (ordered_mechs != NULL)
 682         c_conn->cparams->utils->free(ordered_mechs);
 683     RETURN(conn, result);
 684 }
 685
 686 /* do a single authentication step.
 687  *  serverin    -- the server message received by the client, MUST have a NUL
 688  *                 sentinel, not counted by serverinlen
 689  * output:
 690  *  prompt_need -- on SASL_INTERACT, list of prompts needed to continue
 691  *  clientout   -- the client response to send to the server
 692  *
 693  * returns:
 694  *  SASL_OK        -- success
 695  *  SASL_INTERACT  -- user interaction needed to fill in prompt_need list
 696  *  SASL_BADPROT   -- server protocol incorrect/cancelled
 697  *  SASL_BADSERV   -- server failed mutual auth
 698  */
 699
 700 int sasl_client_step(sasl_conn_t *conn,
 701                      const char *serverin,
 702                      unsigned serverinlen,
 703                      sasl_interact_t **prompt_need,
 704                      const char **clientout,
 705                      unsigned *clientoutlen)
 706 {
 707   sasl_client_conn_t *c_conn= (sasl_client_conn_t *) conn;
 708   int result;
 709
 710   if(_sasl_client_active==0) return SASL_NOTINIT;
 711   if(!conn) return SASL_BADPARAM;
 712
 713   /* check parameters */
 714   if ((serverin==NULL) && (serverinlen>0))
 715       PARAMERROR(conn);
 716
 717   /* Don't do another step if the plugin told us that we're done */
 718   if (conn->oparams.doneflag) {
 719       _sasl_log(conn, SASL_LOG_ERR, "attempting client step after doneflag");
 720       return SASL_FAIL;
 721   }
 722
 723   if(clientout) *clientout = NULL;
 724   if(clientoutlen) *clientoutlen = 0;
 725
 726   /* do a step */
 727   result = c_conn->mech->m.plug->mech_step(conn->context,
 728                                          c_conn->cparams,
 729                                          serverin,
 730                                          serverinlen,
 731                                          prompt_need,
 732                                          clientout, clientoutlen,
 733                                          &conn->oparams);
 734
 735   if (result == SASL_OK) {
 736       /* So we're done on this end, but if both
 737        * 1. the mech does server-send-last
 738        * 2. the protocol does not
 739        * we need to return no data */
 740       if(!*clientout && !(conn->flags & SASL_SUCCESS_DATA)) {
 741           *clientout = "";
 742           *clientoutlen = 0;
 743       }
 744
 745       if(!conn->oparams.maxoutbuf) {
 746           conn->oparams.maxoutbuf = conn->props.maxbufsize;
 747       }
 748
 749       if(conn->oparams.user == NULL || conn->oparams.authid == NULL) {
 750           sasl_seterror(conn, 0,
 751                         "mech did not call canon_user for both authzid and authid");
 752           result = SASL_BADPROT;
 753       }
 754   }
 755
 756   RETURN(conn,result);
 757 }
 758
 759 /* returns the length of all the mechanisms
 760  * added up
 761  */
 762
 763 static unsigned mech_names_len()
 764 {
 765   cmechanism_t *listptr;
 766   unsigned result = 0;
 767
 768   for (listptr = cmechlist->mech_list;
 769        listptr;
 770        listptr = listptr->next)
 771     result += (unsigned) strlen(listptr->m.plug->mech_name);
 772
 773   return result;
 774 }
 775
 776
 777 int _sasl_client_listmech(sasl_conn_t *conn,
 778                           const char *prefix,
 779                           const char *sep,
 780                           const char *suffix,
 781                           const char **result,
 782                           unsigned *plen,
 783                           int *pcount)
 784 {
 785     cmechanism_t *m=NULL;
 786     sasl_ssf_t minssf = 0;
 787     int ret;
 788     size_t resultlen;
 789     int flag;
 790     const char *mysep;
 791
 792     if(_sasl_client_active == 0) return SASL_NOTINIT;
 793     if (!conn) return SASL_BADPARAM;
 794     if(conn->type != SASL_CONN_CLIENT) PARAMERROR(conn);
 795
 796     if (! result)
 797         PARAMERROR(conn);
 798
 799     if (plen != NULL)
 800         *plen = 0;
 801     if (pcount != NULL)
 802         *pcount = 0;
 803
 804     if (sep) {
 805         mysep = sep;
 806     } else {
 807         mysep = " ";
 808     }
 809
 810     if(conn->props.min_ssf < conn->external.ssf) {
 811         minssf = 0;
 812     } else {
 813         minssf = conn->props.min_ssf - conn->external.ssf;
 814     }
 815
 816     if (! cmechlist || cmechlist->mech_length <= 0)
 817         INTERROR(conn, SASL_NOMECH);
 818
 819     resultlen = (prefix ? strlen(prefix) : 0)
 820         + (strlen(mysep) * (cmechlist->mech_length - 1))
 821         + mech_names_len()
 822         + (suffix ? strlen(suffix) : 0)
 823         + 1;
 824     ret = _buf_alloc(&conn->mechlist_buf,
 825                      &conn->mechlist_buf_len, resultlen);
 826     if(ret != SASL_OK) MEMERROR(conn);
 827
 828     if (prefix)
 829         strcpy (conn->mechlist_buf,prefix);
 830     else
 831         *(conn->mechlist_buf) = '\0';
 832
 833     flag = 0;
 834     for (m = cmechlist->mech_list; m != NULL; m = m->next) {
 835             /* do we have the prompts for it? */
 836             if (!have_prompts(conn, m->m.plug))
 837                 continue;
 838
 839             /* is it strong enough? */
 840             if (minssf > m->m.plug->max_ssf)
 841                 continue;
 842
 843             /* does it meet our security properties? */
 844             if (((conn->props.security_flags ^ m->m.plug->security_flags)
 845                  & conn->props.security_flags) != 0) {
 846                 continue;
 847             }
 848
 849             /* Can we meet it's features? */
 850             if ((m->m.plug->features & SASL_FEAT_NEEDSERVERFQDN)
 851                 && !conn->serverFQDN) {
 852                 continue;
 853             }
 854
 855             /* Can it meet our features? */
 856             if ((conn->flags & SASL_NEED_PROXY) &&
 857                 !(m->m.plug->features & SASL_FEAT_ALLOWS_PROXY)) {
 858                 continue;
 859             }
 860
 861             /* Okay, we like it, add it to the list! */
 862
 863             if (pcount != NULL)
 864                 (*pcount)++;
 865
 866             /* print seperator */
 867             if (flag) {
 868                 strcat(conn->mechlist_buf, mysep);
 869             } else {
 870                 flag = 1;
 871             }
 872
 873             /* now print the mechanism name */
 874             strcat(conn->mechlist_buf, m->m.plug->mech_name);
 875     }
 876
 877   if (suffix)
 878       strcat(conn->mechlist_buf,suffix);
 879
 880   if (plen!=NULL)
 881       *plen = (unsigned) strlen(conn->mechlist_buf);
 882
 883   *result = conn->mechlist_buf;
 884
 885   return SASL_OK;
 886 }
 887
 888 sasl_string_list_t *_sasl_client_mechs(void)
 889 {
 890   cmechanism_t *listptr;
 891   sasl_string_list_t *retval = NULL, *next=NULL;
 892
 893   if(!_sasl_client_active) return NULL;
 894
 895   /* make list */
 896   for (listptr = cmechlist->mech_list; listptr; listptr = listptr->next) {
 897       next = sasl_ALLOC(sizeof(sasl_string_list_t));
 898
 899       if(!next && !retval) return NULL;
 900       else if(!next) {
 901           next = retval->next;
 902           do {
 903               sasl_FREE(retval);
 904               retval = next;
 905               next = retval->next;
 906           } while(next);
 907           return NULL;
 908       }
 909
 910       next->d = listptr->m.plug->mech_name;
 911
 912       if(!retval) {
 913           next->next = NULL;
 914           retval = next;
 915       } else {
 916           next->next = retval;
 917           retval = next;
 918       }
 919   }
 920
 921   return retval;
 922 }
 923
 924
 925
 926
 927 /* It would be nice if we can show other information like Author, Company, Year, plugin version */
 928 static void
 929 _sasl_print_mechanism (
 930   client_sasl_mechanism_t *m,
 931   sasl_info_callback_stage_t stage,
 932   void *rock
 933 )
 934 {
 935     char delimiter;
 936
 937     if (stage == SASL_INFO_LIST_START) {
 938         printf ("List of client plugins follows\n");
 939         return;
 940     } else if (stage == SASL_INFO_LIST_END) {
 941         return;
 942     }
 943
 944     /* Process the mechanism */
 945     printf ("Plugin \"%s\" ", m->plugname);
 946
 947     /* There is no delay loading for client side plugins */
 948     printf ("[loaded]");
 949
 950     printf (", \tAPI version: %d\n", m->version);
 951
 952     if (m->plug != NULL) {
 953         printf ("\tSASL mechanism: %s, best SSF: %d\n",
 954                 m->plug->mech_name,
 955                 m->plug->max_ssf);
 956
 957         printf ("\tsecurity flags:");
 958
 959         delimiter = ' ';
 960         if (m->plug->security_flags & SASL_SEC_NOANONYMOUS) {
 961             printf ("%cNO_ANONYMOUS", delimiter);
 962             delimiter = '|';
 963         }
 964
 965         if (m->plug->security_flags & SASL_SEC_NOPLAINTEXT) {
 966             printf ("%cNO_PLAINTEXT", delimiter);
 967             delimiter = '|';
 968         }
 969
 970         if (m->plug->security_flags & SASL_SEC_NOACTIVE) {
 971             printf ("%cNO_ACTIVE", delimiter);
 972             delimiter = '|';
 973         }
 974
 975         if (m->plug->security_flags & SASL_SEC_NODICTIONARY) {
 976             printf ("%cNO_DICTIONARY", delimiter);
 977             delimiter = '|';
 978         }
 979
 980         if (m->plug->security_flags & SASL_SEC_FORWARD_SECRECY) {
 981             printf ("%cFORWARD_SECRECY", delimiter);
 982             delimiter = '|';
 983         }
 984
 985         if (m->plug->security_flags & SASL_SEC_PASS_CREDENTIALS) {
 986             printf ("%cPASS_CREDENTIALS", delimiter);
 987             delimiter = '|';
 988         }
 989
 990         if (m->plug->security_flags & SASL_SEC_MUTUAL_AUTH) {
 991             printf ("%cMUTUAL_AUTH", delimiter);
 992             delimiter = '|';
 993         }
 994
 995
 996
 997         printf ("\n\tfeatures:");
 998
 999         delimiter = ' ';
1000         if (m->plug->features & SASL_FEAT_WANT_CLIENT_FIRST) {
1001             printf ("%cWANT_CLIENT_FIRST", delimiter);
1002             delimiter = '|';
1003         }
1004
1005         if (m->plug->features & SASL_FEAT_SERVER_FIRST) {
1006             printf ("%cSERVER_FIRST", delimiter);
1007             delimiter = '|';
1008         }
1009
1010         if (m->plug->features & SASL_FEAT_ALLOWS_PROXY) {
1011             printf ("%cPROXY_AUTHENTICATION", delimiter);
1012             delimiter = '|';
1013         }
1014
1015         if (m->plug->features & SASL_FEAT_NEEDSERVERFQDN) {
1016             printf ("%cNEED_SERVER_FQDN", delimiter);
1017             delimiter = '|';
1018         }
1019
1020         if (m->plug->features & SASL_FEAT_GSS_FRAMING) {
1021             printf ("%cGSS_FRAMING", delimiter);
1022             delimiter = '|';
1023         }
1024
1025         if (m->plug->features & SASL_FEAT_CHANNEL_BINDING) {
1026             printf ("%cCHANNEL_BINDING", delimiter);
1027             delimiter = '|';
1028         }
1029     }
1030
1031 /* Delay loading is not supported for the client side plugins:
1032     if (m->f) {
1033         printf ("\n\twill be loaded from \"%s\"", m->f);
1034     }
1035  */
1036
1037     printf ("\n");
1038 }
1039
1040
1041 /* Dump information about available client plugins */
1042 int sasl_client_plugin_info (
1043   const char *c_mech_list,              /* space separated mechanism list or NULL for ALL */
1044   sasl_client_info_callback_t *info_cb,
1045   void *info_cb_rock
1046 )
1047 {
1048     cmechanism_t *m;
1049     client_sasl_mechanism_t plug_data;
1050     char * cur_mech;
1051     char * mech_list = NULL;
1052     char * p;
1053
1054     if (info_cb == NULL) {
1055         info_cb = _sasl_print_mechanism;
1056     }
1057
1058     if (cmechlist != NULL) {
1059         info_cb (NULL, SASL_INFO_LIST_START, info_cb_rock);
1060
1061         if (c_mech_list == NULL) {
1062             m = cmechlist->mech_list; /* m point to beginning of the list */
1063
1064             while (m != NULL) {
1065                 memcpy (&plug_data, &m->m, sizeof(plug_data));
1066
1067                 info_cb (&plug_data, SASL_INFO_LIST_MECH, info_cb_rock);
1068
1069                 m = m->next;
1070             }
1071         } else {
1072             mech_list = strdup (c_mech_list);
1073
1074             cur_mech = mech_list;
1075
1076             while (cur_mech != NULL) {
1077                 p = strchr (cur_mech, ' ');
1078                 if (p != NULL) {
1079                     *p = '\0';
1080                     p++;
1081                 }
1082
1083                 m = cmechlist->mech_list; /* m point to beginning of the list */
1084
1085                 while (m != NULL) {
1086                     if (strcasecmp (cur_mech, m->m.plug->mech_name) == 0) {
1087                         memcpy (&plug_data, &m->m, sizeof(plug_data));
1088
1089                         info_cb (&plug_data, SASL_INFO_LIST_MECH, info_cb_rock);
1090                     }
1091
1092                     m = m->next;
1093                 }
1094
1095                 cur_mech = p;
1096             }
1097
1098             free (mech_list);
1099         }
1100
1101         info_cb (NULL, SASL_INFO_LIST_END, info_cb_rock);
1102
1103         return (SASL_OK);
1104     }
1105
1106     return (SASL_NOTINIT);
1107 }