xref: /freebsd/lib/libugidfw/bsde_parse_rule.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_PARSE_RULE 3
35.Sh NAME
36.Nm bsde_parse_rule ,
37.Nm bsde_parse_rule_string
38.Nd parse file system firewall rules
39.Sh LIBRARY
40.Lb libugidfw
41.Sh SYNOPSIS
42.In ugidfw.h
43.Ft int
44.Fn bsde_parse_rule "int argc" "char *argv[]" "struct mac_bsdextended_rule *rule" "size_t buflen" "char *errstr"
45.Ft int
46.Fn bsde_parse_rule_string "const char *string" "struct mac_bsdextended_rule *rule" "size_t buflen" "char *errstr"
47.Sh DESCRIPTION
48The
49.Fn bsde_parse_rule
50function parses an argument vector
51(e.g.
52.Fa argv
53as passed to
54.Fn main )
55into
56.Fa rule .
57If an error occurs,
58.Fa *errstr
59is filled in with the error string
60(up to
61.Fa errlen
62characters, including the terminating NUL).
63.Pp
64The
65.Fn bsde_parse_rule_string
66function is identical to
67.Fn bsde_parse_rule ,
68except that it parse a single string, rather than an array of arguments.
69.Sh RETURN VALUES
70The
71.Fn bsde_parse_rule_string
72and
73.Fn bsde_parse_rule
74functions return
75.Li 0
76if successful;
77otherwise the value
78.Li \&-1
79is returned and the value of
80.Fa *errstr
81is filled in as documented in
82.Sx DESCRIPTION .
83.Sh SEE ALSO
84.Xr bsde_delete_rule 3 ,
85.Xr bsde_get_rule 3 ,
86.Xr bsde_get_rule_count 3 ,
87.Xr bsde_get_rule_slots 3 ,
88.Xr bsde_rule_to_string 3 ,
89.Xr bsde_set_rule 3 ,
90.Xr libugidfw 3 ,
91.Xr mac_bsdextended 4 ,
92.Xr ugidfw 8
93.Sh AUTHORS
94This software was contributed to the
95.Fx
96Project by Network Associates Labs,
97the Security Research Division of Network Associates
98Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
99as part of the DARPA CHATS research program.
100