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_socket_type.3#1 $
32 .Dt AU_BSM_TO_SOCKET_TYPE 3
35 .Nm au_bsm_to_socket_type ,
36 .Nm au_socket_type_to_bsm
37 .Nd "convert between BSM and local socket types"
43 .Fn au_bsm_to_socket_type "u_short bsm_socket_type" "int *local_socket_typep"
45 .Fn au_socket_type_to_bsm "int local_socket_type"
47 These interfaces may be used to convert between the local and BSM socket
50 .Fn au_bsm_to_socket_type
51 function accepts a BSM socket type,
53 and converts it to a local socket type, such as those passed to
55 that will be stored in the integer pointed to by
56 .Fa local_socket_typep
58 This call will fail if the BSM socket type cannot be mapped into a local
59 socket type, which may occur if the socket token was generated on another
62 .Fn au_socket_type_to_bsm
63 function accepts a local socket type, and returns the BSM socket type for it.
64 This call cannot fail, and instead returns a BSM socket type indicating to a
65 later decoder that the socket type could not be encoded.
68 .Fn au_bsm_to_socket_type
69 returns 0 and a converted socket type; on failure, it returns -1 but does not
75 returns a pointer to an error string; on failure it will return
78 .Xr au_bsm_to_domain 3 ,
79 .Xr au_domain_to_bsm 3 ,
80 .Xr au_to_socket_ex 3 ,
83 .Fn au_bsm_to_socket_type
85 .Fn au_socket_type_to_bsm
86 were introduced in OpenBSM 1.1.
88 These functions were implemented by
90 under contract to Apple Inc.
92 The Basic Security Module (BSM) interface to audit records and audit event
93 stream format were defined by Sun Microsystems.