xref: /illumos-gate/usr/src/man/man3sasl/sasl_server_init.3sasl (revision 311330e6823a3a919ff127757c2f0cf9eb17aa0e)
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_SERVER_INIT 3SASL "Oct 22, 2003"
NAME
sasl_server_init - SASL server authentication initialization
SYNOPSIS

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

int sasl_server_init(const sasl_callback *callbacks, const char *appname);
DESCRIPTION

Use the sasl_server_init() interface to initialize SASL. You must call sasl_server_init() before you make a call to sasl_server_start(). sasl_server_init() may be called only once per process. A call to sasl_server_init() initializes all SASL mechanism drivers, that is, the authentication mechanisms. The SASL mechanism drivers are usually found in the /usr/lib/sasl directory.

PARAMETERS
callbacks

Specifies the base callbacks for all client connections.

appname

The name of the application for lower level logging. For example, the sendmail server calls appname this way:

sasl_server_init(srvcallbacks, "Sendmail")
RETURN VALUES

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

ERRORS
SASL_OK

The call to sasl_server_init() was successful.

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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level Unsafe
SEE ALSO

sasl_errors (3SASL), attributes (7)

NOTES

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