xref: /xnu-11215.81.4/security/mac_label.c (revision d4514f0bc1d3f944c22d92e68b646ac3fb40d452) !
1*d4514f0bSApple OSS Distributions /*-
2*d4514f0bSApple OSS Distributions  * Copyright (c) 2004 Networks Associates Technology, Inc.
3*d4514f0bSApple OSS Distributions  * Copyright (c) 2005 SPARTA, Inc.
4*d4514f0bSApple OSS Distributions  * All rights reserved.
5*d4514f0bSApple OSS Distributions  *
6*d4514f0bSApple OSS Distributions  * This software was developed for the FreeBSD Project in part by Network
7*d4514f0bSApple OSS Distributions  * Associates Laboratories, the Security Research Division of Network
8*d4514f0bSApple OSS Distributions  * Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
9*d4514f0bSApple OSS Distributions  * as part of the DARPA CHATS research program.
10*d4514f0bSApple OSS Distributions  *
11*d4514f0bSApple OSS Distributions  * Redistribution and use in source and binary forms, with or without
12*d4514f0bSApple OSS Distributions  * modification, are permitted provided that the following conditions
13*d4514f0bSApple OSS Distributions  * are met:
14*d4514f0bSApple OSS Distributions  * 1. Redistributions of source code must retain the above copyright
15*d4514f0bSApple OSS Distributions  *    notice, this list of conditions and the following disclaimer.
16*d4514f0bSApple OSS Distributions  * 2. Redistributions in binary form must reproduce the above copyright
17*d4514f0bSApple OSS Distributions  *    notice, this list of conditions and the following disclaimer in the
18*d4514f0bSApple OSS Distributions  *    documentation and/or other materials provided with the distribution.
19*d4514f0bSApple OSS Distributions  *
20*d4514f0bSApple OSS Distributions  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21*d4514f0bSApple OSS Distributions  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22*d4514f0bSApple OSS Distributions  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23*d4514f0bSApple OSS Distributions  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24*d4514f0bSApple OSS Distributions  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25*d4514f0bSApple OSS Distributions  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26*d4514f0bSApple OSS Distributions  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27*d4514f0bSApple OSS Distributions  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28*d4514f0bSApple OSS Distributions  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29*d4514f0bSApple OSS Distributions  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30*d4514f0bSApple OSS Distributions  * SUCH DAMAGE.
31*d4514f0bSApple OSS Distributions  */
32*d4514f0bSApple OSS Distributions 
33*d4514f0bSApple OSS Distributions #include <kern/zalloc.h>
34*d4514f0bSApple OSS Distributions #include <security/_label.h>
35*d4514f0bSApple OSS Distributions #include <sys/param.h>
36*d4514f0bSApple OSS Distributions #include <sys/queue.h>
37*d4514f0bSApple OSS Distributions #include <sys/systm.h>
38*d4514f0bSApple OSS Distributions #include <security/mac_internal.h>
39*d4514f0bSApple OSS Distributions 
40*d4514f0bSApple OSS Distributions ZONE_DEFINE_ID(ZONE_ID_MAC_LABEL, "MAC Labels", struct label,
41*d4514f0bSApple OSS Distributions     ZC_READONLY | ZC_ZFREE_CLEARMEM);
42*d4514f0bSApple OSS Distributions 
43*d4514f0bSApple OSS Distributions /*
44*d4514f0bSApple OSS Distributions  * Number of initial values matches logic in security/_label.h
45*d4514f0bSApple OSS Distributions  */
46*d4514f0bSApple OSS Distributions const struct label empty_label = {
47*d4514f0bSApple OSS Distributions 	.l_perpolicy[0 ... MAC_MAX_SLOTS - 1] = MAC_LABEL_NULL_SLOT,
48*d4514f0bSApple OSS Distributions };
49*d4514f0bSApple OSS Distributions 
50*d4514f0bSApple OSS Distributions static struct label *
label_alloc_noinit(int flags)51*d4514f0bSApple OSS Distributions label_alloc_noinit(int flags)
52*d4514f0bSApple OSS Distributions {
53*d4514f0bSApple OSS Distributions 	static_assert(MAC_NOWAIT == Z_NOWAIT);
54*d4514f0bSApple OSS Distributions 	return zalloc_ro(ZONE_ID_MAC_LABEL, Z_ZERO | (flags & MAC_NOWAIT));
55*d4514f0bSApple OSS Distributions }
56*d4514f0bSApple OSS Distributions 
57*d4514f0bSApple OSS Distributions struct label *
mac_labelzone_alloc(int flags)58*d4514f0bSApple OSS Distributions mac_labelzone_alloc(int flags)
59*d4514f0bSApple OSS Distributions {
60*d4514f0bSApple OSS Distributions 	struct label *label;
61*d4514f0bSApple OSS Distributions 
62*d4514f0bSApple OSS Distributions 	label = label_alloc_noinit(flags);
63*d4514f0bSApple OSS Distributions 	if (label) {
64*d4514f0bSApple OSS Distributions 		zalloc_ro_update_elem(ZONE_ID_MAC_LABEL, label, &empty_label);
65*d4514f0bSApple OSS Distributions 	}
66*d4514f0bSApple OSS Distributions 
67*d4514f0bSApple OSS Distributions 	return label;
68*d4514f0bSApple OSS Distributions }
69*d4514f0bSApple OSS Distributions 
70*d4514f0bSApple OSS Distributions struct label *
71*d4514f0bSApple OSS Distributions mac_labelzone_alloc_for_owner(struct label **labelp, int flags,
72*d4514f0bSApple OSS Distributions     void (^extra_setup)(struct label *))
73*d4514f0bSApple OSS Distributions {
74*d4514f0bSApple OSS Distributions 	struct label *label;
75*d4514f0bSApple OSS Distributions 
76*d4514f0bSApple OSS Distributions 	if (labelp) {
77*d4514f0bSApple OSS Distributions 		struct label tmp_label = empty_label;
78*d4514f0bSApple OSS Distributions 
79*d4514f0bSApple OSS Distributions 		label = zalloc_ro(ZONE_ID_MAC_LABEL, Z_ZERO | (flags & MAC_NOWAIT));
80*d4514f0bSApple OSS Distributions 
81*d4514f0bSApple OSS Distributions 		tmp_label.l_owner = labelp;
82*d4514f0bSApple OSS Distributions 		zalloc_ro_update_elem(ZONE_ID_MAC_LABEL, label, &tmp_label);
83*d4514f0bSApple OSS Distributions 	} else {
84*d4514f0bSApple OSS Distributions 		label = mac_labelzone_alloc(flags);
85*d4514f0bSApple OSS Distributions 	}
86*d4514f0bSApple OSS Distributions 
87*d4514f0bSApple OSS Distributions 	if (label && extra_setup) {
88*d4514f0bSApple OSS Distributions 		extra_setup(label);
89*d4514f0bSApple OSS Distributions 	}
90*d4514f0bSApple OSS Distributions 
91*d4514f0bSApple OSS Distributions 	return label;
92*d4514f0bSApple OSS Distributions }
93*d4514f0bSApple OSS Distributions 
94*d4514f0bSApple OSS Distributions struct label *
95*d4514f0bSApple OSS Distributions mac_labelzone_alloc_owned(struct label **labelp, int flags,
96*d4514f0bSApple OSS Distributions     void (^extra_setup)(struct label *))
97*d4514f0bSApple OSS Distributions {
98*d4514f0bSApple OSS Distributions 	struct label *label;
99*d4514f0bSApple OSS Distributions 
100*d4514f0bSApple OSS Distributions 	label = mac_labelzone_alloc_for_owner(labelp, flags, extra_setup);
101*d4514f0bSApple OSS Distributions 
102*d4514f0bSApple OSS Distributions 	if (labelp) {
103*d4514f0bSApple OSS Distributions 		*labelp = label;
104*d4514f0bSApple OSS Distributions 	}
105*d4514f0bSApple OSS Distributions 
106*d4514f0bSApple OSS Distributions 	return label;
107*d4514f0bSApple OSS Distributions }
108*d4514f0bSApple OSS Distributions 
109*d4514f0bSApple OSS Distributions void
mac_labelzone_free(struct label * label)110*d4514f0bSApple OSS Distributions mac_labelzone_free(struct label *label)
111*d4514f0bSApple OSS Distributions {
112*d4514f0bSApple OSS Distributions 	if (label == NULL) {
113*d4514f0bSApple OSS Distributions 		panic("Free of NULL MAC label");
114*d4514f0bSApple OSS Distributions 	}
115*d4514f0bSApple OSS Distributions 
116*d4514f0bSApple OSS Distributions 	zfree_ro(ZONE_ID_MAC_LABEL, label);
117*d4514f0bSApple OSS Distributions }
118*d4514f0bSApple OSS Distributions 
119*d4514f0bSApple OSS Distributions void
120*d4514f0bSApple OSS Distributions mac_labelzone_free_owned(struct label **labelp,
121*d4514f0bSApple OSS Distributions     void (^extra_deinit)(struct label *))
122*d4514f0bSApple OSS Distributions {
123*d4514f0bSApple OSS Distributions 	struct label *label;
124*d4514f0bSApple OSS Distributions 
125*d4514f0bSApple OSS Distributions 	label = mac_label_verify(labelp);
126*d4514f0bSApple OSS Distributions 	if (label) {
127*d4514f0bSApple OSS Distributions 		if (extra_deinit) {
128*d4514f0bSApple OSS Distributions 			extra_deinit(label);
129*d4514f0bSApple OSS Distributions 		}
130*d4514f0bSApple OSS Distributions 
131*d4514f0bSApple OSS Distributions 		*labelp = NULL;
132*d4514f0bSApple OSS Distributions 		mac_labelzone_free(label);
133*d4514f0bSApple OSS Distributions 	}
134*d4514f0bSApple OSS Distributions }
135*d4514f0bSApple OSS Distributions 
136*d4514f0bSApple OSS Distributions __abortlike
137*d4514f0bSApple OSS Distributions static void
mac_label_verify_panic(struct label ** labelp)138*d4514f0bSApple OSS Distributions mac_label_verify_panic(struct label **labelp)
139*d4514f0bSApple OSS Distributions {
140*d4514f0bSApple OSS Distributions 	panic("label backref mismatch: labelp:%p label:%p l_owner:%p", labelp,
141*d4514f0bSApple OSS Distributions 	    *labelp, (*labelp)->l_owner);
142*d4514f0bSApple OSS Distributions }
143*d4514f0bSApple OSS Distributions 
144*d4514f0bSApple OSS Distributions struct label *
mac_label_verify(struct label ** labelp)145*d4514f0bSApple OSS Distributions mac_label_verify(struct label **labelp)
146*d4514f0bSApple OSS Distributions {
147*d4514f0bSApple OSS Distributions 	struct label *label = *labelp;
148*d4514f0bSApple OSS Distributions 
149*d4514f0bSApple OSS Distributions 	if (label != NULL) {
150*d4514f0bSApple OSS Distributions 		zone_require_ro(ZONE_ID_MAC_LABEL, sizeof(struct label), label);
151*d4514f0bSApple OSS Distributions 
152*d4514f0bSApple OSS Distributions 		if (__improbable(label->l_owner != labelp)) {
153*d4514f0bSApple OSS Distributions 			mac_label_verify_panic(labelp);
154*d4514f0bSApple OSS Distributions 		}
155*d4514f0bSApple OSS Distributions 	}
156*d4514f0bSApple OSS Distributions 
157*d4514f0bSApple OSS Distributions 	return label;
158*d4514f0bSApple OSS Distributions }
159*d4514f0bSApple OSS Distributions 
160*d4514f0bSApple OSS Distributions static intptr_t
mac_label_slot_encode(intptr_t p)161*d4514f0bSApple OSS Distributions mac_label_slot_encode(intptr_t p)
162*d4514f0bSApple OSS Distributions {
163*d4514f0bSApple OSS Distributions 	return p ?: MAC_LABEL_NULL_SLOT;
164*d4514f0bSApple OSS Distributions }
165*d4514f0bSApple OSS Distributions 
166*d4514f0bSApple OSS Distributions static intptr_t
mac_label_slot_decode(intptr_t p)167*d4514f0bSApple OSS Distributions mac_label_slot_decode(intptr_t p)
168*d4514f0bSApple OSS Distributions {
169*d4514f0bSApple OSS Distributions 	switch (p) {
170*d4514f0bSApple OSS Distributions 	case 0:
171*d4514f0bSApple OSS Distributions 		/* make sure 0 doesn't mean NULL and causes crashes */
172*d4514f0bSApple OSS Distributions 		return MAC_LABEL_NULL_SLOT;
173*d4514f0bSApple OSS Distributions 	case MAC_LABEL_NULL_SLOT:
174*d4514f0bSApple OSS Distributions 		return 0l;
175*d4514f0bSApple OSS Distributions 	default:
176*d4514f0bSApple OSS Distributions 		return p;
177*d4514f0bSApple OSS Distributions 	}
178*d4514f0bSApple OSS Distributions }
179*d4514f0bSApple OSS Distributions 
180*d4514f0bSApple OSS Distributions /*
181*d4514f0bSApple OSS Distributions  * Functions used by policy modules to get and set label values.
182*d4514f0bSApple OSS Distributions  */
183*d4514f0bSApple OSS Distributions intptr_t
mac_label_get(struct label * label,int slot)184*d4514f0bSApple OSS Distributions mac_label_get(struct label *label, int slot)
185*d4514f0bSApple OSS Distributions {
186*d4514f0bSApple OSS Distributions 	KASSERT(label != NULL, ("mac_label_get: NULL label"));
187*d4514f0bSApple OSS Distributions 
188*d4514f0bSApple OSS Distributions 	zone_require_ro(ZONE_ID_MAC_LABEL, sizeof(struct label), label);
189*d4514f0bSApple OSS Distributions 	return mac_label_slot_decode((intptr_t) label->l_perpolicy[slot]);
190*d4514f0bSApple OSS Distributions }
191*d4514f0bSApple OSS Distributions 
192*d4514f0bSApple OSS Distributions __abortlike
193*d4514f0bSApple OSS Distributions static void
panic_label_set_sentinel(void)194*d4514f0bSApple OSS Distributions panic_label_set_sentinel(void)
195*d4514f0bSApple OSS Distributions {
196*d4514f0bSApple OSS Distributions 	panic("cannot set mac label to ~0");
197*d4514f0bSApple OSS Distributions }
198*d4514f0bSApple OSS Distributions 
199*d4514f0bSApple OSS Distributions void
mac_label_set(struct label * label,int slot,intptr_t v)200*d4514f0bSApple OSS Distributions mac_label_set(struct label *label, int slot, intptr_t v)
201*d4514f0bSApple OSS Distributions {
202*d4514f0bSApple OSS Distributions 	KASSERT(label != NULL, ("mac_label_set: NULL label"));
203*d4514f0bSApple OSS Distributions 
204*d4514f0bSApple OSS Distributions #if DEVELOPMENT || DEBUG
205*d4514f0bSApple OSS Distributions 	/* can't modify a sealed label, see mac_cred_label_seal() */
206*d4514f0bSApple OSS Distributions 	assertf(label->l_owner != (struct label **)-1,
207*d4514f0bSApple OSS Distributions 	    "mac_label_set(%p, %d, 0x%lx) is sealed",
208*d4514f0bSApple OSS Distributions 	    label, slot, v);
209*d4514f0bSApple OSS Distributions #endif
210*d4514f0bSApple OSS Distributions 	if (v == MAC_LABEL_NULL_SLOT) {
211*d4514f0bSApple OSS Distributions 		panic_label_set_sentinel();
212*d4514f0bSApple OSS Distributions 	}
213*d4514f0bSApple OSS Distributions 	v = mac_label_slot_encode(v);
214*d4514f0bSApple OSS Distributions 	zalloc_ro_update_field(ZONE_ID_MAC_LABEL, label, l_perpolicy[slot], &v);
215*d4514f0bSApple OSS Distributions }
216