xref: /netbsd-src/external/bsd/openpam/dist/doc/man/openpam_nullconv.3 (revision 946379e7b37692fc43f68eb0d1c10daa0a7f3b6c)
1.\"	$NetBSD: openpam_nullconv.3,v 1.6 2014/10/24 18:25:14 christos Exp $
2.\"
3.\" Generated from openpam_nullconv.c by gendoc.pl
4.\" Id: openpam_nullconv.c 648 2013-03-05 17:54:27Z des
5.Dd September 12, 2014
6.Dt OPENPAM_NULLCONV 3
7.Os
8.Sh NAME
9.Nm openpam_nullconv
10.Nd null conversation function
11.Sh LIBRARY
12.Lb libpam
13.Sh SYNOPSIS
14.In sys/types.h
15.In security/pam_appl.h
16.In security/openpam.h
17.Ft "int"
18.Fn openpam_nullconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
19.Sh DESCRIPTION
20The
21.Fn openpam_nullconv
22function is a null conversation function suitable
23for applications that want to use PAM but don't support interactive
24dialog with the user.
25Such applications should set
26.Dv PAM_AUTHTOK
27to whatever authentication
28token they've obtained on their own before calling
29.Xr pam_authenticate 3
30and / or
31.Xr pam_chauthtok 3 ,
32and their PAM configuration should specify the
33.Dv use_first_pass
34option for all modules that require access to the
35authentication token, to make sure they use
36.Dv PAM_AUTHTOK
37rather than try to query the user.
38.Sh RETURN VALUES
39The
40.Fn openpam_nullconv
41function returns one of the following values:
42.Bl -tag -width 18n
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 des@des.no .
73