xref: /freebsd/contrib/openpam/doc/man/pam_prompt.3 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\" Generated from pam_prompt.c by gendoc.pl
2.Dd June 27, 2023
3.Dt PAM_PROMPT 3
4.Os
5.Sh NAME
6.Nm pam_prompt
7.Nd call the conversation function
8.Sh SYNOPSIS
9.In sys/types.h
10.In security/pam_appl.h
11.Ft "int"
12.Fn pam_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
13.Sh DESCRIPTION
14The
15.Fn pam_prompt
16function constructs a message from the specified format
17string and arguments and passes it to the given PAM context's
18conversation function.
19.Pp
20A pointer to the response, or
21.Dv NULL
22if the conversation function did
23not return one, is stored in the location pointed to by the
24.Fa resp
25argument.
26.Pp
27See
28.Xr pam_vprompt 3
29for further details.
30.Pp
31.Sh RETURN VALUES
32The
33.Fn pam_prompt
34function returns one of the following values:
35.Bl -tag -width 18n
36.It Bq Er PAM_SUCCESS
37Success.
38.It Bq Er PAM_BUF_ERR
39Memory buffer error.
40.It Bq Er PAM_CONV_ERR
41Conversation failure.
42.It Bq Er PAM_SYSTEM_ERR
43System error.
44.El
45.Sh SEE ALSO
46.Xr pam 3 ,
47.Xr pam_error 3 ,
48.Xr pam_info 3 ,
49.Xr pam_strerror 3 ,
50.Xr pam_vprompt 3
51.Sh STANDARDS
52The
53.Fn pam_prompt
54function is an OpenPAM extension.
55.Sh AUTHORS
56The
57.Fn pam_prompt
58function and this manual page were
59developed for the
60.Fx
61Project by ThinkSec AS and Network Associates Laboratories, the
62Security Research Division of Network Associates, Inc.\& under
63DARPA/SPAWAR contract N66001-01-C-8035
64.Pq Dq CBOSS ,
65as part of the DARPA CHATS research program.
66.Pp
67The OpenPAM library is maintained by
68.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
69