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.\" 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 December 12, 2002 37.Dt PAM_PROMPT 3 38.Os 39.Sh NAME 40.Nm pam_prompt 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_prompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..." 48.Sh DESCRIPTION 49The 50.Nm 51function constructs a message from the specified format 52string and arguments and passes it to the given PAM context's 53conversation function. 54.Pp 55A pointer to the response, or 56.Dv NULL 57if the conversation function did 58not return one, is stored in the location pointed to by the 59.Va resp 60argument. 61.Pp 62See 63.Xr pam_vprompt 3 64for further details. 65.Pp 66.Sh RETURN VALUES 67The 68.Nm 69function returns one of the following values: 70.Bl -tag -width 18n 71.It Bq Er PAM_BUF_ERR 72Memory buffer error. 73.It Bq Er PAM_CONV_ERR 74Conversation failure. 75.It Bq Er PAM_SYSTEM_ERR 76System error. 77.El 78.Sh SEE ALSO 79.Xr pam 3 , 80.Xr pam_error 3 , 81.Xr pam_info 3 , 82.Xr pam_strerror 3 , 83.Xr pam_vprompt 3 84.Sh STANDARDS 85The 86.Nm 87function is an OpenPAM extension. 88.Sh AUTHORS 89The 90.Nm 91function and this manual page were developed for the FreeBSD Project 92by ThinkSec AS and Network Associates Laboratories, the Security 93Research Division of Network Associates, Inc. under DARPA/SPAWAR 94contract N66001-01-C-8035 95.Pq Dq CBOSS , 96as part of the DARPA CHATS research program. 97