lib/common.c

   1 /* common.c - Functions that are common to server and clinet
   2  * Rob Siemborski
   3  * Tim Martin
   4  * $Id: common.c,v 1.114 2006/04/19 18:39:59 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 <string.h>
  49 #include <stdlib.h>
  50 #include <limits.h>
  51 #ifdef HAVE_SYSLOG
  52 #include <syslog.h>
  53 #endif
  54 #include <stdarg.h>
  55 #include <ctype.h>
  56 #include <assert.h>
  57
  58 #include <sasl.h>
  59 #include <saslutil.h>
  60 #include <saslplug.h>
  61 #include "saslint.h"
  62
  63 #ifdef HAVE_UNISTD_H
  64 #include <unistd.h>
  65 #endif
  66
  67 static const char *implementation_string = "Cyrus SASL";
  68
  69 #define VSTR0(maj, min, step)   #maj "." #min "." #step
  70 #define VSTR(maj, min, step)    VSTR0(maj, min, step)
  71 #define SASL_VERSION_STRING     VSTR(SASL_VERSION_MAJOR, SASL_VERSION_MINOR, \
  72                                 SASL_VERSION_STEP)
  73
  74 static int _sasl_getpath(void *context __attribute__((unused)), const char **path);
  75 static int _sasl_getpath_simple(void *context __attribute__((unused)), const char **path);
  76 static int _sasl_getconfpath(void *context __attribute__((unused)), char ** path);
  77 static int _sasl_getconfpath_simple(void *context __attribute__((unused)), const char **path);
  78
  79 #if !defined(WIN32)
  80 static char * _sasl_get_default_unix_path(void *context __attribute__((unused)),
  81                             char * env_var_name, char * default_value);
  82 #else
  83 /* NB: Always returned allocated value */
  84 static char * _sasl_get_default_win_path(void *context __attribute__((unused)),
  85                             char * reg_attr_name, char * default_value);
  86 #endif
  87
  88
  89 static const char build_ident[] = "$Build: libsasl " PACKAGE "-" VERSION " $";
  90
  91 /* It turns out to be convenient to have a shared sasl_utils_t */
  92 LIBSASL_VAR const sasl_utils_t *sasl_global_utils = NULL;
  93
  94 /* Should be a null-terminated array that lists the available mechanisms */
  95 static char **global_mech_list = NULL;
  96
  97 void *free_mutex = NULL;
  98
  99 int (*_sasl_client_cleanup_hook)(void) = NULL;
 100 int (*_sasl_server_cleanup_hook)(void) = NULL;
 101 int (*_sasl_client_idle_hook)(sasl_conn_t *conn) = NULL;
 102 int (*_sasl_server_idle_hook)(sasl_conn_t *conn) = NULL;
 103
 104 sasl_allocation_utils_t _sasl_allocation_utils={
 105   (sasl_malloc_t *)  &malloc,
 106   (sasl_calloc_t *)  &calloc,
 107   (sasl_realloc_t *) &realloc,
 108   (sasl_free_t *) &free
 109 };
 110
 111 #define SASL_ENCODEV_EXTRA  4096
 112
 113 /* Default getpath/getconfpath callbacks. These can be edited by sasl_set_path(). */
 114 static sasl_callback_t default_getpath_cb = {
 115     SASL_CB_GETPATH, &_sasl_getpath, NULL
 116 };
 117 static sasl_callback_t default_getconfpath_cb = {
 118     SASL_CB_GETCONFPATH, &_sasl_getconfpath, NULL
 119 };
 120
 121 static char * default_plugin_path = NULL;
 122 static char * default_conf_path = NULL;
 123
 124 /* Intenal mutex functions do as little as possible (no thread protection) */
 125 static void *sasl_mutex_alloc(void)
 126 {
 127   return (void *)0x1;
 128 }
 129
 130 static int sasl_mutex_lock(void *mutex __attribute__((unused)))
 131 {
 132     return SASL_OK;
 133 }
 134
 135 static int sasl_mutex_unlock(void *mutex __attribute__((unused)))
 136 {
 137     return SASL_OK;
 138 }
 139
 140 static void sasl_mutex_free(void *mutex __attribute__((unused)))
 141 {
 142     return;
 143 }
 144
 145 sasl_mutex_utils_t _sasl_mutex_utils={
 146   &sasl_mutex_alloc,
 147   &sasl_mutex_lock,
 148   &sasl_mutex_unlock,
 149   &sasl_mutex_free
 150 };
 151
 152 void sasl_set_mutex(sasl_mutex_alloc_t *n, sasl_mutex_lock_t *l,
 153                     sasl_mutex_unlock_t *u, sasl_mutex_free_t *d)
 154 {
 155   _sasl_mutex_utils.alloc=n;
 156   _sasl_mutex_utils.lock=l;
 157   _sasl_mutex_utils.unlock=u;
 158   _sasl_mutex_utils.free=d;
 159 }
 160
 161 /* copy a string to malloced memory */
 162 int _sasl_strdup(const char *in, char **out, size_t *outlen)
 163 {
 164   size_t len = strlen(in);
 165   if (outlen) *outlen = len;
 166   *out=sasl_ALLOC((unsigned) len + 1);
 167   if (! *out) return SASL_NOMEM;
 168   strcpy((char *) *out, in);
 169   return SASL_OK;
 170 }
 171
 172 /* adds a string to the buffer; reallocing if need be */
 173 int _sasl_add_string(char **out, size_t *alloclen,
 174                      size_t *outlen, const char *add)
 175 {
 176   size_t addlen;
 177
 178   if (add==NULL) add = "(null)";
 179
 180   addlen=strlen(add); /* only compute once */
 181   if (_buf_alloc(out, alloclen, (*outlen)+addlen)!=SASL_OK)
 182     return SASL_NOMEM;
 183
 184   strncpy(*out + *outlen, add, addlen);
 185   *outlen += addlen;
 186
 187   return SASL_OK;
 188 }
 189
 190 /* a simpler way to set plugin path or configuration file path
 191  * without the need to set sasl_getpath_t callback.
 192  *
 193  * This function can be called before sasl_server_init/sasl_client_init.
 194  *
 195  * Don't call this function without locking in a multithreaded application.
 196  */
 197 int sasl_set_path (int path_type, char * path)
 198 {
 199     int result;
 200
 201     if (path == NULL) {
 202         return (SASL_FAIL);
 203     }
 204
 205     switch (path_type) {
 206         case SASL_PATH_TYPE_PLUGIN:
 207             if (default_plugin_path != NULL) {
 208                 sasl_FREE (default_plugin_path);
 209                 default_plugin_path = NULL;
 210             }
 211             result = _sasl_strdup (path, &default_plugin_path, NULL);
 212             if (result != SASL_OK) {
 213                 return (result);
 214             }
 215
 216             /* Update the default getpath_t callback */
 217             default_getpath_cb.proc = (int (*)()) &_sasl_getpath_simple;
 218             break;
 219
 220         case SASL_PATH_TYPE_CONFIG:
 221             if (default_conf_path != NULL) {
 222                 sasl_FREE (default_conf_path);
 223                 default_conf_path = NULL;
 224             }
 225             result = _sasl_strdup (path, &default_conf_path, NULL);
 226             if (result != SASL_OK) {
 227                 return (result);
 228             }
 229
 230             /* Update the default getpath_t callback */
 231             default_getconfpath_cb.proc = (int (*)()) &_sasl_getconfpath_simple;
 232             break;
 233
 234         default:
 235             return (SASL_FAIL);
 236     }
 237
 238     return (SASL_OK);
 239 }
 240
 241 /* return the version of the cyrus sasl library as compiled,
 242  * using 32 bits: high byte is major version, second byte is minor version,
 243  * low 16 bits are step # */
 244 void sasl_version(const char **implementation, int *version)
 245 {
 246     if(implementation) *implementation = implementation_string;
 247     /* NB: the format is not the same as in SASL_VERSION_FULL */
 248     if(version) *version = (SASL_VERSION_MAJOR << 24) |
 249                            (SASL_VERSION_MINOR << 16) |
 250                            (SASL_VERSION_STEP);
 251 }
 252
 253 /* Extended version of sasl_version above */
 254 void sasl_version_info (const char **implementation, const char **version_string,
 255                     int *version_major, int *version_minor, int *version_step,
 256                     int *version_patch)
 257 {
 258     if (implementation) *implementation = implementation_string;
 259     if (version_string) *version_string = SASL_VERSION_STRING;
 260     if (version_major) *version_major = SASL_VERSION_MAJOR;
 261     if (version_minor) *version_minor = SASL_VERSION_MINOR;
 262     if (version_step) *version_step = SASL_VERSION_STEP;
 263     /* Version patch is always 0 for CMU SASL */
 264     if (version_patch) *version_patch = 0;
 265 }
 266
 267 /* security-encode a regular string.  Mostly a wrapper for sasl_encodev */
 268 /* output is only valid until next call to sasl_encode or sasl_encodev */
 269 int sasl_encode(sasl_conn_t *conn, const char *input,
 270                 unsigned inputlen,
 271                 const char **output, unsigned *outputlen)
 272 {
 273     int result;
 274     struct iovec tmp;
 275
 276     if(!conn) return SASL_BADPARAM;
 277     if(!input || !inputlen || !output || !outputlen)
 278         PARAMERROR(conn);
 279
 280     /* maxoutbuf checking is done in sasl_encodev */
 281
 282     /* Note: We are casting a const pointer here, but it's okay
 283      * because we believe people downstream of us are well-behaved, and the
 284      * alternative is an absolute mess, performance-wise. */
 285     tmp.iov_base = (void *)input;
 286     tmp.iov_len = inputlen;
 287
 288     result = sasl_encodev(conn, &tmp, 1, output, outputlen);
 289
 290     RETURN(conn, result);
 291 }
 292
 293 /* Internal function that doesn't do any verification */
 294 static int
 295 _sasl_encodev (sasl_conn_t *conn,
 296                const struct iovec *invec,
 297                unsigned numiov,
 298                int * p_num_packets,     /* number of packets generated so far */
 299                const char **output,     /* previous output, if *p_num_packets > 0 */
 300                unsigned *outputlen)
 301 {
 302     int result;
 303     char * new_buf;
 304
 305     assert (conn->oparams.encode != NULL);
 306
 307     if (*p_num_packets == 1) {
 308         /* This is the second call to this function,
 309            so we need to allocate a new output buffer
 310            and copy existing data there. */
 311         conn->multipacket_encoded_data.curlen = *outputlen;
 312         if (conn->multipacket_encoded_data.data == NULL) {
 313             conn->multipacket_encoded_data.reallen =
 314                  conn->multipacket_encoded_data.curlen + SASL_ENCODEV_EXTRA;
 315             conn->multipacket_encoded_data.data =
 316                  sasl_ALLOC(conn->multipacket_encoded_data.reallen + 1);
 317
 318             if (conn->multipacket_encoded_data.data == NULL) {
 319                 MEMERROR(conn);
 320             }
 321         } else {
 322             /* A buffer left from a previous sasl_encodev call.
 323                Make sure it is big enough. */
 324             if (conn->multipacket_encoded_data.curlen >
 325                 conn->multipacket_encoded_data.reallen) {
 326                 conn->multipacket_encoded_data.reallen =
 327                     conn->multipacket_encoded_data.curlen + SASL_ENCODEV_EXTRA;
 328
 329                 new_buf = sasl_REALLOC(conn->multipacket_encoded_data.data,
 330                             conn->multipacket_encoded_data.reallen + 1);
 331                 if (new_buf == NULL) {
 332                     MEMERROR(conn);
 333                 }
 334                 conn->multipacket_encoded_data.data = new_buf;
 335             }
 336         }
 337
 338         memcpy (conn->multipacket_encoded_data.data,
 339                 *output,
 340                 *outputlen);
 341     }
 342
 343     result = conn->oparams.encode(conn->context,
 344                                   invec,
 345                                   numiov,
 346                                   output,
 347                                   outputlen);
 348
 349     if (*p_num_packets > 0 && result == SASL_OK) {
 350         /* Is the allocated buffer big enough? If not, grow it. */
 351         if ((conn->multipacket_encoded_data.curlen + *outputlen) >
 352              conn->multipacket_encoded_data.reallen) {
 353             conn->multipacket_encoded_data.reallen =
 354                 conn->multipacket_encoded_data.curlen + *outputlen;
 355             new_buf = sasl_REALLOC(conn->multipacket_encoded_data.data,
 356                         conn->multipacket_encoded_data.reallen + 1);
 357             if (new_buf == NULL) {
 358                 MEMERROR(conn);
 359             }
 360             conn->multipacket_encoded_data.data = new_buf;
 361         }
 362
 363         /* Append new data to the end of the buffer */
 364         memcpy (conn->multipacket_encoded_data.data +
 365                 conn->multipacket_encoded_data.curlen,
 366                 *output,
 367                 *outputlen);
 368         conn->multipacket_encoded_data.curlen += *outputlen;
 369
 370         *output = conn->multipacket_encoded_data.data;
 371         *outputlen = conn->multipacket_encoded_data.curlen;
 372     }
 373
 374     (*p_num_packets)++;
 375
 376     RETURN(conn, result);
 377 }
 378
 379 /* security-encode an iovec */
 380 /* output is only valid until the next call to sasl_encode or sasl_encodev */
 381 int sasl_encodev(sasl_conn_t *conn,
 382                  const struct iovec *invec,
 383                  unsigned numiov,
 384                  const char **output,
 385                  unsigned *outputlen)
 386 {
 387     int result;
 388     unsigned i;
 389     unsigned j;
 390     size_t total_size = 0;
 391     struct iovec *cur_invec = NULL;
 392     struct iovec last_invec;
 393     unsigned cur_numiov;
 394     char * next_buf = NULL;
 395     unsigned remainder_len;
 396     unsigned index_offset;
 397     unsigned allocated = 0;
 398     /* Number of generated SASL packets */
 399     int num_packets = 0;
 400
 401     if (!conn) return SASL_BADPARAM;
 402     if (! invec || ! output || ! outputlen || numiov < 1) {
 403         PARAMERROR(conn);
 404     }
 405
 406     if (!conn->props.maxbufsize) {
 407         sasl_seterror(conn, 0,
 408                       "called sasl_encode[v] with application that does not support security layers");
 409         return SASL_TOOWEAK;
 410     }
 411
 412     /* If oparams.encode is NULL, this means there is no SASL security
 413        layer in effect, so no SASL framing is needed. */
 414     if (conn->oparams.encode == NULL)  {
 415         result = _iovec_to_buf(invec, numiov, &conn->encode_buf);
 416         if (result != SASL_OK) INTERROR(conn, result);
 417
 418         *output = conn->encode_buf->data;
 419         *outputlen = (unsigned) conn->encode_buf->curlen;
 420
 421         RETURN(conn, result);
 422     }
 423
 424     /* This might be better to check on a per-plugin basis, but I think
 425      * it's cleaner and more effective here.  It also encourages plugins
 426      * to be honest about what they accept */
 427
 428     last_invec.iov_base = NULL;
 429     remainder_len = 0;
 430     next_buf = NULL;
 431     i = 0;
 432     while (i < numiov) {
 433         if ((total_size + invec[i].iov_len) > conn->oparams.maxoutbuf) {
 434
 435             /* CLAIM: total_size < conn->oparams.maxoutbuf */
 436
 437             /* Fit as many bytes in last_invec, so that we have conn->oparams.maxoutbuf
 438                bytes in total. */
 439             last_invec.iov_len = conn->oparams.maxoutbuf - total_size;
 440             /* Point to the first byte of the current record. */
 441             last_invec.iov_base = invec[i].iov_base;
 442
 443             /* Note that total_size < conn->oparams.maxoutbuf */
 444             /* The total size of the iov is bigger then the other end can accept.
 445                So we allocate a new iov that contains just enough. */
 446
 447             /* +1 --- for the tail record */
 448             cur_numiov = i + 1;
 449
 450             /* +1 --- just in case we need the head record */
 451             if ((cur_numiov + 1) > allocated) {
 452                 struct iovec *new_invec;
 453
 454                 allocated = cur_numiov + 1;
 455                 new_invec = sasl_REALLOC (cur_invec, sizeof(struct iovec) * allocated);
 456                 if (new_invec == NULL) {
 457                     if (cur_invec != NULL) {
 458                         sasl_FREE(cur_invec);
 459                     }
 460                     MEMERROR(conn);
 461                 }
 462                 cur_invec = new_invec;
 463             }
 464
 465             if (next_buf != NULL) {
 466                 cur_invec[0].iov_base = next_buf;
 467                 cur_invec[0].iov_len = remainder_len;
 468                 cur_numiov++;
 469                 index_offset = 1;
 470             } else {
 471                 index_offset = 0;
 472             }
 473
 474             if (i > 0) {
 475                 /* Copy all previous chunks */
 476                 /* NOTE - The starting index in invec is always 0 */
 477                 for (j = 0; j < i; j++) {
 478                     cur_invec[j + index_offset] = invec[j];
 479                 }
 480             }
 481
 482             /* Initialize the last record */
 483             cur_invec[i + index_offset] = last_invec;
 484
 485             result = _sasl_encodev (conn,
 486                                     cur_invec,
 487                                     cur_numiov,
 488                                     &num_packets,
 489                                     output,
 490                                     outputlen);
 491
 492             if (result != SASL_OK) {
 493                 goto cleanup;
 494             }
 495
 496             /* Point to the first byte that wouldn't fit into
 497                the conn->oparams.maxoutbuf buffer. */
 498             /* Note, if next_buf points to the very end of the IOV record,
 499                it will be reset to NULL below */
 500             next_buf = last_invec.iov_base + last_invec.iov_len;
 501             /* Note - remainder_len is how many bytes left to be encoded in
 502                the current IOV slot. */
 503             remainder_len = (total_size + invec[i].iov_len) - conn->oparams.maxoutbuf;
 504
 505             /* Skip all consumed IOV records */
 506             invec += i + 1;
 507             numiov = numiov - (i + 1);
 508             i = 0;
 509
 510             while (remainder_len > conn->oparams.maxoutbuf) {
 511                 last_invec.iov_base = next_buf;
 512                 last_invec.iov_len = conn->oparams.maxoutbuf;
 513
 514                 /* Note, if next_buf points to the very end of the IOV record,
 515                    it will be reset to NULL below */
 516                 next_buf = last_invec.iov_base + last_invec.iov_len;
 517                 remainder_len = remainder_len - conn->oparams.maxoutbuf;
 518
 519                 result = _sasl_encodev (conn,
 520                                         &last_invec,
 521                                         1,
 522                                         &num_packets,
 523                                         output,
 524                                         outputlen);
 525                 if (result != SASL_OK) {
 526                     goto cleanup;
 527                 }
 528             }
 529
 530             total_size = remainder_len;
 531
 532             if (remainder_len == 0) {
 533                 /* Just clear next_buf */
 534                 next_buf = NULL;
 535             }
 536         } else {
 537             total_size += invec[i].iov_len;
 538             i++;
 539         }
 540     }
 541
 542     /* CLAIM - The remaining data is shorter then conn->oparams.maxoutbuf. */
 543
 544     /* Force encoding of any partial buffer. Might not be optimal on the wire. */
 545     if (next_buf != NULL) {
 546         last_invec.iov_base = next_buf;
 547         last_invec.iov_len = remainder_len;
 548
 549         result = _sasl_encodev (conn,
 550                                 &last_invec,
 551                                 1,
 552                                 &num_packets,
 553                                 output,
 554                                 outputlen);
 555
 556         if (result != SASL_OK) {
 557             goto cleanup;
 558         }
 559     }
 560
 561     if (numiov > 0) {
 562         result = _sasl_encodev (conn,
 563                                 invec,
 564                                 numiov,
 565                                 &num_packets,
 566                                 output,
 567                                 outputlen);
 568     }
 569
 570 cleanup:
 571     if (cur_invec != NULL) {
 572         sasl_FREE(cur_invec);
 573     }
 574
 575     RETURN(conn, result);
 576 }
 577
 578 /* output is only valid until next call to sasl_decode */
 579 int sasl_decode(sasl_conn_t *conn,
 580                 const char *input, unsigned inputlen,
 581                 const char **output, unsigned *outputlen)
 582 {
 583     int result;
 584
 585     if(!conn) return SASL_BADPARAM;
 586     if(!input || !output || !outputlen)
 587         PARAMERROR(conn);
 588
 589     if(!conn->props.maxbufsize) {
 590         sasl_seterror(conn, 0,
 591                       "called sasl_decode with application that does not support security layers");
 592         RETURN(conn, SASL_TOOWEAK);
 593     }
 594
 595     if(conn->oparams.decode == NULL)
 596     {
 597         /* Since we know how long the output is maximally, we can
 598          * just allocate it to begin with, and never need another
 599          * allocation! */
 600
 601         /* However, if they pass us more than they actually can take,
 602          * we cannot help them... */
 603         if(inputlen > conn->props.maxbufsize) {
 604             sasl_seterror(conn, 0,
 605                           "input too large for default sasl_decode");
 606             RETURN(conn,SASL_BUFOVER);
 607         }
 608
 609         if(!conn->decode_buf)
 610             conn->decode_buf = sasl_ALLOC(conn->props.maxbufsize + 1);
 611         if(!conn->decode_buf)
 612             MEMERROR(conn);
 613
 614         memcpy(conn->decode_buf, input, inputlen);
 615         conn->decode_buf[inputlen] = '\0';
 616         *output = conn->decode_buf;
 617         *outputlen = inputlen;
 618
 619         return SASL_OK;
 620     } else {
 621         result = conn->oparams.decode(conn->context, input, inputlen,
 622                                       output, outputlen);
 623
 624         /* NULL an empty buffer (for misbehaved applications) */
 625         if (*outputlen == 0) *output = NULL;
 626
 627         RETURN(conn, result);
 628     }
 629
 630     INTERROR(conn, SASL_FAIL);
 631 }
 632
 633
 634 void
 635 sasl_set_alloc(sasl_malloc_t *m,
 636                sasl_calloc_t *c,
 637                sasl_realloc_t *r,
 638                sasl_free_t *f)
 639 {
 640   _sasl_allocation_utils.malloc=m;
 641   _sasl_allocation_utils.calloc=c;
 642   _sasl_allocation_utils.realloc=r;
 643   _sasl_allocation_utils.free=f;
 644 }
 645
 646 void sasl_done(void)
 647 {
 648     if (_sasl_server_cleanup_hook && _sasl_server_cleanup_hook() == SASL_OK) {
 649         _sasl_server_idle_hook = NULL;
 650         _sasl_server_cleanup_hook = NULL;
 651     }
 652
 653     if (_sasl_client_cleanup_hook && _sasl_client_cleanup_hook() == SASL_OK) {
 654         _sasl_client_idle_hook = NULL;
 655         _sasl_client_cleanup_hook = NULL;
 656     }
 657
 658     if (_sasl_server_cleanup_hook || _sasl_client_cleanup_hook) {
 659         return;
 660     }
 661
 662     /* NOTE - the caller will need to reinitialize the values,
 663        if it is going to call sasl_client_init/sasl_server_init again. */
 664     if (default_plugin_path != NULL) {
 665         sasl_FREE (default_plugin_path);
 666         default_plugin_path = NULL;
 667     }
 668     if (default_conf_path != NULL) {
 669         sasl_FREE (default_conf_path);
 670         default_conf_path = NULL;
 671     }
 672
 673     _sasl_canonuser_free();
 674     _sasl_done_with_plugins();
 675
 676     sasl_MUTEX_FREE(free_mutex);
 677     free_mutex = NULL;
 678
 679     _sasl_free_utils(&sasl_global_utils);
 680
 681     if(global_mech_list) sasl_FREE(global_mech_list);
 682     global_mech_list = NULL;
 683 }
 684
 685 /* fills in the base sasl_conn_t info */
 686 int _sasl_conn_init(sasl_conn_t *conn,
 687                     const char *service,
 688                     unsigned int flags,
 689                     enum Sasl_conn_type type,
 690                     int (*idle_hook)(sasl_conn_t *conn),
 691                     const char *serverFQDN,
 692                     const char *iplocalport,
 693                     const char *ipremoteport,
 694                     const sasl_callback_t *callbacks,
 695                     const sasl_global_callbacks_t *global_callbacks) {
 696   int result = SASL_OK;
 697
 698   conn->type = type;
 699
 700   result = _sasl_strdup(service, &conn->service, NULL);
 701   if (result != SASL_OK)
 702       MEMERROR(conn);
 703
 704   memset(&conn->oparams, 0, sizeof(sasl_out_params_t));
 705   memset(&conn->external, 0, sizeof(_sasl_external_properties_t));
 706
 707   conn->flags = flags;
 708
 709   result = sasl_setprop(conn, SASL_IPLOCALPORT, iplocalport);
 710   if(result != SASL_OK)
 711       RETURN(conn, result);
 712
 713   result = sasl_setprop(conn, SASL_IPREMOTEPORT, ipremoteport);
 714   if(result != SASL_OK)
 715       RETURN(conn, result);
 716
 717   conn->encode_buf = NULL;
 718   conn->context = NULL;
 719   conn->secret = NULL;
 720   conn->idle_hook = idle_hook;
 721   conn->callbacks = callbacks;
 722   conn->global_callbacks = global_callbacks;
 723
 724   memset(&conn->props, 0, sizeof(conn->props));
 725
 726   /* Start this buffer out as an empty string */
 727   conn->error_code = SASL_OK;
 728   conn->errdetail_buf = conn->error_buf = NULL;
 729   conn->errdetail_buf_len = conn->error_buf_len = 150;
 730
 731   result = _buf_alloc(&conn->error_buf, &conn->error_buf_len, 150);
 732   if(result != SASL_OK) MEMERROR(conn);
 733   result = _buf_alloc(&conn->errdetail_buf, &conn->errdetail_buf_len, 150);
 734   if(result != SASL_OK) MEMERROR(conn);
 735
 736   conn->error_buf[0] = '\0';
 737   conn->errdetail_buf[0] = '\0';
 738
 739   conn->decode_buf = NULL;
 740
 741   if(serverFQDN) {
 742       result = _sasl_strdup(serverFQDN, &conn->serverFQDN, NULL);
 743   } else if (conn->type == SASL_CONN_SERVER) {
 744       /* We can fake it because we *are* the server */
 745       char name[MAXHOSTNAMELEN];
 746       memset(name, 0, sizeof(name));
 747       gethostname(name, MAXHOSTNAMELEN);
 748
 749       result = _sasl_strdup(name, &conn->serverFQDN, NULL);
 750   } else {
 751       conn->serverFQDN = NULL;
 752   }
 753
 754
 755   if(result != SASL_OK) MEMERROR( conn );
 756
 757   RETURN(conn, SASL_OK);
 758 }
 759
 760 int _sasl_common_init(sasl_global_callbacks_t *global_callbacks)
 761 {
 762     int result;
 763
 764     /* Setup the global utilities */
 765     if(!sasl_global_utils) {
 766         sasl_global_utils = _sasl_alloc_utils(NULL, global_callbacks);
 767         if(sasl_global_utils == NULL) return SASL_NOMEM;
 768     }
 769
 770     /* Init the canon_user plugin */
 771     result = sasl_canonuser_add_plugin("INTERNAL", internal_canonuser_init);
 772     if(result != SASL_OK) return result;
 773
 774     if (!free_mutex)
 775         free_mutex = sasl_MUTEX_ALLOC();
 776     if (!free_mutex) return SASL_FAIL;
 777
 778     return SASL_OK;
 779 }
 780
 781 /* dispose connection state, sets it to NULL
 782  *  checks for pointer to NULL
 783  */
 784 void sasl_dispose(sasl_conn_t **pconn)
 785 {
 786   int result;
 787
 788   if (! pconn) return;
 789   if (! *pconn) return;
 790
 791   /* serialize disposes. this is necessary because we can't
 792      dispose of conn->mutex if someone else is locked on it */
 793   result = sasl_MUTEX_LOCK(free_mutex);
 794   if (result!=SASL_OK) return;
 795
 796   /* *pconn might have become NULL by now */
 797   if (! (*pconn)) return;
 798
 799   (*pconn)->destroy_conn(*pconn);
 800   sasl_FREE(*pconn);
 801   *pconn=NULL;
 802
 803   sasl_MUTEX_UNLOCK(free_mutex);
 804 }
 805
 806 void _sasl_conn_dispose(sasl_conn_t *conn) {
 807   if (conn->serverFQDN)
 808       sasl_FREE(conn->serverFQDN);
 809
 810   if (conn->external.auth_id)
 811       sasl_FREE(conn->external.auth_id);
 812
 813   if(conn->encode_buf) {
 814       if(conn->encode_buf->data) sasl_FREE(conn->encode_buf->data);
 815       sasl_FREE(conn->encode_buf);
 816   }
 817
 818   if(conn->error_buf)
 819       sasl_FREE(conn->error_buf);
 820
 821   if(conn->errdetail_buf)
 822       sasl_FREE(conn->errdetail_buf);
 823
 824   if(conn->decode_buf)
 825       sasl_FREE(conn->decode_buf);
 826
 827   if(conn->mechlist_buf)
 828       sasl_FREE(conn->mechlist_buf);
 829
 830   if(conn->service)
 831       sasl_FREE(conn->service);
 832
 833   if (conn->multipacket_encoded_data.data) {
 834       sasl_FREE(conn->multipacket_encoded_data.data);
 835   }
 836
 837   /* oparams sub-members should be freed by the plugin, in so much
 838    * as they were allocated by the plugin */
 839 }
 840
 841
 842 /* get property from SASL connection state
 843  *  propnum       -- property number
 844  *  pvalue        -- pointer to value
 845  * returns:
 846  *  SASL_OK       -- no error
 847  *  SASL_NOTDONE  -- property not available yet
 848  *  SASL_BADPARAM -- bad property number
 849  */
 850 int sasl_getprop(sasl_conn_t *conn, int propnum, const void **pvalue)
 851 {
 852   int result = SASL_OK;
 853   sasl_getopt_t *getopt;
 854   void *context;
 855
 856   if (! conn) return SASL_BADPARAM;
 857   if (! pvalue) PARAMERROR(conn);
 858
 859   switch(propnum)
 860   {
 861   case SASL_SSF:
 862       *(sasl_ssf_t **)pvalue= &conn->oparams.mech_ssf;
 863       break;
 864   case SASL_MAXOUTBUF:
 865       *(unsigned **)pvalue = &conn->oparams.maxoutbuf;
 866       break;
 867   case SASL_GETOPTCTX:
 868       result = _sasl_getcallback(conn, SASL_CB_GETOPT, &getopt, &context);
 869       if(result != SASL_OK) break;
 870
 871       *(void **)pvalue = context;
 872       break;
 873   case SASL_CALLBACK:
 874       *(const sasl_callback_t **)pvalue = conn->callbacks;
 875       break;
 876   case SASL_IPLOCALPORT:
 877       if(conn->got_ip_local)
 878           *(const char **)pvalue = conn->iplocalport;
 879       else {
 880           *(const char **)pvalue = NULL;
 881           result = SASL_NOTDONE;
 882       }
 883       break;
 884   case SASL_IPREMOTEPORT:
 885       if(conn->got_ip_remote)
 886           *(const char **)pvalue = conn->ipremoteport;
 887       else {
 888           *(const char **)pvalue = NULL;
 889           result = SASL_NOTDONE;
 890       }
 891       break;
 892   case SASL_USERNAME:
 893       if(! conn->oparams.user)
 894           result = SASL_NOTDONE;
 895       else
 896           *((const char **)pvalue) = conn->oparams.user;
 897       break;
 898   case SASL_AUTHUSER:
 899       if(! conn->oparams.authid)
 900           result = SASL_NOTDONE;
 901       else
 902           *((const char **)pvalue) = conn->oparams.authid;
 903       break;
 904   case SASL_APPNAME:
 905       /* Currently we only support server side contexts, but we should
 906          be able to extend this to support client side contexts as well */
 907       if(conn->type != SASL_CONN_SERVER) result = SASL_BADPROT;
 908       else
 909           *((const char **)pvalue) = ((sasl_server_conn_t *)conn)->sparams->appname;
 910       break;
 911   case SASL_SERVERFQDN:
 912       *((const char **)pvalue) = conn->serverFQDN;
 913       break;
 914   case SASL_DEFUSERREALM:
 915       if(conn->type != SASL_CONN_SERVER) result = SASL_BADPROT;
 916       else
 917           *((const char **)pvalue) = ((sasl_server_conn_t *)conn)->user_realm;
 918       break;
 919   case SASL_SERVICE:
 920       *((const char **)pvalue) = conn->service;
 921       break;
 922   case SASL_AUTHSOURCE: /* name of plugin (not name of mech) */
 923       if(conn->type == SASL_CONN_CLIENT) {
 924           if(!((sasl_client_conn_t *)conn)->mech) {
 925               result = SASL_NOTDONE;
 926               break;
 927           }
 928           *((const char **)pvalue) =
 929               ((sasl_client_conn_t *)conn)->mech->m.plugname;
 930       } else if (conn->type == SASL_CONN_SERVER) {
 931           if(!((sasl_server_conn_t *)conn)->mech) {
 932               result = SASL_NOTDONE;
 933               break;
 934           }
 935           *((const char **)pvalue) =
 936               ((sasl_server_conn_t *)conn)->mech->m.plugname;
 937       } else {
 938           result = SASL_BADPARAM;
 939       }
 940       break;
 941   case SASL_MECHNAME: /* name of mech */
 942       if(conn->type == SASL_CONN_CLIENT) {
 943           if(!((sasl_client_conn_t *)conn)->mech) {
 944               result = SASL_NOTDONE;
 945               break;
 946           }
 947           *((const char **)pvalue) =
 948               ((sasl_client_conn_t *)conn)->mech->m.plug->mech_name;
 949       } else if (conn->type == SASL_CONN_SERVER) {
 950           if(!((sasl_server_conn_t *)conn)->mech) {
 951               result = SASL_NOTDONE;
 952               break;
 953           }
 954           *((const char **)pvalue) =
 955               ((sasl_server_conn_t *)conn)->mech->m.plug->mech_name;
 956       } else {
 957           result = SASL_BADPARAM;
 958       }
 959
 960       if(!(*pvalue) && result == SASL_OK) result = SASL_NOTDONE;
 961       break;
 962   case SASL_PLUGERR:
 963       *((const char **)pvalue) = conn->error_buf;
 964       break;
 965   case SASL_DELEGATEDCREDS:
 966       /* We can't really distinguish between "no delegated credentials"
 967          and "authentication not finished" */
 968       if(! conn->oparams.client_creds)
 969           result = SASL_NOTDONE;
 970       else
 971           *((const char **)pvalue) = conn->oparams.client_creds;
 972       break;
 973   case SASL_GSS_PEER_NAME:
 974       if(! conn->oparams.gss_peer_name)
 975           result = SASL_NOTDONE;
 976       else
 977           *((const char **)pvalue) = conn->oparams.gss_peer_name;
 978       break;
 979   case SASL_GSS_LOCAL_NAME:
 980       if(! conn->oparams.gss_peer_name)
 981           result = SASL_NOTDONE;
 982       else
 983           *((const char **)pvalue) = conn->oparams.gss_local_name;
 984       break;
 985   case SASL_SSF_EXTERNAL:
 986       *((const sasl_ssf_t **)pvalue) = &conn->external.ssf;
 987       break;
 988   case SASL_AUTH_EXTERNAL:
 989       *((const char **)pvalue) = conn->external.auth_id;
 990       break;
 991   case SASL_SEC_PROPS:
 992       *((const sasl_security_properties_t **)pvalue) = &conn->props;
 993       break;
 994   default:
 995       result = SASL_BADPARAM;
 996   }
 997
 998   if(result == SASL_BADPARAM) {
 999       PARAMERROR(conn);
1000   } else if(result == SASL_NOTDONE) {
1001       sasl_seterror(conn, SASL_NOLOG,
1002                     "Information that was requested is not yet available.");
1003       RETURN(conn, result);
1004   } else if(result != SASL_OK) {
1005       INTERROR(conn, result);
1006   } else
1007       RETURN(conn, result);
1008 }
1009
1010 /* set property in SASL connection state
1011  * returns:
1012  *  SASL_OK       -- value set
1013  *  SASL_BADPARAM -- invalid property or value
1014  */
1015 int sasl_setprop(sasl_conn_t *conn, int propnum, const void *value)
1016 {
1017   int result = SASL_OK;
1018   char *str;
1019
1020   /* make sure the sasl context is valid */
1021   if (!conn)
1022     return SASL_BADPARAM;
1023
1024   switch(propnum)
1025   {
1026   case SASL_SSF_EXTERNAL:
1027       conn->external.ssf = *((sasl_ssf_t *)value);
1028       if(conn->type == SASL_CONN_SERVER) {
1029         ((sasl_server_conn_t*)conn)->sparams->external_ssf =
1030           conn->external.ssf;
1031       } else {
1032         ((sasl_client_conn_t*)conn)->cparams->external_ssf =
1033           conn->external.ssf;
1034       }
1035       break;
1036
1037   case SASL_AUTH_EXTERNAL:
1038       if(value && strlen(value)) {
1039           result = _sasl_strdup(value, &str, NULL);
1040           if(result != SASL_OK) MEMERROR(conn);
1041       } else {
1042           str = NULL;
1043       }
1044
1045       if(conn->external.auth_id)
1046           sasl_FREE(conn->external.auth_id);
1047
1048       conn->external.auth_id = str;
1049
1050       break;
1051
1052   case SASL_DEFUSERREALM:
1053       if(conn->type != SASL_CONN_SERVER) {
1054         sasl_seterror(conn, 0, "Tried to set realm on non-server connection");
1055         result = SASL_BADPROT;
1056         break;
1057       }
1058
1059       if(value && strlen(value)) {
1060           result = _sasl_strdup(value, &str, NULL);
1061           if(result != SASL_OK) MEMERROR(conn);
1062       } else {
1063           PARAMERROR(conn);
1064       }
1065
1066       if(((sasl_server_conn_t *)conn)->user_realm)
1067           sasl_FREE(((sasl_server_conn_t *)conn)->user_realm);
1068
1069       ((sasl_server_conn_t *)conn)->user_realm = str;
1070       ((sasl_server_conn_t *)conn)->sparams->user_realm = str;
1071
1072       break;
1073
1074   case SASL_SEC_PROPS:
1075   {
1076       sasl_security_properties_t *props = (sasl_security_properties_t *)value;
1077
1078       if(props->maxbufsize == 0 && props->min_ssf != 0) {
1079           sasl_seterror(conn, 0,
1080                         "Attempt to disable security layers (maxoutbuf == 0) with min_ssf > 0");
1081           RETURN(conn, SASL_TOOWEAK);
1082       }
1083
1084       conn->props = *props;
1085
1086       if(conn->type == SASL_CONN_SERVER) {
1087         ((sasl_server_conn_t*)conn)->sparams->props = *props;
1088       } else {
1089         ((sasl_client_conn_t*)conn)->cparams->props = *props;
1090       }
1091
1092       break;
1093   }
1094
1095   case SASL_IPREMOTEPORT:
1096   {
1097       const char *ipremoteport = (const char *)value;
1098       if(!value) {
1099           conn->got_ip_remote = 0;
1100       } else if (_sasl_ipfromstring(ipremoteport, NULL, 0)
1101                  != SASL_OK) {
1102           sasl_seterror(conn, 0, "Bad IPREMOTEPORT value");
1103           RETURN(conn, SASL_BADPARAM);
1104       } else {
1105           strcpy(conn->ipremoteport, ipremoteport);
1106           conn->got_ip_remote = 1;
1107       }
1108
1109       if(conn->got_ip_remote) {
1110           if(conn->type == SASL_CONN_CLIENT) {
1111               ((sasl_client_conn_t *)conn)->cparams->ipremoteport
1112                   = conn->ipremoteport;
1113               ((sasl_client_conn_t *)conn)->cparams->ipremlen =
1114                   (unsigned) strlen(conn->ipremoteport);
1115           } else if (conn->type == SASL_CONN_SERVER) {
1116               ((sasl_server_conn_t *)conn)->sparams->ipremoteport
1117                   = conn->ipremoteport;
1118               ((sasl_server_conn_t *)conn)->sparams->ipremlen =
1119                   (unsigned) strlen(conn->ipremoteport);
1120           }
1121       } else {
1122           if(conn->type == SASL_CONN_CLIENT) {
1123               ((sasl_client_conn_t *)conn)->cparams->ipremoteport
1124                   = NULL;
1125               ((sasl_client_conn_t *)conn)->cparams->ipremlen = 0;
1126           } else if (conn->type == SASL_CONN_SERVER) {
1127               ((sasl_server_conn_t *)conn)->sparams->ipremoteport
1128                   = NULL;
1129               ((sasl_server_conn_t *)conn)->sparams->ipremlen = 0;
1130           }
1131       }
1132
1133       break;
1134   }
1135
1136   case SASL_IPLOCALPORT:
1137   {
1138       const char *iplocalport = (const char *)value;
1139       if(!value) {
1140           conn->got_ip_local = 0;
1141       } else if (_sasl_ipfromstring(iplocalport, NULL, 0)
1142                  != SASL_OK) {
1143           sasl_seterror(conn, 0, "Bad IPLOCALPORT value");
1144           RETURN(conn, SASL_BADPARAM);
1145       } else {
1146           strcpy(conn->iplocalport, iplocalport);
1147           conn->got_ip_local = 1;
1148       }
1149
1150       if(conn->got_ip_local) {
1151           if(conn->type == SASL_CONN_CLIENT) {
1152               ((sasl_client_conn_t *)conn)->cparams->iplocalport
1153                   = conn->iplocalport;
1154               ((sasl_client_conn_t *)conn)->cparams->iploclen
1155                   = (unsigned) strlen(conn->iplocalport);
1156           } else if (conn->type == SASL_CONN_SERVER) {
1157               ((sasl_server_conn_t *)conn)->sparams->iplocalport
1158                   = conn->iplocalport;
1159               ((sasl_server_conn_t *)conn)->sparams->iploclen
1160                   = (unsigned) strlen(conn->iplocalport);
1161           }
1162       } else {
1163           if(conn->type == SASL_CONN_CLIENT) {
1164               ((sasl_client_conn_t *)conn)->cparams->iplocalport
1165                   = NULL;
1166               ((sasl_client_conn_t *)conn)->cparams->iploclen = 0;
1167           } else if (conn->type == SASL_CONN_SERVER) {
1168               ((sasl_server_conn_t *)conn)->sparams->iplocalport
1169                   = NULL;
1170               ((sasl_server_conn_t *)conn)->sparams->iploclen = 0;
1171           }
1172       }
1173       break;
1174   }
1175
1176   case SASL_APPNAME:
1177       /* Currently we only support server side contexts, but we should
1178          be able to extend this to support client side contexts as well */
1179       if(conn->type != SASL_CONN_SERVER) {
1180         sasl_seterror(conn, 0, "Tried to set application name on non-server connection");
1181         result = SASL_BADPROT;
1182         break;
1183       }
1184
1185       if(((sasl_server_conn_t *)conn)->appname) {
1186           sasl_FREE(((sasl_server_conn_t *)conn)->appname);
1187           ((sasl_server_conn_t *)conn)->appname = NULL;
1188       }
1189
1190       if(value && strlen(value)) {
1191           result = _sasl_strdup(value,
1192                                 &(((sasl_server_conn_t *)conn)->appname),
1193                                 NULL);
1194           if(result != SASL_OK) MEMERROR(conn);
1195           ((sasl_server_conn_t *)conn)->sparams->appname =
1196               ((sasl_server_conn_t *)conn)->appname;
1197           ((sasl_server_conn_t *)conn)->sparams->applen =
1198               (unsigned) strlen(((sasl_server_conn_t *)conn)->appname);
1199       } else {
1200           ((sasl_server_conn_t *)conn)->sparams->appname = NULL;
1201           ((sasl_server_conn_t *)conn)->sparams->applen = 0;
1202       }
1203       break;
1204
1205   case SASL_GSS_CREDS:
1206     if (conn->type == SASL_CONN_SERVER)
1207         ((sasl_server_conn_t *)conn)->sparams->gss_creds = (void *)value;
1208     else
1209         ((sasl_client_conn_t *)conn)->cparams->gss_creds = (void *)value;
1210     break;
1211   case SASL_CHANNEL_BINDINGS: {
1212     struct sasl_channel_bindings *cb = (struct sasl_channel_bindings *)value;
1213
1214     if (conn->type == SASL_CONN_SERVER) {
1215         ((sasl_server_conn_t *)conn)->sparams->chanbindingstype = cb->type;
1216         ((sasl_server_conn_t *)conn)->sparams->chanbindingscrit = cb->critical;
1217         ((sasl_server_conn_t *)conn)->sparams->chanbindingsdata = cb->data;
1218         ((sasl_server_conn_t *)conn)->sparams->chanbindingslen = cb->len;
1219     } else {
1220         ((sasl_client_conn_t *)conn)->cparams->chanbindingstype = cb->type;
1221         ((sasl_client_conn_t *)conn)->cparams->chanbindingscrit = cb->critical;
1222         ((sasl_client_conn_t *)conn)->cparams->chanbindingsdata = cb->data;
1223         ((sasl_client_conn_t *)conn)->cparams->chanbindingslen = cb->len;
1224     }
1225     break;
1226   }
1227   default:
1228       sasl_seterror(conn, 0, "Unknown parameter type");
1229       result = SASL_BADPARAM;
1230   }
1231
1232   RETURN(conn, result);
1233 }
1234
1235 /* this is apparently no longer a user function */
1236 static int sasl_usererr(int saslerr)
1237 {
1238     /* Hide the difference in a username failure and a password failure */
1239     if (saslerr == SASL_NOUSER)
1240         return SASL_BADAUTH;
1241
1242     /* otherwise return the error given; no transform necessary */
1243     return saslerr;
1244 }
1245
1246 const char *sasl_errstring(int saslerr,
1247                            const char *langlist __attribute__((unused)),
1248                            const char **outlang)
1249 {
1250   if (outlang) *outlang="en-us";
1251
1252   switch(saslerr)
1253     {
1254     case SASL_CONTINUE: return "another step is needed in authentication";
1255     case SASL_OK:       return "successful result";
1256     case SASL_FAIL:     return "generic failure";
1257     case SASL_NOMEM:    return "no memory available";
1258     case SASL_BUFOVER:  return "overflowed buffer";
1259     case SASL_NOMECH:   return "no mechanism available";
1260     case SASL_BADPROT:  return "bad protocol / cancel";
1261     case SASL_NOTDONE:  return "can't request info until later in exchange";
1262     case SASL_BADPARAM: return "invalid parameter supplied";
1263     case SASL_TRYAGAIN: return "transient failure (e.g., weak key)";
1264     case SASL_BADMAC:   return "integrity check failed";
1265     case SASL_NOTINIT:  return "SASL library not initialized";
1266                              /* -- client only codes -- */
1267     case SASL_INTERACT:   return "needs user interaction";
1268     case SASL_BADSERV:    return "server failed mutual authentication step";
1269     case SASL_WRONGMECH:  return "mechanism doesn't support requested feature";
1270                              /* -- server only codes -- */
1271     case SASL_BADAUTH:    return "authentication failure";
1272     case SASL_NOAUTHZ:    return "authorization failure";
1273     case SASL_TOOWEAK:    return "mechanism too weak for this user";
1274     case SASL_ENCRYPT:    return "encryption needed to use mechanism";
1275     case SASL_TRANS:      return "One time use of a plaintext password will enable requested mechanism for user";
1276     case SASL_EXPIRED:    return "passphrase expired, has to be reset";
1277     case SASL_DISABLED:   return "account disabled";
1278     case SASL_NOUSER:     return "user not found";
1279     case SASL_BADVERS:    return "version mismatch with plug-in";
1280     case SASL_UNAVAIL:    return "remote authentication server unavailable";
1281     case SASL_NOVERIFY:   return "user exists, but no verifier for user";
1282     case SASL_PWLOCK:     return "passphrase locked";
1283     case SASL_NOCHANGE:   return "requested change was not needed";
1284     case SASL_WEAKPASS:   return "passphrase is too weak for security policy";
1285     case SASL_NOUSERPASS: return "user supplied passwords are not permitted";
1286
1287     default:   return "undefined error!";
1288     }
1289
1290 }
1291
1292 /* Return the sanitized error detail about the last error that occured for
1293  * a connection */
1294 const char *sasl_errdetail(sasl_conn_t *conn)
1295 {
1296     unsigned need_len;
1297     const char *errstr;
1298     char leader[128];
1299
1300     if(!conn) return NULL;
1301
1302     errstr = sasl_errstring(conn->error_code, NULL, NULL);
1303     snprintf(leader,128,"SASL(%d): %s: ",
1304              sasl_usererr(conn->error_code), errstr);
1305
1306     need_len = (unsigned) (strlen(leader) + strlen(conn->error_buf) + 12);
1307     _buf_alloc(&conn->errdetail_buf, &conn->errdetail_buf_len, need_len);
1308
1309     snprintf(conn->errdetail_buf, need_len, "%s%s", leader, conn->error_buf);
1310
1311     return conn->errdetail_buf;
1312 }
1313
1314
1315 /* Note that this needs the global callbacks, so if you don't give getcallbacks
1316  * a sasl_conn_t, you're going to need to pass it yourself (or else we couldn't
1317  * have client and server at the same time */
1318 static int _sasl_global_getopt(void *context,
1319                                const char *plugin_name,
1320                                const char *option,
1321                                const char ** result,
1322                                unsigned *len)
1323 {
1324   const sasl_global_callbacks_t * global_callbacks;
1325   const sasl_callback_t *callback;
1326
1327   global_callbacks = (const sasl_global_callbacks_t *) context;
1328
1329   if (global_callbacks && global_callbacks->callbacks) {
1330       for (callback = global_callbacks->callbacks;
1331            callback->id != SASL_CB_LIST_END;
1332            callback++) {
1333         if (callback->id == SASL_CB_GETOPT) {
1334           if (!callback->proc) return SASL_FAIL;
1335           if (((sasl_getopt_t *)(callback->proc))(callback->context,
1336                                                   plugin_name,
1337                                                   option,
1338                                                   result,
1339                                                   len)
1340               == SASL_OK)
1341             return SASL_OK;
1342         }
1343       }
1344   }
1345
1346   /* look it up in our configuration file */
1347   *result = sasl_config_getstring(option, NULL);
1348   if (*result != NULL) {
1349       if (len) { *len = (unsigned) strlen(*result); }
1350       return SASL_OK;
1351   }
1352
1353   return SASL_FAIL;
1354 }
1355
1356 static int
1357 _sasl_conn_getopt(void *context,
1358                   const char *plugin_name,
1359                   const char *option,
1360                   const char ** result,
1361                   unsigned *len)
1362 {
1363   sasl_conn_t * conn;
1364   const sasl_callback_t *callback;
1365
1366   if (! context)
1367     return SASL_BADPARAM;
1368
1369   conn = (sasl_conn_t *) context;
1370
1371   if (conn->callbacks)
1372     for (callback = conn->callbacks;
1373          callback->id != SASL_CB_LIST_END;
1374          callback++)
1375       if (callback->id == SASL_CB_GETOPT
1376           && (((sasl_getopt_t *)(callback->proc))(callback->context,
1377                                                   plugin_name,
1378                                                   option,
1379                                                   result,
1380                                                   len)
1381               == SASL_OK))
1382         return SASL_OK;
1383
1384   /* If we made it here, we didn't find an appropriate callback
1385    * in the connection's callback list, or the callback we did
1386    * find didn't return SASL_OK.  So we attempt to use the
1387    * global callback for this connection... */
1388   return _sasl_global_getopt((void *)conn->global_callbacks,
1389                              plugin_name,
1390                              option,
1391                              result,
1392                              len);
1393 }
1394
1395 #ifdef HAVE_SYSLOG
1396 /* this is the default logging */
1397 static int _sasl_syslog(void *context,
1398                         int priority,
1399                         const char *message)
1400 {
1401     int syslog_priority;
1402     sasl_server_conn_t *sconn;
1403
1404     if (context) {
1405         if (((sasl_conn_t *)context)->type == SASL_CONN_SERVER) {
1406             sconn = (sasl_server_conn_t *)context;
1407             if (sconn->sparams->log_level < priority)
1408                 return SASL_OK;
1409         }
1410     }
1411
1412     /* set syslog priority */
1413     switch(priority) {
1414     case SASL_LOG_NONE:
1415         return SASL_OK;
1416         break;
1417     case SASL_LOG_ERR:
1418         syslog_priority = LOG_ERR;
1419         break;
1420     case SASL_LOG_WARN:
1421         syslog_priority = LOG_WARNING;
1422         break;
1423     case SASL_LOG_NOTE:
1424     case SASL_LOG_FAIL:
1425         syslog_priority = LOG_NOTICE;
1426         break;
1427     case SASL_LOG_PASS:
1428     case SASL_LOG_TRACE:
1429     case SASL_LOG_DEBUG:
1430     default:
1431         syslog_priority = LOG_DEBUG;
1432         break;
1433     }
1434
1435     /* do the syslog call. Do not need to call openlog? */
1436     syslog(syslog_priority | LOG_AUTH, "%s", message);
1437
1438     return SASL_OK;
1439 }
1440 #endif                          /* HAVE_SYSLOG */
1441
1442 static int
1443 _sasl_getsimple(void *context,
1444                 int id,
1445                 const char ** result,
1446                 size_t *len)
1447 {
1448   const char *userid;
1449   sasl_conn_t *conn;
1450
1451   if (! context || ! result) return SASL_BADPARAM;
1452
1453   conn = (sasl_conn_t *)context;
1454
1455   switch(id) {
1456   case SASL_CB_AUTHNAME:
1457     userid = getenv("USER");
1458     if (userid != NULL) {
1459         *result = userid;
1460         if (len) *len = strlen(userid);
1461         return SASL_OK;
1462     }
1463     userid = getenv("USERNAME");
1464     if (userid != NULL) {
1465         *result = userid;
1466         if (len) *len = strlen(userid);
1467         return SASL_OK;
1468     }
1469 #ifdef WIN32
1470     /* for win32, try using the GetUserName standard call */
1471     {
1472         DWORD i;
1473         BOOL rval;
1474         static char sender[128];
1475
1476         i = sizeof(sender);
1477         rval = GetUserName(sender, &i);
1478         if ( rval) { /* got a userid */
1479                 *result = sender;
1480                 if (len) *len = strlen(sender);
1481                 return SASL_OK;
1482         }
1483     }
1484 #endif /* WIN32 */
1485     return SASL_FAIL;
1486   default:
1487     return SASL_BADPARAM;
1488   }
1489 }
1490
1491 static int
1492 _sasl_getpath(void *context __attribute__((unused)),
1493               const char ** path_dest)
1494 {
1495 #if !defined(WIN32)
1496     char *path;
1497 #endif
1498     int res = SASL_OK;
1499
1500     if (! path_dest) {
1501         return SASL_BADPARAM;
1502     }
1503
1504     /* Only calculate the path once. */
1505     if (default_plugin_path == NULL) {
1506
1507 #if defined(WIN32)
1508         /* NB: On Windows platforms this value is always allocated */
1509         default_plugin_path = _sasl_get_default_win_path(context,
1510                                                          SASL_PLUGIN_PATH_ATTR,
1511                                                          PLUGINDIR);
1512 #else
1513         /* NB: On Unix platforms this value is never allocated */
1514         path = _sasl_get_default_unix_path(context,
1515                                            SASL_PATH_ENV_VAR,
1516                                            PLUGINDIR);
1517
1518         res = _sasl_strdup(path, &default_plugin_path, NULL);
1519 #endif
1520     }
1521
1522     if (res == SASL_OK) {
1523         *path_dest = default_plugin_path;
1524     }
1525
1526     return res;
1527 }
1528
1529 static int
1530 _sasl_getpath_simple(void *context __attribute__((unused)),
1531                      const char **path)
1532 {
1533     if (! path) {
1534         return SASL_BADPARAM;
1535     }
1536
1537     if (default_plugin_path == NULL) {
1538         return SASL_FAIL;
1539     }
1540
1541     *path = default_plugin_path;
1542
1543     return SASL_OK;
1544 }
1545
1546 static int
1547 _sasl_getconfpath(void *context __attribute__((unused)),
1548                   char ** path_dest)
1549 {
1550 #if !defined(WIN32)
1551     char *path;
1552 #endif
1553     int res = SASL_OK;
1554
1555     if (! path_dest) {
1556         return SASL_BADPARAM;
1557     }
1558
1559   /* Only calculate the path once. */
1560     if (default_conf_path == NULL) {
1561
1562 #if defined(WIN32)
1563         /* NB: On Windows platforms this value is always allocated */
1564         default_conf_path = _sasl_get_default_win_path(context,
1565                                                        SASL_CONF_PATH_ATTR,
1566                                                        CONFIGDIR);
1567 #else
1568         /* NB: On Unix platforms this value is never allocated */
1569         path = _sasl_get_default_unix_path(context,
1570                                            SASL_CONF_PATH_ENV_VAR,
1571                                            CONFIGDIR);
1572
1573         res = _sasl_strdup(path, &default_conf_path, NULL);
1574 #endif
1575     }
1576
1577     if (res == SASL_OK) {
1578         *path_dest = default_conf_path;
1579     }
1580
1581     return res;
1582 }
1583
1584 static int
1585 _sasl_getconfpath_simple(void *context __attribute__((unused)),
1586                          const char **path)
1587 {
1588     if (! path) {
1589         return SASL_BADPARAM;
1590     }
1591
1592     if (default_conf_path == NULL) {
1593         return SASL_FAIL;
1594     }
1595
1596     *path = default_conf_path;
1597
1598     return SASL_OK;
1599 }
1600
1601 static int
1602 _sasl_verifyfile(void *context __attribute__((unused)),
1603                  char *file  __attribute__((unused)),
1604                  int type  __attribute__((unused)))
1605 {
1606   /* always say ok */
1607   return SASL_OK;
1608 }
1609
1610
1611 static int
1612 _sasl_proxy_policy(sasl_conn_t *conn,
1613                    void *context __attribute__((unused)),
1614                    const char *requested_user, unsigned rlen,
1615                    const char *auth_identity, unsigned alen,
1616                    const char *def_realm __attribute__((unused)),
1617                    unsigned urlen __attribute__((unused)),
1618                    struct propctx *propctx __attribute__((unused)))
1619 {
1620     if (!conn)
1621         return SASL_BADPARAM;
1622
1623     if (!requested_user || *requested_user == '\0')
1624         return SASL_OK;
1625
1626     if (!auth_identity || !requested_user || rlen != alen ||
1627         (memcmp(auth_identity, requested_user, rlen) != 0)) {
1628         sasl_seterror(conn, 0,
1629                       "Requested identity not authenticated identity");
1630         RETURN(conn, SASL_BADAUTH);
1631     }
1632
1633     return SASL_OK;
1634 }
1635
1636 int _sasl_getcallback(sasl_conn_t * conn,
1637                       unsigned long callbackid,
1638                       int (**pproc)(),
1639                       void **pcontext)
1640 {
1641   const sasl_callback_t *callback;
1642
1643   if (!pproc || !pcontext)
1644       PARAMERROR(conn);
1645
1646   /* Some callbacks are always provided by the library */
1647   switch (callbackid) {
1648   case SASL_CB_LIST_END:
1649     /* Nothing ever gets to provide this */
1650       INTERROR(conn, SASL_FAIL);
1651   case SASL_CB_GETOPT:
1652       if (conn) {
1653           *pproc = &_sasl_conn_getopt;
1654           *pcontext = conn;
1655       } else {
1656           *pproc = &_sasl_global_getopt;
1657           *pcontext = NULL;
1658       }
1659       return SASL_OK;
1660   }
1661
1662   /* If it's not always provided by the library, see if there's
1663    * a version provided by the application for this connection... */
1664   if (conn && conn->callbacks) {
1665     for (callback = conn->callbacks; callback->id != SASL_CB_LIST_END;
1666          callback++) {
1667         if (callback->id == callbackid) {
1668             *pproc = callback->proc;
1669             *pcontext = callback->context;
1670             if (callback->proc) {
1671                 return SASL_OK;
1672             } else {
1673                 return SASL_INTERACT;
1674             }
1675         }
1676     }
1677   }
1678
1679   /* And, if not for this connection, see if there's one
1680    * for all {server,client} connections... */
1681   if (conn && conn->global_callbacks && conn->global_callbacks->callbacks) {
1682       for (callback = conn->global_callbacks->callbacks;
1683            callback->id != SASL_CB_LIST_END;
1684            callback++) {
1685           if (callback->id == callbackid) {
1686               *pproc = callback->proc;
1687               *pcontext = callback->context;
1688               if (callback->proc) {
1689                   return SASL_OK;
1690               } else {
1691                   return SASL_INTERACT;
1692               }
1693           }
1694       }
1695   }
1696
1697   /* Otherwise, see if the library provides a default callback. */
1698   switch (callbackid) {
1699 #ifdef HAVE_SYSLOG
1700   case SASL_CB_LOG:
1701     *pproc = (int (*)()) &_sasl_syslog;
1702     *pcontext = conn;
1703     return SASL_OK;
1704 #endif /* HAVE_SYSLOG */
1705   case SASL_CB_GETPATH:
1706     *pproc = default_getpath_cb.proc;
1707     *pcontext = default_getpath_cb.context;
1708     return SASL_OK;
1709   case SASL_CB_GETCONFPATH:
1710     *pproc = default_getconfpath_cb.proc;
1711     *pcontext = default_getconfpath_cb.context;
1712     return SASL_OK;
1713   case SASL_CB_AUTHNAME:
1714     *pproc = (int (*)()) &_sasl_getsimple;
1715     *pcontext = conn;
1716     return SASL_OK;
1717   case SASL_CB_VERIFYFILE:
1718     *pproc = & _sasl_verifyfile;
1719     *pcontext = NULL;
1720     return SASL_OK;
1721   case SASL_CB_PROXY_POLICY:
1722     *pproc = (int (*)()) &_sasl_proxy_policy;
1723     *pcontext = NULL;
1724     return SASL_OK;
1725   }
1726
1727   /* Unable to find a callback... */
1728   *pproc = NULL;
1729   *pcontext = NULL;
1730   sasl_seterror(conn, SASL_NOLOG, "Unable to find a callback: %d", callbackid);
1731   RETURN(conn,SASL_FAIL);
1732 }
1733
1734
1735 /*
1736  * This function is typically called from a plugin.
1737  * It creates a string from the formatting and varargs given
1738  * and calls the logging callback (syslog by default)
1739  *
1740  * %m will parse the value in the next argument as an errno string
1741  * %z will parse the next argument as a SASL error code.
1742  */
1743
1744 void
1745 _sasl_log (sasl_conn_t *conn,
1746            int level,
1747            const char *fmt,
1748            ...)
1749 {
1750   char *out=(char *) sasl_ALLOC(250);
1751   size_t alloclen=100; /* current allocated length */
1752   size_t outlen=0; /* current length of output buffer */
1753   size_t formatlen;
1754   size_t pos=0; /* current position in format string */
1755   int result;
1756   sasl_log_t *log_cb;
1757   void *log_ctx;
1758
1759   int ival;
1760   unsigned int uval;
1761   char *cval;
1762   va_list ap; /* varargs thing */
1763
1764   if(!fmt) goto done;
1765   if(!out) return;
1766
1767   formatlen = strlen(fmt);
1768
1769   /* See if we have a logging callback... */
1770   result = _sasl_getcallback(conn, SASL_CB_LOG, &log_cb, &log_ctx);
1771   if (result == SASL_OK && ! log_cb)
1772     result = SASL_FAIL;
1773   if (result != SASL_OK) goto done;
1774
1775   va_start(ap, fmt); /* start varargs */
1776
1777   while(pos<formatlen)
1778   {
1779     if (fmt[pos]!='%') /* regular character */
1780     {
1781       result = _buf_alloc(&out, &alloclen, outlen+1);
1782       if (result != SASL_OK) goto done;
1783       out[outlen]=fmt[pos];
1784       outlen++;
1785       pos++;
1786
1787     } else { /* formating thing */
1788       int done=0;
1789       char frmt[10];
1790       int frmtpos=1;
1791       char tempbuf[21];
1792       frmt[0]='%';
1793       pos++;
1794
1795       while (done==0)
1796       {
1797         switch(fmt[pos])
1798           {
1799           case 's': /* need to handle this */
1800             cval = va_arg(ap, char *); /* get the next arg */
1801             result = _sasl_add_string(&out, &alloclen,
1802                                 &outlen, cval);
1803
1804             if (result != SASL_OK) /* add the string */
1805                 goto done;
1806
1807             done=1;
1808             break;
1809
1810           case '%': /* double % output the '%' character */
1811             result = _buf_alloc(&out,&alloclen,outlen+1);
1812             if (result != SASL_OK)
1813                 goto done;
1814
1815             out[outlen]='%';
1816             outlen++;
1817             done=1;
1818             break;
1819
1820           case 'm': /* insert the errno string */
1821             result = _sasl_add_string(&out, &alloclen, &outlen,
1822                                 strerror(va_arg(ap, int)));
1823             if (result != SASL_OK)
1824                 goto done;
1825
1826             done=1;
1827             break;
1828
1829           case 'z': /* insert the sasl error string */
1830             result = _sasl_add_string(&out, &alloclen, &outlen,
1831                                 (char *) sasl_errstring(va_arg(ap, int),NULL,NULL));
1832             if (result != SASL_OK)
1833                 goto done;
1834
1835             done=1;
1836             break;
1837
1838           case 'c':
1839             frmt[frmtpos++]=fmt[pos];
1840             frmt[frmtpos]=0;
1841             tempbuf[0] = (char) va_arg(ap, int); /* get the next arg */
1842             tempbuf[1]='\0';
1843
1844             /* now add the character */
1845             result = _sasl_add_string(&out, &alloclen, &outlen, tempbuf);
1846             if (result != SASL_OK)
1847                 goto done;
1848
1849             done=1;
1850             break;
1851
1852           case 'd':
1853           case 'i':
1854             frmt[frmtpos++]=fmt[pos];
1855             frmt[frmtpos]=0;
1856             ival = va_arg(ap, int); /* get the next arg */
1857
1858             snprintf(tempbuf,20,frmt,ival); /* have snprintf do the work */
1859             /* now add the string */
1860             result = _sasl_add_string(&out, &alloclen, &outlen, tempbuf);
1861             if (result != SASL_OK)
1862                 goto done;
1863
1864             done=1;
1865             break;
1866
1867           case 'o':
1868           case 'u':
1869           case 'x':
1870           case 'X':
1871             frmt[frmtpos++]=fmt[pos];
1872             frmt[frmtpos]=0;
1873             uval = va_arg(ap, unsigned int); /* get the next arg */
1874
1875             snprintf(tempbuf,20,frmt,uval); /* have snprintf do the work */
1876             /* now add the string */
1877             result = _sasl_add_string(&out, &alloclen, &outlen, tempbuf);
1878             if (result != SASL_OK)
1879                 goto done;
1880
1881             done=1;
1882             break;
1883
1884           default:
1885             frmt[frmtpos++]=fmt[pos]; /* add to the formating */
1886             frmt[frmtpos]=0;
1887             if (frmtpos>9)
1888               done=1;
1889           }
1890         pos++;
1891         if (pos>formatlen)
1892           done=1;
1893       }
1894
1895     }
1896   }
1897
1898   /* put 0 at end */
1899   result = _buf_alloc(&out, &alloclen, outlen+1);
1900   if (result != SASL_OK) goto done;
1901   out[outlen]=0;
1902
1903   va_end(ap);
1904
1905   /* send log message */
1906   result = log_cb(log_ctx, level, out);
1907
1908  done:
1909   if(out) sasl_FREE(out);
1910 }
1911
1912
1913
1914 /* Allocate and Init a sasl_utils_t structure */
1915 sasl_utils_t *
1916 _sasl_alloc_utils(sasl_conn_t *conn,
1917                   sasl_global_callbacks_t *global_callbacks)
1918 {
1919   sasl_utils_t *utils;
1920   /* set util functions - need to do rest*/
1921   utils=sasl_ALLOC(sizeof(sasl_utils_t));
1922   if (utils==NULL)
1923     return NULL;
1924
1925   utils->conn = conn;
1926
1927   sasl_randcreate(&utils->rpool);
1928
1929   if (conn) {
1930     utils->getopt = &_sasl_conn_getopt;
1931     utils->getopt_context = conn;
1932   } else {
1933     utils->getopt = &_sasl_global_getopt;
1934     utils->getopt_context = global_callbacks;
1935   }
1936
1937   utils->malloc=_sasl_allocation_utils.malloc;
1938   utils->calloc=_sasl_allocation_utils.calloc;
1939   utils->realloc=_sasl_allocation_utils.realloc;
1940   utils->free=_sasl_allocation_utils.free;
1941
1942   utils->mutex_alloc = _sasl_mutex_utils.alloc;
1943   utils->mutex_lock = _sasl_mutex_utils.lock;
1944   utils->mutex_unlock = _sasl_mutex_utils.unlock;
1945   utils->mutex_free = _sasl_mutex_utils.free;
1946
1947   utils->MD5Init  = &_sasl_MD5Init;
1948   utils->MD5Update= &_sasl_MD5Update;
1949   utils->MD5Final = &_sasl_MD5Final;
1950   utils->hmac_md5 = &_sasl_hmac_md5;
1951   utils->hmac_md5_init = &_sasl_hmac_md5_init;
1952   utils->hmac_md5_final = &_sasl_hmac_md5_final;
1953   utils->hmac_md5_precalc = &_sasl_hmac_md5_precalc;
1954   utils->hmac_md5_import = &_sasl_hmac_md5_import;
1955   utils->mkchal = &sasl_mkchal;
1956   utils->utf8verify = &sasl_utf8verify;
1957   utils->rand=&sasl_rand;
1958   utils->churn=&sasl_churn;
1959   utils->checkpass=NULL;
1960
1961   utils->encode64=&sasl_encode64;
1962   utils->decode64=&sasl_decode64;
1963
1964   utils->erasebuffer=&sasl_erasebuffer;
1965
1966   utils->getprop=&sasl_getprop;
1967   utils->setprop=&sasl_setprop;
1968
1969   utils->getcallback=&_sasl_getcallback;
1970
1971   utils->log=&_sasl_log;
1972
1973   utils->seterror=&sasl_seterror;
1974
1975 #ifndef macintosh
1976   /* Aux Property Utilities */
1977   utils->prop_new=&prop_new;
1978   utils->prop_dup=&prop_dup;
1979   utils->prop_request=&prop_request;
1980   utils->prop_get=&prop_get;
1981   utils->prop_getnames=&prop_getnames;
1982   utils->prop_clear=&prop_clear;
1983   utils->prop_dispose=&prop_dispose;
1984   utils->prop_format=&prop_format;
1985   utils->prop_set=&prop_set;
1986   utils->prop_setvals=&prop_setvals;
1987   utils->prop_erase=&prop_erase;
1988   utils->auxprop_store=&sasl_auxprop_store;
1989 #endif
1990
1991   /* Spares */
1992   utils->spare_fptr = NULL;
1993   utils->spare_fptr1 = utils->spare_fptr2 = NULL;
1994
1995   return utils;
1996 }
1997
1998 int
1999 _sasl_free_utils(const sasl_utils_t ** utils)
2000 {
2001     sasl_utils_t *nonconst;
2002
2003     if(!utils) return SASL_BADPARAM;
2004     if(!*utils) return SASL_OK;
2005
2006     /* I wish we could avoid this cast, it's pretty gratuitous but it
2007      * does make life easier to have it const everywhere else. */
2008     nonconst = (sasl_utils_t *)(*utils);
2009
2010     sasl_randfree(&(nonconst->rpool));
2011     sasl_FREE(nonconst);
2012
2013     *utils = NULL;
2014     return SASL_OK;
2015 }
2016
2017 int sasl_idle(sasl_conn_t *conn)
2018 {
2019   if (! conn) {
2020     if (_sasl_server_idle_hook
2021         && _sasl_server_idle_hook(NULL))
2022       return 1;
2023     if (_sasl_client_idle_hook
2024         && _sasl_client_idle_hook(NULL))
2025       return 1;
2026     return 0;
2027   }
2028
2029   if (conn->idle_hook)
2030     return conn->idle_hook(conn);
2031
2032   return 0;
2033 }
2034
2035 static const sasl_callback_t *
2036 _sasl_find_callback_by_type (const sasl_callback_t *callbacks,
2037                              unsigned long id)
2038 {
2039     if (callbacks) {
2040         while (callbacks->id != SASL_CB_LIST_END) {
2041             if (callbacks->id == id) {
2042                 return callbacks;
2043             } else {
2044                 ++callbacks;
2045             }
2046         }
2047     }
2048     return NULL;
2049 }
2050
2051 const sasl_callback_t *
2052 _sasl_find_getpath_callback(const sasl_callback_t *callbacks)
2053 {
2054   callbacks = _sasl_find_callback_by_type (callbacks, SASL_CB_GETPATH);
2055   if (callbacks != NULL) {
2056     return callbacks;
2057   } else {
2058     return &default_getpath_cb;
2059   }
2060 }
2061
2062 const sasl_callback_t *
2063 _sasl_find_getconfpath_callback(const sasl_callback_t *callbacks)
2064 {
2065   callbacks = _sasl_find_callback_by_type (callbacks, SASL_CB_GETCONFPATH);
2066   if (callbacks != NULL) {
2067     return callbacks;
2068   } else {
2069     return &default_getconfpath_cb;
2070   }
2071 }
2072
2073 const sasl_callback_t *
2074 _sasl_find_verifyfile_callback(const sasl_callback_t *callbacks)
2075 {
2076   static const sasl_callback_t default_verifyfile_cb = {
2077     SASL_CB_VERIFYFILE,
2078     &_sasl_verifyfile,
2079     NULL
2080   };
2081
2082   callbacks = _sasl_find_callback_by_type (callbacks, SASL_CB_VERIFYFILE);
2083   if (callbacks != NULL) {
2084     return callbacks;
2085   } else {
2086     return &default_verifyfile_cb;
2087   }
2088 }
2089
2090 /* Basically a conditional call to realloc(), if we need more */
2091 int _buf_alloc(char **rwbuf, size_t *curlen, size_t newlen)
2092 {
2093     if(!(*rwbuf)) {
2094         *rwbuf = sasl_ALLOC((unsigned)newlen);
2095         if (*rwbuf == NULL) {
2096             *curlen = 0;
2097             return SASL_NOMEM;
2098         }
2099         *curlen = newlen;
2100     } else if(*rwbuf && *curlen < newlen) {
2101         size_t needed = 2*(*curlen);
2102
2103         while(needed < newlen)
2104             needed *= 2;
2105
2106         /* WARN - We will leak the old buffer on failure */
2107         *rwbuf = sasl_REALLOC(*rwbuf, (unsigned)needed);
2108
2109         if (*rwbuf == NULL) {
2110             *curlen = 0;
2111             return SASL_NOMEM;
2112         }
2113         *curlen = needed;
2114     }
2115
2116     return SASL_OK;
2117 }
2118
2119 /* for the mac os x cfm glue: this lets the calling function
2120    get pointers to the error buffer without having to touch the sasl_conn_t struct */
2121 void _sasl_get_errorbuf(sasl_conn_t *conn, char ***bufhdl, size_t **lenhdl)
2122 {
2123         *bufhdl = &conn->error_buf;
2124         *lenhdl = &conn->error_buf_len;
2125 }
2126
2127 /* convert an iovec to a single buffer */
2128 int _iovec_to_buf(const struct iovec *vec,
2129                   unsigned numiov, buffer_info_t **output)
2130 {
2131     unsigned i;
2132     int ret;
2133     buffer_info_t *out;
2134     char *pos;
2135
2136     if (!vec || !output) return SASL_BADPARAM;
2137
2138     if (!(*output)) {
2139         *output = sasl_ALLOC(sizeof(buffer_info_t));
2140         if (!*output) return SASL_NOMEM;
2141         memset(*output,0,sizeof(buffer_info_t));
2142     }
2143
2144     out = *output;
2145
2146     out->curlen = 0;
2147     for (i = 0; i < numiov; i++) {
2148         out->curlen += vec[i].iov_len;
2149     }
2150
2151     ret = _buf_alloc(&out->data, &out->reallen, out->curlen);
2152
2153     if (ret != SASL_OK) return SASL_NOMEM;
2154
2155     memset(out->data, 0, out->reallen);
2156     pos = out->data;
2157
2158     for (i = 0; i < numiov; i++) {
2159         memcpy(pos, vec[i].iov_base, vec[i].iov_len);
2160         pos += vec[i].iov_len;
2161     }
2162
2163     return SASL_OK;
2164 }
2165
2166 /* This code might be useful in the future, but it isn't now, so.... */
2167 #if 0
2168 int _sasl_iptostring(const struct sockaddr *addr, socklen_t addrlen,
2169                      char *out, unsigned outlen) {
2170     char hbuf[NI_MAXHOST], pbuf[NI_MAXSERV];
2171     int niflags;
2172
2173     if(!addr || !out) return SASL_BADPARAM;
2174
2175     niflags = (NI_NUMERICHOST | NI_NUMERICSERV);
2176 #ifdef NI_WITHSCOPEID
2177     if (addr->sa_family == AF_INET6)
2178         niflags |= NI_WITHSCOPEID;
2179 #endif
2180     if (getnameinfo(addr, addrlen, hbuf, sizeof(hbuf), pbuf, sizeof(pbuf),
2181                     niflags) != 0)
2182         return SASL_BADPARAM;
2183
2184     if(outlen < strlen(hbuf) + strlen(pbuf) + 2)
2185         return SASL_BUFOVER;
2186
2187     snprintf(out, outlen, "%s;%s", hbuf, pbuf);
2188
2189     return SASL_OK;
2190 }
2191 #endif
2192
2193 int _sasl_ipfromstring(const char *addr,
2194                        struct sockaddr *out, socklen_t outlen)
2195 {
2196     int i, j;
2197     struct addrinfo hints, *ai = NULL;
2198     char hbuf[NI_MAXHOST];
2199
2200     /* A NULL out pointer just implies we don't do a copy, just verify it */
2201
2202     if(!addr) return SASL_BADPARAM;
2203
2204     /* Parse the address */
2205     for (i = 0; addr[i] != '\0' && addr[i] != ';'; i++) {
2206         if (i >= NI_MAXHOST)
2207             return SASL_BADPARAM;
2208         hbuf[i] = addr[i];
2209     }
2210     hbuf[i] = '\0';
2211
2212     if (addr[i] == ';')
2213         i++;
2214     /* XXX: Do we need this check? */
2215     for (j = i; addr[j] != '\0'; j++)
2216         if (!isdigit((int)(addr[j])))
2217             return SASL_BADPARAM;
2218
2219     memset(&hints, 0, sizeof(hints));
2220     hints.ai_family = PF_UNSPEC;
2221     hints.ai_socktype = SOCK_STREAM;
2222     hints.ai_flags = AI_PASSIVE | AI_NUMERICHOST;
2223     if (getaddrinfo(hbuf, &addr[i], &hints, &ai) != 0)
2224         return SASL_BADPARAM;
2225
2226     if (out) {
2227         if (outlen < (socklen_t)ai->ai_addrlen) {
2228             freeaddrinfo(ai);
2229             return SASL_BUFOVER;
2230         }
2231         memcpy(out, ai->ai_addr, ai->ai_addrlen);
2232     }
2233
2234     freeaddrinfo(ai);
2235
2236     return SASL_OK;
2237 }
2238
2239 int _sasl_build_mechlist(void)
2240 {
2241     int count = 0;
2242     sasl_string_list_t *clist = NULL, *slist = NULL, *olist = NULL;
2243     sasl_string_list_t *p, *q, **last, *p_next;
2244
2245     clist = _sasl_client_mechs();
2246     slist = _sasl_server_mechs();
2247
2248     if(!clist) {
2249         olist = slist;
2250     } else {
2251         int flag;
2252
2253         /* append slist to clist, and set olist to clist */
2254         for(p = slist; p; p = p_next) {
2255             flag = 0;
2256             p_next = p->next;
2257
2258             last = &clist;
2259             for(q = clist; q; q = q->next) {
2260                 if(!strcmp(q->d, p->d)) {
2261                     /* They match, set the flag */
2262                     flag = 1;
2263                     break;
2264                 }
2265                 last = &(q->next);
2266             }
2267
2268             if(!flag) {
2269                 *last = p;
2270                 p->next = NULL;
2271             } else {
2272                 sasl_FREE(p);
2273             }
2274         }
2275
2276         olist = clist;
2277     }
2278
2279     if(!olist) {
2280         printf ("no olist");
2281         return SASL_FAIL;
2282     }
2283
2284     for (p = olist; p; p = p->next) count++;
2285
2286     if(global_mech_list) {
2287         sasl_FREE(global_mech_list);
2288         global_mech_list = NULL;
2289     }
2290
2291     global_mech_list = sasl_ALLOC((count + 1) * sizeof(char *));
2292     if(!global_mech_list) return SASL_NOMEM;
2293
2294     memset(global_mech_list, 0, (count + 1) * sizeof(char *));
2295
2296     count = 0;
2297     for (p = olist; p; p = p_next) {
2298         p_next = p->next;
2299
2300         global_mech_list[count++] = (char *) p->d;
2301
2302         sasl_FREE(p);
2303     }
2304
2305     return SASL_OK;
2306 }
2307
2308 const char ** sasl_global_listmech(void)
2309 {
2310     return (const char **)global_mech_list;
2311 }
2312
2313 int sasl_listmech(sasl_conn_t *conn,
2314                   const char *user,
2315                   const char *prefix,
2316                   const char *sep,
2317                   const char *suffix,
2318                   const char **result,
2319                   unsigned *plen,
2320                   int *pcount)
2321 {
2322     if(!conn) {
2323         return SASL_BADPARAM;
2324     } else if(conn->type == SASL_CONN_SERVER) {
2325         RETURN(conn, _sasl_server_listmech(conn, user, prefix, sep, suffix,
2326                                            result, plen, pcount));
2327     } else if (conn->type == SASL_CONN_CLIENT) {
2328         RETURN(conn, _sasl_client_listmech(conn, prefix, sep, suffix,
2329                                            result, plen, pcount));
2330     }
2331
2332     PARAMERROR(conn);
2333 }
2334
2335
2336 #ifndef WIN32
2337 static char *
2338 _sasl_get_default_unix_path(void *context __attribute__((unused)),
2339                             char * env_var_name,
2340                             char * default_value)
2341 {
2342     char *path = NULL;
2343
2344     /* Honor external variable only in a safe environment */
2345     if (getuid() == geteuid() && getgid() == getegid()) {
2346         path = getenv(env_var_name);
2347     }
2348     if (! path) {
2349         path = default_value;
2350     }
2351
2352     return path;
2353 }
2354
2355 #else
2356 /* Return NULL on failure */
2357 static char *
2358 _sasl_get_default_win_path(void *context __attribute__((unused)),
2359                            char * reg_attr_name,
2360                            char * default_value)
2361 {
2362     /* Open registry entry, and find all registered SASL libraries.
2363      *
2364      * Registry location:
2365      *
2366      *     SOFTWARE\\Carnegie Mellon\\Project Cyrus\\SASL Library
2367      *
2368      * Key - value:
2369      *
2370      *     "SearchPath" - value: PATH like (';' delimited) list
2371      *                    of directories where to search for plugins
2372      *                    The list may contain references to environment
2373      *                    variables (e.g. %PATH%).
2374      *
2375      */
2376     HKEY  hKey;
2377     DWORD ret;
2378     DWORD ValueType;                /* value type */
2379     DWORD cbData;                   /* value size */
2380     BYTE * ValueData;               /* value */
2381     DWORD cbExpandedData;           /* "expanded" value size */
2382     BYTE * ExpandedValueData;       /* "expanded" value */
2383     char * return_value;            /* function return value */
2384     char * tmp;
2385
2386     /* Initialization */
2387     ExpandedValueData = NULL;
2388     ValueData = NULL;
2389     return_value = NULL;
2390
2391     /* Open the registry */
2392     ret = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
2393                        SASL_ROOT_KEY,
2394                        0,
2395                        KEY_READ,
2396                        &hKey);
2397
2398     if (ret != ERROR_SUCCESS) {
2399         /* no registry entry */
2400         (void) _sasl_strdup (default_value, &return_value, NULL);
2401         return return_value;
2402     }
2403
2404     /* figure out value type and required buffer size */
2405     /* the size will include space for terminating NUL if required */
2406     RegQueryValueEx (hKey,
2407                      reg_attr_name,
2408                      NULL,          /* reserved */
2409                      &ValueType,
2410                      NULL,
2411                      &cbData);
2412
2413     /* Only accept string related types */
2414     if (ValueType != REG_EXPAND_SZ &&
2415         ValueType != REG_MULTI_SZ &&
2416         ValueType != REG_SZ) {
2417         return_value = NULL;
2418         goto CLEANUP;
2419     }
2420
2421     /* Any high water mark? */
2422     ValueData = sasl_ALLOC(cbData);
2423     if (ValueData == NULL) {
2424         return_value = NULL;
2425         goto CLEANUP;
2426     };
2427
2428     RegQueryValueEx (hKey,
2429                      reg_attr_name,
2430                      NULL,          /* reserved */
2431                      &ValueType,
2432                      ValueData,
2433                      &cbData);
2434
2435     switch (ValueType) {
2436     case REG_EXPAND_SZ:
2437         /* : A random starting guess */
2438         cbExpandedData = cbData + 1024;
2439         ExpandedValueData = sasl_ALLOC(cbExpandedData);
2440         if (ExpandedValueData == NULL) {
2441             return_value = NULL;
2442             goto CLEANUP;
2443         };
2444
2445         cbExpandedData = ExpandEnvironmentStrings(
2446                                                   ValueData,
2447                                                   ExpandedValueData,
2448                                                   cbExpandedData);
2449
2450         if (cbExpandedData == 0) {
2451             /* : GetLastError() contains the reason for failure */
2452             return_value = NULL;
2453             goto CLEANUP;
2454         }
2455
2456         /* : Must retry expansion with the bigger buffer */
2457         if (cbExpandedData > cbData + 1024) {
2458             /* : Memory leak here if can't realloc */
2459             ExpandedValueData = sasl_REALLOC(ExpandedValueData, cbExpandedData);
2460             if (ExpandedValueData == NULL) {
2461                 return_value = NULL;
2462                 goto CLEANUP;
2463             };
2464
2465             cbExpandedData = ExpandEnvironmentStrings(
2466                                                       ValueData,
2467                                                       ExpandedValueData,
2468                                                       cbExpandedData);
2469
2470             /* : This should not happen */
2471             if (cbExpandedData == 0) {
2472                 /* : GetLastError() contains the reason for failure */
2473                 return_value = NULL;
2474                 goto CLEANUP;
2475             }
2476         }
2477
2478         sasl_FREE(ValueData);
2479         ValueData = ExpandedValueData;
2480         /* : This is to prevent automatical freeing of this block on cleanup */
2481         ExpandedValueData = NULL;
2482
2483         break;
2484
2485     case REG_MULTI_SZ:
2486         tmp = ValueData;
2487
2488         /* : We shouldn't overflow here, as the buffer is guarantied
2489            : to contain at least two consequent NULs */
2490         while (1) {
2491             if (tmp[0] == '\0') {
2492                 /* : Stop the process if we found the end of the string (two consequent NULs) */
2493                 if (tmp[1] == '\0') {
2494                     break;
2495                 }
2496
2497                 /* : Replace delimiting NUL with our delimiter characted */
2498                 tmp[0] = PATHS_DELIMITER;
2499             }
2500             tmp += strlen(tmp);
2501         }
2502         break;
2503
2504     case REG_SZ:
2505         /* Do nothing, it is good as is */
2506         break;
2507
2508     default:
2509         return_value = NULL;
2510         goto CLEANUP;
2511     }
2512
2513     return_value = ValueData;
2514
2515 CLEANUP:
2516     RegCloseKey(hKey);
2517     if (ExpandedValueData != NULL) sasl_FREE(ExpandedValueData);
2518     if (return_value == NULL) {
2519         if (ValueData != NULL) sasl_FREE(ValueData);
2520     }
2521
2522     return (return_value);
2523 }
2524 #endif