[apple/xnu.git] / bsd / sys / imgact.h

/*
 * Copyright (c) 2004-2005, 2011 Apple Computer, 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) 1993, David Greenman
 * All rights reserved.
 *
 * 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * 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 REGENTS 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.
 */
/*
 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
 * support for mandatory and extensible security protections.  This notice
 * is included in support of clause 2.2 (b) of the Apple Public License,
 * Version 2.0.
 */
#ifndef _SYS_IMGACT_H_
#define	_SYS_IMGACT_H_

#define	IMG_SHSIZE	512	/* largest shell interpreter, in bytes */

struct label;
struct proc;
struct nameidata;

struct image_params {
	user_addr_t	ip_user_fname;		/* argument */
	user_addr_t	ip_user_argv;		/* argument */
	user_addr_t	ip_user_envv;		/* argument */
	int		ip_seg;			/* segment for arguments */
	struct vnode	*ip_vp;			/* file */
	struct vnode_attr	*ip_vattr;	/* run file attributes */
	struct vnode_attr	*ip_origvattr;	/* invocation file attributes */
	cpu_type_t	ip_origcputype;		/* cputype of invocation file */
	cpu_subtype_t	ip_origcpusubtype;	/* subtype of invocation file */
	char		*ip_vdata;		/* file data (up to one page) */
	int		ip_flags;		/* image flags */
	int		ip_argc;		/* argument count */
	int		ip_envc;		/* environment count */
	int		ip_applec;		/* apple vector count */

	char		*ip_startargv;		/* argument vector beginning */
	char		*ip_endargv;	/* end of argv/start of envv */
	char		*ip_endenvv;	/* end of envv/start of applev */

	char		*ip_strings;		/* base address for strings */
	char		*ip_strendp;		/* current end pointer */

	int 		ip_argspace;	/* remaining space of NCARGS limit (argv+envv) */
	int		ip_strspace;		/* remaining total string space */

	user_size_t 	ip_arch_offset;		/* subfile offset in ip_vp */
	user_size_t 	ip_arch_size;		/* subfile length in ip_vp */
	char		ip_interp_buffer[IMG_SHSIZE];	/* interpreter buffer space */
	int		ip_interp_sugid_fd;		/* fd for sugid script */

	/* Next two fields are for support of architecture translation... */
	struct vfs_context	*ip_vfs_context;	/* VFS context */
	struct nameidata *ip_ndp;		/* current nameidata */
	thread_t	ip_new_thread;		/* thread for spawn/vfork */

	struct label	*ip_execlabelp;		/* label of the executable */
	struct label	*ip_scriptlabelp;	/* label of the script */
	struct vnode	*ip_scriptvp;		/* script */
	unsigned int	ip_csflags;		/* code signing flags */
	int		ip_mac_return;		/* return code from mac policy checks */
	void		*ip_px_sa;
	void		*ip_px_sfa;
	void		*ip_px_spa;
	void		*ip_px_smpx;		/* MAC-specific spawn attrs. */
	void		*ip_px_persona;		/* persona args */
	void		*ip_cs_error;		/* codesigning error reason */

	uint64_t ip_dyld_fsid;
	uint64_t ip_dyld_fsobjid;
};

/*
 * Image flags
 */
#define	IMGPF_NONE				0x00000000	/* No flags */
#define	IMGPF_INTERPRET			0x00000001	/* Interpreter invoked */
#define	IMGPF_RESERVED			0x00000002
#define	IMGPF_WAS_64BIT_ADDR	0x00000004	/* exec from a 64Bit address space */
#define	IMGPF_IS_64BIT_ADDR		0x00000008	/* exec to a 64Bit address space */
#define	IMGPF_SPAWN				0x00000010	/* spawn (without setexec) */
#define	IMGPF_DISABLE_ASLR		0x00000020	/* disable ASLR */
#define	IMGPF_ALLOW_DATA_EXEC	0x00000040	/* forcibly disallow data execution */
#define	IMGPF_VFORK_EXEC		0x00000080	/* vfork followed by exec */
#define	IMGPF_EXEC				0x00000100	/* exec */
#define	IMGPF_HIGH_BITS_ASLR	0x00000200	/* randomize high bits of ASLR slide */
#define	IMGPF_IS_64BIT_DATA		0x00000400	/* exec to a 64Bit register state */


#endif	/* !_SYS_IMGACT */
Commit	Line	Data
1c79356b	1	/*
316670eb	2	* Copyright (c) 2004-2005, 2011 Apple Computer, Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b	27	*/
1c79356b	28	/*
91447636 A	29	* Copyright (c) 1993, David Greenman
91447636 A	30	* All rights reserved.
1c79356b A	31	*
	32	* Redistribution and use in source and binary forms, with or without
	33	* modification, are permitted provided that the following conditions
	34	* are met:
	35	* 1. Redistributions of source code must retain the above copyright
	36	* notice, this list of conditions and the following disclaimer.
	37	* 2. Redistributions in binary form must reproduce the above copyright
	38	* notice, this list of conditions and the following disclaimer in the
	39	* documentation and/or other materials provided with the distribution.
	40	* 3. All advertising materials mentioning features or use of this software
	41	* must display the following acknowledgement:
91447636 A	42	* This product includes software developed by the University of
91447636 A	43	* California, Berkeley and its contributors.
1c79356b A	44	* 4. Neither the name of the University nor the names of its contributors
	45	* may be used to endorse or promote products derived from this software
	46	* without specific prior written permission.
	47	*
91447636	48	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1c79356b A	49	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	50	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	51	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	52	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	53	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	54	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	55	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	56	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	57	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	58	* SUCH DAMAGE.
1c79356b	59	*/
2d21ac55 A	60	/*
	61	* NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
	62	* support for mandatory and extensible security protections. This notice
	63	* is included in support of clause 2.2 (b) of the Apple Public License,
	64	* Version 2.0.
	65	*/
