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