xref: /freebsd/lib/libugidfw/bsde_rule_to_string.3 (revision d69f82076bd712ae73e7619a8d80e5c9b10a4217)
1d69f8207SChris Costello.\" Copyright (c) 2003 Networks Associates Technology, Inc.
2d69f8207SChris Costello.\" All rights reserved.
3d69f8207SChris Costello.\"
4d69f8207SChris Costello.\" This software was developed for the FreeBSD Project by Chris
5d69f8207SChris Costello.\" Costello at Safeport Network Services and Network Associates
6d69f8207SChris Costello.\" Laboratories, the Security Research Division of Network Associates,
7d69f8207SChris Costello.\" Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part
8d69f8207SChris Costello.\" of the DARPA CHATS research program.
9d69f8207SChris Costello.\"
10d69f8207SChris Costello.\" Redistribution and use in source and binary forms, with or without
11d69f8207SChris Costello.\" modification, are permitted provided that the following conditions
12d69f8207SChris Costello.\" are met:
13d69f8207SChris Costello.\" 1. Redistributions of source code must retain the above copyright
14d69f8207SChris Costello.\"    notice, this list of conditions and the following disclaimer.
15d69f8207SChris Costello.\" 2. Redistributions in binary form must reproduce the above copyright
16d69f8207SChris Costello.\"    notice, this list of conditions and the following disclaimer in the
17d69f8207SChris Costello.\"    documentation and/or other materials provided with the distribution.
18d69f8207SChris Costello.\"
19d69f8207SChris Costello.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
20d69f8207SChris Costello.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21d69f8207SChris Costello.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22d69f8207SChris Costello.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
23d69f8207SChris Costello.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24d69f8207SChris Costello.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25d69f8207SChris Costello.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26d69f8207SChris Costello.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27d69f8207SChris Costello.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28d69f8207SChris Costello.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29d69f8207SChris Costello.\" SUCH DAMAGE.
30d69f8207SChris Costello.\"
31d69f8207SChris Costello.\" $FreeBSD$
32d69f8207SChris Costello.Dd JANUARY 7, 2003
33d69f8207SChris Costello.Os
34d69f8207SChris Costello.Dt BSDE_RULE_TO_STRING 3
35d69f8207SChris Costello.Sh NAME
36d69f8207SChris Costello.Nm bsde_rule_to_string
37d69f8207SChris Costello.Nd converts a ugidfw rule into its text representation
38d69f8207SChris Costello.Sh LIBRARY
39d69f8207SChris Costello.Lb libugidfw
40d69f8207SChris Costello.Sh SYNOPSIS
41d69f8207SChris Costello.In ugidfw.h
42d69f8207SChris Costello.Ft int
43d69f8207SChris Costello.Fn bsde_rule_to_string "struct mac_bsdextended_rule *rule" "char *buf" "size_t buflen"
44d69f8207SChris Costello.Sh DESCRIPTION
45d69f8207SChris CostelloThe
46d69f8207SChris Costello.Fn bsde_rule_to_string
47d69f8207SChris Costellofunction converts a rule in its internal representation
48d69f8207SChris Costello.Vt ( "struct mac_bsdextended_rule" )
49d69f8207SChris Costellointo its text representation and writes up to
50d69f8207SChris Costello.Fa buflen
51d69f8207SChris Costellobytes of it to
52d69f8207SChris Costello.Fa buf
53d69f8207SChris Costello(including the terminating NUL).
54d69f8207SChris Costello.Sh RETURN VALUES
55d69f8207SChris CostelloThe
56d69f8207SChris Costello.Fn bsde_rule_to_string
57d69f8207SChris Costellofunction returns
58d69f8207SChris Costello.Li \&-1
59d69f8207SChris Costelloif the conversion was truncated;
60d69f8207SChris Costellootherwise the value
61d69f8207SChris Costello.Li 0
62d69f8207SChris Costellois returned.
63d69f8207SChris Costello.Sh SEE ALSO
64d69f8207SChris Costello.Xr bsde_delete_rule 3 ,
65d69f8207SChris Costello.Xr bsde_get_rule 3 ,
66d69f8207SChris Costello.Xr bsde_get_rule_count 3 ,
67d69f8207SChris Costello.Xr bsde_get_rule_slots 3 ,
68d69f8207SChris Costello.Xr bsde_parse_rule 3 ,
69d69f8207SChris Costello.Xr bsde_parse_rule_string 3 ,
70d69f8207SChris Costello.Xr bsde_set_rule 3 ,
71d69f8207SChris Costello.Xr libugidfw 3 ,
72d69f8207SChris Costello.Xr mac_bsdextended 4 ,
73d69f8207SChris Costello.Xr ugidfw 8
74d69f8207SChris Costello.Sh AUTHORS
75d69f8207SChris CostelloThis software was contributed to the
76d69f8207SChris Costello.Fx
77d69f8207SChris CostelloProject by Network Associates Labs,
78d69f8207SChris Costellothe Security Research Division of Network Associates
79d69f8207SChris CostelloInc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
80d69f8207SChris Costelloas part of the DARPA CHATS research program.
81