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