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