sasl_listmech(3sasl)

1sasl_listmechS(i3mSpAlSeL)Authentication Security Layer Library Fusnacstli_olnisstmech(3SASL)
2
3
4

NAME

6       sasl_listmech - retrieve a list of the supported SASL mechanisms
7

SYNOPSIS

9       cc [ flag ... ] file ... -lsasl   [ library ... ]
10       #include <sasl/sasl.h>
11
12       int sasl_listmech(sasl_conn_t *conn, const char *user, const char *prefix,
13            const char *sep, const char *suffix, const char **result,
14            unsigned *plen,int *pcount);
15
16

DESCRIPTION

18       The  sasl_listmech()  interface returns a string listing the SASL names
19       of all the mechanisms available to the specified  user.  This  call  is
20       typically  given  to the client through a capability command or initial
21       server response. Client applications need this list so that  they  know
22       what mechanisms the server supports.
23

PARAMETERS

25       conn      The SASL context for this connection user restricts the mech‐
26                 anism list to those mechanisms available to  the  user.  This
27                 parameter is optional.
28
29
30       user      Restricts  security  mechanisms  to  those  available to that
31                 user. The value of user may be NULL, and it is  not  used  if
32                 called by the client application.
33
34
35       prefix    Appended to the beginning of result.
36
37
38       sep       Appended between mechanisms.
39
40
41       suffix    Appended to the end of result.
42
43
44       result    A  null-terminated result string. result must be allocated or
45                 freed by the library.
46
47
48       plen      The length of the result filled in by the library. The  value
49                 of plen may be NULL.
50
51
52       pcount    The  number  of  mechanisms available. The value of pcount is
53                 filled in by the library. The value of pcount may be NULL
54
55

RETURN VALUES

57       sasl_listmech() returns an integer that corresponds  to  a  SASL  error
58       code.
59

ERRORS

61       SASL_OK    The call to sasl_listmech() was successful.
62
63
64
65       See sasl_errors(3SASL) for information on SASL error codes.
66

ATTRIBUTES

68       See attributes(5) for descriptions of the following attributes:
69
70
71
72
73       ┌─────────────────────────────┬─────────────────────────────┐
74       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
75       ├─────────────────────────────┼─────────────────────────────┤
76       │Availability                 │SUNWlibsasl                  │
77       ├─────────────────────────────┼─────────────────────────────┤
78       │Interface Stability          │Evolving                     │
79       ├─────────────────────────────┼─────────────────────────────┤
80       │MT-Level                     │MT-Safe                      │
81       └─────────────────────────────┴─────────────────────────────┘
82