sasl_server_new(3sasl)

1sasl_server_nSeiwm(p3lSeASALu)thentication Security Layer LibrarysFausnlc_tsieornvser_new(3SASL)
2
3
4

NAME

6       sasl_server_new - create a new server authentication object
7

SYNOPSIS

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

DESCRIPTION

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

PARAMETERS

25       service         The registered name of the service that uses SASL.  The
26                       registered name is usually the protocol name, for exam‐
27                       ple, IMAP.
28
29
30       serverFQDN      The fully-qualified server domain name. If the value of
31                       serverFQDN is NULL, use gethostname(3C). The serverFQDN
32                       parameter is useful for multi-homed servers.
33
34
35       user_realm      The domain of the user agent. The user_realm is usually
36                       not necessary. The default value of user_realm is NULL.
37
38
39       iplocalport
40
41                       The  IP  address and port of the local side of the con‐
42                       nection. The value of iplocalport may be NULL. If iplo‐
43                       calport  is  NULL,  mechanisms  that require IP address
44                       information are disabled. The iplocalport  string  must
45                       be in one of the following formats:
46
47                           o      a.b.c.d:port (IPv4)
48
49                           o      [e:f:g:h:i:j:k:l]:port (IPv6)
50
51                           o      [e:f:g:h:i:j:a.b.c.d]:port (IPv6)
52
53
54                       The following older formats are also supported:
55
56                           o      a.b.c.d;port (IPv4)
57
58                           o      e:f:g:h:i:j:k:l;port (IPv6)
59
60                           o      e:f:g:h:i:j:a.b.c.d;port (IPv6)
61
62
63       ipremoteport    The  IP address and port of the remote side of the con‐
64                       nection. The value of ipremoteport  may  be  NULL.  See
65                       iplocalport.
66
67
68       callbacks       Callbacks,  for  example:  authorization, lang, and new
69                       getopt context.
70
71
72       flags           Usage flags. For servers, the flags SASL_NEED_PROXY and
73                       SASL_SUCCESS_DATA are available.
74
75
76       pconn           A  pointer  to  the connection context allocated by the
77                       library. This structure will be  used  for  all  future
78                       SASL calls for this connection.
79
80

RETURN VALUES

82       sasl_server_new()  returns  an integer that corresponds to a SASL error
83       code.
84

ERRORS

86       SASL_OK    The call to sasl_server_new() was successful.
87
88
89
90       All other error codes indicate an error situation that must be handled,
91       or  the  authentication  session should be quit. See sasl_errors(3SASL)
92       for information on SASL error codes.
93

ATTRIBUTES

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