security/mac_internal.h

   1 /*
   2  * Copyright (c) 2007 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 /*-
  30  * Copyright (c) 1999, 2000, 2001, 2002 Robert N. M. Watson
  31  * Copyright (c) 2001 Ilmar S. Habibulin
  32  * Copyright (c) 2001, 2002, 2003, 2004 Networks Associates Technology, Inc.
  33  * Copyright (c) 2005 SPARTA, Inc.
  34  * All rights reserved.
  35  *
  36  * This software was developed by Robert Watson and Ilmar Habibulin for the
  37  * TrustedBSD Project.
  38  *
  39  * This software was developed for the FreeBSD Project in part by Network
  40  * Associates Laboratories, the Security Research Division of Network
  41  * Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
  42  * as part of the DARPA CHATS research program.
  43  *
  44  * Redistribution and use in source and binary forms, with or without
  45  * modification, are permitted provided that the following conditions
  46  * are met:
  47  * 1. Redistributions of source code must retain the above copyright
  48  *    notice, this list of conditions and the following disclaimer.
  49  * 2. Redistributions in binary form must reproduce the above copyright
  50  *    notice, this list of conditions and the following disclaimer in the
  51  *    documentation and/or other materials provided with the distribution.
  52  *
  53  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  54  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  55  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  56  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  57  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  58  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  59  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  60  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  61  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  62  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  63  * SUCH DAMAGE.
  64  *
  65  */
  66
  67 #ifndef _SECURITY_MAC_INTERNAL_H_
  68 #define _SECURITY_MAC_INTERNAL_H_
  69
  70 #include <string.h>
  71 #include <sys/param.h>
  72 #include <sys/queue.h>
  73 #include <security/mac.h>
  74 #include <security/mac_framework.h>
  75 #include <security/mac_policy.h>
  76 #include <security/mac_data.h>
  77 #include <sys/sysctl.h>
  78 #include <kern/wait_queue.h>
  79 #include <kern/locks.h>
  80 #include <sys/kernel.h>
  81 #include <sys/lock.h>
  82 #include <sys/malloc.h>
  83 #include <sys/sbuf.h>
  84 #include <sys/proc.h>
  85 #include <sys/systm.h>
  86 #include <sys/socket.h>
  87 #include <sys/socketvar.h>
  88 #include <sys/vnode.h>
  89
  90 /*
  91  * MAC Framework sysctl namespace.
  92  */
  93
  94 SYSCTL_DECL(_security);
  95 SYSCTL_DECL(_security_mac);
  96
  97 extern int mac_late;
  98
  99 struct mac_policy_list_element {
 100         struct mac_policy_conf *mpc;
 101 };
 102
 103 struct mac_policy_list {
 104         u_int                           numloaded;
 105         u_int                           max;
 106         u_int                           maxindex;
 107         u_int                           staticmax;
 108         u_int                           chunks;
 109         u_int                           freehint;
 110         struct mac_policy_list_element  *entries;
 111 };
 112
 113 typedef struct mac_policy_list mac_policy_list_t;
 114
 115
 116 /*
 117  * Darwin functions not properly exported
 118  */
 119 extern void kmod_load_early(void);      /* defined in libsa/kext.cpp */
 120
 121 /*
 122  * Policy that has registered with the framework for a specific
 123  * label namespace name.
 124  */
 125 struct mac_label_listener {
 126         mac_policy_handle_t             mll_handle;
 127         LIST_ENTRY(mac_label_listener)  mll_list;
 128 };
 129
 130 LIST_HEAD(mac_label_listeners_t, mac_label_listener);
 131
 132 /*
 133  * Type of list used to manage label namespace names.
 134  */
 135 struct mac_label_element {
 136         char                            mle_name[MAC_MAX_LABEL_ELEMENT_NAME];
 137         struct mac_label_listeners_t    mle_listeners;
 138         LIST_ENTRY(mac_label_element)   mle_list;
 139 };
 140
 141 LIST_HEAD(mac_label_element_list_t, mac_label_element);
 142
 143 /*
 144  * Journal operations
 145  */
 146
 147 #define MLJ_TYPE_PORT           1
 148 #define MLJ_TYPE_TASK           2
 149
 150 #define MLJ_PORT_OP_INIT        0x0001
 151 #define MLJ_PORT_OP_CREATE_K    0x0002
 152 #define MLJ_PORT_OP_CREATE      0x0004
 153 #define MLJ_PORT_OP_UPDATE      0x0008
 154
 155 #define MLJ_TASK_OP_INIT        0x0001
 156 #define MLJ_TASK_OP_CREATE_K    0x0002
 157
 158 struct mac_label_journal {
 159         struct label *l;
 160         int type;
 161         int ops;
 162
 163         int kotype;     /* Kernel Port */
 164
 165         TAILQ_ENTRY(mac_label_journal) link;
 166 };
 167 TAILQ_HEAD(mac_label_journal_list_t, mac_label_journal);
 168
 169 int     mac_label_journal_add   (struct label *, int);
 170 int     mac_label_journal_remove(struct label *);
 171 struct mac_label_journal *
 172         mac_label_journal_find  (struct label *);
 173 int     mac_label_journal       (struct label *, int, ...);
 174 void    mac_label_journal_replay(void);
 175
 176
 177 /*
 178  * MAC Framework global variables.
 179  */
 180
 181 extern struct mac_label_element_list_t mac_label_element_list;
 182 extern struct mac_label_element_list_t mac_static_label_element_list;
 183 extern struct mac_label_journal_list_t mac_label_journal_list;
 184
 185 extern struct mac_policy_list mac_policy_list;
 186
 187 /*
 188  * global flags to control whether a MACF subsystem is configured
 189  * at all in the system.
 190  */
 191 extern unsigned int mac_device_enforce;
 192 extern unsigned int mac_file_enforce;
 193 extern unsigned int mac_iokit_enforce;
 194 extern unsigned int mac_pipe_enforce;
 195 extern unsigned int mac_posixsem_enforce;
 196 extern unsigned int mac_posixshm_enforce;
 197 extern unsigned int mac_proc_enforce;
 198 extern unsigned int mac_socket_enforce;
 199 extern unsigned int mac_system_enforce;
 200 extern unsigned int mac_sysvmsg_enforce;
 201 extern unsigned int mac_sysvsem_enforce;
 202 extern unsigned int mac_sysvshm_enforce;
 203 extern unsigned int mac_vm_enforce;
 204 extern unsigned int mac_vnode_enforce;
 205
 206 #if CONFIG_MACF_MACH
 207 extern unsigned int mac_port_enforce;
 208 extern unsigned int mac_task_enforce;
 209 #endif
 210
 211 #if CONFIG_MACF_NET
 212 extern unsigned int mac_label_mbufs;
 213 #endif
 214
 215 static int mac_proc_check_enforce(proc_t p, int enforce_flag);
 216
 217 static __inline__ int mac_proc_check_enforce(proc_t p, int enforce_flags)
 218 {
 219 #if CONFIG_MACF
 220         return ((p->p_mac_enforce & enforce_flags) != 0);
 221 #else
 222         return 0;
 223 #endif
 224 }
 225
 226 static int mac_context_check_enforce(vfs_context_t ctx, int enforce_flags);
 227 static void mac_context_set_enforce(vfs_context_t ctx, int enforce_flags);
 228
 229 static __inline__ int mac_context_check_enforce(vfs_context_t ctx, int enforce_flags)
 230 {
 231         proc_t proc = vfs_context_proc(ctx);
 232
 233         if (proc == NULL)
 234                 return 0;
 235
 236         return (mac_proc_check_enforce(proc, enforce_flags));
 237 }
 238
 239 static __inline__ void mac_context_set_enforce(vfs_context_t ctx, int enforce_flags)
 240 {
 241         proc_t proc = vfs_context_proc(ctx);
 242
 243         if (proc == NULL)
 244                 return;
 245
 246         mac_proc_set_enforce(proc, enforce_flags);
 247 }
 248
 249
 250 /*
 251  * MAC Framework infrastructure functions.
 252  */
 253
 254 int mac_error_select(int error1, int error2);
 255
 256 void  mac_policy_list_busy(void);
 257 int   mac_policy_list_conditional_busy(void);
 258 void  mac_policy_list_unbusy(void);
 259
 260 void           mac_labelzone_init(void);
 261 struct label  *mac_labelzone_alloc(int flags);
 262 void           mac_labelzone_free(struct label *label);
 263
 264 void  mac_label_init(struct label *label);
 265 void  mac_label_destroy(struct label *label);
 266 #if KERNEL
 267 int   mac_check_structmac_consistent(struct user_mac *mac);
 268 #else
 269 int   mac_check_structmac_consistent(struct mac *mac);
 270 #endif
 271
 272 int mac_cred_label_externalize(struct label *, char *e, char *out, size_t olen, int flags);
 273 int mac_lctx_label_externalize(struct label *, char *e, char *out, size_t olen);
 274 #if CONFIG_MACF_SOCKET
 275 int mac_socket_label_externalize(struct label *, char *e, char *out, size_t olen);
 276 #endif /* CONFIG_MACF_SOCKET */
 277 int mac_vnode_label_externalize(struct label *, char *e, char *out, size_t olen, int flags);
 278 int mac_pipe_label_externalize(struct label *label, char *elements,
 279  char *outbuf, size_t outbuflen);
 280
 281 int mac_cred_label_internalize(struct label *label, char *string);
 282 int mac_lctx_label_internalize(struct label *label, char *string);
 283 #if CONFIG_MACF_SOCKET
 284 int mac_socket_label_internalize(struct label *label, char *string);
 285 #endif /* CONFIG_MACF_SOCKET */
 286 int mac_vnode_label_internalize(struct label *label, char *string);
 287 int mac_pipe_label_internalize(struct label *label, char *string);
 288
 289 #if CONFIG_MACF_SOCKET
 290 /* internal socket label manipulation functions */
 291 struct  label *mac_socket_label_alloc(int flags);
 292 void    mac_socket_label_free(struct label *l);
 293 int     mac_socket_label_update(struct ucred *cred, struct socket *so, struct label *l);
 294 #endif /* MAC_SOCKET */
 295
 296 #if CONFIG_MACF_NET
 297 struct label *mac_mbuf_to_label(struct mbuf *m);
 298 #else
 299 #define mac_mbuf_to_label(m) (NULL)
 300 #endif
 301
 302 /*
 303  * MAC_CHECK performs the designated check by walking the policy
 304  * module list and checking with each as to how it feels about the
 305  * request.  Note that it returns its value via 'error' in the scope
 306  * of the caller.
 307  */
 308 #define MAC_CHECK(check, args...) do {                                  \
 309         struct mac_policy_conf *mpc;                                    \
 310         u_int i;                                                        \
 311                                                                         \
 312         error = 0;                                                      \
 313         for (i = 0; i < mac_policy_list.staticmax; i++) {               \
 314                 mpc = mac_policy_list.entries[i].mpc;                   \
 315                 if (mpc == NULL)                                        \
 316                         continue;                                       \
 317                                                                         \
 318                 if (mpc->mpc_ops->mpo_ ## check != NULL)                \
 319                         error = mac_error_select(                       \
 320                             mpc->mpc_ops->mpo_ ## check (args),         \
 321                             error);                                     \
 322         }                                                               \
 323         if (mac_policy_list_conditional_busy() != 0) {                  \
 324                 for (; i <= mac_policy_list.maxindex; i++) {            \
 325                         mpc = mac_policy_list.entries[i].mpc;           \
 326                         if (mpc == NULL)                                \
 327                                 continue;                               \
 328                                                                         \
 329                         if (mpc->mpc_ops->mpo_ ## check != NULL)        \
 330                                 error = mac_error_select(               \
 331                                     mpc->mpc_ops->mpo_ ## check (args), \
 332                                     error);                             \
 333                 }                                                       \
 334                 mac_policy_list_unbusy();                               \
 335         }                                                               \
 336 } while (0)
 337
 338 /*
 339  * MAC_BOOLEAN performs the designated boolean composition by walking
 340  * the module list, invoking each instance of the operation, and
 341  * combining the results using the passed C operator.  Note that it
 342  * returns its value via 'result' in the scope of the caller, which
 343  * should be initialized by the caller in a meaningful way to get
 344  * a meaningful result.
 345  */
 346 #define MAC_BOOLEAN(operation, composition, args...) do {               \
 347         struct mac_policy_conf *mpc;                                    \
 348         u_int i;                                                        \
 349                                                                         \
 350         for (i = 0; i < mac_policy_list.staticmax; i++) {               \
 351                 mpc = mac_policy_list.entries[i].mpc;                   \
 352                 if (mpc == NULL)                                        \
 353                         continue;                                       \
 354                                                                         \
 355                 if (mpc->mpc_ops->mpo_ ## operation != NULL)            \
 356                         result = result composition                     \
 357                             mpc->mpc_ops->mpo_ ## operation             \
 358                             (args);                                     \
 359         }                                                               \
 360         if (mac_policy_list_conditional_busy() != 0) {                  \
 361                 for (; i <= mac_policy_list.maxindex; i++) {            \
 362                         mpc = mac_policy_list.entries[i].mpc;           \
 363                         if (mpc == NULL)                                \
 364                                 continue;                               \
 365                                                                         \
 366                         if (mpc->mpc_ops->mpo_ ## operation != NULL)    \
 367                                 result = result composition             \
 368                                     mpc->mpc_ops->mpo_ ## operation     \
 369                                     (args);                             \
 370                 }                                                       \
 371                 mac_policy_list_unbusy();                               \
 372         }                                                               \
 373 } while (0)
 374
 375 #define MAC_INTERNALIZE(obj, label, instring)                           \
 376         mac_internalize(offsetof(struct mac_policy_ops, mpo_ ## obj ## _label_internalize), label, instring)
 377
 378 #define MAC_EXTERNALIZE(obj, label, elementlist, outbuf, outbuflen)     \
 379         mac_externalize(offsetof(struct mac_policy_ops, mpo_ ## obj ## _label_externalize), label, elementlist, outbuf, outbuflen)
 380
 381 #define MAC_EXTERNALIZE_AUDIT(obj, label, outbuf, outbuflen)    \
 382         mac_externalize(offsetof(struct mac_policy_ops, mpo_ ## obj ## _label_externalize_audit), label, "*", outbuf, outbuflen)
 383
 384 /*
 385  * MAC_PERFORM performs the designated operation by walking the policy
 386  * module list and invoking that operation for each policy.
 387  */
 388 #define MAC_PERFORM(operation, args...) do {                            \
 389         struct mac_policy_conf *mpc;                                    \
 390         u_int i;                                                        \
 391                                                                         \
 392         for (i = 0; i < mac_policy_list.staticmax; i++) {               \
 393                 mpc = mac_policy_list.entries[i].mpc;                   \
 394                 if (mpc == NULL)                                        \
 395                         continue;                                       \
 396                                                                         \
 397                 if (mpc->mpc_ops->mpo_ ## operation != NULL)            \
 398                         mpc->mpc_ops->mpo_ ## operation (args);         \
 399         }                                                               \
 400         if (mac_policy_list_conditional_busy() != 0) {                  \
 401                 for (; i <= mac_policy_list.maxindex; i++) {            \
 402                         mpc = mac_policy_list.entries[i].mpc;           \
 403                         if (mpc == NULL)                                \
 404                                 continue;                               \
 405                                                                         \
 406                         if (mpc->mpc_ops->mpo_ ## operation != NULL)    \
 407                                 mpc->mpc_ops->mpo_ ## operation (args); \
 408                 }                                                       \
 409                 mac_policy_list_unbusy();                               \
 410         }                                                               \
 411 } while (0)
 412
 413 struct __mac_get_pid_args;
 414 struct __mac_get_proc_args;
 415 struct __mac_set_proc_args;
 416 struct __mac_get_lcid_args;
 417 struct __mac_get_lctx_args;
 418 struct __mac_set_lctx_args;
 419 struct __mac_get_fd_args;
 420 struct __mac_get_file_args;
 421 struct __mac_get_link_args;
 422 struct __mac_set_fd_args;
 423 struct __mac_set_file_args;
 424 struct __mac_syscall_args;
 425
 426 void mac_policy_addto_labellist(const mac_policy_handle_t, int);
 427 void mac_policy_removefrom_labellist(const mac_policy_handle_t);
 428
 429 int mac_externalize(size_t mpo_externalize_off, struct label *label,
 430     const char *elementlist, char *outbuf, size_t outbuflen);
 431 int mac_internalize(size_t mpo_internalize_off, struct label *label,
 432     char *elementlist);
 433 #endif  /* !_SECURITY_MAC_INTERNAL_H_ */