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