1.\" $NetBSD: pam_set_data.3,v 1.3 2013/04/06 02:20:28 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 May 26, 2012 40.Dt PAM_SET_DATA 3 41.Os 42.Sh NAME 43.Nm pam_set_data 44.Nd set 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_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)" 52.Sh DESCRIPTION 53The 54.Fn pam_set_data 55function associates a pointer to an opaque object 56with an arbitrary string specified by the 57.Fa module_data_name 58argument, 59in the PAM context specified by the 60.Fa pamh 61argument. 62.Pp 63If not 64.Dv NULL , 65the 66.Fa cleanup 67argument should point to a function 68responsible for releasing the resources associated with the object. 69.Pp 70This function and its counterpart 71.Xr pam_get_data 3 72are useful for managing 73data that are meaningful only to a particular service module. 74.Sh RETURN VALUES 75The 76.Fn pam_set_data 77function returns one of the following values: 78.Bl -tag -width 18n 79.It Bq Er PAM_BUF_ERR 80Memory buffer error. 81.It Bq Er PAM_SYSTEM_ERR 82System error. 83.El 84.Sh SEE ALSO 85.Xr openpam_free_data 3 , 86.Xr pam 3 , 87.Xr pam_get_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.Fn pam_set_data 97function and this manual page were 98developed for the 99.Fx 100Project by ThinkSec 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