96 lines
3.1 KiB
Groff
96 lines
3.1 KiB
Groff
.\"-
|
|
.\" Copyright (c) 2004 Apple Inc.
|
|
.\" Copyright (c) 2005 Robert N. M. Watson
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. Neither the name of Apple Inc. ("Apple") nor the names of
|
|
.\" its contributors may be used to endorse or promote products derived
|
|
.\" from this software without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
|
|
.\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
.\" STRING LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
|
.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.Dd April 19, 2005
|
|
.Dt AU_FREE_TOKEN 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm au_free_token
|
|
.Nd "deallocate a token_t created by any of the au_to_*() BSM API functions"
|
|
.Sh LIBRARY
|
|
.Lb libbsm
|
|
.Sh SYNOPSIS
|
|
.In bsm/libbsm.h
|
|
.Ft void
|
|
.Fn au_free_token "token_t *tok"
|
|
.Sh DESCRIPTION
|
|
The BSM API generally manages deallocation of
|
|
.Vt token_t
|
|
objects.
|
|
However, if
|
|
.Xr au_write 3
|
|
is passed a bad audit descriptor, the
|
|
.Vt "token_t *"
|
|
parameter will be left untouched.
|
|
In that case, the caller can deallocate the
|
|
.Vt token_t
|
|
using
|
|
.Fn au_free_token
|
|
if desired.
|
|
.Pp
|
|
The
|
|
.Fa tok
|
|
argument is a
|
|
.Vt "token_t *"
|
|
generated by one of the
|
|
.Fn au_to_*
|
|
BSM API calls.
|
|
For convenience,
|
|
.Fa tok
|
|
may be
|
|
.Dv NULL ,
|
|
in which case
|
|
.Fn au_free_token
|
|
returns immediately.
|
|
.Sh IMPLEMENTATION NOTES
|
|
This is, in fact, what
|
|
.Xr audit_write 3
|
|
does, in keeping with the existing memory management model of the BSM API.
|
|
.Sh SEE ALSO
|
|
.Xr au_write 3 ,
|
|
.Xr audit_write 3 ,
|
|
.Xr libbsm 3
|
|
.Sh HISTORY
|
|
The OpenBSM implementation was created by McAfee Research, the security
|
|
division of McAfee Inc., under contract to Apple Computer, Inc., in 2004.
|
|
It was subsequently adopted by the TrustedBSD Project as the foundation for
|
|
the OpenBSM distribution.
|
|
.Sh AUTHORS
|
|
.An -nosplit
|
|
This software was created by
|
|
.An Robert Watson ,
|
|
.An Wayne Salamon ,
|
|
and
|
|
.An Suresh Krishnaswamy
|
|
for McAfee Research, the security research division of McAfee,
|
|
Inc., under contract to Apple Computer, Inc.
|
|
.Pp
|
|
The Basic Security Module (BSM) interface to audit records and audit event
|
|
stream format were defined by Sun Microsystems.
|