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.\" Network Associates Laboratories, the Security Research Division of 7.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 8.\" ("CBOSS"), as part of the 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$ 35.\" 36.Dd January 6, 2003 37.Dt PAM_SET_DATA 3 38.Os 39.Sh NAME 40.Nm pam_set_data 41.Nd set module information 42.Sh LIBRARY 43.Lb libpam 44.Sh SYNOPSIS 45.In sys/types.h 46.In security/pam_appl.h 47.Ft int 48.Fn pam_set_data "pam_handle_t *pamh" "const char *module_data_name" "void *data" "void (*cleanup)(pam_handle_t *pamh, void *data, int pam_end_status)" 49.Sh DESCRIPTION 50The 51.Nm 52function associates a pointer to an opaque object 53with an arbitrary string specified by the 54.Va module_data_name 55argument, 56in the PAM context specified by the 57.Va pamh 58argument. 59.Pp 60If not 61.Dv NULL , 62the 63.Xr cleanup 3 64argument should point to a function 65responsible for releasing the resources associated with the object. 66.Pp 67This function and its counterpart 68.Xr pam_get_data 3 69are useful for managing 70data that are meaningful only to a particular service module. 71.Sh RETURN VALUES 72The 73.Nm 74function returns one of the following values: 75.Bl -tag -width 18n 76.It Bq Er PAM_BUF_ERR 77Memory buffer error. 78.It Bq Er PAM_SYSTEM_ERR 79System error. 80.El 81.Sh SEE ALSO 82.Xr cleanup 3 , 83.Xr pam 3 , 84.Xr pam_get_data 3 , 85.Xr pam_strerror 3 86.Sh STANDARDS 87.Rs 88.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 89.%D "June 1997" 90.Re 91.Sh AUTHORS 92The 93.Nm 94function and this manual page were developed for the FreeBSD Project 95by ThinkSec AS and Network Associates Laboratories, the Security 96Research Division of Network Associates, Inc. under DARPA/SPAWAR 97contract N66001-01-C-8035 98.Pq Dq CBOSS , 99as part of the DARPA CHATS research program. 100