xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_prompt.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1.\"	$NetBSD: pam_prompt.3,v 1.9 2023/06/30 21:46:20 christos Exp $
2.\"
3.\" Generated from pam_prompt.c by gendoc.pl
4.Dd June 27, 2023
5.Dt PAM_PROMPT 3
6.Os
7.Sh NAME
8.Nm pam_prompt
9.Nd call the conversation function
10.Sh SYNOPSIS
11.In sys/types.h
12.In security/pam_appl.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.Sh RETURN VALUES
33The
34.Fn pam_prompt
35function returns one of the following values:
36.Bl -tag -width 18n
37.It Bq Er PAM_SUCCESS
38Success.
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 Mt des@des.no .
70