'\" te
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
.TH sasl_server_start 3SASL "1 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
.SH NAME
sasl_server_start \- create a new server authentication object
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
#include <sasl/sasl.h>

\fBint\fR \fBsasl_server_start\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBconst char  *\fR\fImech\fR,
     \fBconst char  *\fR\fIclientin\fR,\ \fBunsigned *\fR\fIclientinlen\fR,
     \fBconst char  **\fR\fIserverout\fR, \fBunsigned *\fR\fIserveroutlen\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBsasl_server_start()\fR interface begins the authentication with the mechanism specified by the \fImech\fR parameter. \fBsasl_server_start()\fR fails if the mechanism is not supported. 
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIconn\fR\fR
.ad
.RS 16n
.rt  
The SASL context for this connection.
.RE

.sp
.ne 2
.mk
.na
\fB\fImech\fR\fR
.ad
.RS 16n
.rt  
The mechanism name that the client requested.
.RE

.sp
.ne 2
.mk
.na
\fB\fIclientin\fR\fR
.ad
.RS 16n
.rt  
The initial response from the client. The value of \fIclientin\fR is \fINULL\fR if the protocol lacks support for the client-send-first or if the other end did not have an initial send. No initial client send is distinct from an initial send of a null string. The protocol must account for this difference.
.RE

.sp
.ne 2
.mk
.na
\fB\fIclientinlen\fR\fR
.ad
.RS 16n
.rt  
The length of the initial response.
.RE

.sp
.ne 2
.mk
.na
\fB\fIserverout\fR\fR
.ad
.RS 16n
.rt  
Created by the plugin library. The value of \fIserverout\fR is the initial server response to send to the client. \fIserverout\fR is allocated or freed by the library. It is the job of the client to send it over the network to the server. Protocol specific encoding, for example \fBbase64\fR encoding, must be done by the server.
.RE

.sp
.ne 2
.mk
.na
\fB\fIserveroutlen\fR\fR
.ad
.RS 16n
.rt  
The length of the initial server challenge.
.RE

.SH RETURN VALUES
.sp
.LP
\fBsasl_server_start()\fR returns an integer that corresponds to a SASL error code.
.SH ERRORS
.sp
.ne 2
.mk
.na
\fB\fBSASL_OK\fR\fR
.ad
.RS 17n
.rt  
Authentication completed successfully.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_CONTINUE\fR\fR
.ad
.RS 17n
.rt  
The call to \fBsasl_server_start()\fR was successful, and more steps are needed in the authentication.
.RE

.sp
.LP
All other error codes indicate an error situation that must be handled, or the authentication session should be quit. See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilitysystem/library/security/libsasl
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBgethostname\fR(3C), \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)