xref: /freebsd/contrib/openpam/doc/man/pam_set_data.3 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" Copyright (c) 2004-2007 Dag-Erling Smørgrav
4.\" All rights reserved.
5.\"
6.\" This software was developed for the FreeBSD Project by ThinkSec AS and
7.\" Network Associates Laboratories, the Security Research Division of
8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9.\" ("CBOSS"), as part of the DARPA CHATS research program.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\" 3. The name of the author may not be used to endorse or promote
20.\"    products derived from this software without specific prior written
21.\"    permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\" $P4$
36.\"
37.Dd December 21, 2007
38.Dt PAM_SET_DATA 3
39.Os
40.Sh NAME
41.Nm pam_set_data
42.Nd set module information
43.Sh LIBRARY
44.Lb libpam
45.Sh SYNOPSIS
46.In sys/types.h
47.In security/pam_appl.h
48.Ft "int"
49.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)"
50.Sh DESCRIPTION
51The
52.Nm
53function associates a pointer to an opaque object
54with an arbitrary string specified by the
55.Fa module_data_name
56argument,
57in the PAM context specified by the
58.Fa pamh
59argument.
60.Pp
61If not
62.Dv NULL ,
63the
64.Fa cleanup
65argument should point to a function
66responsible for releasing the resources associated with the object.
67.Pp
68This function and its counterpart
69.Xr pam_get_data 3
70are useful for managing
71data that are meaningful only to a particular service module.
72.Sh RETURN VALUES
73The
74.Nm
75function returns one of the following values:
76.Bl -tag -width 18n
77.It Bq Er PAM_BUF_ERR
78Memory buffer error.
79.It Bq Er PAM_SYSTEM_ERR
80System error.
81.El
82.Sh SEE ALSO
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
95.Fx
96Project by ThinkSec AS and Network Associates Laboratories, the
97Security Research Division of Network Associates, Inc.\& under
98DARPA/SPAWAR contract N66001-01-C-8035
99.Pq Dq CBOSS ,
100as part of the DARPA CHATS research program.
101