Home | History | Annotate | Line # | Download | only in man
pam_vprompt.3 revision 1.2.8.2 
 $NetBSD: pam_vprompt.3,v 1.2.8.2 2014/08/19 23:52:06 tls Exp $

 Generated from pam_vprompt.c by gendoc.pl
 Id: pam_vprompt.c 648 2013-03-05 17:54:27Z des 
.Dd September 7, 2013
.Dt PAM_VPROMPT 3
.Os
.Sh NAME
.Nm pam_vprompt
.Nd call the conversation function
.Sh LIBRARY
.Lb libpam
.Sh SYNOPSIS
n sys/types.h n security/pam_appl.h .Ft "int"
.Fn pam_vprompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap"
.Sh DESCRIPTION
The
.Fn pam_vprompt
function constructs a string from the
.Fa fmt
and
.Fa ap
arguments using
.Xr vsnprintf 3 ,
and passes it to the given PAM context's
conversation function.

p
The
.Fa style
argument specifies the type of interaction requested, and
must be one of the following:
l -tag -width 18n t Dv PAM_PROMPT_ECHO_OFF Display the message and obtain the user's response without
displaying it.
t Dv PAM_PROMPT_ECHO_ON Display the message and obtain the user's response.
t Dv PAM_ERROR_MSG Display the message as an error message, and do not wait
for a response.
t Dv PAM_TEXT_INFO Display the message as an informational message, and do
not wait for a response.
.El

p
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.

p
The message and response should not exceed
.Dv PAM_MAX_MSG_SIZE
or
.Dv PAM_MAX_RESP_SIZE ,
respectively.
If they do, they may be truncated.
.Sh RETURN VALUES
The
.Fn pam_vprompt
function returns one of the following values:
l -tag -width 18n t Bq Er PAM_BUF_ERR Memory buffer error.
t Bq Er PAM_CONV_ERR Conversation failure.
t Bq Er PAM_SYSTEM_ERR System error.
.El
.Sh SEE ALSO
.Xr pam 3 ,
.Xr pam_error 3 ,
.Xr pam_info 3 ,
.Xr pam_prompt 3 ,
.Xr pam_strerror 3 ,
.Xr pam_verror 3 ,
.Xr pam_vinfo 3 ,
.Xr vsnprintf 3
.Sh STANDARDS
The
.Fn pam_vprompt
function is an OpenPAM extension.
.Sh AUTHORS
The
.Fn pam_vprompt
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

q Dq CBOSS ,
as part of the DARPA CHATS research program.

p
The OpenPAM library is maintained by
.An Dag-Erling Sm\(/orgrav Aq des (at] des.no .