Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 | /* * Copyright (c) 2022 Apple Computer, Inc. All rights reserved. * * @APPLE_LICENSE_HEADER_START@ * * The contents of this file constitute Original Code as defined in and * are subject to the Apple Public Source License Version 1.1 (the * "License"). You may not use this file except in compliance with the * License. Please obtain a copy of the License at * http://www.apple.com/publicsource and read it before using this file. * * This 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 OR NON-INFRINGEMENT. Please see the * License for the specific language governing rights and limitations * under the License. * * @APPLE_LICENSE_HEADER_END@ */ #ifndef _SYS_CODE_SIGNING_H_ #define _SYS_CODE_SIGNING_H_ #include <sys/cdefs.h> __BEGIN_DECLS #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wnullability-completeness" #pragma GCC diagnostic ignored "-Wnullability-completeness-on-arrays" typedef uint32_t code_signing_monitor_type_t; typedef uint32_t code_signing_config_t; /* Monitor Types */ #define CS_MONITOR_TYPE_NONE (0) #define CS_MONITOR_TYPE_PPL (1) #define CS_MONITOR_TYPE_TXM (2) /* Config - Exemptions */ #define CS_CONFIG_UNRESTRICTED_DEBUGGING (1 << 0) #define CS_CONFIG_ALLOW_ANY_SIGNATURE (1 << 1) #define CS_CONFIG_ENFORCEMENT_DISABLED (1 << 2) #define CS_CONFIG_GET_OUT_OF_MY_WAY (1 << 3) #define CS_CONFIG_INTEGRITY_SKIP (1 << 4) #define CS_CONFIG_RELAX_PROFILE_TRUST (1 << 5) #define CS_CONFIG_DEV_MODE_POLICY (1 << 6) /* Config - Features */ #define CS_CONFIG_REM_SUPPORTED (1 << 25) #define CS_CONFIG_MAP_JIT (1 << 26) #define CS_CONFIG_DEVELOPER_MODE_SUPPORTED (1 << 27) #define CS_CONFIG_COMPILATION_SERVICE (1 << 28) #define CS_CONFIG_LOCAL_SIGNING (1 << 29) #define CS_CONFIG_OOP_JIT (1 << 30) #define CS_CONFIG_CSM_ENABLED (1 << 31) #ifdef KERNEL_PRIVATE /* All definitions for XNU and kernel extensions */ #include <mach/boolean.h> #include <mach/kern_return.h> #include <img4/firmware.h> #if !XNU_KERNEL_PRIVATE /* * This header file is shared across the SDK and the KDK. When we're compiling code * for the kernel, but not for XNU, such as a kernel extension, the code signing * traps information is found through <image4/cs/traps.h>. When we're within XNU * proper, this header shouldn't be directory included and instead we should include * <libkern/image4/dlxk.h> instead, which is what we do within XNU_KERNEL_PRIVATE * down below. */ #if __has_include(<image4/cs/traps.h>) #include <image4/cs/traps.h> #else typedef uint64_t image4_cs_trap_t; #endif /* __has_include(<image4/cs/traps.h>) */ #endif /* !XNU_KERNEL_PRIVATE */ /* Availability macros for KPI functions */ #define XNU_SUPPORTS_CSM_TYPE 1 #define XNU_SUPPORTS_CSM_APPLE_IMAGE4 1 #define XNU_SUPPORTS_PROFILE_GARBAGE_COLLECTION 1 #define XNU_SUPPORTS_COMPILATION_SERVICE 1 #define XNU_SUPPORTS_LOCAL_SIGNING 1 #define XNU_SUPPORTS_CE_ACCELERATION 1 #define XNU_SUPPORTS_DISABLE_CODE_SIGNING_FEATURE 1 #define XNU_SUPPORTS_IMAGE4_MONITOR_TRAP 1 #define XNU_SUPPORTS_RESTRICTED_EXECUTION_MODE 1 #define XNU_SUPPORTS_SECURE_CHANNEL_SHARED_PAGE 1 #define XNU_SUPPORTS_CSM_DEVICE_STATE 1 #define XNU_SUPPORTS_REGISTER_PROFILE 1 #define XNU_SUPPORTS_RESEARCH_STATE 1 /* Forward declarations */ struct cs_blob; /* Local signing public key size */ #define XNU_LOCAL_SIGNING_KEY_SIZE 97 typedef struct _cs_profile_register_t { /* * The kernel performs duduplication of registered provisioning profiles * in order to optimize the profile loading code-path. The profile Uuid * is used as the identifier. */ uuid_t uuid; /* * Counter-signature of the profile used for verifying that the user has * opted to trust the profile. This is only required for certain kinds of * profiles. */ const void *sig_data; size_t sig_size; /* The profile data itself -- only DER profiles supported */ const void *data; size_t size; } cs_profile_register_t; #if XNU_KERNEL_PRIVATE #include <sys/code_signing_internal.h> #include <pexpert/pexpert.h> #include <libkern/img4/interface.h> #include <libkern/image4/dlxk.h> #if PMAP_CS_INCLUDE_CODE_SIGNING #if XNU_LOCAL_SIGNING_KEY_SIZE != PMAP_CS_LOCAL_SIGNING_KEY_SIZE #error "XNU local signing key size and PMAP_CS local signing key size differ!" #endif #endif /* PMAP_CS_INCLUDE_CODE_SIGNING */ /* Common developer mode state variable */ extern bool *developer_mode_enabled; /* Common research mode state variables */ extern bool research_mode_enabled; extern bool extended_research_mode_enabled; /** * This function is used to allocate code signing data which in some cases needs to * align to a page length. This is a frequent operation, and as a result, a common * helper is very useful. */ vm_address_t code_signing_allocate( size_t alloc_size); /** * This function is used to deallocate data received from code_signing_allocate. */ void code_signing_deallocate( vm_address_t *alloc_addr, size_t alloc_size); /** * AppleImage4 does not provide an API to convert an object specification index to an * actual object specification. Since this particular function is used across different * places, it makes sense to keep it in a shared header file. * * This function may be called in contexts where printing is not possible, so do NOT * leave a print statement here under any ciscumstances. */ static inline const img4_runtime_object_spec_t* image4_get_object_spec_from_index( img4_runtime_object_spec_index_t obj_spec_index) { const img4_runtime_object_spec_t *__single obj_spec = NULL; switch (obj_spec_index) { case IMG4_RUNTIME_OBJECT_SPEC_INDEX_SUPPLEMENTAL_ROOT: obj_spec = IMG4_RUNTIME_OBJECT_SPEC_SUPPLEMENTAL_ROOT; break; case IMG4_RUNTIME_OBJECT_SPEC_INDEX_LOCAL_POLICY: obj_spec = IMG4_RUNTIME_OBJECT_SPEC_LOCAL_POLICY; break; default: break; } return obj_spec; } /** * Research modes are only allowed when we're using a virtual device, security research * device or when we're using a dev-fused device. */ static inline bool allow_research_modes(void) { if (PE_vmm_present != 0) { return true; } else if ((PE_esdm_fuses & (1 << 0)) != 0) { return true; } else if (PE_i_can_has_debugger(NULL) == true) { return true; } return false; } /** * Perform any initialization required for managing code signing state on the system. * This is called within XNU itself and doesn't need to be exported to anything external. */ void code_signing_init(void); #endif /* XNU_KERNEL_PRIVATE */ /** * Query the system to understand the code signing configuration of the system. This * includes information on what monitor environment is available on the system as well * as what the state of the system looks like with the provided boot-args. */ void code_signing_configuration( code_signing_monitor_type_t *monitor_type, code_signing_config_t *config); /** * This function can be called by a component to disable a particular code signing * feature on the system. For instance, code_signing_configuration is initialized in * early boot, where some kernel extensions which affect code signing aren't online. * When these extensions come online, they may choose to call this function to affect * the state which was previously initialized within code_signing_configuration. */ void disable_code_signing_feature( code_signing_config_t feature); /** * AppleSEPManager uses this API to obtain the physical page which must be mapped as * the secure channel within the SEP. This API is only supported on systems which have * the Trusted Execution Monitor system monitor. */ kern_return_t secure_channel_shared_page( uint64_t *secure_channel_phys, size_t *secure_channel_size); /** * Enable developer mode on the system. When the system contains a monitor environment, * developer mode is turned on by trapping into the appropriate monitor environment. */ void enable_developer_mode(void); /** * Disable developer mode on the system. When the system contains a monitor environment, * developer mode is turned off by trapping into the appropriate monitor environment. */ void disable_developer_mode(void); /** * Query the current state of developer mode on the system. This call never traps into * the monitor environment because XNU can directly read the monitors memory. */ bool developer_mode_state(void); /* * Query the current state of research mode on the system. This call never traps into * the monitor environment as the state is queried at boot and saved in read-only-late * memory. * * This state can only ever be enabled on platforms which support the trusted execution * monitor environment. The state requires research fusing and the use of a security * research device. */ bool research_mode_state(void); /* * Query the current state of extended research mode on the system. This call never traps * into the monitor environment as the state is queried at boot and saved in read-only-late * memory. * * This state can only ever be enabled on platforms which support the trusted execution * monitor environment. The state requires research fusing and the use of a security * research device. */ bool extended_research_mode_state(void); /** * Attempt to enable restricted execution mode on the system. Not all systems support * restricted execution mode. If the call is successful, KERN_SUCCESS is returned, or * an error. */ kern_return_t restricted_execution_mode_enable(void); /** * Query the current state of restricted execution mode on the system. Not all systems * support restricted execution mode. If REM is enabled, KERN_SUCCESS is returned. If * REM is disabled, KERN_DENIED is returned. If REM is not supported on this platform, * then KERN_NOT_SUPPORTED is returned. */ kern_return_t restricted_execution_mode_state(void); /** * This function is called whem the kernel wants the code-signing monitor to update its * device state which is provided by the SEP using an OOB buffer. */ void update_csm_device_state(void); /* * This function called when the kernel wants the code-signing monitor to complete the * functionality of a security boot mode. */ void complete_security_boot_mode( uint32_t security_boot_mode); /* * Register and attempt to associate a provisioning profile with the code signature * attached to the csblob. This call is only relevant for systems which have a code * signing monitor, but it is exported to kernel extensions since AMFI is the primary * consumer. */ int csblob_register_profile( struct cs_blob *csblob, cs_profile_register_t *profile); /** * Wrapper function which is exposed to kernel extensions. This can be used to trigger * a call to the garbage collector for going through and unregistring all unused profiles * on the system. */ void garbage_collect_provisioning_profiles(void); /** * Set the CDHash which is currently being used by the compilation service. This CDHash * is compared against when validating the signature of a compilation service library. */ void set_compilation_service_cdhash( const uint8_t *cdhash); /** * Match a CDHash against the currently stored CDHash for the compilation service. */ bool match_compilation_service_cdhash( const uint8_t *cdhash); /** * Set the local signing key which is currently being used on the system. This key is used * to validate any signatures which are signed on device. */ void set_local_signing_public_key( const uint8_t public_key[XNU_LOCAL_SIGNING_KEY_SIZE]); /** * Get the local signing key which is currently being used on the system. This API is * mostly used by kernel extensions which validate code signatures on the platform. */ uint8_t* get_local_signing_public_key(void); /** * Unrestrict a particular CDHash for local signing, allowing it to be loaded and run on * the system. This is only required to be done for main binaries, since libraries do not * need to be unrestricted. */ void unrestrict_local_signing_cdhash( const uint8_t *cdhash); /** * The kernel or the monitor environments allocate some data which is used by AppleImage4 * for storing critical system information such as nonces. AppleImage4 uses this API to * get access to this data while abstracting the implementation underneath. */ void* kernel_image4_storage_data( size_t *allocated_size); /** * AppleImage4 uses this API to store the specified nonce into the nonce storage. This API * abstracts away the kernel or monitor implementation used. */ void kernel_image4_set_nonce( const img4_nonce_domain_index_t ndi, const img4_nonce_t *nonce); /** * AppleImage4 uses this API to roll a specified nonce on the next boot. This API abstracts * away the kernel or monitor implementation used. */ void kernel_image4_roll_nonce( const img4_nonce_domain_index_t ndi); /** * AppleImage4 uses this API to copy a specified nonce from the nonce storage. This API * abstracts away the kernel or monitor implementation used. * * We need this API since the nonces use a lock to protect against concurrency, and the * lock can only be taken within the monitor environment, if any. */ errno_t kernel_image4_copy_nonce( const img4_nonce_domain_index_t ndi, img4_nonce_t *nonce_out); /** * AppleImage4 uses this API to perform object execution on a particular object type. This * API abstracts away the kernel or monitor implementation used. */ errno_t kernel_image4_execute_object( img4_runtime_object_spec_index_t obj_spec_index, const img4_buff_t *payload, const img4_buff_t *manifest); /** * AppleImage4 uses this API to copy the contents of an executed object. This API abstracts * away the kernel or monitor implementation used. */ errno_t kernel_image4_copy_object( img4_runtime_object_spec_index_t obj_spec_index, vm_address_t object_out, size_t *object_length); /** * AppleImage4 uses this API to get a pointer to the structure which is used for exporting * monitor locked down data to the rest of the system. */ const void* kernel_image4_get_monitor_exports(void); /** * AppleImage4 uses this API to let the monitor environment know the release type for the * the current boot. Under some circumstances, the monitor isn't able to gauge this on its * own. */ errno_t kernel_image4_set_release_type( const char *release_type); /** * AppleImage4 uses this API to let the monitor know when a nonce domain is shadowing the * AP boot nonce. Since this information is queried from the NVRAM, the monitor cant know * this on its own. */ errno_t kernel_image4_set_bnch_shadow( const img4_nonce_domain_index_t ndi); /** * AppleImage4 uses this API to trap into the code signing monitor on the platform for * the image4 dispatch routines. A single entry point is multiplexed into a whole dispatch * table. */ errno_t kernel_image4_monitor_trap( image4_cs_trap_t selector, const void *input_data, size_t input_size, void *output_data, size_t *output_size); /** * AMFI uses this API to obtain the OSEntitlements object which is associated with the * main binary mapped in for a process. * * This API is considered safer for resolving the OSEntitlements than through the cred * structure on the process because the system maintains a strong binding in the linkage * chain from the process structure through the pmap, which ultimately contains the * code signing monitors address space information for the process. */ kern_return_t csm_resolve_os_entitlements_from_proc( const proc_t process, const void **os_entitlements); /** * Wrapper function that calls csm_get_trust_level_kdp if there is a CODE_SIGNING_MONITOR * or returns KERN_NOT_SUPPORTED if there isn't one. */ kern_return_t get_trust_level_kdp( pmap_t pmap, uint32_t *trust_level); /** * Wrapper function that calls csm_get_jit_address_range_kdp if there is a CODE_SIGNING_MONITOR * or returns KERN_NOT_SUPPORTED if there isn't one. */ kern_return_t get_jit_address_range_kdp( pmap_t pmap, uintptr_t *jit_region_start, uintptr_t *jit_region_end); /** * Check whether a particular proc is marked as debugged or not. For many use cases, this * is a stronger check than simply checking for the enablement of developer mode since * an address space can only be marked as debugged if developer mode is already enabled. * * When the system has a code signing monitor, this function acquires the state of the * address space from the monitor. */ kern_return_t address_space_debugged_state( const proc_t process); /** * Implements the same policy as address_space_debugged_state(), but returns * with boolean semantics. */ bool is_address_space_debugged( const proc_t process); #if CODE_SIGNING_MONITOR struct vm_map_entry; /** * Check to see if the monitor is currently enforcing code signing protections or * not. Even when this is disabled, certains artifacts are still protected by the * monitor environment. */ bool csm_enabled(void); /** * Check and inform the code signing monitor that the system is entering lockdown mode. * The code signing monitor then enforces policy based on this state. As part of this, * we also update the code signing configuration of the system. */ void csm_check_lockdown_mode(void); /** * When a task incurs an unresolvable page fault with execute permissions, and is not * being debugged, the task should receive a SIGKILL. This should only happen if the * task isn't actively being debugged. This function abstracts all these details. */ void csm_code_signing_violation( proc_t proc, vm_offset_t addr); /** * This function is used to initialize the state of the locks for managing provisioning * profiles on the system. It should be called by the kernel bootstrap thread during the * early kernel initialization. */ void csm_initialize_provisioning_profiles(void); /** * Register a provisioning profile with the monitor environment available on the * system. This function will allocate its own memory for managing the profile and * the caller is allowed to free their own allocation. */ kern_return_t csm_register_provisioning_profile( const uuid_t profile_uuid, const void *profile, const size_t profile_size); /** * Attempt to trust a provisioning profile with the monitor environment available on * the system. The provided signature will be passed to the monitor as is, and the * caller is responsible for de-allocation of the data, if required. */ kern_return_t csm_trust_provisioning_profile( const uuid_t profile_uuid, const void *sig_data, size_t sig_size); /** * Associate a registered profile with a code signature object which is managed by * the monitor environment. This incrementes the reference count on the profile object * managed by the monitor, preventing the profile from being unregistered. */ kern_return_t csm_associate_provisioning_profile( void *monitor_sig_obj, const uuid_t profile_uuid); /** * Disassociate an associated profile with a code signature object which is managed by * the monitor environment. This decrements the refernce count on the profile object * managed by the monitor, potentially allowing it to be unregistered in case no other * signatures hold a reference count to it. */ kern_return_t csm_disassociate_provisioning_profile( void *monitor_sig_obj); /** * Trigger the provisioning profile garbage collector to go through each registered * profile on the system and unregister it in case it isn't being used. */ void csm_free_provisioning_profiles(void); /** * Acquire the largest size for a code signature which the monitor will allocate on * its own. Anything larger than this size needs to be page-allocated and aligned and * will be locked down by the monitor upon registration. */ vm_size_t csm_signature_size_limit(void); /** * Register a code signature with the monitor environment. The monitor will either * allocate its own memory for the code signature, or it will lockdown the memory which * is given to it. In either case, the signature will be read-only for the kernel. * * If the monitor doesn't enforce code signing, then this function will return the * KERN_SUCCESS condition. */ kern_return_t csm_register_code_signature( const vm_address_t signature_addr, const vm_size_t signature_size, const vm_offset_t code_directory_offset, const char *signature_path, void **monitor_sig_obj, vm_address_t *monitor_signature_addr); /** * Unregister a code signature previously registered with the monitor environment. * This will free (or unlock) the signature memory held by the monitor. * * If the monitor doesn't enforce code signing, then this function will return the * error KERN_NOT_SUPPORTED. */ kern_return_t csm_unregister_code_signature( void *monitor_sig_obj); /** * Verify a code signature previously registered with the monitor. After verification, * the signature can be used for making code signature associations with address spaces. * * If the monitor doesn't enforce code signing, then this function will return the * KERN_SUCCESS condition. */ kern_return_t csm_verify_code_signature( void *monitor_sig_obj, uint32_t *trust_level); /** * Perform 2nd stage reconstitution through the monitor. This unlocks any unused parts * of the code signature, which can then be freed by the kernel. This isn't strictly * required, but it helps in conserving system memory. * * If the monitor doesn't enforce code signing, then this function will return the * error KERN_NOT_SUPPORTED. */ kern_return_t csm_reconstitute_code_signature( void *monitor_sig_obj, vm_address_t *unneeded_addr, vm_size_t *unneeded_size); /** * Setup a nested address space object with the required base address and size for the * nested region. The code signing monitor will enforce that code signature associations * can only be made within this address region. * * This must be called before any associations can be made with the nested address space. */ kern_return_t csm_setup_nested_address_space( pmap_t pmap, const vm_address_t region_addr, const vm_size_t region_size); /** * Associate a code signature with an address space for a specified region with the * monitor environment. The code signature can only be associated if it has been * verified before. */ kern_return_t csm_associate_code_signature( pmap_t pmap, void *monitor_sig_obj, const vm_address_t region_addr, const vm_size_t region_size, const vm_offset_t region_offset); /** * Validate that an address space will allow mapping in a JIT region within the monitor * environment. An address space can only have a single JIT region, and only when it * has the appropriate JIT entitlement. */ kern_return_t csm_allow_jit_region( pmap_t pmap); /** * Associate a JIT region with an address space in the monitor environment. An address * space can only have a JIT region if it has the appropriate JIT entitlement. */ kern_return_t csm_associate_jit_region( pmap_t pmap, const vm_address_t region_addr, const vm_size_t region_size); /** * Associate a debug region with an address space in the monitor environment. An address * space can only have a debug region if it is currently being debugged. */ kern_return_t csm_associate_debug_region( pmap_t pmap, const vm_address_t region_addr, const vm_size_t region_size); /** * Call out to the monitor to inform it that the address space needs to be debugged. The * monitor will only allow the address space to be debugged if it has the appropriate * entitlements. */ kern_return_t csm_allow_invalid_code( pmap_t pmap); /** * Acquire the trust level which is placed on the address space within the monitor * environment. There is no clear mapping of the 32-bit integer returned to the actual * trust level because different code signing monitors use different trust levels. * * The code signing monitor itself does not depend on this value and instead uses * other, more secure methods of checking for trust. In general, we only expect this * function to be used for debugging purposes. * * This function should be careful that any code paths within it do not mutate the * state of the system, and as a result, no code paths here should attempt to take * locks of any kind. */ kern_return_t csm_get_trust_level_kdp( pmap_t pmap, uint32_t *trust_level); /** * Acquire the address range for the JIT region for this address space. * * We expect this function to only be used for debugging purposes, and not for * enforcing any security policies. * This function should be careful that any code paths within it do not mutate the * state of the system, and as a result, no code paths here should attempt to take * locks of any kind. * KERN_SUCCESS is returned if the address space has JIT capability and an address range * was returned in the output arguments. * KERN_NOT_FOUND is returned if the address space does not have JIT, or on systems where * the code signing monitor does not track the JIT range. * KERN_NOT_SUPPORTED is returned for environments where this call is not supported. */ kern_return_t csm_get_jit_address_range_kdp( pmap_t pmap, uintptr_t *jit_region_start, uintptr_t *jit_region_end); /** * Certain address spaces are exempt from code signing enforcement. This function can be * used to check if the specified address space is such or not. */ kern_return_t csm_address_space_exempt( const pmap_t pmap); /** * Instruct the monitor that an address space is about to be forked. The monitor can then * do whatever it needs to do in order to prepare for the fork. */ kern_return_t csm_fork_prepare( pmap_t old_pmap, pmap_t new_pmap); /** * Get the signing identifier which is embedded within the code directory using the * code signing monitor's abstract signature object. */ kern_return_t csm_acquire_signing_identifier( const void *monitor_sig_obj, const char **signing_id); /** * This API to associate an OSEntitlements objects with the code signing monitor's * signature object. This binding is useful as it can be used to resolve the entitlement * object which is used by the kernel for performing queries. */ kern_return_t csm_associate_os_entitlements( void *monitor_sig_obj, const void *os_entitlements); /** * Accelerate the CoreEntitlements context within the code signing monitor's memory * in order to speed up all queries for entitlements going through CoreEntitlements. */ kern_return_t csm_accelerate_entitlements( void *monitor_sig_obj, const CEContext_t **ce_ctx); kern_return_t vm_map_entry_cs_associate( vm_map_t map, struct vm_map_entry *entry, vm_map_kernel_flags_t vmk_flags); kern_return_t cs_associate_blob_with_mapping( void *pmap, vm_map_offset_t start, vm_map_size_t size, vm_object_offset_t offset, void *blobs_p); #endif /* CODE_SIGNING_MONITOR */ #endif /* KERNEL_PRIVATE */ #pragma GCC diagnostic pop __END_DECLS #endif /* _SYS_CODE_SIGNING_H_ */ |