1.\"- 2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 3.\" Copyright (c) 2004-2011 Dag-Erling Smørgrav 4.\" All rights reserved. 5.\" 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. 10.\" 11.\" Redistribution and use in source and binary forms, with or without 12.\" modification, are permitted provided that the following conditions 13.\" are met: 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 21.\" permission. 22.\" 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 33.\" SUCH DAMAGE. 34.\" 35.\" $Id$ 36.\" 37.Dd May 26, 2012 38.Dt PAM_PROMPT 3 39.Os 40.Sh NAME 41.Nm pam_prompt 42.Nd call the conversation function 43.Sh LIBRARY 44.Lb libpam 45.Sh SYNOPSIS 46.In sys/types.h 47.In security/pam_appl.h 48.Ft "int" 49.Fn pam_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..." 50.Sh DESCRIPTION 51The 52.Fn pam_prompt 53function constructs a message from the specified format 54string and arguments and passes it to the given PAM context's 55conversation function. 56.Pp 57A pointer to the response, or 58.Dv NULL 59if the conversation function did 60not return one, is stored in the location pointed to by the 61.Fa resp 62argument. 63.Pp 64See 65.Xr pam_vprompt 3 66for further details. 67.Pp 68.Sh RETURN VALUES 69The 70.Fn pam_prompt 71function returns one of the following values: 72.Bl -tag -width 18n 73.It Bq Er PAM_BUF_ERR 74Memory buffer error. 75.It Bq Er PAM_CONV_ERR 76Conversation failure. 77.It Bq Er PAM_SYSTEM_ERR 78System error. 79.El 80.Sh SEE ALSO 81.Xr pam 3 , 82.Xr pam_error 3 , 83.Xr pam_info 3 , 84.Xr pam_strerror 3 , 85.Xr pam_vprompt 3 86.Sh STANDARDS 87The 88.Fn pam_prompt 89function is an OpenPAM extension. 90.Sh AUTHORS 91The 92.Fn pam_prompt 93function and this manual page were 94developed for the 95.Fx 96Project by ThinkSec AS and Network Associates Laboratories, the 97Security Research Division of Network Associates, Inc.\& under 98DARPA/SPAWAR contract N66001-01-C-8035 99.Pq Dq CBOSS , 100as part of the DARPA CHATS research program. 101