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