xref: /freebsd/sys/security/mac_mls/mac_mls.h (revision f30a9615fddeba5106492b4623e0bc37c999f45d)
1 /*-
2  * Copyright (c) 1999, 2000, 2001, 2002 Robert N. M. Watson
3  * Copyright (c) 2001, 2002 Networks Associates Technology, Inc.
4  * All rights reserved.
5  *
6  * This software was developed by Robert Watson for the TrustedBSD Project.
7  *
8  * This software was developed for the FreeBSD Project in part by NAI Labs,
9  * the Security Research Division of Network Associates, Inc. under
10  * DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA
11  * CHATS research program.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. The names of the authors may not be used to endorse or promote
22  *    products derived from this software without specific prior written
23  *    permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  * $FreeBSD$
38  */
39 /*
40  * Definitions for the TrustedBSD MLS confidentiality policy module.
41  */
42 #ifndef _SYS_SECURITY_MAC_MLS_H
43 #define	_SYS_SECURITY_MAC_MLS_H
44 
45 #define	MAC_MLS_EXTATTR_NAMESPACE	EXTATTR_NAMESPACE_SYSTEM
46 #define	MAC_MLS_EXTATTR_NAME		"mac_mls"
47 
48 #define	MAC_MLS_LABEL_NAME		"mls"
49 
50 #define	MAC_MLS_FLAG_SINGLE	0x00000001	/* mm_single initialized */
51 #define	MAC_MLS_FLAG_RANGE	0x00000002	/* mm_range* initialized */
52 #define	MAC_MLS_FLAGS_BOTH	(MAC_MLS_FLAG_SINGLE | MAC_MLS_FLAG_RANGE)
53 
54 #define	MAC_MLS_TYPE_UNDEF	0	/* Undefined */
55 #define	MAC_MLS_TYPE_LEVEL	1	/* Hierarchal level with mm_level. */
56 #define	MAC_MLS_TYPE_LOW	2	/* Dominated by any
57 					 * MAC_MLS_TYPE_LABEL. */
58 #define	MAC_MLS_TYPE_HIGH	3	/* Dominates any
59 					 * MAC_MLS_TYPE_LABEL. */
60 #define	MAC_MLS_TYPE_EQUAL	4	/* Equivilent to any
61 					 * MAC_MLS_TYPE_LABEL. */
62 
63 /*
64  * Structures and constants associated with a Multi-Level Security policy.
65  * mac_mls represents an MLS label, with mm_type determining its properties,
66  * and mm_level represents the hierarchal sensitivity level if valid for the
67  * current mm_type.  If compartments are used, the same semantics apply as
68  * long as the suject is in every compartment the object is in.  LOW, EQUAL
69  * and HIGH cannot be in compartments.
70  */
71 
72 /*
73  * MLS compartments bit set size (in bits).
74  */
75 #define	MAC_MLS_MAX_COMPARTMMENTS	256
76 
77 struct mac_mls_element {
78 	u_short	mme_type;
79 	u_short	mme_level;
80 	u_char	mme_compartments[MAC_MLS_MAX_COMPARTMENTS >> 3];
81 };
82 
83 /*
84  * MLS labels consist of two components: a single label, and a label
85  * range.  Depending on the context, one or both may be used; the mb_flags
86  * field permits the provider to indicate what fields are intended for
87  * use.
88  */
89 struct mac_mls {
90 	int			mm_flags;
91 	struct mac_mls_element	mm_single;
92 	struct mac_mls_element	mm_rangelow, mm_rangehigh;
93 };
94 
95 /*
96  * MLS compartments bit test/set macros.
97  * The range is 1 to MAC_MLS_MAX_COMPARTMENTS.
98  */
99 #define	MAC_MLS_BIT_TEST(b, w) \
100 	((w)[(((b) - 1) >> 3)] & (1 << (((b) - 1) & 7)))
101 #define	MAC_MLS_BIT_SET(b, w) \
102 	((w)[(((b) - 1) >> 3)] |= (1 << (((b) - 1) & 7)))
103 #define	MAC_MLS_BIT_SET_EMPTY(set)	mls_bit_set_empty(set)
104 
105 #endif /* !_SYS_SECURITY_MAC_MLS_H */
106