1 /*- 2 * Copyright (c) 1999-2002, 2006, 2009 Robert N. M. Watson 3 * Copyright (c) 2001 Ilmar S. Habibulin 4 * Copyright (c) 2001-2004 Networks Associates Technology, Inc. 5 * Copyright (c) 2006 nCircle Network Security, Inc. 6 * Copyright (c) 2006 SPARTA, Inc. 7 * Copyright (c) 2009 Apple, Inc. 8 * All rights reserved. 9 * 10 * This software was developed by Robert Watson and Ilmar Habibulin for the 11 * TrustedBSD Project. 12 * 13 * This software was developed for the FreeBSD Project in part by Network 14 * Associates Laboratories, the Security Research Division of Network 15 * Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), 16 * as part of the DARPA CHATS research program. 17 * 18 * This software was developed by Robert N. M. Watson for the TrustedBSD 19 * Project under contract to nCircle Network Security, Inc. 20 * 21 * This software was enhanced by SPARTA ISSO under SPAWAR contract 22 * N66001-04-C-6019 ("SEFOS"). 23 * 24 * This software was developed at the University of Cambridge Computer 25 * Laboratory with support from a grant from Google, Inc. 26 * 27 * Redistribution and use in source and binary forms, with or without 28 * modification, are permitted provided that the following conditions 29 * are met: 30 * 1. Redistributions of source code must retain the above copyright 31 * notice, this list of conditions and the following disclaimer. 32 * 2. Redistributions in binary form must reproduce the above copyright 33 * notice, this list of conditions and the following disclaimer in the 34 * documentation and/or other materials provided with the distribution. 35 * 36 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 37 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 38 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 39 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 40 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 41 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 42 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 43 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 44 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 45 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 46 * SUCH DAMAGE. 47 * 48 * $FreeBSD$ 49 */ 50 51 #ifndef _SECURITY_MAC_MAC_INTERNAL_H_ 52 #define _SECURITY_MAC_MAC_INTERNAL_H_ 53 54 #ifndef _KERNEL 55 #error "no user-serviceable parts inside" 56 #endif 57 58 #include <sys/lock.h> 59 #include <sys/rmlock.h> 60 61 /* 62 * MAC Framework sysctl namespace. 63 */ 64 #ifdef SYSCTL_DECL 65 SYSCTL_DECL(_security_mac); 66 #endif /* SYSCTL_DECL */ 67 68 /* 69 * MAC Framework SDT DTrace probe namespace, macros for declaring entry 70 * point probes, macros for invoking them. 71 */ 72 #ifdef SDT_PROVIDER_DECLARE 73 SDT_PROVIDER_DECLARE(mac); /* MAC Framework-level events. */ 74 SDT_PROVIDER_DECLARE(mac_framework); /* Entry points to MAC. */ 75 76 #define MAC_CHECK_PROBE_DEFINE4(name, arg0, arg1, arg2, arg3) \ 77 SDT_PROBE_DEFINE5(mac_framework, , name, mac__check__err, \ 78 "int", arg0, arg1, arg2, arg3); \ 79 SDT_PROBE_DEFINE5(mac_framework, , name, mac__check__ok, \ 80 "int", arg0, arg1, arg2, arg3); 81 82 #define MAC_CHECK_PROBE_DEFINE3(name, arg0, arg1, arg2) \ 83 SDT_PROBE_DEFINE4(mac_framework, , name, mac__check__err, \ 84 "int", arg0, arg1, arg2); \ 85 SDT_PROBE_DEFINE4(mac_framework, , name, mac__check__ok, \ 86 "int", arg0, arg1, arg2); 87 88 #define MAC_CHECK_PROBE_DEFINE2(name, arg0, arg1) \ 89 SDT_PROBE_DEFINE3(mac_framework, , name, mac__check__err, \ 90 "int", arg0, arg1); \ 91 SDT_PROBE_DEFINE3(mac_framework, , name, mac__check__ok, \ 92 "int", arg0, arg1); 93 94 #define MAC_CHECK_PROBE_DEFINE1(name, arg0) \ 95 SDT_PROBE_DEFINE2(mac_framework, , name, mac__check__err, \ 96 "int", arg0); \ 97 SDT_PROBE_DEFINE2(mac_framework, , name, mac__check__ok, \ 98 "int", arg0); 99 100 #define MAC_CHECK_PROBE4(name, error, arg0, arg1, arg2, arg3) do { \ 101 if (SDT_PROBES_ENABLED()) { \ 102 if (error) { \ 103 SDT_PROBE5(mac_framework, , name, mac__check__err,\ 104 error, arg0, arg1, arg2, arg3); \ 105 } else { \ 106 SDT_PROBE5(mac_framework, , name, mac__check__ok,\ 107 0, arg0, arg1, arg2, arg3); \ 108 } \ 109 } \ 110 } while (0) 111 112 #define MAC_CHECK_PROBE3(name, error, arg0, arg1, arg2) \ 113 MAC_CHECK_PROBE4(name, error, arg0, arg1, arg2, 0) 114 #define MAC_CHECK_PROBE2(name, error, arg0, arg1) \ 115 MAC_CHECK_PROBE3(name, error, arg0, arg1, 0) 116 #define MAC_CHECK_PROBE1(name, error, arg0) \ 117 MAC_CHECK_PROBE2(name, error, arg0, 0) 118 #endif 119 120 #define MAC_GRANT_PROBE_DEFINE2(name, arg0, arg1) \ 121 SDT_PROBE_DEFINE3(mac_framework, , name, mac__grant__err, \ 122 "int", arg0, arg1); \ 123 SDT_PROBE_DEFINE3(mac_framework, , name, mac__grant__ok, \ 124 "int", arg0, arg1); 125 126 #define MAC_GRANT_PROBE2(name, error, arg0, arg1) do { \ 127 if (SDT_PROBES_ENABLED()) { \ 128 if (error) { \ 129 SDT_PROBE3(mac_framework, , name, mac__grant__err,\ 130 error, arg0, arg1); \ 131 } else { \ 132 SDT_PROBE3(mac_framework, , name, mac__grant__ok,\ 133 error, arg0, arg1); \ 134 } \ 135 } \ 136 } while (0) 137 138 /* 139 * MAC Framework global types and typedefs. 140 */ 141 LIST_HEAD(mac_policy_list_head, mac_policy_conf); 142 #ifdef MALLOC_DECLARE 143 MALLOC_DECLARE(M_MACTEMP); 144 #endif 145 146 /* 147 * MAC labels -- in-kernel storage format. 148 * 149 * In general, struct label pointers are embedded in kernel data structures 150 * representing objects that may be labeled (and protected). Struct label is 151 * opaque to both kernel services that invoke the MAC Framework and MAC 152 * policy modules. In particular, we do not wish to encode the layout of the 153 * label structure into any ABIs. Historically, the slot array contained 154 * unions of {long, void} but now contains uintptr_t. 155 */ 156 #define MAC_MAX_SLOTS 4 157 #define MAC_FLAG_INITIALIZED 0x0000001 /* Is initialized for use. */ 158 struct label { 159 int l_flags; 160 intptr_t l_perpolicy[MAC_MAX_SLOTS]; 161 }; 162 163 164 /* 165 * Flags for mac_labeled, a bitmask of object types need across the union of 166 * all policies currently registered with the MAC Framework, used to key 167 * whether or not labels are allocated and constructors for the type are 168 * invoked. 169 */ 170 #define MPC_OBJECT_CRED 0x0000000000000001 171 #define MPC_OBJECT_PROC 0x0000000000000002 172 #define MPC_OBJECT_VNODE 0x0000000000000004 173 #define MPC_OBJECT_INPCB 0x0000000000000008 174 #define MPC_OBJECT_SOCKET 0x0000000000000010 175 #define MPC_OBJECT_DEVFS 0x0000000000000020 176 #define MPC_OBJECT_MBUF 0x0000000000000040 177 #define MPC_OBJECT_IPQ 0x0000000000000080 178 #define MPC_OBJECT_IFNET 0x0000000000000100 179 #define MPC_OBJECT_BPFDESC 0x0000000000000200 180 #define MPC_OBJECT_PIPE 0x0000000000000400 181 #define MPC_OBJECT_MOUNT 0x0000000000000800 182 #define MPC_OBJECT_POSIXSEM 0x0000000000001000 183 #define MPC_OBJECT_POSIXSHM 0x0000000000002000 184 #define MPC_OBJECT_SYSVMSG 0x0000000000004000 185 #define MPC_OBJECT_SYSVMSQ 0x0000000000008000 186 #define MPC_OBJECT_SYSVSEM 0x0000000000010000 187 #define MPC_OBJECT_SYSVSHM 0x0000000000020000 188 #define MPC_OBJECT_SYNCACHE 0x0000000000040000 189 #define MPC_OBJECT_IP6Q 0x0000000000080000 190 191 /* 192 * MAC Framework global variables. 193 */ 194 extern struct mac_policy_list_head mac_policy_list; 195 extern struct mac_policy_list_head mac_static_policy_list; 196 extern u_int mac_policy_count; 197 extern uint64_t mac_labeled; 198 extern struct mtx mac_ifnet_mtx; 199 200 /* 201 * MAC Framework infrastructure functions. 202 */ 203 int mac_error_select(int error1, int error2); 204 205 void mac_policy_slock_nosleep(struct rm_priotracker *tracker); 206 void mac_policy_slock_sleep(void); 207 void mac_policy_sunlock_nosleep(struct rm_priotracker *tracker); 208 void mac_policy_sunlock_sleep(void); 209 210 struct label *mac_labelzone_alloc(int flags); 211 void mac_labelzone_free(struct label *label); 212 void mac_labelzone_init(void); 213 214 void mac_init_label(struct label *label); 215 void mac_destroy_label(struct label *label); 216 int mac_check_structmac_consistent(struct mac *mac); 217 int mac_allocate_slot(void); 218 219 #define MAC_IFNET_LOCK(ifp) mtx_lock(&mac_ifnet_mtx) 220 #define MAC_IFNET_UNLOCK(ifp) mtx_unlock(&mac_ifnet_mtx) 221 222 /* 223 * MAC Framework per-object type functions. It's not yet clear how the 224 * namespaces, etc, should work for these, so for now, sort by object type. 225 */ 226 struct label *mac_cred_label_alloc(void); 227 void mac_cred_label_free(struct label *label); 228 struct label *mac_pipe_label_alloc(void); 229 void mac_pipe_label_free(struct label *label); 230 struct label *mac_socket_label_alloc(int flag); 231 void mac_socket_label_free(struct label *label); 232 struct label *mac_vnode_label_alloc(void); 233 void mac_vnode_label_free(struct label *label); 234 235 int mac_cred_check_relabel(struct ucred *cred, struct label *newlabel); 236 int mac_cred_externalize_label(struct label *label, char *elements, 237 char *outbuf, size_t outbuflen); 238 int mac_cred_internalize_label(struct label *label, char *string); 239 void mac_cred_relabel(struct ucred *cred, struct label *newlabel); 240 241 struct label *mac_mbuf_to_label(struct mbuf *m); 242 243 void mac_pipe_copy_label(struct label *src, struct label *dest); 244 int mac_pipe_externalize_label(struct label *label, char *elements, 245 char *outbuf, size_t outbuflen); 246 int mac_pipe_internalize_label(struct label *label, char *string); 247 248 int mac_socket_label_set(struct ucred *cred, struct socket *so, 249 struct label *label); 250 void mac_socket_copy_label(struct label *src, struct label *dest); 251 int mac_socket_externalize_label(struct label *label, char *elements, 252 char *outbuf, size_t outbuflen); 253 int mac_socket_internalize_label(struct label *label, char *string); 254 255 int mac_vnode_externalize_label(struct label *label, char *elements, 256 char *outbuf, size_t outbuflen); 257 int mac_vnode_internalize_label(struct label *label, char *string); 258 void mac_vnode_check_mmap_downgrade(struct ucred *cred, struct vnode *vp, 259 int *prot); 260 int vn_setlabel(struct vnode *vp, struct label *intlabel, 261 struct ucred *cred); 262 263 /* 264 * MAC Framework composition macros invoke all registered MAC policies for a 265 * specific entry point. They come in two forms: one which permits policies 266 * to sleep/block, and another that does not. 267 * 268 * MAC_POLICY_CHECK performs the designated check by walking the policy 269 * module list and checking with each as to how it feels about the request. 270 * Note that it returns its value via 'error' in the scope of the caller. 271 */ 272 #define MAC_POLICY_CHECK(check, args...) do { \ 273 struct mac_policy_conf *mpc; \ 274 \ 275 error = 0; \ 276 LIST_FOREACH(mpc, &mac_static_policy_list, mpc_list) { \ 277 if (mpc->mpc_ops->mpo_ ## check != NULL) \ 278 error = mac_error_select( \ 279 mpc->mpc_ops->mpo_ ## check (args), \ 280 error); \ 281 } \ 282 if (!LIST_EMPTY(&mac_policy_list)) { \ 283 mac_policy_slock_sleep(); \ 284 LIST_FOREACH(mpc, &mac_policy_list, mpc_list) { \ 285 if (mpc->mpc_ops->mpo_ ## check != NULL) \ 286 error = mac_error_select( \ 287 mpc->mpc_ops->mpo_ ## check (args), \ 288 error); \ 289 } \ 290 mac_policy_sunlock_sleep(); \ 291 } \ 292 } while (0) 293 294 #define MAC_POLICY_CHECK_NOSLEEP(check, args...) do { \ 295 struct mac_policy_conf *mpc; \ 296 \ 297 error = 0; \ 298 LIST_FOREACH(mpc, &mac_static_policy_list, mpc_list) { \ 299 if (mpc->mpc_ops->mpo_ ## check != NULL) \ 300 error = mac_error_select( \ 301 mpc->mpc_ops->mpo_ ## check (args), \ 302 error); \ 303 } \ 304 if (!LIST_EMPTY(&mac_policy_list)) { \ 305 struct rm_priotracker tracker; \ 306 \ 307 mac_policy_slock_nosleep(&tracker); \ 308 LIST_FOREACH(mpc, &mac_policy_list, mpc_list) { \ 309 if (mpc->mpc_ops->mpo_ ## check != NULL) \ 310 error = mac_error_select( \ 311 mpc->mpc_ops->mpo_ ## check (args), \ 312 error); \ 313 } \ 314 mac_policy_sunlock_nosleep(&tracker); \ 315 } \ 316 } while (0) 317 318 /* 319 * MAC_POLICY_GRANT performs the designated check by walking the policy 320 * module list and checking with each as to how it feels about the request. 321 * Unlike MAC_POLICY_CHECK, it grants if any policies return '0', and 322 * otherwise returns EPERM. Note that it returns its value via 'error' in 323 * the scope of the caller. 324 */ 325 #define MAC_POLICY_GRANT_NOSLEEP(check, args...) do { \ 326 struct mac_policy_conf *mpc; \ 327 \ 328 error = EPERM; \ 329 LIST_FOREACH(mpc, &mac_static_policy_list, mpc_list) { \ 330 if (mpc->mpc_ops->mpo_ ## check != NULL) { \ 331 if (mpc->mpc_ops->mpo_ ## check(args) == 0) \ 332 error = 0; \ 333 } \ 334 } \ 335 if (!LIST_EMPTY(&mac_policy_list)) { \ 336 struct rm_priotracker tracker; \ 337 \ 338 mac_policy_slock_nosleep(&tracker); \ 339 LIST_FOREACH(mpc, &mac_policy_list, mpc_list) { \ 340 if (mpc->mpc_ops->mpo_ ## check != NULL) { \ 341 if (mpc->mpc_ops->mpo_ ## check (args) \ 342 == 0) \ 343 error = 0; \ 344 } \ 345 } \ 346 mac_policy_sunlock_nosleep(&tracker); \ 347 } \ 348 } while (0) 349 350 /* 351 * MAC_POLICY_BOOLEAN performs the designated boolean composition by walking 352 * the module list, invoking each instance of the operation, and combining 353 * the results using the passed C operator. Note that it returns its value 354 * via 'result' in the scope of the caller, which should be initialized by 355 * the caller in a meaningful way to get a meaningful result. 356 */ 357 #define MAC_POLICY_BOOLEAN(operation, composition, args...) do { \ 358 struct mac_policy_conf *mpc; \ 359 \ 360 LIST_FOREACH(mpc, &mac_static_policy_list, mpc_list) { \ 361 if (mpc->mpc_ops->mpo_ ## operation != NULL) \ 362 result = result composition \ 363 mpc->mpc_ops->mpo_ ## operation (args); \ 364 } \ 365 if (!LIST_EMPTY(&mac_policy_list)) { \ 366 mac_policy_slock_sleep(); \ 367 LIST_FOREACH(mpc, &mac_policy_list, mpc_list) { \ 368 if (mpc->mpc_ops->mpo_ ## operation != NULL) \ 369 result = result composition \ 370 mpc->mpc_ops->mpo_ ## operation \ 371 (args); \ 372 } \ 373 mac_policy_sunlock_sleep(); \ 374 } \ 375 } while (0) 376 377 #define MAC_POLICY_BOOLEAN_NOSLEEP(operation, composition, args...) do {\ 378 struct mac_policy_conf *mpc; \ 379 \ 380 LIST_FOREACH(mpc, &mac_static_policy_list, mpc_list) { \ 381 if (mpc->mpc_ops->mpo_ ## operation != NULL) \ 382 result = result composition \ 383 mpc->mpc_ops->mpo_ ## operation (args); \ 384 } \ 385 if (!LIST_EMPTY(&mac_policy_list)) { \ 386 struct rm_priotracker tracker; \ 387 \ 388 mac_policy_slock_nosleep(&tracker); \ 389 LIST_FOREACH(mpc, &mac_policy_list, mpc_list) { \ 390 if (mpc->mpc_ops->mpo_ ## operation != NULL) \ 391 result = result composition \ 392 mpc->mpc_ops->mpo_ ## operation \ 393 (args); \ 394 } \ 395 mac_policy_sunlock_nosleep(&tracker); \ 396 } \ 397 } while (0) 398 399 /* 400 * MAC_POLICY_EXTERNALIZE queries each policy to see if it can generate an 401 * externalized version of a label element by name. Policies declare whether 402 * they have matched a particular element name, parsed from the string by 403 * MAC_POLICY_EXTERNALIZE, and an error is returned if any element is matched 404 * by no policy. 405 */ 406 #define MAC_POLICY_EXTERNALIZE(type, label, elementlist, outbuf, \ 407 outbuflen) do { \ 408 int claimed, first, ignorenotfound, savedlen; \ 409 char *element_name, *element_temp; \ 410 struct sbuf sb; \ 411 \ 412 error = 0; \ 413 first = 1; \ 414 sbuf_new(&sb, outbuf, outbuflen, SBUF_FIXEDLEN); \ 415 element_temp = elementlist; \ 416 while ((element_name = strsep(&element_temp, ",")) != NULL) { \ 417 if (element_name[0] == '?') { \ 418 element_name++; \ 419 ignorenotfound = 1; \ 420 } else \ 421 ignorenotfound = 0; \ 422 savedlen = sbuf_len(&sb); \ 423 if (first) \ 424 error = sbuf_printf(&sb, "%s/", element_name); \ 425 else \ 426 error = sbuf_printf(&sb, ",%s/", element_name); \ 427 if (error == -1) { \ 428 error = EINVAL; /* XXX: E2BIG? */ \ 429 break; \ 430 } \ 431 claimed = 0; \ 432 MAC_POLICY_CHECK(type ## _externalize_label, label, \ 433 element_name, &sb, &claimed); \ 434 if (error) \ 435 break; \ 436 if (claimed == 0 && ignorenotfound) { \ 437 /* Revert last label name. */ \ 438 sbuf_setpos(&sb, savedlen); \ 439 } else if (claimed != 1) { \ 440 error = EINVAL; /* XXX: ENOLABEL? */ \ 441 break; \ 442 } else { \ 443 first = 0; \ 444 } \ 445 } \ 446 sbuf_finish(&sb); \ 447 } while (0) 448 449 /* 450 * MAC_POLICY_INTERNALIZE presents parsed element names and data to each 451 * policy to see if any is willing to claim it and internalize the label 452 * data. If no policies match, an error is returned. 453 */ 454 #define MAC_POLICY_INTERNALIZE(type, label, instring) do { \ 455 char *element, *element_name, *element_data; \ 456 int claimed; \ 457 \ 458 error = 0; \ 459 element = instring; \ 460 while ((element_name = strsep(&element, ",")) != NULL) { \ 461 element_data = element_name; \ 462 element_name = strsep(&element_data, "/"); \ 463 if (element_data == NULL) { \ 464 error = EINVAL; \ 465 break; \ 466 } \ 467 claimed = 0; \ 468 MAC_POLICY_CHECK(type ## _internalize_label, label, \ 469 element_name, element_data, &claimed); \ 470 if (error) \ 471 break; \ 472 if (claimed != 1) { \ 473 /* XXXMAC: Another error here? */ \ 474 error = EINVAL; \ 475 break; \ 476 } \ 477 } \ 478 } while (0) 479 480 /* 481 * MAC_POLICY_PERFORM performs the designated operation by walking the policy 482 * module list and invoking that operation for each policy. 483 */ 484 #define MAC_POLICY_PERFORM(operation, args...) do { \ 485 struct mac_policy_conf *mpc; \ 486 \ 487 LIST_FOREACH(mpc, &mac_static_policy_list, mpc_list) { \ 488 if (mpc->mpc_ops->mpo_ ## operation != NULL) \ 489 mpc->mpc_ops->mpo_ ## operation (args); \ 490 } \ 491 if (!LIST_EMPTY(&mac_policy_list)) { \ 492 mac_policy_slock_sleep(); \ 493 LIST_FOREACH(mpc, &mac_policy_list, mpc_list) { \ 494 if (mpc->mpc_ops->mpo_ ## operation != NULL) \ 495 mpc->mpc_ops->mpo_ ## operation (args); \ 496 } \ 497 mac_policy_sunlock_sleep(); \ 498 } \ 499 } while (0) 500 501 #define MAC_POLICY_PERFORM_NOSLEEP(operation, args...) do { \ 502 struct mac_policy_conf *mpc; \ 503 \ 504 LIST_FOREACH(mpc, &mac_static_policy_list, mpc_list) { \ 505 if (mpc->mpc_ops->mpo_ ## operation != NULL) \ 506 mpc->mpc_ops->mpo_ ## operation (args); \ 507 } \ 508 if (!LIST_EMPTY(&mac_policy_list)) { \ 509 struct rm_priotracker tracker; \ 510 \ 511 mac_policy_slock_nosleep(&tracker); \ 512 LIST_FOREACH(mpc, &mac_policy_list, mpc_list) { \ 513 if (mpc->mpc_ops->mpo_ ## operation != NULL) \ 514 mpc->mpc_ops->mpo_ ## operation (args); \ 515 } \ 516 mac_policy_sunlock_nosleep(&tracker); \ 517 } \ 518 } while (0) 519 520 #endif /* !_SECURITY_MAC_MAC_INTERNAL_H_ */ 521