bsd/sys/imgact.h

   1 /*
   2  * Copyright (c) 2004-2005, 2011 Apple Computer, 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) 1993, David Greenman
  30  * All rights reserved.
  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:
  42  *      This product includes software developed by the University of
  43  *      California, Berkeley and its contributors.
  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  *
  48  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  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.
  59  */
  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  */
  66 #ifndef _SYS_IMGACT_H_
  67 #define _SYS_IMGACT_H_
  68
  69 #define IMG_SHSIZE      512     /* largest shell interpreter, in bytes */
  70
  71 struct label;
  72 struct proc;
  73 struct nameidata;
  74
  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 */
  79         int             ip_seg;                 /* segment for arguments */
  80         struct vnode    *ip_vp;                 /* file */
  81         struct vnode_attr       *ip_vattr;      /* run file attributes */
  82         struct vnode_attr       *ip_origvattr;  /* invocation file attributes */
  83         cpu_type_t      ip_origcputype;         /* cputype of invocation file */
  84         cpu_subtype_t   ip_origcpusubtype;      /* subtype of invocation file */
  85         char            *ip_vdata;              /* file data (up to one page) */
  86         int             ip_flags;               /* image flags */
  87         int             ip_argc;                /* argument count */
  88         int             ip_envc;                /* environment count */
  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
  95         char            *ip_strings;            /* base address for strings */
  96         char            *ip_strendp;            /* current end pointer */
  97
  98         char            *ip_subsystem_root_path;        /* filepath for the subsystem root */
  99
 100         int             ip_argspace;    /* remaining space of NCARGS limit (argv+envv) */
 101         int             ip_strspace;            /* remaining total string space */
 102
 103         user_size_t     ip_arch_offset;         /* subfile offset in ip_vp */
 104         user_size_t     ip_arch_size;           /* subfile length in ip_vp */
 105         char            ip_interp_buffer[IMG_SHSIZE];   /* interpreter buffer space */
 106         int             ip_interp_sugid_fd;             /* fd for sugid script */
 107
 108         /* Next two fields are for support of architecture translation... */
 109         struct vfs_context      *ip_vfs_context;        /* VFS context */
 110         struct nameidata *ip_ndp;               /* current nameidata */
 111         thread_t        ip_new_thread;          /* thread for spawn/vfork */
 112
 113         struct label    *ip_execlabelp;         /* label of the executable */
 114         struct label    *ip_scriptlabelp;       /* label of the script */
 115         struct vnode    *ip_scriptvp;           /* script */
 116         unsigned int    ip_csflags;             /* code signing flags */
 117         int             ip_mac_return;          /* return code from mac policy checks */
 118         void            *ip_px_sa;
 119         void            *ip_px_sfa;
 120         void            *ip_px_spa;
 121         void            *ip_px_smpx;            /* MAC-specific spawn attrs. */
 122         void            *ip_px_persona;         /* persona args */
 123         void            *ip_px_pcred_info;      /* posix cred args */
 124         void            *ip_cs_error;           /* codesigning error reason */
 125         char            *ip_inherited_shared_region_id;  /* inherited shared region id for ptr auth */
 126
 127         uint64_t ip_dyld_fsid;
 128         uint64_t ip_dyld_fsobjid;
 129         uint64_t ip_inherited_jop_pid;
 130         unsigned int    ip_simulator_binary;    /* simulator binary flags */
 131
 132         ipc_port_t      ip_sc_port;             /* SUID port. */
 133 };
 134
 135 /*
 136  * Image flags
 137  */
 138 #define IMGPF_NONE                              0x00000000      /* No flags */
 139 #define IMGPF_INTERPRET                 0x00000001      /* Interpreter invoked */
 140 #define IMGPF_RESERVED                  0x00000002
 141 #define IMGPF_WAS_64BIT_ADDR    0x00000004      /* exec from a 64Bit address space */
 142 #define IMGPF_IS_64BIT_ADDR             0x00000008      /* exec to a 64Bit address space */
 143 #define IMGPF_SPAWN                             0x00000010      /* spawn (without setexec) */
 144 #define IMGPF_DISABLE_ASLR              0x00000020      /* disable ASLR */
 145 #define IMGPF_ALLOW_DATA_EXEC   0x00000040      /* forcibly disallow data execution */
 146 #define IMGPF_VFORK_EXEC                0x00000080      /* vfork followed by exec */
 147 #define IMGPF_EXEC                              0x00000100      /* exec */
 148 #define IMGPF_HIGH_BITS_ASLR    0x00000200      /* randomize high bits of ASLR slide */
 149 #define IMGPF_IS_64BIT_DATA             0x00000400      /* exec to a 64Bit register state */
 150 #define IMGPF_DRIVER             0x00000800      /* exec of a driver binary (no LC_MAIN) */
 151 #define IMGPF_RESLIDE           0x000001000     /* reslide the shared cache */
 152 #define IMGPF_PLUGIN_HOST_DISABLE_A_KEYS  0x000002000     /* process hosts plugins, disable ptr auth A keys */
 153 #define IMGPF_NOJOP             0x80000000
 154
 155
 156 /*
 157  * Simulator binary flags
 158  */
 159 #define IMGPF_SB_DEFAULT         0               /* Default value, did not check if it is a simulator binary */
 160 #define IMGPF_SB_TRUE            1               /* Binary is a simulator binary */
 161 #define IMGPF_SB_FALSE           2               /* Binary is not a simulator binary */
 162
 163
 164 #endif  /* !_SYS_IMGACT */