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

NAME

6       sasl_getsecret_t - Cyrus SASL documentation
7

SYNOPSIS

9       #include <sasl/sasl.h>
10
11       int sasl_getsecret_t(sasl_conn_t *conn,
12                           void *context,
13                           int id,
14                           sasl_secret_t ** psecret);
15

DESCRIPTION

17       int sasl_getsecret_t(sasl_conn_t *conn,
18
19       void *context,
20
21       int id,
22
23       sasl_secret_t ** psecret);
24              sasl_getsecret_t() is used to retrieve the secret  from  the ap‐
25              plication.  A  sasl_secret_t  should  be  allocated  to   length
26              sizeof(sasl_secret_t) + <length of secret>.  It  has two fields:
27              len which is the length of the secret in bytes  and  data  which
28              contains  the  secret  itself  (does  not need to be null termi‐
29              nated).
30
31              Parameters
32
33                     • conn – is the SASL connection context
34

RETURN VALUE

36       SASL  callback  functions should return SASL return codes.  See  sasl.h
37       for a complete list. SASL_OK indicates success.
38
39       Other return codes indicate errors and should be handled.
40

SEE ALSO

42       RFC 4422,:saslman:sasl(3), sasl_callbacks(3)
43

AUTHOR

45       The Cyrus Team
46

48       1993-2016, The Cyrus Team
49
50
51
52
532.1.28                         February 18, 2022           SASL_GETSECRET_T(3)
Impressum