1sasl_server_start(10 July 2001) sasl_server_start(10 July 2001)
2
3
4
6 sasl_server_start - Begin an authentication negotiation
7
8
9
11 #include <sasl/sasl.h>
12
13 int sasl_server_start(sasl_conn_t * conn,
14 const char * mech,
15 const char * clientin,
16 unsigned * clientinlen,
17 const char ** serverout,
18 unsigned * serveroutlen);
19
21 sasl_server_start() begins the authentication with the mechanism speci‐
22 fied with mech. This fails if the mechanism is not supported. SASL_OK
23 is returned if the authentication is complete and the user is authenti‐
24 cated. SASL_CONTINUE is returned if one or more steps are still
25 required in the authentication. All other return values indicate fail‐
26 ure.
27
28
29 conn is the SASL context for this connection
30
31 mech is the mechanism name that the client requested
32
33 clientin is the client initial response, NULL if the protocol lacks
34 support for client-send-first or if the other end did not have an ini‐
35 tial send. Note that no initial client send is distinct from an ini‐
36 tial send of a null string, and the protocol MUST account for this dif‐
37 ference.
38
39
40 clientinlen is the length of initial response
41
42 serverout is created by the plugin library. It is the initial server
43 response to send to the client. This is allocated/freed by the library
44 and it is the job of the client to send it over the network to the
45 server. Also protocol specific encoding (such as base64 encoding) must
46 needs to be done by the server.
47
48 serveroutlen is set to the length of initial server challenge
49
51 sasl_server_start returns an integer which corresponds to one of the
52 SASL errorcodes. SASL_OK indicates that authentication is completed
53 successfully. SASL_CONTINUE indicates success and that there are more
54 steps needed in the authentication. All other return codes indicate
55 errors and should either be handled or the authentication session
56 should be quit.
57
58
60 RFC 2222
61
63 sasl(3), sasl_errors(3), sasl_server_init(3), sasl_server_new(3),
64 sasl_server_step(3)
65
66
67
68SASL man pages SASL sasl_server_start(10 July 2001)