1.\"- 2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 3.\" Copyright (c) 2004-2007 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.\" $P4$ 36.\" 37.Dd December 21, 2007 38.Dt OPENPAM_TTYCONV 3 39.Os 40.Sh NAME 41.Nm openpam_ttyconv 42.Nd simple tty-based conversation function 43.Sh LIBRARY 44.Lb libpam 45.Sh SYNOPSIS 46.In sys/types.h 47.In security/pam_appl.h 48.In security/openpam.h 49.Ft "int" 50.Fn openpam_ttyconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data" 51.Sh DESCRIPTION 52The 53.Nm 54function is a standard conversation function 55suitable for use on TTY devices. 56It should be adequate for the needs of most text-based interactive 57programs. 58.Pp 59The 60.Nm 61function allows the application to specify a 62timeout for user input by setting the global integer variable 63.Va openpam_ttyconv_timeout 64to the length of the timeout in seconds. 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 openpam_nullconv 3 , 80.Xr pam 3 , 81.Xr pam_prompt 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 92.Fx 93Project by ThinkSec AS and Network Associates Laboratories, the 94Security Research Division of Network Associates, Inc.\& under 95DARPA/SPAWAR contract N66001-01-C-8035 96.Pq Dq CBOSS , 97as part of the DARPA CHATS research program. 98