xref: /dflybsd-src/contrib/openpam/doc/man/pam_vprompt.3 (revision 4c84ab30f7dd59ef873b5a6d4e27bcea89d9f848)
110b5fe87SSascha Wildner.\" Generated from pam_vprompt.c by gendoc.pl
210b5fe87SSascha Wildner.\" $OpenPAM: pam_vprompt.c 938 2017-04-30 21:34:42Z des $
3*4c84ab30SSascha Wildner.Dd February 24, 2019
4ade90846SJoerg Sonnenberger.Dt PAM_VPROMPT 3
5ade90846SJoerg Sonnenberger.Os
6ade90846SJoerg Sonnenberger.Sh NAME
7ade90846SJoerg Sonnenberger.Nm pam_vprompt
8ade90846SJoerg Sonnenberger.Nd call the conversation function
9ade90846SJoerg Sonnenberger.Sh SYNOPSIS
10ade90846SJoerg Sonnenberger.In sys/types.h
11609d0d72SSascha Wildner.In security/pam_appl.h
127196b98dSSascha Wildner.In security/openpam.h
13ade90846SJoerg Sonnenberger.Ft "int"
14f23594ceSHasso Tepper.Fn pam_vprompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap"
15ade90846SJoerg Sonnenberger.Sh DESCRIPTION
16ade90846SJoerg SonnenbergerThe
17577efdeeSPeter Avalos.Fn pam_vprompt
18ade90846SJoerg Sonnenbergerfunction constructs a string from the
19ade90846SJoerg Sonnenberger.Fa fmt
20ade90846SJoerg Sonnenbergerand
21ade90846SJoerg Sonnenberger.Fa ap
22ade90846SJoerg Sonnenbergerarguments using
23ade90846SJoerg Sonnenberger.Xr vsnprintf 3 ,
24ade90846SJoerg Sonnenbergerand passes it to the given PAM context's
25ade90846SJoerg Sonnenbergerconversation function.
26ade90846SJoerg Sonnenberger.Pp
27ade90846SJoerg SonnenbergerThe
28ade90846SJoerg Sonnenberger.Fa style
29ade90846SJoerg Sonnenbergerargument specifies the type of interaction requested, and
30ade90846SJoerg Sonnenbergermust be one of the following:
31ade90846SJoerg Sonnenberger.Bl -tag -width 18n
32ade90846SJoerg Sonnenberger.It Dv PAM_PROMPT_ECHO_OFF
33ade90846SJoerg SonnenbergerDisplay the message and obtain the user's response without
34ade90846SJoerg Sonnenbergerdisplaying it.
35ade90846SJoerg Sonnenberger.It Dv PAM_PROMPT_ECHO_ON
36ade90846SJoerg SonnenbergerDisplay the message and obtain the user's response.
37ade90846SJoerg Sonnenberger.It Dv PAM_ERROR_MSG
38ade90846SJoerg SonnenbergerDisplay the message as an error message, and do not wait
39ade90846SJoerg Sonnenbergerfor a response.
40ade90846SJoerg Sonnenberger.It Dv PAM_TEXT_INFO
41ade90846SJoerg SonnenbergerDisplay the message as an informational message, and do
42ade90846SJoerg Sonnenbergernot wait for a response.
43ade90846SJoerg Sonnenberger.El
44ade90846SJoerg Sonnenberger.Pp
45ade90846SJoerg SonnenbergerA pointer to the response, or
46ade90846SJoerg Sonnenberger.Dv NULL
47ade90846SJoerg Sonnenbergerif the conversation function did
48ade90846SJoerg Sonnenbergernot return one, is stored in the location pointed to by the
49ade90846SJoerg Sonnenberger.Fa resp
50ade90846SJoerg Sonnenbergerargument.
51ade90846SJoerg Sonnenberger.Pp
52ade90846SJoerg SonnenbergerThe message and response should not exceed
53ade90846SJoerg Sonnenberger.Dv PAM_MAX_MSG_SIZE
54ade90846SJoerg Sonnenbergeror
55ade90846SJoerg Sonnenberger.Dv PAM_MAX_RESP_SIZE ,
56ade90846SJoerg Sonnenbergerrespectively.
57ade90846SJoerg SonnenbergerIf they do, they may be truncated.
58ade90846SJoerg Sonnenberger.Pp
59ade90846SJoerg Sonnenberger.Sh RETURN VALUES
60ade90846SJoerg SonnenbergerThe
61577efdeeSPeter Avalos.Fn pam_vprompt
62ade90846SJoerg Sonnenbergerfunction returns one of the following values:
63ade90846SJoerg Sonnenberger.Bl -tag -width 18n
6410b5fe87SSascha Wildner.It Bq Er PAM_SUCCESS
6510b5fe87SSascha WildnerSuccess.
66ade90846SJoerg Sonnenberger.It Bq Er PAM_BUF_ERR
67ade90846SJoerg SonnenbergerMemory buffer error.
68ade90846SJoerg Sonnenberger.It Bq Er PAM_CONV_ERR
69ade90846SJoerg SonnenbergerConversation failure.
70ade90846SJoerg Sonnenberger.It Bq Er PAM_SYSTEM_ERR
71ade90846SJoerg SonnenbergerSystem error.
72ade90846SJoerg Sonnenberger.El
73ade90846SJoerg Sonnenberger.Sh SEE ALSO
74ade90846SJoerg Sonnenberger.Xr pam 3 ,
75ade90846SJoerg Sonnenberger.Xr pam_error 3 ,
76ade90846SJoerg Sonnenberger.Xr pam_info 3 ,
77ade90846SJoerg Sonnenberger.Xr pam_prompt 3 ,
78ade90846SJoerg Sonnenberger.Xr pam_strerror 3 ,
79ade90846SJoerg Sonnenberger.Xr pam_verror 3 ,
80ade90846SJoerg Sonnenberger.Xr pam_vinfo 3 ,
81ade90846SJoerg Sonnenberger.Xr vsnprintf 3
82ade90846SJoerg Sonnenberger.Sh STANDARDS
83ade90846SJoerg SonnenbergerThe
84577efdeeSPeter Avalos.Fn pam_vprompt
85ade90846SJoerg Sonnenbergerfunction is an OpenPAM extension.
86ade90846SJoerg Sonnenberger.Sh AUTHORS
87ade90846SJoerg SonnenbergerThe
88577efdeeSPeter Avalos.Fn pam_vprompt
89577efdeeSPeter Avalosfunction and this manual page were
90577efdeeSPeter Avalosdeveloped for the
91ade90846SJoerg Sonnenberger.Fx
92577efdeeSPeter AvalosProject by ThinkSec AS and Network Associates Laboratories, the
93f23594ceSHasso TepperSecurity Research Division of Network Associates, Inc.\& under
94ade90846SJoerg SonnenbergerDARPA/SPAWAR contract N66001-01-C-8035
95ade90846SJoerg Sonnenberger.Pq Dq CBOSS ,
96ade90846SJoerg Sonnenbergeras part of the DARPA CHATS research program.
9710b5fe87SSascha Wildner.Pp
9810b5fe87SSascha WildnerThe OpenPAM library is maintained by
9910b5fe87SSascha Wildner.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
100