xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_get_data.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1.\"	$NetBSD: pam_get_data.3,v 1.9 2023/06/30 21:46:20 christos Exp $
2.\"
3.\" Generated from pam_get_data.c by gendoc.pl
4.Dd June 27, 2023
5.Dt PAM_GET_DATA 3
6.Os
7.Sh NAME
8.Nm pam_get_data
9.Nd get module information
10.Sh SYNOPSIS
11.In sys/types.h
12.In security/pam_appl.h
13.Ft "int"
14.Fn pam_get_data "const pam_handle_t *pamh" "const char *module_data_name" "const void **data"
15.Sh DESCRIPTION
16The
17.Fn pam_get_data
18function looks up the opaque object associated with
19the string specified by the
20.Fa module_data_name
21argument, in the PAM
22context specified by the
23.Fa pamh
24argument.
25A pointer to the object is stored in the location pointed to by the
26.Fa data
27argument.
28If
29.Fn pam_get_data
30fails, the
31.Fa data
32argument is untouched.
33.Pp
34This function and its counterpart
35.Xr pam_set_data 3
36are useful for managing
37data that are meaningful only to a particular service module.
38.Sh RETURN VALUES
39The
40.Fn pam_get_data
41function returns one of the following values:
42.Bl -tag -width 18n
43.It Bq Er PAM_SUCCESS
44Success.
45.It Bq Er PAM_NO_MODULE_DATA
46Module data not found.
47.El
48.Sh SEE ALSO
49.Xr pam 3 ,
50.Xr pam_set_data 3 ,
51.Xr pam_strerror 3
52.Sh STANDARDS
53.Rs
54.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
55.%D "June 1997"
56.Re
57.Sh AUTHORS
58The
59.Fn pam_get_data
60function and this manual page were
61developed for the
62.Fx
63Project by ThinkSec AS and Network Associates Laboratories, the
64Security Research Division of Network Associates, Inc.\& under
65DARPA/SPAWAR contract N66001-01-C-8035
66.Pq Dq CBOSS ,
67as part of the DARPA CHATS research program.
68.Pp
69The OpenPAM library is maintained by
70.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
71