xref: /titanic_41/usr/src/man/man3sasl/sasl_client_init.3sasl (revision b8afd3a780ce850ff107bb3be330465bf47f84bd) 
 te
 Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved.
 Portions Copyright (C) 2003, Sun Microsystems,
 Inc. All Rights Reserved
 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.
 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.
 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]
 sasl_client_init 3SASL "22 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
 NAME
sasl_client_init - initialize SASL client authentication

 SYNOPSIS


cc [ flag ... ] file ... -lsasl [ library ... ]
#include <sasl/sasl.h>

int sasl_client_init(const sasl_callback_t *callbacks);




 DESCRIPTION

Use the sasl_client_init() interface to initialize SASL. The
sasl_client_init() interface must be called before any calls to
sasl_client_start(3SASL). The call to sasl_client_init()
initiallizes all SASL client drivers, for example, authentication mechanisms.
SASL client drivers are usually found in the /usr/lib/sasl directory.

 PARAMETERS

callbacks


Specifies the base callbacks for all client connections.




 RETURN VALUES

sasl_client_init() returns an integer that corresponds to a SASL error
code.

 ERRORS

SASL_OK


The call to sasl_client_init() was successful.





SASL_BADVERS


There is a mismatch in the mechanism version.





SASL_BADPARAM


There is an error in the configuration file.





SASL_NOMEM


There is not enough memory to complete the operation.





All other error codes indicate an error situation that must be handled, or the
authentication session should be quit. See sasl_errors(3SASL) for
information on SASL error codes.

 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelUnsafe



 SEE ALSO

sasl_errors(3SASL), attributes(5)

 NOTES

While most of libsasl is MT-Safe, no other libsasl function should
be called until this function completes.