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