xref: /freebsd/contrib/openpam/doc/man/pam_get_data.3 (revision 09e8dea79366f1e5b3a73e8a271b26e4b6bf2e6a)
1.\"-
2.\" Copyright (c) 2002 Networks Associates Technology, Inc.
3.\" All rights reserved.
4.\"
5.\" This software was developed for the FreeBSD Project by ThinkSec AS and
6.\" NAI Labs, the Security Research Division of Network Associates, Inc.
7.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8.\" 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: //depot/projects/openpam/doc/man/pam_get_data.3#13 $
35.\"
36.Dd May 24, 2002
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 security/pam_appl.h
46.Ft int
47.Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "const void **data"
48.Sh DESCRIPTION
49The
50.Nm
51function looks up the opaque object associated with
52the string specified by the
53.Va module_data_name
54argument, in the PAM
55context specified by the
56.Va pamh
57argument.
58A pointer to the object is stored in the location pointed to by the
59.Va data
60argument.
61.Pp
62This function and its counterpart
63.Xr pam_set_data 3
64are useful for managing
65data that are meaningful only to a particular service module.
66.Sh RETURN VALUES
67The
68.Nm
69function returns one of the following values:
70.Bl -tag -width 18n
71.It Bq Er PAM_NO_MODULE_DATA
72Module data not found.
73.It Bq Er PAM_SYSTEM_ERR
74System error.
75.El
76.Sh SEE ALSO
77.Xr pam 3 ,
78.Xr pam_set_data 3 ,
79.Xr pam_strerror 3
80.Sh STANDARDS
81.Rs
82.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
83.%D "June 1997"
84.Re
85.Sh AUTHORS
86The
87.Nm
88function and this manual page were developed for the FreeBSD Project
89by ThinkSec AS and NAI Labs, the Security Research Division of Network
90Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
91.Pq Dq CBOSS ,
92as part of the DARPA CHATS research program.
93