xref: /freebsd/contrib/openpam/doc/man/openpam_nullconv.3 (revision 8657387683946d0c03e09fe77029edfe309eeb20)
1.\" Generated from openpam_nullconv.c by gendoc.pl
2.\" $OpenPAM: openpam_nullconv.c 938 2017-04-30 21:34:42Z des $
3.Dd April 30, 2017
4.Dt OPENPAM_NULLCONV 3
5.Os
6.Sh NAME
7.Nm openpam_nullconv
8.Nd null conversation function
9.Sh SYNOPSIS
10.In sys/types.h
11.In security/pam_appl.h
12.In security/openpam.h
13.Ft "int"
14.Fn openpam_nullconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
15.Sh DESCRIPTION
16The
17.Fn openpam_nullconv
18function is a null conversation function suitable
19for applications that want to use PAM but don't support interactive
20dialog with the user.
21Such applications should set
22.Dv PAM_AUTHTOK
23to whatever authentication
24token they've obtained on their own before calling
25.Xr pam_authenticate 3
26and / or
27.Xr pam_chauthtok 3 ,
28and their PAM configuration should specify the
29.Dv use_first_pass
30option for all modules that require access to the
31authentication token, to make sure they use
32.Dv PAM_AUTHTOK
33rather than
34try to query the user.
35.Pp
36.Sh RETURN VALUES
37The
38.Fn openpam_nullconv
39function returns one of the following values:
40.Bl -tag -width 18n
41.It Bq Er PAM_SUCCESS
42Success.
43.It Bq Er PAM_CONV_ERR
44Conversation failure.
45.El
46.Sh SEE ALSO
47.Xr openpam_ttyconv 3 ,
48.Xr pam 3 ,
49.Xr pam_authenticate 3 ,
50.Xr pam_chauthtok 3 ,
51.Xr pam_prompt 3 ,
52.Xr pam_set_item 3 ,
53.Xr pam_strerror 3 ,
54.Xr pam_vprompt 3
55.Sh STANDARDS
56The
57.Fn openpam_nullconv
58function is an OpenPAM extension.
59.Sh AUTHORS
60The
61.Fn openpam_nullconv
62function and this manual page were
63developed for the
64.Fx
65Project by ThinkSec AS and Network Associates Laboratories, the
66Security Research Division of Network Associates, Inc.\& under
67DARPA/SPAWAR contract N66001-01-C-8035
68.Pq Dq CBOSS ,
69as part of the DARPA CHATS research program.
70.Pp
71The OpenPAM library is maintained by
72.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
73