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 June 30, 2002 37.Dt OPENPAM_TTYCONV 3 38.Os 39.Sh NAME 40.Nm openpam_ttyconv 41.Nd simple tty-based conversation function 42.Sh LIBRARY 43.Lb libpam 44.Sh SYNOPSIS 45.In security/pam_appl.h 46.In security/openpam.h 47.Ft int 48.Fn openpam_ttyconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data" 49.Sh DESCRIPTION 50The 51.Nm 52function is a standard conversation function 53suitable for use on TTY devices. It should be adequate for the needs 54of most text-based interactive programs. 55.Pp 56The 57.Nm 58function allows the application to specify a 59timeout for user input by setting the global variable 60.Va openpam_ttyconv_timeout 61to the length of the timeout in seconds. 62.Pp 63.Sh RETURN VALUES 64The 65.Nm 66function returns one of the following values: 67.Bl -tag -width 18n 68.It Bq Er PAM_BUF_ERR 69Memory buffer error. 70.It Bq Er PAM_CONV_ERR 71Conversation failure. 72.It Bq Er PAM_SYSTEM_ERR 73System error. 74.El 75.Sh SEE ALSO 76.Xr openpam_nullconv 3 , 77.Xr pam 3 , 78.Xr pam_prompt 3 , 79.Xr pam_strerror 3 , 80.Xr pam_vprompt 3 81.Sh STANDARDS 82The 83.Nm 84function is an OpenPAM extension. 85.Sh AUTHORS 86The 87.Nm 88function and this manual page were developed for the FreeBSD Project 89by ThinkSec AS and Network Associates Laboratories, the Security 90Research Division of Network Associates, Inc. under DARPA/SPAWAR 91contract N66001-01-C-8035 92.Pq Dq CBOSS , 93as part of the DARPA CHATS research program. 94