osfmk/tests/ptrauth_data_tests.c

   1 /*
   2  * Copyright (c) 2020 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 #if DEVELOPMENT || DEBUG
  30 #if __has_feature(ptrauth_calls)
  31
  32 #include <pexpert/pexpert.h>
  33 #include <mach/port.h>
  34 #include <mach/task.h>
  35 #include <kern/task.h>
  36 #include <vm/vm_map.h>
  37 #include <vm/pmap.h>
  38 #include <ipc/ipc_types.h>
  39 #include <ipc/ipc_port.h>
  40 #include <kern/ipc_kobject.h>
  41 #include <kern/kern_types.h>
  42
  43 kern_return_t ptrauth_data_tests(void);
  44
  45 /*
  46  * Given an existing PAC pointer (ptr), its declaration type (decl), the (key)
  47  * used to sign it and the string discriminator (discr), extract the raw pointer
  48  * along with the signature and compare it with one computed on the fly
  49  * via ptrauth_sign_unauthenticated().
  50  *
  51  * If the two mismatch, return an error and fail the test.
  52  */
  53 #define VALIDATE_PTR(decl, ptr, key, discr) { \
  54         decl raw = *(decl *)&(ptr);      \
  55         decl cmp = ptrauth_sign_unauthenticated(ptr, key, \
  56                 ptrauth_blend_discriminator(&ptr, ptrauth_string_discriminator(discr))); \
  57         if (cmp != raw) { \
  58                 printf("kern.run_pac_test: %s (%s) (discr=%s) is not signed as expected (%p vs %p)\n", #decl, #ptr, #discr, raw, cmp); \
  59                 kr = KERN_INVALID_ADDRESS; \
  60         } \
  61 }
  62
  63 /*
  64  * Allocate the containing structure, and store a pointer to the desired member,
  65  * which should be subject to pointer signing.
  66  */
  67 #define ALLOC_VALIDATE_DATA_PTR(structure, decl, member, discr) { \
  68         structure *tmp =  kheap_alloc(KHEAP_TEMP, sizeof(structure), Z_WAITOK | Z_ZERO); \
  69         if (!tmp) return KERN_NO_SPACE; \
  70         tmp->member = (void*)0xffffffff41414141; \
  71         VALIDATE_DATA_PTR(decl, tmp->member, discr) \
  72         kheap_free(KHEAP_TEMP, tmp, sizeof(structure)); \
  73 }
  74
  75 #define VALIDATE_DATA_PTR(decl, ptr, discr) VALIDATE_PTR(decl, ptr, ptrauth_key_process_independent_data, discr)
  76
  77 /*
  78  * Validate that a pointer that is supposed to be signed, is, and that the signature
  79  * matches based on signing key, location and discriminator
  80  */
  81 kern_return_t
  82 ptrauth_data_tests(void)
  83 {
  84         int kr = KERN_SUCCESS;
  85
  86         /* task_t */
  87         ALLOC_VALIDATE_DATA_PTR(struct task, vm_map_t, map, "task.map");
  88         ALLOC_VALIDATE_DATA_PTR(struct task, struct ipc_port *, itk_self[0], "task.itk_self");
  89         ALLOC_VALIDATE_DATA_PTR(struct task, struct ipc_port *, itk_settable_self, "task.itk_settable_self");
  90         ALLOC_VALIDATE_DATA_PTR(struct task, struct ipc_port *, itk_host, "task.itk_host");
  91         ALLOC_VALIDATE_DATA_PTR(struct task, struct ipc_port *, itk_bootstrap, "task.itk_bootstrap");
  92         ALLOC_VALIDATE_DATA_PTR(struct task, struct ipc_port *, itk_debug_control, "task.itk_debug_control");
  93         ALLOC_VALIDATE_DATA_PTR(struct task, struct ipc_space *, itk_space, "task.itk_space");
  94         ALLOC_VALIDATE_DATA_PTR(struct task, void *, bsd_info, "task.bsd_info");
  95         ALLOC_VALIDATE_DATA_PTR(struct task, struct ipc_port *, itk_gssd, "task.itk_gssd");
  96         ALLOC_VALIDATE_DATA_PTR(struct task, struct ipc_port *, itk_task_access, "task.itk_task_access");
  97         ALLOC_VALIDATE_DATA_PTR(struct task, struct ipc_port *, itk_resume, "task.itk_resume");
  98         ALLOC_VALIDATE_DATA_PTR(struct task, struct ipc_port *, itk_seatbelt, "task.itk_seatbelt");
  99
 100         /* _vm_map */
 101         ALLOC_VALIDATE_DATA_PTR(struct _vm_map, pmap_t, pmap, "_vm_map.pmap");
 102
 103         /* pmap */
 104         ALLOC_VALIDATE_DATA_PTR(struct pmap, tt_entry_t *, tte, "pmap.tte");
 105         ALLOC_VALIDATE_DATA_PTR(struct pmap, pmap_t, nested_pmap, "pmap.nested_pmap");
 106
 107         /* ipc_port */
 108         ALLOC_VALIDATE_DATA_PTR(struct ipc_port, ipc_kobject_t, ip_kobject, "ipc_port.kobject");
 109         ALLOC_VALIDATE_DATA_PTR(struct ipc_port, ipc_kobject_label_t, ip_kolabel, "ipc_port.kolabel");
 110
 111         /* ipc_kobject_label */
 112         ALLOC_VALIDATE_DATA_PTR(struct ipc_kobject_label, ipc_kobject_t, ikol_kobject, "ipc_kobject_label.ikol_kobject");
 113
 114         /* ipc_entry */
 115         ALLOC_VALIDATE_DATA_PTR(struct ipc_entry, struct ipc_object *, ie_object, "ipc_entry.ie_object");
 116
 117         /* ipc_kmsg */
 118         ALLOC_VALIDATE_DATA_PTR(struct ipc_kmsg, struct ipc_port *, ikm_prealloc, "kmsg.ikm_prealloc");
 119         ALLOC_VALIDATE_DATA_PTR(struct ipc_kmsg, void *, ikm_data, "kmsg.ikm_data");
 120         ALLOC_VALIDATE_DATA_PTR(struct ipc_kmsg, mach_msg_header_t *, ikm_header, "kmsg.ikm_header");
 121         ALLOC_VALIDATE_DATA_PTR(struct ipc_kmsg, struct ipc_port *, ikm_voucher, "kmsg.ikm_voucher");
 122
 123         return kr;
 124 }
 125
 126 #endif /*  __has_feature(ptrauth_calls) */
 127 #endif /* DEVELOPMENT || DEBUG */