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.\" $FreeBSD$ 32.\" 33.Dd February 25, 2004 34.Os 35.Dt LIBUGIDFW 3 36.Sh NAME 37.Nm libugidfw 38.Nd "library interface to the file system firewall MAC policy" 39.Sh LIBRARY 40.Lb libugidfw 41.Sh SYNOPSIS 42.In sys/types.h 43.In security/mac_bsdextended/mac_bsdextended.h 44.In ugidfw.h 45.Sh DESCRIPTION 46The 47.Nm 48library routines provide an interface to the 49.Xr mac_bsdextended 4 50file system firewall MAC policy. 51.Pp 52The 53.Nm 54library defines the following functions: 55.Bl -tag -width ".Fn bsde_parse_rule_string" 56.It Fn bsde_rule_to_string 57Converts the internal representation of a rule 58.Pq Vt "struct mac_bsdextended_rule" 59into its text representation; 60see 61.Xr bsde_rule_to_string 3 . 62.It Fn bsde_parse_rule 63Parses an entire rule 64(in argument array form); 65see 66.Xr bsde_parse_rule 3 . 67.It Fn bsde_parse_rule_string 68Parses an entire rule string; 69see 70.Xr bsde_parse_rule_string 3 . 71.It Fn bsde_get_rule_count 72Returns the total number of ugidfw rules being enforced in the system; 73see 74.Xr bsde_get_rule_count 3 . 75.It Fn bsde_get_rule_slots 76Returns the total number of used rule slots; 77see 78.Xr bsde_get_rule_slots 3 . 79.It Fn bsde_get_rule 80Returns a rule by its rule number; 81see 82.Xr bsde_get_rule 3 . 83.It Fn bsde_delete_rule 84Deletes a rule by its rule number; 85see 86.Xr bsde_delete_rule 3 . 87.It Fn bsde_set_rule 88Uploads the rule to the 89.Xr mac_bsdextended 4 90module and applies it; 91see 92.Xr bsde_set_rule 3 . 93.It Fn bsde_add_rule 94Upload the rule to the module, automatically selecting the next available 95rule number; see 96.Xr bsde_add_rule 3 . 97.El 98.Sh SEE ALSO 99.Xr bsde_delete_rule 3 , 100.Xr bsde_get_rule 3 , 101.Xr bsde_get_rule_count 3 , 102.Xr bsde_get_rule_slots 3 , 103.Xr bsde_parse_rule 3 , 104.Xr bsde_parse_rule_string 3 , 105.Xr bsde_rule_to_string 3 , 106.Xr bsde_set_rule 3 107.Sh AUTHORS 108This software was contributed to the 109.Fx 110Project by Network Associates Labs, 111the Security Research Division of Network Associates 112Inc. 113under DARPA/SPAWAR contract N66001-01-C-8035 114.Pq Dq CBOSS , 115as part of the DARPA CHATS research program. 116