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