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