xref: /illumos-gate/usr/src/man/man3sasl/sasl_server_step.3sasl (revision 6e6545bfaed3bab9ce836ee82d1abd8f2edba89a)
te
Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved.
Portions Copyright (C) 2003, Sun Microsystems,
Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
SASL_SERVER_STEP 3SASL "Oct 14, 2003"
NAME
sasl_server_step - perform a step in the server authentication negotiation
SYNOPSIS

cc [ flag ... ] file ... -lsasl [ library ... ]
#include <sasl/sasl.h>

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

The sasl_server_step() performs a step in the authentication negotiation.

PARAMETERS
conn

The SASL context for this connection.

clientin

The data given by the client. The data is decoded if the protocol encodes requests that are sent over the wire.

clientinlen

The length of clientin.

serverout

serveroutlen

Set by the library and sent to the client.

RETURN VALUES

sasl_server_step() returns an integer that corresponds to a SASL error code.

ERRORS
SASL_OK

The whole authentication completed successfully.

SASL_CONTINUE

The call to sasl_server_step() was successful, and at least one more step is needed for the authentication.

All other error codes indicate an error situation that you must handle, or you should quit the authentication session. See sasl_errors(3SASL) for information on SASL error codes.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe
SEE ALSO

sasl_errors(3SASL), attributes(5)