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