xref: /netbsd-src/external/bsd/openpam/dist/doc/man/openpam_ttyconv.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1*0d9d0fd8Schristos.\"	$NetBSD: openpam_ttyconv.3,v 1.9 2023/06/30 21:46:20 christos Exp $
244269bb5Schristos.\"
38fa0fefeSchristos.\" Generated from openpam_ttyconv.c by gendoc.pl
4*0d9d0fd8Schristos.Dd June 27, 2023
544269bb5Schristos.Dt OPENPAM_TTYCONV 3
644269bb5Schristos.Os
744269bb5Schristos.Sh NAME
844269bb5Schristos.Nm openpam_ttyconv
944269bb5Schristos.Nd simple tty-based conversation function
1044269bb5Schristos.Sh SYNOPSIS
1144269bb5Schristos.In sys/types.h
1244269bb5Schristos.In security/pam_appl.h
1344269bb5Schristos.In security/openpam.h
1444269bb5Schristos.Ft "int"
1544269bb5Schristos.Fn openpam_ttyconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
1644269bb5Schristos.Sh DESCRIPTION
1744269bb5SchristosThe
18e1b25b17Schristos.Fn openpam_ttyconv
1944269bb5Schristosfunction is a standard conversation function
2044269bb5Schristossuitable for use on TTY devices.
2144269bb5SchristosIt should be adequate for the needs of most text-based interactive
2244269bb5Schristosprograms.
2344269bb5Schristos.Pp
2444269bb5SchristosThe
25e1b25b17Schristos.Fn openpam_ttyconv
2644269bb5Schristosfunction allows the application to specify a
2744269bb5Schristostimeout for user input by setting the global integer variable
2844269bb5Schristos.Va openpam_ttyconv_timeout
2944269bb5Schristosto the length of the timeout in seconds.
3044269bb5Schristos.Pp
3144269bb5Schristos.Sh RETURN VALUES
3244269bb5SchristosThe
33e1b25b17Schristos.Fn openpam_ttyconv
3444269bb5Schristosfunction returns one of the following values:
3544269bb5Schristos.Bl -tag -width 18n
364cb4af11Schristos.It Bq Er PAM_SUCCESS
374cb4af11SchristosSuccess.
3844269bb5Schristos.It Bq Er PAM_BUF_ERR
3944269bb5SchristosMemory buffer error.
4044269bb5Schristos.It Bq Er PAM_CONV_ERR
4144269bb5SchristosConversation failure.
4244269bb5Schristos.It Bq Er PAM_SYSTEM_ERR
4344269bb5SchristosSystem error.
4444269bb5Schristos.El
4544269bb5Schristos.Sh SEE ALSO
461ae23164Schristos.Xr getpass 3 ,
4744269bb5Schristos.Xr openpam_nullconv 3 ,
4844269bb5Schristos.Xr pam 3 ,
4944269bb5Schristos.Xr pam_prompt 3 ,
5044269bb5Schristos.Xr pam_strerror 3 ,
5144269bb5Schristos.Xr pam_vprompt 3
5244269bb5Schristos.Sh STANDARDS
5344269bb5SchristosThe
54e1b25b17Schristos.Fn openpam_ttyconv
5544269bb5Schristosfunction is an OpenPAM extension.
5644269bb5Schristos.Sh AUTHORS
5744269bb5SchristosThe
58e1b25b17Schristos.Fn openpam_ttyconv
59e1b25b17Schristosfunction and this manual page were
60e1b25b17Schristosdeveloped for the
6144269bb5Schristos.Fx
62e1b25b17SchristosProject by ThinkSec AS and Network Associates Laboratories, the
6344269bb5SchristosSecurity Research Division of Network Associates, Inc.\& under
6444269bb5SchristosDARPA/SPAWAR contract N66001-01-C-8035
6544269bb5Schristos.Pq Dq CBOSS ,
6644269bb5Schristosas part of the DARPA CHATS research program.
678fa0fefeSchristos.Pp
688fa0fefeSchristosThe OpenPAM library is maintained by
694cb4af11Schristos.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
70