xref: /xnu-8792.81.2/osfmk/man/host_security_create_task_token.html (revision 19c3b8c28c31cb8130e034cfb5df6bf9ba342d90)
1*19c3b8c2SApple OSS Distributions<h2>host_security_create_task_token</h2>
2*19c3b8c2SApple OSS Distributions<hr>
3*19c3b8c2SApple OSS Distributions<p>
4*19c3b8c2SApple OSS Distributions<strong>Function</strong> - Create a new task with an explicit security token.
5*19c3b8c2SApple OSS Distributions<h3>SYNOPSIS</h3>
6*19c3b8c2SApple OSS Distributions<pre>
7*19c3b8c2SApple OSS Distributions<strong>kern_return_t   host_security_create_task_token</strong>
8*19c3b8c2SApple OSS Distributions                <strong>(host_security_t</strong>                  <var>host_security</var>,
9*19c3b8c2SApple OSS Distributions                 <strong>task_t</strong>                             <var>parent_task</var>,
10*19c3b8c2SApple OSS Distributions                 <strong>security_token_t</strong>                <var>security_token</var>,
11*19c3b8c2SApple OSS Distributions                 <strong>audit_token_t</strong>                      <var>audit_token</var>,
12*19c3b8c2SApple OSS Distributions                 <strong>ledger_port_array_t</strong>                    <var>ledgers</var>,
13*19c3b8c2SApple OSS Distributions                 <strong>boolean_t</strong>                       <var>inherit_memory</var>,
14*19c3b8c2SApple OSS Distributions                 <strong>task_t</strong>                             <var>child_task</var><strong>);</strong>
15*19c3b8c2SApple OSS Distributions</pre>
16*19c3b8c2SApple OSS Distributions<h3>PARAMETERS</h3>
17*19c3b8c2SApple OSS Distributions<dl>
18*19c3b8c2SApple OSS Distributions<p>
19*19c3b8c2SApple OSS Distributions<dt><var>host_security</var>
20*19c3b8c2SApple OSS Distributions<dd>
21*19c3b8c2SApple OSS Distributions[in security send right] The host's security port.
22*19c3b8c2SApple OSS Distributions<p>
23*19c3b8c2SApple OSS Distributions<dt><var>parent_task</var>
24*19c3b8c2SApple OSS Distributions<dd>
25*19c3b8c2SApple OSS Distributions[in task send right] The port for the task from which to draw the child
26*19c3b8c2SApple OSS Distributionstask's port rights and address space.
27*19c3b8c2SApple OSS Distributions<p>
28*19c3b8c2SApple OSS Distributions<dt><var>security_token</var>
29*19c3b8c2SApple OSS Distributions<dd>
30*19c3b8c2SApple OSS Distributions[in scalar] The task's security token.
31*19c3b8c2SApple OSS Distributions<p>
32*19c3b8c2SApple OSS Distributions<dt><var>audit_token</var>
33*19c3b8c2SApple OSS Distributions<dd>
34*19c3b8c2SApple OSS Distributions[in scalar] The task's audit token.
35*19c3b8c2SApple OSS Distributions<p>
36*19c3b8c2SApple OSS Distributions<dt><var>ledgers</var>
37*19c3b8c2SApple OSS Distributions<dd>
38*19c3b8c2SApple OSS Distributions[pointer to in array of ledger send rights] The set of ledgers from which the
39*19c3b8c2SApple OSS Distributionstask will draw its resources.
40*19c3b8c2SApple OSS Distributions<p>
41*19c3b8c2SApple OSS Distributions<dt><var>inherit_memory</var>
42*19c3b8c2SApple OSS Distributions<dd>
43*19c3b8c2SApple OSS Distributions[in scalar] Address space inheritance indicator. If true, the child task in-
44*19c3b8c2SApple OSS Distributionsherits the address space of the parent task. If false, the kernel assigns
45*19c3b8c2SApple OSS Distributionsthe child task an empty address space.
46*19c3b8c2SApple OSS Distributions<p>
47*19c3b8c2SApple OSS Distributions<dt><var>child_task</var>
48*19c3b8c2SApple OSS Distributions<dd>
49*19c3b8c2SApple OSS Distributions[out task send right] The kernel-assigned port name for the new task.
50*19c3b8c2SApple OSS Distributions</dl>
51*19c3b8c2SApple OSS Distributions<h3>DESCRIPTION</h3>
52*19c3b8c2SApple OSS Distributions<p>
53*19c3b8c2SApple OSS DistributionsThe <strong><strong>host_security_create_task_token</strong> function creates a new task from
54*19c3b8c2SApple OSS Distributions<var>parent_task</var> with explicit security and audit token values, returning the name of the
55*19c3b8c2SApple OSS Distributionsnew task in the parameter specified by <var>child_task</var>. Other than the security and audit token values, the child task
56*19c3b8c2SApple OSS Distributionsis as if created by <strong>task_create</strong>.
57*19c3b8c2SApple OSS Distributions<h3>NOTES</h3>
58*19c3b8c2SApple OSS Distributions<p>
59*19c3b8c2SApple OSS DistributionsThe host security port is a privileged port given to the system
60*19c3b8c2SApple OSS Distributionsbootstrap task for the use of this call.
61*19c3b8c2SApple OSS Distributions<h3>RETURN VALUES</h3>
62*19c3b8c2SApple OSS Distributions<dl>
63*19c3b8c2SApple OSS Distributions<p>
64*19c3b8c2SApple OSS Distributions<dt> <strong>KERN_INVALID_SECURITY</strong>
65*19c3b8c2SApple OSS Distributions<dd>
66*19c3b8c2SApple OSS DistributionsThe value of <var>host_security</var> does not specify the security port for the host on which task lies.
67*19c3b8c2SApple OSS Distributions</dl>
68*19c3b8c2SApple OSS Distributions<h3>RELATED INFORMATION</h3>
69*19c3b8c2SApple OSS Distributions<p>
70*19c3b8c2SApple OSS DistributionsFunctions:
71*19c3b8c2SApple OSS Distributions<a href="task_create.html"><strong>task_create</strong></a>,
72*19c3b8c2SApple OSS Distributions<a href="host_security_set_task_token.html"><strong>host_security_set_task_token</strong></a>,
73*19c3b8c2SApple OSS Distributions<a href="mach_msg.html"><strong>mach_msg</strong></a>.
74