sasl_client_new(3sasl)

1sasl_client_nSeiwm(p3lSeASALu)thentication Security Layer LibrarysFausnlc_tciloinesnt_new(3SASL)
2
3
4

NAME

6       sasl_client_new - create a new client authentication object
7

SYNOPSIS

9       cc [ flag ... ] file ... -lsasl   [ library ... ]
10       #include <sasl/sasl.h>
11
12       int sasl_client_new(const char *service, const char *serverFQDN,
13            const char *iplocalport, const char *ipremoteport,
14            const sasl_callback_t *prompt_supp, unsigned flags,
15            sasl_conn_t **pconn);
16
17

DESCRIPTION

19       Use  the sasl_client_new() interface to create a new SASL context. This
20       SASL context will be used for all SASL calls for  one  connection.  The
21       context  handles  both  authentication and the integrity and encryption
22       layers after authentication.
23

PARAMETERS

25       service         The registered name of the service that uses SASL, usu‐
26                       ally the protocol name, for example, IMAP.
27
28
29       serverFQDN      The  fully  qualified  domain  name  of the server, for
30                       example, serverhost.cmu.edu.
31
32
33       iplocalport
34
35                       The IP and port of the local side of the connection, or
36                       NULL.  If  iplocalport is NULL, mechanisms that require
37                       IP address information are  disabled.  The  iplocalport
38                       string must be in one of the following formats:
39
40                           o      a.b.c.d:port (IPv6)
41
42                           o      [e:f:g:h:i:j:k:l]:port (IPv6)
43
44                           o      [e:f:g:h:i:j:a.b.c.d]:port (IPv6)
45
46                           o      a.b.c.d;port (IPv4)
47
48                           o      e:f:g:h:i:j:k:l;port (IPv6)
49
50                           o      e:f:g:h:i:j:a.b.c.d;port (IPv6)
51
52
53       ipremoteport    The  IP  and port of the remote side of the connection,
54                       or NULL.
55
56
57       prompt_supp     A list of the client interactions  supported  that  are
58                       unique  to  this connection. If this parameter is NULL,
59                       the      global      callbacks       specified       in
60                       sasl_client_init(3SASL) are used.
61
62
63       flags           Usage  flags.  For clients, the flag SASL_NEED_PROXY is
64                       available.
65
66
67       pconn           The connection context allocated by  the  library.  The
68                       pconn  structure  is used for all future SASL calls for
69                       this connection.
70
71

RETURN VALUES

73       sasl_client_new() returns an integer that corresponds to a  SASL  error
74       code.
75

ERRORS

77       SASL_OK          The call to sasl_client_new() was successful.
78
79
80       SASL_NOMECH      No mechanishm meets the requested properties.
81
82
83       SASL_BADPARAM    There  is an error in the configuration file or passed
84                        parameters.
85
86
87       SASL_NOMEM       There is not enough memory to complete the operation.
88
89
90
91       All other error codes indicate an error situation that must be handled,
92       or  the  authentication  session should be quit. See sasl_errors(3SASL)
93       for information on SASL error codes.
94

ATTRIBUTES

96       See attributes(5) for descriptions of the following attributes:
97
98
99
100
101       ┌─────────────────────────────┬─────────────────────────────┐
102       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
103       ├─────────────────────────────┼─────────────────────────────┤
104       │Availability                 │SUNWlibsasl                  │
105       ├─────────────────────────────┼─────────────────────────────┤
106       │Interface Stability          │Evolving                     │
107       ├─────────────────────────────┼─────────────────────────────┤
108       │MT-Level                     │Safe                         │
109       └─────────────────────────────┴─────────────────────────────┘
110