Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_server_init (3sasl)

Name

sasl_server_init - SASL server authentication initialization

Synopsis

#include <sasl/sasl.h>

int sasl_server_init(const sasl_callback_t *callbacks,
const char *appname);

Description

sasl_server_init(3sasl)         SASL man pages         sasl_server_init(3sasl)



NAME
       sasl_server_init - SASL server authentication initialization



SYNOPSIS
       #include <sasl/sasl.h>

       int sasl_server_init(const sasl_callback_t *callbacks,
                            const char *appname);


DESCRIPTION
       sasl_server_init() initializes SASL. It must be called before any calls
       to sasl_server_start, and only once per process.  This call initializes
       all  SASL mechanism drivers (e.g. authentication mechanisms). These are
       usually found in the /usr/lib/sasl2 directory but the directory may  be
       overridden  with  the  SASL_PATH  environment  variable  (or at compile
       time).

       callbacks specifies the base callbacks for all client connections.  See
       the sasl_callbacks man page for more information.

       appname  is  the  name of the application. It is used for where to find
       the default configuration file.

RETURN VALUE
       sasl_server_init returns an integer which corresponds  to  one  of  the
       SASL  error  codes. SASL_OK is the only one that indicates success. All
       others indicate errors and should either be handled or the  authentica-
       tion session should be quit.


CONFORMING TO
       RFC 4422


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------------------+
       |ATTRIBUTE TYPE |         ATTRIBUTE VALUE          |
       +---------------+----------------------------------+
       |Availability   | system/library/security/libsasl2 |
       +---------------+----------------------------------+
       |Stability      | Pass-through volatile            |
       +---------------+----------------------------------+

SEE ALSO
       sasl(3SASL),         sasl_callbacks(3SASL),         sasl_errors(3SASL),
       sasl_server_new(3SASL),                       sasl_server_start(3SASL),
       sasl_server_step(3SASL)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source  was  downloaded from  ftp://ftp.cyrusimap.org/cyrus-sasl/cyrus-
       sasl-2.1.26.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.cyrusimap.org/sasl/.



SASL                             10 July 2001          sasl_server_init(3sasl)