xref: /freebsd/contrib/openpam/doc/man/pam_prompt.3 (revision 74bf4e164ba5851606a27d4feff27717452583e5)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" All rights reserved.
4.\"
5.\" This software was developed for the FreeBSD Project by ThinkSec AS and
6.\" Network Associates Laboratories, the Security Research Division of
7.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
8.\" ("CBOSS"), as part of the DARPA CHATS research program.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. The name of the author may not be used to endorse or promote
19.\"    products derived from this software without specific prior written
20.\"    permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" $P4$
35.\"
36.Dd February 10, 2004
37.Dt PAM_PROMPT 3
38.Os
39.Sh NAME
40.Nm pam_prompt
41.Nd call the conversation function
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In sys/types.h
46.In security/pam_appl.h
47.Ft "int"
48.Fn pam_prompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
49.Sh DESCRIPTION
50The
51.Nm
52function constructs a message from the specified format
53string and arguments and passes it to the given PAM context's
54conversation function.
55.Pp
56A pointer to the response, or
57.Dv NULL
58if the conversation function did
59not return one, is stored in the location pointed to by the
60.Va resp
61argument.
62.Pp
63See
64.Xr pam_vprompt 3
65for further details.
66.Pp
67.Sh RETURN VALUES
68The
69.Nm
70function returns one of the following values:
71.Bl -tag -width 18n
72.It Bq Er PAM_BUF_ERR
73Memory buffer error.
74.It Bq Er PAM_CONV_ERR
75Conversation failure.
76.It Bq Er PAM_SYSTEM_ERR
77System error.
78.El
79.Sh SEE ALSO
80.Xr pam 3 ,
81.Xr pam_error 3 ,
82.Xr pam_info 3 ,
83.Xr pam_strerror 3 ,
84.Xr pam_vprompt 3
85.Sh STANDARDS
86The
87.Nm
88function is an OpenPAM extension.
89.Sh AUTHORS
90The
91.Nm
92function and this manual page were developed for the
93.Fx
94Project by ThinkSec AS and Network Associates Laboratories, the
95Security Research Division of Network Associates, Inc.  under
96DARPA/SPAWAR contract N66001-01-C-8035
97.Pq Dq CBOSS ,
98as part of the DARPA CHATS research program.
99