[apple/xnu.git] / security / mac.h

/*
 * Copyright (c) 2007 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*-
 * Copyright (c) 1999-2002 Robert N. M. Watson
 * Copyright (c) 2001-2005 Networks Associates Technology, Inc.
 * Copyright (c) 2005-2006 SPARTA, Inc.
 * All rights reserved.
 *
 * This software was developed by Robert Watson for the TrustedBSD Project.
 *
 * This software was developed for the FreeBSD Project in part by Network
 * Associates Laboratories, the Security Research Division of Network
 * Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
 * as part of the DARPA CHATS research program.
 *
 * This software was enhanced by SPARTA ISSO under SPAWAR contract
 * N66001-04-C-6019 ("SEFOS").
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD: src/sys/sys/mac.h,v 1.40 2003/04/18 19:57:37 rwatson Exp $
 */
/*
 * Userland interface for Mandatory Access Control.
 *
 * The POSIX.1e implementation page may be reached at:
 * http://www.trustedbsd.org/
 */

#ifndef _SECURITY_MAC_H_
#define	_SECURITY_MAC_H_

#ifndef _POSIX_MAC
#define	_POSIX_MAC
#endif

#include <sys/types.h>

/*
 * MAC framework-related constants and limits.
 */
#define	MAC_MAX_POLICY_NAME		32
#define	MAC_MAX_LABEL_ELEMENT_NAME	32
#define	MAC_MAX_LABEL_ELEMENT_DATA	4096
#define	MAC_MAX_LABEL_BUF_LEN		8192
#define MAC_MAX_MANAGED_NAMESPACES	4

struct mac {
	size_t		 m_buflen;
	char		*m_string;
};

typedef struct mac	*mac_t;

#ifdef KERNEL

#ifndef PRIVATE
#warning "MAC policy is not KPI, see Technical Q&A QA1574"
#endif

#if DEBUG
#define SECURITY_MAC_CTLFLAGS (CTLFLAG_RW | CTLFLAG_LOCKED)
#define SECURITY_MAC_CHECK_ENFORCE 1
#else
#define SECURITY_MAC_CTLFLAGS (CTLFLAG_RD | CTLFLAG_LOCKED)
#define SECURITY_MAC_CHECK_ENFORCE 0
#endif

struct user_mac {
	user_size_t	m_buflen;
	user_addr_t	m_string;
};

struct user32_mac {
	uint32_t	m_buflen;
	uint32_t	m_string;
};

struct user64_mac {
	uint64_t	m_buflen;
	uint64_t	m_string;
};
#endif /* KERNEL */

/*
 * Flags to control which MAC subsystems are enforced
 * on a per-process/thread/credential basis.
 */
#define MAC_SYSTEM_ENFORCE	0x0001	/* system management */
#define MAC_PROC_ENFORCE	0x0002	/* process management */
#define MAC_MACH_ENFORCE	0x0004	/* mach interfaces */
#define MAC_VM_ENFORCE		0x0008	/* VM interfaces */
#define MAC_FILE_ENFORCE	0x0010	/* file operations */
#define MAC_SOCKET_ENFORCE	0x0020	/* socket operations */
#define MAC_PIPE_ENFORCE	0x0040	/* pipes */
#define MAC_VNODE_ENFORCE	0x0080	/* vnode operations */
#define MAC_NET_ENFORCE		0x0100	/* network management */
#define MAC_MBUF_ENFORCE	0x0200	/* network traffic */
#define MAC_POSIXSEM_ENFORCE	0x0400	/* posix semaphores */
#define MAC_POSIXSHM_ENFORCE	0x0800	/* posix shared memory */
#define MAC_SYSVMSG_ENFORCE	0x1000	/* SysV message queues */
#define MAC_SYSVSEM_ENFORCE	0x2000	/* SysV semaphores */
#define MAC_SYSVSHM_ENFORCE	0x4000	/* SysV shared memory */
#define MAC_ALL_ENFORCE		0x7fff	/* enforce everything */

/*
 * Device types for mac_iokit_check_device()
 */
#define MAC_DEVICE_USB		"USB"
#define MAC_DEVICE_FIREWIRE	"FireWire"
#define MAC_DEVICE_TYPE_KEY	"DeviceType"

/*
 * Flags for mac_proc_check_suspend_resume()
 */
