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