1*1031c584SApple OSS Distributions /* 2*1031c584SApple OSS Distributions * Copyright (c) 2020 Apple Inc. All rights reserved. 3*1031c584SApple OSS Distributions * 4*1031c584SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*1031c584SApple OSS Distributions * 6*1031c584SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*1031c584SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*1031c584SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*1031c584SApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*1031c584SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*1031c584SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*1031c584SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*1031c584SApple OSS Distributions * terms of an Apple operating system software license agreement. 14*1031c584SApple OSS Distributions * 15*1031c584SApple OSS Distributions * Please obtain a copy of the License at 16*1031c584SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*1031c584SApple OSS Distributions * 18*1031c584SApple OSS Distributions * The Original Code and all software distributed under the License are 19*1031c584SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*1031c584SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*1031c584SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*1031c584SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*1031c584SApple OSS Distributions * Please see the License for the specific language governing rights and 24*1031c584SApple OSS Distributions * limitations under the License. 25*1031c584SApple OSS Distributions * 26*1031c584SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*1031c584SApple OSS Distributions */ 28*1031c584SApple OSS Distributions 29*1031c584SApple OSS Distributions /* 30*1031c584SApple OSS Distributions * 31*1031c584SApple OSS Distributions * A task identity token represents the identity of a mach task without carrying task 32*1031c584SApple OSS Distributions * access capabilities. In applicable scenarios, task identity token can be moved between 33*1031c584SApple OSS Distributions * tasks and be upgraded to desired level of task port flavor (namely, task name port, 34*1031c584SApple OSS Distributions * inspect port, read port or control port) upon use. 35*1031c584SApple OSS Distributions * 36*1031c584SApple OSS Distributions */ 37*1031c584SApple OSS Distributions 38*1031c584SApple OSS Distributions #ifndef _KERN_TASK_IDENT_H 39*1031c584SApple OSS Distributions #define _KERN_TASK_IDENT_H 40*1031c584SApple OSS Distributions 41*1031c584SApple OSS Distributions #if KERNEL_PRIVATE 42*1031c584SApple OSS Distributions 43*1031c584SApple OSS Distributions #include <kern/kern_types.h> 44*1031c584SApple OSS Distributions #include <mach/mach_types.h> 45*1031c584SApple OSS Distributions 46*1031c584SApple OSS Distributions __BEGIN_DECLS 47*1031c584SApple OSS Distributions 48*1031c584SApple OSS Distributions #define TASK_IDENTITY_TOKEN_KPI_VERSION 1 49*1031c584SApple OSS Distributions 50*1031c584SApple OSS Distributions /*! 51*1031c584SApple OSS Distributions * @function task_id_token_port_name_to_task() 52*1031c584SApple OSS Distributions * 53*1031c584SApple OSS Distributions * @abstract 54*1031c584SApple OSS Distributions * Produces a task reference from task identity token port name. 55*1031c584SApple OSS Distributions * 56*1031c584SApple OSS Distributions * For export to kexts only. _DO NOT_ use in kenel proper for correct task 57*1031c584SApple OSS Distributions * reference counting. 58*1031c584SApple OSS Distributions * 59*1031c584SApple OSS Distributions * @param name port name for the task identity token to operate on 60*1031c584SApple OSS Distributions * @param taskp task_t pointer 61*1031c584SApple OSS Distributions * 62*1031c584SApple OSS Distributions * @returns KERN_SUCCESS A valid task reference is produced. 63*1031c584SApple OSS Distributions * KERN_NOT_FOUND Cannot find task represented by token. 64*1031c584SApple OSS Distributions * KERN_INVALID_ARGUMENT Passed identity token is invalid. 65*1031c584SApple OSS Distributions */ 66*1031c584SApple OSS Distributions #if XNU_KERNEL_PRIVATE 67*1031c584SApple OSS Distributions kern_return_t task_id_token_port_name_to_task(mach_port_name_t name, task_t *taskp) 68*1031c584SApple OSS Distributions __XNU_INTERNAL(task_id_token_port_name_to_task); 69*1031c584SApple OSS Distributions 70*1031c584SApple OSS Distributions void task_id_token_release(task_id_token_t token); 71*1031c584SApple OSS Distributions 72*1031c584SApple OSS Distributions ipc_port_t convert_task_id_token_to_port(task_id_token_t token); 73*1031c584SApple OSS Distributions 74*1031c584SApple OSS Distributions task_id_token_t convert_port_to_task_id_token(ipc_port_t port); 75*1031c584SApple OSS Distributions 76*1031c584SApple OSS Distributions #if MACH_KERNEL_PRIVATE 77*1031c584SApple OSS Distributions kern_return_t task_identity_token_get_task_grp(task_id_token_t token, task_t *taskp, task_grp_t grp); 78*1031c584SApple OSS Distributions #endif /* MACH_KERNEL_PRIVATE */ 79*1031c584SApple OSS Distributions 80*1031c584SApple OSS Distributions #else /* !XNU_KERNEL_PRIVATE */ 81*1031c584SApple OSS Distributions kern_return_t task_id_token_port_name_to_task(mach_port_name_t name, task_t *taskp); 82*1031c584SApple OSS Distributions #endif /* !XNU_KERNEL_PRIVATE */ 83*1031c584SApple OSS Distributions 84*1031c584SApple OSS Distributions __END_DECLS 85*1031c584SApple OSS Distributions 86*1031c584SApple OSS Distributions #endif /* KERNEL_PRIVATE */ 87*1031c584SApple OSS Distributions 88*1031c584SApple OSS Distributions #endif /* _KERN_TASK_IDENT_H */ 89