1.\"- 2.\" Copyright (c) 2008 Apple Inc. 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 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. 16.\" 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. 28.\" 29.Dd December 28, 2008 30.Dt AU_BSM_TO_SOCKET_TYPE 3 31.Os 32.Sh NAME 33.Nm au_bsm_to_socket_type , 34.Nm au_socket_type_to_bsm 35.Nd "convert between BSM and local socket types" 36.Sh LIBRARY 37.Lb libbsm 38.Sh SYNOPSIS 39.In bsm/libbsm.h 40.Ft int 41.Fn au_bsm_to_socket_type "u_short bsm_socket_type" "int *local_socket_typep" 42.Ft u_short 43.Fn au_socket_type_to_bsm "int local_socket_type" 44.Sh DESCRIPTION 45These interfaces may be used to convert between the local and BSM socket 46types. 47The 48.Fn au_bsm_to_socket_type 49function accepts a BSM socket type, 50.Fa bsm_socket_type , 51and converts it to a local socket type, such as those passed to 52.Xr socket 2 , 53that will be stored in the integer pointed to by 54.Fa local_socket_typep 55if successful. 56This call will fail if the BSM socket type cannot be mapped into a local 57socket type, which may occur if the socket token was generated on another 58operating system. 59.Pp 60.Fn au_socket_type_to_bsm 61function accepts a local socket type, and returns the BSM socket type for it. 62This call cannot fail, and instead returns a BSM socket type indicating to a 63later decoder that the socket type could not be encoded. 64.Sh RETURN VALULES 65On success, 66.Fn au_bsm_to_socket_type 67returns 0 and a converted socket type; on failure, it returns -1 but does not 68set 69.Xr errno 2 . 70.Pp 71On success, 72.Fn au_strerror 73returns a pointer to an error string; on failure it will return 74.Dv NULL . 75.Sh SEE ALSO 76.Xr au_bsm_to_domain 3 , 77.Xr au_domain_to_bsm 3 , 78.Xr au_to_socket_ex 3 , 79.Xr libbsm 3 80.Sh HISTORY 81.Fn au_bsm_to_socket_type 82and 83.Fn au_socket_type_to_bsm 84were introduced in OpenBSM 1.1. 85.Sh AUTHORS 86These functions were implemented by 87.An Robert Watson 88under contract to Apple Inc. 89.Pp 90The Basic Security Module (BSM) interface to audit records and audit event 91stream format were defined by Sun Microsystems. 92