File: sasl_server_init.rst.txt

package info (click to toggle)
cyrus-sasl2 2.1.27%2Bdfsg-2.1%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 19,940 kB
  • sloc: ansic: 58,942; javascript: 8,745; sh: 4,843; java: 1,614; xml: 1,498; makefile: 1,265; python: 342; perl: 199
file content (54 lines) | stat: -rw-r--r-- 1,743 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
.. saslman:: sasl_server_init(3)

.. _sasl-reference-manpages-library-sasl_server_init:


================================================================
**sasl_server_init** - SASL server authentication initialization
================================================================

Synopsis
========

.. code-block:: C

    #include <sasl/sasl.h>

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

Description
===========

.. c:function:: int sasl_server_init(const sasl_callback_t *callbacks,
                     const char *appname);

    **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).

    :param callbacks: specifies the base callbacks for all client connections.
        See the :saslman:`sasl_callbacks(3)` man page for more information.

    :param appname: is the name of the application.  It  is  used to find the
        default configuration file.

Return Value
============

SASL  callback  functions should return SASL return codes.
See sasl.h for a complete list. :c:macro:`SASL_OK` indicates success.

Other return codes indicate errors and should either be handled or the authentication
session should be quit.

See Also
========

:rfc:`4422`,:saslman:`sasl(3)`, :saslman:`sasl_callbacks(3)`,
:saslman:`sasl_server_new(3)`, :saslman:`sasl_server_start(3)`,
:saslman:`sasl_server_step(3)`, :saslman:`sasl_errors(3)`