Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SASL_CALLBACKS(3)		  Cyrus	SASL		     SASL_CALLBACKS(3)

NAME
       sasl_callbacks -	Cyrus SASL documentation

SYNOPSIS
       #include	<sasl/sasl.h>

DESCRIPTION
       sasl_callbacks	are  used  when	the application	needs some information
       from the	application. Common reasons are	 getting for   getting	 user-
       names  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.

       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_INTERACTas.	   See
       sasl_client_start(3)/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

       sasl_canon_user_t(3)
	      Username canonicalization	function

   Client-only Callbacks
       sasl_getsimple_t
	      Get user/language	list

       sasl_getsecret_t
	      Get authentication secret

       sasl_chalprompt_t(3)
	      Display challenge	and prompt for response

       sasl_getrealm_t
	      Get the realm for	authentication

   Server-only Callbacks
       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
       sasl_errors(3) for a complete list.  SASL_OK  typically	indicates suc-
       cess.

CONFORMING TO
       RFC 4422

SEE ALSO
       sasl(3),	sasl_errors(3),	sasl_authorize_t(3), sasl_log_t(3),  sasl_get-
       path_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_check-
       pass_t(3), sasl_server_userdb_setpass_t(3)

AUTHOR
       The Cyrus Team

COPYRIGHT
       1993-2016, The Cyrus Team

2.1.28			       February	18, 2022	     SASL_CALLBACKS(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | CONFORMING TO | SEE ALSO | AUTHOR | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=sasl_callbacks&sektion=3&manpath=FreeBSD+13.1-RELEASE+and+Ports>

home | help