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