man/sasl_client_init.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2001 Carnegie Mellon University.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\"
  17 .\" 3. The name "Carnegie Mellon University" must not be used to
  18 .\"    endorse or promote products derived from this software without
  19 .\"    prior written permission. For permission or any other legal
  20 .\"    details, please contact
  21 .\"      Office of Technology Transfer
  22 .\"      Carnegie Mellon University
  23 .\"      5000 Forbes Avenue
  24 .\"      Pittsburgh, PA  15213-3890
  25 .\"      (412) 268-4387, fax: (412) 268-7395
  26 .\"      tech-transfer@andrew.cmu.edu
  27 .\"
  28 .\" 4. Redistributions of any form whatsoever must retain the following
  29 .\"    acknowledgment:
  30 .\"    "This product includes software developed by Computing Services
  31 .\"     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
  32 .\"
  33 .\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  34 .\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  35 .\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  36 .\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  37 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  38 .\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  39 .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  40 .\"
  41 .TH sasl_client_init "21 June 2001" SASL "SASL man pages"
  42 .SH NAME
  43 sasl_client_init \- SASL client authentication initialization
  44
  45
  46 .SH SYNOPSIS
  47 .nf
  48 .B #include <sasl/sasl.h>
  49 .sp
  50 .BI "int sasl_client_init(const  sasl_callback_t " *callbacks ");"
  51
  52 .fi
  53 .SH DESCRIPTION
  54
  55 .B sasl_client_init()
  56 initializes SASL. It must be called before any calls to
  57 sasl_client_start. This call initializes all SASL client drivers
  58 (e.g. authentication mechanisms). These are usually found in the
  59 /usr/lib/sasl2 directory but the directory may be overridden with the
  60 SASL_PATH environment variable.
  61 .PP
  62 .I callbacks
  63 specifies the base callbacks for all client connections. See the sasl_callbacks man page for more information
  64 .SH "RETURN VALUE"
  65 sasl_client_init returns an integer which corresponds to one of the
  66 following codes. SASL_OK is the only one that indicates success. All
  67 others indicate errors and should either be handled or the
  68 authentication session should be quit.
  69
  70
  71 .SH ERRORS
  72 .TP 0.8i
  73 .B SASL_OK
  74 Success
  75 .TP 0.8i
  76 .B SASL_BADVERS
  77 Mechanism version mismatch
  78 .TP 0.8i
  79 .B SASL_BADPARAM
  80 Error in config file
  81 .TP 0.8i
  82 .B SASL_NOMEM
  83 Not enough memory to complete operation
  84
  85 .SH "CONFORMING TO"
  86 RFC 2222
  87 .SH "SEE ALSO"
  88 sasl(3), sasl_callbacks(3), sasl_client_new(3), sasl_client_start(3), sasl_client_step(3)