xref: /freebsd/contrib/openpam/doc/man/openpam_ttyconv.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\" Generated from openpam_ttyconv.c by gendoc.pl
2.Dd June 27, 2023
3.Dt OPENPAM_TTYCONV 3
4.Os
5.Sh NAME
6.Nm openpam_ttyconv
7.Nd simple tty-based conversation function
8.Sh SYNOPSIS
9.In sys/types.h
10.In security/pam_appl.h
11.In security/openpam.h
12.Ft "int"
13.Fn openpam_ttyconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
14.Sh DESCRIPTION
15The
16.Fn openpam_ttyconv
17function is a standard conversation function
18suitable for use on TTY devices.
19It should be adequate for the needs of most text-based interactive
20programs.
21.Pp
22The
23.Fn openpam_ttyconv
24function allows the application to specify a
25timeout for user input by setting the global integer variable
26.Va openpam_ttyconv_timeout
27to the length of the timeout in seconds.
28.Pp
29.Sh RETURN VALUES
30The
31.Fn openpam_ttyconv
32function returns one of the following values:
33.Bl -tag -width 18n
34.It Bq Er PAM_SUCCESS
35Success.
36.It Bq Er PAM_BUF_ERR
37Memory buffer error.
38.It Bq Er PAM_CONV_ERR
39Conversation failure.
40.It Bq Er PAM_SYSTEM_ERR
41System error.
42.El
43.Sh SEE ALSO
44.Xr openpam_nullconv 3 ,
45.Xr pam 3 ,
46.Xr pam_prompt 3 ,
47.Xr pam_strerror 3 ,
48.Xr pam_vprompt 3
49.Sh STANDARDS
50The
51.Fn openpam_ttyconv
52function is an OpenPAM extension.
53.Sh AUTHORS
54The
55.Fn openpam_ttyconv
56function and this manual page were
57developed for the
58.Fx
59Project by ThinkSec AS and Network Associates Laboratories, the
60Security Research Division of Network Associates, Inc.\& under
61DARPA/SPAWAR contract N66001-01-C-8035
62.Pq Dq CBOSS ,
63as part of the DARPA CHATS research program.
64.Pp
65The OpenPAM library is maintained by
66.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
67