xref: /netbsd-src/external/bsd/openpam/dist/doc/man/openpam_nullconv.3 (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1.\"	$NetBSD: openpam_nullconv.3,v 1.8 2019/12/15 17:08:21 christos Exp $
2.\"
3.\" Generated from openpam_nullconv.c by gendoc.pl
4.\" $OpenPAM: openpam_nullconv.c 938 2017-04-30 21:34:42Z des $
5.Dd February 24, 2019
6.Dt OPENPAM_NULLCONV 3
7.Os
8.Sh NAME
9.Nm openpam_nullconv
10.Nd null conversation function
11.Sh SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.In security/openpam.h
15.Ft "int"
16.Fn openpam_nullconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
17.Sh DESCRIPTION
18The
19.Fn openpam_nullconv
20function is a null conversation function suitable
21for applications that want to use PAM but don't support interactive
22dialog with the user.
23Such applications should set
24.Dv PAM_AUTHTOK
25to whatever authentication
26token they've obtained on their own before calling
27.Xr pam_authenticate 3
28and / or
29.Xr pam_chauthtok 3 ,
30and their PAM configuration should specify the
31.Dv use_first_pass
32option for all modules that require access to the
33authentication token, to make sure they use
34.Dv PAM_AUTHTOK
35rather than try to query the user.
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