xref: /freebsd/contrib/openbsm/libbsm/au_fcntl_cmd.3 (revision aa77200569e397d6ff1fdb4d255d0fa254d0a128)
1.\"-
2.\" Copyright (c) 2009 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_fcntl_cmd.3#2 $
30.\"
31.Dd March 5, 2009
32.Dt AU_BSM_TO_FCNTL_CMD 3
33.Os
34.Sh NAME
35.Nm au_bsm_to_fcntl_cmd ,
36.Nm au_fcntl_cmd_to_bsm
37.Nd "convert between BSM and local fcntl(2) command values"
38.Sh LIBRARY
39.Lb libbsm
40.Sh SYNOPSIS
41.In bsm/libbsm.h
42.Ft int
43.Fn au_bsm_to_fcntl_cmd "u_short bsm_fcntl_cmd" "int *local_fcntl_cmdp"
44.Ft u_short
45.Fn au_fcntl_cmd_to_bsm "int local_fcntl_cmd"
46.Sh DESCRIPTION
47These interfaces may be used to convert between the local and BSM
48.Xr fcntl 2
49command values.
50The
51.Fn au_bsm_to_fcntl_cmd
52function accepts a BSM command value,
53.Fa bsm_fcntl_cmd ,
54and converts it to a local command value passed to
55.Xr fcntl 2 ,
56that will be stored in the integer pointed to by
57.Fa local_fcntl_cmdp
58if successful.
59This call will fail if the BSM command value cannot be mapped into a local
60.Xr fcntl 2
61command value which may occur if the command token was generated on another
62operating system.
63.Pp
64The
65.Fn au_fcntl_cmd_to_bsm
66function accepts a local
67.Xr fcntl 2
68command value, and returns the BSM
69.Xr fcntl 2
70command value for it.  This call cannot fail, and instead returns a BSM
71command value indicating to a later decoder that the command value could
72not be encoded.
73.Sh RETURN VALUES
74On success,
75.Fn au_bsm_to_fcntl_cmd
76returns 0 and a converted command value; on failure, it returns -1 but does
77not set
78.Xr errno 2 .
79.Sh SEE ALSO
80.Xr fcntl 2 ,
81.Xr au_bsm_to_domain 3 ,
82.Xr au_domain_to_bsm 3 ,
83.Xr au_bsm_to_socket_type 3 ,
84.Xr au_socket_type_to_bsm 3 ,
85.Xr libbsm 3
86.Sh HISTORY
87.Fn au_bsm_to_domain
88and
89.Fn au_domain_to_bsm
90were introduced in OpenBSM 1.1.
91.Sh AUTHORS
92These functions were implemented by
93.An Stacey Son
94under contract to Apple Inc.
95.Pp
96The Basic Security Module (BSM) interface to audit records and audit event
97stream format were defined by Sun Microsystems.
98