xref: /illumos-gate/usr/src/man/man3sasl/sasl_chalprompt_t.3sasl (revision ddb365bfc9e868ad24ccdcb0dc91af18b10df082)
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_CHALPROMPT_T 3SASL "Oct 14, 2003"
NAME
sasl_chalprompt_t - prompt for input in response to a challenge
SYNOPSIS

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

int sasl_chalprompt_t(void *context, int id, const char *challenge,
 const char *prompt, const char *defresult, const char **result,
 unsigned *len);
DESCRIPTION

Use the sasl_chalprompt_t() callback interface to prompt for input in response to a server challenge.

PARAMETERS
context

The context from the callback record.

id

The callback id. id can have a value of SASL_CB_ECHOPROMPT or SASL_CB_NOECHOPROMPT

challenge

The server's challenge.

prompt

A prompt for the user.

defresult

The default result. The value of defresult can be NULL

result

The user's response. result is a null-terminated string.

len

The length of the user's response.

RETURN VALUES

Like other SASL callback functions, sasl_chalprompt_t() returns an integer that corresponds to a SASL error code. See <sasl.h> for a complete list of SASL error codes.

ERRORS
SASL_OK

The call to sasl_chalprompt_t() was successful.

See sasl_errors(3SASL) for information on SASL error codes.

ATTRIBUTES

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

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

sasl_errors (3SASL), sasl_server_new (3SASL), attributes (7)