2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3 .\" All rights reserved.
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.
10 .\" Redistribution and use in source and binary forms, with or without
11 .\" modification, are permitted provided that the following conditions
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
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
41 .Nd call the conversation function
46 .In security/pam_appl.h
48 .Fn pam_vprompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap"
52 function constructs a string from the
58 and passes it to the given PAM context's
59 conversation function.
63 argument specifies the type of interaction requested, and
64 must be one of the following:
66 .It Dv PAM_PROMPT_ECHO_OFF
67 Display the message and obtain the user's response without
69 .It Dv PAM_PROMPT_ECHO_ON
70 Display the message and obtain the user's response.
72 Display the message as an error message, and do not wait
75 Display the message as an informational message, and do
76 not wait for a response.
79 A pointer to the response, or
81 if the conversation function did
82 not return one, is stored in the location pointed to by the
86 The message and response should not exceed
89 .Dv PAM_MAX_RESP_SIZE ,
91 If they do, they may be truncated.
96 function returns one of the following values:
100 .It Bq Er PAM_CONV_ERR
101 Conversation failure.
102 .It Bq Er PAM_SYSTEM_ERR
117 function is an OpenPAM extension.
121 function and this manual page were developed for the
123 Project by ThinkSec AS and Network Associates Laboratories, the
124 Security Research Division of Network Associates, Inc.& under
125 DARPA/SPAWAR contract N66001-01-C-8035
127 as part of the DARPA CHATS research program.