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

NAME

6       sasl_listmech - Cyrus SASL documentation
7

SYNOPSIS

9       #include <sasl/sasl.h>
10
11       int sasl_listmech(sasl_conn_t *conn,
12                        const char *user,
13                        const char *prefix,
14                        const char *sep,
15                        const char *suffix,
16                        const char **result,
17                        unsigned *plen,
18                        int *pcount);
19

DESCRIPTION

21       int sasl_listmech(sasl_conn_t *conn,
22
23       const char *user,
24
25       const char *prefix,
26
27       const char *sep,
28
29       const char *suffix,
30
31       const char **result,
32
33       unsigned *plen,
34
35       int *pcount);
36              sasl_listmech returns a string listing the SASL names of all the
37              mechanisms available to the specified user.  This  is  typically
38              given  to  the  client  through  a capability command or initial
39              server response. Client applications need this list so that they
40              know what mechanisms the server supports.
41
42              Parameters
43
44                     • conn – the SASL context for this connection
45
46                     • user  – (optional) restricts the mechanism list to only
47                       those available to the user.
48
49                     • prefix – appended to beginning of result
50
51                     • sep – appended between mechanisms
52
53                     • suffix – appended to end of result
54
55                     • result – NULL terminated result string (allocated/freed
56                       by library)
57
58                     • plen  –  length  of result filled in by library. May be
59                       NULL
60
61                     • pcount – Number of mechanisms available (filled  in  by
62                       library).  May be NULL
63

EXAMPLE

65       sasl_listmech(conn,NULL,"(",",",")",&mechlist,NULL,NULL);
66
67       may give the following string as a result:
68          (ANONYMOUS,KERBEROS_V4,DIGEST‐MD5)
69

RETURN VALUE

71       SASL  functions should return SASL return codes.  See sasl.h for a com‐
72       plete list. SASL_OK indicates success.
73

SEE ALSO

75       RFC    4422,:saslman:sasl(3),    sasl_server_new(3),    sasl_errors(3),
76       sasl_client_new(3)
77

AUTHOR

79       The Cyrus Team
80

82       1993-2016, The Cyrus Team
83
84
85
86
872.1.28                         February 18, 2022              SASL_LISTMECH(3)
Impressum