xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_prompt.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.\"	$NetBSD: pam_prompt.3,v 1.8 2019/12/15 17:08:21 christos Exp $
2.\"
3.\" Generated from pam_prompt.c by gendoc.pl
4.\" $OpenPAM: pam_prompt.c 938 2017-04-30 21:34:42Z des $
5.Dd February 24, 2019
6.Dt PAM_PROMPT 3
7.Os
8.Sh NAME
9.Nm pam_prompt
10.Nd call the conversation function
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.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