sasl_client_new(26 March 2000)

NAME
sasl_client_new - Create a new client authentication object

SYNOPSIS
#include <sasl.h>

int sasl_client_new(const char *service,
			 const char *serverFQDN,
			 const sasl_callback_t *prompt_supp,
			 int secflags,
			 sasl_conn_t ** pconn);

DESCRIPTION
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/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").

prompt_supp is 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) will be used. See sasl_callback for more information.

secflags are security 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.

Security Flags

Security flags that may be passed to sasl_server_new() include

NOPLAINTEXT
    Don't permit mechanisms susceptible to simple passive attack (e.g., PLAIN, LOGIN)

NOACTIVE
    Protection from active (non-dictionary) attacks during authentication exchange. Authenticates server.

NODICTIONARY
    Don't permit mechanisms susceptible to passive dictionary attack

FORWARD_SECURITY
    Require forward secrecy between sessions. (breaking one won't help break next)

PASS_CREDENTIALS
    Require mechanisms which pass client credentials, and allow mechanisms which can pass credentials to do so.

RETURN VALUE
sasl_client_new returns an integer which corresponds to one of the following codes. SASL_OK is the only one that indicates success. All others indicate errors and should either be handled or the authentication session should be quit.

ERRORS

SASL_OK
    Success

SASL_BADVERS
    Mechanism version mismatch

SASL_BADPARAM
    error in config file

SASL_NOMEM
    not enough memory to complete operation

CONFORMING TO
RFC 2222

SEE ALSO
sasl(3), sasl_client_init(3), sasl_client_start(3), sasl_client_step(3), sasl_setprop(3)