1sasl_client_new(3)              SASL man pages              sasl_client_new(3)
2
3
4

NAME

6       sasl_client_new - Create a new client authentication object
7
8
9

SYNOPSIS

11       #include <sasl/sasl.h>
12
13       int sasl_client_new(const char *service,
14                       const char *serverFQDN,
15                       const char *iplocalport,
16                       const char *ipremoteport,
17                       const sasl_callback_t *prompt_supp,
18                       unsigned flags,
19                       sasl_conn_t ** pconn);
20
21

DESCRIPTION

23       sasl_client_new() creates a new SASL context. This context will be used
24       for all SASL calls for one connection. It handles  both  authentication
25       and integrity/encryption layers after authentication.
26
27       service  is  the  registered  name of the service (usually the protocol
28       name) using SASL (e.g. "imap").
29
30       serverFQDN is the fully qualified  domain  name  of  the  server  (e.g.
31       "serverhost.cmu.edu").
32
33       iplocalport  is the IP and port of the local side of the connection, or
34       NULL.  If iplocalport is NULL it will disable mechanisms  that  require
35       IP  address  information.  This strings must be in one of the following
36       formats:  "a.b.c.d;port"  (IPv4),  "e:f:g:h:i:j:k:l;port"  (IPv6),   or
37       "e:f:g:h:i:j:a.b.c.d;port" (IPv6)
38
39       ipremoteport  is  the IP and port of the remote side of the connection,
40       or NULL (see iplocalport)
41
42       prompt_supp is a list of client interactions supported that  is  unique
43       to  this  connection.  If  this  parameter is NULL the global callbacks
44       (specified in sasl_client_init) will be  used.  See  sasl_callback  for
45       more information.
46
47       flags are connection flags (see below)
48
49       pconn  is  the connection context allocated by the library. This struc‐
50       ture will be used for all future SASL calls for this connection.
51
52       Connection Flags
53
54       Flags that may be passed to sasl_server_new() include
55
56       SASL_SUCCESS_DATA
57               The protocol supports a server-last send
58
59       SASL_NEED_PROXY
60               Force the use of a mechanism that supports an authorization  id
61               that is not the authentication id.
62
63

RETURN VALUE

65       sasl_client_new returns an integer which corresponds to one of the fol‐
66       lowing codes. SASL_OK is the only one that indicates success. All  oth‐
67       ers  indicate errors and should either be handled or the authentication
68       session should be quit.
69
70

ERRORS

72       SASL_OK Success
73
74       SASL_BADPARAM
75               Error in config file or passed parameters
76
77       SASL_NOMECH
78               No mechanism meets requested properties
79
80       SASL_NOMEM
81               Not enough memory to complete operation
82
83

CONFORMING TO

85       RFC 4422
86

SEE ALSO

88       sasl(3),           sasl_client_init(3),           sasl_client_start(3),
89       sasl_client_step(3), sasl_setprop(3)
90
91
92
93SASL                             21 June 2001               sasl_client_new(3)
Impressum