xref: /freebsd/contrib/openpam/doc/man/openpam_ttyconv.3 (revision 74bf4e164ba5851606a27d4feff27717452583e5)
1.\"-
2.\" Copyright (c) 2001-2003 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 February 10, 2004
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 sys/types.h
46.In security/pam_appl.h
47.In security/openpam.h
48.Ft "int"
49.Fn openpam_ttyconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
50.Sh DESCRIPTION
51The
52.Nm
53function is a standard conversation function
54suitable for use on TTY devices.  It should be adequate for the needs
55of most text-based interactive programs.
56.Pp
57The
58.Nm
59function allows the application to specify a
60timeout for user input by setting the global integer variable
61.Va openpam_ttyconv_timeout
62to the length of the timeout in seconds.
63.Pp
64.Sh RETURN VALUES
65The
66.Nm
67function returns one of the following values:
68.Bl -tag -width 18n
69.It Bq Er PAM_BUF_ERR
70Memory buffer error.
71.It Bq Er PAM_CONV_ERR
72Conversation failure.
73.It Bq Er PAM_SYSTEM_ERR
74System error.
75.El
76.Sh SEE ALSO
77.Xr openpam_nullconv 3 ,
78.Xr pam 3 ,
79.Xr pam_prompt 3 ,
80.Xr pam_strerror 3 ,
81.Xr pam_vprompt 3
82.Sh STANDARDS
83The
84.Nm
85function is an OpenPAM extension.
86.Sh AUTHORS
87The
88.Nm
89function and this manual page were developed for the
90.Fx
91Project by ThinkSec AS and Network Associates Laboratories, the
92Security Research Division of Network Associates, Inc.  under
93DARPA/SPAWAR contract N66001-01-C-8035
94.Pq Dq CBOSS ,
95as part of the DARPA CHATS research program.
96