Index for Section 3

Alphabetical listing for S

Bottom of page

sasl_server_step(3)
NAME
  sasl_server_step - Perform a step in the authentication negotiation

SYNOPSIS
  #include <sasl.h>

  int sasl_server_step(
	  sasl_conn_t *conn,
	  const char *clientin,
	  unsigned clientinlen,
	  char **serverout,
	  unsigned *serveroutlen,
	  const char **errstr);

DESCRIPTION
  sasl_server_step performs a step in the authentication negotiation. It
  returns SASL_OK if the whole negotiation is successful and SASL_CONTINUE if
  this step is OK but at least one more step is needed.

  errstr is sometimes returned on error and gives a mechanism specific reason
  for failure. This information should not be given to the client.

  conn is the SASL connection context.

  clientin is the data given by the client (decoded if the protocol encodes
  requests sent over the wire).

  clientinlen is the length of clientin.

  serverout is allocated by the library and should be sent to the client.

  serveroutlen is allocated by the library and is the length of serverout.

RETURN VALUE
  sasl_server_step returns an integer which corresponds to one of the
  following codes. SASL_CONTINUE indicates success and that there are more
  steps needed in the authentication. 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_errors(3), sasl_server_init(3), sasl_server_new(3),
  sasl_server_start(3)

Index for Section 3

Alphabetical listing for S

Top of page