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