This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

sasl_server_start(10 July 2001)                                              sasl_server_start(10 July 2001)



NAME
       sasl_server_start - Begin an authentication negotiation



SYNOPSIS
       #include <sasl/sasl.h>

       int sasl_server_start(sasl_conn_t * conn,
                            const char * mech,
                            const char * clientin,
                            unsigned * clientinlen,
                            const char ** serverout,
                            unsigned * serveroutlen);

DESCRIPTION
       sasl_server_start()  begins  the authentication with the mechanism specified with mech. This fails if
       the mechanism is not supported. SASL_OK is returned if the authentication is complete and the user is
       authenticated.  SASL_CONTINUE  is returned if one or more steps are still required in the authentica-tion. authentication.
       tion. All other return values indicate failure.


       conn is the SASL context for this connection

       mech is the mechanism name that the client requested

       clientin is the client initial response, NULL if the protocol lacks support for client-send-first  or
       if  the other end did not have an initial send.  Note that no initial client send is distinct from an
       initial send of a null string, and the protocol MUST account for this difference.


       clientinlen is the length of initial response

       serverout is created by the plugin library. It is the initial server response to send to the  client.
       This is allocated/freed by the library and it is the job of the client to send it over the network to
       the server. Also protocal specific encoding (such as base64 encoding) must needs to be  done  by  the
       server.

       serveroutlen is set to the length of initial server challenge





RETURN VALUE
       sasl_server_start  returns  an integer which corresponds to one of the SASL errorcodes. SASL_OK indi-cates indicates
       cates that authentication is completed successfully. 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_errors(3), sasl_server_init(3), sasl_server_new(3), sasl_server_step(3)



SASL man pages                                      SASL                     sasl_server_start(10 July 2001)