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