xref: /freebsd/contrib/openpam/doc/man/pam_get_data.3 (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" Copyright (c) 2004-2007 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.\" $P4$
36.\"
37.Dd December 21, 2007
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.Nm
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.
63.Pp
64This function and its counterpart
65.Xr pam_set_data 3
66are useful for managing
67data that are meaningful only to a particular service module.
68.Sh RETURN VALUES
69The
70.Nm
71function returns one of the following values:
72.Bl -tag -width 18n
73.It Bq Er PAM_NO_MODULE_DATA
74Module data not found.
75.It Bq Er PAM_SYSTEM_ERR
76System error.
77.El
78.Sh SEE ALSO
79.Xr pam 3 ,
80.Xr pam_set_data 3 ,
81.Xr pam_strerror 3
82.Sh STANDARDS
83.Rs
84.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
85.%D "June 1997"
86.Re
87.Sh AUTHORS
88The
89.Nm
90function and this manual page were developed for the
91.Fx
92Project by ThinkSec AS and Network Associates Laboratories, the
93Security Research Division of Network Associates, Inc.\& under
94DARPA/SPAWAR contract N66001-01-C-8035
95.Pq Dq CBOSS ,
96as part of the DARPA CHATS research program.
97