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