Index for Section 3

Alphabetical listing for S

Bottom of page

sasl_listmech(3)
NAME
  sasl_listmech - Retrieve a list of the supported SASL mechanisms

SYNOPSIS
  #include <sasl.h>

  int sasl_listmech(
	  sasl_conn_t *conn,
	  const char *user,
	  const char *prefix,
	  const char *sep,
	  const char *suffix,
	  char **result,
	  unsigned *plen,
	  unsigned *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 is the SASL context for this connection.	 user (optional) restricts
  the mechanism list to only those available to the user.  prefix is the
  string prepended to result.  sep is the separator string between mechanisms
  in result.  suffix is the string appended to result.	result is a NULL
  terminated result string (allocated by library).  plen is the length of
  result filled in by library. May be NULL.  pcount is the number of
  mechanisms available. 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
  sasl_listmech returns an integer which corresponds to one of the following
  codes. SASL_OK indicates that the authentication is complete. All other
  return codes indicate errors and should either be handled or the
  authentication session should be quit.

ERRORS
  SASL_OK
       Success. Authentication complete

  SASL_CONTINUE
       Success. keep going.

  SASL_INTERACT
       User interaction needed to fill in prompt_need list

  SASL_BADVERS
       Mechanism version mismatch

  SASL_BADPARAM
       Error in config file

  SASL_NOMEM
       Not enough memory to complete operation

CONFORMING TO
  RFC 2222

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

Index for Section 3

Alphabetical listing for S

Top of page