Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SASL_CLIENT_NEW(3)		  Cyrus	SASL		    SASL_CLIENT_NEW(3)

NAME
       sasl_client_new - Cyrus SASL documentation

SYNOPSIS
       #include	<sasl/sasl.h>

       int sasl_client_new(const char *service,
			   const char *serverFQDN,
			   const char *iplocalport,
			   const char *ipremoteport,
			   const sasl_callback_t *prompt_supp,
			   unsigned flags,
			   sasl_conn_t ** pconn);

DESCRIPTION
       int sasl_client_new(const char *service,

       const char *serverFQDN,

       const char *iplocalport,

       const char *ipremoteport,

       const sasl_callback_t *prompt_supp,

       unsigned	flags,

       sasl_conn_t ** pconn);
	      sasl_client_new()	 creates a new SASL context. This context will
	      be used for all SASL calls for one connection. It	 handles  both
	      authentication and integrity/encryption layers after authentica-
	      tion.

	      Parameters

		     o service a the registered	name of	the  service  (usually
		       the protocol name) using	SASL (e.g. aimapa).

		     o serverFQDN  a  the  fully  qualified domain name	of the
		       server (e.g. aserverhost.example.coma).

		     o iplocalport a 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  string  must  be in one of	the   following	  for-
		       mats: aa.b.c.d;porta   (IPv4),	ae:f:g:h:i:j:k:l;porta
		       (IPv6), or ae:f:g:h:i:j:a.b.c.d;porta (IPv6)

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

		     o prompt_supp a a list of client  interactions  supported
		       that is unique to this connection. If this parameter is
		       NULL    the    global	callbacks    (specified	    in
		       sasl_client_init(3))   will  be	used.  See  sasl_call-
		       backs(3)	for more information.

		     o flags a are connection flags (see below)

		     o pconn a the connection context  allocated  by  the  li-
		       brary.  This structure will be used for all future SASL
		       calls for this connection.

   Connection Flags
       Flags that may be passed	to sasl_client_new():

       o SASL_SUCCESS_DATA: The	protocol supports a serveralast	send

       o

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

RETURN VALUE
       SASL callback functions should return SASL return  codes.   See	sasl.h
       for a complete list. SASL_OK indicates success.

       The following return codes indicate errors and should either be handled
       or the authentication session should be quit:

       o SASL_NOMECH: No mechanism meets requested properties

       o SASL_BADPARAM:	Error in config	file

       o SASL_NOMEM: Not enough	memory to complete operation

SEE ALSO
       RFC  4422,:saslman:sasl(3),   sasl_callbacks(3),	  sasl_client_init(3),
       sasl_client_start(3), sasl_client_step(3), sasl_setprop(3)

AUTHOR
       The Cyrus Team

COPYRIGHT
       1993-2016, The Cyrus Team

2.1.28			       February	18, 2022	    SASL_CLIENT_NEW(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | AUTHOR | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=sasl_client_new&sektion=3&manpath=FreeBSD+13.1-RELEASE+and+Ports>

home | help