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