saslclientstep(10 July 2001) saslclientstep(10 July 2001)

NAME
       saslclientstep - Perform a step in the authentication negotiation



SYNOPSIS
       ##iinncclluuddee <>

       iinntt ssaassllcclliieennttsstteepp((ssaassllccoonnnntt *conn,,
                      ccoonnsstt cchhaarr *serverin,,
                      uunnssiiggnneedd serverinlen,,
                      ssaasslliinntteerraacctttt **** promptneed,,
                      ccoonnsstt cchhaarr **** clientout,,
                      uunnssiiggnneedd ** clientoutlen));;


DESCRIPTION
       ssaassllcclliieennttsstteepp(())  performs  a step in the authentication negotiation.
       It returns SASLOK if the whole negotiation is sucessful and  SASLCON-
       TINUE if this step is ok but at least one more step is needed. A client
       should not assume  an  authentication  negotiation  is  sucessful  just
       because  the  server  signaled success via protocol (i.e. if the server
       said ". OK Authentication succeeded" in  IMAP  saslclientstep  should
       still be called one more time with a serverinlen of zero.

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

       conn is the SASL connection context

       serverin is the data given by  the  server  (decoded  if  the  protocol
       encodes requests sent over the wire)

       serverinlen is the length of serverin

       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.


RREETTUURRNN VVAALLUUEE
       saslclientstep returns an integer which corresponds  to  one  of  the
       following codes. SASLCONTINUE indicates sucess and that there are more
       steps needed in the authentication. SASLOK indicates that the  authen-
       tication is complete. All other return codes indicate errors and should
       either be handled or the authentication session should be quit.


CCOONNFFOORRMMIINNGG TTOO
       RFC 2222

SEE ALSO
       sasl(3),   saslcallbacks(3),   saslerrors(3),    saslclientinit(3),
       saslclientnew(3), saslclientstart(3)



SASL man pages                       SASL       saslclientstep(10 July 2001)