xref: /freebsd/contrib/openpam/doc/man/pam_get_data.3 (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1.\" Generated from pam_get_data.c by gendoc.pl
2.\" $Id: pam_get_data.c 913 2017-01-21 15:11:12Z des $
3.Dd February 19, 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_NO_MODULE_DATA
43Module data not found.
44.El
45.Sh SEE ALSO
46.Xr pam 3 ,
47.Xr pam_set_data 3 ,
48.Xr pam_strerror 3
49.Sh STANDARDS
50.Rs
51.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
52.%D "June 1997"
53.Re
54.Sh AUTHORS
55The
56.Fn pam_get_data
57function and this manual page were
58developed for the
59.Fx
60Project by ThinkSec AS and Network Associates Laboratories, the
61Security Research Division of Network Associates, Inc.\& under
62DARPA/SPAWAR contract N66001-01-C-8035
63.Pq Dq CBOSS ,
64as part of the DARPA CHATS research program.
65.Pp
66The OpenPAM library is maintained by
67.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
68