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