bsd/sys/codesign.h

   1 /*
   2  * Copyright (c) 2006 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 #ifndef _SYS_CODESIGN_H_
  30 #define _SYS_CODESIGN_H_
  31
  32 /* code signing attributes of a process */
  33 #define CS_VALID                0x0000001       /* dynamically valid */
  34 #define CS_ADHOC                0x0000002       /* ad hoc signed */
  35 #define CS_GET_TASK_ALLOW       0x0000004       /* has get-task-allow entitlement */
  36 #define CS_INSTALLER            0x0000008       /* has installer entitlement */
  37
  38 #define CS_HARD                 0x0000100       /* don't load invalid pages */
  39 #define CS_KILL                 0x0000200       /* kill process if it becomes invalid */
  40 #define CS_CHECK_EXPIRATION     0x0000400       /* force expiration checking */
  41 #define CS_RESTRICT             0x0000800       /* tell dyld to treat restricted */
  42 #define CS_ENFORCEMENT          0x0001000       /* require enforcement */
  43 #define CS_REQUIRE_LV           0x0002000       /* require library validation */
  44 #define CS_ENTITLEMENTS_VALIDATED       0x0004000       /* code signature permits restricted entitlements */
  45
  46 #define CS_ALLOWED_MACHO        (CS_ADHOC | CS_HARD | CS_KILL | CS_CHECK_EXPIRATION | CS_RESTRICT | CS_ENFORCEMENT | CS_REQUIRE_LV)
  47
  48 #define CS_EXEC_SET_HARD        0x0100000       /* set CS_HARD on any exec'ed process */
  49 #define CS_EXEC_SET_KILL        0x0200000       /* set CS_KILL on any exec'ed process */
  50 #define CS_EXEC_SET_ENFORCEMENT 0x0400000       /* set CS_ENFORCEMENT on any exec'ed process */
  51 #define CS_EXEC_SET_INSTALLER   0x0800000       /* set CS_INSTALLER on any exec'ed process */
  52
  53 #define CS_KILLED               0x1000000       /* was killed by kernel for invalidity */
  54 #define CS_DYLD_PLATFORM        0x2000000       /* dyld used to load this is a platform binary */
  55 #define CS_PLATFORM_BINARY      0x4000000       /* this is a platform binary */
  56 #define CS_PLATFORM_PATH        0x8000000       /* platform binary by the fact of path (osx only) */
  57 #define CS_DEBUGGED             0x10000000  /* process is currently or has previously been debugged and allowed to run with invalid pages */
  58 #define CS_SIGNED           0x20000000  /* process has a signature (may have gone invalid) */
  59
  60 #define CS_ENTITLEMENT_FLAGS    (CS_GET_TASK_ALLOW | CS_INSTALLER)
  61
  62 /* MAC flags used by F_ADDFILESIGS_* */
  63 #define MAC_VNODE_CHECK_DYLD_SIM 0x1   /* tells the MAC framework that dyld-sim is being loaded */
  64
  65 /* csops  operations */
  66 #define CS_OPS_STATUS           0       /* return status */
  67 #define CS_OPS_MARKINVALID      1       /* invalidate process */
  68 #define CS_OPS_MARKHARD         2       /* set HARD flag */
  69 #define CS_OPS_MARKKILL         3       /* set KILL flag (sticky) */
  70 #ifdef KERNEL_PRIVATE
  71 /* CS_OPS_PIDPATH               4       */
  72 #endif
  73 #define CS_OPS_CDHASH           5       /* get code directory hash */
  74 #define CS_OPS_PIDOFFSET        6       /* get offset of active Mach-o slice */
  75 #define CS_OPS_ENTITLEMENTS_BLOB 7      /* get entitlements blob */
  76 #define CS_OPS_MARKRESTRICT     8       /* set RESTRICT flag (sticky) */
  77 #define CS_OPS_SET_STATUS       9       /* set codesign flags */
  78 #define CS_OPS_BLOB             10      /* get codesign blob */
  79 #define CS_OPS_IDENTITY         11      /* get codesign identity */
  80 #define CS_OPS_CLEARINSTALLER   12      /* clear INSTALLER flag */
  81
  82 /*
  83  * Magic numbers used by Code Signing
  84  */
  85 enum {
  86         CSMAGIC_REQUIREMENT = 0xfade0c00,               /* single Requirement blob */
  87         CSMAGIC_REQUIREMENTS = 0xfade0c01,              /* Requirements vector (internal requirements) */
  88         CSMAGIC_CODEDIRECTORY = 0xfade0c02,             /* CodeDirectory blob */
  89         CSMAGIC_EMBEDDED_SIGNATURE = 0xfade0cc0, /* embedded form of signature data */
  90         CSMAGIC_EMBEDDED_SIGNATURE_OLD = 0xfade0b02,    /* XXX */
  91         CSMAGIC_EMBEDDED_ENTITLEMENTS = 0xfade7171,     /* embedded entitlements */
  92         CSMAGIC_DETACHED_SIGNATURE = 0xfade0cc1, /* multi-arch collection of embedded signatures */
  93         CSMAGIC_BLOBWRAPPER = 0xfade0b01,       /* CMS Signature, among other things */
  94
  95         CS_SUPPORTSSCATTER = 0x20100,
  96         CS_SUPPORTSTEAMID = 0x20200,
  97
  98         CSSLOT_CODEDIRECTORY = 0,                               /* slot index for CodeDirectory */
  99         CSSLOT_INFOSLOT = 1,
 100         CSSLOT_REQUIREMENTS = 2,
 101         CSSLOT_RESOURCEDIR = 3,
 102         CSSLOT_APPLICATION = 4,
 103         CSSLOT_ENTITLEMENTS = 5,
 104
 105         CSSLOT_ALTERNATE_CODEDIRECTORIES = 0x1000, /* first alternate CodeDirectory, if any */
 106         CSSLOT_ALTERNATE_CODEDIRECTORY_MAX = 5,         /* max number of alternate CD slots */
 107         CSSLOT_ALTERNATE_CODEDIRECTORY_LIMIT = CSSLOT_ALTERNATE_CODEDIRECTORIES + CSSLOT_ALTERNATE_CODEDIRECTORY_MAX, /* one past the last */
 108
 109         CSSLOT_SIGNATURESLOT = 0x10000,                 /* CMS Signature */
 110
 111         CSTYPE_INDEX_REQUIREMENTS = 0x00000002,         /* compat with amfi */
 112         CSTYPE_INDEX_ENTITLEMENTS = 0x00000005,         /* compat with amfi */
 113
 114         CS_HASHTYPE_SHA1 = 1,
 115         CS_HASHTYPE_SHA256 = 2,
 116         CS_HASHTYPE_SHA256_TRUNCATED = 3,
 117         CS_HASHTYPE_SHA384 = 4,
 118
 119         CS_SHA1_LEN = 20,
 120         CS_SHA256_TRUNCATED_LEN = 20,
 121
 122         CS_CDHASH_LEN = 20,                                             /* always - larger hashes are truncated */
 123         CS_HASH_MAX_SIZE = 48, /* max size of the hash we'll support */
 124 };
 125
 126
 127 #define KERNEL_HAVE_CS_CODEDIRECTORY 1
 128 #define KERNEL_CS_CODEDIRECTORY_HAVE_PLATFORM 1
 129
 130 /*
 131  * C form of a CodeDirectory.
 132  */
 133 typedef struct __CodeDirectory {
 134         uint32_t magic;                                 /* magic number (CSMAGIC_CODEDIRECTORY) */
 135         uint32_t length;                                /* total length of CodeDirectory blob */
 136         uint32_t version;                               /* compatibility version */
 137         uint32_t flags;                                 /* setup and mode flags */
 138         uint32_t hashOffset;                    /* offset of hash slot element at index zero */
 139         uint32_t identOffset;                   /* offset of identifier string */
 140         uint32_t nSpecialSlots;                 /* number of special hash slots */
 141         uint32_t nCodeSlots;                    /* number of ordinary (code) hash slots */
 142         uint32_t codeLimit;                             /* limit to main image signature range */
 143         uint8_t hashSize;                               /* size of each hash in bytes */
 144         uint8_t hashType;                               /* type of hash (cdHashType* constants) */
 145         uint8_t platform;                               /* platform identifier; zero if not platform binary */
 146         uint8_t pageSize;                               /* log2(page size in bytes); 0 => infinite */
 147         uint32_t spare2;                                /* unused (must be zero) */
 148         /* Version 0x20100 */
 149         uint32_t scatterOffset;                         /* offset of optional scatter vector */
 150         /* Version 0x20200 */
 151         uint32_t teamOffset;                            /* offset of optional team identifier */
 152         /* followed by dynamic content as located by offset fields above */
 153 } CS_CodeDirectory;
 154
 155 /*
 156  * Structure of an embedded-signature SuperBlob
 157  */
 158
 159 typedef struct __BlobIndex {
 160         uint32_t type;                                  /* type of entry */
 161         uint32_t offset;                                /* offset of entry */
 162 } CS_BlobIndex;
 163
 164 typedef struct __SC_SuperBlob {
 165         uint32_t magic;                                 /* magic number */
 166         uint32_t length;                                /* total length of SuperBlob */
 167         uint32_t count;                                 /* number of index entries following */
 168         CS_BlobIndex index[];                   /* (count) entries */
 169         /* followed by Blobs in no particular order as indicated by offsets in index */
 170 } CS_SuperBlob;
 171
 172 #define KERNEL_HAVE_CS_GENERICBLOB 1
 173 typedef struct __SC_GenericBlob {
 174         uint32_t magic;                         /* magic number */
 175         uint32_t length;                        /* total length of blob */
 176         char data[];
 177 } CS_GenericBlob;
 178
 179 typedef struct __SC_Scatter {
 180         uint32_t count;                 // number of pages; zero for sentinel (only)
 181         uint32_t base;                  // first page number
 182         uint64_t targetOffset;          // offset in target
 183         uint64_t spare;                 // reserved
 184 } SC_Scatter;
 185
 186
 187 #ifndef KERNEL
 188
 189 #include <sys/types.h>
 190 #include <mach/message.h>
 191
 192 __BEGIN_DECLS
 193 /* code sign operations */
 194 int csops(pid_t pid, unsigned int  ops, void * useraddr, size_t usersize);
 195 int csops_audittoken(pid_t pid, unsigned int  ops, void * useraddr, size_t usersize, audit_token_t * token);
 196 __END_DECLS
 197
 198 #else /* !KERNEL */
 199
 200 #include <mach/vm_types.h>
 201
 202 #include <sys/cdefs.h>
 203 #include <sys/_types/_off_t.h>
 204
 205 struct vnode;
 206 struct cs_blob;
 207 struct fileglob;
 208
 209 __BEGIN_DECLS
 210 int     cs_valid(struct proc *);
 211 int     cs_enforcement(struct proc *);
 212 int     cs_require_lv(struct proc *);
 213 int     cs_system_require_lv(void);
 214 uint32_t cs_entitlement_flags(struct proc *p);
 215 int     cs_entitlements_blob_get(struct proc *, void **, size_t *);
 216 int     cs_restricted(struct proc *);
 217 uint8_t * cs_get_cdhash(struct proc *);
 218
 219 struct cs_blob * csproc_get_blob(struct proc *);
 220 struct cs_blob * csvnode_get_blob(struct vnode *, off_t);
 221 void             csvnode_print_debug(struct vnode *);
 222
 223 off_t                   csblob_get_base_offset(struct cs_blob *);
 224 vm_size_t               csblob_get_size(struct cs_blob *);
 225 vm_address_t    csblob_get_addr(struct cs_blob *);
 226 const char *    csblob_get_teamid(struct cs_blob *);
 227 const char *    csblob_get_identity(struct cs_blob *);
 228 const uint8_t * csblob_get_cdhash(struct cs_blob *);
 229 int                             csblob_get_platform_binary(struct cs_blob *);
 230 unsigned int    csblob_get_flags(struct cs_blob *blob);
 231
 232 int             csblob_get_entitlements(struct cs_blob *, void **, size_t *);
 233
 234 const CS_GenericBlob *
 235                 csblob_find_blob(struct cs_blob *, uint32_t, uint32_t);
 236 const CS_GenericBlob *
 237                 csblob_find_blob_bytes(const uint8_t *, size_t, uint32_t, uint32_t);
 238 void *          csblob_entitlements_dictionary_copy(struct cs_blob *csblob);
 239 void            csblob_entitlements_dictionary_set(struct cs_blob *csblob, void * entitlements);
 240
 241 /*
 242  * Mostly convenience functions below
 243  */
 244
 245 const   char * csproc_get_teamid(struct proc *);
 246 const   char * csvnode_get_teamid(struct vnode *, off_t);
 247 int     csproc_get_platform_binary(struct proc *);
 248 const   char * csfg_get_teamid(struct fileglob *);
 249 int     csfg_get_path(struct fileglob *, char *, int *);
 250 int     csfg_get_platform_binary(struct fileglob *);
 251 uint8_t * csfg_get_cdhash(struct fileglob *, uint64_t, size_t *);
 252
 253 extern int cs_debug;
 254
 255 #ifdef XNU_KERNEL_PRIVATE
 256
 257 void    cs_init(void);
 258 int     cs_allow_invalid(struct proc *);
 259 int     cs_invalid_page(addr64_t vaddr, boolean_t *cs_killed);
 260 int     csproc_get_platform_path(struct proc *);
 261
 262 #if !SECURE_KERNEL
 263 extern int cs_enforcement_panic;
 264 #endif
 265
 266 #endif /* XNU_KERNEL_PRIVATE */
 267
 268
 269 __END_DECLS
 270
 271
 272
 273 #endif /* KERNEL */
 274
 275 #endif /* _SYS_CODESIGN_H_ */