Edit File: sasl_callbacks.3
.\" Man page generated from reStructuredText. . .TH "SASL_CALLBACKS" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_callbacks \- Cyrus SASL documentation . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH SYNOPSIS .sp .nf #include <sasl/sasl.h> .fi .SH DESCRIPTION .sp \fBsasl_callbacks\fP 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 sasl_client_init(3)/sasl_server_init(3) or sasl_client_new(3)/sasl_server_new(3) calls. If an authentication mechanism needs a callback that the application does not state it supports it cannot be used. .sp If a callback has an id parameter that should be checked to make sure you are giving the appropriate value. .sp 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 sasl_client_start(3)/sasl_client_step(3) for more information. .SS Common Callbacks .INDENT 0.0 .TP .B sasl_getopt_t Get an option value .TP .B sasl_log_t Log message handler .TP .B sasl_getpath_t Get path to search for plugins (e.g. SASL mechanisms) .TP .B sasl_verifyfile_t Verify files for use by SASL .TP .B sasl_canon_user_t(3) Username canonicalization function .UNINDENT .SS Client\-only Callbacks .INDENT 0.0 .TP .B sasl_getsimple_t Get user/language list .TP .B sasl_getsecret_t Get authentication secret .TP .B sasl_chalprompt_t(3) Display challenge and prompt for response .TP .B sasl_getrealm_t Get the realm for authentication .UNINDENT .SS Server\-only Callbacks .INDENT 0.0 .TP .B sasl_authorize_t(3) Authorize policy callback .TP .B sasl_server_userdb_checkpass_t verify plaintext password .TP .B sasl_server_userdb_setpass_t set plaintext password .TP .B sasl_getconfpath_t Get path to search for SASL configuration file (server side only). New in SASL 2.1.22. .UNINDENT .SH RETURN VALUE .sp SASL callback functions should return SASL return codes. See sasl_errors(3) for a complete list. \fBSASL_OK\fP typically indicates success. .SH CONFORMING TO .sp \fI\%RFC 4422\fP .SH SEE ALSO .sp sasl(3), sasl_errors(3), sasl_authorize_t(3), sasl_log_t(3), sasl_getpath_t(3), sasl_getconfpath_t(3), sasl_verifyfile_t(3), sasl_canon_user_t(3), sasl_getsimple_t(3), sasl_getsecret_t(3), sasl_chalprompt_t(3), sasl_getrealm_t(3), sasl_server_userdb_checkpass_t(3), sasl_server_userdb_setpass_t(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .