usr/src/man/man3sasl/sasl_client_init.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_CLIENT_INIT 3SASL "Oct 22, 2003"
   9 .SH NAME
  10 sasl_client_init \- initialize SASL client authentication
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBint\fR \fBsasl_client_init\fR(\fBconst sasl_callback_t *\fR\fIcallbacks\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 Use the \fBsasl_client_init()\fR interface to initialize SASL. The
  24 \fBsasl_client_init()\fR interface must be called before any calls to
  25 \fBsasl_client_start\fR(3SASL). The call to \fBsasl_client_init()\fR
  26 initiallizes all SASL client drivers, for example, authentication mechanisms.
  27 SASL client drivers are usually found in the \fB/usr/lib/sasl\fR directory.
  28 .SH PARAMETERS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIcallbacks\fR\fR
  33 .ad
  34 .RS 13n
  35 Specifies the base callbacks for all client connections.
  36 .RE
  37
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41 \fBsasl_client_init()\fR returns an integer that corresponds to a SASL error
  42 code.
  43 .SH ERRORS
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBSASL_OK\fR\fR
  48 .ad
  49 .RS 17n
  50 The call to \fBsasl_client_init()\fR was successful.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBSASL_BADVERS\fR\fR
  57 .ad
  58 .RS 17n
  59 There is a mismatch in the mechanism version.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBSASL_BADPARAM\fR\fR
  66 .ad
  67 .RS 17n
  68 There is an error in the configuration file.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBSASL_NOMEM\fR\fR
  75 .ad
  76 .RS 17n
  77 There is not enough memory to complete the operation.
  78 .RE
  79
  80 .sp
  81 .LP
  82 All other error codes indicate an error situation that must be handled, or the
  83 authentication session should be quit. See \fBsasl_errors\fR(3SASL) for
  84 information on SASL error codes.
  85 .SH ATTRIBUTES
  86 .sp
  87 .LP
  88 See \fBattributes\fR(5) for descriptions of the following attributes:
  89 .sp
  90
  91 .sp
  92 .TS
  93 box;
  94 c | c
  95 l | l .
  96 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  97 _
  98 Interface Stability     Evolving
  99 _
 100 MT-Level        Unsafe
 101 .TE
 102
 103 .SH SEE ALSO
 104 .sp
 105 .LP
 106 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)
 107 .SH NOTES
 108 .sp
 109 .LP
 110 While most of \fBlibsasl\fR is MT-Safe, no other \fBlibsasl\fR function should
 111 be called until this function completes.