xref: /netbsd-src/external/bsd/openpam/dist/doc/man/openpam_ttyconv.3 (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1.\"	$NetBSD: openpam_ttyconv.3,v 1.4 2013/12/27 20:10:20 christos Exp $
2.\"
3.\" Generated from openpam_ttyconv.c by gendoc.pl
4.\" Id: openpam_ttyconv.c 688 2013-07-11 16:40:08Z des
5.Dd September 7, 2013
6.Dt OPENPAM_TTYCONV 3
7.Os
8.Sh NAME
9.Nm openpam_ttyconv
10.Nd simple tty-based conversation function
11.Sh LIBRARY
12.Lb libpam
13.Sh SYNOPSIS
14.In sys/types.h
15.In security/pam_appl.h
16.In security/openpam.h
17.Ft "int"
18.Fn openpam_ttyconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
19.Sh DESCRIPTION
20The
21.Fn openpam_ttyconv
22function is a standard conversation function
23suitable for use on TTY devices.
24It should be adequate for the needs of most text-based interactive
25programs.
26.Pp
27The
28.Fn openpam_ttyconv
29function allows the application to specify a
30timeout for user input by setting the global integer variable
31.Va openpam_ttyconv_timeout
32to the length of the timeout in seconds.
33.Pp
34.Sh RETURN VALUES
35The
36.Fn openpam_ttyconv
37function returns one of the following values:
38.Bl -tag -width 18n
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 des@des.no .
71