1SASL_SERVER_STEP(3)               Cyrus SASL               SASL_SERVER_STEP(3)
2
3
4

NAME

6       sasl_server_step - Cyrus SASL documentation
7

SYNOPSIS

9       #include <sasl/sasl.h>
10
11       int sasl_server_step(sasl_conn_t *conn,
12           const char *clientin,
13           unsigned clientinlen,
14           const char ** serverout,
15           unsigned * serveroutlen);
16

DESCRIPTION

18       int sasl_server_step(sasl_conn_t *conn,
19
20       const char *clientin,
21
22       unsigned clientinlen,
23
24       const char ** serverout,
25
26       unsigned * serveroutlen);
27              sasl_server_step() performs a step in  the  authentication nego‐
28              tiation.  It returns SASL_OK if the whole  negotiation  is  suc‐
29              cessful  and SASL_CONTINUE if this step is ok but  at least  one
30              more step is needed.
31
32              Parameters
33
34                     • conn – is the SASL connection context
35
36                     • clientin – is the data given by the client (decoded  if
37                       the protocol encodes requests sent over the wire)
38
39                     • clientinlen – is the length of clientin
40
41                     • serverout  –  set  by the library and should be sent to
42                       the client.
43
44                     • serveroutlen – length of serverout.
45

RETURN VALUE

47       SASL  callback  functions should return SASL return codes.  See  sasl.h
48       for a complete list. SASL_CONTINUE indicates success and that there are
49       more steps needed in the authentication. SASL_OK indicates that the au‐
50       thentication is complete.
51
52       Other  return codes indicate errors and should either be handled or the
53       authentication session should be quit.
54

SEE ALSO

56       RFC  4422,:saslman:sasl(3),  sasl_server_init(3),   sasl_server_new(3),
57       sasl_server_start(3), sasl_errors(3)
58

AUTHOR

60       The Cyrus Team
61

63       1993-2016, The Cyrus Team
64
65
66
67
682.1.28                         February 18, 2022           SASL_SERVER_STEP(3)
Impressum