xref: /freebsd/lib/libugidfw/libugidfw.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\" Copyright (c) 2003 Networks Associates Technology, Inc.
2.\" All rights reserved.
3.\"
4.\" This software was developed for the FreeBSD Project by Chris
5.\" Costello at Safeport Network Services and Network Associates
6.\" Laboratories, the Security Research Division of Network Associates,
7.\" Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part
8.\" of the DARPA CHATS research program.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.Dd February 25, 2004
32.Dt LIBUGIDFW 3
33.Os
34.Sh NAME
35.Nm libugidfw
36.Nd "library interface to the file system firewall MAC policy"
37.Sh LIBRARY
38.Lb libugidfw
39.Sh SYNOPSIS
40.In sys/types.h
41.In security/mac_bsdextended/mac_bsdextended.h
42.In ugidfw.h
43.Sh DESCRIPTION
44The
45.Nm
46library routines provide an interface to the
47.Xr mac_bsdextended 4
48file system firewall MAC policy.
49.Pp
50The
51.Nm
52library defines the following functions:
53.Bl -tag -width ".Fn bsde_parse_rule_string"
54.It Fn bsde_rule_to_string
55Converts the internal representation of a rule
56.Pq Vt "struct mac_bsdextended_rule"
57into its text representation;
58see
59.Xr bsde_rule_to_string 3 .
60.It Fn bsde_parse_rule
61Parses an entire rule
62(in argument array form);
63see
64.Xr bsde_parse_rule 3 .
65.It Fn bsde_parse_rule_string
66Parses an entire rule string;
67see
68.Xr bsde_parse_rule_string 3 .
69.It Fn bsde_get_rule_count
70Returns the total number of ugidfw rules being enforced in the system;
71see
72.Xr bsde_get_rule_count 3 .
73.It Fn bsde_get_rule_slots
74Returns the total number of used rule slots;
75see
76.Xr bsde_get_rule_slots 3 .
77.It Fn bsde_get_rule
78Returns a rule by its rule number;
79see
80.Xr bsde_get_rule 3 .
81.It Fn bsde_delete_rule
82Deletes a rule by its rule number;
83see
84.Xr bsde_delete_rule 3 .
85.It Fn bsde_set_rule
86Uploads the rule to the
87.Xr mac_bsdextended 4
88module and applies it;
89see
90.Xr bsde_set_rule 3 .
91.It Fn bsde_add_rule
92Upload the rule to the module, automatically selecting the next available
93rule number; see
94.Xr bsde_add_rule 3 .
95.El
96.Sh SEE ALSO
97.Xr bsde_delete_rule 3 ,
98.Xr bsde_get_rule 3 ,
99.Xr bsde_get_rule_count 3 ,
100.Xr bsde_get_rule_slots 3 ,
101.Xr bsde_parse_rule 3 ,
102.Xr bsde_parse_rule_string 3 ,
103.Xr bsde_rule_to_string 3 ,
104.Xr bsde_set_rule 3
105.Sh AUTHORS
106This software was contributed to the
107.Fx
108Project by Network Associates Labs,
109the Security Research Division of Network Associates
110Inc.
111under DARPA/SPAWAR contract N66001-01-C-8035
112.Pq Dq CBOSS ,
113as part of the DARPA CHATS research program.
114