1.\"- 2.\" Copyright (c) 2004 Apple Computer, Inc. 3.\" Copyright (c) 2005 Robert N. M. Watson 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of 15.\" its contributors may be used to endorse or promote products derived 16.\" from this software without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR 22.\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 26.\" STRING LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/au_free_token.3#6 $ 31.\" 32.Dd April 19, 2005 33.Dt AU_FREE_TOKEN 3 34.Os 35.Sh NAME 36.Nm au_free_token 37.Nd "deallocate a token_t created by any of the au_to_*() BSM API functions" 38.Sh LIBRARY 39.Lb libbsm 40.Sh SYNOPSIS 41.In bsm/libbsm.h 42.Ft void 43.Fn au_free_token "token_t *tok" 44.Sh DESCRIPTION 45The BSM API generally manages deallocation of 46.Vt token_t 47objects. 48However, if 49.Xr au_write 3 50is passed a bad audit descriptor, the 51.Vt "token_t *" 52parameter will be left untouched. 53In that case, the caller can deallocate the 54.Vt token_t 55using 56.Fn au_free_token 57if desired. 58.Pp 59The 60.Fa tok 61argument is a 62.Vt "token_t *" 63generated by one of the 64.Fn au_to_* 65BSM API calls. 66For convenience, 67.Fa tok 68may be 69.Dv NULL , 70in which case 71.Fn au_free_token 72returns immediately. 73.Sh IMPLEMENTATION NOTES 74This is, in fact, what 75.Xr audit_write 3 76does, in keeping with the existing memory management model of the BSM API. 77.Sh SEE ALSO 78.Xr audit_write 3 , 79.Xr au_write 3 , 80.Xr libbsm 3 81.Sh HISTORY 82The OpenBSM implementation was created by McAfee Research, the security 83division of McAfee Inc., under contract to Apple Computer, Inc., in 2004. 84It was subsequently adopted by the TrustedBSD Project as the foundation for 85the OpenBSM distribution. 86.Sh AUTHORS 87.An -nosplit 88This software was created by 89.An Robert Watson , 90.An Wayne Salamon , 91and 92.An Suresh Krishnaswamy 93for McAfee Research, the security research division of McAfee, 94Inc., under contract to Apple Computer, Inc. 95.Pp 96The Basic Security Module (BSM) interface to audit records and audit event 97stream format were defined by Sun Microsystems. 98