91447636 A	66	#ifndef _SYS_IMGACT_H_
91447636 A	67	#define _SYS_IMGACT_H_
1c79356b	68
91447636	69	#define IMG_SHSIZE 512 /* largest shell interpreter, in bytes */
1c79356b	70
2d21ac55	71	struct label;
91447636 A	72	struct proc;
91447636 A	73	struct nameidata;
1c79356b	74
91447636 A	75	struct image_params {
	76	user_addr_t ip_user_fname; /* argument */
	77	user_addr_t ip_user_argv; /* argument */
	78	user_addr_t ip_user_envv; /* argument */
2d21ac55	79	int ip_seg; /* segment for arguments */
91447636 A	80	struct vnode ip_vp; / file */
	81	struct vnode_attr ip_vattr; / run file attributes */
	82	struct vnode_attr ip_origvattr; / invocation file attributes */
2d21ac55 A	83	cpu_type_t ip_origcputype; /* cputype of invocation file */
2d21ac55 A	84	cpu_subtype_t ip_origcpusubtype; /* subtype of invocation file */
91447636 A	85	char ip_vdata; / file data (up to one page) */
	86	int ip_flags; /* image flags */
	87	int ip_argc; /* argument count */
91447636	88	int ip_envc; /* environment count */
6d2010ae A	89	int ip_applec; /* apple vector count */
	90
	91	char ip_startargv; / argument vector beginning */
	92	char ip_endargv; / end of argv/start of envv */
	93	char ip_endenvv; / end of envv/start of applev */
	94
91447636 A	95	char ip_strings; / base address for strings */
91447636 A	96	char ip_strendp; / current end pointer */
6d2010ae A	97
	98	int ip_argspace; /* remaining space of NCARGS limit (argv+envv) */
	99	int ip_strspace; /* remaining total string space */
	100
91447636 A	101	user_size_t ip_arch_offset; /* subfile offset in ip_vp */
91447636 A	102	user_size_t ip_arch_size; /* subfile length in ip_vp */
6d2010ae A	103	char ip_interp_buffer[IMG_SHSIZE]; /* interpreter buffer space */
6d2010ae A	104	int ip_interp_sugid_fd; /* fd for sugid script */
1c79356b	105
0c530ab8	106	/* Next two fields are for support of architecture translation... */
91447636 A	107	struct vfs_context ip_vfs_context; / VFS context */
91447636 A	108	struct nameidata ip_ndp; / current nameidata */
b0d623f7	109	thread_t ip_new_thread; /* thread for spawn/vfork */
2d21ac55 A	110
	111	struct label ip_execlabelp; / label of the executable */
	112	struct label ip_scriptlabelp; / label of the script */
39236c6e	113	struct vnode ip_scriptvp; / script */
2d21ac55	114	unsigned int ip_csflags; /* code signing flags */
fe8ab488	115	int ip_mac_return; /* return code from mac policy checks */
2d21ac55 A	116	void *ip_px_sa;
	117	void *ip_px_sfa;
	118	void *ip_px_spa;
39236c6e	119	void ip_px_smpx; / MAC-specific spawn attrs. */
490019cf	120	void ip_px_persona; / persona args */
39037602	121	void ip_cs_error; / codesigning error reason */
5ba3f43e A	122
	123	uint64_t ip_dyld_fsid;
	124	uint64_t ip_dyld_fsobjid;
91447636	125	};
1c79356b	126
91447636 A	127	/*
	128	* Image flags
	129	*/
d9a64523 A	130	#define IMGPF_NONE 0x00000000 /* No flags */
	131	#define IMGPF_INTERPRET 0x00000001 /* Interpreter invoked */
	132	#define IMGPF_RESERVED 0x00000002
	133	#define IMGPF_WAS_64BIT_ADDR 0x00000004 /* exec from a 64Bit address space */
	134	#define IMGPF_IS_64BIT_ADDR 0x00000008 /* exec to a 64Bit address space */
	135	#define IMGPF_SPAWN 0x00000010 /* spawn (without setexec) */
	136	#define IMGPF_DISABLE_ASLR 0x00000020 /* disable ASLR */
6d2010ae	137	#define IMGPF_ALLOW_DATA_EXEC 0x00000040 /* forcibly disallow data execution */
d9a64523 A	138	#define IMGPF_VFORK_EXEC 0x00000080 /* vfork followed by exec */
d9a64523 A	139	#define IMGPF_EXEC 0x00000100 /* exec */
5ba3f43e	140	#define IMGPF_HIGH_BITS_ASLR 0x00000200 /* randomize high bits of ASLR slide */
d9a64523 A	141	#define IMGPF_IS_64BIT_DATA 0x00000400 /* exec to a 64Bit register state */
d9a64523 A	142
1c79356b	143
91447636	144	#endif /* !_SYS_IMGACT */