xref: /freebsd/lib/libugidfw/bsde_rule_to_string.3 (revision 4b9d605768acabc460aa6dcfe8a1f8db35b16794)
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 January 7, 2003
32.Dt BSDE_RULE_TO_STRING 3
33.Os
34.Sh NAME
35.Nm bsde_rule_to_string
36.Nd "convert a ugidfw rule into its text representation"
37.Sh LIBRARY
38.Lb libugidfw
39.Sh SYNOPSIS
40.In ugidfw.h
41.Ft int
42.Fo bsde_rule_to_string
43.Fa "struct mac_bsdextended_rule *rule" "char *buf" "size_t buflen"
44.Fc
45.Sh DESCRIPTION
46The
47.Fn bsde_rule_to_string
48function converts a rule in its internal representation
49.Pq Vt "struct mac_bsdextended_rule"
50into its text representation, and writes up to
51.Fa buflen
52bytes of it to
53.Fa buf
54(including the terminating
55.Dv NUL ) .
56.Sh RETURN VALUES
57The
58.Fn bsde_rule_to_string
59function returns \-1 if the conversion was truncated;
60otherwise the value 0 is returned.
61.Sh SEE ALSO
62.Xr bsde_delete_rule 3 ,
63.Xr bsde_get_rule 3 ,
64.Xr bsde_get_rule_count 3 ,
65.Xr bsde_get_rule_slots 3 ,
66.Xr bsde_parse_rule 3 ,
67.Xr bsde_parse_rule_string 3 ,
68.Xr bsde_set_rule 3 ,
69.Xr libugidfw 3 ,
70.Xr mac_bsdextended 4 ,
71.Xr ugidfw 8
72.Sh AUTHORS
73This software was contributed to the
74.Fx
75Project by Network Associates Labs,
76the Security Research Division of Network Associates
77Inc.
78under DARPA/SPAWAR contract N66001-01-C-8035
79.Pq Dq CBOSS ,
80as part of the DARPA CHATS research program.
81