xref: /src/external/bsd/openpam/dist/doc/man/pam_prompt.3

<<<<<<< pam_prompt.3
.\"	$NetBSD: pam_prompt.3,v 1.5 2014/10/24 18:17:56 christos Exp $
.\"
=======
>>>>>>> 1.1.1.4
.\" Generated from pam_prompt.c by gendoc.pl
.\" Id: pam_prompt.c 648 2013-03-05 17:54:27Z des 
.Dd September 12, 2014
.Dt PAM_PROMPT 3
.Os
.Sh NAME
.Nm pam_prompt
.Nd call the conversation function
.Sh LIBRARY
.Lb libpam
.Sh SYNOPSIS
.In sys/types.h
.In security/pam_appl.h
.Ft "int"
.Fn pam_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
.Sh DESCRIPTION
The
.Fn pam_prompt
function constructs a message from the specified format
string and arguments and passes it to the given PAM context's
conversation function.
.Pp
A pointer to the response, or
.Dv NULL
if the conversation function did
not return one, is stored in the location pointed to by the
.Fa resp
argument.
.Pp
See
.Xr pam_vprompt 3
for further details.
.Sh RETURN VALUES
The
.Fn pam_prompt
function returns one of the following values:
.Bl -tag -width 18n
.It Bq Er PAM_BUF_ERR
Memory buffer error.
.It Bq Er PAM_CONV_ERR
Conversation failure.
.It Bq Er PAM_SYSTEM_ERR
System error.
.El
.Sh SEE ALSO
.Xr pam 3 ,
.Xr pam_error 3 ,
.Xr pam_info 3 ,
.Xr pam_strerror 3 ,
.Xr pam_vprompt 3
.Sh STANDARDS
The
.Fn pam_prompt
function is an OpenPAM extension.
.Sh AUTHORS
The
.Fn pam_prompt
function and this manual page were
developed for the
.Fx
Project by ThinkSec AS and Network Associates Laboratories, the
Security Research Division of Network Associates, Inc.\& under
DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.
.Pp
The OpenPAM library is maintained by
.An Dag-Erling Sm\(/orgrav Aq des (a] des.no .