2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3 .\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
4 .\" All rights reserved.
6 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
7 .\" Network Associates Laboratories, the Security Research Division of
8 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9 .\" ("CBOSS"), as part of the DARPA CHATS research program.
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\" notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\" notice, this list of conditions and the following disclaimer in the
18 .\" documentation and/or other materials provided with the distribution.
19 .\" 3. The name of the author may not be used to endorse or promote
20 .\" products derived from this software without specific prior written
23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42 .Nd call the conversation function
47 .In security/pam_appl.h
49 .Fn pam_vprompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap"
53 function constructs a string from the
59 and passes it to the given PAM context's
60 conversation function.
64 argument specifies the type of interaction requested, and
65 must be one of the following:
67 .It Dv PAM_PROMPT_ECHO_OFF
68 Display the message and obtain the user's response without
70 .It Dv PAM_PROMPT_ECHO_ON
71 Display the message and obtain the user's response.
73 Display the message as an error message, and do not wait
76 Display the message as an informational message, and do
77 not wait for a response.
80 A pointer to the response, or
82 if the conversation function did
83 not return one, is stored in the location pointed to by the
87 The message and response should not exceed
90 .Dv PAM_MAX_RESP_SIZE ,
92 If they do, they may be truncated.
97 function returns one of the following values:
101 .It Bq Er PAM_CONV_ERR
102 Conversation failure.
103 .It Bq Er PAM_SYSTEM_ERR
118 function is an OpenPAM extension.
122 function and this manual page were
125 Project by ThinkSec AS and Network Associates Laboratories, the
126 Security Research Division of Network Associates, Inc.\& under
127 DARPA/SPAWAR contract N66001-01-C-8035
129 as part of the DARPA CHATS research program.