#define MAC_PROC_CHECK_SUSPEND   		0
#define MAC_PROC_CHECK_RESUME    		1
#define MAC_PROC_CHECK_HIBERNATE 		2
#define MAC_PROC_CHECK_SHUTDOWN_SOCKETS		3
#define MAC_PROC_CHECK_PIDBIND			4

#ifndef KERNEL
/*
 * Location of the userland MAC framework configuration file.  mac.conf
 * binds policy names to shared libraries that understand those policies,
 * as well as setting defaults for MAC-aware applications.
 */
#define	MAC_CONFFILE	"/etc/mac.conf"

/*
 * Extended non-POSIX.1e interfaces that offer additional services
 * available from the userland and kernel MAC frameworks.
 */
#ifdef __APPLE_API_PRIVATE
__BEGIN_DECLS
int	 __mac_execve(char *fname, char **argv, char **envv, mac_t _label);
int	 __mac_get_fd(int _fd, mac_t _label);
int	 __mac_get_file(const char *_path, mac_t _label);
int	 __mac_get_link(const char *_path, mac_t _label);
int	 __mac_get_pid(pid_t _pid, mac_t _label);
int	 __mac_get_proc(mac_t _label);
int	 __mac_set_fd(int _fildes, const mac_t _label);
int	 __mac_set_file(const char *_path, mac_t _label);
int	 __mac_set_link(const char *_path, mac_t _label);
int	 __mac_mount(const char *type, const char *path, int flags, void *data,
    struct mac *label);
int	 __mac_get_mount(const char *path, struct mac *label);
int	 __mac_set_proc(const mac_t _label);
int	 __mac_syscall(const char *_policyname, int _call, void *_arg);
__END_DECLS
#endif /*__APPLE_API_PRIVATE*/

#endif

#endif /* !_SECURITY_MAC_H_ */
Commit	Line	Data
2d21ac55 A	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	* Copyright (c) 1999-2002 Robert N. M. Watson
	30	* Copyright (c) 2001-2005 Networks Associates Technology, Inc.
	31	* Copyright (c) 2005-2006 SPARTA, Inc.
	32	* All rights reserved.
	33	*
	34	* This software was developed by Robert Watson for the TrustedBSD Project.
	35	*
	36	* This software was developed for the FreeBSD Project in part by Network
	37	* Associates Laboratories, the Security Research Division of Network
	38	* Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
	39	* as part of the DARPA CHATS research program.
	40	*
	41	* This software was enhanced by SPARTA ISSO under SPAWAR contract
	42	* N66001-04-C-6019 ("SEFOS").
	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	* $FreeBSD: src/sys/sys/mac.h,v 1.40 2003/04/18 19:57:37 rwatson Exp $
66	*/
67	/*
68	* Userland interface for Mandatory Access Control.
69	*
70	* The POSIX.1e implementation page may be reached at:
71	* http://www.trustedbsd.org/
72	*/
73
74	#ifndef _SECURITY_MAC_H_
75	#define _SECURITY_MAC_H_
76
77	#ifndef _POSIX_MAC
78	#define _POSIX_MAC
79	#endif
80
81	#include <sys/types.h>
82
83	/*
84	* MAC framework-related constants and limits.
85	*/
86	#define MAC_MAX_POLICY_NAME 32
87	#define MAC_MAX_LABEL_ELEMENT_NAME 32
88	#define MAC_MAX_LABEL_ELEMENT_DATA 4096
89	#define MAC_MAX_LABEL_BUF_LEN 8192
90	#define MAC_MAX_MANAGED_NAMESPACES 4
91
92	struct mac {
93	size_t m_buflen;
94	char *m_string;
95	};
96
97	typedef struct mac *mac_t;
98
99	#ifdef KERNEL
39236c6e A	100
	101	#ifndef PRIVATE
	102	#warning "MAC policy is not KPI, see Technical Q&A QA1574"
	103	#endif
	104
3e170ce0 A	105	#if DEBUG
	106	#define SECURITY_MAC_CTLFLAGS (CTLFLAG_RW \| CTLFLAG_LOCKED)
	107	#define SECURITY_MAC_CHECK_ENFORCE 1
	108	#else
	109	#define SECURITY_MAC_CTLFLAGS (CTLFLAG_RD \| CTLFLAG_LOCKED)
	110	#define SECURITY_MAC_CHECK_ENFORCE 0
	111	#endif
	112
2d21ac55 A	113	struct user_mac {
	114	user_size_t m_buflen;
	115	user_addr_t m_string;
	116	};
