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