1.. saslman:: sasl_server_init(3)
2
3.. _sasl-reference-manpages-library-sasl_server_init:
4
5
6================================================================
7**sasl_server_init** - SASL server authentication initialization
8================================================================
9
10Synopsis
11========
12
13.. code-block:: C
14
15    #include <sasl/sasl.h>
16
17    int sasl_server_init(const sasl_callback_t *callbacks,
18                         const char *appname);
19
20Description
21===========
22
23.. c:function:: int sasl_server_init(const sasl_callback_t *callbacks,
24                     const char *appname);
25
26    **sasl_server_init()** initializes SASL.  It  must  be  called
27    before  any  calls to sasl_server_start, and only once per
28    process.  This call initializes all SASL mechanism drivers
29    (e.g.  authentication mechanisms). These are usually found
30    in the /usr/lib/sasl2 directory but the directory  may  be
31    overridden  with the SASL_PATH environment variable (or at
32    compile time).
33
34    :param callbacks: specifies the base callbacks for all client connections.
35        See the :saslman:`sasl_callbacks(3)` man page for more information.
36
37    :param appname: is the name of the application.  It  is  used to find the
38        default configuration file.
39
40Return Value
41============
42
43SASL  callback  functions should return SASL return codes.
44See sasl.h for a complete list. :c:macro:`SASL_OK` indicates success.
45
46Other return codes indicate errors and should either be handled or the authentication
47session should be quit.
48
49See Also
50========
51
52:rfc:`4422`,:saslman:`sasl(3)`, :saslman:`sasl_callbacks(3)`,
53:saslman:`sasl_server_new(3)`, :saslman:`sasl_server_start(3)`,
54:saslman:`sasl_server_step(3)`, :saslman:`sasl_errors(3)`
55