6d2010ae A	117
	118	struct user32_mac {
	119	uint32_t m_buflen;
	120	uint32_t m_string;
	121	};
	122
	123	struct user64_mac {
	124	uint64_t m_buflen;
	125	uint64_t m_string;
	126	};
2d21ac55 A	127	#endif /* KERNEL */
	128
	129	/*
	130	* Flags to control which MAC subsystems are enforced
	131	* on a per-process/thread/credential basis.
	132	*/
	133	#define MAC_SYSTEM_ENFORCE 0x0001 /* system management */
	134	#define MAC_PROC_ENFORCE 0x0002 /* process management */
	135	#define MAC_MACH_ENFORCE 0x0004 /* mach interfaces */
	136	#define MAC_VM_ENFORCE 0x0008 /* VM interfaces */
	137	#define MAC_FILE_ENFORCE 0x0010 /* file operations */
	138	#define MAC_SOCKET_ENFORCE 0x0020 /* socket operations */
	139	#define MAC_PIPE_ENFORCE 0x0040 /* pipes */
	140	#define MAC_VNODE_ENFORCE 0x0080 /* vnode operations */
	141	#define MAC_NET_ENFORCE 0x0100 /* network management */
	142	#define MAC_MBUF_ENFORCE 0x0200 /* network traffic */
	143	#define MAC_POSIXSEM_ENFORCE 0x0400 /* posix semaphores */
	144	#define MAC_POSIXSHM_ENFORCE 0x0800 /* posix shared memory */
	145	#define MAC_SYSVMSG_ENFORCE 0x1000 /* SysV message queues */
	146	#define MAC_SYSVSEM_ENFORCE 0x2000 /* SysV semaphores */
	147	#define MAC_SYSVSHM_ENFORCE 0x4000 /* SysV shared memory */
	148	#define MAC_ALL_ENFORCE 0x7fff /* enforce everything */
	149
	150	/*
	151	* Device types for mac_iokit_check_device()
	152	*/
	153	#define MAC_DEVICE_USB "USB"
	154	#define MAC_DEVICE_FIREWIRE "FireWire"
	155	#define MAC_DEVICE_TYPE_KEY "DeviceType"
	156
6d2010ae A	157	/*
	158	* Flags for mac_proc_check_suspend_resume()
	159	*/
	160	#define MAC_PROC_CHECK_SUSPEND 0
	161	#define MAC_PROC_CHECK_RESUME 1
	162	#define MAC_PROC_CHECK_HIBERNATE 2
316670eb A	163	#define MAC_PROC_CHECK_SHUTDOWN_SOCKETS 3
316670eb A	164	#define MAC_PROC_CHECK_PIDBIND 4
6d2010ae	165
2d21ac55 A	166	#ifndef KERNEL
	167	/*
	168	* Location of the userland MAC framework configuration file. mac.conf
	169	* binds policy names to shared libraries that understand those policies,
	170	* as well as setting defaults for MAC-aware applications.
	171	*/
	172	#define MAC_CONFFILE "/etc/mac.conf"
	173
	174	/*
	175	* Extended non-POSIX.1e interfaces that offer additional services
	176	* available from the userland and kernel MAC frameworks.
	177	*/
	178	#ifdef __APPLE_API_PRIVATE
	179	__BEGIN_DECLS
	180	int __mac_execve(char fname, char argv, char *envv, mac_t _label);
	181	int __mac_get_fd(int _fd, mac_t _label);
	182	int __mac_get_file(const char *_path, mac_t _label);
2d21ac55 A	183	int __mac_get_link(const char *_path, mac_t _label);
	184	int __mac_get_pid(pid_t _pid, mac_t _label);
	185	int __mac_get_proc(mac_t _label);
	186	int __mac_set_fd(int _fildes, const mac_t _label);
	187	int __mac_set_file(const char *_path, mac_t _label);
2d21ac55 A	188	int __mac_set_link(const char *_path, mac_t _label);
	189	int __mac_mount(const char type, const char path, int flags, void *data,
	190	struct mac *label);
	191	int __mac_get_mount(const char path, struct mac label);
	192	int __mac_set_proc(const mac_t _label);
	193	int __mac_syscall(const char _policyname, int _call, void _arg);
	194	__END_DECLS
	195	#endif /__APPLE_API_PRIVATE/
	196
	197	#endif
	198
	199	#endif /* !_SECURITY_MAC_H_ */