Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_server_step (3sasl)

Name

sasl_server_step - Perform a step in the authentication negotiation

Synopsis

#include <sasl/sasl.h>

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

Description

sasl_server_step(3sasl)         SASL man pages         sasl_server_step(3sasl)



NAME
       sasl_server_step - Perform a step in the authentication negotiation



SYNOPSIS
       #include <sasl/sasl.h>

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



DESCRIPTION
       sasl_server_step()  performs  a step in the authentication negotiation.
       It returns SASL_OK if the whole negotiation is successful and SASL_CON-
       TINUE if this step is ok but at least one more step is needed.


       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  cli-
       entin

       serverout and serveroutlen are set by the library and should be sent to
       the client.

RETURN VALUE
       sasl_server_step returns an integer which corresponds  to  one  of  the
       SASL  error  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.


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_init(3SASL),
       sasl_server_new(3SASL), sasl_server_start(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_server_step(3sasl)