1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
.. saslman:: sasl_server_new(3)
.. _sasl-reference-manpages-library-sasl_server_new:
===============================================================
**sasl_server_new** - Create a new server authentication object
===============================================================
Synopsis
========
.. code-block:: C
#include <sasl/sasl.h>
int sasl_server_new(const char *service,
const char *serverFQDN,
const char *user_realm,
const char *iplocalport,
const char *ipremoteport,
const sasl_callback_t *callbacks,
unsigned flags,
sasl_conn_t ** pconn);
Description
===========
.. c:function:: int sasl_server_new(const char *service,
const char *serverFQDN,
const char *user_realm,
const char *iplocalport,
const char *ipremoteport,
const sasl_callback_t *callbacks,
unsigned flags,
sasl_conn_t ** pconn);
**sasl_server_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 authentication.
:param service: is the registered name of the service (usually the
protocol name) using SASL (e.g. "imap").
:param serverFQDN: is the fully qualified server domain name.
NULL means use gethostname(). This is useful for multi-homed servers.
:param user_realm: is the domain of the user agent. This is usually
not necessary (NULL is default)
:param 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)
:param ipremoteport: is the IP and port of the remote side of the
connection, or NULL (see iplocalport)
:param flags: are connection flags (see below)
:param pconn: is a pointer to the connection context allocated by
the library. This structure will be used for all future
SASL calls for this connection.
Connection flags
----------------
Flags that may be passed to **sasl_server_new()**:
* `SASL_SUCCESS_DATA`: The protocol supports a server‐last send
* `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. :c:macro:`SASL_OK` indicates success.
Other return codes indicate errors and should either be handled or the
authentication session should be quit.
See Also
========
:rfc:`4422`,:saslman:`sasl(3)`, :saslman:`sasl_server_init(3)`,
:saslman:`sasl_server_start(3)`, :saslman:`sasl_server_step(3)`,
:saslman:`sasl_setprop(3)`, :saslman:`sasl_errors(3)`
|
