[apple/xnu.git] / osfmk / man / task_create_security_token.html

<h2>task_create_security_token</h2>\r<hr>\r<p>\r<strong>Function</strong> - Create a new task with an explicit security token.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   task_create_security_token</strong>\r                <strong>(task_t</strong>                                    <var>task</var>,\r                 <strong>security_port_t</strong>                  <var>host_security</var>,\r                 <strong>security_token_t</strong>                <var>security_token</var>,\r                 <strong>ledger_port_array_t</strong>                    <var>ledgers</var>,\r                 <strong>boolean_t</strong>                       <var>inherit_memory</var>,\r                 <strong>task_t</strong>                                  <var>task_t</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt><var>parent_task</var>\r<dd>\r[in task send right] The port for the task from which to draw the child \rtask's port rights and address space.\r<p>\r<dt><var>host_security</var>\r<dd>\r[in security send right] The host's security port.\r<p>\r<dt><var>security_token</var>\r<dd>\r[in scalar] The task's security token.\r<p>\r<dt><var>ledgers</var>\r<dd>\r[pointer to in array of ledger send rights] The set of ledgers from which the\rtask will draw its resources.\r<p>\r<dt><var>inherit_memory</var>\r<dd>\r[in scalar] Address space inheritance indicator. If true, the child task in-\rherits the address space of the parent task. If false, the kernel assigns \rthe child task an empty address space.\r<p>\r<dt><var>child_task</var>\r<dd>\r[out task send right] The kernel-assigned port name for the new task.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong><strong>task_create</strong>_security_token</strong> function creates a new task from\r<var>parent_task</var> with an explicit security token, returning the name of the\rnew task in the parameter specified by <var>child_task</var>. Other than the security token, the child task\ris as if created by <strong>task_create</strong>.\r<h3>NOTES</h3>\r<p>\rThe host security port is a privileged port given to the system\rbootstrap task for the use of this call.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>KERN_INVALID_SECURITY</strong>\r<dd>\rThe value of <var>host_security</var> does not specify the security port for the host on which task lies.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="task_create.html"><strong>task_create</strong></a>,\r<a href="task_set_security_token.html"><strong>task_set_security_token</strong></a>,\r<a href="mach_msg.html"><strong>mach_msg</strong></a>.\r