1.\"- 2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 3.\" All rights reserved. 4.\" 5.\" This software was developed for the FreeBSD Project by ThinkSec AS and 6.\" Network Associates Laboratories, the Security Research Division of 7.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 8.\" ("CBOSS"), as part of the DARPA CHATS research program. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. The name of the author may not be used to endorse or promote 19.\" products derived from this software without specific prior written 20.\" permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" $P4$ 35.\" 36.Dd June 16, 2005 37.Dt PAM_VPROMPT 3 38.Os 39.Sh NAME 40.Nm pam_vprompt 41.Nd call the conversation function 42.Sh LIBRARY 43.Lb libpam 44.Sh SYNOPSIS 45.In sys/types.h 46.In security/pam_appl.h 47.Ft "int" 48.Fn pam_vprompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap" 49.Sh DESCRIPTION 50The 51.Nm 52function constructs a string from the 53.Fa fmt 54and 55.Fa ap 56arguments using 57.Xr vsnprintf 3 , 58and passes it to the given PAM context's 59conversation function. 60.Pp 61The 62.Fa style 63argument specifies the type of interaction requested, and 64must be one of the following: 65.Bl -tag -width 18n 66.It Dv PAM_PROMPT_ECHO_OFF 67Display the message and obtain the user's response without 68displaying it. 69.It Dv PAM_PROMPT_ECHO_ON 70Display the message and obtain the user's response. 71.It Dv PAM_ERROR_MSG 72Display the message as an error message, and do not wait 73for a response. 74.It Dv PAM_TEXT_INFO 75Display the message as an informational message, and do 76not wait for a response. 77.El 78.Pp 79A pointer to the response, or 80.Dv NULL 81if the conversation function did 82not return one, is stored in the location pointed to by the 83.Fa resp 84argument. 85.Pp 86The message and response should not exceed 87.Dv PAM_MAX_MSG_SIZE 88or 89.Dv PAM_MAX_RESP_SIZE , 90respectively. 91If they do, they may be truncated. 92.Pp 93.Sh RETURN VALUES 94The 95.Nm 96function returns one of the following values: 97.Bl -tag -width 18n 98.It Bq Er PAM_BUF_ERR 99Memory buffer error. 100.It Bq Er PAM_CONV_ERR 101Conversation failure. 102.It Bq Er PAM_SYSTEM_ERR 103System error. 104.El 105.Sh SEE ALSO 106.Xr pam 3 , 107.Xr pam_error 3 , 108.Xr pam_info 3 , 109.Xr pam_prompt 3 , 110.Xr pam_strerror 3 , 111.Xr pam_verror 3 , 112.Xr pam_vinfo 3 , 113.Xr vsnprintf 3 114.Sh STANDARDS 115The 116.Nm 117function is an OpenPAM extension. 118.Sh AUTHORS 119The 120.Nm 121function and this manual page were developed for the 122.Fx 123Project by ThinkSec AS and Network Associates Laboratories, the 124Security Research Division of Network Associates, Inc.& under 125DARPA/SPAWAR contract N66001-01-C-8035 126.Pq Dq CBOSS , 127as part of the DARPA CHATS research program. 128