saslclientnew(21 June 2001) saslclientnew(21 June 2001)

NAME
       saslclientnew - Create a new client authentication object



SYNOPSIS
       ##iinncclluuddee <>

       iinntt ssaassllcclliieennttnneeww((ccoonnsstt cchhaarr *service,,
                       ccoonnsstt cchhaarr *serverFQDN,,
                       ccoonnsstt cchhaarr *iplocalport,,
                       ccoonnsstt cchhaarr *ipremoteport,,
                       ccoonnsstt ssaassllccaallllbbaacckktt *promptsupp,
                       uunnssiiggnneedd flags,,
                       ssaassllccoonnnntt **** pconn));;


DESCRIPTION
       ssaassllcclliieennttnneeww(()) creates a new SASL context. This context will be used
       for all SASL calls for one connection. It handles  both  authentication
       and integrity/encyption layers after authentication.

       service  is  the  registered  name of the service (usually the protocol
       name) using SASL (e.g. "imap").

       serverFQDN is the fully qualified  domain  name  of  the  server  (e.g.
       "serverhost.cmu.edu").

       iplocalport  is the IP and port of the local side of the connection, or
       NULL.  If iplocalport is NULL it will disable mechanisms  that  require
       IP  address  information.  This strings must be in one of the following
       formats:  "a.b.c.d;port"  (IPv4),  "e:f:g:h:i:j:k:l;port"  (IPv6),   or
       "e:f:g:h:i:j:a.b.c.d;port" (IPv6)

       ipremoteport  is  the IP and port of the remote side of the connection,
       or NULL (see iplocalport)

       promptsupp is a list of client interactions supported that  is  unique
       to  this  connection.  If  this  parameter is NULL the global callbacks
       (specified in saslclientinit) will be  used.  See  saslcallback  for
       more information.

       flags are connection flags (see below)

       pconn is the conection context allocated by the library. This structure
       will be used for all future SASL calls for this connection.

       CCoonnnneeccttiioonn FFllaaggss

       Flags that may be passed to ssaassllsseerrvveerrnneeww(()) include

       SSAASSLLSSUUCCCCEESSSSDDAATTAA
               The protocol supports a server-last send

       SSAASSLLNNEEEEDDPPRROOXXYY
               Force the use of a mechanism that supports an authorization  id
               that is not the authentication id.


RREETTUURRNN VVAALLUUEE
       saslclientnew returns an integer which corresponds to one of the fol-
       lowing codes. SASLOK is the only one that indicates success. All  oth-
       ers  indicate errors and should either be handled or the authentication
       session should be quit.


EERRRROORRSS
       SSAASSLLOOKK Success

       SSAASSLLBBAADDPPAARRAAMM
               Error in config file or passed parameters

       SSAASSLLNNOOMMEECCHH
               No mechanism meets requested properties

       SSAASSLLNNOOMMEEMM
               Not enough memory to complete operation


CCOONNFFOORRMMIINNGG TTOO
       RFC 2222

SEE ALSO
       sasl(3),           saslclientinit(3),           saslclientstart(3),
       saslclientstep(3), saslsetprop(3)



SASL man pages                       SASL        saslclientnew(21 June 2001)