xref: /freebsd/contrib/openpam/doc/man/pam_prompt.3 (revision 2f513db72b034fd5ef7f080b11be5c711c15186a)
1.\" Generated from pam_prompt.c by gendoc.pl
2.\" $OpenPAM: pam_prompt.c 938 2017-04-30 21:34:42Z des $
3.Dd February 24, 2019
4.Dt PAM_PROMPT 3
5.Os
6.Sh NAME
7.Nm pam_prompt
8.Nd call the conversation function
9.Sh SYNOPSIS
10.In sys/types.h
11.In security/pam_appl.h
12.Ft "int"
13.Fn pam_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
14.Sh DESCRIPTION
15The
16.Fn pam_prompt
17function constructs a message from the specified format
18string and arguments and passes it to the given PAM context's
19conversation function.
20.Pp
21A pointer to the response, or
22.Dv NULL
23if the conversation function did
24not return one, is stored in the location pointed to by the
25.Fa resp
26argument.
27.Pp
28See
29.Xr pam_vprompt 3
30for further details.
31.Pp
32.Sh RETURN VALUES
33The
34.Fn pam_prompt
35function returns one of the following values:
36.Bl -tag -width 18n
37.It Bq Er PAM_SUCCESS
38Success.
39.It Bq Er PAM_BUF_ERR
40Memory buffer error.
41.It Bq Er PAM_CONV_ERR
42Conversation failure.
43.It Bq Er PAM_SYSTEM_ERR
44System error.
45.El
46.Sh SEE ALSO
47.Xr pam 3 ,
48.Xr pam_error 3 ,
49.Xr pam_info 3 ,
50.Xr pam_strerror 3 ,
51.Xr pam_vprompt 3
52.Sh STANDARDS
53The
54.Fn pam_prompt
55function is an OpenPAM extension.
56.Sh AUTHORS
57The
58.Fn pam_prompt
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