sasl_callbacks(3)

1sasl_callbacks(3)               SASL man pages               sasl_callbacks(3)
2
3
4

NAME

6       sasl_callbacks - How to work with SASL callbacks
7
8

SYNOPSIS

10       #include <sasl/sasl.h>
11
12

DESCRIPTION

14       sasl_callbacks  are  used  when  the application needs some information
15       from the application. Common reasons are getting for getting  usernames
16       and passwords. A client MUST specify what callbacks they support in the
17       sasl_client/server_init()  or  sasl_client/server_new()  calls.  If  an
18       authentication mechanism needs a callback that the application does not
19       state it supports it cannot be used.
20
21       If a callback has an id parameter that should be checked to  make  sure
22       you are giving the appropriate value.
23
24       If  an application is using the client side of the library functions to
25       handle the callbacks are not necessary.  Instead  the  application  may
26       deal  with  callbacks via SASL_INTERACT's. See sasl_client_start/step()
27       for more information.
28
29       The list of callbacks follows:
30
31

Common Callbacks

33       sasl_getopt_t
34               Get an option value
35
36       sasl_log_t
37               Log message handler
38
39       sasl_getpath_t
40               Get path to search for plugins (e.g. SASL mechanisms)
41
42       sasl_verifyfile_t
43               Verify files for use by SASL
44
45       sasl_canon_user_t
46               Username canonicalization function.
47
48

Client-only Callbacks

50       sasl_getsimple_t
51               Get user/language list
52
53       sasl_getsecret_t
54               Get authentication secret
55
56       sasl_chalprompt_t
57               Display challenge and prompt for response
58
59       sasl_getrealm_t
60               Get the realm for authentication
61
62

Server-only Callbacks

64       sasl_authorize_t
65               Authorize policy callback
66
67       sasl_server_userdb_checkpass_t
68               verify plaintext password
69
70       sasl_server_userdb_setpass_t
71               set plaintext password
72
73       sasl_getconfpath_t
74               Get path to search for SASL  configuration  file  (server  side
75               only). New in SASL 2.1.22.
76
77

RETURN VALUE

79       SASL callback functions should return SASL return codes. See sasl.h for
80       a complete list. SASL_OK typically indicates success.
81
82

CONFORMING TO

84       RFC 4422
85
86