xref: /freebsd/contrib/openpam/doc/man/openpam_free_data.3 (revision ae83180158c4c937f170e31eff311b18c0286a93)
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 June 30, 2002
37.Dt OPENPAM_FREE_DATA 3
38.Os
39.Sh NAME
40.Nm openpam_free_data
41.Nd generic cleanup function
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In security/pam_appl.h
46.In security/openpam.h
47.Ft void
48.Fn openpam_free_data "pam_handle_t *pamh" "void *data" "int status"
49.Sh DESCRIPTION
50The
51.Nm
52is a cleanup function suitable for passing to
53.Xr pam_set_data 3 .
54It simply releases the data by passing its
55.Va data
56argument to
57.Xr free 3 .
58.Sh SEE ALSO
59.Xr free 3 ,
60.Xr pam 3 ,
61.Xr pam_set_data 3
62.Sh STANDARDS
63The
64.Nm
65function is an OpenPAM extension.
66.Sh AUTHORS
67The
68.Nm
69function and this manual page were developed for the FreeBSD Project
70by ThinkSec AS and Network Associates Laboratories, the Security
71Research Division of Network Associates, Inc.  under DARPA/SPAWAR
72contract N66001-01-C-8035
73.Pq Dq CBOSS ,
74as part of the DARPA CHATS research program.
75