xref: /freebsd/contrib/openpam/doc/man/pam_prompt.3 (revision ef90af83a58199ef3980d8c9a7dad07ec9b4bea3)
1.\" Generated from pam_prompt.c by gendoc.pl
2.\" $Id: pam_prompt.c 648 2013-03-05 17:54:27Z des $
3.Dd September 7, 2013
4.Dt PAM_PROMPT 3
5.Os
6.Sh NAME
7.Nm pam_prompt
8.Nd call the conversation function
9.Sh LIBRARY
10.Lb libpam
11.Sh SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.Ft "int"
15.Fn pam_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
16.Sh DESCRIPTION
17The
18.Fn pam_prompt
19function constructs a message from the specified format
20string and arguments and passes it to the given PAM context's
21conversation function.
22.Pp
23A pointer to the response, or
24.Dv NULL
25if the conversation function did
26not return one, is stored in the location pointed to by the
27.Fa resp
28argument.
29.Pp
30See
31.Xr pam_vprompt 3
32for further details.
33.Pp
34.Sh RETURN VALUES
35The
36.Fn pam_prompt
37function returns one of the following values:
38.Bl -tag -width 18n
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 des@des.no .
70