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 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
|
.. saslman:: sasl_callbacks(3)
.. _sasl-reference-manpages-library-sasl_callbacks:
====================================================
**sasl_callbacks** - How to work with SASL callbacks
====================================================
Synopsis
========
.. code-block:: C
#include <sasl/sasl.h>
Description
===========
**sasl_callbacks** are used when the application needs some
information from the application. Common reasons are getting
for getting usernames and passwords. A client MUST
specify what callbacks they support in the
:saslman:`sasl_client_init(3)`/:saslman:`sasl_server_init(3)`
or :saslman:`sasl_client_new(3)`/:saslman:`sasl_server_new(3)`
calls. If an authentication mechanism needs a callback
that the application does not state it supports it cannot
be used.
If a callback has an id parameter that should be checked
to make sure you are giving the appropriate value.
If an application is using the client side of the library
functions to handle the callbacks are not necessary.
Instead the application may deal with callbacks via
SASL_INTERACT's. See :saslman:`sasl_client_start(3)`/:saslman:`sasl_client_step(3)` for more
information.
Common Callbacks
----------------
sasl_getopt_t
Get an option value
sasl_log_t
Log message handler
sasl_getpath_t
Get path to search for plugins (e.g. SASL mechanisms)
sasl_verifyfile_t
Verify files for use by SASL
:saslman:`sasl_canon_user_t(3)`
Username canonicalization function
Client-only Callbacks
---------------------
sasl_getsimple_t
Get user/language list
sasl_getsecret_t
Get authentication secret
:saslman:`sasl_chalprompt_t(3)`
Display challenge and prompt for response
sasl_getrealm_t
Get the realm for authentication
Server-only Callbacks
---------------------
:saslman:`sasl_authorize_t(3)`
Authorize policy callback
sasl_server_userdb_checkpass_t
verify plaintext password
sasl_server_userdb_setpass_t
set plaintext password
sasl_getconfpath_t
Get path to search for SASL configuration file
(server side only). New in SASL 2.1.22.
Return value
============
SASL callback functions should return SASL return codes.
See :saslman:`sasl_errors(3)` for a complete list. :c:macro:`SASL_OK` typically indicates success.
Conforming to
=============
:rfc:`4422`
See Also
========
:saslman:`sasl(3)`, :saslman:`sasl_errors(3)`, :saslman:`sasl_authorize_t(3)`,
:saslman:`sasl_log_t(3)`, :saslman:`sasl_getpath_t(3)`,
:saslman:`sasl_getconfpath_t(3)`, :saslman:`sasl_verifyfile_t(3)`,
:saslman:`sasl_canon_user_t(3)`, :saslman:`sasl_getsimple_t(3)`,
:saslman:`sasl_getsecret_t(3)`, :saslman:`sasl_chalprompt_t(3)`,
:saslman:`sasl_getrealm_t(3)`, :saslman:`sasl_server_userdb_checkpass_t(3)`,
:saslman:`sasl_server_userdb_setpass_t(3)`
|