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