Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

sasl_client_start(3sasl) [sunos man page]

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

NAME

       sasl_client_start - perform a step in the authentication negotiation

SYNOPSIS

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

       int   sasl_client_start(sasl_conn_t   *conn,  const  char  *mechlist,  sasl_interact_t  **prompt_need,  const  char  **clientout,  unsigned
       *clientoutlen, const char **mech);

DESCRIPTION

       Use the sasl_client_start() interface to select a mechanism for authentication and start the authentication session. The mechlist parameter
       holds the list of mechanisms that the client might like to use. The mechanisms in the list are not necessarily supported by the client, nor
       are the mechanisms necessarily valid. SASL determines which of the mechanisms to use based upon the security preferences specified earlier.
       The list of mechanisms is typically a list of mechanisms that the server supports, acquired from a capability request.

       If  SASL_INTERACT  is returned, the library needs some values to be filled in before it can proceed. The prompt_need structure is filled in
       with requests. The application fullfills these requests and calls sasl_client_start() again  with  identical  parameters.  The  prompt_need
       parameter is the same pointer as before, but it is filled in by the application.

PARAMETERS

       conn		       The SASL connection context.

       mechlist 	       A list of mechanism that the server has available. Punctuation is ignored.

       prompt_need	       A list of prompts that are needed to continue, if necessary.

       clientout	       clientout  and  clientoutlen are created. They contain the initial client response to send to the server. It is the
       clientoutlen	       job of the client to send them over the network to the server. Any protocol specific encodingthat is necessary, for
			       example base64 encoding, must be done by the client.

			       If the protocol lacks client-send-first capability, then set clientout to NULL. If there is no initial client-send,
			       then *clientout will be set to NULL on return.

       mech		       Contains the name of the chosen SASL mechanism, upon success.

RETURN VALUES

       sasl_client_start() returns an integer that corresponds to a SASL error code.

ERRORS

       SASL_CONTINUE   The call to sasl_client_start() was successful, and more steps are needed in the authentication.

       All other  error  codes	indicate  an  error  situation	that  must  be	handled,  or  the  authentication  session  should  be	quit.  See
       sasl_errors(3SASL) for information on SASL error codes.

ATTRIBUTES

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

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

SEE ALSO

	sasl_errors(3SASL), attributes(5)

SunOS 5.10							    26 Aug 2003 					  sasl_client_start(3SASL)

Check Out this Related Man Page

sasl_client_start(10 July 2001) 										   sasl_client_start(10 July 2001)

NAME

       sasl_client_start - Begin an authentication negotiation

SYNOPSIS

       #include <sasl/sasl.h>

       int sasl_client_start(sasl_conn_t * conn,
		       const char * mechlist,
		       sasl_interact_t ** prompt_need,
		       const char ** clientout,
		       unsigned * clientoutlen,
		       const char ** mech);

DESCRIPTION

       sasl_client_start()  selects  a	mechanism for authentication and starts the authentication session. The mechlist is the list of mechanisms
       the client might like to use. The mechanisms in the list are not necessarily supported by the client or even valid. SASL  determines  which
       of  these to use based upon the security preferences specified earlier. The list of mechanisms is typically a list of mechanisms the server
       supports acquired from a capability request.

       If SASL_INTERACT is returned the library needs some values to be filled in before it can proceed. The prompt_need structure will be  filled
       in with requests. The application should fulfill these requests and call sasl_client_start again with identical parameters (the prompt_need
       parameter will be the same pointer as before but filled in by the application).

       mechlist is a list of mechanisms the server has available. Punctuation if ignored.

       prompt_need is filled in with a list of prompts needed to continue (if necessary).

       clientout and clientoutlen is created. It is the initial client response to send to the server. It is the job of the client to send it over
       the network to the server.  Any protocal specific encoding (such as base64 encoding) necessary needs to be done by the client.

       If the protocol lacks client-send-first capability, then set clientout to NULL.

       If there is no initial client-send, then *clientout will be set to NULL on return.

       mech contains the name of the chosen SASL mechanism (on success)

RETURN VALUE

       sasl_client_start  returns  an  integer	which corresponds to one of the following codes. SASL_CONTINUE indicates sucess and that there are
       more steps needed in the authentication. All other return codes indicate errors and should either be handled or the authentication  session
       should be quit.

CONFORMING TO

       RFC 2222

SEE ALSO

       sasl(3), sasl_callbacks(3), sasl_errors(3), sasl_client_init(3), sasl_client_new(3), sasl_client_step(3)

SASL man pages							       SASL					   sasl_client_start(10 July 2001)
Man Page