xref: /freebsd/lib/libugidfw/bsde_get_rule_count.3 (revision 4b2eaea43fec8e8792be611dea204071a10b655a)
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.Dd JANUARY 7, 2003
33.Os
34.Dt BSDE_GET_RULE_COUNT 3
35.Sh NAME
36.Nm bsde_get_rule_count ,
37.Nm bsde_get_rule_slots
38.Nd file system firewall statistics
39.Sh LIBRARY
40.Lb libugidfw
41.Sh SYNOPSIS
42.In ugidfw.h
43.Ft int
44.Fn bsde_get_rule_count "size_t errlen" "char *errstr"
45.Ft int
46.Fn bsde_get_rule_slots "size_t errlen" "char *errstr"
47.Sh DESCRIPTION
48The
49.Fn bsde_get_rule_count
50and
51.Fn bsde_get_rule_slots
52return the total number of enforced rules
53and the total number of used rule slots, respectively.
54If an error occurs,
55.Fa *errstr
56is filled in with the error string
57(up to
58.Fa errlen
59characters, including the terminating NUL).
60.Sh RETURN VALUES
61The
62.Fn bsde_get_rule_count
63and
64.Fn bsde_get_rule_slots
65functions return
66the number of enforced rules and rule slots (respectively)
67if successful;
68otherwise the value
69.Li \&-1
70is returned and the value of
71.Fa *errstr
72is filled in as documented in
73.Sx DESCRIPTION .
74.Sh SEE ALSO
75.Xr bsde_delete_rule 3 ,
76.Xr bsde_get_rule 3 ,
77.Xr bsde_parse_rule 3 ,
78.Xr bsde_parse_rule_string 3 ,
79.Xr bsde_rule_to_string 3 ,
80.Xr bsde_set_rule 3 ,
81.Xr libugidfw 3 ,
82.Xr mac_bsdextended 4 ,
83.Xr ugidfw 8
84.Sh AUTHORS
85This software was contributed to the
86.Fx
87Project by Network Associates Labs,
88the Security Research Division of Network Associates
89Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
90as part of the DARPA CHATS research program.
91