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