1.\"- 2.\" Copyright (c) 2002 Networks Associates Technology, Inc. 3.\" All rights reserved. 4.\" 5.\" This software was developed for the FreeBSD Project by ThinkSec AS and 6.\" NAI Labs, the Security Research Division of Network Associates, Inc. 7.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the 8.\" 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: //depot/projects/openpam/doc/man/pam_vprompt.3#10 $ 35.\" 36.Dd May 2, 2002 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 security/pam_appl.h 46.Ft int 47.Fn pam_vprompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap" 48.Sh DESCRIPTION 49The 50.Nm 51function constructs a string from the 52.Va fmt 53and 54.Va ap 55arguments using 56.Xr vsnprintf 3 , 57and passes it to the given PAM context's 58conversation function. 59.Pp 60The 61.Va style 62argument specifies the type of interaction requested, and 63must be one of the following: 64.Bl -tag -width 18n 65.It Dv PAM_PROMPT_ECHO_OFF 66Display the message and obtain the user's response without 67displaying it. 68.It Dv PAM_PROMPT_ECHO_ON 69Display the message and obtain the user's response. 70.It Dv PAM_ERROR_MSG 71Display the message as an error message, and do not wait 72for a response. 73.It Dv PAM_TEXT_INFO 74Display the message as an informational message, and do 75not wait for a response. 76.El 77A pointer to the response, or 78.Dv NULL 79if the conversation function did 80not return one, is stored in the location pointed to by the 81.Va resp 82argument. 83.Pp 84The message and response should not exceed 85.Dv PAM_MAX_MSG_SIZE 86or 87.Dv PAM_MAX_RESP_SIZE , 88respectively. 89If they do, they may be truncated. 90.Pp 91.Sh RETURN VALUES 92The 93.Nm 94function returns one of the following values: 95.Bl -tag -width 18n 96.It Bq Er PAM_BUF_ERR 97Memory buffer error. 98.It Bq Er PAM_CONV_ERR 99Conversation failure. 100.It Bq Er PAM_SYSTEM_ERR 101System error. 102.El 103.Sh SEE ALSO 104.Xr pam 3 , 105.Xr pam_error 3 , 106.Xr pam_info 3 , 107.Xr pam_prompt 3 , 108.Xr pam_strerror 3 , 109.Xr pam_verror 3 , 110.Xr pam_vinfo 3 , 111.Xr vsnprintf 3 112.Sh STANDARDS 113The 114.Nm 115function is an OpenPAM extension. 116.Sh AUTHORS 117The 118.Nm 119function and this manual page were developed for the FreeBSD Project 120by ThinkSec AS and NAI Labs, the Security Research Division of Network 121Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 122.Pq Dq CBOSS , 123as part of the DARPA CHATS research program. 124