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