pam_get_data.3 revision 1.1.1.2 $NetBSD: pam_get_data.3,v 1.1.1.2 2013/04/06 01:23:32 christos Exp $- Copyright (c) 2001-2003 Networks Associates Technology, Inc. Copyright (c) 2004-2011 Dag-Erling Smrgrav All rights reserved. This software was developed for the FreeBSD Project by ThinkSec AS and Network Associates Laboratories, the Security Research Division of Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS research program. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Id.Dd May 26, 2012
.Dt PAM_GET_DATA 3
.Os
.Sh NAME
.Nm pam_get_data
.Nd get module information
.Sh LIBRARY
.Lb libpam
.Sh SYNOPSIS
n sys/types.h n security/pam_appl.h .Ft "int"
.Fn pam_get_data "const pam_handle_t *pamh" "const char *module_data_name" "const void **data"
.Sh DESCRIPTION
The
.Fn pam_get_data
function looks up the opaque object associated with
the string specified by the
.Fa module_data_name
argument, in the PAM
context specified by the
.Fa pamh
argument.
A pointer to the object is stored in the location pointed to by the
.Fa data
argument.
If
.Fn pam_get_data
fails, the
.Fa data
argument is untouched.
p
This function and its counterpart
.Xr pam_set_data 3
are useful for managing
data that are meaningful only to a particular service module.
.Sh RETURN VALUES
The
.Fn pam_get_data
function returns one of the following values:
l -tag -width 18n t Bq Er PAM_NO_MODULE_DATA Module data not found.
t Bq Er PAM_SYSTEM_ERR System error.
.El
.Sh SEE ALSO
.Xr pam 3 ,
.Xr pam_set_data 3 ,
.Xr pam_strerror 3
.Sh STANDARDS
.Rs
.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
.%D "June 1997"
.Re
.Sh AUTHORS
The
.Fn pam_get_data
function and this manual page were
developed for the
.Fx
Project by ThinkSec AS and Network Associates Laboratories, the
Security Research Division of Network Associates, Inc. under
DARPA/SPAWAR contract N66001-01-C-8035
q Dq CBOSS ,
as part of the DARPA CHATS research program.