Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_listmech (3sasl)

Name

sasl_listmech - Retrieve a list of the supported SASL mechanisms

Synopsis

#include <sasl/sasl.h>


int sasl_listmech(sasl_conn_t *conn,
const char *user,
const char *prefix,
const char *sep,
const char *suffix,
const char **result,
unsigned *plen,
int *pcount);

Description

sasl_listmech(3sasl)            SASL man pages            sasl_listmech(3sasl)



NAME
       sasl_listmech - Retrieve a list of the supported SASL mechanisms

SYNOPSIS
       #include <sasl/sasl.h>


       int sasl_listmech(sasl_conn_t *conn,
                        const char *user,
                        const char *prefix,
                        const char *sep,
                        const char *suffix,
                        const char **result,
                        unsigned *plen,
                        int *pcount);


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

       conn the SASL context for this connection user (optional) restricts the
       mechanism list to only those available to the user.  prefix appended to
       beginning  of result sep appended between mechanisms suffix appended to
       end of result result NULL terminated result string (allocated/freed  by
       library) plen length of result filled in by library. May be NULL pcount
       Number of mechanisms available (filled in by library). May be NULL

       Example:

       sasl_listmech(conn,NULL,"(",",",")",&mechlist,NULL,NULL);

       may give the string
       (ANONYMOUS,KERBEROS_V4,DIGEST-MD5)
       as a result

RETURN VALUE
       Returns SASL_OK on success. SASL error code on failure.


CONFORMING TO
       RFC 4422


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------------------+
       |ATTRIBUTE TYPE |         ATTRIBUTE VALUE          |
       +---------------+----------------------------------+
       |Availability   | system/library/security/libsasl2 |
       +---------------+----------------------------------+
       |Stability      | Pass-through volatile            |
       +---------------+----------------------------------+

SEE ALSO
       sasl(3SASL),        sasl_errors(3SASL),         sasl_server_new(3SASL),
       sasl_client_new(3SASL)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source  was  downloaded from  ftp://ftp.cyrusimap.org/cyrus-sasl/cyrus-
       sasl-2.1.26.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.cyrusimap.org/sasl/.



SASL                             10 July 2001             sasl_listmech(3sasl)