sasl_client_step - Perform a step in the authentication negotiation
#include <sasl/sasl.h> int sasl_client_step(sasl_conn_t *conn, const char *serverin, unsigned serverinlen, sasl_interact_t ** prompt_need, const char ** clientout, unsigned * clientoutlen);
sasl_client_step(3sasl) SASL man pages sasl_client_step(3sasl)
NAME
sasl_client_step - Perform a step in the authentication negotiation
SYNOPSIS
#include <sasl/sasl.h>
int sasl_client_step(sasl_conn_t *conn,
const char *serverin,
unsigned serverinlen,
sasl_interact_t ** prompt_need,
const char ** clientout,
unsigned * clientoutlen);
DESCRIPTION
sasl_client_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. A client
should not assume an authentication negotiation is successful just
because the server signaled success via protocol (i.e. if the server
said ". OK Authentication succeeded" in IMAP sasl_client_step should
still be called one more time with a serverinlen of zero.
If SASL_INTERACT is returned the library needs some values to be filled
in before it can proceed. The prompt_need structure will be filled in
with requests. The application should fulfill these requests and call
sasl_client_start again with identical parameters (the prompt_need
parameter will be the same pointer as before but filled in by the
application).
conn is the SASL connection context
serverin is the data given by the server (decoded if the protocol
encodes requests sent over the wire)
serverinlen is the length of serverin
clientout and clientoutlen is created. It is the initial client
response to send to the server. It is the job of the client to send it
over the network to the server. Any protocol specific encoding (such
as base64 encoding) necessary needs to be done by the client.
RETURN VALUE
sasl_client_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.
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_callbacks(3SASL), sasl_errors(3SASL),
sasl_client_init(3SASL), sasl_client_new(3SASL),
sasl_client_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_client_step(3sasl)