.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gsasl_client_step" 3 "1.10.0" "gsasl" "gsasl"
.SH NAME
gsasl_client_step \- API function
.SH SYNOPSIS
.B #include <gsasl.h>
.sp
.BI "int gsasl_client_step(Gsasl_session * " sctx ", const char * " input ", size_t " input_len ", char * " output ", size_t * " output_len ");"
.SH ARGUMENTS
.IP "Gsasl_session * sctx" 12
libgsasl client handle.
.IP "const char * input" 12
input byte array.
.IP "size_t input_len" 12
size of input byte array.
.IP "char * output" 12
output byte array.
.IP "size_t * output_len" 12
size of output byte array.
.SH "DESCRIPTION"
Perform one step of SASL authentication in client.  This reads data
from server (specified with input and input_len), processes it
(potentially invoking callbacks to the application), and writes
data to server (into variables output and output_len).

The contents of the output buffer is unspecified if this functions
returns anything other than \fBGSASL_NEEDS_MORE\fP.

Return value: Returns \fBGSASL_OK\fP if authenticated terminated
successfully, \fBGSASL_NEEDS_MORE\fP if more data is needed, or error
code.
.SH "DEPRECATED"
Use \fBgsasl_step()\fP instead.
.SH "REPORTING BUGS"
Report bugs to <bug-gsasl@gnu.org>.
.br
General guidelines for reporting bugs: http://www.gnu.org/gethelp/
.br
GNU SASL home page: http://www.gnu.org/software/gsasl/

.SH COPYRIGHT
Copyright \(co 2002-2021 Simon Josefsson.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gsasl
is maintained as a Texinfo manual.  If the
.B info
and
.B gsasl
programs are properly installed at your site, the command
.IP
.B info gsasl
.PP
should give you access to the complete manual.
As an alternative you may obtain the manual from:
.IP
.B http://www.gnu.org/software/gsasl/manual/
.PP