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