sasl_getsimple_t(3) [debian man page]

sasl_getsimple_t(3)						  SASL man pages					       sasl_getsimple_t(3)

NAME

       sasl_getsimple_t - The SASL callback for username/authname/realm

SYNOPSIS

       #include <sasl/sasl.h>

       int sasl_getsimple_t(void *context,
			   int id,
			   const char ** result,
			   unsigned * len);

DESCRIPTION

       sasl_getsimple_t  is  used to retrieve simple things from the application. In practice this is authentication name, authorization name, and
       realm. The id parameter indicates which value is being requested.  Possible values include:

       SASL_CB_USER	- Client user identity to login as
       SASL_CB_AUTHNAME - Client authentication name
       SASL_CB_LANGUAGE - Comma-separated list of RFC 1766 languages
       SASL_CB_CNONCE	- Client-nonce (for testing mostly)

RETURN VALUE

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

CONFORMING TO

       RFC 4422

SEE ALSO

       sasl(3), sasl_callbacks(3), sasl_errors(3)

SASL
								   10 July 2001 					       sasl_getsimple_t(3)

sasl_getsimple_t(3SASL) 		      Simple Authentication Security Layer Library Functions			   sasl_getsimple_t(3SASL)

NAME

       sasl_getsimple_t - the SASL callback function for username, authname and realm

SYNOPSIS

       cc [ flag ... ] file ... -lsasl	 [ library ... ]
       #include <sasl/sasl.h>

       int sasl_getsimple_t(void *context, int id, const char **result, unsigned *len);

DESCRIPTION

       Use  the  sasl_getsimple_t() callback function to retrieve simple data from the application such as the authentication name, the authoriza-
       tion name, and the realm. The id parameter indicates which value is requested.

PARAMETERS

       context	       The context from the callback structure.

       id	       The callback ID. Possible values for id include:

		       SASL_CB_USER	       Client user identity for login.

		       SASL_CB_AUTHNAME        Client authentication name.

		       SASL_CB_LANGUAGE        Comma-separated list of languages pursuant to RFC 1766.

		       SASL_CB_CNONCE	       The client-nonce. This value is used primarily for testing.

       result	       To cancel user, set the value of result with a null-terminated string. If the value of result is NULL,  then  the  user	is
		       cancelled.

       len	       The length of result.

RETURN VALUES

       Like  other  SASL  callback functions, sasl_getsimple_t() returns an integer that corresponds to a SASL error code. See <sasl.h> for a com-
       plete list of SASL error codes.

ERRORS

       SASL_OK	       The call to sasl_getsimple_t() was successful.

       See sasl_errors(3SASL) for information on SASL error codes.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWlibsasl		   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       sasl_errors(3SASL), attributes(5)

       Alvestrand, H. RFC 1766, Tags for the Identification of Languages. Network Working Group. November 1995.

SunOS 5.10							    27 Oct 2003 					   sasl_getsimple_t(3SASL)