1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" All rights reserved.
4.\"
5.\" This software was developed for the FreeBSD Project by ThinkSec AS and
6.\" Network Associates Laboratories, the Security Research Division of
7.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
8.\" ("CBOSS"), as part of the DARPA CHATS research program.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. The name of the author may not be used to endorse or promote
19.\"    products derived from this software without specific prior written
20.\"    permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" $P4$
35.\"
36.Dd June 16, 2005
37.Dt PAM_GET_DATA 3
38.Os
39.Sh NAME
40.Nm pam_get_data
41.Nd get module information
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In sys/types.h
46.In security/pam_appl.h
47.Ft "int"
48.Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "void **data"
49.Sh DESCRIPTION
50The
51.Nm
52function looks up the opaque object associated with
53the string specified by the
54.Fa module_data_name
55argument, in the PAM
56context specified by the
57.Fa pamh
58argument.
59A pointer to the object is stored in the location pointed to by the
60.Fa data
61argument.
62.Pp
63This function and its counterpart
64.Xr pam_set_data 3
65are useful for managing
66data that are meaningful only to a particular service module.
67.Sh RETURN VALUES
68The
69.Nm
70function returns one of the following values:
71.Bl -tag -width 18n
72.It Bq Er PAM_NO_MODULE_DATA
73Module data not found.
74.It Bq Er PAM_SYSTEM_ERR
75System error.
76.El
77.Sh SEE ALSO
78.Xr pam 3 ,
79.Xr pam_set_data 3 ,
80.Xr pam_strerror 3
81.Sh STANDARDS
82.Rs
83.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
84.%D "June 1997"
85.Re
86.Sh AUTHORS
87The
88.Nm
89function and this manual page were developed for the
90.Fx
91Project by ThinkSec AS and Network Associates Laboratories, the
92Security Research Division of Network Associates, Inc.& under
93DARPA/SPAWAR contract N66001-01-C-8035
94.Pq Dq CBOSS ,
95as part of the DARPA CHATS research program.
96