saslclientstart(10 July 2001) saslclientstart(10 July 2001)

NAME
       saslclientstart - Begin an authentication negotiation

SYNOPSIS
       ##iinncclluuddee <>

       iinntt ssaassllcclliieennttssttaarrtt((ssaassllccoonnnntt ** conn,,
                       ccoonnsstt cchhaarr ** mechlist,,
                       ssaasslliinntteerraacctttt **** promptneed,,
                       ccoonnsstt cchhaarr **** clientout,,
                       uunnssiiggnneedd ** clientoutlen,,
                       ccoonnsstt cchhaarr **** mech));;


DESCRIPTION
       ssaassllcclliieennttssttaarrtt(())  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 necessar-
       ily 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  sup-
       ports acquired from a capability request.

       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).


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

       promptneed  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)


RREETTUURRNN VVAALLUUEE
       saslclientstart  returns  an  integer which corresponds to one of the
       following codes. SASLCONTINUE 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.


CCOONNFFOORRMMIINNGG TTOO
       RFC 2222

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



SASL man pages                       SASL      saslclientstart(10 July 2001)