opensolaris man page for sasl_getsecret_t

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

NAME
       sasl_getsecret_t - the SASL callback function for secrets (passwords)

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

       int sasl_getsecret_t(sasl_conn_t *conn, void *context,
	    int id, sasl_secret_t **psecret);

DESCRIPTION
       Use   the   sasl_getsecret_t()	function   to	retrieve   the	 secret   from	 the  application.  Allocate  a  sasl_secret_t	to  length
       sizeof(sasl_secret_t)+<length of secret>. sasl_secret_t has two fields of len which contain the length of secret in bytes and the data con-
       tained in secret. The secret string does not need to be null-terminated.

PARAMETERS
       conn	  The connection context

       context	  The context from the callback structure

       id	  The callback ID

       psecret	  To  cancel,  set  the  value	of psecret to NULL. Otherwise, set the value to the password structure. The structure must persist
		  until the next call to sasl_getsecret_t() in the same connection. Middleware erases password data when it is done with it.

RETURN VALUES
       Like other SASL callback functions, sasl_getsecret_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_getsecret_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)

SunOS 5.11							    27 Oct 2003 					   sasl_getsecret_t(3SASL)