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.\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/au_domain.3#2 $ 30.\" 31.Dd December 28, 2008 32.Dt AU_BSM_TO_DOMAIN 3 33.Os 34.Sh NAME 35.Nm au_bsm_to_domain , 36.Nm au_domain_to_bsm 37.Nd "convert between BSM and local protocol domains" 38.Sh LIBRARY 39.Lb libbsm 40.Sh SYNOPSIS 41.In bsm/libbsm.h 42.Ft int 43.Fn au_bsm_to_domain "u_short bsm_domain" "int *local_domainp" 44.Ft u_short 45.Fn au_domain_to_bsm "int local_domain" 46.Sh DESCRIPTION 47These interfaces may be used to convert between the local and BSM protocol 48domains. 49The 50.Fn au_bsm_to_domain 51function accepts a BSM domain, 52.Fa bsm_domain , 53and converts it to a local domain, such as those passed to 54.Xr socket 2 , 55that will be stored in the integer pointed to by 56.Fa local_domainp 57if successful. 58This call will fail if the BSM domain cannot be mapped into a local domain, 59which may occur if the socket token was generated on another operating 60system. 61.Pp 62The 63.Fn au_domain_to_bsm 64function accepts a local domain, and returns the BSM domain for it. 65This call cannot fail, and instead returns a BSM domain indicating to a later 66decoder that the domain could not be encoded. 67.Sh RETURN VALULES 68On success, 69.Fn au_bsm_to_domain 70returns 0 and a converted domain; on failure, it returns -1 but does not set 71.Xr errno 2 . 72.Sh SEE ALSO 73.Xr au_bsm_to_socket_type 3 , 74.Xr au_socket_type_to_bsm 3 , 75.Xr au_to_socket_ex 3 , 76.Xr libbsm 3 77.Sh HISTORY 78.Fn au_bsm_to_domain 79and 80.Fn au_domain_to_bsm 81were introduced in OpenBSM 1.1. 82.Sh AUTHORS 83These functions were implemented by 84.An Robert Watson 85under contract to Apple Inc. 86.Pp 87The Basic Security Module (BSM) interface to audit records and audit event 88stream format were defined by Sun Microsystems. 89