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

NAME

6       sasl_server_start - Cyrus SASL documentation
7

SYNOPSIS

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

DESCRIPTION

19       int sasl_server_start(sasl_conn_t * conn,
20
21       const char * mech,
22
23       const char * clientin,
24
25       unsigned * clientinlen,
26
27       const char ** serverout,
28
29       unsigned * serveroutlen);
30              sasl_server_start() begins  the  authentication  with the mecha‐
31              nism specified with mech. This fails if the  mechanism  is   not
32              supported.
33
34              Parameters
35
36                     • conn – is the SASL connection context
37
38                     • mech – is the mechanism name that the client requested
39
40                     • clientin  – is the client initial response, NULL if the
41                       protocol lacks support for client‐send‐first or if  the
42                       other  end   did  not  have an initial send.  Note that
43                       no initial client send  is  distinct  from  an  initial
44                       send  of  a  null string, and the protocol MUST account
45                       for this difference.
46
47                     • clientinlen – is the length of initial response
48
49                     • serverout – is created by the plugin library. It is the
50                       initial  server response to send to the client. This is
51                       allocated/freed by the library and it is the job of the
52                       client to send it over the network to the server.  Also
53                       protocol specific  encoding (such as  base64  encoding)
54                       must needs to be done by the server.
55
56                     • serveroutlen  –  is set to the length of initial server
57                       challenge
58

RETURN VALUE

60       SASL  callback  functions should return SASL return codes.  See  sasl.h
61       for  a complete list. SASL_OK is returned if the authentication is com‐
62       plete and the user is authenticated.  SASL_CONTINUE  is returned if one
63       or more steps are still required in the authentication.
64
65       All  other  return  values indicate errors and should be handled or the
66       authentication session should be quit.
67

SEE ALSO

69       RFC  4422,:saslman:sasl(3),  sasl_server_init(3),   sasl_server_new(3),
70       sasl_server_step(3), sasl_errors(3)
71

AUTHOR

73       The Cyrus Team
74

76       1993-2016, The Cyrus Team
77
78
79
80
812.1.28                         February 18, 2022          SASL_SERVER_START(3)
Impressum