sasl_server_start(3sasl)

1sasl_server_sStiamrptl(e3SAAuStLh)entication Security Layer LibrarsyasFlu_nscetrivoenrs_start(3SASL)
2
3
4

NAME

6       sasl_server_start - create a new server authentication object
7

SYNOPSIS

9       cc [ flag ... ] file ... -lsasl   [ library ... ]
10       #include <sasl/sasl.h>
11
12       int sasl_server_start(sasl_conn_t *conn, const char  *mech,
13            const char  *clientin, unsigned *clientinlen,
14            const char  **serverout, unsigned *serveroutlen);
15
16

DESCRIPTION

18       The  sasl_server_start()  interface  begins the authentication with the
19       mechanism specified by the mech parameter. sasl_server_start() fails if
20       the mechanism is not supported.
21

PARAMETERS

23       conn            The SASL context for this connection.
24
25
26       mech            The mechanism name that the client requested.
27
28
29       clientin        The initial response from the client. The value of cli‐
30                       entin is NULL if the protocol  lacks  support  for  the
31                       client-send-first  or  if the other end did not have an
32                       initial send. No initial client send is  distinct  from
33                       an  initial  send  of  a null string. The protocol must
34                       account for this difference.
35
36
37       clientinlen     The length of the initial response.
38
39
40       serverout       Created by the plugin library. The value  of  serverout
41                       is  the  initial server response to send to the client.
42                       serverout is allocated or freed by the library.  It  is
43                       the  job  of  the client to send it over the network to
44                       the server. Protocol  specific  encoding,  for  example
45                       base64 encoding, must be done by the server.
46
47
48       serveroutlen    The length of the initial server challenge.
49
50

RETURN VALUES

52       sasl_server_start() returns an integer that corresponds to a SASL error
53       code.
54

ERRORS

56       SASL_OK          Authentication completed successfully.
57
58
59       SASL_CONTINUE    The call to sasl_server_start()  was  successful,  and
60                        more steps are needed in the authentication.
61
62
63
64       All other error codes indicate an error situation that must be handled,
65       or the authentication session should be  quit.  See  sasl_errors(3SASL)
66       for information on SASL error codes.
67

ATTRIBUTES

69       See attributes(5) for descriptions of the following attributes:
70
71
72
73
74       ┌─────────────────────────────┬─────────────────────────────┐
75       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
76       ├─────────────────────────────┼─────────────────────────────┤
77       │Availability                 │SUNWlibsasl                  │
78       ├─────────────────────────────┼─────────────────────────────┤
79       │Interface Stability          │Evolving                     │
80       ├─────────────────────────────┼─────────────────────────────┤
81       │MT-Level                     │MT-Safe                      │
82       └─────────────────────────────┴─────────────────────────────┘
83