Simple Authentication Security Layer Library Functions
saslclientstep(3SASL)
NAME
saslclientstep - acquire an auxiliary property context
SYNOPSIS
cc [ flag ... ] file ... -lsasl [ library ... ]
#include
int saslclientstep(saslconnt *conn, const char *serverin,
saslinteractt **unsigned serverinlen, promptneed,
const char **clientout, saslinteractt **unsigned *clientoutlen);
DESCRIPTION
Use the saslclientstep() interface performs a step in the
authentication negotiation. saslclientstep() returns
SASLOK if the complete negotiation is successful. If the
negotiation on step is completed successfuly, but at least
one more step is required, saslclientstep() returns
SASLCONTINUE. A client should not assume an authentication
negotiaion is successful because the server signaled success
through the protocol. For example, if the server signaled OK
Authentication succeeded in IMAP, saslclientstep() should
be called one more time with a serverinlen of zero.
If a call to saslclientstep() returns SASLINTERACT, the
library requires some values before saslclientstep() can
proceed. The promptneed structure will be filled with the
requests. The application should fulfull these requests and
call saslclientstep() again with identical parameters. The
promptneed parameter will be the same pointer as before,
but it will have been filled in by the application.
PARAMETERS
conn The SASL connection context.
serverin The data given by the server. The data is
decoded if the protocol encodes requests
sent over the wire.
serverinlen The length of the serverin.
clientout clientout and clientoutlen are created. They
clientoutlen contain the initial client response to send
to the server. It is the job of the client
to send them over the network to the server.
Any protocol specific encodingthat is neces-
sary, for example base64 encoding, must be
SunOS 5.11 Last change: 28 Aug 2003 1
Simple Authentication Security Layer Library Functions
saslclientstep(3SASL)
done by the client.
promptneed A list of prompts that are needed to con-
tinue, if necessary.
RETURN VALUES
saslclientstep() returns an integer that corresponds to a
SASL error code.
ERORS
SASLOK The call to saslclientstart() was suc-
cessful. Authentication is complete.
SASLCONTINUE The call to saslclientstart() was suc-
cessful, but at least one more step is
required for authentication.
SASLINTERACT The library requires some values before
saslclientstep() can proceed.
All other error codes indicate an error situation that must
be handled, or the authentication session should be quit.
See saslerrors(3SASL) for information on SASL error codes.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SunOS 5.11 Last change: 28 Aug 2003 2
Simple Authentication Security Layer Library Functions
saslclientstep(3SASL)
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWlibsasl
Interface Stability Evolving
MT-Level Safe
SEE ALSO
saslerrors(3SASL), attributes(5)
SunOS 5.11 Last change: 28 Aug 2003 3
Simple Authentication Security Layer Library Functions
saslclientstep(3SASL)
SunOS 5.11 Last change: 28 Aug 2003 4
|
