Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_client_init (3sasl)

Name

sasl_client_init - SASL client authentication initialization

Synopsis

#include <sasl/sasl.h>

int sasl_client_init(const  sasl_callback_t *callbacks);

Description

sasl_client_init(3sasl)         SASL man pages         sasl_client_init(3sasl)



NAME
       sasl_client_init - SASL client authentication initialization



SYNOPSIS
       #include <sasl/sasl.h>

       int sasl_client_init(const  sasl_callback_t *callbacks);


DESCRIPTION
       sasl_client_init() initializes SASL. It must be called before any calls
       to sasl_client_start. This call initializes  all  SASL  client  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.

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

RETURN VALUE
       sasl_client_init returns an integer which corresponds  to  one  of  the
       following  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.



ERRORS
       SASL_OK Success

       SASL_BADVERS
               Mechanism version mismatch

       SASL_BADPARAM
               Error in config file

       SASL_NOMEM
               Not enough memory to complete operation


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_client_new(3SASL),
       sasl_client_start(3SASL), sasl_client_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                             21 June 2001          sasl_client_init(3sasl)