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

NAME

6       sasl_getopt_t - Cyrus SASL documentation
7

SYNOPSIS

9       #include <sasl/sasl.h>
10
11       int sasl_getopt_t(void *context,
12                      const char *plugin_name,
13                      const char *option,
14                      const char ** result,
15                      unsigned * len);
16

DESCRIPTION

18       int sasl_getopt_t(void *context,
19
20       const char *plugin_name,
21
22       const char *option,
23
24       const char ** result,
25
26       unsigned * len);
27              sasl_getopt_t  is  used  to  retrieve an option, often mechanism
28              specific, from the application. An example of this is requesting
29              what KERBEROS_V4 srvtab file to use.
30
31              Parameters
32
33                     • context – is the SASL connection context
34
35                     • plugin_name – is the plugin this value is for.
36
37                     • option  – is a string representing the option. A common
38                       option that all server applications  should  handle  is
39                       the  method  for checking plaintext passwords.  See the
40                       administrators guide for a full description of this op‐
41                       tion.
42
43              Memory  management  of  options  supplied by the getopt callback
44              should be done by the application, however, any requested option
45              must  remain  available  until  the callback is no longer valid.
46              That is, when sasl_dispose(3) is called for a the connection  it
47              is associated with,  or  sasl_done(3) is called for global call‐
48              backs.
49

RETURN VALUE

51       SASL callback functions should return SASL return  codes.   See  sasl.h
52       for a complete list. SASL_OK indicates success.
53
54       Other return codes indicate errors and should be handled.
55

SEE ALSO

57       RFC 4422,:saslman:sasl(3), sasl_errors(3) sasl_callbacks(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_GETOPT_T(3)
Impressum