xref: /xnu-11215.41.3/osfmk/man/host_security_set_task_token.html (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1*33de042dSApple OSS Distributions<h2>host_security_set_task_token</h2>
2*33de042dSApple OSS Distributions<hr>
3*33de042dSApple OSS Distributions<p>
4*33de042dSApple OSS Distributions<strong>Function</strong> - Change the target task's security token.
5*33de042dSApple OSS Distributions<h3>SYNOPSIS</h3>
6*33de042dSApple OSS Distributions<pre>
7*33de042dSApple OSS Distributions<strong>kern_return_t   host_security_set_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>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>host_t</strong>                                    <var>host</var><strong>);</strong>
13*33de042dSApple OSS Distributions</pre>
14*33de042dSApple OSS Distributions<h3>PARAMETERS</h3>
15*33de042dSApple OSS Distributions<dl>
16*33de042dSApple OSS Distributions<p>
17*33de042dSApple OSS Distributions<dt><var>host_security</var>
18*33de042dSApple OSS Distributions<dd>
19*33de042dSApple OSS Distributions[in security send right] The host's security port.
20*33de042dSApple OSS Distributions<p>
21*33de042dSApple OSS Distributions<dt><var>task</var>
22*33de042dSApple OSS Distributions<dd>
23*33de042dSApple OSS Distributions[in task send right] The port for the task for which the token is to be set.
24*33de042dSApple OSS Distributions<p>
25*33de042dSApple OSS Distributions<dt><var>security_token</var>
26*33de042dSApple OSS Distributions<dd>
27*33de042dSApple OSS Distributions[in scalar] The new security token.
28*33de042dSApple OSS Distributions<p>
29*33de042dSApple OSS Distributions<dt><var>audit_token</var>
30*33de042dSApple OSS Distributions<dd>
31*33de042dSApple OSS Distributions[in scalar] The new audit token.
32*33de042dSApple OSS Distributions<p>
33*33de042dSApple OSS Distributions<dt><var>host</var>
34*33de042dSApple OSS Distributions<dd>
35*33de042dSApple OSS Distributions[in host send right] The task's new host-self port.
36*33de042dSApple OSS Distributions</dl>
37*33de042dSApple OSS Distributions<h3>DESCRIPTION</h3>
38*33de042dSApple OSS Distributions<p>
39*33de042dSApple OSS DistributionsThe <strong>host_security_set_task_token</strong> function changes the
40*33de042dSApple OSS Distributionsspecified task's security and audit tokens; the new tokens will be
41*33de042dSApple OSS Distributionsincluded in all subsequent messages sent from the task. The
42*33de042dSApple OSS Distributionsinitial value of a task's security and audit tokens is that of its
43*33de042dSApple OSS Distributionsparent.
44*33de042dSApple OSS Distributions<h3>NOTES</h3>
45*33de042dSApple OSS Distributions<p>
46*33de042dSApple OSS DistributionsThe host security port is a privileged port given to the system
47*33de042dSApple OSS Distributionsbootstrap task for the use of this call.
48*33de042dSApple OSS Distributions<h3>RETURN VALUES</h3>
49*33de042dSApple OSS Distributions<dl>
50*33de042dSApple OSS Distributions<p>
51*33de042dSApple OSS Distributions<dt> <strong>KERN_INVALID_SECURITY</strong>
52*33de042dSApple OSS Distributions<dd>
53*33de042dSApple OSS DistributionsThe value of <var>host_security</var> does not specify the security port for the host on which task lies.
54*33de042dSApple OSS Distributions</dl>
55*33de042dSApple OSS Distributions<h3>RELATED INFORMATION</h3>
56*33de042dSApple OSS Distributions<p>
57*33de042dSApple OSS DistributionsFunctions:
58*33de042dSApple OSS Distributions<a href="task_create.html"><strong>task_create</strong></a>,
59*33de042dSApple OSS Distributions<a href="task_info.html"><strong>task_info</strong></a>,
60*33de042dSApple OSS Distributions<a href="mach_msg.html"><strong>mach_msg</strong></a>.
61