2 .\" Copyright (c) 2008 Apple Inc.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
13 .\" 3. Neither the name of Apple Inc. ("Apple") nor the names of
14 .\" its contributors may be used to endorse or promote products derived
15 .\" from this software without specific prior written permission.
17 .\" THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
21 .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/au_errno.3#4 $
38 .Nd "convert between BSM and local error numbers"
44 .Fn au_bsm_to_errno "u_char bsm_error" "int *errorp"
46 .Fn au_errno_to_bsm "int error"
48 .Fn au_strerror "int bsm_error"
50 These interfaces may be used to convert between the local (
52 and BSM error number spaces found in BSM return tokens.
56 function accepts a BSM error value,
60 that will be stored in the integer pointed to by
63 This call will fail if the BSM error cannot be mapped into a local error
64 number, which may occur if the return token was generated on another
69 function accepts a local
71 value, and returns the BSM error number for it.
72 This call cannot fail, and instead returns a BSM error number indicating to
73 a later decoder that the error could not be encoded.
77 function converts a BSM error value to a string, generally by converting first to a
78 local error number and using the local
80 function, but will also work for errors that are not locally defined.
84 returns 0 and a converted error value; on failure, it returns -1 but does not
90 returns a pointer to an error string; on failure it will return
94 .Xr au_to_return32 3 ,
95 .Xr au_to_return64 3 ,
101 were introduced in OpenBSM 1.1.
103 These functions were implemented by
105 under contract to Apple Inc.
107 The Basic Security Module (BSM) interface to audit records and audit event
108 stream format were defined by Sun Microsystems.
111 is unable to provide localized strings for errors not available in the local