xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_vprompt.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1*0d9d0fd8Schristos.\"	$NetBSD: pam_vprompt.3,v 1.9 2023/06/30 21:46:20 christos Exp $
244269bb5Schristos.\"
38fa0fefeSchristos.\" Generated from pam_vprompt.c by gendoc.pl
4*0d9d0fd8Schristos.Dd June 27, 2023
544269bb5Schristos.Dt PAM_VPROMPT 3
644269bb5Schristos.Os
744269bb5Schristos.Sh NAME
844269bb5Schristos.Nm pam_vprompt
944269bb5Schristos.Nd call the conversation function
1044269bb5Schristos.Sh SYNOPSIS
1144269bb5Schristos.In sys/types.h
1244269bb5Schristos.In security/pam_appl.h
1344269bb5Schristos.Ft "int"
1444269bb5Schristos.Fn pam_vprompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap"
1544269bb5Schristos.Sh DESCRIPTION
1644269bb5SchristosThe
17e1b25b17Schristos.Fn pam_vprompt
1844269bb5Schristosfunction constructs a string from the
1944269bb5Schristos.Fa fmt
2044269bb5Schristosand
2144269bb5Schristos.Fa ap
2244269bb5Schristosarguments using
2344269bb5Schristos.Xr vsnprintf 3 ,
2444269bb5Schristosand passes it to the given PAM context's
2544269bb5Schristosconversation function.
2644269bb5Schristos.Pp
2744269bb5SchristosThe
2844269bb5Schristos.Fa style
2944269bb5Schristosargument specifies the type of interaction requested, and
3044269bb5Schristosmust be one of the following:
3144269bb5Schristos.Bl -tag -width 18n
3244269bb5Schristos.It Dv PAM_PROMPT_ECHO_OFF
3344269bb5SchristosDisplay the message and obtain the user's response without
3444269bb5Schristosdisplaying it.
3544269bb5Schristos.It Dv PAM_PROMPT_ECHO_ON
3644269bb5SchristosDisplay the message and obtain the user's response.
3744269bb5Schristos.It Dv PAM_ERROR_MSG
3844269bb5SchristosDisplay the message as an error message, and do not wait
3944269bb5Schristosfor a response.
4044269bb5Schristos.It Dv PAM_TEXT_INFO
4144269bb5SchristosDisplay the message as an informational message, and do
4244269bb5Schristosnot wait for a response.
4344269bb5Schristos.El
4444269bb5Schristos.Pp
4544269bb5SchristosA pointer to the response, or
4644269bb5Schristos.Dv NULL
4744269bb5Schristosif the conversation function did
4844269bb5Schristosnot return one, is stored in the location pointed to by the
4944269bb5Schristos.Fa resp
5044269bb5Schristosargument.
5144269bb5Schristos.Pp
5244269bb5SchristosThe message and response should not exceed
5344269bb5Schristos.Dv PAM_MAX_MSG_SIZE
5444269bb5Schristosor
5544269bb5Schristos.Dv PAM_MAX_RESP_SIZE ,
5644269bb5Schristosrespectively.
5744269bb5SchristosIf they do, they may be truncated.
5844269bb5Schristos.Sh RETURN VALUES
5944269bb5SchristosThe
60e1b25b17Schristos.Fn pam_vprompt
6144269bb5Schristosfunction returns one of the following values:
6244269bb5Schristos.Bl -tag -width 18n
634cb4af11Schristos.It Bq Er PAM_SUCCESS
644cb4af11SchristosSuccess.
6544269bb5Schristos.It Bq Er PAM_BUF_ERR
6644269bb5SchristosMemory buffer error.
6744269bb5Schristos.It Bq Er PAM_CONV_ERR
6844269bb5SchristosConversation failure.
6944269bb5Schristos.It Bq Er PAM_SYSTEM_ERR
7044269bb5SchristosSystem error.
7144269bb5Schristos.El
7244269bb5Schristos.Sh SEE ALSO
7344269bb5Schristos.Xr pam 3 ,
7444269bb5Schristos.Xr pam_error 3 ,
7544269bb5Schristos.Xr pam_info 3 ,
7644269bb5Schristos.Xr pam_prompt 3 ,
7744269bb5Schristos.Xr pam_strerror 3 ,
7844269bb5Schristos.Xr pam_verror 3 ,
7944269bb5Schristos.Xr pam_vinfo 3 ,
8044269bb5Schristos.Xr vsnprintf 3
8144269bb5Schristos.Sh STANDARDS
8244269bb5SchristosThe
83e1b25b17Schristos.Fn pam_vprompt
8444269bb5Schristosfunction is an OpenPAM extension.
8544269bb5Schristos.Sh AUTHORS
8644269bb5SchristosThe
87e1b25b17Schristos.Fn pam_vprompt
88e1b25b17Schristosfunction and this manual page were
89e1b25b17Schristosdeveloped for the
9044269bb5Schristos.Fx
91e1b25b17SchristosProject by ThinkSec AS and Network Associates Laboratories, the
9244269bb5SchristosSecurity Research Division of Network Associates, Inc.\& under
9344269bb5SchristosDARPA/SPAWAR contract N66001-01-C-8035
9444269bb5Schristos.Pq Dq CBOSS ,
9544269bb5Schristosas part of the DARPA CHATS research program.
968fa0fefeSchristos.Pp
978fa0fefeSchristosThe OpenPAM library is maintained by
984cb4af11Schristos.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
99